Class FilesystemIterator

Summary

Fully Qualified Name: Zend\Cache\Storage\Adapter\FilesystemIterator
Implements: IteratorInterface

Description

Methods

Name Description Defined By
__construct() Constructor FilesystemIterator
current() Get current key, value or metadata. FilesystemIterator
getMode() Get iterator mode FilesystemIterator
getStorage() Get storage instance FilesystemIterator
key() Get current key FilesystemIterator
next() Move forward to next element FilesystemIterator
rewind() Rewind the Iterator to the first element. FilesystemIterator
setMode() Set iterator mode FilesystemIterator
valid() Checks if current position is valid FilesystemIterator

Method Details

__construct()

Constructor

Parameter Name Type Description
$storage \Filesystem
$path string
$prefix string

Returns:

current()

Get current key, value or metadata.

Returns: mixed

getMode()

Get iterator mode

Returns: int Value of IteratorInterface::CURRENT_AS_*

getStorage()

Get storage instance

Returns: \Filesystem

key()

Get current key

Returns: string

next()

Move forward to next element

Returns: void

rewind()

Rewind the Iterator to the first element.

Returns: bool false if the operation failed.

setMode()

Set iterator mode

Parameter Name Type Description
$mode int

Returns: \FilesystemIterator Provides a fluent interface

valid()

Checks if current position is valid

Returns: bool

Top