SearchResult

SearchResult.php : 16 Copy path

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¶

$items ¶

SearchResult.php : 28 Copy path

The value objects found for the query.

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

$totalCount ¶

SearchResult.php : 21 Copy path

The total number of URLs.

public int|null $totalCount = 0

Methods¶

__construct() ¶

ValueObject.php : 30 Copy path

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>	[]	-

getIterator() ¶

SearchResult.php : 33 Copy path

{@inheritdoc}

public getIterator() : Traversable

Return values

Traversable

getProperties() ¶

ValueObject.php : 50 Copy path

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>