*/
interface IteratorAggregate extends Traversable {
/**
* Retrieve an external iterator
* @link http://php.net/manual/en/iteratoraggregate.getiterator.php
* @return Traversable
* An offset to check for.
*
* The return value will be casted to boolean if non-boolean was returned. * @since 5.0.0 */ public function offsetExists($offset); /** * Offset to retrieve * @link http://php.net/manual/en/arrayaccess.offsetget.php * @param TKey $offset
* The offset to retrieve. *
* @return TValue|null Can return all value types. * @psalm-ignore-nullable-return * @since 5.0.0 */ public function offsetGet($offset); /** * Offset to set * @link http://php.net/manual/en/arrayaccess.offsetset.php * @param TKey $offset* The offset to assign the value to. *
* @param TValue $value* The value to set. *
* @return void * @since 5.0.0 */ public function offsetSet($offset, $value); /** * Offset to unset * @link http://php.net/manual/en/arrayaccess.offsetunset.php * @param TKey $offset* The offset to unset. *
* @return void * @since 5.0.0 */ public function offsetUnset($offset); } /** * This class allows objects to work as arrays. * @link http://php.net/manual/en/class.arrayobject.php * * @template TKey * @template TValue * @template-implements IteratorAggregate* The index being checked. *
* @return bool true if the requested index exists, otherwise false * @since 5.0.0 */ public function offsetExists($index) { } /** * Returns the value at the specified index * @link http://php.net/manual/en/arrayobject.offsetget.php * @param TKey $index* The index with the value. *
* @return TValue The value at the specified index or false. * @since 5.0.0 */ public function offsetGet($index) { } /** * Sets the value at the specified index to newval * @link http://php.net/manual/en/arrayobject.offsetset.php * @param TKey $index* The index being set. *
* @param TValue $newval* The new value for the index. *
* @return void * @since 5.0.0 */ public function offsetSet($index, $newval) { } /** * Unsets the value at the specified index * @link http://php.net/manual/en/arrayobject.offsetunset.php * @param TKey $index* The index being unset. *
* @return void * @since 5.0.0 */ public function offsetUnset($index) { } /** * Appends the value * @link http://php.net/manual/en/arrayobject.append.php * @param TValue $value* The value being appended. *
* @return void * @since 5.0.0 */ public function append($value) { } /** * Creates a copy of the ArrayObject. * @link http://php.net/manual/en/arrayobject.getarraycopy.php * @return array* The new ArrayObject behavior. * It takes on either a bitmask, or named constants. Using named * constants is strongly encouraged to ensure compatibility for future * versions. *
** The available behavior flags are listed below. The actual * meanings of these flags are described in the * predefined constants. *
value | *constant | *
1 | ** ArrayObject::STD_PROP_LIST * | *
2 | ** ArrayObject::ARRAY_AS_PROPS * | *
* Function cmp_function should accept two * parameters which will be filled by pairs of entries. * 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. *
* @return void * @since 5.2.0 */ public function uasort($cmp_function) { } /** * Sort the entries by keys using a user-defined comparison function * @link http://php.net/manual/en/arrayobject.uksort.php * @param callback $cmp_function* The callback comparison function. *
** Function cmp_function should accept two * parameters which will be filled by pairs of entry keys. * 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. *
* @return void * @since 5.2.0 */ public function uksort($cmp_function) { } /** * Sort entries using a "natural order" algorithm * @link http://php.net/manual/en/arrayobject.natsort.php * @return void * @since 5.2.0 */ public function natsort() { } /** * Sort an array using a case insensitive "natural order" algorithm * @link http://php.net/manual/en/arrayobject.natcasesort.php * @return void * @since 5.2.0 */ public function natcasesort() { } /** * Unserialize an ArrayObject * @link http://php.net/manual/en/arrayobject.unserialize.php * @param string $serialized* The serialized ArrayObject. *
* @return void The unserialized ArrayObject. * @since 5.3.0 */ public function unserialize($serialized) { } /** * Serialize an ArrayObject * @link http://php.net/manual/en/arrayobject.serialize.php * @return string The serialized representation of the ArrayObject. * @since 5.3.0 */ public function serialize() { } /** * Create a new iterator from an ArrayObject instance * @link http://php.net/manual/en/arrayobject.getiterator.php * @return ArrayIterator* The new array or object to exchange with the current array. *
* @return array the old array. * @since 5.1.0 */ public function exchangeArray($input) { } /** * Sets the iterator classname for the ArrayObject. * @link http://php.net/manual/en/arrayobject.setiteratorclass.php * @param string $iterator_class* The classname of the array iterator to use when iterating over this object. *
* @return void * @since 5.1.0 */ public function setIteratorClass($iterator_class) { } /** * Gets the iterator classname for the ArrayObject. * @link http://php.net/manual/en/arrayobject.getiteratorclass.php * @return string the iterator class name that is used to iterate over this object. * @since 5.1.0 */ public function getIteratorClass() { } } /** * The Seekable iterator. * @link https://php.net/manual/en/class.seekableiterator.php * @template TKey * @template TValue * @template-extends Iterator* The position to seek to. *
* @return void * @since 5.1.0 */ public function seek($position); } /** * This iterator allows to unset and modify values and keys while iterating * over Arrays and Objects. * @link http://php.net/manual/en/class.arrayiterator.php * * @template TKey as array-key * @template TValue * @template-implements SeekableIterator* The offset being checked. *
* @return bool true if the offset exists, otherwise false * @since 5.0.0 */ public function offsetExists($index) { } /** * Get value for an offset * @link http://php.net/manual/en/arrayiterator.offsetget.php * @param TKey $index* The offset to get the value from. *
* @return TValue The value at offset index. * @since 5.0.0 */ public function offsetGet($index) { } /** * Set value for an offset * @link http://php.net/manual/en/arrayiterator.offsetset.php * @param TKey $index* The index to set for. *
* @param TValue $newval* The new value to store at the index. *
* @return void * @since 5.0.0 */ public function offsetSet($index, $newval) { } /** * Unset value for an offset * @link http://php.net/manual/en/arrayiterator.offsetunset.php * @param TKey $index* The offset to unset. *
* @return void * @since 5.0.0 */ public function offsetUnset($index) { } /** * Append an element * @link http://php.net/manual/en/arrayiterator.append.php * @param TValue $value* The value to append. *
* @return void * @since 5.0.0 */ public function append($value) { } /** * Get array copy * @link http://php.net/manual/en/arrayiterator.getarraycopy.php * @return array A copy of the array, or array of public properties * if ArrayIterator refers to an object. * @since 5.0.0 */ public function getArrayCopy() { } /** * Count elements * @link http://php.net/manual/en/arrayiterator.count.php * @return int The number of elements or public properties in the associated * array or object, respectively. * @since 5.0.0 */ public function count() { } /** * Get flags * @link http://php.net/manual/en/arrayiterator.getflags.php * @return string The current flags. * @since 5.1.0 */ public function getFlags() { } /** * Set behaviour flags * @link http://php.net/manual/en/arrayiterator.setflags.php * @param string $flags* A bitmask as follows: * 0 = Properties of the object have their normal functionality * when accessed as list (var_dump, foreach, etc.). * 1 = Array indices can be accessed as properties in read/write. *
* @return void * @since 5.1.0 */ public function setFlags($flags) { } /** * Sort array by values * @link http://php.net/manual/en/arrayiterator.asort.php * @return void * @since 5.2.0 */ public function asort() { } /** * Sort array by keys * @link http://php.net/manual/en/arrayiterator.ksort.php * @return void * @since 5.2.0 */ public function ksort() { } /** * User defined sort * @link http://php.net/manual/en/arrayiterator.uasort.php * @param string $cmp_function* The compare function used for the sort. *
* @return void * @since 5.2.0 */ public function uasort($cmp_function) { } /** * User defined sort * @link http://php.net/manual/en/arrayiterator.uksort.php * @param string $cmp_function* The compare function used for the sort. *
* @return void * @since 5.2.0 */ public function uksort($cmp_function) { } /** * Sort an array naturally * @link http://php.net/manual/en/arrayiterator.natsort.php * @return void * @since 5.2.0 */ public function natsort() { } /** * Sort an array naturally, case insensitive * @link http://php.net/manual/en/arrayiterator.natcasesort.php * @return void * @since 5.2.0 */ public function natcasesort() { } /** * Unserialize * @link http://php.net/manual/en/arrayiterator.unserialize.php * @param string $serialized* The serialized ArrayIterator object to be unserialized. *
* @return void The ArrayIterator. * @since 5.3.0 */ public function unserialize($serialized) { } /** * Serialize * @link http://php.net/manual/en/arrayiterator.serialize.php * @return string The serialized ArrayIterator. * @since 5.3.0 */ public function serialize() { } /** * Rewind array back to the start * @link http://php.net/manual/en/arrayiterator.rewind.php * @return void * @since 5.0.0 */ public function rewind() { } /** * Return current array entry * @link http://php.net/manual/en/arrayiterator.current.php * @return mixed The current array entry. * @since 5.0.0 */ public function current() { } /** * Return current array key * @link http://php.net/manual/en/arrayiterator.key.php * @return mixed The current array key. * @since 5.0.0 */ public function key() { } /** * Move to next entry * @link http://php.net/manual/en/arrayiterator.next.php * @return void * @since 5.0.0 */ public function next() { } /** * Check whether array contains more entries * @link http://php.net/manual/en/arrayiterator.valid.php * @return bool * @since 5.0.0 */ public function valid() { } /** * Seek to position * @link http://php.net/manual/en/arrayiterator.seek.php * @param int $position* The position to seek to. *
* @return void * @since 5.0.0 */ public function seek($position) { } } /** * The DOMElement class * @link http://php.net/manual/en/class.domelement.php */ class DOMDocument extends DOMNode { /** * @return DOMNodeList* The value to push. *
* @return void * @since 5.3.0 */ public function push ($value) {} /** * Prepends the doubly linked list with an element * @link https://php.net/manual/en/spldoublylinkedlist.unshift.php * @param TValue $value* The value to unshift. *
* @return void * @since 5.3.0 */ public function unshift ($value) {} /** * Peeks at the node from the end of the doubly linked list * @link https://php.net/manual/en/spldoublylinkedlist.top.php * @return TValue The value of the last node. * @since 5.3.0 */ public function top () {} /** * Peeks at the node from the beginning of the doubly linked list * @link https://php.net/manual/en/spldoublylinkedlist.bottom.php * @return TValue The value of the first node. * @since 5.3.0 */ public function bottom () {} /** * Counts the number of elements in the doubly linked list. * @link https://php.net/manual/en/spldoublylinkedlist.count.php * @return int the number of elements in the doubly linked list. * @since 5.3.0 */ public function count () {} /** * Checks whether the doubly linked list is empty. * @link https://php.net/manual/en/spldoublylinkedlist.isempty.php * @return bool whether the doubly linked list is empty. * @since 5.3.0 */ public function isEmpty () {} /** * Returns whether the requested $index exists * @link https://php.net/manual/en/spldoublylinkedlist.offsetexists.php * @param TKey $index* The index being checked. *
* @return bool true if the requested index exists, otherwise false * @since 5.3.0 */ public function offsetExists ($index) {} /** * Returns the value at the specified $index * @link https://php.net/manual/en/spldoublylinkedlist.offsetget.php * @param TKey $index* The index with the value. *
* @return TValue The value at the specified index. * @since 5.3.0 */ public function offsetGet ($index) {} /** * Sets the value at the specified $index to $newval * @link https://php.net/manual/en/spldoublylinkedlist.offsetset.php * @param TKey $index* The index being set. *
* @param TValue $newval* The new value for the index. *
* @return void * @since 5.3.0 */ public function offsetSet ($index, $newval) {} /** * Unsets the value at the specified $index * @link https://php.net/manual/en/spldoublylinkedlist.offsetunset.php * @param TKey $index* The index being unset. *
* @return void * @since 5.3.0 */ public function offsetUnset ($index) {} /** * Return current array entry * @link https://php.net/manual/en/spldoublylinkedlist.current.php * @return TValue The current node value. * @since 5.3.0 */ public function current () {} /** * Return current node index * @link https://php.net/manual/en/spldoublylinkedlist.key.php * @return TKey The current node index. * @since 5.3.0 */ public function key () {} } /** * 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 * @template TValue * @template-extends SplDoublyLinkedList* The value to enqueue. *
* @return void * @since 5.3.0 */ public function enqueue ($value) {} /** * Dequeues a node from the queue * @link https://php.net/manual/en/splqueue.dequeue.php * @return TValue The value of the dequeued node. * @since 5.3.0 */ public function dequeue () {} } /** * 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 TObject as object * @template TArrayValue * @template-implements ArrayAccess* The object to add. *
* @param TArrayValue|null $data [optional]* The data to associate with the object. *
* @return void * @since 5.1.0 */ public function attach ($object, $data = null) {} /** * Removes an object from the storage * @link https://php.net/manual/en/splobjectstorage.detach.php * @param TObject $object* The object to remove. *
* @return void * @since 5.1.0 */ public function detach ($object) {} /** * Checks if the storage contains a specific object * @link https://php.net/manual/en/splobjectstorage.contains.php * @param TObject $object* The object to look for. *
* @return bool true if the object is in the storage, false otherwise. * @since 5.1.0 */ public function contains ($object) {} /** * Adds all objects from another storage * @link https://php.net/manual/en/splobjectstorage.addall.php * @param SplObjectStorage* The storage you want to import. *
* @return void * @since 5.3.0 */ public function addAll ($storage) {} /** * Removes objects contained in another storage from the current storage * @link https://php.net/manual/en/splobjectstorage.removeall.php * @param SplObjectStorage* The storage containing the elements to remove. *
* @return void * @since 5.3.0 */ public function removeAll ($storage) {} /** * 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* The storage containing the elements to retain in the current storage. *
* @return void * @since 5.3.6 */ public function removeAllExcept ($storage) {} /** * Returns the data associated with the current iterator entry * @link https://php.net/manual/en/splobjectstorage.getinfo.php * @return TArrayValue The data associated with the current iterator position. * @since 5.3.0 */ public function getInfo () {} /** * Sets the data associated with the current iterator entry * @link https://php.net/manual/en/splobjectstorage.setinfo.php * @param TArrayValue $data* The data to associate with the current iterator entry. *
* @return void * @since 5.3.0 */ public function setInfo ($data) {} /** * Returns the number of objects in the storage * @link https://php.net/manual/en/splobjectstorage.count.php * @return int The number of objects in the storage. * @since 5.1.0 */ public function count () {} /** * Rewind the iterator to the first storage element * @link https://php.net/manual/en/splobjectstorage.rewind.php * @return void * @since 5.1.0 */ public function rewind () {} /** * Returns if the current iterator entry is valid * @link https://php.net/manual/en/splobjectstorage.valid.php * @return bool true if the iterator entry is valid, false otherwise. * @since 5.1.0 */ public function valid () {} /** * Returns the index at which the iterator currently is * @link https://php.net/manual/en/splobjectstorage.key.php * @return int The index corresponding to the position of the iterator. * @since 5.1.0 */ public function key () {} /** * Returns the current storage entry * @link https://php.net/manual/en/splobjectstorage.current.php * @return TObject The object at the current iterator position. * @since 5.1.0 */ public function current () {} /** * Move to the next entry * @link https://php.net/manual/en/splobjectstorage.next.php * @return void * @since 5.1.0 */ public function next () {} /** * Unserializes a storage from its string representation * @link https://php.net/manual/en/splobjectstorage.unserialize.php * @param string $serialized* The serialized representation of a storage. *
* @return void * @since 5.2.2 */ public function unserialize ($serialized) {} /** * Serializes the storage * @link https://php.net/manual/en/splobjectstorage.serialize.php * @return string A string representing the storage. * @since 5.2.2 */ public function serialize () {} /** * Checks whether an object exists in the storage * @link https://php.net/manual/en/splobjectstorage.offsetexists.php * @param TObject $object* The object to look for. *
* @return bool true if the object exists in the storage, * and false otherwise. * @since 5.3.0 */ public function offsetExists ($object) {} /** * Associates data to an object in the storage * @link https://php.net/manual/en/splobjectstorage.offsetset.php * @param TObject $object* The object to associate data with. *
* @param TArrayValue|null $data [optional]* The data to associate with the object. *
* @return void * @since 5.3.0 */ public function offsetSet ($object, $data = null) {} /** * Removes an object from the storage * @link https://php.net/manual/en/splobjectstorage.offsetunset.php * @param TObject $object* The object to remove. *
* @return void * @since 5.3.0 */ public function offsetUnset ($object) {} /** * Returns the data associated with an* The object to look for. *
* @return TArrayValue The data previously associated with the object in the storage. * @since 5.3.0 */ public function offsetGet ($object) {} /** * Calculate a unique identifier for the contained objects * @link https://php.net/manual/en/splobjectstorage.gethash.php * @param $object* object whose identifier is to be calculated. * @return string A string with the calculated identifier. * @since 5.4.0 */ public function getHash($object) {} }