AbstractFileCollection
extends AbstractLazyCollection
in package
implements
FileCollectionInterface
Collection of objects stored into a filesystem.
Tags
Table of Contents
Interfaces
- FileCollectionInterface
- Collection of objects stored into a filesystem.
Properties
- $collection : mixed
- $createObjectFunction : callable
- $filterFunction : callable|null
- $flags : int
- $iterator : RecursiveDirectoryIterator|RecursiveUniformResourceIterator
- $nestingLimit : int
- $path : string
Methods
- chunk() : array<string|int, mixed>
- Split collection into chunks.
- getPath() : string
- jsonSerialize() : array<string|int, mixed>
- matching() : ArrayCollection
- reverse() : CollectionInterface
- Reverse the order of the items.
- select() : CollectionInterface
- Select items from collection.
- shuffle() : CollectionInterface
- Shuffle items.
- unselect() : CollectionInterface
- Un-select items from collection.
- __construct() : mixed
- addFilter() : $this
- createObject() : object
- doInitialize() : mixed
- {@inheritDoc}
- doInitializeByIterator() : array<string|int, mixed>
- doInitializeChildren() : array<string|int, mixed>
- setIterator() : void
Properties
$collection
protected
mixed
$collection
Tags
$createObjectFunction
protected
callable
$createObjectFunction
$filterFunction
protected
callable|null
$filterFunction
$flags
protected
int
$flags
$iterator
protected
RecursiveDirectoryIterator|RecursiveUniformResourceIterator
$iterator
$nestingLimit
protected
int
$nestingLimit
$path
protected
string
$path
Methods
chunk()
Split collection into chunks.
public
chunk(mixed $size) : array<string|int, mixed>
Parameters
- $size : mixed
-
Size of each chunk.
Return values
array<string|int, mixed>getPath()
public
getPath() : string
Return values
stringjsonSerialize()
public
jsonSerialize() : array<string|int, mixed>
Attributes
- #[ReturnTypeWillChange]
Return values
array<string|int, mixed>matching()
public
matching(Criteria $criteria) : ArrayCollection
Parameters
- $criteria : Criteria
Tags
Return values
ArrayCollectionreverse()
Reverse the order of the items.
public
reverse() : CollectionInterface
Tags
Return values
CollectionInterfaceselect()
Select items from collection.
public
select(array<string|int, mixed> $keys) : CollectionInterface
Parameters
- $keys : array<string|int, mixed>
Tags
Return values
CollectionInterfaceshuffle()
Shuffle items.
public
shuffle() : CollectionInterface
Tags
Return values
CollectionInterfaceunselect()
Un-select items from collection.
public
unselect(array<string|int, mixed> $keys) : CollectionInterface
Parameters
- $keys : array<string|int, mixed>
Tags
Return values
CollectionInterface__construct()
protected
__construct(string $path) : mixed
Parameters
- $path : string
addFilter()
protected
addFilter(callable $filterFunction) : $this
Parameters
- $filterFunction : callable
Return values
$thiscreateObject()
protected
createObject(RecursiveDirectoryIterator $file) : object
Parameters
- $file : RecursiveDirectoryIterator
Return values
objectdoInitialize()
{@inheritDoc}
protected
doInitialize() : mixed
doInitializeByIterator()
protected
doInitializeByIterator(SeekableIterator $iterator, int $nestingLimit) : array<string|int, mixed>
Parameters
- $iterator : SeekableIterator
- $nestingLimit : int
Tags
Return values
array<string|int, mixed>doInitializeChildren()
protected
doInitializeChildren(array<string|int, mixed> $children, int $nestingLimit) : array<string|int, mixed>
Parameters
- $children : array<string|int, mixed>
- $nestingLimit : int
Return values
array<string|int, mixed>setIterator()
protected
setIterator() : void