SuggestionCollection

SuggestionCollection.php : 19 Copy path

Extends MutableArrayList

Properties¶

$items ¶

AbstractInMemoryCollection.php : 24 Copy path

protected array<string|int, mixed> $items

Methods¶

__construct() ¶

SuggestionCollection.php : 23 Copy path

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

Parameters

Name	Type	Default value	Description
$items	array<string\|int, mixed>	[]	-
$totalCount	int	0	-

append() ¶

SuggestionCollection.php : 33 Copy path

public append(mixed $item) : void

Parameters

Name	Type	Default value	Description
$item	mixed	-	-

clear() ¶

MutableArrayList.php : 37 Copy path

public clear() : void

contains() ¶

ArrayList.php : 50 Copy path

public contains(mixed $value) : bool

Parameters

Name	Type	Default value	Description
$value	mixed	-	-

Return values

bool

count() ¶

AbstractInMemoryCollection.php : 49 Copy path

public count() : int

Return values

int

decreaseTotalCount() ¶

SuggestionCollection.php : 65 Copy path

public decreaseTotalCount(int $totalCount) : void

Parameters

Name	Type	Default value	Description
$totalCount	int	-	-

exists() ¶

AbstractInMemoryCollection.php : 81 Copy path

Tests the existence of an element that satisfies the given predicate.

public exists(Closure $predicate) : bool

Parameters

Name	Type	Default value	Description
$predicate	Closure	-	-

Return values

bool

filter() ¶

AbstractInMemoryCollection.php : 57 Copy path

Returns all the elements of this collection that satisfy the predicate.

public filter(Closure $predicate) : self

Parameters

Name	Type	Default value	Description
$predicate	Closure	-	-

Return values

self

first() ¶

ArrayList.php : 29 Copy path

Return first element of collection.

public first() : TValue

Return values

TValue

forAll() ¶

AbstractInMemoryCollection.php : 70 Copy path

Tests whether the given predicate holds for all elements of this collection.

public forAll(Closure $predicate) : bool

Parameters

Name	Type	Default value	Description
$predicate	Closure	-	-

Return values

bool

getIterator() ¶

AbstractInMemoryCollection.php : 44 Copy path

public getIterator() : Iterator

Return values

Iterator

getTotalCount() ¶

SuggestionCollection.php : 70 Copy path

public getTotalCount() : int

Return values

int

increaseTotalCount() ¶

SuggestionCollection.php : 60 Copy path

public increaseTotalCount(int $totalCount) : void

Parameters

Name	Type	Default value	Description
$totalCount	int	-	-

isEmpty() ¶

AbstractInMemoryCollection.php : 34 Copy path

public isEmpty() : bool

Return values

bool

last() ¶

ArrayList.php : 38 Copy path

Return last element of collection.

public last() : TValue

Return values

TValue

map() ¶

AbstractInMemoryCollection.php : 65 Copy path

Applies the given function to each element in the collection and returns a new collection with the elements returned by the function.

public map(Closure $function) : self

Parameters

Name	Type	Default value	Description
$function	Closure	-	-

Return values

self

prepend() ¶

MutableArrayList.php : 24 Copy path

public prepend(mixed $value) : void

Parameters

Name	Type	Default value	Description
$value	mixed	-	-

remove() ¶

MutableArrayList.php : 29 Copy path

public remove(mixed $value) : void

Parameters

Name	Type	Default value	Description
$value	mixed	-	-

sortByScore() ¶

SuggestionCollection.php : 50 Copy path

public sortByScore() : void

toArray() ¶

AbstractInMemoryCollection.php : 39 Copy path

public toArray() : array<string|int, TValue>

Return values

array<string|int, TValue>

truncate() ¶

SuggestionCollection.php : 55 Copy path

public truncate(int $count) : void

Parameters

Name	Type	Default value	Description
$count	int	-	-

createFrom() ¶

MutableArrayList.php : 42 Copy path

protected createFrom(array<string|int, mixed> $items) : MutableArrayList

Parameters

Name	Type	Default value	Description
$items	array<string\|int, mixed>	-	-

Return values

MutableArrayList