abstract class Redis_AbstractBackend in Redis 7.2

Hierarchy

• class \Redis_AbstractBackend

File

lib/Redis/AbstractBackend.php, line 3

abstract class Redis_AbstractBackend {

  /**
   * Key components name separator
   */
  const KEY_SEPARATOR = ':';

  /**
   * @var string
   */
  protected static $globalPrefix;

  /**
   * Get site default global prefix
   *
   * @return string
   */
  public static function getGlobalPrefix() {

    // Provide a fallback for multisite. This is on purpose not inside the
    // getPrefixForBin() function in order to decouple the unified prefix
    // variable logic and custom module related security logic, that is not
    // necessary for all backends. We can't just use HTTP_HOST, as multiple
    // hosts might be using the same database. Or, more commonly, a site
    // might not be a multisite at all, but might be using Drush leading to
    // a separate HTTP_HOST of 'default'. Likewise, we can't rely on
    // conf_path(), as settings.php might be modifying what database to
    // connect to. To mirror what core does with database caching we use
    // the DB credentials to inform our cache key.
    if (null === self::$globalPrefix) {
      if (isset($GLOBALS['db_url'])) {

        // Drupal 6 specifics when using the cache_backport module, we
        // therefore cannot use \Database class to determine database
        // settings.
        self::$globalPrefix = md5($GLOBALS['db_url']);
      }
      else {
        require_once DRUPAL_ROOT . '/includes/database/database.inc';
        $dbInfo = Database::getConnectionInfo();
        $active = $dbInfo['default'];
        self::$globalPrefix = md5($active['host'] . $active['database'] . $active['prefix']['default']);
      }
    }
    return self::$globalPrefix;
  }

  /**
   * Get global default prefix
   *
   * @param string $namespace
   *
   * @return string
   */
  public static function getDefaultPrefix($namespace = null) {
    $ret = null;
    if (isset($GLOBALS['drupal_test_info']) && !empty($GLOBALS['drupal_test_info']['test_run_id'])) {
      $ret = $GLOBALS['drupal_test_info']['test_run_id'];
    }
    else {
      $prefixes = variable_get('cache_prefix', null);
      if (is_string($prefixes)) {

        // Variable can be a string which then considered as a default
        // behavior.
        $ret = $prefixes;
      }
      else {
        if (null !== $namespace && isset($prefixes[$namespace])) {
          if (false !== $prefixes[$namespace]) {

            // If entry is set and not false an explicit prefix is set
            // for the bin.
            $ret = $prefixes[$namespace];
          }
          else {

            // If we have an explicit false it means no prefix whatever
            // is the default configuration.
            $ret = '';
          }
        }
        else {

          // Key is not set, we can safely rely on default behavior.
          if (isset($prefixes['default']) && false !== $prefixes['default']) {
            $ret = $prefixes['default'];
          }
          else {

            // When default is not set or an explicit false this means
            // no prefix.
            $ret = '';
          }
        }
      }
    }
    if (empty($ret)) {
      $ret = self::getGlobalPrefix();
    }
    return $ret;
  }

  /**
   * @var string
   */
  private $prefix;

  /**
   * Default constructor
   */
  public function __construct($namespace = null) {
    $this->prefix = self::getDefaultPrefix($namespace);
  }

  /**
   * Get redis client
   *
   * @return Redis|Predis\Client
   */
  public function getClient() {

    // Ugly stateless and static
    return Redis_Client::getClient();
  }

  /**
   * Set prefix
   *
   * @param string $prefix
   */
  public final function setPrefix($prefix) {
    $this->prefix = $prefix;
  }

  /**
   * Get prefix
   *
   * @return string
   */
  public final function getPrefix() {
    return $this->prefix;
  }

  /**
   * Get full key name using the set prefix
   *
   * @param string ...
   *   Any numer of strings to append to path using the separator
   *
   * @return string
   */
  public function getKey() {
    $args = array_filter(func_get_args());
    if (empty($args)) {
      return $this->prefix;
    }
    else {
      if (is_array($args)) {
        array_unshift($args, $this->prefix);
        return implode(self::KEY_SEPARATOR, $args);
      }
      else {
        return $this->prefix . self::KEY_SEPARATOR . $args;
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Redis_AbstractBackend::$globalPrefix	protected static	property
Redis_AbstractBackend::$prefix	private	property
Redis_AbstractBackend::getClient	public	function	Get redis client
Redis_AbstractBackend::getDefaultPrefix	public static	function	Get global default prefix
Redis_AbstractBackend::getGlobalPrefix	public static	function	Get site default global prefix
Redis_AbstractBackend::getKey	public	function	Get full key name using the set prefix	2
Redis_AbstractBackend::getPrefix	final public	function	Get prefix
Redis_AbstractBackend::KEY_SEPARATOR		constant	Key components name separator
Redis_AbstractBackend::setPrefix	final public	function	Set prefix
Redis_AbstractBackend::__construct	public	function	Default constructor	2