Reader
abstract class Reader implements Countable, ArrayAccess, Iterator (View source)
Base of the reader classes.
Properties
| protected mixed | $currentItem | The current item in use by the iterator. |
|
| protected int | $currentPosition | The current position of the iterator. |
|
| protected array | $items | The items from which the reader can read. |
|
| protected callable|null | $offsetGetFormatter | A custom function to format the items in the list. |
Methods
Set the item output formatter.
Get the number of items in this reader.
Get the key of the current element.
Move forward to next element.
Rewind the iterator to the first element.
Checks if current iterator position is valid.
Check if an offset($key) exists.
Get the item at offset($key).
Set/Add an item.
Unset an item from the list.
Details
abstract Reader
loadData()
Loads the data into the reader.
Reader
setOffsetGetFormatter(callable $callable)
Set the item output formatter.
$filesPath = "/home/nisse/storeage";
$readerObj = new CustomReader();
$readerObj->setOffsetGetFormatter(function($item) use ($filesPath){
return $filesPath.DIRECTORY_SEPARATOR.$item;
});
$readerObj->offsetSet(0, 'file0.txt');
$file0 = $readerObj->current();
// echo $file0; // == /home/nisse/storeage/file0.txt
int
count()
Get the number of items in this reader.
Reader
current()
Get the current element.
int
key()
Get the key of the current element.
void
next()
Move forward to next element.
void
rewind()
Rewind the iterator to the first element.
bool
valid()
Checks if current iterator position is valid.
bool
offsetExists(mixed $key)
Check if an offset($key) exists.
mixed
offsetGet(mixed $key)
Get the item at offset($key).
void
offsetSet(mixed $key, mixed $value)
Set/Add an item.
void
offsetUnset(mixed $key)
Unset an item from the list.