opensourcemirror
/
phpstorm-stubs
mirror of https://github.com/JetBrains/phpstorm-stubs.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Iterator, SPL, and Fiber templates (rebased from #1212, improved) (#1252) 

Add templates to Iterator, SPL, and Fiber
This commit is contained in:
Daniil Gentili 2021-11-13 09:21:57 +01:00 committed by GitHub
parent b66b7686c1
commit 791d61f58c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 120 additions and 73 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
Core/Core_c.php
View File

@ -23,6 +23,10 @@ interface iterable {}
* Instead it must be implemented by either {@see IteratorAggregate} or {@see Iterator}.
*
* @link https://php.net/manual/en/class.traversable.php
* @template TKey
* @template TValue
*
* @template-implements iterable<TKey, TValue>
*/
interface Traversable extends iterable {}
@ -31,13 +35,14 @@ interface Traversable extends iterable {}
* @link https://php.net/manual/en/class.iteratoraggregate.php
* @template TKey
* @template TValue
* @template-implements Traversable<TKey, TValue>
*/
interface IteratorAggregate extends Traversable
{
/**
* Retrieve an external iterator
* @link https://php.net/manual/en/iteratoraggregate.getiterator.php
* @return Traversable|TValue[] An instance of an object implementing <b>Iterator</b> or
* @return Traversable<TKey, TValue> An instance of an object implementing <b>Iterator</b> or
* <b>Traversable</b>
* @throws Exception on failure.
*/
@ -49,13 +54,16 @@ interface IteratorAggregate extends Traversable
* Interface for external iterators or objects that can be iterated
* themselves internally.
* @link https://php.net/manual/en/class.iterator.php
* @template TKey
* @template TValue
* @template-implements Traversable<TKey, TValue>
*/
interface Iterator extends Traversable
{
/**
* Return the current element
* @link https://php.net/manual/en/iterator.current.php
* @return mixed Can return any type.
* @return TValue Can return any type.
*/
#[TentativeType]
public function current(): mixed;
@ -71,7 +79,7 @@ interface Iterator extends Traversable
/**
* Return the key of the current element
* @link https://php.net/manual/en/iterator.key.php
* @return string|float|int|bool|null scalar on success, or null on failure.
* @return TKey|null TKey on success, or null on failure.
*/
#[TentativeType]
public function key(): mixed;
@ -97,6 +105,8 @@ interface Iterator extends Traversable
/**
* Interface to provide accessing objects as arrays.
* @link https://php.net/manual/en/class.arrayaccess.php
* @template TKey
* @template TValue
*/
interface ArrayAccess
{
@ -120,7 +130,7 @@ interface ArrayAccess
* @param mixed $offset <p>
* The offset to retrieve.
* </p>
* @return mixed Can return all value types.
* @return TValue Can return all value types.
*/
#[TentativeType]
public function offsetGet(#[LanguageLevelTypeAware(['8.0' => 'mixed'], default: '')] $offset): mixed;
@ -128,10 +138,10 @@ interface ArrayAccess
/**
* Offset to set
* @link https://php.net/manual/en/arrayaccess.offsetset.php
* @param mixed $offset <p>
* @param TKey $offset <p>
* The offset to assign the value to.
* </p>
* @param mixed $value <p>
* @param TValue $value <p>
* The value to set.
* </p>
* @return void
@ -145,7 +155,7 @@ interface ArrayAccess
/**
* Offset to unset
* @link https://php.net/manual/en/arrayaccess.offsetunset.php
* @param mixed $offset <p>
* @param TKey $offset <p>
* The offset to unset.
* </p>
* @return void
@ -710,6 +720,10 @@ final class WeakReference
* it will simply be removed from the map.
*
* @since 8.0
*
* @template TKey of object
* @template TValue
* @template-implements IteratorAggregate<TKey, TValue>
*/
final class WeakMap implements ArrayAccess, Countable, IteratorAggregate
{
@ -717,7 +731,7 @@ final class WeakMap implements ArrayAccess, Countable, IteratorAggregate
* Returns {@see true} if the value for the object is contained in
* the {@see WeakMap} and {@see false} instead.
*
* @param object $object Any object
* @param TKey $object Any object
* @return bool
*/
public function offsetExists($object): bool {}
@ -725,16 +739,16 @@ final class WeakMap implements ArrayAccess, Countable, IteratorAggregate
/**
* Returns the existsing value by an object.
*
* @param object $object Any object
* @return mixed Value associated with the key object
* @param TKey $object Any object
* @return TValue Value associated with the key object
*/
public function offsetGet($object): mixed {}
/**
* Sets a new value for an object.
*
* @param object $object Any object
* @param mixed $value Any value
* @param TKey $object Any object
* @param TValue $value Any value
* @return void
*/
public function offsetSet($object, mixed $value): void {}
@ -742,7 +756,7 @@ final class WeakMap implements ArrayAccess, Countable, IteratorAggregate
/**
* Force removes an object value from the {@see WeakMap} instance.
*
* @param object $object Any object
* @param TKey $object Any object
* @return void
*/
public function offsetUnset($object): void {}
@ -750,7 +764,7 @@ final class WeakMap implements ArrayAccess, Countable, IteratorAggregate
/**
* Returns an iterator in the "[object => mixed]" format.
*
* @return Traversable
* @return Traversable<TKey, TValue>
*/
public function getIterator(): Iterator {}
@ -926,6 +940,11 @@ interface StringBackedEnum extends BackedEnum
/**
* @since 8.1
*
* @template TStart
* @template TResume
* @template TReturn
* @template TSuspend
*/
final class Fiber
{
@ -937,9 +956,9 @@ final class Fiber
/**
* Starts execution of the fiber. Returns when the fiber suspends or terminates.
*
* @param mixed ...$args Arguments passed to fiber function.
* @param TStart ...$args Arguments passed to fiber function.
*
* @return mixed Value from the first suspension point or NULL if the fiber returns.
* @return TSuspend|null Value from the first suspension point or NULL if the fiber returns.
*
* @throws FiberError If the fiber has already been started.
* @throws Throwable If the fiber callable throws an uncaught exception.
@ -950,9 +969,9 @@ final class Fiber
* Resumes the fiber, returning the given value from {@see Fiber::suspend()}.
* Returns when the fiber suspends or terminates.
*
* @param mixed $value
* @param TResume $value
*
* @return mixed Value from the next suspension point or NULL if the fiber returns.
* @return TSuspend|null Value from the next suspension point or NULL if the fiber returns.
*
* @throws FiberError If the fiber has not started, is running, or has terminated.
* @throws Throwable If the fiber callable throws an uncaught exception.
@ -965,7 +984,7 @@ final class Fiber
*
* @param Throwable $exception
*
* @return mixed Value from the next suspension point or NULL if the fiber returns.
* @return TSuspend|null Value from the next suspension point or NULL if the fiber returns.
*
* @throws FiberError If the fiber has not started, is running, or has terminated.
* @throws Throwable If the fiber callable throws an uncaught exception.
@ -993,27 +1012,25 @@ final class Fiber
public function isTerminated(): bool {}
/**
* @return mixed Return value of the fiber callback. NULL is returned if the fiber does not have a return statement.
* @return TReturn Return value of the fiber callback. NULL is returned if the fiber does not have a return statement.
*
* @throws FiberError If the fiber has not terminated or the fiber threw an exception.
*/
public function getReturn(): mixed {}
public static function getCurrent(): ?Fiber {}
/**
* @return self|null Returns the currently executing fiber instance or NULL if in {main}.
*/
public static function this() {}
public static function getCurrent(): ?Fiber {}
/**
* Suspend execution of the fiber. The fiber may be resumed with {@see Fiber::resume()} or {@see Fiber::throw()}.
*
* Cannot be called from {main}.
*
* @param mixed $value Value to return from {@see Fiber::resume()} or {@see Fiber::throw()}.
* @param TSuspend $value Value to return from {@see Fiber::resume()} or {@see Fiber::throw()}.
*
* @return mixed Value provided to {@see Fiber::resume()}.
* @return TResume Value provided to {@see Fiber::resume()}.
*
* @throws FiberError Thrown if not within a fiber (i.e., if called from {main}).
* @throws Throwable Exception provided to {@see Fiber::throw()}.

107
SPL/SPL_c1.php
View File

@ -1036,8 +1036,11 @@ class SplTempFileObject extends SplFileObject
}
/**
* @template TValue
* The SplDoublyLinkedList class provides the main functionalities of a doubly linked list.
* @link https://php.net/manual/en/class.spldoublylinkedlist.php
* @template-implements Iterator<int, TValue>
* @template-implements ArrayAccess<int, TValue>
*/
class SplDoublyLinkedList implements Iterator, Countable, ArrayAccess, Serializable
{
@ -1288,6 +1291,7 @@ class SplDoublyLinkedList implements Iterator, Countable, ArrayAccess, Serializa
}
/**
* @template TValue
* The SplQueue class provides the main functionalities of a queue implemented using a doubly linked list.
* @link https://php.net/manual/en/class.splqueue.php
*/
@ -1296,7 +1300,7 @@ class SplQueue extends SplDoublyLinkedList
/**
* Adds an element to the queue.
* @link https://php.net/manual/en/splqueue.enqueue.php
* @param mixed $value <p>
* @param TValue $value <p>
* The value to enqueue.
* </p>
* @return void
@ -1307,7 +1311,7 @@ class SplQueue extends SplDoublyLinkedList
/**
* Dequeues a node from the queue
* @link https://php.net/manual/en/splqueue.dequeue.php
* @return mixed The value of the dequeued node.
* @return TValue The value of the dequeued node.
*/
#[TentativeType]
public function dequeue(): mixed {}
@ -1326,8 +1330,10 @@ class SplQueue extends SplDoublyLinkedList
}
/**
* @template TValue
* The SplStack class provides the main functionalities of a stack implemented using a doubly linked list.
* @link https://php.net/manual/en/class.splstack.php
* @template-extends SplDoublyLinkedList<TValue>
*/
class SplStack extends SplDoublyLinkedList
{
@ -1345,8 +1351,10 @@ class SplStack extends SplDoublyLinkedList
}
/**
* @template TValue
* The SplHeap class provides the main functionalities of an Heap.
* @link https://php.net/manual/en/class.splheap.php
* @template-implements Iterator<int, TValue>
*/
abstract class SplHeap implements Iterator, Countable
{
@ -1361,7 +1369,7 @@ abstract class SplHeap implements Iterator, Countable
/**
* Inserts an element in the heap by sifting it up.
* @link https://php.net/manual/en/splheap.insert.php
* @param mixed $value <p>
* @param TValue $value <p>
* The value to insert.
* </p>
* @return bool
@ -1372,7 +1380,7 @@ abstract class SplHeap implements Iterator, Countable
/**
* Peeks at the node from the top of the heap
* @link https://php.net/manual/en/splheap.top.php
* @return mixed The value of the node on the top.
* @return TValue The value of the node on the top.
*/
#[TentativeType]
public function top(): mixed {}
@ -1404,7 +1412,7 @@ abstract class SplHeap implements Iterator, Countable
/**
* Return current node pointed by the iterator
* @link https://php.net/manual/en/splheap.current.php
* @return mixed The current node value.
* @return TValue The current node value.
*/
#[TentativeType]
public function current(): mixed {}
@ -1472,18 +1480,20 @@ abstract class SplHeap implements Iterator, Countable
}
/**
* @template TValue
* The SplMinHeap class provides the main functionalities of a heap, keeping the minimum on the top.
* @link https://php.net/manual/en/class.splminheap.php
* @template-extends SplHeap<TValue>
*/
class SplMinHeap extends SplHeap
{
/**
* Compare elements in order to place them correctly in the heap while sifting up.
* @link https://php.net/manual/en/splminheap.compare.php
* @param mixed $value1 <p>
* @param TValue $value1 <p>
* The value of the first node being compared.
* </p>
* @param mixed $value2 <p>
* @param TValue $value2 <p>
* The value of the second node being compared.
* </p>
* @return void Result of the comparison, positive integer if <i>value1</i> is lower than <i>value2</i>, 0 if they are equal, negative integer otherwise.
@ -1500,14 +1510,14 @@ class SplMinHeap extends SplHeap
/**
* Extracts a node from top of the heap and sift up.
* @link https://php.net/manual/en/splheap.extract.php
* @return mixed The value of the extracted node.
* @return TValue The value of the extracted node.
*/
public function extract() {}
/**
* Inserts an element in the heap by sifting it up.
* @link https://php.net/manual/en/splheap.insert.php
* @param mixed $value <p>
* @param TValue $value <p>
* The value to insert.
* </p>
* @return void
@ -1517,7 +1527,7 @@ class SplMinHeap extends SplHeap
/**
* Peeks at the node from the top of the heap
* @link https://php.net/manual/en/splheap.top.php
* @return mixed The value of the node on the top.
* @return TValue The value of the node on the top.
*/
public function top() {}
@ -1545,7 +1555,7 @@ class SplMinHeap extends SplHeap
/**
* Return current node pointed by the iterator
* @link https://php.net/manual/en/splheap.current.php
* @return mixed The current node value.
* @return TValue The current node value.
*/
public function current() {}
@ -1579,18 +1589,20 @@ class SplMinHeap extends SplHeap
}
/**
* @template TValue
* The SplMaxHeap class provides the main functionalities of a heap, keeping the maximum on the top.
* @link https://php.net/manual/en/class.splmaxheap.php
* @template-extends SplHeap<TValue>
*/
class SplMaxHeap extends SplHeap
{
/**
* Compare elements in order to place them correctly in the heap while sifting up.
* @link https://php.net/manual/en/splmaxheap.compare.php
* @param mixed $value1 <p>
* @param TValue $value1 <p>
* The value of the first node being compared.
* </p>
* @param mixed $value2 <p>
* @param TValue $value2 <p>
* The value of the second node being compared.
* </p>
* @return void Result of the comparison, positive integer if <i>value1</i> is greater than <i>value2</i>, 0 if they are equal, negative integer otherwise.
@ -1606,9 +1618,12 @@ class SplMaxHeap extends SplHeap
}
/**
* @template TPriority
* @template TValue
* The SplPriorityQueue class provides the main functionalities of an
* prioritized queue, implemented using a heap.
* @link https://php.net/manual/en/class.splpriorityqueue.php
* @template-implements Iterator<int, TValue>
*/
class SplPriorityQueue implements Iterator, Countable
{
@ -1625,10 +1640,10 @@ class SplPriorityQueue implements Iterator, Countable
/**
* Compare priorities in order to place elements correctly in the heap while sifting up.
* @link https://php.net/manual/en/splpriorityqueue.compare.php
* @param mixed $priority1 <p>
* @param TPriority $priority1 <p>
* The priority of the first node being compared.
* </p>
* @param mixed $priority2 <p>
* @param TPriority $priority2 <p>
* The priority of the second node being compared.
* </p>
* @return int Result of the comparison, positive integer if <i>priority1</i> is greater than <i>priority2</i>, 0 if they are equal, negative integer otherwise.
@ -1645,10 +1660,10 @@ class SplPriorityQueue implements Iterator, Countable
/**
* Inserts an element in the queue by sifting it up.
* @link https://php.net/manual/en/splpriorityqueue.insert.php
* @param mixed $value <p>
* @param TValue $value <p>
* The value to insert.
* </p>
* @param mixed $priority <p>
* @param TPriority $priority <p>
* The associated priority.
* </p>
* @return true
@ -1675,7 +1690,7 @@ class SplPriorityQueue implements Iterator, Countable
/**
* Peeks at the node from the top of the queue
* @link https://php.net/manual/en/splpriorityqueue.top.php
* @return mixed The value or priority (or both) of the top node, depending on the extract flag.
* @return TValue The value or priority (or both) of the top node, depending on the extract flag.
*/
#[TentativeType]
public function top(): mixed {}
@ -1683,7 +1698,7 @@ class SplPriorityQueue implements Iterator, Countable
/**
* Extracts a node from top of the heap and sift up.
* @link https://php.net/manual/en/splpriorityqueue.extract.php
* @return mixed The value or priority (or both) of the extracted node, depending on the extract flag.
* @return TValue The value or priority (or both) of the extracted node, depending on the extract flag.
*/
#[TentativeType]
public function extract(): mixed {}
@ -1715,7 +1730,7 @@ class SplPriorityQueue implements Iterator, Countable
/**
* Return current node pointed by the iterator
* @link https://php.net/manual/en/splpriorityqueue.current.php
* @return mixed The value or priority (or both) of the current node, depending on the extract flag.
* @return TValue The value or priority (or both) of the current node, depending on the extract flag.
*/
#[TentativeType]
public function current(): mixed {}
@ -1772,12 +1787,16 @@ class SplPriorityQueue implements Iterator, Countable
}
/**
* @template TValue
* The SplFixedArray class provides the main functionalities of array. The
* main differences between a SplFixedArray and a normal PHP array is that
* the SplFixedArray is of fixed length and allows only integers within
* the range as indexes. The advantage is that it allows a faster array
* implementation.
* @link https://php.net/manual/en/class.splfixedarray.php
* @template-implements Iterator<int, TValue>
* @template-implements ArrayAccess<int, TValue>
* @template-implements IteratorAggregate<int, TValue>
*/
class SplFixedArray implements Iterator, ArrayAccess, Countable, IteratorAggregate, JsonSerializable
{
@ -1799,7 +1818,7 @@ class SplFixedArray implements Iterator, ArrayAccess, Countable, IteratorAggrega
/**
* Returns a PHP array from the fixed array
* @link https://php.net/manual/en/splfixedarray.toarray.php
* @return array a PHP array, similar to the fixed array.
* @return TValue[] a PHP array, similar to the fixed array.
*/
#[TentativeType]
public function toArray(): array {}
@ -1857,7 +1876,7 @@ class SplFixedArray implements Iterator, ArrayAccess, Countable, IteratorAggrega
* @param int $index <p>
* The index with the value.
* </p>
* @return mixed The value at the specified <i>index</i>.
* @return TValue The value at the specified <i>index</i>.
*/
#[TentativeType]
public function offsetGet($index): mixed {}
@ -1868,7 +1887,7 @@ class SplFixedArray implements Iterator, ArrayAccess, Countable, IteratorAggrega
* @param int $index <p>
* The index being set.
* </p>
* @param mixed $value <p>
* @param TValue $value <p>
* The new value for the <i>index</i>.
* </p>
* @return void
@ -1897,7 +1916,7 @@ class SplFixedArray implements Iterator, ArrayAccess, Countable, IteratorAggrega
/**
* Return current array entry
* @link https://php.net/manual/en/splfixedarray.current.php
* @return mixed The current element value.
* @return TValue The current element value.
*/
public function current() {}
@ -1927,7 +1946,7 @@ class SplFixedArray implements Iterator, ArrayAccess, Countable, IteratorAggrega
public function __wakeup(): void {}
/**
* @return Traversable
* @return Traversable<int, TValue>
*/
public function getIterator(): Iterator {}
@ -1992,20 +2011,24 @@ interface SplSubject
}
/**
* @template TObject of object
* @template TValue
* The SplObjectStorage class provides a map from objects to data or, by
* ignoring data, an object set. This dual purpose can be useful in many
* cases involving the need to uniquely identify objects.
* @link https://php.net/manual/en/class.splobjectstorage.php
* @template-implements Iterator<int, TObject>
* @template-implements ArrayAccess<TObject, TValue>
*/
class SplObjectStorage implements Countable, Iterator, Serializable, ArrayAccess
{
/**
* Adds an object in the storage
* @link https://php.net/manual/en/splobjectstorage.attach.php
* @param object $object <p>
* @param TObject $object <p>
* The object to add.
* </p>
* @param mixed $info [optional] <p>
* @param TValue $info [optional] <p>
* The data to associate with the object.
* </p>
* @return void
@ -2019,7 +2042,7 @@ class SplObjectStorage implements Countable, Iterator, Serializable, ArrayAccess
/**
* Removes an object from the storage
* @link https://php.net/manual/en/splobjectstorage.detach.php
* @param object $object <p>
* @param TObject $object <p>
* The object to remove.
* </p>
* @return void
@ -2030,7 +2053,7 @@ class SplObjectStorage implements Countable, Iterator, Serializable, ArrayAccess
/**
* Checks if the storage contains a specific object
* @link https://php.net/manual/en/splobjectstorage.contains.php
* @param object $object <p>
* @param TObject $object <p>
* The object to look for.
* </p>
* @return bool true if the object is in the storage, false otherwise.
@ -2041,7 +2064,7 @@ class SplObjectStorage implements Countable, Iterator, Serializable, ArrayAccess
/**
* Adds all objects from another storage
* @link https://php.net/manual/en/splobjectstorage.addall.php
* @param SplObjectStorage $storage <p>
* @param SplObjectStorage<TObject, TValue> $storage <p>
* The storage you want to import.
* </p>
* @return int
@ -2052,7 +2075,7 @@ class SplObjectStorage implements Countable, Iterator, Serializable, ArrayAccess
/**
* Removes objects contained in another storage from the current storage
* @link https://php.net/manual/en/splobjectstorage.removeall.php
* @param SplObjectStorage $storage <p>
* @param SplObjectStorage<TObject, TValue> $storage <p>
* The storage containing the elements to remove.
* </p>
* @return int
@ -2063,7 +2086,7 @@ class SplObjectStorage implements Countable, Iterator, Serializable, ArrayAccess
/**
* Removes all objects except for those contained in another storage from the current storage
* @link https://php.net/manual/en/splobjectstorage.removeallexcept.php
* @param SplObjectStorage $storage <p>
* @param SplObjectStorage<TObject, TValue> $storage <p>
* The storage containing the elements to retain in the current storage.
* </p>
* @return int
@ -2075,7 +2098,7 @@ class SplObjectStorage implements Countable, Iterator, Serializable, ArrayAccess
/**
* Returns the data associated with the current iterator entry
* @link https://php.net/manual/en/splobjectstorage.getinfo.php
* @return mixed The data associated with the current iterator position.
* @return TValue The data associated with the current iterator position.
*/
#[TentativeType]
public function getInfo(): mixed {}
@ -2083,7 +2106,7 @@ class SplObjectStorage implements Countable, Iterator, Serializable, ArrayAccess
/**
* Sets the data associated with the current iterator entry
* @link https://php.net/manual/en/splobjectstorage.setinfo.php
* @param mixed $info <p>
* @param TValue $info <p>
* The data to associate with the current iterator entry.
* </p>
* @return void
@ -2127,7 +2150,7 @@ class SplObjectStorage implements Countable, Iterator, Serializable, ArrayAccess
/**
* Returns the current storage entry
* @link https://php.net/manual/en/splobjectstorage.current.php
* @return object The object at the current iterator position.
* @return TObject The object at the current iterator position.
*/
#[TentativeType]
public function current(): object {}
@ -2164,7 +2187,7 @@ class SplObjectStorage implements Countable, Iterator, Serializable, ArrayAccess
/**
* Checks whether an object exists in the storage
* @link https://php.net/manual/en/splobjectstorage.offsetexists.php
* @param object $object <p>
* @param TObject $object <p>
* The object to look for.
* </p>
* @return bool true if the object exists in the storage,
@ -2176,10 +2199,10 @@ class SplObjectStorage implements Countable, Iterator, Serializable, ArrayAccess
/**
* Associates data to an object in the storage
* @link https://php.net/manual/en/splobjectstorage.offsetset.php
* @param object $object <p>
* @param TObject $object <p>
* The object to associate data with.
* </p>
* @param mixed $info [optional] <p>
* @param TValue $info [optional] <p>
* The data to associate with the object.
* </p>
* @return void
@ -2193,7 +2216,7 @@ class SplObjectStorage implements Countable, Iterator, Serializable, ArrayAccess
/**
* Removes an object from the storage
* @link https://php.net/manual/en/splobjectstorage.offsetunset.php
* @param object $object <p>
* @param TObject $object <p>
* The object to remove.
* </p>
* @return void
@ -2204,10 +2227,10 @@ class SplObjectStorage implements Countable, Iterator, Serializable, ArrayAccess
/**
* Returns the data associated with an <type>object</type>
* @link https://php.net/manual/en/splobjectstorage.offsetget.php
* @param object $object <p>
* @param TObject $object <p>
* The object to look for.
* </p>
* @return mixed The data previously associated with the object in the storage.
* @return TValue The data previously associated with the object in the storage.
*/
#[TentativeType]
public function offsetGet($object): mixed {}
@ -2215,7 +2238,7 @@ class SplObjectStorage implements Countable, Iterator, Serializable, ArrayAccess
/**
* Calculate a unique identifier for the contained objects
* @link https://php.net/manual/en/splobjectstorage.gethash.php
* @param object $object <p>
* @param TObject $object <p>
* object whose identifier is to be calculated.
* </p>
* @return string A string with the calculated identifier.

19
standard/_types.php
View File

@ -149,9 +149,16 @@ namespace {
function PS_UNRESERVE_PREFIX_eval($code) {}
/**
* @template TKey of array-key
* @template TSend
* @template TReturn
* @template TYield
*
* Generator objects are returned from generators, cannot be instantiated via new.
* @link https://secure.php.net/manual/en/class.generator.php
* @link https://wiki.php.net/rfc/generators
*
* @template-implements Iterator<TKey, TYield>
*/
final class Generator implements Iterator
{
@ -169,13 +176,13 @@ namespace {
/**
* Returns whatever was passed to yield or null if nothing was passed or the generator is already closed.
* @return mixed
* @return TYield|null
*/
public function current(): mixed {}
/**
* Returns the yielded key or, if none was specified, an auto-incrementing key or null if the generator is already closed.
* @return string|float|int|bool|null
* @return TKey
*/
#[LanguageLevelTypeAware(['8.0' => 'mixed'], default: 'string|float|int|bool|null')]
public function key() {}
@ -188,15 +195,15 @@ namespace {
/**
* Sets the return value of the yield expression and resumes the generator (unless the generator is already closed).
* @param mixed $value
* @return mixed
* @param TSend $value
* @return TYield|null
*/
public function send(mixed $value): mixed {}
/**
* Throws an exception at the current suspension point in the generator.
* @param Throwable $exception
* @return mixed
* @return TYield|null
*/
public function PS_UNRESERVE_PREFIX_throw(Throwable $exception): mixed {}
@ -204,7 +211,7 @@ namespace {
* Returns whatever was passed to return or null if nothing.
* Throws an exception if the generator is still valid.
* @link https://wiki.php.net/rfc/generator-return-expressions
* @return mixed
* @return TReturn
* @since 7.0
*/
public function getReturn(): mixed {}