DbaIterator
in package
implements
IteratorInterface
Interfaces, Classes, Traits and Enums
Table of Contents
- $currentInternalKey : string|bool
- The current internal key
- $handle : resource
- The dba resource handle
- $mode : int
- The iterator mode
- $prefixLength : int
- The length of the namespace prefix
- $storage : Dba
- The apc storage instance
- __construct() : mixed
- Constructor
- current() : mixed
- Get current key, value or metadata.
- getMode() : int
- Get iterator mode
- getStorage() : Dba
- Get storage instance
- key() : string
- Get current key
- next() : void
- Move forward to next element
- rewind() : void
- Rewind the Iterator to the first element.
- setMode() : DbaIterator
- Set iterator mode
- valid() : bool
- Checks if current position is valid
Properties
$currentInternalKey
The current internal key
protected
string|bool
$currentInternalKey
$handle
The dba resource handle
protected
resource
$handle
$mode
The iterator mode
protected
int
$mode
= \Zend\Cache\Storage\IteratorInterface::CURRENT_AS_KEY
$prefixLength
The length of the namespace prefix
protected
int
$prefixLength
$storage
The apc storage instance
protected
Dba
$storage
Methods
__construct()
Constructor
public
__construct(Dba $storage, resource $handle, string $prefix) : mixed
Parameters
- $storage : Dba
- $handle : resource
- $prefix : string
Return values
mixed —current()
Get current key, value or metadata.
public
current() : mixed
Tags
Return values
mixed —getMode()
Get iterator mode
public
getMode() : int
Return values
int —Value of IteratorInterface::CURRENT_AS_*
getStorage()
Get storage instance
public
getStorage() : Dba
Return values
Dba —key()
Get current key
public
key() : string
Tags
Return values
string —next()
Move forward to next element
public
next() : void
Tags
Return values
void —rewind()
Rewind the Iterator to the first element.
public
rewind() : void
Tags
Return values
void —setMode()
Set iterator mode
public
setMode(int $mode) : DbaIterator
Parameters
- $mode : int
Return values
DbaIterator —Provides a fluent interface
valid()
Checks if current position is valid
public
valid() : bool