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