interface/modules/zend_modules/library/Zend/Cache/Storage/Adapter/FilesystemIterator.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 GlobIterator;
  13 use Zend\Cache\Storage\IteratorInterface;
  14
  15 class FilesystemIterator implements IteratorInterface
  16 {
  17
  18     /**
  19      * The Filesystem storage instance
  20      *
  21      * @var Filesystem
  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 GlobIterator instance
  34      *
  35      * @var GlobIterator
  36      */
  37     protected $globIterator;
  38
  39     /**
  40      * The namespace sprefix
  41      *
  42      * @var string
  43      */
  44     protected $prefix;
  45
  46     /**
  47      * String length of namespace prefix
  48      *
  49      * @var int
  50      */
  51     protected $prefixLength;
  52
  53     /**
  54      * Constructor
  55      *
  56      * @param Filesystem  $storage
  57      * @param string      $path
  58      * @param string      $prefix
  59      */
  60     public function __construct(Filesystem $storage, $path, $prefix)
  61     {
  62         $this->storage      = $storage;
  63         $this->globIterator = new GlobIterator($path, GlobIterator::KEY_AS_FILENAME);
  64         $this->prefix       = $prefix;
  65         $this->prefixLength = strlen($prefix);
  66     }
  67
  68     /**
  69      * Get storage instance
  70      *
  71      * @return Filesystem
  72      */
  73     public function getStorage()
  74     {
  75         return $this->storage;
  76     }
  77
  78     /**
  79      * Get iterator mode
  80      *
  81      * @return int Value of IteratorInterface::CURRENT_AS_*
  82      */
  83     public function getMode()
  84     {
  85         return $this->mode;
  86     }
  87
  88     /**
  89      * Set iterator mode
  90      *
  91      * @param int $mode
  92      * @return FilesystemIterator Fluent interface
  93      */
  94     public function setMode($mode)
  95     {
  96         $this->mode = (int) $mode;
  97         return $this;
  98     }
  99
 100     /* Iterator */
 101
 102     /**
 103      * Get current key, value or metadata.
 104      *
 105      * @return mixed
 106      */
 107     public function current()
 108     {
 109         if ($this->mode == IteratorInterface::CURRENT_AS_SELF) {
 110             return $this;
 111         }
 112
 113         $key = $this->key();
 114
 115         if ($this->mode == IteratorInterface::CURRENT_AS_VALUE) {
 116             return $this->storage->getItem($key);
 117         } elseif ($this->mode == IteratorInterface::CURRENT_AS_METADATA) {
 118             return $this->storage->getMetadata($key);
 119         }
 120
 121         return $key;
 122     }
 123
 124     /**
 125      * Get current key
 126      *
 127      * @return string
 128      */
 129     public function key()
 130     {
 131         $filename = $this->globIterator->key();
 132
 133         // return without namespace prefix and file suffix
 134         return substr($filename, $this->prefixLength, -4);
 135     }
 136
 137     /**
 138      * Move forward to next element
 139      *
 140      * @return void
 141      */
 142     public function next()
 143     {
 144         $this->globIterator->next();
 145     }
 146
 147     /**
 148      * Checks if current position is valid
 149      *
 150      * @return bool
 151      */
 152     public function valid()
 153     {
 154         try {
 155             return $this->globIterator->valid();
 156         } catch (\LogicException $e) {
 157             // @link https://bugs.php.net/bug.php?id=55701
 158             // GlobIterator throws LogicException with message
 159             // 'The parent constructor was not called: the object is in an invalid state'
 160             return false;
 161         }
 162     }
 163
 164     /**
 165      * Rewind the Iterator to the first element.
 166      *
 167      * @return bool false if the operation failed.
 168      */
 169     public function rewind()
 170     {
 171         try {
 172             return $this->globIterator->rewind();
 173         } catch (\LogicException $e) {
 174             // @link https://bugs.php.net/bug.php?id=55701
 175             // GlobIterator throws LogicException with message
 176             // 'The parent constructor was not called: the object is in an invalid state'
 177             return false;
 178         }
 179     }
 180 }