Copied!

SearchResult

SearchResult.php : 15
Extends ValueObject
Implements IteratorAggregate

The base class for all value objects and structs.

Supports readonly properties by marking them as protected. In this case they will only be writable using constructor, and need to be documented using property-read <$var> annotation in class doc in addition to inline property doc. Writable properties must be public and must be documented inline.

Properties

public $count

SearchResult.php : 40

The total number of Trash items.

 
public int $count = 0
Tags
Deprecated

Property is here purely for BC with 5.x/6.x.

public $items

SearchResult.php : 47

The Trash items found for the query.

 
public array<string|int, TrashItem> $items = []

public $totalCount

SearchResult.php : 31

The total number of Trash items.

 
public int $totalCount = 0

Methods

public__construct()

SearchResult.php : 17

Construct object optionally with a set of properties.

 
public __construct([array<string|int, mixed> $properties = [] ])

Readonly properties values must be set using $properties as they are not writable anymore after object has been created.

Parameters

Name Type Default value Description
$properties array<string|int, mixed> [] -

publicgetIterator()

SearchResult.php : 49 
public getIterator() : Traversable

Return values

Traversable

protectedgetProperties()

ValueObject.php : 50

Function where list of properties are returned.

 
protected getProperties([array<string|int, mixed> $dynamicProperties = [] ]) : array<string|int, mixed>

Used by attributes(), override to add dynamic properties

Parameters

Name Type Default value Description
$dynamicProperties array<string|int, mixed> []

Additional dynamic properties exposed on the object

Return values

array<string|int, mixed>