ICanBoogie/Storage 2.1.x
  • Namespace
  • Class

Namespaces

  • ICanBoogie
    • Storage
      • Codec
      • Storage

Classes

  • APCStorage
  • CacheCollection
  • FileStorage
  • FileStorageIterator
  • RedisStorage
  • RunTimeStorage
  • StorageCollection

Interfaces

  • Cache
  • Codec
  • Storage
 1  2  3  4  5  6  7  8  9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 
<?php

/*
 * This file is part of the ICanBoogie package.
 *
 * (c) Olivier Laviale <olivier.laviale@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace ICanBoogie\Storage;

/**
 * Iterates through a file storage.
 *
 * The iterator is usually created using the {@link FileStorage::matching()} method.
 *
 * The iterator can also be used to delete matching keys.
 */
class FileStorageIterator implements \Iterator
{
    /**
     * Iterator.
     *
     * @var \Iterator
     */
    protected $iterator;

    public function __construct(\Iterator $iterator)
    {
        $this->iterator = $iterator;
    }

    /**
     * Returns the directory iterator.
     *
     * Dot files are skipped.
     *
     * @return \DirectoryIterator
     */
    public function current()
    {
        $file = $this->iterator->current();

        if ($file->isDot())
        {
            $this->iterator->next();

            $file = $this->current();
        }

        return $file;
    }

    public function next()
    {
        $this->iterator->next();
    }

    /**
     * Returns the pathname of the key.
     *
     * @return string
     */
    public function key()
    {
        return $this->iterator->current()->getFilename();
    }

    public function valid()
    {
        return $this->iterator->valid();
    }

    public function rewind()
    {
        $this->iterator->rewind();
    }

    /**
     * Deletes the key found by the iterator.
     */
    public function delete()
    {
        foreach ($this->iterator as $file)
        {
            unlink($file->getPathname());
        }
    }
}
ICanBoogie/Storage 2.1.x API documentation generated by ApiGen