| Current File : /var/www/vinorea/modules/psxdesign/vendor/jetbrains/phpstorm-stubs/ds/ds.php |
<?php
/**
* PHP Data Structure stubs, a PECL extension
* @version 1.0.0
* @author Dominic Guhl <dominic.guhl@posteo.de>
* @copyright © 2019 PHP Documentation Group
* @license CC-BY 3.0, https://www.php.net/manual/en/cc.license.php
*/
namespace Ds;
use ArrayAccess;
use Countable;
use IteratorAggregate;
use JsonSerializable;
use OutOfBoundsException;
use OutOfRangeException;
use Traversable;
use UnderflowException;
/**
* Collection is the base interface which covers functionality common to all
* the data structures in this library. It guarantees that all structures
* are traversable, countable, and can be converted to json using
* json_encode().
* @package Ds
*
* @template-covariant TKey
* @template-covariant TValue
* @extends IteratorAggregate<TKey, TValue>
*/
interface Collection extends Countable, IteratorAggregate, JsonSerializable
{
/**
* Removes all values from the collection.
* @link https://www.php.net/manual/en/ds-collection.clear.php
*/
public function clear(): void;
/**
* Returns a shallow copy of the collection.
* @link https://www.php.net/manual/en/ds-collection.copy.php
* @return Collection<TKey, TValue>
*/
public function copy();
/**
* Returns whether the collection is empty.
* @link https://www.php.net/manual/en/ds-collection.isempty.php
* @return bool
*/
public function isEmpty(): bool;
/**
* Converts the collection to an array.
* <p><b>Note:</b> Casting to an array is not supported yet.</p>
* @link https://www.php.net/manual/en/ds-collection.toarray.php
* @return array<TValue> An array containing all the values in the same order as
* the collection.
*/
public function toArray(): array;
}
/**
* Hashable is an interface which allows objects to be used as keys. It’s
* an alternative to spl_object_hash(), which determines an object’s hash
* based on its <b>handle:</b> this means that two objects that are considered
* equal by an implicit definition would not treated as equal because they
* are not the same instance.
*
* hash() is used to return a scalar value to be used as the object's hash
* value, which determines where it goes in the hash table. While this value
* does not have to be unique, objects which are equal must have the same
* hash value.
*
* equals() is used to determine if two objects are equal. It's guaranteed
* that the comparing object will be an instance of the same class as the
* subject.
* @package Ds
*/
interface Hashable
{
/**
* Determines whether another object is equal to the current instance.
*
* This method allows objects to be used as keys in structures such as
* Ds\Map and Ds\Set, or any other lookup structure that honors this
* interface.
*
* <b>Note:</b> It's guaranteed that $obj is an instance of the same class.
*
* <b>Caution:</b> It's important that objects which are equal also have the
* same hash value.
* @see https://www.php.net/manual/en/ds-hashable.hash.php
* @link https://www.php.net/manual/en/ds-hashable.equals.php
* @param object $obj The object to compare the current instance to,
* which is always an instance of the same class.
*
* @return bool True if equal, false otherwise.
*/
public function equals($obj): bool;
/**
* Returns a scalar value to be used as the hash value of the objects.
*
* While the hash value does not define equality, all objects that are
* equal according to Ds\Hashable::equals() must have the same hash
* value. Hash values of equal objects don't have to be unique, for
* example you could just return TRUE for all objects and nothing
* would break - the only implication would be that hash tables then
* turn into linked lists because all your objects will be hashed to
* the same bucket. It's therefore very important that you pick a good
* hash value, such as an ID or email address.
*
* This method allows objects to be used as keys in structures such as
* Ds\Map and Ds\Set, or any other lookup structure that honors this
* interface.
*
* <b>Caution:</b> Do not pick a value that might change within the object,
* such as a public property. Hash table lookups would fail because
* the hash has changed.
*
* <b>Caution:</b> All objects that are equal must have the same hash value.
*
* @return mixed A scalar value to be used as this object's hash value.
* @link https://www.php.net/manual/en/ds-hashable.hash.php
*/
public function hash();
}
/**
* A Sequence describes the behaviour of values arranged in a single,
* linear dimension. Some languages refer to this as a "List". It’s
* similar to an array that uses incremental integer keys, with the
* exception of a few characteristics:
* <ul>
* <li>Values will always be indexed as [0, 1, 2, …, size - 1].</li>
* <li>Only allowed to access values by index in the range [0, size - 1].</li>
* </ul>
* <br>
* Use cases:
* <ul>
* <li>Wherever you would use an array as a list (not concerned with keys).</li>
* <li>A more efficient alternative to SplDoublyLinkedList and SplFixedArray.</li>
* </ul>
* @package Ds
* @template TValue
* @extends Collection<int, TValue>
*/
interface Sequence extends Collection, ArrayAccess
{
/**
* Ensures that enough memory is allocated for a required capacity.
* This removes the need to reallocate the internal as values are added.
*
* @param int $capacity The number of values for which capacity should
* be allocated.<p><b>Note:</b> Capacity will stay the same if this value is
* less than or equal to the current capacity.</p>
* @link https://www.php.net/manual/en/ds-sequence.allocate.php
*/
public function allocate(int $capacity): void;
/**
* Updates all values by applying a callback function to each value in
* the sequence.
* @param callable(TValue): TValue $callback A callable to apply to each value in the
* sequence. The callback should return what the value should be
* replaced by.
* <code>callback ( mixed $value ) : mixed</code>
* @link https://www.php.net/manual/en/ds-sequence.apply.php
*/
public function apply(callable $callback): void;
/**
* Returns the current capacity.
* @return int The current capacity.
* @link https://www.php.net/manual/en/ds-sequence.capacity.php
*/
public function capacity(): int;
/**
* Determines if the sequence contains all values.
* @param TValue ...$values Values to check.
* @return bool FALSE if any of the provided values are not in the
* sequence, TRUE otherwise.
* @link https://www.php.net/manual/en/ds-sequence.contains.php
*/
public function contains(...$values): bool;
/**
* Creates a new sequence using a callable to determine which values
* to include.
* @param null|callable(TValue): bool $callback Optional callable which returns TRUE if the
* value should be included, FALSE otherwise. If a callback is not
* provided, only values which are TRUE (see converting to boolean) will
* be included.
* <code>callback ( mixed $value ) : bool</code>
* @return Sequence<TValue> A new sequence containing all the values for which
* either the callback returned TRUE, or all values that convert to
* TRUE if a callback was not provided.
* @link https://www.php.net/manual/en/ds-sequence.filter.php
*/
public function filter(?callable $callback = null);
/**
* Returns the index of the value, or FALSE if not found.
* @param TValue $value The value to find.
* @return int|false The index of the value, or FALSE if not found.
* @link https://www.php.net/manual/en/ds-sequence.find.php
*/
public function find($value);
/**
* Returns the first value in the sequence.
* @return TValue The first value in the sequence.
* @throws UnderflowException if empty.
* @link https://www.php.net/manual/en/ds-sequence.first.php
*/
public function first();
/**
* Returns the value at a given index.
* @param int $index The index to access, starting at 0.
* @return TValue The value at the requested index.
* @throws OutOfRangeException if the index is not valid.
* @link https://www.php.net/manual/en/ds-sequence.get.php
*/
public function get(int $index);
/**
* Inserts values into the sequence at a given index.
*
* @param int $index The index at which to insert. 0 <= index <= count
* <p><b>Note:</b> You can insert at the index equal to the number of values.</p>
* @param TValue ...$values The value or values to insert.
* @throws OutOfRangeException if the index is not valid.
* @link https://www.php.net/manual/en/ds-sequence.insert.php
*/
public function insert(int $index, ...$values): void;
/**
* Joins all values together as a string using an optional separator
* between each value.
* @param string $glue An optional string to separate each value.
* @return string All values of the sequence joined together as a
* string.
* @link https://www.php.net/manual/en/ds-sequence.join.php
*/
public function join(string $glue = ''): string;
/**
* Returns the last value in the sequence.
* @return TValue The last value in the sequence.
* @throws UnderflowException if empty.
* @link https://www.php.net/manual/en/ds-sequence.last.php
*/
public function last();
/**
* Returns the result of applying a callback function to each value in
* the sequence.
* @template TNewValue
* @param callable(TValue): TNewValue $callback A callable to apply to each value in the
* sequence.
* The callable should return what the new value will be in the new
* sequence.
* <code>callback ( mixed $value ) : mixed</code>
* @return Sequence<TNewValue> The result of applying a callback to each value in
* the sequence.<p><b>Note:</b> The values of the current instance won't be
* affected.</p>
* @link https://www.php.net/manual/en/ds-sequence.map.php
*/
public function map(callable $callback): Sequence;
/**
* Returns the result of adding all given values to the sequence.
* @template TValue2
* @param iterable<TValue2> $values A traversable object or an array.
* @return Sequence<TValue|TValue2> The result of adding all given values to the
* sequence, effectively the same as adding the values to a copy,
* then returning that copy.
* @link https://www.php.net/manual/en/ds-sequence.merge.php
*/
public function merge($values): Sequence;
/**
* Removes and returns the last value.
* @return TValue The removed last value.
* @throws UnderflowException if empty.
* @link https://www.php.net/manual/en/ds-sequence.pop.php
*/
public function pop();
/**
* Adds values to the end of the sequence.
* @param TValue ...$values The values to add.
*/
public function push(...$values): void;
/**
* Reduces the sequence to a single value using a callback function.
* @template TCarry
* @param callable(TCarry, TValue): TCarry $callback <p>
* <code>
* callback ( mixed $carry , mixed $value ) : mixed</code>
* <b>$carry</b> The return value of the previous callback, or initial if it's
* the first iteration.<br>
* <b>$value</b> The value of the current iteration.
* </p>
* @param TCarry $initial The initial value of the carry value. Can be NULL.
* @return TCarry The return value of the final callback.
* @link https://www.php.net/manual/en/ds-sequence.reduce.php
*/
public function reduce(callable $callback, $initial = null);
/**
* Removes and returns a value by index.
* @param int $index The index of the value to remove.
* @return TValue The value that was removed.
* @link https://www.php.net/manual/en/ds-sequence.remove.php
*/
public function remove(int $index);
/**
* Reverses the sequence in-place.
* @link https://www.php.net/manual/en/ds-sequence.reverse.php
*/
public function reverse(): void;
/**
* Returns a reversed copy of the sequence.
* @return Sequence<TValue> A reversed copy of the sequence.
* <p><b>Note:</b> The current instance is not affected.</p>
*/
public function reversed();
/**
* Rotates the sequence by a given number of rotations, which is
* equivalent to successively calling
* $sequence->push($sequence->shift()) if the number of rotations is
* positive, or $sequence->unshift($sequence->pop()) if negative.
* @param int $rotations The number of times the sequence should be
* rotated.
* @link https://www.php.net/manual/en/ds-sequence.rotate.php
*/
public function rotate(int $rotations): void;
/**
* Updates a value at a given index.
* @param int $index The index of the value to update.
* @param TValue $value The new value.
* @throws OutOfRangeException if the index is not valid.
* @link https://www.php.net/manual/en/ds-sequence.set.php
*/
public function set(int $index, $value): void;
/**
* Removes and returns the first value.
* @return TValue
* @throws UnderflowException if empty.
* @link https://www.php.net/manual/en/ds-sequence.shift.php
*/
public function shift();
/**
* Creates a sub-sequence of a given range.
* @param int $index The index at which the sub-sequence starts.
* If positive, the sequence will start at that index in the sequence.
* If negative, the sequence will start that far from the end.
* @param int|null $length If a length is given and is positive, the
* resulting sequence will have up to that many values in it. If the
* length results in an overflow, only values up to the end of the
* sequence will be included. If a length is given and is negative,
* the sequence will stop that many values from the end. If a length
* is not provided, the resulting sequence will contain all values
* between the index and the end of the sequence.
* @return Sequence<TValue> A sub-sequence of the given range.
* @link https://www.php.net/manual/en/ds-sequence.slice.php
*/
public function slice(int $index, int $length = null);
/**
* Sorts the sequence in-place, using an optional comparator function.
* @param callable(TValue, TValue): int|null $comparator The comparison function must return
* an integer less than, equal to, or greater than zero if the first
* argument is considered to be respectively less than, equal to, or
* greater than the second. Note that before PHP 7.0.0 this integer had
* to be in the range from -2147483648 to 2147483647.<p>
* <code>callback ( mixed $a, mixed $b ) : int</code></p>
* <p><b>Caution:</b> Returning non-integer values from the comparison
* function, such as float, will result in an internal cast to integer
* of the callback's return value. So values such as 0.99 and 0.1 will
* both be cast to an integer value of 0, which will compare such
* values as equal.</p>
* @link https://www.php.net/manual/en/ds-sequence.sort.php
*/
public function sort(?callable $comparator = null): void;
/**
* Returns a sorted copy, using an optional comparator function.
* @param callable(TValue, TValue): int|null $comparator The comparison function must return
* an integer less than, equal to, or greater than zero if the first
* argument is considered to be respectively less than, equal to, or
* greater than the second. Note that before PHP 7.0.0 this integer had
* to be in the range from -2147483648 to 2147483647.<p>
* <code>callback ( mixed $a, mixed $b ) : int</code></p>
* <p><b>Caution:</b> Returning non-integer values from the comparison
* function, such as float, will result in an internal cast to integer
* of the callback's return value. So values such as 0.99 and 0.1 will
* both be cast to an integer value of 0, which will compare such
* values as equal.</p>
* @return Sequence<TValue> Returns a sorted copy of the sequence.
* @link https://www.php.net/manual/en/ds-sequence.sort.php
*/
public function sorted(?callable $comparator = null);
/**
* Returns the sum of all values in the sequence.
* <p><b>Note:</b> Arrays and objects are considered equal to zero when
* calculating the sum.</p>
* @return float|int The sum of all the values in the sequence as
* either a float or int depending on the values in the sequence.
*/
public function sum(): float|int;
/**
* Adds values to the front of the sequence, moving all the current
* values forward to make room for the new values.
* @param TValue ...$values The values to add to the front of the sequence.
* <p><b>Note:</b> Multiple values will be added in the same order that they
* are passed.</p>
*/
public function unshift(...$values): void;
}
/**
* A Vector is a sequence of values in a contiguous buffer that grows and
* shrinks automatically. It’s the most efficient sequential structure
* because a value’s index is a direct mapping to its index in the buffer,
* and the growth factor isn't bound to a specific multiple or exponent.
* <br><br>
* <p>
* <h3>Strengths
* <ul>
* <li>Supports array syntax (square brackets).</li>
* <li>Uses less overall memory than an array for the same number of values.</li>
* <li>Automatically frees allocated memory when its size drops low enough.</li>
* <li>Capacity does not have to be a power of 2.</li>
* <li>get(), set(), push(), pop() are all O(1)</li>
* </ul>
* </p>
* <h3>Weaknesses
* <ul>
* <li>shift(), unshift(), insert() and remove() are all O(n).</li>
* </ul>
*
* @link https://www.php.net/manual/en/class.ds-vector.php
*
* @package Ds
* @template TValue
* @implements Sequence<TValue>
*/
class Vector implements Sequence
{
public const MIN_CAPACITY = 10;
/**
* Creates a new instance, using either a traversable object or an array for the initial values.
*
* @param array<TValue> $values
*/
public function __construct($values = []) {}
/**
* Ensures that enough memory is allocated for a required capacity.
* This removes the need to reallocate the internal as values are added.
* @param int $capacity The number of values for which capacity should
* be allocated.
* <p><b>Note:</b> Capacity will stay the same if this value is less than or
* equal to the current capacity.</p>
* @link https://www.php.net/manual/en/ds-vector.allocate.php
*/
public function allocate(int $capacity): void {}
/**
* Updates all values by applying a callback function to each value in
* the vector.
* @param callable(TValue): TValue $callback
* <code>callback ( mixed $value ) : mixed</code>
* A callable to apply to each value in the vector. The callback should
* return what the value should be replaced by.
* @link https://www.php.net/manual/en/ds-vector.apply.php
*/
public function apply(callable $callback): void {}
/**
* Returns the current capacity.
* @return int The current capacity.
* @link https://www.php.net/manual/en/ds-vector.capacity.php
*/
public function capacity(): int {}
/**
* Removes all values from the vector.
* @link https://www.php.net/manual/en/ds-vector.clear.php
*/
public function clear(): void {}
/**
* Determines if the vector contains all values.
* @param TValue ...$values Values to check.
* @return bool FALSE if any of the provided values are not in the
* vector, TRUE otherwise.
* @link https://www.php.net/manual/en/ds-vector.contains.php
*/
public function contains(...$values): bool {}
/**
*Returns a shallow copy of the vector.
* @return Vector<TValue> Returns a shallow copy of the vector.
*/
public function copy(): Vector {}
/**
* Creates a new vector using a callable to determine which values to
* include.
*
* @param null|callable(TValue): bool $callback
* Optional callable which returns TRUE if the value should be included,
* FALSE otherwise. If a callback is not provided, only values which are
* TRUE (see converting to boolean) will be included.
* <code>callback ( mixed $value ) : bool</code>
* @return Vector<TValue> A new vector containing all the values for which
* either the callback returned TRUE, or all values that convert to
* TRUE if a callback was not provided.
* @link https://www.php.net/manual/en/ds-vector.filter.php
*/
public function filter(?callable $callback = null): Vector {}
/**
* Returns the index of the value, or FALSE if not found.
* @param TValue $value The value to find.
* @return int|false The index of the value, or FALSE if not found.
* <p><b>Note:</b> Values will be compared by value and by type.</p>
* @link https://www.php.net/manual/en/ds-vector.find.php
*/
public function find($value) {}
/**
* Returns the first value in the vector.
* @return TValue
* @throws UnderflowException if empty.
* @link https://www.php.net/manual/en/ds-vector.first.php
*/
public function first() {}
/**
* Returns the value at a given index.
* @param int $index The index to access, starting at 0.
* @return TValue
* @link https://www.php.net/manual/en/ds-vector.get.php
*/
public function get(int $index) {}
public function getIterator(): Traversable {}
/**
* Inserts values into the sequence at a given index.
*
* @param int $index The index at which to insert. 0 <= index <= count
* Note:<br>
* You can insert at the index equal to the number of values.
* @param array<TValue> ...$values The value or values to insert.
* @link https://www.php.net/manual/en/ds-vector.insert.php
*/
public function insert(int $index, ...$values): void {}
/**
* Joins all values together as a string using an optional separator between each value.
*
* @param string|null $glue An optional string to separate each value.
* @return string All values of the sequence joined together as a string.
* @link https://www.php.net/manual/en/ds-vector.join.php
*/
public function join(?string $glue = null): string {}
/**
* Returns the last value in the sequence.
*
* @return TValue The last value in the sequence.
* @link https://www.php.net/manual/en/ds-vector.last.php
*/
public function last() {}
/**
* Returns the result of applying a callback function to each value in the sequence.
*
* @template TNewValue
* @param callable(TValue): TNewValue $callback A callable to apply to each value in the sequence.
* <br>The callable should return what the new value will be in the new sequence.
*
* @return Vector<TNewValue>
* @link https://www.php.net/manual/en/ds-vector.map.php
*/
public function map(callable $callback): Vector {}
/**
* Returns the result of adding all given values to the sequence.
*
* @template TValue2
* @param iterable<TValue2> $values A traversable object or an array.
* @return Vector<TValue|TValue2> The result of adding all given values to the sequence, effectively the same as adding the
* values to a copy, then returning that copy.<br>
* Note:<br>
* The current instance won't be affected.
* @link https://www.php.net/manual/en/ds-vector.merge.php
*/
public function merge($values): Vector {}
/**
* Removes and returns the last value.
*
* @return TValue
* @link https://www.php.net/manual/en/ds-vector.pop.php
*/
public function pop() {}
/**
* Adds values to the end of the sequence.
* @param TValue ...$values
* @link https://www.php.net/manual/en/ds-vector.push.php
*/
public function push(...$values): void {}
/**
* Reduces the sequence to a single value using a callback function.
* @template TCarry
* @param callable(TCarry, TValue): TCarry $callback <br>
* <code>callback ( mixed $carry , mixed $value ) : mixed</code><br>
* <b>carry</b> The return value of the previous callback, or initial if it's the first iteration.<br>
* <b>value</b> The value of the current iteration.
* @param TCarry $initial The initial value of the carry value. Can be NULL.
*
* @return TCarry The return value of the final callback.
*
* @link https://www.php.net/manual/en/ds-vector.reduce.php
*/
public function reduce(callable $callback, $initial = null) {}
/**
* Removes and returns a value by index.
* @param int $index The index of the value to remove.
* @return TValue The value that was removed.
* @link https://www.php.net/manual/en/ds-vector.remove.php
*/
public function remove(int $index) {}
/**
* Reverses the sequence in-place.
* @link https://www.php.net/manual/en/ds-vector.reverse.php
*/
public function reverse(): void {}
/**
* Returns a reversed copy of the sequence.
* @return Vector<TValue> A reversed copy of the sequence.<br>
* <b>Note:</b> The current instance is not affected.
* @link https://www.php.net/manual/en/ds-vector.reversed.php
*/
public function reversed(): Vector {}
/**
* Rotates the sequence by a given number of rotations, which is
* equivalent to successively calling $sequence->push($sequence->shift())
* if the number of rotations is positive, or $sequence->unshift($sequence->pop())
* if negative.
*
* @link https://www.php.net/manual/en/ds-vector.rotate.php
*
* @param int $rotations The number of times the sequence should be rotated.
*/
public function rotate(int $rotations): void {}
/**
* Updates a value at a given index.
*
* @link https://www.php.net/manual/en/ds-vector.set.php
*
* @param int $index The index of the value to update.
* @param TValue $value The new value.
*
* @throws OutOfRangeException if the index is not valid.
*/
public function set(int $index, $value): void {}
/**
* Removes and returns the first value.
*
* @link https://www.php.net/manual/en/ds-vector.shift.php
*
* @return TValue The first value, which was removed.
* @throws UnderflowException if empty.
*/
public function shift() {}
/**
* Creates a sub-sequence of a given range.
* @link https://www.php.net/manual/en/ds-vector.slice.php
* @param int $index The index at which the sub-sequence starts. If
* positive, the sequence will start at that
* index in the sequence. If negative, the sequence will start that
* far from the end.
* @param int|null $length If a length is given and is positive, the
* resulting sequence will have up to that many values in it. If the
* length results in an overflow, only values up to the end of the
* sequence will be included. If a length is given and is negative,
* the sequence will stop that many values from the end. If a length
* is not provided, the resulting sequence will contain all values
* between the index and the end of the sequence.
* @return Vector<TValue>
*/
public function slice(int $index, int $length = null): Vector {}
/**
* Sorts the sequence in-place, using an optional comparator function.
* @link https://www.php.net/manual/en/ds-vector.sort.php
* @param callable(TValue, TValue): int|null $comparator The comparison function must return an
* integer less than, equal to, or greater
* than zero if the first argument is considered to be respectively less than, equal to, or greater than the
* second. Note that before PHP 7.0.0 this integer had to be in the
* range from -2147483648 to 2147483647.<br>
* <code>callback ( mixed $a, mixed $b ) : int</code>
* <b>Caution:</b> Returning non-integer values from the comparison function,
* such as float, will result in an
* internal cast to integer of the callback's return value. So values
* such as 0.99 and 0.1 will both be cast to an integer value of 0,
* which will compare such values as equal.
*/
public function sort(?callable $comparator = null): void {}
/**
* Returns a sorted copy, using an optional comparator function.
* @link https://www.php.net/manual/en/ds-vector.sorted.php
* @param callable(TValue, TValue): int|null $comparator The comparison function must return an integer less than, equal to, or
* greater than zero if the first argument is considered to be respectively less than, equal to, or greater
* than the second. Note that before PHP 7.0.0 this integer had to be in the range from -2147483648 to
* 2147483647.<br>
* <code>callback ( mixed $a, mixed $b ) : int</code>
* <b>Caution:</b> Returning non-integer values from the comparison function, such as float, will result in an
* internal cast to integer of the callback's return value. So values such as 0.99 and 0.1 will both be cast to
* an integer value of 0, which will compare such values as equal.
* @return Vector<TValue> Returns a sorted copy of the sequence.
*/
public function sorted(?callable $comparator = null): Vector {}
/**
* Returns the sum of all values in the sequence.<br>
* <b>Note:</b> Arrays and objects are considered equal to zero when
* calculating the sum.
* @link https://www.php.net/manual/en/ds-vector.sum.php
* @return float
*/
public function sum(): float {}
/**
* Adds values to the front of the sequence, moving all the current
* values forward to make room for the new values.
* @param TValue ...$values The values to add to the front of the sequence.<br>
* <b>Note:</b> Multiple values will be added in the same order that they are
* passed.
* @link https://www.php.net/manual/en/ds-vector.unshift.php
*/
public function unshift($values): void {}
/**
* Count elements of an object
* @link https://php.net/manual/en/ds-vector.count.php
* @return int The custom count as an integer.
* <p>
* The return value is cast to an integer.
* </p>
* @since 5.1
*/
public function count(): int {}
/**
* Returns whether the collection is empty.
* @link https://www.php.net/manual/en/ds-vector.isempty.php
* @return bool
*/
public function isEmpty(): bool {}
/**
* Converts the collection to an array.
* <p><b>Note:</b> Casting to an array is not supported yet.</p>
* @link https://www.php.net/manual/en/ds-vector.toarray.php
* @return array<TValue> An array containing all the values in the same order as
* the collection.
*/
public function toArray(): array {}
/**
* Specify data which should be serialized to JSON
* @link https://php.net/manual/en/ds-vector.jsonserialize.php
* @return mixed data which can be serialized by <b>json_encode</b>,
* which is a value of any type other than a resource.
* @since 5.4
*/
public function jsonSerialize() {}
/**
* @param int $offset
*/
public function offsetExists(mixed $offset): bool {}
/**
* @param int $offset
*
* @return TValue
*/
public function offsetGet(mixed $offset) {}
/**
* @param int $offset
* @param TValue $value
*/
public function offsetSet(mixed $offset, mixed $value) {}
/**
* @param int $offset
*/
public function offsetUnset(mixed $offset): void {}
}
/**
* @template TValue
* @implements Sequence<TValue>
*/
class Deque implements Sequence
{
/**
* Creates a new instance, using either a traversable object or an array for the initial values.
* @param TValue ...$values A traversable object or an array to use for the initial values.
*
* @link https://www.php.net/manual/en/ds-deque.construct.php
*/
public function __construct(...$values) {}
/**
* Count elements of an object
* @link https://php.net/manual/en/countable.count.php
* @return int The custom count as an integer.
* <p>
* The return value is cast to an integer.
* </p>
* @since 5.1
*/
public function count(): int {}
/**
* Removes all values from the deque.
* @link https://www.php.net/manual/en/ds-deque.clear.php
*/
public function clear(): void {}
/**
* Returns a shallow copy of the deque.
* @link https://www.php.net/manual/en/ds-deque.copy.php
* @return Deque<TValue>
*/
public function copy(): Collection {}
public function getIterator(): Traversable {}
/**
* Returns whether the deque is empty.
* @link https://www.php.net/manual/en/ds-deque.isempty.php
* @return bool
*/
public function isEmpty(): bool {}
/**
* Converts the deque to an array.
* <p><b>Note:</b> Casting to an array is not supported yet.</p>
* @link https://www.php.net/manual/en/ds-deque.toarray.php
* @return array<TValue> An array containing all the values in the same order as
* the deque.
*/
public function toArray(): array {}
/**
* Ensures that enough memory is allocated for a required capacity.
* This removes the need to reallocate the internal as values are added.
*
* @param int $capacity The number of values for which capacity should
* be allocated.<p><b>Note:</b> Capacity will stay the same if this value is
* less than or equal to the current capacity.</p>
* <p><b>Note:</b> Capacity will always be rounded up to the nearest power of 2.</p>
* @link https://www.php.net/manual/en/ds-deque.allocate.php
*/
public function allocate(int $capacity): void {}
/**
* Updates all values by applying a callback function to each value in
* the deque.
* @param callable(TValue): TValue $callback A callable to apply to each value in the
* deque. The callback should return what the value should be
* replaced by.<p>
* <code>callback ( mixed $value ) : mixed</code>
* </p>
* @link https://www.php.net/manual/en/ds-deque.apply.php
*/
public function apply(callable $callback): void {}
/**
* Returns the current capacity.
* @return int The current capacity.
* @link https://www.php.net/manual/en/ds-deque.capacity.php
*/
public function capacity(): int {}
/**
* Determines if the deque contains all values.
* @param TValue $values Values to check.
* @return bool FALSE if any of the provided values are not in the
* deque, TRUE otherwise.
* @link https://www.php.net/manual/en/ds-deque.contains.php
*/
public function contains(...$values): bool {}
/**
* Creates a new deque using a callable to determine which values
* to include.
* @param null|callable(TValue): bool $callback Optional callable which returns TRUE if the
* value should be included, FALSE otherwise. If a callback is not
* provided, only values which are TRUE (see converting to boolean) will
* be included.<p>
* <code>callback ( mixed $value ) : bool</code>
* </p>
* @return Deque<TValue> A new deque containing all the values for which
* either the callback returned TRUE, or all values that convert to
* TRUE if a callback was not provided.
* @link https://www.php.net/manual/en/ds-deque.filter.php
*/
public function filter(?callable $callback = null): Deque {}
/**
* Returns the index of the value, or FALSE if not found.
* @param TValue $value The value to find.
* @return int|false The index of the value, or FALSE if not found.
* @link https://www.php.net/manual/en/ds-deque.find.php
*/
public function find($value) {}
/**
* Returns the first value in the deque.
* @return TValue The first value in the deque.
* @throws UnderflowException if empty.
* @link https://www.php.net/manual/en/ds-deque.first.php
*/
public function first() {}
/**
* Returns the value at a given index.
* @param int $index The index to access, starting at 0.
* @return TValue The value at the requested index.
* @throws OutOfRangeException if the index is not valid.
* @link https://www.php.net/manual/en/ds-deque.get.php
*/
public function get(int $index) {}
/**
* Inserts values into the deque at a given index.
*
* @param int $index The index at which to insert. 0 <= index <= count
* <p><b>Note:</b> You can insert at the index equal to the number of values.</p>
* @param TValue ...$values The value or values to insert.
* @throws OutOfRangeException if the index is not valid.
* @link https://www.php.net/manual/en/ds-deque.insert.php
*/
public function insert(int $index, ...$values): void {}
/**
* Joins all values together as a string using an optional separator
* between each value.
* @param string $glue An optional string to separate each value.
* @return string All values of the deque joined together as a
* string.
* @link https://www.php.net/manual/en/ds-deque.join.php
*/
public function join(string $glue = ''): string {}
/**
* Returns the last value in the deque.
* @return TValue The last value in the deque.
* @throws UnderflowException if empty.
* @link https://www.php.net/manual/en/ds-deque.last.php
*/
public function last() {}
/**
* Returns the result of applying a callback function to each value in
* the deque.
*
* @template TNewValue
* @param callable(TValue): TNewValue $callback A callable to apply to each value in the
* deque.
* The callable should return what the new value will be in the new
* deque.
* <code>callback ( mixed $value ) : mixed</code>
*
* @return Deque<TNewValue> The result of applying a callback to each value in
* the deque.
* <p><b>Note:</b> The values of the current instance won't be
* affected.</p>
* @link https://www.php.net/manual/en/ds-deque.map.php
*/
public function map(callable $callback): Deque {}
/**
* Returns the result of adding all given values to the deque.
* @template TValue2
* @param iterable<TValue2> $values A traversable object or an array.
* @return Deque<TValue|TValue2> The result of adding all given values to the
* deque, effectively the same as adding the values to a copy,
* then returning that copy.
* @link https://www.php.net/manual/en/ds-deque.merge.php
*/
public function merge($values): Deque {}
/**
* Removes and returns the last value.
* @return TValue The removed last value.
* @throws UnderflowException if empty.
* @link https://www.php.net/manual/en/ds-deque.pop.php
*/
public function pop() {}
/**
* Adds values to the end of the deque.
* @param TValue ...$values The values to add.
*/
public function push(...$values): void {}
/**
* Reduces the deque to a single value using a callback function.
* @template TCarry
* @param callable(TCarry, TValue): TCarry $callback
* <code>callback ( mixed $carry , mixed $value ) : mixed</code>
* <b>$carry</b> The return value of the previous callback, or initial if it's
* the first iteration.<p>
* <b>$value</b> The value of the current iteration.
* </p>
* @param TCarry $initial The initial value of the carry value. Can be NULL.
* @return TCarry The return value of the final callback.
* @link https://www.php.net/manual/en/ds-deque.reduce.php
*/
public function reduce(callable $callback, $initial = null) {}
/**
* Removes and returns a value by index.
* @param int $index The index of the value to remove.
* @return TValue The value that was removed.
* @link https://www.php.net/manual/en/ds-deque.remove.php
*/
public function remove(int $index) {}
/**
* Reverses the deque in-place.
* @link https://www.php.net/manual/en/ds-deque.reverse.php
*/
public function reverse(): void {}
/**
* Returns a reversed copy of the deque.
* @return Deque<TValue> A reversed copy of the deque.
* <p><b>Note:</b> The current instance is not affected.</p>
*/
public function reversed(): Deque {}
/**
* Rotates the deque by a given number of rotations, which is
* equivalent to successively calling
* $deque->push($deque->shift()) if the number of rotations is
* positive, or $deque->unshift($deque->pop()) if negative.
* @param int $rotations The number of times the deque should be
* rotated.
* @link https://www.php.net/manual/en/ds-deque.rotate.php
*/
public function rotate(int $rotations): void {}
/**
* Updates a value at a given index.
* @param int $index The index of the value to update.
* @param TValue $value The new value.
* @throws OutOfRangeException if the index is not valid.
* @link https://www.php.net/manual/en/ds-deque.set.php
*/
public function set(int $index, $value): void {}
/**
* Removes and returns the first value.
* @return TValue
* @throws UnderflowException if empty.
* @link https://www.php.net/manual/en/ds-deque.shift.php
*/
public function shift() {}
/**
* Creates a sub-deque of a given range.
* @param int $index The index at which the sub-deque starts.
* If positive, the deque will start at that index in the deque.
* If negative, the deque will start that far from the end.
* @param int|null $length If a length is given and is positive, the
* resulting deque will have up to that many values in it. If the
* length results in an overflow, only values up to the end of the
* deque will be included. If a length is given and is negative,
* the deque will stop that many values from the end. If a length
* is not provided, the resulting deque will contain all values
* between the index and the end of the deque.
* @return Deque<TValue> A sub-deque of the given range.
* @link https://www.php.net/manual/en/ds-deque.slice.php
*/
public function slice(int $index, int $length = null): Deque {}
/**
* Sorts the deque in-place, using an optional comparator function.
* @param callable(TValue, TValue): int|null $comparator The comparison function must return
* an integer less than, equal to, or greater than zero if the first
* argument is considered to be respectively less than, equal to, or
* greater than the second. Note that before PHP 7.0.0 this integer had
* to be in the range from -2147483648 to 2147483647.
* <code>callback ( mixed $a, mixed $b ) : int</code>
* <p><b>Caution:</b> Returning non-integer values from the comparison
* function, such as float, will result in an internal cast to integer
* of the callback's return value. So values such as 0.99 and 0.1 will
* both be cast to an integer value of 0, which will compare such
* values as equal.</p>
* @link https://www.php.net/manual/en/ds-deque.sort.php
*/
public function sort(?callable $comparator = null): void {}
/**
* Returns a sorted copy, using an optional comparator function.
* @param callable(TValue, TValue): int|null $comparator The comparison function must return
* an integer less than, equal to, or greater than zero if the first
* argument is considered to be respectively less than, equal to, or
* greater than the second. Note that before PHP 7.0.0 this integer had
* to be in the range from -2147483648 to 2147483647.
* <code>callback ( mixed $a, mixed $b ) : int</code>
* <p><b>Caution:</b> Returning non-integer values from the comparison
* function, such as float, will result in an internal cast to integer
* of the callback's return value. So values such as 0.99 and 0.1 will
* both be cast to an integer value of 0, which will compare such
* values as equal.</p>
* @return Deque<TValue> Returns a sorted copy of the deque.
* @link https://www.php.net/manual/en/ds-deque.sort.php
*/
public function sorted(?callable $comparator = null): Deque {}
/**
* Returns the sum of all values in the deque.
* <p><b>Note:</b> Arrays and objects are considered equal to zero when
* calculating the sum.</p>
* @return float|int The sum of all the values in the deque as
* either a float or int depending on the values in the deque.
*/
public function sum(): float|int {}
/**
* Adds values to the front of the deque, moving all the current
* values forward to make room for the new values.
* @param TValue ...$values The values to add to the front of the deque.
* <p><b>Note:</b> Multiple values will be added in the same order that they
* are passed.</p>
*/
public function unshift(...$values): void {}
/**
* Specify data which should be serialized to JSON
* @link https://php.net/manual/en/ds-vector.jsonserialize.php
* @return mixed data which can be serialized by <b>json_encode</b>,
* which is a value of any type other than a resource.
* @since 5.4
*/
public function jsonSerialize() {}
/**
* @param int $offset
*/
public function offsetExists(mixed $offset): bool {}
/**
* @param int $offset
*
* @return TValue
*/
public function offsetGet(mixed $offset) {}
/**
* @param int $offset
* @param TValue $value
*/
public function offsetSet(mixed $offset, mixed $value) {}
/**
* @param int $offset
*/
public function offsetUnset(mixed $offset): void {}
}
/**
* @template TKey
* @template TValue
* @implements Collection<TKey, TValue>
*/
class Map implements Collection, ArrayAccess
{
/**
* Creates a new instance, using either a traversable object or an array for the initial values.
* @param iterable<TKey, TValue> ...$values A traversable object or an array to use for the initial values.
*
* @link https://www.php.net/manual/en/ds-map.construct.php
*/
public function __construct(...$values) {}
/**
* Allocates enough memory for a required capacity.
*
* @param int $capacity The number of values for which capacity should be allocated.<br>
* <p><b>Note:</b> Capacity will stay the same if this value is less than or equal to the current capacity.</p>
* Capacity will always be rounded up to the nearest power of 2.
*
* @link https://www.php.net/manual/en/ds-map.allocate.php
*/
public function allocate(int $capacity) {}
/**
* Updates all values by applying a callback function to each value in the map.
*
* @param callable(TKey, TValue): TValue $callback A callable to apply to each value in the map. The callback should return what
* the value should be replaced by.
*
* @link https://www.php.net/manual/en/ds-map.apply.php
*/
public function apply(callable $callback) {}
/**
* Returns the current capacity.
*
* @return int
*
* @link https://www.php.net/manual/en/ds-map.capacity.php
*/
public function capacity(): int {}
/**
* Count elements of an object
* @link https://php.net/manual/en/countable.count.php
* @return int The custom count as an integer.
* </p>
* <p>
* The return value is cast to an integer.
* @since 5.1
*/
public function count(): int {}
/**
* Removes all values from the collection.
* @link https://www.php.net/manual/en/ds-collection.clear.php
*/
public function clear(): void {}
/**
* Returns a shallow copy of the collection.
* @link https://www.php.net/manual/en/ds-collection.copy.php
* @return Map<TKey, TValue>
*/
public function copy(): Collection {}
/**
* Returns the result of removing all keys from the current instance that are present in a given map.
*
* A \ B = {x ∈ A | x ∉ B}
*
* @template TValue2
* @param Map<TKey, TValue2> $map The map containing the keys to exclude in the resulting map.
*
* @return Map<TKey, TValue> The result of removing all keys from the current instance that are present in a given map.
*
* @link https://www.php.net/manual/en/ds-map.diff.php
*/
public function diff(Map $map): Map {}
/**
* Creates a new map using a callable to determine which pairs to include
*
* @param null|callable(TKey, TValue): bool $callback Optional callable which returns TRUE if the pair should be included, FALSE
* otherwise. If a callback is not provided, only values which are TRUE (see converting to boolean) will be included.
*
* @return Map<TKey, TValue>
*
* @link https://www.php.net/manual/en/ds-map.filter.php
*/
public function filter(?callable $callback = null): Map {}
/**
* Returns the first pair in the map
*
* @return Pair<TKey, TValue> The first pair in the map.
*
* @throws UnderflowException if empty
*
* @link https://www.php.net/manual/en/ds-map.first.php
*/
public function first(): Pair {}
/**
* Returns the value for a given key, or an optional default value if the key could not be found.
* <p>
* <b>Note:</b> Keys of type object are supported. If an object implements Ds\Hashable, equality will be
* determined by the object's equals function. If an object does not implement Ds\Hashable, objects must be references to the same instance to be considered equal.
* </p>
* <p>
* <b>Note:</b> You can also use array syntax to access values by key, eg. $map["key"].
* </p>
* <p>
* <b>Caution:</b> Be careful when using array syntax. Scalar keys will be coerced to integers by the engine. For
* example, $map["1"] will attempt to access int(1), while $map->get("1") will correctly look up the string key.
* </p>
*
* @template TDefault
* @param TKey $key The key to look up.
* @param TDefault $default The optional default value, returned if the key could not be found.
*
* @return TValue|TDefault The value mapped to the given key, or the default value if provided and the key could not be found in the map.
*
* @throws OutOfBoundsException if the key could not be found and a default value was not provided.
*
* @link https://www.php.net/manual/en/ds-map.get.php
*/
public function get($key, $default = null) {}
public function getIterator(): Traversable {}
/**
* Determines whether the map contains a given key
*
* @param TKey $key The key to look for.
*
* @return bool Returns TRUE if the key could found, FALSE otherwise.
*
* @link https://www.php.net/manual/en/ds-map.hasKey.php
*/
public function hasKey($key): bool {}
/**
* Determines whether the map contains a given value
*
* @param TValue $value The value to look for.
*
* @return bool Returns TRUE if the value could found, FALSE otherwise.
*
* @link https://www.php.net/manual/en/ds-map.hasValue.php
*/
public function hasValue($value): bool {}
/**
* Creates a new map containing the pairs of the current instance whose
* keys are also present in the given map. In other words, returns a
* copy of the current instance with all keys removed that are not also
* in the other map.
*
* A ∩ B = {x : x ∈ A ∧ x ∈ B}
*
* <p><b>Note:</b> Values from the current instance will be kept.</p>
*
* @template TKey2
* @template TValue2
* @param Map<TKey2, TValue2> $map The other map, containing the keys to intersect with.
*
* @return Map<TKey&TKey2, TValue> The key intersection of the current instance and another map.
*
* @link https://www.php.net/manual/en/ds-map.intersect.php
*/
public function intersect(Map $map): Map {}
/**
* Returns whether the collection is empty.
*
* @link https://www.php.net/manual/en/ds-collection.isempty.php
*
* @return bool Returns TRUE if the map is empty, FALSE otherwise.
*
* @link https://www.php.net/manual/en/ds-map.isempty.php
*/
public function isEmpty(): bool {}
/**
* Converts the map to an array.
* <p><b>Note:</b> Casting to an array is not supported yet.</p>
* <p><b>Caution:</b> Maps where non-scalar keys are can't be converted to an
* array.
* </p>
* <p><b>Caution:</b> An array will treat all numeric keys as integers, eg.
* "1" and 1 as keys in the map will only result in 1 being included in
* the array.
* </p>
*
* @link https://www.php.net/manual/en/ds-map.toarray.php
* @return array<TValue> An array containing all the values in the same order as
* the map.
*/
public function toArray(): array {}
/**
* Specify data which should be serialized to JSON
* @link https://php.net/manual/en/jsonserializable.jsonserialize.php
* @return mixed data which can be serialized by <b>json_encode</b>,
* which is a value of any type other than a resource.
* @since 5.4
*/
public function jsonSerialize() {}
/**
* Returns a set containing all the keys of the map, in the same order.
* @link https://www.php.net/manual/en/ds-map.keys.php
* @return Set<TKey> A Ds\Set containing all the keys of the map.
*/
public function keys(): Set {}
/**
* Sorts the map in-place by key, using an optional comparator function.
* @param callable(TKey, TKey):int|null $comparator The comparison function must return
* an integer less than, equal to, or greater than zero if the first
* argument is considered to be respectively less than, equal to, or
* greater than the second. Note that before PHP 7.0.0 this integer had
* to be in the range from -2147483648 to 2147483647.
* <code>callback ( mixed $a, mixed $b ) : int</code>
* <p><b>Caution:</b> Returning non-integer values from the comparison function, such
* as float, will result in an internal cast to integer of the
* callback's return value. So values such as 0.99 and 0.1 will both be
* cast to an integer value of 0, which will compare such values as
* equal.</p>
* @link https://www.php.net/manual/en/ds-map.ksort.php
*/
public function ksort(?callable $comparator = null) {}
/**
* Returns a copy sorted by key, using an optional comparator function.
* @param callable(TKey, TKey): int|null $comparator The comparison function must return
* an integer less than, equal to, or greater than zero if the first
* argument is considered to be respectively less than, equal to, or
* greater than the second. Note that before PHP 7.0.0 this integer had
* to be in the range from -2147483648 to 2147483647.
* <code>callback ( mixed $a, mixed $b ) : int</code>
* <p><b>Caution:</b> Returning non-integer values from the comparison function, such
* as float, will result in an internal cast to integer of the
* callback's return value. So values such as 0.99 and 0.1 will both be
* cast to an integer value of 0, which will compare such values as
* equal.</p>
* @return Map<TKeyK, TValueV> Returns a copy of the map, sorted by key.
* @link https://www.php.net/manual/en/ds-map.ksorted.php
*/
public function ksorted(?callable $comparator = null): Map {}
/**
* Returns the last pair of the map.
* @return Pair<K,V> The last pair of the map.
* @throws UnderflowException if empty
* @link https://www.php.net/manual/en/ds-map.last.php
*/
public function last(): Pair {}
/**
* Returns the result of applying a callback function to each value of
* the map.
* @template TNewValue
* @param callable(TKey, TValue): TNewValue $callback A callable to apply to each value in the
* map. The callable should return what the key will be mapped to in the
* resulting map.
* <code>callback ( mixed $key , mixed $value ) : mixed</code>
* @return Map<TKey, TNewValue> The result of applying a callback to each value in the
* map.
*
* <b>Note:</b> The keys and values of the current instance won't be affected.
*
* @link https://www.php.net/manual/en/ds-map.map.php
*/
public function map(callable $callback): Map {}
/**
* Returns the result of associating all keys of a given traversable
* object or array with their corresponding values, combined with the
* current instance.
* @template TKey2
* @template TValue2
* @param iterable<TKey2, TValue2> $values A traversable object or an array.
* @return Map<TKey|TKey2, TValue|TValue2> The result of associating all keys of a given traversable
* object or array with their corresponding values, combined with the
* current instance.
*
* <b>Note:</b> The current instance won't be affected.
*
* @link https://www.php.net/manual/en/ds-map.merge.php
*/
public function merge($values): Map {}
/**
* Returns a Ds\Sequence containing all the pairs of the map.
*
* @return Sequence<Pair<TKey, TValueV>> Ds\Sequence containing all the pairs of the map.
*
* @link https://www.php.net/manual/en/ds-map.pairs.php
*/
public function pairs(): Sequence {}
/**
* Associates a key with a value, overwriting a previous association if
* one exists.
* @param TKey $key The key to associate the value with.
* @param TValue $value The value to be associated with the key.
*
* <b>Note:</b> Keys of type object are supported. If an object implements
* Ds\Hashable, equality will be determined by the object's equals
* function. If an object does not implement Ds\Hashable, objects must
* be references to the same instance to be considered equal.
*
* <b>Note:</b> You can also use array syntax to associate values by key, eg.
* $map["key"] = $value.
*
* <b>Caution:</b> Be careful when using array syntax. Scalar keys will be
* coerced to integers by the engine. For example, $map["1"] will
* attempt to access int(1), while $map->get("1") will correctly look up
* the string key.
*
* @link https://www.php.net/manual/en/ds-map.put.php
*/
public function put($key, $value) {}
/**
* Associates all key-value pairs of a traversable object or array.
*
* <b>Note:</b> Keys of type object are supported. If an object implements
* Ds\Hashable, equality will be determined
* by the object's equals function. If an object does not implement
* Ds\Hashable, objects must be references to the same instance to be
* considered equal.
*
* @param iterable<TKey, TValue> $pairs traversable object or array.
*
* @link https://www.php.net/manual/en/ds-map.putall.php
*/
public function putAll($pairs) {}
/**
* Reduces the map to a single value using a callback function.
*
* @template TCarry
* @param callable(TCarry, TKey, TValue): TCarry $callback
* <code>callback ( mixed $carry , mixed $key , mixed $value ) : mixed</code>
* <b>carry</b> The return value of the previous callback, or initial if
* it's the first iteration.
* <b>key</b> The key of the current iteration.
* <b>value</b> The value of the current iteration.
*
* @param TCarry $initial The initial value of the carry value. Can be
* NULL.
*
* @return TCarry
* @link https://www.php.net/manual/en/ds-map.reduce.php
*/
public function reduce(callable $callback, $initial) {}
/**
* Removes and returns a value by key, or return an optional default
* value if the key could not be found.
*
* @template TDefault
* @param TKey $key The key to remove.
* @param TDefault $default The optional default value, returned if the key
* could not be found.
*
* <b>Note:</b> Keys of type object are supported. If an object implements
* Ds\Hashable, equality will be determined
* by the object's equals function. If an object does not implement
* Ds\Hashable, objects must be references to the same instance to be
* considered equal.
*
* <b>Note:</b> You can also use array syntax to access values by key, eg.
* $map["key"].
*
* <b>Caution:</b> Be careful when using array syntax. Scalar keys will be
* coerced to integers by the engine. For example, $map["1"] will
* attempt to access int(1), while $map->get("1") will correctly look up
* the string key.
*
* @return TValue|TDefault The value that was removed, or the default value if
* provided and the key could not be found in the map.
*
* @throws OutOfBoundsException if the key could not be found and a
* default value was not provided.
*
* @link https://www.php.net/manual/en/ds-map.remove.php
*/
public function remove($key, $default = null) {}
/**
* Reverses the map in-place.
*
* @link https://www.php.net/manual/en/ds-map.reverse.php
*/
public function reverse() {}
/**
* Returns a reversed copy of the map.
*
* @return Map<TKey, TValue> A reversed copy of the map.
*
* <p><b>Note:</b> The current instance is not affected.</p>
*
* @link https://www.php.net/manual/en/ds-map.reversed.php
*/
public function reversed(): Map {}
/**
* Returns the pair at a given zero-based position.
*
* @param int $position The zero-based positional index to return.
*
* @return Pair<TKey, TValue> Returns the Ds\Pair at the given position.
*
* @throws OutOfRangeException if the position is not valid.
*
* @link https://www.php.net/manual/en/ds-map.skip.php
*/
public function skip(int $position): Pair {}
/**
* Returns a subset of the map defined by a starting index and length.
*
* @param int $index The index at which the range starts. If positive,
* the range will start at that index in the map. If negative, the range
* will start that far from the end.
*
* @param int|null $length If a length is given and is positive, the
* resulting map will have up to that many pairs in it. If a length is
* given and is negative, the range will stop that many pairs from the
* end. If the length results in an overflow, only pairs up to the end
* of the map will be included. If a length is not provided, the
* resulting map will contain all pairs between the index and the end of
* the map.
*
* @return Map<TKey, TValue> A subset of the map defined by a starting index and
* length.
*
* @link https://www.php.net/manual/en/ds-map.slice.php
*/
public function slice(int $index, ?int $length = null): Map {}
/**
* Sorts the map in-place by value, using an optional comparator
* function.
*
* @param callable(TValue, TValue): int|null $comparator The comparison function must return
* an integer less than, equal to, or greater than zero if the first
* argument is considered to be respectively less than, equal to, or
* greater than the second. Note that before PHP 7.0.0 this integer had
* to be in the range from -2147483648 to 2147483647.
*
* <code>callback ( mixed $a, mixed $b ) : int</code>
*
* <b>Caution:</b> Returning non-integer values from the comparison function,
* such as float, will result in an internal cast to integer of the
* callback's return value. So values such as 0.99 and 0.1 will both be
* cast to an integer value of 0, which will compare such values as
* equal.
*
* @link https://www.php.net/manual/en/ds-map.sort.php
*/
public function sort(?callable $comparator = null) {}
/**
* Returns a copy, sorted by value using an optional comparator function.
*
* @param callable(TValue, TValue): int|null $comparator The comparison function must return
* an integer less than, equal to, or greater than zero if the first
* argument is considered to be respectively less than, equal to, or
* greater than the second. Note that before PHP 7.0.0 this integer had
* to be in the range from -2147483648 to 2147483647.
*
* <code>callback ( mixed $a, mixed $b ) : int</code>
*
* <b>Caution:</b> Returning non-integer values from the comparison function,
* such as float, will result in an internal cast to integer of the
* callback's return value. So values such as 0.99 and 0.1 will both be
* cast to an integer value of 0, which will compare such values as
* equal.
*
* @return Map<TKey, TValue>
*
* @link https://www.php.net/manual/en/ds-map.sorted.php
*/
public function sorted(?callable $comparator = null): Map {}
/**
* Returns the sum of all values in the map.
*
* <b>Note:</b> Arrays and objects are considered equal to zero when
* calculating the sum.
*
* @return float|int The sum of all the values in the map as either a
* float or int depending on the values in the map.
*
* @link https://www.php.net/manual/en/ds-map.sum.php
*/
public function sum(): float|int {}
/**
* Creates a new map using values from the current instance and another
* map.
*
* A ∪ B = {x: x ∈ A ∨ x ∈ B}
*
* <p><b>Note:</b> Values of the current instance will be overwritten by those
* provided where keys are equal.</p>
*
* @template TKey2
* @template TValue2
* @param Map<TKey2, TValue2> $map The other map, to combine with the current instance.
*
* @return Map<TKey|TKey2 , TValue|TValue2> A new map containing all the pairs of the current
* instance as well as another map.
*
* @link https://www.php.net/manual/en/ds-map.union.php
*/
public function union(Map $map): Map {}
/**
* Returns a sequence containing all the values of the map, in the same
* order.
*
* @return Sequence<TValue> A Ds\Sequence containing all the values of the map.
*
* @link https://www.php.net/manual/en/ds-map.values.php
*/
public function values(): Sequence {}
/**
* Creates a new map containing keys of the current instance as well as
* another map, but not of both.
*
* A ⊖ B = {x : x ∈ (A \ B) ∪ (B \ A)}
*
* @template TKey2
* @template TValue2
* @param Map<TKey2, TValue2> $map The other map.
*
* @return Map<TKey|TKey2, TValue|TValue2> A new map containing keys in the current instance as well
* as another map, but not in both.
*
* @link https://www.php.net/manual/en/ds-map.xor.php
*/
public function xor(Map $map): Map {}
/**
* @param TKey $offset
*/
public function offsetExists(mixed $offset): bool {}
/**
* @param TKey $offset
*
* @return TValue
*/
public function offsetGet(mixed $offset) {}
/**
* @param TKey $offset
* @param TValue $value
*/
public function offsetSet(mixed $offset, mixed $value) {}
/**
* @param TKey $offset
*/
public function offsetUnset(mixed $offset): void {}
}
/**
* A pair is used by Ds\Map to pair keys with values.
* @package Ds
* @template-covariant TKey
* @template-covariant TValue
*/
class Pair implements JsonSerializable
{
/**
* @var TKey
*/
public $key;
/**
* @var TValue
*/
public $value;
/**
* Creates a new instance using a given key and value.
*
* @param TKey $key
* @param TValue $value
*
* @link https://php.net/manual/en/ds-pair.construct.php
*/
public function __construct($key = null, $value = null) {}
/**
* Removes all values from the pair.
*
* @link https://php.net/manual/en/ds-pair.clear.php
*/
public function clear() {}
/**
* Returns a shallow copy of the pair.
*
* @return Pair<TKey, TValue> Returns a shallow copy of the pair.
*
* @link https://php.net/manual/en/ds-pair.copy.php
*/
public function copy(): Pair {}
/**
* Returns whether the pair is empty.
*
* @return bool Returns TRUE if the pair is empty, FALSE otherwise.
*
* @link https://php.net/manual/en/ds-pair.isempty.php
*/
public function isEmpty(): bool {}
/**
* Converts the pair to an array.
*
* <p><b>Note:</b> Casting to an array is not supported yet.</p>
*
* @return array{key: TKey, value: TValue} An array containing all the values in the same order as
* the pair.
*
* @link https://php.net/manual/en/ds-pair.toarray.php
*/
public function toArray(): array {}
/**
* Specify data which should be serialized to JSON
* @link https://php.net/manual/en/ds-pair.jsonserialize.php
* @return mixed data which can be serialized by <b>json_encode</b>,
* which is a value of any type other than a resource.
*/
public function jsonSerialize() {}
}
/**
* A Set is a sequence of unique values. This implementation uses the same
* hash table as Ds\Map, where values are used as keys and the mapped value
* is ignored.
*
* @link https://www.php.net/manual/en/class.ds-set.php
*
* @package Ds
* @template TValue
* @implements Collection<int, TValue>
*/
class Set implements Collection, ArrayAccess
{
/**
* Creates a new instance, using either a traversable object or an array
* for the initial values.
*
* @param iterable<TValue> $values A traversable object of an array to
* use the initial values.
*
* @link https://php.net/manual/en/ds-set.construct.php
*/
public function __construct(iterable $values = []) {}
/**
* Adds all given values to the set that haven't already been added.
*
* <p><b>Note:</b> Values of type object are supported. If an object implements
* Ds\Hashable, equality will be determined by the object's equals
* function. If an object does not implement Ds\Hashable, objects must
* be references to the same instance to be considered equal.
*
* <p><b>Caution:</b> All comparisons are strict (type and value).
*
* @param TValue ...$values Values to add to the set.
*
* @link https://php.net/manual/en/ds-set.add.php
*/
public function add(...$values) {}
/**
* Allocates enough memory for a required capacity.
*
* @param int $capacity The number of values for which capacity should
* be allocated.
*
* <p><b>Note:</b> Capacity will stay the same if this value is less than or
* equal to the current capacity.
*
* <p>Capacity will always be rounded up to the nearest power of 2.
*
* @link https://php.net/manual/en/ds-set.allocate.php
*/
public function allocate(int $capacity) {}
/**
* Determines if the set contains all values.
*
* <p>Values of type object are supported. If an object implements
* Ds\Hashable, equality will be determined by the object's equals
* function. If an object does not implement Ds\Hashable, objects must
* be references to the same instance to be considered equal.
*
* <p><b>Caution:</b> All comparisons are strict (type and value).
*
* @param TValue ...$values Values to check.
*
* @return bool
*
* @link https://php.net/manual/en/ds-set.contains.php
*/
public function contains(...$values): bool {}
/**
* Returns the current capacity.
* @link https://www.php.net/manual/en/ds-set.capacity.php
*
* @return int
*/
public function capacity(): int {}
/**
* Removes all values from the set.
* @link https://www.php.net/manual/en/ds-set.clear.php
*/
public function clear(): void {}
/**
* Count elements of an object
* @link https://php.net/manual/en/ds-set.count.php
* @return int The custom count as an integer.
* </p>
* <p>
* The return value is cast to an integer.
* @since 5.1
*/
public function count(): int {}
/**
* Returns a shallow copy of the set.
* @link https://www.php.net/manual/en/ds-set.copy.php
* @return Set<TValue>
*/
public function copy(): Set {}
/**
* Creates a new set using values that aren't in another set.
*
* A \ B = {x ∈ A | x ∉ B}
*
* @link https://www.php.net/manual/en/ds-set.diff.php
*
* @template TValue2
* @param Set<TValue2> $set Set containing the values to exclude.
*
* @return Set<TValue> A new set containing all values that were not in the
* other set.
*/
public function diff(Set $set): Set {}
/**
* Creates a new set using a callable to determine which values to
* include
*
* @link https://www.php.net/manual/en/ds-set.filter.php
*
* @param null|callable(TValue): bool $callback Optional callable which returns TRUE if the
* value should be included, FALSE otherwise.
* If a callback is not provided, only values which are TRUE (see
* converting to boolean) will be included.
*
* @return Set<TValue> A new set containing all the values for which either the
* callback returned TRUE, or all values that convert to TRUE if a
* callback was not provided.
*/
public function filter(?callable $callback = null): Set {}
/**
* Returns the first value in the set.
*
* @link https://www.php.net/manual/en/ds-set.first.php
*
* @return TValue The first value in the set.
*/
public function first() {}
/**
* Returns the value at a given index.
*
* @link https://www.php.net/manual/en/ds-set.get.php
*
* @param int $index The index to access, starting at 0.
*
* @return TValue The value at the requested index.
*/
public function get(int $index) {}
public function getIterator(): Traversable {}
/**
* Creates a new set using values common to both the current instance
* and another set. In other words, returns a copy of the current
* instance with all values removed that are not in the other set.
*
* A ∩ B = {x : x ∈ A ∧ x ∈ B}
*
* @link https://www.php.net/manual/en/ds-set.intersect.php
*
* @template TValue2
* @param Set<TValue2> $set The other set.
* @return Set<TValue&TValue2> The intersection of the current instance and another set.
*/
public function intersect(Set $set): Set {}
/**
* Returns whether the set is empty.
* @link https://www.php.net/manual/en/ds-set.isempty.php
*
* @return bool
*/
public function isEmpty(): bool {}
/**
* Joins all values together as a string using an optional separator
* between each value.
*
* @link https://www.php.net/manual/en/ds-set.join.php
*
* @param null|string $glue An optional string to separate each value.
*
* @return string
*/
public function join(?string $glue = null): string {}
/**
* Returns the result of applying a callback function to each value in
* the set.
* @template TNewValue
* @param callable(TValue): TNewValue $callback A callable to apply to each value in the
* set.
* The callable should return what the new value will be in the new
* set.
* <code>callback ( mixed $value ) : mixed</code>
* @return Set<TNewValue> The result of applying a callback to each value in
* the set.
* <p><b>Note:</b> The values of the current instance won't be affected.</p>
*/
public function map(callable $callback): Set {}
/**
* Returns the result of adding all given values to the set.
*
* <p><b>Note:</b> The current instance won't be affected.</p>
*
* @link https://www.php.net/manual/en/ds-set.merge.php
*
* @template TValue2
* @param iterable<TValue2> $values A traversable object or an array.
*
* @return Set<TValue|TValue2> The result of adding all given values to the set,
* effectively the same as adding the values to a copy, then returning
* that copy.
*/
public function merge($values): Set {}
/**
* Reduces the set to a single value using a callback function.
*
* @link https://www.php.net/manual/en/ds-set.reduce.php
*
* @template TCarry
* @param callable(TCarry, TValue): TCarry $callback
* <code>callback ( mixed $carry , mixed $value ) : mixed</code>
* $carry The return value of the previous callback, or initial if
* it's the first iteration.
* $value The value of the current iteration.
*
* @param TCarry $initial The initial value of the carry value. Can be
* NULL.
*
* @return TCarry The return value of the final callback.
*/
public function reduce(callable $callback, $initial = null) {}
/**
* Removes all given values from the set, ignoring any that are not in
* the set.
*
* @link https://www.php.net/manual/en/ds-set.remove.php
*
* @param TValue ...$values The values to remove.
*/
public function remove(...$values) {}
/**
* Reverses the set in-place.
*
* @link https://www.php.net/manual/en/ds-set.reverse.php
*/
public function reverse() {}
/**
* Returns a reversed copy of the set.
*
* @link https://www.php.net/manual/en/ds-set.reversed.php
*
* <p><b>Note:</b> The current instance is not affected.</p>
*
* @return Set<TValue> A reversed copy of the set.
*/
public function reversed(): Set {}
/**
* Returns a sub-set of a given range
*
* @param int $index The index at which the sub-set starts. If positive,
* the set will start at that index in
* the set. If negative, the set will start that far from the end.
*
* @param int|null $length If a length is given and is positive, the
* resulting set will have up to that many values in it. If the length
* results in an overflow, only values up to the end of the set will be
* included. If a length is given and is negative, the set will stop
* that many values from the end. If a length is not provided, the
* resulting set will contain all values between the index and the end
* of the set.
*
* @return Set<TValue> A sub-set of the given range.
*/
public function slice(int $index, ?int $length = null): Set {}
/**
* Returns the last value in the set.
*
* @link https://www.php.net/manual/en/ds-set.last.php
*
* @return TValue The last value in the set.
*
* @throws UnderflowException if empty.
*/
public function last() {}
/**
* Sorts the set in-place, using an optional comparator function.
*
* @param callable(TValue, TValue): int|null $comparator The comparison function must return
* an integer less than, equal to, or greater than zero if the first
* argument is considered to be respectively less than, equal to, or
* greater than the second. Note that before PHP 7.0.0 this integer had
* to be in the range from -2147483648 to 2147483647.
* <code>callback ( mixed $a, mixed $b ) : int</code>
* <note><b>Caution:</b> Returning non-integer values from the comparison
* function, such as float, will result in an internal cast to integer
* of the callback's return value. So values such as 0.99 and 0.1 will
* both be cast to an integer value of 0, which will compare such values
* as equal.</note>
*
* @link https://www.php.net/manual/en/ds-set.sort.php
*/
public function sort(?callable $comparator = null) {}
/**
* Returns a sorted copy, using an optional comparator function.
*
* @link https://www.php.net/manual/en/ds-set.sorted.php
*
* @param null|callable(TValue, TValue): int $comparator The comparison function must return an
* integer less than, equal to, or greater than zero if the first
* argument is considered to be respectively less than, equal to, or
* greater than the second. Note that before PHP 7.0.0 this integer had
* to be in the range from -2147483648 to 2147483647.
*
* <code>callback ( mixed $a, mixed $b ) : int</code>
*
* <p><b>Caution:</b> Returning non-integer values from the comparison
* function, such as float, will result in an
* internal cast to integer of the callback's return value. So values
* such as 0.99 and 0.1 will both be cast to an integer value of 0,
* which will compare such values as equal.</p>
*
* @return Set<TValue> Returns a sorted copy of the set.
*/
public function sorted(?callable $comparator = null): Set {}
/**
* Returns the sum of all values in the set.
*
* <p><b>Note:</b> Arrays and objects are considered equal to zero when
* calculating the sum.</p>
*
* @link https://www.php.net/manual/en/ds-set.sum.php
*
* @return float|int The sum of all the values in the set as either a
* float or int depending on the values in the set.
*/
public function sum(): float|int {}
/**
* Creates a new set that contains the values of the current instance as
* well as the values of another set.
*
* A ∪ B = {x: x ∈ A ∨ x ∈ B}
*
* @link https://www.php.net/manual/en/ds-set.union.php
*
* @template TValue2
* @param Set<TValue2> $set The other set, to combine with the current instance.
*
* @return Set<TValue|TValue2> A new set containing all the values of the current
* instance as well as another set.
*/
public function union(Set $set): Set {}
/**
* Creates a new set using values in either the current instance or in
* another set, but not in both.
*
* A ⊖ B = {x : x ∈ (A \ B) ∪ (B \ A)}
*
* @link https://www.php.net/manual/en/ds-set.xor.php
*
* @template TValue2
* @param Set<TValue2> $set The other set.
*
* @return Set<TValue|TValue2> A new set containing values in the current instance as
* well as another set, but not in both.
*/
public function xor(Set $set): Set {}
/**
* Converts the set to an array.
* <p><b>Note:</b> Casting to an array is not supported yet.</p>
* @link https://www.php.net/manual/en/ds-set.toarray.php
* @return array<TValue> An array containing all the values in the same order as
* the collection.
*/
public function toArray(): array {}
/**
* Specify data which should be serialized to JSON
* @link https://php.net/manual/en/ds-set.jsonserialize.php
* @return mixed data which can be serialized by <b>json_encode</b>,
* which is a value of any type other than a resource.
* @since 5.4
*/
public function jsonSerialize() {}
/**
* @param int $offset
*/
public function offsetExists(mixed $offset): bool {}
/**
* @param int $offset
*
* @return TValue
*/
public function offsetGet(mixed $offset) {}
/**
* @param int $offset
* @param TValue $value
*/
public function offsetSet(mixed $offset, mixed $value) {}
/**
* @param int $offset
*/
public function offsetUnset(mixed $offset): void {}
}
/**
* A Stack is a “last in, first out” or “LIFO” collection that only allows
* access to the value at the top of the structure and iterates in that
* order, destructively.
*
* @package Ds
* @template TValue
* @implements Collection<int, TValue>
*
* @link https://www.php.net/manual/en/class.ds-stack.php
*/
class Stack implements Collection, ArrayAccess
{
/**
* Creates a new instance, using either a traversable object or an array
* for the initial values.
*
* @link https://www.php.net/manual/en/ds-stack.construct.php
*
* @param iterable<TValue> $values A traversable object or an
* array to use for the initial values.
*/
public function __construct($values = []) {}
/**
* Ensures that enough memory is allocated for a required capacity. This
* removes the need to reallocate the internal as values are added.
*
* @link https://www.php.net/manual/en/ds-stack.allocate.php
*
* @param int $capacity The number of values for which capacity should
* be allocated.
*
* <p><b>Note:</b> Capacity will stay the same if this value is less than or
* equal to the current capacity.</p>
*/
public function allocate(int $capacity) {}
/**
* Returns the current capacity.
*
* @link https://www.php.net/manual/en/ds-stack.capacity.php
*
* @return int The current capacity.
*/
public function capacity(): int {}
/**
* Removes all values from the stack.
* @link https://www.php.net/manual/en/ds-stack.clear.php
*/
public function clear(): void {}
/**
* Count elements of an object
* @link https://php.net/manual/en/ds-stack.count.php
* @return int The custom count as an integer.
* </p>
* <p>
* The return value is cast to an integer.
* @since 5.1
*/
public function count(): int {}
/**
* Returns a shallow copy of the collection.
* @link https://www.php.net/manual/en/ds-stack.copy.php
* @return Stack<TValue>
*/
public function copy(): Stack {}
public function getIterator(): Traversable {}
/**
* Returns whether the collection is empty.
* @link https://www.php.net/manual/en/ds-stack.isempty.php
* @return bool
*/
public function isEmpty(): bool {}
/**
* Converts the collection to an array.
* <p><b>Note:</b> Casting to an array is not supported yet.</p>
* @link https://www.php.net/manual/en/ds-stack.toarray.php
* @return array<TValue> An array containing all the values in the same order as
* the collection.
*/
public function toArray(): array {}
/**
* Specify data which should be serialized to JSON
* @link https://php.net/manual/en/jsonserializable.jsonserialize.php
* @return mixed data which can be serialized by <b>json_encode</b>,
* which is a value of any type other than a resource.
* @since 5.4
*/
public function jsonSerialize() {}
/**
* Returns the value at the top of the stack, but does not remove it.
*
* @link https://www.php.net/manual/en/ds-queue.peek.php
*
* @return TValue The value at the top of the stack.
*
* @throws UnderflowException
*/
public function peek() {}
/**
* Removes and returns the value at the top of the stack.
*
* @link https://www.php.net/manual/en/ds-queue.pop.php
*
* @return TValue The removed value which was at the top of the stack.
*
* @throws UnderflowException
*/
public function pop() {}
/**
* Pushes values onto the stack.
*
* @link https://www.php.net/manual/en/ds-queue.push.php
*
* @param TValue ...$values The values to push onto the stack.
*/
public function push(...$values) {}
/**
* @param int $offset
*/
public function offsetExists(mixed $offset): bool {}
/**
* @param int $offset
*
* @return TValue
*/
public function offsetGet(mixed $offset) {}
/**
* @param int $offset
* @param TValue $value
*/
public function offsetSet(mixed $offset, mixed $value) {}
/**
* @param int $offset
*/
public function offsetUnset(mixed $offset): void {}
}
/**
* A Queue is a “first in, first out” or “FIFO” collection that only allows
* access to the value at the front of the queue and iterates in that order,
* destructively.
*
* Uses a Ds\Vector internally.
*
* @package Ds
* @template TValue
* @implements Collection<int, TValue>
*/
class Queue implements Collection, ArrayAccess
{
/**
* Creates a new instance, using either a traversable object or an array
* for the initial values.
*
* @link https://www.php.net/manual/en/ds-queue.construct.php
*
* @param iterable<TValue> $values A traversable object or an
* array to use for the initial values.
*/
public function __construct($values = []) {}
/**
* Ensures that enough memory is allocated for a required capacity. This
* removes the need to reallocate the internal as values are added.
*
* @link https://www.php.net/manual/en/ds-queue.allocate.php
*
* @param int $capacity The number of values for which capacity should
* be allocated.
*
* <p><b>Note:</b> Capacity will stay the same if this value is less than or
* equal to the current capacity.</p>
*/
public function allocate(int $capacity) {}
/**
* Returns the current capacity.
*
* @link https://www.php.net/manual/en/ds-queue.capacity.php
*
* @return int The current capacity.
*/
public function capacity(): int {}
/**
* Removes all values from the queue.
* @link https://www.php.net/manual/en/ds-queue.clear.php
*/
public function clear(): void {}
/**
* Count elements of an object
* @link https://php.net/manual/en/ds-queue.count.php
* @return int The custom count as an integer.
* </p>
* <p>
* The return value is cast to an integer.
* @since 5.1
*/
public function count(): int {}
/**
* Returns a shallow copy of the collection.
* @link https://www.php.net/manual/en/ds-queue.copy.php
* @return Queue<TValue>
*/
public function copy(): Queue {}
/**
* @return Traversable<TValue>
*/
public function getIterator(): Traversable {}
/**
* Returns whether the collection is empty.
* @link https://www.php.net/manual/en/ds-queue.isempty.php
* @return bool
*/
public function isEmpty(): bool {}
/**
* Converts the collection to an array.
* <p><b>Note:</b> Casting to an array is not supported yet.</p>
* @link https://www.php.net/manual/en/ds-queue.toarray.php
* @return array<TValue> An array containing all the values in the same order as
* the collection.
*/
public function toArray(): array {}
/**
* Specify data which should be serialized to JSON
* @link https://php.net/manual/en/jsonserializable.jsonserialize.php
* @return mixed data which can be serialized by <b>json_encode</b>,
* which is a value of any type other than a resource.
* @since 5.4
*/
public function jsonSerialize() {}
/**
* Returns the value at the top of the queue, but does not remove it.
*
* @link https://www.php.net/manual/en/ds-queue.peek.php
*
* @return TValue The value at the top of the queue.
*
* @throws UnderflowException
*/
public function peek() {}
/**
* Removes and returns the value at the top of the queue.
*
* @link https://www.php.net/manual/en/ds-queue.pop.php
*
* @return TValue The removed value which was at the top of the queue.
*
* @throws UnderflowException
*/
public function pop() {}
/**
* Pushes values onto the queue.
*
* @link https://www.php.net/manual/en/ds-queue.push.php
*
* @param TValue ...$values The values to push onto the queue.
*/
public function push(...$values) {}
/**
* @param int $offset
*/
public function offsetExists(mixed $offset): bool {}
/**
* @param int $offset
*
* @return TValue
*/
public function offsetGet(mixed $offset) {}
/**
* @param int $offset
* @param TValue $value
*/
public function offsetSet(mixed $offset, mixed $value) {}
/**
* @param int $offset
*/
public function offsetUnset(mixed $offset): void {}
}
/**
* A PriorityQueue is very similar to a Queue. Values are pushed into the
* queue with an assigned priority, and the value with the highest priority
* will always be at the front of the queue.
*
* Implemented using a max heap.
*
* @package Ds
* @template TValue
* @implements Collection<int, TValue>
*
* @link https://www.php.net/manual/en/class.ds-priorityqueue.php
*/
class PriorityQueue implements Collection
{
public const MIN_CAPACITY = 8;
/**
* Count elements of an object
* @link https://php.net/manual/en/countable.count.php
* @return int The custom count as an integer.
* </p>
* <p>
* The return value is cast to an integer.
* @since 5.1
*/
public function count(): int {}
/**
* Allocates enough memory for a required capacity
* @link https://www.php.net/manual/en/ds-priorityqueue.allocate.php
*
* @param int $capacity
*/
public function allocate(int $capacity): void {}
/**
* Returns the current capacity
* @link https://www.php.net/manual/en/ds-priorityqueue.capacity.php
*
* @return int
*/
public function capacity(): int {}
/**
* Removes all values from the collection.
* @link https://www.php.net/manual/en/ds-collection.clear.php
*/
public function clear(): void {}
/**
* Returns a shallow copy of the collection.
* @link https://www.php.net/manual/en/ds-collection.copy.php
* @return PriorityQueue<TValue>
*/
public function copy() {}
public function getIterator(): Traversable {}
/**
* Returns whether the collection is empty.
* @link https://www.php.net/manual/en/ds-collection.isempty.php
* @return bool
*/
public function isEmpty(): bool {}
/**
* Returns the value at the front of the queue, but does not remove it.
* @link https://www.php.net/manual/en/ds-priorityqueue.peek.php
*
* @return TValue The value at the front of the queue.
* @throws UnderflowException if empty.
*/
public function peek() {}
/**
* Removes and returns the value with the highest priority
* @link https://www.php.net/manual/en/ds-priorityqueue.pop.php
*
* @return TValue The removed value which was at the front of the queue.
* @throws UnderflowException if empty.
*/
public function pop() {}
/**
* Pushes a value with a given priority into the queue.
*
* @param TValue $value
* @param int $priority
*/
public function push($value, int $priority) {}
/**
* Converts the collection to an array.
* <p><b>Note:</b> Casting to an array is not supported yet.</p>
* @link https://www.php.net/manual/en/ds-collection.toarray.php
* @return array<TValue> An array containing all the values in the same order as
* the collection.
*/
public function toArray(): array {}
/**
* Specify data which should be serialized to JSON
* @link https://php.net/manual/en/jsonserializable.jsonserialize.php
* @return mixed data which can be serialized by <b>json_encode</b>,
* which is a value of any type other than a resource.
* @since 5.4
*/
public function jsonSerialize() {}
}