You are here

class DrupalMemcached in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 modules/memcache/src/DrupalMemcached.php \Drupal\memcache\DrupalMemcached

Class DrupalMemcached.

Hierarchy

Expanded class hierarchy of DrupalMemcached

File

modules/memcache/src/DrupalMemcached.php, line 15
Contains \Drupal\memcache\DrupalMemcached.

Namespace

Drupal\memcache
View source
class DrupalMemcached extends DrupalMemcacheBase {

  /**
   * {@inheritdoc}
   */
  public function __construct($bin, Settings $settings) {
    parent::__construct($bin, $settings);
    $this->memcache = new \Memcached();
    $default_opts = array(
      \Memcached::OPT_COMPRESSION => FALSE,
      \Memcached::OPT_DISTRIBUTION => \Memcached::DISTRIBUTION_CONSISTENT,
    );
    foreach ($default_opts as $key => $value) {
      $this->memcache
        ->setOption($key, $value);
    }

    // See README.txt for setting custom Memcache options when using the
    // memcached PECL extension.
    foreach ($this->settings
      ->get('memcache_options', array()) as $key => $value) {
      $this->memcache
        ->setOption($key, $value);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function addServer($server_path, $persistent = FALSE) {
    list($host, $port) = explode(':', $server_path);
    if ($host == 'unix') {

      // Memcached expects just the path to the socket without the protocol
      $host = substr($host, 7);

      // Port is always 0 for unix sockets.
      $port = 0;
    }
    return $this->memcache
      ->addServer($host, $port, $persistent);
  }

  /**
   * {@inheritdoc}
   */
  public function set($key, $value, $exp = 0, $flag = FALSE) {
    $full_key = $this
      ->key($key);
    return $this->memcache
      ->set($full_key, $value, $exp);
  }

  /**
   * {@inheritdoc}
   */
  public function getMulti(array $keys) {
    $full_keys = array();
    foreach ($keys as $cid) {
      $full_key = $this
        ->key($cid);
      $full_keys[$cid] = $full_key;
    }
    $results = $this->memcache
      ->getMulti($full_keys);

    // If $results is FALSE, convert it to an empty array.
    if (!$results) {
      $results = array();
    }

    // Convert the full keys back to the cid.
    $cid_results = array();
    $cid_lookup = array_flip($full_keys);
    foreach ($results as $key => $value) {
      $cid_results[$cid_lookup[$key]] = $value;
    }
    return $cid_results;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DrupalMemcacheBase::$bin protected property The cache bin name.
DrupalMemcacheBase::$hashAlgorithm protected property The hash algorithm to pass to hash(). Defaults to 'sha1'
DrupalMemcacheBase::$memcache protected property The memcache object.
DrupalMemcacheBase::$settings protected property The settings object.
DrupalMemcacheBase::delete public function Deletes an item from Memcache. Overrides DrupalMemcacheInterface::delete
DrupalMemcacheBase::flush public function Immediately invalidates all existing items. Overrides DrupalMemcacheInterface::flush
DrupalMemcacheBase::get public function Retrieves a value from Memcache. Overrides DrupalMemcacheInterface::get
DrupalMemcacheBase::key public function Prepares the memcache key. Overrides DrupalMemcacheInterface::key
DrupalMemcached::addServer public function Adds a memcache server. Overrides DrupalMemcacheInterface::addServer
DrupalMemcached::getMulti public function Retrieves multiple values from Memcache. Overrides DrupalMemcacheInterface::getMulti
DrupalMemcached::set public function Adds an item into memcache. Overrides DrupalMemcacheInterface::set
DrupalMemcached::__construct public function Constructs a DrupalMemcacheBase object. Overrides DrupalMemcacheBase::__construct