vendor/tedivm/stash/src/Stash/Driver/AbstractDriver.php line 39

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Stash package.
  5.  *
  6.  * (c) Robert Hafner <tedivm@tedivm.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Stash\Driver;
  14. use Stash\Interfaces\DriverInterface;
  15. use Stash\Exception\RuntimeException;
  17. /**
  18.  * Abstract base class for all drivers to use.
  19.  *
  20.  * @package Stash
  21.  * @author  Robert Hafner <tedivm@tedivm.com>
  22.  */
  23. abstract class AbstractDriver implements DriverInterface
  24. {
  25.     /**
  26.      * Initializes the driver.
  27.      *
  28.      * @param array $options
  29.      *   An additional array of options to pass through to setOptions().
  30.      *
  31.      * @throws RuntimeException
  32.      */
  33.     public function __construct(array $options = array())
  34.     {
  35.         if (!static::isAvailable()) {
  36.             throw new RuntimeException(get_class($this) . ' is not available.');
  37.         }
  39.         $this->setOptions($options);
  40.     }
  42.     /**
  43.      * @return array
  44.      */
  45.     public function getDefaultOptions()
  46.     {
  47.         return array();
  48.     }
  50.     /**
  51.      * {@inheritdoc}
  52.      */
  53.     protected function setOptions(array $options = array())
  54.     {
  55.         // empty
  56.     }
  58.     /**
  59.      * {@inheritdoc}
  60.      */
  61.     public static function isAvailable()
  62.     {
  63.         return true;
  64.     }
  66.     /**
  67.      * {@inheritdoc}
  68.      */
  69.     public function isPersistent()
  70.     {
  71.         return false;
  72.     }
  73. }