vendor/zendframework/zend-cache/src/Storage/Adapter/ApcuIterator.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2016 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Cache\Storage\Adapter;
  11
  12 use Zend\Cache\Storage\IteratorInterface;
  13 use APCuIterator as BaseApcuIterator;
  14
  15 class ApcuIterator implements IteratorInterface
  16 {
  17     /**
  18      * The storage instance
  19      *
  20      * @var Apcu
  21      */
  22     protected $storage;
  23
  24     /**
  25      * The iterator mode
  26      *
  27      * @var int
  28      */
  29     protected $mode = IteratorInterface::CURRENT_AS_KEY;
  30
  31     /**
  32      * The base APCIterator instance
  33      *
  34      * @var APCIterator
  35      */
  36     protected $baseIterator;
  37
  38     /**
  39      * The length of the namespace prefix
  40      *
  41      * @var int
  42      */
  43     protected $prefixLength;
  44
  45     /**
  46      * Constructor
  47      *
  48      * @param Apcu             $storage
  49      * @param BaseApcuIterator $baseIterator
  50      * @param string           $prefix
  51      */
  52     public function __construct(Apcu $storage, BaseApcuIterator $baseIterator, $prefix)
  53     {
  54         $this->storage      = $storage;
  55         $this->baseIterator = $baseIterator;
  56         $this->prefixLength = strlen($prefix);
  57     }
  58
  59     /**
  60      * Get storage instance
  61      *
  62      * @return Apcu
  63      */
  64     public function getStorage()
  65     {
  66         return $this->storage;
  67     }
  68
  69     /**
  70      * Get iterator mode
  71      *
  72      * @return int Value of IteratorInterface::CURRENT_AS_*
  73      */
  74     public function getMode()
  75     {
  76         return $this->mode;
  77     }
  78
  79     /**
  80      * Set iterator mode
  81      *
  82      * @param int $mode
  83      * @return ApcuIterator Provides a fluent interface
  84      */
  85     public function setMode($mode)
  86     {
  87         $this->mode = (int) $mode;
  88         return $this;
  89     }
  90
  91     /* Iterator */
  92
  93     /**
  94      * Get current key, value or metadata.
  95      *
  96      * @return mixed
  97      */
  98     public function current()
  99     {
 100         if ($this->mode == IteratorInterface::CURRENT_AS_SELF) {
 101             return $this;
 102         }
 103
 104         $key = $this->key();
 105
 106         if ($this->mode == IteratorInterface::CURRENT_AS_VALUE) {
 107             return $this->storage->getItem($key);
 108         } elseif ($this->mode == IteratorInterface::CURRENT_AS_METADATA) {
 109             return $this->storage->getMetadata($key);
 110         }
 111
 112         return $key;
 113     }
 114
 115     /**
 116      * Get current key
 117      *
 118      * @return string
 119      */
 120     public function key()
 121     {
 122         $key = $this->baseIterator->key();
 123
 124         // remove namespace prefix
 125         return substr($key, $this->prefixLength);
 126     }
 127
 128     /**
 129      * Move forward to next element
 130      *
 131      * @return void
 132      */
 133     public function next()
 134     {
 135         $this->baseIterator->next();
 136     }
 137
 138     /**
 139      * Checks if current position is valid
 140      *
 141      * @return bool
 142      */
 143     public function valid()
 144     {
 145         return $this->baseIterator->valid();
 146     }
 147
 148     /**
 149      * Rewind the Iterator to the first element.
 150      *
 151      * @return void
 152      */
 153     public function rewind()
 154     {
 155         return $this->baseIterator->rewind();
 156     }
 157 }