interface/modules/zend_modules/library/Zend/Cache/Storage/Adapter/ApcIterator.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-2013 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 APCIterator as BaseApcIterator;
  13 use Zend\Cache\Storage\IteratorInterface;
  14
  15 class ApcIterator implements IteratorInterface
  16 {
  17
  18     /**
  19      * The apc storage instance
  20      *
  21      * @var Apc
  22      */
  23     protected $storage;
  24
  25     /**
  26      * The iterator mode
  27      *
  28      * @var int
  29      */
  30     protected $mode = IteratorInterface::CURRENT_AS_KEY;
  31
  32     /**
  33      * The base APCIterator instance
  34      *
  35      * @var BaseApcIterator
  36      */
  37     protected $baseIterator;
  38
  39     /**
  40      * The length of the namespace prefix
  41      *
  42      * @var int
  43      */
  44     protected $prefixLength;
  45
  46     /**
  47      * Constructor
  48      *
  49      * @param Apc             $storage
  50      * @param BaseApcIterator $baseIterator
  51      * @param string          $prefix
  52      */
  53     public function __construct(Apc $storage, BaseApcIterator $baseIterator, $prefix)
  54     {
  55         $this->storage      = $storage;
  56         $this->baseIterator = $baseIterator;
  57         $this->prefixLength = strlen($prefix);
  58     }
  59
  60     /**
  61      * Get storage instance
  62      *
  63      * @return Apc
  64      */
  65     public function getStorage()
  66     {
  67         return $this->storage;
  68     }
  69
  70     /**
  71      * Get iterator mode
  72      *
  73      * @return int Value of IteratorInterface::CURRENT_AS_*
  74      */
  75     public function getMode()
  76     {
  77         return $this->mode;
  78     }
  79
  80     /**
  81      * Set iterator mode
  82      *
  83      * @param int $mode
  84      * @return ApcIterator Fluent interface
  85      */
  86     public function setMode($mode)
  87     {
  88         $this->mode = (int) $mode;
  89         return $this;
  90     }
  91
  92     /* Iterator */
  93
  94     /**
  95      * Get current key, value or metadata.
  96      *
  97      * @return mixed
  98      */
  99     public function current()
 100     {
 101         if ($this->mode == IteratorInterface::CURRENT_AS_SELF) {
 102             return $this;
 103         }
 104
 105         $key = $this->key();
 106
 107         if ($this->mode == IteratorInterface::CURRENT_AS_VALUE) {
 108             return $this->storage->getItem($key);
 109         } elseif ($this->mode == IteratorInterface::CURRENT_AS_METADATA) {
 110             return $this->storage->getMetadata($key);
 111         }
 112
 113         return $key;
 114     }
 115
 116     /**
 117      * Get current key
 118      *
 119      * @return string
 120      */
 121     public function key()
 122     {
 123         $key = $this->baseIterator->key();
 124
 125         // remove namespace prefix
 126         return substr($key, $this->prefixLength);
 127     }
 128
 129     /**
 130      * Move forward to next element
 131      *
 132      * @return void
 133      */
 134     public function next()
 135     {
 136         $this->baseIterator->next();
 137     }
 138
 139     /**
 140      * Checks if current position is valid
 141      *
 142      * @return bool
 143      */
 144     public function valid()
 145     {
 146         return $this->baseIterator->valid();
 147     }
 148
 149     /**
 150      * Rewind the Iterator to the first element.
 151      *
 152      * @return void
 153      */
 154     public function rewind()
 155     {
 156         return $this->baseIterator->rewind();
 157     }
 158 }