From 9a0df3080cb6a024046096457f1c4cb457a40a83 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Dawid=20Paku=C5=82a?=
Internal (built-in) classes that implement this interface can be used in - * a foreach construct and do not need to implement - * IteratorAggregate or - * Iterator.
- *This is an internal engine interface which cannot be implemented in PHP - * scripts. Either IteratorAggregate or - * Iterator must be used instead. - * When implementing an interface which extends Traversable, make sure to - * list IteratorAggregate or - * Iterator before its name in the implements - * clause.
- * @link http://www.php.net/manual/en/class.traversable.php - */ interface Traversable { } -/** - * Interface to create an external Iterator. - * @link http://www.php.net/manual/en/class.iteratoraggregate.php - */ interface IteratorAggregate extends Traversable { /** - * Retrieve an external iterator - * @link http://www.php.net/manual/en/iteratoraggregate.getiterator.php - * @return Traversable An instance of an object implementing Iterator or - * Traversable + * {@inheritdoc} */ - abstract public function getIterator (): Traversable; + abstract public function getIterator (); } -/** - * Interface for external iterators or objects that can be iterated - * themselves internally. - * @link http://www.php.net/manual/en/class.iterator.php - */ interface Iterator extends Traversable { /** - * Return the current element - * @link http://www.php.net/manual/en/iterator.current.php - * @return mixed Can return any type. + * {@inheritdoc} */ - abstract public function current (): mixed; + abstract public function current (); /** - * Move forward to next element - * @link http://www.php.net/manual/en/iterator.next.php - * @return void Any returned value is ignored. + * {@inheritdoc} */ - abstract public function next (): void; + abstract public function next (); /** - * Return the key of the current element - * @link http://www.php.net/manual/en/iterator.key.php - * @return mixed Returns scalar on success, or null on failure. + * {@inheritdoc} */ - abstract public function key (): mixed; + abstract public function key (); /** - * Checks if current position is valid - * @link http://www.php.net/manual/en/iterator.valid.php - * @return bool The return value will be casted to bool and then evaluated. - * Returns true on success or false on failure. + * {@inheritdoc} */ - abstract public function valid (): bool; + abstract public function valid (); /** - * Rewind the Iterator to the first element - * @link http://www.php.net/manual/en/iterator.rewind.php - * @return void Any returned value is ignored. + * {@inheritdoc} */ - abstract public function rewind (): void; + abstract public function rewind (); } -/** - * Interface for customized serializing. - *Classes that implement this interface no longer support - * __sleep() and - * __wakeup(). The method serialize is - * called whenever an instance needs to be serialized. This does not invoke __destruct() - * or have any other side effect unless programmed inside the method. When the data is - * unserialized the class is known and the appropriate unserialize() method is called as - * a constructor instead of calling __construct(). If you need to execute the standard - * constructor you may do so in the method.
- *As of PHP 8.1.0, a class which implements Serializable without also implementing __serialize() and __unserialize() will generate a deprecation warning.
- * @link http://www.php.net/manual/en/class.serializable.php - */ interface Serializable { /** - * String representation of object - * @link http://www.php.net/manual/en/serializable.serialize.php - * @return string|null Returns the string representation of the object or null + * {@inheritdoc} */ - abstract public function serialize (): ?string; + abstract public function serialize (); /** - * Constructs the object - * @link http://www.php.net/manual/en/serializable.unserialize.php - * @param string $data - * @return void The return value from this method is ignored. + * {@inheritdoc} + * @param string $data */ - abstract public function unserialize (string $data): void; + abstract public function unserialize (string $data); } -/** - * Interface to provide accessing objects as arrays. - * @link http://www.php.net/manual/en/class.arrayaccess.php - */ interface ArrayAccess { /** - * Whether an offset exists - * @link http://www.php.net/manual/en/arrayaccess.offsetexists.php - * @param mixed $offset - * @return bool Returns true on success or false on failure. - *The return value will be casted to bool if non-boolean was returned.
+ * {@inheritdoc} + * @param mixed $offset */ - abstract public function offsetExists (mixed $offset): bool; + abstract public function offsetExists (mixed $offset = null); /** - * Offset to retrieve - * @link http://www.php.net/manual/en/arrayaccess.offsetget.php - * @param mixed $offset - * @return mixed Can return all value types. + * {@inheritdoc} + * @param mixed $offset */ - abstract public function offsetGet (mixed $offset): mixed; + abstract public function offsetGet (mixed $offset = null); /** - * Assign a value to the specified offset - * @link http://www.php.net/manual/en/arrayaccess.offsetset.php - * @param mixed $offset - * @param mixed $value - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $offset + * @param mixed $value */ - abstract public function offsetSet (mixed $offset, mixed $value): void; + abstract public function offsetSet (mixed $offset = null, mixed $value = null); /** - * Unset an offset - * @link http://www.php.net/manual/en/arrayaccess.offsetunset.php - * @param mixed $offset - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $offset */ - abstract public function offsetUnset (mixed $offset): void; + abstract public function offsetUnset (mixed $offset = null); } -/** - * Classes implementing Countable can be used with the - * count function. - * @link http://www.php.net/manual/en/class.countable.php - */ interface Countable { /** - * Count elements of an object - * @link http://www.php.net/manual/en/countable.count.php - * @return int The custom count as an int. - *The return value is cast to an int.
+ * {@inheritdoc} */ - abstract public function count (): int; + abstract public function count (); } -/** - * The Stringable interface denotes a class as - * having a __toString() method. Unlike most interfaces, - * Stringable is implicitly present on any class that - * has the magic __toString() method defined, although it - * can and should be declared explicitly. - *Its primary value is to allow functions to type check against the union - * type string|Stringable to accept either a string primitive - * or an object that can be cast to a string.
- * @link http://www.php.net/manual/en/class.stringable.php - */ interface Stringable { /** - * Gets a string representation of the object - * @link http://www.php.net/manual/en/stringable.tostring.php - * @return string Returns the string representation of the object. + * {@inheritdoc} */ abstract public function __toString (): string; } -/** - * Class to ease implementing IteratorAggregate - * for internal classes. - * @link http://www.php.net/manual/en/class.internaliterator.php - */ final class InternalIterator implements Iterator, Traversable { /** - * Private constructor to disallow direct instantiation - * @link http://www.php.net/manual/en/internaliterator.construct.php + * {@inheritdoc} */ private function __construct () {} /** - * Return the current element - * @link http://www.php.net/manual/en/internaliterator.current.php - * @return mixed Returns the current element. + * {@inheritdoc} */ public function current (): mixed {} /** - * Return the key of the current element - * @link http://www.php.net/manual/en/internaliterator.key.php - * @return mixed Returns the key of the current element. + * {@inheritdoc} */ public function key (): mixed {} /** - * Move forward to next element - * @link http://www.php.net/manual/en/internaliterator.next.php - * @return void No value is returned. + * {@inheritdoc} */ public function next (): void {} /** - * Check if current position is valid - * @link http://www.php.net/manual/en/internaliterator.valid.php - * @return bool Returns whether the current position is valid. + * {@inheritdoc} */ public function valid (): bool {} /** - * Rewind the Iterator to the first element - * @link http://www.php.net/manual/en/internaliterator.rewind.php - * @return void No value is returned. + * {@inheritdoc} */ public function rewind (): void {} } -/** - * Throwable is the base interface for any object that - * can be thrown via a throw statement, including - * Error and Exception. - *PHP classes cannot implement the Throwable - * interface directly, and must instead extend - * Exception.
- * @link http://www.php.net/manual/en/class.throwable.php - */ interface Throwable extends Stringable { /** - * Gets the message - * @link http://www.php.net/manual/en/throwable.getmessage.php - * @return string Returns the message associated with the thrown object. + * {@inheritdoc} */ abstract public function getMessage (): string; /** - * Gets the exception code - * @link http://www.php.net/manual/en/throwable.getcode.php - * @return int Returns the exception code as int in - * Exception but possibly as other type in - * Exception descendants (for example as - * string in PDOException). + * {@inheritdoc} */ - abstract public function getCode (): int; + abstract public function getCode (); /** - * Gets the file in which the object was created - * @link http://www.php.net/manual/en/throwable.getfile.php - * @return string Returns the filename in which the thrown object was created. + * {@inheritdoc} */ abstract public function getFile (): string; /** - * Gets the line on which the object was instantiated - * @link http://www.php.net/manual/en/throwable.getline.php - * @return int Returns the line number where the thrown object was instantiated. + * {@inheritdoc} */ abstract public function getLine (): int; /** - * Gets the stack trace - * @link http://www.php.net/manual/en/throwable.gettrace.php - * @return array Returns the stack trace as an array in the same format as - * debug_backtrace. + * {@inheritdoc} */ abstract public function getTrace (): array; /** - * Returns the previous Throwable - * @link http://www.php.net/manual/en/throwable.getprevious.php - * @return Throwable|null Returns the previous Throwable if available, or - * null otherwise. + * {@inheritdoc} */ abstract public function getPrevious (): ?Throwable; /** - * Gets the stack trace as a string - * @link http://www.php.net/manual/en/throwable.gettraceasstring.php - * @return string Returns the stack trace as a string. + * {@inheritdoc} */ abstract public function getTraceAsString (): string; /** - * Gets a string representation of the object - * @link http://www.php.net/manual/en/stringable.tostring.php - * @return string Returns the string representation of the object. + * {@inheritdoc} */ abstract public function __toString (): string; } -/** - * Exception is the base class for - * all user exceptions. - * @link http://www.php.net/manual/en/class.exception.php - */ class Exception implements Stringable, Throwable { - /** - * The exception message - * @var string - * @link http://www.php.net/manual/en/class.exception.php#exception.props.message - */ - protected string $message; + protected $message; - /** - * The exception code - * @var int - * @link http://www.php.net/manual/en/class.exception.php#exception.props.code - */ - protected int $code; + protected $code; - /** - * The filename where the exception was created - * @var string - * @link http://www.php.net/manual/en/class.exception.php#exception.props.file - */ protected string $file; - /** - * The line where the exception was created - * @var int - * @link http://www.php.net/manual/en/class.exception.php#exception.props.line - */ protected int $line; /** - * Clone the exception - * @link http://www.php.net/manual/en/exception.clone.php - * @return void No value is returned. + * {@inheritdoc} */ private function __clone (): void {} /** - * Construct the exception - * @link http://www.php.net/manual/en/exception.construct.php - * @param string $message [optional] - * @param int $code [optional] - * @param Throwable|null $previous [optional] - * @return string + * {@inheritdoc} + * @param string $message [optional] + * @param int $code [optional] + * @param Throwable|null $previous [optional] */ - public function __construct (string $message = '""', int $code = null, ?Throwable $previous = null): string {} + public function __construct (string $message = '', int $code = 0, ?Throwable $previous = NULL) {} /** * {@inheritdoc} @@ -379,97 +212,64 @@ public function __construct (string $message = '""', int $code = null, ?Throwabl public function __wakeup () {} /** - * Gets the Exception message - * @link http://www.php.net/manual/en/exception.getmessage.php - * @return string Returns the Exception message as a string. + * {@inheritdoc} */ final public function getMessage (): string {} /** - * Gets the Exception code - * @link http://www.php.net/manual/en/exception.getcode.php - * @return int Returns the exception code as int in - * Exception but possibly as other type in - * Exception descendants (for example as - * string in PDOException). + * {@inheritdoc} */ - final public function getCode (): int {} + final public function getCode () {} /** - * Gets the file in which the exception was created - * @link http://www.php.net/manual/en/exception.getfile.php - * @return string Returns the filename in which the exception was created. + * {@inheritdoc} */ final public function getFile (): string {} /** - * Gets the line in which the exception was created - * @link http://www.php.net/manual/en/exception.getline.php - * @return int Returns the line number where the exception was created. + * {@inheritdoc} */ final public function getLine (): int {} /** - * Gets the stack trace - * @link http://www.php.net/manual/en/exception.gettrace.php - * @return array Returns the Exception stack trace as an array. + * {@inheritdoc} */ final public function getTrace (): array {} /** - * Returns previous Throwable - * @link http://www.php.net/manual/en/exception.getprevious.php - * @return Throwable|null Returns the previous Throwable if available - * or null otherwise. + * {@inheritdoc} */ final public function getPrevious (): ?Throwable {} /** - * Gets the stack trace as a string - * @link http://www.php.net/manual/en/exception.gettraceasstring.php - * @return string Returns the Exception stack trace as a string. + * {@inheritdoc} */ final public function getTraceAsString (): string {} /** - * String representation of the exception - * @link http://www.php.net/manual/en/exception.tostring.php - * @return string Returns the string representation of the exception. + * {@inheritdoc} */ public function __toString (): string {} } -/** - * An Error Exception. - * @link http://www.php.net/manual/en/class.errorexception.php - */ class ErrorException extends Exception implements Throwable, Stringable { - /** - * The severity of the exception - * @var int - * @link http://www.php.net/manual/en/class.errorexception.php#errorexception.props.severity - */ protected int $severity; /** - * Constructs the exception - * @link http://www.php.net/manual/en/errorexception.construct.php - * @param string $message [optional] - * @param int $code [optional] - * @param int $severity [optional] - * @param string|null $filename [optional] - * @param int|null $line [optional] - * @param Throwable|null $previous [optional] - * @return string + * {@inheritdoc} + * @param string $message [optional] + * @param int $code [optional] + * @param int $severity [optional] + * @param string|null $filename [optional] + * @param int|null $line [optional] + * @param Throwable|null $previous [optional] */ - public function __construct (string $message = '""', int $code = null, int $severity = E_ERROR, ?string $filename = null, ?int $line = null, ?Throwable $previous = null): string {} + public function __construct (string $message = '', int $code = 0, int $severity = 1, ?string $filename = NULL, ?int $line = NULL, ?Throwable $previous = NULL) {} /** - * Gets the exception severity - * @link http://www.php.net/manual/en/errorexception.getseverity.php - * @return int Returns the severity level of the exception. + * {@inheritdoc} */ final public function getSeverity (): int {} @@ -479,118 +279,69 @@ final public function getSeverity (): int {} public function __wakeup () {} /** - * Gets the Exception message - * @link http://www.php.net/manual/en/exception.getmessage.php - * @return string Returns the Exception message as a string. + * {@inheritdoc} */ final public function getMessage (): string {} /** - * Gets the Exception code - * @link http://www.php.net/manual/en/exception.getcode.php - * @return int Returns the exception code as int in - * Exception but possibly as other type in - * Exception descendants (for example as - * string in PDOException). + * {@inheritdoc} */ - final public function getCode (): int {} + final public function getCode () {} /** - * Gets the file in which the exception was created - * @link http://www.php.net/manual/en/exception.getfile.php - * @return string Returns the filename in which the exception was created. + * {@inheritdoc} */ final public function getFile (): string {} /** - * Gets the line in which the exception was created - * @link http://www.php.net/manual/en/exception.getline.php - * @return int Returns the line number where the exception was created. + * {@inheritdoc} */ final public function getLine (): int {} /** - * Gets the stack trace - * @link http://www.php.net/manual/en/exception.gettrace.php - * @return array Returns the Exception stack trace as an array. + * {@inheritdoc} */ final public function getTrace (): array {} /** - * Returns previous Throwable - * @link http://www.php.net/manual/en/exception.getprevious.php - * @return Throwable|null Returns the previous Throwable if available - * or null otherwise. + * {@inheritdoc} */ final public function getPrevious (): ?Throwable {} /** - * Gets the stack trace as a string - * @link http://www.php.net/manual/en/exception.gettraceasstring.php - * @return string Returns the Exception stack trace as a string. + * {@inheritdoc} */ final public function getTraceAsString (): string {} /** - * String representation of the exception - * @link http://www.php.net/manual/en/exception.tostring.php - * @return string Returns the string representation of the exception. + * {@inheritdoc} */ public function __toString (): string {} } -/** - * Error is the base class for all - * internal PHP errors. - * @link http://www.php.net/manual/en/class.error.php - */ class Error implements Stringable, Throwable { - /** - * The error message - * @var string - * @link http://www.php.net/manual/en/class.error.php#error.props.message - */ - protected string $message; + protected $message; - /** - * The error code - * @var int - * @link http://www.php.net/manual/en/class.error.php#error.props.code - */ - protected int $code; + protected $code; - /** - * The filename where the error happened - * @var string - * @link http://www.php.net/manual/en/class.error.php#error.props.file - */ protected string $file; - /** - * The line where the error happened - * @var int - * @link http://www.php.net/manual/en/class.error.php#error.props.line - */ protected int $line; /** - * Clone the error - * @link http://www.php.net/manual/en/error.clone.php - * @return void No value is returned. + * {@inheritdoc} */ private function __clone (): void {} /** - * Construct the error object - * @link http://www.php.net/manual/en/error.construct.php - * @param string $message [optional] - * @param int $code [optional] - * @param Throwable|null $previous [optional] - * @return string + * {@inheritdoc} + * @param string $message [optional] + * @param int $code [optional] + * @param Throwable|null $previous [optional] */ - public function __construct (string $message = '""', int $code = null, ?Throwable $previous = null): string {} + public function __construct (string $message = '', int $code = 0, ?Throwable $previous = NULL) {} /** * {@inheritdoc} @@ -598,80 +349,56 @@ public function __construct (string $message = '""', int $code = null, ?Throwabl public function __wakeup () {} /** - * Gets the error message - * @link http://www.php.net/manual/en/error.getmessage.php - * @return string Returns the error message as a string. + * {@inheritdoc} */ final public function getMessage (): string {} /** - * Gets the error code - * @link http://www.php.net/manual/en/error.getcode.php - * @return int Returns the error code as int + * {@inheritdoc} */ - final public function getCode (): int {} + final public function getCode () {} /** - * Gets the file in which the error occurred - * @link http://www.php.net/manual/en/error.getfile.php - * @return string Returns the filename in which the error occurred. + * {@inheritdoc} */ final public function getFile (): string {} /** - * Gets the line in which the error occurred - * @link http://www.php.net/manual/en/error.getline.php - * @return int Returns the line number where the error occurred. + * {@inheritdoc} */ final public function getLine (): int {} /** - * Gets the stack trace - * @link http://www.php.net/manual/en/error.gettrace.php - * @return array Returns the stack trace as an array. + * {@inheritdoc} */ final public function getTrace (): array {} /** - * Returns previous Throwable - * @link http://www.php.net/manual/en/error.getprevious.php - * @return Throwable|null Returns the previous Throwable if available - * or null otherwise. + * {@inheritdoc} */ final public function getPrevious (): ?Throwable {} /** - * Gets the stack trace as a string - * @link http://www.php.net/manual/en/error.gettraceasstring.php - * @return string Returns the stack trace as a string. + * {@inheritdoc} */ final public function getTraceAsString (): string {} /** - * String representation of the error - * @link http://www.php.net/manual/en/error.tostring.php - * @return string Returns the string representation of the error. + * {@inheritdoc} */ public function __toString (): string {} } -/** - * CompileError is thrown for some - * compilation errors, which formerly issued a fatal error. - * @link http://www.php.net/manual/en/class.compileerror.php - */ class CompileError extends Error implements Throwable, Stringable { /** - * Construct the error object - * @link http://www.php.net/manual/en/error.construct.php - * @param string $message [optional] - * @param int $code [optional] - * @param Throwable|null $previous [optional] - * @return string + * {@inheritdoc} + * @param string $message [optional] + * @param int $code [optional] + * @param Throwable|null $previous [optional] */ - public function __construct (string $message = '""', int $code = null, ?Throwable $previous = null): string {} + public function __construct (string $message = '', int $code = 0, ?Throwable $previous = NULL) {} /** * {@inheritdoc} @@ -679,81 +406,56 @@ public function __construct (string $message = '""', int $code = null, ?Throwabl public function __wakeup () {} /** - * Gets the error message - * @link http://www.php.net/manual/en/error.getmessage.php - * @return string Returns the error message as a string. + * {@inheritdoc} */ final public function getMessage (): string {} /** - * Gets the error code - * @link http://www.php.net/manual/en/error.getcode.php - * @return int Returns the error code as int + * {@inheritdoc} */ - final public function getCode (): int {} + final public function getCode () {} /** - * Gets the file in which the error occurred - * @link http://www.php.net/manual/en/error.getfile.php - * @return string Returns the filename in which the error occurred. + * {@inheritdoc} */ final public function getFile (): string {} /** - * Gets the line in which the error occurred - * @link http://www.php.net/manual/en/error.getline.php - * @return int Returns the line number where the error occurred. + * {@inheritdoc} */ final public function getLine (): int {} /** - * Gets the stack trace - * @link http://www.php.net/manual/en/error.gettrace.php - * @return array Returns the stack trace as an array. + * {@inheritdoc} */ final public function getTrace (): array {} /** - * Returns previous Throwable - * @link http://www.php.net/manual/en/error.getprevious.php - * @return Throwable|null Returns the previous Throwable if available - * or null otherwise. + * {@inheritdoc} */ final public function getPrevious (): ?Throwable {} /** - * Gets the stack trace as a string - * @link http://www.php.net/manual/en/error.gettraceasstring.php - * @return string Returns the stack trace as a string. + * {@inheritdoc} */ final public function getTraceAsString (): string {} /** - * String representation of the error - * @link http://www.php.net/manual/en/error.tostring.php - * @return string Returns the string representation of the error. + * {@inheritdoc} */ public function __toString (): string {} } -/** - * ParseError is thrown when an - * error occurs while parsing PHP code, such as when - * eval is called. - * @link http://www.php.net/manual/en/class.parseerror.php - */ class ParseError extends CompileError implements Stringable, Throwable { /** - * Construct the error object - * @link http://www.php.net/manual/en/error.construct.php - * @param string $message [optional] - * @param int $code [optional] - * @param Throwable|null $previous [optional] - * @return string + * {@inheritdoc} + * @param string $message [optional] + * @param int $code [optional] + * @param Throwable|null $previous [optional] */ - public function __construct (string $message = '""', int $code = null, ?Throwable $previous = null): string {} + public function __construct (string $message = '', int $code = 0, ?Throwable $previous = NULL) {} /** * {@inheritdoc} @@ -761,87 +463,56 @@ public function __construct (string $message = '""', int $code = null, ?Throwabl public function __wakeup () {} /** - * Gets the error message - * @link http://www.php.net/manual/en/error.getmessage.php - * @return string Returns the error message as a string. + * {@inheritdoc} */ final public function getMessage (): string {} /** - * Gets the error code - * @link http://www.php.net/manual/en/error.getcode.php - * @return int Returns the error code as int + * {@inheritdoc} */ - final public function getCode (): int {} + final public function getCode () {} /** - * Gets the file in which the error occurred - * @link http://www.php.net/manual/en/error.getfile.php - * @return string Returns the filename in which the error occurred. + * {@inheritdoc} */ final public function getFile (): string {} /** - * Gets the line in which the error occurred - * @link http://www.php.net/manual/en/error.getline.php - * @return int Returns the line number where the error occurred. + * {@inheritdoc} */ final public function getLine (): int {} /** - * Gets the stack trace - * @link http://www.php.net/manual/en/error.gettrace.php - * @return array Returns the stack trace as an array. + * {@inheritdoc} */ final public function getTrace (): array {} /** - * Returns previous Throwable - * @link http://www.php.net/manual/en/error.getprevious.php - * @return Throwable|null Returns the previous Throwable if available - * or null otherwise. + * {@inheritdoc} */ final public function getPrevious (): ?Throwable {} /** - * Gets the stack trace as a string - * @link http://www.php.net/manual/en/error.gettraceasstring.php - * @return string Returns the stack trace as a string. + * {@inheritdoc} */ final public function getTraceAsString (): string {} /** - * String representation of the error - * @link http://www.php.net/manual/en/error.tostring.php - * @return string Returns the string representation of the error. + * {@inheritdoc} */ public function __toString (): string {} } -/** - * A TypeError may be thrown when: - *- * The value being set for a class property does not match - * the property's corresponding declared type. - * The argument type being passed to a function does not match - * its corresponding declared parameter type. - * A value being returned from a function does not match the - * declared function return type. - *
- * @link http://www.php.net/manual/en/class.typeerror.php - */ class TypeError extends Error implements Throwable, Stringable { /** - * Construct the error object - * @link http://www.php.net/manual/en/error.construct.php - * @param string $message [optional] - * @param int $code [optional] - * @param Throwable|null $previous [optional] - * @return string + * {@inheritdoc} + * @param string $message [optional] + * @param int $code [optional] + * @param Throwable|null $previous [optional] */ - public function __construct (string $message = '""', int $code = null, ?Throwable $previous = null): string {} + public function __construct (string $message = '', int $code = 0, ?Throwable $previous = NULL) {} /** * {@inheritdoc} @@ -849,80 +520,56 @@ public function __construct (string $message = '""', int $code = null, ?Throwabl public function __wakeup () {} /** - * Gets the error message - * @link http://www.php.net/manual/en/error.getmessage.php - * @return string Returns the error message as a string. + * {@inheritdoc} */ final public function getMessage (): string {} /** - * Gets the error code - * @link http://www.php.net/manual/en/error.getcode.php - * @return int Returns the error code as int + * {@inheritdoc} */ - final public function getCode (): int {} + final public function getCode () {} /** - * Gets the file in which the error occurred - * @link http://www.php.net/manual/en/error.getfile.php - * @return string Returns the filename in which the error occurred. + * {@inheritdoc} */ final public function getFile (): string {} /** - * Gets the line in which the error occurred - * @link http://www.php.net/manual/en/error.getline.php - * @return int Returns the line number where the error occurred. + * {@inheritdoc} */ final public function getLine (): int {} /** - * Gets the stack trace - * @link http://www.php.net/manual/en/error.gettrace.php - * @return array Returns the stack trace as an array. + * {@inheritdoc} */ final public function getTrace (): array {} /** - * Returns previous Throwable - * @link http://www.php.net/manual/en/error.getprevious.php - * @return Throwable|null Returns the previous Throwable if available - * or null otherwise. + * {@inheritdoc} */ final public function getPrevious (): ?Throwable {} /** - * Gets the stack trace as a string - * @link http://www.php.net/manual/en/error.gettraceasstring.php - * @return string Returns the stack trace as a string. + * {@inheritdoc} */ final public function getTraceAsString (): string {} /** - * String representation of the error - * @link http://www.php.net/manual/en/error.tostring.php - * @return string Returns the string representation of the error. + * {@inheritdoc} */ public function __toString (): string {} } -/** - * ArgumentCountError is thrown - * when too few arguments are passed to a user-defined function or method. - * @link http://www.php.net/manual/en/class.argumentcounterror.php - */ class ArgumentCountError extends TypeError implements Stringable, Throwable { /** - * Construct the error object - * @link http://www.php.net/manual/en/error.construct.php - * @param string $message [optional] - * @param int $code [optional] - * @param Throwable|null $previous [optional] - * @return string + * {@inheritdoc} + * @param string $message [optional] + * @param int $code [optional] + * @param Throwable|null $previous [optional] */ - public function __construct (string $message = '""', int $code = null, ?Throwable $previous = null): string {} + public function __construct (string $message = '', int $code = 0, ?Throwable $previous = NULL) {} /** * {@inheritdoc} @@ -930,83 +577,56 @@ public function __construct (string $message = '""', int $code = null, ?Throwabl public function __wakeup () {} /** - * Gets the error message - * @link http://www.php.net/manual/en/error.getmessage.php - * @return string Returns the error message as a string. + * {@inheritdoc} */ final public function getMessage (): string {} /** - * Gets the error code - * @link http://www.php.net/manual/en/error.getcode.php - * @return int Returns the error code as int + * {@inheritdoc} */ - final public function getCode (): int {} + final public function getCode () {} /** - * Gets the file in which the error occurred - * @link http://www.php.net/manual/en/error.getfile.php - * @return string Returns the filename in which the error occurred. + * {@inheritdoc} */ final public function getFile (): string {} /** - * Gets the line in which the error occurred - * @link http://www.php.net/manual/en/error.getline.php - * @return int Returns the line number where the error occurred. + * {@inheritdoc} */ final public function getLine (): int {} /** - * Gets the stack trace - * @link http://www.php.net/manual/en/error.gettrace.php - * @return array Returns the stack trace as an array. + * {@inheritdoc} */ final public function getTrace (): array {} /** - * Returns previous Throwable - * @link http://www.php.net/manual/en/error.getprevious.php - * @return Throwable|null Returns the previous Throwable if available - * or null otherwise. + * {@inheritdoc} */ final public function getPrevious (): ?Throwable {} /** - * Gets the stack trace as a string - * @link http://www.php.net/manual/en/error.gettraceasstring.php - * @return string Returns the stack trace as a string. + * {@inheritdoc} */ final public function getTraceAsString (): string {} /** - * String representation of the error - * @link http://www.php.net/manual/en/error.tostring.php - * @return string Returns the string representation of the error. + * {@inheritdoc} */ public function __toString (): string {} } -/** - * A ValueError is thrown when the - * type of an argument is correct but the value of it is incorrect. - * For example, passing a negative integer when the function expects a - * positive one, or passing an empty string/array when the function expects - * it to not be empty. - * @link http://www.php.net/manual/en/class.valueerror.php - */ class ValueError extends Error implements Throwable, Stringable { /** - * Construct the error object - * @link http://www.php.net/manual/en/error.construct.php - * @param string $message [optional] - * @param int $code [optional] - * @param Throwable|null $previous [optional] - * @return string + * {@inheritdoc} + * @param string $message [optional] + * @param int $code [optional] + * @param Throwable|null $previous [optional] */ - public function __construct (string $message = '""', int $code = null, ?Throwable $previous = null): string {} + public function __construct (string $message = '', int $code = 0, ?Throwable $previous = NULL) {} /** * {@inheritdoc} @@ -1014,83 +634,56 @@ public function __construct (string $message = '""', int $code = null, ?Throwabl public function __wakeup () {} /** - * Gets the error message - * @link http://www.php.net/manual/en/error.getmessage.php - * @return string Returns the error message as a string. + * {@inheritdoc} */ final public function getMessage (): string {} /** - * Gets the error code - * @link http://www.php.net/manual/en/error.getcode.php - * @return int Returns the error code as int + * {@inheritdoc} */ - final public function getCode (): int {} + final public function getCode () {} /** - * Gets the file in which the error occurred - * @link http://www.php.net/manual/en/error.getfile.php - * @return string Returns the filename in which the error occurred. + * {@inheritdoc} */ final public function getFile (): string {} /** - * Gets the line in which the error occurred - * @link http://www.php.net/manual/en/error.getline.php - * @return int Returns the line number where the error occurred. + * {@inheritdoc} */ final public function getLine (): int {} /** - * Gets the stack trace - * @link http://www.php.net/manual/en/error.gettrace.php - * @return array Returns the stack trace as an array. + * {@inheritdoc} */ final public function getTrace (): array {} /** - * Returns previous Throwable - * @link http://www.php.net/manual/en/error.getprevious.php - * @return Throwable|null Returns the previous Throwable if available - * or null otherwise. + * {@inheritdoc} */ final public function getPrevious (): ?Throwable {} /** - * Gets the stack trace as a string - * @link http://www.php.net/manual/en/error.gettraceasstring.php - * @return string Returns the stack trace as a string. + * {@inheritdoc} */ final public function getTraceAsString (): string {} /** - * String representation of the error - * @link http://www.php.net/manual/en/error.tostring.php - * @return string Returns the string representation of the error. + * {@inheritdoc} */ public function __toString (): string {} } -/** - * ArithmeticError is thrown when - * an error occurs while performing mathematical operations. - * These errors include attempting to perform a bitshift by a negative - * amount, and any call to intdiv that would result in a - * value outside the possible bounds of an int. - * @link http://www.php.net/manual/en/class.arithmeticerror.php - */ class ArithmeticError extends Error implements Throwable, Stringable { /** - * Construct the error object - * @link http://www.php.net/manual/en/error.construct.php - * @param string $message [optional] - * @param int $code [optional] - * @param Throwable|null $previous [optional] - * @return string + * {@inheritdoc} + * @param string $message [optional] + * @param int $code [optional] + * @param Throwable|null $previous [optional] */ - public function __construct (string $message = '""', int $code = null, ?Throwable $previous = null): string {} + public function __construct (string $message = '', int $code = 0, ?Throwable $previous = NULL) {} /** * {@inheritdoc} @@ -1098,80 +691,56 @@ public function __construct (string $message = '""', int $code = null, ?Throwabl public function __wakeup () {} /** - * Gets the error message - * @link http://www.php.net/manual/en/error.getmessage.php - * @return string Returns the error message as a string. + * {@inheritdoc} */ final public function getMessage (): string {} /** - * Gets the error code - * @link http://www.php.net/manual/en/error.getcode.php - * @return int Returns the error code as int + * {@inheritdoc} */ - final public function getCode (): int {} + final public function getCode () {} /** - * Gets the file in which the error occurred - * @link http://www.php.net/manual/en/error.getfile.php - * @return string Returns the filename in which the error occurred. + * {@inheritdoc} */ final public function getFile (): string {} /** - * Gets the line in which the error occurred - * @link http://www.php.net/manual/en/error.getline.php - * @return int Returns the line number where the error occurred. + * {@inheritdoc} */ final public function getLine (): int {} /** - * Gets the stack trace - * @link http://www.php.net/manual/en/error.gettrace.php - * @return array Returns the stack trace as an array. + * {@inheritdoc} */ final public function getTrace (): array {} /** - * Returns previous Throwable - * @link http://www.php.net/manual/en/error.getprevious.php - * @return Throwable|null Returns the previous Throwable if available - * or null otherwise. + * {@inheritdoc} */ final public function getPrevious (): ?Throwable {} /** - * Gets the stack trace as a string - * @link http://www.php.net/manual/en/error.gettraceasstring.php - * @return string Returns the stack trace as a string. + * {@inheritdoc} */ final public function getTraceAsString (): string {} /** - * String representation of the error - * @link http://www.php.net/manual/en/error.tostring.php - * @return string Returns the string representation of the error. + * {@inheritdoc} */ public function __toString (): string {} } -/** - * DivisionByZeroError is thrown - * when an attempt is made to divide a number by zero. - * @link http://www.php.net/manual/en/class.divisionbyzeroerror.php - */ class DivisionByZeroError extends ArithmeticError implements Stringable, Throwable { /** - * Construct the error object - * @link http://www.php.net/manual/en/error.construct.php - * @param string $message [optional] - * @param int $code [optional] - * @param Throwable|null $previous [optional] - * @return string + * {@inheritdoc} + * @param string $message [optional] + * @param int $code [optional] + * @param Throwable|null $previous [optional] */ - public function __construct (string $message = '""', int $code = null, ?Throwable $previous = null): string {} + public function __construct (string $message = '', int $code = 0, ?Throwable $previous = NULL) {} /** * {@inheritdoc} @@ -1179,81 +748,56 @@ public function __construct (string $message = '""', int $code = null, ?Throwabl public function __wakeup () {} /** - * Gets the error message - * @link http://www.php.net/manual/en/error.getmessage.php - * @return string Returns the error message as a string. + * {@inheritdoc} */ final public function getMessage (): string {} /** - * Gets the error code - * @link http://www.php.net/manual/en/error.getcode.php - * @return int Returns the error code as int + * {@inheritdoc} */ - final public function getCode (): int {} + final public function getCode () {} /** - * Gets the file in which the error occurred - * @link http://www.php.net/manual/en/error.getfile.php - * @return string Returns the filename in which the error occurred. + * {@inheritdoc} */ final public function getFile (): string {} /** - * Gets the line in which the error occurred - * @link http://www.php.net/manual/en/error.getline.php - * @return int Returns the line number where the error occurred. + * {@inheritdoc} */ final public function getLine (): int {} /** - * Gets the stack trace - * @link http://www.php.net/manual/en/error.gettrace.php - * @return array Returns the stack trace as an array. + * {@inheritdoc} */ final public function getTrace (): array {} /** - * Returns previous Throwable - * @link http://www.php.net/manual/en/error.getprevious.php - * @return Throwable|null Returns the previous Throwable if available - * or null otherwise. + * {@inheritdoc} */ final public function getPrevious (): ?Throwable {} /** - * Gets the stack trace as a string - * @link http://www.php.net/manual/en/error.gettraceasstring.php - * @return string Returns the stack trace as a string. + * {@inheritdoc} */ final public function getTraceAsString (): string {} /** - * String representation of the error - * @link http://www.php.net/manual/en/error.tostring.php - * @return string Returns the string representation of the error. + * {@inheritdoc} */ public function __toString (): string {} } -/** - * An UnhandledMatchError is thrown - * when the subject passed to a match expression is not handled by any arm - * of the match expression. - * @link http://www.php.net/manual/en/class.unhandledmatcherror.php - */ class UnhandledMatchError extends Error implements Throwable, Stringable { /** - * Construct the error object - * @link http://www.php.net/manual/en/error.construct.php - * @param string $message [optional] - * @param int $code [optional] - * @param Throwable|null $previous [optional] - * @return string + * {@inheritdoc} + * @param string $message [optional] + * @param int $code [optional] + * @param Throwable|null $previous [optional] */ - public function __construct (string $message = '""', int $code = null, ?Throwable $previous = null): string {} + public function __construct (string $message = '', int $code = 0, ?Throwable $previous = NULL) {} /** * {@inheritdoc} @@ -1261,132 +805,79 @@ public function __construct (string $message = '""', int $code = null, ?Throwabl public function __wakeup () {} /** - * Gets the error message - * @link http://www.php.net/manual/en/error.getmessage.php - * @return string Returns the error message as a string. + * {@inheritdoc} */ final public function getMessage (): string {} /** - * Gets the error code - * @link http://www.php.net/manual/en/error.getcode.php - * @return int Returns the error code as int + * {@inheritdoc} */ - final public function getCode (): int {} + final public function getCode () {} /** - * Gets the file in which the error occurred - * @link http://www.php.net/manual/en/error.getfile.php - * @return string Returns the filename in which the error occurred. + * {@inheritdoc} */ final public function getFile (): string {} /** - * Gets the line in which the error occurred - * @link http://www.php.net/manual/en/error.getline.php - * @return int Returns the line number where the error occurred. + * {@inheritdoc} */ final public function getLine (): int {} /** - * Gets the stack trace - * @link http://www.php.net/manual/en/error.gettrace.php - * @return array Returns the stack trace as an array. + * {@inheritdoc} */ final public function getTrace (): array {} /** - * Returns previous Throwable - * @link http://www.php.net/manual/en/error.getprevious.php - * @return Throwable|null Returns the previous Throwable if available - * or null otherwise. + * {@inheritdoc} */ final public function getPrevious (): ?Throwable {} /** - * Gets the stack trace as a string - * @link http://www.php.net/manual/en/error.gettraceasstring.php - * @return string Returns the stack trace as a string. + * {@inheritdoc} */ final public function getTraceAsString (): string {} /** - * String representation of the error - * @link http://www.php.net/manual/en/error.tostring.php - * @return string Returns the string representation of the error. + * {@inheritdoc} */ public function __toString (): string {} } -/** - * Class used to represent anonymous - * functions. - *Anonymous functions yield objects of this type. - * This class has methods that allow - * further control of the anonymous function after it has been created.
- *Besides the methods listed here, this class also has an - * __invoke method. This is for consistency with other - * classes that implement calling - * magic, as this method is not used for calling the function.
- * @link http://www.php.net/manual/en/class.closure.php - */ final class Closure { /** - * Constructor that disallows instantiation - * @link http://www.php.net/manual/en/closure.construct.php + * {@inheritdoc} */ private function __construct () {} /** - * Duplicates a closure with a specific bound object and class scope - * @link http://www.php.net/manual/en/closure.bind.php - * @param Closure $closure The anonymous functions to bind. - * @param object|null $newThis The object to which the given anonymous function should be bound, or - * null for the closure to be unbound. - * @param object|string|null $newScope [optional] The class scope to which the closure is to be associated, or - * 'static' to keep the current one. If an object is given, the type of the - * object will be used instead. This determines the visibility of protected - * and private methods of the bound object. - * It is not allowed to pass (an object of) an internal class as this parameter. - * @return Closure|null Returns a new Closure object, or null on failure. - */ - public static function bind (Closure $closure, ?object $newThis, object|string|null $newScope = '"static"'): ?Closure {} - - /** - * Duplicates the closure with a new bound object and class scope - * @link http://www.php.net/manual/en/closure.bindto.php - * @param object|null $newThis The object to which the given anonymous function should be bound, or - * null for the closure to be unbound. - * @param object|string|null $newScope [optional] The class scope to which the closure is to be associated, or - * 'static' to keep the current one. If an object is given, the type of the - * object will be used instead. This determines the visibility of protected - * and private methods of the bound object. - * It is not allowed to pass (an object of) an internal class as this parameter. - * @return Closure|null Returns the newly created Closure object - * or null on failure. - */ - public function bindTo (?object $newThis, object|string|null $newScope = '"static"'): ?Closure {} - - /** - * Binds and calls the closure - * @link http://www.php.net/manual/en/closure.call.php - * @param object $newThis The object to bind the closure to for the duration of the - * call. - * @param mixed $args Zero or more parameters, which will be given as parameters to the - * closure. - * @return mixed Returns the return value of the closure. + * {@inheritdoc} + * @param Closure $closure + * @param object|null $newThis + * @param object|string|null $newScope [optional] + */ + public static function bind (Closure $closure, ?object $newThis = null, object|string|null $newScope = 'static'): ?Closure {} + + /** + * {@inheritdoc} + * @param object|null $newThis + * @param object|string|null $newScope [optional] + */ + public function bindTo (?object $newThis = null, object|string|null $newScope = 'static'): ?Closure {} + + /** + * {@inheritdoc} + * @param object $newThis + * @param mixed $args [optional] */ public function call (object $newThis, mixed ...$args): mixed {} /** - * Converts a callable into a closure - * @link http://www.php.net/manual/en/closure.fromcallable.php - * @param callable $callback The callable to convert. - * @return Closure Returns the newly created Closure or throws a - * TypeError if the callback is - * not callable in the current scope. + * {@inheritdoc} + * @param callable $callback */ public static function fromCallable (callable $callback): Closure {} @@ -1397,70 +888,47 @@ public function __invoke () {} } -/** - * Generator objects are returned from generators. - *Generator objects cannot be instantiated via - * new.
- * @link http://www.php.net/manual/en/class.generator.php - */ final class Generator implements Iterator, Traversable { /** - * Rewind the iterator - * @link http://www.php.net/manual/en/generator.rewind.php - * @return void No value is returned. + * {@inheritdoc} */ public function rewind (): void {} /** - * Check if the iterator has been closed - * @link http://www.php.net/manual/en/generator.valid.php - * @return bool Returns false if the iterator has been closed. Otherwise returns true. + * {@inheritdoc} */ public function valid (): bool {} /** - * Get the yielded value - * @link http://www.php.net/manual/en/generator.current.php - * @return mixed Returns the yielded value. + * {@inheritdoc} */ public function current (): mixed {} /** - * Get the yielded key - * @link http://www.php.net/manual/en/generator.key.php - * @return mixed Returns the yielded key. + * {@inheritdoc} */ public function key (): mixed {} /** - * Resume execution of the generator - * @link http://www.php.net/manual/en/generator.next.php - * @return void No value is returned. + * {@inheritdoc} */ public function next (): void {} /** - * Send a value to the generator - * @link http://www.php.net/manual/en/generator.send.php - * @param mixed $value Value to send into the generator. This value will be the return value of the - * yield expression the generator is currently at. - * @return mixed Returns the yielded value. + * {@inheritdoc} + * @param mixed $value */ - public function send (mixed $value): mixed {} + public function send (mixed $value = null): mixed {} /** - * Throw an exception into the generator - * @link http://www.php.net/manual/en/generator.throw.php - * @param Throwable $exception Exception to throw into the generator. - * @return mixed Returns the yielded value. + * {@inheritdoc} + * @param Throwable $exception */ public function throw (Throwable $exception): mixed {} /** - * Get the return value of a generator - * @link http://www.php.net/manual/en/generator.getreturn.php - * @return mixed Returns the generator's return value once it has finished executing. + * {@inheritdoc} */ public function getReturn (): mixed {} @@ -1469,14 +937,12 @@ public function getReturn (): mixed {} class ClosedGeneratorException extends Exception implements Throwable, Stringable { /** - * Construct the exception - * @link http://www.php.net/manual/en/exception.construct.php - * @param string $message [optional] - * @param int $code [optional] - * @param Throwable|null $previous [optional] - * @return string + * {@inheritdoc} + * @param string $message [optional] + * @param int $code [optional] + * @param Throwable|null $previous [optional] */ - public function __construct (string $message = '""', int $code = null, ?Throwable $previous = null): string {} + public function __construct (string $message = '', int $code = 0, ?Throwable $previous = NULL) {} /** * {@inheritdoc} @@ -1484,173 +950,106 @@ public function __construct (string $message = '""', int $code = null, ?Throwabl public function __wakeup () {} /** - * Gets the Exception message - * @link http://www.php.net/manual/en/exception.getmessage.php - * @return string Returns the Exception message as a string. + * {@inheritdoc} */ final public function getMessage (): string {} /** - * Gets the Exception code - * @link http://www.php.net/manual/en/exception.getcode.php - * @return int Returns the exception code as int in - * Exception but possibly as other type in - * Exception descendants (for example as - * string in PDOException). + * {@inheritdoc} */ - final public function getCode (): int {} + final public function getCode () {} /** - * Gets the file in which the exception was created - * @link http://www.php.net/manual/en/exception.getfile.php - * @return string Returns the filename in which the exception was created. + * {@inheritdoc} */ final public function getFile (): string {} /** - * Gets the line in which the exception was created - * @link http://www.php.net/manual/en/exception.getline.php - * @return int Returns the line number where the exception was created. + * {@inheritdoc} */ final public function getLine (): int {} /** - * Gets the stack trace - * @link http://www.php.net/manual/en/exception.gettrace.php - * @return array Returns the Exception stack trace as an array. + * {@inheritdoc} */ final public function getTrace (): array {} /** - * Returns previous Throwable - * @link http://www.php.net/manual/en/exception.getprevious.php - * @return Throwable|null Returns the previous Throwable if available - * or null otherwise. + * {@inheritdoc} */ final public function getPrevious (): ?Throwable {} /** - * Gets the stack trace as a string - * @link http://www.php.net/manual/en/exception.gettraceasstring.php - * @return string Returns the Exception stack trace as a string. + * {@inheritdoc} */ final public function getTraceAsString (): string {} /** - * String representation of the exception - * @link http://www.php.net/manual/en/exception.tostring.php - * @return string Returns the string representation of the exception. + * {@inheritdoc} */ public function __toString (): string {} } -/** - * Weak references allow the programmer to retain a reference to an object which does not prevent - * the object from being destroyed. They are useful for implementing cache like structures. - *WeakReferences cannot be serialized.
- * @link http://www.php.net/manual/en/class.weakreference.php - */ final class WeakReference { /** - * Constructor that disallows instantiation - * @link http://www.php.net/manual/en/weakreference.construct.php + * {@inheritdoc} */ public function __construct () {} /** - * Create a new weak reference - * @link http://www.php.net/manual/en/weakreference.create.php - * @param object $object The object to be weakly referenced. - * @return WeakReference Returns the freshly instantiated object. + * {@inheritdoc} + * @param object $object */ public static function create (object $object): WeakReference {} /** - * Get a weakly referenced Object - * @link http://www.php.net/manual/en/weakreference.get.php - * @return object|null Returns the referenced object, or null if the object has been destroyed. + * {@inheritdoc} */ public function get (): ?object {} } -/** - * A WeakMap is map (or dictionary) that accepts objects as keys. However, unlike the - * otherwise similar SplObjectStorage, an object in a key of WeakMap - * does not contribute toward the object's reference count. That is, if at any point the only remaining reference - * to an object is the key of a WeakMap, the object will be garbage collected and removed - * from the WeakMap. Its primary use case is for building caches of data derived from - * an object that do not need to live longer than the object. - *WeakMap implements ArrayAccess, - * Iterator, and Countable, - * so in most cases it can be used in the same fashion as an associative array.
- * @link http://www.php.net/manual/en/class.weakmap.php - */ final class WeakMap implements ArrayAccess, Countable, IteratorAggregate, Traversable { /** - * Returns the value pointed to by a certain object - * @link http://www.php.net/manual/en/weakmap.offsetget.php - * @param object $object Some object contained as key in the map. - * @return mixed Returns the value associated to the object passed as argument, null - * otherwise. + * {@inheritdoc} + * @param mixed $object */ - public function offsetGet (object $object): mixed {} + public function offsetGet ($object = null): mixed {} /** - * Updates the map with a new key-value pair - * @link http://www.php.net/manual/en/weakmap.offsetset.php - * @param object $object The object serving as key of the key-value pair. - * @param mixed $value The arbitrary data serving as value of the key-value pair. - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $object + * @param mixed $value */ - public function offsetSet (object $object, mixed $value): void {} + public function offsetSet ($object = null, mixed $value = null): void {} /** - * Checks whether a certain object is in the map - * @link http://www.php.net/manual/en/weakmap.offsetexists.php - * @param object $object Object to check for. - * @return bool Returns true if the object is contained in the map, false otherwise. + * {@inheritdoc} + * @param mixed $object */ - public function offsetExists (object $object): bool {} + public function offsetExists ($object = null): bool {} /** - * Removes an entry from the map - * @link http://www.php.net/manual/en/weakmap.offsetunset.php - * @param object $object The key object to remove from the map. - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $object */ - public function offsetUnset (object $object): void {} + public function offsetUnset ($object = null): void {} /** - * Counts the number of live entries in the map - * @link http://www.php.net/manual/en/weakmap.count.php - * @return int Returns the number of live entries in the map. + * {@inheritdoc} */ public function count (): int {} /** - * Retrieve an external iterator - * @link http://www.php.net/manual/en/weakmap.getiterator.php - * @return Iterator An instance of an object implementing Iterator or - * Traversable + * {@inheritdoc} */ public function getIterator (): Iterator {} } -/** - * Attributes offer the ability to add structured, machine-readable metadata - * information on declarations in code: Classes, methods, functions, - * parameters, properties and class constants can be the target of an attribute. - * The metadata defined by attributes can then be inspected at runtime using the - * Reflection APIs. - * Attributes could therefore be thought of as a configuration language - * embedded directly into code. - * @link http://www.php.net/manual/en/class.attribute.php - */ #[Attribute(1, )] final class Attribute { const TARGET_CLASS = 1; @@ -1666,272 +1065,173 @@ final class Attribute { public int $flags; /** - * Construct a new Attribute instance - * @link http://www.php.net/manual/en/attribute.construct.php - * @param int $flags [optional] - * @return int + * {@inheritdoc} + * @param int $flags [optional] */ - public function __construct (int $flags = \Attribute::TARGET_ALL): int {} + public function __construct (int $flags = 63) {} } -/** - * Most non-final internal methods now require overriding methods to declare - * a compatible return type, otherwise a deprecated notice is emitted during - * inheritance validation. - * In case the return type cannot be declared for an overriding method due to - * PHP cross-version compatibility concerns, - * a #[\ReturnTypeWillChange] attribute can be added to silence - * the deprecation notice. - * @link http://www.php.net/manual/en/class.returntypewillchange.php - */ #[Attribute(4, )] final class ReturnTypeWillChange { /** - * Construct a new ReturnTypeWillChange attribute instance - * @link http://www.php.net/manual/en/returntypewillchange.construct.php + * {@inheritdoc} */ public function __construct () {} } -/** - * This attribute is used to mark classes that allow - * dynamic properties. - * @link http://www.php.net/manual/en/class.allowdynamicproperties.php - */ #[Attribute(1, )] final class AllowDynamicProperties { /** - * Construct a new AllowDynamicProperties attribute instance - * @link http://www.php.net/manual/en/allowdynamicproperties.construct.php + * {@inheritdoc} */ public function __construct () {} } -/** - * This attribute is used to mark a parameter that is sensitive and should - * have its value redacted if present in a stack trace. - * @link http://www.php.net/manual/en/class.sensitiveparameter.php - */ #[Attribute(32, )] final class SensitiveParameter { /** - * Construct a new SensitiveParameter attribute instance - * @link http://www.php.net/manual/en/sensitiveparameter.construct.php + * {@inheritdoc} */ public function __construct () {} } -/** - * The SensitiveParameterValue class allows wrapping sensitive - * values to protect them against accidental exposure. - *Values of parameters having the SensitiveParameter attribute - * will automatically be wrapped inside of a SensitiveParameterValue - * object within stack traces.
- * @link http://www.php.net/manual/en/class.sensitiveparametervalue.php - */ final class SensitiveParameterValue { readonly mixed $value; /** - * Constructs a new SensitiveParameterValue object - * @link http://www.php.net/manual/en/sensitiveparametervalue.construct.php - * @param mixed $value An arbitrary value that should be stored inside the SensitiveParameterValue object. - * @return mixed + * {@inheritdoc} + * @param mixed $value */ - public function __construct (mixed $value): mixed {} + public function __construct (mixed $value = null) {} /** - * Returns the sensitive value - * @link http://www.php.net/manual/en/sensitiveparametervalue.getvalue.php - * @return mixed The sensitive value. + * {@inheritdoc} */ public function getValue (): mixed {} /** - * Protects the sensitive value against accidental exposure - * @link http://www.php.net/manual/en/sensitiveparametervalue.debuginfo.php - * @return array An empty array. + * {@inheritdoc} */ public function __debugInfo (): array {} } -/** - * The UnitEnum interface is automatically applied to all - * enumerations by the engine. It may not be implemented by user-defined classes. - * Enumerations may not override its methods, as default implementations are provided - * by the engine. It is available only for type checks. - * @link http://www.php.net/manual/en/class.unitenum.php - */ -interface UnitEnum { +#[Attribute(4, )] +final class Override { /** - * Generates a list of cases on an enum - * @link http://www.php.net/manual/en/unitenum.cases.php - * @return array An array of all defined cases of this enumeration, in order of declaration. + * {@inheritdoc} */ - abstract public static function cases (): array; + public function __construct () {} + +} + +interface UnitEnum { + + /** + * {@inheritdoc} + */ + abstract public static function cases (): array; } -/** - * The BackedEnum interface is automatically applied to backed - * enumerations by the engine. It may not be implemented by user-defined classes. - * Enumerations may not override its methods, as default implementations are provided - * by the engine. It is available only for type checks. - * @link http://www.php.net/manual/en/class.backedenum.php - */ interface BackedEnum extends UnitEnum { /** - * Maps a scalar to an enum instance - * @link http://www.php.net/manual/en/backedenum.from.php - * @param int|string $value The scalar value to map to an enum case. - * @return static A case instance of this enumeration. + * {@inheritdoc} + * @param string|int $value */ - abstract public static function from (int|string $value): static; + abstract public static function from (string|int $value): static; /** - * Maps a scalar to an enum instance or null - * @link http://www.php.net/manual/en/backedenum.tryfrom.php - * @param int|string $value The scalar value to map to an enum case. - * @return static|null A case instance of this enumeration, or null if not found. + * {@inheritdoc} + * @param string|int $value */ - abstract public static function tryFrom (int|string $value): ?static; + abstract public static function tryFrom (string|int $value): ?static; /** - * Generates a list of cases on an enum - * @link http://www.php.net/manual/en/unitenum.cases.php - * @return array An array of all defined cases of this enumeration, in order of declaration. + * {@inheritdoc} */ abstract public static function cases (): array; } -/** - * Fibers represent full-stack, interruptible functions. Fibers may be suspended from anywhere in the call-stack, - * pausing execution within the fiber until the fiber is resumed at a later time. - * @link http://www.php.net/manual/en/class.fiber.php - */ final class Fiber { /** - * Creates a new Fiber instance - * @link http://www.php.net/manual/en/fiber.construct.php - * @param callable $callback The callable to invoke when starting the fiber. - * Arguments given to Fiber::start will be - * provided as arguments to the given callable. - * @return callable + * {@inheritdoc} + * @param callable $callback */ - public function __construct (callable $callback): callable {} + public function __construct (callable $callback) {} /** - * Start execution of the fiber - * @link http://www.php.net/manual/en/fiber.start.php - * @param mixed $args The arguments to use when invoking the callable given to the fiber constructor. - * @return mixed The value provided to the first call to Fiber::suspend or null if the fiber returns. - * If the fiber throws an exception before suspending, it will be thrown from the call to this method. + * {@inheritdoc} + * @param mixed $args [optional] */ public function start (mixed ...$args): mixed {} /** - * Resumes execution of the fiber with a value - * @link http://www.php.net/manual/en/fiber.resume.php - * @param mixed $value [optional] The value to resume the fiber. This value will be the return value of the current - * Fiber::suspend call. - * @return mixed The value provided to the next call to Fiber::suspend or null if the fiber returns. - * If the fiber throws an exception before suspending, it will be thrown from the call to this method. + * {@inheritdoc} + * @param mixed $value [optional] */ - public function resume (mixed $value = null): mixed {} + public function resume (mixed $value = NULL): mixed {} /** - * Resumes execution of the fiber with an exception - * @link http://www.php.net/manual/en/fiber.throw.php - * @param Throwable $exception The exception to throw into the fiber from the current Fiber::suspend call. - * @return mixed The value provided to the next call to Fiber::suspend or null if the fiber returns. - * If the fiber throws an exception before suspending, it will be thrown from the call to this method. + * {@inheritdoc} + * @param Throwable $exception */ public function throw (Throwable $exception): mixed {} /** - * Determines if the fiber has started - * @link http://www.php.net/manual/en/fiber.isstarted.php - * @return bool Returns true only after the fiber has been started; otherwise false is returned. + * {@inheritdoc} */ public function isStarted (): bool {} /** - * Determines if the fiber is suspended - * @link http://www.php.net/manual/en/fiber.issuspended.php - * @return bool Returns true if the fiber is currently suspended; otherwise false is returned. + * {@inheritdoc} */ public function isSuspended (): bool {} /** - * Determines if the fiber is running - * @link http://www.php.net/manual/en/fiber.isrunning.php - * @return bool Returns true only if the fiber is running. A fiber is considered running after a call to - * Fiber::start, Fiber::resume, or - * Fiber::throw that has not yet returned. - * Return false if the fiber is not running. + * {@inheritdoc} */ public function isRunning (): bool {} /** - * Determines if the fiber has terminated - * @link http://www.php.net/manual/en/fiber.isterminated.php - * @return bool Returns true only after the fiber has terminated, either by returning or throwing an exception; - * otherwise false is returned. + * {@inheritdoc} */ public function isTerminated (): bool {} /** - * Gets the value returned by the Fiber - * @link http://www.php.net/manual/en/fiber.getreturn.php - * @return mixed Returns the value returned by the callable provided to Fiber::__construct. - * If the fiber has not returned a value, either because it has not been started, has not terminated, or threw an - * exception, a FiberError will be thrown. + * {@inheritdoc} */ public function getReturn (): mixed {} /** - * Gets the currently executing Fiber instance - * @link http://www.php.net/manual/en/fiber.getcurrent.php - * @return Fiber|null Returns the currently executing Fiber instance or null if this method is called from - * outside a fiber. + * {@inheritdoc} */ public static function getCurrent (): ?Fiber {} /** - * Suspends execution of the current fiber - * @link http://www.php.net/manual/en/fiber.suspend.php - * @param mixed $value [optional] The value to return from the call to Fiber::start, - * Fiber::resume, or Fiber::throw that switched execution into - * the current fiber. - * @return mixed The value provided to Fiber::resume. + * {@inheritdoc} + * @param mixed $value [optional] */ - public static function suspend (mixed $value = null): mixed {} + public static function suspend (mixed $value = NULL): mixed {} } -/** - * FiberError is thrown - * when an invalid operation is performed on a Fiber. - * @link http://www.php.net/manual/en/class.fibererror.php - */ final class FiberError extends Error implements Throwable, Stringable { /** - * Constructor to disallow direct instantiation - * @link http://www.php.net/manual/en/fibererror.construct.php + * {@inheritdoc} */ public function __construct () {} @@ -1941,410 +1241,257 @@ public function __construct () {} public function __wakeup () {} /** - * Gets the error message - * @link http://www.php.net/manual/en/error.getmessage.php - * @return string Returns the error message as a string. + * {@inheritdoc} */ final public function getMessage (): string {} /** - * Gets the error code - * @link http://www.php.net/manual/en/error.getcode.php - * @return int Returns the error code as int + * {@inheritdoc} */ - final public function getCode (): int {} + final public function getCode () {} /** - * Gets the file in which the error occurred - * @link http://www.php.net/manual/en/error.getfile.php - * @return string Returns the filename in which the error occurred. + * {@inheritdoc} */ final public function getFile (): string {} /** - * Gets the line in which the error occurred - * @link http://www.php.net/manual/en/error.getline.php - * @return int Returns the line number where the error occurred. + * {@inheritdoc} */ final public function getLine (): int {} /** - * Gets the stack trace - * @link http://www.php.net/manual/en/error.gettrace.php - * @return array Returns the stack trace as an array. + * {@inheritdoc} */ final public function getTrace (): array {} /** - * Returns previous Throwable - * @link http://www.php.net/manual/en/error.getprevious.php - * @return Throwable|null Returns the previous Throwable if available - * or null otherwise. + * {@inheritdoc} */ final public function getPrevious (): ?Throwable {} /** - * Gets the stack trace as a string - * @link http://www.php.net/manual/en/error.gettraceasstring.php - * @return string Returns the stack trace as a string. + * {@inheritdoc} */ final public function getTraceAsString (): string {} /** - * String representation of the error - * @link http://www.php.net/manual/en/error.tostring.php - * @return string Returns the string representation of the error. + * {@inheritdoc} */ public function __toString (): string {} } -/** - * A generic empty class with dynamic properties. - *Objects of this class can be instantiated with - * new operator or created by - * typecasting to object. - * Several PHP functions also create instances of this class, e.g. - * json_decode, mysqli_fetch_object - * or PDOStatement::fetchObject.
- *Despite not implementing - * __get()/__set() - * magic methods, this class allows dynamic properties and does not require the - * #[\AllowDynamicProperties] attribute.
- *This is not a base class as PHP does not have a concept of a universal base - * class. However, it is possible to create a custom class that extends from - * stdClass and as a result inherits the functionality - * of dynamic properties.
- * @link http://www.php.net/manual/en/class.stdclass.php - */ #[AllowDynamicProperties] class stdClass { } /** - * Gets the version of the current Zend engine - * @link http://www.php.net/manual/en/function.zend-version.php - * @return string Returns the Zend Engine version number, as a string. + * {@inheritdoc} */ function zend_version (): string {} /** - * Returns the number of arguments passed to the function - * @link http://www.php.net/manual/en/function.func-num-args.php - * @return int Returns the number of arguments passed into the current user-defined - * function. + * {@inheritdoc} */ function func_num_args (): int {} /** - * Return an item from the argument list - * @link http://www.php.net/manual/en/function.func-get-arg.php - * @param int $position - * @return mixed Returns the specified argument, or false on error. + * {@inheritdoc} + * @param int $position */ function func_get_arg (int $position): mixed {} /** - * Returns an array comprising a function's argument list - * @link http://www.php.net/manual/en/function.func-get-args.php - * @return array Returns an array in which each element is a copy of the corresponding - * member of the current user-defined function's argument list. + * {@inheritdoc} */ function func_get_args (): array {} /** - * Get string length - * @link http://www.php.net/manual/en/function.strlen.php - * @param string $string - * @return int The length of the string in bytes. + * {@inheritdoc} + * @param string $string */ function strlen (string $string): int {} /** - * Binary safe string comparison - * @link http://www.php.net/manual/en/function.strcmp.php - * @param string $string1 - * @param string $string2 - * @return int Returns -1 if string1 is less than - * string2; 1 if string1 - * is greater than string2, and 0 if they are - * equal. + * {@inheritdoc} + * @param string $string1 + * @param string $string2 */ function strcmp (string $string1, string $string2): int {} /** - * Binary safe string comparison of the first n characters - * @link http://www.php.net/manual/en/function.strncmp.php - * @param string $string1 - * @param string $string2 - * @param int $length - * @return int Returns -1 if string1 is less than - * string2; 1 if string1 - * is greater than string2, and 0 if they are - * equal. + * {@inheritdoc} + * @param string $string1 + * @param string $string2 + * @param int $length */ function strncmp (string $string1, string $string2, int $length): int {} /** - * Binary safe case-insensitive string comparison - * @link http://www.php.net/manual/en/function.strcasecmp.php - * @param string $string1 - * @param string $string2 - * @return int Returns -1 if string1 is less than - * string2; 1 if string1 - * is greater than string2, and 0 if they are - * equal. + * {@inheritdoc} + * @param string $string1 + * @param string $string2 */ function strcasecmp (string $string1, string $string2): int {} /** - * Binary safe case-insensitive string comparison of the first n characters - * @link http://www.php.net/manual/en/function.strncasecmp.php - * @param string $string1 - * @param string $string2 - * @param int $length - * @return int Returns -1 if string1 is less than - * string2; 1 if string1 is - * greater than string2, and 0 if they are equal. + * {@inheritdoc} + * @param string $string1 + * @param string $string2 + * @param int $length */ function strncasecmp (string $string1, string $string2, int $length): int {} /** - * Sets which PHP errors are reported - * @link http://www.php.net/manual/en/function.error-reporting.php - * @param int|null $error_level [optional] - * @return int Returns the old error_reporting - * level or the current level if no error_level parameter is - * given. + * {@inheritdoc} + * @param int|null $error_level [optional] */ -function error_reporting (?int $error_level = null): int {} +function error_reporting (?int $error_level = NULL): int {} /** - * Defines a named constant - * @link http://www.php.net/manual/en/function.define.php - * @param string $constant_name - * @param mixed $value - * @param bool $case_insensitive [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $constant_name + * @param mixed $value + * @param bool $case_insensitive [optional] */ -function define (string $constant_name, mixed $value, bool $case_insensitive = false): bool {} +function define (string $constant_name, mixed $value = null, bool $case_insensitive = false): bool {} /** - * Checks whether a given named constant exists - * @link http://www.php.net/manual/en/function.defined.php - * @param string $constant_name - * @return bool Returns true if the named constant given by constant_name - * has been defined, false otherwise. + * {@inheritdoc} + * @param string $constant_name */ function defined (string $constant_name): bool {} /** - * Returns the name of the class of an object - * @link http://www.php.net/manual/en/function.get-class.php - * @param object $object [optional] - * @return string Returns the name of the class of which object is an - * instance. - *If object is omitted when inside a class, the - * name of that class is returned.
- *If the object is an instance of a class which exists - * in a namespace, the qualified namespaced name of that class is returned.
+ * {@inheritdoc} + * @param object $object [optional] */ -function get_class (object $object = null): string {} +function get_class (object $object = NULL): string {} /** - * The "Late Static Binding" class name - * @link http://www.php.net/manual/en/function.get-called-class.php - * @return string Returns the class name. Returns false if called from outside a class. + * {@inheritdoc} */ function get_called_class (): string {} /** - * Retrieves the parent class name for object or class - * @link http://www.php.net/manual/en/function.get-parent-class.php - * @param object|string $object_or_class [optional] - * @return string|false Returns the name of the parent class of the class of which - * object_or_class is an instance or the name. - *If the object does not have a parent or the class given does not exist false will be returned.
- *If called without parameter outside object, this function returns false.
+ * {@inheritdoc} + * @param object|string $object_or_class [optional] */ -function get_parent_class (object|string $object_or_class = null): string|false {} +function get_parent_class (object|string $object_or_class = NULL): string|false {} /** - * Checks if the object has this class as one of its parents or implements it - * @link http://www.php.net/manual/en/function.is-subclass-of.php - * @param mixed $object_or_class - * @param string $class - * @param bool $allow_string [optional] - * @return bool This function returns true if the object object_or_class, - * belongs to a class which is a subclass of - * class, false otherwise. + * {@inheritdoc} + * @param mixed $object_or_class + * @param string $class + * @param bool $allow_string [optional] */ -function is_subclass_of (mixed $object_or_class, string $class, bool $allow_string = true): bool {} +function is_subclass_of (mixed $object_or_class = null, string $class, bool $allow_string = true): bool {} /** - * Checks whether the object is of a given type or subtype - * @link http://www.php.net/manual/en/function.is-a.php - * @param mixed $object_or_class - * @param string $class - * @param bool $allow_string [optional] - * @return bool Returns true if the object is of this object type or has this object type as one of - * its supertypes, false otherwise. + * {@inheritdoc} + * @param mixed $object_or_class + * @param string $class + * @param bool $allow_string [optional] */ -function is_a (mixed $object_or_class, string $class, bool $allow_string = false): bool {} +function is_a (mixed $object_or_class = null, string $class, bool $allow_string = false): bool {} /** - * Get the default properties of the class - * @link http://www.php.net/manual/en/function.get-class-vars.php - * @param string $class - * @return array Returns an associative array of declared properties visible from the - * current scope, with their default value. - * The resulting array elements are in the form of - * varname => value. - * In case of an error, it returns false. + * {@inheritdoc} + * @param string $class */ function get_class_vars (string $class): array {} /** - * Gets the properties of the given object - * @link http://www.php.net/manual/en/function.get-object-vars.php - * @param object $object - * @return array Returns an associative array of defined object accessible non-static properties - * for the specified object in scope. + * {@inheritdoc} + * @param object $object */ function get_object_vars (object $object): array {} /** - * Returns an array of mangled object properties - * @link http://www.php.net/manual/en/function.get-mangled-object-vars.php - * @param object $object - * @return array Returns an array containing all properties, regardless of visibility, of object. + * {@inheritdoc} + * @param object $object */ function get_mangled_object_vars (object $object): array {} /** - * Gets the class methods' names - * @link http://www.php.net/manual/en/function.get-class-methods.php - * @param object|string $object_or_class - * @return array Returns an array of method names defined for the class specified by - * object_or_class. + * {@inheritdoc} + * @param object|string $object_or_class */ function get_class_methods (object|string $object_or_class): array {} /** - * Checks if the class method exists - * @link http://www.php.net/manual/en/function.method-exists.php - * @param object|string $object_or_class - * @param string $method - * @return bool Returns true if the method given by method - * has been defined for the given object_or_class, false - * otherwise. + * {@inheritdoc} + * @param mixed $object_or_class + * @param string $method */ -function method_exists (object|string $object_or_class, string $method): bool {} +function method_exists ($object_or_class = null, string $method): bool {} /** - * Checks if the object or class has a property - * @link http://www.php.net/manual/en/function.property-exists.php - * @param object|string $object_or_class - * @param string $property - * @return bool Returns true if the property exists, false if it doesn't exist or - * null in case of an error. + * {@inheritdoc} + * @param mixed $object_or_class + * @param string $property */ -function property_exists (object|string $object_or_class, string $property): bool {} +function property_exists ($object_or_class = null, string $property): bool {} /** - * Checks if the class has been defined - * @link http://www.php.net/manual/en/function.class-exists.php - * @param string $class - * @param bool $autoload [optional] - * @return bool Returns true if class is a defined class, - * false otherwise. + * {@inheritdoc} + * @param string $class + * @param bool $autoload [optional] */ function class_exists (string $class, bool $autoload = true): bool {} /** - * Checks if the interface has been defined - * @link http://www.php.net/manual/en/function.interface-exists.php - * @param string $interface - * @param bool $autoload [optional] - * @return bool Returns true if the interface given by - * interface has been defined, false otherwise. + * {@inheritdoc} + * @param string $interface + * @param bool $autoload [optional] */ function interface_exists (string $interface, bool $autoload = true): bool {} /** - * Checks if the trait exists - * @link http://www.php.net/manual/en/function.trait-exists.php - * @param string $trait Name of the trait to check - * @param bool $autoload [optional] Whether to autoload - * if not already loaded. - * @return bool Returns true if trait exists, and false otherwise. + * {@inheritdoc} + * @param string $trait + * @param bool $autoload [optional] */ function trait_exists (string $trait, bool $autoload = true): bool {} /** - * Checks if the enum has been defined - * @link http://www.php.net/manual/en/function.enum-exists.php - * @param string $enum - * @param bool $autoload [optional] - * @return bool Returns true if enum is a defined enum, - * false otherwise. + * {@inheritdoc} + * @param string $enum + * @param bool $autoload [optional] */ function enum_exists (string $enum, bool $autoload = true): bool {} /** - * Return true if the given function has been defined - * @link http://www.php.net/manual/en/function.function-exists.php - * @param string $function - * @return bool Returns true if function exists and is a - * function, false otherwise. - *This function will return false for constructs, such as - * include_once and echo.
+ * {@inheritdoc} + * @param string $function */ function function_exists (string $function): bool {} /** - * Creates an alias for a class - * @link http://www.php.net/manual/en/function.class-alias.php - * @param string $class - * @param string $alias - * @param bool $autoload [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $class + * @param string $alias + * @param bool $autoload [optional] */ function class_alias (string $class, string $alias, bool $autoload = true): bool {} /** - * Returns an array with the names of included or required files - * @link http://www.php.net/manual/en/function.get-included-files.php - * @return array Returns an array of the names of all files. - *The script originally called is considered an "included file," so it will - * be listed together with the files referenced by - * include and family.
- *Files that are included or required multiple times only show up once in - * the returned array.
+ * {@inheritdoc} */ function get_included_files (): array {} /** - * Alias of get_included_files - * @link http://www.php.net/manual/en/function.get-required-files.php - * @return array Returns an array of the names of all files. - *The script originally called is considered an "included file," so it will - * be listed together with the files referenced by - * include and family.
- *Files that are included or required multiple times only show up once in - * the returned array.
+ * {@inheritdoc} */ function get_required_files (): array {} /** - * Generates a user-level error/warning/notice message - * @link http://www.php.net/manual/en/function.trigger-error.php - * @param string $message - * @param int $error_level [optional] - * @return bool This function returns false if wrong error_level is - * specified, true otherwise. + * {@inheritdoc} + * @param string $message + * @param int $error_level [optional] */ -function trigger_error (string $message, int $error_level = E_USER_NOTICE): bool {} +function trigger_error (string $message, int $error_level = 1024): bool {} /** * {@inheritdoc} @@ -2354,461 +1501,155 @@ function trigger_error (string $message, int $error_level = E_USER_NOTICE): bool function user_error (string $message, int $error_level = 1024): bool {} /** - * Sets a user-defined error handler function - * @link http://www.php.net/manual/en/function.set-error-handler.php - * @param callable|null $callback - * @param int $error_levels [optional] - * @return callable|null Returns the previously defined error handler (if any). If - * the built-in error handler is used null is returned. - * If the previous error handler - * was a class method, this function will return an indexed array with the class - * and the method name. + * {@inheritdoc} + * @param callable|null $callback + * @param int $error_levels [optional] */ -function set_error_handler (?callable $callback, int $error_levels = E_ALL): ?callable {} +function set_error_handler (?callable $callback = null, int $error_levels = 32767) {} /** - * Restores the previous error handler function - * @link http://www.php.net/manual/en/function.restore-error-handler.php - * @return true Always returns true. + * {@inheritdoc} */ function restore_error_handler (): true {} /** - * Sets a user-defined exception handler function - * @link http://www.php.net/manual/en/function.set-exception-handler.php - * @param callable|null $callback - * @return callable|null Returns the previously defined exception handler, or null on error. If - * no previous handler was defined, null is also returned. + * {@inheritdoc} + * @param callable|null $callback */ -function set_exception_handler (?callable $callback): ?callable {} +function set_exception_handler (?callable $callback = null) {} /** - * Restores the previously defined exception handler function - * @link http://www.php.net/manual/en/function.restore-exception-handler.php - * @return true Always returns true. + * {@inheritdoc} */ function restore_exception_handler (): true {} /** - * Returns an array with the name of the defined classes - * @link http://www.php.net/manual/en/function.get-declared-classes.php - * @return array Returns an array of the names of the declared classes in the current - * script. - *Note that depending on what extensions you have compiled or - * loaded into PHP, additional classes could be present. This means that - * you will not be able to define your own classes using these - * names. There is a list of predefined classes in the Predefined Classes section of - * the appendices.
+ * {@inheritdoc} */ function get_declared_classes (): array {} /** - * Returns an array of all declared traits - * @link http://www.php.net/manual/en/function.get-declared-traits.php - * @return array Returns an array with names of all declared traits in values. + * {@inheritdoc} */ function get_declared_traits (): array {} /** - * Returns an array of all declared interfaces - * @link http://www.php.net/manual/en/function.get-declared-interfaces.php - * @return array Returns an array of the names of the declared interfaces in the current - * script. + * {@inheritdoc} */ function get_declared_interfaces (): array {} /** - * Returns an array of all defined functions - * @link http://www.php.net/manual/en/function.get-defined-functions.php - * @param bool $exclude_disabled [optional] Whether disabled functions should be excluded from the return value. - * @return array Returns a multidimensional array containing a list of all defined - * functions, both built-in (internal) and user-defined. The internal - * functions will be accessible via $arr["internal"], and - * the user defined ones using $arr["user"] (see example - * below). + * {@inheritdoc} + * @param bool $exclude_disabled [optional] */ function get_defined_functions (bool $exclude_disabled = true): array {} /** - * Returns an array of all defined variables - * @link http://www.php.net/manual/en/function.get-defined-vars.php - * @return array A multidimensional array with all the variables. + * {@inheritdoc} */ function get_defined_vars (): array {} /** - * Returns the resource type - * @link http://www.php.net/manual/en/function.get-resource-type.php - * @param resource $resource - * @return string If the given resource is a resource, this function - * will return a string representing its type. If the type is not identified - * by this function, the return value will be the string - * Unknown. - *This function will return null and generate an error if - * resource is not a resource.
+ * {@inheritdoc} + * @param mixed $resource */ -function get_resource_type ($resource): string {} +function get_resource_type ($resource = null): string {} /** - * Returns an integer identifier for the given resource - * @link http://www.php.net/manual/en/function.get-resource-id.php - * @param resource $resource - * @return int The int identifier for the given resource. - *This function is essentially an int cast of - * resource to make it easier to retrieve the resource ID.
+ * {@inheritdoc} + * @param mixed $resource */ -function get_resource_id ($resource): int {} +function get_resource_id ($resource = null): int {} /** - * Returns active resources - * @link http://www.php.net/manual/en/function.get-resources.php - * @param string|null $type [optional] - * @return array Returns an array of currently active resources, indexed by - * resource number. + * {@inheritdoc} + * @param string|null $type [optional] */ -function get_resources (?string $type = null): array {} +function get_resources (?string $type = NULL): array {} /** - * Returns an array with the names of all modules compiled and loaded - * @link http://www.php.net/manual/en/function.get-loaded-extensions.php - * @param bool $zend_extensions [optional] - * @return array Returns an indexed array of all the modules names. + * {@inheritdoc} + * @param bool $zend_extensions [optional] */ function get_loaded_extensions (bool $zend_extensions = false): array {} /** - * Returns an associative array with the names of all the constants and their values - * @link http://www.php.net/manual/en/function.get-defined-constants.php - * @param bool $categorize [optional] - * @return array Returns an array of constant name => constant value array, optionally - * groupped by extension name registering the constant. + * {@inheritdoc} + * @param bool $categorize [optional] */ function get_defined_constants (bool $categorize = false): array {} /** - * Generates a backtrace - * @link http://www.php.net/manual/en/function.debug-backtrace.php - * @param int $options [optional] - * @param int $limit [optional] - * @return array Returns an array of associative arrays. The possible returned elements - * are as follows: - *Name | - *Type | - *Description | - *
function | - *string | - *- * The current function name. See also - * __FUNCTION__. - * | - *
line | - *int | - *- * The current line number. See also - * __LINE__. - * | - *
file | - *string | - *- * The current file name. See also - * __FILE__. - * | - *
class | - *string | - *- * The current class name. See also - * __CLASS__ - * | - *
object | - *object | - *- * The current object. - * | - *
type | - *string | - *- * The current call type. If a method call, "->" is returned. If a static - * method call, "::" is returned. If a function call, nothing is returned. - * | - *
args | - *array | - *- * If inside a function, this lists the functions arguments. If - * inside an included file, this lists the included file name(s). - * | - *
- *
- * "runs"
- *
- * "collected"
- *
- * "threshold"
- *
- * "roots"
- *
This is an alias for - * PHP_OUTPUT_HANDLER_WRITE.
- * @link http://www.php.net/manual/en/outcontrol.constants.php - * @var int - */ define ('PHP_OUTPUT_HANDLER_CONT', 0); - -/** - * Indicates that output buffering has ended. - *This is an alias for - * PHP_OUTPUT_HANDLER_FINAL.
- * @link http://www.php.net/manual/en/outcontrol.constants.php - * @var int - */ define ('PHP_OUTPUT_HANDLER_END', 8); - -/** - * Controls whether an output buffer created by - * ob_start can be cleaned. - * @link http://www.php.net/manual/en/outcontrol.constants.php - * @var int - */ define ('PHP_OUTPUT_HANDLER_CLEANABLE', 16); - -/** - * Controls whether an output buffer created by - * ob_start can be flushed. - * @link http://www.php.net/manual/en/outcontrol.constants.php - * @var int - */ define ('PHP_OUTPUT_HANDLER_FLUSHABLE', 32); - -/** - * Controls whether an output buffer created by - * ob_start can be removed before the end of the script. - * @link http://www.php.net/manual/en/outcontrol.constants.php - * @var int - */ define ('PHP_OUTPUT_HANDLER_REMOVABLE', 64); - -/** - * The default set of output buffer flags; currently equivalent to - * PHP_OUTPUT_HANDLER_CLEANABLE | - * PHP_OUTPUT_HANDLER_FLUSHABLE | - * PHP_OUTPUT_HANDLER_REMOVABLE. - * @link http://www.php.net/manual/en/outcontrol.constants.php - * @var int - */ define ('PHP_OUTPUT_HANDLER_STDFLAGS', 112); define ('PHP_OUTPUT_HANDLER_STARTED', 4096); define ('PHP_OUTPUT_HANDLER_DISABLED', 8192); @@ -3198,9 +1713,11 @@ function gc_status (): array {} define ('UPLOAD_ERR_NO_TMP_DIR', 6); define ('UPLOAD_ERR_CANT_WRITE', 7); define ('UPLOAD_ERR_EXTENSION', 8); -define ('PHP_CLI_PROCESS_TITLE', false); +define ('PHP_SAPI', "cli"); +define ('PHP_BINARY', "/opt/homebrew/Cellar/php/8.3.0/bin/php"); +define ('PHP_CLI_PROCESS_TITLE', true); define ('STDIN', "Resource id #1"); define ('STDOUT', "Resource id #2"); define ('STDERR', "Resource id #3"); -// End of Core v.8.2.6 +// End of Core v.8.3.0 diff --git a/plugins/org.eclipse.php.core/Resources/language/php8.3/FFI.php b/plugins/org.eclipse.php.core/Resources/language/php8.3/FFI.php index 953aa9a97a..0b52b29a8d 100644 --- a/plugins/org.eclipse.php.core/Resources/language/php8.3/FFI.php +++ b/plugins/org.eclipse.php.core/Resources/language/php8.3/FFI.php @@ -1,23 +1,18 @@ FFI definition parsing and shared library loading may take significant time. It is not useful - * to do it on each HTTP request in a Web environment. However, it is possible to preload FFI definitions - * and libraries at PHP startup, and to instantiate FFI objects when necessary. Header files - * may be extended with special FFI_SCOPE defines (e.g. #define FFI_SCOPE "foo"”"; - * the default scope is "C") and then loaded by FFI::load during preloading. - * This leads to the creation of a persistent binding, that will be available to all the following - * requests through FFI::scope. - * Refer to the complete PHP/FFI/preloading example - * for details. - *It is possible to preload more than one C header file into the same scope.
- * @link http://www.php.net/manual/en/class.ffi.php - */ final class FFI { const __BIGGEST_ALIGNMENT__ = 8; /** - * Creates a new FFI object - * @link http://www.php.net/manual/en/ffi.cdef.php - * @param string $code [optional] A string containing a sequence of declarations in regular C language - * (types, structures, functions, variables, etc). Actually, this string may - * be copy-pasted from C header files. - *C preprocessor directives are not supported, i.e. #include, - * #define and CPP macros do not work.
- * @param string|null $lib [optional] The name of a shared library file, to be loaded and linked with the - * definitions. - *If lib is omitted, platforms supporting RTLD_DEFAULT - * attempt to lookup symbols declared in code in the normal global - * scope. Other systems will fail to resolve these symbols.
- * @return FFI Returns the freshly created FFI object. - */ - public static function cdef (string $code = '""', ?string $lib = null): FFI {} - - /** - * Loads C declarations from a C header file - * @link http://www.php.net/manual/en/ffi.load.php - * @param string $filename The name of a C header file. - *C preprocessor directives are not supported, i.e. #include, - * #define and CPP macros do not work, except for special cases - * listed below.
- *The header file should contain a #define statement for the - * FFI_SCOPE variable, e.g.: #define FFI_SCOPE "MYLIB". - * Refer to the class introduction for details.
- *The header file may contain a #define statement for the - * FFI_LIB variable to specify the library it exposes. If it is - * a system library only the file name is required, e.g.: #define FFI_LIB - * "libc.so.6". If it is a custom library, a relative path is required, - * e.g.: #define FFI_LIB "./mylib.so".
- * @return FFI|null Returns the freshly created FFI object, or null on failure. + * {@inheritdoc} + * @param string $code [optional] + * @param string|null $lib [optional] + */ + public static function cdef (string $code = '', ?string $lib = NULL): FFI {} + + /** + * {@inheritdoc} + * @param string $filename */ public static function load (string $filename): ?FFI {} /** - * Instantiates an FFI object with C declarations parsed during preloading - * @link http://www.php.net/manual/en/ffi.scope.php - * @param string $name The scope name defined by a special FFI_SCOPE define. - * @return FFI Returns the freshly created FFI object. + * {@inheritdoc} + * @param string $name */ public static function scope (string $name): FFI {} /** - * Creates a C data structure - * @link http://www.php.net/manual/en/ffi.new.php - * @param FFI\CType|string $type type is a valid C declaration as string, or an - * instance of FFI\CType which has already been created. - * @param bool $owned [optional] Whether to create owned (i.e. managed) or unmanaged data. Managed data lives together - * with the returned FFI\CData object, and is released when the - * last reference to that object is released by regular PHP reference counting or GC. - * Unmanaged data should be released by calling FFI::free, - * when no longer needed. - * @param bool $persistent [optional] Whether to allocate the C data structure permanently on the system heap (using - * malloc), or on the PHP request heap (using emalloc). - * @return FFI\CData|null Returns the freshly created FFI\CData object, - * or null on failure. + * {@inheritdoc} + * @param FFI\CType|string $type + * @param bool $owned [optional] + * @param bool $persistent [optional] */ public static function new (FFI\CType|string $type, bool $owned = true, bool $persistent = false): ?FFI\CData {} /** - * Releases an unmanaged data structure - * @link http://www.php.net/manual/en/ffi.free.php - * @param FFI\CData $ptr The handle of the unmanaged pointer to a C data structure. - * @return void No value is returned. + * {@inheritdoc} + * @param FFI\CData $ptr */ public static function free (FFI\CData &$ptr): void {} /** - * Performs a C type cast - * @link http://www.php.net/manual/en/ffi.cast.php - * @param FFI\CType|string $type A valid C declaration as string, or an instance of FFI\CType - * which has already been created. - * @param FFI\CData|int|float|bool|null $ptr The handle of the pointer to a C data structure. - * @return FFI\CData|null Returns the freshly created FFI\CData object. + * {@inheritdoc} + * @param FFI\CType|string $type + * @param mixed $ptr */ - public static function cast (FFI\CType|string $type, FFI\CData|int|float|bool|null &$ptr): ?FFI\CData {} + public static function cast (FFI\CType|string $type, &$ptr = null): ?FFI\CData {} /** - * Creates an FFI\CType object from a C declaration - * @link http://www.php.net/manual/en/ffi.type.php - * @param string $type A valid C declaration as string, or an instance of FFI\CType - * which has already been created. - * @return FFI\CType|null Returns the freshly created FFI\CType object, - * or null on failure. + * {@inheritdoc} + * @param string $type */ public static function type (string $type): ?FFI\CType {} /** - * Gets the FFI\CType of FFI\CData - * @link http://www.php.net/manual/en/ffi.typeof.php - * @param FFI\CData $ptr The handle of the pointer to a C data structure. - * @return FFI\CType Returns the FFI\CType object representing the type of the given - * FFI\CData object. + * {@inheritdoc} + * @param FFI\CData $ptr */ public static function typeof (FFI\CData &$ptr): FFI\CType {} /** - * Dynamically constructs a new C array type - * @link http://www.php.net/manual/en/ffi.arraytype.php - * @param FFI\CType $type A valid C declaration as string, or an instance of FFI\CType - * which has already been created. - * @param array $dimensions The dimensions of the type as array. - * @return FFI\CType Returns the freshly created FFI\CType object. + * {@inheritdoc} + * @param FFI\CType $type + * @param array $dimensions */ public static function arrayType (FFI\CType $type, array $dimensions): FFI\CType {} /** - * Creates an unmanaged pointer to C data - * @link http://www.php.net/manual/en/ffi.addr.php - * @param FFI\CData $ptr The handle of the pointer to a C data structure. - * @return FFI\CData Returns the freshly created FFI\CData object. + * {@inheritdoc} + * @param FFI\CData $ptr */ public static function addr (FFI\CData &$ptr): FFI\CData {} /** - * Gets the size of C data or types - * @link http://www.php.net/manual/en/ffi.sizeof.php - * @param FFI\CData|FFI\CType $ptr The handle of the C data or type. - * @return int The size of the memory area pointed at by ptr. + * {@inheritdoc} + * @param FFI\CData|FFI\CType $ptr */ public static function sizeof (FFI\CData|FFI\CType &$ptr): int {} /** - * Gets the alignment - * @link http://www.php.net/manual/en/ffi.alignof.php - * @param FFI\CData|FFI\CType $ptr The handle of the C data or type. - * @return int Returns the alignment of the given FFI\CData or - * FFI\CType object. + * {@inheritdoc} + * @param FFI\CData|FFI\CType $ptr */ public static function alignof (FFI\CData|FFI\CType &$ptr): int {} /** - * Copies one memory area to another - * @link http://www.php.net/manual/en/ffi.memcpy.php - * @param FFI\CData $to The start of the memory area to copy to. - * @param FFI\CData|string $from The start of the memory area to copy from. - * @param int $size The number of bytes to copy. - * @return void No value is returned. + * {@inheritdoc} + * @param FFI\CData $to + * @param mixed $from + * @param int $size */ - public static function memcpy (FFI\CData &$to, FFI\CData|string &$from, int $size): void {} + public static function memcpy (FFI\CData &$to, &$from = null, int $size): void {} /** - * Compares memory areas - * @link http://www.php.net/manual/en/ffi.memcmp.php - * @param string|FFI\CData $ptr1 The start of one memory area. - * @param string|FFI\CData $ptr2 The start of another memory area. - * @param int $size The number of bytes to compare. - * @return int Returns < 0 if the contents of the memory area starting at ptr1 - * are considered less than the contents of the memory area starting at ptr2, - * > 0 if the contents of the first memory area are considered greater than the second, - * and 0 if they are equal. + * {@inheritdoc} + * @param mixed $ptr1 + * @param mixed $ptr2 + * @param int $size */ - public static function memcmp (string|FFI\CData &$ptr1, string|FFI\CData &$ptr2, int $size): int {} + public static function memcmp (&$ptr1 = null, &$ptr2 = null, int $size): int {} /** - * Fills a memory area - * @link http://www.php.net/manual/en/ffi.memset.php - * @param FFI\CData $ptr The start of the memory area to fill. - * @param int $value The byte to fill with. - * @param int $size The number of bytes to fill. - * @return void No value is returned. + * {@inheritdoc} + * @param FFI\CData $ptr + * @param int $value + * @param int $size */ public static function memset (FFI\CData &$ptr, int $value, int $size): void {} /** - * Creates a PHP string from a memory area - * @link http://www.php.net/manual/en/ffi.string.php - * @param FFI\CData $ptr The start of the memory area from which to create a string. - * @param int|null $size [optional] The number of bytes to copy to the string. - * If size is omitted, ptr must be a zero terminated - * array of C chars. - * @return string The freshly created PHP string. + * {@inheritdoc} + * @param FFI\CData $ptr + * @param int|null $size [optional] */ - public static function string (FFI\CData &$ptr, ?int $size = null): string {} + public static function string (FFI\CData &$ptr, ?int $size = NULL): string {} /** - * Checks whether a FFI\CData is a null pointer - * @link http://www.php.net/manual/en/ffi.isnull.php - * @param FFI\CData $ptr The handle of the pointer to a C data structure. - * @return bool Returns whether a FFI\CData is a null pointer. + * {@inheritdoc} + * @param FFI\CData $ptr */ public static function isNull (FFI\CData &$ptr): bool {} @@ -383,52 +250,9 @@ public static function isNull (FFI\CData &$ptr): bool {} namespace FFI { -/** - * FFI\CData objects can be used in a number of ways as a regular - * PHP data: - *
- *
- * C data of scalar types can be read and assigned via the $cdata property, e.g.
- * $x = FFI::new('int'); $x->cdata = 42;
- *
- * C struct and union fields can be accessed as regular PHP object property, e.g.
- * $cdata->field
- *
- * C array elements can be accessed as regular PHP array elements, e.g.
- * $cdata[$offset]
- *
- * C arrays can be iterated using foreach statements.
- *
- * C arrays can be used as arguments of count.
- *
- * C pointers can be dereferenced as arrays, e.g. $cdata[0]
- *
- * C pointers can be compared using regular comparison operators (<,
- * <=, ==, !=, >=, >).
- *
- * C pointers can be incremented and decremented using regular +/-/
- * ++/–- operations, e.g. $cdata += 5
- *
- * C pointers can be subtracted from another using regular - operations.
- *
- * C pointers to functions can be called as a regular PHP closure, e.g. $cdata()
- *
- * Any C data can be duplicated using the clone
- * operator, e.g. $cdata2 = clone $cdata;
- *
- * Any C data can be visualized using var_dump, print_r, etc.
- *
<?php
- * if ($db->getAttribute(PDO::ATTR_DRIVER_NAME) == 'mysql') {
- * echo "Running on mysql; doing something mysql specific here\n";
- * }
- * ?>
- *
- * @var string
const ATTR_DRIVER_NAME = 16;
- /**
- * Forces all values fetched to be treated as strings.
- * @var int
const ATTR_STRINGIFY_FETCHES = 17;
- /**
- * Sets the maximum column name length.
- * @var int
const ATTR_MAX_COLUMN_LEN = 18;
- /**
- * @var int
const ATTR_EMULATE_PREPARES = 20;
- /**
- * @var int
const ATTR_DEFAULT_FETCH_MODE = 19;
- /**
- * Sets the default string parameter type, this can be one of PDO::PARAM_STR_NATL
- * and PDO::PARAM_STR_CHAR.
- * Available since PHP 7.2.0.
- * @var int
const ATTR_DEFAULT_STR_PARAM = 21;
- /**
- * Do not raise an error or exception if an error occurs. The developer is
- * expected to explicitly check for errors. This is the default mode.
- * See Errors and error handling
- * for more information about this attribute.
- * @var int
const ERRMODE_SILENT = 0;
- /**
- * Issue a PHP E_WARNING message if an error occurs.
- * See Errors and error handling
- * for more information about this attribute.
- * @var int
const ERRMODE_WARNING = 1;
- /**
- * Throw a PDOException if an error occurs.
- * See Errors and error handling
- * for more information about this attribute.
- * @var int
const ERRMODE_EXCEPTION = 2;
- /**
- * Leave column names as returned by the database driver.
- * @var int
const CASE_NATURAL = 0;
- /**
- * Force column names to lower case.
- * @var int
const CASE_LOWER = 2;
- /**
- * Force column names to upper case.
- * @var int
const CASE_UPPER = 1;
- /**
- * @var int
const NULL_NATURAL = 0;
- /**
- * @var int
const NULL_EMPTY_STRING = 1;
- /**
- * @var int
const NULL_TO_STRING = 2;
- /**
- * Corresponds to SQLSTATE '00000', meaning that the SQL statement was
- * successfully issued with no errors or warnings. This constant is for
- * your convenience when checking PDO::errorCode or
- * PDOStatement::errorCode to determine if an error
- * occurred. You will usually know if this is the case by examining the
- * return code from the method that raised the error condition anyway.
- * @var string
const ERR_NONE = 00000;
- /**
- * Fetch the next row in the result set. Valid only for scrollable cursors.
- * @var int
const FETCH_ORI_NEXT = 0;
- /**
- * Fetch the previous row in the result set. Valid only for scrollable
- * cursors.
- * @var int
const FETCH_ORI_PRIOR = 1;
- /**
- * Fetch the first row in the result set. Valid only for scrollable cursors.
- * @var int
const FETCH_ORI_FIRST = 2;
- /**
- * Fetch the last row in the result set. Valid only for scrollable cursors.
- * @var int
const FETCH_ORI_LAST = 3;
- /**
- * Fetch the requested row by row number from the result set. Valid only
- * for scrollable cursors.
- * @var int
const FETCH_ORI_ABS = 4;
- /**
- * Fetch the requested row by relative position from the current position
- * of the cursor in the result set. Valid only for scrollable cursors.
- * @var int
const FETCH_ORI_REL = 5;
- /**
- * Create a PDOStatement object with a forward-only cursor. This is the
- * default cursor choice, as it is the fastest and most common data access
- * pattern in PHP.
- * @var int
const CURSOR_FWDONLY = 0;
- /**
- * Create a PDOStatement object with a scrollable cursor. Pass the
- * PDO::FETCH_ORI_* constants to control the rows fetched from the result set.
- * @var int
const CURSOR_SCROLL = 1;
const DBLIB_ATTR_CONNECTION_TIMEOUT = 1000;
const DBLIB_ATTR_QUERY_TIMEOUT = 1001;
@@ -491,149 +145,33 @@ class PDO {
const DBLIB_ATTR_TDS_VERSION = 1004;
const DBLIB_ATTR_SKIP_EMPTY_ROWSETS = 1005;
const DBLIB_ATTR_DATETIME_CONVERT = 1006;
- /**
- * Setting MySQL unbuffered mode
- *
- * <?php
- * $pdo = new PDO("mysql:host=localhost;dbname=world", 'my_user', 'my_password');
- * $pdo->setAttribute(PDO::MYSQL_ATTR_USE_BUFFERED_QUERY, false);
- * $unbufferedResult = $pdo->query("SELECT Name FROM City");
- * foreach ($unbufferedResult as $row) {
- * echo $row['Name'] . PHP_EOL;
- * }
- * ?>
- *
- * @var bool
const MYSQL_ATTR_USE_BUFFERED_QUERY = 1000;
- /**
- * Enable LOAD LOCAL INFILE.
- * Note, this constant can only be used in the driver_options - * array when constructing a new database handle.
- * @var int const MYSQL_ATTR_LOCAL_INFILE = 1001; - /** - * Command to execute when connecting to the MySQL server. Will - * automatically be re-executed when reconnecting. - *Note, this constant can only be used in the driver_options - * array when constructing a new database handle.
- * @var string const MYSQL_ATTR_INIT_COMMAND = 1002; - /** - * Enable network communication compression. - * @var int const MYSQL_ATTR_COMPRESS = 1003; - /** - * Perform direct queries, don't use prepared statements. - * @var int const MYSQL_ATTR_DIRECT_QUERY = 1004; - /** - * Return the number of found (matched) rows, not the - * number of changed rows. - * @var int const MYSQL_ATTR_FOUND_ROWS = 1005; - /** - * Permit spaces after function names. Makes all functions - * names reserved words. - * @var int const MYSQL_ATTR_IGNORE_SPACE = 1006; - /** - * The file path to the SSL key. - * @var int const MYSQL_ATTR_SSL_KEY = 1007; - /** - * The file path to the SSL certificate. - * @var int const MYSQL_ATTR_SSL_CERT = 1008; - /** - * The file path to the SSL certificate authority. - * @var int const MYSQL_ATTR_SSL_CA = 1009; - /** - * The file path to the directory that contains the trusted SSL - * CA certificates, which are stored in PEM format. - * @var int const MYSQL_ATTR_SSL_CAPATH = 1010; - /** - * A list of one or more permissible ciphers to use for SSL encryption, in a format - * understood by OpenSSL. For example: DHE-RSA-AES256-SHA:AES128-SHA - * @var int const MYSQL_ATTR_SSL_CIPHER = 1011; const MYSQL_ATTR_SERVER_PUBLIC_KEY = 1012; - /** - * Disables multi query execution in both PDO::prepare - * and PDO::query when set to false. - *Note, this constant can only be used in the driver_options - * array when constructing a new database handle.
- * @var int const MYSQL_ATTR_MULTI_STATEMENTS = 1013; - /** - * Provides a way to disable verification of the server SSL certificate. - *This exists as of PHP 7.0.18 and PHP 7.1.4.
- * @var int const MYSQL_ATTR_SSL_VERIFY_SERVER_CERT = 1014; - /** - * Allows restricting LOCAL DATA loading to files located in this designated - * directory. Available as of PHP 8.1.0. - *Note, this constant can only be used in the driver_options - * array when constructing a new database handle.
- * @var string const MYSQL_ATTR_LOCAL_INFILE_DIRECTORY = 1015; - /** - * This option controls whether the ODBC cursor library is used. The ODBC cursor library - * supports some advanced ODBC features (e.g. block scrollable cursors), which may not - * be implemented by the driver. The following values are supported: - *
- *
- *
- * PDO::ODBC_SQL_USE_IF_NEEDED (the default): - * use the ODBC cursor library when needed. - *
- *- * PDO::ODBC_SQL_USE_DRIVER: - * never use the ODBC cursor library. - *
- *- * PDO::ODBC_SQL_USE_ODBC: - * always use the ODBC cursor library. - *
- * - *PDO::ODBC_SQL_USE_IF_NEEDED (the default): - * use the ODBC cursor library when needed.
- *PDO::ODBC_SQL_USE_DRIVER: - * never use the ODBC cursor library.
- *PDO::ODBC_SQL_USE_ODBC: - * always use the ODBC cursor library.
- * @var int const ODBC_ATTR_USE_CURSOR_LIBRARY = 1000; - /** - * Windows only. If true, UTF-16 encoded character data (CHAR, - * VARCHAR and LONGVARCHAR) is converted to - * UTF-8 when reading from or writing data to the database. - * If false (the default), character encoding conversion may be done by the driver. - * @var bool const ODBC_ATTR_ASSUME_UTF8 = 1001; const ODBC_SQL_USE_IF_NEEDED = 0; const ODBC_SQL_USE_DRIVER = 2; const ODBC_SQL_USE_ODBC = 1; - /** - * Send the query and the parameters to the server together in a single - * call, avoiding the need to create a named prepared statement separately. - * If the query is only going to be executed once this can reduce latency by - * avoiding an unnecessary server round-trip. - * @var int const PGSQL_ATTR_DISABLE_PREPARES = 1000; const PGSQL_TRANSACTION_IDLE = 0; const PGSQL_TRANSACTION_ACTIVE = 1; const PGSQL_TRANSACTION_INTRANS = 2; const PGSQL_TRANSACTION_INERROR = 3; const PGSQL_TRANSACTION_UNKNOWN = 4; - /** - * Specifies that a function created with PDO::sqliteCreateFunction - * is deterministic, i.e. it always returns the same result given the same inputs within - * a single SQL statement. (Available as of PHP 7.1.4.) - * @var int const SQLITE_DETERMINISTIC = 2048; const SQLITE_ATTR_OPEN_FLAGS = 1000; const SQLITE_OPEN_READONLY = 1; @@ -642,18 +180,7 @@ class PDO { const SQLITE_ATTR_READONLY_STATEMENT = 1001; const SQLITE_ATTR_EXTENDED_RESULT_CODES = 1002; const SQLSRV_ATTR_ENCODING = 1000; - /** - * A non-negative integer representing the timeout period, in seconds. Zero (0) - * is the default and means no timeout. This constant can be passed to - * PDOStatement::setAttribute, PDO::setAttribute, and PDO::prepare. - * @var int const SQLSRV_ATTR_QUERY_TIMEOUT = 1001; - /** - * Indicates that a query should be executed directly, without being prepared. - * This constant can be passed to PDO::setAttribute, and PDO::prepare. For more - * information, see - * Direct and Prepared Statement Execution. - * @var int const SQLSRV_ATTR_DIRECT_QUERY = 1002; const SQLSRV_ATTR_CURSOR_SCROLL_TYPE = 1003; const SQLSRV_ATTR_CLIENT_BUFFER_MAX_KB_SIZE = 1004; @@ -663,492 +190,245 @@ class PDO { const SQLSRV_ATTR_DECIMAL_PLACES = 1008; const SQLSRV_ATTR_DATA_CLASSIFICATION = 1009; const SQLSRV_PARAM_OUT_DEFAULT_SIZE = -1; - /** - * Specifies that data is sent/retrieved to/from the server according to - * PDO::SQLSRV_ENCODING_SYSTEM if specified during connection. The connection's - * encoding is used if specified in a prepare statement. This constant can be - * passed to PDOStatement::setAttribute, PDO::setAttribute, PDO::prepare, - * PDOStatement::bindColumn, and PDOStatement::bindParam. - * @var int const SQLSRV_ENCODING_DEFAULT = 1; - /** - * Specifies that data is sent/retrieved to/from the server as 8-bit characters - * as specified in the code page of the Windows locale that is set on the system. - * Any multi-byte characters or characters that do not map into this code page - * are substituted with a single byte question mark (?) character. This constant - * can be passed to PDOStatement::setAttribute, PDO::setAttribute, PDO::prepare, - * PDOStatement::bindColumn, and PDOStatement::bindParam. - * @var int const SQLSRV_ENCODING_SYSTEM = 3; - /** - * Specifies that data is sent/retrieved as a raw byte stream to/from the server - * without performing encoding or translation. This constant can be passed to - * PDOStatement::setAttribute, PDO::prepare, PDOStatement::bindColumn, and - * PDOStatement::bindParam. - * @var int const SQLSRV_ENCODING_BINARY = 2; - /** - * Specifies that data is sent/retrieved to/from the server in UTF-8 encoding. - * This is the default encoding. This constant can be passed to - * PDOStatement::setAttribute, PDO::setAttribute, PDO::prepare, - * PDOStatement::bindColumn, and PDOStatement::bindParam. - * @var int const SQLSRV_ENCODING_UTF8 = 65001; const SQLSRV_CURSOR_STATIC = 3; const SQLSRV_CURSOR_DYNAMIC = 2; const SQLSRV_CURSOR_KEYSET = 1; const SQLSRV_CURSOR_BUFFERED = 42; - /** - * This constant is an acceptable value for the SQLSRV DSN key TransactionIsolation. - * This constant sets the transaction isolation level for the connection to - * Read Uncommitted. - * @var int const SQLSRV_TXN_READ_UNCOMMITTED = "READ_UNCOMMITTED"; - /** - * This constant is an acceptable value for the SQLSRV DSN key TransactionIsolation. - * This constant sets the transaction isolation level for the connection to - * Read Committed. - * @var int const SQLSRV_TXN_READ_COMMITTED = "READ_COMMITTED"; - /** - * This constant is an acceptable value for the SQLSRV DSN key TransactionIsolation. - * This constant sets the transaction isolation level for the connection to - * Repeateable Read. - * @var int const SQLSRV_TXN_REPEATABLE_READ = "REPEATABLE_READ"; - /** - * This constant is an acceptable value for the SQLSRV DSN key TransactionIsolation. - * This constant sets the transaction isolation level for the connection to - * Serializable. - * @var int const SQLSRV_TXN_SERIALIZABLE = "SERIALIZABLE"; - /** - * This constant is an acceptable value for the SQLSRV DSN key TransactionIsolation. - * This constant sets the transaction isolation level for the connection to Snapshot. - * @var int const SQLSRV_TXN_SNAPSHOT = "SNAPSHOT"; /** - * Creates a PDO instance representing a connection to a database - * @link http://www.php.net/manual/en/pdo.construct.php - * @param string $dsn - * @param string|null $username [optional] - * @param string|null $password [optional] - * @param array|null $options [optional] - * @return string + * {@inheritdoc} + * @param string $dsn + * @param string|null $username [optional] + * @param string|null $password [optional] + * @param array|null $options [optional] */ - public function __construct (string $dsn, ?string $username = null, ?string $password = null, ?array $options = null): string {} + public function __construct (string $dsn, ?string $username = NULL, ?string $password = NULL, ?array $options = NULL) {} /** - * Initiates a transaction - * @link http://www.php.net/manual/en/pdo.begintransaction.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function beginTransaction (): bool {} + public function beginTransaction () {} /** - * Commits a transaction - * @link http://www.php.net/manual/en/pdo.commit.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function commit (): bool {} + public function commit () {} /** - * Fetch the SQLSTATE associated with the last operation on the database handle - * @link http://www.php.net/manual/en/pdo.errorcode.php - * @return string|null Returns an SQLSTATE, a five characters alphanumeric identifier defined in - * the ANSI SQL-92 standard. Briefly, an SQLSTATE consists of a - * two characters class value followed by a three characters subclass value. A - * class value of 01 indicates a warning and is accompanied by a return code - * of SQL_SUCCESS_WITH_INFO. Class values other than '01', except for the - * class 'IM', indicate an error. The class 'IM' is specific to warnings - * and errors that derive from the implementation of PDO (or perhaps ODBC, - * if you're using the ODBC driver) itself. The subclass value '000' in any - * class indicates that there is no subclass for that SQLSTATE. - *PDO::errorCode only retrieves error codes for operations - * performed directly on the database handle. If you create a PDOStatement - * object through PDO::prepare or - * PDO::query and invoke an error on the statement - * handle, PDO::errorCode will not reflect that error. - * You must call PDOStatement::errorCode to return the error - * code for an operation performed on a particular statement handle.
- *Returns null if no operation has been run on the database handle.
+ * {@inheritdoc} */ - public function errorCode (): ?string {} + public function errorCode () {} /** - * Fetch extended error information associated with the last operation on the database handle - * @link http://www.php.net/manual/en/pdo.errorinfo.php - * @return array PDO::errorInfo returns an array of error information - * about the last operation performed by this database handle. The array - * consists of at least the following fields: - *Element | - *Information | - *
0 | - *SQLSTATE error code (a five characters alphanumeric identifier defined - * in the ANSI SQL standard). | - *
1 | - *Driver-specific error code. | - *
2 | - *Driver-specific error message. | - *
If the SQLSTATE error code is not set or there is no driver-specific - * error, the elements following element 0 will be set to null.
- *PDO::errorInfo only retrieves error information for - * operations performed directly on the database handle. If you create a - * PDOStatement object through PDO::prepare or - * PDO::query and invoke an error on the statement - * handle, PDO::errorInfo will not reflect the error - * from the statement handle. You must call - * PDOStatement::errorInfo to return the error - * information for an operation performed on a particular statement handle.
+ * {@inheritdoc} */ - public function errorInfo (): array {} + public function errorInfo () {} /** - * Execute an SQL statement and return the number of affected rows - * @link http://www.php.net/manual/en/pdo.exec.php - * @param string $statement - * @return int|false PDO::exec returns the number of rows that were modified - * or deleted by the SQL statement you issued. If no rows were affected, - * PDO::exec returns 0. - *The following example incorrectly relies on the return value of - * PDO::exec, wherein a statement that affected 0 rows - * results in a call to die: - *
- * <?php
- * $db->exec() or die(print_r($db->errorInfo(), true)); // incorrect
- * ?>
- *
+ * {@inheritdoc}
+ * @param string $statement
*/
- public function exec (string $statement): int|false {}
+ public function exec (string $statement) {}
/**
- * Retrieve a database connection attribute
- * @link http://www.php.net/manual/en/pdo.getattribute.php
- * @param int $attribute
- * @return mixed A successful call returns the value of the requested PDO attribute.
- * An unsuccessful call returns null.
+ * {@inheritdoc}
+ * @param int $attribute
*/
- public function getAttribute (int $attribute): mixed {}
+ public function getAttribute (int $attribute) {}
/**
- * Return an array of available PDO drivers
- * @link http://www.php.net/manual/en/pdo.getavailabledrivers.php
- * @return array PDO::getAvailableDrivers returns an array of PDO driver names. If
- * no drivers are available, it returns an empty array.
+ * {@inheritdoc}
*/
- public static function getAvailableDrivers (): array {}
+ public static function getAvailableDrivers () {}
/**
- * Checks if inside a transaction
- * @link http://www.php.net/manual/en/pdo.intransaction.php
- * @return bool Returns true if a transaction is currently active, and false if not.
+ * {@inheritdoc}
*/
- public function inTransaction (): bool {}
+ public function inTransaction () {}
/**
- * Returns the ID of the last inserted row or sequence value
- * @link http://www.php.net/manual/en/pdo.lastinsertid.php
- * @param string|null $name [optional]
- * @return string|false If a sequence name was not specified for the name
- * parameter, PDO::lastInsertId returns a
- * string representing the row ID of the last row that was inserted into
- * the database.
- * If a sequence name was specified for the name - * parameter, PDO::lastInsertId returns a - * string representing the last value retrieved from the specified sequence - * object.
- *If the PDO driver does not support this capability, - * PDO::lastInsertId triggers an - * IM001 SQLSTATE.
+ * {@inheritdoc} + * @param string|null $name [optional] */ - public function lastInsertId (?string $name = null): string|false {} + public function lastInsertId (?string $name = NULL) {} /** - * Prepares a statement for execution and returns a statement object - * @link http://www.php.net/manual/en/pdo.prepare.php - * @param string $query - * @param array $options [optional] - * @return PDOStatement|false If the database server successfully prepares the statement, - * PDO::prepare returns a - * PDOStatement object. - * If the database server cannot successfully prepare the statement, - * PDO::prepare returns false or emits - * PDOException (depending on error handling). - *Emulated prepared statements does not communicate with the database server - * so PDO::prepare does not check the statement.
+ * {@inheritdoc} + * @param string $query + * @param array $options [optional] */ - public function prepare (string $query, array $options = '[]'): PDOStatement|false {} + public function prepare (string $query, array $options = array ( +)) {} /** - * Prepares and executes an SQL statement without placeholders - * @link http://www.php.net/manual/en/pdo.query.php - * @param string $query - * @param int|null $fetchMode [optional] - * @return PDOStatement|false Returns a PDOStatement object or false on failure. + * {@inheritdoc} + * @param string $query + * @param int|null $fetchMode [optional] + * @param mixed $fetchModeArgs [optional] */ - public function query (string $query, ?int $fetchMode = null): PDOStatement|false {} + public function query (string $query, ?int $fetchMode = NULL, mixed ...$fetchModeArgs) {} /** - * Quotes a string for use in a query - * @link http://www.php.net/manual/en/pdo.quote.php - * @param string $string - * @param int $type [optional] - * @return string|false Returns a quoted string that is theoretically safe to pass into an - * SQL statement. Returns false if the driver does not support quoting in - * this way. + * {@inheritdoc} + * @param string $string + * @param int $type [optional] */ - public function quote (string $string, int $type = \PDO::PARAM_STR): string|false {} + public function quote (string $string, int $type = 2) {} /** - * Rolls back a transaction - * @link http://www.php.net/manual/en/pdo.rollback.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function rollBack (): bool {} + public function rollBack () {} /** - * Set an attribute - * @link http://www.php.net/manual/en/pdo.setattribute.php - * @param int $attribute - * @param mixed $value - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $attribute + * @param mixed $value */ - public function setAttribute (int $attribute, mixed $value): bool {} + public function setAttribute (int $attribute, mixed $value = null) {} } -/** - * Represents a prepared statement and, after the statement is executed, an - * associated result set. - * @link http://www.php.net/manual/en/class.pdostatement.php - */ class PDOStatement implements IteratorAggregate, Traversable { - /** - * Used query string. - * @var string - * @link http://www.php.net/manual/en/class.pdostatement.php#pdostatement.props.querystring - */ public string $queryString; /** - * Bind a column to a PHP variable - * @link http://www.php.net/manual/en/pdostatement.bindcolumn.php - * @param string|int $column - * @param mixed $var - * @param int $type [optional] - * @param int $maxLength [optional] - * @param mixed $driverOptions [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string|int $column + * @param mixed $var + * @param int $type [optional] + * @param int $maxLength [optional] + * @param mixed $driverOptions [optional] */ - public function bindColumn (string|int $column, mixed &$var, int $type = \PDO::PARAM_STR, int $maxLength = null, mixed $driverOptions = null): bool {} + public function bindColumn (string|int $column, mixed &$var = null, int $type = 2, int $maxLength = 0, mixed $driverOptions = NULL) {} /** - * Binds a parameter to the specified variable name - * @link http://www.php.net/manual/en/pdostatement.bindparam.php - * @param string|int $param - * @param mixed $var - * @param int $type [optional] - * @param int $maxLength [optional] - * @param mixed $driverOptions [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string|int $param + * @param mixed $var + * @param int $type [optional] + * @param int $maxLength [optional] + * @param mixed $driverOptions [optional] */ - public function bindParam (string|int $param, mixed &$var, int $type = \PDO::PARAM_STR, int $maxLength = null, mixed $driverOptions = null): bool {} + public function bindParam (string|int $param, mixed &$var = null, int $type = 2, int $maxLength = 0, mixed $driverOptions = NULL) {} /** - * Binds a value to a parameter - * @link http://www.php.net/manual/en/pdostatement.bindvalue.php - * @param string|int $param - * @param mixed $value - * @param int $type [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string|int $param + * @param mixed $value + * @param int $type [optional] */ - public function bindValue (string|int $param, mixed $value, int $type = \PDO::PARAM_STR): bool {} + public function bindValue (string|int $param, mixed $value = null, int $type = 2) {} /** - * Closes the cursor, enabling the statement to be executed again - * @link http://www.php.net/manual/en/pdostatement.closecursor.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function closeCursor (): bool {} + public function closeCursor () {} /** - * Returns the number of columns in the result set - * @link http://www.php.net/manual/en/pdostatement.columncount.php - * @return int Returns the number of columns in the result set represented by the - * PDOStatement object, even if the result set is empty. If there is no result set, - * PDOStatement::columnCount returns 0. + * {@inheritdoc} */ - public function columnCount (): int {} + public function columnCount () {} /** - * Dump an SQL prepared command - * @link http://www.php.net/manual/en/pdostatement.debugdumpparams.php - * @return bool|null Returns null, or false in case of an error. + * {@inheritdoc} */ - public function debugDumpParams (): ?bool {} + public function debugDumpParams () {} /** - * Fetch the SQLSTATE associated with the last operation on the statement handle - * @link http://www.php.net/manual/en/pdostatement.errorcode.php - * @return string|null Identical to PDO::errorCode, except that - * PDOStatement::errorCode only retrieves error codes - * for operations performed with PDOStatement objects. + * {@inheritdoc} */ - public function errorCode (): ?string {} + public function errorCode () {} /** - * Fetch extended error information associated with the last operation on the statement handle - * @link http://www.php.net/manual/en/pdostatement.errorinfo.php - * @return array PDOStatement::errorInfo returns an array of - * error information about the last operation performed by this - * statement handle. The array consists of at least the following fields: - *Element | - *Information | - *
0 | - *SQLSTATE error code (a five characters alphanumeric identifier defined - * in the ANSI SQL standard). | - *
1 | - *Driver specific error code. | - *
2 | - *Driver specific error message. | - *
Using this method to fetch large result sets will result in a heavy - * demand on system and possibly network resources. Rather than retrieving - * all of the data and manipulating it in PHP, consider using the database - * server to manipulate the result sets. For example, use the WHERE and - * ORDER BY clauses in SQL to restrict results before retrieving and - * processing them with PHP.
+ * {@inheritdoc} + * @param int $mode [optional] + * @param mixed $args [optional] */ - public function fetchAll (int $mode = \PDO::FETCH_DEFAULT): array {} + public function fetchAll (int $mode = 0, mixed ...$args) {} /** - * Returns a single column from the next row of a result set - * @link http://www.php.net/manual/en/pdostatement.fetchcolumn.php - * @param int $column [optional] - * @return mixed PDOStatement::fetchColumn returns a single column - * from the next row of a result set or false if there are no more rows. - *There is no way to return another column from the same row if you - * use PDOStatement::fetchColumn to retrieve data.
+ * {@inheritdoc} + * @param int $column [optional] */ - public function fetchColumn (int $column = null): mixed {} + public function fetchColumn (int $column = 0) {} /** - * Fetches the next row and returns it as an object - * @link http://www.php.net/manual/en/pdostatement.fetchobject.php - * @param string|null $class [optional] - * @param array $constructorArgs [optional] - * @return object|false Returns an instance of the required class with property names that - * correspond to the column names or false on failure. + * {@inheritdoc} + * @param string|null $class [optional] + * @param array $constructorArgs [optional] */ - public function fetchObject (?string $class = '"stdClass"', array $constructorArgs = '[]'): object|false {} + public function fetchObject (?string $class = 'stdClass', array $constructorArgs = array ( +)) {} /** - * Retrieve a statement attribute - * @link http://www.php.net/manual/en/pdostatement.getattribute.php - * @param int $name - * @return mixed Returns the attribute value. + * {@inheritdoc} + * @param int $name */ - public function getAttribute (int $name): mixed {} + public function getAttribute (int $name) {} /** - * Returns metadata for a column in a result set - * @link http://www.php.net/manual/en/pdostatement.getcolumnmeta.php - * @param int $column - * @return array|false Returns an associative array containing the following values representing - * the metadata for a single column: - *Returns false if the requested column does not exist in the result set, - * or if no result set exists.
+ * {@inheritdoc} + * @param int $column */ - public function getColumnMeta (int $column): array|false {} + public function getColumnMeta (int $column) {} /** - * Advances to the next rowset in a multi-rowset statement handle - * @link http://www.php.net/manual/en/pdostatement.nextrowset.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function nextRowset (): bool {} + public function nextRowset () {} /** - * Returns the number of rows affected by the last SQL statement - * @link http://www.php.net/manual/en/pdostatement.rowcount.php - * @return int Returns the number of rows. + * {@inheritdoc} */ - public function rowCount (): int {} + public function rowCount () {} /** - * Set a statement attribute - * @link http://www.php.net/manual/en/pdostatement.setattribute.php - * @param int $attribute - * @param mixed $value - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $attribute + * @param mixed $value */ - public function setAttribute (int $attribute, mixed $value): bool {} + public function setAttribute (int $attribute, mixed $value = null) {} /** - * Set the default fetch mode for this statement - * @link http://www.php.net/manual/en/pdostatement.setfetchmode.php - * @param int $mode - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $mode + * @param mixed $args [optional] */ - public function setFetchMode (int $mode): bool {} + public function setFetchMode (int $mode, mixed ...$args) {} /** - * Gets result set iterator - * @link http://www.php.net/manual/en/pdostatement.getiterator.php - * @return Iterator + * {@inheritdoc} */ public function getIterator (): Iterator {} @@ -1160,11 +440,8 @@ final class PDORow { } /** - * Return an array of available PDO drivers - * @link http://www.php.net/manual/en/pdo.getavailabledrivers.php - * @return array PDO::getAvailableDrivers returns an array of PDO driver names. If - * no drivers are available, it returns an empty array. + * {@inheritdoc} */ function pdo_drivers (): array {} -// End of PDO v.8.2.6 +// End of PDO v.8.3.0 diff --git a/plugins/org.eclipse.php.core/Resources/language/php8.3/PDO_ODBC.php b/plugins/org.eclipse.php.core/Resources/language/php8.3/PDO_ODBC.php index 4543d4c1cc..fff47a4b87 100644 --- a/plugins/org.eclipse.php.core/Resources/language/php8.3/PDO_ODBC.php +++ b/plugins/org.eclipse.php.core/Resources/language/php8.3/PDO_ODBC.php @@ -1,4 +1,6 @@ Default is 0 which will only return results for attributes that - * are of the class name. - *The only other option available, is to use ReflectionAttribute::IS_INSTANCEOF, - * which will instead use instanceof for filtering.
- * @return array Array of attributes, as a ReflectionAttribute object. + * {@inheritdoc} + * @param string|null $name [optional] + * @param int $flags [optional] */ - public function getAttributes (?string $name = null, int $flags = null): array {} + public function getAttributes (?string $name = NULL, int $flags = 0): array {} /** - * Gets a string representation of the object - * @link http://www.php.net/manual/en/stringable.tostring.php - * @return string Returns the string representation of the object. + * {@inheritdoc} */ abstract public function __toString (): string; } -/** - * The ReflectionFunction class reports - * information about a function. - * @link http://www.php.net/manual/en/class.reflectionfunction.php - */ class ReflectionFunction extends ReflectionFunctionAbstract implements Stringable, Reflector { - /** - * Indicates deprecated functions. const IS_DEPRECATED = 2048; /** - * Constructs a ReflectionFunction object - * @link http://www.php.net/manual/en/reflectionfunction.construct.php - * @param Closure|string $function - * @return Closure|string + * {@inheritdoc} + * @param Closure|string $function */ - public function __construct (Closure|string $function): Closure|string {} + public function __construct (Closure|string $function) {} /** - * To string - * @link http://www.php.net/manual/en/reflectionfunction.tostring.php - * @return string Returns ReflectionFunction::export-like output for - * the function. + * {@inheritdoc} */ public function __toString (): string {} /** - * Checks if a function is anonymous - * @link http://www.php.net/manual/en/reflectionfunction.isanonymous.php - * @return bool Returns true if the function is anonymous, otherwise false. + * {@inheritdoc} */ public function isAnonymous (): bool {} /** - * Checks if function is disabled - * @link http://www.php.net/manual/en/reflectionfunction.isdisabled.php - * @return bool true if it's disable, otherwise false - * @deprecated 1 + * {@inheritdoc} + * @deprecated */ - public function isDisabled (): bool {} + public function isDisabled () {} /** - * Invokes function - * @link http://www.php.net/manual/en/reflectionfunction.invoke.php - * @param mixed $args - * @return mixed Returns the result of the invoked function call. + * {@inheritdoc} + * @param mixed $args [optional] */ - public function invoke (mixed ...$args): mixed {} + public function invoke (mixed ...$args) {} /** - * Invokes function args - * @link http://www.php.net/manual/en/reflectionfunction.invokeargs.php - * @param array $args - * @return mixed Returns the result of the invoked function + * {@inheritdoc} + * @param array $args */ - public function invokeArgs (array $args): mixed {} + public function invokeArgs (array $args) {} /** - * Returns a dynamically created closure for the function - * @link http://www.php.net/manual/en/reflectionfunction.getclosure.php - * @return Closure Returns Closure. + * {@inheritdoc} */ - public function getClosure (): Closure {} + public function getClosure () {} /** - * Checks if function in namespace - * @link http://www.php.net/manual/en/reflectionfunctionabstract.innamespace.php - * @return bool true if it's in a namespace, otherwise false + * {@inheritdoc} */ - public function inNamespace (): bool {} + public function inNamespace () {} /** - * Checks if closure - * @link http://www.php.net/manual/en/reflectionfunctionabstract.isclosure.php - * @return bool Returns true if the function is a Closure, otherwise false. + * {@inheritdoc} */ - public function isClosure (): bool {} + public function isClosure () {} /** - * Checks if deprecated - * @link http://www.php.net/manual/en/reflectionfunctionabstract.isdeprecated.php - * @return bool true if it's deprecated, otherwise false + * {@inheritdoc} */ - public function isDeprecated (): bool {} + public function isDeprecated () {} /** - * Checks if is internal - * @link http://www.php.net/manual/en/reflectionfunctionabstract.isinternal.php - * @return bool true if it's internal, otherwise false + * {@inheritdoc} */ - public function isInternal (): bool {} + public function isInternal () {} /** - * Checks if user defined - * @link http://www.php.net/manual/en/reflectionfunctionabstract.isuserdefined.php - * @return bool true if it's user-defined, otherwise false; + * {@inheritdoc} */ - public function isUserDefined (): bool {} + public function isUserDefined () {} /** - * Returns whether this function is a generator - * @link http://www.php.net/manual/en/reflectionfunctionabstract.isgenerator.php - * @return bool Returns true if the function is generator, false if it is not or null - * on failure. + * {@inheritdoc} */ - public function isGenerator (): bool {} + public function isGenerator () {} /** - * Checks if the function is variadic - * @link http://www.php.net/manual/en/reflectionfunctionabstract.isvariadic.php - * @return bool Returns true if the function is variadic, otherwise false. + * {@inheritdoc} */ - public function isVariadic (): bool {} + public function isVariadic () {} /** - * Checks if the function is static - * @link http://www.php.net/manual/en/reflectiofunctionabstract.isstatic.php - * @return bool true if the function is static, otherwise false + * {@inheritdoc} */ - public function isStatic (): bool {} + public function isStatic () {} /** - * Returns this pointer bound to closure - * @link http://www.php.net/manual/en/reflectionfunctionabstract.getclosurethis.php - * @return object|null Returns $this pointer. - * Returns null in case of an error. + * {@inheritdoc} */ - public function getClosureThis (): ?object {} + public function getClosureThis () {} /** - * Returns the scope associated to the closure - * @link http://www.php.net/manual/en/reflectionfunctionabstract.getclosurescopeclass.php - * @return ReflectionClass|null Returns the class on success or null on failure. + * {@inheritdoc} */ - public function getClosureScopeClass (): ?ReflectionClass {} + public function getClosureScopeClass () {} /** * {@inheritdoc} @@ -522,399 +350,263 @@ public function getClosureScopeClass (): ?ReflectionClass {} public function getClosureCalledClass () {} /** - * Returns an array of the used variables in the Closure - * @link http://www.php.net/manual/en/reflectionfunctionabstract.getclosureusedvariables.php - * @return array Returns an array of the used variables in the Closure. + * {@inheritdoc} */ public function getClosureUsedVariables (): array {} /** - * Gets doc comment - * @link http://www.php.net/manual/en/reflectionfunctionabstract.getdoccomment.php - * @return string|false The doc comment if it exists, otherwise false + * {@inheritdoc} */ - public function getDocComment (): string|false {} + public function getDocComment () {} /** - * Gets end line number - * @link http://www.php.net/manual/en/reflectionfunctionabstract.getendline.php - * @return int|false The ending line number of the user defined function, or false if unknown. + * {@inheritdoc} */ - public function getEndLine (): int|false {} + public function getEndLine () {} /** - * Gets extension info - * @link http://www.php.net/manual/en/reflectionfunctionabstract.getextension.php - * @return ReflectionExtension|null The extension information, as a ReflectionExtension object, - * or null for user-defined functions. + * {@inheritdoc} */ - public function getExtension (): ?ReflectionExtension {} + public function getExtension () {} /** - * Gets extension name - * @link http://www.php.net/manual/en/reflectionfunctionabstract.getextensionname.php - * @return string|false The name of the extension which defined the function, - * or false for user-defined functions. + * {@inheritdoc} */ - public function getExtensionName (): string|false {} + public function getExtensionName () {} /** - * Gets file name - * @link http://www.php.net/manual/en/reflectionfunctionabstract.getfilename.php - * @return string|false Returns the filename of the file in which the function has been defined. - * If the class is defined in the PHP core or in a PHP extension, false - * is returned. + * {@inheritdoc} */ - public function getFileName (): string|false {} + public function getFileName () {} /** - * Gets function name - * @link http://www.php.net/manual/en/reflectionfunctionabstract.getname.php - * @return string The name of the function. + * {@inheritdoc} */ - public function getName (): string {} + public function getName () {} /** - * Gets namespace name - * @link http://www.php.net/manual/en/reflectionfunctionabstract.getnamespacename.php - * @return string The namespace name. + * {@inheritdoc} */ - public function getNamespaceName (): string {} + public function getNamespaceName () {} /** - * Gets number of parameters - * @link http://www.php.net/manual/en/reflectionfunctionabstract.getnumberofparameters.php - * @return int The number of parameters. + * {@inheritdoc} */ - public function getNumberOfParameters (): int {} + public function getNumberOfParameters () {} /** - * Gets number of required parameters - * @link http://www.php.net/manual/en/reflectionfunctionabstract.getnumberofrequiredparameters.php - * @return int The number of required parameters. + * {@inheritdoc} */ - public function getNumberOfRequiredParameters (): int {} + public function getNumberOfRequiredParameters () {} /** - * Gets parameters - * @link http://www.php.net/manual/en/reflectionfunctionabstract.getparameters.php - * @return array The parameters, as a ReflectionParameter object. + * {@inheritdoc} */ - public function getParameters (): array {} + public function getParameters () {} /** - * Gets function short name - * @link http://www.php.net/manual/en/reflectionfunctionabstract.getshortname.php - * @return string The short name of the function. + * {@inheritdoc} */ - public function getShortName (): string {} + public function getShortName () {} /** - * Gets starting line number - * @link http://www.php.net/manual/en/reflectionfunctionabstract.getstartline.php - * @return int|false The starting line number, or false if unknown. + * {@inheritdoc} */ - public function getStartLine (): int|false {} + public function getStartLine () {} /** - * Gets static variables - * @link http://www.php.net/manual/en/reflectionfunctionabstract.getstaticvariables.php - * @return array An array of static variables. + * {@inheritdoc} */ - public function getStaticVariables (): array {} + public function getStaticVariables () {} /** - * Checks if returns reference - * @link http://www.php.net/manual/en/reflectionfunctionabstract.returnsreference.php - * @return bool true if it returns a reference, otherwise false + * {@inheritdoc} */ - public function returnsReference (): bool {} + public function returnsReference () {} /** - * Checks if the function has a specified return type - * @link http://www.php.net/manual/en/reflectionfunctionabstract.hasreturntype.php - * @return bool Returns true if the function is a specified return type, otherwise false. + * {@inheritdoc} */ - public function hasReturnType (): bool {} + public function hasReturnType () {} /** - * Gets the specified return type of a function - * @link http://www.php.net/manual/en/reflectionfunctionabstract.getreturntype.php - * @return ReflectionType|null Returns a ReflectionType object if a return type is - * specified, null otherwise. + * {@inheritdoc} */ - public function getReturnType (): ?ReflectionType {} + public function getReturnType () {} /** - * Returns whether the function has a tentative return type - * @link http://www.php.net/manual/en/reflectionfunctionabstract.hastentativereturntype.php - * @return bool Returns true if the function has a tentative return type, otherwise false. + * {@inheritdoc} */ public function hasTentativeReturnType (): bool {} /** - * Returns the tentative return type associated with the function - * @link http://www.php.net/manual/en/reflectionfunctionabstract.gettentativereturntype.php - * @return ReflectionType|null Returns a ReflectionType object if a tentative return type is - * specified, null otherwise. + * {@inheritdoc} */ public function getTentativeReturnType (): ?ReflectionType {} /** - * Gets Attributes - * @link http://www.php.net/manual/en/reflectionfunctionabstract.getattributes.php - * @param string|null $name [optional] Filter the results to include only ReflectionAttribute - * instances for attributes matching this class name. - * @param int $flags [optional] Flags for determining how to filter the results, if name - * is provided. - *Default is 0 which will only return results for attributes that - * are of the class name.
- *The only other option available, is to use ReflectionAttribute::IS_INSTANCEOF, - * which will instead use instanceof for filtering.
- * @return array Array of attributes, as a ReflectionAttribute object. + * {@inheritdoc} + * @param string|null $name [optional] + * @param int $flags [optional] */ - public function getAttributes (?string $name = null, int $flags = null): array {} + public function getAttributes (?string $name = NULL, int $flags = 0): array {} } -/** - * The ReflectionGenerator class reports - * information about a generator. - * @link http://www.php.net/manual/en/class.reflectiongenerator.php - */ final class ReflectionGenerator { /** - * Constructs a ReflectionGenerator object - * @link http://www.php.net/manual/en/reflectiongenerator.construct.php - * @param Generator $generator - * @return Generator + * {@inheritdoc} + * @param Generator $generator */ - public function __construct (Generator $generator): Generator {} + public function __construct (Generator $generator) {} /** - * Gets the currently executing line of the generator - * @link http://www.php.net/manual/en/reflectiongenerator.getexecutingline.php - * @return int Returns the line number of the currently executing statement in the generator. + * {@inheritdoc} */ - public function getExecutingLine (): int {} + public function getExecutingLine () {} /** - * Gets the file name of the currently executing generator - * @link http://www.php.net/manual/en/reflectiongenerator.getexecutingfile.php - * @return string Returns the full path and file name of the currently executing generator. + * {@inheritdoc} */ - public function getExecutingFile (): string {} + public function getExecutingFile () {} /** - * Gets the trace of the executing generator - * @link http://www.php.net/manual/en/reflectiongenerator.gettrace.php - * @param int $options [optional] - * @return array Returns the trace of the currently executing generator. + * {@inheritdoc} + * @param int $options [optional] */ - public function getTrace (int $options = DEBUG_BACKTRACE_PROVIDE_OBJECT): array {} + public function getTrace (int $options = 1) {} /** - * Gets the function name of the generator - * @link http://www.php.net/manual/en/reflectiongenerator.getfunction.php - * @return ReflectionFunctionAbstract Returns a ReflectionFunctionAbstract class. This will - * be ReflectionFunction for functions, or - * ReflectionMethod for methods. + * {@inheritdoc} */ - public function getFunction (): ReflectionFunctionAbstract {} + public function getFunction () {} /** - * Gets the $this value of the generator - * @link http://www.php.net/manual/en/reflectiongenerator.getthis.php - * @return object|null Returns the $this value, or null if the generator was - * not created in a class context. + * {@inheritdoc} */ - public function getThis (): ?object {} + public function getThis () {} /** - * Gets the executing Generator object - * @link http://www.php.net/manual/en/reflectiongenerator.getexecutinggenerator.php - * @return Generator Returns the currently executing Generator object. + * {@inheritdoc} */ - public function getExecutingGenerator (): Generator {} + public function getExecutingGenerator () {} } -/** - * The ReflectionParameter class retrieves - * information about function's or method's parameters. - *To introspect function parameters, first create an instance - * of the ReflectionFunction or - * ReflectionMethod classes and then use their - * ReflectionFunctionAbstract::getParameters method - * to retrieve an array of parameters.
- * @link http://www.php.net/manual/en/class.reflectionparameter.php - */ class ReflectionParameter implements Stringable, Reflector { - /** - * Name of the parameter. Read-only, throws - * ReflectionException in attempt to write. - * @var string - * @link http://www.php.net/manual/en/class.reflectionparameter.php#reflectionparameter.props.name - */ public string $name; /** - * Clone - * @link http://www.php.net/manual/en/reflectionparameter.clone.php - * @return void + * {@inheritdoc} */ private function __clone (): void {} /** - * Construct - * @link http://www.php.net/manual/en/reflectionparameter.construct.php - * @param string|array|object $function - * @param int|string $param - * @return string|array|object + * {@inheritdoc} + * @param mixed $function + * @param string|int $param */ - public function __construct (string|array|object $function, int|string $param): string|array|object {} + public function __construct ($function = null, string|int $param) {} /** - * To string - * @link http://www.php.net/manual/en/reflectionparameter.tostring.php - * @return string + * {@inheritdoc} */ public function __toString (): string {} /** - * Gets parameter name - * @link http://www.php.net/manual/en/reflectionparameter.getname.php - * @return string The name of the reflected parameter. + * {@inheritdoc} */ - public function getName (): string {} + public function getName () {} /** - * Checks if passed by reference - * @link http://www.php.net/manual/en/reflectionparameter.ispassedbyreference.php - * @return bool true if the parameter is passed in by reference, otherwise false + * {@inheritdoc} */ - public function isPassedByReference (): bool {} + public function isPassedByReference () {} /** - * Returns whether this parameter can be passed by value - * @link http://www.php.net/manual/en/reflectionparameter.canbepassedbyvalue.php - * @return bool Returns true if the parameter can be passed by value, false otherwise. - * Returns null in case of an error. + * {@inheritdoc} */ - public function canBePassedByValue (): bool {} + public function canBePassedByValue () {} /** - * Gets declaring function - * @link http://www.php.net/manual/en/reflectionparameter.getdeclaringfunction.php - * @return ReflectionFunctionAbstract A ReflectionFunction object. + * {@inheritdoc} */ - public function getDeclaringFunction (): ReflectionFunctionAbstract {} + public function getDeclaringFunction () {} /** - * Gets declaring class - * @link http://www.php.net/manual/en/reflectionparameter.getdeclaringclass.php - * @return ReflectionClass|null A ReflectionClass object or null if called on function. + * {@inheritdoc} */ - public function getDeclaringClass (): ?ReflectionClass {} + public function getDeclaringClass () {} /** - * Get a ReflectionClass object for the parameter being reflected or null - * @link http://www.php.net/manual/en/reflectionparameter.getclass.php - * @return ReflectionClass|null A ReflectionClass object, or null if no type is declared, - * or the declared type is not a class or interface. - * @deprecated 1 + * {@inheritdoc} + * @deprecated */ - public function getClass (): ?ReflectionClass {} + public function getClass () {} /** - * Checks if parameter has a type - * @link http://www.php.net/manual/en/reflectionparameter.hastype.php - * @return bool true if a type is specified, false otherwise. + * {@inheritdoc} */ - public function hasType (): bool {} + public function hasType () {} /** - * Gets a parameter's type - * @link http://www.php.net/manual/en/reflectionparameter.gettype.php - * @return ReflectionType|null Returns a ReflectionType object if a parameter type is - * specified, null otherwise. + * {@inheritdoc} */ - public function getType (): ?ReflectionType {} + public function getType () {} /** - * Checks if parameter expects an array - * @link http://www.php.net/manual/en/reflectionparameter.isarray.php - * @return bool true if an array is expected, false otherwise. - * @deprecated 1 + * {@inheritdoc} + * @deprecated */ - public function isArray (): bool {} + public function isArray () {} /** - * Returns whether parameter MUST be callable - * @link http://www.php.net/manual/en/reflectionparameter.iscallable.php - * @return bool Returns true if the parameter is callable, false if it is - * not or null on failure. - * @deprecated 1 + * {@inheritdoc} + * @deprecated */ - public function isCallable (): bool {} + public function isCallable () {} /** - * Checks if null is allowed - * @link http://www.php.net/manual/en/reflectionparameter.allowsnull.php - * @return bool true if null is allowed, otherwise false + * {@inheritdoc} */ - public function allowsNull (): bool {} + public function allowsNull () {} /** - * Gets parameter position - * @link http://www.php.net/manual/en/reflectionparameter.getposition.php - * @return int The position of the parameter, left to right, starting at position #0. + * {@inheritdoc} */ - public function getPosition (): int {} + public function getPosition () {} /** - * Checks if optional - * @link http://www.php.net/manual/en/reflectionparameter.isoptional.php - * @return bool true if the parameter is optional, otherwise false + * {@inheritdoc} */ - public function isOptional (): bool {} + public function isOptional () {} /** - * Checks if a default value is available - * @link http://www.php.net/manual/en/reflectionparameter.isdefaultvalueavailable.php - * @return bool true if a default value is available, otherwise false + * {@inheritdoc} */ - public function isDefaultValueAvailable (): bool {} + public function isDefaultValueAvailable () {} /** - * Gets default parameter value - * @link http://www.php.net/manual/en/reflectionparameter.getdefaultvalue.php - * @return mixed The parameters default value. + * {@inheritdoc} */ - public function getDefaultValue (): mixed {} + public function getDefaultValue () {} /** - * Returns whether the default value of this parameter is a constant - * @link http://www.php.net/manual/en/reflectionparameter.isdefaultvalueconstant.php - * @return bool Returns true if the default value is constant, and false otherwise. + * {@inheritdoc} */ - public function isDefaultValueConstant (): bool {} + public function isDefaultValueConstant () {} /** - * Returns the default value's constant name if default value is constant or null - * @link http://www.php.net/manual/en/reflectionparameter.getdefaultvalueconstantname.php - * @return string|null Returns string on success or null on failure. + * {@inheritdoc} */ - public function getDefaultValueConstantName (): ?string {} + public function getDefaultValueConstantName () {} /** - * Checks if the parameter is variadic - * @link http://www.php.net/manual/en/reflectionparameter.isvariadic.php - * @return bool Returns true if the parameter is variadic, otherwise false. + * {@inheritdoc} */ - public function isVariadic (): bool {} + public function isVariadic () {} /** * {@inheritdoc} @@ -922,33 +614,14 @@ public function isVariadic (): bool {} public function isPromoted (): bool {} /** - * Gets Attributes - * @link http://www.php.net/manual/en/reflectionparameter.getattributes.php - * @param string|null $name [optional] Filter the results to include only ReflectionAttribute - * instances for attributes matching this class name. - * @param int $flags [optional] Flags for determining how to filter the results, if name - * is provided. - *Default is 0 which will only return results for attributes that - * are of the class name.
- *The only other option available, is to use ReflectionAttribute::IS_INSTANCEOF, - * which will instead use instanceof for filtering.
- * @return array Array of attributes, as a ReflectionAttribute object. + * {@inheritdoc} + * @param string|null $name [optional] + * @param int $flags [optional] */ - public function getAttributes (?string $name = null, int $flags = null): array {} + public function getAttributes (?string $name = NULL, int $flags = 0): array {} } -/** - * The ReflectionType class reports - * information about a function's parameter/return type or a class's property type. - * The Reflection extension declares the following subtypes: - *- * ReflectionNamedType (as of PHP 7.1.0) - * ReflectionUnionType (as of PHP 8.0.0) - * ReflectionIntersectionType (as of PHP 8.1.0) - *
- * @link http://www.php.net/manual/en/class.reflectiontype.php - */ abstract class ReflectionType implements Stringable { /** @@ -957,357 +630,238 @@ abstract class ReflectionType implements Stringable { private function __clone (): void {} /** - * Checks if null is allowed - * @link http://www.php.net/manual/en/reflectiontype.allowsnull.php - * @return bool true if null is allowed, otherwise false + * {@inheritdoc} */ - public function allowsNull (): bool {} + public function allowsNull () {} /** - * To string - * @link http://www.php.net/manual/en/reflectiontype.tostring.php - * @return string Returns the type of the parameter. - * @deprecated 1 + * {@inheritdoc} */ public function __toString (): string {} } -/** - * @link http://www.php.net/manual/en/class.reflectionnamedtype.php - */ class ReflectionNamedType extends ReflectionType implements Stringable { /** - * Get the name of the type as a string - * @link http://www.php.net/manual/en/reflectionnamedtype.getname.php - * @return string Returns the name of the type being reflected. + * {@inheritdoc} */ - public function getName (): string {} + public function getName () {} /** - * Checks if it is a built-in type - * @link http://www.php.net/manual/en/reflectionnamedtype.isbuiltin.php - * @return bool true if it's a built-in type, otherwise false + * {@inheritdoc} */ - public function isBuiltin (): bool {} + public function isBuiltin () {} /** - * Checks if null is allowed - * @link http://www.php.net/manual/en/reflectiontype.allowsnull.php - * @return bool true if null is allowed, otherwise false + * {@inheritdoc} */ - public function allowsNull (): bool {} + public function allowsNull () {} /** - * To string - * @link http://www.php.net/manual/en/reflectiontype.tostring.php - * @return string Returns the type of the parameter. - * @deprecated 1 + * {@inheritdoc} */ public function __toString (): string {} } -/** - * @link http://www.php.net/manual/en/class.reflectionuniontype.php - */ class ReflectionUnionType extends ReflectionType implements Stringable { /** - * Returns the types included in the union type - * @link http://www.php.net/manual/en/reflectionuniontype.gettypes.php - * @return array An array of ReflectionType objects. + * {@inheritdoc} */ public function getTypes (): array {} /** - * Checks if null is allowed - * @link http://www.php.net/manual/en/reflectiontype.allowsnull.php - * @return bool true if null is allowed, otherwise false + * {@inheritdoc} */ - public function allowsNull (): bool {} + public function allowsNull () {} /** - * To string - * @link http://www.php.net/manual/en/reflectiontype.tostring.php - * @return string Returns the type of the parameter. - * @deprecated 1 + * {@inheritdoc} */ public function __toString (): string {} } -/** - * @link http://www.php.net/manual/en/class.reflectionintersectiontype.php - */ class ReflectionIntersectionType extends ReflectionType implements Stringable { /** - * Returns the types included in the intersection type - * @link http://www.php.net/manual/en/reflectionintersectiontype.gettypes.php - * @return array An array of ReflectionType objects. + * {@inheritdoc} */ public function getTypes (): array {} /** - * Checks if null is allowed - * @link http://www.php.net/manual/en/reflectiontype.allowsnull.php - * @return bool true if null is allowed, otherwise false + * {@inheritdoc} */ - public function allowsNull (): bool {} + public function allowsNull () {} /** - * To string - * @link http://www.php.net/manual/en/reflectiontype.tostring.php - * @return string Returns the type of the parameter. - * @deprecated 1 + * {@inheritdoc} */ public function __toString (): string {} } -/** - * The ReflectionMethod class reports - * information about a method. - * @link http://www.php.net/manual/en/class.reflectionmethod.php - */ class ReflectionMethod extends ReflectionFunctionAbstract implements Stringable, Reflector { - /** - * Indicates that the method is static. - * Prior to PHP 7.4.0, the value was 1. const IS_STATIC = 16; - /** - * Indicates that the method is public. - * Prior to PHP 7.4.0, the value was 256. const IS_PUBLIC = 1; - /** - * Indicates that the method is protected. - * Prior to PHP 7.4.0, the value was 512. const IS_PROTECTED = 2; - /** - * Indicates that the method is private. - * Prior to PHP 7.4.0, the value was 1024. const IS_PRIVATE = 4; - /** - * Indicates that the method is abstract. - * Prior to PHP 7.4.0, the value was 2. const IS_ABSTRACT = 64; - /** - * Indicates that the method is final. - * Prior to PHP 7.4.0, the value was 4. const IS_FINAL = 32; + public string $class; + /** - * Class name - * @var string - * @link http://www.php.net/manual/en/class.reflectionmethod.php#reflectionmethod.props.class + * {@inheritdoc} + * @param object|string $objectOrMethod + * @param string|null $method [optional] */ - public string $class; + public function __construct (object|string $objectOrMethod, ?string $method = NULL) {} /** - * Constructs a ReflectionMethod - * @link http://www.php.net/manual/en/reflectionmethod.construct.php - * @param object|string $objectOrMethod - * @param string $method - * @return object|string + * {@inheritdoc} + * @param string $method */ - public function __construct (object|string $objectOrMethod, string $method): object|string {} + public static function createFromMethodName (string $method): static {} /** - * Returns the string representation of the Reflection method object - * @link http://www.php.net/manual/en/reflectionmethod.tostring.php - * @return string A string representation of this ReflectionMethod instance. + * {@inheritdoc} */ public function __toString (): string {} /** - * Checks if method is public - * @link http://www.php.net/manual/en/reflectionmethod.ispublic.php - * @return bool true if the method is public, otherwise false + * {@inheritdoc} */ - public function isPublic (): bool {} + public function isPublic () {} /** - * Checks if method is private - * @link http://www.php.net/manual/en/reflectionmethod.isprivate.php - * @return bool true if the method is private, otherwise false + * {@inheritdoc} */ - public function isPrivate (): bool {} + public function isPrivate () {} /** - * Checks if method is protected - * @link http://www.php.net/manual/en/reflectionmethod.isprotected.php - * @return bool true if the method is protected, otherwise false + * {@inheritdoc} */ - public function isProtected (): bool {} + public function isProtected () {} /** - * Checks if method is abstract - * @link http://www.php.net/manual/en/reflectionmethod.isabstract.php - * @return bool true if the method is abstract, otherwise false + * {@inheritdoc} */ - public function isAbstract (): bool {} + public function isAbstract () {} /** - * Checks if method is final - * @link http://www.php.net/manual/en/reflectionmethod.isfinal.php - * @return bool true if the method is final, otherwise false + * {@inheritdoc} */ - public function isFinal (): bool {} + public function isFinal () {} /** - * Checks if method is a constructor - * @link http://www.php.net/manual/en/reflectionmethod.isconstructor.php - * @return bool true if the method is a constructor, otherwise false + * {@inheritdoc} */ - public function isConstructor (): bool {} + public function isConstructor () {} /** - * Checks if method is a destructor - * @link http://www.php.net/manual/en/reflectionmethod.isdestructor.php - * @return bool true if the method is a destructor, otherwise false + * {@inheritdoc} */ - public function isDestructor (): bool {} + public function isDestructor () {} /** - * Returns a dynamically created closure for the method - * @link http://www.php.net/manual/en/reflectionmethod.getclosure.php - * @param object|null $object [optional] Forbidden for static methods, required for other methods. - * @return Closure Returns Closure. - * Returns null in case of an error. + * {@inheritdoc} + * @param object|null $object [optional] */ - public function getClosure (?object $object = null): Closure {} + public function getClosure (?object $object = NULL) {} /** - * Gets the method modifiers - * @link http://www.php.net/manual/en/reflectionmethod.getmodifiers.php - * @return int A numeric representation of the modifiers. - * The actual meaning of these modifiers are described under - * predefined constants. + * {@inheritdoc} */ - public function getModifiers (): int {} + public function getModifiers () {} /** - * Invoke - * @link http://www.php.net/manual/en/reflectionmethod.invoke.php - * @param object|null $object - * @param mixed $args - * @return mixed Returns the method result. + * {@inheritdoc} + * @param object|null $object + * @param mixed $args [optional] */ - public function invoke (?object $object, mixed ...$args): mixed {} + public function invoke (?object $object = null, mixed ...$args) {} /** - * Invoke args - * @link http://www.php.net/manual/en/reflectionmethod.invokeargs.php - * @param object|null $object - * @param array $args - * @return mixed Returns the method result. + * {@inheritdoc} + * @param object|null $object + * @param array $args */ - public function invokeArgs (?object $object, array $args): mixed {} + public function invokeArgs (?object $object = null, array $args) {} /** - * Gets declaring class for the reflected method - * @link http://www.php.net/manual/en/reflectionmethod.getdeclaringclass.php - * @return ReflectionClass A ReflectionClass object of the class that the - * reflected method is part of. + * {@inheritdoc} */ - public function getDeclaringClass (): ReflectionClass {} + public function getDeclaringClass () {} /** - * Gets the method prototype (if there is one) - * @link http://www.php.net/manual/en/reflectionmethod.getprototype.php - * @return ReflectionMethod A ReflectionMethod instance of the method prototype. + * {@inheritdoc} */ - public function getPrototype (): ReflectionMethod {} + public function getPrototype () {} /** - * Returns whether a method has a prototype - * @link http://www.php.net/manual/en/reflectionmethod.hasprototype.php - * @return bool Returns true if the method has a prototype, otherwise false. + * {@inheritdoc} */ public function hasPrototype (): bool {} /** - * Set method accessibility - * @link http://www.php.net/manual/en/reflectionmethod.setaccessible.php - * @param bool $accessible - * @return void No value is returned. + * {@inheritdoc} + * @param bool $accessible */ - public function setAccessible (bool $accessible): void {} + public function setAccessible (bool $accessible) {} /** - * Checks if function in namespace - * @link http://www.php.net/manual/en/reflectionfunctionabstract.innamespace.php - * @return bool true if it's in a namespace, otherwise false + * {@inheritdoc} */ - public function inNamespace (): bool {} + public function inNamespace () {} /** - * Checks if closure - * @link http://www.php.net/manual/en/reflectionfunctionabstract.isclosure.php - * @return bool Returns true if the function is a Closure, otherwise false. + * {@inheritdoc} */ - public function isClosure (): bool {} + public function isClosure () {} /** - * Checks if deprecated - * @link http://www.php.net/manual/en/reflectionfunctionabstract.isdeprecated.php - * @return bool true if it's deprecated, otherwise false + * {@inheritdoc} */ - public function isDeprecated (): bool {} + public function isDeprecated () {} /** - * Checks if is internal - * @link http://www.php.net/manual/en/reflectionfunctionabstract.isinternal.php - * @return bool true if it's internal, otherwise false + * {@inheritdoc} */ - public function isInternal (): bool {} + public function isInternal () {} /** - * Checks if user defined - * @link http://www.php.net/manual/en/reflectionfunctionabstract.isuserdefined.php - * @return bool true if it's user-defined, otherwise false; + * {@inheritdoc} */ - public function isUserDefined (): bool {} + public function isUserDefined () {} /** - * Returns whether this function is a generator - * @link http://www.php.net/manual/en/reflectionfunctionabstract.isgenerator.php - * @return bool Returns true if the function is generator, false if it is not or null - * on failure. + * {@inheritdoc} */ - public function isGenerator (): bool {} + public function isGenerator () {} /** - * Checks if the function is variadic - * @link http://www.php.net/manual/en/reflectionfunctionabstract.isvariadic.php - * @return bool Returns true if the function is variadic, otherwise false. + * {@inheritdoc} */ - public function isVariadic (): bool {} + public function isVariadic () {} /** - * Checks if the function is static - * @link http://www.php.net/manual/en/reflectiofunctionabstract.isstatic.php - * @return bool true if the function is static, otherwise false + * {@inheritdoc} */ - public function isStatic (): bool {} + public function isStatic () {} /** - * Returns this pointer bound to closure - * @link http://www.php.net/manual/en/reflectionfunctionabstract.getclosurethis.php - * @return object|null Returns $this pointer. - * Returns null in case of an error. + * {@inheritdoc} */ - public function getClosureThis (): ?object {} + public function getClosureThis () {} /** - * Returns the scope associated to the closure - * @link http://www.php.net/manual/en/reflectionfunctionabstract.getclosurescopeclass.php - * @return ReflectionClass|null Returns the class on success or null on failure. + * {@inheritdoc} */ - public function getClosureScopeClass (): ?ReflectionClass {} + public function getClosureScopeClass () {} /** * {@inheritdoc} @@ -1315,189 +869,116 @@ public function getClosureScopeClass (): ?ReflectionClass {} public function getClosureCalledClass () {} /** - * Returns an array of the used variables in the Closure - * @link http://www.php.net/manual/en/reflectionfunctionabstract.getclosureusedvariables.php - * @return array Returns an array of the used variables in the Closure. + * {@inheritdoc} */ public function getClosureUsedVariables (): array {} /** - * Gets doc comment - * @link http://www.php.net/manual/en/reflectionfunctionabstract.getdoccomment.php - * @return string|false The doc comment if it exists, otherwise false + * {@inheritdoc} */ - public function getDocComment (): string|false {} + public function getDocComment () {} /** - * Gets end line number - * @link http://www.php.net/manual/en/reflectionfunctionabstract.getendline.php - * @return int|false The ending line number of the user defined function, or false if unknown. + * {@inheritdoc} */ - public function getEndLine (): int|false {} + public function getEndLine () {} /** - * Gets extension info - * @link http://www.php.net/manual/en/reflectionfunctionabstract.getextension.php - * @return ReflectionExtension|null The extension information, as a ReflectionExtension object, - * or null for user-defined functions. + * {@inheritdoc} */ - public function getExtension (): ?ReflectionExtension {} + public function getExtension () {} /** - * Gets extension name - * @link http://www.php.net/manual/en/reflectionfunctionabstract.getextensionname.php - * @return string|false The name of the extension which defined the function, - * or false for user-defined functions. + * {@inheritdoc} */ - public function getExtensionName (): string|false {} + public function getExtensionName () {} /** - * Gets file name - * @link http://www.php.net/manual/en/reflectionfunctionabstract.getfilename.php - * @return string|false Returns the filename of the file in which the function has been defined. - * If the class is defined in the PHP core or in a PHP extension, false - * is returned. + * {@inheritdoc} */ - public function getFileName (): string|false {} + public function getFileName () {} /** - * Gets function name - * @link http://www.php.net/manual/en/reflectionfunctionabstract.getname.php - * @return string The name of the function. + * {@inheritdoc} */ - public function getName (): string {} + public function getName () {} /** - * Gets namespace name - * @link http://www.php.net/manual/en/reflectionfunctionabstract.getnamespacename.php - * @return string The namespace name. + * {@inheritdoc} */ - public function getNamespaceName (): string {} + public function getNamespaceName () {} /** - * Gets number of parameters - * @link http://www.php.net/manual/en/reflectionfunctionabstract.getnumberofparameters.php - * @return int The number of parameters. + * {@inheritdoc} */ - public function getNumberOfParameters (): int {} + public function getNumberOfParameters () {} /** - * Gets number of required parameters - * @link http://www.php.net/manual/en/reflectionfunctionabstract.getnumberofrequiredparameters.php - * @return int The number of required parameters. + * {@inheritdoc} */ - public function getNumberOfRequiredParameters (): int {} + public function getNumberOfRequiredParameters () {} /** - * Gets parameters - * @link http://www.php.net/manual/en/reflectionfunctionabstract.getparameters.php - * @return array The parameters, as a ReflectionParameter object. + * {@inheritdoc} */ - public function getParameters (): array {} + public function getParameters () {} /** - * Gets function short name - * @link http://www.php.net/manual/en/reflectionfunctionabstract.getshortname.php - * @return string The short name of the function. + * {@inheritdoc} */ - public function getShortName (): string {} + public function getShortName () {} /** - * Gets starting line number - * @link http://www.php.net/manual/en/reflectionfunctionabstract.getstartline.php - * @return int|false The starting line number, or false if unknown. + * {@inheritdoc} */ - public function getStartLine (): int|false {} + public function getStartLine () {} /** - * Gets static variables - * @link http://www.php.net/manual/en/reflectionfunctionabstract.getstaticvariables.php - * @return array An array of static variables. + * {@inheritdoc} */ - public function getStaticVariables (): array {} + public function getStaticVariables () {} /** - * Checks if returns reference - * @link http://www.php.net/manual/en/reflectionfunctionabstract.returnsreference.php - * @return bool true if it returns a reference, otherwise false + * {@inheritdoc} */ - public function returnsReference (): bool {} + public function returnsReference () {} /** - * Checks if the function has a specified return type - * @link http://www.php.net/manual/en/reflectionfunctionabstract.hasreturntype.php - * @return bool Returns true if the function is a specified return type, otherwise false. + * {@inheritdoc} */ - public function hasReturnType (): bool {} + public function hasReturnType () {} /** - * Gets the specified return type of a function - * @link http://www.php.net/manual/en/reflectionfunctionabstract.getreturntype.php - * @return ReflectionType|null Returns a ReflectionType object if a return type is - * specified, null otherwise. + * {@inheritdoc} */ - public function getReturnType (): ?ReflectionType {} + public function getReturnType () {} /** - * Returns whether the function has a tentative return type - * @link http://www.php.net/manual/en/reflectionfunctionabstract.hastentativereturntype.php - * @return bool Returns true if the function has a tentative return type, otherwise false. + * {@inheritdoc} */ public function hasTentativeReturnType (): bool {} /** - * Returns the tentative return type associated with the function - * @link http://www.php.net/manual/en/reflectionfunctionabstract.gettentativereturntype.php - * @return ReflectionType|null Returns a ReflectionType object if a tentative return type is - * specified, null otherwise. + * {@inheritdoc} */ public function getTentativeReturnType (): ?ReflectionType {} /** - * Gets Attributes - * @link http://www.php.net/manual/en/reflectionfunctionabstract.getattributes.php - * @param string|null $name [optional] Filter the results to include only ReflectionAttribute - * instances for attributes matching this class name. - * @param int $flags [optional] Flags for determining how to filter the results, if name - * is provided. - *Default is 0 which will only return results for attributes that - * are of the class name.
- *The only other option available, is to use ReflectionAttribute::IS_INSTANCEOF, - * which will instead use instanceof for filtering.
- * @return array Array of attributes, as a ReflectionAttribute object. + * {@inheritdoc} + * @param string|null $name [optional] + * @param int $flags [optional] */ - public function getAttributes (?string $name = null, int $flags = null): array {} + public function getAttributes (?string $name = NULL, int $flags = 0): array {} } -/** - * The ReflectionClass class reports - * information about a class. - * @link http://www.php.net/manual/en/class.reflectionclass.php - */ class ReflectionClass implements Stringable, Reflector { - /** - * Indicates the class is - * abstract because it has some abstract methods. const IS_IMPLICIT_ABSTRACT = 16; - /** - * Indicates the class is - * abstract because of its definition. const IS_EXPLICIT_ABSTRACT = 64; - /** - * Indicates the class is final. const IS_FINAL = 32; - /** - * Indicates the class is readonly. const IS_READONLY = 65536; - /** - * Name of the class. Read-only, throws - * ReflectionException in attempt to write. - * @var string - * @link http://www.php.net/manual/en/class.reflectionclass.php#reflectionclass.props.name - */ public string $name; /** @@ -1506,373 +987,260 @@ class ReflectionClass implements Stringable, Reflector { private function __clone (): void {} /** - * Constructs a ReflectionClass - * @link http://www.php.net/manual/en/reflectionclass.construct.php - * @param object|string $objectOrClass - * @return object|string + * {@inheritdoc} + * @param object|string $objectOrClass */ - public function __construct (object|string $objectOrClass): object|string {} + public function __construct (object|string $objectOrClass) {} /** - * Returns the string representation of the ReflectionClass object - * @link http://www.php.net/manual/en/reflectionclass.tostring.php - * @return string A string representation of this ReflectionClass instance. + * {@inheritdoc} */ public function __toString (): string {} /** - * Gets class name - * @link http://www.php.net/manual/en/reflectionclass.getname.php - * @return string The class name. + * {@inheritdoc} */ - public function getName (): string {} + public function getName () {} /** - * Checks if class is defined internally by an extension, or the core - * @link http://www.php.net/manual/en/reflectionclass.isinternal.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function isInternal (): bool {} + public function isInternal () {} /** - * Checks if user defined - * @link http://www.php.net/manual/en/reflectionclass.isuserdefined.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function isUserDefined (): bool {} + public function isUserDefined () {} /** - * Checks if class is anonymous - * @link http://www.php.net/manual/en/reflectionclass.isanonymous.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function isAnonymous (): bool {} + public function isAnonymous () {} /** - * Checks if the class is instantiable - * @link http://www.php.net/manual/en/reflectionclass.isinstantiable.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function isInstantiable (): bool {} + public function isInstantiable () {} /** - * Returns whether this class is cloneable - * @link http://www.php.net/manual/en/reflectionclass.iscloneable.php - * @return bool Returns true if the class is cloneable, false otherwise. + * {@inheritdoc} */ - public function isCloneable (): bool {} + public function isCloneable () {} /** - * Gets the filename of the file in which the class has been defined - * @link http://www.php.net/manual/en/reflectionclass.getfilename.php - * @return string|false Returns the filename of the file in which the class has been defined. - * If the class is defined in the PHP core or in a PHP extension, false - * is returned. + * {@inheritdoc} */ - public function getFileName (): string|false {} + public function getFileName () {} /** - * Gets starting line number - * @link http://www.php.net/manual/en/reflectionclass.getstartline.php - * @return int|false The starting line number, as an int, or false if unknown. + * {@inheritdoc} */ - public function getStartLine (): int|false {} + public function getStartLine () {} /** - * Gets end line - * @link http://www.php.net/manual/en/reflectionclass.getendline.php - * @return int|false The ending line number of the user defined class, or false if unknown. + * {@inheritdoc} */ - public function getEndLine (): int|false {} + public function getEndLine () {} /** - * Gets doc comments - * @link http://www.php.net/manual/en/reflectionclass.getdoccomment.php - * @return string|false The doc comment if it exists, otherwise false. + * {@inheritdoc} */ - public function getDocComment (): string|false {} + public function getDocComment () {} /** - * Gets the constructor of the class - * @link http://www.php.net/manual/en/reflectionclass.getconstructor.php - * @return ReflectionMethod|null A ReflectionMethod object reflecting the class' constructor, or null if the class - * has no constructor. + * {@inheritdoc} */ - public function getConstructor (): ?ReflectionMethod {} + public function getConstructor () {} /** - * Checks if method is defined - * @link http://www.php.net/manual/en/reflectionclass.hasmethod.php - * @param string $name - * @return bool true if it has the method, otherwise false + * {@inheritdoc} + * @param string $name */ - public function hasMethod (string $name): bool {} + public function hasMethod (string $name) {} /** - * Gets a ReflectionMethod for a class method - * @link http://www.php.net/manual/en/reflectionclass.getmethod.php - * @param string $name - * @return ReflectionMethod A ReflectionMethod. + * {@inheritdoc} + * @param string $name */ - public function getMethod (string $name): ReflectionMethod {} + public function getMethod (string $name) {} /** - * Gets an array of methods - * @link http://www.php.net/manual/en/reflectionclass.getmethods.php - * @param int|null $filter [optional] - * @return array An array of ReflectionMethod objects - * reflecting each method. + * {@inheritdoc} + * @param int|null $filter [optional] */ - public function getMethods (?int $filter = null): array {} + public function getMethods (?int $filter = NULL) {} /** - * Checks if property is defined - * @link http://www.php.net/manual/en/reflectionclass.hasproperty.php - * @param string $name - * @return bool true if it has the property, otherwise false + * {@inheritdoc} + * @param string $name */ - public function hasProperty (string $name): bool {} + public function hasProperty (string $name) {} /** - * Gets a ReflectionProperty for a class's property - * @link http://www.php.net/manual/en/reflectionclass.getproperty.php - * @param string $name - * @return ReflectionProperty A ReflectionProperty. + * {@inheritdoc} + * @param string $name */ - public function getProperty (string $name): ReflectionProperty {} + public function getProperty (string $name) {} /** - * Gets properties - * @link http://www.php.net/manual/en/reflectionclass.getproperties.php - * @param int|null $filter [optional] - * @return array An array of ReflectionProperty objects. + * {@inheritdoc} + * @param int|null $filter [optional] */ - public function getProperties (?int $filter = null): array {} + public function getProperties (?int $filter = NULL) {} /** - * Checks if constant is defined - * @link http://www.php.net/manual/en/reflectionclass.hasconstant.php - * @param string $name - * @return bool true if the constant is defined, otherwise false. + * {@inheritdoc} + * @param string $name */ - public function hasConstant (string $name): bool {} + public function hasConstant (string $name) {} /** - * Gets constants - * @link http://www.php.net/manual/en/reflectionclass.getconstants.php - * @param int|null $filter [optional] The optional filter, for filtering desired constant visibilities. It's configured using - * the ReflectionClassConstant constants, - * and defaults to all constant visibilities. - * @return array An array of constants, where the keys hold the name - * and the values the value of the constants. + * {@inheritdoc} + * @param int|null $filter [optional] */ - public function getConstants (?int $filter = null): array {} + public function getConstants (?int $filter = NULL) {} /** - * Gets class constants - * @link http://www.php.net/manual/en/reflectionclass.getreflectionconstants.php - * @param int|null $filter [optional] The optional filter, for filtering desired constant visibilities. It's configured using - * the ReflectionClassConstant constants, - * and defaults to all constant visibilities. - * @return array An array of ReflectionClassConstant objects. + * {@inheritdoc} + * @param int|null $filter [optional] */ - public function getReflectionConstants (?int $filter = null): array {} + public function getReflectionConstants (?int $filter = NULL) {} /** - * Gets defined constant - * @link http://www.php.net/manual/en/reflectionclass.getconstant.php - * @param string $name - * @return mixed Value of the constant with the name name. - * Returns false if the constant was not found in the class. + * {@inheritdoc} + * @param string $name */ - public function getConstant (string $name): mixed {} + public function getConstant (string $name) {} /** - * Gets a ReflectionClassConstant for a class's constant - * @link http://www.php.net/manual/en/reflectionclass.getreflectionconstant.php - * @param string $name - * @return ReflectionClassConstant|false A ReflectionClassConstant, or false on failure. + * {@inheritdoc} + * @param string $name */ - public function getReflectionConstant (string $name): ReflectionClassConstant|false {} + public function getReflectionConstant (string $name) {} /** - * Gets the interfaces - * @link http://www.php.net/manual/en/reflectionclass.getinterfaces.php - * @return array An associative array of interfaces, with keys as interface - * names and the array values as ReflectionClass objects. + * {@inheritdoc} */ - public function getInterfaces (): array {} + public function getInterfaces () {} /** - * Gets the interface names - * @link http://www.php.net/manual/en/reflectionclass.getinterfacenames.php - * @return array A numerical array with interface names as the values. + * {@inheritdoc} */ - public function getInterfaceNames (): array {} + public function getInterfaceNames () {} /** - * Checks if the class is an interface - * @link http://www.php.net/manual/en/reflectionclass.isinterface.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function isInterface (): bool {} + public function isInterface () {} /** - * Returns an array of traits used by this class - * @link http://www.php.net/manual/en/reflectionclass.gettraits.php - * @return array Returns an array with trait names in keys and instances of trait's - * ReflectionClass in values. - * Returns null in case of an error. + * {@inheritdoc} */ - public function getTraits (): array {} + public function getTraits () {} /** - * Returns an array of names of traits used by this class - * @link http://www.php.net/manual/en/reflectionclass.gettraitnames.php - * @return array Returns an array with trait names in values. + * {@inheritdoc} */ - public function getTraitNames (): array {} + public function getTraitNames () {} /** - * Returns an array of trait aliases - * @link http://www.php.net/manual/en/reflectionclass.gettraitaliases.php - * @return array Returns an array with new method names in keys and original names (in the - * format "TraitName::original") in values. + * {@inheritdoc} */ - public function getTraitAliases (): array {} + public function getTraitAliases () {} /** - * Returns whether this is a trait - * @link http://www.php.net/manual/en/reflectionclass.istrait.php - * @return bool Returns true if this is a trait, false otherwise. - * Returns null in case of an error. + * {@inheritdoc} */ - public function isTrait (): bool {} + public function isTrait () {} /** - * Returns whether this is an enum - * @link http://www.php.net/manual/en/reflectionclass.isenum.php - * @return bool Returns true if this is an enum, false otherwise. + * {@inheritdoc} */ public function isEnum (): bool {} /** - * Checks if class is abstract - * @link http://www.php.net/manual/en/reflectionclass.isabstract.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function isAbstract (): bool {} + public function isAbstract () {} /** - * Checks if class is final - * @link http://www.php.net/manual/en/reflectionclass.isfinal.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function isFinal (): bool {} + public function isFinal () {} /** - * Checks if class is readonly - * @link http://www.php.net/manual/en/reflectionclass.isreadonly.php - * @return bool true if a class is readonly, false otherwise. + * {@inheritdoc} */ public function isReadOnly (): bool {} /** - * Gets the class modifiers - * @link http://www.php.net/manual/en/reflectionclass.getmodifiers.php - * @return int Returns bitmask of - * modifier constants. + * {@inheritdoc} */ - public function getModifiers (): int {} + public function getModifiers () {} /** - * Checks class for instance - * @link http://www.php.net/manual/en/reflectionclass.isinstance.php - * @param object $object - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param object $object */ - public function isInstance (object $object): bool {} + public function isInstance (object $object) {} /** - * Creates a new class instance from given arguments - * @link http://www.php.net/manual/en/reflectionclass.newinstance.php - * @param mixed $args - * @return object + * {@inheritdoc} + * @param mixed $args [optional] */ - public function newInstance (mixed ...$args): object {} + public function newInstance (mixed ...$args) {} /** - * Creates a new class instance without invoking the constructor - * @link http://www.php.net/manual/en/reflectionclass.newinstancewithoutconstructor.php - * @return object + * {@inheritdoc} */ - public function newInstanceWithoutConstructor (): object {} + public function newInstanceWithoutConstructor () {} /** - * Creates a new class instance from given arguments - * @link http://www.php.net/manual/en/reflectionclass.newinstanceargs.php - * @param array $args [optional] - * @return object|null Returns a new instance of the class, or null on failure. + * {@inheritdoc} + * @param array $args [optional] */ - public function newInstanceArgs (array $args = '[]'): ?object {} + public function newInstanceArgs (array $args = array ( +)) {} /** - * Gets parent class - * @link http://www.php.net/manual/en/reflectionclass.getparentclass.php - * @return ReflectionClass|false A ReflectionClass or false if there's no parent. + * {@inheritdoc} */ - public function getParentClass (): ReflectionClass|false {} + public function getParentClass () {} /** - * Checks if a subclass - * @link http://www.php.net/manual/en/reflectionclass.issubclassof.php - * @param ReflectionClass|string $class - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param ReflectionClass|string $class */ - public function isSubclassOf (ReflectionClass|string $class): bool {} + public function isSubclassOf (ReflectionClass|string $class) {} /** - * Gets static properties - * @link http://www.php.net/manual/en/reflectionclass.getstaticproperties.php - * @return array|null The static properties, as an array, or null on failure. + * {@inheritdoc} */ - public function getStaticProperties (): ?array {} + public function getStaticProperties () {} /** - * Gets static property value - * @link http://www.php.net/manual/en/reflectionclass.getstaticpropertyvalue.php - * @param string $name - * @param mixed $def_value [optional] - * @return mixed The value of the static property. + * {@inheritdoc} + * @param string $name + * @param mixed $default [optional] */ - public function getStaticPropertyValue (string $name, mixed &$def_value = null): mixed {} + public function getStaticPropertyValue (string $name, mixed $default = NULL) {} /** - * Sets static property value - * @link http://www.php.net/manual/en/reflectionclass.setstaticpropertyvalue.php - * @param string $name - * @param mixed $value - * @return void No value is returned. + * {@inheritdoc} + * @param string $name + * @param mixed $value */ - public function setStaticPropertyValue (string $name, mixed $value): void {} + public function setStaticPropertyValue (string $name, mixed $value = null) {} /** - * Gets default properties - * @link http://www.php.net/manual/en/reflectionclass.getdefaultproperties.php - * @return array An array of default properties, with the key being the name of - * the property and the value being the default value of the property or null - * if the property doesn't have a default value. The function does not distinguish - * between static and non static properties and does not take visibility modifiers - * into account. + * {@inheritdoc} */ - public function getDefaultProperties (): array {} + public function getDefaultProperties () {} /** - * Check whether this class is iterable - * @link http://www.php.net/manual/en/reflectionclass.isiterable.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function isIterable (): bool {} + public function isIterable () {} /** * {@inheritdoc} @@ -1880,71 +1248,45 @@ public function isIterable (): bool {} public function isIterateable () {} /** - * Implements interface - * @link http://www.php.net/manual/en/reflectionclass.implementsinterface.php - * @param ReflectionClass|string $interface - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param ReflectionClass|string $interface */ - public function implementsInterface (ReflectionClass|string $interface): bool {} + public function implementsInterface (ReflectionClass|string $interface) {} /** - * Gets a ReflectionExtension object for the extension which defined the class - * @link http://www.php.net/manual/en/reflectionclass.getextension.php - * @return ReflectionExtension|null A ReflectionExtension object representing the extension which defined the class, - * or null for user-defined classes. + * {@inheritdoc} */ - public function getExtension (): ?ReflectionExtension {} + public function getExtension () {} /** - * Gets the name of the extension which defined the class - * @link http://www.php.net/manual/en/reflectionclass.getextensionname.php - * @return string|false The name of the extension which defined the class, or false for user-defined classes. + * {@inheritdoc} */ - public function getExtensionName (): string|false {} + public function getExtensionName () {} /** - * Checks if in namespace - * @link http://www.php.net/manual/en/reflectionclass.innamespace.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function inNamespace (): bool {} + public function inNamespace () {} /** - * Gets namespace name - * @link http://www.php.net/manual/en/reflectionclass.getnamespacename.php - * @return string The namespace name. + * {@inheritdoc} */ - public function getNamespaceName (): string {} + public function getNamespaceName () {} /** - * Gets short name - * @link http://www.php.net/manual/en/reflectionclass.getshortname.php - * @return string The class short name. + * {@inheritdoc} */ - public function getShortName (): string {} + public function getShortName () {} /** - * Gets Attributes - * @link http://www.php.net/manual/en/reflectionclass.getattributes.php - * @param string|null $name [optional] Filter the results to include only ReflectionAttribute - * instances for attributes matching this class name. - * @param int $flags [optional] Flags for determining how to filter the results, if name - * is provided. - *Default is 0 which will only return results for attributes that - * are of the class name.
- *The only other option available, is to use ReflectionAttribute::IS_INSTANCEOF, - * which will instead use instanceof for filtering.
- * @return array Array of attributes, as a ReflectionAttribute object. + * {@inheritdoc} + * @param string|null $name [optional] + * @param int $flags [optional] */ - public function getAttributes (?string $name = null, int $flags = null): array {} + public function getAttributes (?string $name = NULL, int $flags = 0): array {} } -/** - * The ReflectionObject class reports - * information about an object. - * @link http://www.php.net/manual/en/class.reflectionobject.php - */ class ReflectionObject extends ReflectionClass implements Reflector, Stringable { const IS_IMPLICIT_ABSTRACT = 16; const IS_EXPLICIT_ABSTRACT = 64; @@ -1953,373 +1295,260 @@ class ReflectionObject extends ReflectionClass implements Reflector, Stringable /** - * Constructs a ReflectionObject - * @link http://www.php.net/manual/en/reflectionobject.construct.php - * @param object $object - * @return object + * {@inheritdoc} + * @param object $object */ - public function __construct (object $object): object {} + public function __construct (object $object) {} /** - * Returns the string representation of the ReflectionClass object - * @link http://www.php.net/manual/en/reflectionclass.tostring.php - * @return string A string representation of this ReflectionClass instance. + * {@inheritdoc} */ public function __toString (): string {} /** - * Gets class name - * @link http://www.php.net/manual/en/reflectionclass.getname.php - * @return string The class name. + * {@inheritdoc} */ - public function getName (): string {} + public function getName () {} /** - * Checks if class is defined internally by an extension, or the core - * @link http://www.php.net/manual/en/reflectionclass.isinternal.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function isInternal (): bool {} + public function isInternal () {} /** - * Checks if user defined - * @link http://www.php.net/manual/en/reflectionclass.isuserdefined.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function isUserDefined (): bool {} + public function isUserDefined () {} /** - * Checks if class is anonymous - * @link http://www.php.net/manual/en/reflectionclass.isanonymous.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function isAnonymous (): bool {} + public function isAnonymous () {} /** - * Checks if the class is instantiable - * @link http://www.php.net/manual/en/reflectionclass.isinstantiable.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function isInstantiable (): bool {} + public function isInstantiable () {} /** - * Returns whether this class is cloneable - * @link http://www.php.net/manual/en/reflectionclass.iscloneable.php - * @return bool Returns true if the class is cloneable, false otherwise. + * {@inheritdoc} */ - public function isCloneable (): bool {} + public function isCloneable () {} /** - * Gets the filename of the file in which the class has been defined - * @link http://www.php.net/manual/en/reflectionclass.getfilename.php - * @return string|false Returns the filename of the file in which the class has been defined. - * If the class is defined in the PHP core or in a PHP extension, false - * is returned. + * {@inheritdoc} */ - public function getFileName (): string|false {} + public function getFileName () {} /** - * Gets starting line number - * @link http://www.php.net/manual/en/reflectionclass.getstartline.php - * @return int|false The starting line number, as an int, or false if unknown. + * {@inheritdoc} */ - public function getStartLine (): int|false {} + public function getStartLine () {} /** - * Gets end line - * @link http://www.php.net/manual/en/reflectionclass.getendline.php - * @return int|false The ending line number of the user defined class, or false if unknown. + * {@inheritdoc} */ - public function getEndLine (): int|false {} + public function getEndLine () {} /** - * Gets doc comments - * @link http://www.php.net/manual/en/reflectionclass.getdoccomment.php - * @return string|false The doc comment if it exists, otherwise false. + * {@inheritdoc} */ - public function getDocComment (): string|false {} + public function getDocComment () {} /** - * Gets the constructor of the class - * @link http://www.php.net/manual/en/reflectionclass.getconstructor.php - * @return ReflectionMethod|null A ReflectionMethod object reflecting the class' constructor, or null if the class - * has no constructor. + * {@inheritdoc} */ - public function getConstructor (): ?ReflectionMethod {} + public function getConstructor () {} /** - * Checks if method is defined - * @link http://www.php.net/manual/en/reflectionclass.hasmethod.php - * @param string $name - * @return bool true if it has the method, otherwise false + * {@inheritdoc} + * @param string $name */ - public function hasMethod (string $name): bool {} + public function hasMethod (string $name) {} /** - * Gets a ReflectionMethod for a class method - * @link http://www.php.net/manual/en/reflectionclass.getmethod.php - * @param string $name - * @return ReflectionMethod A ReflectionMethod. + * {@inheritdoc} + * @param string $name */ - public function getMethod (string $name): ReflectionMethod {} + public function getMethod (string $name) {} /** - * Gets an array of methods - * @link http://www.php.net/manual/en/reflectionclass.getmethods.php - * @param int|null $filter [optional] - * @return array An array of ReflectionMethod objects - * reflecting each method. + * {@inheritdoc} + * @param int|null $filter [optional] */ - public function getMethods (?int $filter = null): array {} + public function getMethods (?int $filter = NULL) {} /** - * Checks if property is defined - * @link http://www.php.net/manual/en/reflectionclass.hasproperty.php - * @param string $name - * @return bool true if it has the property, otherwise false + * {@inheritdoc} + * @param string $name */ - public function hasProperty (string $name): bool {} + public function hasProperty (string $name) {} /** - * Gets a ReflectionProperty for a class's property - * @link http://www.php.net/manual/en/reflectionclass.getproperty.php - * @param string $name - * @return ReflectionProperty A ReflectionProperty. + * {@inheritdoc} + * @param string $name */ - public function getProperty (string $name): ReflectionProperty {} + public function getProperty (string $name) {} /** - * Gets properties - * @link http://www.php.net/manual/en/reflectionclass.getproperties.php - * @param int|null $filter [optional] - * @return array An array of ReflectionProperty objects. + * {@inheritdoc} + * @param int|null $filter [optional] */ - public function getProperties (?int $filter = null): array {} + public function getProperties (?int $filter = NULL) {} /** - * Checks if constant is defined - * @link http://www.php.net/manual/en/reflectionclass.hasconstant.php - * @param string $name - * @return bool true if the constant is defined, otherwise false. + * {@inheritdoc} + * @param string $name */ - public function hasConstant (string $name): bool {} + public function hasConstant (string $name) {} /** - * Gets constants - * @link http://www.php.net/manual/en/reflectionclass.getconstants.php - * @param int|null $filter [optional] The optional filter, for filtering desired constant visibilities. It's configured using - * the ReflectionClassConstant constants, - * and defaults to all constant visibilities. - * @return array An array of constants, where the keys hold the name - * and the values the value of the constants. + * {@inheritdoc} + * @param int|null $filter [optional] */ - public function getConstants (?int $filter = null): array {} + public function getConstants (?int $filter = NULL) {} /** - * Gets class constants - * @link http://www.php.net/manual/en/reflectionclass.getreflectionconstants.php - * @param int|null $filter [optional] The optional filter, for filtering desired constant visibilities. It's configured using - * the ReflectionClassConstant constants, - * and defaults to all constant visibilities. - * @return array An array of ReflectionClassConstant objects. + * {@inheritdoc} + * @param int|null $filter [optional] */ - public function getReflectionConstants (?int $filter = null): array {} + public function getReflectionConstants (?int $filter = NULL) {} /** - * Gets defined constant - * @link http://www.php.net/manual/en/reflectionclass.getconstant.php - * @param string $name - * @return mixed Value of the constant with the name name. - * Returns false if the constant was not found in the class. + * {@inheritdoc} + * @param string $name */ - public function getConstant (string $name): mixed {} + public function getConstant (string $name) {} /** - * Gets a ReflectionClassConstant for a class's constant - * @link http://www.php.net/manual/en/reflectionclass.getreflectionconstant.php - * @param string $name - * @return ReflectionClassConstant|false A ReflectionClassConstant, or false on failure. + * {@inheritdoc} + * @param string $name */ - public function getReflectionConstant (string $name): ReflectionClassConstant|false {} + public function getReflectionConstant (string $name) {} /** - * Gets the interfaces - * @link http://www.php.net/manual/en/reflectionclass.getinterfaces.php - * @return array An associative array of interfaces, with keys as interface - * names and the array values as ReflectionClass objects. + * {@inheritdoc} */ - public function getInterfaces (): array {} + public function getInterfaces () {} /** - * Gets the interface names - * @link http://www.php.net/manual/en/reflectionclass.getinterfacenames.php - * @return array A numerical array with interface names as the values. + * {@inheritdoc} */ - public function getInterfaceNames (): array {} + public function getInterfaceNames () {} /** - * Checks if the class is an interface - * @link http://www.php.net/manual/en/reflectionclass.isinterface.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function isInterface (): bool {} + public function isInterface () {} /** - * Returns an array of traits used by this class - * @link http://www.php.net/manual/en/reflectionclass.gettraits.php - * @return array Returns an array with trait names in keys and instances of trait's - * ReflectionClass in values. - * Returns null in case of an error. + * {@inheritdoc} */ - public function getTraits (): array {} + public function getTraits () {} /** - * Returns an array of names of traits used by this class - * @link http://www.php.net/manual/en/reflectionclass.gettraitnames.php - * @return array Returns an array with trait names in values. + * {@inheritdoc} */ - public function getTraitNames (): array {} + public function getTraitNames () {} /** - * Returns an array of trait aliases - * @link http://www.php.net/manual/en/reflectionclass.gettraitaliases.php - * @return array Returns an array with new method names in keys and original names (in the - * format "TraitName::original") in values. + * {@inheritdoc} */ - public function getTraitAliases (): array {} + public function getTraitAliases () {} /** - * Returns whether this is a trait - * @link http://www.php.net/manual/en/reflectionclass.istrait.php - * @return bool Returns true if this is a trait, false otherwise. - * Returns null in case of an error. + * {@inheritdoc} */ - public function isTrait (): bool {} + public function isTrait () {} /** - * Returns whether this is an enum - * @link http://www.php.net/manual/en/reflectionclass.isenum.php - * @return bool Returns true if this is an enum, false otherwise. + * {@inheritdoc} */ public function isEnum (): bool {} /** - * Checks if class is abstract - * @link http://www.php.net/manual/en/reflectionclass.isabstract.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function isAbstract (): bool {} + public function isAbstract () {} /** - * Checks if class is final - * @link http://www.php.net/manual/en/reflectionclass.isfinal.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function isFinal (): bool {} + public function isFinal () {} /** - * Checks if class is readonly - * @link http://www.php.net/manual/en/reflectionclass.isreadonly.php - * @return bool true if a class is readonly, false otherwise. + * {@inheritdoc} */ public function isReadOnly (): bool {} /** - * Gets the class modifiers - * @link http://www.php.net/manual/en/reflectionclass.getmodifiers.php - * @return int Returns bitmask of - * modifier constants. + * {@inheritdoc} */ - public function getModifiers (): int {} + public function getModifiers () {} /** - * Checks class for instance - * @link http://www.php.net/manual/en/reflectionclass.isinstance.php - * @param object $object - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param object $object */ - public function isInstance (object $object): bool {} + public function isInstance (object $object) {} /** - * Creates a new class instance from given arguments - * @link http://www.php.net/manual/en/reflectionclass.newinstance.php - * @param mixed $args - * @return object + * {@inheritdoc} + * @param mixed $args [optional] */ - public function newInstance (mixed ...$args): object {} + public function newInstance (mixed ...$args) {} /** - * Creates a new class instance without invoking the constructor - * @link http://www.php.net/manual/en/reflectionclass.newinstancewithoutconstructor.php - * @return object + * {@inheritdoc} */ - public function newInstanceWithoutConstructor (): object {} + public function newInstanceWithoutConstructor () {} /** - * Creates a new class instance from given arguments - * @link http://www.php.net/manual/en/reflectionclass.newinstanceargs.php - * @param array $args [optional] - * @return object|null Returns a new instance of the class, or null on failure. + * {@inheritdoc} + * @param array $args [optional] */ - public function newInstanceArgs (array $args = '[]'): ?object {} + public function newInstanceArgs (array $args = array ( +)) {} /** - * Gets parent class - * @link http://www.php.net/manual/en/reflectionclass.getparentclass.php - * @return ReflectionClass|false A ReflectionClass or false if there's no parent. + * {@inheritdoc} */ - public function getParentClass (): ReflectionClass|false {} + public function getParentClass () {} /** - * Checks if a subclass - * @link http://www.php.net/manual/en/reflectionclass.issubclassof.php - * @param ReflectionClass|string $class - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param ReflectionClass|string $class */ - public function isSubclassOf (ReflectionClass|string $class): bool {} + public function isSubclassOf (ReflectionClass|string $class) {} /** - * Gets static properties - * @link http://www.php.net/manual/en/reflectionclass.getstaticproperties.php - * @return array|null The static properties, as an array, or null on failure. + * {@inheritdoc} */ - public function getStaticProperties (): ?array {} + public function getStaticProperties () {} /** - * Gets static property value - * @link http://www.php.net/manual/en/reflectionclass.getstaticpropertyvalue.php - * @param string $name - * @param mixed $def_value [optional] - * @return mixed The value of the static property. + * {@inheritdoc} + * @param string $name + * @param mixed $default [optional] */ - public function getStaticPropertyValue (string $name, mixed &$def_value = null): mixed {} + public function getStaticPropertyValue (string $name, mixed $default = NULL) {} /** - * Sets static property value - * @link http://www.php.net/manual/en/reflectionclass.setstaticpropertyvalue.php - * @param string $name - * @param mixed $value - * @return void No value is returned. + * {@inheritdoc} + * @param string $name + * @param mixed $value */ - public function setStaticPropertyValue (string $name, mixed $value): void {} + public function setStaticPropertyValue (string $name, mixed $value = null) {} /** - * Gets default properties - * @link http://www.php.net/manual/en/reflectionclass.getdefaultproperties.php - * @return array An array of default properties, with the key being the name of - * the property and the value being the default value of the property or null - * if the property doesn't have a default value. The function does not distinguish - * between static and non static properties and does not take visibility modifiers - * into account. + * {@inheritdoc} */ - public function getDefaultProperties (): array {} + public function getDefaultProperties () {} /** - * Check whether this class is iterable - * @link http://www.php.net/manual/en/reflectionclass.isiterable.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function isIterable (): bool {} + public function isIterable () {} /** * {@inheritdoc} @@ -2327,344 +1556,192 @@ public function isIterable (): bool {} public function isIterateable () {} /** - * Implements interface - * @link http://www.php.net/manual/en/reflectionclass.implementsinterface.php - * @param ReflectionClass|string $interface - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param ReflectionClass|string $interface */ - public function implementsInterface (ReflectionClass|string $interface): bool {} + public function implementsInterface (ReflectionClass|string $interface) {} /** - * Gets a ReflectionExtension object for the extension which defined the class - * @link http://www.php.net/manual/en/reflectionclass.getextension.php - * @return ReflectionExtension|null A ReflectionExtension object representing the extension which defined the class, - * or null for user-defined classes. + * {@inheritdoc} */ - public function getExtension (): ?ReflectionExtension {} + public function getExtension () {} /** - * Gets the name of the extension which defined the class - * @link http://www.php.net/manual/en/reflectionclass.getextensionname.php - * @return string|false The name of the extension which defined the class, or false for user-defined classes. + * {@inheritdoc} */ - public function getExtensionName (): string|false {} + public function getExtensionName () {} /** - * Checks if in namespace - * @link http://www.php.net/manual/en/reflectionclass.innamespace.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function inNamespace (): bool {} + public function inNamespace () {} /** - * Gets namespace name - * @link http://www.php.net/manual/en/reflectionclass.getnamespacename.php - * @return string The namespace name. + * {@inheritdoc} */ - public function getNamespaceName (): string {} + public function getNamespaceName () {} /** - * Gets short name - * @link http://www.php.net/manual/en/reflectionclass.getshortname.php - * @return string The class short name. + * {@inheritdoc} */ - public function getShortName (): string {} + public function getShortName () {} /** - * Gets Attributes - * @link http://www.php.net/manual/en/reflectionclass.getattributes.php - * @param string|null $name [optional] Filter the results to include only ReflectionAttribute - * instances for attributes matching this class name. - * @param int $flags [optional] Flags for determining how to filter the results, if name - * is provided. - *Default is 0 which will only return results for attributes that - * are of the class name.
- *The only other option available, is to use ReflectionAttribute::IS_INSTANCEOF, - * which will instead use instanceof for filtering.
- * @return array Array of attributes, as a ReflectionAttribute object. + * {@inheritdoc} + * @param string|null $name [optional] + * @param int $flags [optional] */ - public function getAttributes (?string $name = null, int $flags = null): array {} + public function getAttributes (?string $name = NULL, int $flags = 0): array {} } -/** - * The ReflectionProperty class reports - * information about class properties. - * @link http://www.php.net/manual/en/class.reflectionproperty.php - */ class ReflectionProperty implements Stringable, Reflector { - /** - * Indicates static - * properties. - * Prior to PHP 7.4.0, the value was 1. const IS_STATIC = 16; - /** - * Indicates readonly - * properties. Available as of PHP 8.1.0. const IS_READONLY = 128; - /** - * Indicates public - * properties. - * Prior to PHP 7.4.0, the value was 256. const IS_PUBLIC = 1; - /** - * Indicates protected - * properties. - * Prior to PHP 7.4.0, the value was 512. const IS_PROTECTED = 2; - /** - * Indicates private - * properties. - * Prior to PHP 7.4.0, the value was 1024. const IS_PRIVATE = 4; - /** - * Name of the property. Read-only, throws - * ReflectionException in attempt to write. - * @var string - * @link http://www.php.net/manual/en/class.reflectionproperty.php#reflectionproperty.props.name - */ public string $name; - /** - * Name of the class where the property is defined. Read-only, throws - * ReflectionException in attempt to write. - * @var string - * @link http://www.php.net/manual/en/class.reflectionproperty.php#reflectionproperty.props.class - */ public string $class; /** - * Clone - * @link http://www.php.net/manual/en/reflectionproperty.clone.php - * @return void + * {@inheritdoc} */ private function __clone (): void {} /** - * Construct a ReflectionProperty object - * @link http://www.php.net/manual/en/reflectionproperty.construct.php - * @param object|string $class - * @param string $property - * @return object|string + * {@inheritdoc} + * @param object|string $class + * @param string $property */ - public function __construct (object|string $class, string $property): object|string {} + public function __construct (object|string $class, string $property) {} /** - * To string - * @link http://www.php.net/manual/en/reflectionproperty.tostring.php - * @return string + * {@inheritdoc} */ public function __toString (): string {} /** - * Gets property name - * @link http://www.php.net/manual/en/reflectionproperty.getname.php - * @return string The name of the reflected property. + * {@inheritdoc} */ - public function getName (): string {} + public function getName () {} /** - * Gets value - * @link http://www.php.net/manual/en/reflectionproperty.getvalue.php - * @param object|null $object [optional] - * @return mixed The current value of the property. + * {@inheritdoc} + * @param object|null $object [optional] */ - public function getValue (?object $object = null): mixed {} + public function getValue (?object $object = NULL) {} /** - * Set property value - * @link http://www.php.net/manual/en/reflectionproperty.setvalue.php - * @param object $object - * @param mixed $value - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $objectOrValue + * @param mixed $value [optional] */ - public function setValue (object $object, mixed $value): void {} + public function setValue (mixed $objectOrValue = null, mixed $value = NULL) {} /** - * Checks whether a property is initialized - * @link http://www.php.net/manual/en/reflectionproperty.isinitialized.php - * @param object|null $object [optional] If the property is non-static an object must be provided to fetch the - * property from. - * @return bool Returns false for typed properties prior to initialization, - * and for properties that have been explicitly unset. - * For all other properties true will be returned. + * {@inheritdoc} + * @param object|null $object [optional] */ - public function isInitialized (?object $object = null): bool {} + public function isInitialized (?object $object = NULL) {} /** - * Checks if property is public - * @link http://www.php.net/manual/en/reflectionproperty.ispublic.php - * @return bool true if the property is public, false otherwise. + * {@inheritdoc} */ - public function isPublic (): bool {} + public function isPublic () {} /** - * Checks if property is private - * @link http://www.php.net/manual/en/reflectionproperty.isprivate.php - * @return bool true if the property is private, false otherwise. + * {@inheritdoc} */ - public function isPrivate (): bool {} + public function isPrivate () {} /** - * Checks if property is protected - * @link http://www.php.net/manual/en/reflectionproperty.isprotected.php - * @return bool true if the property is protected, false otherwise. + * {@inheritdoc} */ - public function isProtected (): bool {} + public function isProtected () {} /** - * Checks if property is static - * @link http://www.php.net/manual/en/reflectionproperty.isstatic.php - * @return bool true if the property is static, false otherwise. + * {@inheritdoc} */ - public function isStatic (): bool {} + public function isStatic () {} /** - * Checks if property is readonly - * @link http://www.php.net/manual/en/reflectionproperty.isreadonly.php - * @return bool true if the property is readonly, false otherwise. + * {@inheritdoc} */ public function isReadOnly (): bool {} /** - * Checks if property is a default property - * @link http://www.php.net/manual/en/reflectionproperty.isdefault.php - * @return bool true if the property was declared at compile-time, or false if - * it was created at run-time. + * {@inheritdoc} */ - public function isDefault (): bool {} + public function isDefault () {} /** - * Checks if property is promoted - * @link http://www.php.net/manual/en/reflectionproperty.ispromoted.php - * @return bool true if the property is promoted, false otherwise. + * {@inheritdoc} */ public function isPromoted (): bool {} /** - * Gets the property modifiers - * @link http://www.php.net/manual/en/reflectionproperty.getmodifiers.php - * @return int A numeric representation of the modifiers. - * The actual meaning of these modifiers are described under - * predefined constants. + * {@inheritdoc} */ - public function getModifiers (): int {} + public function getModifiers () {} /** - * Gets declaring class - * @link http://www.php.net/manual/en/reflectionproperty.getdeclaringclass.php - * @return ReflectionClass A ReflectionClass object. + * {@inheritdoc} */ - public function getDeclaringClass (): ReflectionClass {} + public function getDeclaringClass () {} /** - * Gets the property doc comment - * @link http://www.php.net/manual/en/reflectionproperty.getdoccomment.php - * @return string|false The doc comment if it exists, otherwise false. + * {@inheritdoc} */ - public function getDocComment (): string|false {} + public function getDocComment () {} /** - * Set property accessibility - * @link http://www.php.net/manual/en/reflectionproperty.setaccessible.php - * @param bool $accessible - * @return void No value is returned. + * {@inheritdoc} + * @param bool $accessible */ - public function setAccessible (bool $accessible): void {} + public function setAccessible (bool $accessible) {} /** - * Gets a property's type - * @link http://www.php.net/manual/en/reflectionproperty.gettype.php - * @return ReflectionType|null Returns a ReflectionType if the property has a type, - * and null otherwise. + * {@inheritdoc} */ - public function getType (): ?ReflectionType {} + public function getType () {} /** - * Checks if property has a type - * @link http://www.php.net/manual/en/reflectionproperty.hastype.php - * @return bool true if a type is specified, false otherwise. + * {@inheritdoc} */ - public function hasType (): bool {} + public function hasType () {} /** - * Checks if property has a default value declared - * @link http://www.php.net/manual/en/reflectionproperty.hasdefaultvalue.php - * @return bool If the property has any default value (including null) true is returned; - * if the property is typed without a default value declared or is a dynamic property, false is returned. + * {@inheritdoc} */ public function hasDefaultValue (): bool {} /** - * Returns the default value declared for a property - * @link http://www.php.net/manual/en/reflectionproperty.getdefaultvalue.php - * @return mixed The default value if the property has any default value (including null). - * If there is no default value, then null is returned. It is not possible to differentiate - * between a null default value and an unitialized typed property. - * Use ReflectionProperty::hasDefaultValue to detect the difference. + * {@inheritdoc} */ - public function getDefaultValue (): mixed {} + public function getDefaultValue () {} /** - * Gets Attributes - * @link http://www.php.net/manual/en/reflectionproperty.getattributes.php - * @param string|null $name [optional] Filter the results to include only ReflectionAttribute - * instances for attributes matching this class name. - * @param int $flags [optional] Flags for determining how to filter the results, if name - * is provided. - *Default is 0 which will only return results for attributes that - * are of the class name.
- *The only other option available, is to use ReflectionAttribute::IS_INSTANCEOF, - * which will instead use instanceof for filtering.
- * @return array Array of attributes, as a ReflectionAttribute object. + * {@inheritdoc} + * @param string|null $name [optional] + * @param int $flags [optional] */ - public function getAttributes (?string $name = null, int $flags = null): array {} + public function getAttributes (?string $name = NULL, int $flags = 0): array {} } -/** - * The ReflectionClassConstant class reports - * information about a class constant. - * @link http://www.php.net/manual/en/class.reflectionclassconstant.php - */ class ReflectionClassConstant implements Stringable, Reflector { - /** - * Indicates public - * constants. - * Prior to PHP 7.4.0, the value was 256. const IS_PUBLIC = 1; - /** - * Indicates protected - * constants. - * Prior to PHP 7.4.0, the value was 512. const IS_PROTECTED = 2; - /** - * Indicates private - * constants. - * Prior to PHP 7.4.0, the value was 1024. const IS_PRIVATE = 4; - /** - * Indicates final - * constants. Available as of PHP 8.1.0. const IS_FINAL = 32; - /** - * Name of the class constant. Read-only, throws - * ReflectionException in attempt to write. - * @var string - * @link http://www.php.net/manual/en/class.reflectionclassconstant.php#reflectionclassconstant.props.name - */ public string $name; - /** - * Name of the class where the class constant is defined. Read-only, throws - * ReflectionException in attempt to write. - * @var string - * @link http://www.php.net/manual/en/class.reflectionclassconstant.php#reflectionclassconstant.props.class - */ public string $class; /** @@ -2673,331 +1750,221 @@ class ReflectionClassConstant implements Stringable, Reflector { private function __clone (): void {} /** - * Constructs a ReflectionClassConstant - * @link http://www.php.net/manual/en/reflectionclassconstant.construct.php - * @param object|string $class - * @param string $constant - * @return object|string + * {@inheritdoc} + * @param object|string $class + * @param string $constant */ - public function __construct (object|string $class, string $constant): object|string {} + public function __construct (object|string $class, string $constant) {} /** - * Returns the string representation of the ReflectionClassConstant object - * @link http://www.php.net/manual/en/reflectionclassconstant.tostring.php - * @return string A string representation of this ReflectionClassConstant instance. + * {@inheritdoc} */ public function __toString (): string {} /** - * Get name of the constant - * @link http://www.php.net/manual/en/reflectionclassconstant.getname.php - * @return string Returns the constant's name. + * {@inheritdoc} */ - public function getName (): string {} + public function getName () {} /** - * Gets value - * @link http://www.php.net/manual/en/reflectionclassconstant.getvalue.php - * @return mixed The value of the class constant. + * {@inheritdoc} */ - public function getValue (): mixed {} + public function getValue () {} /** - * Checks if class constant is public - * @link http://www.php.net/manual/en/reflectionclassconstant.ispublic.php - * @return bool true if the class constant is public, otherwise false + * {@inheritdoc} */ - public function isPublic (): bool {} + public function isPublic () {} /** - * Checks if class constant is private - * @link http://www.php.net/manual/en/reflectionclassconstant.isprivate.php - * @return bool true if the class constant is private, otherwise false + * {@inheritdoc} */ - public function isPrivate (): bool {} + public function isPrivate () {} /** - * Checks if class constant is protected - * @link http://www.php.net/manual/en/reflectionclassconstant.isprotected.php - * @return bool true if the class constant is protected, otherwise false + * {@inheritdoc} */ - public function isProtected (): bool {} + public function isProtected () {} /** - * Checks if class constant is final - * @link http://www.php.net/manual/en/reflectionclassconstant.isfinal.php - * @return bool true if the class constant is final, otherwise false + * {@inheritdoc} */ public function isFinal (): bool {} /** - * Gets the class constant modifiers - * @link http://www.php.net/manual/en/reflectionclassconstant.getmodifiers.php - * @return int A numeric representation of the modifiers. - * The actual meaning of these modifiers are described under - * predefined constants. + * {@inheritdoc} */ - public function getModifiers (): int {} + public function getModifiers () {} /** - * Gets declaring class - * @link http://www.php.net/manual/en/reflectionclassconstant.getdeclaringclass.php - * @return ReflectionClass A ReflectionClass object. + * {@inheritdoc} */ - public function getDeclaringClass (): ReflectionClass {} + public function getDeclaringClass () {} /** - * Gets doc comments - * @link http://www.php.net/manual/en/reflectionclassconstant.getdoccomment.php - * @return string|false The doc comment if it exists, otherwise false + * {@inheritdoc} */ - public function getDocComment (): string|false {} + public function getDocComment () {} /** - * Gets Attributes - * @link http://www.php.net/manual/en/reflectionclassconstant.getattributes.php - * @param string|null $name [optional] Filter the results to include only ReflectionAttribute - * instances for attributes matching this class name. - * @param int $flags [optional] Flags for determining how to filter the results, if name - * is provided. - *Default is 0 which will only return results for attributes that - * are of the class name.
- *The only other option available, is to use ReflectionAttribute::IS_INSTANCEOF, - * which will instead use instanceof for filtering.
- * @return array Array of attributes, as a ReflectionAttribute object. + * {@inheritdoc} + * @param string|null $name [optional] + * @param int $flags [optional] */ - public function getAttributes (?string $name = null, int $flags = null): array {} + public function getAttributes (?string $name = NULL, int $flags = 0): array {} /** - * Checks if class constant is an Enum case - * @link http://www.php.net/manual/en/reflectionclassconstant.isenumcase.php - * @return bool true if the class constant is an Enum case; false otherwise. + * {@inheritdoc} */ public function isEnumCase (): bool {} + /** + * {@inheritdoc} + */ + public function hasType (): bool {} + + /** + * {@inheritdoc} + */ + public function getType (): ?ReflectionType {} + } -/** - * The ReflectionExtension class reports - * information about an extension. - * @link http://www.php.net/manual/en/class.reflectionextension.php - */ class ReflectionExtension implements Stringable, Reflector { - /** - * Name of the extension, same as calling the - * ReflectionExtension::getName - * method. - * @var string - * @link http://www.php.net/manual/en/class.reflectionextension.php#reflectionextension.props.name - */ public string $name; /** - * Clones - * @link http://www.php.net/manual/en/reflectionextension.clone.php - * @return void No value is returned, if called a fatal error will occur. + * {@inheritdoc} */ private function __clone (): void {} /** - * Constructs a ReflectionExtension - * @link http://www.php.net/manual/en/reflectionextension.construct.php - * @param string $name - * @return string + * {@inheritdoc} + * @param string $name */ - public function __construct (string $name): string {} + public function __construct (string $name) {} /** - * To string - * @link http://www.php.net/manual/en/reflectionextension.tostring.php - * @return string Returns the exported extension as a string, in the same way as the - * ReflectionExtension::export. + * {@inheritdoc} */ public function __toString (): string {} /** - * Gets extension name - * @link http://www.php.net/manual/en/reflectionextension.getname.php - * @return string The extensions name. + * {@inheritdoc} */ - public function getName (): string {} + public function getName () {} /** - * Gets extension version - * @link http://www.php.net/manual/en/reflectionextension.getversion.php - * @return string|null The version of the extension, or null if the extension has no version. + * {@inheritdoc} */ - public function getVersion (): ?string {} + public function getVersion () {} /** - * Gets extension functions - * @link http://www.php.net/manual/en/reflectionextension.getfunctions.php - * @return array An associative array of ReflectionFunction objects, - * for each function defined in the extension with the keys being the function - * names. If no function are defined, an empty array is returned. + * {@inheritdoc} */ - public function getFunctions (): array {} + public function getFunctions () {} /** - * Gets constants - * @link http://www.php.net/manual/en/reflectionextension.getconstants.php - * @return array An associative array with constant names as keys. + * {@inheritdoc} */ - public function getConstants (): array {} + public function getConstants () {} /** - * Gets extension ini entries - * @link http://www.php.net/manual/en/reflectionextension.getinientries.php - * @return array An associative array with the ini entries as keys, - * with their defined values as values. + * {@inheritdoc} */ - public function getINIEntries (): array {} + public function getINIEntries () {} /** - * Gets classes - * @link http://www.php.net/manual/en/reflectionextension.getclasses.php - * @return array An array of ReflectionClass objects, one - * for each class within the extension. If no classes are defined, - * an empty array is returned. + * {@inheritdoc} */ - public function getClasses (): array {} + public function getClasses () {} /** - * Gets class names - * @link http://www.php.net/manual/en/reflectionextension.getclassnames.php - * @return array An array of class names, as defined in the extension. - * If no classes are defined, an empty array is returned. + * {@inheritdoc} */ - public function getClassNames (): array {} + public function getClassNames () {} /** - * Gets dependencies - * @link http://www.php.net/manual/en/reflectionextension.getdependencies.php - * @return array An associative array with dependencies as keys and - * either Required, Optional - * or Conflicts as the values. + * {@inheritdoc} */ - public function getDependencies (): array {} + public function getDependencies () {} /** - * Print extension info - * @link http://www.php.net/manual/en/reflectionextension.info.php - * @return void Information about the extension. + * {@inheritdoc} */ - public function info (): void {} + public function info () {} /** - * Returns whether this extension is persistent - * @link http://www.php.net/manual/en/reflectionextension.ispersistent.php - * @return bool Returns true for extensions loaded by extension, false - * otherwise. + * {@inheritdoc} */ - public function isPersistent (): bool {} + public function isPersistent () {} /** - * Returns whether this extension is temporary - * @link http://www.php.net/manual/en/reflectionextension.istemporary.php - * @return bool Returns true for extensions loaded by dl, - * false otherwise. + * {@inheritdoc} */ - public function isTemporary (): bool {} + public function isTemporary () {} } -/** - * @link http://www.php.net/manual/en/class.reflectionzendextension.php - */ class ReflectionZendExtension implements Stringable, Reflector { - /** - * Name of the extension. Read-only, throws - * ReflectionException in attempt to write. - * @var string - * @link http://www.php.net/manual/en/class.reflectionzendextension.php#reflectionzendextension.props.name - */ public string $name; /** - * Clone handler - * @link http://www.php.net/manual/en/reflectionzendextension.clone.php - * @return void + * {@inheritdoc} */ private function __clone (): void {} /** - * Constructor - * @link http://www.php.net/manual/en/reflectionzendextension.construct.php - * @param string $name - * @return string + * {@inheritdoc} + * @param string $name */ - public function __construct (string $name): string {} + public function __construct (string $name) {} /** - * To string handler - * @link http://www.php.net/manual/en/reflectionzendextension.tostring.php - * @return string + * {@inheritdoc} */ public function __toString (): string {} /** - * Gets name - * @link http://www.php.net/manual/en/reflectionzendextension.getname.php - * @return string + * {@inheritdoc} */ - public function getName (): string {} + public function getName () {} /** - * Gets version - * @link http://www.php.net/manual/en/reflectionzendextension.getversion.php - * @return string + * {@inheritdoc} */ - public function getVersion (): string {} + public function getVersion () {} /** - * Gets author - * @link http://www.php.net/manual/en/reflectionzendextension.getauthor.php - * @return string + * {@inheritdoc} */ - public function getAuthor (): string {} + public function getAuthor () {} /** - * Gets URL - * @link http://www.php.net/manual/en/reflectionzendextension.geturl.php - * @return string + * {@inheritdoc} */ - public function getURL (): string {} + public function getURL () {} /** - * Gets copyright - * @link http://www.php.net/manual/en/reflectionzendextension.getcopyright.php - * @return string + * {@inheritdoc} */ - public function getCopyright (): string {} + public function getCopyright () {} } -/** - * The ReflectionReference class provides information about - * a reference. - * @link http://www.php.net/manual/en/class.reflectionreference.php - */ final class ReflectionReference { /** - * Create a ReflectionReference from an array element - * @link http://www.php.net/manual/en/reflectionreference.fromarrayelement.php - * @param array $array The array which contains the potential reference. - * @param int|string $key The key; either an int or a string. - * @return ReflectionReference|null Returns a ReflectionReference instance if - * $array[$key] is a reference, or null otherwise. + * {@inheritdoc} + * @param array $array + * @param string|int $key */ - public static function fromArrayElement (array $array, int|string $key): ?ReflectionReference {} + public static function fromArrayElement (array $array, string|int $key): ?ReflectionReference {} /** - * Get unique ID of a reference - * @link http://www.php.net/manual/en/reflectionreference.getid.php - * @return string Returns a string of unspecified format. + * {@inheritdoc} */ public function getId (): string {} @@ -3007,57 +1974,38 @@ public function getId (): string {} private function __clone (): void {} /** - * Private constructor to disallow direct instantiation - * @link http://www.php.net/manual/en/reflectionreference.construct.php + * {@inheritdoc} */ private function __construct () {} } -/** - * The ReflectionAttribute class provides information about - * an Attribute. - * @link http://www.php.net/manual/en/class.reflectionattribute.php - */ class ReflectionAttribute implements Stringable, Reflector { - /** - * Retrieve attributes using an - * instanceof check. const IS_INSTANCEOF = 2; /** - * Gets attribute name - * @link http://www.php.net/manual/en/reflectionattribute.getname.php - * @return string The name of the attribute. + * {@inheritdoc} */ public function getName (): string {} /** - * Returns the target of the attribute as bitmask - * @link http://www.php.net/manual/en/reflectionattribute.gettarget.php - * @return int Gets target of the attribute as bitmask. + * {@inheritdoc} */ public function getTarget (): int {} /** - * Returns whether the attribute of this name has been repeated on a code element - * @link http://www.php.net/manual/en/reflectionattribute.isrepeated.php - * @return bool Returns true when attribute is used repeatedly, otherwise false. + * {@inheritdoc} */ public function isRepeated (): bool {} /** - * Gets arguments passed to attribute - * @link http://www.php.net/manual/en/reflectionattribute.getarguments.php - * @return array The arguments passed to attribute. + * {@inheritdoc} */ public function getArguments (): array {} /** - * Instantiates the attribute class represented by this ReflectionAttribute class and arguments - * @link http://www.php.net/manual/en/reflectionattribute.newinstance.php - * @return object New instance of the attribute. + * {@inheritdoc} */ public function newInstance (): object {} @@ -3072,18 +2020,12 @@ public function __toString (): string {} private function __clone (): void {} /** - * Private constructor to disallow direct instantiation - * @link http://www.php.net/manual/en/reflectionattribute.construct.php + * {@inheritdoc} */ private function __construct () {} } -/** - * The ReflectionEnum class reports - * information about an Enum. - * @link http://www.php.net/manual/en/class.reflectionenum.php - */ class ReflectionEnum extends ReflectionClass implements Reflector, Stringable { const IS_IMPLICIT_ABSTRACT = 16; const IS_EXPLICIT_ABSTRACT = 64; @@ -3092,414 +2034,287 @@ class ReflectionEnum extends ReflectionClass implements Reflector, Stringable { /** - * Instantiates a ReflectionEnum object - * @link http://www.php.net/manual/en/reflectionenum.construct.php - * @param object|string $objectOrClass An enum instance or a name. - * @return object|string + * {@inheritdoc} + * @param object|string $objectOrClass */ - public function __construct (object|string $objectOrClass): object|string {} + public function __construct (object|string $objectOrClass) {} /** - * Checks for a case on an Enum - * @link http://www.php.net/manual/en/reflectionenum.hascase.php - * @param string $name The case to check for. - * @return bool true if the case is defined, false if not. + * {@inheritdoc} + * @param string $name */ public function hasCase (string $name): bool {} /** - * Returns a specific case of an Enum - * @link http://www.php.net/manual/en/reflectionenum.getcase.php - * @param string $name The name of the case to retrieve. - * @return ReflectionEnumUnitCase An instance of ReflectionEnumUnitCase - * or ReflectionEnumBackedCase, as appropriate. + * {@inheritdoc} + * @param string $name */ public function getCase (string $name): ReflectionEnumUnitCase {} /** - * Returns a list of all cases on an Enum - * @link http://www.php.net/manual/en/reflectionenum.getcases.php - * @return array An array of Enum reflection objects, one for each case in the Enum. For a Unit Enum, - * they will all be instances of ReflectionEnumUnitCase. For a Backed - * Enum, they will all be instances of ReflectionEnumBackedCase. + * {@inheritdoc} */ public function getCases (): array {} /** - * Determines if an Enum is a Backed Enum - * @link http://www.php.net/manual/en/reflectionenum.isbacked.php - * @return bool true if the Enum has a backing scalar, false if not. + * {@inheritdoc} */ public function isBacked (): bool {} /** - * Gets the backing type of an Enum, if any - * @link http://www.php.net/manual/en/reflectionenum.getbackingtype.php - * @return ReflectionNamedType|null An instance of ReflectionNamedType, or null - * if the Enum has no backing type. + * {@inheritdoc} */ public function getBackingType (): ?ReflectionNamedType {} /** - * Returns the string representation of the ReflectionClass object - * @link http://www.php.net/manual/en/reflectionclass.tostring.php - * @return string A string representation of this ReflectionClass instance. + * {@inheritdoc} */ public function __toString (): string {} /** - * Gets class name - * @link http://www.php.net/manual/en/reflectionclass.getname.php - * @return string The class name. + * {@inheritdoc} */ - public function getName (): string {} + public function getName () {} /** - * Checks if class is defined internally by an extension, or the core - * @link http://www.php.net/manual/en/reflectionclass.isinternal.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function isInternal (): bool {} + public function isInternal () {} /** - * Checks if user defined - * @link http://www.php.net/manual/en/reflectionclass.isuserdefined.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function isUserDefined (): bool {} + public function isUserDefined () {} /** - * Checks if class is anonymous - * @link http://www.php.net/manual/en/reflectionclass.isanonymous.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function isAnonymous (): bool {} + public function isAnonymous () {} /** - * Checks if the class is instantiable - * @link http://www.php.net/manual/en/reflectionclass.isinstantiable.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function isInstantiable (): bool {} + public function isInstantiable () {} /** - * Returns whether this class is cloneable - * @link http://www.php.net/manual/en/reflectionclass.iscloneable.php - * @return bool Returns true if the class is cloneable, false otherwise. + * {@inheritdoc} */ - public function isCloneable (): bool {} + public function isCloneable () {} /** - * Gets the filename of the file in which the class has been defined - * @link http://www.php.net/manual/en/reflectionclass.getfilename.php - * @return string|false Returns the filename of the file in which the class has been defined. - * If the class is defined in the PHP core or in a PHP extension, false - * is returned. + * {@inheritdoc} */ - public function getFileName (): string|false {} + public function getFileName () {} /** - * Gets starting line number - * @link http://www.php.net/manual/en/reflectionclass.getstartline.php - * @return int|false The starting line number, as an int, or false if unknown. + * {@inheritdoc} */ - public function getStartLine (): int|false {} + public function getStartLine () {} /** - * Gets end line - * @link http://www.php.net/manual/en/reflectionclass.getendline.php - * @return int|false The ending line number of the user defined class, or false if unknown. + * {@inheritdoc} */ - public function getEndLine (): int|false {} + public function getEndLine () {} /** - * Gets doc comments - * @link http://www.php.net/manual/en/reflectionclass.getdoccomment.php - * @return string|false The doc comment if it exists, otherwise false. + * {@inheritdoc} */ - public function getDocComment (): string|false {} + public function getDocComment () {} /** - * Gets the constructor of the class - * @link http://www.php.net/manual/en/reflectionclass.getconstructor.php - * @return ReflectionMethod|null A ReflectionMethod object reflecting the class' constructor, or null if the class - * has no constructor. + * {@inheritdoc} */ - public function getConstructor (): ?ReflectionMethod {} + public function getConstructor () {} /** - * Checks if method is defined - * @link http://www.php.net/manual/en/reflectionclass.hasmethod.php - * @param string $name - * @return bool true if it has the method, otherwise false + * {@inheritdoc} + * @param string $name */ - public function hasMethod (string $name): bool {} + public function hasMethod (string $name) {} /** - * Gets a ReflectionMethod for a class method - * @link http://www.php.net/manual/en/reflectionclass.getmethod.php - * @param string $name - * @return ReflectionMethod A ReflectionMethod. + * {@inheritdoc} + * @param string $name */ - public function getMethod (string $name): ReflectionMethod {} + public function getMethod (string $name) {} /** - * Gets an array of methods - * @link http://www.php.net/manual/en/reflectionclass.getmethods.php - * @param int|null $filter [optional] - * @return array An array of ReflectionMethod objects - * reflecting each method. + * {@inheritdoc} + * @param int|null $filter [optional] */ - public function getMethods (?int $filter = null): array {} + public function getMethods (?int $filter = NULL) {} /** - * Checks if property is defined - * @link http://www.php.net/manual/en/reflectionclass.hasproperty.php - * @param string $name - * @return bool true if it has the property, otherwise false + * {@inheritdoc} + * @param string $name */ - public function hasProperty (string $name): bool {} + public function hasProperty (string $name) {} /** - * Gets a ReflectionProperty for a class's property - * @link http://www.php.net/manual/en/reflectionclass.getproperty.php - * @param string $name - * @return ReflectionProperty A ReflectionProperty. + * {@inheritdoc} + * @param string $name */ - public function getProperty (string $name): ReflectionProperty {} + public function getProperty (string $name) {} /** - * Gets properties - * @link http://www.php.net/manual/en/reflectionclass.getproperties.php - * @param int|null $filter [optional] - * @return array An array of ReflectionProperty objects. + * {@inheritdoc} + * @param int|null $filter [optional] */ - public function getProperties (?int $filter = null): array {} + public function getProperties (?int $filter = NULL) {} /** - * Checks if constant is defined - * @link http://www.php.net/manual/en/reflectionclass.hasconstant.php - * @param string $name - * @return bool true if the constant is defined, otherwise false. + * {@inheritdoc} + * @param string $name */ - public function hasConstant (string $name): bool {} + public function hasConstant (string $name) {} /** - * Gets constants - * @link http://www.php.net/manual/en/reflectionclass.getconstants.php - * @param int|null $filter [optional] The optional filter, for filtering desired constant visibilities. It's configured using - * the ReflectionClassConstant constants, - * and defaults to all constant visibilities. - * @return array An array of constants, where the keys hold the name - * and the values the value of the constants. + * {@inheritdoc} + * @param int|null $filter [optional] */ - public function getConstants (?int $filter = null): array {} + public function getConstants (?int $filter = NULL) {} /** - * Gets class constants - * @link http://www.php.net/manual/en/reflectionclass.getreflectionconstants.php - * @param int|null $filter [optional] The optional filter, for filtering desired constant visibilities. It's configured using - * the ReflectionClassConstant constants, - * and defaults to all constant visibilities. - * @return array An array of ReflectionClassConstant objects. + * {@inheritdoc} + * @param int|null $filter [optional] */ - public function getReflectionConstants (?int $filter = null): array {} + public function getReflectionConstants (?int $filter = NULL) {} /** - * Gets defined constant - * @link http://www.php.net/manual/en/reflectionclass.getconstant.php - * @param string $name - * @return mixed Value of the constant with the name name. - * Returns false if the constant was not found in the class. + * {@inheritdoc} + * @param string $name */ - public function getConstant (string $name): mixed {} + public function getConstant (string $name) {} /** - * Gets a ReflectionClassConstant for a class's constant - * @link http://www.php.net/manual/en/reflectionclass.getreflectionconstant.php - * @param string $name - * @return ReflectionClassConstant|false A ReflectionClassConstant, or false on failure. + * {@inheritdoc} + * @param string $name */ - public function getReflectionConstant (string $name): ReflectionClassConstant|false {} + public function getReflectionConstant (string $name) {} /** - * Gets the interfaces - * @link http://www.php.net/manual/en/reflectionclass.getinterfaces.php - * @return array An associative array of interfaces, with keys as interface - * names and the array values as ReflectionClass objects. + * {@inheritdoc} */ - public function getInterfaces (): array {} + public function getInterfaces () {} /** - * Gets the interface names - * @link http://www.php.net/manual/en/reflectionclass.getinterfacenames.php - * @return array A numerical array with interface names as the values. + * {@inheritdoc} */ - public function getInterfaceNames (): array {} + public function getInterfaceNames () {} /** - * Checks if the class is an interface - * @link http://www.php.net/manual/en/reflectionclass.isinterface.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function isInterface (): bool {} + public function isInterface () {} /** - * Returns an array of traits used by this class - * @link http://www.php.net/manual/en/reflectionclass.gettraits.php - * @return array Returns an array with trait names in keys and instances of trait's - * ReflectionClass in values. - * Returns null in case of an error. + * {@inheritdoc} */ - public function getTraits (): array {} + public function getTraits () {} /** - * Returns an array of names of traits used by this class - * @link http://www.php.net/manual/en/reflectionclass.gettraitnames.php - * @return array Returns an array with trait names in values. + * {@inheritdoc} */ - public function getTraitNames (): array {} + public function getTraitNames () {} /** - * Returns an array of trait aliases - * @link http://www.php.net/manual/en/reflectionclass.gettraitaliases.php - * @return array Returns an array with new method names in keys and original names (in the - * format "TraitName::original") in values. + * {@inheritdoc} */ - public function getTraitAliases (): array {} + public function getTraitAliases () {} /** - * Returns whether this is a trait - * @link http://www.php.net/manual/en/reflectionclass.istrait.php - * @return bool Returns true if this is a trait, false otherwise. - * Returns null in case of an error. + * {@inheritdoc} */ - public function isTrait (): bool {} + public function isTrait () {} /** - * Returns whether this is an enum - * @link http://www.php.net/manual/en/reflectionclass.isenum.php - * @return bool Returns true if this is an enum, false otherwise. + * {@inheritdoc} */ public function isEnum (): bool {} /** - * Checks if class is abstract - * @link http://www.php.net/manual/en/reflectionclass.isabstract.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function isAbstract (): bool {} + public function isAbstract () {} /** - * Checks if class is final - * @link http://www.php.net/manual/en/reflectionclass.isfinal.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function isFinal (): bool {} + public function isFinal () {} /** - * Checks if class is readonly - * @link http://www.php.net/manual/en/reflectionclass.isreadonly.php - * @return bool true if a class is readonly, false otherwise. + * {@inheritdoc} */ public function isReadOnly (): bool {} /** - * Gets the class modifiers - * @link http://www.php.net/manual/en/reflectionclass.getmodifiers.php - * @return int Returns bitmask of - * modifier constants. + * {@inheritdoc} */ - public function getModifiers (): int {} + public function getModifiers () {} /** - * Checks class for instance - * @link http://www.php.net/manual/en/reflectionclass.isinstance.php - * @param object $object - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param object $object */ - public function isInstance (object $object): bool {} + public function isInstance (object $object) {} /** - * Creates a new class instance from given arguments - * @link http://www.php.net/manual/en/reflectionclass.newinstance.php - * @param mixed $args - * @return object + * {@inheritdoc} + * @param mixed $args [optional] */ - public function newInstance (mixed ...$args): object {} + public function newInstance (mixed ...$args) {} /** - * Creates a new class instance without invoking the constructor - * @link http://www.php.net/manual/en/reflectionclass.newinstancewithoutconstructor.php - * @return object + * {@inheritdoc} */ - public function newInstanceWithoutConstructor (): object {} + public function newInstanceWithoutConstructor () {} /** - * Creates a new class instance from given arguments - * @link http://www.php.net/manual/en/reflectionclass.newinstanceargs.php - * @param array $args [optional] - * @return object|null Returns a new instance of the class, or null on failure. + * {@inheritdoc} + * @param array $args [optional] */ - public function newInstanceArgs (array $args = '[]'): ?object {} + public function newInstanceArgs (array $args = array ( +)) {} /** - * Gets parent class - * @link http://www.php.net/manual/en/reflectionclass.getparentclass.php - * @return ReflectionClass|false A ReflectionClass or false if there's no parent. + * {@inheritdoc} */ - public function getParentClass (): ReflectionClass|false {} + public function getParentClass () {} /** - * Checks if a subclass - * @link http://www.php.net/manual/en/reflectionclass.issubclassof.php - * @param ReflectionClass|string $class - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param ReflectionClass|string $class */ - public function isSubclassOf (ReflectionClass|string $class): bool {} + public function isSubclassOf (ReflectionClass|string $class) {} /** - * Gets static properties - * @link http://www.php.net/manual/en/reflectionclass.getstaticproperties.php - * @return array|null The static properties, as an array, or null on failure. + * {@inheritdoc} */ - public function getStaticProperties (): ?array {} + public function getStaticProperties () {} /** - * Gets static property value - * @link http://www.php.net/manual/en/reflectionclass.getstaticpropertyvalue.php - * @param string $name - * @param mixed $def_value [optional] - * @return mixed The value of the static property. + * {@inheritdoc} + * @param string $name + * @param mixed $default [optional] */ - public function getStaticPropertyValue (string $name, mixed &$def_value = null): mixed {} + public function getStaticPropertyValue (string $name, mixed $default = NULL) {} /** - * Sets static property value - * @link http://www.php.net/manual/en/reflectionclass.setstaticpropertyvalue.php - * @param string $name - * @param mixed $value - * @return void No value is returned. + * {@inheritdoc} + * @param string $name + * @param mixed $value */ - public function setStaticPropertyValue (string $name, mixed $value): void {} + public function setStaticPropertyValue (string $name, mixed $value = null) {} /** - * Gets default properties - * @link http://www.php.net/manual/en/reflectionclass.getdefaultproperties.php - * @return array An array of default properties, with the key being the name of - * the property and the value being the default value of the property or null - * if the property doesn't have a default value. The function does not distinguish - * between static and non static properties and does not take visibility modifiers - * into account. + * {@inheritdoc} */ - public function getDefaultProperties (): array {} + public function getDefaultProperties () {} /** - * Check whether this class is iterable - * @link http://www.php.net/manual/en/reflectionclass.isiterable.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function isIterable (): bool {} + public function isIterable () {} /** * {@inheritdoc} @@ -3507,71 +2322,45 @@ public function isIterable (): bool {} public function isIterateable () {} /** - * Implements interface - * @link http://www.php.net/manual/en/reflectionclass.implementsinterface.php - * @param ReflectionClass|string $interface - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param ReflectionClass|string $interface */ - public function implementsInterface (ReflectionClass|string $interface): bool {} + public function implementsInterface (ReflectionClass|string $interface) {} /** - * Gets a ReflectionExtension object for the extension which defined the class - * @link http://www.php.net/manual/en/reflectionclass.getextension.php - * @return ReflectionExtension|null A ReflectionExtension object representing the extension which defined the class, - * or null for user-defined classes. + * {@inheritdoc} */ - public function getExtension (): ?ReflectionExtension {} + public function getExtension () {} /** - * Gets the name of the extension which defined the class - * @link http://www.php.net/manual/en/reflectionclass.getextensionname.php - * @return string|false The name of the extension which defined the class, or false for user-defined classes. + * {@inheritdoc} */ - public function getExtensionName (): string|false {} + public function getExtensionName () {} /** - * Checks if in namespace - * @link http://www.php.net/manual/en/reflectionclass.innamespace.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function inNamespace (): bool {} + public function inNamespace () {} /** - * Gets namespace name - * @link http://www.php.net/manual/en/reflectionclass.getnamespacename.php - * @return string The namespace name. + * {@inheritdoc} */ - public function getNamespaceName (): string {} + public function getNamespaceName () {} /** - * Gets short name - * @link http://www.php.net/manual/en/reflectionclass.getshortname.php - * @return string The class short name. + * {@inheritdoc} */ - public function getShortName (): string {} + public function getShortName () {} /** - * Gets Attributes - * @link http://www.php.net/manual/en/reflectionclass.getattributes.php - * @param string|null $name [optional] Filter the results to include only ReflectionAttribute - * instances for attributes matching this class name. - * @param int $flags [optional] Flags for determining how to filter the results, if name - * is provided. - *Default is 0 which will only return results for attributes that - * are of the class name.
- *The only other option available, is to use ReflectionAttribute::IS_INSTANCEOF, - * which will instead use instanceof for filtering.
- * @return array Array of attributes, as a ReflectionAttribute object. + * {@inheritdoc} + * @param string|null $name [optional] + * @param int $flags [optional] */ - public function getAttributes (?string $name = null, int $flags = null): array {} + public function getAttributes (?string $name = NULL, int $flags = 0): array {} } -/** - * The ReflectionEnumUnitCase class reports - * information about an Enum unit case, which has no scalar equivalent. - * @link http://www.php.net/manual/en/class.reflectionenumunitcase.php - */ class ReflectionEnumUnitCase extends ReflectionClassConstant implements Reflector, Stringable { const IS_PUBLIC = 1; const IS_PROTECTED = 2; @@ -3580,123 +2369,91 @@ class ReflectionEnumUnitCase extends ReflectionClassConstant implements Reflecto /** - * Instantiates a ReflectionEnumUnitCase object - * @link http://www.php.net/manual/en/reflectionenumunitcase.construct.php - * @param object|string $class An enum instance or a name. - * @param string $constant An enum constant name. - * @return object|string + * {@inheritdoc} + * @param object|string $class + * @param string $constant */ - public function __construct (object|string $class, string $constant): object|string {} + public function __construct (object|string $class, string $constant) {} /** - * Gets the reflection of the enum of this case - * @link http://www.php.net/manual/en/reflectionenumunitcase.getenum.php - * @return ReflectionEnum A ReflectionEnum instance describing the Enum - * this case belongs to. + * {@inheritdoc} */ public function getEnum (): ReflectionEnum {} /** - * Gets the enum case object described by this reflection object - * @link http://www.php.net/manual/en/reflectionenumunitcase.getvalue.php - * @return UnitEnum The enum case object described by this reflection object. + * {@inheritdoc} */ public function getValue (): UnitEnum {} /** - * Returns the string representation of the ReflectionClassConstant object - * @link http://www.php.net/manual/en/reflectionclassconstant.tostring.php - * @return string A string representation of this ReflectionClassConstant instance. + * {@inheritdoc} */ public function __toString (): string {} /** - * Get name of the constant - * @link http://www.php.net/manual/en/reflectionclassconstant.getname.php - * @return string Returns the constant's name. + * {@inheritdoc} */ - public function getName (): string {} + public function getName () {} /** - * Checks if class constant is public - * @link http://www.php.net/manual/en/reflectionclassconstant.ispublic.php - * @return bool true if the class constant is public, otherwise false + * {@inheritdoc} */ - public function isPublic (): bool {} + public function isPublic () {} /** - * Checks if class constant is private - * @link http://www.php.net/manual/en/reflectionclassconstant.isprivate.php - * @return bool true if the class constant is private, otherwise false + * {@inheritdoc} */ - public function isPrivate (): bool {} + public function isPrivate () {} /** - * Checks if class constant is protected - * @link http://www.php.net/manual/en/reflectionclassconstant.isprotected.php - * @return bool true if the class constant is protected, otherwise false + * {@inheritdoc} */ - public function isProtected (): bool {} + public function isProtected () {} /** - * Checks if class constant is final - * @link http://www.php.net/manual/en/reflectionclassconstant.isfinal.php - * @return bool true if the class constant is final, otherwise false + * {@inheritdoc} */ public function isFinal (): bool {} /** - * Gets the class constant modifiers - * @link http://www.php.net/manual/en/reflectionclassconstant.getmodifiers.php - * @return int A numeric representation of the modifiers. - * The actual meaning of these modifiers are described under - * predefined constants. + * {@inheritdoc} */ - public function getModifiers (): int {} + public function getModifiers () {} /** - * Gets declaring class - * @link http://www.php.net/manual/en/reflectionclassconstant.getdeclaringclass.php - * @return ReflectionClass A ReflectionClass object. + * {@inheritdoc} */ - public function getDeclaringClass (): ReflectionClass {} + public function getDeclaringClass () {} /** - * Gets doc comments - * @link http://www.php.net/manual/en/reflectionclassconstant.getdoccomment.php - * @return string|false The doc comment if it exists, otherwise false + * {@inheritdoc} */ - public function getDocComment (): string|false {} + public function getDocComment () {} /** - * Gets Attributes - * @link http://www.php.net/manual/en/reflectionclassconstant.getattributes.php - * @param string|null $name [optional] Filter the results to include only ReflectionAttribute - * instances for attributes matching this class name. - * @param int $flags [optional] Flags for determining how to filter the results, if name - * is provided. - *Default is 0 which will only return results for attributes that - * are of the class name.
- *The only other option available, is to use ReflectionAttribute::IS_INSTANCEOF, - * which will instead use instanceof for filtering.
- * @return array Array of attributes, as a ReflectionAttribute object. + * {@inheritdoc} + * @param string|null $name [optional] + * @param int $flags [optional] */ - public function getAttributes (?string $name = null, int $flags = null): array {} + public function getAttributes (?string $name = NULL, int $flags = 0): array {} /** - * Checks if class constant is an Enum case - * @link http://www.php.net/manual/en/reflectionclassconstant.isenumcase.php - * @return bool true if the class constant is an Enum case; false otherwise. + * {@inheritdoc} */ public function isEnumCase (): bool {} + /** + * {@inheritdoc} + */ + public function hasType (): bool {} + + /** + * {@inheritdoc} + */ + public function getType (): ?ReflectionType {} + } -/** - * The ReflectionEnumBackedCase class reports - * information about an Enum backed case, which has a scalar equivalent. - * @link http://www.php.net/manual/en/class.reflectionenumbackedcase.php - */ class ReflectionEnumBackedCase extends ReflectionEnumUnitCase implements Stringable, Reflector { const IS_PUBLIC = 1; const IS_PROTECTED = 2; @@ -3705,173 +2462,129 @@ class ReflectionEnumBackedCase extends ReflectionEnumUnitCase implements Stringa /** - * Instantiates a ReflectionEnumBackedCase object - * @link http://www.php.net/manual/en/reflectionenumbackedcase.construct.php - * @param object|string $class An enum instance or a name. - * @param string $constant An enum constant name. - * @return object|string + * {@inheritdoc} + * @param object|string $class + * @param string $constant */ - public function __construct (object|string $class, string $constant): object|string {} + public function __construct (object|string $class, string $constant) {} /** - * Gets the scalar value backing this Enum case - * @link http://www.php.net/manual/en/reflectionenumbackedcase.getbackingvalue.php - * @return int|string The scalar equivalent of this enum case. + * {@inheritdoc} */ - public function getBackingValue (): int|string {} + public function getBackingValue (): string|int {} /** - * Gets the reflection of the enum of this case - * @link http://www.php.net/manual/en/reflectionenumunitcase.getenum.php - * @return ReflectionEnum A ReflectionEnum instance describing the Enum - * this case belongs to. + * {@inheritdoc} */ public function getEnum (): ReflectionEnum {} /** - * Gets the enum case object described by this reflection object - * @link http://www.php.net/manual/en/reflectionenumunitcase.getvalue.php - * @return UnitEnum The enum case object described by this reflection object. + * {@inheritdoc} */ public function getValue (): UnitEnum {} /** - * Returns the string representation of the ReflectionClassConstant object - * @link http://www.php.net/manual/en/reflectionclassconstant.tostring.php - * @return string A string representation of this ReflectionClassConstant instance. + * {@inheritdoc} */ public function __toString (): string {} /** - * Get name of the constant - * @link http://www.php.net/manual/en/reflectionclassconstant.getname.php - * @return string Returns the constant's name. + * {@inheritdoc} */ - public function getName (): string {} + public function getName () {} /** - * Checks if class constant is public - * @link http://www.php.net/manual/en/reflectionclassconstant.ispublic.php - * @return bool true if the class constant is public, otherwise false + * {@inheritdoc} */ - public function isPublic (): bool {} + public function isPublic () {} /** - * Checks if class constant is private - * @link http://www.php.net/manual/en/reflectionclassconstant.isprivate.php - * @return bool true if the class constant is private, otherwise false + * {@inheritdoc} */ - public function isPrivate (): bool {} + public function isPrivate () {} /** - * Checks if class constant is protected - * @link http://www.php.net/manual/en/reflectionclassconstant.isprotected.php - * @return bool true if the class constant is protected, otherwise false + * {@inheritdoc} */ - public function isProtected (): bool {} + public function isProtected () {} /** - * Checks if class constant is final - * @link http://www.php.net/manual/en/reflectionclassconstant.isfinal.php - * @return bool true if the class constant is final, otherwise false + * {@inheritdoc} */ public function isFinal (): bool {} /** - * Gets the class constant modifiers - * @link http://www.php.net/manual/en/reflectionclassconstant.getmodifiers.php - * @return int A numeric representation of the modifiers. - * The actual meaning of these modifiers are described under - * predefined constants. + * {@inheritdoc} */ - public function getModifiers (): int {} + public function getModifiers () {} /** - * Gets declaring class - * @link http://www.php.net/manual/en/reflectionclassconstant.getdeclaringclass.php - * @return ReflectionClass A ReflectionClass object. + * {@inheritdoc} */ - public function getDeclaringClass (): ReflectionClass {} + public function getDeclaringClass () {} /** - * Gets doc comments - * @link http://www.php.net/manual/en/reflectionclassconstant.getdoccomment.php - * @return string|false The doc comment if it exists, otherwise false + * {@inheritdoc} */ - public function getDocComment (): string|false {} + public function getDocComment () {} /** - * Gets Attributes - * @link http://www.php.net/manual/en/reflectionclassconstant.getattributes.php - * @param string|null $name [optional] Filter the results to include only ReflectionAttribute - * instances for attributes matching this class name. - * @param int $flags [optional] Flags for determining how to filter the results, if name - * is provided. - *Default is 0 which will only return results for attributes that - * are of the class name.
- *The only other option available, is to use ReflectionAttribute::IS_INSTANCEOF, - * which will instead use instanceof for filtering.
- * @return array Array of attributes, as a ReflectionAttribute object. + * {@inheritdoc} + * @param string|null $name [optional] + * @param int $flags [optional] */ - public function getAttributes (?string $name = null, int $flags = null): array {} + public function getAttributes (?string $name = NULL, int $flags = 0): array {} /** - * Checks if class constant is an Enum case - * @link http://www.php.net/manual/en/reflectionclassconstant.isenumcase.php - * @return bool true if the class constant is an Enum case; false otherwise. + * {@inheritdoc} */ public function isEnumCase (): bool {} + /** + * {@inheritdoc} + */ + public function hasType (): bool {} + + /** + * {@inheritdoc} + */ + public function getType (): ?ReflectionType {} + } -/** - * @link http://www.php.net/manual/en/class.reflectionfiber.php - */ final class ReflectionFiber { /** - * Constructs a ReflectionFiber object - * @link http://www.php.net/manual/en/reflectionfiber.construct.php - * @param Fiber $fiber The Fiber to reflect. - * @return Fiber + * {@inheritdoc} + * @param Fiber $fiber */ - public function __construct (Fiber $fiber): Fiber {} + public function __construct (Fiber $fiber) {} /** - * Get the reflected Fiber instance - * @link http://www.php.net/manual/en/reflectionfiber.getfiber.php - * @return Fiber The Fiber instance being reflected. + * {@inheritdoc} */ public function getFiber (): Fiber {} /** - * Get the file name of the current execution point - * @link http://www.php.net/manual/en/reflectionfiber.getexecutingfile.php - * @return string The full path and file name of the reflected fiber. + * {@inheritdoc} */ - public function getExecutingFile (): string {} + public function getExecutingFile (): ?string {} /** - * Get the line number of the current execution point - * @link http://www.php.net/manual/en/reflectionfiber.getexecutingline.php - * @return int The line number of the current execution point in the fiber. + * {@inheritdoc} */ - public function getExecutingLine (): int {} + public function getExecutingLine (): ?int {} /** - * Gets the callable used to create the Fiber - * @link http://www.php.net/manual/en/reflectionfiber.getcallable.php - * @return callable The callable used to create the Fiber. + * {@inheritdoc} */ public function getCallable (): callable {} /** - * Get the backtrace of the current execution point - * @link http://www.php.net/manual/en/reflectionfiber.gettrace.php - * @param int $options [optional] - * @return array The backtrace of the current execution point in the fiber. + * {@inheritdoc} + * @param int $options [optional] */ - public function getTrace (int $options = DEBUG_BACKTRACE_PROVIDE_OBJECT): array {} + public function getTrace (int $options = 1): array {} } -// End of Reflection v.8.2.6 +// End of Reflection v.8.3.0 diff --git a/plugins/org.eclipse.php.core/Resources/language/php8.3/SPL.php b/plugins/org.eclipse.php.core/Resources/language/php8.3/SPL.php index ae58f4978a..8b59f06cdb 100644 --- a/plugins/org.eclipse.php.core/Resources/language/php8.3/SPL.php +++ b/plugins/org.eclipse.php.core/Resources/language/php8.3/SPL.php @@ -1,23 +1,16 @@ May be any valid callable value. - * @return Iterator + * {@inheritdoc} + * @param Iterator $iterator + * @param callable $callback */ - public function __construct (Iterator $iterator, callable $callback): Iterator {} + public function __construct (Iterator $iterator, callable $callback) {} /** - * Calls the callback with the current value, the current key and the inner iterator as arguments - * @link http://www.php.net/manual/en/callbackfilteriterator.accept.php - * @return bool Returns true to accept the current item, or false otherwise. + * {@inheritdoc} */ - public function accept (): bool {} + public function accept () {} /** - * Rewind the iterator - * @link http://www.php.net/manual/en/filteriterator.rewind.php - * @return void No value is returned. + * {@inheritdoc} */ - public function rewind (): void {} + public function rewind () {} /** - * Move the iterator forward - * @link http://www.php.net/manual/en/filteriterator.next.php - * @return void No value is returned. + * {@inheritdoc} */ - public function next (): void {} + public function next () {} /** - * Get the inner iterator - * @link http://www.php.net/manual/en/iteratoriterator.getinneriterator.php - * @return Iterator|null The inner iterator as passed to IteratorIterator::__construct, or null when there is no inner iterator. + * {@inheritdoc} */ - public function getInnerIterator (): ?Iterator {} + public function getInnerIterator () {} /** - * Checks if the iterator is valid - * @link http://www.php.net/manual/en/iteratoriterator.valid.php - * @return bool Returns true if the iterator is valid, otherwise false + * {@inheritdoc} */ - public function valid (): bool {} + public function valid () {} /** - * Get the key of the current element - * @link http://www.php.net/manual/en/iteratoriterator.key.php - * @return mixed The key of the current element. + * {@inheritdoc} */ - public function key (): mixed {} + public function key () {} /** - * Get the current value - * @link http://www.php.net/manual/en/iteratoriterator.current.php - * @return mixed The value of the current element. + * {@inheritdoc} */ - public function current (): mixed {} + public function current () {} } -/** - * @link http://www.php.net/manual/en/class.recursivecallbackfilteriterator.php - */ class RecursiveCallbackFilterIterator extends CallbackFilterIterator implements Iterator, Traversable, OuterIterator, RecursiveIterator { /** - * Create a RecursiveCallbackFilterIterator from a RecursiveIterator - * @link http://www.php.net/manual/en/recursivecallbackfilteriterator.construct.php - * @param RecursiveIterator $iterator The recursive iterator to be filtered. - * @param callable $callback The callback, which should return true to accept the current item - * or false otherwise. - * See Examples. - *May be any valid callable value.
- * @return RecursiveIterator + * {@inheritdoc} + * @param RecursiveIterator $iterator + * @param callable $callback */ - public function __construct (RecursiveIterator $iterator, callable $callback): RecursiveIterator {} + public function __construct (RecursiveIterator $iterator, callable $callback) {} /** - * Check whether the inner iterator's current element has children - * @link http://www.php.net/manual/en/recursivecallbackfilteriterator.haschildren.php - * @return bool Returns true if the current element has children, false otherwise. + * {@inheritdoc} */ - public function hasChildren (): bool {} + public function hasChildren () {} /** - * Return the inner iterator's children contained in a RecursiveCallbackFilterIterator - * @link http://www.php.net/manual/en/recursivecallbackfilteriterator.getchildren.php - * @return RecursiveCallbackFilterIterator Returns a RecursiveCallbackFilterIterator containing - * the children. + * {@inheritdoc} */ - public function getChildren (): RecursiveCallbackFilterIterator {} + public function getChildren () {} /** - * Calls the callback with the current value, the current key and the inner iterator as arguments - * @link http://www.php.net/manual/en/callbackfilteriterator.accept.php - * @return bool Returns true to accept the current item, or false otherwise. + * {@inheritdoc} */ - public function accept (): bool {} + public function accept () {} /** - * Rewind the iterator - * @link http://www.php.net/manual/en/filteriterator.rewind.php - * @return void No value is returned. + * {@inheritdoc} */ - public function rewind (): void {} + public function rewind () {} /** - * Move the iterator forward - * @link http://www.php.net/manual/en/filteriterator.next.php - * @return void No value is returned. + * {@inheritdoc} */ - public function next (): void {} + public function next () {} /** - * Get the inner iterator - * @link http://www.php.net/manual/en/iteratoriterator.getinneriterator.php - * @return Iterator|null The inner iterator as passed to IteratorIterator::__construct, or null when there is no inner iterator. + * {@inheritdoc} */ - public function getInnerIterator (): ?Iterator {} + public function getInnerIterator () {} /** - * Checks if the iterator is valid - * @link http://www.php.net/manual/en/iteratoriterator.valid.php - * @return bool Returns true if the iterator is valid, otherwise false + * {@inheritdoc} */ - public function valid (): bool {} + public function valid () {} /** - * Get the key of the current element - * @link http://www.php.net/manual/en/iteratoriterator.key.php - * @return mixed The key of the current element. + * {@inheritdoc} */ - public function key (): mixed {} + public function key () {} /** - * Get the current value - * @link http://www.php.net/manual/en/iteratoriterator.current.php - * @return mixed The value of the current element. + * {@inheritdoc} */ - public function current (): mixed {} + public function current () {} } -/** - * This extended FilterIterator allows a recursive - * iteration using RecursiveIteratorIterator that only - * shows those elements which have children. - * @link http://www.php.net/manual/en/class.parentiterator.php - */ class ParentIterator extends RecursiveFilterIterator implements RecursiveIterator, Iterator, Traversable, OuterIterator { /** - * Constructs a ParentIterator - * @link http://www.php.net/manual/en/parentiterator.construct.php - * @param RecursiveIterator $iterator - * @return RecursiveIterator + * {@inheritdoc} + * @param RecursiveIterator $iterator */ - public function __construct (RecursiveIterator $iterator): RecursiveIterator {} + public function __construct (RecursiveIterator $iterator) {} /** - * Determines acceptability - * @link http://www.php.net/manual/en/parentiterator.accept.php - * @return bool true if the current element is acceptable, otherwise false. + * {@inheritdoc} */ - public function accept (): bool {} + public function accept () {} /** - * Check whether the inner iterator's current element has children - * @link http://www.php.net/manual/en/recursivefilteriterator.haschildren.php - * @return bool true if the inner iterator has children, otherwise false + * {@inheritdoc} */ - public function hasChildren (): bool {} + public function hasChildren () {} /** - * Return the inner iterator's children contained in a RecursiveFilterIterator - * @link http://www.php.net/manual/en/recursivefilteriterator.getchildren.php - * @return RecursiveFilterIterator|null Returns a RecursiveFilterIterator containing the inner iterator's children. + * {@inheritdoc} */ - public function getChildren (): ?RecursiveFilterIterator {} + public function getChildren () {} /** - * Rewind the iterator - * @link http://www.php.net/manual/en/filteriterator.rewind.php - * @return void No value is returned. + * {@inheritdoc} */ - public function rewind (): void {} + public function rewind () {} /** - * Move the iterator forward - * @link http://www.php.net/manual/en/filteriterator.next.php - * @return void No value is returned. + * {@inheritdoc} */ - public function next (): void {} + public function next () {} /** - * Get the inner iterator - * @link http://www.php.net/manual/en/iteratoriterator.getinneriterator.php - * @return Iterator|null The inner iterator as passed to IteratorIterator::__construct, or null when there is no inner iterator. + * {@inheritdoc} */ - public function getInnerIterator (): ?Iterator {} + public function getInnerIterator () {} /** - * Checks if the iterator is valid - * @link http://www.php.net/manual/en/iteratoriterator.valid.php - * @return bool Returns true if the iterator is valid, otherwise false + * {@inheritdoc} */ - public function valid (): bool {} + public function valid () {} /** - * Get the key of the current element - * @link http://www.php.net/manual/en/iteratoriterator.key.php - * @return mixed The key of the current element. + * {@inheritdoc} */ - public function key (): mixed {} + public function key () {} /** - * Get the current value - * @link http://www.php.net/manual/en/iteratoriterator.current.php - * @return mixed The value of the current element. + * {@inheritdoc} */ - public function current (): mixed {} + public function current () {} } -/** - * The Seekable iterator. - * @link http://www.php.net/manual/en/class.seekableiterator.php - */ interface SeekableIterator extends Iterator, Traversable { /** - * Seeks to a position - * @link http://www.php.net/manual/en/seekableiterator.seek.php - * @param int $offset - * @return void No value is returned. + * {@inheritdoc} + * @param int $offset */ - abstract public function seek (int $offset): void; + abstract public function seek (int $offset); /** - * Return the current element - * @link http://www.php.net/manual/en/iterator.current.php - * @return mixed Can return any type. + * {@inheritdoc} */ - abstract public function current (): mixed; + abstract public function current (); /** - * Move forward to next element - * @link http://www.php.net/manual/en/iterator.next.php - * @return void Any returned value is ignored. + * {@inheritdoc} */ - abstract public function next (): void; + abstract public function next (); /** - * Return the key of the current element - * @link http://www.php.net/manual/en/iterator.key.php - * @return mixed Returns scalar on success, or null on failure. + * {@inheritdoc} */ - abstract public function key (): mixed; + abstract public function key (); /** - * Checks if current position is valid - * @link http://www.php.net/manual/en/iterator.valid.php - * @return bool The return value will be casted to bool and then evaluated. - * Returns true on success or false on failure. + * {@inheritdoc} */ - abstract public function valid (): bool; + abstract public function valid (); /** - * Rewind the Iterator to the first element - * @link http://www.php.net/manual/en/iterator.rewind.php - * @return void Any returned value is ignored. + * {@inheritdoc} */ - abstract public function rewind (): void; + abstract public function rewind (); } -/** - * The LimitIterator class allows iteration over - * a limited subset of items in an Iterator. - * @link http://www.php.net/manual/en/class.limititerator.php - */ class LimitIterator extends IteratorIterator implements Iterator, Traversable, OuterIterator { /** - * Construct a LimitIterator - * @link http://www.php.net/manual/en/limititerator.construct.php - * @param Iterator $iterator - * @param int $offset [optional] - * @param int $limit [optional] - * @return Iterator + * {@inheritdoc} + * @param Iterator $iterator + * @param int $offset [optional] + * @param int $limit [optional] */ - public function __construct (Iterator $iterator, int $offset = null, int $limit = -1): Iterator {} + public function __construct (Iterator $iterator, int $offset = 0, int $limit = -1) {} /** - * Rewind the iterator to the specified starting offset - * @link http://www.php.net/manual/en/limititerator.rewind.php - * @return void No value is returned. + * {@inheritdoc} */ - public function rewind (): void {} + public function rewind () {} /** - * Check whether the current element is valid - * @link http://www.php.net/manual/en/limititerator.valid.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function valid (): bool {} + public function valid () {} /** - * Move the iterator forward - * @link http://www.php.net/manual/en/limititerator.next.php - * @return void No value is returned. + * {@inheritdoc} */ - public function next (): void {} + public function next () {} /** - * Seek to the given position - * @link http://www.php.net/manual/en/limititerator.seek.php - * @param int $offset - * @return int Returns the offset position after seeking. + * {@inheritdoc} + * @param int $offset */ - public function seek (int $offset): int {} + public function seek (int $offset) {} /** - * Return the current position - * @link http://www.php.net/manual/en/limititerator.getposition.php - * @return int The current position. + * {@inheritdoc} */ - public function getPosition (): int {} + public function getPosition () {} /** - * Get the inner iterator - * @link http://www.php.net/manual/en/iteratoriterator.getinneriterator.php - * @return Iterator|null The inner iterator as passed to IteratorIterator::__construct, or null when there is no inner iterator. + * {@inheritdoc} */ - public function getInnerIterator (): ?Iterator {} + public function getInnerIterator () {} /** - * Get the key of the current element - * @link http://www.php.net/manual/en/iteratoriterator.key.php - * @return mixed The key of the current element. + * {@inheritdoc} */ - public function key (): mixed {} + public function key () {} /** - * Get the current value - * @link http://www.php.net/manual/en/iteratoriterator.current.php - * @return mixed The value of the current element. + * {@inheritdoc} */ - public function current (): mixed {} + public function current () {} } -/** - * This object supports cached iteration over another iterator. - * @link http://www.php.net/manual/en/class.cachingiterator.php - */ class CachingIterator extends IteratorIterator implements Stringable, Iterator, Traversable, OuterIterator, ArrayAccess, Countable { - /** - * Convert every element to string. const CALL_TOSTRING = 1; - /** - * Don't throw exception in accessing children. const CATCH_GET_CHILD = 16; - /** - * Use key for conversion to - * string. const TOSTRING_USE_KEY = 2; - /** - * Use current for - * conversion to string. const TOSTRING_USE_CURRENT = 4; - /** - * Use inner - * for conversion to string. const TOSTRING_USE_INNER = 8; - /** - * Cache all read data. const FULL_CACHE = 256; /** - * Construct a new CachingIterator object for the iterator - * @link http://www.php.net/manual/en/cachingiterator.construct.php - * @param Iterator $iterator - * @param int $flags [optional] - * @return Iterator + * {@inheritdoc} + * @param Iterator $iterator + * @param int $flags [optional] */ - public function __construct (Iterator $iterator, int $flags = \CachingIterator::CALL_TOSTRING): Iterator {} + public function __construct (Iterator $iterator, int $flags = 1) {} /** - * Rewind the iterator - * @link http://www.php.net/manual/en/cachingiterator.rewind.php - * @return void No value is returned. + * {@inheritdoc} */ - public function rewind (): void {} + public function rewind () {} /** - * Check whether the current element is valid - * @link http://www.php.net/manual/en/cachingiterator.valid.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function valid (): bool {} + public function valid () {} /** - * Move the iterator forward - * @link http://www.php.net/manual/en/cachingiterator.next.php - * @return void No value is returned. + * {@inheritdoc} */ - public function next (): void {} + public function next () {} /** - * Check whether the inner iterator has a valid next element - * @link http://www.php.net/manual/en/cachingiterator.hasnext.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function hasNext (): bool {} + public function hasNext () {} /** - * Return the string representation of the current element - * @link http://www.php.net/manual/en/cachingiterator.tostring.php - * @return string The string representation of the current element. + * {@inheritdoc} */ public function __toString (): string {} /** - * Get flags used - * @link http://www.php.net/manual/en/cachingiterator.getflags.php - * @return int Description... + * {@inheritdoc} */ - public function getFlags (): int {} + public function getFlags () {} /** - * The setFlags purpose - * @link http://www.php.net/manual/en/cachingiterator.setflags.php - * @param int $flags - * @return void No value is returned. + * {@inheritdoc} + * @param int $flags */ - public function setFlags (int $flags): void {} + public function setFlags (int $flags) {} /** - * The offsetGet purpose - * @link http://www.php.net/manual/en/cachingiterator.offsetget.php - * @param string $key - * @return mixed Description... + * {@inheritdoc} + * @param mixed $key */ - public function offsetGet (string $key): mixed {} + public function offsetGet ($key = null) {} /** - * The offsetSet purpose - * @link http://www.php.net/manual/en/cachingiterator.offsetset.php - * @param string $key - * @param mixed $value - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $key + * @param mixed $value */ - public function offsetSet (string $key, mixed $value): void {} + public function offsetSet ($key = null, mixed $value = null) {} /** - * The offsetUnset purpose - * @link http://www.php.net/manual/en/cachingiterator.offsetunset.php - * @param string $key - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $key */ - public function offsetUnset (string $key): void {} + public function offsetUnset ($key = null) {} /** - * The offsetExists purpose - * @link http://www.php.net/manual/en/cachingiterator.offsetexists.php - * @param string $key - * @return bool Returns true if an entry referenced by the offset exists, false otherwise. + * {@inheritdoc} + * @param mixed $key */ - public function offsetExists (string $key): bool {} + public function offsetExists ($key = null) {} /** - * Retrieve the contents of the cache - * @link http://www.php.net/manual/en/cachingiterator.getcache.php - * @return array An array containing the cache items. + * {@inheritdoc} */ - public function getCache (): array {} + public function getCache () {} /** - * The number of elements in the iterator - * @link http://www.php.net/manual/en/cachingiterator.count.php - * @return int The count of the elements iterated over. + * {@inheritdoc} */ - public function count (): int {} + public function count () {} /** - * Get the inner iterator - * @link http://www.php.net/manual/en/iteratoriterator.getinneriterator.php - * @return Iterator|null The inner iterator as passed to IteratorIterator::__construct, or null when there is no inner iterator. + * {@inheritdoc} */ - public function getInnerIterator (): ?Iterator {} + public function getInnerIterator () {} /** - * Get the key of the current element - * @link http://www.php.net/manual/en/iteratoriterator.key.php - * @return mixed The key of the current element. + * {@inheritdoc} */ - public function key (): mixed {} + public function key () {} /** - * Get the current value - * @link http://www.php.net/manual/en/iteratoriterator.current.php - * @return mixed The value of the current element. + * {@inheritdoc} */ - public function current (): mixed {} + public function current () {} } -/** - * ... - * @link http://www.php.net/manual/en/class.recursivecachingiterator.php - */ class RecursiveCachingIterator extends CachingIterator implements Countable, ArrayAccess, OuterIterator, Traversable, Iterator, Stringable, RecursiveIterator { const CALL_TOSTRING = 1; const CATCH_GET_CHILD = 16; @@ -2091,498 +1420,342 @@ class RecursiveCachingIterator extends CachingIterator implements Countable, Arr /** - * Construct - * @link http://www.php.net/manual/en/recursivecachingiterator.construct.php - * @param Iterator $iterator - * @param int $flags [optional] - * @return Iterator + * {@inheritdoc} + * @param Iterator $iterator + * @param int $flags [optional] */ - public function __construct (Iterator $iterator, int $flags = \RecursiveCachingIterator::CALL_TOSTRING): Iterator {} + public function __construct (Iterator $iterator, int $flags = 1) {} /** - * Check whether the current element of the inner iterator has children - * @link http://www.php.net/manual/en/recursivecachingiterator.haschildren.php - * @return bool true if the inner iterator has children, otherwise false + * {@inheritdoc} */ - public function hasChildren (): bool {} + public function hasChildren () {} /** - * Return the inner iterator's children as a RecursiveCachingIterator - * @link http://www.php.net/manual/en/recursivecachingiterator.getchildren.php - * @return RecursiveCachingIterator|null The inner iterator's children, as a RecursiveCachingIterator; or null if there is no children. + * {@inheritdoc} */ - public function getChildren (): ?RecursiveCachingIterator {} + public function getChildren () {} /** - * Rewind the iterator - * @link http://www.php.net/manual/en/cachingiterator.rewind.php - * @return void No value is returned. + * {@inheritdoc} */ - public function rewind (): void {} + public function rewind () {} /** - * Check whether the current element is valid - * @link http://www.php.net/manual/en/cachingiterator.valid.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function valid (): bool {} + public function valid () {} /** - * Move the iterator forward - * @link http://www.php.net/manual/en/cachingiterator.next.php - * @return void No value is returned. + * {@inheritdoc} */ - public function next (): void {} + public function next () {} /** - * Check whether the inner iterator has a valid next element - * @link http://www.php.net/manual/en/cachingiterator.hasnext.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function hasNext (): bool {} + public function hasNext () {} /** - * Return the string representation of the current element - * @link http://www.php.net/manual/en/cachingiterator.tostring.php - * @return string The string representation of the current element. + * {@inheritdoc} */ public function __toString (): string {} /** - * Get flags used - * @link http://www.php.net/manual/en/cachingiterator.getflags.php - * @return int Description... + * {@inheritdoc} */ - public function getFlags (): int {} + public function getFlags () {} /** - * The setFlags purpose - * @link http://www.php.net/manual/en/cachingiterator.setflags.php - * @param int $flags - * @return void No value is returned. + * {@inheritdoc} + * @param int $flags */ - public function setFlags (int $flags): void {} + public function setFlags (int $flags) {} /** - * The offsetGet purpose - * @link http://www.php.net/manual/en/cachingiterator.offsetget.php - * @param string $key - * @return mixed Description... + * {@inheritdoc} + * @param mixed $key */ - public function offsetGet (string $key): mixed {} + public function offsetGet ($key = null) {} /** - * The offsetSet purpose - * @link http://www.php.net/manual/en/cachingiterator.offsetset.php - * @param string $key - * @param mixed $value - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $key + * @param mixed $value */ - public function offsetSet (string $key, mixed $value): void {} + public function offsetSet ($key = null, mixed $value = null) {} /** - * The offsetUnset purpose - * @link http://www.php.net/manual/en/cachingiterator.offsetunset.php - * @param string $key - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $key */ - public function offsetUnset (string $key): void {} + public function offsetUnset ($key = null) {} /** - * The offsetExists purpose - * @link http://www.php.net/manual/en/cachingiterator.offsetexists.php - * @param string $key - * @return bool Returns true if an entry referenced by the offset exists, false otherwise. + * {@inheritdoc} + * @param mixed $key */ - public function offsetExists (string $key): bool {} + public function offsetExists ($key = null) {} /** - * Retrieve the contents of the cache - * @link http://www.php.net/manual/en/cachingiterator.getcache.php - * @return array An array containing the cache items. + * {@inheritdoc} */ - public function getCache (): array {} + public function getCache () {} /** - * The number of elements in the iterator - * @link http://www.php.net/manual/en/cachingiterator.count.php - * @return int The count of the elements iterated over. + * {@inheritdoc} */ - public function count (): int {} + public function count () {} /** - * Get the inner iterator - * @link http://www.php.net/manual/en/iteratoriterator.getinneriterator.php - * @return Iterator|null The inner iterator as passed to IteratorIterator::__construct, or null when there is no inner iterator. + * {@inheritdoc} */ - public function getInnerIterator (): ?Iterator {} + public function getInnerIterator () {} /** - * Get the key of the current element - * @link http://www.php.net/manual/en/iteratoriterator.key.php - * @return mixed The key of the current element. + * {@inheritdoc} */ - public function key (): mixed {} + public function key () {} /** - * Get the current value - * @link http://www.php.net/manual/en/iteratoriterator.current.php - * @return mixed The value of the current element. + * {@inheritdoc} */ - public function current (): mixed {} + public function current () {} } -/** - * This iterator ignores rewind operations. This allows processing an iterator in multiple partial foreach loops. - * @link http://www.php.net/manual/en/class.norewinditerator.php - */ class NoRewindIterator extends IteratorIterator implements Iterator, Traversable, OuterIterator { /** - * Construct a NoRewindIterator - * @link http://www.php.net/manual/en/norewinditerator.construct.php - * @param Iterator $iterator - * @return Iterator + * {@inheritdoc} + * @param Iterator $iterator */ - public function __construct (Iterator $iterator): Iterator {} + public function __construct (Iterator $iterator) {} /** - * Prevents the rewind operation on the inner iterator - * @link http://www.php.net/manual/en/norewinditerator.rewind.php - * @return void No value is returned. + * {@inheritdoc} */ - public function rewind (): void {} + public function rewind () {} /** - * Validates the iterator - * @link http://www.php.net/manual/en/norewinditerator.valid.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function valid (): bool {} + public function valid () {} /** - * Get the current key - * @link http://www.php.net/manual/en/norewinditerator.key.php - * @return mixed The current key. + * {@inheritdoc} */ - public function key (): mixed {} + public function key () {} /** - * Get the current value - * @link http://www.php.net/manual/en/norewinditerator.current.php - * @return mixed The current value. + * {@inheritdoc} */ - public function current (): mixed {} + public function current () {} /** - * Forward to the next element - * @link http://www.php.net/manual/en/norewinditerator.next.php - * @return void No value is returned. + * {@inheritdoc} */ - public function next (): void {} + public function next () {} /** - * Get the inner iterator - * @link http://www.php.net/manual/en/iteratoriterator.getinneriterator.php - * @return Iterator|null The inner iterator as passed to IteratorIterator::__construct, or null when there is no inner iterator. + * {@inheritdoc} */ - public function getInnerIterator (): ?Iterator {} + public function getInnerIterator () {} } -/** - * An Iterator that iterates over several iterators one after the other. - * @link http://www.php.net/manual/en/class.appenditerator.php - */ class AppendIterator extends IteratorIterator implements Iterator, Traversable, OuterIterator { /** - * Constructs an AppendIterator - * @link http://www.php.net/manual/en/appenditerator.construct.php + * {@inheritdoc} */ public function __construct () {} /** - * Appends an iterator - * @link http://www.php.net/manual/en/appenditerator.append.php - * @param Iterator $iterator - * @return void No value is returned. + * {@inheritdoc} + * @param Iterator $iterator */ - public function append (Iterator $iterator): void {} + public function append (Iterator $iterator) {} /** - * Rewinds the Iterator - * @link http://www.php.net/manual/en/appenditerator.rewind.php - * @return void No value is returned. + * {@inheritdoc} */ - public function rewind (): void {} + public function rewind () {} /** - * Checks validity of the current element - * @link http://www.php.net/manual/en/appenditerator.valid.php - * @return bool Returns true if the current iteration is valid, false otherwise. + * {@inheritdoc} */ - public function valid (): bool {} + public function valid () {} /** - * Gets the current value - * @link http://www.php.net/manual/en/appenditerator.current.php - * @return mixed The current value if it is valid or null otherwise. + * {@inheritdoc} */ - public function current (): mixed {} + public function current () {} /** - * Moves to the next element - * @link http://www.php.net/manual/en/appenditerator.next.php - * @return void No value is returned. + * {@inheritdoc} */ - public function next (): void {} + public function next () {} /** - * Gets an index of iterators - * @link http://www.php.net/manual/en/appenditerator.getiteratorindex.php - * @return int|null Returns the zero-based, integer index of the current inner iterator if it exists, or null otherwise. + * {@inheritdoc} */ - public function getIteratorIndex (): ?int {} + public function getIteratorIndex () {} /** - * Gets the ArrayIterator - * @link http://www.php.net/manual/en/appenditerator.getarrayiterator.php - * @return ArrayIterator Returns an ArrayIterator containing - * the appended iterators. + * {@inheritdoc} */ - public function getArrayIterator (): ArrayIterator {} + public function getArrayIterator () {} /** - * Get the inner iterator - * @link http://www.php.net/manual/en/iteratoriterator.getinneriterator.php - * @return Iterator|null The inner iterator as passed to IteratorIterator::__construct, or null when there is no inner iterator. + * {@inheritdoc} */ - public function getInnerIterator (): ?Iterator {} + public function getInnerIterator () {} /** - * Get the key of the current element - * @link http://www.php.net/manual/en/iteratoriterator.key.php - * @return mixed The key of the current element. + * {@inheritdoc} */ - public function key (): mixed {} + public function key () {} } -/** - * The InfiniteIterator allows one to - * infinitely iterate over an iterator without having to manually - * rewind the iterator upon reaching its end. - * @link http://www.php.net/manual/en/class.infiniteiterator.php - */ class InfiniteIterator extends IteratorIterator implements Iterator, Traversable, OuterIterator { /** - * Constructs an InfiniteIterator - * @link http://www.php.net/manual/en/infiniteiterator.construct.php - * @param Iterator $iterator - * @return Iterator + * {@inheritdoc} + * @param Iterator $iterator */ - public function __construct (Iterator $iterator): Iterator {} + public function __construct (Iterator $iterator) {} /** - * Moves the inner Iterator forward or rewinds it - * @link http://www.php.net/manual/en/infiniteiterator.next.php - * @return void No value is returned. + * {@inheritdoc} */ - public function next (): void {} + public function next () {} /** - * Get the inner iterator - * @link http://www.php.net/manual/en/iteratoriterator.getinneriterator.php - * @return Iterator|null The inner iterator as passed to IteratorIterator::__construct, or null when there is no inner iterator. + * {@inheritdoc} */ - public function getInnerIterator (): ?Iterator {} + public function getInnerIterator () {} /** - * Rewind to the first element - * @link http://www.php.net/manual/en/iteratoriterator.rewind.php - * @return void No value is returned. + * {@inheritdoc} */ - public function rewind (): void {} + public function rewind () {} /** - * Checks if the iterator is valid - * @link http://www.php.net/manual/en/iteratoriterator.valid.php - * @return bool Returns true if the iterator is valid, otherwise false + * {@inheritdoc} */ - public function valid (): bool {} + public function valid () {} /** - * Get the key of the current element - * @link http://www.php.net/manual/en/iteratoriterator.key.php - * @return mixed The key of the current element. + * {@inheritdoc} */ - public function key (): mixed {} + public function key () {} /** - * Get the current value - * @link http://www.php.net/manual/en/iteratoriterator.current.php - * @return mixed The value of the current element. + * {@inheritdoc} */ - public function current (): mixed {} + public function current () {} } -/** - * This iterator can be used to filter another iterator based on a regular expression. - * @link http://www.php.net/manual/en/class.regexiterator.php - */ class RegexIterator extends FilterIterator implements OuterIterator, Traversable, Iterator { - /** - * Special flag: Match the entry key instead of the entry value. const USE_KEY = 1; - /** - * Inverts the return value of RegexIterator::accept. const INVERT_MATCH = 2; - /** - * Only execute match (filter) for the current entry - * (see preg_match). const MATCH = 0; - /** - * Return the first match for the current entry - * (see preg_match). const GET_MATCH = 1; - /** - * Return all matches for the current entry - * (see preg_match_all). const ALL_MATCHES = 2; - /** - * Returns the split values for the current entry (see preg_split). const SPLIT = 3; - /** - * Replace the current entry - * (see preg_replace; Not fully implemented yet) const REPLACE = 4; public ?string $replacement; /** - * Create a new RegexIterator - * @link http://www.php.net/manual/en/regexiterator.construct.php - * @param Iterator $iterator - * @param string $pattern - * @param int $mode [optional] - * @param int $flags [optional] - * @param int $pregFlags [optional] - * @return Iterator + * {@inheritdoc} + * @param Iterator $iterator + * @param string $pattern + * @param int $mode [optional] + * @param int $flags [optional] + * @param int $pregFlags [optional] */ - public function __construct (Iterator $iterator, string $pattern, int $mode = \RegexIterator::MATCH, int $flags = null, int $pregFlags = null): Iterator {} + public function __construct (Iterator $iterator, string $pattern, int $mode = 0, int $flags = 0, int $pregFlags = 0) {} /** - * Get accept status - * @link http://www.php.net/manual/en/regexiterator.accept.php - * @return bool true if a match, false otherwise. + * {@inheritdoc} */ - public function accept (): bool {} + public function accept () {} /** - * Returns operation mode - * @link http://www.php.net/manual/en/regexiterator.getmode.php - * @return int Returns the operation mode. + * {@inheritdoc} */ - public function getMode (): int {} + public function getMode () {} /** - * Sets the operation mode - * @link http://www.php.net/manual/en/regexiterator.setmode.php - * @param int $mode - * @return void No value is returned. + * {@inheritdoc} + * @param int $mode */ - public function setMode (int $mode): void {} + public function setMode (int $mode) {} /** - * Get flags - * @link http://www.php.net/manual/en/regexiterator.getflags.php - * @return int Returns the set flags. + * {@inheritdoc} */ - public function getFlags (): int {} + public function getFlags () {} /** - * Sets the flags - * @link http://www.php.net/manual/en/regexiterator.setflags.php - * @param int $flags - * @return void No value is returned. + * {@inheritdoc} + * @param int $flags */ - public function setFlags (int $flags): void {} + public function setFlags (int $flags) {} /** - * Returns current regular expression - * @link http://www.php.net/manual/en/regexiterator.getregex.php - * @return string + * {@inheritdoc} */ - public function getRegex (): string {} + public function getRegex () {} /** - * Returns the regular expression flags - * @link http://www.php.net/manual/en/regexiterator.getpregflags.php - * @return int Returns a bitmask of the regular expression flags. + * {@inheritdoc} */ - public function getPregFlags (): int {} + public function getPregFlags () {} /** - * Sets the regular expression flags - * @link http://www.php.net/manual/en/regexiterator.setpregflags.php - * @param int $pregFlags - * @return void No value is returned. + * {@inheritdoc} + * @param int $pregFlags */ - public function setPregFlags (int $pregFlags): void {} + public function setPregFlags (int $pregFlags) {} /** - * Rewind the iterator - * @link http://www.php.net/manual/en/filteriterator.rewind.php - * @return void No value is returned. + * {@inheritdoc} */ - public function rewind (): void {} + public function rewind () {} /** - * Move the iterator forward - * @link http://www.php.net/manual/en/filteriterator.next.php - * @return void No value is returned. + * {@inheritdoc} */ - public function next (): void {} + public function next () {} /** - * Get the inner iterator - * @link http://www.php.net/manual/en/iteratoriterator.getinneriterator.php - * @return Iterator|null The inner iterator as passed to IteratorIterator::__construct, or null when there is no inner iterator. + * {@inheritdoc} */ - public function getInnerIterator (): ?Iterator {} + public function getInnerIterator () {} /** - * Checks if the iterator is valid - * @link http://www.php.net/manual/en/iteratoriterator.valid.php - * @return bool Returns true if the iterator is valid, otherwise false + * {@inheritdoc} */ - public function valid (): bool {} + public function valid () {} /** - * Get the key of the current element - * @link http://www.php.net/manual/en/iteratoriterator.key.php - * @return mixed The key of the current element. + * {@inheritdoc} */ - public function key (): mixed {} + public function key () {} /** - * Get the current value - * @link http://www.php.net/manual/en/iteratoriterator.current.php - * @return mixed The value of the current element. + * {@inheritdoc} */ - public function current (): mixed {} + public function current () {} } -/** - * This recursive iterator can filter another recursive iterator via a regular expression. - * @link http://www.php.net/manual/en/class.recursiveregexiterator.php - */ class RecursiveRegexIterator extends RegexIterator implements Iterator, Traversable, OuterIterator, RecursiveIterator { const USE_KEY = 1; const INVERT_MATCH = 2; @@ -2594,16 +1767,14 @@ class RecursiveRegexIterator extends RegexIterator implements Iterator, Traversa /** - * Creates a new RecursiveRegexIterator - * @link http://www.php.net/manual/en/recursiveregexiterator.construct.php - * @param RecursiveIterator $iterator - * @param string $pattern - * @param int $mode [optional] - * @param int $flags [optional] - * @param int $pregFlags [optional] - * @return RecursiveIterator + * {@inheritdoc} + * @param RecursiveIterator $iterator + * @param string $pattern + * @param int $mode [optional] + * @param int $flags [optional] + * @param int $pregFlags [optional] */ - public function __construct (RecursiveIterator $iterator, string $pattern, int $mode = \RecursiveRegexIterator::MATCH, int $flags = null, int $pregFlags = null): RecursiveIterator {} + public function __construct (RecursiveIterator $iterator, string $pattern, int $mode = 0, int $flags = 0, int $pregFlags = 0) {} /** * {@inheritdoc} @@ -2611,162 +1782,114 @@ public function __construct (RecursiveIterator $iterator, string $pattern, int $ public function accept () {} /** - * Returns whether an iterator can be obtained for the current entry - * @link http://www.php.net/manual/en/recursiveregexiterator.haschildren.php - * @return bool Returns true if an iterator can be obtained for the current entry, otherwise returns false. + * {@inheritdoc} */ - public function hasChildren (): bool {} + public function hasChildren () {} /** - * Returns an iterator for the current entry - * @link http://www.php.net/manual/en/recursiveregexiterator.getchildren.php - * @return RecursiveRegexIterator An iterator for the current entry, if it can be iterated over by the inner iterator. + * {@inheritdoc} */ - public function getChildren (): RecursiveRegexIterator {} + public function getChildren () {} /** - * Returns operation mode - * @link http://www.php.net/manual/en/regexiterator.getmode.php - * @return int Returns the operation mode. + * {@inheritdoc} */ - public function getMode (): int {} + public function getMode () {} /** - * Sets the operation mode - * @link http://www.php.net/manual/en/regexiterator.setmode.php - * @param int $mode - * @return void No value is returned. + * {@inheritdoc} + * @param int $mode */ - public function setMode (int $mode): void {} + public function setMode (int $mode) {} /** - * Get flags - * @link http://www.php.net/manual/en/regexiterator.getflags.php - * @return int Returns the set flags. + * {@inheritdoc} */ - public function getFlags (): int {} + public function getFlags () {} /** - * Sets the flags - * @link http://www.php.net/manual/en/regexiterator.setflags.php - * @param int $flags - * @return void No value is returned. + * {@inheritdoc} + * @param int $flags */ - public function setFlags (int $flags): void {} + public function setFlags (int $flags) {} /** - * Returns current regular expression - * @link http://www.php.net/manual/en/regexiterator.getregex.php - * @return string + * {@inheritdoc} */ - public function getRegex (): string {} + public function getRegex () {} /** - * Returns the regular expression flags - * @link http://www.php.net/manual/en/regexiterator.getpregflags.php - * @return int Returns a bitmask of the regular expression flags. + * {@inheritdoc} */ - public function getPregFlags (): int {} + public function getPregFlags () {} /** - * Sets the regular expression flags - * @link http://www.php.net/manual/en/regexiterator.setpregflags.php - * @param int $pregFlags - * @return void No value is returned. + * {@inheritdoc} + * @param int $pregFlags */ - public function setPregFlags (int $pregFlags): void {} + public function setPregFlags (int $pregFlags) {} /** - * Rewind the iterator - * @link http://www.php.net/manual/en/filteriterator.rewind.php - * @return void No value is returned. + * {@inheritdoc} */ - public function rewind (): void {} + public function rewind () {} /** - * Move the iterator forward - * @link http://www.php.net/manual/en/filteriterator.next.php - * @return void No value is returned. + * {@inheritdoc} */ - public function next (): void {} + public function next () {} /** - * Get the inner iterator - * @link http://www.php.net/manual/en/iteratoriterator.getinneriterator.php - * @return Iterator|null The inner iterator as passed to IteratorIterator::__construct, or null when there is no inner iterator. + * {@inheritdoc} */ - public function getInnerIterator (): ?Iterator {} + public function getInnerIterator () {} /** - * Checks if the iterator is valid - * @link http://www.php.net/manual/en/iteratoriterator.valid.php - * @return bool Returns true if the iterator is valid, otherwise false + * {@inheritdoc} */ - public function valid (): bool {} + public function valid () {} /** - * Get the key of the current element - * @link http://www.php.net/manual/en/iteratoriterator.key.php - * @return mixed The key of the current element. + * {@inheritdoc} */ - public function key (): mixed {} + public function key () {} /** - * Get the current value - * @link http://www.php.net/manual/en/iteratoriterator.current.php - * @return mixed The value of the current element. + * {@inheritdoc} */ - public function current (): mixed {} + public function current () {} } -/** - * The EmptyIterator class for an empty iterator. - * @link http://www.php.net/manual/en/class.emptyiterator.php - */ class EmptyIterator implements Iterator, Traversable { /** - * The current() method - * @link http://www.php.net/manual/en/emptyiterator.current.php - * @return never No value is returned. + * {@inheritdoc} */ - public function current (): never {} + public function current () {} /** - * The next() method - * @link http://www.php.net/manual/en/emptyiterator.next.php - * @return void No value is returned. + * {@inheritdoc} */ - public function next (): void {} + public function next () {} /** - * The key() method - * @link http://www.php.net/manual/en/emptyiterator.key.php - * @return never No value is returned. + * {@inheritdoc} */ - public function key (): never {} + public function key () {} /** - * The valid() method - * @link http://www.php.net/manual/en/emptyiterator.valid.php - * @return false false + * {@inheritdoc} */ - public function valid (): false {} + public function valid () {} /** - * The rewind() method - * @link http://www.php.net/manual/en/emptyiterator.rewind.php - * @return void No value is returned. + * {@inheritdoc} */ - public function rewind (): void {} + public function rewind () {} } -/** - * Allows iterating over a RecursiveIterator to generate an ASCII graphic tree. - * @link http://www.php.net/manual/en/class.recursivetreeiterator.php - */ class RecursiveTreeIterator extends RecursiveIteratorIterator implements Iterator, Traversable, OuterIterator { const LEAVES_ONLY = 0; const SELF_FIRST = 1; @@ -2783,378 +1906,241 @@ class RecursiveTreeIterator extends RecursiveIteratorIterator implements Iterato /** - * Construct a RecursiveTreeIterator - * @link http://www.php.net/manual/en/recursivetreeiterator.construct.php - * @param RecursiveIterator|IteratorAggregate $iterator - * @param int $flags [optional] - * @param int $cachingIteratorFlags [optional] - * @param int $mode [optional] - * @return RecursiveIterator|IteratorAggregate + * {@inheritdoc} + * @param mixed $iterator + * @param int $flags [optional] + * @param int $cachingIteratorFlags [optional] + * @param int $mode [optional] */ - public function __construct (RecursiveIterator|IteratorAggregate $iterator, int $flags = \RecursiveTreeIterator::BYPASS_KEY, int $cachingIteratorFlags = \CachingIterator::CATCH_GET_CHILD, int $mode = \RecursiveTreeIterator::SELF_FIRST): RecursiveIterator|IteratorAggregate {} + public function __construct ($iterator = null, int $flags = 8, int $cachingIteratorFlags = 16, int $mode = 1) {} /** - * Get the key of the current element - * @link http://www.php.net/manual/en/recursivetreeiterator.key.php - * @return mixed Returns the current key prefixed and postfixed. + * {@inheritdoc} */ - public function key (): mixed {} + public function key () {} /** - * Get current element - * @link http://www.php.net/manual/en/recursivetreeiterator.current.php - * @return mixed Returns the current element prefixed and postfixed. + * {@inheritdoc} */ - public function current (): mixed {} + public function current () {} /** - * Get the prefix - * @link http://www.php.net/manual/en/recursivetreeiterator.getprefix.php - * @return string Returns the string to place in front of current element + * {@inheritdoc} */ - public function getPrefix (): string {} + public function getPrefix () {} /** - * Set postfix - * @link http://www.php.net/manual/en/recursivetreeiterator.setpostfix.php - * @param string $postfix - * @return void No value is returned. + * {@inheritdoc} + * @param string $postfix */ - public function setPostfix (string $postfix): void {} + public function setPostfix (string $postfix) {} /** - * Set a part of the prefix - * @link http://www.php.net/manual/en/recursivetreeiterator.setprefixpart.php - * @param int $part - * @param string $value - * @return void No value is returned. + * {@inheritdoc} + * @param int $part + * @param string $value */ - public function setPrefixPart (int $part, string $value): void {} + public function setPrefixPart (int $part, string $value) {} /** - * Get current entry - * @link http://www.php.net/manual/en/recursivetreeiterator.getentry.php - * @return string Returns the part of the tree built for the current element. + * {@inheritdoc} */ - public function getEntry (): string {} + public function getEntry () {} /** - * Get the postfix - * @link http://www.php.net/manual/en/recursivetreeiterator.getpostfix.php - * @return string Returns the string to place after the current element. + * {@inheritdoc} */ - public function getPostfix (): string {} + public function getPostfix () {} /** - * Rewind the iterator to the first element of the top level inner iterator - * @link http://www.php.net/manual/en/recursiveiteratoriterator.rewind.php - * @return void No value is returned. + * {@inheritdoc} */ - public function rewind (): void {} + public function rewind () {} /** - * Check whether the current position is valid - * @link http://www.php.net/manual/en/recursiveiteratoriterator.valid.php - * @return bool true if the current position is valid, otherwise false + * {@inheritdoc} */ - public function valid (): bool {} + public function valid () {} /** - * Move forward to the next element - * @link http://www.php.net/manual/en/recursiveiteratoriterator.next.php - * @return void No value is returned. + * {@inheritdoc} */ - public function next (): void {} + public function next () {} /** - * Get the current depth of the recursive iteration - * @link http://www.php.net/manual/en/recursiveiteratoriterator.getdepth.php - * @return int The current depth of the recursive iteration. + * {@inheritdoc} */ - public function getDepth (): int {} + public function getDepth () {} /** - * The current active sub iterator - * @link http://www.php.net/manual/en/recursiveiteratoriterator.getsubiterator.php - * @param int|null $level [optional] - * @return RecursiveIterator|null The current active sub iterator on success; null on failure. + * {@inheritdoc} + * @param int|null $level [optional] */ - public function getSubIterator (?int $level = null): ?RecursiveIterator {} + public function getSubIterator (?int $level = NULL) {} /** - * Get inner iterator - * @link http://www.php.net/manual/en/recursiveiteratoriterator.getinneriterator.php - * @return RecursiveIterator The current active sub iterator. + * {@inheritdoc} */ - public function getInnerIterator (): RecursiveIterator {} + public function getInnerIterator () {} /** - * Begin Iteration - * @link http://www.php.net/manual/en/recursiveiteratoriterator.beginiteration.php - * @return void No value is returned. + * {@inheritdoc} */ - public function beginIteration (): void {} + public function beginIteration () {} /** - * End Iteration - * @link http://www.php.net/manual/en/recursiveiteratoriterator.enditeration.php - * @return void No value is returned. + * {@inheritdoc} */ - public function endIteration (): void {} + public function endIteration () {} /** - * Has children - * @link http://www.php.net/manual/en/recursiveiteratoriterator.callhaschildren.php - * @return bool Returns whether the element has children. + * {@inheritdoc} */ - public function callHasChildren (): bool {} + public function callHasChildren () {} /** - * Get children - * @link http://www.php.net/manual/en/recursiveiteratoriterator.callgetchildren.php - * @return RecursiveIterator|null A RecursiveIterator on success, or null on failure. + * {@inheritdoc} */ - public function callGetChildren (): ?RecursiveIterator {} + public function callGetChildren () {} /** - * Begin children - * @link http://www.php.net/manual/en/recursiveiteratoriterator.beginchildren.php - * @return void No value is returned. + * {@inheritdoc} */ - public function beginChildren (): void {} + public function beginChildren () {} /** - * End children - * @link http://www.php.net/manual/en/recursiveiteratoriterator.endchildren.php - * @return void No value is returned. + * {@inheritdoc} */ - public function endChildren (): void {} + public function endChildren () {} /** - * Next element - * @link http://www.php.net/manual/en/recursiveiteratoriterator.nextelement.php - * @return void No value is returned. + * {@inheritdoc} */ - public function nextElement (): void {} + public function nextElement () {} /** - * Set max depth - * @link http://www.php.net/manual/en/recursiveiteratoriterator.setmaxdepth.php - * @param int $maxDepth [optional] - * @return void No value is returned. + * {@inheritdoc} + * @param int $maxDepth [optional] */ - public function setMaxDepth (int $maxDepth = -1): void {} + public function setMaxDepth (int $maxDepth = -1) {} /** - * Get max depth - * @link http://www.php.net/manual/en/recursiveiteratoriterator.getmaxdepth.php - * @return int|false The maximum accepted depth, or false if any depth is allowed. + * {@inheritdoc} */ - public function getMaxDepth (): int|false {} + public function getMaxDepth () {} } -/** - * This class allows objects to work as arrays. - * @link http://www.php.net/manual/en/class.arrayobject.php - */ class ArrayObject implements IteratorAggregate, Traversable, ArrayAccess, Serializable, Countable { - /** - * Properties of the object have their normal functionality when accessed as list (var_dump, foreach, etc.). const STD_PROP_LIST = 1; - /** - * Entries can be accessed as properties (read and write). const ARRAY_AS_PROPS = 2; /** - * Construct a new array object - * @link http://www.php.net/manual/en/arrayobject.construct.php - * @param array|object $array [optional] - * @param int $flags [optional] - * @param string $iteratorClass [optional] - * @return array|object + * {@inheritdoc} + * @param object|array $array [optional] + * @param int $flags [optional] + * @param string $iteratorClass [optional] */ - public function __construct (array|object $array = '[]', int $flags = null, string $iteratorClass = 'ArrayIterator::class'): array|object {} + public function __construct (object|array $array = array ( +), int $flags = 0, string $iteratorClass = 'ArrayIterator') {} /** - * Returns whether the requested index exists - * @link http://www.php.net/manual/en/arrayobject.offsetexists.php - * @param mixed $key - * @return bool true if the requested index exists, otherwise false + * {@inheritdoc} + * @param mixed $key */ - public function offsetExists (mixed $key): bool {} + public function offsetExists (mixed $key = null) {} /** - * Returns the value at the specified index - * @link http://www.php.net/manual/en/arrayobject.offsetget.php - * @param mixed $key - * @return mixed The value at the specified index or null. + * {@inheritdoc} + * @param mixed $key */ - public function offsetGet (mixed $key): mixed {} + public function offsetGet (mixed $key = null) {} /** - * Sets the value at the specified index to newval - * @link http://www.php.net/manual/en/arrayobject.offsetset.php - * @param mixed $key - * @param mixed $value - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $key + * @param mixed $value */ - public function offsetSet (mixed $key, mixed $value): void {} + public function offsetSet (mixed $key = null, mixed $value = null) {} /** - * Unsets the value at the specified index - * @link http://www.php.net/manual/en/arrayobject.offsetunset.php - * @param mixed $key - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $key */ - public function offsetUnset (mixed $key): void {} + public function offsetUnset (mixed $key = null) {} /** - * Appends the value - * @link http://www.php.net/manual/en/arrayobject.append.php - * @param mixed $value - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $value */ - public function append (mixed $value): void {} + public function append (mixed $value = null) {} /** - * Creates a copy of the ArrayObject - * @link http://www.php.net/manual/en/arrayobject.getarraycopy.php - * @return array Returns a copy of the array. When the ArrayObject refers to an object, - * an array of the properties of that object will be returned. + * {@inheritdoc} */ - public function getArrayCopy (): array {} + public function getArrayCopy () {} /** - * Get the number of public properties in the ArrayObject - * @link http://www.php.net/manual/en/arrayobject.count.php - * @return int The number of public properties in the ArrayObject. - *When the ArrayObject is constructed from an array all properties are public.
+ * {@inheritdoc} */ - public function count (): int {} + public function count () {} /** - * Gets the behavior flags - * @link http://www.php.net/manual/en/arrayobject.getflags.php - * @return int Returns the behavior flags of the ArrayObject. + * {@inheritdoc} */ - public function getFlags (): int {} + public function getFlags () {} /** - * Sets the behavior flags - * @link http://www.php.net/manual/en/arrayobject.setflags.php - * @param int $flags - * @return void No value is returned. + * {@inheritdoc} + * @param int $flags */ - public function setFlags (int $flags): void {} + public function setFlags (int $flags) {} /** - * Sort the entries by value - * @link http://www.php.net/manual/en/arrayobject.asort.php - * @param int $flags [optional] The optional second parameter flags - * may be used to modify the sorting behavior using these values: - *Sorting type flags: - *
- *
- * SORT_REGULAR - compare items normally;
- * the details are described in the comparison operators section
- *
- * SORT_NUMERIC - compare items numerically
- *
- * SORT_STRING - compare items as strings
- *
- * SORT_LOCALE_STRING - compare items as
- * strings, based on the current locale. It uses the locale,
- * which can be changed using setlocale
- *
- * SORT_NATURAL - compare items as strings
- * using "natural ordering" like natsort
- *
- * SORT_FLAG_CASE - can be combined
- * (bitwise OR) with
- * SORT_STRING or
- * SORT_NATURAL to sort strings case-insensitively
- *
Sorting type flags: - *
- *
- * SORT_REGULAR - compare items normally;
- * the details are described in the comparison operators section
- *
- * SORT_NUMERIC - compare items numerically
- *
- * SORT_STRING - compare items as strings
- *
- * SORT_LOCALE_STRING - compare items as
- * strings, based on the current locale. It uses the locale,
- * which can be changed using setlocale
- *
- * SORT_NATURAL - compare items as strings
- * using "natural ordering" like natsort
- *
- * SORT_FLAG_CASE - can be combined
- * (bitwise OR) with
- * SORT_STRING or
- * SORT_NATURAL to sort strings case-insensitively
- *
When you want to iterate over the same array multiple times you need to - * instantiate ArrayObject and let it create ArrayIterator instances that - * refer to it either by using foreach or by calling its getIterator() - * method manually.
- * @link http://www.php.net/manual/en/class.arrayiterator.php - */ class ArrayIterator implements SeekableIterator, Traversable, Iterator, ArrayAccess, Serializable, Countable { - /** - * Properties of the object have their normal functionality when accessed as list (var_dump, foreach, etc.). const STD_PROP_LIST = 1; - /** - * Entries can be accessed as properties (read and write). const ARRAY_AS_PROPS = 2; /** - * Construct an ArrayIterator - * @link http://www.php.net/manual/en/arrayiterator.construct.php - * @param array|object $array [optional] - * @param int $flags [optional] - * @return array|object + * {@inheritdoc} + * @param object|array $array [optional] + * @param int $flags [optional] */ - public function __construct (array|object $array = '[]', int $flags = null): array|object {} + public function __construct (object|array $array = array ( +), int $flags = 0) {} /** - * Check if offset exists - * @link http://www.php.net/manual/en/arrayiterator.offsetexists.php - * @param mixed $key - * @return bool true if the offset exists, otherwise false + * {@inheritdoc} + * @param mixed $key */ - public function offsetExists (mixed $key): bool {} + public function offsetExists (mixed $key = null) {} /** - * Get value for an offset - * @link http://www.php.net/manual/en/arrayiterator.offsetget.php - * @param mixed $key - * @return mixed The value at offset key. + * {@inheritdoc} + * @param mixed $key */ - public function offsetGet (mixed $key): mixed {} + public function offsetGet (mixed $key = null) {} /** - * Set value for an offset - * @link http://www.php.net/manual/en/arrayiterator.offsetset.php - * @param mixed $key - * @param mixed $value - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $key + * @param mixed $value */ - public function offsetSet (mixed $key, mixed $value): void {} + public function offsetSet (mixed $key = null, mixed $value = null) {} /** - * Unset value for an offset - * @link http://www.php.net/manual/en/arrayiterator.offsetunset.php - * @param mixed $key - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $key */ - public function offsetUnset (mixed $key): void {} + public function offsetUnset (mixed $key = null) {} /** - * Append an element - * @link http://www.php.net/manual/en/arrayiterator.append.php - * @param mixed $value - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $value */ - public function append (mixed $value): void {} + public function append (mixed $value = null) {} /** - * Get array copy - * @link http://www.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. + * {@inheritdoc} */ - public function getArrayCopy (): array {} + public function getArrayCopy () {} /** - * Count elements - * @link http://www.php.net/manual/en/arrayiterator.count.php - * @return int The number of elements or public properties in the associated - * array or object, respectively. + * {@inheritdoc} */ - public function count (): int {} + public function count () {} /** - * Get behavior flags - * @link http://www.php.net/manual/en/arrayiterator.getflags.php - * @return int Returns the behavior flags of the ArrayIterator. + * {@inheritdoc} */ - public function getFlags (): int {} + public function getFlags () {} /** - * Set behaviour flags - * @link http://www.php.net/manual/en/arrayiterator.setflags.php - * @param int $flags - * @return void No value is returned. + * {@inheritdoc} + * @param int $flags */ - public function setFlags (int $flags): void {} + public function setFlags (int $flags) {} /** - * Sort entries by values - * @link http://www.php.net/manual/en/arrayiterator.asort.php - * @param int $flags [optional] The optional second parameter flags - * may be used to modify the sorting behavior using these values: - *Sorting type flags: - *
- *
- * SORT_REGULAR - compare items normally;
- * the details are described in the comparison operators section
- *
- * SORT_NUMERIC - compare items numerically
- *
- * SORT_STRING - compare items as strings
- *
- * SORT_LOCALE_STRING - compare items as
- * strings, based on the current locale. It uses the locale,
- * which can be changed using setlocale
- *
- * SORT_NATURAL - compare items as strings
- * using "natural ordering" like natsort
- *
- * SORT_FLAG_CASE - can be combined
- * (bitwise OR) with
- * SORT_STRING or
- * SORT_NATURAL to sort strings case-insensitively
- *
Sorting type flags: - *
- *
- * SORT_REGULAR - compare items normally;
- * the details are described in the comparison operators section
- *
- * SORT_NUMERIC - compare items numerically
- *
- * SORT_STRING - compare items as strings
- *
- * SORT_LOCALE_STRING - compare items as
- * strings, based on the current locale. It uses the locale,
- * which can be changed using setlocale
- *
- * SORT_NATURAL - compare items as strings
- * using "natural ordering" like natsort
- *
- * SORT_FLAG_CASE - can be combined
- * (bitwise OR) with
- * SORT_STRING or
- * SORT_NATURAL to sort strings case-insensitively
- *
Sorting type flags: - *
- *
- * SORT_REGULAR - compare items normally;
- * the details are described in the comparison operators section
- *
- * SORT_NUMERIC - compare items numerically
- *
- * SORT_STRING - compare items as strings
- *
- * SORT_LOCALE_STRING - compare items as
- * strings, based on the current locale. It uses the locale,
- * which can be changed using setlocale
- *
- * SORT_NATURAL - compare items as strings
- * using "natural ordering" like natsort
- *
- * SORT_FLAG_CASE - can be combined
- * (bitwise OR) with
- * SORT_STRING or
- * SORT_NATURAL to sort strings case-insensitively
- *
Sorting type flags: - *
- *
- * SORT_REGULAR - compare items normally;
- * the details are described in the comparison operators section
- *
- * SORT_NUMERIC - compare items numerically
- *
- * SORT_STRING - compare items as strings
- *
- * SORT_LOCALE_STRING - compare items as
- * strings, based on the current locale. It uses the locale,
- * which can be changed using setlocale
- *
- * SORT_NATURAL - compare items as strings
- * using "natural ordering" like natsort
- *
- * SORT_FLAG_CASE - can be combined
- * (bitwise OR) with
- * SORT_STRING or
- * SORT_NATURAL to sort strings case-insensitively
- *
A blank line in a CSV file will be returned as an array - * comprising a single null field unless using SplFileObject::SKIP_EMPTY | SplFileObject::DROP_NEW_LINE, - * in which case empty lines are skipped.
+ * {@inheritdoc} + * @param string $separator [optional] + * @param string $enclosure [optional] + * @param string $escape [optional] */ - public function fgetcsv (string $separator = '","', string $enclosure = '"\\""', string $escape = '"\\\\"'): array|false {} + public function fgetcsv (string $separator = ',', string $enclosure = '"', string $escape = '\\') {} /** - * Write a field array as a CSV line - * @link http://www.php.net/manual/en/splfileobject.fputcsv.php - * @param array $fields An array of values. - * @param string $separator [optional] The optional separator parameter sets the field - * delimiter (one single-byte character only). - * @param string $enclosure [optional] The optional enclosure parameter sets the field - * enclosure (one single-byte character only). - * @param string $escape [optional] The optional escape parameter sets the - * escape character (at most one single-byte character). - * An empty string ("") disables the proprietary escape mechanism. - * @param string $eol [optional] The optional eol parameter sets - * a custom End of Line sequence. - * @return int|false Returns the length of the written string or false on failure. - *Returns false, and does not write the CSV line to the file, if the - * separator or enclosure - * parameter is not a single character.
+ * {@inheritdoc} + * @param array $fields + * @param string $separator [optional] + * @param string $enclosure [optional] + * @param string $escape [optional] + * @param string $eol [optional] */ - public function fputcsv (array $fields, string $separator = '","', string $enclosure = '"\\""', string $escape = '"\\\\"', string $eol = '"\\n"'): int|false {} + public function fputcsv (array $fields, string $separator = ',', string $enclosure = '"', string $escape = '\\', string $eol = ' +') {} /** - * Set the delimiter, enclosure and escape character for CSV - * @link http://www.php.net/manual/en/splfileobject.setcsvcontrol.php - * @param string $separator [optional] - * @param string $enclosure [optional] - * @param string $escape [optional] - * @return void No value is returned. + * {@inheritdoc} + * @param string $separator [optional] + * @param string $enclosure [optional] + * @param string $escape [optional] */ - public function setCsvControl (string $separator = '","', string $enclosure = '"\\""', string $escape = '"\\\\"'): void {} + public function setCsvControl (string $separator = ',', string $enclosure = '"', string $escape = '\\') {} /** - * Get the delimiter, enclosure and escape character for CSV - * @link http://www.php.net/manual/en/splfileobject.getcsvcontrol.php - * @return array Returns an indexed array containing the delimiter, enclosure and escape character. + * {@inheritdoc} */ - public function getCsvControl (): array {} + public function getCsvControl () {} /** - * Portable file locking - * @link http://www.php.net/manual/en/splfileobject.flock.php - * @param int $operation - * @param int $wouldBlock [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $operation + * @param mixed $wouldBlock [optional] */ - public function flock (int $operation, int &$wouldBlock = null): bool {} + public function flock (int $operation, &$wouldBlock = NULL) {} /** - * Flushes the output to the file - * @link http://www.php.net/manual/en/splfileobject.fflush.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function fflush (): bool {} + public function fflush () {} /** - * Return current file position - * @link http://www.php.net/manual/en/splfileobject.ftell.php - * @return int|false Returns the position of the file pointer as an integer, or false on error. + * {@inheritdoc} */ - public function ftell (): int|false {} + public function ftell () {} /** - * Seek to a position - * @link http://www.php.net/manual/en/splfileobject.fseek.php - * @param int $offset - * @param int $whence [optional] - * @return int Returns 0 if the seek was successful, -1 otherwise. Note that seeking - * past EOF is not considered an error. + * {@inheritdoc} + * @param int $offset + * @param int $whence [optional] */ - public function fseek (int $offset, int $whence = SEEK_SET): int {} + public function fseek (int $offset, int $whence = 0) {} /** - * Gets character from file - * @link http://www.php.net/manual/en/splfileobject.fgetc.php - * @return string|false Returns a string containing a single character read from the file or false on EOF. + * {@inheritdoc} */ - public function fgetc (): string|false {} + public function fgetc () {} /** - * Output all remaining data on a file pointer - * @link http://www.php.net/manual/en/splfileobject.fpassthru.php - * @return int Returns the number of characters read from handle - * and passed through to the output. + * {@inheritdoc} */ - public function fpassthru (): int {} + public function fpassthru () {} /** - * Parses input from file according to a format - * @link http://www.php.net/manual/en/splfileobject.fscanf.php - * @param string $format - * @param mixed $vars - * @return array|int|null If only one parameter is passed to this method, the values parsed will be - * returned as an array. Otherwise, if optional parameters are passed, the - * function will return the number of assigned values. The optional - * parameters must be passed by reference. + * {@inheritdoc} + * @param string $format + * @param mixed $vars [optional] */ - public function fscanf (string $format, mixed &...$vars): array|int|null {} + public function fscanf (string $format, mixed &...$vars) {} /** - * Write to file - * @link http://www.php.net/manual/en/splfileobject.fwrite.php - * @param string $data - * @param int $length [optional] - * @return int|false Returns the number of bytes written, or false on error. + * {@inheritdoc} + * @param string $data + * @param int $length [optional] */ - public function fwrite (string $data, int $length = null): int|false {} + public function fwrite (string $data, int $length = 0) {} /** - * Gets information about the file - * @link http://www.php.net/manual/en/splfileobject.fstat.php - * @return array Returns an array with the statistics of the file; the format of the array - * is described in detail on the stat manual page. + * {@inheritdoc} */ - public function fstat (): array {} + public function fstat () {} /** - * Truncates the file to a given length - * @link http://www.php.net/manual/en/splfileobject.ftruncate.php - * @param int $size - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $size */ - public function ftruncate (int $size): bool {} + public function ftruncate (int $size) {} /** - * Retrieve current line of file - * @link http://www.php.net/manual/en/splfileobject.current.php - * @return string|array|false Retrieves the current line of the file. If the SplFileObject::READ_CSV flag is set, this method returns an array containing the current line parsed as CSV data. - * If the end of the file is reached, false is returned. + * {@inheritdoc} */ - public function current (): string|array|false {} + public function current () {} /** - * Get line number - * @link http://www.php.net/manual/en/splfileobject.key.php - * @return int Returns the current line number. + * {@inheritdoc} */ - public function key (): int {} + public function key () {} /** - * Read next line - * @link http://www.php.net/manual/en/splfileobject.next.php - * @return void No value is returned. + * {@inheritdoc} */ - public function next (): void {} + public function next () {} /** - * Sets flags for the SplFileObject - * @link http://www.php.net/manual/en/splfileobject.setflags.php - * @param int $flags - * @return void No value is returned. + * {@inheritdoc} + * @param int $flags */ - public function setFlags (int $flags): void {} + public function setFlags (int $flags) {} /** - * Gets flags for the SplFileObject - * @link http://www.php.net/manual/en/splfileobject.getflags.php - * @return int Returns an int representing the flags. + * {@inheritdoc} */ - public function getFlags (): int {} + public function getFlags () {} /** - * Set maximum line length - * @link http://www.php.net/manual/en/splfileobject.setmaxlinelen.php - * @param int $maxLength - * @return void No value is returned. + * {@inheritdoc} + * @param int $maxLength */ - public function setMaxLineLen (int $maxLength): void {} + public function setMaxLineLen (int $maxLength) {} /** - * Get maximum line length - * @link http://www.php.net/manual/en/splfileobject.getmaxlinelen.php - * @return int Returns the maximum line length if one has been set with - * SplFileObject::setMaxLineLen, default is 0. + * {@inheritdoc} */ - public function getMaxLineLen (): int {} + public function getMaxLineLen () {} /** - * SplFileObject does not have children - * @link http://www.php.net/manual/en/splfileobject.haschildren.php - * @return false Returns false + * {@inheritdoc} */ - public function hasChildren (): false {} + public function hasChildren () {} /** - * No purpose - * @link http://www.php.net/manual/en/splfileobject.getchildren.php - * @return null Returns null. + * {@inheritdoc} */ - public function getChildren (): null {} + public function getChildren () {} /** - * Seek to specified line - * @link http://www.php.net/manual/en/splfileobject.seek.php - * @param int $line - * @return void No value is returned. + * {@inheritdoc} + * @param int $line */ - public function seek (int $line): void {} + public function seek (int $line) {} /** * {@inheritdoc} @@ -5577,205 +3798,147 @@ public function getCurrentLine () {} public function __toString (): string {} /** - * Gets the path without filename - * @link http://www.php.net/manual/en/splfileinfo.getpath.php - * @return string Returns the path to the file. + * {@inheritdoc} */ - public function getPath (): string {} + public function getPath () {} /** - * Gets the filename - * @link http://www.php.net/manual/en/splfileinfo.getfilename.php - * @return string The filename. + * {@inheritdoc} */ - public function getFilename (): string {} + public function getFilename () {} /** - * Gets the file extension - * @link http://www.php.net/manual/en/splfileinfo.getextension.php - * @return string Returns a string containing the file extension, or an - * empty string if the file has no extension. + * {@inheritdoc} */ - public function getExtension (): string {} + public function getExtension () {} /** - * Gets the base name of the file - * @link http://www.php.net/manual/en/splfileinfo.getbasename.php - * @param string $suffix [optional] - * @return string Returns the base name without path information. + * {@inheritdoc} + * @param string $suffix [optional] */ - public function getBasename (string $suffix = '""'): string {} + public function getBasename (string $suffix = '') {} /** - * Gets the path to the file - * @link http://www.php.net/manual/en/splfileinfo.getpathname.php - * @return string The path to the file. + * {@inheritdoc} */ - public function getPathname (): string {} + public function getPathname () {} /** - * Gets file permissions - * @link http://www.php.net/manual/en/splfileinfo.getperms.php - * @return int|false Returns the file permissions on success, or false on failure. + * {@inheritdoc} */ - public function getPerms (): int|false {} + public function getPerms () {} /** - * Gets the inode for the file - * @link http://www.php.net/manual/en/splfileinfo.getinode.php - * @return int|false Returns the inode number for the filesystem object on success, or false on failure. + * {@inheritdoc} */ - public function getInode (): int|false {} + public function getInode () {} /** - * Gets file size - * @link http://www.php.net/manual/en/splfileinfo.getsize.php - * @return int|false The filesize in bytes on success, or false on failure. + * {@inheritdoc} */ - public function getSize (): int|false {} + public function getSize () {} /** - * Gets the owner of the file - * @link http://www.php.net/manual/en/splfileinfo.getowner.php - * @return int|false The owner id in numerical format on success, or false on failure. + * {@inheritdoc} */ - public function getOwner (): int|false {} + public function getOwner () {} /** - * Gets the file group - * @link http://www.php.net/manual/en/splfileinfo.getgroup.php - * @return int|false The group id in numerical format on success, or false on failure. + * {@inheritdoc} */ - public function getGroup (): int|false {} + public function getGroup () {} /** - * Gets last access time of the file - * @link http://www.php.net/manual/en/splfileinfo.getatime.php - * @return int|false Returns the time the file was last accessed on success, or false on failure. + * {@inheritdoc} */ - public function getATime (): int|false {} + public function getATime () {} /** - * Gets the last modified time - * @link http://www.php.net/manual/en/splfileinfo.getmtime.php - * @return int|false Returns the last modified time for the file, in a Unix timestamp on success, or false on failure. + * {@inheritdoc} */ - public function getMTime (): int|false {} + public function getMTime () {} /** - * Gets the inode change time - * @link http://www.php.net/manual/en/splfileinfo.getctime.php - * @return int|false The last change time, in a Unix timestamp on success, or false on failure. + * {@inheritdoc} */ - public function getCTime (): int|false {} + public function getCTime () {} /** - * Gets file type - * @link http://www.php.net/manual/en/splfileinfo.gettype.php - * @return string|false A string representing the type of the entry. - * May be one of file, link, - * dir, block, fifo, - * char, socket, or unknown, or false on failure. + * {@inheritdoc} */ - public function getType (): string|false {} + public function getType () {} /** - * Tells if the entry is writable - * @link http://www.php.net/manual/en/splfileinfo.iswritable.php - * @return bool Returns true if writable, false otherwise; + * {@inheritdoc} */ - public function isWritable (): bool {} + public function isWritable () {} /** - * Tells if file is readable - * @link http://www.php.net/manual/en/splfileinfo.isreadable.php - * @return bool Returns true if readable, false otherwise. + * {@inheritdoc} */ - public function isReadable (): bool {} + public function isReadable () {} /** - * Tells if the file is executable - * @link http://www.php.net/manual/en/splfileinfo.isexecutable.php - * @return bool Returns true if executable, false otherwise. + * {@inheritdoc} */ - public function isExecutable (): bool {} + public function isExecutable () {} /** - * Tells if the object references a regular file - * @link http://www.php.net/manual/en/splfileinfo.isfile.php - * @return bool Returns true if the file exists and is a regular file (not a link), false otherwise. + * {@inheritdoc} */ - public function isFile (): bool {} + public function isFile () {} /** - * Tells if the file is a directory - * @link http://www.php.net/manual/en/splfileinfo.isdir.php - * @return bool Returns true if a directory, false otherwise. + * {@inheritdoc} */ - public function isDir (): bool {} + public function isDir () {} /** - * Tells if the file is a link - * @link http://www.php.net/manual/en/splfileinfo.islink.php - * @return bool Returns true if the file is a link, false otherwise. + * {@inheritdoc} */ - public function isLink (): bool {} + public function isLink () {} /** - * Gets the target of a link - * @link http://www.php.net/manual/en/splfileinfo.getlinktarget.php - * @return string|false Returns the target of the filesystem link on success, or false on failure. + * {@inheritdoc} */ - public function getLinkTarget (): string|false {} + public function getLinkTarget () {} /** - * Gets absolute path to file - * @link http://www.php.net/manual/en/splfileinfo.getrealpath.php - * @return string|false Returns the path to the file, or false if the file does not exist. + * {@inheritdoc} */ - public function getRealPath (): string|false {} + public function getRealPath () {} /** - * Gets an SplFileInfo object for the file - * @link http://www.php.net/manual/en/splfileinfo.getfileinfo.php - * @param string|null $class [optional] - * @return SplFileInfo An SplFileInfo object created for the file. + * {@inheritdoc} + * @param string|null $class [optional] */ - public function getFileInfo (?string $class = null): SplFileInfo {} + public function getFileInfo (?string $class = NULL) {} /** - * Gets an SplFileInfo object for the path - * @link http://www.php.net/manual/en/splfileinfo.getpathinfo.php - * @param string|null $class [optional] - * @return SplFileInfo|null Returns an SplFileInfo object for the parent path of the file on success, or null on failure. + * {@inheritdoc} + * @param string|null $class [optional] */ - public function getPathInfo (?string $class = null): ?SplFileInfo {} + public function getPathInfo (?string $class = NULL) {} /** - * Gets an SplFileObject object for the file - * @link http://www.php.net/manual/en/splfileinfo.openfile.php - * @param string $mode [optional] - * @param bool $useIncludePath [optional] - * @param resource|null $context [optional] - * @return SplFileObject The opened file as an SplFileObject object. + * {@inheritdoc} + * @param string $mode [optional] + * @param bool $useIncludePath [optional] + * @param mixed $context [optional] */ - public function openFile (string $mode = '"r"', bool $useIncludePath = false, $context = null): SplFileObject {} + public function openFile (string $mode = 'r', bool $useIncludePath = false, $context = NULL) {} /** - * Sets the class used with SplFileInfo::openFile - * @link http://www.php.net/manual/en/splfileinfo.setfileclass.php - * @param string $class [optional] - * @return void No value is returned. + * {@inheritdoc} + * @param string $class [optional] */ - public function setFileClass (string $class = 'SplFileObject::class'): void {} + public function setFileClass (string $class = 'SplFileObject') {} /** - * Sets the class used with SplFileInfo::getFileInfo and SplFileInfo::getPathInfo - * @link http://www.php.net/manual/en/splfileinfo.setinfoclass.php - * @param string $class [optional] - * @return void No value is returned. + * {@inheritdoc} + * @param string $class [optional] */ - public function setInfoClass (string $class = 'SplFileInfo::class'): void {} + public function setInfoClass (string $class = 'SplFileInfo') {} /** * {@inheritdoc} @@ -5790,10 +3953,6 @@ final public function _bad_state_ex () {} } -/** - * The SplTempFileObject class offers an object-oriented interface for a temporary file. - * @link http://www.php.net/manual/en/class.spltempfileobject.php - */ class SplTempFileObject extends SplFileObject implements SeekableIterator, Iterator, Traversable, RecursiveIterator, Stringable { const DROP_NEW_LINE = 1; const READ_AHEAD = 2; @@ -5802,258 +3961,180 @@ class SplTempFileObject extends SplFileObject implements SeekableIterator, Itera /** - * Construct a new temporary file object - * @link http://www.php.net/manual/en/spltempfileobject.construct.php - * @param int $maxMemory [optional] - * @return int + * {@inheritdoc} + * @param int $maxMemory [optional] */ - public function __construct (int $maxMemory = '2 * 1024 * 1024'): int {} + public function __construct (int $maxMemory = 2097152) {} /** - * Rewind the file to the first line - * @link http://www.php.net/manual/en/splfileobject.rewind.php - * @return void No value is returned. + * {@inheritdoc} */ - public function rewind (): void {} + public function rewind () {} /** - * Reached end of file - * @link http://www.php.net/manual/en/splfileobject.eof.php - * @return bool Returns true if file is at EOF, false otherwise. + * {@inheritdoc} */ - public function eof (): bool {} + public function eof () {} /** - * Not at EOF - * @link http://www.php.net/manual/en/splfileobject.valid.php - * @return bool Returns true if not reached EOF, false otherwise. + * {@inheritdoc} */ - public function valid (): bool {} + public function valid () {} /** - * Gets line from file - * @link http://www.php.net/manual/en/splfileobject.fgets.php - * @return string Returns a string containing the next line from the file. + * {@inheritdoc} */ - public function fgets (): string {} + public function fgets () {} /** - * Read from file - * @link http://www.php.net/manual/en/splfileobject.fread.php - * @param int $length The number of bytes to read. - * @return string|false Returns the string read from the file or false on failure. + * {@inheritdoc} + * @param int $length */ - public function fread (int $length): string|false {} + public function fread (int $length) {} /** - * Gets line from file and parse as CSV fields - * @link http://www.php.net/manual/en/splfileobject.fgetcsv.php - * @param string $separator [optional] - * @param string $enclosure [optional] - * @param string $escape [optional] - * @return array|false Returns an indexed array containing the fields read, or false on error. - *A blank line in a CSV file will be returned as an array - * comprising a single null field unless using SplFileObject::SKIP_EMPTY | SplFileObject::DROP_NEW_LINE, - * in which case empty lines are skipped.
+ * {@inheritdoc} + * @param string $separator [optional] + * @param string $enclosure [optional] + * @param string $escape [optional] */ - public function fgetcsv (string $separator = '","', string $enclosure = '"\\""', string $escape = '"\\\\"'): array|false {} + public function fgetcsv (string $separator = ',', string $enclosure = '"', string $escape = '\\') {} /** - * Write a field array as a CSV line - * @link http://www.php.net/manual/en/splfileobject.fputcsv.php - * @param array $fields An array of values. - * @param string $separator [optional] The optional separator parameter sets the field - * delimiter (one single-byte character only). - * @param string $enclosure [optional] The optional enclosure parameter sets the field - * enclosure (one single-byte character only). - * @param string $escape [optional] The optional escape parameter sets the - * escape character (at most one single-byte character). - * An empty string ("") disables the proprietary escape mechanism. - * @param string $eol [optional] The optional eol parameter sets - * a custom End of Line sequence. - * @return int|false Returns the length of the written string or false on failure. - *Returns false, and does not write the CSV line to the file, if the - * separator or enclosure - * parameter is not a single character.
+ * {@inheritdoc} + * @param array $fields + * @param string $separator [optional] + * @param string $enclosure [optional] + * @param string $escape [optional] + * @param string $eol [optional] */ - public function fputcsv (array $fields, string $separator = '","', string $enclosure = '"\\""', string $escape = '"\\\\"', string $eol = '"\\n"'): int|false {} + public function fputcsv (array $fields, string $separator = ',', string $enclosure = '"', string $escape = '\\', string $eol = ' +') {} /** - * Set the delimiter, enclosure and escape character for CSV - * @link http://www.php.net/manual/en/splfileobject.setcsvcontrol.php - * @param string $separator [optional] - * @param string $enclosure [optional] - * @param string $escape [optional] - * @return void No value is returned. + * {@inheritdoc} + * @param string $separator [optional] + * @param string $enclosure [optional] + * @param string $escape [optional] */ - public function setCsvControl (string $separator = '","', string $enclosure = '"\\""', string $escape = '"\\\\"'): void {} + public function setCsvControl (string $separator = ',', string $enclosure = '"', string $escape = '\\') {} /** - * Get the delimiter, enclosure and escape character for CSV - * @link http://www.php.net/manual/en/splfileobject.getcsvcontrol.php - * @return array Returns an indexed array containing the delimiter, enclosure and escape character. + * {@inheritdoc} */ - public function getCsvControl (): array {} + public function getCsvControl () {} /** - * Portable file locking - * @link http://www.php.net/manual/en/splfileobject.flock.php - * @param int $operation - * @param int $wouldBlock [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $operation + * @param mixed $wouldBlock [optional] */ - public function flock (int $operation, int &$wouldBlock = null): bool {} + public function flock (int $operation, &$wouldBlock = NULL) {} /** - * Flushes the output to the file - * @link http://www.php.net/manual/en/splfileobject.fflush.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function fflush (): bool {} + public function fflush () {} /** - * Return current file position - * @link http://www.php.net/manual/en/splfileobject.ftell.php - * @return int|false Returns the position of the file pointer as an integer, or false on error. + * {@inheritdoc} */ - public function ftell (): int|false {} + public function ftell () {} /** - * Seek to a position - * @link http://www.php.net/manual/en/splfileobject.fseek.php - * @param int $offset - * @param int $whence [optional] - * @return int Returns 0 if the seek was successful, -1 otherwise. Note that seeking - * past EOF is not considered an error. + * {@inheritdoc} + * @param int $offset + * @param int $whence [optional] */ - public function fseek (int $offset, int $whence = SEEK_SET): int {} + public function fseek (int $offset, int $whence = 0) {} /** - * Gets character from file - * @link http://www.php.net/manual/en/splfileobject.fgetc.php - * @return string|false Returns a string containing a single character read from the file or false on EOF. + * {@inheritdoc} */ - public function fgetc (): string|false {} + public function fgetc () {} /** - * Output all remaining data on a file pointer - * @link http://www.php.net/manual/en/splfileobject.fpassthru.php - * @return int Returns the number of characters read from handle - * and passed through to the output. + * {@inheritdoc} */ - public function fpassthru (): int {} + public function fpassthru () {} /** - * Parses input from file according to a format - * @link http://www.php.net/manual/en/splfileobject.fscanf.php - * @param string $format - * @param mixed $vars - * @return array|int|null If only one parameter is passed to this method, the values parsed will be - * returned as an array. Otherwise, if optional parameters are passed, the - * function will return the number of assigned values. The optional - * parameters must be passed by reference. + * {@inheritdoc} + * @param string $format + * @param mixed $vars [optional] */ - public function fscanf (string $format, mixed &...$vars): array|int|null {} + public function fscanf (string $format, mixed &...$vars) {} /** - * Write to file - * @link http://www.php.net/manual/en/splfileobject.fwrite.php - * @param string $data - * @param int $length [optional] - * @return int|false Returns the number of bytes written, or false on error. + * {@inheritdoc} + * @param string $data + * @param int $length [optional] */ - public function fwrite (string $data, int $length = null): int|false {} + public function fwrite (string $data, int $length = 0) {} /** - * Gets information about the file - * @link http://www.php.net/manual/en/splfileobject.fstat.php - * @return array Returns an array with the statistics of the file; the format of the array - * is described in detail on the stat manual page. + * {@inheritdoc} */ - public function fstat (): array {} + public function fstat () {} /** - * Truncates the file to a given length - * @link http://www.php.net/manual/en/splfileobject.ftruncate.php - * @param int $size - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $size */ - public function ftruncate (int $size): bool {} + public function ftruncate (int $size) {} /** - * Retrieve current line of file - * @link http://www.php.net/manual/en/splfileobject.current.php - * @return string|array|false Retrieves the current line of the file. If the SplFileObject::READ_CSV flag is set, this method returns an array containing the current line parsed as CSV data. - * If the end of the file is reached, false is returned. + * {@inheritdoc} */ - public function current (): string|array|false {} + public function current () {} /** - * Get line number - * @link http://www.php.net/manual/en/splfileobject.key.php - * @return int Returns the current line number. + * {@inheritdoc} */ - public function key (): int {} + public function key () {} /** - * Read next line - * @link http://www.php.net/manual/en/splfileobject.next.php - * @return void No value is returned. + * {@inheritdoc} */ - public function next (): void {} + public function next () {} /** - * Sets flags for the SplFileObject - * @link http://www.php.net/manual/en/splfileobject.setflags.php - * @param int $flags - * @return void No value is returned. + * {@inheritdoc} + * @param int $flags */ - public function setFlags (int $flags): void {} + public function setFlags (int $flags) {} /** - * Gets flags for the SplFileObject - * @link http://www.php.net/manual/en/splfileobject.getflags.php - * @return int Returns an int representing the flags. + * {@inheritdoc} */ - public function getFlags (): int {} + public function getFlags () {} /** - * Set maximum line length - * @link http://www.php.net/manual/en/splfileobject.setmaxlinelen.php - * @param int $maxLength - * @return void No value is returned. + * {@inheritdoc} + * @param int $maxLength */ - public function setMaxLineLen (int $maxLength): void {} + public function setMaxLineLen (int $maxLength) {} /** - * Get maximum line length - * @link http://www.php.net/manual/en/splfileobject.getmaxlinelen.php - * @return int Returns the maximum line length if one has been set with - * SplFileObject::setMaxLineLen, default is 0. + * {@inheritdoc} */ - public function getMaxLineLen (): int {} + public function getMaxLineLen () {} /** - * SplFileObject does not have children - * @link http://www.php.net/manual/en/splfileobject.haschildren.php - * @return false Returns false + * {@inheritdoc} */ - public function hasChildren (): false {} + public function hasChildren () {} /** - * No purpose - * @link http://www.php.net/manual/en/splfileobject.getchildren.php - * @return null Returns null. + * {@inheritdoc} */ - public function getChildren (): null {} + public function getChildren () {} /** - * Seek to specified line - * @link http://www.php.net/manual/en/splfileobject.seek.php - * @param int $line - * @return void No value is returned. + * {@inheritdoc} + * @param int $line */ - public function seek (int $line): void {} + public function seek (int $line) {} /** * {@inheritdoc} @@ -6066,205 +4147,147 @@ public function getCurrentLine () {} public function __toString (): string {} /** - * Gets the path without filename - * @link http://www.php.net/manual/en/splfileinfo.getpath.php - * @return string Returns the path to the file. + * {@inheritdoc} */ - public function getPath (): string {} + public function getPath () {} /** - * Gets the filename - * @link http://www.php.net/manual/en/splfileinfo.getfilename.php - * @return string The filename. + * {@inheritdoc} */ - public function getFilename (): string {} + public function getFilename () {} /** - * Gets the file extension - * @link http://www.php.net/manual/en/splfileinfo.getextension.php - * @return string Returns a string containing the file extension, or an - * empty string if the file has no extension. + * {@inheritdoc} */ - public function getExtension (): string {} + public function getExtension () {} /** - * Gets the base name of the file - * @link http://www.php.net/manual/en/splfileinfo.getbasename.php - * @param string $suffix [optional] - * @return string Returns the base name without path information. + * {@inheritdoc} + * @param string $suffix [optional] */ - public function getBasename (string $suffix = '""'): string {} + public function getBasename (string $suffix = '') {} /** - * Gets the path to the file - * @link http://www.php.net/manual/en/splfileinfo.getpathname.php - * @return string The path to the file. + * {@inheritdoc} */ - public function getPathname (): string {} + public function getPathname () {} /** - * Gets file permissions - * @link http://www.php.net/manual/en/splfileinfo.getperms.php - * @return int|false Returns the file permissions on success, or false on failure. + * {@inheritdoc} */ - public function getPerms (): int|false {} + public function getPerms () {} /** - * Gets the inode for the file - * @link http://www.php.net/manual/en/splfileinfo.getinode.php - * @return int|false Returns the inode number for the filesystem object on success, or false on failure. + * {@inheritdoc} */ - public function getInode (): int|false {} + public function getInode () {} /** - * Gets file size - * @link http://www.php.net/manual/en/splfileinfo.getsize.php - * @return int|false The filesize in bytes on success, or false on failure. + * {@inheritdoc} */ - public function getSize (): int|false {} + public function getSize () {} /** - * Gets the owner of the file - * @link http://www.php.net/manual/en/splfileinfo.getowner.php - * @return int|false The owner id in numerical format on success, or false on failure. + * {@inheritdoc} */ - public function getOwner (): int|false {} + public function getOwner () {} /** - * Gets the file group - * @link http://www.php.net/manual/en/splfileinfo.getgroup.php - * @return int|false The group id in numerical format on success, or false on failure. + * {@inheritdoc} */ - public function getGroup (): int|false {} + public function getGroup () {} /** - * Gets last access time of the file - * @link http://www.php.net/manual/en/splfileinfo.getatime.php - * @return int|false Returns the time the file was last accessed on success, or false on failure. + * {@inheritdoc} */ - public function getATime (): int|false {} + public function getATime () {} /** - * Gets the last modified time - * @link http://www.php.net/manual/en/splfileinfo.getmtime.php - * @return int|false Returns the last modified time for the file, in a Unix timestamp on success, or false on failure. + * {@inheritdoc} */ - public function getMTime (): int|false {} + public function getMTime () {} /** - * Gets the inode change time - * @link http://www.php.net/manual/en/splfileinfo.getctime.php - * @return int|false The last change time, in a Unix timestamp on success, or false on failure. + * {@inheritdoc} */ - public function getCTime (): int|false {} + public function getCTime () {} /** - * Gets file type - * @link http://www.php.net/manual/en/splfileinfo.gettype.php - * @return string|false A string representing the type of the entry. - * May be one of file, link, - * dir, block, fifo, - * char, socket, or unknown, or false on failure. + * {@inheritdoc} */ - public function getType (): string|false {} + public function getType () {} /** - * Tells if the entry is writable - * @link http://www.php.net/manual/en/splfileinfo.iswritable.php - * @return bool Returns true if writable, false otherwise; + * {@inheritdoc} */ - public function isWritable (): bool {} + public function isWritable () {} /** - * Tells if file is readable - * @link http://www.php.net/manual/en/splfileinfo.isreadable.php - * @return bool Returns true if readable, false otherwise. + * {@inheritdoc} */ - public function isReadable (): bool {} + public function isReadable () {} /** - * Tells if the file is executable - * @link http://www.php.net/manual/en/splfileinfo.isexecutable.php - * @return bool Returns true if executable, false otherwise. + * {@inheritdoc} */ - public function isExecutable (): bool {} + public function isExecutable () {} /** - * Tells if the object references a regular file - * @link http://www.php.net/manual/en/splfileinfo.isfile.php - * @return bool Returns true if the file exists and is a regular file (not a link), false otherwise. + * {@inheritdoc} */ - public function isFile (): bool {} + public function isFile () {} /** - * Tells if the file is a directory - * @link http://www.php.net/manual/en/splfileinfo.isdir.php - * @return bool Returns true if a directory, false otherwise. + * {@inheritdoc} */ - public function isDir (): bool {} + public function isDir () {} /** - * Tells if the file is a link - * @link http://www.php.net/manual/en/splfileinfo.islink.php - * @return bool Returns true if the file is a link, false otherwise. + * {@inheritdoc} */ - public function isLink (): bool {} + public function isLink () {} /** - * Gets the target of a link - * @link http://www.php.net/manual/en/splfileinfo.getlinktarget.php - * @return string|false Returns the target of the filesystem link on success, or false on failure. + * {@inheritdoc} */ - public function getLinkTarget (): string|false {} + public function getLinkTarget () {} /** - * Gets absolute path to file - * @link http://www.php.net/manual/en/splfileinfo.getrealpath.php - * @return string|false Returns the path to the file, or false if the file does not exist. + * {@inheritdoc} */ - public function getRealPath (): string|false {} + public function getRealPath () {} /** - * Gets an SplFileInfo object for the file - * @link http://www.php.net/manual/en/splfileinfo.getfileinfo.php - * @param string|null $class [optional] - * @return SplFileInfo An SplFileInfo object created for the file. + * {@inheritdoc} + * @param string|null $class [optional] */ - public function getFileInfo (?string $class = null): SplFileInfo {} + public function getFileInfo (?string $class = NULL) {} /** - * Gets an SplFileInfo object for the path - * @link http://www.php.net/manual/en/splfileinfo.getpathinfo.php - * @param string|null $class [optional] - * @return SplFileInfo|null Returns an SplFileInfo object for the parent path of the file on success, or null on failure. + * {@inheritdoc} + * @param string|null $class [optional] */ - public function getPathInfo (?string $class = null): ?SplFileInfo {} + public function getPathInfo (?string $class = NULL) {} /** - * Gets an SplFileObject object for the file - * @link http://www.php.net/manual/en/splfileinfo.openfile.php - * @param string $mode [optional] - * @param bool $useIncludePath [optional] - * @param resource|null $context [optional] - * @return SplFileObject The opened file as an SplFileObject object. + * {@inheritdoc} + * @param string $mode [optional] + * @param bool $useIncludePath [optional] + * @param mixed $context [optional] */ - public function openFile (string $mode = '"r"', bool $useIncludePath = false, $context = null): SplFileObject {} + public function openFile (string $mode = 'r', bool $useIncludePath = false, $context = NULL) {} /** - * Sets the class used with SplFileInfo::openFile - * @link http://www.php.net/manual/en/splfileinfo.setfileclass.php - * @param string $class [optional] - * @return void No value is returned. + * {@inheritdoc} + * @param string $class [optional] */ - public function setFileClass (string $class = 'SplFileObject::class'): void {} + public function setFileClass (string $class = 'SplFileObject') {} /** - * Sets the class used with SplFileInfo::getFileInfo and SplFileInfo::getPathInfo - * @link http://www.php.net/manual/en/splfileinfo.setinfoclass.php - * @param string $class [optional] - * @return void No value is returned. + * {@inheritdoc} + * @param string $class [optional] */ - public function setInfoClass (string $class = 'SplFileInfo::class'): void {} + public function setInfoClass (string $class = 'SplFileInfo') {} /** * {@inheritdoc} @@ -6279,77 +4302,51 @@ final public function _bad_state_ex () {} } -/** - * The SplDoublyLinkedList class provides the main functionalities of a doubly linked list. - * @link http://www.php.net/manual/en/class.spldoublylinkedlist.php - */ class SplDoublyLinkedList implements Iterator, Traversable, Countable, ArrayAccess, Serializable { - /** - * The list will be iterated in a last in, first out order, like a stack. const IT_MODE_LIFO = 2; - /** - * The list will be iterated in a first in, first out order, like a queue. const IT_MODE_FIFO = 0; - /** - * Iteration will remove the iterated elements. const IT_MODE_DELETE = 1; - /** - * Iteration will not remove the iterated elements. const IT_MODE_KEEP = 0; /** - * Add/insert a new value at the specified index - * @link http://www.php.net/manual/en/spldoublylinkedlist.add.php - * @param int $index - * @param mixed $value - * @return void No value is returned. + * {@inheritdoc} + * @param int $index + * @param mixed $value */ - public function add (int $index, mixed $value): void {} + public function add (int $index, mixed $value = null) {} /** - * Pops a node from the end of the doubly linked list - * @link http://www.php.net/manual/en/spldoublylinkedlist.pop.php - * @return mixed The value of the popped node. + * {@inheritdoc} */ - public function pop (): mixed {} + public function pop () {} /** - * Shifts a node from the beginning of the doubly linked list - * @link http://www.php.net/manual/en/spldoublylinkedlist.shift.php - * @return mixed The value of the shifted node. + * {@inheritdoc} */ - public function shift (): mixed {} + public function shift () {} /** - * Pushes an element at the end of the doubly linked list - * @link http://www.php.net/manual/en/spldoublylinkedlist.push.php - * @param mixed $value - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $value */ - public function push (mixed $value): void {} + public function push (mixed $value = null) {} /** - * Prepends the doubly linked list with an element - * @link http://www.php.net/manual/en/spldoublylinkedlist.unshift.php - * @param mixed $value - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $value */ - public function unshift (mixed $value): void {} + public function unshift (mixed $value = null) {} /** - * Peeks at the node from the end of the doubly linked list - * @link http://www.php.net/manual/en/spldoublylinkedlist.top.php - * @return mixed The value of the last node. + * {@inheritdoc} */ - public function top (): mixed {} + public function top () {} /** - * Peeks at the node from the beginning of the doubly linked list - * @link http://www.php.net/manual/en/spldoublylinkedlist.bottom.php - * @return mixed The value of the first node. + * {@inheritdoc} */ - public function bottom (): mixed {} + public function bottom () {} /** * {@inheritdoc} @@ -6357,123 +4354,91 @@ public function bottom (): mixed {} public function __debugInfo () {} /** - * Counts the number of elements in the doubly linked list - * @link http://www.php.net/manual/en/spldoublylinkedlist.count.php - * @return int Returns the number of elements in the doubly linked list. + * {@inheritdoc} */ - public function count (): int {} + public function count () {} /** - * Checks whether the doubly linked list is empty - * @link http://www.php.net/manual/en/spldoublylinkedlist.isempty.php - * @return bool Returns whether the doubly linked list is empty. + * {@inheritdoc} */ - public function isEmpty (): bool {} + public function isEmpty () {} /** - * Sets the mode of iteration - * @link http://www.php.net/manual/en/spldoublylinkedlist.setiteratormode.php - * @param int $mode - * @return int Returns the different modes and flags that affect the iteration. + * {@inheritdoc} + * @param int $mode */ - public function setIteratorMode (int $mode): int {} + public function setIteratorMode (int $mode) {} /** - * Returns the mode of iteration - * @link http://www.php.net/manual/en/spldoublylinkedlist.getiteratormode.php - * @return int Returns the different modes and flags that affect the iteration. + * {@inheritdoc} */ - public function getIteratorMode (): int {} + public function getIteratorMode () {} /** - * Returns whether the requested $index exists - * @link http://www.php.net/manual/en/spldoublylinkedlist.offsetexists.php - * @param int $index - * @return bool true if the requested index exists, otherwise false + * {@inheritdoc} + * @param mixed $index */ - public function offsetExists (int $index): bool {} + public function offsetExists ($index = null) {} /** - * Returns the value at the specified $index - * @link http://www.php.net/manual/en/spldoublylinkedlist.offsetget.php - * @param int $index - * @return mixed The value at the specified index. + * {@inheritdoc} + * @param mixed $index */ - public function offsetGet (int $index): mixed {} + public function offsetGet ($index = null) {} /** - * Sets the value at the specified $index to $value - * @link http://www.php.net/manual/en/spldoublylinkedlist.offsetset.php - * @param int|null $index - * @param mixed $value - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $index + * @param mixed $value */ - public function offsetSet (?int $index, mixed $value): void {} + public function offsetSet ($index = null, mixed $value = null) {} /** - * Unsets the value at the specified $index - * @link http://www.php.net/manual/en/spldoublylinkedlist.offsetunset.php - * @param int $index - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $index */ - public function offsetUnset (int $index): void {} + public function offsetUnset ($index = null) {} /** - * Rewind iterator back to the start - * @link http://www.php.net/manual/en/spldoublylinkedlist.rewind.php - * @return void No value is returned. + * {@inheritdoc} */ - public function rewind (): void {} + public function rewind () {} /** - * Return current array entry - * @link http://www.php.net/manual/en/spldoublylinkedlist.current.php - * @return mixed The current node value. + * {@inheritdoc} */ - public function current (): mixed {} + public function current () {} /** - * Return current node index - * @link http://www.php.net/manual/en/spldoublylinkedlist.key.php - * @return int The current node index. + * {@inheritdoc} */ - public function key (): int {} + public function key () {} /** - * Move to previous entry - * @link http://www.php.net/manual/en/spldoublylinkedlist.prev.php - * @return void No value is returned. + * {@inheritdoc} */ - public function prev (): void {} + public function prev () {} /** - * Move to next entry - * @link http://www.php.net/manual/en/spldoublylinkedlist.next.php - * @return void No value is returned. + * {@inheritdoc} */ - public function next (): void {} + public function next () {} /** - * Check whether the doubly linked list contains more nodes - * @link http://www.php.net/manual/en/spldoublylinkedlist.valid.php - * @return bool Returnsfalse otherwise. + * {@inheritdoc} */ - public function valid (): bool {} + public function valid () {} /** - * Unserializes the storage - * @link http://www.php.net/manual/en/spldoublylinkedlist.unserialize.php - * @param string $data The serialized string. - * @return void No value is returned. + * {@inheritdoc} + * @param string $data */ - public function unserialize (string $data): void {} + public function unserialize (string $data) {} /** - * Serializes the storage - * @link http://www.php.net/manual/en/spldoublylinkedlist.serialize.php - * @return string The serialized string. + * {@inheritdoc} */ - public function serialize (): string {} + public function serialize () {} /** * {@inheritdoc} @@ -6488,11 +4453,6 @@ public function __unserialize (array $data) {} } -/** - * The SplQueue class provides the main functionalities of a queue implemented using a doubly linked list by - * setting the iterator mode to SplDoublyLinkedList::IT_MODE_FIFO. - * @link http://www.php.net/manual/en/class.splqueue.php - */ class SplQueue extends SplDoublyLinkedList implements Serializable, ArrayAccess, Countable, Traversable, Iterator { const IT_MODE_LIFO = 2; const IT_MODE_FIFO = 0; @@ -6501,72 +4461,54 @@ class SplQueue extends SplDoublyLinkedList implements Serializable, ArrayAccess, /** - * Adds an element to the queue - * @link http://www.php.net/manual/en/splqueue.enqueue.php - * @param mixed $value - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $value */ - public function enqueue (mixed $value): void {} + public function enqueue (mixed $value = null) {} /** - * Dequeues a node from the queue - * @link http://www.php.net/manual/en/splqueue.dequeue.php - * @return mixed The value of the dequeued node. + * {@inheritdoc} */ - public function dequeue (): mixed {} + public function dequeue () {} /** - * Add/insert a new value at the specified index - * @link http://www.php.net/manual/en/spldoublylinkedlist.add.php - * @param int $index - * @param mixed $value - * @return void No value is returned. + * {@inheritdoc} + * @param int $index + * @param mixed $value */ - public function add (int $index, mixed $value): void {} + public function add (int $index, mixed $value = null) {} /** - * Pops a node from the end of the doubly linked list - * @link http://www.php.net/manual/en/spldoublylinkedlist.pop.php - * @return mixed The value of the popped node. + * {@inheritdoc} */ - public function pop (): mixed {} + public function pop () {} /** - * Shifts a node from the beginning of the doubly linked list - * @link http://www.php.net/manual/en/spldoublylinkedlist.shift.php - * @return mixed The value of the shifted node. + * {@inheritdoc} */ - public function shift (): mixed {} + public function shift () {} /** - * Pushes an element at the end of the doubly linked list - * @link http://www.php.net/manual/en/spldoublylinkedlist.push.php - * @param mixed $value - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $value */ - public function push (mixed $value): void {} + public function push (mixed $value = null) {} /** - * Prepends the doubly linked list with an element - * @link http://www.php.net/manual/en/spldoublylinkedlist.unshift.php - * @param mixed $value - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $value */ - public function unshift (mixed $value): void {} + public function unshift (mixed $value = null) {} /** - * Peeks at the node from the end of the doubly linked list - * @link http://www.php.net/manual/en/spldoublylinkedlist.top.php - * @return mixed The value of the last node. + * {@inheritdoc} */ - public function top (): mixed {} + public function top () {} /** - * Peeks at the node from the beginning of the doubly linked list - * @link http://www.php.net/manual/en/spldoublylinkedlist.bottom.php - * @return mixed The value of the first node. + * {@inheritdoc} */ - public function bottom (): mixed {} + public function bottom () {} /** * {@inheritdoc} @@ -6574,123 +4516,91 @@ public function bottom (): mixed {} public function __debugInfo () {} /** - * Counts the number of elements in the doubly linked list - * @link http://www.php.net/manual/en/spldoublylinkedlist.count.php - * @return int Returns the number of elements in the doubly linked list. + * {@inheritdoc} */ - public function count (): int {} + public function count () {} /** - * Checks whether the doubly linked list is empty - * @link http://www.php.net/manual/en/spldoublylinkedlist.isempty.php - * @return bool Returns whether the doubly linked list is empty. + * {@inheritdoc} */ - public function isEmpty (): bool {} + public function isEmpty () {} /** - * Sets the mode of iteration - * @link http://www.php.net/manual/en/spldoublylinkedlist.setiteratormode.php - * @param int $mode - * @return int Returns the different modes and flags that affect the iteration. + * {@inheritdoc} + * @param int $mode */ - public function setIteratorMode (int $mode): int {} + public function setIteratorMode (int $mode) {} /** - * Returns the mode of iteration - * @link http://www.php.net/manual/en/spldoublylinkedlist.getiteratormode.php - * @return int Returns the different modes and flags that affect the iteration. + * {@inheritdoc} */ - public function getIteratorMode (): int {} + public function getIteratorMode () {} /** - * Returns whether the requested $index exists - * @link http://www.php.net/manual/en/spldoublylinkedlist.offsetexists.php - * @param int $index - * @return bool true if the requested index exists, otherwise false + * {@inheritdoc} + * @param mixed $index */ - public function offsetExists (int $index): bool {} + public function offsetExists ($index = null) {} /** - * Returns the value at the specified $index - * @link http://www.php.net/manual/en/spldoublylinkedlist.offsetget.php - * @param int $index - * @return mixed The value at the specified index. + * {@inheritdoc} + * @param mixed $index */ - public function offsetGet (int $index): mixed {} + public function offsetGet ($index = null) {} /** - * Sets the value at the specified $index to $value - * @link http://www.php.net/manual/en/spldoublylinkedlist.offsetset.php - * @param int|null $index - * @param mixed $value - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $index + * @param mixed $value */ - public function offsetSet (?int $index, mixed $value): void {} + public function offsetSet ($index = null, mixed $value = null) {} /** - * Unsets the value at the specified $index - * @link http://www.php.net/manual/en/spldoublylinkedlist.offsetunset.php - * @param int $index - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $index */ - public function offsetUnset (int $index): void {} + public function offsetUnset ($index = null) {} /** - * Rewind iterator back to the start - * @link http://www.php.net/manual/en/spldoublylinkedlist.rewind.php - * @return void No value is returned. + * {@inheritdoc} */ - public function rewind (): void {} + public function rewind () {} /** - * Return current array entry - * @link http://www.php.net/manual/en/spldoublylinkedlist.current.php - * @return mixed The current node value. + * {@inheritdoc} */ - public function current (): mixed {} + public function current () {} /** - * Return current node index - * @link http://www.php.net/manual/en/spldoublylinkedlist.key.php - * @return int The current node index. + * {@inheritdoc} */ - public function key (): int {} + public function key () {} /** - * Move to previous entry - * @link http://www.php.net/manual/en/spldoublylinkedlist.prev.php - * @return void No value is returned. + * {@inheritdoc} */ - public function prev (): void {} + public function prev () {} /** - * Move to next entry - * @link http://www.php.net/manual/en/spldoublylinkedlist.next.php - * @return void No value is returned. + * {@inheritdoc} */ - public function next (): void {} + public function next () {} /** - * Check whether the doubly linked list contains more nodes - * @link http://www.php.net/manual/en/spldoublylinkedlist.valid.php - * @return bool Returns
false otherwise. + * {@inheritdoc} */ - public function valid (): bool {} + public function valid () {} /** - * Unserializes the storage - * @link http://www.php.net/manual/en/spldoublylinkedlist.unserialize.php - * @param string $data The serialized string. - * @return void No value is returned. + * {@inheritdoc} + * @param string $data */ - public function unserialize (string $data): void {} + public function unserialize (string $data) {} /** - * Serializes the storage - * @link http://www.php.net/manual/en/spldoublylinkedlist.serialize.php - * @return string The serialized string. + * {@inheritdoc} */ - public function serialize (): string {} + public function serialize () {} /** * {@inheritdoc} @@ -6705,11 +4615,6 @@ public function __unserialize (array $data) {} } -/** - * The SplStack class provides the main functionalities of a stack implemented using a doubly linked list by - * setting the iterator mode to SplDoublyLinkedList::IT_MODE_LIFO. - * @link http://www.php.net/manual/en/class.splstack.php - */ class SplStack extends SplDoublyLinkedList implements Serializable, ArrayAccess, Countable, Traversable, Iterator { const IT_MODE_LIFO = 2; const IT_MODE_FIFO = 0; @@ -6718,57 +4623,43 @@ class SplStack extends SplDoublyLinkedList implements Serializable, ArrayAccess, /** - * Add/insert a new value at the specified index - * @link http://www.php.net/manual/en/spldoublylinkedlist.add.php - * @param int $index - * @param mixed $value - * @return void No value is returned. + * {@inheritdoc} + * @param int $index + * @param mixed $value */ - public function add (int $index, mixed $value): void {} + public function add (int $index, mixed $value = null) {} /** - * Pops a node from the end of the doubly linked list - * @link http://www.php.net/manual/en/spldoublylinkedlist.pop.php - * @return mixed The value of the popped node. + * {@inheritdoc} */ - public function pop (): mixed {} + public function pop () {} /** - * Shifts a node from the beginning of the doubly linked list - * @link http://www.php.net/manual/en/spldoublylinkedlist.shift.php - * @return mixed The value of the shifted node. + * {@inheritdoc} */ - public function shift (): mixed {} + public function shift () {} /** - * Pushes an element at the end of the doubly linked list - * @link http://www.php.net/manual/en/spldoublylinkedlist.push.php - * @param mixed $value - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $value */ - public function push (mixed $value): void {} + public function push (mixed $value = null) {} /** - * Prepends the doubly linked list with an element - * @link http://www.php.net/manual/en/spldoublylinkedlist.unshift.php - * @param mixed $value - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $value */ - public function unshift (mixed $value): void {} + public function unshift (mixed $value = null) {} /** - * Peeks at the node from the end of the doubly linked list - * @link http://www.php.net/manual/en/spldoublylinkedlist.top.php - * @return mixed The value of the last node. + * {@inheritdoc} */ - public function top (): mixed {} + public function top () {} /** - * Peeks at the node from the beginning of the doubly linked list - * @link http://www.php.net/manual/en/spldoublylinkedlist.bottom.php - * @return mixed The value of the first node. + * {@inheritdoc} */ - public function bottom (): mixed {} + public function bottom () {} /** * {@inheritdoc} @@ -6776,123 +4667,91 @@ public function bottom (): mixed {} public function __debugInfo () {} /** - * Counts the number of elements in the doubly linked list - * @link http://www.php.net/manual/en/spldoublylinkedlist.count.php - * @return int Returns the number of elements in the doubly linked list. + * {@inheritdoc} */ - public function count (): int {} + public function count () {} /** - * Checks whether the doubly linked list is empty - * @link http://www.php.net/manual/en/spldoublylinkedlist.isempty.php - * @return bool Returns whether the doubly linked list is empty. + * {@inheritdoc} */ - public function isEmpty (): bool {} + public function isEmpty () {} /** - * Sets the mode of iteration - * @link http://www.php.net/manual/en/spldoublylinkedlist.setiteratormode.php - * @param int $mode - * @return int Returns the different modes and flags that affect the iteration. + * {@inheritdoc} + * @param int $mode */ - public function setIteratorMode (int $mode): int {} + public function setIteratorMode (int $mode) {} /** - * Returns the mode of iteration - * @link http://www.php.net/manual/en/spldoublylinkedlist.getiteratormode.php - * @return int Returns the different modes and flags that affect the iteration. + * {@inheritdoc} */ - public function getIteratorMode (): int {} + public function getIteratorMode () {} /** - * Returns whether the requested $index exists - * @link http://www.php.net/manual/en/spldoublylinkedlist.offsetexists.php - * @param int $index - * @return bool true if the requested index exists, otherwise false + * {@inheritdoc} + * @param mixed $index */ - public function offsetExists (int $index): bool {} + public function offsetExists ($index = null) {} /** - * Returns the value at the specified $index - * @link http://www.php.net/manual/en/spldoublylinkedlist.offsetget.php - * @param int $index - * @return mixed The value at the specified index. + * {@inheritdoc} + * @param mixed $index */ - public function offsetGet (int $index): mixed {} + public function offsetGet ($index = null) {} /** - * Sets the value at the specified $index to $value - * @link http://www.php.net/manual/en/spldoublylinkedlist.offsetset.php - * @param int|null $index - * @param mixed $value - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $index + * @param mixed $value */ - public function offsetSet (?int $index, mixed $value): void {} + public function offsetSet ($index = null, mixed $value = null) {} /** - * Unsets the value at the specified $index - * @link http://www.php.net/manual/en/spldoublylinkedlist.offsetunset.php - * @param int $index - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $index */ - public function offsetUnset (int $index): void {} + public function offsetUnset ($index = null) {} /** - * Rewind iterator back to the start - * @link http://www.php.net/manual/en/spldoublylinkedlist.rewind.php - * @return void No value is returned. + * {@inheritdoc} */ - public function rewind (): void {} + public function rewind () {} /** - * Return current array entry - * @link http://www.php.net/manual/en/spldoublylinkedlist.current.php - * @return mixed The current node value. + * {@inheritdoc} */ - public function current (): mixed {} + public function current () {} /** - * Return current node index - * @link http://www.php.net/manual/en/spldoublylinkedlist.key.php - * @return int The current node index. + * {@inheritdoc} */ - public function key (): int {} + public function key () {} /** - * Move to previous entry - * @link http://www.php.net/manual/en/spldoublylinkedlist.prev.php - * @return void No value is returned. + * {@inheritdoc} */ - public function prev (): void {} + public function prev () {} /** - * Move to next entry - * @link http://www.php.net/manual/en/spldoublylinkedlist.next.php - * @return void No value is returned. + * {@inheritdoc} */ - public function next (): void {} + public function next () {} /** - * Check whether the doubly linked list contains more nodes - * @link http://www.php.net/manual/en/spldoublylinkedlist.valid.php - * @return bool Returns
false otherwise. + * {@inheritdoc} */ - public function valid (): bool {} + public function valid () {} /** - * Unserializes the storage - * @link http://www.php.net/manual/en/spldoublylinkedlist.unserialize.php - * @param string $data The serialized string. - * @return void No value is returned. + * {@inheritdoc} + * @param string $data */ - public function unserialize (string $data): void {} + public function unserialize (string $data) {} /** - * Serializes the storage - * @link http://www.php.net/manual/en/spldoublylinkedlist.serialize.php - * @return string The serialized string. + * {@inheritdoc} */ - public function serialize (): string {} + public function serialize () {} /** * {@inheritdoc} @@ -6907,106 +4766,75 @@ public function __unserialize (array $data) {} } -/** - * The SplHeap class provides the main functionalities of a Heap. - * @link http://www.php.net/manual/en/class.splheap.php - */ abstract class SplHeap implements Iterator, Traversable, Countable { /** - * Extracts a node from top of the heap and sift up - * @link http://www.php.net/manual/en/splheap.extract.php - * @return mixed The value of the extracted node. + * {@inheritdoc} */ - public function extract (): mixed {} + public function extract () {} /** - * Inserts an element in the heap by sifting it up - * @link http://www.php.net/manual/en/splheap.insert.php - * @param mixed $value - * @return true Always returns true. + * {@inheritdoc} + * @param mixed $value */ - public function insert (mixed $value): true {} + public function insert (mixed $value = null) {} /** - * Peeks at the node from the top of the heap - * @link http://www.php.net/manual/en/splheap.top.php - * @return mixed The value of the node on the top. + * {@inheritdoc} */ - public function top (): mixed {} + public function top () {} /** - * Counts the number of elements in the heap - * @link http://www.php.net/manual/en/splheap.count.php - * @return int Returns the number of elements in the heap. + * {@inheritdoc} */ - public function count (): int {} + public function count () {} /** - * Checks whether the heap is empty - * @link http://www.php.net/manual/en/splheap.isempty.php - * @return bool Returns whether the heap is empty. + * {@inheritdoc} */ - public function isEmpty (): bool {} + public function isEmpty () {} /** - * Rewind iterator back to the start (no-op) - * @link http://www.php.net/manual/en/splheap.rewind.php - * @return void No value is returned. + * {@inheritdoc} */ - public function rewind (): void {} + public function rewind () {} /** - * Return current node pointed by the iterator - * @link http://www.php.net/manual/en/splheap.current.php - * @return mixed The current node value. + * {@inheritdoc} */ - public function current (): mixed {} + public function current () {} /** - * Return current node index - * @link http://www.php.net/manual/en/splheap.key.php - * @return int The current node index. + * {@inheritdoc} */ - public function key (): int {} + public function key () {} /** - * Move to the next node - * @link http://www.php.net/manual/en/splheap.next.php - * @return void No value is returned. + * {@inheritdoc} */ - public function next (): void {} + public function next () {} /** - * Check whether the heap contains more nodes - * @link http://www.php.net/manual/en/splheap.valid.php - * @return bool Returns true if the heap contains any more nodes, false otherwise. + * {@inheritdoc} */ - public function valid (): bool {} + public function valid () {} /** - * Recover from the corrupted state and allow further actions on the heap - * @link http://www.php.net/manual/en/splheap.recoverfromcorruption.php - * @return bool Always returns true. + * {@inheritdoc} */ - public function recoverFromCorruption (): bool {} + public function recoverFromCorruption () {} /** - * Compare elements in order to place them correctly in the heap while sifting up - * @link http://www.php.net/manual/en/splheap.compare.php - * @param mixed $value1 - * @param mixed $value2 - * @return int Result of the comparison, positive integer if value1 is greater than value2, 0 if they are equal, negative integer otherwise. - *
Having multiple elements with the same value in a Heap is not recommended. They will end up in an arbitrary relative position.
+ * {@inheritdoc} + * @param mixed $value1 + * @param mixed $value2 */ - abstract protected function compare (mixed $value1, mixed $value2): int; + abstract protected function compare (mixed $value1 = null, mixed $value2 = null); /** - * Tells if the heap is in a corrupted state - * @link http://www.php.net/manual/en/splheap.iscorrupted.php - * @return bool Returns true if the heap is corrupted, false otherwise. + * {@inheritdoc} */ - public function isCorrupted (): bool {} + public function isCorrupted () {} /** * {@inheritdoc} @@ -7015,106 +4843,75 @@ public function __debugInfo () {} } -/** - * The SplMinHeap class provides the main functionalities of a heap, keeping the minimum on the top. - * @link http://www.php.net/manual/en/class.splminheap.php - */ class SplMinHeap extends SplHeap implements Countable, Traversable, Iterator { /** - * Compare elements in order to place them correctly in the heap while sifting up - * @link http://www.php.net/manual/en/splminheap.compare.php - * @param mixed $value1 - * @param mixed $value2 - * @return int Result of the comparison, positive integer if value1 is lower than value2, 0 if they are equal, negative integer otherwise. - *Having multiple elements with the same value in a Heap is not recommended. They will end up in an arbitrary relative position.
+ * {@inheritdoc} + * @param mixed $value1 + * @param mixed $value2 */ - protected function compare (mixed $value1, mixed $value2): int {} + protected function compare (mixed $value1 = null, mixed $value2 = null) {} /** - * Extracts a node from top of the heap and sift up - * @link http://www.php.net/manual/en/splheap.extract.php - * @return mixed The value of the extracted node. + * {@inheritdoc} */ - public function extract (): mixed {} + public function extract () {} /** - * Inserts an element in the heap by sifting it up - * @link http://www.php.net/manual/en/splheap.insert.php - * @param mixed $value - * @return true Always returns true. + * {@inheritdoc} + * @param mixed $value */ - public function insert (mixed $value): true {} + public function insert (mixed $value = null) {} /** - * Peeks at the node from the top of the heap - * @link http://www.php.net/manual/en/splheap.top.php - * @return mixed The value of the node on the top. + * {@inheritdoc} */ - public function top (): mixed {} + public function top () {} /** - * Counts the number of elements in the heap - * @link http://www.php.net/manual/en/splheap.count.php - * @return int Returns the number of elements in the heap. + * {@inheritdoc} */ - public function count (): int {} + public function count () {} /** - * Checks whether the heap is empty - * @link http://www.php.net/manual/en/splheap.isempty.php - * @return bool Returns whether the heap is empty. + * {@inheritdoc} */ - public function isEmpty (): bool {} + public function isEmpty () {} /** - * Rewind iterator back to the start (no-op) - * @link http://www.php.net/manual/en/splheap.rewind.php - * @return void No value is returned. + * {@inheritdoc} */ - public function rewind (): void {} + public function rewind () {} /** - * Return current node pointed by the iterator - * @link http://www.php.net/manual/en/splheap.current.php - * @return mixed The current node value. + * {@inheritdoc} */ - public function current (): mixed {} + public function current () {} /** - * Return current node index - * @link http://www.php.net/manual/en/splheap.key.php - * @return int The current node index. + * {@inheritdoc} */ - public function key (): int {} + public function key () {} /** - * Move to the next node - * @link http://www.php.net/manual/en/splheap.next.php - * @return void No value is returned. + * {@inheritdoc} */ - public function next (): void {} + public function next () {} /** - * Check whether the heap contains more nodes - * @link http://www.php.net/manual/en/splheap.valid.php - * @return bool Returns true if the heap contains any more nodes, false otherwise. + * {@inheritdoc} */ - public function valid (): bool {} + public function valid () {} /** - * Recover from the corrupted state and allow further actions on the heap - * @link http://www.php.net/manual/en/splheap.recoverfromcorruption.php - * @return bool Always returns true. + * {@inheritdoc} */ - public function recoverFromCorruption (): bool {} + public function recoverFromCorruption () {} /** - * Tells if the heap is in a corrupted state - * @link http://www.php.net/manual/en/splheap.iscorrupted.php - * @return bool Returns true if the heap is corrupted, false otherwise. + * {@inheritdoc} */ - public function isCorrupted (): bool {} + public function isCorrupted () {} /** * {@inheritdoc} @@ -7123,106 +4920,75 @@ public function __debugInfo () {} } -/** - * The SplMaxHeap class provides the main functionalities of a heap, keeping the maximum on the top. - * @link http://www.php.net/manual/en/class.splmaxheap.php - */ class SplMaxHeap extends SplHeap implements Countable, Traversable, Iterator { /** - * Compare elements in order to place them correctly in the heap while sifting up - * @link http://www.php.net/manual/en/splmaxheap.compare.php - * @param mixed $value1 - * @param mixed $value2 - * @return int Result of the comparison, positive integer if value1 is greater than value2, 0 if they are equal, negative integer otherwise. - *Having multiple elements with the same value in a Heap is not recommended. They will end up in an arbitrary relative position.
+ * {@inheritdoc} + * @param mixed $value1 + * @param mixed $value2 */ - protected function compare (mixed $value1, mixed $value2): int {} + protected function compare (mixed $value1 = null, mixed $value2 = null) {} /** - * Extracts a node from top of the heap and sift up - * @link http://www.php.net/manual/en/splheap.extract.php - * @return mixed The value of the extracted node. + * {@inheritdoc} */ - public function extract (): mixed {} + public function extract () {} /** - * Inserts an element in the heap by sifting it up - * @link http://www.php.net/manual/en/splheap.insert.php - * @param mixed $value - * @return true Always returns true. + * {@inheritdoc} + * @param mixed $value */ - public function insert (mixed $value): true {} + public function insert (mixed $value = null) {} /** - * Peeks at the node from the top of the heap - * @link http://www.php.net/manual/en/splheap.top.php - * @return mixed The value of the node on the top. + * {@inheritdoc} */ - public function top (): mixed {} + public function top () {} /** - * Counts the number of elements in the heap - * @link http://www.php.net/manual/en/splheap.count.php - * @return int Returns the number of elements in the heap. + * {@inheritdoc} */ - public function count (): int {} + public function count () {} /** - * Checks whether the heap is empty - * @link http://www.php.net/manual/en/splheap.isempty.php - * @return bool Returns whether the heap is empty. + * {@inheritdoc} */ - public function isEmpty (): bool {} + public function isEmpty () {} /** - * Rewind iterator back to the start (no-op) - * @link http://www.php.net/manual/en/splheap.rewind.php - * @return void No value is returned. + * {@inheritdoc} */ - public function rewind (): void {} + public function rewind () {} /** - * Return current node pointed by the iterator - * @link http://www.php.net/manual/en/splheap.current.php - * @return mixed The current node value. + * {@inheritdoc} */ - public function current (): mixed {} + public function current () {} /** - * Return current node index - * @link http://www.php.net/manual/en/splheap.key.php - * @return int The current node index. + * {@inheritdoc} */ - public function key (): int {} + public function key () {} /** - * Move to the next node - * @link http://www.php.net/manual/en/splheap.next.php - * @return void No value is returned. + * {@inheritdoc} */ - public function next (): void {} + public function next () {} /** - * Check whether the heap contains more nodes - * @link http://www.php.net/manual/en/splheap.valid.php - * @return bool Returns true if the heap contains any more nodes, false otherwise. + * {@inheritdoc} */ - public function valid (): bool {} + public function valid () {} /** - * Recover from the corrupted state and allow further actions on the heap - * @link http://www.php.net/manual/en/splheap.recoverfromcorruption.php - * @return bool Always returns true. + * {@inheritdoc} */ - public function recoverFromCorruption (): bool {} + public function recoverFromCorruption () {} /** - * Tells if the heap is in a corrupted state - * @link http://www.php.net/manual/en/splheap.iscorrupted.php - * @return bool Returns true if the heap is corrupted, false otherwise. + * {@inheritdoc} */ - public function isCorrupted (): bool {} + public function isCorrupted () {} /** * {@inheritdoc} @@ -7231,11 +4997,6 @@ public function __debugInfo () {} } -/** - * The SplPriorityQueue class provides the main functionalities of a - * prioritized queue, implemented using a max heap. - * @link http://www.php.net/manual/en/class.splpriorityqueue.php - */ class SplPriorityQueue implements Iterator, Traversable, Countable { const EXTR_BOTH = 3; const EXTR_PRIORITY = 2; @@ -7243,115 +5004,84 @@ class SplPriorityQueue implements Iterator, Traversable, Countable { /** - * Compare priorities in order to place elements correctly in the heap while sifting up - * @link http://www.php.net/manual/en/splpriorityqueue.compare.php - * @param mixed $priority1 - * @param mixed $priority2 - * @return int Result of the comparison, positive integer if priority1 is greater than priority2, 0 if they are equal, negative integer otherwise. - *Multiple elements with the same priority will get dequeued in no particular order.
+ * {@inheritdoc} + * @param mixed $priority1 + * @param mixed $priority2 */ - public function compare (mixed $priority1, mixed $priority2): int {} + public function compare (mixed $priority1 = null, mixed $priority2 = null) {} /** - * Inserts an element in the queue by sifting it up - * @link http://www.php.net/manual/en/splpriorityqueue.insert.php - * @param mixed $value - * @param mixed $priority - * @return bool Returns true. + * {@inheritdoc} + * @param mixed $value + * @param mixed $priority */ - public function insert (mixed $value, mixed $priority): bool {} + public function insert (mixed $value = null, mixed $priority = null) {} /** - * Sets the mode of extraction - * @link http://www.php.net/manual/en/splpriorityqueue.setextractflags.php - * @param int $flags - * @return int Returns the flags of extraction. + * {@inheritdoc} + * @param int $flags */ - public function setExtractFlags (int $flags): int {} + public function setExtractFlags (int $flags) {} /** - * Peeks at the node from the top of the queue - * @link http://www.php.net/manual/en/splpriorityqueue.top.php - * @return mixed The value or priority (or both) of the top node, depending on the extract flag. + * {@inheritdoc} */ - public function top (): mixed {} + public function top () {} /** - * Extracts a node from top of the heap and sift up - * @link http://www.php.net/manual/en/splpriorityqueue.extract.php - * @return mixed The value or priority (or both) of the extracted node, depending on the extract flag. + * {@inheritdoc} */ - public function extract (): mixed {} + public function extract () {} /** - * Counts the number of elements in the queue - * @link http://www.php.net/manual/en/splpriorityqueue.count.php - * @return int Returns the number of elements in the queue. + * {@inheritdoc} */ - public function count (): int {} + public function count () {} /** - * Checks whether the queue is empty - * @link http://www.php.net/manual/en/splpriorityqueue.isempty.php - * @return bool Returns whether the queue is empty. + * {@inheritdoc} */ - public function isEmpty (): bool {} + public function isEmpty () {} /** - * Rewind iterator back to the start (no-op) - * @link http://www.php.net/manual/en/splpriorityqueue.rewind.php - * @return void No value is returned. + * {@inheritdoc} */ - public function rewind (): void {} + public function rewind () {} /** - * Return current node pointed by the iterator - * @link http://www.php.net/manual/en/splpriorityqueue.current.php - * @return mixed The value or priority (or both) of the current node, depending on the extract flag. + * {@inheritdoc} */ - public function current (): mixed {} + public function current () {} /** - * Return current node index - * @link http://www.php.net/manual/en/splpriorityqueue.key.php - * @return int The current node index. + * {@inheritdoc} */ - public function key (): int {} + public function key () {} /** - * Move to the next node - * @link http://www.php.net/manual/en/splpriorityqueue.next.php - * @return void No value is returned. + * {@inheritdoc} */ - public function next (): void {} + public function next () {} /** - * Check whether the queue contains more nodes - * @link http://www.php.net/manual/en/splpriorityqueue.valid.php - * @return bool Returns true if the queue contains any more nodes, false otherwise. + * {@inheritdoc} */ - public function valid (): bool {} + public function valid () {} /** - * Recover from the corrupted state and allow further actions on the queue - * @link http://www.php.net/manual/en/splpriorityqueue.recoverfromcorruption.php - * @return bool Always returns true. + * {@inheritdoc} */ - public function recoverFromCorruption (): bool {} + public function recoverFromCorruption () {} /** - * Tells if the priority queue is in a corrupted state - * @link http://www.php.net/manual/en/splpriorityqueue.iscorrupted.php - * @return bool Returns true if the priority queue is corrupted, false otherwise. + * {@inheritdoc} */ - public function isCorrupted (): bool {} + public function isCorrupted () {} /** - * Get the flags of extraction - * @link http://www.php.net/manual/en/splpriorityqueue.getextractflags.php - * @return int Returns the flags of extraction. + * {@inheritdoc} */ - public function getExtractFlags (): int {} + public function getExtractFlags () {} /** * {@inheritdoc} @@ -7360,30 +5090,18 @@ public function __debugInfo () {} } -/** - * The SplFixedArray class provides the main functionalities of array. The - * main difference between a SplFixedArray and a normal PHP array is that - * the SplFixedArray must be resized manually and allows only integers within - * the range as indexes. The advantage is that it uses less memory than - * a standard array. - * @link http://www.php.net/manual/en/class.splfixedarray.php - */ class SplFixedArray implements IteratorAggregate, Traversable, ArrayAccess, Countable, JsonSerializable { /** - * Constructs a new fixed array - * @link http://www.php.net/manual/en/splfixedarray.construct.php - * @param int $size [optional] - * @return int + * {@inheritdoc} + * @param int $size [optional] */ - public function __construct (int $size = null): int {} + public function __construct (int $size = 0) {} /** - * Reinitialises the array after being unserialised - * @link http://www.php.net/manual/en/splfixedarray.wakeup.php - * @return void No value is returned. + * {@inheritdoc} */ - public function __wakeup (): void {} + public function __wakeup () {} /** * {@inheritdoc} @@ -7397,76 +5115,57 @@ public function __serialize (): array {} public function __unserialize (array $data): void {} /** - * Returns the size of the array - * @link http://www.php.net/manual/en/splfixedarray.count.php - * @return int Returns the size of the array. + * {@inheritdoc} */ - public function count (): int {} + public function count () {} /** - * Returns a PHP array from the fixed array - * @link http://www.php.net/manual/en/splfixedarray.toarray.php - * @return array Returns a PHP array, similar to the fixed array. + * {@inheritdoc} */ - public function toArray (): array {} + public function toArray () {} /** - * Import a PHP array in a SplFixedArray instance - * @link http://www.php.net/manual/en/splfixedarray.fromarray.php - * @param array $array - * @param bool $preserveKeys [optional] - * @return SplFixedArray Returns an instance of SplFixedArray - * containing the array content. + * {@inheritdoc} + * @param array $array + * @param bool $preserveKeys [optional] */ - public static function fromArray (array $array, bool $preserveKeys = true): SplFixedArray {} + public static function fromArray (array $array, bool $preserveKeys = true) {} /** - * Gets the size of the array - * @link http://www.php.net/manual/en/splfixedarray.getsize.php - * @return int Returns the size of the array, as an int. + * {@inheritdoc} */ - public function getSize (): int {} + public function getSize () {} /** - * Change the size of an array - * @link http://www.php.net/manual/en/splfixedarray.setsize.php - * @param int $size - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $size */ - public function setSize (int $size): bool {} + public function setSize (int $size) {} /** - * Returns whether the requested index exists - * @link http://www.php.net/manual/en/splfixedarray.offsetexists.php - * @param int $index - * @return bool true if the requested index exists, otherwise false + * {@inheritdoc} + * @param mixed $index */ - public function offsetExists (int $index): bool {} + public function offsetExists ($index = null) {} /** - * Returns the value at the specified index - * @link http://www.php.net/manual/en/splfixedarray.offsetget.php - * @param int $index - * @return mixed The value at the specified index. + * {@inheritdoc} + * @param mixed $index */ - public function offsetGet (int $index): mixed {} + public function offsetGet ($index = null) {} /** - * Sets a new value at a specified index - * @link http://www.php.net/manual/en/splfixedarray.offsetset.php - * @param int $index - * @param mixed $value - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $index + * @param mixed $value */ - public function offsetSet (int $index, mixed $value): void {} + public function offsetSet ($index = null, mixed $value = null) {} /** - * Unsets the value at the specified $index - * @link http://www.php.net/manual/en/splfixedarray.offsetunset.php - * @param int $index - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $index */ - public function offsetUnset (int $index): void {} + public function offsetUnset ($index = null) {} /** * {@inheritdoc} @@ -7480,226 +5179,159 @@ public function jsonSerialize (): array {} } -/** - * The SplObserver interface is used alongside - * SplSubject to implement the Observer Design Pattern. - * @link http://www.php.net/manual/en/class.splobserver.php - */ interface SplObserver { /** - * Receive update from subject - * @link http://www.php.net/manual/en/splobserver.update.php - * @param SplSubject $subject - * @return void No value is returned. + * {@inheritdoc} + * @param SplSubject $subject */ - abstract public function update (SplSubject $subject): void; + abstract public function update (SplSubject $subject); } -/** - * The SplSubject interface is used alongside - * SplObserver to implement the Observer Design Pattern. - * @link http://www.php.net/manual/en/class.splsubject.php - */ interface SplSubject { /** - * Attach an SplObserver - * @link http://www.php.net/manual/en/splsubject.attach.php - * @param SplObserver $observer - * @return void No value is returned. + * {@inheritdoc} + * @param SplObserver $observer */ - abstract public function attach (SplObserver $observer): void; + abstract public function attach (SplObserver $observer); /** - * Detach an observer - * @link http://www.php.net/manual/en/splsubject.detach.php - * @param SplObserver $observer - * @return void No value is returned. + * {@inheritdoc} + * @param SplObserver $observer */ - abstract public function detach (SplObserver $observer): void; + abstract public function detach (SplObserver $observer); /** - * Notify an observer - * @link http://www.php.net/manual/en/splsubject.notify.php - * @return void No value is returned. + * {@inheritdoc} */ - abstract public function notify (): void; + abstract public function notify (); } -/** - * 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 http://www.php.net/manual/en/class.splobjectstorage.php - */ class SplObjectStorage implements Countable, Iterator, Traversable, Serializable, ArrayAccess { /** - * Adds an object in the storage - * @link http://www.php.net/manual/en/splobjectstorage.attach.php - * @param object $object - * @param mixed $info [optional] - * @return void No value is returned. + * {@inheritdoc} + * @param object $object + * @param mixed $info [optional] */ - public function attach (object $object, mixed $info = null): void {} + public function attach (object $object, mixed $info = NULL) {} /** - * Removes an object from the storage - * @link http://www.php.net/manual/en/splobjectstorage.detach.php - * @param object $object - * @return void No value is returned. + * {@inheritdoc} + * @param object $object */ - public function detach (object $object): void {} + public function detach (object $object) {} /** - * Checks if the storage contains a specific object - * @link http://www.php.net/manual/en/splobjectstorage.contains.php - * @param object $object - * @return bool Returns true if the object is in the storage, false otherwise. + * {@inheritdoc} + * @param object $object */ - public function contains (object $object): bool {} + public function contains (object $object) {} /** - * Adds all objects from another storage - * @link http://www.php.net/manual/en/splobjectstorage.addall.php - * @param SplObjectStorage $storage - * @return int The number of objects in the storage. + * {@inheritdoc} + * @param SplObjectStorage $storage */ - public function addAll (SplObjectStorage $storage): int {} + public function addAll (SplObjectStorage $storage) {} /** - * Removes objects contained in another storage from the current storage - * @link http://www.php.net/manual/en/splobjectstorage.removeall.php - * @param SplObjectStorage $storage - * @return int Returns the number of remaining objects. + * {@inheritdoc} + * @param SplObjectStorage $storage */ - public function removeAll (SplObjectStorage $storage): int {} + public function removeAll (SplObjectStorage $storage) {} /** - * Removes all objects except for those contained in another storage from the current storage - * @link http://www.php.net/manual/en/splobjectstorage.removeallexcept.php - * @param SplObjectStorage $storage - * @return int Returns the number of remaining objects. + * {@inheritdoc} + * @param SplObjectStorage $storage */ - public function removeAllExcept (SplObjectStorage $storage): int {} + public function removeAllExcept (SplObjectStorage $storage) {} /** - * Returns the data associated with the current iterator entry - * @link http://www.php.net/manual/en/splobjectstorage.getinfo.php - * @return mixed The data associated with the current iterator position. + * {@inheritdoc} */ - public function getInfo (): mixed {} + public function getInfo () {} /** - * Sets the data associated with the current iterator entry - * @link http://www.php.net/manual/en/splobjectstorage.setinfo.php - * @param mixed $info - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $info */ - public function setInfo (mixed $info): void {} + public function setInfo (mixed $info = null) {} /** - * Returns the number of objects in the storage - * @link http://www.php.net/manual/en/splobjectstorage.count.php - * @param int $mode [optional] - * @return int The number of objects in the storage. + * {@inheritdoc} + * @param int $mode [optional] */ - public function count (int $mode = COUNT_NORMAL): int {} + public function count (int $mode = 0) {} /** - * Rewind the iterator to the first storage element - * @link http://www.php.net/manual/en/splobjectstorage.rewind.php - * @return void No value is returned. + * {@inheritdoc} */ - public function rewind (): void {} + public function rewind () {} /** - * Returns if the current iterator entry is valid - * @link http://www.php.net/manual/en/splobjectstorage.valid.php - * @return bool Returns true if the iterator entry is valid, false otherwise. + * {@inheritdoc} */ - public function valid (): bool {} + public function valid () {} /** - * Returns the index at which the iterator currently is - * @link http://www.php.net/manual/en/splobjectstorage.key.php - * @return int The index corresponding to the position of the iterator. + * {@inheritdoc} */ - public function key (): int {} + public function key () {} /** - * Returns the current storage entry - * @link http://www.php.net/manual/en/splobjectstorage.current.php - * @return object The object at the current iterator position. + * {@inheritdoc} */ - public function current (): object {} + public function current () {} /** - * Move to the next entry - * @link http://www.php.net/manual/en/splobjectstorage.next.php - * @return void No value is returned. + * {@inheritdoc} */ - public function next (): void {} + public function next () {} /** - * Unserializes a storage from its string representation - * @link http://www.php.net/manual/en/splobjectstorage.unserialize.php - * @param string $data - * @return void No value is returned. + * {@inheritdoc} + * @param string $data */ - public function unserialize (string $data): void {} + public function unserialize (string $data) {} /** - * Serializes the storage - * @link http://www.php.net/manual/en/splobjectstorage.serialize.php - * @return string A string representing the storage. + * {@inheritdoc} */ - public function serialize (): string {} + public function serialize () {} /** - * Checks whether an object exists in the storage - * @link http://www.php.net/manual/en/splobjectstorage.offsetexists.php - * @param object $object - * @return bool Returns true if the object exists in the storage, - * and false otherwise. + * {@inheritdoc} + * @param mixed $object */ - public function offsetExists (object $object): bool {} + public function offsetExists ($object = null) {} /** - * Returns the data associated with an object - * @link http://www.php.net/manual/en/splobjectstorage.offsetget.php - * @param object $object - * @return mixed The data previously associated with the object in the storage. + * {@inheritdoc} + * @param mixed $object */ - public function offsetGet (object $object): mixed {} + public function offsetGet ($object = null) {} /** - * Associates data to an object in the storage - * @link http://www.php.net/manual/en/splobjectstorage.offsetset.php - * @param object $object - * @param mixed $info [optional] - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $object + * @param mixed $info [optional] */ - public function offsetSet (object $object, mixed $info = null): void {} + public function offsetSet ($object = null, mixed $info = NULL) {} /** - * Removes an object from the storage - * @link http://www.php.net/manual/en/splobjectstorage.offsetunset.php - * @param object $object - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $object */ - public function offsetUnset (object $object): void {} + public function offsetUnset ($object = null) {} /** - * Calculate a unique identifier for the contained objects - * @link http://www.php.net/manual/en/splobjectstorage.gethash.php - * @param object $object The object whose identifier is to be calculated. - * @return string A string with the calculated identifier. + * {@inheritdoc} + * @param object $object */ - public function getHash (object $object): string {} + public function getHash (object $object) {} /** * {@inheritdoc} @@ -7719,115 +5351,78 @@ public function __debugInfo () {} } -/** - * An Iterator that sequentially iterates over all attached iterators - * @link http://www.php.net/manual/en/class.multipleiterator.php - */ class MultipleIterator implements Iterator, Traversable { - /** - * Do not require all sub iterators to be valid in iteration. const MIT_NEED_ANY = 0; - /** - * Require all sub iterators to be valid in iteration. const MIT_NEED_ALL = 1; - /** - * Keys are created from the sub iterators position. const MIT_KEYS_NUMERIC = 0; - /** - * Keys are created from sub iterators associated information. const MIT_KEYS_ASSOC = 2; /** - * Constructs a new MultipleIterator - * @link http://www.php.net/manual/en/multipleiterator.construct.php - * @param int $flags [optional] - * @return int + * {@inheritdoc} + * @param int $flags [optional] */ - public function __construct (int $flags = 'MultipleIterator::MIT_NEED_ALL | MultipleIterator::MIT_KEYS_NUMERIC'): int {} + public function __construct (int $flags = 1) {} /** - * Gets the flag information - * @link http://www.php.net/manual/en/multipleiterator.getflags.php - * @return int Information about the flags, as an int. + * {@inheritdoc} */ - public function getFlags (): int {} + public function getFlags () {} /** - * Sets flags - * @link http://www.php.net/manual/en/multipleiterator.setflags.php - * @param int $flags - * @return void No value is returned. + * {@inheritdoc} + * @param int $flags */ - public function setFlags (int $flags): void {} + public function setFlags (int $flags) {} /** - * Attaches iterator information - * @link http://www.php.net/manual/en/multipleiterator.attachiterator.php - * @param Iterator $iterator - * @param string|int|null $info [optional] - * @return void Description... + * {@inheritdoc} + * @param Iterator $iterator + * @param string|int|null $info [optional] */ - public function attachIterator (Iterator $iterator, string|int|null $info = null): void {} + public function attachIterator (Iterator $iterator, string|int|null $info = NULL) {} /** - * Detaches an iterator - * @link http://www.php.net/manual/en/multipleiterator.detachiterator.php - * @param Iterator $iterator - * @return void No value is returned. + * {@inheritdoc} + * @param Iterator $iterator */ - public function detachIterator (Iterator $iterator): void {} + public function detachIterator (Iterator $iterator) {} /** - * Checks if an iterator is attached - * @link http://www.php.net/manual/en/multipleiterator.containsiterator.php - * @param Iterator $iterator - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param Iterator $iterator */ - public function containsIterator (Iterator $iterator): bool {} + public function containsIterator (Iterator $iterator) {} /** - * Gets the number of attached iterator instances - * @link http://www.php.net/manual/en/multipleiterator.countiterators.php - * @return int The number of attached iterator instances (as an int). + * {@inheritdoc} */ - public function countIterators (): int {} + public function countIterators () {} /** - * Rewinds all attached iterator instances - * @link http://www.php.net/manual/en/multipleiterator.rewind.php - * @return void No value is returned. + * {@inheritdoc} */ - public function rewind (): void {} + public function rewind () {} /** - * Checks the validity of sub iterators - * @link http://www.php.net/manual/en/multipleiterator.valid.php - * @return bool Returns true if one or all sub iterators are valid depending on flags, - * otherwise false + * {@inheritdoc} */ - public function valid (): bool {} + public function valid () {} /** - * Gets the registered iterator instances - * @link http://www.php.net/manual/en/multipleiterator.key.php - * @return array An array of all registered iterator instances. + * {@inheritdoc} */ - public function key (): array {} + public function key () {} /** - * Gets the registered iterator instances - * @link http://www.php.net/manual/en/multipleiterator.current.php - * @return array An array containing the current values of each attached iterator. + * {@inheritdoc} */ - public function current (): array {} + public function current () {} /** - * Moves all attached iterator instances forward - * @link http://www.php.net/manual/en/multipleiterator.next.php - * @return void No value is returned. + * {@inheritdoc} */ - public function next (): void {} + public function next () {} /** * {@inheritdoc} @@ -7837,135 +5432,100 @@ public function __debugInfo () {} } /** - * Return the interfaces which are implemented by the given class or interface - * @link http://www.php.net/manual/en/function.class-implements.php - * @param object|string $object_or_class - * @param bool $autoload [optional] - * @return array|false An array on success, or false when the given class doesn't exist. + * {@inheritdoc} + * @param mixed $object_or_class + * @param bool $autoload [optional] */ -function class_implements (object|string $object_or_class, bool $autoload = true): array|false {} +function class_implements ($object_or_class = null, bool $autoload = true): array|false {} /** - * Return the parent classes of the given class - * @link http://www.php.net/manual/en/function.class-parents.php - * @param object|string $object_or_class - * @param bool $autoload [optional] - * @return array|false An array on success, or false when the given class doesn't exist. + * {@inheritdoc} + * @param mixed $object_or_class + * @param bool $autoload [optional] */ -function class_parents (object|string $object_or_class, bool $autoload = true): array|false {} +function class_parents ($object_or_class = null, bool $autoload = true): array|false {} /** - * Return the traits used by the given class - * @link http://www.php.net/manual/en/function.class-uses.php - * @param object|string $object_or_class - * @param bool $autoload [optional] - * @return array|false An array on success, or false when the given class doesn't exist. + * {@inheritdoc} + * @param mixed $object_or_class + * @param bool $autoload [optional] */ -function class_uses (object|string $object_or_class, bool $autoload = true): array|false {} +function class_uses ($object_or_class = null, bool $autoload = true): array|false {} /** - * Default implementation for __autoload() - * @link http://www.php.net/manual/en/function.spl-autoload.php - * @param string $class - * @param string|null $file_extensions [optional] - * @return void No value is returned. + * {@inheritdoc} + * @param string $class + * @param string|null $file_extensions [optional] */ -function spl_autoload (string $class, ?string $file_extensions = null): void {} +function spl_autoload (string $class, ?string $file_extensions = NULL): void {} /** - * Try all registered __autoload() functions to load the requested class - * @link http://www.php.net/manual/en/function.spl-autoload-call.php - * @param string $class - * @return void No value is returned. + * {@inheritdoc} + * @param string $class */ function spl_autoload_call (string $class): void {} /** - * Register and return default file extensions for spl_autoload - * @link http://www.php.net/manual/en/function.spl-autoload-extensions.php - * @param string|null $file_extensions [optional] - * @return string A comma delimited list of default file extensions for - * spl_autoload. + * {@inheritdoc} + * @param string|null $file_extensions [optional] */ -function spl_autoload_extensions (?string $file_extensions = null): string {} +function spl_autoload_extensions (?string $file_extensions = NULL): string {} /** - * Return all registered __autoload() functions - * @link http://www.php.net/manual/en/function.spl-autoload-functions.php - * @return array An array of all registered __autoload functions. - * If no function is registered, or the autoload queue is not activated, - * then the return value will be an empty array. + * {@inheritdoc} */ function spl_autoload_functions (): array {} /** - * Register given function as __autoload() implementation - * @link http://www.php.net/manual/en/function.spl-autoload-register.php - * @param callable|null $callback [optional] - * @param bool $throw [optional] - * @param bool $prepend [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param callable|null $callback [optional] + * @param bool $throw [optional] + * @param bool $prepend [optional] */ -function spl_autoload_register (?callable $callback = null, bool $throw = true, bool $prepend = false): bool {} +function spl_autoload_register (?callable $callback = NULL, bool $throw = true, bool $prepend = false): bool {} /** - * Unregister given function as __autoload() implementation - * @link http://www.php.net/manual/en/function.spl-autoload-unregister.php - * @param callable $callback - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param callable $callback */ function spl_autoload_unregister (callable $callback): bool {} /** - * Return available SPL classes - * @link http://www.php.net/manual/en/function.spl-classes.php - * @return array Returns an array containing the currently available SPL classes. + * {@inheritdoc} */ function spl_classes (): array {} /** - * Return hash id for given object - * @link http://www.php.net/manual/en/function.spl-object-hash.php - * @param object $object - * @return string A string that is unique for each currently existing object and is always - * the same for each object. + * {@inheritdoc} + * @param object $object */ function spl_object_hash (object $object): string {} /** - * Return the integer object handle for given object - * @link http://www.php.net/manual/en/function.spl-object-id.php - * @param object $object - * @return int An integer identifier that is unique for each currently existing object and - * is always the same for each object. + * {@inheritdoc} + * @param object $object */ function spl_object_id (object $object): int {} /** - * Call a function for every element in an iterator - * @link http://www.php.net/manual/en/function.iterator-apply.php - * @param Traversable $iterator - * @param callable $callback - * @param array|null $args [optional] - * @return int Returns the iteration count. + * {@inheritdoc} + * @param Traversable $iterator + * @param callable $callback + * @param array|null $args [optional] */ -function iterator_apply (Traversable $iterator, callable $callback, ?array $args = null): int {} +function iterator_apply (Traversable $iterator, callable $callback, ?array $args = NULL): int {} /** - * Count the elements in an iterator - * @link http://www.php.net/manual/en/function.iterator-count.php - * @param Traversable|array $iterator - * @return int The number of elements in iterator. + * {@inheritdoc} + * @param Traversable|array $iterator */ function iterator_count (Traversable|array $iterator): int {} /** - * Copy the iterator into an array - * @link http://www.php.net/manual/en/function.iterator-to-array.php - * @param Traversable|array $iterator - * @param bool $preserve_keys [optional] - * @return array An array containing the elements of the iterator. + * {@inheritdoc} + * @param Traversable|array $iterator + * @param bool $preserve_keys [optional] */ function iterator_to_array (Traversable|array $iterator, bool $preserve_keys = true): array {} -// End of SPL v.8.2.6 +// End of SPL v.8.3.0 diff --git a/plugins/org.eclipse.php.core/Resources/language/php8.3/SimpleXML.php b/plugins/org.eclipse.php.core/Resources/language/php8.3/SimpleXML.php index f20ff4ef0b..acc5931beb 100644 --- a/plugins/org.eclipse.php.core/Resources/language/php8.3/SimpleXML.php +++ b/plugins/org.eclipse.php.core/Resources/language/php8.3/SimpleXML.php @@ -1,41 +1,27 @@ Returns null if called on a SimpleXMLElement - * object that already represents an attribute and not a tag. + * {@inheritdoc} + * @param string|null $namespaceOrPrefix [optional] + * @param bool $isPrefix [optional] */ - public function attributes (?string $namespaceOrPrefix = null, bool $isPrefix = false): ?SimpleXMLElement {} + public function attributes (?string $namespaceOrPrefix = NULL, bool $isPrefix = false) {} /** - * Creates a new SimpleXMLElement object - * @link http://www.php.net/manual/en/simplexmlelement.construct.php - * @param string $data - * @param int $options [optional] - * @param bool $dataIsURL [optional] - * @param string $namespaceOrPrefix [optional] - * @param bool $isPrefix [optional] - * @return string + * {@inheritdoc} + * @param string $data + * @param int $options [optional] + * @param bool $dataIsURL [optional] + * @param string $namespaceOrPrefix [optional] + * @param bool $isPrefix [optional] */ - public function __construct (string $data, int $options = null, bool $dataIsURL = false, string $namespaceOrPrefix = '""', bool $isPrefix = false): string {} + public function __construct (string $data, int $options = 0, bool $dataIsURL = false, string $namespaceOrPrefix = '', bool $isPrefix = false) {} /** - * Adds a child element to the XML node - * @link http://www.php.net/manual/en/simplexmlelement.addchild.php - * @param string $qualifiedName - * @param string|null $value [optional] - * @param string|null $namespace [optional] - * @return SimpleXMLElement|null The addChild method returns a SimpleXMLElement - * object representing the child added to the XML node on success; null on failure. + * {@inheritdoc} + * @param string $qualifiedName + * @param string|null $value [optional] + * @param string|null $namespace [optional] */ - public function addChild (string $qualifiedName, ?string $value = null, ?string $namespace = null): ?SimpleXMLElement {} + public function addChild (string $qualifiedName, ?string $value = NULL, ?string $namespace = NULL) {} /** - * Adds an attribute to the SimpleXML element - * @link http://www.php.net/manual/en/simplexmlelement.addattribute.php - * @param string $qualifiedName - * @param string $value - * @param string|null $namespace [optional] - * @return void No value is returned. + * {@inheritdoc} + * @param string $qualifiedName + * @param string $value + * @param string|null $namespace [optional] */ - public function addAttribute (string $qualifiedName, string $value, ?string $namespace = null): void {} + public function addAttribute (string $qualifiedName, string $value, ?string $namespace = NULL) {} /** - * Gets the name of the XML element - * @link http://www.php.net/manual/en/simplexmlelement.getname.php - * @return string The getName method returns as a string the - * name of the XML tag referenced by the SimpleXMLElement object. + * {@inheritdoc} */ - public function getName (): string {} + public function getName () {} /** - * Returns the string content - * @link http://www.php.net/manual/en/simplexmlelement.tostring.php - * @return string Returns the string content on success or an empty string on failure. + * {@inheritdoc} */ public function __toString (): string {} /** - * Counts the children of an element - * @link http://www.php.net/manual/en/simplexmlelement.count.php - * @return int Returns the number of elements of an element. + * {@inheritdoc} */ - public function count (): int {} + public function count () {} /** - * Rewind to the first element - * @link http://www.php.net/manual/en/simplexmlelement.rewind.php - * @return void No value is returned. + * {@inheritdoc} */ - public function rewind (): void {} + public function rewind () {} /** - * Check whether the current element is valid - * @link http://www.php.net/manual/en/simplexmlelement.valid.php - * @return bool Returns true if the current element is valid, otherwise false + * {@inheritdoc} */ - public function valid (): bool {} + public function valid () {} /** - * Returns the current element - * @link http://www.php.net/manual/en/simplexmlelement.current.php - * @return SimpleXMLElement Returns the current element as a SimpleXMLElement object. + * {@inheritdoc} */ - public function current (): SimpleXMLElement {} + public function current () {} /** - * Return current key - * @link http://www.php.net/manual/en/simplexmlelement.key.php - * @return string Returns the XML tag name of the element referenced by the current SimpleXMLElement object. + * {@inheritdoc} */ - public function key (): string {} + public function key () {} /** - * Move to next element - * @link http://www.php.net/manual/en/simplexmlelement.next.php - * @return void No value is returned. + * {@inheritdoc} */ - public function next (): void {} + public function next () {} /** - * Checks whether the current element has sub elements - * @link http://www.php.net/manual/en/simplexmlelement.haschildren.php - * @return bool true if the current element has sub-elements, otherwise false + * {@inheritdoc} */ - public function hasChildren (): bool {} + public function hasChildren () {} /** - * Returns the sub-elements of the current element - * @link http://www.php.net/manual/en/simplexmlelement.getchildren.php - * @return SimpleXMLElement|null Returns a SimpleXMLElement object containing - * the sub-elements of the current element. + * {@inheritdoc} */ - public function getChildren (): ?SimpleXMLElement {} + public function getChildren () {} } -/** - * The SimpleXMLIterator provides recursive iteration over all nodes of a SimpleXMLElement object. - * @link http://www.php.net/manual/en/class.simplexmliterator.php - */ class SimpleXMLIterator extends SimpleXMLElement implements Iterator, Traversable, RecursiveIterator, Countable, Stringable { /** - * Runs XPath query on XML data - * @link http://www.php.net/manual/en/simplexmlelement.xpath.php - * @param string $expression - * @return array|null|false Returns an array of SimpleXMLElement objects on success; or null or false in - * case of an error. + * {@inheritdoc} + * @param string $expression */ - public function xpath (string $expression): array|null|false {} + public function xpath (string $expression) {} /** - * Creates a prefix/ns context for the next XPath query - * @link http://www.php.net/manual/en/simplexmlelement.registerxpathnamespace.php - * @param string $prefix - * @param string $namespace - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $prefix + * @param string $namespace */ - public function registerXPathNamespace (string $prefix, string $namespace): bool {} + public function registerXPathNamespace (string $prefix, string $namespace) {} /** - * Return a well-formed XML string based on SimpleXML element - * @link http://www.php.net/manual/en/simplexmlelement.asxml.php - * @param string|null $filename [optional] - * @return string|bool If the filename isn't specified, this function - * returns a string on success and false on error. If the - * parameter is specified, it returns true if the file was written - * successfully and false otherwise. + * {@inheritdoc} + * @param string|null $filename [optional] */ - public function asXML (?string $filename = null): string|bool {} + public function asXML (?string $filename = NULL) {} /** * {@inheritdoc} @@ -234,187 +162,135 @@ public function asXML (?string $filename = null): string|bool {} public function saveXML (?string $filename = NULL) {} /** - * Returns namespaces used in document - * @link http://www.php.net/manual/en/simplexmlelement.getnamespaces.php - * @param bool $recursive [optional] - * @return array The getNamespaces method returns an array of - * namespace names with their associated URIs. + * {@inheritdoc} + * @param bool $recursive [optional] */ - public function getNamespaces (bool $recursive = false): array {} + public function getNamespaces (bool $recursive = false) {} /** - * Returns namespaces declared in document - * @link http://www.php.net/manual/en/simplexmlelement.getdocnamespaces.php - * @param bool $recursive [optional] - * @param bool $fromRoot [optional] - * @return array|false The getDocNamespaces method returns an array - * of namespace names with their associated URIs. + * {@inheritdoc} + * @param bool $recursive [optional] + * @param bool $fromRoot [optional] */ - public function getDocNamespaces (bool $recursive = false, bool $fromRoot = true): array|false {} + public function getDocNamespaces (bool $recursive = false, bool $fromRoot = true) {} /** - * Finds children of given node - * @link http://www.php.net/manual/en/simplexmlelement.children.php - * @param string|null $namespaceOrPrefix [optional] - * @param bool $isPrefix [optional] - * @return SimpleXMLElement|null Returns a SimpleXMLElement element, whether the node - * has children or not, unless the node represents an attribute, in which case - * null is returned. + * {@inheritdoc} + * @param string|null $namespaceOrPrefix [optional] + * @param bool $isPrefix [optional] */ - public function children (?string $namespaceOrPrefix = null, bool $isPrefix = false): ?SimpleXMLElement {} + public function children (?string $namespaceOrPrefix = NULL, bool $isPrefix = false) {} /** - * Identifies an element's attributes - * @link http://www.php.net/manual/en/simplexmlelement.attributes.php - * @param string|null $namespaceOrPrefix [optional] - * @param bool $isPrefix [optional] - * @return SimpleXMLElement|null Returns a SimpleXMLElement object that can be - * iterated over to loop through the attributes on the tag. - *Returns null if called on a SimpleXMLElement - * object that already represents an attribute and not a tag.
+ * {@inheritdoc} + * @param string|null $namespaceOrPrefix [optional] + * @param bool $isPrefix [optional] */ - public function attributes (?string $namespaceOrPrefix = null, bool $isPrefix = false): ?SimpleXMLElement {} + public function attributes (?string $namespaceOrPrefix = NULL, bool $isPrefix = false) {} /** - * Creates a new SimpleXMLElement object - * @link http://www.php.net/manual/en/simplexmlelement.construct.php - * @param string $data - * @param int $options [optional] - * @param bool $dataIsURL [optional] - * @param string $namespaceOrPrefix [optional] - * @param bool $isPrefix [optional] - * @return string + * {@inheritdoc} + * @param string $data + * @param int $options [optional] + * @param bool $dataIsURL [optional] + * @param string $namespaceOrPrefix [optional] + * @param bool $isPrefix [optional] */ - public function __construct (string $data, int $options = null, bool $dataIsURL = false, string $namespaceOrPrefix = '""', bool $isPrefix = false): string {} + public function __construct (string $data, int $options = 0, bool $dataIsURL = false, string $namespaceOrPrefix = '', bool $isPrefix = false) {} /** - * Adds a child element to the XML node - * @link http://www.php.net/manual/en/simplexmlelement.addchild.php - * @param string $qualifiedName - * @param string|null $value [optional] - * @param string|null $namespace [optional] - * @return SimpleXMLElement|null The addChild method returns a SimpleXMLElement - * object representing the child added to the XML node on success; null on failure. + * {@inheritdoc} + * @param string $qualifiedName + * @param string|null $value [optional] + * @param string|null $namespace [optional] */ - public function addChild (string $qualifiedName, ?string $value = null, ?string $namespace = null): ?SimpleXMLElement {} + public function addChild (string $qualifiedName, ?string $value = NULL, ?string $namespace = NULL) {} /** - * Adds an attribute to the SimpleXML element - * @link http://www.php.net/manual/en/simplexmlelement.addattribute.php - * @param string $qualifiedName - * @param string $value - * @param string|null $namespace [optional] - * @return void No value is returned. + * {@inheritdoc} + * @param string $qualifiedName + * @param string $value + * @param string|null $namespace [optional] */ - public function addAttribute (string $qualifiedName, string $value, ?string $namespace = null): void {} + public function addAttribute (string $qualifiedName, string $value, ?string $namespace = NULL) {} /** - * Gets the name of the XML element - * @link http://www.php.net/manual/en/simplexmlelement.getname.php - * @return string The getName method returns as a string the - * name of the XML tag referenced by the SimpleXMLElement object. + * {@inheritdoc} */ - public function getName (): string {} + public function getName () {} /** - * Returns the string content - * @link http://www.php.net/manual/en/simplexmlelement.tostring.php - * @return string Returns the string content on success or an empty string on failure. + * {@inheritdoc} */ public function __toString (): string {} /** - * Counts the children of an element - * @link http://www.php.net/manual/en/simplexmlelement.count.php - * @return int Returns the number of elements of an element. + * {@inheritdoc} */ - public function count (): int {} + public function count () {} /** - * Rewind to the first element - * @link http://www.php.net/manual/en/simplexmlelement.rewind.php - * @return void No value is returned. + * {@inheritdoc} */ - public function rewind (): void {} + public function rewind () {} /** - * Check whether the current element is valid - * @link http://www.php.net/manual/en/simplexmlelement.valid.php - * @return bool Returns true if the current element is valid, otherwise false + * {@inheritdoc} */ - public function valid (): bool {} + public function valid () {} /** - * Returns the current element - * @link http://www.php.net/manual/en/simplexmlelement.current.php - * @return SimpleXMLElement Returns the current element as a SimpleXMLElement object. + * {@inheritdoc} */ - public function current (): SimpleXMLElement {} + public function current () {} /** - * Return current key - * @link http://www.php.net/manual/en/simplexmlelement.key.php - * @return string Returns the XML tag name of the element referenced by the current SimpleXMLElement object. + * {@inheritdoc} */ - public function key (): string {} + public function key () {} /** - * Move to next element - * @link http://www.php.net/manual/en/simplexmlelement.next.php - * @return void No value is returned. + * {@inheritdoc} */ - public function next (): void {} + public function next () {} /** - * Checks whether the current element has sub elements - * @link http://www.php.net/manual/en/simplexmlelement.haschildren.php - * @return bool true if the current element has sub-elements, otherwise false + * {@inheritdoc} */ - public function hasChildren (): bool {} + public function hasChildren () {} /** - * Returns the sub-elements of the current element - * @link http://www.php.net/manual/en/simplexmlelement.getchildren.php - * @return SimpleXMLElement|null Returns a SimpleXMLElement object containing - * the sub-elements of the current element. + * {@inheritdoc} */ - public function getChildren (): ?SimpleXMLElement {} + public function getChildren () {} } /** - * Interprets an XML file into an object - * @link http://www.php.net/manual/en/function.simplexml-load-file.php - * @param string $filename - * @param string|null $class_name [optional] - * @param int $options [optional] - * @param string $namespace_or_prefix [optional] - * @param bool $is_prefix [optional] - * @return SimpleXMLElement|false Returns an object of class SimpleXMLElement with - * properties containing the data held within the XML document, or false on failure. + * {@inheritdoc} + * @param string $filename + * @param string|null $class_name [optional] + * @param int $options [optional] + * @param string $namespace_or_prefix [optional] + * @param bool $is_prefix [optional] */ -function simplexml_load_file (string $filename, ?string $class_name = 'SimpleXMLElement::class', int $options = null, string $namespace_or_prefix = '""', bool $is_prefix = false): SimpleXMLElement|false {} +function simplexml_load_file (string $filename, ?string $class_name = 'SimpleXMLElement', int $options = 0, string $namespace_or_prefix = '', bool $is_prefix = false): SimpleXMLElement|false {} /** - * Interprets a string of XML into an object - * @link http://www.php.net/manual/en/function.simplexml-load-string.php - * @param string $data - * @param string|null $class_name [optional] - * @param int $options [optional] - * @param string $namespace_or_prefix [optional] - * @param bool $is_prefix [optional] - * @return SimpleXMLElement|false Returns an object of class SimpleXMLElement with - * properties containing the data held within the xml document, or false on failure. + * {@inheritdoc} + * @param string $data + * @param string|null $class_name [optional] + * @param int $options [optional] + * @param string $namespace_or_prefix [optional] + * @param bool $is_prefix [optional] */ -function simplexml_load_string (string $data, ?string $class_name = 'SimpleXMLElement::class', int $options = null, string $namespace_or_prefix = '""', bool $is_prefix = false): SimpleXMLElement|false {} +function simplexml_load_string (string $data, ?string $class_name = 'SimpleXMLElement', int $options = 0, string $namespace_or_prefix = '', bool $is_prefix = false): SimpleXMLElement|false {} /** - * Get a SimpleXMLElement object from a DOM node - * @link http://www.php.net/manual/en/function.simplexml-import-dom.php - * @param SimpleXMLElement|DOMNode $node - * @param string|null $class_name [optional] - * @return SimpleXMLElement|null Returns a SimpleXMLElement or null on failure. + * {@inheritdoc} + * @param SimpleXMLElement|DOMNode $node + * @param string|null $class_name [optional] */ -function simplexml_import_dom (SimpleXMLElement|DOMNode $node, ?string $class_name = 'SimpleXMLElement::class'): ?SimpleXMLElement {} +function simplexml_import_dom (SimpleXMLElement|DOMNode $node, ?string $class_name = 'SimpleXMLElement'): ?SimpleXMLElement {} -// End of SimpleXML v.8.2.6 +// End of SimpleXML v.8.3.0 diff --git a/plugins/org.eclipse.php.core/Resources/language/php8.3/Zend OPcache.php b/plugins/org.eclipse.php.core/Resources/language/php8.3/Zend OPcache.php index 8c60cdd1bc..df0b8e1f2b 100644 --- a/plugins/org.eclipse.php.core/Resources/language/php8.3/Zend OPcache.php +++ b/plugins/org.eclipse.php.core/Resources/language/php8.3/Zend OPcache.php @@ -1,59 +1,40 @@ Unserialization of CURLFile instances is not allowed. - * As of PHP 7.4.0, serialization is forbidden in the first place. - * @link http://www.php.net/manual/en/class.curlfile.php - */ class CURLFile { - /** - * Name of the file to be uploaded. - * @var string - * @link http://www.php.net/manual/en/class.curlfile.php#curlfile.props.name - */ public string $name; - /** - * MIME type of the file (default is application/octet-stream). - * @var string - * @link http://www.php.net/manual/en/class.curlfile.php#curlfile.props.mime - */ public string $mime; - /** - * The name of the file in the upload data (defaults to the name property). - * @var string - * @link http://www.php.net/manual/en/class.curlfile.php#curlfile.props.postname - */ public string $postname; /** - * Create a CURLFile object - * @link http://www.php.net/manual/en/curlfile.construct.php - * @param string $filename Path to the file which will be uploaded. - * @param string|null $mime_type [optional] Mimetype of the file. - * @param string|null $posted_filename [optional] Name of the file to be used in the upload data. - * @return CURLFile Returns a CURLFile object. + * {@inheritdoc} + * @param string $filename + * @param string|null $mime_type [optional] + * @param string|null $posted_filename [optional] */ - public function __construct (string $filename, ?string $mime_type = null, ?string $posted_filename = null): CURLFile {} + public function __construct (string $filename, ?string $mime_type = NULL, ?string $posted_filename = NULL) {} /** - * Get file name - * @link http://www.php.net/manual/en/curlfile.getfilename.php - * @return string Returns file name. + * {@inheritdoc} */ - public function getFilename (): string {} + public function getFilename () {} /** - * Get MIME type - * @link http://www.php.net/manual/en/curlfile.getmimetype.php - * @return string Returns MIME type. + * {@inheritdoc} */ - public function getMimeType (): string {} + public function getMimeType () {} /** - * Get file name for POST - * @link http://www.php.net/manual/en/curlfile.getpostfilename.php - * @return string Returns file name for POST. + * {@inheritdoc} */ - public function getPostFilename (): string {} + public function getPostFilename () {} /** - * Set MIME type - * @link http://www.php.net/manual/en/curlfile.setmimetype.php - * @param string $mime_type MIME type to be used in POST data. - * @return void No value is returned. + * {@inheritdoc} + * @param string $mime_type */ - public function setMimeType (string $mime_type): void {} + public function setMimeType (string $mime_type) {} /** - * Set file name for POST - * @link http://www.php.net/manual/en/curlfile.setpostfilename.php - * @param string $posted_filename Filename to be used in POST data. - * @return void No value is returned. + * {@inheritdoc} + * @param string $posted_filename */ - public function setPostFilename (string $posted_filename): void {} + public function setPostFilename (string $posted_filename) {} } -/** - * CURLStringFile makes it possible to upload a file directly from a variable. - * This is similar to CURLFile, but works with the contents of the file, not filename. - * This class or CURLFile should be used to upload the contents of the file with CURLOPT_POSTFIELDS. - * @link http://www.php.net/manual/en/class.curlstringfile.php - */ class CURLStringFile { - /** - * The contents to be uploaded. - * @var string - * @link http://www.php.net/manual/en/class.curlstringfile.php#curlstringfile.props.data - */ public string $data; - /** - * The name of the file to be used in the upload data. - * @var string - * @link http://www.php.net/manual/en/class.curlstringfile.php#curlstringfile.props.postname - */ public string $postname; - /** - * MIME type of the file (default is application/octet-stream). - * @var string - * @link http://www.php.net/manual/en/class.curlstringfile.php#curlstringfile.props.mime - */ public string $mime; /** - * Create a CURLStringFile object - * @link http://www.php.net/manual/en/curlstringfile.construct.php - * @param string $data The contents to be uploaded. - * @param string $postname The name of the file to be used in the upload data. - * @param string $mime [optional] MIME type of the file (default is application/octet-stream). - * @return string + * {@inheritdoc} + * @param string $data + * @param string $postname + * @param string $mime [optional] */ - public function __construct (string $data, string $postname, string $mime = '"application/octet-stream"'): string {} + public function __construct (string $data, string $postname, string $mime = 'application/octet-stream') {} } /** - * Close a cURL session - * @link http://www.php.net/manual/en/function.curl-close.php - * @param CurlHandle $handle - * @return void No value is returned. + * {@inheritdoc} + * @param CurlHandle $handle */ function curl_close (CurlHandle $handle): void {} /** - * Copy a cURL handle along with all of its preferences - * @link http://www.php.net/manual/en/function.curl-copy-handle.php - * @param CurlHandle $handle - * @return CurlHandle|false Returns a new cURL handle, or false on failure. + * {@inheritdoc} + * @param CurlHandle $handle */ function curl_copy_handle (CurlHandle $handle): CurlHandle|false {} /** - * Return the last error number - * @link http://www.php.net/manual/en/function.curl-errno.php - * @param CurlHandle $handle - * @return int Returns the error number or 0 (zero) if no error - * occurred. + * {@inheritdoc} + * @param CurlHandle $handle */ function curl_errno (CurlHandle $handle): int {} /** - * Return a string containing the last error for the current session - * @link http://www.php.net/manual/en/function.curl-error.php - * @param CurlHandle $handle - * @return string Returns the error message or '' (the empty string) if no - * error occurred. + * {@inheritdoc} + * @param CurlHandle $handle */ function curl_error (CurlHandle $handle): string {} /** - * URL encodes the given string - * @link http://www.php.net/manual/en/function.curl-escape.php - * @param CurlHandle $handle A cURL handle returned by - * curl_init. - * @param string $string The string to be encoded. - * @return string|false Returns escaped string or false on failure. + * {@inheritdoc} + * @param CurlHandle $handle + * @param string $string */ function curl_escape (CurlHandle $handle, string $string): string|false {} /** - * Decodes the given URL encoded string - * @link http://www.php.net/manual/en/function.curl-unescape.php - * @param CurlHandle $handle A cURL handle returned by - * curl_init. - * @param string $string The URL encoded string to be decoded. - * @return string|false Returns decoded string or false on failure. + * {@inheritdoc} + * @param CurlHandle $handle + * @param string $string */ function curl_unescape (CurlHandle $handle, string $string): string|false {} /** - * Set an option for the cURL multi handle - * @link http://www.php.net/manual/en/function.curl-multi-setopt.php - * @param CurlMultiHandle $multi_handle - * @param int $option One of the CURLMOPT_* constants. - * @param mixed $value The value to be set on option. - *value should be an int for the - * following values of the option parameter: - *
Option | - *Set value to | - *
CURLMOPT_PIPELINING | - *- * Pass 1 to enable or 0 to disable. Enabling pipelining on a multi - * handle will make it attempt to perform HTTP Pipelining as far as - * possible for transfers using this handle. This means that if you add - * a second request that can use an already existing connection, the - * second request will be "piped" on the same connection. - * As of cURL 7.43.0, the value is a bitmask, and you can also pass 2 to try to multiplex the new - * transfer over an existing HTTP/2 connection if possible. - * Passing 3 instructs cURL to ask for pipelining and multiplexing - * independently of each other. - * As of cURL 7.62.0, setting the pipelining bit has no effect. - * Instead of integer literals, you can also use the CURLPIPE_* - * constants if available. - * | - *
CURLMOPT_MAXCONNECTS | - *- * Pass a number that will be used as the maximum amount of - * simultaneously open connections that libcurl may cache. - * By default the size will be enlarged to fit four times the number - * of handles added via curl_multi_add_handle. - * When the cache is full, curl closes the oldest one in the cache - * to prevent the number of open connections from increasing. - * | - *
CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE | - *- * Pass a number that specifies the chunk length threshold for pipelining - * in bytes. - * | - *
CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE | - *- * Pass a number that specifies the size threshold for pipelining - * penalty in bytes. - * | - *
CURLMOPT_MAX_HOST_CONNECTIONS | - *- * Pass a number that specifies the maximum number of connections to a - * single host. - * | - *
CURLMOPT_MAX_PIPELINE_LENGTH | - *- * Pass a number that specifies the maximum number of requests in a - * pipeline. - * | - *
CURLMOPT_MAX_TOTAL_CONNECTIONS | - *- * Pass a number that specifies the maximum number of simultaneously - * open connections. - * | - *
CURLMOPT_PUSHFUNCTION | - *
- * Pass a callable that will be registered to handle server
- * pushes and should have the following signature:
- * intpushfunction
- * resourceparent_ch
- * resourcepushed_ch
- * arrayheaders
- *
- * parent_ch
- * - * The parent cURL handle (the request the client made). - * - * pushed_ch - *- * - * A new cURL handle for the pushed request. - * - * headers - *- * - * The push promise headers. - * - * - * The push function is supposed to return either - * CURL_PUSH_OK if it can handle the push, or - * CURL_PUSH_DENY to reject it. - * |
- *
The parent cURL handle (the request the client made).
- *A new cURL handle for the pushed request.
- *The push promise headers.
- * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param CurlMultiHandle $multi_handle + * @param int $option + * @param mixed $value */ -function curl_multi_setopt (CurlMultiHandle $multi_handle, int $option, mixed $value): bool {} +function curl_multi_setopt (CurlMultiHandle $multi_handle, int $option, mixed $value = null): bool {} /** - * Perform a cURL session - * @link http://www.php.net/manual/en/function.curl-exec.php - * @param CurlHandle $handle - * @return string|bool Returns true on success or false on failure. However, if the CURLOPT_RETURNTRANSFER - * option is set, it will return - * the result on success, false on failure. - *Note that response status codes which indicate errors (such as 404 - * Not found) are not regarded as failure. - * curl_getinfo can be used to check for these.
+ * {@inheritdoc} + * @param CurlHandle $handle */ function curl_exec (CurlHandle $handle): string|bool {} /** - * Create a CURLFile object - * @link http://www.php.net/manual/en/curlfile.construct.php - * @param string $filename Path to the file which will be uploaded. - * @param string|null $mime_type [optional] Mimetype of the file. - * @param string|null $posted_filename [optional] Name of the file to be used in the upload data. - * @return CURLFile Returns a CURLFile object. + * {@inheritdoc} + * @param string $filename + * @param string|null $mime_type [optional] + * @param string|null $posted_filename [optional] */ -function curl_file_create (string $filename, ?string $mime_type = null, ?string $posted_filename = null): CURLFile {} +function curl_file_create (string $filename, ?string $mime_type = NULL, ?string $posted_filename = NULL): CURLFile {} /** - * Get information regarding a specific transfer - * @link http://www.php.net/manual/en/function.curl-getinfo.php - * @param CurlHandle $handle - * @param int|null $option [optional] - * @return mixed If option is given, returns its value. - * Otherwise, returns an associative array with the following elements - * (which correspond to option), or false on failure: - *
- *
- * "url"
- *
- * "content_type"
- *
- * "http_code"
- *
- * "header_size"
- *
- * "request_size"
- *
- * "filetime"
- *
- * "ssl_verify_result"
- *
- * "redirect_count"
- *
- * "total_time"
- *
- * "namelookup_time"
- *
- * "connect_time"
- *
- * "pretransfer_time"
- *
- * "size_upload"
- *
- * "size_download"
- *
- * "speed_download"
- *
- * "speed_upload"
- *
- * "download_content_length"
- *
- * "upload_content_length"
- *
- * "starttransfer_time"
- *
- * "redirect_time"
- *
- * "certinfo"
- *
- * "primary_ip"
- *
- * "primary_port"
- *
- * "local_ip"
- *
- * "local_port"
- *
- * "redirect_url"
- *
- * "request_header" (This is only set if the CURLINFO_HEADER_OUT
- * is set by a previous call to curl_setopt)
- *
This only returns errors regarding the whole multi stack. There might still have - * occurred problems on individual transfers even when this function returns - * CURLM_OK.
+ * {@inheritdoc} + * @param CurlMultiHandle $multi_handle + * @param mixed $still_running */ -function curl_multi_exec (CurlMultiHandle $multi_handle, int &$still_running): int {} +function curl_multi_exec (CurlMultiHandle $multi_handle, &$still_running = null): int {} /** - * Return the content of a cURL handle if CURLOPT_RETURNTRANSFER is set - * @link http://www.php.net/manual/en/function.curl-multi-getcontent.php - * @param CurlHandle $handle - * @return string|null Return the content of a cURL handle if CURLOPT_RETURNTRANSFER is set or null if not set. + * {@inheritdoc} + * @param CurlHandle $handle */ function curl_multi_getcontent (CurlHandle $handle): ?string {} /** - * Get information about the current transfers - * @link http://www.php.net/manual/en/function.curl-multi-info-read.php - * @param CurlMultiHandle $multi_handle - * @param int $queued_messages [optional] - * @return array|false On success, returns an associative array for the message, false on failure. - *Key: | - *Value: | - *
msg | - *The CURLMSG_DONE constant. Other return values - * are currently not available. | - *
result | - *One of the CURLE_* constants. If everything is - * OK, the CURLE_OK will be the result. | - *
handle | - *Resource of type curl indicates the handle which it concerns. | - *
Option | - *Description | - *
CURLSHOPT_SHARE | - *- * Specifies a type of data that should be shared. - * | - *
CURLSHOPT_UNSHARE | - *- * Specifies a type of data that will be no longer shared. - * | - *
Value | - *Description | - *
CURL_LOCK_DATA_COOKIE | - *- * Shares cookie data. - * | - *
CURL_LOCK_DATA_DNS | - *- * Shares DNS cache. Note that when you use cURL multi handles, - * all handles added to the same multi handle will share DNS cache - * by default. - * | - *
CURL_LOCK_DATA_SSL_SESSION | - *- * Shares SSL session IDs, reducing the time spent on the SSL - * handshake when reconnecting to the same server. Note that SSL - * session IDs are reused within the same handle by default. - * | - *
Key | - *Value description | - *
version_number | - *cURL 24 bit version number | - *
version | - *cURL version number, as a string | - *
ssl_version_number | - *OpenSSL 24 bit version number | - *
ssl_version | - *OpenSSL version number, as a string | - *
libz_version | - *zlib version number, as a string | - *
host | - *Information about the host where cURL was built | - *
age | - *|
features | - *A bitmask of the CURL_VERSION_XXX constants | - *
protocols | - *An array of protocols names supported by cURL | - *
format character | - *Description | - *Example returned values | - *
Day | - *--- | - *--- | - *
d | - *Day of the month, 2 digits with leading zeros | - *01 to 31 | - *
D | - *A textual representation of a day, three letters | - *Mon through Sun | - *
j | - *Day of the month without leading zeros | - *1 to 31 | - *
l (lowercase 'L') | - *A full textual representation of the day of the week | - *Sunday through Saturday | - *
N | - *ISO 8601 numeric representation of the day of the week | - *1 (for Monday) through 7 (for Sunday) | - *
S | - *English ordinal suffix for the day of the month, 2 characters | - *- * st, nd, rd or - * th. Works well with j - * | - *
w | - *Numeric representation of the day of the week | - *0 (for Sunday) through 6 (for Saturday) | - *
z | - *The day of the year (starting from 0) | - *0 through 365 | - *
Week | - *--- | - *--- | - *
W | - *ISO 8601 week number of year, weeks starting on Monday | - *Example: 42 (the 42nd week in the year) | - *
Month | - *--- | - *--- | - *
F | - *A full textual representation of a month, such as January or March | - *January through December | - *
m | - *Numeric representation of a month, with leading zeros | - *01 through 12 | - *
M | - *A short textual representation of a month, three letters | - *Jan through Dec | - *
n | - *Numeric representation of a month, without leading zeros | - *1 through 12 | - *
t | - *Number of days in the given month | - *28 through 31 | - *
Year | - *--- | - *--- | - *
L | - *Whether it's a leap year | - *1 if it is a leap year, 0 otherwise. | - *
o | - *ISO 8601 week-numbering year. This has the same value as - * Y, except that if the ISO week number - * (W) belongs to the previous or next year, that year - * is used instead. | - *Examples: 1999 or 2003 | - *
X | - *An expanded full numeric representation of a year, at least 4 digits, - * with - for years BCE, and + - * for years CE. | - *Examples: -0055, +0787, - * +1999, +10191 | - *
x | - *An expanded full numeric representation if requried, or a - * standard full numeral representation if possible (like - * Y). At least four digits. Years BCE are prefixed - * with a -. Years beyond (and including) - * 10000 are prefixed by a - * +. | - *Examples: -0055, 0787, - * 1999, +10191 | - *
Y | - *A full numeric representation of a year, at least 4 digits, - * with - for years BCE. | - *Examples: -0055, 0787, - * 1999, 2003, - * 10191 | - *
y | - *A two digit representation of a year | - *Examples: 99 or 03 | - *
Time | - *--- | - *--- | - *
a | - *Lowercase Ante meridiem and Post meridiem | - *am or pm | - *
A | - *Uppercase Ante meridiem and Post meridiem | - *AM or PM | - *
B | - *Swatch Internet time | - *000 through 999 | - *
g | - *12-hour format of an hour without leading zeros | - *1 through 12 | - *
G | - *24-hour format of an hour without leading zeros | - *0 through 23 | - *
h | - *12-hour format of an hour with leading zeros | - *01 through 12 | - *
H | - *24-hour format of an hour with leading zeros | - *00 through 23 | - *
i | - *Minutes with leading zeros | - *00 to 59 | - *
s | - *Seconds with leading zeros | - *00 through 59 | - *
u | - *- * Microseconds. Note that - * date will always generate - * 000000 since it takes an int - * parameter, whereas DateTime::format does - * support microseconds if DateTime was - * created with microseconds. - * | - *Example: 654321 | - *
v | - *- * Milliseconds. Same note applies as for - * u. - * | - *Example: 654 | - *
Timezone | - *--- | - *--- | - *
e | - *Timezone identifier | - *Examples: UTC, GMT, Atlantic/Azores | - *
I (capital i) | - *Whether or not the date is in daylight saving time | - *1 if Daylight Saving Time, 0 otherwise. | - *
O | - *Difference to Greenwich time (GMT) without colon between hours and minutes | - *Example: +0200 | - *
P | - *Difference to Greenwich time (GMT) with colon between hours and minutes | - *Example: +02:00 | - *
p | - *- * The same as P, but returns Z instead of +00:00 - * (available as of PHP 8.0.0) - * | - *Examples: Z or +02:00 | - *
T | - *Timezone abbreviation, if known; otherwise the GMT offset. | - *Examples: EST, MDT, +05 | - *
Z | - *Timezone offset in seconds. The offset for timezones west of UTC is always - * negative, and for those east of UTC is always positive. | - *-43200 through 50400 | - *
Full Date/Time | - *--- | - *--- | - *
c | - *ISO 8601 date | - *2004-02-12T15:19:21+00:00 | - *
r | - *RFC 2822/RFC 5322 formatted date | - *Example: Thu, 21 Dec 2000 16:01:07 +0200 | - *
U | - *Seconds since the Unix Epoch (January 1 1970 00:00:00 GMT) | - *See also time | - *
Unrecognized characters in the format string will be printed - * as-is. The Z format will always return - * 0 when using gmdate.
- *Since this function only accepts int timestamps the - * u format character is only useful when using the - * date_format function with user based timestamps - * created with date_create.
- * @return string Returns the formatted date string on success. - */ - abstract public function format (string $format): string; - - /** - * Return time zone relative to given DateTime - * @link http://www.php.net/manual/en/datetime.gettimezone.php - * @return DateTimeZone|false Returns a DateTimeZone object on success - * or false on failure. - */ - abstract public function getTimezone (): DateTimeZone|false; - - /** - * Returns the timezone offset - * @link http://www.php.net/manual/en/datetime.getoffset.php - * @return int Returns the timezone offset in seconds from UTC on success. - */ - abstract public function getOffset (): int; - - /** - * Gets the Unix timestamp - * @link http://www.php.net/manual/en/datetime.gettimestamp.php - * @return int Returns the Unix timestamp representing the date. - */ - abstract public function getTimestamp (): int; - - /** - * Returns the difference between two DateTime objects - * @link http://www.php.net/manual/en/datetime.diff.php - * @param DateTimeInterface $targetObject - * @param bool $absolute [optional] Should the interval be forced to be positive? - * @return DateInterval The DateInterval object represents the - * difference between the two dates. - *The return value more specifically represents the clock-time interval to - * apply to the original object ($this or - * $originObject) to arrive at the - * $targetObject. This process is not always - * reversible.
- *The method is aware of DST changeovers, and hence can return an interval of - * 24 hours and 30 minutes, as per one of the examples. If - * you want to calculate with absolute time, you need to convert both the - * $this/$baseObject, and - * $targetObject to UTC first.
- */ - abstract public function diff (DateTimeInterface $targetObject, bool $absolute = false): DateInterval; - - /** - * The __wakeup handler - * @link http://www.php.net/manual/en/datetime.wakeup.php - * @return void Initializes a DateTime object. - */ - abstract public function __wakeup (): void; + * {@inheritdoc} + * @param string $format + */ + abstract public function format (string $format); + + /** + * {@inheritdoc} + */ + abstract public function getTimezone (); + + /** + * {@inheritdoc} + */ + abstract public function getOffset (); + + /** + * {@inheritdoc} + */ + abstract public function getTimestamp (); + + /** + * {@inheritdoc} + * @param DateTimeInterface $targetObject + * @param bool $absolute [optional] + */ + abstract public function diff (DateTimeInterface $targetObject, bool $absolute = false); + + /** + * {@inheritdoc} + */ + abstract public function __wakeup (); /** * {@inheritdoc} @@ -434,19 +65,6 @@ abstract public function __unserialize (array $data): void; } -/** - * Representation of date and time. - *This class behaves the same as DateTimeImmutable - * except objects are modified itself when modification methods such as - * DateTime::modify are called.
- *Calling methods on objects of the class DateTime - * will change the information encapsulated in these objects, if you want to - * prevent that you will have to use clone operator to - * create a new object. Use DateTimeImmutable - * instead of DateTime to obtain this recommended - * behaviour by default.
- * @link http://www.php.net/manual/en/class.datetime.php - */ class DateTime implements DateTimeInterface { const ATOM = "Y-m-d\TH:i:sP"; const COOKIE = "l, d-M-Y H:i:s T"; @@ -465,1539 +83,804 @@ class DateTime implements DateTimeInterface { /** - * Returns new DateTime object - * @link http://www.php.net/manual/en/datetime.construct.php - * @param string $datetime [optional] A date/time string. Valid formats are explained in Date and Time Formats. - *Enter "now" here to obtain the current time when using - * the $timezone parameter.
- * @param DateTimeZone|null $timezone [optional] A DateTimeZone object representing the - * timezone of $datetime. - *If $timezone is omitted or null, - * the current timezone will be used.
- *The $timezone parameter - * and the current timezone are ignored when the - * $datetime parameter either - * is a UNIX timestamp (e.g. @946684800) - * or specifies a timezone - * (e.g. 2010-01-28T15:00:00+02:00).
- * @return string Returns a new DateTime instance. - * Procedural style returns false on failure. + * {@inheritdoc} + * @param string $datetime [optional] + * @param DateTimeZone|null $timezone [optional] + */ + public function __construct (string $datetime = 'now', ?DateTimeZone $timezone = NULL) {} + + /** + * {@inheritdoc} + */ + public function __serialize (): array {} + + /** + * {@inheritdoc} + * @param array $data + */ + public function __unserialize (array $data): void {} + + /** + * {@inheritdoc} + */ + public function __wakeup () {} + + /** + * {@inheritdoc} + * @param array $array + */ + public static function __set_state (array $array) {} + + /** + * {@inheritdoc} + * @param DateTimeImmutable $object + */ + public static function createFromImmutable (DateTimeImmutable $object) {} + + /** + * {@inheritdoc} + * @param DateTimeInterface $object + */ + public static function createFromInterface (DateTimeInterface $object): DateTime {} + + /** + * {@inheritdoc} + * @param string $format + * @param string $datetime + * @param DateTimeZone|null $timezone [optional] + */ + public static function createFromFormat (string $format, string $datetime, ?DateTimeZone $timezone = NULL) {} + + /** + * {@inheritdoc} + */ + public static function getLastErrors () {} + + /** + * {@inheritdoc} + * @param string $format + */ + public function format (string $format) {} + + /** + * {@inheritdoc} + * @param string $modifier + */ + public function modify (string $modifier) {} + + /** + * {@inheritdoc} + * @param DateInterval $interval + */ + public function add (DateInterval $interval) {} + + /** + * {@inheritdoc} + * @param DateInterval $interval + */ + public function sub (DateInterval $interval) {} + + /** + * {@inheritdoc} + */ + public function getTimezone () {} + + /** + * {@inheritdoc} + * @param DateTimeZone $timezone + */ + public function setTimezone (DateTimeZone $timezone) {} + + /** + * {@inheritdoc} + */ + public function getOffset () {} + + /** + * {@inheritdoc} + * @param int $hour + * @param int $minute + * @param int $second [optional] + * @param int $microsecond [optional] + */ + public function setTime (int $hour, int $minute, int $second = 0, int $microsecond = 0) {} + + /** + * {@inheritdoc} + * @param int $year + * @param int $month + * @param int $day + */ + public function setDate (int $year, int $month, int $day) {} + + /** + * {@inheritdoc} + * @param int $year + * @param int $week + * @param int $dayOfWeek [optional] + */ + public function setISODate (int $year, int $week, int $dayOfWeek = 1) {} + + /** + * {@inheritdoc} + * @param int $timestamp + */ + public function setTimestamp (int $timestamp) {} + + /** + * {@inheritdoc} + */ + public function getTimestamp () {} + + /** + * {@inheritdoc} + * @param DateTimeInterface $targetObject + * @param bool $absolute [optional] + */ + public function diff (DateTimeInterface $targetObject, bool $absolute = false) {} + +} + +class DateTimeImmutable implements DateTimeInterface { + const ATOM = "Y-m-d\TH:i:sP"; + const COOKIE = "l, d-M-Y H:i:s T"; + const ISO8601 = "Y-m-d\TH:i:sO"; + const ISO8601_EXPANDED = "X-m-d\TH:i:sP"; + const RFC822 = "D, d M y H:i:s O"; + const RFC850 = "l, d-M-y H:i:s T"; + const RFC1036 = "D, d M y H:i:s O"; + const RFC1123 = "D, d M Y H:i:s O"; + const RFC7231 = "D, d M Y H:i:s \G\M\T"; + const RFC2822 = "D, d M Y H:i:s O"; + const RFC3339 = "Y-m-d\TH:i:sP"; + const RFC3339_EXTENDED = "Y-m-d\TH:i:s.vP"; + const RSS = "D, d M Y H:i:s O"; + const W3C = "Y-m-d\TH:i:sP"; + + + /** + * {@inheritdoc} + * @param string $datetime [optional] + * @param DateTimeZone|null $timezone [optional] + */ + public function __construct (string $datetime = 'now', ?DateTimeZone $timezone = NULL) {} + + /** + * {@inheritdoc} + */ + public function __serialize (): array {} + + /** + * {@inheritdoc} + * @param array $data + */ + public function __unserialize (array $data): void {} + + /** + * {@inheritdoc} + */ + public function __wakeup () {} + + /** + * {@inheritdoc} + * @param array $array + */ + public static function __set_state (array $array) {} + + /** + * {@inheritdoc} + * @param string $format + * @param string $datetime + * @param DateTimeZone|null $timezone [optional] + */ + public static function createFromFormat (string $format, string $datetime, ?DateTimeZone $timezone = NULL) {} + + /** + * {@inheritdoc} + */ + public static function getLastErrors () {} + + /** + * {@inheritdoc} + * @param string $format + */ + public function format (string $format) {} + + /** + * {@inheritdoc} + */ + public function getTimezone () {} + + /** + * {@inheritdoc} + */ + public function getOffset () {} + + /** + * {@inheritdoc} + */ + public function getTimestamp () {} + + /** + * {@inheritdoc} + * @param DateTimeInterface $targetObject + * @param bool $absolute [optional] + */ + public function diff (DateTimeInterface $targetObject, bool $absolute = false) {} + + /** + * {@inheritdoc} + * @param string $modifier + */ + public function modify (string $modifier) {} + + /** + * {@inheritdoc} + * @param DateInterval $interval + */ + public function add (DateInterval $interval) {} + + /** + * {@inheritdoc} + * @param DateInterval $interval + */ + public function sub (DateInterval $interval) {} + + /** + * {@inheritdoc} + * @param DateTimeZone $timezone + */ + public function setTimezone (DateTimeZone $timezone) {} + + /** + * {@inheritdoc} + * @param int $hour + * @param int $minute + * @param int $second [optional] + * @param int $microsecond [optional] + */ + public function setTime (int $hour, int $minute, int $second = 0, int $microsecond = 0) {} + + /** + * {@inheritdoc} + * @param int $year + * @param int $month + * @param int $day + */ + public function setDate (int $year, int $month, int $day) {} + + /** + * {@inheritdoc} + * @param int $year + * @param int $week + * @param int $dayOfWeek [optional] + */ + public function setISODate (int $year, int $week, int $dayOfWeek = 1) {} + + /** + * {@inheritdoc} + * @param int $timestamp + */ + public function setTimestamp (int $timestamp) {} + + /** + * {@inheritdoc} + * @param DateTime $object + */ + public static function createFromMutable (DateTime $object) {} + + /** + * {@inheritdoc} + * @param DateTimeInterface $object + */ + public static function createFromInterface (DateTimeInterface $object): DateTimeImmutable {} + +} + +class DateTimeZone { + const AFRICA = 1; + const AMERICA = 2; + const ANTARCTICA = 4; + const ARCTIC = 8; + const ASIA = 16; + const ATLANTIC = 32; + const AUSTRALIA = 64; + const EUROPE = 128; + const INDIAN = 256; + const PACIFIC = 512; + const UTC = 1024; + const ALL = 2047; + const ALL_WITH_BC = 4095; + const PER_COUNTRY = 4096; + + + /** + * {@inheritdoc} + * @param string $timezone + */ + public function __construct (string $timezone) {} + + /** + * {@inheritdoc} + */ + public function getName () {} + + /** + * {@inheritdoc} + * @param DateTimeInterface $datetime + */ + public function getOffset (DateTimeInterface $datetime) {} + + /** + * {@inheritdoc} + * @param int $timestampBegin [optional] + * @param int $timestampEnd [optional] + */ + public function getTransitions (int $timestampBegin = -9223372036854775807-1, int $timestampEnd = 9223372036854775807) {} + + /** + * {@inheritdoc} + */ + public function getLocation () {} + + /** + * {@inheritdoc} + */ + public static function listAbbreviations () {} + + /** + * {@inheritdoc} + * @param int $timezoneGroup [optional] + * @param string|null $countryCode [optional] + */ + public static function listIdentifiers (int $timezoneGroup = 2047, ?string $countryCode = NULL) {} + + /** + * {@inheritdoc} + */ + public function __serialize (): array {} + + /** + * {@inheritdoc} + * @param array $data + */ + public function __unserialize (array $data): void {} + + /** + * {@inheritdoc} + */ + public function __wakeup () {} + + /** + * {@inheritdoc} + * @param array $array + */ + public static function __set_state (array $array) {} + +} + +class DateInterval { + + /** + * {@inheritdoc} + * @param string $duration + */ + public function __construct (string $duration) {} + + /** + * {@inheritdoc} + * @param string $datetime + */ + public static function createFromDateString (string $datetime) {} + + /** + * {@inheritdoc} + * @param string $format + */ + public function format (string $format) {} + + /** + * {@inheritdoc} + */ + public function __serialize (): array {} + + /** + * {@inheritdoc} + * @param array $data + */ + public function __unserialize (array $data): void {} + + /** + * {@inheritdoc} + */ + public function __wakeup () {} + + /** + * {@inheritdoc} + * @param array $array + */ + public static function __set_state (array $array) {} + +} + +class DatePeriod implements IteratorAggregate, Traversable { + const EXCLUDE_START_DATE = 1; + const INCLUDE_END_DATE = 2; + + + public ?DateTimeInterface $start; + + public ?DateTimeInterface $current; + + public ?DateTimeInterface $end; + + public ?DateInterval $interval; + + public int $recurrences; + + public bool $include_start_date; + + public bool $include_end_date; + + /** + * {@inheritdoc} + * @param string $specification + * @param int $options [optional] + */ + public static function createFromISO8601String (string $specification, int $options = 0): static {} + + /** + * {@inheritdoc} + * @param mixed $start + * @param mixed $interval [optional] + * @param mixed $end [optional] + * @param mixed $options [optional] + */ + public function __construct ($start = null, $interval = NULL, $end = NULL, $options = NULL) {} + + /** + * {@inheritdoc} + */ + public function getStartDate () {} + + /** + * {@inheritdoc} + */ + public function getEndDate () {} + + /** + * {@inheritdoc} + */ + public function getDateInterval () {} + + /** + * {@inheritdoc} + */ + public function getRecurrences () {} + + /** + * {@inheritdoc} + */ + public function __serialize (): array {} + + /** + * {@inheritdoc} + * @param array $data + */ + public function __unserialize (array $data): void {} + + /** + * {@inheritdoc} + */ + public function __wakeup () {} + + /** + * {@inheritdoc} + * @param array $array + */ + public static function __set_state (array $array) {} + + /** + * {@inheritdoc} + */ + public function getIterator (): Iterator {} + +} + +class DateError extends Error implements Throwable, Stringable { + + /** + * {@inheritdoc} + * @param string $message [optional] + * @param int $code [optional] + * @param Throwable|null $previous [optional] + */ + public function __construct (string $message = '', int $code = 0, ?Throwable $previous = NULL) {} + + /** + * {@inheritdoc} + */ + public function __wakeup () {} + + /** + * {@inheritdoc} + */ + final public function getMessage (): string {} + + /** + * {@inheritdoc} + */ + final public function getCode () {} + + /** + * {@inheritdoc} + */ + final public function getFile (): string {} + + /** + * {@inheritdoc} + */ + final public function getLine (): int {} + + /** + * {@inheritdoc} + */ + final public function getTrace (): array {} + + /** + * {@inheritdoc} + */ + final public function getPrevious (): ?Throwable {} + + /** + * {@inheritdoc} + */ + final public function getTraceAsString (): string {} + + /** + * {@inheritdoc} + */ + public function __toString (): string {} + +} + +class DateObjectError extends DateError implements Stringable, Throwable { + + /** + * {@inheritdoc} + * @param string $message [optional] + * @param int $code [optional] + * @param Throwable|null $previous [optional] + */ + public function __construct (string $message = '', int $code = 0, ?Throwable $previous = NULL) {} + + /** + * {@inheritdoc} + */ + public function __wakeup () {} + + /** + * {@inheritdoc} + */ + final public function getMessage (): string {} + + /** + * {@inheritdoc} + */ + final public function getCode () {} + + /** + * {@inheritdoc} + */ + final public function getFile (): string {} + + /** + * {@inheritdoc} + */ + final public function getLine (): int {} + + /** + * {@inheritdoc} */ - public function __construct (string $datetime = '"now"', ?DateTimeZone $timezone = null): string {} + final public function getTrace (): array {} /** * {@inheritdoc} */ - public function __serialize (): array {} + final public function getPrevious (): ?Throwable {} /** * {@inheritdoc} - * @param array $data */ - public function __unserialize (array $data): void {} + final public function getTraceAsString (): string {} /** - * The __wakeup handler - * @link http://www.php.net/manual/en/datetime.wakeup.php - * @return void Initializes a DateTime object. + * {@inheritdoc} */ - public function __wakeup (): void {} + public function __toString (): string {} + +} + +class DateRangeError extends DateError implements Stringable, Throwable { /** - * The __set_state handler - * @link http://www.php.net/manual/en/datetime.set-state.php - * @param array $array Initialization array. - * @return DateTime Returns a new instance of a DateTime object. + * {@inheritdoc} + * @param string $message [optional] + * @param int $code [optional] + * @param Throwable|null $previous [optional] */ - public static function __set_state (array $array): DateTime {} + public function __construct (string $message = '', int $code = 0, ?Throwable $previous = NULL) {} /** - * Returns new DateTime instance encapsulating the given DateTimeImmutable object - * @link http://www.php.net/manual/en/datetime.createfromimmutable.php - * @param DateTimeImmutable $object - * @return static Returns a new DateTime instance. + * {@inheritdoc} */ - public static function createFromImmutable (DateTimeImmutable $object): static {} + public function __wakeup () {} /** - * Returns new DateTime object encapsulating the given DateTimeInterface object - * @link http://www.php.net/manual/en/datetime.createfrominterface.php - * @param DateTimeInterface $object - * @return DateTime Returns a new DateTime instance. + * {@inheritdoc} */ - public static function createFromInterface (DateTimeInterface $object): DateTime {} + final public function getMessage (): string {} /** - * Parses a time string according to a specified format - * @link http://www.php.net/manual/en/datetime.createfromformat.php - * @param string $format - * @param string $datetime - * @param DateTimeZone|null $timezone [optional] - * @return DateTime|false Returns a new DateTime instance or false on failure. + * {@inheritdoc} */ - public static function createFromFormat (string $format, string $datetime, ?DateTimeZone $timezone = null): DateTime|false {} + final public function getCode () {} /** * {@inheritdoc} */ - public static function getLastErrors () {} + final public function getFile (): string {} /** - * Returns date formatted according to given format - * @link http://www.php.net/manual/en/datetime.format.php - * @param string $format The format of the outputted date string. See the formatting - * options below. There are also several - * predefined date constants - * that may be used instead, so for example DATE_RSS - * contains the format string 'D, d M Y H:i:s'. - *format character | - *Description | - *Example returned values | - *
Day | - *--- | - *--- | - *
d | - *Day of the month, 2 digits with leading zeros | - *01 to 31 | - *
D | - *A textual representation of a day, three letters | - *Mon through Sun | - *
j | - *Day of the month without leading zeros | - *1 to 31 | - *
l (lowercase 'L') | - *A full textual representation of the day of the week | - *Sunday through Saturday | - *
N | - *ISO 8601 numeric representation of the day of the week | - *1 (for Monday) through 7 (for Sunday) | - *
S | - *English ordinal suffix for the day of the month, 2 characters | - *- * st, nd, rd or - * th. Works well with j - * | - *
w | - *Numeric representation of the day of the week | - *0 (for Sunday) through 6 (for Saturday) | - *
z | - *The day of the year (starting from 0) | - *0 through 365 | - *
Week | - *--- | - *--- | - *
W | - *ISO 8601 week number of year, weeks starting on Monday | - *Example: 42 (the 42nd week in the year) | - *
Month | - *--- | - *--- | - *
F | - *A full textual representation of a month, such as January or March | - *January through December | - *
m | - *Numeric representation of a month, with leading zeros | - *01 through 12 | - *
M | - *A short textual representation of a month, three letters | - *Jan through Dec | - *
n | - *Numeric representation of a month, without leading zeros | - *1 through 12 | - *
t | - *Number of days in the given month | - *28 through 31 | - *
Year | - *--- | - *--- | - *
L | - *Whether it's a leap year | - *1 if it is a leap year, 0 otherwise. | - *
o | - *ISO 8601 week-numbering year. This has the same value as - * Y, except that if the ISO week number - * (W) belongs to the previous or next year, that year - * is used instead. | - *Examples: 1999 or 2003 | - *
X | - *An expanded full numeric representation of a year, at least 4 digits, - * with - for years BCE, and + - * for years CE. | - *Examples: -0055, +0787, - * +1999, +10191 | - *
x | - *An expanded full numeric representation if requried, or a - * standard full numeral representation if possible (like - * Y). At least four digits. Years BCE are prefixed - * with a -. Years beyond (and including) - * 10000 are prefixed by a - * +. | - *Examples: -0055, 0787, - * 1999, +10191 | - *
Y | - *A full numeric representation of a year, at least 4 digits, - * with - for years BCE. | - *Examples: -0055, 0787, - * 1999, 2003, - * 10191 | - *
y | - *A two digit representation of a year | - *Examples: 99 or 03 | - *
Time | - *--- | - *--- | - *
a | - *Lowercase Ante meridiem and Post meridiem | - *am or pm | - *
A | - *Uppercase Ante meridiem and Post meridiem | - *AM or PM | - *
B | - *Swatch Internet time | - *000 through 999 | - *
g | - *12-hour format of an hour without leading zeros | - *1 through 12 | - *
G | - *24-hour format of an hour without leading zeros | - *0 through 23 | - *
h | - *12-hour format of an hour with leading zeros | - *01 through 12 | - *
H | - *24-hour format of an hour with leading zeros | - *00 through 23 | - *
i | - *Minutes with leading zeros | - *00 to 59 | - *
s | - *Seconds with leading zeros | - *00 through 59 | - *
u | - *- * Microseconds. Note that - * date will always generate - * 000000 since it takes an int - * parameter, whereas DateTime::format does - * support microseconds if DateTime was - * created with microseconds. - * | - *Example: 654321 | - *
v | - *- * Milliseconds. Same note applies as for - * u. - * | - *Example: 654 | - *
Timezone | - *--- | - *--- | - *
e | - *Timezone identifier | - *Examples: UTC, GMT, Atlantic/Azores | - *
I (capital i) | - *Whether or not the date is in daylight saving time | - *1 if Daylight Saving Time, 0 otherwise. | - *
O | - *Difference to Greenwich time (GMT) without colon between hours and minutes | - *Example: +0200 | - *
P | - *Difference to Greenwich time (GMT) with colon between hours and minutes | - *Example: +02:00 | - *
p | - *- * The same as P, but returns Z instead of +00:00 - * (available as of PHP 8.0.0) - * | - *Examples: Z or +02:00 | - *
T | - *Timezone abbreviation, if known; otherwise the GMT offset. | - *Examples: EST, MDT, +05 | - *
Z | - *Timezone offset in seconds. The offset for timezones west of UTC is always - * negative, and for those east of UTC is always positive. | - *-43200 through 50400 | - *
Full Date/Time | - *--- | - *--- | - *
c | - *ISO 8601 date | - *2004-02-12T15:19:21+00:00 | - *
r | - *RFC 2822/RFC 5322 formatted date | - *Example: Thu, 21 Dec 2000 16:01:07 +0200 | - *
U | - *Seconds since the Unix Epoch (January 1 1970 00:00:00 GMT) | - *See also time | - *
Unrecognized characters in the format string will be printed - * as-is. The Z format will always return - * 0 when using gmdate.
- *Since this function only accepts int timestamps the - * u format character is only useful when using the - * date_format function with user based timestamps - * created with date_create.
- * @return string Returns the formatted date string on success. - */ - public function format (string $format): string {} - - /** - * Alters the timestamp - * @link http://www.php.net/manual/en/datetime.modify.php - * @param string $modifier A date/time string. Valid formats are explained in Date and Time Formats. - * @return DateTime|false Returns the modified DateTime object for method chaining or false on failure. - */ - public function modify (string $modifier): DateTime|false {} - - /** - * Modifies a DateTime object, with added amount of days, months, years, hours, minutes and seconds - * @link http://www.php.net/manual/en/datetime.add.php - * @param DateInterval $interval A DateInterval object - * @return DateTime Returns the modified DateTime object for method chaining. - */ - public function add (DateInterval $interval): DateTime {} - - /** - * Subtracts an amount of days, months, years, hours, minutes and seconds from - * a DateTime object - * @link http://www.php.net/manual/en/datetime.sub.php - * @param DateInterval $interval A DateInterval object - * @return DateTime Returns the modified DateTime object for method chaining. - */ - public function sub (DateInterval $interval): DateTime {} - - /** - * Return time zone relative to given DateTime - * @link http://www.php.net/manual/en/datetime.gettimezone.php - * @return DateTimeZone|false Returns a DateTimeZone object on success - * or false on failure. - */ - public function getTimezone (): DateTimeZone|false {} - - /** - * Sets the time zone for the DateTime object - * @link http://www.php.net/manual/en/datetime.settimezone.php - * @param DateTimeZone $timezone A DateTimeZone object representing the - * desired time zone. - * @return DateTime Returns the DateTime object for method chaining. The - * underlaying point-in-time is not changed when calling this method. - */ - public function setTimezone (DateTimeZone $timezone): DateTime {} - - /** - * Returns the timezone offset - * @link http://www.php.net/manual/en/datetime.getoffset.php - * @return int Returns the timezone offset in seconds from UTC on success. - */ - public function getOffset (): int {} - - /** - * Sets the time - * @link http://www.php.net/manual/en/datetime.settime.php - * @param int $hour Hour of the time. - * @param int $minute Minute of the time. - * @param int $second [optional] Second of the time. - * @param int $microsecond [optional] Microsecond of the time. - * @return DateTime Returns the modified DateTime object for method chaining. - */ - public function setTime (int $hour, int $minute, int $second = null, int $microsecond = null): DateTime {} - - /** - * Sets the date - * @link http://www.php.net/manual/en/datetime.setdate.php - * @param int $year Year of the date. - * @param int $month Month of the date. - * @param int $day Day of the date. - * @return DateTime Returns the modified DateTime object for method chaining. + * {@inheritdoc} */ - public function setDate (int $year, int $month, int $day): DateTime {} + final public function getLine (): int {} /** - * Sets the ISO date - * @link http://www.php.net/manual/en/datetime.setisodate.php - * @param int $year Year of the date. - * @param int $week Week of the date. - * @param int $dayOfWeek [optional] Offset from the first day of the week. - * @return DateTime Returns the modified DateTime object for method chaining. + * {@inheritdoc} */ - public function setISODate (int $year, int $week, int $dayOfWeek = 1): DateTime {} + final public function getTrace (): array {} /** - * Sets the date and time based on an Unix timestamp - * @link http://www.php.net/manual/en/datetime.settimestamp.php - * @param int $timestamp Unix timestamp representing the date. - * Setting timestamps outside the range of int is possible by using - * DateTimeImmutable::modify with the @ format. - * @return DateTime Returns the modified DateTime object for method chaining. + * {@inheritdoc} */ - public function setTimestamp (int $timestamp): DateTime {} + final public function getPrevious (): ?Throwable {} /** - * Gets the Unix timestamp - * @link http://www.php.net/manual/en/datetime.gettimestamp.php - * @return int Returns the Unix timestamp representing the date. + * {@inheritdoc} */ - public function getTimestamp (): int {} + final public function getTraceAsString (): string {} /** - * Returns the difference between two DateTime objects - * @link http://www.php.net/manual/en/datetime.diff.php - * @param DateTimeInterface $targetObject - * @param bool $absolute [optional] Should the interval be forced to be positive? - * @return DateInterval The DateInterval object represents the - * difference between the two dates. - *The return value more specifically represents the clock-time interval to - * apply to the original object ($this or - * $originObject) to arrive at the - * $targetObject. This process is not always - * reversible.
- *The method is aware of DST changeovers, and hence can return an interval of - * 24 hours and 30 minutes, as per one of the examples. If - * you want to calculate with absolute time, you need to convert both the - * $this/$baseObject, and - * $targetObject to UTC first.
+ * {@inheritdoc} */ - public function diff (DateTimeInterface $targetObject, bool $absolute = false): DateInterval {} + public function __toString (): string {} } -/** - * Representation of date and time. - *This class behaves the same as DateTime - * except new objects are returned when modification methods such as - * DateTime::modify are called.
- * @link http://www.php.net/manual/en/class.datetimeimmutable.php - */ -class DateTimeImmutable implements DateTimeInterface { - const ATOM = "Y-m-d\TH:i:sP"; - const COOKIE = "l, d-M-Y H:i:s T"; - const ISO8601 = "Y-m-d\TH:i:sO"; - const ISO8601_EXPANDED = "X-m-d\TH:i:sP"; - const RFC822 = "D, d M y H:i:s O"; - const RFC850 = "l, d-M-y H:i:s T"; - const RFC1036 = "D, d M y H:i:s O"; - const RFC1123 = "D, d M Y H:i:s O"; - const RFC7231 = "D, d M Y H:i:s \G\M\T"; - const RFC2822 = "D, d M Y H:i:s O"; - const RFC3339 = "Y-m-d\TH:i:sP"; - const RFC3339_EXTENDED = "Y-m-d\TH:i:s.vP"; - const RSS = "D, d M Y H:i:s O"; - const W3C = "Y-m-d\TH:i:sP"; - +class DateException extends Exception implements Throwable, Stringable { /** - * Returns new DateTimeImmutable object - * @link http://www.php.net/manual/en/datetimeimmutable.construct.php - * @param string $datetime [optional] A date/time string. Valid formats are explained in Date and Time Formats. - *Enter "now" here to obtain the current time when using - * the $timezone parameter.
- * @param DateTimeZone|null $timezone [optional] A DateTimeZone object representing the - * timezone of $datetime. - *If $timezone is omitted or null, - * the current timezone will be used.
- *The $timezone parameter - * and the current timezone are ignored when the - * $datetime parameter either - * is a UNIX timestamp (e.g. @946684800) - * or specifies a timezone - * (e.g. 2010-01-28T15:00:00+02:00, or - * 2010-07-05T06:00:00Z).
- * @return DateTimeImmutable|false Returns a new DateTimeImmutable instance. - * Procedural style returns false on failure. + * {@inheritdoc} + * @param string $message [optional] + * @param int $code [optional] + * @param Throwable|null $previous [optional] */ - public function __construct (string $datetime = '"now"', ?DateTimeZone $timezone = null): DateTimeImmutable|false {} + public function __construct (string $message = '', int $code = 0, ?Throwable $previous = NULL) {} /** * {@inheritdoc} */ - public function __serialize (): array {} + public function __wakeup () {} /** * {@inheritdoc} - * @param array $data */ - public function __unserialize (array $data): void {} + final public function getMessage (): string {} /** - * The __wakeup handler - * @link http://www.php.net/manual/en/datetime.wakeup.php - * @return void Initializes a DateTime object. - */ - public function __wakeup (): void {} - - /** - * The __set_state handler - * @link http://www.php.net/manual/en/datetimeimmutable.set-state.php - * @param array $array Initialization array. - * @return DateTimeImmutable Returns a new instance of a DateTimeImmutable object. - */ - public static function __set_state (array $array): DateTimeImmutable {} - - /** - * Parses a time string according to a specified format - * @link http://www.php.net/manual/en/datetimeimmutable.createfromformat.php - * @param string $format The format that the passed in string should be in. See the - * formatting options below. In most cases, the same letters as for the - * date can be used. - *All fields are initialised with the current date/time. In most cases you - * would want to reset these to "zero" (the Unix epoch, 1970-01-01 - * 00:00:00 UTC). You do that by including the - * ! character as first character in your - * format, or | as your last. - * Please see the documentation for each character below for more - * information.
- *The format is parsed from left to right, which means that in some - * situations the order in which the format characters are present affects - * the result. In the case of z (the day of the year), - * it is required that a year has already been parsed, - * for example through the Y or y - * characters.
- *Letters that are used for parsing numbers allow a wide range of values, - * outside of what the logical range would be. For example, the - * d (day of the month) accepts values in the range from - * 00 to 99. The only constraint is - * on the amount of digits. The date/time parser's overflow mechanism is - * used when out-of-range values are given. The examples below show some of - * this behaviour.
- *This also means that the data parsed for a format letter is greedy, and - * will read up to the amount of digits its format allows for. That can - * then also mean that there are no - * longer enough characters in the datetime string - * for following format characters. An example on this page also - * illustrates this issue.
- *format character | - *Description | - *Example parsable values | - *
Day | - *--- | - *--- | - *
d and j | - *Day of the month, 2 digits with or without leading zeros | - *- * 01 to 31 or - * 1 to 31. (2 digit numbers - * higher than the number of days in the month are accepted, in which - * case they will make the month overflow. For example using 33 with - * January, means February 2nd) - * | - *
D and l | - *A textual representation of a day | - *- * Mon through Sun or - * Sunday through Saturday. If - * the day name given is different then the day name belonging to a - * parsed (or default) date is different, then an overflow occurs to - * the next date with the given day name. See the - * examples below for an explanation. - * | - *
S | - *English ordinal suffix for the day of the month, 2 - * characters. It's ignored while processing. | - *- * st, nd, rd or - * th. - * | - *
z | - *- * The day of the year (starting from 0); - * must be preceded by Y or y. - * | - *- * 0 through 365. (3 digit - * numbers higher than the numbers in a year are accepted, in which - * case they will make the year overflow. For example using 366 with - * 2022, means January 2nd, 2023) - * | - *
Month | - *--- | - *--- | - *
F and M | - *A textual representation of a month, such as January or Sept | - *- * January through December or - * Jan through Dec - * | - *
m and n | - *Numeric representation of a month, with or without leading zeros | - *- * 01 through 12 or - * 1 through 12. - * (2 digit numbers higher than 12 are accepted, in which case they - * will make the year overflow. For example using 13 means January in - * the next year) - * | - *
Year | - *--- | - *--- | - *
X and x | - *A full numeric representation of a year, up to 19 digits, - * optionally prefixed by + or - * - | - *Examples: 0055, 787, - * 1999, -2003, - * +10191 | - *
Y | - *A full numeric representation of a year, up to 4 digits | - *Examples: 0055, 787, - * 1999, 2003 | - *
y | - *- * A two digit representation of a year (which is assumed to be in the - * range 1970-2069, inclusive) - * | - *- * Examples: - * 99 or 03 - * (which will be interpreted as 1999 and - * 2003, respectively) - * | - *
Time | - *--- | - *--- | - *
a and A | - *Ante meridiem and Post meridiem | - *am or pm | - *
g and h | - *12-hour format of an hour with or without leading zero | - *- * 1 through 12 or - * 01 through 12 (2 digit - * numbers higher than 12 are accepted, in which case they will make - * the day overflow. For example using 14 means - * 02 in the next AM/PM period) - * | - *
G and H | - *24-hour format of an hour with or without leading zeros | - *- * 0 through 23 or - * 00 through 23 (2 digit - * numbers higher than 24 are accepted, in which case they will make - * the day overflow. For example using 26 means - * 02:00 the next day) - * | - *
i | - *Minutes with leading zeros | - *- * 00 to 59. (2 digit - * numbers higher than 59 are accepted, in which case they will make - * the hour overflow. For example using 66 means - * :06 the next hour) - * | - *
s | - *Seconds, with leading zeros | - *- * 00 through 59 (2 digit - * numbers higher than 59 are accepted, in which case they will make - * the minute overflow. For example using 90 means - * :30 the next minute) - * | - *
v | - *Fraction in milliseconds (up to three digits) | - *Example: 12 (0.12 - * seconds), 345 (0.345 seconds) | - *
u | - *Fraction in microseconds (up to six digits) | - *Example: 45 (0.45 - * seconds), 654321 (0.654321 - * seconds) | - *
Timezone | - *--- | - *--- | - *
- * e, O, - * P and T - * | - *Timezone identifier, or difference to UTC in hours, or - * difference to UTC with colon between hours and minutes, or timezone - * abbreviation | - *Examples: UTC, GMT, - * Atlantic/Azores or - * +0200 or +02:00 or - * EST, MDT - * | - *
Full Date/Time | - *--- | - *--- | - *
U | - *Seconds since the Unix Epoch (January 1 1970 00:00:00 GMT) | - *Example: 1292177455 | - *
Whitespace and Separators | - *--- | - *--- | - *
(space) | - *One space or one tab | - *Example: | - *
# | - *- * One of the following separation symbol: ;, - * :, /, ., - * ,, -, ( or - * ) - * | - *Example: / | - *
- * ;, - * :, /, ., - * ,, -, ( or - * ) - * | - *The specified character. | - *Example: - | - *
? | - *A random byte | - *Example: ^ (Be aware that for UTF-8 - * characters you might need more than one ?. - * In this case, using * is probably what you want - * instead) | - *
* | - *Random bytes until the next separator or digit | - *Example: * in Y-*-d with - * the string 2009-aWord-08 will match - * aWord | - *
! | - *Resets all fields (year, month, day, hour, minute, second, - * fraction and timezone information) to zero-like values ( - * 0 for hour, minute, second and fraction, - * 1 for month and day, 1970 - * for year and UTC for timezone information) | - *Without !, all fields will be set to the - * current date and time. | - *
| | - *Resets all fields (year, month, day, hour, minute, second, - * fraction and timezone information) to zero-like values if they have - * not been parsed yet | - *Y-m-d| will set the year, month and day - * to the information found in the string to parse, and sets the hour, - * minute and second to 0. | - *
+ | - *If this format specifier is present, trailing data in the - * string will not cause an error, but a warning instead | - *Use DateTimeImmutable::getLastErrors to find out - * whether trailing data was present. | - *
Unrecognized characters in the format string will cause the - * parsing to fail and an error message is appended to the returned - * structure. You can query error messages with - * DateTimeImmutable::getLastErrors.
- *To include literal characters in format, you have - * to escape them with a backslash (\).
- *If format does not contain the character - * ! then portions of the generated date/time which are not - * specified in format will be set to the current - * system time.
- *If format contains the - * character !, then portions of the generated - * date/time not provided in format, as well as - * values to the left-hand side of the !, will - * be set to corresponding values from the Unix epoch.
- *If any time character is parsed, then all other time-related fields are - * set to "0", unless also parsed.
- *The Unix epoch is 1970-01-01 00:00:00 UTC.
- * @param string $datetime String representing the time. - * @param DateTimeZone|null $timezone [optional] A DateTimeZone object representing the - * desired time zone. - *If timezone is omitted or null and - * datetime contains no timezone, - * the current timezone will be used.
- *The timezone parameter - * and the current timezone are ignored when the - * datetime parameter either - * contains a UNIX timestamp (e.g. 946684800) - * or specifies a timezone - * (e.g. 2010-01-28T15:00:00+02:00).
- * @return DateTimeImmutable|false Returns a new DateTimeImmutable instance or false on failure. - */ - public static function createFromFormat (string $format, string $datetime, ?DateTimeZone $timezone = null): DateTimeImmutable|false {} - - /** - * Returns the warnings and errors - * @link http://www.php.net/manual/en/datetimeimmutable.getlasterrors.php - * @return array|false Returns array containing info about warnings and errors, or false if there - * are neither warnings nor errors. - */ - public static function getLastErrors (): array|false {} - - /** - * Returns date formatted according to given format - * @link http://www.php.net/manual/en/datetime.format.php - * @param string $format The format of the outputted date string. See the formatting - * options below. There are also several - * predefined date constants - * that may be used instead, so for example DATE_RSS - * contains the format string 'D, d M Y H:i:s'. - *format character | - *Description | - *Example returned values | - *
Day | - *--- | - *--- | - *
d | - *Day of the month, 2 digits with leading zeros | - *01 to 31 | - *
D | - *A textual representation of a day, three letters | - *Mon through Sun | - *
j | - *Day of the month without leading zeros | - *1 to 31 | - *
l (lowercase 'L') | - *A full textual representation of the day of the week | - *Sunday through Saturday | - *
N | - *ISO 8601 numeric representation of the day of the week | - *1 (for Monday) through 7 (for Sunday) | - *
S | - *English ordinal suffix for the day of the month, 2 characters | - *- * st, nd, rd or - * th. Works well with j - * | - *
w | - *Numeric representation of the day of the week | - *0 (for Sunday) through 6 (for Saturday) | - *
z | - *The day of the year (starting from 0) | - *0 through 365 | - *
Week | - *--- | - *--- | - *
W | - *ISO 8601 week number of year, weeks starting on Monday | - *Example: 42 (the 42nd week in the year) | - *
Month | - *--- | - *--- | - *
F | - *A full textual representation of a month, such as January or March | - *January through December | - *
m | - *Numeric representation of a month, with leading zeros | - *01 through 12 | - *
M | - *A short textual representation of a month, three letters | - *Jan through Dec | - *
n | - *Numeric representation of a month, without leading zeros | - *1 through 12 | - *
t | - *Number of days in the given month | - *28 through 31 | - *
Year | - *--- | - *--- | - *
L | - *Whether it's a leap year | - *1 if it is a leap year, 0 otherwise. | - *
o | - *ISO 8601 week-numbering year. This has the same value as - * Y, except that if the ISO week number - * (W) belongs to the previous or next year, that year - * is used instead. | - *Examples: 1999 or 2003 | - *
X | - *An expanded full numeric representation of a year, at least 4 digits, - * with - for years BCE, and + - * for years CE. | - *Examples: -0055, +0787, - * +1999, +10191 | - *
x | - *An expanded full numeric representation if requried, or a - * standard full numeral representation if possible (like - * Y). At least four digits. Years BCE are prefixed - * with a -. Years beyond (and including) - * 10000 are prefixed by a - * +. | - *Examples: -0055, 0787, - * 1999, +10191 | - *
Y | - *A full numeric representation of a year, at least 4 digits, - * with - for years BCE. | - *Examples: -0055, 0787, - * 1999, 2003, - * 10191 | - *
y | - *A two digit representation of a year | - *Examples: 99 or 03 | - *
Time | - *--- | - *--- | - *
a | - *Lowercase Ante meridiem and Post meridiem | - *am or pm | - *
A | - *Uppercase Ante meridiem and Post meridiem | - *AM or PM | - *
B | - *Swatch Internet time | - *000 through 999 | - *
g | - *12-hour format of an hour without leading zeros | - *1 through 12 | - *
G | - *24-hour format of an hour without leading zeros | - *0 through 23 | - *
h | - *12-hour format of an hour with leading zeros | - *01 through 12 | - *
H | - *24-hour format of an hour with leading zeros | - *00 through 23 | - *
i | - *Minutes with leading zeros | - *00 to 59 | - *
s | - *Seconds with leading zeros | - *00 through 59 | - *
u | - *- * Microseconds. Note that - * date will always generate - * 000000 since it takes an int - * parameter, whereas DateTime::format does - * support microseconds if DateTime was - * created with microseconds. - * | - *Example: 654321 | - *
v | - *- * Milliseconds. Same note applies as for - * u. - * | - *Example: 654 | - *
Timezone | - *--- | - *--- | - *
e | - *Timezone identifier | - *Examples: UTC, GMT, Atlantic/Azores | - *
I (capital i) | - *Whether or not the date is in daylight saving time | - *1 if Daylight Saving Time, 0 otherwise. | - *
O | - *Difference to Greenwich time (GMT) without colon between hours and minutes | - *Example: +0200 | - *
P | - *Difference to Greenwich time (GMT) with colon between hours and minutes | - *Example: +02:00 | - *
p | - *- * The same as P, but returns Z instead of +00:00 - * (available as of PHP 8.0.0) - * | - *Examples: Z or +02:00 | - *
T | - *Timezone abbreviation, if known; otherwise the GMT offset. | - *Examples: EST, MDT, +05 | - *
Z | - *Timezone offset in seconds. The offset for timezones west of UTC is always - * negative, and for those east of UTC is always positive. | - *-43200 through 50400 | - *
Full Date/Time | - *--- | - *--- | - *
c | - *ISO 8601 date | - *2004-02-12T15:19:21+00:00 | - *
r | - *RFC 2822/RFC 5322 formatted date | - *Example: Thu, 21 Dec 2000 16:01:07 +0200 | - *
U | - *Seconds since the Unix Epoch (January 1 1970 00:00:00 GMT) | - *See also time | - *
Unrecognized characters in the format string will be printed - * as-is. The Z format will always return - * 0 when using gmdate.
- *Since this function only accepts int timestamps the - * u format character is only useful when using the - * date_format function with user based timestamps - * created with date_create.
- * @return string Returns the formatted date string on success. - */ - public function format (string $format): string {} - - /** - * Return time zone relative to given DateTime - * @link http://www.php.net/manual/en/datetime.gettimezone.php - * @return DateTimeZone|false Returns a DateTimeZone object on success - * or false on failure. - */ - public function getTimezone (): DateTimeZone|false {} - - /** - * Returns the timezone offset - * @link http://www.php.net/manual/en/datetime.getoffset.php - * @return int Returns the timezone offset in seconds from UTC on success. - */ - public function getOffset (): int {} - - /** - * Gets the Unix timestamp - * @link http://www.php.net/manual/en/datetime.gettimestamp.php - * @return int Returns the Unix timestamp representing the date. - */ - public function getTimestamp (): int {} - - /** - * Returns the difference between two DateTime objects - * @link http://www.php.net/manual/en/datetime.diff.php - * @param DateTimeInterface $targetObject - * @param bool $absolute [optional] Should the interval be forced to be positive? - * @return DateInterval The DateInterval object represents the - * difference between the two dates. - *The return value more specifically represents the clock-time interval to - * apply to the original object ($this or - * $originObject) to arrive at the - * $targetObject. This process is not always - * reversible.
- *The method is aware of DST changeovers, and hence can return an interval of - * 24 hours and 30 minutes, as per one of the examples. If - * you want to calculate with absolute time, you need to convert both the - * $this/$baseObject, and - * $targetObject to UTC first.
- */ - public function diff (DateTimeInterface $targetObject, bool $absolute = false): DateInterval {} - - /** - * Creates a new object with modified timestamp - * @link http://www.php.net/manual/en/datetimeimmutable.modify.php - * @param string $modifier A date/time string. Valid formats are explained in Date and Time Formats. - * @return DateTimeImmutable|false Returns a new modified DateTimeImmutable object or false on failure. - */ - public function modify (string $modifier): DateTimeImmutable|false {} - - /** - * Returns a new object, with added amount of days, months, years, hours, minutes and seconds - * @link http://www.php.net/manual/en/datetimeimmutable.add.php - * @param DateInterval $interval A DateInterval object - * @return DateTimeImmutable Returns a new DateTimeImmutable object with the modified data. - */ - public function add (DateInterval $interval): DateTimeImmutable {} + * {@inheritdoc} + */ + final public function getCode () {} /** - * Subtracts an amount of days, months, years, hours, minutes and seconds - * @link http://www.php.net/manual/en/datetimeimmutable.sub.php - * @param DateInterval $interval A DateInterval object - * @return DateTimeImmutable Returns a new DateTimeImmutable object with the modified data. + * {@inheritdoc} */ - public function sub (DateInterval $interval): DateTimeImmutable {} + final public function getFile (): string {} /** - * Sets the time zone - * @link http://www.php.net/manual/en/datetimeimmutable.settimezone.php - * @param DateTimeZone $timezone A DateTimeZone object representing the - * desired time zone. - * @return DateTimeImmutable Returns a new modified DateTimeImmutable object for - * method chaining. The underlaying point-in-time is not changed when calling - * this method. + * {@inheritdoc} */ - public function setTimezone (DateTimeZone $timezone): DateTimeImmutable {} + final public function getLine (): int {} /** - * Sets the time - * @link http://www.php.net/manual/en/datetimeimmutable.settime.php - * @param int $hour Hour of the time. - * @param int $minute Minute of the time. - * @param int $second [optional] Second of the time. - * @param int $microsecond [optional] Microsecond of the time. - * @return DateTimeImmutable Returns a new DateTimeImmutable object with the modified data. + * {@inheritdoc} */ - public function setTime (int $hour, int $minute, int $second = null, int $microsecond = null): DateTimeImmutable {} + final public function getTrace (): array {} /** - * Sets the date - * @link http://www.php.net/manual/en/datetimeimmutable.setdate.php - * @param int $year Year of the date. - * @param int $month Month of the date. - * @param int $day Day of the date. - * @return DateTimeImmutable Returns a new DateTimeImmutable object with the modified data. + * {@inheritdoc} */ - public function setDate (int $year, int $month, int $day): DateTimeImmutable {} + final public function getPrevious (): ?Throwable {} /** - * Sets the ISO date - * @link http://www.php.net/manual/en/datetimeimmutable.setisodate.php - * @param int $year Year of the date. - * @param int $week Week of the date. - * @param int $dayOfWeek [optional] Offset from the first day of the week. - * @return DateTimeImmutable Returns a new DateTimeImmutable object with the modified data. + * {@inheritdoc} */ - public function setISODate (int $year, int $week, int $dayOfWeek = 1): DateTimeImmutable {} + final public function getTraceAsString (): string {} /** - * Sets the date and time based on a Unix timestamp - * @link http://www.php.net/manual/en/datetimeimmutable.settimestamp.php - * @param int $timestamp Unix timestamp representing the date. - * Setting timestamps outside the range of int is possible by using - * DateTimeImmutable::modify with the @ format. - * @return DateTimeImmutable Returns a new DateTimeImmutable object with the modified data. + * {@inheritdoc} */ - public function setTimestamp (int $timestamp): DateTimeImmutable {} + public function __toString (): string {} + +} + +class DateInvalidTimeZoneException extends DateException implements Stringable, Throwable { /** - * Returns new DateTimeImmutable instance encapsulating the given DateTime object - * @link http://www.php.net/manual/en/datetimeimmutable.createfrommutable.php - * @param DateTime $object - * @return static Returns a new DateTimeImmutable instance. + * {@inheritdoc} + * @param string $message [optional] + * @param int $code [optional] + * @param Throwable|null $previous [optional] */ - public static function createFromMutable (DateTime $object): static {} + public function __construct (string $message = '', int $code = 0, ?Throwable $previous = NULL) {} /** - * Returns new DateTimeImmutable object encapsulating the given DateTimeInterface object - * @link http://www.php.net/manual/en/datetimeimmutable.createfrominterface.php - * @param DateTimeInterface $object - * @return DateTimeImmutable Returns a new DateTimeImmutable instance. + * {@inheritdoc} */ - public static function createFromInterface (DateTimeInterface $object): DateTimeImmutable {} - -} + public function __wakeup () {} -/** - * Representation of time zone. - * @link http://www.php.net/manual/en/class.datetimezone.php - */ -class DateTimeZone { - /** - * Africa time zones. - const AFRICA = 1; - /** - * America time zones. - const AMERICA = 2; - /** - * Antarctica time zones. - const ANTARCTICA = 4; - /** - * Arctic time zones. - const ARCTIC = 8; - /** - * Asia time zones. - const ASIA = 16; - /** - * Atlantic time zones. - const ATLANTIC = 32; - /** - * Australia time zones. - const AUSTRALIA = 64; /** - * Europe time zones. - const EUROPE = 128; - /** - * Indian time zones. - const INDIAN = 256; - /** - * Pacific time zones. - const PACIFIC = 512; + * {@inheritdoc} + */ + final public function getMessage (): string {} + /** - * UTC time zones. - const UTC = 1024; + * {@inheritdoc} + */ + final public function getCode () {} + /** - * All time zones. - const ALL = 2047; + * {@inheritdoc} + */ + final public function getFile (): string {} + /** - * All time zones including backwards compatible. - const ALL_WITH_BC = 4095; + * {@inheritdoc} + */ + final public function getLine (): int {} + /** - * Time zones per country. - const PER_COUNTRY = 4096; + * {@inheritdoc} + */ + final public function getTrace (): array {} + /** + * {@inheritdoc} + */ + final public function getPrevious (): ?Throwable {} /** - * Creates new DateTimeZone object - * @link http://www.php.net/manual/en/datetimezone.construct.php - * @param string $timezone - * @return DateTimeZone|false Returns DateTimeZone on success. - * Procedural style returns false on failure. - */ - public function __construct (string $timezone): DateTimeZone|false {} - - /** - * Returns the name of the timezone - * @link http://www.php.net/manual/en/datetimezone.getname.php - * @return string Depending on zone type, UTC offset (type 1), timezone abbreviation (type - * 2), and timezone identifiers as published in the IANA timezone database - * (type 3), the descriptor string to create a new - * DateTimeZone object with the same offset and/or - * rules. For example 02:00, CEST, or - * one of the timezone names in the. - */ - public function getName (): string {} - - /** - * Returns the timezone offset from GMT - * @link http://www.php.net/manual/en/datetimezone.getoffset.php - * @param DateTimeInterface $datetime - * @return int Returns time zone offset in seconds. - */ - public function getOffset (DateTimeInterface $datetime): int {} - - /** - * Returns all transitions for the timezone - * @link http://www.php.net/manual/en/datetimezone.gettransitions.php - * @param int $timestampBegin [optional] - * @param int $timestampEnd [optional] - * @return array|false Returns a numerically indexed array of - * transition arrays on success, or false on failure. DateTimeZone - * objects wrapping type 1 (UTC offsets) and type 2 (abbreviations) do not - * contain any transitions, and calling this method on them will return - * false. - *
If timestampBegin is given, the first entry in the - * returned array will contain a transition element at the time of - * timestampBegin.
- *Key | - *Type | - *Description | - *
ts | - *int | - *Unix timestamp | - *
time | - *string | - *DateTimeInterface::ISO8601_EXPANDED (PHP - * 8.2 and later), or DateTimeInterface::ISO8601 (PHP - * 8.1 and lower) time string | - *
offset | - *int | - *Offset to UTC in seconds | - *
isdst | - *bool | - *Whether daylight saving time is active | - *
abbr | - *string | - *Timezone abbreviation | - *
A date interval stores either a fixed amount of time (in years, months, - * days, hours etc) or a relative time string in the format that - * DateTimeImmutable's and - * DateTime's constructors support.
- *More specifically, the information in an object of the - * DateInterval class is an instruction to get from - * one date/time to another date/time. This process is not always reversible.
- *A common way to create a DateInterval object - * is by calculating the difference between two date/time objects through - * DateTimeInterface::diff.
- *Since there is no well defined way to compare date intervals, - * DateInterval instances are - * incomparable.
- * @link http://www.php.net/manual/en/class.dateinterval.php - */ -class DateInterval { + /** + * {@inheritdoc} + */ + final public function getFile (): string {} /** - * Number of years. - * @var int - * @link http://www.php.net/manual/en/class.dateinterval.php#dateinterval.props.y + * {@inheritdoc} */ - public int $y; + final public function getLine (): int {} /** - * Number of months. - * @var int - * @link http://www.php.net/manual/en/class.dateinterval.php#dateinterval.props.m + * {@inheritdoc} */ - public int $m; + final public function getTrace (): array {} /** - * Number of days. - * @var int - * @link http://www.php.net/manual/en/class.dateinterval.php#dateinterval.props.d + * {@inheritdoc} */ - public int $d; + final public function getPrevious (): ?Throwable {} /** - * Number of hours. - * @var int - * @link http://www.php.net/manual/en/class.dateinterval.php#dateinterval.props.h + * {@inheritdoc} */ - public int $h; + final public function getTraceAsString (): string {} /** - * Number of minutes. - * @var int - * @link http://www.php.net/manual/en/class.dateinterval.php#dateinterval.props.i + * {@inheritdoc} */ - public int $i; + public function __toString (): string {} + +} + +class DateMalformedStringException extends DateException implements Stringable, Throwable { /** - * Number of seconds. - * @var int - * @link http://www.php.net/manual/en/class.dateinterval.php#dateinterval.props.s + * {@inheritdoc} + * @param string $message [optional] + * @param int $code [optional] + * @param Throwable|null $previous [optional] */ - public int $s; + public function __construct (string $message = '', int $code = 0, ?Throwable $previous = NULL) {} /** - * Number of microseconds, as a fraction of a second. - * @var float - * @link http://www.php.net/manual/en/class.dateinterval.php#dateinterval.props.f + * {@inheritdoc} */ - public float $f; + public function __wakeup () {} /** - * Is 1 if the interval - * represents a negative time period and - * 0 otherwise. - * See DateInterval::format. - * @var int - * @link http://www.php.net/manual/en/class.dateinterval.php#dateinterval.props.invert + * {@inheritdoc} */ - public int $invert; + final public function getMessage (): string {} /** - * If the DateInterval object was created by - * DateTimeImmutable::diff or - * DateTime::diff, then this is the - * total number of full days between the start and end dates. Otherwise, - * days will be false. - * @var mixed - * @link http://www.php.net/manual/en/class.dateinterval.php#dateinterval.props.days + * {@inheritdoc} */ - public mixed $days; + final public function getCode () {} /** - * If the DateInterval object was created by - * DateInterval::createFromDateString, then - * this property's value will be true, and the - * date_string property will be populated. Otherwise, - * the value will be false, and the y to - * f, invert, and - * days properties will be populated. - * @var bool - * @link http://www.php.net/manual/en/class.dateinterval.php#dateinterval.props.from_string + * {@inheritdoc} */ - public bool $from_string; + final public function getFile (): string {} /** - * The string used as argument to - * DateInterval::createFromDateString. - * @var string - * @link http://www.php.net/manual/en/class.dateinterval.php#dateinterval.props.date_string + * {@inheritdoc} */ - public string $date_string; + final public function getLine (): int {} /** - * Creates a new DateInterval object - * @link http://www.php.net/manual/en/dateinterval.construct.php - * @param string $duration - * @return string + * {@inheritdoc} */ - public function __construct (string $duration): string {} + final public function getTrace (): array {} /** - * Sets up a DateInterval from the relative parts of the string - * @link http://www.php.net/manual/en/dateinterval.createfromdatestring.php - * @param string $datetime - * @return DateInterval|false Returns a new DateInterval instance on success, or false on failure. + * {@inheritdoc} */ - public static function createFromDateString (string $datetime): DateInterval|false {} + final public function getPrevious (): ?Throwable {} /** - * Formats the interval - * @link http://www.php.net/manual/en/dateinterval.format.php - * @param string $format - * @return string Returns the formatted interval. + * {@inheritdoc} */ - public function format (string $format): string {} + final public function getTraceAsString (): string {} /** * {@inheritdoc} */ - public function __serialize (): array {} + public function __toString (): string {} + +} + +class DateMalformedIntervalStringException extends DateException implements Stringable, Throwable { /** * {@inheritdoc} - * @param array $data + * @param string $message [optional] + * @param int $code [optional] + * @param Throwable|null $previous [optional] */ - public function __unserialize (array $data): void {} + public function __construct (string $message = '', int $code = 0, ?Throwable $previous = NULL) {} /** * {@inheritdoc} @@ -2164,892 +1003,235 @@ public function __wakeup () {} /** * {@inheritdoc} - * @param array $array */ - public static function __set_state (array $array) {} + final public function getMessage (): string {} -} - -/** - * Represents a date period. - *A date period allows iteration over a set of dates and times, recurring at - * regular intervals, over a given period.
- * @link http://www.php.net/manual/en/class.dateperiod.php - */ -class DatePeriod implements IteratorAggregate, Traversable { - /** - * Exclude start date, used in DatePeriod::__construct. - const EXCLUDE_START_DATE = 1; /** - * Include end date, used in DatePeriod::__construct. - const INCLUDE_END_DATE = 2; + * {@inheritdoc} + */ + final public function getCode () {} + /** + * {@inheritdoc} + */ + final public function getFile (): string {} /** - * The start date of the period. - * @var DateTimeInterface|null - * @link http://www.php.net/manual/en/class.dateperiod.php#dateperiod.props.start + * {@inheritdoc} */ - public readonly ?DateTimeInterface $start; + final public function getLine (): int {} /** - * During iteration this will contain the current date within the period. - * @var DateTimeInterface|null - * @link http://www.php.net/manual/en/class.dateperiod.php#dateperiod.props.current + * {@inheritdoc} */ - public readonly ?DateTimeInterface $current; + final public function getTrace (): array {} /** - * The end date of the period. - * @var DateTimeInterface|null - * @link http://www.php.net/manual/en/class.dateperiod.php#dateperiod.props.end + * {@inheritdoc} */ - public readonly ?DateTimeInterface $end; + final public function getPrevious (): ?Throwable {} - /** - * An ISO 8601 repeating interval specification. - * @var DateInterval|null - * @link http://www.php.net/manual/en/class.dateperiod.php#dateperiod.props.interval - */ - public readonly ?DateInterval $interval; + /** + * {@inheritdoc} + */ + final public function getTraceAsString (): string {} /** - * The minimum amount of instances as retured by the iterator. - *If the number of recurrences has been explicitly passed through the - * recurrences parameter in the constructor of the - * DatePeriod instance, then this property contains - * this value, plus one if the start date has not been disabled - * through DatePeriod::EXCLUDE_START_DATE, - * plus one if the end date has been enabled through - * DatePeriod::INCLUDE_END_DATE.
- *If the number of recurrences has not been explicitly passed, then this - * property contains the minimum number of returned instances. This would - * be 0, plus one if the start date - * has not been disabled through - * DatePeriod::EXCLUDE_START_DATE, - * plus one if the end date has been enabled through - * DatePeriod::INCLUDE_END_DATE.
- *<?php
- * $start = new DateTime('2018-12-31 00:00:00');
- * $end = new DateTime('2021-12-31 00:00:00');
- * $interval = new DateInterval('P1M');
- * $recurrences = 5;
- * // recurrences explicitly set through the constructor
- * $period = new DatePeriod($start, $interval, $recurrences, DatePeriod::EXCLUDE_START_DATE);
- * echo $period->recurrences, "\n";
- * $period = new DatePeriod($start, $interval, $recurrences);
- * echo $period->recurrences, "\n";
- * $period = new DatePeriod($start, $interval, $recurrences, DatePeriod::INCLUDE_END_DATE);
- * echo $period->recurrences, "\n";
- * // recurrences not set in the constructor
- * $period = new DatePeriod($start, $interval, $end);
- * echo $period->recurrences, "\n";
- * $period = new DatePeriod($start, $interval, $end, DatePeriod::EXCLUDE_START_DATE);
- * echo $period->recurrences, "\n";
- * ?>
- * The above example will output:
- * 5 - * 6 - * 7 - * 1 - * 0 - *See also DatePeriod::getRecurrences.
- * @var int - * @link http://www.php.net/manual/en/class.dateperiod.php#dateperiod.props.recurrences + * {@inheritdoc} */ - public readonly int $recurrences; + public function __toString (): string {} + +} + +class DateMalformedPeriodStringException extends DateException implements Stringable, Throwable { /** - * Whether to include the start date in the set of recurring dates or not. - * @var bool - * @link http://www.php.net/manual/en/class.dateperiod.php#dateperiod.props.include_start_date + * {@inheritdoc} + * @param string $message [optional] + * @param int $code [optional] + * @param Throwable|null $previous [optional] */ - public readonly bool $include_start_date; + public function __construct (string $message = '', int $code = 0, ?Throwable $previous = NULL) {} /** - * Whether to include the end date in the set of recurring dates or not. - * @var bool - * @link http://www.php.net/manual/en/class.dateperiod.php#dateperiod.props.include_end_date + * {@inheritdoc} */ - public readonly bool $include_end_date; + public function __wakeup () {} /** - * Creates a new DatePeriod object - * @link http://www.php.net/manual/en/dateperiod.construct.php - * @param DateTimeInterface $start - * @param DateInterval $interval - * @param int $recurrences - * @param int $options [optional] - * @return DateTimeInterface + * {@inheritdoc} */ - public function __construct (DateTimeInterface $start, DateInterval $interval, int $recurrences, int $options = null): DateTimeInterface {} + final public function getMessage (): string {} /** - * Gets the start date - * @link http://www.php.net/manual/en/dateperiod.getstartdate.php - * @return DateTimeInterface Returns a DateTimeImmutable object - * when the DatePeriod is initialized with a - * DateTimeImmutable object - * as the start parameter. - *Returns a DateTime object - * otherwise.
+ * {@inheritdoc} */ - public function getStartDate (): DateTimeInterface {} + final public function getCode () {} /** - * Gets the end date - * @link http://www.php.net/manual/en/dateperiod.getenddate.php - * @return DateTimeInterface|null Returns null if the DatePeriod does - * not have an end date. For example, when initialized with the - * recurrences parameter, or the - * isostr parameter without an - * end date. - *Returns a DateTimeImmutable object - * when the DatePeriod is initialized with a - * DateTimeImmutable object - * as the end parameter.
- *Returns a cloned DateTime object - * representing the end date otherwise.
- */ - public function getEndDate (): ?DateTimeInterface {} - - /** - * Gets the interval - * @link http://www.php.net/manual/en/dateperiod.getdateinterval.php - * @return DateInterval Returns a DateInterval object - */ - public function getDateInterval (): DateInterval {} - - /** - * Gets the number of recurrences - * @link http://www.php.net/manual/en/dateperiod.getrecurrences.php - * @return int|null The number of recurrences as set by explicitly passing the - * $recurrences to the contructor of the - * DatePeriod class, or null otherwise. + * {@inheritdoc} */ - public function getRecurrences (): ?int {} + final public function getFile (): string {} /** * {@inheritdoc} */ - public function __serialize (): array {} + final public function getLine (): int {} /** * {@inheritdoc} - * @param array $data */ - public function __unserialize (array $data): void {} + final public function getTrace (): array {} /** * {@inheritdoc} */ - public function __wakeup () {} + final public function getPrevious (): ?Throwable {} /** * {@inheritdoc} - * @param array $array */ - public static function __set_state (array $array) {} + final public function getTraceAsString (): string {} /** * {@inheritdoc} */ - public function getIterator (): Iterator {} + public function __toString (): string {} } /** - * Parse about any English textual datetime description into a Unix timestamp - * @link http://www.php.net/manual/en/function.strtotime.php - * @param string $datetime - * @param int|null $baseTimestamp [optional] - * @return int|false Returns a timestamp on success, false otherwise. + * {@inheritdoc} + * @param string $datetime + * @param int|null $baseTimestamp [optional] */ -function strtotime (string $datetime, ?int $baseTimestamp = null): int|false {} +function strtotime (string $datetime, ?int $baseTimestamp = NULL): int|false {} /** - * Format a Unix timestamp - * @link http://www.php.net/manual/en/function.date.php - * @param string $format Format accepted by DateTimeInterface::format. - * @param int|null $timestamp [optional] The optional timestamp parameter is an - * int Unix timestamp that defaults to the current - * local time if timestamp is omitted or null. In other - * words, it defaults to the value of time. - * @return string Returns a formatted date string. + * {@inheritdoc} + * @param string $format + * @param int|null $timestamp [optional] */ -function date (string $format, ?int $timestamp = null): string {} +function date (string $format, ?int $timestamp = NULL): string {} /** - * Format a local time/date part as integer - * @link http://www.php.net/manual/en/function.idate.php - * @param string $format - * @param int|null $timestamp [optional] - * @return int|false Returns an int on success, or false on failure. - *As idate always returns an int and - * as they can't start with a "0", idate may return - * fewer digits than you would expect. See the example below.
+ * {@inheritdoc} + * @param string $format + * @param int|null $timestamp [optional] */ -function idate (string $format, ?int $timestamp = null): int|false {} +function idate (string $format, ?int $timestamp = NULL): int|false {} /** - * Format a GMT/UTC date/time - * @link http://www.php.net/manual/en/function.gmdate.php - * @param string $format - * @param int|null $timestamp [optional] - * @return string Returns a formatted date string. + * {@inheritdoc} + * @param string $format + * @param int|null $timestamp [optional] */ -function gmdate (string $format, ?int $timestamp = null): string {} +function gmdate (string $format, ?int $timestamp = NULL): string {} /** - * Get Unix timestamp for a date - * @link http://www.php.net/manual/en/function.mktime.php - * @param int $hour - * @param int|null $minute [optional] - * @param int|null $second [optional] - * @param int|null $month [optional] - * @param int|null $day [optional] - * @param int|null $year [optional] - * @return int|false mktime returns the Unix timestamp of the arguments - * given. + * {@inheritdoc} + * @param int $hour + * @param int|null $minute [optional] + * @param int|null $second [optional] + * @param int|null $month [optional] + * @param int|null $day [optional] + * @param int|null $year [optional] */ -function mktime (int $hour, ?int $minute = null, ?int $second = null, ?int $month = null, ?int $day = null, ?int $year = null): int|false {} +function mktime (int $hour, ?int $minute = NULL, ?int $second = NULL, ?int $month = NULL, ?int $day = NULL, ?int $year = NULL): int|false {} /** - * Get Unix timestamp for a GMT date - * @link http://www.php.net/manual/en/function.gmmktime.php - * @param int $hour - * @param int|null $minute [optional] - * @param int|null $second [optional] - * @param int|null $month [optional] - * @param int|null $day [optional] - * @param int|null $year [optional] - * @return int|false Returns a int Unix timestamp on success, or false on failure. + * {@inheritdoc} + * @param int $hour + * @param int|null $minute [optional] + * @param int|null $second [optional] + * @param int|null $month [optional] + * @param int|null $day [optional] + * @param int|null $year [optional] */ -function gmmktime (int $hour, ?int $minute = null, ?int $second = null, ?int $month = null, ?int $day = null, ?int $year = null): int|false {} +function gmmktime (int $hour, ?int $minute = NULL, ?int $second = NULL, ?int $month = NULL, ?int $day = NULL, ?int $year = NULL): int|false {} /** - * Validate a Gregorian date - * @link http://www.php.net/manual/en/function.checkdate.php - * @param int $month - * @param int $day - * @param int $year - * @return bool Returns true if the date given is valid; otherwise returns false. + * {@inheritdoc} + * @param int $month + * @param int $day + * @param int $year */ function checkdate (int $month, int $day, int $year): bool {} /** - * Format a local time/date according to locale settings - * @link http://www.php.net/manual/en/function.strftime.php - * @param string $format - * @param int|null $timestamp [optional] - * @return string|false Returns a string formatted according format - * using the given timestamp or the current - * local time if no timestamp is given. Month and weekday names and - * other language-dependent strings respect the current locale set - * with setlocale. - * The function returns false if format is empty, contains unsupported - * conversion specifiers, or if the length of the returned string would be greater than - * 4095. - * @deprecated 1 + * {@inheritdoc} + * @param string $format + * @param int|null $timestamp [optional] + * @deprecated */ -function strftime (string $format, ?int $timestamp = null): string|false {} +function strftime (string $format, ?int $timestamp = NULL): string|false {} /** - * Format a GMT/UTC time/date according to locale settings - * @link http://www.php.net/manual/en/function.gmstrftime.php - * @param string $format - * @param int|null $timestamp [optional] - * @return string|false Returns a string formatted according to the given format string - * using the given timestamp or the current - * local time if no timestamp is given. Month and weekday names and - * other language dependent strings respect the current locale set - * with setlocale. - * On failure, false is returned. - * @deprecated 1 + * {@inheritdoc} + * @param string $format + * @param int|null $timestamp [optional] + * @deprecated */ -function gmstrftime (string $format, ?int $timestamp = null): string|false {} +function gmstrftime (string $format, ?int $timestamp = NULL): string|false {} /** - * Return current Unix timestamp - * @link http://www.php.net/manual/en/function.time.php - * @return int Returns the current timestamp. + * {@inheritdoc} */ function time (): int {} /** - * Get the local time - * @link http://www.php.net/manual/en/function.localtime.php - * @param int|null $timestamp [optional] - * @param bool $associative [optional] - * @return array If associative is set to false or not supplied then - * the array is returned as a regular, numerically indexed array. - * If associative is set to true then - * localtime returns an associative array containing - * the elements of the structure returned by the C - * function call to localtime. - * The keys of the associative array are as follows: - *
- * "tm_sec" - seconds, 0 to 59
- *
- * "tm_min" - minutes, 0 to 59
- *
- * "tm_hour" - hours, 0 to 23
- *
- * "tm_mday" - day of the month, 1 to 31
- *
- * "tm_mon" - month of the year, 0 (Jan) to 11 (Dec)
- *
- * "tm_year" - years since 1900
- *
- * "tm_wday" - day of the week, 0 (Sun) to 6 (Sat)
- *
- * "tm_yday" - day of the year, 0 to 365
- *
- * "tm_isdst" - is daylight savings time in effect?
- * Positive if yes, 0 if not, negative if unknown.
Key | - *Description | - *Example returned values | - *
"seconds" | - *Numeric representation of seconds | - *0 to 59 | - *
"minutes" | - *Numeric representation of minutes | - *0 to 59 | - *
"hours" | - *Numeric representation of hours | - *0 to 23 | - *
"mday" | - *Numeric representation of the day of the month | - *1 to 31 | - *
"wday" | - *Numeric representation of the day of the week | - *0 (for Sunday) through 6 (for Saturday) | - *
"mon" | - *Numeric representation of a month | - *1 through 12 | - *
"year" | - *A full numeric representation of a year, 4 digits | - *Examples: 1999 or 2003 | - *
"yday" | - *Numeric representation of the day of the year | - *0 through 365 | - *
"weekday" | - *A full textual representation of the day of the week | - *Sunday through Saturday | - *
"month" | - *A full textual representation of a month, such as January or March | - *January through December | - *
0 | - *- * Seconds since the Unix Epoch, similar to the values returned by - * time and used by date. - * | - *- * System Dependent, typically -2147483648 through - * 2147483647. - * | - *
All fields are initialised with the current date/time. In most cases you - * would want to reset these to "zero" (the Unix epoch, 1970-01-01 - * 00:00:00 UTC). You do that by including the - * ! character as first character in your - * format, or | as your last. - * Please see the documentation for each character below for more - * information.
- *The format is parsed from left to right, which means that in some - * situations the order in which the format characters are present affects - * the result. In the case of z (the day of the year), - * it is required that a year has already been parsed, - * for example through the Y or y - * characters.
- *Letters that are used for parsing numbers allow a wide range of values, - * outside of what the logical range would be. For example, the - * d (day of the month) accepts values in the range from - * 00 to 99. The only constraint is - * on the amount of digits. The date/time parser's overflow mechanism is - * used when out-of-range values are given. The examples below show some of - * this behaviour.
- *This also means that the data parsed for a format letter is greedy, and - * will read up to the amount of digits its format allows for. That can - * then also mean that there are no - * longer enough characters in the datetime string - * for following format characters. An example on this page also - * illustrates this issue.
- *format character | - *Description | - *Example parsable values | - *
Day | - *--- | - *--- | - *
d and j | - *Day of the month, 2 digits with or without leading zeros | - *- * 01 to 31 or - * 1 to 31. (2 digit numbers - * higher than the number of days in the month are accepted, in which - * case they will make the month overflow. For example using 33 with - * January, means February 2nd) - * | - *
D and l | - *A textual representation of a day | - *- * Mon through Sun or - * Sunday through Saturday. If - * the day name given is different then the day name belonging to a - * parsed (or default) date is different, then an overflow occurs to - * the next date with the given day name. See the - * examples below for an explanation. - * | - *
S | - *English ordinal suffix for the day of the month, 2 - * characters. It's ignored while processing. | - *- * st, nd, rd or - * th. - * | - *
z | - *- * The day of the year (starting from 0); - * must be preceded by Y or y. - * | - *- * 0 through 365. (3 digit - * numbers higher than the numbers in a year are accepted, in which - * case they will make the year overflow. For example using 366 with - * 2022, means January 2nd, 2023) - * | - *
Month | - *--- | - *--- | - *
F and M | - *A textual representation of a month, such as January or Sept | - *- * January through December or - * Jan through Dec - * | - *
m and n | - *Numeric representation of a month, with or without leading zeros | - *- * 01 through 12 or - * 1 through 12. - * (2 digit numbers higher than 12 are accepted, in which case they - * will make the year overflow. For example using 13 means January in - * the next year) - * | - *
Year | - *--- | - *--- | - *
X and x | - *A full numeric representation of a year, up to 19 digits, - * optionally prefixed by + or - * - | - *Examples: 0055, 787, - * 1999, -2003, - * +10191 | - *
Y | - *A full numeric representation of a year, up to 4 digits | - *Examples: 0055, 787, - * 1999, 2003 | - *
y | - *- * A two digit representation of a year (which is assumed to be in the - * range 1970-2069, inclusive) - * | - *- * Examples: - * 99 or 03 - * (which will be interpreted as 1999 and - * 2003, respectively) - * | - *
Time | - *--- | - *--- | - *
a and A | - *Ante meridiem and Post meridiem | - *am or pm | - *
g and h | - *12-hour format of an hour with or without leading zero | - *- * 1 through 12 or - * 01 through 12 (2 digit - * numbers higher than 12 are accepted, in which case they will make - * the day overflow. For example using 14 means - * 02 in the next AM/PM period) - * | - *
G and H | - *24-hour format of an hour with or without leading zeros | - *- * 0 through 23 or - * 00 through 23 (2 digit - * numbers higher than 24 are accepted, in which case they will make - * the day overflow. For example using 26 means - * 02:00 the next day) - * | - *
i | - *Minutes with leading zeros | - *- * 00 to 59. (2 digit - * numbers higher than 59 are accepted, in which case they will make - * the hour overflow. For example using 66 means - * :06 the next hour) - * | - *
s | - *Seconds, with leading zeros | - *- * 00 through 59 (2 digit - * numbers higher than 59 are accepted, in which case they will make - * the minute overflow. For example using 90 means - * :30 the next minute) - * | - *
v | - *Fraction in milliseconds (up to three digits) | - *Example: 12 (0.12 - * seconds), 345 (0.345 seconds) | - *
u | - *Fraction in microseconds (up to six digits) | - *Example: 45 (0.45 - * seconds), 654321 (0.654321 - * seconds) | - *
Timezone | - *--- | - *--- | - *
- * e, O, - * P and T - * | - *Timezone identifier, or difference to UTC in hours, or - * difference to UTC with colon between hours and minutes, or timezone - * abbreviation | - *Examples: UTC, GMT, - * Atlantic/Azores or - * +0200 or +02:00 or - * EST, MDT - * | - *
Full Date/Time | - *--- | - *--- | - *
U | - *Seconds since the Unix Epoch (January 1 1970 00:00:00 GMT) | - *Example: 1292177455 | - *
Whitespace and Separators | - *--- | - *--- | - *
(space) | - *One space or one tab | - *Example: | - *
# | - *- * One of the following separation symbol: ;, - * :, /, ., - * ,, -, ( or - * ) - * | - *Example: / | - *
- * ;, - * :, /, ., - * ,, -, ( or - * ) - * | - *The specified character. | - *Example: - | - *
? | - *A random byte | - *Example: ^ (Be aware that for UTF-8 - * characters you might need more than one ?. - * In this case, using * is probably what you want - * instead) | - *
* | - *Random bytes until the next separator or digit | - *Example: * in Y-*-d with - * the string 2009-aWord-08 will match - * aWord | - *
! | - *Resets all fields (year, month, day, hour, minute, second, - * fraction and timezone information) to zero-like values ( - * 0 for hour, minute, second and fraction, - * 1 for month and day, 1970 - * for year and UTC for timezone information) | - *Without !, all fields will be set to the - * current date and time. | - *
| | - *Resets all fields (year, month, day, hour, minute, second, - * fraction and timezone information) to zero-like values if they have - * not been parsed yet | - *Y-m-d| will set the year, month and day - * to the information found in the string to parse, and sets the hour, - * minute and second to 0. | - *
+ | - *If this format specifier is present, trailing data in the - * string will not cause an error, but a warning instead | - *Use DateTimeImmutable::getLastErrors to find out - * whether trailing data was present. | - *
Unrecognized characters in the format string will cause the - * parsing to fail and an error message is appended to the returned - * structure. You can query error messages with - * DateTimeImmutable::getLastErrors.
- *To include literal characters in format, you have - * to escape them with a backslash (\).
- *If format does not contain the character - * ! then portions of the generated date/time which are not - * specified in format will be set to the current - * system time.
- *If format contains the - * character !, then portions of the generated - * date/time not provided in format, as well as - * values to the left-hand side of the !, will - * be set to corresponding values from the Unix epoch.
- *If any time character is parsed, then all other time-related fields are - * set to "0", unless also parsed.
- *The Unix epoch is 1970-01-01 00:00:00 UTC.
- * @param string $datetime String representing the time. - * @param DateTimeZone|null $timezone [optional] A DateTimeZone object representing the - * desired time zone. - *If timezone is omitted or null and - * datetime contains no timezone, - * the current timezone will be used.
- *The timezone parameter - * and the current timezone are ignored when the - * datetime parameter either - * contains a UNIX timestamp (e.g. 946684800) - * or specifies a timezone - * (e.g. 2010-01-28T15:00:00+02:00).
- * @return DateTimeImmutable|false Returns a new DateTimeImmutable instance or false on failure. + * {@inheritdoc} + * @param string $format + * @param string $datetime + * @param DateTimeZone|null $timezone [optional] */ -function date_create_immutable_from_format (string $format, string $datetime, ?DateTimeZone $timezone = null): DateTimeImmutable|false {} +function date_create_immutable_from_format (string $format, string $datetime, ?DateTimeZone $timezone = NULL): DateTimeImmutable|false {} /** - * Returns associative array with detailed info about given date/time - * @link http://www.php.net/manual/en/function.date-parse.php - * @param string $datetime - * @return array Returns array with information about the parsed date/time. - *The returned array has keys for year, - * month, day, hour, - * minute, second, - * fraction, and is_localtime.
- *If is_localtime is present then - * zone_type indicates the type of timezone. For type - * 1 (UTC offset) the zone, - * is_dst fields are added; for type 2 - * (abbreviation) the fields tz_abbr, - * is_dst are added; and for type 3 - * (timezone identifier) the tz_abbr, - * tz_id are added.
- *If relative time elements are present in the - * datetime string such as +3 days, - * the then returned array includes a nested array with the key - * relative. This array then contains the keys - * year, month, day, - * hour, minute, - * second, and if necessary weekday, and - * weekdays, depending on the string that was passed in.
- *The array includes warning_count and - * warnings fields. The first one indicate how many - * warnings there were. - * The keys of elements warnings array indicate the - * position in the given datetime where the warning - * occurred, with the string value describing the warning itself.
- *The array also contains error_count and - * errors fields. The first one indicate how many errors - * were found. - * The keys of elements errors array indicate the - * position in the given datetime where the error - * occurred, with the string value describing the error itself.
- *The number of array elements in the warnings and - * errors arrays might be less than - * warning_count or error_count if they - * occurred at the same position.
+ * {@inheritdoc} + * @param string $datetime */ function date_parse (string $datetime): array {} /** - * Get info about given date formatted according to the specified format - * @link http://www.php.net/manual/en/function.date-parse-from-format.php - * @param string $format - * @param string $datetime - * @return array Returns associative array with detailed info about given date/time. - *The returned array has keys for year, - * month, day, hour, - * minute, second, - * fraction, and is_localtime.
- *If is_localtime is present then - * zone_type indicates the type of timezone. For type - * 1 (UTC offset) the zone, - * is_dst fields are added; for type 2 - * (abbreviation) the fields tz_abbr, - * is_dst are added; and for type 3 - * (timezone identifier) the tz_abbr, - * tz_id are added.
- *The array includes warning_count and - * warnings fields. The first one indicate how many - * warnings there were. - * The keys of elements warnings array indicate the - * position in the given datetime where the warning - * occurred, with the string value describing the warning itself. An example - * below shows such a warning.
- *The array also contains error_count and - * errors fields. The first one indicate how many errors - * were found. - * The keys of elements errors array indicate the - * position in the given datetime where the error - * occurred, with the string value describing the error itself. An example - * below shows such an error.
- *The number of array elements in the warnings and - * errors arrays might be less than - * warning_count or error_count if they - * occurred at the same position.
+ * {@inheritdoc} + * @param string $format + * @param string $datetime */ function date_parse_from_format (string $format, string $datetime): array {} @@ -3059,592 +1241,156 @@ function date_parse_from_format (string $format, string $datetime): array {} function date_get_last_errors (): array|false {} /** - * Returns date formatted according to given format - * @link http://www.php.net/manual/en/datetime.format.php - * @param DateTimeInterface $object Procedural style only: A DateTime object - * returned by date_create - * @param string $format The format of the outputted date string. See the formatting - * options below. There are also several - * predefined date constants - * that may be used instead, so for example DATE_RSS - * contains the format string 'D, d M Y H:i:s'. - *format character | - *Description | - *Example returned values | - *
Day | - *--- | - *--- | - *
d | - *Day of the month, 2 digits with leading zeros | - *01 to 31 | - *
D | - *A textual representation of a day, three letters | - *Mon through Sun | - *
j | - *Day of the month without leading zeros | - *1 to 31 | - *
l (lowercase 'L') | - *A full textual representation of the day of the week | - *Sunday through Saturday | - *
N | - *ISO 8601 numeric representation of the day of the week | - *1 (for Monday) through 7 (for Sunday) | - *
S | - *English ordinal suffix for the day of the month, 2 characters | - *- * st, nd, rd or - * th. Works well with j - * | - *
w | - *Numeric representation of the day of the week | - *0 (for Sunday) through 6 (for Saturday) | - *
z | - *The day of the year (starting from 0) | - *0 through 365 | - *
Week | - *--- | - *--- | - *
W | - *ISO 8601 week number of year, weeks starting on Monday | - *Example: 42 (the 42nd week in the year) | - *
Month | - *--- | - *--- | - *
F | - *A full textual representation of a month, such as January or March | - *January through December | - *
m | - *Numeric representation of a month, with leading zeros | - *01 through 12 | - *
M | - *A short textual representation of a month, three letters | - *Jan through Dec | - *
n | - *Numeric representation of a month, without leading zeros | - *1 through 12 | - *
t | - *Number of days in the given month | - *28 through 31 | - *
Year | - *--- | - *--- | - *
L | - *Whether it's a leap year | - *1 if it is a leap year, 0 otherwise. | - *
o | - *ISO 8601 week-numbering year. This has the same value as - * Y, except that if the ISO week number - * (W) belongs to the previous or next year, that year - * is used instead. | - *Examples: 1999 or 2003 | - *
X | - *An expanded full numeric representation of a year, at least 4 digits, - * with - for years BCE, and + - * for years CE. | - *Examples: -0055, +0787, - * +1999, +10191 | - *
x | - *An expanded full numeric representation if requried, or a - * standard full numeral representation if possible (like - * Y). At least four digits. Years BCE are prefixed - * with a -. Years beyond (and including) - * 10000 are prefixed by a - * +. | - *Examples: -0055, 0787, - * 1999, +10191 | - *
Y | - *A full numeric representation of a year, at least 4 digits, - * with - for years BCE. | - *Examples: -0055, 0787, - * 1999, 2003, - * 10191 | - *
y | - *A two digit representation of a year | - *Examples: 99 or 03 | - *
Time | - *--- | - *--- | - *
a | - *Lowercase Ante meridiem and Post meridiem | - *am or pm | - *
A | - *Uppercase Ante meridiem and Post meridiem | - *AM or PM | - *
B | - *Swatch Internet time | - *000 through 999 | - *
g | - *12-hour format of an hour without leading zeros | - *1 through 12 | - *
G | - *24-hour format of an hour without leading zeros | - *0 through 23 | - *
h | - *12-hour format of an hour with leading zeros | - *01 through 12 | - *
H | - *24-hour format of an hour with leading zeros | - *00 through 23 | - *
i | - *Minutes with leading zeros | - *00 to 59 | - *
s | - *Seconds with leading zeros | - *00 through 59 | - *
u | - *- * Microseconds. Note that - * date will always generate - * 000000 since it takes an int - * parameter, whereas DateTime::format does - * support microseconds if DateTime was - * created with microseconds. - * | - *Example: 654321 | - *
v | - *- * Milliseconds. Same note applies as for - * u. - * | - *Example: 654 | - *
Timezone | - *--- | - *--- | - *
e | - *Timezone identifier | - *Examples: UTC, GMT, Atlantic/Azores | - *
I (capital i) | - *Whether or not the date is in daylight saving time | - *1 if Daylight Saving Time, 0 otherwise. | - *
O | - *Difference to Greenwich time (GMT) without colon between hours and minutes | - *Example: +0200 | - *
P | - *Difference to Greenwich time (GMT) with colon between hours and minutes | - *Example: +02:00 | - *
p | - *- * The same as P, but returns Z instead of +00:00 - * (available as of PHP 8.0.0) - * | - *Examples: Z or +02:00 | - *
T | - *Timezone abbreviation, if known; otherwise the GMT offset. | - *Examples: EST, MDT, +05 | - *
Z | - *Timezone offset in seconds. The offset for timezones west of UTC is always - * negative, and for those east of UTC is always positive. | - *-43200 through 50400 | - *
Full Date/Time | - *--- | - *--- | - *
c | - *ISO 8601 date | - *2004-02-12T15:19:21+00:00 | - *
r | - *RFC 2822/RFC 5322 formatted date | - *Example: Thu, 21 Dec 2000 16:01:07 +0200 | - *
U | - *Seconds since the Unix Epoch (January 1 1970 00:00:00 GMT) | - *See also time | - *
Unrecognized characters in the format string will be printed - * as-is. The Z format will always return - * 0 when using gmdate.
- *Since this function only accepts int timestamps the - * u format character is only useful when using the - * date_format function with user based timestamps - * created with date_create.
- * @return string Returns the formatted date string on success. + * {@inheritdoc} + * @param DateTimeInterface $object + * @param string $format */ function date_format (DateTimeInterface $object, string $format): string {} /** - * Alters the timestamp - * @link http://www.php.net/manual/en/datetime.modify.php - * @param DateTime $object Procedural style only: A DateTime object - * returned by date_create. - * The function modifies this object. - * @param string $modifier A date/time string. Valid formats are explained in Date and Time Formats. - * @return DateTime|false Returns the modified DateTime object for method chaining or false on failure. + * {@inheritdoc} + * @param DateTime $object + * @param string $modifier */ function date_modify (DateTime $object, string $modifier): DateTime|false {} /** - * Modifies a DateTime object, with added amount of days, months, years, hours, minutes and seconds - * @link http://www.php.net/manual/en/datetime.add.php - * @param DateTime $object Procedural style only: A DateTime object - * returned by date_create. - * The function modifies this object. - * @param DateInterval $interval A DateInterval object - * @return DateTime Returns the modified DateTime object for method chaining. + * {@inheritdoc} + * @param DateTime $object + * @param DateInterval $interval */ function date_add (DateTime $object, DateInterval $interval): DateTime {} /** - * Subtracts an amount of days, months, years, hours, minutes and seconds from - * a DateTime object - * @link http://www.php.net/manual/en/datetime.sub.php - * @param DateTime $object Procedural style only: A DateTime object - * returned by date_create. - * The function modifies this object. - * @param DateInterval $interval A DateInterval object - * @return DateTime Returns the modified DateTime object for method chaining. + * {@inheritdoc} + * @param DateTime $object + * @param DateInterval $interval */ function date_sub (DateTime $object, DateInterval $interval): DateTime {} /** - * Return time zone relative to given DateTime - * @link http://www.php.net/manual/en/datetime.gettimezone.php - * @param DateTimeInterface $object Procedural style only: A DateTime object - * returned by date_create - * @return DateTimeZone|false Returns a DateTimeZone object on success - * or false on failure. + * {@inheritdoc} + * @param DateTimeInterface $object */ function date_timezone_get (DateTimeInterface $object): DateTimeZone|false {} /** - * Sets the time zone for the DateTime object - * @link http://www.php.net/manual/en/datetime.settimezone.php - * @param DateTime $object Procedural style only: A DateTime object - * returned by date_create. - * The function modifies this object. - * @param DateTimeZone $timezone A DateTimeZone object representing the - * desired time zone. - * @return DateTime Returns the DateTime object for method chaining. The - * underlaying point-in-time is not changed when calling this method. + * {@inheritdoc} + * @param DateTime $object + * @param DateTimeZone $timezone */ function date_timezone_set (DateTime $object, DateTimeZone $timezone): DateTime {} /** - * Returns the timezone offset - * @link http://www.php.net/manual/en/datetime.getoffset.php - * @param DateTimeInterface $object Procedural style only: A DateTime object - * returned by date_create - * @return int Returns the timezone offset in seconds from UTC on success. + * {@inheritdoc} + * @param DateTimeInterface $object */ function date_offset_get (DateTimeInterface $object): int {} /** - * Returns the difference between two DateTime objects - * @link http://www.php.net/manual/en/datetime.diff.php - * @param DateTimeInterface $baseObject - * @param DateTimeInterface $targetObject - * @param bool $absolute [optional] Should the interval be forced to be positive? - * @return DateInterval The DateInterval object represents the - * difference between the two dates. - *The return value more specifically represents the clock-time interval to - * apply to the original object ($this or - * $originObject) to arrive at the - * $targetObject. This process is not always - * reversible.
- *The method is aware of DST changeovers, and hence can return an interval of - * 24 hours and 30 minutes, as per one of the examples. If - * you want to calculate with absolute time, you need to convert both the - * $this/$baseObject, and - * $targetObject to UTC first.
+ * {@inheritdoc} + * @param DateTimeInterface $baseObject + * @param DateTimeInterface $targetObject + * @param bool $absolute [optional] */ function date_diff (DateTimeInterface $baseObject, DateTimeInterface $targetObject, bool $absolute = false): DateInterval {} /** - * Sets the time - * @link http://www.php.net/manual/en/datetime.settime.php - * @param DateTime $object Procedural style only: A DateTime object - * returned by date_create. - * The function modifies this object. - * @param int $hour Hour of the time. - * @param int $minute Minute of the time. - * @param int $second [optional] Second of the time. - * @param int $microsecond [optional] Microsecond of the time. - * @return DateTime Returns the modified DateTime object for method chaining. + * {@inheritdoc} + * @param DateTime $object + * @param int $hour + * @param int $minute + * @param int $second [optional] + * @param int $microsecond [optional] */ -function date_time_set (DateTime $object, int $hour, int $minute, int $second = null, int $microsecond = null): DateTime {} +function date_time_set (DateTime $object, int $hour, int $minute, int $second = 0, int $microsecond = 0): DateTime {} /** - * Sets the date - * @link http://www.php.net/manual/en/datetime.setdate.php - * @param DateTime $object Procedural style only: A DateTime object - * returned by date_create. - * The function modifies this object. - * @param int $year Year of the date. - * @param int $month Month of the date. - * @param int $day Day of the date. - * @return DateTime Returns the modified DateTime object for method chaining. + * {@inheritdoc} + * @param DateTime $object + * @param int $year + * @param int $month + * @param int $day */ function date_date_set (DateTime $object, int $year, int $month, int $day): DateTime {} /** - * Sets the ISO date - * @link http://www.php.net/manual/en/datetime.setisodate.php - * @param DateTime $object Procedural style only: A DateTime object - * returned by date_create. - * The function modifies this object. - * @param int $year Year of the date. - * @param int $week Week of the date. - * @param int $dayOfWeek [optional] Offset from the first day of the week. - * @return DateTime Returns the modified DateTime object for method chaining. + * {@inheritdoc} + * @param DateTime $object + * @param int $year + * @param int $week + * @param int $dayOfWeek [optional] */ function date_isodate_set (DateTime $object, int $year, int $week, int $dayOfWeek = 1): DateTime {} /** - * Sets the date and time based on an Unix timestamp - * @link http://www.php.net/manual/en/datetime.settimestamp.php - * @param DateTime $object Procedural style only: A DateTime object - * returned by date_create. - * The function modifies this object. - * @param int $timestamp Unix timestamp representing the date. - * Setting timestamps outside the range of int is possible by using - * DateTimeImmutable::modify with the @ format. - * @return DateTime Returns the modified DateTime object for method chaining. + * {@inheritdoc} + * @param DateTime $object + * @param int $timestamp */ function date_timestamp_set (DateTime $object, int $timestamp): DateTime {} /** - * Gets the Unix timestamp - * @link http://www.php.net/manual/en/datetime.gettimestamp.php - * @param DateTimeInterface $object - * @return int Returns the Unix timestamp representing the date. + * {@inheritdoc} + * @param DateTimeInterface $object */ function date_timestamp_get (DateTimeInterface $object): int {} /** - * Creates new DateTimeZone object - * @link http://www.php.net/manual/en/datetimezone.construct.php - * @param string $timezone - * @return DateTimeZone|false Returns DateTimeZone on success. - * Procedural style returns false on failure. + * {@inheritdoc} + * @param string $timezone */ function timezone_open (string $timezone): DateTimeZone|false {} /** - * Returns the name of the timezone - * @link http://www.php.net/manual/en/datetimezone.getname.php - * @param DateTimeZone $object The DateTimeZone for which to get a name. - * @return string Depending on zone type, UTC offset (type 1), timezone abbreviation (type - * 2), and timezone identifiers as published in the IANA timezone database - * (type 3), the descriptor string to create a new - * DateTimeZone object with the same offset and/or - * rules. For example 02:00, CEST, or - * one of the timezone names in the. + * {@inheritdoc} + * @param DateTimeZone $object */ function timezone_name_get (DateTimeZone $object): string {} /** - * Returns a timezone name by guessing from abbreviation and UTC offset - * @link http://www.php.net/manual/en/function.timezone-name-from-abbr.php - * @param string $abbr - * @param int $utcOffset [optional] - * @param int $isDST [optional] - * @return string|false Returns time zone name on success or false on failure. + * {@inheritdoc} + * @param string $abbr + * @param int $utcOffset [optional] + * @param int $isDST [optional] */ function timezone_name_from_abbr (string $abbr, int $utcOffset = -1, int $isDST = -1): string|false {} /** - * Returns the timezone offset from GMT - * @link http://www.php.net/manual/en/datetimezone.getoffset.php - * @param DateTimeZone $object - * @param DateTimeInterface $datetime - * @return int Returns time zone offset in seconds. + * {@inheritdoc} + * @param DateTimeZone $object + * @param DateTimeInterface $datetime */ function timezone_offset_get (DateTimeZone $object, DateTimeInterface $datetime): int {} /** - * Returns all transitions for the timezone - * @link http://www.php.net/manual/en/datetimezone.gettransitions.php - * @param DateTimeZone $object - * @param int $timestampBegin [optional] - * @param int $timestampEnd [optional] - * @return array|false Returns a numerically indexed array of - * transition arrays on success, or false on failure. DateTimeZone - * objects wrapping type 1 (UTC offsets) and type 2 (abbreviations) do not - * contain any transitions, and calling this method on them will return - * false. - *
If timestampBegin is given, the first entry in the - * returned array will contain a transition element at the time of - * timestampBegin.
- *Key | - *Type | - *Description | - *
ts | - *int | - *Unix timestamp | - *
time | - *string | - *DateTimeInterface::ISO8601_EXPANDED (PHP - * 8.2 and later), or DateTimeInterface::ISO8601 (PHP - * 8.1 and lower) time string | - *
offset | - *int | - *Offset to UTC in seconds | - *
isdst | - *bool | - *Whether daylight saving time is active | - *
abbr | - *string | - *Timezone abbreviation | - *
If you have a timezone database version that is old (for example, it - * doesn't show the current year), then you can update the timezone information - * by either upgrading your PHP version, or installing the timezonedb PECL package.
- *Some Linux distributions patch PHP's date/time support to use an - * alternative source for timezone information. In which case this function - * will return 0.system. You are encouraged to install the - * timezonedb PECL - * package in that case as well.
+ * {@inheritdoc} */ function timezone_version_get (): string {} @@ -3662,101 +1408,45 @@ function date_interval_create_from_date_string (string $datetime): DateInterval| function date_interval_format (DateInterval $object, string $format): string {} /** - * Sets the default timezone used by all date/time functions in a script - * @link http://www.php.net/manual/en/function.date-default-timezone-set.php - * @param string $timezoneId - * @return bool This function returns false if the - * timezoneId isn't valid, or true - * otherwise. + * {@inheritdoc} + * @param string $timezoneId */ function date_default_timezone_set (string $timezoneId): bool {} /** - * Gets the default timezone used by all date/time functions in a script - * @link http://www.php.net/manual/en/function.date-default-timezone-get.php - * @return string Returns a string. + * {@inheritdoc} */ function date_default_timezone_get (): string {} /** - * Returns time of sunrise for a given day and location - * @link http://www.php.net/manual/en/function.date-sunrise.php - * @param int $timestamp - * @param int $returnFormat [optional] - * @param float|null $latitude [optional] - * @param float|null $longitude [optional] - * @param float|null $zenith [optional] - * @param float|null $utcOffset [optional] - * @return string|int|float|false Returns the sunrise time in a specified returnFormat on - * success or false on failure. One potential reason for failure is that the - * sun does not rise at all, which happens inside the polar circles for part of - * the year. - * @deprecated 1 + * {@inheritdoc} + * @param int $timestamp + * @param int $returnFormat [optional] + * @param float|null $latitude [optional] + * @param float|null $longitude [optional] + * @param float|null $zenith [optional] + * @param float|null $utcOffset [optional] + * @deprecated */ -function date_sunrise (int $timestamp, int $returnFormat = SUNFUNCS_RET_STRING, ?float $latitude = null, ?float $longitude = null, ?float $zenith = null, ?float $utcOffset = null): string|int|float|false {} +function date_sunrise (int $timestamp, int $returnFormat = 1, ?float $latitude = NULL, ?float $longitude = NULL, ?float $zenith = NULL, ?float $utcOffset = NULL): string|int|float|false {} /** - * Returns time of sunset for a given day and location - * @link http://www.php.net/manual/en/function.date-sunset.php - * @param int $timestamp - * @param int $returnFormat [optional] - * @param float|null $latitude [optional] - * @param float|null $longitude [optional] - * @param float|null $zenith [optional] - * @param float|null $utcOffset [optional] - * @return string|int|float|false Returns the sunset time in a specified returnFormat on - * success or false on failure. One potential reason for failure is that the - * sun does not set at all, which happens inside the polar circles for part of - * the year. - * @deprecated 1 + * {@inheritdoc} + * @param int $timestamp + * @param int $returnFormat [optional] + * @param float|null $latitude [optional] + * @param float|null $longitude [optional] + * @param float|null $zenith [optional] + * @param float|null $utcOffset [optional] + * @deprecated */ -function date_sunset (int $timestamp, int $returnFormat = SUNFUNCS_RET_STRING, ?float $latitude = null, ?float $longitude = null, ?float $zenith = null, ?float $utcOffset = null): string|int|float|false {} +function date_sunset (int $timestamp, int $returnFormat = 1, ?float $latitude = NULL, ?float $longitude = NULL, ?float $zenith = NULL, ?float $utcOffset = NULL): string|int|float|false {} /** - * Returns an array with information about sunset/sunrise and twilight begin/end - * @link http://www.php.net/manual/en/function.date-sun-info.php - * @param int $timestamp - * @param float $latitude - * @param float $longitude - * @return array Returns array on success or false on failure. - * The structure of the array is detailed in the following list: - *sunrise
- *
- * The timestamp of the sunrise (zenith angle = 90°35').
- * sunset
- *
- * The timestamp of the sunset (zenith angle = 90°35').
- * transit
- *
- * The timestamp when the sun is at its zenith, i.e. has reached its topmost
- * point.
- * civil_twilight_begin
- *
- * The start of the civil dawn (zenith angle = 96°). It ends at
- * sunrise.
- * civil_twilight_end
- *
- * The end of the civil dusk (zenith angle = 96°). It starts at
- * sunset.
- * nautical_twilight_begin
- *
- * The start of the nautical dawn (zenith angle = 102°). It ends at
- * civil_twilight_begin.
- * nautical_twilight_end
- *
- * The end of the nautical dusk (zenith angle = 102°). It starts at
- * civil_twilight_end.
- * astronomical_twilight_begin
- *
- * The start of the astronomical dawn (zenith angle = 108°). It ends at
- * nautical_twilight_begin.
- * astronomical_twilight_end
- *
- * The end of the astronomical dusk (zenith angle = 108°). It starts at
- * nautical_twilight_end.
The values of the array elements are either UNIX timestamps, false if the - * sun is below the respective zenith for the whole day, or true if the sun is - * above the respective zenith for the whole day.
+ * {@inheritdoc} + * @param int $timestamp + * @param float $latitude + * @param float $longitude */ function date_sun_info (int $timestamp, float $latitude, float $longitude): array {} @@ -3774,26 +1464,8 @@ function date_sun_info (int $timestamp, float $latitude, float $longitude): arra define ('DATE_RFC3339_EXTENDED', "Y-m-d\TH:i:s.vP"); define ('DATE_RSS', "D, d M Y H:i:s O"); define ('DATE_W3C', "Y-m-d\TH:i:sP"); - -/** - * Timestamp - * @link http://www.php.net/manual/en/datetime.constants.php - * @var int - */ define ('SUNFUNCS_RET_TIMESTAMP', 0); - -/** - * Hours:minutes (example: 08:02) - * @link http://www.php.net/manual/en/datetime.constants.php - * @var int - */ define ('SUNFUNCS_RET_STRING', 1); - -/** - * Hours as floating point number (example 8.75) - * @link http://www.php.net/manual/en/datetime.constants.php - * @var int - */ define ('SUNFUNCS_RET_DOUBLE', 2); -// End of date v.8.2.6 +// End of date v.8.3.0 diff --git a/plugins/org.eclipse.php.core/Resources/language/php8.3/dba.php b/plugins/org.eclipse.php.core/Resources/language/php8.3/dba.php index 49ef995211..cd289ec1b6 100644 --- a/plugins/org.eclipse.php.core/Resources/language/php8.3/dba.php +++ b/plugins/org.eclipse.php.core/Resources/language/php8.3/dba.php @@ -1,150 +1,112 @@ When the internal cdb library is used you will see - * cdb and cdb_make. + * {@inheritdoc} + * @param bool $full_info [optional] */ function dba_handlers (bool $full_info = false): array {} /** - * List all open database files - * @link http://www.php.net/manual/en/function.dba-list.php - * @return array An associative array, in the form resourceid => filename. + * {@inheritdoc} */ function dba_list (): array {} -// End of dba v.8.2.6 +// End of dba v.8.3.0 diff --git a/plugins/org.eclipse.php.core/Resources/language/php8.3/dom.php b/plugins/org.eclipse.php.core/Resources/language/php8.3/dom.php index 85d2a8d641..edfddb51b9 100644 --- a/plugins/org.eclipse.php.core/Resources/language/php8.3/dom.php +++ b/plugins/org.eclipse.php.core/Resources/language/php8.3/dom.php @@ -2,30 +2,17 @@ // Start of dom v.20031129 -/** - * DOM operations raise exceptions under particular circumstances, i.e., - * when an operation is impossible to perform for logical reasons. - *See also .
- * @link http://www.php.net/manual/en/class.domexception.php - */ final class DOMException extends Exception implements Throwable, Stringable { - /** - * The exception code - * @var int - * @link http://www.php.net/manual/en/class.domexception.php#domexception.props.code - */ - protected int $code; + public $code; /** - * Construct the exception - * @link http://www.php.net/manual/en/exception.construct.php - * @param string $message [optional] - * @param int $code [optional] - * @param Throwable|null $previous [optional] - * @return string + * {@inheritdoc} + * @param string $message [optional] + * @param int $code [optional] + * @param Throwable|null $previous [optional] */ - public function __construct (string $message = '""', int $code = null, ?Throwable $previous = null): string {} + public function __construct (string $message = '', int $code = 0, ?Throwable $previous = NULL) {} /** * {@inheritdoc} @@ -33,134 +20,96 @@ public function __construct (string $message = '""', int $code = null, ?Throwabl public function __wakeup () {} /** - * Gets the Exception message - * @link http://www.php.net/manual/en/exception.getmessage.php - * @return string Returns the Exception message as a string. + * {@inheritdoc} */ final public function getMessage (): string {} /** - * Gets the Exception code - * @link http://www.php.net/manual/en/exception.getcode.php - * @return int Returns the exception code as int in - * Exception but possibly as other type in - * Exception descendants (for example as - * string in PDOException). + * {@inheritdoc} */ - final public function getCode (): int {} + final public function getCode () {} /** - * Gets the file in which the exception was created - * @link http://www.php.net/manual/en/exception.getfile.php - * @return string Returns the filename in which the exception was created. + * {@inheritdoc} */ final public function getFile (): string {} /** - * Gets the line in which the exception was created - * @link http://www.php.net/manual/en/exception.getline.php - * @return int Returns the line number where the exception was created. + * {@inheritdoc} */ final public function getLine (): int {} /** - * Gets the stack trace - * @link http://www.php.net/manual/en/exception.gettrace.php - * @return array Returns the Exception stack trace as an array. + * {@inheritdoc} */ final public function getTrace (): array {} /** - * Returns previous Throwable - * @link http://www.php.net/manual/en/exception.getprevious.php - * @return Throwable|null Returns the previous Throwable if available - * or null otherwise. + * {@inheritdoc} */ final public function getPrevious (): ?Throwable {} /** - * Gets the stack trace as a string - * @link http://www.php.net/manual/en/exception.gettraceasstring.php - * @return string Returns the Exception stack trace as a string. + * {@inheritdoc} */ final public function getTraceAsString (): string {} /** - * String representation of the exception - * @link http://www.php.net/manual/en/exception.tostring.php - * @return string Returns the string representation of the exception. + * {@inheritdoc} */ public function __toString (): string {} } -/** - * @link http://www.php.net/manual/en/class.domparentnode.php - */ interface DOMParentNode { /** - * Appends nodes after the last child node - * @link http://www.php.net/manual/en/domparentnode.append.php - * @param DOMNode|string $nodes - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $nodes [optional] + */ + abstract public function append (...$nodes): void; + + /** + * {@inheritdoc} + * @param mixed $nodes [optional] */ - abstract public function append (DOMNode|string ...$nodes): void; + abstract public function prepend (...$nodes): void; /** - * Prepends nodes before the first child node - * @link http://www.php.net/manual/en/domparentnode.prepend.php - * @param DOMNode|string $nodes - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $nodes [optional] */ - abstract public function prepend (DOMNode|string ...$nodes): void; + abstract public function replaceChildren (...$nodes): void; } -/** - * @link http://www.php.net/manual/en/class.domchildnode.php - */ interface DOMChildNode { /** - * Removes the node - * @link http://www.php.net/manual/en/domchildnode.remove.php - * @return void No value is returned. + * {@inheritdoc} */ abstract public function remove (): void; /** - * Adds nodes before the node - * @link http://www.php.net/manual/en/domchildnode.before.php - * @param DOMNode|string $nodes - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $nodes [optional] */ - abstract public function before (DOMNode|string ...$nodes): void; + abstract public function before (...$nodes): void; /** - * Adds nodes after the node - * @link http://www.php.net/manual/en/domchildnode.after.php - * @param DOMNode|string $nodes - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $nodes [optional] */ - abstract public function after (DOMNode|string ...$nodes): void; + abstract public function after (...$nodes): void; /** - * Replaces the node with new nodes - * @link http://www.php.net/manual/en/domchildnode.replacewith.php - * @param DOMNode|string $nodes - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $nodes [optional] */ - abstract public function replaceWith (DOMNode|string ...$nodes): void; + abstract public function replaceWith (...$nodes): void; } -/** - * The DOMImplementation class provides a number - * of methods for performing operations that are independent of any - * particular instance of the document object model. - * @link http://www.php.net/manual/en/class.domimplementation.php - */ class DOMImplementation { /** @@ -171,311 +120,202 @@ class DOMImplementation { public function getFeature (string $feature, string $version) {} /** - * Test if the DOM implementation implements a specific feature - * @link http://www.php.net/manual/en/domimplementation.hasfeature.php - * @param string $feature - * @param string $version - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $feature + * @param string $version */ - public function hasFeature (string $feature, string $version): bool {} + public function hasFeature (string $feature, string $version) {} /** - * Creates an empty DOMDocumentType object - * @link http://www.php.net/manual/en/domimplementation.createdocumenttype.php - * @param string $qualifiedName - * @param string $publicId [optional] - * @param string $systemId [optional] - * @return DOMDocumentType|false A new DOMDocumentType node with its - * ownerDocument set to null or false on error. + * {@inheritdoc} + * @param string $qualifiedName + * @param string $publicId [optional] + * @param string $systemId [optional] */ - public function createDocumentType (string $qualifiedName, string $publicId = '""', string $systemId = '""'): DOMDocumentType|false {} + public function createDocumentType (string $qualifiedName, string $publicId = '', string $systemId = '') {} /** - * Creates a DOMDocument object of the specified type with its document element - * @link http://www.php.net/manual/en/domimplementation.createdocument.php - * @param string|null $namespace [optional] - * @param string $qualifiedName [optional] - * @param DOMDocumentType|null $doctype [optional] - * @return DOMDocument|false A new DOMDocument object or false on error. If - * namespace, qualifiedName, - * and doctype are null, the returned - * DOMDocument is empty with no document element + * {@inheritdoc} + * @param string|null $namespace [optional] + * @param string $qualifiedName [optional] + * @param DOMDocumentType|null $doctype [optional] */ - public function createDocument (?string $namespace = null, string $qualifiedName = '""', ?DOMDocumentType $doctype = null): DOMDocument|false {} + public function createDocument (?string $namespace = NULL, string $qualifiedName = '', ?DOMDocumentType $doctype = NULL) {} } -/** - * @link http://www.php.net/manual/en/class.domnode.php - */ class DOMNode { - /** - * Returns the most accurate name for the current node type - * @var string - * @link http://www.php.net/manual/en/class.domnode.php#domnode.props.nodename - */ - public readonly string $nodeName; + public string $nodeName; - /** - * The value of this node, depending on its type. - * Contrary to the W3C specification, the node value of - * DOMElement nodes is equal to DOMNode::textContent instead - * of null. - * @var string|null - * @link http://www.php.net/manual/en/class.domnode.php#domnode.props.nodevalue - */ public ?string $nodeValue; - /** - * Gets the type of the node. One of the predefined XML_xxx_NODE constants - * @var int - * @link http://www.php.net/manual/en/class.domnode.php#domnode.props.nodetype - */ - public readonly int $nodeType; + public int $nodeType; - /** - * The parent of this node. If there is no such node, this returns null. - * @var DOMNode|null - * @link http://www.php.net/manual/en/class.domnode.php#domnode.props.parentnode - */ - public readonly ?DOMNode $parentNode; + public ?DOMNode $parentNode; - /** - * A DOMNodeList that contains all - * children of this node. If there are no children, this is an empty - * DOMNodeList. - * @var DOMNodeList - * @link http://www.php.net/manual/en/class.domnode.php#domnode.props.childnodes - */ - public readonly DOMNodeList $childNodes; + public ?DOMElement $parentElement; - /** - * The first child of this node. If there is no such node, this - * returns null. - * @var DOMNode|null - * @link http://www.php.net/manual/en/class.domnode.php#domnode.props.firstchild - */ - public readonly ?DOMNode $firstChild; + public DOMNodeList $childNodes; - /** - * The last child of this node. If there is no such node, this returns null. - * @var DOMNode|null - * @link http://www.php.net/manual/en/class.domnode.php#domnode.props.lastchild - */ - public readonly ?DOMNode $lastChild; + public ?DOMNode $firstChild; - /** - * The node immediately preceding this node. If there is no such - * node, this returns null. - * @var DOMNode|null - * @link http://www.php.net/manual/en/class.domnode.php#domnode.props.previoussibling - */ - public readonly ?DOMNode $previousSibling; + public ?DOMNode $lastChild; - /** - * The node immediately following this node. If there is no such - * node, this returns null. - * @var DOMNode|null - * @link http://www.php.net/manual/en/class.domnode.php#domnode.props.nextsibling - */ - public readonly ?DOMNode $nextSibling; + public ?DOMNode $previousSibling; - /** - * A DOMNamedNodeMap containing the - * attributes of this node (if it is a DOMElement) - * or null otherwise. - * @var DOMNamedNodeMap|null - * @link http://www.php.net/manual/en/class.domnode.php#domnode.props.attributes - */ - public readonly ?DOMNamedNodeMap $attributes; + public ?DOMNode $nextSibling; - /** - * The DOMDocument object associated with this node, or null if this node is a DOMDocument - * @var DOMDocument|null - * @link http://www.php.net/manual/en/class.domnode.php#domnode.props.ownerdocument - */ - public readonly ?DOMDocument $ownerDocument; + public ?DOMNamedNodeMap $attributes; + + public bool $isConnected; + + public ?DOMDocument $ownerDocument; + + public ?string $namespaceURI; + + public string $prefix; + + public ?string $localName; + + public ?string $baseURI; + + public string $textContent; /** - * The namespace URI of this node, or null if it is unspecified. - * @var string|null - * @link http://www.php.net/manual/en/class.domnode.php#domnode.props.namespaceuri + * {@inheritdoc} */ - public readonly ?string $namespaceURI; + public function __sleep (): array {} /** - * The namespace prefix of this node. - * @var string - * @link http://www.php.net/manual/en/class.domnode.php#domnode.props.prefix + * {@inheritdoc} */ - public string $prefix; + public function __wakeup (): void {} /** - * Returns the local part of the qualified name of this node. - * @var string|null - * @link http://www.php.net/manual/en/class.domnode.php#domnode.props.localname + * {@inheritdoc} + * @param DOMNode $node */ - public readonly ?string $localName; + public function appendChild (DOMNode $node) {} /** - * The absolute base URI of this node or null if the implementation - * wasn't able to obtain an absolute URI. - * @var string|null - * @link http://www.php.net/manual/en/class.domnode.php#domnode.props.baseuri + * {@inheritdoc} + * @param bool $exclusive [optional] + * @param bool $withComments [optional] + * @param array|null $xpath [optional] + * @param array|null $nsPrefixes [optional] */ - public readonly ?string $baseURI; + public function C14N (bool $exclusive = false, bool $withComments = false, ?array $xpath = NULL, ?array $nsPrefixes = NULL) {} /** - * The text content of this node and its descendants. - * @var string - * @link http://www.php.net/manual/en/class.domnode.php#domnode.props.textcontent + * {@inheritdoc} + * @param string $uri + * @param bool $exclusive [optional] + * @param bool $withComments [optional] + * @param array|null $xpath [optional] + * @param array|null $nsPrefixes [optional] */ - public string $textContent; + public function C14NFile (string $uri, bool $exclusive = false, bool $withComments = false, ?array $xpath = NULL, ?array $nsPrefixes = NULL) {} /** - * Adds new child at the end of the children - * @link http://www.php.net/manual/en/domnode.appendchild.php - * @param DOMNode $node - * @return DOMNode|false The node added or false on error. + * {@inheritdoc} + * @param bool $deep [optional] */ - public function appendChild (DOMNode $node): DOMNode|false {} + public function cloneNode (bool $deep = false) {} /** - * Canonicalize nodes to a string - * @link http://www.php.net/manual/en/domnode.c14n.php - * @param bool $exclusive [optional] Enable exclusive parsing of only the nodes matched by the provided - * xpath or namespace prefixes. - * @param bool $withComments [optional] Retain comments in output. - * @param array|null $xpath [optional] An array of xpaths to filter the nodes by. - * @param array|null $nsPrefixes [optional] An array of namespace prefixes to filter the nodes by. - * @return string|false Returns canonicalized nodes as a string or false on failure + * {@inheritdoc} */ - public function C14N (bool $exclusive = false, bool $withComments = false, ?array $xpath = null, ?array $nsPrefixes = null): string|false {} + public function getLineNo () {} /** - * Canonicalize nodes to a file - * @link http://www.php.net/manual/en/domnode.c14nfile.php - * @param string $uri Path to write the output to. - * @param bool $exclusive [optional] Enable exclusive parsing of only the nodes matched by the provided - * xpath or namespace prefixes. - * @param bool $withComments [optional] Retain comments in output. - * @param array|null $xpath [optional] An array of xpaths to filter the nodes by. - * @param array|null $nsPrefixes [optional] An array of namespace prefixes to filter the nodes by. - * @return int|false Number of bytes written or false on failure + * {@inheritdoc} */ - public function C14NFile (string $uri, bool $exclusive = false, bool $withComments = false, ?array $xpath = null, ?array $nsPrefixes = null): int|false {} + public function getNodePath () {} /** - * Clones a node - * @link http://www.php.net/manual/en/domnode.clonenode.php - * @param bool $deep [optional] - * @return DOMNode|false The cloned node. + * {@inheritdoc} */ - public function cloneNode (bool $deep = false): DOMNode|false {} + public function hasAttributes () {} /** - * Get line number for a node - * @link http://www.php.net/manual/en/domnode.getlineno.php - * @return int Always returns the line number where the node was defined in. + * {@inheritdoc} */ - public function getLineNo (): int {} + public function hasChildNodes () {} /** - * Get an XPath for a node - * @link http://www.php.net/manual/en/domnode.getnodepath.php - * @return string|null Returns a string containing the XPath, or null in case of an error. + * {@inheritdoc} + * @param DOMNode $node + * @param DOMNode|null $child [optional] */ - public function getNodePath (): ?string {} + public function insertBefore (DOMNode $node, ?DOMNode $child = NULL) {} /** - * Checks if node has attributes - * @link http://www.php.net/manual/en/domnode.hasattributes.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $namespace */ - public function hasAttributes (): bool {} + public function isDefaultNamespace (string $namespace) {} /** - * Checks if node has children - * @link http://www.php.net/manual/en/domnode.haschildnodes.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param DOMNode $otherNode */ - public function hasChildNodes (): bool {} + public function isSameNode (DOMNode $otherNode) {} /** - * Adds a new child before a reference node - * @link http://www.php.net/manual/en/domnode.insertbefore.php - * @param DOMNode $node - * @param DOMNode|null $child [optional] - * @return DOMNode|false The inserted node or false on error. + * {@inheritdoc} + * @param DOMNode|null $otherNode */ - public function insertBefore (DOMNode $node, ?DOMNode $child = null): DOMNode|false {} + public function isEqualNode (?DOMNode $otherNode = null): bool {} /** - * Checks if the specified namespaceURI is the default namespace or not - * @link http://www.php.net/manual/en/domnode.isdefaultnamespace.php - * @param string $namespace - * @return bool Return true if namespace is the default - * namespace, false otherwise. + * {@inheritdoc} + * @param string $feature + * @param string $version */ - public function isDefaultNamespace (string $namespace): bool {} + public function isSupported (string $feature, string $version) {} /** - * Indicates if two nodes are the same node - * @link http://www.php.net/manual/en/domnode.issamenode.php - * @param DOMNode $otherNode - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string|null $prefix */ - public function isSameNode (DOMNode $otherNode): bool {} + public function lookupNamespaceURI (?string $prefix = null) {} /** - * Checks if feature is supported for specified version - * @link http://www.php.net/manual/en/domnode.issupported.php - * @param string $feature - * @param string $version - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $namespace */ - public function isSupported (string $feature, string $version): bool {} + public function lookupPrefix (string $namespace) {} /** - * Gets the namespace URI of the node based on the prefix - * @link http://www.php.net/manual/en/domnode.lookupnamespaceuri.php - * @param string $prefix - * @return string The namespace URI of the node. + * {@inheritdoc} */ - public function lookupNamespaceURI (string $prefix): string {} + public function normalize () {} /** - * Gets the namespace prefix of the node based on the namespace URI - * @link http://www.php.net/manual/en/domnode.lookupprefix.php - * @param string $namespace - * @return string|null The prefix of the namespace or null on error. + * {@inheritdoc} + * @param DOMNode $child */ - public function lookupPrefix (string $namespace): ?string {} + public function removeChild (DOMNode $child) {} /** - * Normalizes the node - * @link http://www.php.net/manual/en/domnode.normalize.php - * @return void No value is returned. + * {@inheritdoc} + * @param DOMNode $node + * @param DOMNode $child */ - public function normalize (): void {} + public function replaceChild (DOMNode $node, DOMNode $child) {} /** - * Removes child from list of children - * @link http://www.php.net/manual/en/domnode.removechild.php - * @param DOMNode $child - * @return DOMNode|false If the child could be removed the function returns the old child or false on error. + * {@inheritdoc} + * @param DOMNode|DOMNameSpaceNode|null $other */ - public function removeChild (DOMNode $child): DOMNode|false {} + public function contains (DOMNode|DOMNameSpaceNode|null $other = null): bool {} /** - * Replaces a child - * @link http://www.php.net/manual/en/domnode.replacechild.php - * @param DOMNode $node - * @param DOMNode $child - * @return DOMNode|false The old node or false if an error occur. + * {@inheritdoc} + * @param array|null $options [optional] */ - public function replaceChild (DOMNode $node, DOMNode $child): DOMNode|false {} + public function getRootNode (?array $options = NULL): DOMNode {} } @@ -493,50 +333,44 @@ class DOMNameSpaceNode { public ?string $namespaceURI; + public bool $isConnected; + public ?DOMDocument $ownerDocument; public ?DOMNode $parentNode; -} -/** - * @link http://www.php.net/manual/en/class.domdocumentfragment.php - */ -class DOMDocumentFragment extends DOMNode implements DOMParentNode { + public ?DOMElement $parentElement; /** - * First child element or null. - * @var DOMElement|null - * @link http://www.php.net/manual/en/class.domdocumentfragment.php#domdocumentfragment.props.firstelementchild + * {@inheritdoc} */ - public readonly ?DOMElement $firstElementChild; + public function __sleep (): array {} /** - * Last child element or null. - * @var DOMElement|null - * @link http://www.php.net/manual/en/class.domdocumentfragment.php#domdocumentfragment.props.lastelementchild + * {@inheritdoc} */ - public readonly ?DOMElement $lastElementChild; + public function __wakeup (): void {} - /** - * The number of child elements. - * @var int - * @link http://www.php.net/manual/en/class.domdocumentfragment.php#domdocumentfragment.props.childelementcount - */ - public readonly int $childElementCount; +} + +class DOMDocumentFragment extends DOMNode implements DOMParentNode { + + public ?DOMElement $firstElementChild; + + public ?DOMElement $lastElementChild; + + public int $childElementCount; /** - * Constructs a DOMDocumentFragment object - * @link http://www.php.net/manual/en/domdocumentfragment.construct.php + * {@inheritdoc} */ public function __construct () {} /** - * Append raw XML data - * @link http://www.php.net/manual/en/domdocumentfragment.appendxml.php - * @param string $data - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $data */ - public function appendXML (string $data): bool {} + public function appendXML (string $data) {} /** * {@inheritdoc} @@ -551,611 +385,393 @@ public function append (...$nodes): void {} public function prepend (...$nodes): void {} /** - * Adds new child at the end of the children - * @link http://www.php.net/manual/en/domnode.appendchild.php - * @param DOMNode $node - * @return DOMNode|false The node added or false on error. + * {@inheritdoc} + * @param mixed $nodes [optional] */ - public function appendChild (DOMNode $node): DOMNode|false {} + public function replaceChildren (...$nodes): void {} /** - * Canonicalize nodes to a string - * @link http://www.php.net/manual/en/domnode.c14n.php - * @param bool $exclusive [optional] Enable exclusive parsing of only the nodes matched by the provided - * xpath or namespace prefixes. - * @param bool $withComments [optional] Retain comments in output. - * @param array|null $xpath [optional] An array of xpaths to filter the nodes by. - * @param array|null $nsPrefixes [optional] An array of namespace prefixes to filter the nodes by. - * @return string|false Returns canonicalized nodes as a string or false on failure + * {@inheritdoc} */ - public function C14N (bool $exclusive = false, bool $withComments = false, ?array $xpath = null, ?array $nsPrefixes = null): string|false {} + public function __sleep (): array {} /** - * Canonicalize nodes to a file - * @link http://www.php.net/manual/en/domnode.c14nfile.php - * @param string $uri Path to write the output to. - * @param bool $exclusive [optional] Enable exclusive parsing of only the nodes matched by the provided - * xpath or namespace prefixes. - * @param bool $withComments [optional] Retain comments in output. - * @param array|null $xpath [optional] An array of xpaths to filter the nodes by. - * @param array|null $nsPrefixes [optional] An array of namespace prefixes to filter the nodes by. - * @return int|false Number of bytes written or false on failure + * {@inheritdoc} */ - public function C14NFile (string $uri, bool $exclusive = false, bool $withComments = false, ?array $xpath = null, ?array $nsPrefixes = null): int|false {} + public function __wakeup (): void {} /** - * Clones a node - * @link http://www.php.net/manual/en/domnode.clonenode.php - * @param bool $deep [optional] - * @return DOMNode|false The cloned node. + * {@inheritdoc} + * @param DOMNode $node */ - public function cloneNode (bool $deep = false): DOMNode|false {} + public function appendChild (DOMNode $node) {} /** - * Get line number for a node - * @link http://www.php.net/manual/en/domnode.getlineno.php - * @return int Always returns the line number where the node was defined in. + * {@inheritdoc} + * @param bool $exclusive [optional] + * @param bool $withComments [optional] + * @param array|null $xpath [optional] + * @param array|null $nsPrefixes [optional] */ - public function getLineNo (): int {} + public function C14N (bool $exclusive = false, bool $withComments = false, ?array $xpath = NULL, ?array $nsPrefixes = NULL) {} /** - * Get an XPath for a node - * @link http://www.php.net/manual/en/domnode.getnodepath.php - * @return string|null Returns a string containing the XPath, or null in case of an error. + * {@inheritdoc} + * @param string $uri + * @param bool $exclusive [optional] + * @param bool $withComments [optional] + * @param array|null $xpath [optional] + * @param array|null $nsPrefixes [optional] */ - public function getNodePath (): ?string {} + public function C14NFile (string $uri, bool $exclusive = false, bool $withComments = false, ?array $xpath = NULL, ?array $nsPrefixes = NULL) {} /** - * Checks if node has attributes - * @link http://www.php.net/manual/en/domnode.hasattributes.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param bool $deep [optional] */ - public function hasAttributes (): bool {} + public function cloneNode (bool $deep = false) {} /** - * Checks if node has children - * @link http://www.php.net/manual/en/domnode.haschildnodes.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function hasChildNodes (): bool {} + public function getLineNo () {} /** - * Adds a new child before a reference node - * @link http://www.php.net/manual/en/domnode.insertbefore.php - * @param DOMNode $node - * @param DOMNode|null $child [optional] - * @return DOMNode|false The inserted node or false on error. + * {@inheritdoc} */ - public function insertBefore (DOMNode $node, ?DOMNode $child = null): DOMNode|false {} + public function getNodePath () {} /** - * Checks if the specified namespaceURI is the default namespace or not - * @link http://www.php.net/manual/en/domnode.isdefaultnamespace.php - * @param string $namespace - * @return bool Return true if namespace is the default - * namespace, false otherwise. + * {@inheritdoc} */ - public function isDefaultNamespace (string $namespace): bool {} + public function hasAttributes () {} /** - * Indicates if two nodes are the same node - * @link http://www.php.net/manual/en/domnode.issamenode.php - * @param DOMNode $otherNode - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function isSameNode (DOMNode $otherNode): bool {} + public function hasChildNodes () {} /** - * Checks if feature is supported for specified version - * @link http://www.php.net/manual/en/domnode.issupported.php - * @param string $feature - * @param string $version - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param DOMNode $node + * @param DOMNode|null $child [optional] */ - public function isSupported (string $feature, string $version): bool {} + public function insertBefore (DOMNode $node, ?DOMNode $child = NULL) {} /** - * Gets the namespace URI of the node based on the prefix - * @link http://www.php.net/manual/en/domnode.lookupnamespaceuri.php - * @param string $prefix - * @return string The namespace URI of the node. + * {@inheritdoc} + * @param string $namespace */ - public function lookupNamespaceURI (string $prefix): string {} + public function isDefaultNamespace (string $namespace) {} /** - * Gets the namespace prefix of the node based on the namespace URI - * @link http://www.php.net/manual/en/domnode.lookupprefix.php - * @param string $namespace - * @return string|null The prefix of the namespace or null on error. + * {@inheritdoc} + * @param DOMNode $otherNode */ - public function lookupPrefix (string $namespace): ?string {} + public function isSameNode (DOMNode $otherNode) {} /** - * Normalizes the node - * @link http://www.php.net/manual/en/domnode.normalize.php - * @return void No value is returned. + * {@inheritdoc} + * @param DOMNode|null $otherNode */ - public function normalize (): void {} + public function isEqualNode (?DOMNode $otherNode = null): bool {} /** - * Removes child from list of children - * @link http://www.php.net/manual/en/domnode.removechild.php - * @param DOMNode $child - * @return DOMNode|false If the child could be removed the function returns the old child or false on error. + * {@inheritdoc} + * @param string $feature + * @param string $version */ - public function removeChild (DOMNode $child): DOMNode|false {} + public function isSupported (string $feature, string $version) {} /** - * Replaces a child - * @link http://www.php.net/manual/en/domnode.replacechild.php - * @param DOMNode $node - * @param DOMNode $child - * @return DOMNode|false The old node or false if an error occur. + * {@inheritdoc} + * @param string|null $prefix */ - public function replaceChild (DOMNode $node, DOMNode $child): DOMNode|false {} - -} - -/** - * Represents an entire HTML or XML document; serves as the root of the - * document tree. - * @link http://www.php.net/manual/en/class.domdocument.php - */ -class DOMDocument extends DOMNode implements DOMParentNode { + public function lookupNamespaceURI (?string $prefix = null) {} /** - * The Document Type Declaration associated with this document. - * @var DOMDocumentType|null - * @link http://www.php.net/manual/en/class.domdocument.php#domdocument.props.doctype + * {@inheritdoc} + * @param string $namespace */ - public readonly ?DOMDocumentType $doctype; + public function lookupPrefix (string $namespace) {} /** - * The DOMImplementation object that handles - * this document. - * @var DOMImplementation - * @link http://www.php.net/manual/en/class.domdocument.php#domdocument.props.implementation + * {@inheritdoc} */ - public readonly DOMImplementation $implementation; + public function normalize () {} /** - * The DOMElement object that is the first - * document element. If not found, this evaluates to null. - * @var DOMElement|null - * @link http://www.php.net/manual/en/class.domdocument.php#domdocument.props.documentelement + * {@inheritdoc} + * @param DOMNode $child */ - public readonly ?DOMElement $documentElement; + public function removeChild (DOMNode $child) {} /** - * Deprecated. Actual encoding of the document, - * is a readonly equivalent to - * encoding. - * @var string|null - * @link http://www.php.net/manual/en/class.domdocument.php#domdocument.props.actualencoding + * {@inheritdoc} + * @param DOMNode $node + * @param DOMNode $child */ - public readonly ?string $actualEncoding; + public function replaceChild (DOMNode $node, DOMNode $child) {} /** - * Encoding of the document, as specified by the XML declaration. This - * attribute is not present in the final DOM Level 3 specification, but - * is the only way of manipulating XML document encoding in this - * implementation. - * @var string|null - * @link http://www.php.net/manual/en/class.domdocument.php#domdocument.props.encoding + * {@inheritdoc} + * @param DOMNode|DOMNameSpaceNode|null $other */ - public ?string $encoding; + public function contains (DOMNode|DOMNameSpaceNode|null $other = null): bool {} /** - * An attribute specifying, as part of the XML declaration, the - * encoding of this document. This is null when unspecified or when it - * is not known, such as when the Document was created in memory. - * @var string|null - * @link http://www.php.net/manual/en/class.domdocument.php#domdocument.props.xmlencoding + * {@inheritdoc} + * @param array|null $options [optional] */ - public readonly ?string $xmlEncoding; + public function getRootNode (?array $options = NULL): DOMNode {} + +} + +class DOMDocument extends DOMNode implements DOMParentNode { + + public ?DOMDocumentType $doctype; + + public DOMImplementation $implementation; + + public ?DOMElement $documentElement; + + public ?string $actualEncoding; + + public ?string $encoding; + + public ?string $xmlEncoding; - /** - * Deprecated. Whether or not the document is - * standalone, as specified by the XML declaration, corresponds to - * xmlStandalone. - * @var bool - * @link http://www.php.net/manual/en/class.domdocument.php#domdocument.props.standalone - */ public bool $standalone; - /** - * An attribute specifying, as part of the XML declaration, whether - * this document is standalone. This is false when unspecified. - * @var bool - * @link http://www.php.net/manual/en/class.domdocument.php#domdocument.props.xmlstandalone - */ public bool $xmlStandalone; - /** - * Deprecated. Version of XML, corresponds to - * xmlVersion. - * @var string|null - * @link http://www.php.net/manual/en/class.domdocument.php#domdocument.props.version - */ public ?string $version; - /** - * An attribute specifying, as part of the XML declaration, the - * version number of this document. If there is no declaration and if - * this document supports the "XML" feature, the value is "1.0". - * @var string|null - * @link http://www.php.net/manual/en/class.domdocument.php#domdocument.props.xmlversion - */ public ?string $xmlVersion; - /** - * Throws DOMException on errors. Default to true. - * @var bool - * @link http://www.php.net/manual/en/class.domdocument.php#domdocument.props.stricterrorchecking - */ public bool $strictErrorChecking; - /** - * The location of the document or null if undefined. - * @var string|null - * @link http://www.php.net/manual/en/class.domdocument.php#domdocument.props.documenturi - */ public ?string $documentURI; - /** - * Deprecated. Configuration used when - * DOMDocument::normalizeDocument is - * invoked. - * @var mixed - * @link http://www.php.net/manual/en/class.domdocument.php#domdocument.props.config - */ - public readonly mixed $config; + public mixed $config; - /** - * Nicely formats output with indentation and extra space. - * This has no effect if the document was loaded with - * preserveWhitespace enabled. - * @var bool - * @link http://www.php.net/manual/en/class.domdocument.php#domdocument.props.formatoutput - */ public bool $formatOutput; - /** - * Loads and validates against the DTD. Default to false. - * @var bool - * @link http://www.php.net/manual/en/class.domdocument.php#domdocument.props.validateonparse - */ public bool $validateOnParse; - /** - * Set it to true to load external entities from a doctype - * declaration. This is useful for including character entities in - * your XML document. - * @var bool - * @link http://www.php.net/manual/en/class.domdocument.php#domdocument.props.resolveexternals - */ public bool $resolveExternals; - /** - * Do not remove redundant white space. Default to true. - * Setting this to false has the same effect as passing LIBXML_NOBLANKS - * as option to DOMDocument::load etc. - * @var bool - * @link http://www.php.net/manual/en/class.domdocument.php#domdocument.props.preservewhitespace - */ public bool $preserveWhiteSpace; - /** - * Proprietary. Enables recovery mode, i.e. trying - * to parse non-well formed documents. This attribute is not part of - * the DOM specification and is specific to libxml. - * @var bool - * @link http://www.php.net/manual/en/class.domdocument.php#domdocument.props.recover - */ public bool $recover; - /** - * Proprietary. Whether or not to substitute - * entities. This attribute is not part of - * the DOM specification and is specific to libxml. - * @var bool - * @link http://www.php.net/manual/en/class.domdocument.php#domdocument.props.substituteentities - */ public bool $substituteEntities; - /** - * First child element or null. - * @var DOMElement|null - * @link http://www.php.net/manual/en/class.domdocument.php#domdocument.props.firstelementchild - */ - public readonly ?DOMElement $firstElementChild; + public ?DOMElement $firstElementChild; - /** - * Last child element or null. - * @var DOMElement|null - * @link http://www.php.net/manual/en/class.domdocument.php#domdocument.props.lastelementchild - */ - public readonly ?DOMElement $lastElementChild; + public ?DOMElement $lastElementChild; - /** - * The number of child elements. - * @var int - * @link http://www.php.net/manual/en/class.domdocument.php#domdocument.props.childelementcount - */ - public readonly int $childElementCount; + public int $childElementCount; /** - * Creates a new DOMDocument object - * @link http://www.php.net/manual/en/domdocument.construct.php - * @param string $version [optional] - * @param string $encoding [optional] - * @return string + * {@inheritdoc} + * @param string $version [optional] + * @param string $encoding [optional] */ - public function __construct (string $version = '"1.0"', string $encoding = '""'): string {} + public function __construct (string $version = '1.0', string $encoding = '') {} /** - * Create new attribute - * @link http://www.php.net/manual/en/domdocument.createattribute.php - * @param string $localName - * @return DOMAttr|false The new DOMAttr or false if an error occurred. + * {@inheritdoc} + * @param string $localName */ - public function createAttribute (string $localName): DOMAttr|false {} + public function createAttribute (string $localName) {} /** - * Create new attribute node with an associated namespace - * @link http://www.php.net/manual/en/domdocument.createattributens.php - * @param string|null $namespace - * @param string $qualifiedName - * @return DOMAttr|false The new DOMAttr or false if an error occurred. + * {@inheritdoc} + * @param string|null $namespace + * @param string $qualifiedName */ - public function createAttributeNS (?string $namespace, string $qualifiedName): DOMAttr|false {} + public function createAttributeNS (?string $namespace = null, string $qualifiedName) {} /** - * Create new cdata node - * @link http://www.php.net/manual/en/domdocument.createcdatasection.php - * @param string $data - * @return DOMCdataSection|false The new DOMCDATASection or false if an error occurred. + * {@inheritdoc} + * @param string $data */ - public function createCDATASection (string $data): DOMCdataSection|false {} + public function createCDATASection (string $data) {} /** - * Create new comment node - * @link http://www.php.net/manual/en/domdocument.createcomment.php - * @param string $data - * @return DOMComment The new DOMComment. + * {@inheritdoc} + * @param string $data */ - public function createComment (string $data): DOMComment {} + public function createComment (string $data) {} /** - * Create new document fragment - * @link http://www.php.net/manual/en/domdocument.createdocumentfragment.php - * @return DOMDocumentFragment The new DOMDocumentFragment. + * {@inheritdoc} */ - public function createDocumentFragment (): DOMDocumentFragment {} + public function createDocumentFragment () {} /** - * Create new element node - * @link http://www.php.net/manual/en/domdocument.createelement.php - * @param string $localName - * @param string $value [optional] - * @return DOMElement|false Returns a new instance of class DOMElement or false - * if an error occurred. + * {@inheritdoc} + * @param string $localName + * @param string $value [optional] */ - public function createElement (string $localName, string $value = '""'): DOMElement|false {} + public function createElement (string $localName, string $value = '') {} /** - * Create new element node with an associated namespace - * @link http://www.php.net/manual/en/domdocument.createelementns.php - * @param string|null $namespace - * @param string $qualifiedName - * @param string $value [optional] - * @return DOMElement|false The new DOMElement or false if an error occurred. + * {@inheritdoc} + * @param string|null $namespace + * @param string $qualifiedName + * @param string $value [optional] */ - public function createElementNS (?string $namespace, string $qualifiedName, string $value = '""'): DOMElement|false {} + public function createElementNS (?string $namespace = null, string $qualifiedName, string $value = '') {} /** - * Create new entity reference node - * @link http://www.php.net/manual/en/domdocument.createentityreference.php - * @param string $name - * @return DOMEntityReference|false The new DOMEntityReference or false if an error - * occurred. + * {@inheritdoc} + * @param string $name */ - public function createEntityReference (string $name): DOMEntityReference|false {} + public function createEntityReference (string $name) {} /** - * Creates new PI node - * @link http://www.php.net/manual/en/domdocument.createprocessinginstruction.php - * @param string $target - * @param string $data [optional] - * @return DOMProcessingInstruction|false The new DOMProcessingInstruction or false if an error occurred. + * {@inheritdoc} + * @param string $target + * @param string $data [optional] */ - public function createProcessingInstruction (string $target, string $data = '""'): DOMProcessingInstruction|false {} + public function createProcessingInstruction (string $target, string $data = '') {} /** - * Create new text node - * @link http://www.php.net/manual/en/domdocument.createtextnode.php - * @param string $data - * @return DOMText The new DOMText. + * {@inheritdoc} + * @param string $data */ - public function createTextNode (string $data): DOMText {} + public function createTextNode (string $data) {} /** - * Searches for an element with a certain id - * @link http://www.php.net/manual/en/domdocument.getelementbyid.php - * @param string $elementId - * @return DOMElement|null Returns the DOMElement or null if the element is - * not found. + * {@inheritdoc} + * @param string $elementId */ - public function getElementById (string $elementId): ?DOMElement {} + public function getElementById (string $elementId) {} /** - * Searches for all elements with given local tag name - * @link http://www.php.net/manual/en/domdocument.getelementsbytagname.php - * @param string $qualifiedName - * @return DOMNodeList A new DOMNodeList object containing all the matched - * elements. + * {@inheritdoc} + * @param string $qualifiedName */ - public function getElementsByTagName (string $qualifiedName): DOMNodeList {} + public function getElementsByTagName (string $qualifiedName) {} /** - * Searches for all elements with given tag name in specified namespace - * @link http://www.php.net/manual/en/domdocument.getelementsbytagnamens.php - * @param string|null $namespace - * @param string $localName - * @return DOMNodeList A new DOMNodeList object containing all the matched - * elements. + * {@inheritdoc} + * @param string|null $namespace + * @param string $localName */ - public function getElementsByTagNameNS (?string $namespace, string $localName): DOMNodeList {} + public function getElementsByTagNameNS (?string $namespace = null, string $localName) {} /** - * Import node into current document - * @link http://www.php.net/manual/en/domdocument.importnode.php - * @param DOMNode $node - * @param bool $deep [optional] - * @return DOMNode|false The copied node or false, if it cannot be copied. + * {@inheritdoc} + * @param DOMNode $node + * @param bool $deep [optional] */ - public function importNode (DOMNode $node, bool $deep = false): DOMNode|false {} + public function importNode (DOMNode $node, bool $deep = false) {} /** - * Load XML from a file - * @link http://www.php.net/manual/en/domdocument.load.php - * @param string $filename - * @param int $options [optional] - * @return DOMDocument|bool Returns true on success or false on failure. If called statically, returns a - * DOMDocument or false on failure. + * {@inheritdoc} + * @param string $filename + * @param int $options [optional] */ - public function load (string $filename, int $options = null): DOMDocument|bool {} + public function load (string $filename, int $options = 0) {} /** - * Load XML from a string - * @link http://www.php.net/manual/en/domdocument.loadxml.php - * @param string $source - * @param int $options [optional] - * @return DOMDocument|bool Returns true on success or false on failure. If called statically, returns a - * DOMDocument or false on failure. + * {@inheritdoc} + * @param string $source + * @param int $options [optional] */ - public function loadXML (string $source, int $options = null): DOMDocument|bool {} + public function loadXML (string $source, int $options = 0) {} /** - * Normalizes the document - * @link http://www.php.net/manual/en/domdocument.normalizedocument.php - * @return void No value is returned. + * {@inheritdoc} */ - public function normalizeDocument (): void {} + public function normalizeDocument () {} /** - * Register extended class used to create base node type - * @link http://www.php.net/manual/en/domdocument.registernodeclass.php - * @param string $baseClass - * @param string|null $extendedClass - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $baseClass + * @param string|null $extendedClass */ - public function registerNodeClass (string $baseClass, ?string $extendedClass): bool {} + public function registerNodeClass (string $baseClass, ?string $extendedClass = null) {} /** - * Dumps the internal XML tree back into a file - * @link http://www.php.net/manual/en/domdocument.save.php - * @param string $filename - * @param int $options [optional] - * @return int|false Returns the number of bytes written or false if an error occurred. + * {@inheritdoc} + * @param string $filename + * @param int $options [optional] */ - public function save (string $filename, int $options = null): int|false {} + public function save (string $filename, int $options = 0) {} /** - * Load HTML from a string - * @link http://www.php.net/manual/en/domdocument.loadhtml.php - * @param string $source - * @param int $options [optional] - * @return DOMDocument|bool Returns true on success or false on failure. If called statically, returns a - * DOMDocument or false on failure. + * {@inheritdoc} + * @param string $source + * @param int $options [optional] */ - public function loadHTML (string $source, int $options = null): DOMDocument|bool {} + public function loadHTML (string $source, int $options = 0) {} /** - * Load HTML from a file - * @link http://www.php.net/manual/en/domdocument.loadhtmlfile.php - * @param string $filename - * @param int $options [optional] - * @return DOMDocument|bool Returns true on success or false on failure. If called statically, returns a - * DOMDocument or false on failure. + * {@inheritdoc} + * @param string $filename + * @param int $options [optional] */ - public function loadHTMLFile (string $filename, int $options = null): DOMDocument|bool {} + public function loadHTMLFile (string $filename, int $options = 0) {} /** - * Dumps the internal document into a string using HTML formatting - * @link http://www.php.net/manual/en/domdocument.savehtml.php - * @param DOMNode|null $node [optional] - * @return string|false Returns the HTML, or false if an error occurred. + * {@inheritdoc} + * @param DOMNode|null $node [optional] */ - public function saveHTML (?DOMNode $node = null): string|false {} + public function saveHTML (?DOMNode $node = NULL) {} /** - * Dumps the internal document into a file using HTML formatting - * @link http://www.php.net/manual/en/domdocument.savehtmlfile.php - * @param string $filename - * @return int|false Returns the number of bytes written or false if an error occurred. + * {@inheritdoc} + * @param string $filename */ - public function saveHTMLFile (string $filename): int|false {} + public function saveHTMLFile (string $filename) {} /** - * Dumps the internal XML tree back into a string - * @link http://www.php.net/manual/en/domdocument.savexml.php - * @param DOMNode|null $node [optional] - * @param int $options [optional] - * @return string|false Returns the XML, or false if an error occurred. + * {@inheritdoc} + * @param DOMNode|null $node [optional] + * @param int $options [optional] */ - public function saveXML (?DOMNode $node = null, int $options = null): string|false {} + public function saveXML (?DOMNode $node = NULL, int $options = 0) {} /** - * Validates a document based on a schema. Only XML Schema 1.0 is supported. - * @link http://www.php.net/manual/en/domdocument.schemavalidate.php - * @param string $filename - * @param int $flags [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $filename + * @param int $flags [optional] */ - public function schemaValidate (string $filename, int $flags = null): bool {} + public function schemaValidate (string $filename, int $flags = 0) {} /** - * Validates a document based on a schema - * @link http://www.php.net/manual/en/domdocument.schemavalidatesource.php - * @param string $source - * @param int $flags [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $source + * @param int $flags [optional] */ - public function schemaValidateSource (string $source, int $flags = null): bool {} + public function schemaValidateSource (string $source, int $flags = 0) {} /** - * Performs relaxNG validation on the document - * @link http://www.php.net/manual/en/domdocument.relaxngvalidate.php - * @param string $filename - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $filename */ - public function relaxNGValidate (string $filename): bool {} + public function relaxNGValidate (string $filename) {} /** - * Performs relaxNG validation on the document - * @link http://www.php.net/manual/en/domdocument.relaxngvalidatesource.php - * @param string $source - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $source */ - public function relaxNGValidateSource (string $source): bool {} + public function relaxNGValidateSource (string $source) {} /** - * Validates the document based on its DTD - * @link http://www.php.net/manual/en/domdocument.validate.php - * @return bool Returns true on success or false on failure. - * If the document has no DTD attached, this method will return false. + * {@inheritdoc} */ - public function validate (): bool {} + public function validate () {} /** - * Substitutes XIncludes in a DOMDocument Object - * @link http://www.php.net/manual/en/domdocument.xinclude.php - * @param int $options [optional] - * @return int|false Returns the number of XIncludes in the document, -1 if some processing failed, - * or false if there were no substitutions. + * {@inheritdoc} + * @param int $options [optional] */ - public function xinclude (int $options = null): int|false {} + public function xinclude (int $options = 0) {} /** * {@inheritdoc} @@ -1176,238 +792,197 @@ public function append (...$nodes): void {} public function prepend (...$nodes): void {} /** - * Adds new child at the end of the children - * @link http://www.php.net/manual/en/domnode.appendchild.php - * @param DOMNode $node - * @return DOMNode|false The node added or false on error. + * {@inheritdoc} + * @param mixed $nodes [optional] */ - public function appendChild (DOMNode $node): DOMNode|false {} + public function replaceChildren (...$nodes): void {} /** - * Canonicalize nodes to a string - * @link http://www.php.net/manual/en/domnode.c14n.php - * @param bool $exclusive [optional] Enable exclusive parsing of only the nodes matched by the provided - * xpath or namespace prefixes. - * @param bool $withComments [optional] Retain comments in output. - * @param array|null $xpath [optional] An array of xpaths to filter the nodes by. - * @param array|null $nsPrefixes [optional] An array of namespace prefixes to filter the nodes by. - * @return string|false Returns canonicalized nodes as a string or false on failure + * {@inheritdoc} */ - public function C14N (bool $exclusive = false, bool $withComments = false, ?array $xpath = null, ?array $nsPrefixes = null): string|false {} + public function __sleep (): array {} /** - * Canonicalize nodes to a file - * @link http://www.php.net/manual/en/domnode.c14nfile.php - * @param string $uri Path to write the output to. - * @param bool $exclusive [optional] Enable exclusive parsing of only the nodes matched by the provided - * xpath or namespace prefixes. - * @param bool $withComments [optional] Retain comments in output. - * @param array|null $xpath [optional] An array of xpaths to filter the nodes by. - * @param array|null $nsPrefixes [optional] An array of namespace prefixes to filter the nodes by. - * @return int|false Number of bytes written or false on failure + * {@inheritdoc} */ - public function C14NFile (string $uri, bool $exclusive = false, bool $withComments = false, ?array $xpath = null, ?array $nsPrefixes = null): int|false {} + public function __wakeup (): void {} /** - * Clones a node - * @link http://www.php.net/manual/en/domnode.clonenode.php - * @param bool $deep [optional] - * @return DOMNode|false The cloned node. + * {@inheritdoc} + * @param DOMNode $node */ - public function cloneNode (bool $deep = false): DOMNode|false {} + public function appendChild (DOMNode $node) {} /** - * Get line number for a node - * @link http://www.php.net/manual/en/domnode.getlineno.php - * @return int Always returns the line number where the node was defined in. + * {@inheritdoc} + * @param bool $exclusive [optional] + * @param bool $withComments [optional] + * @param array|null $xpath [optional] + * @param array|null $nsPrefixes [optional] */ - public function getLineNo (): int {} + public function C14N (bool $exclusive = false, bool $withComments = false, ?array $xpath = NULL, ?array $nsPrefixes = NULL) {} /** - * Get an XPath for a node - * @link http://www.php.net/manual/en/domnode.getnodepath.php - * @return string|null Returns a string containing the XPath, or null in case of an error. + * {@inheritdoc} + * @param string $uri + * @param bool $exclusive [optional] + * @param bool $withComments [optional] + * @param array|null $xpath [optional] + * @param array|null $nsPrefixes [optional] */ - public function getNodePath (): ?string {} + public function C14NFile (string $uri, bool $exclusive = false, bool $withComments = false, ?array $xpath = NULL, ?array $nsPrefixes = NULL) {} /** - * Checks if node has attributes - * @link http://www.php.net/manual/en/domnode.hasattributes.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param bool $deep [optional] */ - public function hasAttributes (): bool {} + public function cloneNode (bool $deep = false) {} /** - * Checks if node has children - * @link http://www.php.net/manual/en/domnode.haschildnodes.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function hasChildNodes (): bool {} + public function getLineNo () {} /** - * Adds a new child before a reference node - * @link http://www.php.net/manual/en/domnode.insertbefore.php - * @param DOMNode $node - * @param DOMNode|null $child [optional] - * @return DOMNode|false The inserted node or false on error. + * {@inheritdoc} */ - public function insertBefore (DOMNode $node, ?DOMNode $child = null): DOMNode|false {} + public function getNodePath () {} /** - * Checks if the specified namespaceURI is the default namespace or not - * @link http://www.php.net/manual/en/domnode.isdefaultnamespace.php - * @param string $namespace - * @return bool Return true if namespace is the default - * namespace, false otherwise. + * {@inheritdoc} */ - public function isDefaultNamespace (string $namespace): bool {} + public function hasAttributes () {} /** - * Indicates if two nodes are the same node - * @link http://www.php.net/manual/en/domnode.issamenode.php - * @param DOMNode $otherNode - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function isSameNode (DOMNode $otherNode): bool {} + public function hasChildNodes () {} /** - * Checks if feature is supported for specified version - * @link http://www.php.net/manual/en/domnode.issupported.php - * @param string $feature - * @param string $version - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param DOMNode $node + * @param DOMNode|null $child [optional] */ - public function isSupported (string $feature, string $version): bool {} + public function insertBefore (DOMNode $node, ?DOMNode $child = NULL) {} /** - * Gets the namespace URI of the node based on the prefix - * @link http://www.php.net/manual/en/domnode.lookupnamespaceuri.php - * @param string $prefix - * @return string The namespace URI of the node. + * {@inheritdoc} + * @param string $namespace */ - public function lookupNamespaceURI (string $prefix): string {} + public function isDefaultNamespace (string $namespace) {} /** - * Gets the namespace prefix of the node based on the namespace URI - * @link http://www.php.net/manual/en/domnode.lookupprefix.php - * @param string $namespace - * @return string|null The prefix of the namespace or null on error. + * {@inheritdoc} + * @param DOMNode $otherNode */ - public function lookupPrefix (string $namespace): ?string {} + public function isSameNode (DOMNode $otherNode) {} /** - * Normalizes the node - * @link http://www.php.net/manual/en/domnode.normalize.php - * @return void No value is returned. + * {@inheritdoc} + * @param DOMNode|null $otherNode */ - public function normalize (): void {} + public function isEqualNode (?DOMNode $otherNode = null): bool {} /** - * Removes child from list of children - * @link http://www.php.net/manual/en/domnode.removechild.php - * @param DOMNode $child - * @return DOMNode|false If the child could be removed the function returns the old child or false on error. - */ - public function removeChild (DOMNode $child): DOMNode|false {} - + * {@inheritdoc} + * @param string $feature + * @param string $version + */ + public function isSupported (string $feature, string $version) {} + /** - * Replaces a child - * @link http://www.php.net/manual/en/domnode.replacechild.php - * @param DOMNode $node - * @param DOMNode $child - * @return DOMNode|false The old node or false if an error occur. + * {@inheritdoc} + * @param string|null $prefix */ - public function replaceChild (DOMNode $node, DOMNode $child): DOMNode|false {} + public function lookupNamespaceURI (?string $prefix = null) {} -} + /** + * {@inheritdoc} + * @param string $namespace + */ + public function lookupPrefix (string $namespace) {} -/** - * @link http://www.php.net/manual/en/class.domnodelist.php - */ -class DOMNodeList implements IteratorAggregate, Traversable, Countable { + /** + * {@inheritdoc} + */ + public function normalize () {} /** - * The number of nodes in the list. The range of valid child node - * indices is 0 to length - 1 inclusive. - * @var int - * @link http://www.php.net/manual/en/class.domnodelist.php#domnodelist.props.length + * {@inheritdoc} + * @param DOMNode $child */ - public readonly int $length; + public function removeChild (DOMNode $child) {} /** - * Get number of nodes in the list - * @link http://www.php.net/manual/en/domnodelist.count.php - * @return int Returns the number of nodes in the list, which is identical to the - * length property. + * {@inheritdoc} + * @param DOMNode $node + * @param DOMNode $child */ - public function count (): int {} + public function replaceChild (DOMNode $node, DOMNode $child) {} /** * {@inheritdoc} + * @param DOMNode|DOMNameSpaceNode|null $other */ - public function getIterator (): Iterator {} + public function contains (DOMNode|DOMNameSpaceNode|null $other = null): bool {} /** - * Retrieves a node specified by index - * @link http://www.php.net/manual/en/domnodelist.item.php - * @param int $index - * @return DOMNode|DOMNameSpaceNode|null The node at the indexth position in the - * DOMNodeList, or null if that is not a valid - * index. + * {@inheritdoc} + * @param array|null $options [optional] */ - public function item (int $index): DOMNode|DOMNameSpaceNode|null {} + public function getRootNode (?array $options = NULL): DOMNode {} } -/** - * @link http://www.php.net/manual/en/class.domnamednodemap.php - */ -class DOMNamedNodeMap implements IteratorAggregate, Traversable, Countable { +class DOMNodeList implements IteratorAggregate, Traversable, Countable { + + public int $length; + + /** + * {@inheritdoc} + */ + public function count () {} + + /** + * {@inheritdoc} + */ + public function getIterator (): Iterator {} /** - * The number of nodes in the map. The range of valid child node - * indices is 0 to length - 1 inclusive. - * @var int - * @link http://www.php.net/manual/en/class.domnamednodemap.php#domnamednodemap.props.length + * {@inheritdoc} + * @param int $index */ - public readonly int $length; + public function item (int $index) {} + +} + +class DOMNamedNodeMap implements IteratorAggregate, Traversable, Countable { + + public int $length; /** - * Retrieves a node specified by name - * @link http://www.php.net/manual/en/domnamednodemap.getnameditem.php - * @param string $qualifiedName - * @return DOMNode|null A node (of any type) with the specified nodeName, or - * null if no node is found. + * {@inheritdoc} + * @param string $qualifiedName */ - public function getNamedItem (string $qualifiedName): ?DOMNode {} + public function getNamedItem (string $qualifiedName) {} /** - * Retrieves a node specified by local name and namespace URI - * @link http://www.php.net/manual/en/domnamednodemap.getnameditemns.php - * @param string|null $namespace - * @param string $localName - * @return DOMNode|null A node (of any type) with the specified local name and namespace URI, or - * null if no node is found. + * {@inheritdoc} + * @param string|null $namespace + * @param string $localName */ - public function getNamedItemNS (?string $namespace, string $localName): ?DOMNode {} + public function getNamedItemNS (?string $namespace = null, string $localName) {} /** - * Retrieves a node specified by index - * @link http://www.php.net/manual/en/domnamednodemap.item.php - * @param int $index - * @return DOMNode|null The node at the indexth position in the map, or null - * if that is not a valid index (greater than or equal to the number of nodes - * in this map). + * {@inheritdoc} + * @param int $index */ - public function item (int $index): ?DOMNode {} + public function item (int $index) {} /** - * Get number of nodes in the map - * @link http://www.php.net/manual/en/domnamednodemap.count.php - * @return int Returns the number of nodes in the map, which is identical to the - * length property. + * {@inheritdoc} */ - public function count (): int {} + public function count () {} /** * {@inheritdoc} @@ -1416,87 +991,50 @@ public function getIterator (): Iterator {} } -/** - * Represents nodes with character data. No nodes directly correspond to - * this class, but other nodes do inherit from it. - * @link http://www.php.net/manual/en/class.domcharacterdata.php - */ class DOMCharacterData extends DOMNode implements DOMChildNode { - /** - * The contents of the node. - * @var string - * @link http://www.php.net/manual/en/class.domcharacterdata.php#domcharacterdata.props.data - */ public string $data; - /** - * The length of the contents. - * @var int - * @link http://www.php.net/manual/en/class.domcharacterdata.php#domcharacterdata.props.length - */ - public readonly int $length; + public int $length; - /** - * The previous sibling element or null. - * @var DOMElement|null - * @link http://www.php.net/manual/en/class.domcharacterdata.php#domcharacterdata.props.previouselementsibling - */ - public readonly ?DOMElement $previousElementSibling; + public ?DOMElement $previousElementSibling; - /** - * The next sibling element or null. - * @var DOMElement|null - * @link http://www.php.net/manual/en/class.domcharacterdata.php#domcharacterdata.props.nextelementsibling - */ - public readonly ?DOMElement $nextElementSibling; + public ?DOMElement $nextElementSibling; /** - * Append the string to the end of the character data of the node - * @link http://www.php.net/manual/en/domcharacterdata.appenddata.php - * @param string $data - * @return true Always returns true. + * {@inheritdoc} + * @param string $data */ - public function appendData (string $data): true {} + public function appendData (string $data) {} /** - * Extracts a range of data from the node - * @link http://www.php.net/manual/en/domcharacterdata.substringdata.php - * @param int $offset - * @param int $count - * @return string|false The specified substring. If the sum of offset - * and count exceeds the length, then all 16-bit units - * to the end of the data are returned. + * {@inheritdoc} + * @param int $offset + * @param int $count */ - public function substringData (int $offset, int $count): string|false {} + public function substringData (int $offset, int $count) {} /** - * Insert a string at the specified 16-bit unit offset - * @link http://www.php.net/manual/en/domcharacterdata.insertdata.php - * @param int $offset - * @param string $data - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $offset + * @param string $data */ - public function insertData (int $offset, string $data): bool {} + public function insertData (int $offset, string $data) {} /** - * Remove a range of characters from the node - * @link http://www.php.net/manual/en/domcharacterdata.deletedata.php - * @param int $offset - * @param int $count - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $offset + * @param int $count */ - public function deleteData (int $offset, int $count): bool {} + public function deleteData (int $offset, int $count) {} /** - * Replace a substring within the DOMCharacterData node - * @link http://www.php.net/manual/en/domcharacterdata.replacedata.php - * @param int $offset - * @param int $count - * @param string $data - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $offset + * @param int $count + * @param string $data */ - public function replaceData (int $offset, int $count, string $data): bool {} + public function replaceData (int $offset, int $count, string $data) {} /** * {@inheritdoc} @@ -1522,586 +1060,462 @@ public function before (...$nodes): void {} public function after (...$nodes): void {} /** - * Adds new child at the end of the children - * @link http://www.php.net/manual/en/domnode.appendchild.php - * @param DOMNode $node - * @return DOMNode|false The node added or false on error. + * {@inheritdoc} */ - public function appendChild (DOMNode $node): DOMNode|false {} + public function __sleep (): array {} /** - * Canonicalize nodes to a string - * @link http://www.php.net/manual/en/domnode.c14n.php - * @param bool $exclusive [optional] Enable exclusive parsing of only the nodes matched by the provided - * xpath or namespace prefixes. - * @param bool $withComments [optional] Retain comments in output. - * @param array|null $xpath [optional] An array of xpaths to filter the nodes by. - * @param array|null $nsPrefixes [optional] An array of namespace prefixes to filter the nodes by. - * @return string|false Returns canonicalized nodes as a string or false on failure + * {@inheritdoc} */ - public function C14N (bool $exclusive = false, bool $withComments = false, ?array $xpath = null, ?array $nsPrefixes = null): string|false {} + public function __wakeup (): void {} /** - * Canonicalize nodes to a file - * @link http://www.php.net/manual/en/domnode.c14nfile.php - * @param string $uri Path to write the output to. - * @param bool $exclusive [optional] Enable exclusive parsing of only the nodes matched by the provided - * xpath or namespace prefixes. - * @param bool $withComments [optional] Retain comments in output. - * @param array|null $xpath [optional] An array of xpaths to filter the nodes by. - * @param array|null $nsPrefixes [optional] An array of namespace prefixes to filter the nodes by. - * @return int|false Number of bytes written or false on failure + * {@inheritdoc} + * @param DOMNode $node */ - public function C14NFile (string $uri, bool $exclusive = false, bool $withComments = false, ?array $xpath = null, ?array $nsPrefixes = null): int|false {} + public function appendChild (DOMNode $node) {} /** - * Clones a node - * @link http://www.php.net/manual/en/domnode.clonenode.php - * @param bool $deep [optional] - * @return DOMNode|false The cloned node. + * {@inheritdoc} + * @param bool $exclusive [optional] + * @param bool $withComments [optional] + * @param array|null $xpath [optional] + * @param array|null $nsPrefixes [optional] */ - public function cloneNode (bool $deep = false): DOMNode|false {} + public function C14N (bool $exclusive = false, bool $withComments = false, ?array $xpath = NULL, ?array $nsPrefixes = NULL) {} /** - * Get line number for a node - * @link http://www.php.net/manual/en/domnode.getlineno.php - * @return int Always returns the line number where the node was defined in. + * {@inheritdoc} + * @param string $uri + * @param bool $exclusive [optional] + * @param bool $withComments [optional] + * @param array|null $xpath [optional] + * @param array|null $nsPrefixes [optional] */ - public function getLineNo (): int {} + public function C14NFile (string $uri, bool $exclusive = false, bool $withComments = false, ?array $xpath = NULL, ?array $nsPrefixes = NULL) {} /** - * Get an XPath for a node - * @link http://www.php.net/manual/en/domnode.getnodepath.php - * @return string|null Returns a string containing the XPath, or null in case of an error. + * {@inheritdoc} + * @param bool $deep [optional] */ - public function getNodePath (): ?string {} + public function cloneNode (bool $deep = false) {} /** - * Checks if node has attributes - * @link http://www.php.net/manual/en/domnode.hasattributes.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function hasAttributes (): bool {} + public function getLineNo () {} /** - * Checks if node has children - * @link http://www.php.net/manual/en/domnode.haschildnodes.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function hasChildNodes (): bool {} + public function getNodePath () {} /** - * Adds a new child before a reference node - * @link http://www.php.net/manual/en/domnode.insertbefore.php - * @param DOMNode $node - * @param DOMNode|null $child [optional] - * @return DOMNode|false The inserted node or false on error. + * {@inheritdoc} */ - public function insertBefore (DOMNode $node, ?DOMNode $child = null): DOMNode|false {} + public function hasAttributes () {} /** - * Checks if the specified namespaceURI is the default namespace or not - * @link http://www.php.net/manual/en/domnode.isdefaultnamespace.php - * @param string $namespace - * @return bool Return true if namespace is the default - * namespace, false otherwise. + * {@inheritdoc} */ - public function isDefaultNamespace (string $namespace): bool {} + public function hasChildNodes () {} /** - * Indicates if two nodes are the same node - * @link http://www.php.net/manual/en/domnode.issamenode.php - * @param DOMNode $otherNode - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param DOMNode $node + * @param DOMNode|null $child [optional] */ - public function isSameNode (DOMNode $otherNode): bool {} + public function insertBefore (DOMNode $node, ?DOMNode $child = NULL) {} /** - * Checks if feature is supported for specified version - * @link http://www.php.net/manual/en/domnode.issupported.php - * @param string $feature - * @param string $version - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $namespace */ - public function isSupported (string $feature, string $version): bool {} + public function isDefaultNamespace (string $namespace) {} /** - * Gets the namespace URI of the node based on the prefix - * @link http://www.php.net/manual/en/domnode.lookupnamespaceuri.php - * @param string $prefix - * @return string The namespace URI of the node. + * {@inheritdoc} + * @param DOMNode $otherNode */ - public function lookupNamespaceURI (string $prefix): string {} + public function isSameNode (DOMNode $otherNode) {} /** - * Gets the namespace prefix of the node based on the namespace URI - * @link http://www.php.net/manual/en/domnode.lookupprefix.php - * @param string $namespace - * @return string|null The prefix of the namespace or null on error. + * {@inheritdoc} + * @param DOMNode|null $otherNode */ - public function lookupPrefix (string $namespace): ?string {} + public function isEqualNode (?DOMNode $otherNode = null): bool {} /** - * Normalizes the node - * @link http://www.php.net/manual/en/domnode.normalize.php - * @return void No value is returned. + * {@inheritdoc} + * @param string $feature + * @param string $version */ - public function normalize (): void {} + public function isSupported (string $feature, string $version) {} /** - * Removes child from list of children - * @link http://www.php.net/manual/en/domnode.removechild.php - * @param DOMNode $child - * @return DOMNode|false If the child could be removed the function returns the old child or false on error. + * {@inheritdoc} + * @param string|null $prefix */ - public function removeChild (DOMNode $child): DOMNode|false {} + public function lookupNamespaceURI (?string $prefix = null) {} /** - * Replaces a child - * @link http://www.php.net/manual/en/domnode.replacechild.php - * @param DOMNode $node - * @param DOMNode $child - * @return DOMNode|false The old node or false if an error occur. + * {@inheritdoc} + * @param string $namespace */ - public function replaceChild (DOMNode $node, DOMNode $child): DOMNode|false {} - -} - -/** - * DOMAttr represents an attribute in the - * DOMElement object. - * @link http://www.php.net/manual/en/class.domattr.php - */ -class DOMAttr extends DOMNode { + public function lookupPrefix (string $namespace) {} /** - * The name of the attribute. - * @var string - * @link http://www.php.net/manual/en/class.domattr.php#domattr.props.name + * {@inheritdoc} */ - public readonly string $name; + public function normalize () {} /** - * Not implemented yet, always is true. - * @var bool - * @link http://www.php.net/manual/en/class.domattr.php#domattr.props.specified + * {@inheritdoc} + * @param DOMNode $child */ - public readonly bool $specified; + public function removeChild (DOMNode $child) {} /** - * The value of the attribute. - * @var string - * @link http://www.php.net/manual/en/class.domattr.php#domattr.props.value + * {@inheritdoc} + * @param DOMNode $node + * @param DOMNode $child */ - public string $value; + public function replaceChild (DOMNode $node, DOMNode $child) {} /** - * The element which contains the attribute or null. - * @var DOMElement|null - * @link http://www.php.net/manual/en/class.domattr.php#domattr.props.ownerelement + * {@inheritdoc} + * @param DOMNode|DOMNameSpaceNode|null $other */ - public readonly ?DOMElement $ownerElement; + public function contains (DOMNode|DOMNameSpaceNode|null $other = null): bool {} /** - * Not implemented yet, always is null. - * @var mixed - * @link http://www.php.net/manual/en/class.domattr.php#domattr.props.schematypeinfo + * {@inheritdoc} + * @param array|null $options [optional] */ - public readonly mixed $schemaTypeInfo; + public function getRootNode (?array $options = NULL): DOMNode {} + +} + +class DOMAttr extends DOMNode { + + public string $name; + + public bool $specified; + + public string $value; + + public ?DOMElement $ownerElement; + + public mixed $schemaTypeInfo; /** - * Creates a new DOMAttr object - * @link http://www.php.net/manual/en/domattr.construct.php - * @param string $name - * @param string $value [optional] - * @return string + * {@inheritdoc} + * @param string $name + * @param string $value [optional] */ - public function __construct (string $name, string $value = '""'): string {} + public function __construct (string $name, string $value = '') {} /** - * Checks if attribute is a defined ID - * @link http://www.php.net/manual/en/domattr.isid.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function isId (): bool {} + public function isId () {} /** - * Adds new child at the end of the children - * @link http://www.php.net/manual/en/domnode.appendchild.php - * @param DOMNode $node - * @return DOMNode|false The node added or false on error. + * {@inheritdoc} */ - public function appendChild (DOMNode $node): DOMNode|false {} + public function __sleep (): array {} /** - * Canonicalize nodes to a string - * @link http://www.php.net/manual/en/domnode.c14n.php - * @param bool $exclusive [optional] Enable exclusive parsing of only the nodes matched by the provided - * xpath or namespace prefixes. - * @param bool $withComments [optional] Retain comments in output. - * @param array|null $xpath [optional] An array of xpaths to filter the nodes by. - * @param array|null $nsPrefixes [optional] An array of namespace prefixes to filter the nodes by. - * @return string|false Returns canonicalized nodes as a string or false on failure + * {@inheritdoc} */ - public function C14N (bool $exclusive = false, bool $withComments = false, ?array $xpath = null, ?array $nsPrefixes = null): string|false {} + public function __wakeup (): void {} /** - * Canonicalize nodes to a file - * @link http://www.php.net/manual/en/domnode.c14nfile.php - * @param string $uri Path to write the output to. - * @param bool $exclusive [optional] Enable exclusive parsing of only the nodes matched by the provided - * xpath or namespace prefixes. - * @param bool $withComments [optional] Retain comments in output. - * @param array|null $xpath [optional] An array of xpaths to filter the nodes by. - * @param array|null $nsPrefixes [optional] An array of namespace prefixes to filter the nodes by. - * @return int|false Number of bytes written or false on failure + * {@inheritdoc} + * @param DOMNode $node */ - public function C14NFile (string $uri, bool $exclusive = false, bool $withComments = false, ?array $xpath = null, ?array $nsPrefixes = null): int|false {} + public function appendChild (DOMNode $node) {} /** - * Clones a node - * @link http://www.php.net/manual/en/domnode.clonenode.php - * @param bool $deep [optional] - * @return DOMNode|false The cloned node. + * {@inheritdoc} + * @param bool $exclusive [optional] + * @param bool $withComments [optional] + * @param array|null $xpath [optional] + * @param array|null $nsPrefixes [optional] */ - public function cloneNode (bool $deep = false): DOMNode|false {} + public function C14N (bool $exclusive = false, bool $withComments = false, ?array $xpath = NULL, ?array $nsPrefixes = NULL) {} /** - * Get line number for a node - * @link http://www.php.net/manual/en/domnode.getlineno.php - * @return int Always returns the line number where the node was defined in. + * {@inheritdoc} + * @param string $uri + * @param bool $exclusive [optional] + * @param bool $withComments [optional] + * @param array|null $xpath [optional] + * @param array|null $nsPrefixes [optional] */ - public function getLineNo (): int {} + public function C14NFile (string $uri, bool $exclusive = false, bool $withComments = false, ?array $xpath = NULL, ?array $nsPrefixes = NULL) {} /** - * Get an XPath for a node - * @link http://www.php.net/manual/en/domnode.getnodepath.php - * @return string|null Returns a string containing the XPath, or null in case of an error. + * {@inheritdoc} + * @param bool $deep [optional] */ - public function getNodePath (): ?string {} + public function cloneNode (bool $deep = false) {} /** - * Checks if node has attributes - * @link http://www.php.net/manual/en/domnode.hasattributes.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function hasAttributes (): bool {} + public function getLineNo () {} /** - * Checks if node has children - * @link http://www.php.net/manual/en/domnode.haschildnodes.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function hasChildNodes (): bool {} + public function getNodePath () {} /** - * Adds a new child before a reference node - * @link http://www.php.net/manual/en/domnode.insertbefore.php - * @param DOMNode $node - * @param DOMNode|null $child [optional] - * @return DOMNode|false The inserted node or false on error. + * {@inheritdoc} */ - public function insertBefore (DOMNode $node, ?DOMNode $child = null): DOMNode|false {} + public function hasAttributes () {} /** - * Checks if the specified namespaceURI is the default namespace or not - * @link http://www.php.net/manual/en/domnode.isdefaultnamespace.php - * @param string $namespace - * @return bool Return true if namespace is the default - * namespace, false otherwise. + * {@inheritdoc} */ - public function isDefaultNamespace (string $namespace): bool {} + public function hasChildNodes () {} /** - * Indicates if two nodes are the same node - * @link http://www.php.net/manual/en/domnode.issamenode.php - * @param DOMNode $otherNode - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param DOMNode $node + * @param DOMNode|null $child [optional] */ - public function isSameNode (DOMNode $otherNode): bool {} + public function insertBefore (DOMNode $node, ?DOMNode $child = NULL) {} /** - * Checks if feature is supported for specified version - * @link http://www.php.net/manual/en/domnode.issupported.php - * @param string $feature - * @param string $version - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $namespace */ - public function isSupported (string $feature, string $version): bool {} + public function isDefaultNamespace (string $namespace) {} /** - * Gets the namespace URI of the node based on the prefix - * @link http://www.php.net/manual/en/domnode.lookupnamespaceuri.php - * @param string $prefix - * @return string The namespace URI of the node. + * {@inheritdoc} + * @param DOMNode $otherNode */ - public function lookupNamespaceURI (string $prefix): string {} + public function isSameNode (DOMNode $otherNode) {} /** - * Gets the namespace prefix of the node based on the namespace URI - * @link http://www.php.net/manual/en/domnode.lookupprefix.php - * @param string $namespace - * @return string|null The prefix of the namespace or null on error. + * {@inheritdoc} + * @param DOMNode|null $otherNode */ - public function lookupPrefix (string $namespace): ?string {} + public function isEqualNode (?DOMNode $otherNode = null): bool {} /** - * Normalizes the node - * @link http://www.php.net/manual/en/domnode.normalize.php - * @return void No value is returned. + * {@inheritdoc} + * @param string $feature + * @param string $version */ - public function normalize (): void {} + public function isSupported (string $feature, string $version) {} /** - * Removes child from list of children - * @link http://www.php.net/manual/en/domnode.removechild.php - * @param DOMNode $child - * @return DOMNode|false If the child could be removed the function returns the old child or false on error. + * {@inheritdoc} + * @param string|null $prefix */ - public function removeChild (DOMNode $child): DOMNode|false {} + public function lookupNamespaceURI (?string $prefix = null) {} /** - * Replaces a child - * @link http://www.php.net/manual/en/domnode.replacechild.php - * @param DOMNode $node - * @param DOMNode $child - * @return DOMNode|false The old node or false if an error occur. + * {@inheritdoc} + * @param string $namespace */ - public function replaceChild (DOMNode $node, DOMNode $child): DOMNode|false {} - -} - -/** - * @link http://www.php.net/manual/en/class.domelement.php - */ -class DOMElement extends DOMNode implements DOMParentNode, DOMChildNode { + public function lookupPrefix (string $namespace) {} /** - * The element name - * @var string - * @link http://www.php.net/manual/en/class.domelement.php#domelement.props.tagname + * {@inheritdoc} */ - public readonly string $tagName; + public function normalize () {} /** - * Not implemented yet, always return null - * @var mixed - * @link http://www.php.net/manual/en/class.domelement.php#domelement.props.schematypeinfo + * {@inheritdoc} + * @param DOMNode $child */ - public readonly mixed $schemaTypeInfo; + public function removeChild (DOMNode $child) {} /** - * First child element or null. - * @var DOMElement|null - * @link http://www.php.net/manual/en/class.domelement.php#domelement.props.firstelementchild + * {@inheritdoc} + * @param DOMNode $node + * @param DOMNode $child */ - public readonly ?DOMElement $firstElementChild; + public function replaceChild (DOMNode $node, DOMNode $child) {} /** - * Last child element or null. - * @var DOMElement|null - * @link http://www.php.net/manual/en/class.domelement.php#domelement.props.lastelementchild + * {@inheritdoc} + * @param DOMNode|DOMNameSpaceNode|null $other */ - public readonly ?DOMElement $lastElementChild; + public function contains (DOMNode|DOMNameSpaceNode|null $other = null): bool {} /** - * The number of child elements. - * @var int - * @link http://www.php.net/manual/en/class.domelement.php#domelement.props.childelementcount + * {@inheritdoc} + * @param array|null $options [optional] */ - public readonly int $childElementCount; + public function getRootNode (?array $options = NULL): DOMNode {} + +} + +class DOMElement extends DOMNode implements DOMParentNode, DOMChildNode { + + public string $tagName; + + public string $className; + + public string $id; + + public mixed $schemaTypeInfo; + + public ?DOMElement $firstElementChild; + + public ?DOMElement $lastElementChild; + + public int $childElementCount; + + public ?DOMElement $previousElementSibling; + + public ?DOMElement $nextElementSibling; /** - * The previous sibling element or null. - * @var DOMElement|null - * @link http://www.php.net/manual/en/class.domelement.php#domelement.props.previouselementsibling + * {@inheritdoc} + * @param string $qualifiedName + * @param string|null $value [optional] + * @param string $namespace [optional] */ - public readonly ?DOMElement $previousElementSibling; + public function __construct (string $qualifiedName, ?string $value = NULL, string $namespace = '') {} /** - * The next sibling element or null. - * @var DOMElement|null - * @link http://www.php.net/manual/en/class.domelement.php#domelement.props.nextelementsibling + * {@inheritdoc} + * @param string $qualifiedName */ - public readonly ?DOMElement $nextElementSibling; + public function getAttribute (string $qualifiedName) {} /** - * Creates a new DOMElement object - * @link http://www.php.net/manual/en/domelement.construct.php - * @param string $qualifiedName - * @param string|null $value [optional] - * @param string $namespace [optional] - * @return string + * {@inheritdoc} */ - public function __construct (string $qualifiedName, ?string $value = null, string $namespace = '""'): string {} + public function getAttributeNames (): array {} /** - * Returns value of attribute - * @link http://www.php.net/manual/en/domelement.getattribute.php - * @param string $qualifiedName - * @return string The value of the attribute, or an empty string if no attribute with the - * given qualifiedName is found. + * {@inheritdoc} + * @param string|null $namespace + * @param string $localName */ - public function getAttribute (string $qualifiedName): string {} + public function getAttributeNS (?string $namespace = null, string $localName) {} /** - * Returns value of attribute - * @link http://www.php.net/manual/en/domelement.getattributens.php - * @param string|null $namespace - * @param string $localName - * @return string The value of the attribute, or an empty string if no attribute with the - * given localName and namespace - * is found. + * {@inheritdoc} + * @param string $qualifiedName */ - public function getAttributeNS (?string $namespace, string $localName): string {} + public function getAttributeNode (string $qualifiedName) {} /** - * Returns attribute node - * @link http://www.php.net/manual/en/domelement.getattributenode.php - * @param string $qualifiedName - * @return DOMAttr|DOMNameSpaceNode|false The attribute node. Note that for XML namespace declarations - * (xmlns and xmlns:* attributes) an - * instance of DOMNameSpaceNode is returned instead of a - * DOMAttr. + * {@inheritdoc} + * @param string|null $namespace + * @param string $localName */ - public function getAttributeNode (string $qualifiedName): DOMAttr|DOMNameSpaceNode|false {} + public function getAttributeNodeNS (?string $namespace = null, string $localName) {} /** - * Returns attribute node - * @link http://www.php.net/manual/en/domelement.getattributenodens.php - * @param string|null $namespace - * @param string $localName - * @return DOMAttr|DOMNameSpaceNode|null The attribute node. Note that for XML namespace declarations - * (xmlns and xmlns:* attributes) an - * instance of DOMNameSpaceNode is returned instead of a - * DOMAttr object. + * {@inheritdoc} + * @param string $qualifiedName */ - public function getAttributeNodeNS (?string $namespace, string $localName): DOMAttr|DOMNameSpaceNode|null {} + public function getElementsByTagName (string $qualifiedName) {} /** - * Gets elements by tagname - * @link http://www.php.net/manual/en/domelement.getelementsbytagname.php - * @param string $qualifiedName - * @return DOMNodeList This function returns a new instance of the class - * DOMNodeList of all matched elements. + * {@inheritdoc} + * @param string|null $namespace + * @param string $localName */ - public function getElementsByTagName (string $qualifiedName): DOMNodeList {} + public function getElementsByTagNameNS (?string $namespace = null, string $localName) {} /** - * Get elements by namespaceURI and localName - * @link http://www.php.net/manual/en/domelement.getelementsbytagnamens.php - * @param string|null $namespace - * @param string $localName - * @return DOMNodeList This function returns a new instance of the class - * DOMNodeList of all matched elements in the order in - * which they are encountered in a preorder traversal of this element tree. + * {@inheritdoc} + * @param string $qualifiedName */ - public function getElementsByTagNameNS (?string $namespace, string $localName): DOMNodeList {} + public function hasAttribute (string $qualifiedName) {} /** - * Checks to see if attribute exists - * @link http://www.php.net/manual/en/domelement.hasattribute.php - * @param string $qualifiedName - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string|null $namespace + * @param string $localName */ - public function hasAttribute (string $qualifiedName): bool {} + public function hasAttributeNS (?string $namespace = null, string $localName) {} /** - * Checks to see if attribute exists - * @link http://www.php.net/manual/en/domelement.hasattributens.php - * @param string|null $namespace - * @param string $localName - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $qualifiedName */ - public function hasAttributeNS (?string $namespace, string $localName): bool {} + public function removeAttribute (string $qualifiedName) {} /** - * Removes attribute - * @link http://www.php.net/manual/en/domelement.removeattribute.php - * @param string $qualifiedName - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string|null $namespace + * @param string $localName */ - public function removeAttribute (string $qualifiedName): bool {} + public function removeAttributeNS (?string $namespace = null, string $localName) {} /** - * Removes attribute - * @link http://www.php.net/manual/en/domelement.removeattributens.php - * @param string|null $namespace - * @param string $localName - * @return void No value is returned. + * {@inheritdoc} + * @param DOMAttr $attr */ - public function removeAttributeNS (?string $namespace, string $localName): void {} + public function removeAttributeNode (DOMAttr $attr) {} /** - * Removes attribute - * @link http://www.php.net/manual/en/domelement.removeattributenode.php - * @param DOMAttr $attr - * @return DOMAttr|false Returns true on success or false on failure. + * {@inheritdoc} + * @param string $qualifiedName + * @param string $value */ - public function removeAttributeNode (DOMAttr $attr): DOMAttr|false {} + public function setAttribute (string $qualifiedName, string $value) {} /** - * Adds new or modifies existing attribute - * @link http://www.php.net/manual/en/domelement.setattribute.php - * @param string $qualifiedName - * @param string $value - * @return DOMAttr|bool The created or modified DOMAttr or false if an error occurred. + * {@inheritdoc} + * @param string|null $namespace + * @param string $qualifiedName + * @param string $value */ - public function setAttribute (string $qualifiedName, string $value): DOMAttr|bool {} + public function setAttributeNS (?string $namespace = null, string $qualifiedName, string $value) {} /** - * Adds new attribute - * @link http://www.php.net/manual/en/domelement.setattributens.php - * @param string|null $namespace - * @param string $qualifiedName - * @param string $value - * @return void No value is returned. + * {@inheritdoc} + * @param DOMAttr $attr */ - public function setAttributeNS (?string $namespace, string $qualifiedName, string $value): void {} + public function setAttributeNode (DOMAttr $attr) {} /** - * Adds new attribute node to element - * @link http://www.php.net/manual/en/domelement.setattributenode.php - * @param DOMAttr $attr - * @return DOMAttr|null|false Returns old node if the attribute has been replaced or null. + * {@inheritdoc} + * @param DOMAttr $attr */ - public function setAttributeNode (DOMAttr $attr): DOMAttr|null|false {} + public function setAttributeNodeNS (DOMAttr $attr) {} /** - * Adds new attribute node to element - * @link http://www.php.net/manual/en/domelement.setattributenodens.php - * @param DOMAttr $attr - * @return DOMAttr|null|false Returns the old node if the attribute has been replaced. + * {@inheritdoc} + * @param string $qualifiedName + * @param bool $isId */ - public function setAttributeNodeNS (DOMAttr $attr): DOMAttr|null|false {} + public function setIdAttribute (string $qualifiedName, bool $isId) {} /** - * Declares the attribute specified by name to be of type ID - * @link http://www.php.net/manual/en/domelement.setidattribute.php - * @param string $qualifiedName - * @param bool $isId - * @return void No value is returned. + * {@inheritdoc} + * @param string $namespace + * @param string $qualifiedName + * @param bool $isId */ - public function setIdAttribute (string $qualifiedName, bool $isId): void {} + public function setIdAttributeNS (string $namespace, string $qualifiedName, bool $isId) {} /** - * Declares the attribute specified by local name and namespace URI to be of type ID - * @link http://www.php.net/manual/en/domelement.setidattributens.php - * @param string $namespace - * @param string $qualifiedName - * @param bool $isId - * @return void No value is returned. + * {@inheritdoc} + * @param DOMAttr $attr + * @param bool $isId */ - public function setIdAttributeNS (string $namespace, string $qualifiedName, bool $isId): void {} + public function setIdAttributeNode (DOMAttr $attr, bool $isId) {} /** - * Declares the attribute specified by node to be of type ID - * @link http://www.php.net/manual/en/domelement.setidattributenode.php - * @param DOMAttr $attr - * @param bool $isId - * @return void No value is returned. + * {@inheritdoc} + * @param string $qualifiedName + * @param bool|null $force [optional] */ - public function setIdAttributeNode (DOMAttr $attr, bool $isId): void {} + public function toggleAttribute (string $qualifiedName, ?bool $force = NULL): bool {} /** * {@inheritdoc} @@ -2139,246 +1553,425 @@ public function append (...$nodes): void {} public function prepend (...$nodes): void {} /** - * Adds new child at the end of the children - * @link http://www.php.net/manual/en/domnode.appendchild.php - * @param DOMNode $node - * @return DOMNode|false The node added or false on error. + * {@inheritdoc} + * @param mixed $nodes [optional] */ - public function appendChild (DOMNode $node): DOMNode|false {} + public function replaceChildren (...$nodes): void {} /** - * Canonicalize nodes to a string - * @link http://www.php.net/manual/en/domnode.c14n.php - * @param bool $exclusive [optional] Enable exclusive parsing of only the nodes matched by the provided - * xpath or namespace prefixes. - * @param bool $withComments [optional] Retain comments in output. - * @param array|null $xpath [optional] An array of xpaths to filter the nodes by. - * @param array|null $nsPrefixes [optional] An array of namespace prefixes to filter the nodes by. - * @return string|false Returns canonicalized nodes as a string or false on failure + * {@inheritdoc} + * @param string $where + * @param DOMElement $element */ - public function C14N (bool $exclusive = false, bool $withComments = false, ?array $xpath = null, ?array $nsPrefixes = null): string|false {} + public function insertAdjacentElement (string $where, DOMElement $element): ?DOMElement {} /** - * Canonicalize nodes to a file - * @link http://www.php.net/manual/en/domnode.c14nfile.php - * @param string $uri Path to write the output to. - * @param bool $exclusive [optional] Enable exclusive parsing of only the nodes matched by the provided - * xpath or namespace prefixes. - * @param bool $withComments [optional] Retain comments in output. - * @param array|null $xpath [optional] An array of xpaths to filter the nodes by. - * @param array|null $nsPrefixes [optional] An array of namespace prefixes to filter the nodes by. - * @return int|false Number of bytes written or false on failure + * {@inheritdoc} + * @param string $where + * @param string $data */ - public function C14NFile (string $uri, bool $exclusive = false, bool $withComments = false, ?array $xpath = null, ?array $nsPrefixes = null): int|false {} + public function insertAdjacentText (string $where, string $data): void {} /** - * Clones a node - * @link http://www.php.net/manual/en/domnode.clonenode.php - * @param bool $deep [optional] - * @return DOMNode|false The cloned node. + * {@inheritdoc} */ - public function cloneNode (bool $deep = false): DOMNode|false {} + public function __sleep (): array {} /** - * Get line number for a node - * @link http://www.php.net/manual/en/domnode.getlineno.php - * @return int Always returns the line number where the node was defined in. + * {@inheritdoc} */ - public function getLineNo (): int {} + public function __wakeup (): void {} /** - * Get an XPath for a node - * @link http://www.php.net/manual/en/domnode.getnodepath.php - * @return string|null Returns a string containing the XPath, or null in case of an error. + * {@inheritdoc} + * @param DOMNode $node */ - public function getNodePath (): ?string {} + public function appendChild (DOMNode $node) {} /** - * Checks if node has attributes - * @link http://www.php.net/manual/en/domnode.hasattributes.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param bool $exclusive [optional] + * @param bool $withComments [optional] + * @param array|null $xpath [optional] + * @param array|null $nsPrefixes [optional] */ - public function hasAttributes (): bool {} + public function C14N (bool $exclusive = false, bool $withComments = false, ?array $xpath = NULL, ?array $nsPrefixes = NULL) {} /** - * Checks if node has children - * @link http://www.php.net/manual/en/domnode.haschildnodes.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $uri + * @param bool $exclusive [optional] + * @param bool $withComments [optional] + * @param array|null $xpath [optional] + * @param array|null $nsPrefixes [optional] */ - public function hasChildNodes (): bool {} + public function C14NFile (string $uri, bool $exclusive = false, bool $withComments = false, ?array $xpath = NULL, ?array $nsPrefixes = NULL) {} /** - * Adds a new child before a reference node - * @link http://www.php.net/manual/en/domnode.insertbefore.php - * @param DOMNode $node - * @param DOMNode|null $child [optional] - * @return DOMNode|false The inserted node or false on error. + * {@inheritdoc} + * @param bool $deep [optional] */ - public function insertBefore (DOMNode $node, ?DOMNode $child = null): DOMNode|false {} + public function cloneNode (bool $deep = false) {} /** - * Checks if the specified namespaceURI is the default namespace or not - * @link http://www.php.net/manual/en/domnode.isdefaultnamespace.php - * @param string $namespace - * @return bool Return true if namespace is the default - * namespace, false otherwise. + * {@inheritdoc} */ - public function isDefaultNamespace (string $namespace): bool {} + public function getLineNo () {} /** - * Indicates if two nodes are the same node - * @link http://www.php.net/manual/en/domnode.issamenode.php - * @param DOMNode $otherNode - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function isSameNode (DOMNode $otherNode): bool {} + public function getNodePath () {} /** - * Checks if feature is supported for specified version - * @link http://www.php.net/manual/en/domnode.issupported.php - * @param string $feature - * @param string $version - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function isSupported (string $feature, string $version): bool {} + public function hasAttributes () {} /** - * Gets the namespace URI of the node based on the prefix - * @link http://www.php.net/manual/en/domnode.lookupnamespaceuri.php - * @param string $prefix - * @return string The namespace URI of the node. + * {@inheritdoc} */ - public function lookupNamespaceURI (string $prefix): string {} + public function hasChildNodes () {} /** - * Gets the namespace prefix of the node based on the namespace URI - * @link http://www.php.net/manual/en/domnode.lookupprefix.php - * @param string $namespace - * @return string|null The prefix of the namespace or null on error. + * {@inheritdoc} + * @param DOMNode $node + * @param DOMNode|null $child [optional] */ - public function lookupPrefix (string $namespace): ?string {} + public function insertBefore (DOMNode $node, ?DOMNode $child = NULL) {} /** - * Normalizes the node - * @link http://www.php.net/manual/en/domnode.normalize.php - * @return void No value is returned. + * {@inheritdoc} + * @param string $namespace */ - public function normalize (): void {} + public function isDefaultNamespace (string $namespace) {} /** - * Removes child from list of children - * @link http://www.php.net/manual/en/domnode.removechild.php - * @param DOMNode $child - * @return DOMNode|false If the child could be removed the function returns the old child or false on error. + * {@inheritdoc} + * @param DOMNode $otherNode */ - public function removeChild (DOMNode $child): DOMNode|false {} + public function isSameNode (DOMNode $otherNode) {} /** - * Replaces a child - * @link http://www.php.net/manual/en/domnode.replacechild.php - * @param DOMNode $node - * @param DOMNode $child - * @return DOMNode|false The old node or false if an error occur. + * {@inheritdoc} + * @param DOMNode|null $otherNode */ - public function replaceChild (DOMNode $node, DOMNode $child): DOMNode|false {} + public function isEqualNode (?DOMNode $otherNode = null): bool {} + + /** + * {@inheritdoc} + * @param string $feature + * @param string $version + */ + public function isSupported (string $feature, string $version) {} + + /** + * {@inheritdoc} + * @param string|null $prefix + */ + public function lookupNamespaceURI (?string $prefix = null) {} + + /** + * {@inheritdoc} + * @param string $namespace + */ + public function lookupPrefix (string $namespace) {} + + /** + * {@inheritdoc} + */ + public function normalize () {} + + /** + * {@inheritdoc} + * @param DOMNode $child + */ + public function removeChild (DOMNode $child) {} + + /** + * {@inheritdoc} + * @param DOMNode $node + * @param DOMNode $child + */ + public function replaceChild (DOMNode $node, DOMNode $child) {} + + /** + * {@inheritdoc} + * @param DOMNode|DOMNameSpaceNode|null $other + */ + public function contains (DOMNode|DOMNameSpaceNode|null $other = null): bool {} + + /** + * {@inheritdoc} + * @param array|null $options [optional] + */ + public function getRootNode (?array $options = NULL): DOMNode {} } -/** - * The DOMText class inherits from - * DOMCharacterData and represents the textual - * content of a DOMElement or - * DOMAttr. - * @link http://www.php.net/manual/en/class.domtext.php - */ class DOMText extends DOMCharacterData implements DOMChildNode { + public string $wholeText; + + /** + * {@inheritdoc} + * @param string $data [optional] + */ + public function __construct (string $data = '') {} + + /** + * {@inheritdoc} + */ + public function isWhitespaceInElementContent () {} + + /** + * {@inheritdoc} + */ + public function isElementContentWhitespace () {} + + /** + * {@inheritdoc} + * @param int $offset + */ + public function splitText (int $offset) {} + + /** + * {@inheritdoc} + * @param string $data + */ + public function appendData (string $data) {} + + /** + * {@inheritdoc} + * @param int $offset + * @param int $count + */ + public function substringData (int $offset, int $count) {} + + /** + * {@inheritdoc} + * @param int $offset + * @param string $data + */ + public function insertData (int $offset, string $data) {} + + /** + * {@inheritdoc} + * @param int $offset + * @param int $count + */ + public function deleteData (int $offset, int $count) {} + + /** + * {@inheritdoc} + * @param int $offset + * @param int $count + * @param string $data + */ + public function replaceData (int $offset, int $count, string $data) {} + + /** + * {@inheritdoc} + * @param mixed $nodes [optional] + */ + public function replaceWith (...$nodes): void {} + + /** + * {@inheritdoc} + */ + public function remove (): void {} + + /** + * {@inheritdoc} + * @param mixed $nodes [optional] + */ + public function before (...$nodes): void {} + + /** + * {@inheritdoc} + * @param mixed $nodes [optional] + */ + public function after (...$nodes): void {} + + /** + * {@inheritdoc} + */ + public function __sleep (): array {} + + /** + * {@inheritdoc} + */ + public function __wakeup (): void {} + + /** + * {@inheritdoc} + * @param DOMNode $node + */ + public function appendChild (DOMNode $node) {} + + /** + * {@inheritdoc} + * @param bool $exclusive [optional] + * @param bool $withComments [optional] + * @param array|null $xpath [optional] + * @param array|null $nsPrefixes [optional] + */ + public function C14N (bool $exclusive = false, bool $withComments = false, ?array $xpath = NULL, ?array $nsPrefixes = NULL) {} + + /** + * {@inheritdoc} + * @param string $uri + * @param bool $exclusive [optional] + * @param bool $withComments [optional] + * @param array|null $xpath [optional] + * @param array|null $nsPrefixes [optional] + */ + public function C14NFile (string $uri, bool $exclusive = false, bool $withComments = false, ?array $xpath = NULL, ?array $nsPrefixes = NULL) {} + + /** + * {@inheritdoc} + * @param bool $deep [optional] + */ + public function cloneNode (bool $deep = false) {} + + /** + * {@inheritdoc} + */ + public function getLineNo () {} + + /** + * {@inheritdoc} + */ + public function getNodePath () {} + + /** + * {@inheritdoc} + */ + public function hasAttributes () {} + + /** + * {@inheritdoc} + */ + public function hasChildNodes () {} + /** - * Holds all the text of logically-adjacent (not separated by Element, - * Comment or Processing Instruction) Text nodes. - * @var string - * @link http://www.php.net/manual/en/class.domtext.php#domtext.props.wholetext + * {@inheritdoc} + * @param DOMNode $node + * @param DOMNode|null $child [optional] + */ + public function insertBefore (DOMNode $node, ?DOMNode $child = NULL) {} + + /** + * {@inheritdoc} + * @param string $namespace + */ + public function isDefaultNamespace (string $namespace) {} + + /** + * {@inheritdoc} + * @param DOMNode $otherNode */ - public readonly string $wholeText; + public function isSameNode (DOMNode $otherNode) {} /** - * Creates a new DOMText object - * @link http://www.php.net/manual/en/domtext.construct.php - * @param string $data [optional] - * @return string + * {@inheritdoc} + * @param DOMNode|null $otherNode */ - public function __construct (string $data = '""'): string {} + public function isEqualNode (?DOMNode $otherNode = null): bool {} /** - * Indicates whether this text node contains whitespace - * @link http://www.php.net/manual/en/domtext.iswhitespaceinelementcontent.php - * @return bool Returns true if node contains zero or more whitespace characters and - * nothing else. Returns false otherwise. + * {@inheritdoc} + * @param string $feature + * @param string $version */ - public function isWhitespaceInElementContent (): bool {} + public function isSupported (string $feature, string $version) {} /** - * Returns whether this text node contains whitespace in element content - * @link http://www.php.net/manual/en/domtext.iselementcontentwhitespace.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string|null $prefix */ - public function isElementContentWhitespace (): bool {} + public function lookupNamespaceURI (?string $prefix = null) {} /** - * Breaks this node into two nodes at the specified offset - * @link http://www.php.net/manual/en/domtext.splittext.php - * @param int $offset - * @return DOMText|false The new node of the same type, which contains all the content at and after the - * offset. + * {@inheritdoc} + * @param string $namespace */ - public function splitText (int $offset): DOMText|false {} + public function lookupPrefix (string $namespace) {} /** - * Append the string to the end of the character data of the node - * @link http://www.php.net/manual/en/domcharacterdata.appenddata.php - * @param string $data - * @return true Always returns true. + * {@inheritdoc} */ - public function appendData (string $data): true {} + public function normalize () {} /** - * Extracts a range of data from the node - * @link http://www.php.net/manual/en/domcharacterdata.substringdata.php - * @param int $offset - * @param int $count - * @return string|false The specified substring. If the sum of offset - * and count exceeds the length, then all 16-bit units - * to the end of the data are returned. + * {@inheritdoc} + * @param DOMNode $child */ - public function substringData (int $offset, int $count): string|false {} + public function removeChild (DOMNode $child) {} /** - * Insert a string at the specified 16-bit unit offset - * @link http://www.php.net/manual/en/domcharacterdata.insertdata.php - * @param int $offset - * @param string $data - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param DOMNode $node + * @param DOMNode $child */ - public function insertData (int $offset, string $data): bool {} + public function replaceChild (DOMNode $node, DOMNode $child) {} /** - * Remove a range of characters from the node - * @link http://www.php.net/manual/en/domcharacterdata.deletedata.php - * @param int $offset - * @param int $count - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param DOMNode|DOMNameSpaceNode|null $other */ - public function deleteData (int $offset, int $count): bool {} + public function contains (DOMNode|DOMNameSpaceNode|null $other = null): bool {} /** - * Replace a substring within the DOMCharacterData node - * @link http://www.php.net/manual/en/domcharacterdata.replacedata.php - * @param int $offset - * @param int $count - * @param string $data - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param array|null $options [optional] */ - public function replaceData (int $offset, int $count, string $data): bool {} + public function getRootNode (?array $options = NULL): DOMNode {} + +} + +class DOMComment extends DOMCharacterData implements DOMChildNode { + + /** + * {@inheritdoc} + * @param string $data [optional] + */ + public function __construct (string $data = '') {} + + /** + * {@inheritdoc} + * @param string $data + */ + public function appendData (string $data) {} + + /** + * {@inheritdoc} + * @param int $offset + * @param int $count + */ + public function substringData (int $offset, int $count) {} + + /** + * {@inheritdoc} + * @param int $offset + * @param string $data + */ + public function insertData (int $offset, string $data) {} + + /** + * {@inheritdoc} + * @param int $offset + * @param int $count + */ + public function deleteData (int $offset, int $count) {} + + /** + * {@inheritdoc} + * @param int $offset + * @param int $count + * @param string $data + */ + public function replaceData (int $offset, int $count, string $data) {} /** * {@inheritdoc} @@ -2404,212 +1997,200 @@ public function before (...$nodes): void {} public function after (...$nodes): void {} /** - * Adds new child at the end of the children - * @link http://www.php.net/manual/en/domnode.appendchild.php - * @param DOMNode $node - * @return DOMNode|false The node added or false on error. + * {@inheritdoc} + */ + public function __sleep (): array {} + + /** + * {@inheritdoc} + */ + public function __wakeup (): void {} + + /** + * {@inheritdoc} + * @param DOMNode $node */ - public function appendChild (DOMNode $node): DOMNode|false {} + public function appendChild (DOMNode $node) {} /** - * Canonicalize nodes to a string - * @link http://www.php.net/manual/en/domnode.c14n.php - * @param bool $exclusive [optional] Enable exclusive parsing of only the nodes matched by the provided - * xpath or namespace prefixes. - * @param bool $withComments [optional] Retain comments in output. - * @param array|null $xpath [optional] An array of xpaths to filter the nodes by. - * @param array|null $nsPrefixes [optional] An array of namespace prefixes to filter the nodes by. - * @return string|false Returns canonicalized nodes as a string or false on failure + * {@inheritdoc} + * @param bool $exclusive [optional] + * @param bool $withComments [optional] + * @param array|null $xpath [optional] + * @param array|null $nsPrefixes [optional] */ - public function C14N (bool $exclusive = false, bool $withComments = false, ?array $xpath = null, ?array $nsPrefixes = null): string|false {} + public function C14N (bool $exclusive = false, bool $withComments = false, ?array $xpath = NULL, ?array $nsPrefixes = NULL) {} /** - * Canonicalize nodes to a file - * @link http://www.php.net/manual/en/domnode.c14nfile.php - * @param string $uri Path to write the output to. - * @param bool $exclusive [optional] Enable exclusive parsing of only the nodes matched by the provided - * xpath or namespace prefixes. - * @param bool $withComments [optional] Retain comments in output. - * @param array|null $xpath [optional] An array of xpaths to filter the nodes by. - * @param array|null $nsPrefixes [optional] An array of namespace prefixes to filter the nodes by. - * @return int|false Number of bytes written or false on failure + * {@inheritdoc} + * @param string $uri + * @param bool $exclusive [optional] + * @param bool $withComments [optional] + * @param array|null $xpath [optional] + * @param array|null $nsPrefixes [optional] */ - public function C14NFile (string $uri, bool $exclusive = false, bool $withComments = false, ?array $xpath = null, ?array $nsPrefixes = null): int|false {} + public function C14NFile (string $uri, bool $exclusive = false, bool $withComments = false, ?array $xpath = NULL, ?array $nsPrefixes = NULL) {} /** - * Clones a node - * @link http://www.php.net/manual/en/domnode.clonenode.php - * @param bool $deep [optional] - * @return DOMNode|false The cloned node. + * {@inheritdoc} + * @param bool $deep [optional] */ - public function cloneNode (bool $deep = false): DOMNode|false {} + public function cloneNode (bool $deep = false) {} /** - * Get line number for a node - * @link http://www.php.net/manual/en/domnode.getlineno.php - * @return int Always returns the line number where the node was defined in. + * {@inheritdoc} */ - public function getLineNo (): int {} + public function getLineNo () {} /** - * Get an XPath for a node - * @link http://www.php.net/manual/en/domnode.getnodepath.php - * @return string|null Returns a string containing the XPath, or null in case of an error. + * {@inheritdoc} */ - public function getNodePath (): ?string {} + public function getNodePath () {} /** - * Checks if node has attributes - * @link http://www.php.net/manual/en/domnode.hasattributes.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function hasAttributes (): bool {} + public function hasAttributes () {} /** - * Checks if node has children - * @link http://www.php.net/manual/en/domnode.haschildnodes.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function hasChildNodes (): bool {} + public function hasChildNodes () {} /** - * Adds a new child before a reference node - * @link http://www.php.net/manual/en/domnode.insertbefore.php - * @param DOMNode $node - * @param DOMNode|null $child [optional] - * @return DOMNode|false The inserted node or false on error. + * {@inheritdoc} + * @param DOMNode $node + * @param DOMNode|null $child [optional] */ - public function insertBefore (DOMNode $node, ?DOMNode $child = null): DOMNode|false {} + public function insertBefore (DOMNode $node, ?DOMNode $child = NULL) {} /** - * Checks if the specified namespaceURI is the default namespace or not - * @link http://www.php.net/manual/en/domnode.isdefaultnamespace.php - * @param string $namespace - * @return bool Return true if namespace is the default - * namespace, false otherwise. + * {@inheritdoc} + * @param string $namespace */ - public function isDefaultNamespace (string $namespace): bool {} + public function isDefaultNamespace (string $namespace) {} /** - * Indicates if two nodes are the same node - * @link http://www.php.net/manual/en/domnode.issamenode.php - * @param DOMNode $otherNode - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param DOMNode $otherNode */ - public function isSameNode (DOMNode $otherNode): bool {} + public function isSameNode (DOMNode $otherNode) {} /** - * Checks if feature is supported for specified version - * @link http://www.php.net/manual/en/domnode.issupported.php - * @param string $feature - * @param string $version - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param DOMNode|null $otherNode */ - public function isSupported (string $feature, string $version): bool {} + public function isEqualNode (?DOMNode $otherNode = null): bool {} /** - * Gets the namespace URI of the node based on the prefix - * @link http://www.php.net/manual/en/domnode.lookupnamespaceuri.php - * @param string $prefix - * @return string The namespace URI of the node. + * {@inheritdoc} + * @param string $feature + * @param string $version */ - public function lookupNamespaceURI (string $prefix): string {} + public function isSupported (string $feature, string $version) {} /** - * Gets the namespace prefix of the node based on the namespace URI - * @link http://www.php.net/manual/en/domnode.lookupprefix.php - * @param string $namespace - * @return string|null The prefix of the namespace or null on error. + * {@inheritdoc} + * @param string|null $prefix */ - public function lookupPrefix (string $namespace): ?string {} + public function lookupNamespaceURI (?string $prefix = null) {} /** - * Normalizes the node - * @link http://www.php.net/manual/en/domnode.normalize.php - * @return void No value is returned. + * {@inheritdoc} + * @param string $namespace */ - public function normalize (): void {} + public function lookupPrefix (string $namespace) {} /** - * Removes child from list of children - * @link http://www.php.net/manual/en/domnode.removechild.php - * @param DOMNode $child - * @return DOMNode|false If the child could be removed the function returns the old child or false on error. + * {@inheritdoc} */ - public function removeChild (DOMNode $child): DOMNode|false {} + public function normalize () {} /** - * Replaces a child - * @link http://www.php.net/manual/en/domnode.replacechild.php - * @param DOMNode $node - * @param DOMNode $child - * @return DOMNode|false The old node or false if an error occur. + * {@inheritdoc} + * @param DOMNode $child */ - public function replaceChild (DOMNode $node, DOMNode $child): DOMNode|false {} + public function removeChild (DOMNode $child) {} + + /** + * {@inheritdoc} + * @param DOMNode $node + * @param DOMNode $child + */ + public function replaceChild (DOMNode $node, DOMNode $child) {} + + /** + * {@inheritdoc} + * @param DOMNode|DOMNameSpaceNode|null $other + */ + public function contains (DOMNode|DOMNameSpaceNode|null $other = null): bool {} + + /** + * {@inheritdoc} + * @param array|null $options [optional] + */ + public function getRootNode (?array $options = NULL): DOMNode {} } -/** - * Represents comment nodes, characters delimited by <!-- - * and -->. - * @link http://www.php.net/manual/en/class.domcomment.php - */ -class DOMComment extends DOMCharacterData implements DOMChildNode { +class DOMCdataSection extends DOMText implements DOMChildNode { /** - * Creates a new DOMComment object - * @link http://www.php.net/manual/en/domcomment.construct.php - * @param string $data [optional] - * @return string + * {@inheritdoc} + * @param string $data */ - public function __construct (string $data = '""'): string {} + public function __construct (string $data) {} /** - * Append the string to the end of the character data of the node - * @link http://www.php.net/manual/en/domcharacterdata.appenddata.php - * @param string $data - * @return true Always returns true. + * {@inheritdoc} + */ + public function isWhitespaceInElementContent () {} + + /** + * {@inheritdoc} + */ + public function isElementContentWhitespace () {} + + /** + * {@inheritdoc} + * @param int $offset + */ + public function splitText (int $offset) {} + + /** + * {@inheritdoc} + * @param string $data */ - public function appendData (string $data): true {} + public function appendData (string $data) {} /** - * Extracts a range of data from the node - * @link http://www.php.net/manual/en/domcharacterdata.substringdata.php - * @param int $offset - * @param int $count - * @return string|false The specified substring. If the sum of offset - * and count exceeds the length, then all 16-bit units - * to the end of the data are returned. + * {@inheritdoc} + * @param int $offset + * @param int $count */ - public function substringData (int $offset, int $count): string|false {} + public function substringData (int $offset, int $count) {} /** - * Insert a string at the specified 16-bit unit offset - * @link http://www.php.net/manual/en/domcharacterdata.insertdata.php - * @param int $offset - * @param string $data - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $offset + * @param string $data */ - public function insertData (int $offset, string $data): bool {} + public function insertData (int $offset, string $data) {} /** - * Remove a range of characters from the node - * @link http://www.php.net/manual/en/domcharacterdata.deletedata.php - * @param int $offset - * @param int $count - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $offset + * @param int $count */ - public function deleteData (int $offset, int $count): bool {} + public function deleteData (int $offset, int $count) {} /** - * Replace a substring within the DOMCharacterData node - * @link http://www.php.net/manual/en/domcharacterdata.replacedata.php - * @param int $offset - * @param int $count - * @param string $data - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $offset + * @param int $count + * @param string $data */ - public function replaceData (int $offset, int $count, string $data): bool {} + public function replaceData (int $offset, int $count, string $data) {} /** * {@inheritdoc} @@ -2635,1368 +2216,929 @@ public function before (...$nodes): void {} public function after (...$nodes): void {} /** - * Adds new child at the end of the children - * @link http://www.php.net/manual/en/domnode.appendchild.php - * @param DOMNode $node - * @return DOMNode|false The node added or false on error. + * {@inheritdoc} */ - public function appendChild (DOMNode $node): DOMNode|false {} + public function __sleep (): array {} /** - * Canonicalize nodes to a string - * @link http://www.php.net/manual/en/domnode.c14n.php - * @param bool $exclusive [optional] Enable exclusive parsing of only the nodes matched by the provided - * xpath or namespace prefixes. - * @param bool $withComments [optional] Retain comments in output. - * @param array|null $xpath [optional] An array of xpaths to filter the nodes by. - * @param array|null $nsPrefixes [optional] An array of namespace prefixes to filter the nodes by. - * @return string|false Returns canonicalized nodes as a string or false on failure + * {@inheritdoc} */ - public function C14N (bool $exclusive = false, bool $withComments = false, ?array $xpath = null, ?array $nsPrefixes = null): string|false {} + public function __wakeup (): void {} /** - * Canonicalize nodes to a file - * @link http://www.php.net/manual/en/domnode.c14nfile.php - * @param string $uri Path to write the output to. - * @param bool $exclusive [optional] Enable exclusive parsing of only the nodes matched by the provided - * xpath or namespace prefixes. - * @param bool $withComments [optional] Retain comments in output. - * @param array|null $xpath [optional] An array of xpaths to filter the nodes by. - * @param array|null $nsPrefixes [optional] An array of namespace prefixes to filter the nodes by. - * @return int|false Number of bytes written or false on failure + * {@inheritdoc} + * @param DOMNode $node */ - public function C14NFile (string $uri, bool $exclusive = false, bool $withComments = false, ?array $xpath = null, ?array $nsPrefixes = null): int|false {} + public function appendChild (DOMNode $node) {} /** - * Clones a node - * @link http://www.php.net/manual/en/domnode.clonenode.php - * @param bool $deep [optional] - * @return DOMNode|false The cloned node. + * {@inheritdoc} + * @param bool $exclusive [optional] + * @param bool $withComments [optional] + * @param array|null $xpath [optional] + * @param array|null $nsPrefixes [optional] */ - public function cloneNode (bool $deep = false): DOMNode|false {} + public function C14N (bool $exclusive = false, bool $withComments = false, ?array $xpath = NULL, ?array $nsPrefixes = NULL) {} /** - * Get line number for a node - * @link http://www.php.net/manual/en/domnode.getlineno.php - * @return int Always returns the line number where the node was defined in. + * {@inheritdoc} + * @param string $uri + * @param bool $exclusive [optional] + * @param bool $withComments [optional] + * @param array|null $xpath [optional] + * @param array|null $nsPrefixes [optional] */ - public function getLineNo (): int {} + public function C14NFile (string $uri, bool $exclusive = false, bool $withComments = false, ?array $xpath = NULL, ?array $nsPrefixes = NULL) {} /** - * Get an XPath for a node - * @link http://www.php.net/manual/en/domnode.getnodepath.php - * @return string|null Returns a string containing the XPath, or null in case of an error. + * {@inheritdoc} + * @param bool $deep [optional] */ - public function getNodePath (): ?string {} + public function cloneNode (bool $deep = false) {} /** - * Checks if node has attributes - * @link http://www.php.net/manual/en/domnode.hasattributes.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function hasAttributes (): bool {} + public function getLineNo () {} /** - * Checks if node has children - * @link http://www.php.net/manual/en/domnode.haschildnodes.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function hasChildNodes (): bool {} + public function getNodePath () {} /** - * Adds a new child before a reference node - * @link http://www.php.net/manual/en/domnode.insertbefore.php - * @param DOMNode $node - * @param DOMNode|null $child [optional] - * @return DOMNode|false The inserted node or false on error. + * {@inheritdoc} */ - public function insertBefore (DOMNode $node, ?DOMNode $child = null): DOMNode|false {} + public function hasAttributes () {} /** - * Checks if the specified namespaceURI is the default namespace or not - * @link http://www.php.net/manual/en/domnode.isdefaultnamespace.php - * @param string $namespace - * @return bool Return true if namespace is the default - * namespace, false otherwise. + * {@inheritdoc} */ - public function isDefaultNamespace (string $namespace): bool {} + public function hasChildNodes () {} /** - * Indicates if two nodes are the same node - * @link http://www.php.net/manual/en/domnode.issamenode.php - * @param DOMNode $otherNode - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param DOMNode $node + * @param DOMNode|null $child [optional] */ - public function isSameNode (DOMNode $otherNode): bool {} + public function insertBefore (DOMNode $node, ?DOMNode $child = NULL) {} /** - * Checks if feature is supported for specified version - * @link http://www.php.net/manual/en/domnode.issupported.php - * @param string $feature - * @param string $version - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $namespace */ - public function isSupported (string $feature, string $version): bool {} + public function isDefaultNamespace (string $namespace) {} /** - * Gets the namespace URI of the node based on the prefix - * @link http://www.php.net/manual/en/domnode.lookupnamespaceuri.php - * @param string $prefix - * @return string The namespace URI of the node. + * {@inheritdoc} + * @param DOMNode $otherNode */ - public function lookupNamespaceURI (string $prefix): string {} + public function isSameNode (DOMNode $otherNode) {} /** - * Gets the namespace prefix of the node based on the namespace URI - * @link http://www.php.net/manual/en/domnode.lookupprefix.php - * @param string $namespace - * @return string|null The prefix of the namespace or null on error. + * {@inheritdoc} + * @param DOMNode|null $otherNode */ - public function lookupPrefix (string $namespace): ?string {} + public function isEqualNode (?DOMNode $otherNode = null): bool {} /** - * Normalizes the node - * @link http://www.php.net/manual/en/domnode.normalize.php - * @return void No value is returned. + * {@inheritdoc} + * @param string $feature + * @param string $version */ - public function normalize (): void {} + public function isSupported (string $feature, string $version) {} /** - * Removes child from list of children - * @link http://www.php.net/manual/en/domnode.removechild.php - * @param DOMNode $child - * @return DOMNode|false If the child could be removed the function returns the old child or false on error. + * {@inheritdoc} + * @param string|null $prefix */ - public function removeChild (DOMNode $child): DOMNode|false {} + public function lookupNamespaceURI (?string $prefix = null) {} /** - * Replaces a child - * @link http://www.php.net/manual/en/domnode.replacechild.php - * @param DOMNode $node - * @param DOMNode $child - * @return DOMNode|false The old node or false if an error occur. + * {@inheritdoc} + * @param string $namespace */ - public function replaceChild (DOMNode $node, DOMNode $child): DOMNode|false {} - -} - -/** - * The DOMCdataSection inherits from - * DOMText for textural representation - * of CData constructs. - * @link http://www.php.net/manual/en/class.domcdatasection.php - */ -class DOMCdataSection extends DOMText implements DOMChildNode { + public function lookupPrefix (string $namespace) {} /** - * Constructs a new DOMCdataSection object - * @link http://www.php.net/manual/en/domcdatasection.construct.php - * @param string $data The value of the CDATA node. If not supplied, an empty CDATA node is created. - * @return string + * {@inheritdoc} */ - public function __construct (string $data): string {} + public function normalize () {} /** - * Indicates whether this text node contains whitespace - * @link http://www.php.net/manual/en/domtext.iswhitespaceinelementcontent.php - * @return bool Returns true if node contains zero or more whitespace characters and - * nothing else. Returns false otherwise. + * {@inheritdoc} + * @param DOMNode $child */ - public function isWhitespaceInElementContent (): bool {} + public function removeChild (DOMNode $child) {} /** - * Returns whether this text node contains whitespace in element content - * @link http://www.php.net/manual/en/domtext.iselementcontentwhitespace.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param DOMNode $node + * @param DOMNode $child */ - public function isElementContentWhitespace (): bool {} + public function replaceChild (DOMNode $node, DOMNode $child) {} /** - * Breaks this node into two nodes at the specified offset - * @link http://www.php.net/manual/en/domtext.splittext.php - * @param int $offset - * @return DOMText|false The new node of the same type, which contains all the content at and after the - * offset. + * {@inheritdoc} + * @param DOMNode|DOMNameSpaceNode|null $other */ - public function splitText (int $offset): DOMText|false {} + public function contains (DOMNode|DOMNameSpaceNode|null $other = null): bool {} /** - * Append the string to the end of the character data of the node - * @link http://www.php.net/manual/en/domcharacterdata.appenddata.php - * @param string $data - * @return true Always returns true. + * {@inheritdoc} + * @param array|null $options [optional] */ - public function appendData (string $data): true {} + public function getRootNode (?array $options = NULL): DOMNode {} - /** - * Extracts a range of data from the node - * @link http://www.php.net/manual/en/domcharacterdata.substringdata.php - * @param int $offset - * @param int $count - * @return string|false The specified substring. If the sum of offset - * and count exceeds the length, then all 16-bit units - * to the end of the data are returned. - */ - public function substringData (int $offset, int $count): string|false {} +} - /** - * Insert a string at the specified 16-bit unit offset - * @link http://www.php.net/manual/en/domcharacterdata.insertdata.php - * @param int $offset - * @param string $data - * @return bool Returns true on success or false on failure. - */ - public function insertData (int $offset, string $data): bool {} +class DOMDocumentType extends DOMNode { - /** - * Remove a range of characters from the node - * @link http://www.php.net/manual/en/domcharacterdata.deletedata.php - * @param int $offset - * @param int $count - * @return bool Returns true on success or false on failure. - */ - public function deleteData (int $offset, int $count): bool {} + public string $name; + + public DOMNamedNodeMap $entities; + + public DOMNamedNodeMap $notations; + + public string $publicId; + + public string $systemId; + + public ?string $internalSubset; /** - * Replace a substring within the DOMCharacterData node - * @link http://www.php.net/manual/en/domcharacterdata.replacedata.php - * @param int $offset - * @param int $count - * @param string $data - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function replaceData (int $offset, int $count, string $data): bool {} + public function __sleep (): array {} /** * {@inheritdoc} - * @param mixed $nodes [optional] */ - public function replaceWith (...$nodes): void {} + public function __wakeup (): void {} /** * {@inheritdoc} + * @param DOMNode $node */ - public function remove (): void {} + public function appendChild (DOMNode $node) {} /** * {@inheritdoc} - * @param mixed $nodes [optional] + * @param bool $exclusive [optional] + * @param bool $withComments [optional] + * @param array|null $xpath [optional] + * @param array|null $nsPrefixes [optional] */ - public function before (...$nodes): void {} + public function C14N (bool $exclusive = false, bool $withComments = false, ?array $xpath = NULL, ?array $nsPrefixes = NULL) {} /** * {@inheritdoc} - * @param mixed $nodes [optional] + * @param string $uri + * @param bool $exclusive [optional] + * @param bool $withComments [optional] + * @param array|null $xpath [optional] + * @param array|null $nsPrefixes [optional] */ - public function after (...$nodes): void {} + public function C14NFile (string $uri, bool $exclusive = false, bool $withComments = false, ?array $xpath = NULL, ?array $nsPrefixes = NULL) {} /** - * Adds new child at the end of the children - * @link http://www.php.net/manual/en/domnode.appendchild.php - * @param DOMNode $node - * @return DOMNode|false The node added or false on error. + * {@inheritdoc} + * @param bool $deep [optional] */ - public function appendChild (DOMNode $node): DOMNode|false {} + public function cloneNode (bool $deep = false) {} /** - * Canonicalize nodes to a string - * @link http://www.php.net/manual/en/domnode.c14n.php - * @param bool $exclusive [optional] Enable exclusive parsing of only the nodes matched by the provided - * xpath or namespace prefixes. - * @param bool $withComments [optional] Retain comments in output. - * @param array|null $xpath [optional] An array of xpaths to filter the nodes by. - * @param array|null $nsPrefixes [optional] An array of namespace prefixes to filter the nodes by. - * @return string|false Returns canonicalized nodes as a string or false on failure + * {@inheritdoc} */ - public function C14N (bool $exclusive = false, bool $withComments = false, ?array $xpath = null, ?array $nsPrefixes = null): string|false {} + public function getLineNo () {} /** - * Canonicalize nodes to a file - * @link http://www.php.net/manual/en/domnode.c14nfile.php - * @param string $uri Path to write the output to. - * @param bool $exclusive [optional] Enable exclusive parsing of only the nodes matched by the provided - * xpath or namespace prefixes. - * @param bool $withComments [optional] Retain comments in output. - * @param array|null $xpath [optional] An array of xpaths to filter the nodes by. - * @param array|null $nsPrefixes [optional] An array of namespace prefixes to filter the nodes by. - * @return int|false Number of bytes written or false on failure + * {@inheritdoc} */ - public function C14NFile (string $uri, bool $exclusive = false, bool $withComments = false, ?array $xpath = null, ?array $nsPrefixes = null): int|false {} + public function getNodePath () {} /** - * Clones a node - * @link http://www.php.net/manual/en/domnode.clonenode.php - * @param bool $deep [optional] - * @return DOMNode|false The cloned node. + * {@inheritdoc} */ - public function cloneNode (bool $deep = false): DOMNode|false {} + public function hasAttributes () {} /** - * Get line number for a node - * @link http://www.php.net/manual/en/domnode.getlineno.php - * @return int Always returns the line number where the node was defined in. + * {@inheritdoc} */ - public function getLineNo (): int {} + public function hasChildNodes () {} /** - * Get an XPath for a node - * @link http://www.php.net/manual/en/domnode.getnodepath.php - * @return string|null Returns a string containing the XPath, or null in case of an error. + * {@inheritdoc} + * @param DOMNode $node + * @param DOMNode|null $child [optional] */ - public function getNodePath (): ?string {} + public function insertBefore (DOMNode $node, ?DOMNode $child = NULL) {} /** - * Checks if node has attributes - * @link http://www.php.net/manual/en/domnode.hasattributes.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $namespace */ - public function hasAttributes (): bool {} + public function isDefaultNamespace (string $namespace) {} /** - * Checks if node has children - * @link http://www.php.net/manual/en/domnode.haschildnodes.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param DOMNode $otherNode */ - public function hasChildNodes (): bool {} + public function isSameNode (DOMNode $otherNode) {} /** - * Adds a new child before a reference node - * @link http://www.php.net/manual/en/domnode.insertbefore.php - * @param DOMNode $node - * @param DOMNode|null $child [optional] - * @return DOMNode|false The inserted node or false on error. + * {@inheritdoc} + * @param DOMNode|null $otherNode */ - public function insertBefore (DOMNode $node, ?DOMNode $child = null): DOMNode|false {} + public function isEqualNode (?DOMNode $otherNode = null): bool {} /** - * Checks if the specified namespaceURI is the default namespace or not - * @link http://www.php.net/manual/en/domnode.isdefaultnamespace.php - * @param string $namespace - * @return bool Return true if namespace is the default - * namespace, false otherwise. + * {@inheritdoc} + * @param string $feature + * @param string $version */ - public function isDefaultNamespace (string $namespace): bool {} + public function isSupported (string $feature, string $version) {} /** - * Indicates if two nodes are the same node - * @link http://www.php.net/manual/en/domnode.issamenode.php - * @param DOMNode $otherNode - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string|null $prefix */ - public function isSameNode (DOMNode $otherNode): bool {} + public function lookupNamespaceURI (?string $prefix = null) {} /** - * Checks if feature is supported for specified version - * @link http://www.php.net/manual/en/domnode.issupported.php - * @param string $feature - * @param string $version - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $namespace */ - public function isSupported (string $feature, string $version): bool {} + public function lookupPrefix (string $namespace) {} /** - * Gets the namespace URI of the node based on the prefix - * @link http://www.php.net/manual/en/domnode.lookupnamespaceuri.php - * @param string $prefix - * @return string The namespace URI of the node. + * {@inheritdoc} */ - public function lookupNamespaceURI (string $prefix): string {} + public function normalize () {} /** - * Gets the namespace prefix of the node based on the namespace URI - * @link http://www.php.net/manual/en/domnode.lookupprefix.php - * @param string $namespace - * @return string|null The prefix of the namespace or null on error. + * {@inheritdoc} + * @param DOMNode $child */ - public function lookupPrefix (string $namespace): ?string {} + public function removeChild (DOMNode $child) {} /** - * Normalizes the node - * @link http://www.php.net/manual/en/domnode.normalize.php - * @return void No value is returned. + * {@inheritdoc} + * @param DOMNode $node + * @param DOMNode $child */ - public function normalize (): void {} + public function replaceChild (DOMNode $node, DOMNode $child) {} /** - * Removes child from list of children - * @link http://www.php.net/manual/en/domnode.removechild.php - * @param DOMNode $child - * @return DOMNode|false If the child could be removed the function returns the old child or false on error. + * {@inheritdoc} + * @param DOMNode|DOMNameSpaceNode|null $other */ - public function removeChild (DOMNode $child): DOMNode|false {} + public function contains (DOMNode|DOMNameSpaceNode|null $other = null): bool {} /** - * Replaces a child - * @link http://www.php.net/manual/en/domnode.replacechild.php - * @param DOMNode $node - * @param DOMNode $child - * @return DOMNode|false The old node or false if an error occur. + * {@inheritdoc} + * @param array|null $options [optional] */ - public function replaceChild (DOMNode $node, DOMNode $child): DOMNode|false {} + public function getRootNode (?array $options = NULL): DOMNode {} } -/** - * Each DOMDocument has a doctype - * attribute whose value is either null or a DOMDocumentType object. - * @link http://www.php.net/manual/en/class.domdocumenttype.php - */ -class DOMDocumentType extends DOMNode { +class DOMNotation extends DOMNode { - /** - * The name of DTD; i.e., the name immediately following the - * DOCTYPE keyword. - * @var string - * @link http://www.php.net/manual/en/class.domdocumenttype.php#domdocumenttype.props.name - */ - public readonly string $name; + public string $publicId; + + public string $systemId; /** - * A DOMNamedNodeMap containing the general - * entities, both external and internal, declared in the DTD. - * @var DOMNamedNodeMap - * @link http://www.php.net/manual/en/class.domdocumenttype.php#domdocumenttype.props.entities + * {@inheritdoc} */ - public readonly DOMNamedNodeMap $entities; + public function __sleep (): array {} /** - * A DOMNamedNodeMap containing the notations - * declared in the DTD. - * @var DOMNamedNodeMap - * @link http://www.php.net/manual/en/class.domdocumenttype.php#domdocumenttype.props.notations + * {@inheritdoc} */ - public readonly DOMNamedNodeMap $notations; + public function __wakeup (): void {} /** - * The public identifier of the external subset. - * @var string - * @link http://www.php.net/manual/en/class.domdocumenttype.php#domdocumenttype.props.publicid + * {@inheritdoc} + * @param DOMNode $node */ - public readonly string $publicId; + public function appendChild (DOMNode $node) {} /** - * The system identifier of the external subset. This may be an - * absolute URI or not. - * @var string - * @link http://www.php.net/manual/en/class.domdocumenttype.php#domdocumenttype.props.systemid + * {@inheritdoc} + * @param bool $exclusive [optional] + * @param bool $withComments [optional] + * @param array|null $xpath [optional] + * @param array|null $nsPrefixes [optional] */ - public readonly string $systemId; + public function C14N (bool $exclusive = false, bool $withComments = false, ?array $xpath = NULL, ?array $nsPrefixes = NULL) {} /** - * The internal subset as a string, or null if there is none. This - * does not contain the delimiting square brackets. - * @var string|null - * @link http://www.php.net/manual/en/class.domdocumenttype.php#domdocumenttype.props.internalsubset + * {@inheritdoc} + * @param string $uri + * @param bool $exclusive [optional] + * @param bool $withComments [optional] + * @param array|null $xpath [optional] + * @param array|null $nsPrefixes [optional] */ - public readonly ?string $internalSubset; + public function C14NFile (string $uri, bool $exclusive = false, bool $withComments = false, ?array $xpath = NULL, ?array $nsPrefixes = NULL) {} /** - * Adds new child at the end of the children - * @link http://www.php.net/manual/en/domnode.appendchild.php - * @param DOMNode $node - * @return DOMNode|false The node added or false on error. + * {@inheritdoc} + * @param bool $deep [optional] */ - public function appendChild (DOMNode $node): DOMNode|false {} + public function cloneNode (bool $deep = false) {} /** - * Canonicalize nodes to a string - * @link http://www.php.net/manual/en/domnode.c14n.php - * @param bool $exclusive [optional] Enable exclusive parsing of only the nodes matched by the provided - * xpath or namespace prefixes. - * @param bool $withComments [optional] Retain comments in output. - * @param array|null $xpath [optional] An array of xpaths to filter the nodes by. - * @param array|null $nsPrefixes [optional] An array of namespace prefixes to filter the nodes by. - * @return string|false Returns canonicalized nodes as a string or false on failure + * {@inheritdoc} */ - public function C14N (bool $exclusive = false, bool $withComments = false, ?array $xpath = null, ?array $nsPrefixes = null): string|false {} + public function getLineNo () {} /** - * Canonicalize nodes to a file - * @link http://www.php.net/manual/en/domnode.c14nfile.php - * @param string $uri Path to write the output to. - * @param bool $exclusive [optional] Enable exclusive parsing of only the nodes matched by the provided - * xpath or namespace prefixes. - * @param bool $withComments [optional] Retain comments in output. - * @param array|null $xpath [optional] An array of xpaths to filter the nodes by. - * @param array|null $nsPrefixes [optional] An array of namespace prefixes to filter the nodes by. - * @return int|false Number of bytes written or false on failure + * {@inheritdoc} */ - public function C14NFile (string $uri, bool $exclusive = false, bool $withComments = false, ?array $xpath = null, ?array $nsPrefixes = null): int|false {} + public function getNodePath () {} /** - * Clones a node - * @link http://www.php.net/manual/en/domnode.clonenode.php - * @param bool $deep [optional] - * @return DOMNode|false The cloned node. + * {@inheritdoc} */ - public function cloneNode (bool $deep = false): DOMNode|false {} + public function hasAttributes () {} /** - * Get line number for a node - * @link http://www.php.net/manual/en/domnode.getlineno.php - * @return int Always returns the line number where the node was defined in. + * {@inheritdoc} */ - public function getLineNo (): int {} + public function hasChildNodes () {} /** - * Get an XPath for a node - * @link http://www.php.net/manual/en/domnode.getnodepath.php - * @return string|null Returns a string containing the XPath, or null in case of an error. + * {@inheritdoc} + * @param DOMNode $node + * @param DOMNode|null $child [optional] */ - public function getNodePath (): ?string {} + public function insertBefore (DOMNode $node, ?DOMNode $child = NULL) {} /** - * Checks if node has attributes - * @link http://www.php.net/manual/en/domnode.hasattributes.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $namespace */ - public function hasAttributes (): bool {} + public function isDefaultNamespace (string $namespace) {} /** - * Checks if node has children - * @link http://www.php.net/manual/en/domnode.haschildnodes.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param DOMNode $otherNode */ - public function hasChildNodes (): bool {} + public function isSameNode (DOMNode $otherNode) {} /** - * Adds a new child before a reference node - * @link http://www.php.net/manual/en/domnode.insertbefore.php - * @param DOMNode $node - * @param DOMNode|null $child [optional] - * @return DOMNode|false The inserted node or false on error. + * {@inheritdoc} + * @param DOMNode|null $otherNode */ - public function insertBefore (DOMNode $node, ?DOMNode $child = null): DOMNode|false {} + public function isEqualNode (?DOMNode $otherNode = null): bool {} /** - * Checks if the specified namespaceURI is the default namespace or not - * @link http://www.php.net/manual/en/domnode.isdefaultnamespace.php - * @param string $namespace - * @return bool Return true if namespace is the default - * namespace, false otherwise. + * {@inheritdoc} + * @param string $feature + * @param string $version */ - public function isDefaultNamespace (string $namespace): bool {} + public function isSupported (string $feature, string $version) {} /** - * Indicates if two nodes are the same node - * @link http://www.php.net/manual/en/domnode.issamenode.php - * @param DOMNode $otherNode - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string|null $prefix */ - public function isSameNode (DOMNode $otherNode): bool {} + public function lookupNamespaceURI (?string $prefix = null) {} /** - * Checks if feature is supported for specified version - * @link http://www.php.net/manual/en/domnode.issupported.php - * @param string $feature - * @param string $version - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $namespace */ - public function isSupported (string $feature, string $version): bool {} + public function lookupPrefix (string $namespace) {} /** - * Gets the namespace URI of the node based on the prefix - * @link http://www.php.net/manual/en/domnode.lookupnamespaceuri.php - * @param string $prefix - * @return string The namespace URI of the node. + * {@inheritdoc} */ - public function lookupNamespaceURI (string $prefix): string {} + public function normalize () {} /** - * Gets the namespace prefix of the node based on the namespace URI - * @link http://www.php.net/manual/en/domnode.lookupprefix.php - * @param string $namespace - * @return string|null The prefix of the namespace or null on error. + * {@inheritdoc} + * @param DOMNode $child */ - public function lookupPrefix (string $namespace): ?string {} + public function removeChild (DOMNode $child) {} /** - * Normalizes the node - * @link http://www.php.net/manual/en/domnode.normalize.php - * @return void No value is returned. + * {@inheritdoc} + * @param DOMNode $node + * @param DOMNode $child */ - public function normalize (): void {} + public function replaceChild (DOMNode $node, DOMNode $child) {} /** - * Removes child from list of children - * @link http://www.php.net/manual/en/domnode.removechild.php - * @param DOMNode $child - * @return DOMNode|false If the child could be removed the function returns the old child or false on error. + * {@inheritdoc} + * @param DOMNode|DOMNameSpaceNode|null $other */ - public function removeChild (DOMNode $child): DOMNode|false {} + public function contains (DOMNode|DOMNameSpaceNode|null $other = null): bool {} /** - * Replaces a child - * @link http://www.php.net/manual/en/domnode.replacechild.php - * @param DOMNode $node - * @param DOMNode $child - * @return DOMNode|false The old node or false if an error occur. + * {@inheritdoc} + * @param array|null $options [optional] */ - public function replaceChild (DOMNode $node, DOMNode $child): DOMNode|false {} + public function getRootNode (?array $options = NULL): DOMNode {} } -/** - * @link http://www.php.net/manual/en/class.domnotation.php - */ -class DOMNotation extends DOMNode { +class DOMEntity extends DOMNode { - public readonly string $publicId; + public ?string $publicId; - public readonly string $systemId; + public ?string $systemId; - /** - * Adds new child at the end of the children - * @link http://www.php.net/manual/en/domnode.appendchild.php - * @param DOMNode $node - * @return DOMNode|false The node added or false on error. - */ - public function appendChild (DOMNode $node): DOMNode|false {} + public ?string $notationName; - /** - * Canonicalize nodes to a string - * @link http://www.php.net/manual/en/domnode.c14n.php - * @param bool $exclusive [optional] Enable exclusive parsing of only the nodes matched by the provided - * xpath or namespace prefixes. - * @param bool $withComments [optional] Retain comments in output. - * @param array|null $xpath [optional] An array of xpaths to filter the nodes by. - * @param array|null $nsPrefixes [optional] An array of namespace prefixes to filter the nodes by. - * @return string|false Returns canonicalized nodes as a string or false on failure - */ - public function C14N (bool $exclusive = false, bool $withComments = false, ?array $xpath = null, ?array $nsPrefixes = null): string|false {} + public ?string $actualEncoding; - /** - * Canonicalize nodes to a file - * @link http://www.php.net/manual/en/domnode.c14nfile.php - * @param string $uri Path to write the output to. - * @param bool $exclusive [optional] Enable exclusive parsing of only the nodes matched by the provided - * xpath or namespace prefixes. - * @param bool $withComments [optional] Retain comments in output. - * @param array|null $xpath [optional] An array of xpaths to filter the nodes by. - * @param array|null $nsPrefixes [optional] An array of namespace prefixes to filter the nodes by. - * @return int|false Number of bytes written or false on failure - */ - public function C14NFile (string $uri, bool $exclusive = false, bool $withComments = false, ?array $xpath = null, ?array $nsPrefixes = null): int|false {} + public ?string $encoding; - /** - * Clones a node - * @link http://www.php.net/manual/en/domnode.clonenode.php - * @param bool $deep [optional] - * @return DOMNode|false The cloned node. - */ - public function cloneNode (bool $deep = false): DOMNode|false {} + public ?string $version; /** - * Get line number for a node - * @link http://www.php.net/manual/en/domnode.getlineno.php - * @return int Always returns the line number where the node was defined in. + * {@inheritdoc} */ - public function getLineNo (): int {} + public function __sleep (): array {} /** - * Get an XPath for a node - * @link http://www.php.net/manual/en/domnode.getnodepath.php - * @return string|null Returns a string containing the XPath, or null in case of an error. + * {@inheritdoc} */ - public function getNodePath (): ?string {} + public function __wakeup (): void {} /** - * Checks if node has attributes - * @link http://www.php.net/manual/en/domnode.hasattributes.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param DOMNode $node */ - public function hasAttributes (): bool {} + public function appendChild (DOMNode $node) {} /** - * Checks if node has children - * @link http://www.php.net/manual/en/domnode.haschildnodes.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param bool $exclusive [optional] + * @param bool $withComments [optional] + * @param array|null $xpath [optional] + * @param array|null $nsPrefixes [optional] */ - public function hasChildNodes (): bool {} + public function C14N (bool $exclusive = false, bool $withComments = false, ?array $xpath = NULL, ?array $nsPrefixes = NULL) {} /** - * Adds a new child before a reference node - * @link http://www.php.net/manual/en/domnode.insertbefore.php - * @param DOMNode $node - * @param DOMNode|null $child [optional] - * @return DOMNode|false The inserted node or false on error. + * {@inheritdoc} + * @param string $uri + * @param bool $exclusive [optional] + * @param bool $withComments [optional] + * @param array|null $xpath [optional] + * @param array|null $nsPrefixes [optional] */ - public function insertBefore (DOMNode $node, ?DOMNode $child = null): DOMNode|false {} + public function C14NFile (string $uri, bool $exclusive = false, bool $withComments = false, ?array $xpath = NULL, ?array $nsPrefixes = NULL) {} /** - * Checks if the specified namespaceURI is the default namespace or not - * @link http://www.php.net/manual/en/domnode.isdefaultnamespace.php - * @param string $namespace - * @return bool Return true if namespace is the default - * namespace, false otherwise. + * {@inheritdoc} + * @param bool $deep [optional] */ - public function isDefaultNamespace (string $namespace): bool {} + public function cloneNode (bool $deep = false) {} /** - * Indicates if two nodes are the same node - * @link http://www.php.net/manual/en/domnode.issamenode.php - * @param DOMNode $otherNode - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function isSameNode (DOMNode $otherNode): bool {} + public function getLineNo () {} /** - * Checks if feature is supported for specified version - * @link http://www.php.net/manual/en/domnode.issupported.php - * @param string $feature - * @param string $version - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function isSupported (string $feature, string $version): bool {} + public function getNodePath () {} /** - * Gets the namespace URI of the node based on the prefix - * @link http://www.php.net/manual/en/domnode.lookupnamespaceuri.php - * @param string $prefix - * @return string The namespace URI of the node. + * {@inheritdoc} */ - public function lookupNamespaceURI (string $prefix): string {} + public function hasAttributes () {} /** - * Gets the namespace prefix of the node based on the namespace URI - * @link http://www.php.net/manual/en/domnode.lookupprefix.php - * @param string $namespace - * @return string|null The prefix of the namespace or null on error. + * {@inheritdoc} */ - public function lookupPrefix (string $namespace): ?string {} + public function hasChildNodes () {} /** - * Normalizes the node - * @link http://www.php.net/manual/en/domnode.normalize.php - * @return void No value is returned. + * {@inheritdoc} + * @param DOMNode $node + * @param DOMNode|null $child [optional] */ - public function normalize (): void {} + public function insertBefore (DOMNode $node, ?DOMNode $child = NULL) {} /** - * Removes child from list of children - * @link http://www.php.net/manual/en/domnode.removechild.php - * @param DOMNode $child - * @return DOMNode|false If the child could be removed the function returns the old child or false on error. + * {@inheritdoc} + * @param string $namespace */ - public function removeChild (DOMNode $child): DOMNode|false {} + public function isDefaultNamespace (string $namespace) {} /** - * Replaces a child - * @link http://www.php.net/manual/en/domnode.replacechild.php - * @param DOMNode $node - * @param DOMNode $child - * @return DOMNode|false The old node or false if an error occur. + * {@inheritdoc} + * @param DOMNode $otherNode */ - public function replaceChild (DOMNode $node, DOMNode $child): DOMNode|false {} - -} - -/** - * This interface represents a known entity, either parsed or unparsed, in an XML document. - * @link http://www.php.net/manual/en/class.domentity.php - */ -class DOMEntity extends DOMNode { + public function isSameNode (DOMNode $otherNode) {} /** - * The public identifier associated with the entity if specified, and - * null otherwise. - * @var string|null - * @link http://www.php.net/manual/en/class.domentity.php#domentity.props.publicid + * {@inheritdoc} + * @param DOMNode|null $otherNode */ - public readonly ?string $publicId; + public function isEqualNode (?DOMNode $otherNode = null): bool {} /** - * The system identifier associated with the entity if specified, and - * null otherwise. This may be an absolute URI or not. - * @var string|null - * @link http://www.php.net/manual/en/class.domentity.php#domentity.props.systemid + * {@inheritdoc} + * @param string $feature + * @param string $version */ - public readonly ?string $systemId; + public function isSupported (string $feature, string $version) {} /** - * For unparsed entities, the name of the notation for the entity. For - * parsed entities, this is null. - * @var string|null - * @link http://www.php.net/manual/en/class.domentity.php#domentity.props.notationname + * {@inheritdoc} + * @param string|null $prefix */ - public readonly ?string $notationName; + public function lookupNamespaceURI (?string $prefix = null) {} /** - * An attribute specifying the encoding used for this entity at the - * time of parsing, when it is an external parsed entity. This is - * null if it is an entity from the internal subset or if it is not - * known. - * @var string|null - * @link http://www.php.net/manual/en/class.domentity.php#domentity.props.actualencoding + * {@inheritdoc} + * @param string $namespace */ - public readonly ?string $actualEncoding; + public function lookupPrefix (string $namespace) {} /** - * An attribute specifying, as part of the text declaration, the - * encoding of this entity, when it is an external parsed entity. This - * is null otherwise. - * @var string|null - * @link http://www.php.net/manual/en/class.domentity.php#domentity.props.encoding + * {@inheritdoc} */ - public readonly ?string $encoding; + public function normalize () {} /** - * An attribute specifying, as part of the text declaration, the - * version number of this entity, when it is an external parsed - * entity. This is null otherwise. - * @var string|null - * @link http://www.php.net/manual/en/class.domentity.php#domentity.props.version + * {@inheritdoc} + * @param DOMNode $child */ - public readonly ?string $version; + public function removeChild (DOMNode $child) {} /** - * Adds new child at the end of the children - * @link http://www.php.net/manual/en/domnode.appendchild.php - * @param DOMNode $node - * @return DOMNode|false The node added or false on error. + * {@inheritdoc} + * @param DOMNode $node + * @param DOMNode $child */ - public function appendChild (DOMNode $node): DOMNode|false {} + public function replaceChild (DOMNode $node, DOMNode $child) {} /** - * Canonicalize nodes to a string - * @link http://www.php.net/manual/en/domnode.c14n.php - * @param bool $exclusive [optional] Enable exclusive parsing of only the nodes matched by the provided - * xpath or namespace prefixes. - * @param bool $withComments [optional] Retain comments in output. - * @param array|null $xpath [optional] An array of xpaths to filter the nodes by. - * @param array|null $nsPrefixes [optional] An array of namespace prefixes to filter the nodes by. - * @return string|false Returns canonicalized nodes as a string or false on failure + * {@inheritdoc} + * @param DOMNode|DOMNameSpaceNode|null $other */ - public function C14N (bool $exclusive = false, bool $withComments = false, ?array $xpath = null, ?array $nsPrefixes = null): string|false {} + public function contains (DOMNode|DOMNameSpaceNode|null $other = null): bool {} /** - * Canonicalize nodes to a file - * @link http://www.php.net/manual/en/domnode.c14nfile.php - * @param string $uri Path to write the output to. - * @param bool $exclusive [optional] Enable exclusive parsing of only the nodes matched by the provided - * xpath or namespace prefixes. - * @param bool $withComments [optional] Retain comments in output. - * @param array|null $xpath [optional] An array of xpaths to filter the nodes by. - * @param array|null $nsPrefixes [optional] An array of namespace prefixes to filter the nodes by. - * @return int|false Number of bytes written or false on failure + * {@inheritdoc} + * @param array|null $options [optional] */ - public function C14NFile (string $uri, bool $exclusive = false, bool $withComments = false, ?array $xpath = null, ?array $nsPrefixes = null): int|false {} + public function getRootNode (?array $options = NULL): DOMNode {} - /** - * Clones a node - * @link http://www.php.net/manual/en/domnode.clonenode.php - * @param bool $deep [optional] - * @return DOMNode|false The cloned node. - */ - public function cloneNode (bool $deep = false): DOMNode|false {} +} - /** - * Get line number for a node - * @link http://www.php.net/manual/en/domnode.getlineno.php - * @return int Always returns the line number where the node was defined in. - */ - public function getLineNo (): int {} +class DOMEntityReference extends DOMNode { /** - * Get an XPath for a node - * @link http://www.php.net/manual/en/domnode.getnodepath.php - * @return string|null Returns a string containing the XPath, or null in case of an error. + * {@inheritdoc} + * @param string $name */ - public function getNodePath (): ?string {} + public function __construct (string $name) {} /** - * Checks if node has attributes - * @link http://www.php.net/manual/en/domnode.hasattributes.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function hasAttributes (): bool {} + public function __sleep (): array {} /** - * Checks if node has children - * @link http://www.php.net/manual/en/domnode.haschildnodes.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function hasChildNodes (): bool {} + public function __wakeup (): void {} /** - * Adds a new child before a reference node - * @link http://www.php.net/manual/en/domnode.insertbefore.php - * @param DOMNode $node - * @param DOMNode|null $child [optional] - * @return DOMNode|false The inserted node or false on error. + * {@inheritdoc} + * @param DOMNode $node */ - public function insertBefore (DOMNode $node, ?DOMNode $child = null): DOMNode|false {} + public function appendChild (DOMNode $node) {} /** - * Checks if the specified namespaceURI is the default namespace or not - * @link http://www.php.net/manual/en/domnode.isdefaultnamespace.php - * @param string $namespace - * @return bool Return true if namespace is the default - * namespace, false otherwise. + * {@inheritdoc} + * @param bool $exclusive [optional] + * @param bool $withComments [optional] + * @param array|null $xpath [optional] + * @param array|null $nsPrefixes [optional] */ - public function isDefaultNamespace (string $namespace): bool {} + public function C14N (bool $exclusive = false, bool $withComments = false, ?array $xpath = NULL, ?array $nsPrefixes = NULL) {} /** - * Indicates if two nodes are the same node - * @link http://www.php.net/manual/en/domnode.issamenode.php - * @param DOMNode $otherNode - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $uri + * @param bool $exclusive [optional] + * @param bool $withComments [optional] + * @param array|null $xpath [optional] + * @param array|null $nsPrefixes [optional] */ - public function isSameNode (DOMNode $otherNode): bool {} + public function C14NFile (string $uri, bool $exclusive = false, bool $withComments = false, ?array $xpath = NULL, ?array $nsPrefixes = NULL) {} /** - * Checks if feature is supported for specified version - * @link http://www.php.net/manual/en/domnode.issupported.php - * @param string $feature - * @param string $version - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param bool $deep [optional] */ - public function isSupported (string $feature, string $version): bool {} + public function cloneNode (bool $deep = false) {} /** - * Gets the namespace URI of the node based on the prefix - * @link http://www.php.net/manual/en/domnode.lookupnamespaceuri.php - * @param string $prefix - * @return string The namespace URI of the node. + * {@inheritdoc} */ - public function lookupNamespaceURI (string $prefix): string {} + public function getLineNo () {} /** - * Gets the namespace prefix of the node based on the namespace URI - * @link http://www.php.net/manual/en/domnode.lookupprefix.php - * @param string $namespace - * @return string|null The prefix of the namespace or null on error. + * {@inheritdoc} */ - public function lookupPrefix (string $namespace): ?string {} + public function getNodePath () {} /** - * Normalizes the node - * @link http://www.php.net/manual/en/domnode.normalize.php - * @return void No value is returned. + * {@inheritdoc} */ - public function normalize (): void {} + public function hasAttributes () {} /** - * Removes child from list of children - * @link http://www.php.net/manual/en/domnode.removechild.php - * @param DOMNode $child - * @return DOMNode|false If the child could be removed the function returns the old child or false on error. + * {@inheritdoc} */ - public function removeChild (DOMNode $child): DOMNode|false {} + public function hasChildNodes () {} /** - * Replaces a child - * @link http://www.php.net/manual/en/domnode.replacechild.php - * @param DOMNode $node - * @param DOMNode $child - * @return DOMNode|false The old node or false if an error occur. + * {@inheritdoc} + * @param DOMNode $node + * @param DOMNode|null $child [optional] */ - public function replaceChild (DOMNode $node, DOMNode $child): DOMNode|false {} - -} - -/** - * @link http://www.php.net/manual/en/class.domentityreference.php - */ -class DOMEntityReference extends DOMNode { + public function insertBefore (DOMNode $node, ?DOMNode $child = NULL) {} /** - * Creates a new DOMEntityReference object - * @link http://www.php.net/manual/en/domentityreference.construct.php - * @param string $name - * @return string + * {@inheritdoc} + * @param string $namespace */ - public function __construct (string $name): string {} + public function isDefaultNamespace (string $namespace) {} /** - * Adds new child at the end of the children - * @link http://www.php.net/manual/en/domnode.appendchild.php - * @param DOMNode $node - * @return DOMNode|false The node added or false on error. + * {@inheritdoc} + * @param DOMNode $otherNode */ - public function appendChild (DOMNode $node): DOMNode|false {} + public function isSameNode (DOMNode $otherNode) {} /** - * Canonicalize nodes to a string - * @link http://www.php.net/manual/en/domnode.c14n.php - * @param bool $exclusive [optional] Enable exclusive parsing of only the nodes matched by the provided - * xpath or namespace prefixes. - * @param bool $withComments [optional] Retain comments in output. - * @param array|null $xpath [optional] An array of xpaths to filter the nodes by. - * @param array|null $nsPrefixes [optional] An array of namespace prefixes to filter the nodes by. - * @return string|false Returns canonicalized nodes as a string or false on failure + * {@inheritdoc} + * @param DOMNode|null $otherNode */ - public function C14N (bool $exclusive = false, bool $withComments = false, ?array $xpath = null, ?array $nsPrefixes = null): string|false {} + public function isEqualNode (?DOMNode $otherNode = null): bool {} /** - * Canonicalize nodes to a file - * @link http://www.php.net/manual/en/domnode.c14nfile.php - * @param string $uri Path to write the output to. - * @param bool $exclusive [optional] Enable exclusive parsing of only the nodes matched by the provided - * xpath or namespace prefixes. - * @param bool $withComments [optional] Retain comments in output. - * @param array|null $xpath [optional] An array of xpaths to filter the nodes by. - * @param array|null $nsPrefixes [optional] An array of namespace prefixes to filter the nodes by. - * @return int|false Number of bytes written or false on failure + * {@inheritdoc} + * @param string $feature + * @param string $version */ - public function C14NFile (string $uri, bool $exclusive = false, bool $withComments = false, ?array $xpath = null, ?array $nsPrefixes = null): int|false {} + public function isSupported (string $feature, string $version) {} /** - * Clones a node - * @link http://www.php.net/manual/en/domnode.clonenode.php - * @param bool $deep [optional] - * @return DOMNode|false The cloned node. + * {@inheritdoc} + * @param string|null $prefix */ - public function cloneNode (bool $deep = false): DOMNode|false {} + public function lookupNamespaceURI (?string $prefix = null) {} /** - * Get line number for a node - * @link http://www.php.net/manual/en/domnode.getlineno.php - * @return int Always returns the line number where the node was defined in. + * {@inheritdoc} + * @param string $namespace */ - public function getLineNo (): int {} + public function lookupPrefix (string $namespace) {} /** - * Get an XPath for a node - * @link http://www.php.net/manual/en/domnode.getnodepath.php - * @return string|null Returns a string containing the XPath, or null in case of an error. + * {@inheritdoc} */ - public function getNodePath (): ?string {} + public function normalize () {} /** - * Checks if node has attributes - * @link http://www.php.net/manual/en/domnode.hasattributes.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param DOMNode $child */ - public function hasAttributes (): bool {} + public function removeChild (DOMNode $child) {} /** - * Checks if node has children - * @link http://www.php.net/manual/en/domnode.haschildnodes.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param DOMNode $node + * @param DOMNode $child */ - public function hasChildNodes (): bool {} + public function replaceChild (DOMNode $node, DOMNode $child) {} /** - * Adds a new child before a reference node - * @link http://www.php.net/manual/en/domnode.insertbefore.php - * @param DOMNode $node - * @param DOMNode|null $child [optional] - * @return DOMNode|false The inserted node or false on error. + * {@inheritdoc} + * @param DOMNode|DOMNameSpaceNode|null $other */ - public function insertBefore (DOMNode $node, ?DOMNode $child = null): DOMNode|false {} + public function contains (DOMNode|DOMNameSpaceNode|null $other = null): bool {} /** - * Checks if the specified namespaceURI is the default namespace or not - * @link http://www.php.net/manual/en/domnode.isdefaultnamespace.php - * @param string $namespace - * @return bool Return true if namespace is the default - * namespace, false otherwise. + * {@inheritdoc} + * @param array|null $options [optional] */ - public function isDefaultNamespace (string $namespace): bool {} + public function getRootNode (?array $options = NULL): DOMNode {} - /** - * Indicates if two nodes are the same node - * @link http://www.php.net/manual/en/domnode.issamenode.php - * @param DOMNode $otherNode - * @return bool Returns true on success or false on failure. - */ - public function isSameNode (DOMNode $otherNode): bool {} +} - /** - * Checks if feature is supported for specified version - * @link http://www.php.net/manual/en/domnode.issupported.php - * @param string $feature - * @param string $version - * @return bool Returns true on success or false on failure. - */ - public function isSupported (string $feature, string $version): bool {} +class DOMProcessingInstruction extends DOMNode { + + public string $target; + + public string $data; /** - * Gets the namespace URI of the node based on the prefix - * @link http://www.php.net/manual/en/domnode.lookupnamespaceuri.php - * @param string $prefix - * @return string The namespace URI of the node. + * {@inheritdoc} + * @param string $name + * @param string $value [optional] */ - public function lookupNamespaceURI (string $prefix): string {} + public function __construct (string $name, string $value = '') {} /** - * Gets the namespace prefix of the node based on the namespace URI - * @link http://www.php.net/manual/en/domnode.lookupprefix.php - * @param string $namespace - * @return string|null The prefix of the namespace or null on error. + * {@inheritdoc} */ - public function lookupPrefix (string $namespace): ?string {} + public function __sleep (): array {} /** - * Normalizes the node - * @link http://www.php.net/manual/en/domnode.normalize.php - * @return void No value is returned. + * {@inheritdoc} */ - public function normalize (): void {} + public function __wakeup (): void {} /** - * Removes child from list of children - * @link http://www.php.net/manual/en/domnode.removechild.php - * @param DOMNode $child - * @return DOMNode|false If the child could be removed the function returns the old child or false on error. + * {@inheritdoc} + * @param DOMNode $node */ - public function removeChild (DOMNode $child): DOMNode|false {} + public function appendChild (DOMNode $node) {} /** - * Replaces a child - * @link http://www.php.net/manual/en/domnode.replacechild.php - * @param DOMNode $node - * @param DOMNode $child - * @return DOMNode|false The old node or false if an error occur. + * {@inheritdoc} + * @param bool $exclusive [optional] + * @param bool $withComments [optional] + * @param array|null $xpath [optional] + * @param array|null $nsPrefixes [optional] */ - public function replaceChild (DOMNode $node, DOMNode $child): DOMNode|false {} - -} - -/** - * @link http://www.php.net/manual/en/class.domprocessinginstruction.php - */ -class DOMProcessingInstruction extends DOMNode { - - public readonly string $target; - - public string $data; + public function C14N (bool $exclusive = false, bool $withComments = false, ?array $xpath = NULL, ?array $nsPrefixes = NULL) {} /** - * Creates a new DOMProcessingInstruction object - * @link http://www.php.net/manual/en/domprocessinginstruction.construct.php - * @param string $name - * @param string $value [optional] - * @return string + * {@inheritdoc} + * @param string $uri + * @param bool $exclusive [optional] + * @param bool $withComments [optional] + * @param array|null $xpath [optional] + * @param array|null $nsPrefixes [optional] */ - public function __construct (string $name, string $value = '""'): string {} + public function C14NFile (string $uri, bool $exclusive = false, bool $withComments = false, ?array $xpath = NULL, ?array $nsPrefixes = NULL) {} /** - * Adds new child at the end of the children - * @link http://www.php.net/manual/en/domnode.appendchild.php - * @param DOMNode $node - * @return DOMNode|false The node added or false on error. + * {@inheritdoc} + * @param bool $deep [optional] */ - public function appendChild (DOMNode $node): DOMNode|false {} + public function cloneNode (bool $deep = false) {} /** - * Canonicalize nodes to a string - * @link http://www.php.net/manual/en/domnode.c14n.php - * @param bool $exclusive [optional] Enable exclusive parsing of only the nodes matched by the provided - * xpath or namespace prefixes. - * @param bool $withComments [optional] Retain comments in output. - * @param array|null $xpath [optional] An array of xpaths to filter the nodes by. - * @param array|null $nsPrefixes [optional] An array of namespace prefixes to filter the nodes by. - * @return string|false Returns canonicalized nodes as a string or false on failure + * {@inheritdoc} */ - public function C14N (bool $exclusive = false, bool $withComments = false, ?array $xpath = null, ?array $nsPrefixes = null): string|false {} + public function getLineNo () {} /** - * Canonicalize nodes to a file - * @link http://www.php.net/manual/en/domnode.c14nfile.php - * @param string $uri Path to write the output to. - * @param bool $exclusive [optional] Enable exclusive parsing of only the nodes matched by the provided - * xpath or namespace prefixes. - * @param bool $withComments [optional] Retain comments in output. - * @param array|null $xpath [optional] An array of xpaths to filter the nodes by. - * @param array|null $nsPrefixes [optional] An array of namespace prefixes to filter the nodes by. - * @return int|false Number of bytes written or false on failure + * {@inheritdoc} */ - public function C14NFile (string $uri, bool $exclusive = false, bool $withComments = false, ?array $xpath = null, ?array $nsPrefixes = null): int|false {} + public function getNodePath () {} /** - * Clones a node - * @link http://www.php.net/manual/en/domnode.clonenode.php - * @param bool $deep [optional] - * @return DOMNode|false The cloned node. + * {@inheritdoc} */ - public function cloneNode (bool $deep = false): DOMNode|false {} + public function hasAttributes () {} /** - * Get line number for a node - * @link http://www.php.net/manual/en/domnode.getlineno.php - * @return int Always returns the line number where the node was defined in. + * {@inheritdoc} */ - public function getLineNo (): int {} + public function hasChildNodes () {} /** - * Get an XPath for a node - * @link http://www.php.net/manual/en/domnode.getnodepath.php - * @return string|null Returns a string containing the XPath, or null in case of an error. + * {@inheritdoc} + * @param DOMNode $node + * @param DOMNode|null $child [optional] */ - public function getNodePath (): ?string {} + public function insertBefore (DOMNode $node, ?DOMNode $child = NULL) {} /** - * Checks if node has attributes - * @link http://www.php.net/manual/en/domnode.hasattributes.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $namespace */ - public function hasAttributes (): bool {} + public function isDefaultNamespace (string $namespace) {} /** - * Checks if node has children - * @link http://www.php.net/manual/en/domnode.haschildnodes.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param DOMNode $otherNode */ - public function hasChildNodes (): bool {} + public function isSameNode (DOMNode $otherNode) {} /** - * Adds a new child before a reference node - * @link http://www.php.net/manual/en/domnode.insertbefore.php - * @param DOMNode $node - * @param DOMNode|null $child [optional] - * @return DOMNode|false The inserted node or false on error. + * {@inheritdoc} + * @param DOMNode|null $otherNode */ - public function insertBefore (DOMNode $node, ?DOMNode $child = null): DOMNode|false {} + public function isEqualNode (?DOMNode $otherNode = null): bool {} /** - * Checks if the specified namespaceURI is the default namespace or not - * @link http://www.php.net/manual/en/domnode.isdefaultnamespace.php - * @param string $namespace - * @return bool Return true if namespace is the default - * namespace, false otherwise. + * {@inheritdoc} + * @param string $feature + * @param string $version */ - public function isDefaultNamespace (string $namespace): bool {} + public function isSupported (string $feature, string $version) {} /** - * Indicates if two nodes are the same node - * @link http://www.php.net/manual/en/domnode.issamenode.php - * @param DOMNode $otherNode - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string|null $prefix */ - public function isSameNode (DOMNode $otherNode): bool {} + public function lookupNamespaceURI (?string $prefix = null) {} /** - * Checks if feature is supported for specified version - * @link http://www.php.net/manual/en/domnode.issupported.php - * @param string $feature - * @param string $version - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $namespace */ - public function isSupported (string $feature, string $version): bool {} + public function lookupPrefix (string $namespace) {} /** - * Gets the namespace URI of the node based on the prefix - * @link http://www.php.net/manual/en/domnode.lookupnamespaceuri.php - * @param string $prefix - * @return string The namespace URI of the node. + * {@inheritdoc} */ - public function lookupNamespaceURI (string $prefix): string {} + public function normalize () {} /** - * Gets the namespace prefix of the node based on the namespace URI - * @link http://www.php.net/manual/en/domnode.lookupprefix.php - * @param string $namespace - * @return string|null The prefix of the namespace or null on error. + * {@inheritdoc} + * @param DOMNode $child */ - public function lookupPrefix (string $namespace): ?string {} + public function removeChild (DOMNode $child) {} /** - * Normalizes the node - * @link http://www.php.net/manual/en/domnode.normalize.php - * @return void No value is returned. + * {@inheritdoc} + * @param DOMNode $node + * @param DOMNode $child */ - public function normalize (): void {} + public function replaceChild (DOMNode $node, DOMNode $child) {} /** - * Removes child from list of children - * @link http://www.php.net/manual/en/domnode.removechild.php - * @param DOMNode $child - * @return DOMNode|false If the child could be removed the function returns the old child or false on error. + * {@inheritdoc} + * @param DOMNode|DOMNameSpaceNode|null $other */ - public function removeChild (DOMNode $child): DOMNode|false {} + public function contains (DOMNode|DOMNameSpaceNode|null $other = null): bool {} /** - * Replaces a child - * @link http://www.php.net/manual/en/domnode.replacechild.php - * @param DOMNode $node - * @param DOMNode $child - * @return DOMNode|false The old node or false if an error occur. + * {@inheritdoc} + * @param array|null $options [optional] */ - public function replaceChild (DOMNode $node, DOMNode $child): DOMNode|false {} + public function getRootNode (?array $options = NULL): DOMNode {} } -/** - * Supports XPath 1.0 - * @link http://www.php.net/manual/en/class.domxpath.php - */ class DOMXPath { - public readonly DOMDocument $document; + public DOMDocument $document; - /** - * When set to true, namespaces in the node are registered. - * @var bool - * @link http://www.php.net/manual/en/class.domxpath.php#domxpath.props.registernodenamespaces - */ public bool $registerNodeNamespaces; /** - * Creates a new DOMXPath object - * @link http://www.php.net/manual/en/domxpath.construct.php - * @param DOMDocument $document - * @param bool $registerNodeNS [optional] - * @return DOMDocument + * {@inheritdoc} + * @param DOMDocument $document + * @param bool $registerNodeNS [optional] */ - public function __construct (DOMDocument $document, bool $registerNodeNS = true): DOMDocument {} + public function __construct (DOMDocument $document, bool $registerNodeNS = true) {} /** - * Evaluates the given XPath expression and returns a typed result if possible - * @link http://www.php.net/manual/en/domxpath.evaluate.php - * @param string $expression - * @param DOMNode|null $contextNode [optional] - * @param bool $registerNodeNS [optional] - * @return mixed Returns a typed result if possible or a DOMNodeList - * containing all nodes matching the given XPath expression. - *If the expression is malformed or the - * contextNode is invalid, - * DOMXPath::evaluate returns false.
+ * {@inheritdoc} + * @param string $expression + * @param DOMNode|null $contextNode [optional] + * @param bool $registerNodeNS [optional] */ - public function evaluate (string $expression, ?DOMNode $contextNode = null, bool $registerNodeNS = true): mixed {} + public function evaluate (string $expression, ?DOMNode $contextNode = NULL, bool $registerNodeNS = true) {} /** - * Evaluates the given XPath expression - * @link http://www.php.net/manual/en/domxpath.query.php - * @param string $expression - * @param DOMNode|null $contextNode [optional] - * @param bool $registerNodeNS [optional] - * @return mixed Returns a DOMNodeList containing all nodes matching - * the given XPath expression. Any expression which - * does not return nodes will return an empty - * DOMNodeList. - *If the expression is malformed or the - * contextNode is invalid, - * DOMXPath::query returns false.
+ * {@inheritdoc} + * @param string $expression + * @param DOMNode|null $contextNode [optional] + * @param bool $registerNodeNS [optional] */ - public function query (string $expression, ?DOMNode $contextNode = null, bool $registerNodeNS = true): mixed {} + public function query (string $expression, ?DOMNode $contextNode = NULL, bool $registerNodeNS = true) {} /** - * Registers the namespace with the DOMXPath object - * @link http://www.php.net/manual/en/domxpath.registernamespace.php - * @param string $prefix - * @param string $namespace - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $prefix + * @param string $namespace */ - public function registerNamespace (string $prefix, string $namespace): bool {} + public function registerNamespace (string $prefix, string $namespace) {} /** - * Register PHP functions as XPath functions - * @link http://www.php.net/manual/en/domxpath.registerphpfunctions.php - * @param string|array|null $restrict [optional] - * @return void No value is returned. + * {@inheritdoc} + * @param array|string|null $restrict [optional] */ - public function registerPhpFunctions (string|array|null $restrict = null): void {} + public function registerPhpFunctions (array|string|null $restrict = NULL) {} } /** - * Gets a DOMElement object from a - * SimpleXMLElement object - * @link http://www.php.net/manual/en/function.dom-import-simplexml.php - * @param object $node - * @return DOMElement The DOMElement node added. + * {@inheritdoc} + * @param object $node */ function dom_import_simplexml (object $node): DOMElement {} diff --git a/plugins/org.eclipse.php.core/Resources/language/php8.3/ds.php b/plugins/org.eclipse.php.core/Resources/language/php8.3/ds.php index 45e395ebc9..63815288da 100644 --- a/plugins/org.eclipse.php.core/Resources/language/php8.3/ds.php +++ b/plugins/org.eclipse.php.core/Resources/language/php8.3/ds.php @@ -7,394 +7,254 @@ interface Hashable { /** - * Returns a scalar value to be used as a hash value - * @link http://www.php.net/manual/en/ds-hashable.hash.php - * @return mixed A scalar value to be used as this object's hash value. + * {@inheritdoc} */ - abstract public function hash (): mixed; + abstract public function hash (); /** - * Determines whether an object is equal to the current instance - * @link http://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. + * {@inheritdoc} + * @param mixed $obj */ - abstract public function equals (object $obj): bool; + abstract public function equals ($obj = null): bool; } interface Collection extends \IteratorAggregate, \Traversable, \Countable, \JsonSerializable { /** - * Removes all values - * @link http://www.php.net/manual/en/ds-collection.clear.php - * @return void No value is returned. + * {@inheritdoc} */ - abstract public function clear (): void; + abstract public function clear (); /** - * Returns a shallow copy of the collection - * @link http://www.php.net/manual/en/ds-collection.copy.php - * @return \Ds\Collection Returns a shallow copy of the collection. + * {@inheritdoc} */ abstract public function copy (): \Ds\Collection; /** - * Returns whether the collection is empty - * @link http://www.php.net/manual/en/ds-collection.isempty.php - * @return bool Returns true if the collection is empty, false otherwise. + * {@inheritdoc} */ abstract public function isEmpty (): bool; /** - * Converts the collection to an array - * @link http://www.php.net/manual/en/ds-collection.toarray.php - * @return array An array containing all the values in the same order as the collection. + * {@inheritdoc} */ abstract public function toArray (): array; /** - * Retrieve an external iterator - * @link http://www.php.net/manual/en/iteratoraggregate.getiterator.php - * @return \Traversable An instance of an object implementing Iterator or - * Traversable + * {@inheritdoc} */ - abstract public function getIterator (): \Traversable; + abstract public function getIterator (); /** - * Count elements of an object - * @link http://www.php.net/manual/en/countable.count.php - * @return int The custom count as an int. - *The return value is cast to an int.
+ * {@inheritdoc} */ - abstract public function count (): int; + abstract public function count (); /** - * Specify data which should be serialized to JSON - * @link http://www.php.net/manual/en/jsonserializable.jsonserialize.php - * @return mixed Returns data which can be serialized by json_encode, - * which is a value of any type other than a resource. + * {@inheritdoc} */ - abstract public function jsonSerialize (): mixed; + abstract public function jsonSerialize (); } interface Sequence extends \Ds\Collection, \JsonSerializable, \Countable, \Traversable, \IteratorAggregate, \ArrayAccess { /** - * Allocates enough memory for a required capacity - * @link http://www.php.net/manual/en/ds-sequence.allocate.php - * @param int $capacity The number of values for which capacity should be allocated. - *Capacity will stay the same if this value is less than or equal to the - * current capacity.
- * @return void No value is returned. + * {@inheritdoc} + * @param int $capacity */ - abstract public function allocate (int $capacity): void; + abstract public function allocate (int $capacity); /** - * Returns the current capacity - * @link http://www.php.net/manual/en/ds-sequence.capacity.php - * @return int The current capacity. + * {@inheritdoc} */ abstract public function capacity (): int; /** - * Determines if the sequence contains given values - * @link http://www.php.net/manual/en/ds-sequence.contains.php - * @param mixed $values Values to check. - * @return bool false if any of the provided values are not in the - * sequence, true otherwise. + * {@inheritdoc} + * @param mixed $values [optional] */ - abstract public function contains (mixed ...$values): bool; + abstract public function contains (...$values): bool; /** - * Creates a new sequence using a callable to - * determine which values to include - * @link http://www.php.net/manual/en/ds-sequence.filter.php - * @param callable $callback [optional] bool - * callback - * mixedvalue - *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 \Ds\Sequence 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. + * {@inheritdoc} + * @param callable|null $callback [optional] */ - abstract public function filter (callable $callback = null): \Ds\Sequence; + abstract public function filter (?callable $callback = NULL): \Ds\Sequence; /** - * Attempts to find a value's index - * @link http://www.php.net/manual/en/ds-sequence.find.php - * @param mixed $value The value to find. - * @return mixed The index of the value, or false if not found. - *Values will be compared by value and by type.
+ * {@inheritdoc} + * @param mixed $value */ - abstract public function find (mixed $value): mixed; + abstract public function find ($value = null); /** - * Returns the first value in the sequence - * @link http://www.php.net/manual/en/ds-sequence.first.php - * @return mixed The first value in the sequence. + * {@inheritdoc} */ - abstract public function first (): mixed; + abstract public function first (); /** - * Returns the value at a given index - * @link http://www.php.net/manual/en/ds-sequence.get.php - * @param int $index The index to access, starting at 0. - * @return mixed The value at the requested index. + * {@inheritdoc} + * @param int $index */ - abstract public function get (int $index): mixed; + abstract public function get (int $index); /** - * Inserts values at a given index - * @link http://www.php.net/manual/en/ds-sequence.insert.php - * @param int $index The index at which to insert. 0 <= index <= count - *You can insert at the index equal to the number of values.
- * @param mixed $values The value or values to insert. - * @return void No value is returned. + * {@inheritdoc} + * @param int $index + * @param mixed $values [optional] */ - abstract public function insert (int $index, mixed ...$values): void; + abstract public function insert (int $index, ...$values); /** - * Joins all values together as a string - * @link http://www.php.net/manual/en/ds-sequence.join.php - * @param string $glue [optional] An optional string to separate each value. - * @return string All values of the sequence joined together as a string. + * {@inheritdoc} + * @param string $glue [optional] */ - abstract public function join (string $glue = null): string; + abstract public function join (string $glue = NULL): string; /** - * Returns the last value - * @link http://www.php.net/manual/en/ds-sequence.last.php - * @return mixed The last value in the sequence. + * {@inheritdoc} */ - abstract public function last (): mixed; + abstract public function last (); /** - * Returns the result of applying a callback to each value - * @link http://www.php.net/manual/en/ds-sequence.map.php - * @param callable $callback mixed - * callback - * mixedvalue - *A callable to apply to each value in the sequence.
- *The callable should return what the new value will be in the new sequence.
- * @return \Ds\Sequence The result of applying a callback to each value in - * the sequence. - *The values of the current instance won't be affected.
+ * {@inheritdoc} + * @param callable $callback */ abstract public function map (callable $callback): \Ds\Sequence; /** - * Returns the result of adding all given values to the sequence - * @link http://www.php.net/manual/en/ds-sequence.merge.php - * @param mixed $values A traversable object or an array. - * @return \Ds\Sequence The result of adding all given values to the sequence, - * effectively the same as adding the values to a copy, then returning that copy. - *The current instance won't be affected.
+ * {@inheritdoc} + * @param mixed $values */ - abstract public function merge (mixed $values): \Ds\Sequence; + abstract public function merge ($values = null): \Ds\Sequence; /** - * Removes and returns the last value - * @link http://www.php.net/manual/en/ds-sequence.pop.php - * @return mixed The removed last value. + * {@inheritdoc} */ - abstract public function pop (): mixed; + abstract public function pop (); /** - * Adds values to the end of the sequence - * @link http://www.php.net/manual/en/ds-sequence.push.php - * @param mixed $values The values to add. - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $values [optional] */ - abstract public function push (mixed ...$values): void; + abstract public function push (...$values); /** - * Reduces the sequence to a single value using a callback function - * @link http://www.php.net/manual/en/ds-sequence.reduce.php - * @param callable $callback The return value of the previous callback, or initial if - * it's the first iteration. - *The value of the current iteration.
- * @param mixed $initial [optional] The initial value of the carry value. Can be null. - * @return mixed The return value of the final callback. + * {@inheritdoc} + * @param callable $callback + * @param mixed $initial [optional] */ - abstract public function reduce (callable $callback, mixed $initial = null): mixed; + abstract public function reduce (callable $callback, $initial = NULL); /** - * Removes and returns a value by index - * @link http://www.php.net/manual/en/ds-sequence.remove.php - * @param int $index The index of the value to remove. - * @return mixed The value that was removed. + * {@inheritdoc} + * @param int $index */ - abstract public function remove (int $index): mixed; + abstract public function remove (int $index); /** - * Reverses the sequence in-place - * @link http://www.php.net/manual/en/ds-sequence.reverse.php - * @return void No value is returned. + * {@inheritdoc} */ - abstract public function reverse (): void; + abstract public function reverse (); /** - * Rotates the sequence by a given number of rotations - * @link http://www.php.net/manual/en/ds-sequence.rotate.php - * @param int $rotations The number of times the sequence should be rotated. - * @return void No value is returned.. The sequence of the current instance will be rotated. + * {@inheritdoc} + * @param int $rotations */ - abstract public function rotate (int $rotations): void; + abstract public function rotate (int $rotations); /** - * Updates a value at a given index - * @link http://www.php.net/manual/en/ds-sequence.set.php - * @param int $index The index of the value to update. - * @param mixed $value The new value. - * @return void No value is returned. + * {@inheritdoc} + * @param int $index + * @param mixed $value */ - abstract public function set (int $index, mixed $value): void; + abstract public function set (int $index, $value = null); /** - * Removes and returns the first value - * @link http://www.php.net/manual/en/ds-sequence.shift.php - * @return mixed The first value, which was removed. + * {@inheritdoc} */ - abstract public function shift (): mixed; + abstract public function shift (); /** - * Returns a sub-sequence of a given range - * @link http://www.php.net/manual/en/ds-sequence.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 $length [optional] 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 \Ds\Sequence A sub-sequence of the given range. + * {@inheritdoc} + * @param int $index + * @param int|null $length [optional] */ - abstract public function slice (int $index, int $length = null): \Ds\Sequence; + abstract public function slice (int $index, ?int $length = NULL): \Ds\Sequence; /** - * Sorts the sequence in-place - * @link http://www.php.net/manual/en/ds-sequence.sort.php - * @param callable $comparator [optional] > - * 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. - *Returning non-integer values from the comparison - * function, such as float, will result in an internal cast to - * int 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 void No value is returned. + * {@inheritdoc} + * @param callable|null $comparator [optional] */ - abstract public function sort (callable $comparator = null): void; + abstract public function sort (?callable $comparator = NULL); /** - * Adds values to the front of the sequence - * @link http://www.php.net/manual/en/ds-sequence.unshift.php - * @param mixed $values [optional] The values to add to the front of the sequence. - *- * Multiple values will be added in the same order that they are - * passed. - *
- *Multiple values will be added in the same order that they are - * passed.
- * @return void No value is returned. + * {@inheritdoc} + * @param mixed $values [optional] */ - abstract public function unshift (mixed $values = null): void; + abstract public function unshift (...$values); /** - * Removes all values - * @link http://www.php.net/manual/en/ds-collection.clear.php - * @return void No value is returned. + * {@inheritdoc} */ - abstract public function clear (): void; + abstract public function clear (); /** - * Returns a shallow copy of the collection - * @link http://www.php.net/manual/en/ds-collection.copy.php - * @return \Ds\Collection Returns a shallow copy of the collection. + * {@inheritdoc} */ abstract public function copy (): \Ds\Collection; /** - * Returns whether the collection is empty - * @link http://www.php.net/manual/en/ds-collection.isempty.php - * @return bool Returns true if the collection is empty, false otherwise. + * {@inheritdoc} */ abstract public function isEmpty (): bool; /** - * Converts the collection to an array - * @link http://www.php.net/manual/en/ds-collection.toarray.php - * @return array An array containing all the values in the same order as the collection. + * {@inheritdoc} */ abstract public function toArray (): array; /** - * Retrieve an external iterator - * @link http://www.php.net/manual/en/iteratoraggregate.getiterator.php - * @return \Traversable An instance of an object implementing Iterator or - * Traversable + * {@inheritdoc} */ - abstract public function getIterator (): \Traversable; + abstract public function getIterator (); /** - * Count elements of an object - * @link http://www.php.net/manual/en/countable.count.php - * @return int The custom count as an int. - *The return value is cast to an int.
+ * {@inheritdoc} */ - abstract public function count (): int; + abstract public function count (); /** - * Specify data which should be serialized to JSON - * @link http://www.php.net/manual/en/jsonserializable.jsonserialize.php - * @return mixed Returns data which can be serialized by json_encode, - * which is a value of any type other than a resource. + * {@inheritdoc} */ - abstract public function jsonSerialize (): mixed; + abstract public function jsonSerialize (); /** - * Whether an offset exists - * @link http://www.php.net/manual/en/arrayaccess.offsetexists.php - * @param mixed $offset - * @return bool Returns true on success or false on failure. - *The return value will be casted to bool if non-boolean was returned.
+ * {@inheritdoc} + * @param mixed $offset */ - abstract public function offsetExists (mixed $offset): bool; + abstract public function offsetExists (mixed $offset = null); /** - * Offset to retrieve - * @link http://www.php.net/manual/en/arrayaccess.offsetget.php - * @param mixed $offset - * @return mixed Can return all value types. + * {@inheritdoc} + * @param mixed $offset */ - abstract public function offsetGet (mixed $offset): mixed; + abstract public function offsetGet (mixed $offset = null); /** - * Assign a value to the specified offset - * @link http://www.php.net/manual/en/arrayaccess.offsetset.php - * @param mixed $offset - * @param mixed $value - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $offset + * @param mixed $value */ - abstract public function offsetSet (mixed $offset, mixed $value): void; + abstract public function offsetSet (mixed $offset = null, mixed $value = null); /** - * Unset an offset - * @link http://www.php.net/manual/en/arrayaccess.offsetunset.php - * @param mixed $offset - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $offset */ - abstract public function offsetUnset (mixed $offset): void; + abstract public function offsetUnset (mixed $offset = null); } @@ -403,12 +263,10 @@ final class Vector implements \Ds\Sequence, \ArrayAccess, \IteratorAggregate, \T /** - * Creates a new instance - * @link http://www.php.net/manual/en/ds-vector.construct.php - * @param mixed $values [optional] A traversable object or an array to use for the initial values. - * @return mixed + * {@inheritdoc} + * @param mixed $values [optional] */ - public function __construct (mixed $values = null): mixed {} + public function __construct ($values = NULL) {} /** * {@inheritdoc} @@ -416,132 +274,80 @@ public function __construct (mixed $values = null): mixed {} public function getIterator (): \Traversable {} /** - * Allocates enough memory for a required capacity - * @link http://www.php.net/manual/en/ds-vector.allocate.php - * @param int $capacity The number of values for which capacity should be allocated. - *Capacity will stay the same if this value is less than or equal to the - * current capacity.
- * @return void No value is returned. + * {@inheritdoc} + * @param int $capacity */ - public function allocate (int $capacity): void {} + public function allocate (int $capacity) {} /** - * Updates all values by applying a callback function to each value - * @link http://www.php.net/manual/en/ds-vector.apply.php - * @param callable $callback mixed - * callback - * mixedvalue - *A callable to apply to each value in the vector.
- *The callback should return what the value should be replaced by.
- * @return void No value is returned. + * {@inheritdoc} + * @param callable $callback */ - public function apply (callable $callback): void {} + public function apply (callable $callback) {} /** - * Returns the current capacity - * @link http://www.php.net/manual/en/ds-vector.capacity.php - * @return int The current capacity. + * {@inheritdoc} */ public function capacity (): int {} /** - * Determines if the vector contains given values - * @link http://www.php.net/manual/en/ds-vector.contains.php - * @param mixed $values Values to check. - * @return bool false if any of the provided values are not in the - * vector, true otherwise. + * {@inheritdoc} + * @param mixed $values [optional] */ - public function contains (mixed ...$values): bool {} + public function contains (...$values): bool {} /** - * Creates a new vector using a callable to - * determine which values to include - * @link http://www.php.net/manual/en/ds-vector.filter.php - * @param callable $callback [optional] bool - * callback - * mixedvalue - *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 \Ds\Vector 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. + * {@inheritdoc} + * @param callable|null $callback [optional] */ - public function filter (callable $callback = null): \Ds\Vector {} + public function filter (?callable $callback = NULL): \Ds\Sequence {} /** - * Attempts to find a value's index - * @link http://www.php.net/manual/en/ds-vector.find.php - * @param mixed $value The value to find. - * @return mixed The index of the value, or false if not found. - *Values will be compared by value and by type.
+ * {@inheritdoc} + * @param mixed $value */ - public function find (mixed $value): mixed {} + public function find ($value = null) {} /** - * Returns the first value in the vector - * @link http://www.php.net/manual/en/ds-vector.first.php - * @return mixed The first value in the vector. + * {@inheritdoc} */ - public function first (): mixed {} + public function first () {} /** - * Returns the value at a given index - * @link http://www.php.net/manual/en/ds-vector.get.php - * @param int $index The index to access, starting at 0. - * @return mixed The value at the requested index. + * {@inheritdoc} + * @param int $index */ - public function get (int $index): mixed {} + public function get (int $index) {} /** - * Inserts values at a given index - * @link http://www.php.net/manual/en/ds-vector.insert.php - * @param int $index The index at which to insert. 0 <= index <= count - *You can insert at the index equal to the number of values.
- * @param mixed $values The value or values to insert. - * @return void No value is returned. + * {@inheritdoc} + * @param int $index + * @param mixed $values [optional] */ - public function insert (int $index, mixed ...$values): void {} + public function insert (int $index, ...$values) {} /** - * Joins all values together as a string - * @link http://www.php.net/manual/en/ds-vector.join.php - * @param string $glue [optional] An optional string to separate each value. - * @return string All values of the vector joined together as a string. + * {@inheritdoc} + * @param string $glue [optional] */ - public function join (string $glue = null): string {} + public function join (string $glue = NULL): string {} /** - * Returns the last value - * @link http://www.php.net/manual/en/ds-vector.last.php - * @return mixed The last value in the vector. + * {@inheritdoc} */ - public function last (): mixed {} + public function last () {} /** - * Returns the result of applying a callback to each value - * @link http://www.php.net/manual/en/ds-vector.map.php - * @param callable $callback mixed - * callback - * mixedvalue - *A callable to apply to each value in the vector.
- *The callable should return what the new value will be in the new vector.
- * @return \Ds\Vector The result of applying a callback to each value in - * the vector. - *The values of the current instance won't be affected.
+ * {@inheritdoc} + * @param callable $callback */ - public function map (callable $callback): \Ds\Vector {} + public function map (callable $callback): \Ds\Sequence {} /** - * Returns the result of adding all given values to the vector - * @link http://www.php.net/manual/en/ds-vector.merge.php - * @param mixed $values A traversable object or an array. - * @return \Ds\Vector The result of adding all given values to the vector, - * effectively the same as adding the values to a copy, then returning that copy. - *The current instance won't be affected.
+ * {@inheritdoc} + * @param mixed $values */ - public function merge (mixed $values): \Ds\Vector {} + public function merge ($values = null): \Ds\Sequence {} /** * {@inheritdoc} @@ -569,163 +375,96 @@ public function offsetSet (mixed $offset = null, mixed $value = null) {} public function offsetUnset (mixed $offset = null) {} /** - * Removes and returns the last value - * @link http://www.php.net/manual/en/ds-vector.pop.php - * @return mixed The removed last value. + * {@inheritdoc} */ - public function pop (): mixed {} + public function pop () {} /** - * Adds values to the end of the vector - * @link http://www.php.net/manual/en/ds-vector.push.php - * @param mixed $values The values to add. - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $values [optional] */ - public function push (mixed ...$values): void {} + public function push (...$values) {} /** - * Reduces the vector to a single value using a callback function - * @link http://www.php.net/manual/en/ds-vector.reduce.php - * @param callable $callback The return value of the previous callback, or initial if - * it's the first iteration. - *The value of the current iteration.
- * @param mixed $initial [optional] The initial value of the carry value. Can be null. - * @return mixed The return value of the final callback. + * {@inheritdoc} + * @param callable $callback + * @param mixed $initial [optional] */ - public function reduce (callable $callback, mixed $initial = null): mixed {} + public function reduce (callable $callback, $initial = NULL) {} /** - * Removes and returns a value by index - * @link http://www.php.net/manual/en/ds-vector.remove.php - * @param int $index The index of the value to remove. - * @return mixed The value that was removed. + * {@inheritdoc} + * @param int $index */ - public function remove (int $index): mixed {} + public function remove (int $index) {} /** - * Reverses the vector in-place - * @link http://www.php.net/manual/en/ds-vector.reverse.php - * @return void No value is returned. + * {@inheritdoc} */ - public function reverse (): void {} + public function reverse () {} /** - * Returns a reversed copy - * @link http://www.php.net/manual/en/ds-vector.reversed.php - * @return \Ds\Vector A reversed copy of the vector. - *- * The current instance is not affected. - *
- *The current instance is not affected.
+ * {@inheritdoc} */ - public function reversed (): \Ds\Vector {} + public function reversed (): \Ds\Sequence {} /** - * Rotates the vector by a given number of rotations - * @link http://www.php.net/manual/en/ds-vector.rotate.php - * @param int $rotations The number of times the vector should be rotated. - * @return void No value is returned.. The vector of the current instance will be rotated. + * {@inheritdoc} + * @param int $rotations */ - public function rotate (int $rotations): void {} + public function rotate (int $rotations) {} /** - * Updates a value at a given index - * @link http://www.php.net/manual/en/ds-vector.set.php - * @param int $index The index of the value to update. - * @param mixed $value The new value. - * @return void No value is returned. + * {@inheritdoc} + * @param int $index + * @param mixed $value */ - public function set (int $index, mixed $value): void {} + public function set (int $index, $value = null) {} /** - * Removes and returns the first value - * @link http://www.php.net/manual/en/ds-vector.shift.php - * @return mixed The first value, which was removed. + * {@inheritdoc} */ - public function shift (): mixed {} + public function shift () {} /** - * Returns a sub-vector of a given range - * @link http://www.php.net/manual/en/ds-vector.slice.php - * @param int $index The index at which the sub-vector starts. - *If positive, the vector will start at that index in the vector. - * If negative, the vector will start that far from the end.
- * @param int $length [optional] If a length is given and is positive, the resulting - * vector will have up to that many values in it. - * If the length results in an overflow, only - * values up to the end of the vector will be included. - * If a length is given and is negative, the vector - * will stop that many values from the end. - * If a length is not provided, the resulting vector - * will contain all values between the index and the - * end of the vector. - * @return \Ds\Vector A sub-vector of the given range. + * {@inheritdoc} + * @param int $index + * @param int|null $length [optional] */ - public function slice (int $index, int $length = null): \Ds\Vector {} + public function slice (int $index, ?int $length = NULL): \Ds\Sequence {} /** - * Sorts the vector in-place - * @link http://www.php.net/manual/en/ds-vector.sort.php - * @param callable $comparator [optional] > - * 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. - *Returning non-integer values from the comparison - * function, such as float, will result in an internal cast to - * int 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 void No value is returned. + * {@inheritdoc} + * @param callable|null $comparator [optional] */ - public function sort (callable $comparator = null): void {} + public function sort (?callable $comparator = NULL) {} /** - * Returns a sorted copy - * @link http://www.php.net/manual/en/ds-vector.sorted.php - * @param callable $comparator [optional] > - * 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. - *Returning non-integer values from the comparison - * function, such as float, will result in an internal cast to - * int 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 \Ds\Vector Returns a sorted copy of the vector. + * {@inheritdoc} + * @param callable|null $comparator [optional] */ - public function sorted (callable $comparator = null): \Ds\Vector {} + public function sorted (?callable $comparator = NULL): \Ds\Sequence {} /** - * Returns the sum of all values in the vector - * @link http://www.php.net/manual/en/ds-vector.sum.php - * @return int|float The sum of all the values in the vector as either a float or int - * depending on the values in the vector. + * {@inheritdoc} */ - public function sum (): int|float {} + public function sum () {} /** - * Adds values to the front of the vector - * @link http://www.php.net/manual/en/ds-vector.unshift.php - * @param mixed $values [optional] The values to add to the front of the vector. - *- * Multiple values will be added in the same order that they are - * passed. - *
- *Multiple values will be added in the same order that they are - * passed.
- * @return void No value is returned. + * {@inheritdoc} + * @param mixed $values [optional] */ - public function unshift (mixed $values = null): void {} + public function unshift (...$values) {} /** - * Removes all values - * @link http://www.php.net/manual/en/ds-vector.clear.php - * @return void No value is returned. + * {@inheritdoc} */ - public function clear (): void {} + public function clear () {} /** - * Returns a shallow copy of the vector - * @link http://www.php.net/manual/en/ds-vector.copy.php - * @return \Ds\Vector Returns a shallow copy of the vector. + * {@inheritdoc} */ - public function copy (): \Ds\Vector {} + public function copy (): \Ds\Collection {} /** * {@inheritdoc} @@ -733,9 +472,7 @@ public function copy (): \Ds\Vector {} public function count (): int {} /** - * Returns whether the vector is empty - * @link http://www.php.net/manual/en/ds-vector.isempty.php - * @return bool Returns true if the vector is empty, false otherwise. + * {@inheritdoc} */ public function isEmpty (): bool {} @@ -745,9 +482,7 @@ public function isEmpty (): bool {} public function jsonSerialize () {} /** - * Converts the vector to an array - * @link http://www.php.net/manual/en/ds-vector.toarray.php - * @return array An array containing all the values in the same order as the vector. + * {@inheritdoc} */ public function toArray (): array {} @@ -758,12 +493,10 @@ final class Deque implements \Ds\Sequence, \ArrayAccess, \IteratorAggregate, \Tr /** - * Creates a new instance - * @link http://www.php.net/manual/en/ds-deque.construct.php - * @param mixed $values [optional] A traversable object or an array to use for the initial values. - * @return mixed + * {@inheritdoc} + * @param mixed $values [optional] */ - public function __construct (mixed $values = null): mixed {} + public function __construct ($values = NULL) {} /** * {@inheritdoc} @@ -771,18 +504,14 @@ public function __construct (mixed $values = null): mixed {} public function getIterator (): \Traversable {} /** - * Removes all values from the deque - * @link http://www.php.net/manual/en/ds-deque.clear.php - * @return void No value is returned. + * {@inheritdoc} */ - public function clear (): void {} + public function clear () {} /** - * Returns a shallow copy of the deque - * @link http://www.php.net/manual/en/ds-deque.copy.php - * @return \Ds\Deque A shallow copy of the deque. + * {@inheritdoc} */ - public function copy (): \Ds\Deque {} + public function copy (): \Ds\Collection {} /** * {@inheritdoc} @@ -790,9 +519,7 @@ public function copy (): \Ds\Deque {} public function count (): int {} /** - * Returns whether the deque is empty - * @link http://www.php.net/manual/en/ds-deque.isempty.php - * @return bool Returns true if the deque is empty, false otherwise. + * {@inheritdoc} */ public function isEmpty (): bool {} @@ -802,140 +529,85 @@ public function isEmpty (): bool {} public function jsonSerialize () {} /** - * Converts the deque to an array - * @link http://www.php.net/manual/en/ds-deque.toarray.php - * @return array An array containing all the values in the same order as the deque. + * {@inheritdoc} */ public function toArray (): array {} /** - * Allocates enough memory for a required capacity - * @link http://www.php.net/manual/en/ds-deque.allocate.php - * @param int $capacity The number of values for which capacity should be allocated. - *Capacity will stay the same if this value is less than or equal to the - * current capacity.
- *Capacity will always be rounded up to the nearest power of 2.
- * @return void No value is returned. + * {@inheritdoc} + * @param int $capacity */ - public function allocate (int $capacity): void {} + public function allocate (int $capacity) {} /** - * Updates all values by applying a callback function to each value - * @link http://www.php.net/manual/en/ds-deque.apply.php - * @param callable $callback mixed - * callback - * mixedvalue - *A callable to apply to each value in the deque.
- *The callback should return what the value should be replaced by.
- * @return void No value is returned. + * {@inheritdoc} + * @param callable $callback */ - public function apply (callable $callback): void {} + public function apply (callable $callback) {} /** - * Returns the current capacity - * @link http://www.php.net/manual/en/ds-deque.capacity.php - * @return int The current capacity. + * {@inheritdoc} */ public function capacity (): int {} /** - * Determines if the deque contains given values - * @link http://www.php.net/manual/en/ds-deque.contains.php - * @param mixed $values Values to check. - * @return bool false if any of the provided values are not in the - * deque, true otherwise. + * {@inheritdoc} + * @param mixed $values [optional] */ - public function contains (mixed ...$values): bool {} + public function contains (...$values): bool {} /** - * Creates a new deque using a callable to - * determine which values to include - * @link http://www.php.net/manual/en/ds-deque.filter.php - * @param callable $callback [optional] bool - * callback - * mixedvalue - *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 \Ds\Deque 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. + * {@inheritdoc} + * @param callable|null $callback [optional] */ - public function filter (callable $callback = null): \Ds\Deque {} + public function filter (?callable $callback = NULL): \Ds\Sequence {} /** - * Attempts to find a value's index - * @link http://www.php.net/manual/en/ds-deque.find.php - * @param mixed $value The value to find. - * @return mixed The index of the value, or false if not found. - *Values will be compared by value and by type.
+ * {@inheritdoc} + * @param mixed $value */ - public function find (mixed $value): mixed {} + public function find ($value = null) {} /** - * Returns the first value in the deque - * @link http://www.php.net/manual/en/ds-deque.first.php - * @return mixed The first value in the deque. + * {@inheritdoc} */ - public function first (): mixed {} + public function first () {} /** - * Returns the value at a given index - * @link http://www.php.net/manual/en/ds-deque.get.php - * @param int $index The index to access, starting at 0. - * @return mixed The value at the requested index. + * {@inheritdoc} + * @param int $index */ - public function get (int $index): mixed {} + public function get (int $index) {} /** - * Inserts values at a given index - * @link http://www.php.net/manual/en/ds-deque.insert.php - * @param int $index The index at which to insert. 0 <= index <= count - *You can insert at the index equal to the number of values.
- * @param mixed $values The value or values to insert. - * @return void No value is returned. + * {@inheritdoc} + * @param int $index + * @param mixed $values [optional] */ - public function insert (int $index, mixed ...$values): void {} + public function insert (int $index, ...$values) {} /** - * Joins all values together as a string - * @link http://www.php.net/manual/en/ds-deque.join.php - * @param string $glue [optional] An optional string to separate each value. - * @return string All values of the deque joined together as a string. + * {@inheritdoc} + * @param string $glue [optional] */ - public function join (string $glue = null): string {} + public function join (string $glue = NULL): string {} /** - * Returns the last value - * @link http://www.php.net/manual/en/ds-deque.last.php - * @return mixed The last value in the deque. + * {@inheritdoc} */ - public function last (): mixed {} + public function last () {} /** - * Returns the result of applying a callback to each value - * @link http://www.php.net/manual/en/ds-deque.map.php - * @param callable $callback mixed - * callback - * mixedvalue - *A callable to apply to each value in the deque.
- *The callable should return what the new value will be in the new deque.
- * @return \Ds\Deque The result of applying a callback to each value in - * the deque. - *The values of the current instance won't be affected.
+ * {@inheritdoc} + * @param callable $callback */ - public function map (callable $callback): \Ds\Deque {} + public function map (callable $callback): \Ds\Sequence {} /** - * Returns the result of adding all given values to the deque - * @link http://www.php.net/manual/en/ds-deque.merge.php - * @param mixed $values A traversable object or an array. - * @return \Ds\Deque The result of adding all given values to the deque, - * effectively the same as adding the values to a copy, then returning that copy. - *The current instance won't be affected.
+ * {@inheritdoc} + * @param mixed $values */ - public function merge (mixed $values): \Ds\Deque {} + public function merge ($values = null): \Ds\Sequence {} /** * {@inheritdoc} @@ -963,200 +635,123 @@ public function offsetSet (mixed $offset = null, mixed $value = null) {} public function offsetUnset (mixed $offset = null) {} /** - * Removes and returns the last value - * @link http://www.php.net/manual/en/ds-deque.pop.php - * @return mixed The removed last value. + * {@inheritdoc} */ - public function pop (): mixed {} + public function pop () {} /** - * Adds values to the end of the deque - * @link http://www.php.net/manual/en/ds-deque.push.php - * @param mixed $values The values to add. - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $values [optional] */ - public function push (mixed ...$values): void {} + public function push (...$values) {} /** - * Reduces the deque to a single value using a callback function - * @link http://www.php.net/manual/en/ds-deque.reduce.php - * @param callable $callback The return value of the previous callback, or initial if - * it's the first iteration. - *The value of the current iteration.
- * @param mixed $initial [optional] The initial value of the carry value. Can be null. - * @return mixed The return value of the final callback. + * {@inheritdoc} + * @param callable $callback + * @param mixed $initial [optional] */ - public function reduce (callable $callback, mixed $initial = null): mixed {} + public function reduce (callable $callback, $initial = NULL) {} /** - * Removes and returns a value by index - * @link http://www.php.net/manual/en/ds-deque.remove.php - * @param int $index The index of the value to remove. - * @return mixed The value that was removed. + * {@inheritdoc} + * @param int $index */ - public function remove (int $index): mixed {} + public function remove (int $index) {} /** - * Reverses the deque in-place - * @link http://www.php.net/manual/en/ds-deque.reverse.php - * @return void No value is returned. + * {@inheritdoc} */ - public function reverse (): void {} + public function reverse () {} /** - * Returns a reversed copy - * @link http://www.php.net/manual/en/ds-deque.reversed.php - * @return \Ds\Deque A reversed copy of the deque. - *- * The current instance is not affected. - *
- *The current instance is not affected.
+ * {@inheritdoc} */ - public function reversed (): \Ds\Deque {} + public function reversed (): \Ds\Sequence {} /** - * Rotates the deque by a given number of rotations - * @link http://www.php.net/manual/en/ds-deque.rotate.php - * @param int $rotations The number of times the deque should be rotated. - * @return void No value is returned.. The deque of the current instance will be rotated. + * {@inheritdoc} + * @param int $rotations */ - public function rotate (int $rotations): void {} + public function rotate (int $rotations) {} /** - * Updates a value at a given index - * @link http://www.php.net/manual/en/ds-deque.set.php - * @param int $index The index of the value to update. - * @param mixed $value The new value. - * @return void No value is returned. + * {@inheritdoc} + * @param int $index + * @param mixed $value */ - public function set (int $index, mixed $value): void {} + public function set (int $index, $value = null) {} /** - * Removes and returns the first value - * @link http://www.php.net/manual/en/ds-deque.shift.php - * @return mixed The first value, which was removed. + * {@inheritdoc} */ - public function shift (): mixed {} + public function shift () {} /** - * Returns a sub-deque of a given range - * @link http://www.php.net/manual/en/ds-deque.slice.php - * @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 $length [optional] 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 \Ds\Deque A sub-deque of the given range. + * {@inheritdoc} + * @param int $index + * @param int|null $length [optional] */ - public function slice (int $index, int $length = null): \Ds\Deque {} + public function slice (int $index, ?int $length = NULL): \Ds\Sequence {} /** - * Sorts the deque in-place - * @link http://www.php.net/manual/en/ds-deque.sort.php - * @param callable $comparator [optional] > - * 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. - *Returning non-integer values from the comparison - * function, such as float, will result in an internal cast to - * int 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 void No value is returned. + * {@inheritdoc} + * @param callable|null $comparator [optional] */ - public function sort (callable $comparator = null): void {} + public function sort (?callable $comparator = NULL) {} /** - * Returns a sorted copy - * @link http://www.php.net/manual/en/ds-deque.sorted.php - * @param callable $comparator [optional] > - * 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. - *Returning non-integer values from the comparison - * function, such as float, will result in an internal cast to - * int 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 \Ds\Deque Returns a sorted copy of the deque. + * {@inheritdoc} + * @param callable|null $comparator [optional] */ - public function sorted (callable $comparator = null): \Ds\Deque {} + public function sorted (?callable $comparator = NULL): \Ds\Sequence {} /** - * Returns the sum of all values in the deque - * @link http://www.php.net/manual/en/ds-deque.sum.php - * @return int|float The sum of all the values in the deque as either a float or int - * depending on the values in the deque. + * {@inheritdoc} */ - public function sum (): int|float {} + public function sum () {} /** - * Adds values to the front of the deque - * @link http://www.php.net/manual/en/ds-deque.unshift.php - * @param mixed $values [optional] The values to add to the front of the deque. - *- * Multiple values will be added in the same order that they are - * passed. - *
- *Multiple values will be added in the same order that they are - * passed.
- * @return void No value is returned. + * {@inheritdoc} + * @param mixed $values [optional] */ - public function unshift (mixed $values = null): void {} + public function unshift (...$values) {} } final class Stack implements \Ds\Collection, \JsonSerializable, \Countable, \Traversable, \IteratorAggregate, \ArrayAccess { /** - * Creates a new instance - * @link http://www.php.net/manual/en/ds-stack.construct.php - * @param mixed $values [optional] A traversable object or an array to use for the initial values. - * @return mixed + * {@inheritdoc} + * @param mixed $values [optional] */ - public function __construct (mixed $values = null): mixed {} + public function __construct ($values = NULL) {} /** - * Allocates enough memory for a required capacity - * @link http://www.php.net/manual/en/ds-stack.allocate.php - * @param int $capacity The number of values for which capacity should be allocated. - *Capacity will stay the same if this value is less than or equal to the - * current capacity.
- * @return void No value is returned. + * {@inheritdoc} + * @param int $capacity */ - public function allocate (int $capacity): void {} + public function allocate (int $capacity) {} /** - * Returns the current capacity - * @link http://www.php.net/manual/en/ds-stack.capacity.php - * @return int The current capacity. + * {@inheritdoc} */ public function capacity (): int {} /** - * Returns the value at the top of the stack - * @link http://www.php.net/manual/en/ds-stack.peek.php - * @return mixed The value at the top of the stack. + * {@inheritdoc} */ - public function peek (): mixed {} + public function peek () {} /** - * Removes and returns the value at the top of the stack - * @link http://www.php.net/manual/en/ds-stack.pop.php - * @return mixed The removed value which was at the top of the stack. + * {@inheritdoc} */ - public function pop (): mixed {} + public function pop () {} /** - * Pushes values onto the stack - * @link http://www.php.net/manual/en/ds-stack.push.php - * @param mixed $values The values to push onto the stack. - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $values [optional] */ - public function push (mixed ...$values): void {} + public function push (...$values) {} /** * {@inheritdoc} @@ -1189,18 +784,14 @@ public function offsetSet (mixed $offset = null, mixed $value = null) {} public function offsetUnset (mixed $offset = null) {} /** - * Removes all values - * @link http://www.php.net/manual/en/ds-stack.clear.php - * @return void No value is returned. + * {@inheritdoc} */ - public function clear (): void {} + public function clear () {} /** - * Returns a shallow copy of the stack - * @link http://www.php.net/manual/en/ds-stack.copy.php - * @return \Ds\Stack Returns a shallow copy of the stack. + * {@inheritdoc} */ - public function copy (): \Ds\Stack {} + public function copy (): \Ds\Collection {} /** * {@inheritdoc} @@ -1208,9 +799,7 @@ public function copy (): \Ds\Stack {} public function count (): int {} /** - * Returns whether the stack is empty - * @link http://www.php.net/manual/en/ds-stack.isempty.php - * @return bool Returns true if the stack is empty, false otherwise. + * {@inheritdoc} */ public function isEmpty (): bool {} @@ -1220,9 +809,7 @@ public function isEmpty (): bool {} public function jsonSerialize () {} /** - * Converts the stack to an array - * @link http://www.php.net/manual/en/ds-stack.toarray.php - * @return array An array containing all the values in the same order as the stack. + * {@inheritdoc} */ public function toArray (): array {} @@ -1233,52 +820,37 @@ final class Queue implements \Ds\Collection, \JsonSerializable, \Countable, \Tra /** - * Creates a new instance - * @link http://www.php.net/manual/en/ds-queue.construct.php - * @param mixed $values [optional] A traversable object or an array to use for the initial values. - * @return mixed + * {@inheritdoc} + * @param mixed $values [optional] */ - public function __construct (mixed $values = null): mixed {} + public function __construct ($values = NULL) {} /** - * Allocates enough memory for a required capacity - * @link http://www.php.net/manual/en/ds-queue.allocate.php - * @param int $capacity The number of values for which capacity should be allocated. - *Capacity will stay the same if this value is less than or equal to the - * current capacity.
- *Capacity will always be rounded up to the nearest power of 2.
- * @return void No value is returned. + * {@inheritdoc} + * @param int $capacity */ - public function allocate (int $capacity): void {} + public function allocate (int $capacity) {} /** - * Returns the current capacity - * @link http://www.php.net/manual/en/ds-queue.capacity.php - * @return int The current capacity. + * {@inheritdoc} */ public function capacity (): int {} /** - * Returns the value at the front of the queue - * @link http://www.php.net/manual/en/ds-queue.peek.php - * @return mixed The value at the front of the queue. + * {@inheritdoc} */ - public function peek (): mixed {} + public function peek () {} /** - * Removes and returns the value at the front of the queue - * @link http://www.php.net/manual/en/ds-queue.pop.php - * @return mixed The removed value which was at the front of the queue. + * {@inheritdoc} */ - public function pop (): mixed {} + public function pop () {} /** - * Pushes values into the queue - * @link http://www.php.net/manual/en/ds-queue.push.php - * @param mixed $values The values to push into the queue. - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $values [optional] */ - public function push (mixed ...$values): void {} + public function push (...$values) {} /** * {@inheritdoc} @@ -1311,18 +883,14 @@ public function offsetSet (mixed $offset = null, mixed $value = null) {} public function offsetUnset (mixed $offset = null) {} /** - * Removes all values - * @link http://www.php.net/manual/en/ds-queue.clear.php - * @return void No value is returned. + * {@inheritdoc} */ - public function clear (): void {} + public function clear () {} /** - * Returns a shallow copy of the queue - * @link http://www.php.net/manual/en/ds-queue.copy.php - * @return \Ds\Queue Returns a shallow copy of the queue. + * {@inheritdoc} */ - public function copy (): \Ds\Queue {} + public function copy (): \Ds\Collection {} /** * {@inheritdoc} @@ -1330,9 +898,7 @@ public function copy (): \Ds\Queue {} public function count (): int {} /** - * Returns whether the queue is empty - * @link http://www.php.net/manual/en/ds-queue.isempty.php - * @return bool Returns true if the queue is empty, false otherwise. + * {@inheritdoc} */ public function isEmpty (): bool {} @@ -1342,9 +908,7 @@ public function isEmpty (): bool {} public function jsonSerialize () {} /** - * Converts the queue to an array - * @link http://www.php.net/manual/en/ds-queue.toarray.php - * @return array An array containing all the values in the same order as the queue. + * {@inheritdoc} */ public function toArray (): array {} @@ -1355,327 +919,190 @@ final class Map implements \Ds\Collection, \JsonSerializable, \Countable, \Trave /** - * Creates a new instance - * @link http://www.php.net/manual/en/ds-map.construct.php - * @param mixed $values A traversable object or an array to use for the initial values. - * @return mixed + * {@inheritdoc} + * @param mixed $values [optional] */ - public function __construct (mixed ...$values): mixed {} + public function __construct ($values = NULL) {} /** - * Allocates enough memory for a required capacity - * @link http://www.php.net/manual/en/ds-map.allocate.php - * @param int $capacity The number of values for which capacity should be allocated. - *Capacity will stay the same if this value is less than or equal to the - * current capacity.
- *Capacity will always be rounded up to the nearest power of 2.
- * @return void No value is returned. + * {@inheritdoc} + * @param int $capacity */ - public function allocate (int $capacity): void {} + public function allocate (int $capacity) {} /** - * Updates all values by applying a callback function to each value - * @link http://www.php.net/manual/en/ds-map.apply.php - * @param callable $callback mixed - * callback - * mixedkey - * mixedvalue - *A callable to apply to each value in the map.
- *The callback should return what the value should be replaced by.
- * @return void No value is returned. + * {@inheritdoc} + * @param callable $callback */ - public function apply (callable $callback): void {} + public function apply (callable $callback) {} /** - * Returns the current capacity - * @link http://www.php.net/manual/en/ds-map.capacity.php - * @return int The current capacity. + * {@inheritdoc} */ public function capacity (): int {} /** - * Creates a new map using keys that aren't in another map - * @link http://www.php.net/manual/en/ds-map.diff.php - * @param \Ds\Map $map The map containing the keys to exclude in the resulting map. - * @return \Ds\Map The result of removing all keys from the current instance that are - * present in a given map. + * {@inheritdoc} + * @param \Ds\Map $map */ public function diff (\Ds\Map $map): \Ds\Map {} /** - * Creates a new map using a callable to determine which pairs to include - * @link http://www.php.net/manual/en/ds-map.filter.php - * @param callable $callback [optional] bool - * callback - * mixedkey - * mixedvalue - *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 \Ds\Map A new map containing all the pairs for which - * either the callback returned true, or all values that - * convert to true if a callback was not provided. + * {@inheritdoc} + * @param callable|null $callback [optional] */ - public function filter (callable $callback = null): \Ds\Map {} + public function filter (?callable $callback = NULL): \Ds\Map {} /** - * Returns the first pair in the map - * @link http://www.php.net/manual/en/ds-map.first.php - * @return \Ds\Pair The first pair in the map. + * {@inheritdoc} */ public function first (): \Ds\Pair {} /** - * Returns the value for a given key - * @link http://www.php.net/manual/en/ds-map.get.php - * @param mixed $key The key to look up. - * @param mixed $default [optional] The optional default value, returned if the key could not be found. - * @return mixed The value mapped to the given key, or the default - * value if provided and the key could not be found in the map. + * {@inheritdoc} + * @param mixed $key + * @param mixed $default [optional] */ - public function get (mixed $key, mixed $default = null): mixed {} + public function get ($key = null, $default = NULL) {} /** - * Determines whether the map contains a given key - * @link http://www.php.net/manual/en/ds-map.haskey.php - * @param mixed $key The key to look for. - * @return bool Returns true if the key could found, false otherwise. + * {@inheritdoc} + * @param mixed $key */ - public function hasKey (mixed $key): bool {} + public function hasKey ($key = null): bool {} /** - * Determines whether the map contains a given value - * @link http://www.php.net/manual/en/ds-map.hasvalue.php - * @param mixed $value The value to look for. - * @return bool Returns true if the value could found, false otherwise. + * {@inheritdoc} + * @param mixed $value */ - public function hasValue (mixed $value): bool {} + public function hasValue ($value = null): bool {} /** - * Creates a new map by intersecting keys with another map - * @link http://www.php.net/manual/en/ds-map.intersect.php - * @param \Ds\Map $map The other map, containing the keys to intersect with. - * @return \Ds\Map The key intersection of the current instance and another map. + * {@inheritdoc} + * @param \Ds\Map $map */ public function intersect (\Ds\Map $map): \Ds\Map {} /** - * Returns a set of the map's keys - * @link http://www.php.net/manual/en/ds-map.keys.php - * @return \Ds\Set A Ds\Set containing all the keys of the map. + * {@inheritdoc} */ public function keys (): \Ds\Set {} /** - * Sorts the map in-place by key - * @link http://www.php.net/manual/en/ds-map.ksort.php - * @param callable $comparator [optional] > - * 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. - *Returning non-integer values from the comparison - * function, such as float, will result in an internal cast to - * int 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 void No value is returned. + * {@inheritdoc} + * @param callable|null $comparator [optional] */ - public function ksort (callable $comparator = null): void {} + public function ksort (?callable $comparator = NULL) {} /** - * Returns a copy, sorted by key - * @link http://www.php.net/manual/en/ds-map.ksorted.php - * @param callable $comparator [optional] > - * 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. - *Returning non-integer values from the comparison - * function, such as float, will result in an internal cast to - * int 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 \Ds\Map Returns a copy of the map, sorted by key. + * {@inheritdoc} + * @param callable|null $comparator [optional] */ - public function ksorted (callable $comparator = null): \Ds\Map {} + public function ksorted (?callable $comparator = NULL): \Ds\Map {} /** - * Returns the last pair of the map - * @link http://www.php.net/manual/en/ds-map.last.php - * @return \Ds\Pair The last pair of the map. + * {@inheritdoc} */ public function last (): \Ds\Pair {} /** - * Returns the result of applying a callback to each value - * @link http://www.php.net/manual/en/ds-map.map.php - * @param callable $callback mixed - * callback - * mixedkey - * mixedvalue - *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.
- * @return \Ds\Map The result of applying a callback to each value in - * the map. - *The keys and values of the current instance won't be affected.
+ * {@inheritdoc} + * @param callable $callback */ public function map (callable $callback): \Ds\Map {} /** - * Returns the result of adding all given associations - * @link http://www.php.net/manual/en/ds-map.merge.php - * @param mixed $values A traversable object or an array. - * @return \Ds\Map The result of associating all keys of a given traversable - * object or array with their corresponding values, combined with the current instance. - *The current instance won't be affected.
+ * {@inheritdoc} + * @param mixed $values */ - public function merge (mixed $values): \Ds\Map {} + public function merge ($values = null): \Ds\Map {} /** - * Returns a sequence containing all the pairs of the map - * @link http://www.php.net/manual/en/ds-map.pairs.php - * @return \Ds\Sequence Ds\Sequence containing all the pairs of the map. + * {@inheritdoc} */ public function pairs (): \Ds\Sequence {} /** - * Associates a key with a value - * @link http://www.php.net/manual/en/ds-map.put.php - * @param mixed $key The key to associate the value with. - * @param mixed $value The value to be associated with the key. - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $key + * @param mixed $value */ - public function put (mixed $key, mixed $value): void {} + public function put ($key = null, $value = null) {} /** - * Associates all key-value pairs of a traversable object or array - * @link http://www.php.net/manual/en/ds-map.putall.php - * @param mixed $pairs traversable object or array. - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $values */ - public function putAll (mixed $pairs): void {} + public function putAll ($values = null) {} /** - * Reduces the map to a single value using a callback function - * @link http://www.php.net/manual/en/ds-map.reduce.php - * @param callable $callback The return value of the previous callback, or initial if - * it's the first iteration. - *The key of the current iteration.
- *The value of the current iteration.
- * @param mixed $initial [optional] The initial value of the carry value. Can be null. - * @return mixed The return value of the final callback. + * {@inheritdoc} + * @param callable $callback + * @param mixed $initial [optional] */ - public function reduce (callable $callback, mixed $initial = null): mixed {} + public function reduce (callable $callback, $initial = NULL) {} /** - * Removes and returns a value by key - * @link http://www.php.net/manual/en/ds-map.remove.php - * @param mixed $key The key to remove. - * @param mixed $default [optional] The optional default value, returned if the key could not be found. - * @return mixed The value that was removed, or the default - * value if provided and the key could not be found in the map. + * {@inheritdoc} + * @param mixed $key + * @param mixed $default [optional] */ - public function remove (mixed $key, mixed $default = null): mixed {} + public function remove ($key = null, $default = NULL) {} /** - * Reverses the map in-place - * @link http://www.php.net/manual/en/ds-map.reverse.php - * @return void No value is returned. + * {@inheritdoc} */ - public function reverse (): void {} + public function reverse () {} /** - * Returns a reversed copy - * @link http://www.php.net/manual/en/ds-map.reversed.php - * @return \Ds\Map A reversed copy of the map. - *- * The current instance is not affected. - *
- *The current instance is not affected.
+ * {@inheritdoc} */ public function reversed (): \Ds\Map {} /** - * Returns the pair at a given positional index - * @link http://www.php.net/manual/en/ds-map.skip.php - * @param int $position The zero-based positional index to return. - * @return \Ds\Pair Returns the Ds\Pair at the given position. + * {@inheritdoc} + * @param int $position */ public function skip (int $position): \Ds\Pair {} /** - * Returns a subset of the map defined by a starting index and length - * @link http://www.php.net/manual/en/ds-map.slice.php - * @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 $length [optional] 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 \Ds\Map A subset of the map defined by a starting index and length. + * {@inheritdoc} + * @param int $index + * @param int|null $length [optional] */ - public function slice (int $index, int $length = null): \Ds\Map {} + public function slice (int $index, ?int $length = NULL): \Ds\Map {} /** - * Sorts the map in-place by value - * @link http://www.php.net/manual/en/ds-map.sort.php - * @param callable $comparator [optional] > - * 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. - *Returning non-integer values from the comparison - * function, such as float, will result in an internal cast to - * int 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 void No value is returned. + * {@inheritdoc} + * @param callable|null $comparator [optional] */ - public function sort (callable $comparator = null): void {} + public function sort (?callable $comparator = NULL) {} /** - * Returns a copy, sorted by value - * @link http://www.php.net/manual/en/ds-map.sorted.php - * @param callable $comparator [optional] > - * 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. - *Returning non-integer values from the comparison - * function, such as float, will result in an internal cast to - * int 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 \Ds\Map Returns a copy of the map, sorted by value. + * {@inheritdoc} + * @param callable|null $comparator [optional] */ - public function sorted (callable $comparator = null): \Ds\Map {} + public function sorted (?callable $comparator = NULL): \Ds\Map {} /** - * Returns the sum of all values in the map - * @link http://www.php.net/manual/en/ds-map.sum.php - * @return int|float The sum of all the values in the map as either a float or int - * depending on the values in the map. + * {@inheritdoc} */ - public function sum (): int|float {} + public function sum () {} /** - * Creates a new map using values from the current instance and another map - * @link http://www.php.net/manual/en/ds-map.union.php - * @param \Ds\Map $map The other map, to combine with the current instance. - * @return \Ds\Map A new map containing all the pairs of the current instance as well as another map. + * {@inheritdoc} + * @param mixed $map */ - public function union (\Ds\Map $map): \Ds\Map {} + public function union ($map = null): \Ds\Map {} /** - * Returns a sequence of the map's values - * @link http://www.php.net/manual/en/ds-map.values.php - * @return \Ds\Sequence A Ds\Sequence containing all the values of the map. + * {@inheritdoc} */ public function values (): \Ds\Sequence {} /** - * Creates a new map using keys of either the current instance or of another map, but not of both - * @link http://www.php.net/manual/en/ds-map.xor.php - * @param \Ds\Map $map The other map. - * @return \Ds\Map A new map containing keys in the current instance as well as another map, - * but not in both. + * {@inheritdoc} + * @param \Ds\Map $map */ public function xor (\Ds\Map $map): \Ds\Map {} @@ -1710,18 +1137,14 @@ public function offsetSet (mixed $offset = null, mixed $value = null) {} public function offsetUnset (mixed $offset = null) {} /** - * Removes all values - * @link http://www.php.net/manual/en/ds-map.clear.php - * @return void No value is returned. + * {@inheritdoc} */ - public function clear (): void {} + public function clear () {} /** - * Returns a shallow copy of the map - * @link http://www.php.net/manual/en/ds-map.copy.php - * @return \Ds\Map Returns a shallow copy of the map. + * {@inheritdoc} */ - public function copy (): \Ds\Map {} + public function copy (): \Ds\Collection {} /** * {@inheritdoc} @@ -1729,9 +1152,7 @@ public function copy (): \Ds\Map {} public function count (): int {} /** - * Returns whether the map is empty - * @link http://www.php.net/manual/en/ds-map.isempty.php - * @return bool Returns true if the map is empty, false otherwise. + * {@inheritdoc} */ public function isEmpty (): bool {} @@ -1741,9 +1162,7 @@ public function isEmpty (): bool {} public function jsonSerialize () {} /** - * Converts the map to an array - * @link http://www.php.net/manual/en/ds-map.toarray.php - * @return array An array containing all the values in the same order as the map. + * {@inheritdoc} */ public function toArray (): array {} @@ -1754,110 +1173,73 @@ final class Set implements \Ds\Collection, \JsonSerializable, \Countable, \Trave /** - * Creates a new instance - * @link http://www.php.net/manual/en/ds-set.construct.php - * @param mixed $values [optional] A traversable object or an array to use for the initial values. - * @return mixed + * {@inheritdoc} + * @param mixed $values [optional] */ - public function __construct (mixed $values = '[]'): mixed {} + public function __construct ($values = NULL) {} /** - * Adds values to the set - * @link http://www.php.net/manual/en/ds-set.add.php - * @param mixed $values Values to add to the set. - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $values [optional] */ - public function add (mixed ...$values): void {} + public function add (...$values) {} /** - * Allocates enough memory for a required capacity - * @link http://www.php.net/manual/en/ds-set.allocate.php - * @param int $capacity The number of values for which capacity should be allocated. - *Capacity will stay the same if this value is less than or equal to the - * current capacity.
- *Capacity will always be rounded up to the nearest power of 2.
- * @return void No value is returned. + * {@inheritdoc} + * @param int $capacity */ - public function allocate (int $capacity): void {} + public function allocate (int $capacity) {} /** - * Returns the current capacity - * @link http://www.php.net/manual/en/ds-set.capacity.php - * @return int The current capacity. + * {@inheritdoc} */ public function capacity (): int {} /** - * Determines if the set contains all values - * @link http://www.php.net/manual/en/ds-set.contains.php - * @param mixed $values Values to check. - * @return bool false if any of the provided values are not in the - * set, true otherwise. + * {@inheritdoc} + * @param mixed $values [optional] */ - public function contains (mixed ...$values): bool {} + public function contains (...$values): bool {} /** - * Creates a new set using values that aren't in another set - * @link http://www.php.net/manual/en/ds-set.diff.php - * @param \Ds\Set $set Set containing the values to exclude. - * @return \Ds\Set A new set containing all values that were not in the other set. + * {@inheritdoc} + * @param \Ds\Set $set */ public function diff (\Ds\Set $set): \Ds\Set {} /** - * Creates a new set using a callable to - * determine which values to include - * @link http://www.php.net/manual/en/ds-set.filter.php - * @param callable $callback [optional] bool - * callback - * mixedvalue - *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 \Ds\Set 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. + * {@inheritdoc} + * @param callable|null $predicate [optional] */ - public function filter (callable $callback = null): \Ds\Set {} + public function filter (?callable $predicate = NULL): \Ds\Set {} /** - * Returns the first value in the set - * @link http://www.php.net/manual/en/ds-set.first.php - * @return mixed The first value in the set. + * {@inheritdoc} */ - public function first (): mixed {} + public function first () {} /** - * Returns the value at a given index - * @link http://www.php.net/manual/en/ds-set.get.php - * @param int $index The index to access, starting at 0. - * @return mixed The value at the requested index. + * {@inheritdoc} + * @param int $index */ - public function get (int $index): mixed {} + public function get (int $index) {} /** - * Creates a new set by intersecting values with another set - * @link http://www.php.net/manual/en/ds-set.intersect.php - * @param \Ds\Set $set The other set. - * @return \Ds\Set The intersection of the current instance and another set. + * {@inheritdoc} + * @param \Ds\Set $set */ public function intersect (\Ds\Set $set): \Ds\Set {} /** - * Joins all values together as a string - * @link http://www.php.net/manual/en/ds-set.join.php - * @param string $glue [optional] An optional string to separate each value. - * @return string All values of the set joined together as a string. + * {@inheritdoc} + * @param string $glue [optional] */ - public function join (string $glue = null): string {} + public function join (string $glue = NULL) {} /** - * Returns the last value in the set - * @link http://www.php.net/manual/en/ds-set.last.php - * @return mixed The last value in the set. + * {@inheritdoc} */ - public function last (): mixed {} + public function last () {} /** * {@inheritdoc} @@ -1866,121 +1248,67 @@ public function last (): mixed {} public function map (callable $callback): \Ds\Set {} /** - * Returns the result of adding all given values to the set - * @link http://www.php.net/manual/en/ds-set.merge.php - * @param mixed $values A traversable object or an array. - * @return \Ds\Set The result of adding all given values to the set, - * effectively the same as adding the values to a copy, then returning that copy. - *The current instance won't be affected.
+ * {@inheritdoc} + * @param mixed $values */ - public function merge (mixed $values): \Ds\Set {} + public function merge ($values = null): \Ds\Set {} /** - * Reduces the set to a single value using a callback function - * @link http://www.php.net/manual/en/ds-set.reduce.php - * @param callable $callback The return value of the previous callback, or initial if - * it's the first iteration. - *The value of the current iteration.
- * @param mixed $initial [optional] The initial value of the carry value. Can be null. - * @return mixed The return value of the final callback. + * {@inheritdoc} + * @param callable $callback + * @param mixed $initial [optional] */ - public function reduce (callable $callback, mixed $initial = null): mixed {} + public function reduce (callable $callback, $initial = NULL) {} /** - * Removes all given values from the set - * @link http://www.php.net/manual/en/ds-set.remove.php - * @param mixed $values The values to remove. - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $values [optional] */ - public function remove (mixed ...$values): void {} + public function remove (...$values) {} /** - * Reverses the set in-place - * @link http://www.php.net/manual/en/ds-set.reverse.php - * @return void No value is returned. + * {@inheritdoc} */ - public function reverse (): void {} + public function reverse () {} /** - * Returns a reversed copy - * @link http://www.php.net/manual/en/ds-set.reversed.php - * @return \Ds\Set A reversed copy of the set. - *- * The current instance is not affected. - *
- *The current instance is not affected.
+ * {@inheritdoc} */ public function reversed (): \Ds\Set {} /** - * Returns a sub-set of a given range - * @link http://www.php.net/manual/en/ds-set.slice.php - * @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 $length [optional] 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 \Ds\Set A sub-set of the given range. + * {@inheritdoc} + * @param int $index + * @param int|null $length [optional] */ - public function slice (int $index, int $length = null): \Ds\Set {} + public function slice (int $index, ?int $length = NULL): \Ds\Set {} /** - * Sorts the set in-place - * @link http://www.php.net/manual/en/ds-set.sort.php - * @param callable $comparator [optional] > - * 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. - *Returning non-integer values from the comparison - * function, such as float, will result in an internal cast to - * int 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 void No value is returned. + * {@inheritdoc} + * @param callable|null $comparator [optional] */ - public function sort (callable $comparator = null): void {} + public function sort (?callable $comparator = NULL) {} /** - * Returns a sorted copy - * @link http://www.php.net/manual/en/ds-set.sorted.php - * @param callable $comparator [optional] > - * 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. - *Returning non-integer values from the comparison - * function, such as float, will result in an internal cast to - * int 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 \Ds\Set Returns a sorted copy of the set. + * {@inheritdoc} + * @param callable|null $comparator [optional] */ - public function sorted (callable $comparator = null): \Ds\Set {} + public function sorted (?callable $comparator = NULL): \Ds\Set {} /** - * Returns the sum of all values in the set - * @link http://www.php.net/manual/en/ds-set.sum.php - * @return int|float The sum of all the values in the set as either a float or int - * depending on the values in the set. + * {@inheritdoc} */ - public function sum (): int|float {} + public function sum () {} /** - * Creates a new set using values from the current instance and another set - * @link http://www.php.net/manual/en/ds-set.union.php - * @param \Ds\Set $set The other set, to combine with the current instance. - * @return \Ds\Set A new set containing all the values of the current instance as well as another set. + * {@inheritdoc} + * @param \Ds\Set $set */ public function union (\Ds\Set $set): \Ds\Set {} /** - * Creates a new set using values in either the current instance or in another set, but not in both - * @link http://www.php.net/manual/en/ds-set.xor.php - * @param \Ds\Set $set The other set. - * @return \Ds\Set A new set containing values in the current instance as well as another set, - * but not in both. + * {@inheritdoc} + * @param \Ds\Set $set */ public function xor (\Ds\Set $set): \Ds\Set {} @@ -2015,18 +1343,14 @@ public function offsetSet (mixed $offset = null, mixed $value = null) {} public function offsetUnset (mixed $offset = null) {} /** - * Removes all values - * @link http://www.php.net/manual/en/ds-set.clear.php - * @return void No value is returned. + * {@inheritdoc} */ - public function clear (): void {} + public function clear () {} /** - * Returns a shallow copy of the set - * @link http://www.php.net/manual/en/ds-set.copy.php - * @return \Ds\Set Returns a shallow copy of the set. + * {@inheritdoc} */ - public function copy (): \Ds\Set {} + public function copy (): \Ds\Collection {} /** * {@inheritdoc} @@ -2034,9 +1358,7 @@ public function copy (): \Ds\Set {} public function count (): int {} /** - * Returns whether the set is empty - * @link http://www.php.net/manual/en/ds-set.isempty.php - * @return bool Returns true if the set is empty, false otherwise. + * {@inheritdoc} */ public function isEmpty (): bool {} @@ -2046,9 +1368,7 @@ public function isEmpty (): bool {} public function jsonSerialize () {} /** - * Converts the set to an array - * @link http://www.php.net/manual/en/ds-set.toarray.php - * @return array An array containing all the values in the same order as the set. + * {@inheritdoc} */ public function toArray (): array {} @@ -2059,51 +1379,37 @@ final class PriorityQueue implements \Ds\Collection, \JsonSerializable, \Countab /** - * Creates a new instance - * @link http://www.php.net/manual/en/ds-priorityqueue.construct.php + * {@inheritdoc} */ public function __construct () {} /** - * Allocates enough memory for a required capacity - * @link http://www.php.net/manual/en/ds-priorityqueue.allocate.php - * @param int $capacity The number of values for which capacity should be allocated. - *Capacity will stay the same if this value is less than or equal to the - * current capacity.
- *Capacity will always be rounded up to the nearest power of 2.
- * @return void No value is returned. + * {@inheritdoc} + * @param int $capacity */ - public function allocate (int $capacity): void {} + public function allocate (int $capacity) {} /** - * Returns the current capacity - * @link http://www.php.net/manual/en/ds-priorityqueue.capacity.php - * @return int The current capacity. + * {@inheritdoc} */ public function capacity (): int {} /** - * Returns the value at the front of the queue - * @link http://www.php.net/manual/en/ds-priorityqueue.peek.php - * @return mixed The value at the front of the queue. + * {@inheritdoc} */ - public function peek (): mixed {} + public function peek () {} /** - * Removes and returns the value with the highest priority - * @link http://www.php.net/manual/en/ds-priorityqueue.pop.php - * @return mixed The removed value which was at the front of the queue. + * {@inheritdoc} */ - public function pop (): mixed {} + public function pop () {} /** - * Pushes values into the queue - * @link http://www.php.net/manual/en/ds-priorityqueue.push.php - * @param mixed $value The value to push into the queue. - * @param int $priority The priority associated with the value. - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $value + * @param mixed $priority */ - public function push (mixed $value, int $priority): void {} + public function push ($value = null, $priority = null) {} /** * {@inheritdoc} @@ -2111,18 +1417,14 @@ public function push (mixed $value, int $priority): void {} public function getIterator (): \Traversable {} /** - * Removes all values - * @link http://www.php.net/manual/en/ds-priorityqueue.clear.php - * @return void No value is returned. + * {@inheritdoc} */ - public function clear (): void {} + public function clear () {} /** - * Returns a shallow copy of the queue - * @link http://www.php.net/manual/en/ds-priorityqueue.copy.php - * @return \Ds\PriorityQueue Returns a shallow copy of the queue. + * {@inheritdoc} */ - public function copy (): \Ds\PriorityQueue {} + public function copy (): \Ds\Collection {} /** * {@inheritdoc} @@ -2130,9 +1432,7 @@ public function copy (): \Ds\PriorityQueue {} public function count (): int {} /** - * Returns whether the queue is empty - * @link http://www.php.net/manual/en/ds-priorityqueue.isempty.php - * @return bool Returns true if the queue is empty, false otherwise. + * {@inheritdoc} */ public function isEmpty (): bool {} @@ -2142,9 +1442,7 @@ public function isEmpty (): bool {} public function jsonSerialize () {} /** - * Converts the queue to an array - * @link http://www.php.net/manual/en/ds-priorityqueue.toarray.php - * @return array An array containing all the values in the same order as the queue. + * {@inheritdoc} */ public function toArray (): array {} @@ -2157,18 +1455,14 @@ final class Pair implements \JsonSerializable { public $value; /** - * Creates a new instance - * @link http://www.php.net/manual/en/ds-pair.construct.php - * @param mixed $key [optional] The key. - * @param mixed $value [optional] The value. - * @return mixed + * {@inheritdoc} + * @param mixed $key [optional] + * @param mixed $value [optional] */ - public function __construct (mixed $key = null, mixed $value = null): mixed {} + public function __construct ($key = NULL, $value = NULL) {} /** - * Returns a shallow copy of the pair - * @link http://www.php.net/manual/en/ds-pair.copy.php - * @return \Ds\Pair Returns a shallow copy of the pair. + * {@inheritdoc} */ public function copy (): \Ds\Pair {} @@ -2178,9 +1472,7 @@ public function copy (): \Ds\Pair {} public function jsonSerialize () {} /** - * Converts the pair to an array - * @link http://www.php.net/manual/en/ds-pair.toarray.php - * @return array An array containing all the values in the same order as the pair. + * {@inheritdoc} */ public function toArray (): array {} diff --git a/plugins/org.eclipse.php.core/Resources/language/php8.3/event.php b/plugins/org.eclipse.php.core/Resources/language/php8.3/event.php index aeda1bd214..0df914346e 100644 --- a/plugins/org.eclipse.php.core/Resources/language/php8.3/event.php +++ b/plugins/org.eclipse.php.core/Resources/language/php8.3/event.php @@ -2,182 +2,69 @@ // Start of event v.3.0.8 -/** - * Event - * class represents and event firing on a file descriptor being ready to read - * from or write to; a file descriptor becoming ready to read from or write - * to(edge-triggered I/O only); a timeout expiring; a signal occurring; a - * user-triggered event. - *Every event is associated with - * EventBase - * . However, event will never fire until it is - * added - * (via - * Event::add - * ). An added event remains in - * pending - * state until the registered event occurs, thus turning it to - * active - * state. To handle events user may register a callback which is called when - * event becomes active. If event is configured - * persistent - * , it remains pending. If it is not persistent, it stops being pending when - * it's callback runs. - * Event::del - * method - * deletes - * event, thus making it non-pending. By means of - * Event::add - * method it could be added again.
- * @link http://www.php.net/manual/en/class.event.php - */ final class Event { - /** - * Indicates that the event should be edge-triggered, if the underlying - * event base backend supports edge-triggered events. This affects the - * semantics of - * Event::READ - * and - * Event::WRITE - * . const ET = 32; - /** - * Indicates that the event is persistent. See - * About event persistence - * . const PERSIST = 16; - /** - * This flag indicates an event that becomes active when the provided file - * descriptor(usually a stream resource, or socket) is ready for reading. const READ = 2; - /** - * This flag indicates an event that becomes active when the provided file - * descriptor(usually a stream resource, or socket) is ready for reading. const WRITE = 4; - /** - * Used to implement signal detection. See "Constructing signal events" - * below. const SIGNAL = 8; - /** - * This flag indicates an event that becomes active after a timeout - * elapses. - *The - * Event::TIMEOUT - * flag is ignored when constructing an event: one can either set a - * timeout when event is - * added - * , or not. It is set in the - * $what - * argument to the callback function when a timeout has occurred.
const TIMEOUT = 1; - /** - * Whether event is pending. See - * About event persistence - * . - * @var bool - * @link http://www.php.net/manual/en/class.event.php#event.props.pending - */ - public readonly bool $pending; + public $pending; public $data; /** - * Constructs Event object - * @link http://www.php.net/manual/en/event.construct.php - * @param EventBase $base The event base to associate with. - * @param mixed $fd stream resource, socket resource, or numeric file descriptor. For timer - * events pass - * -1 - * . For signal events pass the signal number, e.g. - * SIGHUP - * . - * @param int $what Event flags. See - * Event flags - * . - * @param callable $cb The event callback. See - * Event callbacks - * . - * @param mixed $arg [optional] Custom data. If specified, it will be passed to the callback when event - * triggers. - * @return EventBase Returns Event object. - */ - public function __construct (EventBase $base, mixed $fd, int $what, callable $cb, mixed $arg = NULL): EventBase {} - - /** - * Make event non-pending and free resources allocated for this - * event - * @link http://www.php.net/manual/en/event.free.php - * @return void No value is returned. + * {@inheritdoc} + * @param EventBase $base + * @param mixed $fd + * @param int $what + * @param callable $cb + * @param mixed $arg [optional] + */ + public function __construct (EventBase $base, mixed $fd = null, int $what, callable $cb, mixed $arg = NULL) {} + + /** + * {@inheritdoc} */ public function free (): void {} /** - * Re-configures event - * @link http://www.php.net/manual/en/event.set.php - * @param EventBase $base The event base to associate the event with. - * @param mixed $fd Stream resource, socket resource, or numeric file descriptor. For timer - * events pass - * -1 - * . For signal events pass the signal number, e.g. - * SIGHUP - * . - * @param int $what [optional] See - * Event flags - * . - * @param callable $cb [optional] The event callback. See - * Event callbacks - * . - * @param mixed $arg [optional] Custom data associated with the event. It will be passed to the callback - * when the event becomes active. - * @return bool Returns true on success or false on failure. - */ - public function set (EventBase $base, mixed $fd, int $what = null, callable $cb = null, mixed $arg = null): bool {} - - /** - * Returns array with of the names of the methods supported in this version of Libevent - * @link http://www.php.net/manual/en/event.getsupportedmethods.php - * @return array Returns array. + * {@inheritdoc} + * @param EventBase $base + * @param mixed $fd + * @param int $what [optional] + * @param callable|null $cb [optional] + * @param mixed $arg [optional] + */ + public function set (EventBase $base, mixed $fd = null, int $what = NULL, ?callable $cb = NULL, mixed $arg = NULL): bool {} + + /** + * {@inheritdoc} */ public static function getSupportedMethods (): array {} /** - * Makes event pending - * @link http://www.php.net/manual/en/event.add.php - * @param float $timeout [optional] Timeout in seconds. - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param float $timeout [optional] */ - public function add (float $timeout = null): bool {} + public function add (float $timeout = -1): bool {} /** - * Makes event non-pending - * @link http://www.php.net/manual/en/event.del.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ public function del (): bool {} /** - * Set event priority - * @link http://www.php.net/manual/en/event.setpriority.php - * @param int $priority The event priority. - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $priority */ public function setPriority (int $priority): bool {} /** - * Detects whether event is pending or scheduled - * @link http://www.php.net/manual/en/event.pending.php - * @param int $flags One of, or a composition of the following constants: - * Event::READ - * , - * Event::WRITE - * , - * Event::TIMEOUT - * , - * Event::SIGNAL - * . - * @return bool Returns true if event is pending or scheduled. Otherwise false. + * {@inheritdoc} + * @param int $flags */ public function pending (int $flags): bool {} @@ -187,44 +74,29 @@ public function pending (int $flags): bool {} public function removeTimer (): bool {} /** - * Constructs timer event object - * @link http://www.php.net/manual/en/event.timer.php - * @param EventBase $base The associated event base object. - * @param callable $cb The signal event callback. See - * Event callbacks - * . - * @param mixed $arg [optional] Custom data. If specified, it will be passed to the callback when event - * triggers. - * @return Event Returns Event object on success. Otherwise false. + * {@inheritdoc} + * @param EventBase $base + * @param callable $cb + * @param mixed $arg [optional] */ - public static function timer (EventBase $base, callable $cb, mixed $arg = null): Event {} + public static function timer (EventBase $base, callable $cb, mixed $arg = NULL): Event {} /** - * Re-configures timer event - * @link http://www.php.net/manual/en/event.settimer.php - * @param EventBase $base The event base to associate with. - * @param callable $cb The timer event callback. See - * Event callbacks - * . - * @param mixed $arg [optional] Custom data. If specified, it will be passed to the callback when event - * triggers. - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param EventBase $base + * @param callable $cb + * @param mixed $arg [optional] */ - public function setTimer (EventBase $base, callable $cb, mixed $arg = null): bool {} + public function setTimer (EventBase $base, callable $cb, mixed $arg = NULL): bool {} /** - * Constructs signal event object - * @link http://www.php.net/manual/en/event.signal.php - * @param EventBase $base The associated event base object. - * @param int $signum The signal number. - * @param callable $cb The signal event callback. See - * Event callbacks - * . - * @param mixed $arg [optional] Custom data. If specified, it will be passed to the callback when event - * triggers. - * @return Event Returns Event object on success. Otherwise false. + * {@inheritdoc} + * @param EventBase $base + * @param int $signum + * @param callable $cb + * @param mixed $arg [optional] */ - public static function signal (EventBase $base, int $signum, callable $cb, mixed $arg = null): Event {} + public static function signal (EventBase $base, int $signum, callable $cb, mixed $arg = NULL): Event {} /** * {@inheritdoc} @@ -250,99 +122,22 @@ public function delSignal (): bool {} } -/** - * EventBase - * class represents libevent's event base structure. It holds a set of events - * and can poll to determine which events are active. - *Each event base has a - * method - * , or a - * backend - * that it uses to determine which events are ready. The recognized methods - * are: - * select - * , - * poll - * , - * epoll - * , - * kqueue - * , - * devpoll - * , - * evport - * and - * win32 - * .
- *To configure event base to use, or avoid specific backend - * EventConfig - * class can be used.
- *Do - * NOT - * destroy the - * EventBase - * object as long as resources of the associated - * Event - * objects are not released. Otherwise, it will lead to unpredictable - * results!
- * @link http://www.php.net/manual/en/class.eventbase.php - */ final class EventBase { - /** - * Flag used with - * EventBase::loop - * method which means: "block until libevent has an active event, then - * exit once all active events have had their callbacks run". const LOOP_ONCE = 1; - /** - * Flag used with - * EventBase::loop - * method which means: "do not block: see which events are ready now, run - * the callbacks of the highest-priority ones, then exit". const LOOP_NONBLOCK = 2; - /** - * Configuration flag. Do not allocate a lock for the event base, even if - * we have locking set up". const NOLOCK = 1; - /** - * Windows-only configuration flag. Enables the IOCP dispatcher at - * startup. const STARTUP_IOCP = 4; - /** - * Configuration flag. Instead of checking the current time every time the - * event loop is ready to run timeout callbacks, check after each timeout - * callback. const NO_CACHE_TIME = 8; - /** - * If we are using the - * epoll - * backend, this flag says that it is safe to use Libevent's internal - * change-list code to batch up adds and deletes in order to try to do as - * few syscalls as possible. - *Setting this flag can make code run faster, but it may trigger a Linux - * bug: it is not safe to use this flag if one has any fds cloned by - * dup(), or its variants. Doing so will produce strange and - * hard-to-diagnose bugs.
- *This flag can also be activated by settnig the - * EVENT_EPOLL_USE_CHANGELIST - * environment variable.
- *This flag has no effect if one winds up using a backend other than - * epoll - * .
const EPOLL_USE_CHANGELIST = 16; const IGNORE_ENV = 2; const PRECISE_TIMER = 32; /** - * Constructs EventBase object - * @link http://www.php.net/manual/en/eventbase.construct.php - * @param EventConfig $cfg [optional] Optional - * EventConfig - * object. - * @return EventConfig Returns EventBase object. + * {@inheritdoc} + * @param EventConfig|null $cfg [optional] */ - public function __construct (EventConfig $cfg = null): EventConfig {} + public function __construct (?EventConfig $cfg = NULL) {} /** * {@inheritdoc} @@ -355,56 +150,37 @@ final public function __sleep (): array {} final public function __wakeup (): void {} /** - * Returns event method in use - * @link http://www.php.net/manual/en/eventbase.getmethod.php - * @return string String representing used event method(backend). + * {@inheritdoc} */ public function getMethod (): string {} /** - * Returns bitmask of features supported - * @link http://www.php.net/manual/en/eventbase.getfeatures.php - * @return int Returns integer representing a bitmask of supported features. See - * EventConfig::FEATURE_* constants - * . + * {@inheritdoc} */ public function getFeatures (): int {} /** - * Sets number of priorities per event base - * @link http://www.php.net/manual/en/eventbase.priorityinit.php - * @param int $n_priorities The number of priorities per event base. - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $n_priorities */ public function priorityInit (int $n_priorities): bool {} /** - * Dispatch pending events - * @link http://www.php.net/manual/en/eventbase.loop.php - * @param int $flags [optional] Optional flags. One of - * EventBase::LOOP_* - * constants. See - * EventBase constants - * . - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $flags [optional] */ - public function loop (int $flags = null): bool {} + public function loop (int $flags = -1): bool {} /** - * Dispatch pending events - * @link http://www.php.net/manual/en/eventbase.dispatch.php - * @return void Returns true on success or false on failure. + * {@inheritdoc} */ - public function dispatch (): void {} + public function dispatch (): bool {} /** - * Stop dispatching events - * @link http://www.php.net/manual/en/eventbase.exit.php - * @param float $timeout [optional] Optional number of seconds after which the event base should stop - * dispatching events. - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param float $timeout [optional] */ - public function exit (float $timeout = null): bool {} + public function exit (float $timeout = 0.0): bool {} /** * {@inheritdoc} @@ -413,50 +189,32 @@ public function exit (float $timeout = null): bool {} public function set (Event $event): bool {} /** - * Tells event_base to stop dispatching events - * @link http://www.php.net/manual/en/eventbase.stop.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ public function stop (): bool {} /** - * Checks if the event loop was told to exit - * @link http://www.php.net/manual/en/eventbase.gotstop.php - * @return bool Returns true, event loop was told to stop by - * EventBase::stop - * . Otherwise false. + * {@inheritdoc} */ public function gotStop (): bool {} /** - * Checks if the event loop was told to exit - * @link http://www.php.net/manual/en/eventbase.gotexit.php - * @return bool Returns true, event loop was told to exit by - * EventBase::exit - * . Otherwise false. + * {@inheritdoc} */ public function gotExit (): bool {} /** - * Returns the current event base time - * @link http://www.php.net/manual/en/eventbase.gettimeofdaycached.php - * @return float Returns the current - * event base - * time. On failure returns null. + * {@inheritdoc} */ public function getTimeOfDayCached (): float {} /** - * Re-initialize event base(after a fork) - * @link http://www.php.net/manual/en/eventbase.reinit.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ public function reInit (): bool {} /** - * Free resources allocated for this event base - * @link http://www.php.net/manual/en/eventbase.free.php - * @return void No value is returned. + * {@inheritdoc} */ public function free (): void {} @@ -472,35 +230,16 @@ public function resume (): bool {} } -/** - * Represents configuration structure which could be used in construction of - * the - * EventBase - * . - * @link http://www.php.net/manual/en/class.eventconfig.php - */ final class EventConfig { - /** - * Requires a backend method that supports edge-triggered I/O. const FEATURE_ET = 1; - /** - * Requires a backend method where adding or deleting a single event, or - * having a single event become active, is an O(1) operation. const FEATURE_O1 = 2; - /** - * Requires a backend method that can support arbitrary file descriptor - * types, and not just sockets. const FEATURE_FDS = 4; /** - * Constructs EventConfig object - * @link http://www.php.net/manual/en/eventconfig.construct.php - * @return void Returns - * EventConfig - * object. + * {@inheritdoc} */ - public function __construct (): void {} + public function __construct () {} /** * {@inheritdoc} @@ -513,422 +252,186 @@ final public function __sleep (): array {} final public function __wakeup (): void {} /** - * Tells libevent to avoid specific event method - * @link http://www.php.net/manual/en/eventconfig.avoidmethod.php - * @param string $method The backend method to avoid. See - * EventConfig constants - * . - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $method */ public function avoidMethod (string $method): bool {} /** - * Enters a required event method feature that the application demands - * @link http://www.php.net/manual/en/eventconfig.requirefeatures.php - * @param int $feature Bitmask of required features. See - * EventConfig::FEATURE_* constants - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $feature */ public function requireFeatures (int $feature): bool {} /** - * Prevents priority inversion - * @link http://www.php.net/manual/en/eventconfig.setmaxdispatchinterval.php - * @param int $max_interval An interval after which Libevent should stop running callbacks and check - * for more events, or - * 0 - * , if there should be no such interval. - * @param int $max_callbacks A number of callbacks after which Libevent should stop running callbacks - * and check for more events, or - * -1 - * , if there should be no such limit. - * @param int $min_priority A priority below which - * max_interval - * and - * max_callbacks - * should not be enforced. If this is set to - * 0 - * , they are enforced for events of every priority; if it's set to - * 1 - * , they're enforced for events of priority - * 1 - * and above, and so on. - * @return void Returns true on success or false on failure. + * {@inheritdoc} + * @param int $max_interval + * @param int $max_callbacks + * @param int $min_priority */ public function setMaxDispatchInterval (int $max_interval, int $max_callbacks, int $min_priority): void {} /** - * Sets one or more flags to configure the eventual EventBase will be initialized - * @link http://www.php.net/manual/en/eventconfig.setflags.php - * @param int $flags One of EventBase::LOOP_* constants. - * See EventBase constants. - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $flags */ public function setFlags (int $flags): bool {} } -/** - * Represents Libevent's buffer event. - *Usually an application wants to perform some amount of data buffering in - * addition to just responding to events. When we want to write data, for - * example, the usual pattern looks like:
- *Decide that we want to write some data to a connection; put that data in - * a buffer.
- *Wait for the connection to become writable
- *Write as much of the data as we can
- *Remember how much we wrote, and if we still have more data to write, - * wait for the connection to become writable again.
- *This buffered I/O pattern is common enough that Libevent provides a - * generic mechanism for it. A "buffer event" consists of an underlying - * transport (like a socket), a read buffer, and a write buffer. Instead of - * regular events, which give callbacks when the underlying transport is - * ready to be read or written, a buffer event invokes its user-supplied - * callbacks when it has read or written enough data.
- * @link http://www.php.net/manual/en/class.eventbufferevent.php - */ final class EventBufferEvent { - /** - * An event occurred during a read operation on the bufferevent. See the - * other flags for which event it was. const READING = 1; - /** - * An event occurred during a write operation on the bufferevent. See the - * other flags for which event it was. const WRITING = 2; - /** - * Got an end-of-file indication on the buffer event. const EOF = 16; - /** - * An error occurred during a bufferevent operation. For more information - * on what the error was, call - * EventUtil::getLastSocketErrno - * and/or - * EventUtil::getLastSocketError - * . const ERROR = 32; const TIMEOUT = 64; - /** - * Finished a requested connection on the bufferevent. const CONNECTED = 128; - /** - * When the buffer event is freed, close the underlying transport. This - * will close an underlying socket, free an underlying buffer event, etc. const OPT_CLOSE_ON_FREE = 1; - /** - * Automatically allocate locks for the bufferevent, so that it’s safe - * to use from multiple threads. const OPT_THREADSAFE = 2; - /** - * When this flag is set, the bufferevent defers all of its callbacks. See - * Fast - * portable non-blocking network programming with Libevent, Deferred callbacks - * . const OPT_DEFER_CALLBACKS = 4; - /** - * By default, when the bufferevent is set up to be threadsafe, the buffer - * event’s locks are held whenever the any user-provided callback is - * invoked. Setting this option makes Libevent release the buffer - * event’s lock when it’s invoking the callbacks. const OPT_UNLOCK_CALLBACKS = 8; - /** - * The SSL handshake is done const SSL_OPEN = 0; - /** - * SSL is currently performing negotiation as a client const SSL_CONNECTING = 1; - /** - * SSL is currently performing negotiation as a server const SSL_ACCEPTING = 2; - /** - * Numeric file descriptor associated with the buffer event. Normally - * represents a bound socket. Equals to null, if there is no file - * descriptor(socket) associated with the buffer event. - * @var int - * @link http://www.php.net/manual/en/class.eventbufferevent.php#eventbufferevent.props.fd - */ - public int $fd; + public $priority; - /** - * The priority of the events used to implement the buffer event. - * @var int - * @link http://www.php.net/manual/en/class.eventbufferevent.php#eventbufferevent.props.priority - */ - public int $priority; + public $fd; - /** - * Underlying input buffer object( - * EventBuffer - * ) - * @var EventBuffer - * @link http://www.php.net/manual/en/class.eventbufferevent.php#eventbufferevent.props.input - */ - public readonly EventBuffer $input; + public $input; - /** - * Underlying output buffer object( - * EventBuffer - * ) - * @var EventBuffer - * @link http://www.php.net/manual/en/class.eventbufferevent.php#eventbufferevent.props.output - */ - public readonly EventBuffer $output; + public $output; public $allow_ssl_dirty_shutdown; /** - * Constructs EventBufferEvent object - * @link http://www.php.net/manual/en/eventbufferevent.construct.php - * @param EventBase $base Event base that should be associated with the new buffer event. - * @param mixed $socket [optional] May be created as a stream(not necessarily by means of - * sockets - * extension) - * @param int $options [optional] One of - * EventBufferEvent::OPT_* - * constants - * , or - * 0 - * . - * @param callable $readcb [optional] Read event callback. See - * About buffer event - * callbacks - * . - * @param callable $writecb [optional] Write event callback. See - * About buffer event - * callbacks - * . - * @param callable $eventcb [optional] Status-change event callback. See - * About buffer event - * callbacks - * . - * @param mixed $arg [optional] A variable that will be passed to all the callbacks. - * @return EventBase Returns buffer event resource optionally associated with socket resource. - * */ - */ - public function __construct (EventBase $base, mixed $socket = null, int $options = null, callable $readcb = null, callable $writecb = null, callable $eventcb = null, mixed $arg = null): EventBase {} - - /** - * Free a buffer event - * @link http://www.php.net/manual/en/eventbufferevent.free.php - * @return void No value is returned. + * {@inheritdoc} + * @param EventBase $base + * @param mixed $socket [optional] + * @param int $options [optional] + * @param callable|null $readcb [optional] + * @param callable|null $writecb [optional] + * @param callable|null $eventcb [optional] + * @param mixed $arg [optional] + */ + public function __construct (EventBase $base, mixed $socket = NULL, int $options = 0, ?callable $readcb = NULL, ?callable $writecb = NULL, ?callable $eventcb = NULL, mixed $arg = NULL) {} + + /** + * {@inheritdoc} */ public function free (): void {} /** - * Closes file descriptor associated with the current buffer event - * @link http://www.php.net/manual/en/eventbufferevent.close.php - * @return void No value is returned. + * {@inheritdoc} */ public function close (): void {} /** - * Connect buffer event's file descriptor to given address or - * UNIX socket - * @link http://www.php.net/manual/en/eventbufferevent.connect.php - * @param string $addr Should contain an IP address with optional port number, or a path to - * UNIX domain socket. Recognized formats are: - *- * [IPv6Address]:port - * [IPv6Address] - * IPv6Address - * IPv4Address:port - * IPv4Address - * unix:path - *- * Note, - * 'unix:' - * prefix is currently not case sensitive. - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $addr */ public function connect (string $addr): bool {} /** - * Connects to a hostname with optionally asyncronous DNS resolving - * @link http://www.php.net/manual/en/eventbufferevent.connecthost.php - * @param EventDnsBase $dns_base Object of - * EventDnsBase - * in case if DNS is to be resolved asyncronously. Otherwise null. - * @param string $hostname Hostname to connect to. Recognized formats are: - *
- * www.example.com (hostname) - * 1.2.3.4 (ipv4address) - * ::1 (ipv6address) - * [::1] ([ipv6address]) - *- * @param int $port Port number - * @param int $family [optional] Address family. - * EventUtil::AF_UNSPEC - * , - * EventUtil::AF_INET - * , or - * EventUtil::AF_INET6 - * . See - * EventUtil constants - * . - * @return bool Returns true on success or false on failure. - */ - public function connectHost (EventDnsBase $dns_base, string $hostname, int $port, int $family = \EventUtil::AF_UNSPEC): bool {} - - /** - * Returns string describing the last failed DNS lookup attempt - * @link http://www.php.net/manual/en/eventbufferevent.getdnserrorstring.php - * @return string Returns a string describing DNS lookup error, or an empty string for no - * error. + * {@inheritdoc} + * @param EventDnsBase|null $dns_base + * @param string $hostname + * @param int $port + * @param int $family [optional] + */ + public function connectHost (?EventDnsBase $dns_base = null, string $hostname, int $port, int $family = 0): bool {} + + /** + * {@inheritdoc} */ public function getDnsErrorString (): string {} /** - * Assigns read, write and event(status) callbacks - * @link http://www.php.net/manual/en/eventbufferevent.setcallbacks.php - * @param callable $readcb Read event callback. See - * About buffer event - * callbacks - * . - * @param callable $writecb Write event callback. See - * About buffer event - * callbacks - * . - * @param callable $eventcb Status-change event callback. See - * About buffer event - * callbacks - * . - * @param mixed $arg [optional] A variable that will be passed to all the callbacks. - * @return void No value is returned. - */ - public function setCallbacks (callable $readcb, callable $writecb, callable $eventcb, mixed $arg = null): void {} - - /** - * Enable events read, write, or both on a buffer event - * @link http://www.php.net/manual/en/eventbufferevent.enable.php - * @param int $events Event::READ - * , - * Event::WRITE - * , or - * Event::READ - * | - * Event::WRITE - * on a buffer event. - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param callable|null $readcb + * @param callable|null $writecb + * @param callable|null $eventcb + * @param mixed $arg [optional] + */ + public function setCallbacks (?callable $readcb = null, ?callable $writecb = null, ?callable $eventcb = null, mixed $arg = NULL): void {} + + /** + * {@inheritdoc} + * @param int $events */ public function enable (int $events): bool {} /** - * Disable events read, write, or both on a buffer event - * @link http://www.php.net/manual/en/eventbufferevent.disable.php - * @param int $events - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $events */ public function disable (int $events): bool {} /** - * Returns bitmask of events currently enabled on the buffer event - * @link http://www.php.net/manual/en/eventbufferevent.getenabled.php - * @return int Returns integer representing a bitmask of events currently enabled on the - * buffer event + * {@inheritdoc} */ public function getEnabled (): int {} /** - * Returns underlying input buffer associated with current buffer - * event - * @link http://www.php.net/manual/en/eventbufferevent.getinput.php - * @return EventBuffer Returns instance of - * EventBuffer - * input buffer associated with current buffer event. + * {@inheritdoc} */ public function getInput (): EventBuffer {} /** - * Returns underlying output buffer associated with current buffer - * event - * @link http://www.php.net/manual/en/eventbufferevent.getoutput.php - * @return EventBuffer Returns instance of - * EventBuffer - * output buffer associated with current buffer event. + * {@inheritdoc} */ public function getOutput (): EventBuffer {} /** - * Adjusts read and/or write watermarks - * @link http://www.php.net/manual/en/eventbufferevent.setwatermark.php - * @param int $events Bitmask of - * Event::READ - * , - * Event::WRITE - * , or both. - * @param int $lowmark Minimum watermark value. - * @param int $highmark Maximum watermark value. - * 0 - * means "unlimited". - * @return void No value is returned. + * {@inheritdoc} + * @param int $events + * @param int $lowmark + * @param int $highmark */ public function setWatermark (int $events, int $lowmark, int $highmark): void {} /** - * Adds data to a buffer event's output buffer - * @link http://www.php.net/manual/en/eventbufferevent.write.php - * @param string $data Data to be added to the underlying buffer. - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $data */ public function write (string $data): bool {} /** - * Adds contents of the entire buffer to a buffer event's output - * buffer - * @link http://www.php.net/manual/en/eventbufferevent.writebuffer.php - * @param EventBuffer $buf Source - * EventBuffer - * object. - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param EventBuffer $buf */ public function writeBuffer (EventBuffer $buf): bool {} /** - * Read buffer's data - * @link http://www.php.net/manual/en/eventbufferevent.read.php - * @param int $size Maximum number of bytes to read - * @return string Returns string of data read from the input buffer. + * {@inheritdoc} + * @param int $size */ - public function read (int $size): string {} + public function read (int $size): ?string {} /** - * Drains the entire contents of the input buffer and places them into buf - * @link http://www.php.net/manual/en/eventbufferevent.readbuffer.php - * @param EventBuffer $buf Target buffer - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param EventBuffer $buf */ public function readBuffer (EventBuffer $buf): bool {} /** - * Creates two buffer events connected to each other - * @link http://www.php.net/manual/en/eventbufferevent.createpair.php - * @param EventBase $base Associated event base - * @param int $options [optional] EventBufferEvent::OPT_* constants - * combined with bitwise - * OR - * operator. - * @return array Returns array of two - * EventBufferEvent - * objects connected to each other. + * {@inheritdoc} + * @param EventBase $base + * @param int $options [optional] */ - public static function createPair (EventBase $base, int $options = null): array {} + public static function createPair (EventBase $base, int $options = 0): array|false {} /** - * Assign a priority to a bufferevent - * @link http://www.php.net/manual/en/eventbufferevent.setpriority.php - * @param int $priority Priority value. - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $priority */ public function setPriority (int $priority): bool {} /** - * Set the read and write timeout for a buffer event - * @link http://www.php.net/manual/en/eventbufferevent.settimeouts.php - * @param float $timeout_read Read timeout - * @param float $timeout_write Write timeout - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param float $timeout_read + * @param float $timeout_write */ public function setTimeouts (float $timeout_read, float $timeout_write): bool {} @@ -942,601 +445,288 @@ public function setTimeouts (float $timeout_read, float $timeout_write): bool {} public static function createSslFilter (EventBufferEvent $unnderlying, EventSslContext $ctx, int $state, int $options = 0): EventBufferEvent {} /** - * Creates a new SSL buffer event to send its data over an SSL on a socket - * @link http://www.php.net/manual/en/eventbufferevent.sslsocket.php - * @param EventBase $base Associated event base. - * @param mixed $socket Socket to use for this SSL. Can be stream or socket resource, numeric - * file descriptor, or null. If - * socket - * is null, it is assumed that the file descriptor for the socket will be - * assigned later, for instance, by means of - * EventBufferEvent::connectHost - * method. - * @param EventSslContext $ctx Object of - * EventSslContext - * class. - * @param int $state The current state of SSL connection: - * EventBufferEvent::SSL_OPEN - * , - * EventBufferEvent::SSL_ACCEPTING - * or - * EventBufferEvent::SSL_CONNECTING - * . - * @param int $options [optional] The buffer event options. - * @return EventBufferEvent Returns - * EventBufferEvent - * object. - */ - public static function sslSocket (EventBase $base, mixed $socket, EventSslContext $ctx, int $state, int $options = null): EventBufferEvent {} - - /** - * Returns most recent OpenSSL error reported on the buffer event - * @link http://www.php.net/manual/en/eventbufferevent.sslerror.php - * @return string Returns OpenSSL error string reported on the buffer event, or false, if - * there is no more error to return. + * {@inheritdoc} + * @param EventBase $base + * @param mixed $socket + * @param EventSslContext $ctx + * @param int $state + * @param int $options [optional] + */ + public static function sslSocket (EventBase $base, mixed $socket = null, EventSslContext $ctx, int $state, int $options = 0): EventBufferEvent {} + + /** + * {@inheritdoc} */ public function sslError (): string {} /** - * Tells a bufferevent to begin SSL renegotiation - * @link http://www.php.net/manual/en/eventbufferevent.sslrenegotiate.php - * @return void No value is returned. + * {@inheritdoc} */ public function sslRenegotiate (): void {} /** - * Returns a textual description of the cipher - * @link http://www.php.net/manual/en/eventbufferevent.sslgetcipherinfo.php - * @return string Returns a textual description of the cipher on success, or false on error. + * {@inheritdoc} */ public function sslGetCipherInfo (): string {} /** - * Returns the current cipher name of the SSL connection - * @link http://www.php.net/manual/en/eventbufferevent.sslgetciphername.php - * @return string Returns the current cipher name of the SSL connection, or false on error. + * {@inheritdoc} */ public function sslGetCipherName (): string {} /** - * Returns version of cipher used by current SSL connection - * @link http://www.php.net/manual/en/eventbufferevent.sslgetcipherversion.php - * @return string Returns the current cipher version of the SSL connection, or false on error. + * {@inheritdoc} */ public function sslGetCipherVersion (): string {} /** - * Returns the name of the protocol used for current SSL connection - * @link http://www.php.net/manual/en/eventbufferevent.sslgetprotocol.php - * @return string Returns the name of the protocol used for current SSL connection. + * {@inheritdoc} */ public function sslGetProtocol (): string {} } -/** - * EventBuffer - * represents Libevent's "evbuffer", an utility functionality for buffered - * I/O. - *
Event buffers are meant to be generally useful for doing the "buffer" part - * of buffered network I/O.
- * @link http://www.php.net/manual/en/class.eventbuffer.php - */ class EventBuffer { - /** - * The end of line is any sequence of any number of carriage return and - * linefeed characters. This format is not very useful; it exists mainly - * for backward compatibility. const EOL_ANY = 0; - /** - * The end of the line is an optional carriage return, followed by a - * linefeed. (In other words, it is either a - * "\r\n" - * or a - * "\n" - * .) This format is useful in parsing text-based Internet protocols, - * since the standards generally prescribe a - * "\r\n" - * line-terminator, but nonconformant clients sometimes say just - * "\n" - * . const EOL_CRLF = 1; - /** - * The end of a line is a single carriage return, followed by a single - * linefeed. (This is also known as - * "\r\n" - * . The ASCII values are - * 0x0D - * 0x0A - * ). const EOL_CRLF_STRICT = 2; - /** - * The end of a line is a single linefeed character. (This is also known - * as - * "\n" - * . It is ASCII value is - * 0x0A - * .) const EOL_LF = 3; const EOL_NUL = 4; - /** - * Flag used as argument of - * EventBuffer::setPosition - * method. If this flag specified, the position pointer is moved to an - * absolute position within the buffer. const PTR_SET = 0; - /** - * The same as - * EventBuffer::PTR_SET - * , except this flag causes - * EventBuffer::setPosition - * method to move position forward up to the specified number of - * bytes(instead of setting absolute position). const PTR_ADD = 1; - /** - * The number of bytes stored in an event buffer. - * @var int - * @link http://www.php.net/manual/en/class.eventbuffer.php#eventbuffer.props.length - */ - public readonly int $length; + public $length; - /** - * The number of bytes stored contiguously at the front of the buffer. The - * bytes in a buffer may be stored in multiple separate chunks of memory; - * the property returns the number of bytes currently stored in the first - * chunk. - * @var int - * @link http://www.php.net/manual/en/class.eventbuffer.php#eventbuffer.props.contiguous_space - */ - public readonly int $contiguous_space; + public $contiguous_space; /** - * Constructs EventBuffer object - * @link http://www.php.net/manual/en/eventbuffer.construct.php - * @return void Returns EventBuffer object. + * {@inheritdoc} */ - public function __construct (): void {} + public function __construct () {} /** - * Prevent calls that modify an event buffer from succeeding - * @link http://www.php.net/manual/en/eventbuffer.freeze.php - * @param bool $at_front Whether to disable changes to the front or end of the buffer. - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param bool $at_front */ public function freeze (bool $at_front): bool {} /** - * Re-enable calls that modify an event buffer - * @link http://www.php.net/manual/en/eventbuffer.unfreeze.php - * @param bool $at_front Whether to enable events at the front or at the end of the buffer. - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param bool $at_front */ public function unfreeze (bool $at_front): bool {} /** - * Acquires a lock on buffer - * @link http://www.php.net/manual/en/eventbuffer.lock.php + * {@inheritdoc} * @param bool $at_front - * @return void No value is returned. */ public function lock (bool $at_front): void {} /** - * Releases lock acquired by EventBuffer::lock - * @link http://www.php.net/manual/en/eventbuffer.unlock.php + * {@inheritdoc} * @param bool $at_front - * @return bool Returns true on success or false on failure. */ - public function unlock (bool $at_front): bool {} + public function unlock (bool $at_front): void {} /** - * @link http://www.php.net/manual/en/eventbuffer.enablelocking.php - * @return void No value is returned. + * {@inheritdoc} */ public function enableLocking (): void {} /** - * Append data to the end of an event buffer - * @link http://www.php.net/manual/en/eventbuffer.add.php - * @param string $data String to be appended to the end of the buffer. - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $data */ public function add (string $data): bool {} /** - * Read data from an evbuffer and drain the bytes read - * @link http://www.php.net/manual/en/eventbuffer.read.php - * @param int $max_bytes Maxmimum number of bytes to read from the buffer. - * @return string Returns string read, or false on failure. + * {@inheritdoc} + * @param int $max_bytes */ public function read (int $max_bytes): string {} /** - * Move all data from a buffer provided to the current instance of EventBuffer - * @link http://www.php.net/manual/en/eventbuffer.addbuffer.php - * @param EventBuffer $buf The source EventBuffer object. - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param EventBuffer $buf */ public function addBuffer (EventBuffer $buf): bool {} /** - * Moves the specified number of bytes from a source buffer to the - * end of the current buffer - * @link http://www.php.net/manual/en/eventbuffer.appendfrom.php - * @param EventBuffer $buf Source buffer. - * @param int $len - * @return int Returns the number of bytes read. + * {@inheritdoc} + * @param EventBuffer $buf + * @param int $len */ public function appendFrom (EventBuffer $buf, int $len): int {} /** - * Reserves space in buffer - * @link http://www.php.net/manual/en/eventbuffer.expand.php - * @param int $len The number of bytes to reserve for the buffer - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $len */ public function expand (int $len): bool {} /** - * Prepend data to the front of the buffer - * @link http://www.php.net/manual/en/eventbuffer.prepend.php - * @param string $data String to be prepended to the front of the buffer. - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $data */ public function prepend (string $data): bool {} /** - * Moves all data from source buffer to the front of current buffer - * @link http://www.php.net/manual/en/eventbuffer.prependbuffer.php - * @param EventBuffer $buf Source buffer. - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param EventBuffer $buf */ public function prependBuffer (EventBuffer $buf): bool {} /** - * Removes specified number of bytes from the front of the buffer - * without copying it anywhere - * @link http://www.php.net/manual/en/eventbuffer.drain.php - * @param int $len The number of bytes to remove from the buffer. - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $len */ public function drain (int $len): bool {} /** - * Copies out specified number of bytes from the front of the buffer - * @link http://www.php.net/manual/en/eventbuffer.copyout.php - * @param string $data Output string. - * @param int $max_bytes The number of bytes to copy. - * @return int Returns the number of bytes copied, or - * -1 - * on failure. + * {@inheritdoc} + * @param string $data + * @param int $max_bytes */ public function copyout (string &$data, int $max_bytes): int {} /** - * Extracts a line from the front of the buffer - * @link http://www.php.net/manual/en/eventbuffer.readline.php - * @param int $eol_style One of - * EventBuffer:EOL_* constants - * . - * @return string On success returns the line read from the buffer, otherwise null. + * {@inheritdoc} + * @param int $eol_style */ - public function readLine (int $eol_style): string {} + public function readLine (int $eol_style): ?string {} /** - * Scans the buffer for an occurrence of a string - * @link http://www.php.net/manual/en/eventbuffer.search.php - * @param string $what String to search. - * @param int $start [optional] Start search position. - * @param int $end [optional] End search position. - * @return mixed Returns numeric position of the first occurrence of the string in the - * buffer, or false if string is not found. + * {@inheritdoc} + * @param string $what + * @param int $start [optional] + * @param int $end [optional] */ - public function search (string $what, int $start = -1, int $end = -1): mixed {} + public function search (string $what, int $start = -1, int $end = -1): int|false {} /** - * Scans the buffer for an occurrence of an end of line - * @link http://www.php.net/manual/en/eventbuffer.searcheol.php - * @param int $start [optional] Start search position. - * @param int $eol_style [optional] One of - * EventBuffer:EOL_* constants - * . - * @return mixed Returns numeric position of the first occurrence of end-of-line symbol in - * the buffer, or false if not found. + * {@inheritdoc} + * @param int $start [optional] + * @param int $eol_style [optional] */ - public function searchEol (int $start = -1, int $eol_style = ' - EventBuffer::EOL_ANY - '): mixed {} + public function searchEol (int $start = -1, int $eol_style = 0): int|false {} /** - * Linearizes data within buffer - * and returns it's contents as a string - * @link http://www.php.net/manual/en/eventbuffer.pullup.php - * @param int $size The number of bytes required to be contiguous within the buffer. - * @return string If - * size - * is greater than the number of bytes in the buffer, the function returns - * null. Otherwise, - * EventBuffer::pullup - * returns string. + * {@inheritdoc} + * @param int $size */ - public function pullup (int $size): string {} + public function pullup (int $size): ?string {} /** - * Write contents of the buffer to a file or socket - * @link http://www.php.net/manual/en/eventbuffer.write.php - * @param mixed $fd Socket resource, stream or numeric file descriptor associated normally - * associated with a socket. - * @param int $howmuch [optional] The maximum number of bytes to write. - * @return int Returns the number of bytes written, or false on error. + * {@inheritdoc} + * @param mixed $fd + * @param int $howmuch [optional] */ - public function write (mixed $fd, int $howmuch = null): int {} + public function write (mixed $fd = null, int $howmuch = -1): int|false {} /** - * Read data from a file onto the end of the buffer - * @link http://www.php.net/manual/en/eventbuffer.readfrom.php - * @param mixed $fd Socket resource, stream, or numeric file descriptor. - * @param int $howmuch Maxmimum number of bytes to read. - * @return int Returns the number of bytes read, or false on failure. + * {@inheritdoc} + * @param mixed $fd + * @param int $howmuch [optional] */ - public function readFrom (mixed $fd, int $howmuch): int {} + public function readFrom (mixed $fd = null, int $howmuch = -1): int|false {} /** - * Substracts a portion of the buffer data - * @link http://www.php.net/manual/en/eventbuffer.substr.php - * @param int $start The start position of data to be substracted. - * @param int $length [optional] Maximum number of bytes to substract. - * @return string Returns the data substracted as a - * string - * on success, or false on failure. + * {@inheritdoc} + * @param int $start + * @param int $length [optional] */ - public function substr (int $start, int $length = null): string {} + public function substr (int $start, int $length = -1): string|false {} } -/** - * Represents Libevent's DNS base structure. Used to resolve DNS - * asyncronously, parse configuration files like resolv.conf etc. - * @link http://www.php.net/manual/en/class.eventdnsbase.php - */ final class EventDnsBase { - /** - * Tells to read the domain and search fields from the - * resolv.conf - * file and the - * ndots - * option, and use them to decide which domains(if any) to search for - * hostnames that aren’t fully-qualified. const OPTION_SEARCH = 1; - /** - * Tells to learn the nameservers from the - * resolv.conf - * file. const OPTION_NAMESERVERS = 2; const OPTION_MISC = 4; - /** - * Tells to read a list of hosts from - * /etc/hosts - * as part of loading the - * resolv.conf - * file. const OPTION_HOSTSFILE = 8; - /** - * Tells to learn as much as it can from the - * resolv.conf - * file. const OPTIONS_ALL = 15; /** - * Constructs EventDnsBase object - * @link http://www.php.net/manual/en/eventdnsbase.construct.php - * @param EventBase $base Event base. - * @param bool $initialize If the - * initialize - * argument is true, it tries to configure the DNS base sensibly given - * your operating system’s default. Otherwise, it leaves the event DNS - * base empty, with no nameservers or options configured. In the latter - * case DNS base should be configured manually, e.g. with - * EventDnsBase::parseResolvConf - * . - * @return EventBase Returns EventDnsBase object. - */ - public function __construct (EventBase $base, bool $initialize): EventBase {} - - /** - * Scans the resolv.conf-formatted file - * @link http://www.php.net/manual/en/eventdnsbase.parseresolvconf.php - * @param int $flags Determines what information is parsed from the - * resolv.conf - * file. See the man page for - * resolv.conf - * for the format of this file. - *The following directives are not parsed from the file: - * sortlist, rotate, no-check-names, inet6, debug - * .
- *If this function encounters an error, the possible return values are: - *
- * 1 = failed to open file - * 2 = failed to stat file - * 3 = file too large - * 4 = out of memory - * 5 = short read from file - * 6 = no nameservers listed in the file - *
- * @param string $filename Path to - * resolv.conf - * file. - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param EventBase $base + * @param bool $initialize + */ + public function __construct (EventBase $base, bool $initialize) {} + + /** + * {@inheritdoc} + * @param int $flags + * @param string $filename */ public function parseResolvConf (int $flags, string $filename): bool {} /** - * Adds a nameserver to the DNS base - * @link http://www.php.net/manual/en/eventdnsbase.addnameserverip.php - * @param string $ip The nameserver string, either as an IPv4 address, an IPv6 address, an - * IPv4 address with a port ( - * IPv4:Port - * ), or an IPv6 address with a port ( - * [IPv6]:Port - * ). - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $ip */ public function addNameserverIp (string $ip): bool {} /** - * Loads a hosts file (in the same format as /etc/hosts) from hosts file - * @link http://www.php.net/manual/en/eventdnsbase.loadhosts.php - * @param string $hosts Path to the hosts' file. - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $hosts */ public function loadHosts (string $hosts): bool {} /** - * Removes all current search suffixes - * @link http://www.php.net/manual/en/eventdnsbase.clearsearch.php - * @return void No value is returned. + * {@inheritdoc} */ public function clearSearch (): void {} /** - * Adds a domain to the list of search domains - * @link http://www.php.net/manual/en/eventdnsbase.addsearch.php - * @param string $domain Search domain. - * @return void No value is returned. + * {@inheritdoc} + * @param string $domain */ public function addSearch (string $domain): void {} /** - * Set the 'ndots' parameter for searches - * @link http://www.php.net/manual/en/eventdnsbase.setsearchndots.php - * @param int $ndots The number of dots. - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $ndots */ - public function setSearchNdots (int $ndots): bool {} + public function setSearchNdots (int $ndots): void {} /** - * Set the value of a configuration option - * @link http://www.php.net/manual/en/eventdnsbase.setoption.php - * @param string $option The currently available configuration options are: - * "ndots" - * , - * "timeout" - * , - * "max-timeouts" - * , - * "max-inflight" - * , and - * "attempts" - * . - * @param string $value Option value. - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $option + * @param string $value */ public function setOption (string $option, string $value): bool {} /** - * Gets the number of configured nameservers - * @link http://www.php.net/manual/en/eventdnsbase.countnameservers.php - * @return int Returns the number of configured nameservers(not necessarily the number of - * running nameservers). This is useful for double-checking whether our calls - * to the various nameserver configuration functions have been successful. + * {@inheritdoc} */ public function countNameservers (): int {} } -/** - * Represents a connection listener. - * @link http://www.php.net/manual/en/class.eventlistener.php - */ final class EventListener { - /** - * By default Libevent turns underlying file descriptors, or sockets, to - * non-blocking mode. This flag tells Libevent to leave them in blocking - * mode. const OPT_LEAVE_SOCKETS_BLOCKING = 1; - /** - * If this option is set, the connection listener closes its underlying - * socket when the - * EventListener - * object is freed. const OPT_CLOSE_ON_FREE = 2; - /** - * If this option is set, the connection listener sets the close-on-exec - * flag on the underlying listener socket. See platform documentation for - * fcntl - * and - * FD_CLOEXEC - * for more information. const OPT_CLOSE_ON_EXEC = 4; - /** - * By default on some platforms, once a listener socket is closed, no - * other socket can bind to the same port until a while has passed. - * Setting this option makes Libevent mark the socket as reusable, so that - * once it is closed, another socket can be opened to listen on the same - * port. const OPT_REUSEABLE = 8; const OPT_DISABLED = 32; - /** - * Allocate locks for the listener, so that it’s safe to use it from - * multiple threads. const OPT_THREADSAFE = 16; const OPT_DEFERRED_ACCEPT = 64; + public $fd; + /** - * Numeric file descriptor of the underlying socket. (Added in - * event-1.6.0 - * .) - * @var int - * @link http://www.php.net/manual/en/class.eventlistener.php#eventlistener.props.fd - */ - public readonly int $fd; - - /** - * Creates new connection listener associated with an event base - * @link http://www.php.net/manual/en/eventlistener.construct.php - * @param EventBase $base Associated event base. - * @param callable $cb A - * callable - * that will be invoked when new connection received. - * @param mixed $data Custom user data attached to - * cb - * . - * @param int $flags Bit mask of - * EventListener::OPT_* - * constants. See - * EventListener constants - * . - * @param int $backlog Controls the maximum number of pending connections that the network - * stack should allow to wait in a not-yet-accepted state at any time; see - * documentation for your system’s - * listen - * function for more details. If - * backlog - * is negative, Libevent tries to pick a good value for the - * backlog - * ; if it is zero, Event assumes that - * listen - * is already called on the socket( - * target - * ) - * @param mixed $target May be string, socket resource, or a stream associated with a socket. In - * case if - * target - * is a string, the string will be parsed as network address. It will be - * interpreted as a UNIX domain socket path, if prefixed with - * 'unix:' - * , e.g. - * 'unix:/tmp/my.sock' - * . - * @return EventBase Returns - * EventListener - * object representing the event connection listener. - */ - public function __construct (EventBase $base, callable $cb, mixed $data, int $flags, int $backlog, mixed $target): EventBase {} + * {@inheritdoc} + * @param EventBase $base + * @param callable $cb + * @param mixed $data + * @param int $flags + * @param int $backlog + * @param mixed $target + */ + public function __construct (EventBase $base, callable $cb, mixed $data = null, int $flags, int $backlog, mixed $target = null) {} /** * {@inheritdoc} @@ -1554,136 +744,53 @@ final public function __wakeup (): void {} public function free (): void {} /** - * Enables an event connect listener object - * @link http://www.php.net/manual/en/eventlistener.enable.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ public function enable (): bool {} /** - * Disables an event connect listener object - * @link http://www.php.net/manual/en/eventlistener.disable.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ public function disable (): bool {} /** - * The setCallback purpose - * @link http://www.php.net/manual/en/eventlistener.setcallback.php - * @param callable $cb The new callback for new connections. Ignored if null. - *Should match the following prototype:
- *
- * listener
- *
- *
- * The - * EventListener - * object. - *
- * fd - *- * The file descriptor or a resource associated with the listener. - *
- * address - *- * Array of two elements: IP address and the - * server - * port. - *
- * arg - *- * User custom data attached to the callback. - *
- * - *The - * EventListener - * object.
- *The file descriptor or a resource associated with the listener.
- *Array of two elements: IP address and the - * server - * port.
- *User custom data attached to the callback.
- * @param mixed $arg [optional] Custom user data attached to the callback. Ignored if null. - * @return void No value is returned. - */ - public function setCallback (callable $cb, mixed $arg = null): void {} - - /** - * Set event listener's error callback - * @link http://www.php.net/manual/en/eventlistener.seterrorcallback.php - * @param string $cb The error callback. Should match the following prototype: - *
- * listener
- *
- *
- * The - * EventListener - * object. - *
- * data - *- * User custom data attached to the callback. - *
- * - *The - * EventListener - * object.
- *User custom data attached to the callback.
- * @return void - */ - public function setErrorCallback (string $cb): void {} - - /** - * Returns event base associated with the event listener - * @link http://www.php.net/manual/en/eventlistener.getbase.php - * @return void Returns event base associated with the event listener. - */ - public function getBase (): void {} - - /** - * Retreives the current address to which the - * listener's socket is bound - * @link http://www.php.net/manual/en/eventlistener.getsocketname.php - * @param string $address Output parameter. IP-address depending on the socket address family. - * @param mixed $port [optional] Output parameter. The port the socket is bound to. - * @return bool Returns true on success or false on failure. - */ - public function getSocketName (string &$address, mixed &$port = null): bool {} + * {@inheritdoc} + * @param callable $cb + * @param mixed $arg [optional] + */ + public function setCallback (callable $cb, mixed $arg = NULL): void {} + + /** + * {@inheritdoc} + * @param callable $cb + */ + public function setErrorCallback (callable $cb): void {} + + /** + * {@inheritdoc} + */ + public function getBase (): EventBase {} + + /** + * {@inheritdoc} + * @param mixed $address + * @param mixed $port + */ + public function getSocketName (mixed &$address = null, mixed &$port = null): bool {} } -/** - * Represents an HTTP connection. - * @link http://www.php.net/manual/en/class.eventhttpconnection.php - */ final class EventHttpConnection { /** - * Constructs EventHttpConnection object - * @link http://www.php.net/manual/en/eventhttpconnection.construct.php - * @param EventBase $base Associated event base. - * @param EventDnsBase $dns_base If - * dns_base - * is null, hostname resolution will block. - * @param string $address The address to connect to. - * @param int $port The port to connect to. - * @param EventSslContext $ctx [optional] EventSslContext - * class object. Enables OpenSSL. - *This parameter is available only if - * Event - * is compiled with OpenSSL support and only with - * Libevent - * 2.1.0-alpha - * and higher.
- * @return EventBase Returns - * EventHttpConnection - * object. + * {@inheritdoc} + * @param EventBase $base + * @param EventDnsBase|null $dns_base + * @param string $address + * @param int $port + * @param EventSslContext|null $ctx [optional] */ - public function __construct (EventBase $base, EventDnsBase $dns_base, string $address, int $port, EventSslContext $ctx = null): EventBase {} + public function __construct (EventBase $base, ?EventDnsBase $dns_base = null, string $address, int $port, ?EventSslContext $ctx = NULL) {} /** * {@inheritdoc} @@ -1696,124 +803,78 @@ final public function __sleep (): array {} final public function __wakeup (): void {} /** - * Returns event base associated with the connection - * @link http://www.php.net/manual/en/eventhttpconnection.getbase.php - * @return EventBase On success returns - * EventBase - * object associated with the connection. Otherwise false. + * {@inheritdoc} */ - public function getBase (): EventBase {} + public function getBase (): EventBase|false {} /** - * Gets the remote address and port associated with the connection - * @link http://www.php.net/manual/en/eventhttpconnection.getpeer.php - * @param string $address Address of the peer. - * @param int $port Port of the peer. - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $address + * @param mixed $port */ - public function getPeer (string &$address, int &$port): void {} + public function getPeer (mixed &$address = null, mixed &$port = null): void {} /** - * Sets the IP address from which HTTP connections are made - * @link http://www.php.net/manual/en/eventhttpconnection.setlocaladdress.php - * @param string $address The IP address from which HTTP connections are made. - * @return void No value is returned. + * {@inheritdoc} + * @param string $address */ public function setLocalAddress (string $address): void {} /** - * Sets the local port from which connections are made - * @link http://www.php.net/manual/en/eventhttpconnection.setlocalport.php - * @param int $port The port number. - * @return void + * {@inheritdoc} + * @param int $port */ public function setLocalPort (int $port): void {} /** - * Sets the timeout for the connection - * @link http://www.php.net/manual/en/eventhttpconnection.settimeout.php - * @param int $timeout Timeout in seconds. - * @return void No value is returned. + * {@inheritdoc} + * @param int $timeout */ public function setTimeout (int $timeout): void {} /** - * Sets maximum header size - * @link http://www.php.net/manual/en/eventhttpconnection.setmaxheaderssize.php - * @param string $max_size The maximum header size in bytes. - * @return void No value is returned. + * {@inheritdoc} + * @param int $max_size */ - public function setMaxHeadersSize (string $max_size): void {} + public function setMaxHeadersSize (int $max_size): void {} /** - * Sets maximum body size for the connection - * @link http://www.php.net/manual/en/eventhttpconnection.setmaxbodysize.php - * @param string $max_size The maximum body size in bytes. - * @return void No value is returned. + * {@inheritdoc} + * @param int $max_size */ - public function setMaxBodySize (string $max_size): void {} + public function setMaxBodySize (int $max_size): void {} /** - * Sets the retry limit for the connection - * @link http://www.php.net/manual/en/eventhttpconnection.setretries.php - * @param int $retries The retry limit. - * -1 - * means infinity. - * @return void No value is returned. + * {@inheritdoc} + * @param int $retries */ public function setRetries (int $retries): void {} /** - * Makes an HTTP request over the specified connection - * @link http://www.php.net/manual/en/eventhttpconnection.makerequest.php - * @param EventHttpRequest $req The connection object over which to send the request. - * @param int $type One of - * EventHttpRequest::CMD_* constants - * . - * @param string $uri The URI associated with the request. - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param EventHttpRequest $req + * @param int $type + * @param string $uri */ - public function makeRequest (EventHttpRequest $req, int $type, string $uri): bool {} + public function makeRequest (EventHttpRequest $req, int $type, string $uri): ?bool {} /** - * Set callback for connection close - * @link http://www.php.net/manual/en/eventhttpconnection.setclosecallback.php - * @param callable $callback Callback which is called when connection is closed. Should match the - * following prototype: - * @param mixed $data [optional] - * @return void No value is returned. + * {@inheritdoc} + * @param callable $callback + * @param mixed $data [optional] */ - public function setCloseCallback (callable $callback, mixed $data = null): void {} + public function setCloseCallback (callable $callback, mixed $data = NULL): void {} } -/** - * Represents HTTP server. - * @link http://www.php.net/manual/en/class.eventhttp.php - */ final class EventHttp { /** - * Constructs EventHttp object(the HTTP server) - * @link http://www.php.net/manual/en/eventhttp.construct.php - * @param EventBase $base Associated event base. - * @param EventSslContext $ctx [optional] EventSslContext - * class object. Turns plain HTTP server into HTTPS server. It means that - * if - * ctx - * is configured correctly, then the underlying buffer events will be based - * on OpenSSL sockets. Thus, all traffic will pass through the SSL or TLS. - *This parameter is available only if - * Event - * is compiled with OpenSSL support and only with - * Libevent - * 2.1.0-alpha - * and higher.
- * @return EventBase Returns - * EventHttp - * object. + * {@inheritdoc} + * @param EventBase $base + * @param EventSslContext|null $ctx [optional] */ - public function __construct (EventBase $base, EventSslContext $ctx = null): EventBase {} + public function __construct (EventBase $base, ?EventSslContext $ctx = NULL) {} /** * {@inheritdoc} @@ -1826,183 +887,91 @@ final public function __sleep (): array {} final public function __wakeup (): void {} /** - * Makes an HTTP server accept connections on the specified socket stream or resource - * @link http://www.php.net/manual/en/eventhttp.accept.php - * @param mixed $socket Socket resource, stream or numeric file descriptor representing a socket - * ready to accept connections. - * @return bool Returns true on success or false on failure. - */ - public function accept (mixed $socket): bool {} - - /** - * Binds an HTTP server on the specified address and port - * @link http://www.php.net/manual/en/eventhttp.bind.php - * @param string $address A string containing the IP address to - * listen(2) - * on. - * @param int $port The port number to listen on. - * @return void Returns true on success or false on failure. - */ - public function bind (string $address, int $port): void {} - - /** - * Sets a callback for specified URI - * @link http://www.php.net/manual/en/eventhttp.setcallback.php - * @param string $path The path for which to invoke the callback. - * @param string $cb The callback - * callable - * that gets invoked on requested - * path - * . It should match the following prototype: - *
- * req
- *
- *
- * EventHttpRequest - * object. - *
- * arg - *- * Custom data. - *
- * - *EventHttpRequest - * object.
- *Custom data.
- * @param string $arg [optional] Custom data. - * @return void Returns true on success or false on failure. - */ - public function setCallback (string $path, string $cb, string $arg = null): void {} - - /** - * Sets default callback to handle requests that are not caught by specific callbacks - * @link http://www.php.net/manual/en/eventhttp.setdefaultcallback.php - * @param string $cb The callback - * callable - * . It should match the following prototype: - *
- * req
- *
- *
- * EventHttpRequest - * object. - *
- * arg - *- * Custom data. - *
- * - *EventHttpRequest - * object.
- *Custom data.
- * @param string $arg [optional] User custom data passed to the callback. - * @return void Returns true on success or false on failure. - */ - public function setDefaultCallback (string $cb, string $arg = null): void {} - - /** - * Sets the what HTTP methods are supported in requests accepted by this server, and passed to user callbacks - * @link http://www.php.net/manual/en/eventhttp.setallowedmethods.php - * @param int $methods A bit mask of - * EventHttpRequest::CMD_* - * constants - * . - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $socket + */ + public function accept (mixed $socket = null): bool {} + + /** + * {@inheritdoc} + * @param string $address + * @param int $port + */ + public function bind (string $address, int $port): bool {} + + /** + * {@inheritdoc} + * @param string $path + * @param callable $cb + * @param mixed $arg [optional] + */ + public function setCallback (string $path, callable $cb, mixed $arg = NULL): bool {} + + /** + * {@inheritdoc} + * @param callable $cb + * @param mixed $arg [optional] + */ + public function setDefaultCallback (callable $cb, mixed $arg = NULL): void {} + + /** + * {@inheritdoc} + * @param int $methods */ public function setAllowedMethods (int $methods): void {} /** - * Sets maximum request body size - * @link http://www.php.net/manual/en/eventhttp.setmaxbodysize.php - * @param int $value The body size in bytes. - * @return void No value is returned. + * {@inheritdoc} + * @param int $value */ public function setMaxBodySize (int $value): void {} /** - * Sets maximum HTTP header size - * @link http://www.php.net/manual/en/eventhttp.setmaxheaderssize.php - * @param int $value The header size in bytes. - * @return void No value is returned. + * {@inheritdoc} + * @param int $value */ public function setMaxHeadersSize (int $value): void {} /** - * Sets the timeout for an HTTP request - * @link http://www.php.net/manual/en/eventhttp.settimeout.php - * @param int $value The timeout in seconds. - * @return void No value is returned. + * {@inheritdoc} + * @param int $value */ public function setTimeout (int $value): void {} /** - * Adds a server alias to the HTTP server object - * @link http://www.php.net/manual/en/eventhttp.addserveralias.php - * @param string $alias The alias to add. - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $alias */ public function addServerAlias (string $alias): bool {} /** - * Removes server alias - * @link http://www.php.net/manual/en/eventhttp.removeserveralias.php - * @param string $alias The alias to remove. - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $alias */ public function removeServerAlias (string $alias): bool {} } -/** - * Represents an HTTP request. - * @link http://www.php.net/manual/en/class.eventhttprequest.php - */ final class EventHttpRequest { - /** - * GET method(command) const CMD_GET = 1; - /** - * POST method(command) const CMD_POST = 2; - /** - * HEAD method(command) const CMD_HEAD = 4; - /** - * PUT method(command) const CMD_PUT = 8; - /** - * DELETE command(method) const CMD_DELETE = 16; - /** - * OPTIONS method(command) const CMD_OPTIONS = 32; - /** - * TRACE method(command) const CMD_TRACE = 64; - /** - * CONNECT method(command) const CMD_CONNECT = 128; - /** - * PATCH method(command) const CMD_PATCH = 256; - /** - * Request input header type. const INPUT_HEADER = 1; - /** - * Request output header type. const OUTPUT_HEADER = 2; /** - * Constructs EventHttpRequest object - * @link http://www.php.net/manual/en/eventhttprequest.construct.php - * @param callable $callback Gets invoked on requesting path. Should match the following prototype: - * @param mixed $data [optional] User custom data passed to the callback. - * @return callable Returns EventHttpRequest object. + * {@inheritdoc} + * @param callable $callback + * @param mixed $data [optional] */ - public function __construct (callable $callback, mixed $data = null): callable {} + public function __construct (callable $callback, mixed $data = NULL) {} /** * {@inheritdoc} @@ -2015,419 +984,206 @@ final public function __sleep (): array {} final public function __wakeup (): void {} /** - * Frees the object and removes associated events - * @link http://www.php.net/manual/en/eventhttprequest.free.php - * @return void No value is returned. + * {@inheritdoc} */ public function free (): void {} /** - * Returns the request command(method) - * @link http://www.php.net/manual/en/eventhttprequest.getcommand.php - * @return void Returns the request command, one of - * EventHttpRequest::CMD_* - * constants. + * {@inheritdoc} */ - public function getCommand (): void {} + public function getCommand (): int {} /** - * Returns the request host - * @link http://www.php.net/manual/en/eventhttprequest.gethost.php - * @return string Returns the request host. + * {@inheritdoc} */ public function getHost (): string {} /** - * Returns the request URI - * @link http://www.php.net/manual/en/eventhttprequest.geturi.php - * @return string Returns the request URI + * {@inheritdoc} */ public function getUri (): string {} /** - * Returns the response code - * @link http://www.php.net/manual/en/eventhttprequest.getresponsecode.php - * @return int Returns the response code of the request. + * {@inheritdoc} */ public function getResponseCode (): int {} /** - * Returns associative array of the input headers - * @link http://www.php.net/manual/en/eventhttprequest.getinputheaders.php - * @return array Returns associative array of the input headers. + * {@inheritdoc} */ public function getInputHeaders (): array {} /** - * Returns associative array of the output headers - * @link http://www.php.net/manual/en/eventhttprequest.getoutputheaders.php - * @return void + * {@inheritdoc} */ - public function getOutputHeaders (): void {} + public function getOutputHeaders (): array {} /** - * Returns the input buffer - * @link http://www.php.net/manual/en/eventhttprequest.getinputbuffer.php - * @return EventBuffer Returns the input buffer. + * {@inheritdoc} */ public function getInputBuffer (): EventBuffer {} /** - * Returns the output buffer of the request - * @link http://www.php.net/manual/en/eventhttprequest.getoutputbuffer.php - * @return EventBuffer Returns the output buffer of the request. + * {@inheritdoc} */ public function getOutputBuffer (): EventBuffer {} /** - * Returns EventBufferEvent object - * @link http://www.php.net/manual/en/eventhttprequest.getbufferevent.php - * @return EventBufferEvent Returns - * EventBufferEvent - * object. + * {@inheritdoc} */ - public function getBufferEvent (): EventBufferEvent {} + public function getBufferEvent (): ?EventBufferEvent {} /** - * Returns EventHttpConnection object - * @link http://www.php.net/manual/en/eventhttprequest.getconnection.php - * @return EventHttpConnection Returns - * EventHttpConnection - * object. + * {@inheritdoc} */ - public function getConnection (): EventHttpConnection {} + public function getConnection (): ?EventHttpConnection {} /** - * Closes associated HTTP connection - * @link http://www.php.net/manual/en/eventhttprequest.closeconnection.php - * @return void No value is returned. + * {@inheritdoc} */ public function closeConnection (): void {} /** - * Send an HTML error message to the client - * @link http://www.php.net/manual/en/eventhttprequest.senderror.php - * @param int $error The HTTP error code. - * @param string $reason [optional] A brief explanation ofthe error. If null, the standard meaning of the - * error code will be used. - * @return void No value is returned. + * {@inheritdoc} + * @param int $error + * @param string|null $reason [optional] */ - public function sendError (int $error, string $reason = null): void {} + public function sendError (int $error, ?string $reason = NULL): void {} /** - * Send an HTML reply to the client - * @link http://www.php.net/manual/en/eventhttprequest.sendreply.php - * @param int $code The HTTP response code to send. - * @param string $reason A brief message to send with the response code. - * @param EventBuffer $buf [optional] The body of the response. - * @return void No value is returned. + * {@inheritdoc} + * @param int $code + * @param string $reason + * @param EventBuffer|null $buf [optional] */ - public function sendReply (int $code, string $reason, EventBuffer $buf = null): void {} + public function sendReply (int $code, string $reason, ?EventBuffer $buf = NULL): void {} /** - * Send another data chunk as part of an ongoing chunked reply - * @link http://www.php.net/manual/en/eventhttprequest.sendreplychunk.php - * @param EventBuffer $buf The data chunk to send as part of the reply. - * @return void No value is returned. + * {@inheritdoc} + * @param EventBuffer $buf */ public function sendReplyChunk (EventBuffer $buf): void {} /** - * Complete a chunked reply, freeing the request as appropriate - * @link http://www.php.net/manual/en/eventhttprequest.sendreplyend.php - * @return void No value is returned. + * {@inheritdoc} */ public function sendReplyEnd (): void {} /** - * Initiate a chunked reply - * @link http://www.php.net/manual/en/eventhttprequest.sendreplystart.php - * @param int $code The HTTP response code to send. - * @param string $reason A brief message to send with the response code. - * @return void No value is returned. + * {@inheritdoc} + * @param int $code + * @param string $reason */ public function sendReplyStart (int $code, string $reason): void {} /** - * Cancels a pending HTTP request - * @link http://www.php.net/manual/en/eventhttprequest.cancel.php - * @return void No value is returned. + * {@inheritdoc} */ public function cancel (): void {} /** - * Adds an HTTP header to the headers of the request - * @link http://www.php.net/manual/en/eventhttprequest.addheader.php - * @param string $key Header name. - * @param string $value Header value. - * @param int $type One of - * EventHttpRequest::*_HEADER constants - * . - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $key + * @param string $value + * @param int $type */ public function addHeader (string $key, string $value, int $type): bool {} /** - * Removes all output headers from the header list of the request - * @link http://www.php.net/manual/en/eventhttprequest.clearheaders.php - * @return void No value is returned. + * {@inheritdoc} */ public function clearHeaders (): void {} /** - * Removes an HTTP header from the headers of the request - * @link http://www.php.net/manual/en/eventhttprequest.removeheader.php - * @param string $key The header name. - * @param string $type type - * is one of - * EventHttpRequest::*_HEADER - * constants. - * @return void Removes an HTTP header from the headers of the request. + * {@inheritdoc} + * @param string $key + * @param int $type */ - public function removeHeader (string $key, string $type): void {} + public function removeHeader (string $key, int $type): bool {} /** - * Finds the value belonging a header - * @link http://www.php.net/manual/en/eventhttprequest.findheader.php - * @param string $key The header name. - * @param string $type One of - * EventHttpRequest::*_HEADER constants - * . - * @return void Returns null if header not found. + * {@inheritdoc} + * @param string $key + * @param int $type */ - public function findHeader (string $key, string $type): void {} + public function findHeader (string $key, int $type): ?string {} } -/** - * EventUtil - * is a singleton with supplimentary methods and constants. - * @link http://www.php.net/manual/en/class.eventutil.php - */ final class EventUtil { - /** - * IPv4 address family const AF_INET = 2; - /** - * IPv6 address family const AF_INET6 = 30; const AF_UNIX = 1; - /** - * Unspecified IP address family const AF_UNSPEC = 0; - /** - * Socket option. Enable socket debugging. Only allowed for processes with - * the - * CAP_NET_ADMIN - * capability or an effective user ID of - * 0 - * . (Added in event-1.6.0.) const SO_DEBUG = 1; - /** - * Socket option. Indicates that the rules used in validating addresses - * supplied in a - * bind(2) - * call should allow reuse of local addresses. See the - * socket(7) - * manual page. (Added in event-1.6.0.) const SO_REUSEADDR = 4; - /** - * Socket option. Enable sending of keep-alive messages on - * connection-oriented sockets. Expects an integer boolean flag. See the - * socket(7) - * manual page. (Added in event-1.6.0.) const SO_KEEPALIVE = 8; - /** - * Socket option. See the - * socket(7) - * manual page. (Added in event-1.6.0.) const SO_DONTROUTE = 16; - /** - * Socket option. When enabled, a - * close(2) - * or - * shutdown(2) - * will not return until all queued messages for the socket have been - * successfully sent or the linger timeout has been reached. Otherwise, - * the call returns immediately and the closing is done in the background. - * See the - * socket(7) - * manual page. (Added in event-1.6.0.) const SO_LINGER = 128; - /** - * Socket option. Reports whether transmission of broadcast messages is - * supported. See the - * socket(7) - * manual page. (Added in event-1.6.0.) const SO_BROADCAST = 32; - /** - * Socket option. See the - * socket(7) - * manual page. (Added in event-1.6.0.) const SO_OOBINLINE = 256; - /** - * Socket option. See the - * socket(7) - * manual page. (Added in event-1.6.0.) const SO_SNDBUF = 4097; - /** - * Socket option. See the - * socket(7) - * manual page. (Added in event-1.6.0.) const SO_RCVBUF = 4098; - /** - * Socket option. See the - * socket(7) - * manual page. (Added in event-1.6.0.) const SO_SNDLOWAT = 4099; - /** - * Socket option. See the - * socket(7) - * manual page. (Added in event-1.6.0.) const SO_RCVLOWAT = 4100; - /** - * Socket option. See the - * socket(7) - * manual page. (Added in event-1.6.0.) const SO_SNDTIMEO = 4101; - /** - * Socket option. See the - * socket(7) - * manual page. (Added in event-1.6.0.) const SO_RCVTIMEO = 4102; - /** - * Socket option. See the - * socket(7) - * manual page. (Added in event-1.6.0.) const SO_TYPE = 4104; - /** - * Socket option. See the - * socket(7) - * manual page. (Added in event-1.6.0.) const SO_ERROR = 4103; const TCP_NODELAY = 1; - /** - * Socket option level. See the - * socket(7) - * manual page. (Added in event-1.6.0.) const SOL_SOCKET = 65535; - /** - * Socket option level. See the - * socket(7) - * manual page. (Added in event-1.6.0.) const SOL_TCP = 6; - /** - * Socket option level. See the - * socket(7) - * manual page. (Added in event-1.6.0.) const SOL_UDP = 17; const SOCK_RAW = 3; - /** - * See the - * socket(7) - * manual page. (Added in event-1.6.0.) const IPPROTO_IP = 0; - /** - * See the - * socket(7) - * manual page. (Added in event-1.6.0.) const IPPROTO_IPV6 = 41; - /** - * Libevent' version number at the time when Event extension had been - * compiled with the library. const LIBEVENT_VERSION_NUMBER = 33623040; /** - * The abstract constructor - * @link http://www.php.net/manual/en/eventutil.construct.php - * @return void No value is returned. + * {@inheritdoc} */ - private function __construct (): void {} + private function __construct () {} /** - * Returns the most recent socket error number - * @link http://www.php.net/manual/en/eventutil.getlastsocketerrno.php - * @param mixed $socket [optional] Socket resource, stream or a file descriptor of a socket. - * @return int Returns the most recent socket error number( - * errno - * ). + * {@inheritdoc} + * @param Socket|null $socket [optional] */ - public static function getLastSocketErrno (mixed $socket = null): int {} + public static function getLastSocketErrno (?Socket $socket = NULL): int|false {} /** - * Returns the most recent socket error - * @link http://www.php.net/manual/en/eventutil.getlastsocketerror.php - * @param mixed $socket [optional] Socket resource, stream or a file descriptor of a socket. - * @return string Returns the most recent socket error. + * {@inheritdoc} + * @param mixed $socket [optional] */ - public static function getLastSocketError (mixed $socket = null): string {} + public static function getLastSocketError (mixed $socket = NULL): string|false {} /** - * Generates entropy by means of OpenSSL's RAND_poll() - * @link http://www.php.net/manual/en/eventutil.sslrandpoll.php - * @return void No value is returned. + * {@inheritdoc} */ - public static function sslRandPoll (): void {} + public static function sslRandPoll (): bool {} /** - * Retreives the current address to which the - * socket is bound - * @link http://www.php.net/manual/en/eventutil.getsocketname.php - * @param mixed $socket Socket resource, stream or a file descriptor of a socket. - * @param string $address Output parameter. IP-address, or the UNIX domain socket path depending - * on the socket address family. - * @param mixed $port [optional] Output parameter. The port the socket is bound to. Has no meaning for - * UNIX domain sockets. - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mixed $socket + * @param mixed $address + * @param mixed $port [optional] */ - public static function getSocketName (mixed $socket, string &$address, mixed &$port = null): bool {} + public static function getSocketName (mixed $socket = null, mixed &$address = null, mixed &$port = NULL): bool {} /** - * Returns numeric file descriptor of a socket, or stream - * @link http://www.php.net/manual/en/eventutil.getsocketfd.php - * @param mixed $socket Socket resource or stream. - * @return int Returns numeric file descriptor of a socket, or stream. - * EventUtil::getSocketFd - * returns false in case if it is whether failed to recognize the type of - * the underlying file, or detected that the file descriptor associated with - * socket - * is not valid. + * {@inheritdoc} + * @param mixed $socket */ - public static function getSocketFd (mixed $socket): int {} + public static function getSocketFd (mixed $socket = null): int {} /** - * Sets socket options - * @link http://www.php.net/manual/en/eventutil.setsocketoption.php - * @param mixed $socket Socket resource, stream, or numeric file descriptor associated with the - * socket. - * @param int $level One of - * EventUtil::SOL_* - * constants. Specifies the protocol level at which the option resides. For - * example, to retrieve options at the socket level, a - * level - * parameter of - * EventUtil::SOL_SOCKET - * would be used. Other levels, such as TCP, can be used by specifying the - * protocol number of that level. Protocol numbers can be found by using - * the - * getprotobyname - * function. See - * EventUtil constants - * . - * @param int $optname Option name(type). Has the same meaning as corresponding parameter of - * socket_get_option - * function. See - * EventUtil constants - * . - * @param mixed $optval Accepts the same values as - * optval - * parameter of the - * socket_get_option - * function. - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mixed $socket + * @param int $level + * @param int $optname + * @param mixed $optval */ - public static function setSocketOption (mixed $socket, int $level, int $optname, mixed $optval): bool {} + public static function setSocketOption (mixed $socket = null, int $level, int $optname, mixed $optval = null): bool {} /** * {@inheritdoc} @@ -2437,73 +1193,21 @@ public static function createSocket (int $fd): Socket|false {} } -/** - * Represents - * SSL_CTX - * structure. Provides methods and properties to configure the SSL context. - * @link http://www.php.net/manual/en/class.eventsslcontext.php - */ final class EventSslContext { - /** - * TLS client method. See - * SSL_CTX_new(3) - * man page. const TLS_CLIENT_METHOD = 4; - /** - * TLS server method. See - * SSL_CTX_new(3) - * man page. const TLS_SERVER_METHOD = 8; const TLSv11_CLIENT_METHOD = 9; const TLSv11_SERVER_METHOD = 10; const TLSv12_CLIENT_METHOD = 11; const TLSv12_SERVER_METHOD = 12; - /** - * Key for an item of the options' array used in - * EventSslContext::__construct - * . The option points to path of local certificate. const OPT_LOCAL_CERT = 1; - /** - * Key for an item of the options' array used in - * EventSslContext::__construct - * . The option points to path of the private key. const OPT_LOCAL_PK = 2; - /** - * Key for an item of the options' array used in - * EventSslContext::__construct - * . Represents passphrase of the certificate. const OPT_PASSPHRASE = 3; - /** - * Key for an item of the options' array used in - * EventSslContext::__construct - * . Represents path of the certificate authority file. const OPT_CA_FILE = 4; - /** - * Key for an item of the options' array used in - * EventSslContext::__construct - * . Represents path where the certificate authority file should be - * searched for. const OPT_CA_PATH = 5; - /** - * Key for an item of the options' array used in - * EventSslContext::__construct - * . Represents option that allows self-signed certificates. const OPT_ALLOW_SELF_SIGNED = 6; - /** - * Key for an item of the options' array used in - * EventSslContext::__construct - * . Represents option that tells Event to verify peer. const OPT_VERIFY_PEER = 7; - /** - * Key for an item of the options' array used in - * EventSslContext::__construct - * . Represents maximum depth for the certificate chain verification that - * shall be allowed for the SSL context. const OPT_VERIFY_DEPTH = 8; - /** - * Key for an item of the options' array used in - * EventSslContext::__construct - * . Represents the cipher list for the SSL context. const OPT_CIPHERS = 9; const OPT_NO_SSLv2 = 10; const OPT_NO_SSLv3 = 11; @@ -2513,8 +1217,8 @@ final class EventSslContext { const OPT_CIPHER_SERVER_PREFERENCE = 15; const OPT_REQUIRE_CLIENT_CERT = 16; const OPT_VERIFY_CLIENT_ONCE = 17; - const OPENSSL_VERSION_TEXT = "OpenSSL 1.1.1q 5 Jul 2022"; - const OPENSSL_VERSION_NUMBER = 269488415; + const OPENSSL_VERSION_TEXT = "OpenSSL 3.1.2 1 Aug 2023"; + const OPENSSL_VERSION_NUMBER = 806354976; const SSL3_VERSION = 768; const TLS1_VERSION = 769; const TLS1_1_VERSION = 770; @@ -2523,36 +1227,16 @@ final class EventSslContext { const DTLS1_2_VERSION = 65277; - /** - * Path to local certificate file on filesystem. It must be a PEM-encoded - * file which contains certificate. It can optionally contain the - * certificate chain of issuers. - * @var string - * @link http://www.php.net/manual/en/class.eventsslcontext.php#eventsslcontext.props.local_cert - */ - public string $local_cert; + public $local_cert; - /** - * Path to local private key file - * @var string - * @link http://www.php.net/manual/en/class.eventsslcontext.php#eventsslcontext.props.local_pk - */ - public string $local_pk; + public $local_pk; /** - * Constructs an OpenSSL context for use with Event classes - * @link http://www.php.net/manual/en/eventsslcontext.construct.php - * @param string $method One of - * EventSslContext::*_METHOD constants - * . - * @param string $options Associative array of SSL context options One of - * EventSslContext::OPT_* constants - * . - * @return string Returns - * EventSslContext - * object. + * {@inheritdoc} + * @param int $method + * @param array $options */ - public function __construct (string $method, string $options): string {} + public function __construct (int $method, array $options) {} /** * {@inheritdoc} @@ -2573,14 +1257,12 @@ class EventException extends RuntimeException implements Stringable, Throwable { public $errorInfo; /** - * Construct the exception - * @link http://www.php.net/manual/en/exception.construct.php - * @param string $message [optional] - * @param int $code [optional] - * @param Throwable|null $previous [optional] - * @return string + * {@inheritdoc} + * @param string $message [optional] + * @param int $code [optional] + * @param Throwable|null $previous [optional] */ - public function __construct (string $message = '""', int $code = null, ?Throwable $previous = null): string {} + public function __construct (string $message = '', int $code = 0, ?Throwable $previous = NULL) {} /** * {@inheritdoc} @@ -2588,62 +1270,42 @@ public function __construct (string $message = '""', int $code = null, ?Throwabl public function __wakeup () {} /** - * Gets the Exception message - * @link http://www.php.net/manual/en/exception.getmessage.php - * @return string Returns the Exception message as a string. + * {@inheritdoc} */ final public function getMessage (): string {} /** - * Gets the Exception code - * @link http://www.php.net/manual/en/exception.getcode.php - * @return int Returns the exception code as int in - * Exception but possibly as other type in - * Exception descendants (for example as - * string in PDOException). + * {@inheritdoc} */ - final public function getCode (): int {} + final public function getCode () {} /** - * Gets the file in which the exception was created - * @link http://www.php.net/manual/en/exception.getfile.php - * @return string Returns the filename in which the exception was created. + * {@inheritdoc} */ final public function getFile (): string {} /** - * Gets the line in which the exception was created - * @link http://www.php.net/manual/en/exception.getline.php - * @return int Returns the line number where the exception was created. + * {@inheritdoc} */ final public function getLine (): int {} /** - * Gets the stack trace - * @link http://www.php.net/manual/en/exception.gettrace.php - * @return array Returns the Exception stack trace as an array. + * {@inheritdoc} */ final public function getTrace (): array {} /** - * Returns previous Throwable - * @link http://www.php.net/manual/en/exception.getprevious.php - * @return Throwable|null Returns the previous Throwable if available - * or null otherwise. + * {@inheritdoc} */ final public function getPrevious (): ?Throwable {} /** - * Gets the stack trace as a string - * @link http://www.php.net/manual/en/exception.gettraceasstring.php - * @return string Returns the Exception stack trace as a string. + * {@inheritdoc} */ final public function getTraceAsString (): string {} /** - * String representation of the exception - * @link http://www.php.net/manual/en/exception.tostring.php - * @return string Returns the string representation of the exception. + * {@inheritdoc} */ public function __toString (): string {} diff --git a/plugins/org.eclipse.php.core/Resources/language/php8.3/exif.php b/plugins/org.eclipse.php.core/Resources/language/php8.3/exif.php index d7f13eadee..15686803f0 100644 --- a/plugins/org.eclipse.php.core/Resources/language/php8.3/exif.php +++ b/plugins/org.eclipse.php.core/Resources/language/php8.3/exif.php @@ -1,149 +1,37 @@ The following constants are defined, and represent possible - * exif_imagetype return values: - *Value | - *Constant | - *
1 | - *IMAGETYPE_GIF | - *
2 | - *IMAGETYPE_JPEG | - *
3 | - *IMAGETYPE_PNG | - *
4 | - *IMAGETYPE_SWF | - *
5 | - *IMAGETYPE_PSD | - *
6 | - *IMAGETYPE_BMP | - *
7 | - *IMAGETYPE_TIFF_II (intel byte order) | - *
8 | - *- * IMAGETYPE_TIFF_MM (motorola byte order) - * | - *
9 | - *IMAGETYPE_JPC | - *
10 | - *IMAGETYPE_JP2 | - *
11 | - *IMAGETYPE_JPX | - *
12 | - *IMAGETYPE_JB2 | - *
13 | - *IMAGETYPE_SWC | - *
14 | - *IMAGETYPE_IFF | - *
15 | - *IMAGETYPE_WBMP | - *
16 | - *IMAGETYPE_XBM | - *
17 | - *IMAGETYPE_ICO | - *
18 | - *IMAGETYPE_WEBP | - *
exif_imagetype will emit an E_NOTICE - * and return false if it is unable to read enough bytes from the file to - * determine the image type.
+ * {@inheritdoc} + * @param string $filename */ function exif_imagetype (string $filename): int|false {} - -/** - * This constant has a value of 1 if the - * mbstring is enabled, otherwise - * it has a value of 0. - * @link http://www.php.net/manual/en/ref.mbstring.php - * @var int - */ define ('EXIF_USE_MBSTRING', 1); -// End of exif v.8.2.6 +// End of exif v.8.3.0 diff --git a/plugins/org.eclipse.php.core/Resources/language/php8.3/expect.php b/plugins/org.eclipse.php.core/Resources/language/php8.3/expect.php index 6154c00a53..6744e3cc2d 100644 --- a/plugins/org.eclipse.php.core/Resources/language/php8.3/expect.php +++ b/plugins/org.eclipse.php.core/Resources/language/php8.3/expect.php @@ -3,76 +3,24 @@ // Start of expect v.0.4.0 /** - * Execute command via Bourne shell, and open the PTY stream to - * the process - * @link http://www.php.net/manual/en/function.expect-popen.php - * @param string $command - * @return resource Returns an open PTY stream to the processes stdio, - * stdout, and stderr. - *On failure this function returns false.
+ * {@inheritdoc} + * @param mixed $command */ -function expect_popen (string $command) {} +function expect_popen ($command = null) {} /** - * Waits until the output from a process matches one - * of the patterns, a specified time period has passed, or an EOF is seen - * @link http://www.php.net/manual/en/function.expect-expectl.php - * @param resource $expect - * @param array $cases - * @param array $match [optional] - * @return int Returns value associated with the pattern that was matched. - *On failure this function returns: - * EXP_EOF, - * EXP_TIMEOUT - * or - * EXP_FULLBUFFER
+ * {@inheritdoc} + * @param mixed $stream + * @param mixed $expect_cases + * @param mixed $match [optional] */ -function expect_expectl ($expect, array $cases, array &$match = null): int {} +function expect_expectl ($stream = null, $expect_cases = null, &$match = NULL) {} - -/** - * Indicates that the pattern is a glob-style string pattern. - * @link http://www.php.net/manual/en/expect.constants.php - * @var int - */ define ('EXP_GLOB', 1); - -/** - * Indicates that the pattern is an exact string. - * @link http://www.php.net/manual/en/expect.constants.php - * @var int - */ define ('EXP_EXACT', 2); - -/** - * Indicates that the pattern is a regexp-style string pattern. - * @link http://www.php.net/manual/en/expect.constants.php - * @var int - */ define ('EXP_REGEXP', 3); - -/** - * Value, returned by expect_expectl, when EOF is - * reached. - * @link http://www.php.net/manual/en/expect.constants.php - * @var int - */ define ('EXP_EOF', -11); - -/** - * Value, returned by expect_expectl upon timeout of - * seconds, specified in value of expect.timeout - * @link http://www.php.net/manual/en/ini.expect.timeout.php - * @var int - */ define ('EXP_TIMEOUT', -2); - -/** - * Value, returned by expect_expectl if no pattern have - * been matched. - * @link http://www.php.net/manual/en/expect.constants.php - * @var int - */ define ('EXP_FULLBUFFER', -5); // End of expect v.0.4.0 diff --git a/plugins/org.eclipse.php.core/Resources/language/php8.3/fileinfo.php b/plugins/org.eclipse.php.core/Resources/language/php8.3/fileinfo.php index b90fffff87..fb2d61e0e3 100644 --- a/plugins/org.eclipse.php.core/Resources/language/php8.3/fileinfo.php +++ b/plugins/org.eclipse.php.core/Resources/language/php8.3/fileinfo.php @@ -1,191 +1,94 @@ An array value will be false if the filter fails, or null if - * the variable is not set. Or if the flag FILTER_NULL_ON_FAILURE - * is used, it returns false if the variable is not set and null if the filter - * fails. If the add_empty parameter is false, no array - * element will be added for unset variables. + * {@inheritdoc} + * @param int $type + * @param array|int $options [optional] + * @param bool $add_empty [optional] */ -function filter_input_array (int $type, array|int $options = FILTER_DEFAULT, bool $add_empty = true): array|false|null {} +function filter_input_array (int $type, array|int $options = 516, bool $add_empty = true): array|false|null {} /** - * Gets multiple variables and optionally filters them - * @link http://www.php.net/manual/en/function.filter-var-array.php - * @param array $array - * @param array|int $options [optional] - * @param bool $add_empty [optional] - * @return array|false|null An array containing the values of the requested variables on success, or false - * on failure. An array value will be false if the filter fails, or null if - * the variable is not set. + * {@inheritdoc} + * @param array $array + * @param array|int $options [optional] + * @param bool $add_empty [optional] */ -function filter_var_array (array $array, array|int $options = FILTER_DEFAULT, bool $add_empty = true): array|false|null {} +function filter_var_array (array $array, array|int $options = 516, bool $add_empty = true): array|false|null {} /** - * Returns a list of all supported filters - * @link http://www.php.net/manual/en/function.filter-list.php - * @return array Returns an array of names of all supported filters, empty array if there - * are no such filters. Indexes of this array are not filter IDs, they can be - * obtained with filter_id from a name instead. + * {@inheritdoc} */ function filter_list (): array {} /** - * Returns the filter ID belonging to a named filter - * @link http://www.php.net/manual/en/function.filter-id.php - * @param string $name - * @return int|false ID of a filter on success or false if filter doesn't exist. + * {@inheritdoc} + * @param string $name */ function filter_id (string $name): int|false {} - -/** - * POST variables. - * @link http://www.php.net/manual/en/reserved.variables.post.php - * @var int - */ define ('INPUT_POST', 0); - -/** - * GET variables. - * @link http://www.php.net/manual/en/reserved.variables.get.php - * @var int - */ define ('INPUT_GET', 1); - -/** - * COOKIE variables. - * @link http://www.php.net/manual/en/reserved.variables.cookies.php - * @var int - */ define ('INPUT_COOKIE', 2); - -/** - * ENV variables. - * @link http://www.php.net/manual/en/reserved.variables.environment.php - * @var int - */ define ('INPUT_ENV', 4); - -/** - * SERVER variables. - * @link http://www.php.net/manual/en/reserved.variables.server.php - * @var int - */ define ('INPUT_SERVER', 5); - -/** - * No flags. - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_FLAG_NONE', 0); - -/** - * Flag used to require scalar as input - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_REQUIRE_SCALAR', 33554432); - -/** - * Require an array as input. - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_REQUIRE_ARRAY', 16777216); - -/** - * Always returns an array. - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_FORCE_ARRAY', 67108864); - -/** - * Use NULL instead of FALSE on failure. - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_NULL_ON_FAILURE', 134217728); - -/** - * ID of "int" filter. - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_VALIDATE_INT', 257); - -/** - * ID of "boolean" filter. - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_VALIDATE_BOOLEAN', 258); - -/** - * Alias of FILTER_VALIDATE_BOOLEAN. - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_VALIDATE_BOOL', 258); - -/** - * ID of "float" filter. - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_VALIDATE_FLOAT', 259); - -/** - * ID of "validate_regexp" filter. - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_VALIDATE_REGEXP', 272); - -/** - * ID of "validate_domain" filter. - * (Available as of PHP 7.0.0) - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_VALIDATE_DOMAIN', 277); - -/** - * ID of "validate_url" filter. - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_VALIDATE_URL', 273); - -/** - * ID of "validate_email" filter. - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_VALIDATE_EMAIL', 274); - -/** - * ID of "validate_ip" filter. - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_VALIDATE_IP', 275); - -/** - * ID of "validate_mac_address" filter. - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_VALIDATE_MAC', 276); - -/** - * ID of default ("unsafe_raw") filter. This is equivalent to - * FILTER_UNSAFE_RAW. - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_DEFAULT', 516); - -/** - * ID of "unsafe_raw" filter. - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_UNSAFE_RAW', 516); - -/** - * ID of "string" filter. - * (Deprecated as of PHP 8.1.0, - * use htmlspecialchars instead.) - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_SANITIZE_STRING', 513); - -/** - * ID of "stripped" filter. - * (Deprecated as of PHP 8.1.0, - * use htmlspecialchars instead.) - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_SANITIZE_STRIPPED', 513); - -/** - * ID of "encoded" filter. - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_SANITIZE_ENCODED', 514); - -/** - * ID of "special_chars" filter. - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_SANITIZE_SPECIAL_CHARS', 515); define ('FILTER_SANITIZE_FULL_SPECIAL_CHARS', 522); - -/** - * ID of "email" filter. - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_SANITIZE_EMAIL', 517); - -/** - * ID of "url" filter. - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_SANITIZE_URL', 518); - -/** - * ID of "number_int" filter. - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_SANITIZE_NUMBER_INT', 519); - -/** - * ID of "number_float" filter. - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_SANITIZE_NUMBER_FLOAT', 520); - -/** - * ID of "add_slashes" filter. - * (Available as of PHP 7.3.0) - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_SANITIZE_ADD_SLASHES', 523); - -/** - * ID of "callback" filter. - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_CALLBACK', 1024); - -/** - * Allow octal notation (0[0-7]+) in "int" filter. - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_FLAG_ALLOW_OCTAL', 1); - -/** - * Allow hex notation (0x[0-9a-fA-F]+) in "int" filter. - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_FLAG_ALLOW_HEX', 2); - -/** - * Strip characters with ASCII value less than 32. - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_FLAG_STRIP_LOW', 4); - -/** - * Strip characters with ASCII value greater than 127. - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_FLAG_STRIP_HIGH', 8); - -/** - * Strips backtick characters. - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_FLAG_STRIP_BACKTICK', 512); - -/** - * Encode characters with ASCII value less than 32. - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_FLAG_ENCODE_LOW', 16); - -/** - * Encode characters with ASCII value greater than 127. - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_FLAG_ENCODE_HIGH', 32); - -/** - * Encode &. - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_FLAG_ENCODE_AMP', 64); - -/** - * Don't encode ' and ". - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_FLAG_NO_ENCODE_QUOTES', 128); - -/** - * (No use for now.) - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_FLAG_EMPTY_STRING_NULL', 256); - -/** - * Allow fractional part in "number_float" filter. - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_FLAG_ALLOW_FRACTION', 4096); - -/** - * Allow thousand separator (,) in "number_float" filter. - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_FLAG_ALLOW_THOUSAND', 8192); - -/** - * Allow scientific notation (e, E) in - * "number_float" filter. - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_FLAG_ALLOW_SCIENTIFIC', 16384); - -/** - * Require path in "validate_url" filter. - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_FLAG_PATH_REQUIRED', 262144); - -/** - * Require query in "validate_url" filter. - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_FLAG_QUERY_REQUIRED', 524288); - -/** - * Allow only IPv4 address in "validate_ip" filter. - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_FLAG_IPV4', 1048576); - -/** - * Allow only IPv6 address in "validate_ip" filter. - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_FLAG_IPV6', 2097152); - -/** - * Deny reserved addresses in "validate_ip" filter. - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_FLAG_NO_RES_RANGE', 4194304); - -/** - * Deny private addresses in "validate_ip" filter. - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_FLAG_NO_PRIV_RANGE', 8388608); define ('FILTER_FLAG_GLOBAL_RANGE', 268435456); - -/** - * Require hostnames to start with an alphanumeric character and contain - * only alphanumerics or hyphens. - * (Available as of PHP 7.0.0) - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_FLAG_HOSTNAME', 1048576); - -/** - * Accepts Unicode characters in the local part in "validate_email" filter. - * (Available as of PHP 7.1.0) - * @link http://www.php.net/manual/en/filter.constants.php - * @var int - */ define ('FILTER_FLAG_EMAIL_UNICODE', 1048576); -// End of filter v.8.2.6 +// End of filter v.8.3.0 diff --git a/plugins/org.eclipse.php.core/Resources/language/php8.3/ftp.php b/plugins/org.eclipse.php.core/Resources/language/php8.3/ftp.php index 444b7d22c2..1802fe3f11 100644 --- a/plugins/org.eclipse.php.core/Resources/language/php8.3/ftp.php +++ b/plugins/org.eclipse.php.core/Resources/language/php8.3/ftp.php @@ -1,13 +1,9 @@ The output is not parsed in any way. The system type identifier returned by - * ftp_systype can be used to determine how the results - * should be interpreted. + * {@inheritdoc} + * @param FTP\Connection $ftp + * @param string $directory + * @param bool $recursive [optional] */ function ftp_rawlist (FTP\Connection $ftp, string $directory, bool $recursive = false): array|false {} /** - * Returns a list of files in the given directory - * @link http://www.php.net/manual/en/function.ftp-mlsd.php - * @param FTP\Connection $ftp - * @param string $directory - * @return array|false Returns an array of arrays with file infos from the specified directory on success or - * false on error. + * {@inheritdoc} + * @param FTP\Connection $ftp + * @param string $directory */ function ftp_mlsd (FTP\Connection $ftp, string $directory): array|false {} /** - * Returns the system type identifier of the remote FTP server - * @link http://www.php.net/manual/en/function.ftp-systype.php - * @param FTP\Connection $ftp - * @return string|false Returns the remote system type, or false on error. + * {@inheritdoc} + * @param FTP\Connection $ftp */ function ftp_systype (FTP\Connection $ftp): string|false {} /** - * Downloads a file from the FTP server and saves to an open file - * @link http://www.php.net/manual/en/function.ftp-fget.php - * @param FTP\Connection $ftp - * @param resource $stream - * @param string $remote_filename - * @param int $mode [optional] - * @param int $offset [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param FTP\Connection $ftp + * @param mixed $stream + * @param string $remote_filename + * @param int $mode [optional] + * @param int $offset [optional] */ -function ftp_fget (FTP\Connection $ftp, $stream, string $remote_filename, int $mode = FTP_BINARY, int $offset = null): bool {} +function ftp_fget (FTP\Connection $ftp, $stream = null, string $remote_filename, int $mode = 2, int $offset = 0): bool {} /** - * Retrieves a file from the FTP server and writes it to an open file (non-blocking) - * @link http://www.php.net/manual/en/function.ftp-nb-fget.php - * @param FTP\Connection $ftp - * @param resource $stream - * @param string $remote_filename - * @param int $mode [optional] - * @param int $offset [optional] - * @return int Returns FTP_FAILED or FTP_FINISHED - * or FTP_MOREDATA. + * {@inheritdoc} + * @param FTP\Connection $ftp + * @param mixed $stream + * @param string $remote_filename + * @param int $mode [optional] + * @param int $offset [optional] */ -function ftp_nb_fget (FTP\Connection $ftp, $stream, string $remote_filename, int $mode = FTP_BINARY, int $offset = null): int {} +function ftp_nb_fget (FTP\Connection $ftp, $stream = null, string $remote_filename, int $mode = 2, int $offset = 0): int {} /** - * Turns passive mode on or off - * @link http://www.php.net/manual/en/function.ftp-pasv.php - * @param FTP\Connection $ftp - * @param bool $enable - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param FTP\Connection $ftp + * @param bool $enable */ function ftp_pasv (FTP\Connection $ftp, bool $enable): bool {} /** - * Downloads a file from the FTP server - * @link http://www.php.net/manual/en/function.ftp-get.php - * @param FTP\Connection $ftp - * @param string $local_filename - * @param string $remote_filename - * @param int $mode [optional] - * @param int $offset [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param FTP\Connection $ftp + * @param string $local_filename + * @param string $remote_filename + * @param int $mode [optional] + * @param int $offset [optional] */ -function ftp_get (FTP\Connection $ftp, string $local_filename, string $remote_filename, int $mode = FTP_BINARY, int $offset = null): bool {} +function ftp_get (FTP\Connection $ftp, string $local_filename, string $remote_filename, int $mode = 2, int $offset = 0): bool {} /** - * Retrieves a file from the FTP server and writes it to a local file (non-blocking) - * @link http://www.php.net/manual/en/function.ftp-nb-get.php - * @param FTP\Connection $ftp - * @param string $local_filename - * @param string $remote_filename - * @param int $mode [optional] - * @param int $offset [optional] - * @return int|false Returns FTP_FAILED or FTP_FINISHED - * or FTP_MOREDATA, or false on failure to open the local file. + * {@inheritdoc} + * @param FTP\Connection $ftp + * @param string $local_filename + * @param string $remote_filename + * @param int $mode [optional] + * @param int $offset [optional] */ -function ftp_nb_get (FTP\Connection $ftp, string $local_filename, string $remote_filename, int $mode = FTP_BINARY, int $offset = null): int|false {} +function ftp_nb_get (FTP\Connection $ftp, string $local_filename, string $remote_filename, int $mode = 2, int $offset = 0): int|false {} /** - * Continues retrieving/sending a file (non-blocking) - * @link http://www.php.net/manual/en/function.ftp-nb-continue.php - * @param FTP\Connection $ftp - * @return int Returns FTP_FAILED or FTP_FINISHED - * or FTP_MOREDATA. + * {@inheritdoc} + * @param FTP\Connection $ftp */ function ftp_nb_continue (FTP\Connection $ftp): int {} /** - * Uploads from an open file to the FTP server - * @link http://www.php.net/manual/en/function.ftp-fput.php - * @param FTP\Connection $ftp - * @param string $remote_filename - * @param resource $stream - * @param int $mode [optional] - * @param int $offset [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param FTP\Connection $ftp + * @param string $remote_filename + * @param mixed $stream + * @param int $mode [optional] + * @param int $offset [optional] */ -function ftp_fput (FTP\Connection $ftp, string $remote_filename, $stream, int $mode = FTP_BINARY, int $offset = null): bool {} +function ftp_fput (FTP\Connection $ftp, string $remote_filename, $stream = null, int $mode = 2, int $offset = 0): bool {} /** - * Stores a file from an open file to the FTP server (non-blocking) - * @link http://www.php.net/manual/en/function.ftp-nb-fput.php - * @param FTP\Connection $ftp - * @param string $remote_filename - * @param resource $stream - * @param int $mode [optional] - * @param int $offset [optional] - * @return int Returns FTP_FAILED or FTP_FINISHED - * or FTP_MOREDATA. + * {@inheritdoc} + * @param FTP\Connection $ftp + * @param string $remote_filename + * @param mixed $stream + * @param int $mode [optional] + * @param int $offset [optional] */ -function ftp_nb_fput (FTP\Connection $ftp, string $remote_filename, $stream, int $mode = FTP_BINARY, int $offset = null): int {} +function ftp_nb_fput (FTP\Connection $ftp, string $remote_filename, $stream = null, int $mode = 2, int $offset = 0): int {} /** - * Uploads a file to the FTP server - * @link http://www.php.net/manual/en/function.ftp-put.php - * @param FTP\Connection $ftp - * @param string $remote_filename - * @param string $local_filename - * @param int $mode [optional] - * @param int $offset [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param FTP\Connection $ftp + * @param string $remote_filename + * @param string $local_filename + * @param int $mode [optional] + * @param int $offset [optional] */ -function ftp_put (FTP\Connection $ftp, string $remote_filename, string $local_filename, int $mode = FTP_BINARY, int $offset = null): bool {} +function ftp_put (FTP\Connection $ftp, string $remote_filename, string $local_filename, int $mode = 2, int $offset = 0): bool {} /** - * Append the contents of a file to another file on the FTP server - * @link http://www.php.net/manual/en/function.ftp-append.php - * @param FTP\Connection $ftp >An FTP\Connection instance. - * @param string $remote_filename - * @param string $local_filename - * @param int $mode [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param FTP\Connection $ftp + * @param string $remote_filename + * @param string $local_filename + * @param int $mode [optional] */ -function ftp_append (FTP\Connection $ftp, string $remote_filename, string $local_filename, int $mode = FTP_BINARY): bool {} +function ftp_append (FTP\Connection $ftp, string $remote_filename, string $local_filename, int $mode = 2): bool {} /** - * Stores a file on the FTP server (non-blocking) - * @link http://www.php.net/manual/en/function.ftp-nb-put.php - * @param FTP\Connection $ftp - * @param string $remote_filename - * @param string $local_filename - * @param int $mode [optional] - * @param int $offset [optional] - * @return int|false Returns FTP_FAILED or FTP_FINISHED - * or FTP_MOREDATA, or false on failure to open the local file. + * {@inheritdoc} + * @param FTP\Connection $ftp + * @param string $remote_filename + * @param string $local_filename + * @param int $mode [optional] + * @param int $offset [optional] */ -function ftp_nb_put (FTP\Connection $ftp, string $remote_filename, string $local_filename, int $mode = FTP_BINARY, int $offset = null): int|false {} +function ftp_nb_put (FTP\Connection $ftp, string $remote_filename, string $local_filename, int $mode = 2, int $offset = 0): int|false {} /** - * Returns the size of the given file - * @link http://www.php.net/manual/en/function.ftp-size.php - * @param FTP\Connection $ftp - * @param string $filename - * @return int Returns the file size on success, or -1 on error. + * {@inheritdoc} + * @param FTP\Connection $ftp + * @param string $filename */ function ftp_size (FTP\Connection $ftp, string $filename): int {} /** - * Returns the last modified time of the given file - * @link http://www.php.net/manual/en/function.ftp-mdtm.php - * @param FTP\Connection $ftp - * @param string $filename - * @return int Returns the last modified time as a local Unix timestamp on success, or -1 on - * error. + * {@inheritdoc} + * @param FTP\Connection $ftp + * @param string $filename */ function ftp_mdtm (FTP\Connection $ftp, string $filename): int {} /** - * Renames a file or a directory on the FTP server - * @link http://www.php.net/manual/en/function.ftp-rename.php - * @param FTP\Connection $ftp - * @param string $from - * @param string $to - * @return bool Returns true on success or false on failure. Upon failure (such as attempting to rename a non-existent - * file), an E_WARNING error will be emitted. + * {@inheritdoc} + * @param FTP\Connection $ftp + * @param string $from + * @param string $to */ function ftp_rename (FTP\Connection $ftp, string $from, string $to): bool {} /** - * Deletes a file on the FTP server - * @link http://www.php.net/manual/en/function.ftp-delete.php - * @param FTP\Connection $ftp - * @param string $filename - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param FTP\Connection $ftp + * @param string $filename */ function ftp_delete (FTP\Connection $ftp, string $filename): bool {} /** - * Sends a SITE command to the server - * @link http://www.php.net/manual/en/function.ftp-site.php - * @param FTP\Connection $ftp - * @param string $command - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param FTP\Connection $ftp + * @param string $command */ function ftp_site (FTP\Connection $ftp, string $command): bool {} /** - * Closes an FTP connection - * @link http://www.php.net/manual/en/function.ftp-close.php - * @param FTP\Connection $ftp - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param FTP\Connection $ftp */ function ftp_close (FTP\Connection $ftp): bool {} /** - * Alias of ftp_close - * @link http://www.php.net/manual/en/function.ftp-quit.php - * @param FTP\Connection $ftp - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param FTP\Connection $ftp */ function ftp_quit (FTP\Connection $ftp): bool {} /** - * Set miscellaneous runtime FTP options - * @link http://www.php.net/manual/en/function.ftp-set-option.php - * @param FTP\Connection $ftp - * @param int $option - * @param int|bool $value - * @return bool Returns true if the option could be set; false if not. A warning - * message will be thrown if the option is not - * supported or the passed value doesn't match the - * expected value for the given option. + * {@inheritdoc} + * @param FTP\Connection $ftp + * @param int $option + * @param mixed $value */ -function ftp_set_option (FTP\Connection $ftp, int $option, int|bool $value): bool {} +function ftp_set_option (FTP\Connection $ftp, int $option, $value = null): bool {} /** - * Retrieves various runtime behaviours of the current FTP connection - * @link http://www.php.net/manual/en/function.ftp-get-option.php - * @param FTP\Connection $ftp - * @param int $option - * @return int|bool Returns the value on success or false if the given - * option is not supported. In the latter case, a - * warning message is also thrown. + * {@inheritdoc} + * @param FTP\Connection $ftp + * @param int $option */ function ftp_get_option (FTP\Connection $ftp, int $option): int|bool {} - -/** - * - * @link http://www.php.net/manual/en/ftp.constants.php - * @var int - */ define ('FTP_ASCII', 1); - -/** - * Alias of FTP_ASCII. - * @link http://www.php.net/manual/en/ftp.constants.php - * @var int - */ define ('FTP_TEXT', 1); - -/** - * - * @link http://www.php.net/manual/en/ftp.constants.php - * @var int - */ define ('FTP_BINARY', 2); - -/** - * Alias of FTP_BINARY. - * @link http://www.php.net/manual/en/ftp.constants.php - * @var int - */ define ('FTP_IMAGE', 2); - -/** - * Automatically determine resume position and start position for GET and PUT requests - * (only works if FTP_AUTOSEEK is enabled) - * @link http://www.php.net/manual/en/ftp.constants.php - * @var int - */ define ('FTP_AUTORESUME', -1); - -/** - * See ftp_set_option for information. - * @link http://www.php.net/manual/en/ftp.constants.php - * @var int - */ define ('FTP_TIMEOUT_SEC', 0); - -/** - * See ftp_set_option for information. - * @link http://www.php.net/manual/en/ftp.constants.php - * @var int - */ define ('FTP_AUTOSEEK', 1); - -/** - * See ftp_set_option for information. - * @link http://www.php.net/manual/en/ftp.constants.php - * @var bool - */ define ('FTP_USEPASVADDRESS', 2); - -/** - * Asynchronous transfer has failed - * @link http://www.php.net/manual/en/ftp.constants.php - * @var int - */ define ('FTP_FAILED', 0); - -/** - * Asynchronous transfer has finished - * @link http://www.php.net/manual/en/ftp.constants.php - * @var int - */ define ('FTP_FINISHED', 1); - -/** - * Asynchronous transfer is still active - * @link http://www.php.net/manual/en/ftp.constants.php - * @var int - */ define ('FTP_MOREDATA', 2); } -// End of ftp v.8.2.6 +// End of ftp v.8.3.0 diff --git a/plugins/org.eclipse.php.core/Resources/language/php8.3/gd.php b/plugins/org.eclipse.php.core/Resources/language/php8.3/gd.php index aeb22ece92..9efb067e29 100644 --- a/plugins/org.eclipse.php.core/Resources/language/php8.3/gd.php +++ b/plugins/org.eclipse.php.core/Resources/language/php8.3/gd.php @@ -1,1631 +1,939 @@Attribute | - *Meaning | - *
GD Version | - *string value describing the installed - * libgd version. | - *
FreeType Support | - *bool value. true - * if FreeType Support is installed. | - *
FreeType Linkage | - *string value describing the way in which - * FreeType was linked. Expected values are: 'with freetype', - * 'with TTF library', and 'with unknown library'. This element will - * only be defined if FreeType Support evaluated to - * true. | - *
GIF Read Support | - *bool value. true - * if support for reading GIF - * images is included. | - *
GIF Create Support | - *bool value. true - * if support for creating GIF - * images is included. | - *
JPEG Support | - *bool value. true - * if JPEG support is included. | - *
PNG Support | - *bool value. true - * if PNG support is included. | - *
WBMP Support | - *bool value. true - * if WBMP support is included. | - *
XBM Support | - *bool value. true - * if XBM support is included. | - *
WebP Support | - *bool value. true - * if WebP support is included. | - *
AVIF Support | - *bool value. true - * if AVIF support is included. - * Available as of PHP 8.1.0. | - *
- *
- * x-coordinate of the upper left corner
- *
- * y-coordinate of the upper left corner
- *
- * x-coordinate of the lower right corner
- *
- * y-coordinate of the lower right corner
- *
0 | - *lower left corner, X position | - *
1 | - *lower left corner, Y position | - *
2 | - *lower right corner, X position | - *
3 | - *lower right corner, Y position | - *
4 | - *upper right corner, X position | - *
5 | - *upper right corner, Y position | - *
6 | - *upper left corner, X position | - *
7 | - *upper left corner, Y position | - *
The points are relative to the text regardless of the - * angle, so "upper left" means in the top left-hand - * corner seeing the text horizontally.
- *On failure, false is returned.
- */ -function imageftbbox (float $size, float $angle, string $font_filename, string $string, array $options = '[]'): array|false {} - -/** - * Write text to the image using fonts using FreeType 2 - * @link http://www.php.net/manual/en/function.imagefttext.php - * @param GdImage $image - * @param float $size - * @param float $angle - * @param int $x - * @param int $y - * @param int $color - * @param string $font_filename - * @param string $text - * @param array $options [optional] - * @return array|false This function returns an array defining the four points of the box, starting in the lower left and moving counter-clockwise: - *0 | - *lower left x-coordinate | - *
1 | - *lower left y-coordinate | - *
2 | - *lower right x-coordinate | - *
3 | - *lower right y-coordinate | - *
4 | - *upper right x-coordinate | - *
5 | - *upper right y-coordinate | - *
6 | - *upper left x-coordinate | - *
7 | - *upper left y-coordinate | - *
On failure, false is returned.
- */ -function imagefttext (GdImage $image, float $size, float $angle, int $x, int $y, int $color, string $font_filename, string $text, array $options = '[]'): array|false {} - -/** - * Give the bounding box of a text using TrueType fonts - * @link http://www.php.net/manual/en/function.imagettfbbox.php - * @param float $size - * @param float $angle - * @param string $font_filename - * @param string $string - * @param array $options [optional] - * @return array|false imagettfbbox returns an array with 8 - * elements representing four points making the bounding box of the - * text on success and false on error. - *key | - *contents | - *
0 | - *lower left corner, X position | - *
1 | - *lower left corner, Y position | - *
2 | - *lower right corner, X position | - *
3 | - *lower right corner, Y position | - *
4 | - *upper right corner, X position | - *
5 | - *upper right corner, Y position | - *
6 | - *upper left corner, X position | - *
7 | - *upper left corner, Y position | - *
The points are relative to the text regardless of the - * angle, so "upper left" means in the top left-hand - * corner seeing the text horizontally.
- */ -function imagettfbbox (float $size, float $angle, string $font_filename, string $string, array $options = '[]'): array|false {} - -/** - * Write text to the image using TrueType fonts - * @link http://www.php.net/manual/en/function.imagettftext.php - * @param GdImage $image - * @param float $size - * @param float $angle - * @param int $x - * @param int $y - * @param int $color - * @param string $font_filename - * @param string $text - * @param array $options [optional] - * @return array|false Returns an array with 8 elements representing four points making the - * bounding box of the text. The order of the points is lower left, lower - * right, upper right, upper left. The points are relative to the text - * regardless of the angle, so "upper left" means in the top left-hand - * corner when you see the text horizontally. - * Returns false on error. - */ -function imagettftext (GdImage $image, float $size, float $angle, int $x, int $y, int $color, string $font_filename, string $text, array $options = '[]'): array|false {} - -/** - * Applies a filter to an image - * @link http://www.php.net/manual/en/function.imagefilter.php - * @param GdImage $image - * @param int $filter - * @param array|int|float|bool $args - * @return bool Returns true on success or false on failure. - */ -function imagefilter (GdImage $image, int $filter, array|int|float|bool ...$args): bool {} - -/** - * Apply a 3x3 convolution matrix, using coefficient and offset - * @link http://www.php.net/manual/en/function.imageconvolution.php - * @param GdImage $image - * @param array $matrix - * @param float $divisor - * @param float $offset - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param float $size + * @param float $angle + * @param string $font_filename + * @param string $string + * @param array $options [optional] */ -function imageconvolution (GdImage $image, array $matrix, float $divisor, float $offset): bool {} +function imageftbbox (float $size, float $angle, string $font_filename, string $string, array $options = array ( +)): array|false {} /** - * Flips an image using a given mode - * @link http://www.php.net/manual/en/function.imageflip.php - * @param GdImage $image - * @param int $mode - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param GdImage $image + * @param float $size + * @param float $angle + * @param int $x + * @param int $y + * @param int $color + * @param string $font_filename + * @param string $text + * @param array $options [optional] */ -function imageflip (GdImage $image, int $mode): bool {} +function imagefttext (GdImage $image, float $size, float $angle, int $x, int $y, int $color, string $font_filename, string $text, array $options = array ( +)): array|false {} /** - * Should antialias functions be used or not - * @link http://www.php.net/manual/en/function.imageantialias.php - * @param GdImage $image - * @param bool $enable - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param float $size + * @param float $angle + * @param string $font_filename + * @param string $string + * @param array $options [optional] */ -function imageantialias (GdImage $image, bool $enable): bool {} +function imagettfbbox (float $size, float $angle, string $font_filename, string $string, array $options = array ( +)): array|false {} /** - * Crop an image to the given rectangle - * @link http://www.php.net/manual/en/function.imagecrop.php - * @param GdImage $image A GdImage object, returned by one of the image creation functions, - * such as imagecreatetruecolor. - * @param array $rectangle The cropping rectangle as array with keys - * x, y, width and - * height. - * @return GdImage|false Return cropped image object on success or false on failure. + * {@inheritdoc} + * @param GdImage $image + * @param float $size + * @param float $angle + * @param int $x + * @param int $y + * @param int $color + * @param string $font_filename + * @param string $text + * @param array $options [optional] */ -function imagecrop (GdImage $image, array $rectangle): GdImage|false {} +function imagettftext (GdImage $image, float $size, float $angle, int $x, int $y, int $color, string $font_filename, string $text, array $options = array ( +)): array|false {} /** - * Crop an image automatically using one of the available modes - * @link http://www.php.net/manual/en/function.imagecropauto.php - * @param GdImage $image A GdImage object, returned by one of the image creation functions, - * such as imagecreatetruecolor. - * @param int $mode [optional] One of the following constants: - * @param float $threshold [optional] Specifies the tolerance in percent to be used while comparing the image - * color and the color to crop. The method used to calculate the color - * difference is based on the color distance in the RGB(a) cube. - *Used only in IMG_CROP_THRESHOLD mode.
- * @param int $color [optional] Either an RGB color value or a palette index. - *Used only in IMG_CROP_THRESHOLD mode.
- * @return GdImage|false Returns a cropped image object on success or false on failure. - * If the complete image was cropped, imagecrop returns false. - */ -function imagecropauto (GdImage $image, int $mode = IMG_CROP_DEFAULT, float $threshold = 0.5, int $color = -1): GdImage|false {} - -/** - * Scale an image using the given new width and height - * @link http://www.php.net/manual/en/function.imagescale.php - * @param GdImage $image A GdImage object, returned by one of the image creation functions, - * such as imagecreatetruecolor. - * @param int $width The width to scale the image to. - * @param int $height [optional] The height to scale the image to. If omitted or negative, the aspect - * ratio will be preserved. - * @param int $mode [optional] One of IMG_NEAREST_NEIGHBOUR, - * IMG_BILINEAR_FIXED, - * IMG_BICUBIC, - * IMG_BICUBIC_FIXED or anything else (will use two - * pass). - * IMG_WEIGHTED4 is not yet supported. - * @return GdImage|false Return the scaled image object on success or false on failure. - */ -function imagescale (GdImage $image, int $width, int $height = -1, int $mode = IMG_BILINEAR_FIXED): GdImage|false {} - -/** - * Return an image containing the affine transformed src image, using an optional clipping area - * @link http://www.php.net/manual/en/function.imageaffine.php - * @param GdImage $image A GdImage object, returned by one of the image creation functions, - * such as imagecreatetruecolor. - * @param array $affine Array with keys 0 to 5. - * @param array|null $clip [optional] Array with keys "x", "y", "width" and "height"; or null. - * @return GdImage|false Return affined image object on success or false on failure. - */ -function imageaffine (GdImage $image, array $affine, ?array $clip = null): GdImage|false {} - -/** - * Get an affine transformation matrix - * @link http://www.php.net/manual/en/function.imageaffinematrixget.php - * @param int $type One of the IMG_AFFINE_* constants. - * @param array|float $options If type is IMG_AFFINE_TRANSLATE - * or IMG_AFFINE_SCALE, - * options has to be an array with keys x - * and y, both having float values. - *If type is IMG_AFFINE_ROTATE, - * IMG_AFFINE_SHEAR_HORIZONTAL or IMG_AFFINE_SHEAR_VERTICAL, - * options has to be a float specifying the angle.
- * @return array|false An affine transformation matrix (an array with keys - * 0 to 5 and float values) - * or false on failure. - */ -function imageaffinematrixget (int $type, array|float $options): array|false {} - -/** - * Concatenate two affine transformation matrices - * @link http://www.php.net/manual/en/function.imageaffinematrixconcat.php - * @param array $matrix1 An affine transformation matrix (an array with keys - * 0 to 5 and float values). - * @param array $matrix2 An affine transformation matrix (an array with keys - * 0 to 5 and float values). - * @return array|false An affine transformation matrix (an array with keys - * 0 to 5 and float values) - * or false on failure. + * {@inheritdoc} + * @param GdImage $image + * @param int $filter + * @param mixed $args [optional] */ -function imageaffinematrixconcat (array $matrix1, array $matrix2): array|false {} +function imagefilter (GdImage $image, int $filter, ...$args): bool {} /** - * Get the interpolation method - * @link http://www.php.net/manual/en/function.imagegetinterpolation.php - * @param GdImage $image A GdImage object, returned by one of the image creation functions, - * such as imagecreatetruecolor. - * @return int Returns the interpolation method. + * {@inheritdoc} + * @param GdImage $image + * @param array $matrix + * @param float $divisor + * @param float $offset */ -function imagegetinterpolation (GdImage $image): int {} +function imageconvolution (GdImage $image, array $matrix, float $divisor, float $offset): bool {} /** - * Set the interpolation method - * @link http://www.php.net/manual/en/function.imagesetinterpolation.php - * @param GdImage $image - * @param int $method [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param GdImage $image + * @param int $mode */ -function imagesetinterpolation (GdImage $image, int $method = IMG_BILINEAR_FIXED): bool {} +function imageflip (GdImage $image, int $mode): bool {} /** - * Get or set the resolution of the image - * @link http://www.php.net/manual/en/function.imageresolution.php - * @param GdImage $image A GdImage object, returned by one of the image creation functions, - * such as imagecreatetruecolor. - * @param int|null $resolution_x [optional] The horizontal resolution in DPI. - * @param int|null $resolution_y [optional] The vertical resolution in DPI. - * @return array|bool When used as getter, - * it returns an indexed array of the horizontal and vertical resolution on - * success, or false on failure. - * When used as setter, it returns - * true on success, or false on failure. + * {@inheritdoc} + * @param GdImage $image + * @param bool $enable */ -function imageresolution (GdImage $image, ?int $resolution_x = null, ?int $resolution_y = null): array|bool {} - +function imageantialias (GdImage $image, bool $enable): bool {} /** - * > - * Used as a return value by imagetypes - * Available as of PHP 8.1.0. - * @link http://www.php.net/manual/en/image.constants.php - * @var int + * {@inheritdoc} + * @param GdImage $image + * @param array $rectangle */ -define ('IMG_AVIF', 256); +function imagecrop (GdImage $image, array $rectangle): GdImage|false {} /** - * > - * Used as a return value by imagetypes - * @link http://www.php.net/manual/en/image.constants.php - * @var int + * {@inheritdoc} + * @param GdImage $image + * @param int $mode [optional] + * @param float $threshold [optional] + * @param int $color [optional] */ -define ('IMG_GIF', 1); +function imagecropauto (GdImage $image, int $mode = 0, float $threshold = 0.5, int $color = -1): GdImage|false {} /** - * > - * Used as a return value by imagetypes - * @link http://www.php.net/manual/en/image.constants.php - * @var int + * {@inheritdoc} + * @param GdImage $image + * @param int $width + * @param int $height [optional] + * @param int $mode [optional] */ -define ('IMG_JPG', 2); +function imagescale (GdImage $image, int $width, int $height = -1, int $mode = 3): GdImage|false {} /** - * This constant has the same value as IMG_JPG - * @link http://www.php.net/manual/en/image.constants.php - * @var int + * {@inheritdoc} + * @param GdImage $image + * @param array $affine + * @param array|null $clip [optional] */ -define ('IMG_JPEG', 2); +function imageaffine (GdImage $image, array $affine, ?array $clip = NULL): GdImage|false {} /** - * > - * Used as a return value by imagetypes - * @link http://www.php.net/manual/en/image.constants.php - * @var int + * {@inheritdoc} + * @param int $type + * @param mixed $options */ -define ('IMG_PNG', 4); +function imageaffinematrixget (int $type, $options = null): array|false {} /** - * > - * Used as a return value by imagetypes - * @link http://www.php.net/manual/en/image.constants.php - * @var int + * {@inheritdoc} + * @param array $matrix1 + * @param array $matrix2 */ -define ('IMG_WBMP', 8); +function imageaffinematrixconcat (array $matrix1, array $matrix2): array|false {} /** - * > - * Used as a return value by imagetypes - * @link http://www.php.net/manual/en/image.constants.php - * @var int + * {@inheritdoc} + * @param GdImage $image */ -define ('IMG_XPM', 16); +function imagegetinterpolation (GdImage $image): int {} /** - * > - * Used as a return value by imagetypes - * Available as of PHP 7.0.10. - * @link http://www.php.net/manual/en/image.constants.php - * @var int + * {@inheritdoc} + * @param GdImage $image + * @param int $method [optional] */ -define ('IMG_WEBP', 32); +function imagesetinterpolation (GdImage $image, int $method = 3): bool {} /** - * > - * Used as a return value by imagetypes - * @link http://www.php.net/manual/en/image.constants.php - * @var int + * {@inheritdoc} + * @param GdImage $image + * @param int|null $resolution_x [optional] + * @param int|null $resolution_y [optional] */ +function imageresolution (GdImage $image, ?int $resolution_x = NULL, ?int $resolution_y = NULL): array|bool {} + +define ('IMG_AVIF', 256); +define ('IMG_GIF', 1); +define ('IMG_JPG', 2); +define ('IMG_JPEG', 2); +define ('IMG_PNG', 4); +define ('IMG_WBMP', 8); +define ('IMG_XPM', 16); +define ('IMG_WEBP', 32); define ('IMG_BMP', 64); define ('IMG_TGA', 128); - -/** - * Available as of PHP 8.1.0. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_WEBP_LOSSLESS', 101); - -/** - * > - * Special color option which can be used instead of a color allocated with - * imagecolorallocate or - * imagecolorallocatealpha. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_COLOR_TILED', -5); - -/** - * > - * Special color option which can be used instead of a color allocated with - * imagecolorallocate or - * imagecolorallocatealpha. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_COLOR_STYLED', -2); - -/** - * > - * Special color option which can be used instead of a color allocated with - * imagecolorallocate or - * imagecolorallocatealpha. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_COLOR_BRUSHED', -3); - -/** - * > - * Special color option which can be used instead of a color allocated with - * imagecolorallocate or - * imagecolorallocatealpha. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_COLOR_STYLEDBRUSHED', -4); - -/** - * > - * Special color option which can be used instead of a color allocated with - * imagecolorallocate or - * imagecolorallocatealpha. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_COLOR_TRANSPARENT', -6); - -/** - * This constant has the same value as IMG_ARC_PIE - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_ARC_ROUNDED', 0); - -/** - * > - * A style constant used by the imagefilledarc function. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_ARC_PIE', 0); - -/** - * > - * A style constant used by the imagefilledarc function. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_ARC_CHORD', 1); - -/** - * > - * A style constant used by the imagefilledarc function. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_ARC_NOFILL', 2); - -/** - * > - * A style constant used by the imagefilledarc function. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_ARC_EDGED', 4); - -/** - * > - * A type constant used by the imagegd2 function. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_GD2_RAW', 1); - -/** - * > - * A type constant used by the imagegd2 function. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_GD2_COMPRESSED', 2); - -/** - * > - * Used together with imageflip, available as of PHP 5.5.0. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_FLIP_HORIZONTAL', 1); - -/** - * > - * Used together with imageflip, available as of PHP 5.5.0. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_FLIP_VERTICAL', 2); - -/** - * > - * Used together with imageflip, available as of PHP 5.5.0. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_FLIP_BOTH', 3); - -/** - * > - * Alpha blending effect used by the imagelayereffect function. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_EFFECT_REPLACE', 0); - -/** - * > - * Alpha blending effect used by the imagelayereffect function. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_EFFECT_ALPHABLEND', 1); - -/** - * > - * Alpha blending effect used by the imagelayereffect function. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_EFFECT_NORMAL', 2); - -/** - * > - * Alpha blending effect used by the imagelayereffect function. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_EFFECT_OVERLAY', 3); - -/** - * > - * Alpha blending effect used by the imagelayereffect function. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_EFFECT_MULTIPLY', 4); define ('IMG_CROP_DEFAULT', 0); define ('IMG_CROP_TRANSPARENT', 1); @@ -1633,417 +941,57 @@ function imageresolution (GdImage $image, ?int $resolution_x = null, ?int $resol define ('IMG_CROP_WHITE', 3); define ('IMG_CROP_SIDES', 4); define ('IMG_CROP_THRESHOLD', 5); - -/** - * > - * Used together with imagesetinterpolation, available as of PHP 5.5.0. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_BELL', 1); - -/** - * > - * Used together with imagesetinterpolation, available as of PHP 5.5.0. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_BESSEL', 2); - -/** - * > - * Used together with imagesetinterpolation, available as of PHP 5.5.0. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_BILINEAR_FIXED', 3); - -/** - * > - * Used together with imagesetinterpolation, available as of PHP 5.5.0. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_BICUBIC', 4); - -/** - * > - * Used together with imagesetinterpolation, available as of PHP 5.5.0. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_BICUBIC_FIXED', 5); - -/** - * > - * Used together with imagesetinterpolation, available as of PHP 5.5.0. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_BLACKMAN', 6); - -/** - * > - * Used together with imagesetinterpolation, available as of PHP 5.5.0. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_BOX', 7); - -/** - * > - * Used together with imagesetinterpolation, available as of PHP 5.5.0. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_BSPLINE', 8); - -/** - * > - * Used together with imagesetinterpolation, available as of PHP 5.5.0. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_CATMULLROM', 9); - -/** - * > - * Used together with imagesetinterpolation, available as of PHP 5.5.0. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_GAUSSIAN', 10); - -/** - * > - * Used together with imagesetinterpolation, available as of PHP 5.5.0. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_GENERALIZED_CUBIC', 11); - -/** - * > - * Used together with imagesetinterpolation, available as of PHP 5.5.0. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_HERMITE', 12); - -/** - * > - * Used together with imagesetinterpolation, available as of PHP 5.5.0. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_HAMMING', 13); - -/** - * > - * Used together with imagesetinterpolation, available as of PHP 5.5.0. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_HANNING', 14); - -/** - * > - * Used together with imagesetinterpolation, available as of PHP 5.5.0. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_MITCHELL', 15); - -/** - * > - * Used together with imagesetinterpolation, available as of PHP 5.5.0. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_POWER', 17); - -/** - * > - * Used together with imagesetinterpolation, available as of PHP 5.5.0. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_QUADRATIC', 18); - -/** - * > - * Used together with imagesetinterpolation, available as of PHP 5.5.0. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_SINC', 19); - -/** - * > - * Used together with imagesetinterpolation, available as of PHP 5.5.0. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_NEAREST_NEIGHBOUR', 16); - -/** - * > - * Used together with imagesetinterpolation, available as of PHP 5.5.0. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_WEIGHTED4', 21); - -/** - * > - * Used together with imagesetinterpolation, available as of PHP 5.5.0. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_TRIANGLE', 20); - -/** - * > - * An affine transformation type constant used by the imageaffinematrixget function. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_AFFINE_TRANSLATE', 0); - -/** - * > - * An affine transformation type constant used by the imageaffinematrixget function. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_AFFINE_SCALE', 1); - -/** - * > - * An affine transformation type constant used by the imageaffinematrixget function. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_AFFINE_ROTATE', 2); - -/** - * > - * An affine transformation type constant used by the imageaffinematrixget function. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_AFFINE_SHEAR_HORIZONTAL', 3); - -/** - * > - * An affine transformation type constant used by the imageaffinematrixget function. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_AFFINE_SHEAR_VERTICAL', 4); - -/** - * When the bundled version of GD is used this is 1 otherwise - * its set to 0. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('GD_BUNDLED', 0); - -/** - * > - * Special GD filter used by the imagefilter function. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_FILTER_NEGATE', 0); - -/** - * > - * Special GD filter used by the imagefilter function. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_FILTER_GRAYSCALE', 1); - -/** - * > - * Special GD filter used by the imagefilter function. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_FILTER_BRIGHTNESS', 2); - -/** - * > - * Special GD filter used by the imagefilter function. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_FILTER_CONTRAST', 3); - -/** - * > - * Special GD filter used by the imagefilter function. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_FILTER_COLORIZE', 4); - -/** - * > - * Special GD filter used by the imagefilter function. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_FILTER_EDGEDETECT', 5); - -/** - * > - * Special GD filter used by the imagefilter function. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_FILTER_GAUSSIAN_BLUR', 7); - -/** - * > - * Special GD filter used by the imagefilter function. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_FILTER_SELECTIVE_BLUR', 8); - -/** - * > - * Special GD filter used by the imagefilter function. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_FILTER_EMBOSS', 6); - -/** - * > - * Special GD filter used by the imagefilter function. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_FILTER_MEAN_REMOVAL', 9); - -/** - * > - * Special GD filter used by the imagefilter function. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_FILTER_SMOOTH', 10); - -/** - * > - * Special GD filter used by the imagefilter function. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_FILTER_PIXELATE', 11); - -/** - * > - * Special GD filter used by the imagefilter function. - * (Available as of PHP 7.4.0) - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMG_FILTER_SCATTER', 12); - -/** - * The GD version PHP was compiled against. - * @link http://www.php.net/manual/en/image.constants.php - * @var string - */ define ('GD_VERSION', "2.3.3"); - -/** - * The GD major version PHP was compiled against. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('GD_MAJOR_VERSION', 2); - -/** - * The GD minor version PHP was compiled against. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('GD_MINOR_VERSION', 3); - -/** - * The GD release version PHP was compiled against. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('GD_RELEASE_VERSION', 3); - -/** - * The GD "extra" version (beta/rc..) PHP was compiled against. - * @link http://www.php.net/manual/en/image.constants.php - * @var string - */ define ('GD_EXTRA_VERSION', ""); - -/** - * > - * A special PNG filter, used by the imagepng function. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('PNG_NO_FILTER', 0); - -/** - * > - * A special PNG filter, used by the imagepng function. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('PNG_FILTER_NONE', 8); - -/** - * > - * A special PNG filter, used by the imagepng function. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('PNG_FILTER_SUB', 16); - -/** - * > - * A special PNG filter, used by the imagepng function. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('PNG_FILTER_UP', 32); - -/** - * > - * A special PNG filter, used by the imagepng function. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('PNG_FILTER_AVG', 64); - -/** - * > - * A special PNG filter, used by the imagepng function. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('PNG_FILTER_PAETH', 128); - -/** - * > - * A special PNG filter, used by the imagepng function. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('PNG_ALL_FILTERS', 248); -// End of gd v.8.2.6 +// End of gd v.8.3.0 diff --git a/plugins/org.eclipse.php.core/Resources/language/php8.3/gearman.php b/plugins/org.eclipse.php.core/Resources/language/php8.3/gearman.php index eaf01d7894..bc2bacfe08 100644 --- a/plugins/org.eclipse.php.core/Resources/language/php8.3/gearman.php +++ b/plugins/org.eclipse.php.core/Resources/language/php8.3/gearman.php @@ -2,20 +2,12 @@ // Start of gearman v.2.1.0 -/** - * Represents a class for connecting to a Gearman job server and making requests to perform - * some function on provided data. The function performed must be one registered by a Gearman - * worker and the data passed is opaque to the job server. - * @link http://www.php.net/manual/en/class.gearmanclient.php - */ class GearmanClient { /** - * Create a GearmanClient instance - * @link http://www.php.net/manual/en/gearmanclient.construct.php - * @return void A GearmanClient object. + * {@inheritdoc} */ - public function __construct (): void {} + public function __construct () {} /** * {@inheritdoc} @@ -23,23 +15,17 @@ public function __construct (): void {} public function __destruct () {} /** - * Get the last Gearman return code - * @link http://www.php.net/manual/en/gearmanclient.returncode.php - * @return int A valid Gearman return code. + * {@inheritdoc} */ public function returnCode (): int {} /** - * Returns an error string for the last error encountered - * @link http://www.php.net/manual/en/gearmanclient.error.php - * @return string A human readable error string. + * {@inheritdoc} */ - public function error (): string {} + public function error (): string|false {} /** - * Get an errno value - * @link http://www.php.net/manual/en/gearmanclient.geterrno.php - * @return int A valid Gearman errno. + * {@inheritdoc} */ public function getErrno (): int {} @@ -49,152 +35,115 @@ public function getErrno (): int {} public function options (): int {} /** - * Set client options - * @link http://www.php.net/manual/en/gearmanclient.setoptions.php - * @param int $options - * @return bool Always returns true. + * {@inheritdoc} + * @param int $option */ - public function setOptions (int $options): bool {} + public function setOptions (int $option): bool {} /** - * Add client options - * @link http://www.php.net/manual/en/gearmanclient.addoptions.php - * @param int $options - * @return bool Always returns true. + * {@inheritdoc} + * @param int $option */ - public function addOptions (int $options): bool {} + public function addOptions (int $option): bool {} /** - * Remove client options - * @link http://www.php.net/manual/en/gearmanclient.removeoptions.php - * @param int $options - * @return bool Always returns true. + * {@inheritdoc} + * @param int $option */ - public function removeOptions (int $options): bool {} + public function removeOptions (int $option): bool {} /** - * Get current socket I/O activity timeout value - * @link http://www.php.net/manual/en/gearmanclient.timeout.php - * @return int Timeout in milliseconds to wait for I/O activity. A negative value means an infinite timeout. + * {@inheritdoc} */ public function timeout (): int {} /** - * Set socket I/O activity timeout - * @link http://www.php.net/manual/en/gearmanclient.settimeout.php - * @param int $timeout - * @return bool Always returns true. + * {@inheritdoc} + * @param int $timeout */ public function setTimeout (int $timeout): bool {} /** - * Add a job server to the client - * @link http://www.php.net/manual/en/gearmanclient.addserver.php - * @param string $host [optional] - * @param int $port [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $host [optional] + * @param int $port [optional] + * @param bool $setupExceptionHandler [optional] */ - public function addServer (string $host = '127.0.0.1', int $port = 4730): bool {} + public function addServer (string $host = NULL, int $port = 0, bool $setupExceptionHandler = true): bool {} /** - * Add a list of job servers to the client - * @link http://www.php.net/manual/en/gearmanclient.addservers.php - * @param string $servers [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $servers [optional] + * @param bool $setupExceptionHandler [optional] */ - public function addServers (string $servers = '127.0.0.1:4730'): bool {} + public function addServers (string $servers = NULL, bool $setupExceptionHandler = true): bool {} /** - * Wait for I/O activity on all connections in a client - * @link http://www.php.net/manual/en/gearmanclient.wait.php - * @return bool true on success false on an error. + * {@inheritdoc} */ public function wait (): bool {} /** - * Run a single task and return a result - * @link http://www.php.net/manual/en/gearmanclient.donormal.php - * @param string $function_name - * @param string $workload - * @param string $unique [optional] - * @return string A string representing the results of running a task. + * {@inheritdoc} + * @param string $function + * @param string $workload + * @param string|null $unique [optional] */ - public function doNormal (string $function_name, string $workload, string $unique = null): string {} + public function doNormal (string $function, string $workload, ?string $unique = NULL): string {} /** - * Run a single high priority task - * @link http://www.php.net/manual/en/gearmanclient.dohigh.php - * @param string $function_name - * @param string $workload - * @param string $unique [optional] - * @return string A string representing the results of running a task. + * {@inheritdoc} + * @param string $function + * @param string $workload + * @param string|null $unique [optional] */ - public function doHigh (string $function_name, string $workload, string $unique = null): string {} + public function doHigh (string $function, string $workload, ?string $unique = NULL): string {} /** - * Run a single low priority task - * @link http://www.php.net/manual/en/gearmanclient.dolow.php - * @param string $function_name - * @param string $workload - * @param string $unique [optional] - * @return string A string representing the results of running a task. + * {@inheritdoc} + * @param string $function + * @param string $workload + * @param string|null $unique [optional] */ - public function dolow (string $function_name, string $workload, string $unique = null): string {} + public function dolow (string $function, string $workload, ?string $unique = NULL): string {} /** - * Run a task in the background - * @link http://www.php.net/manual/en/gearmanclient.dobackground.php - * @param string $function_name - * @param string $workload - * @param string $unique [optional] - * @return string The job handle for the submitted task. + * {@inheritdoc} + * @param string $function + * @param string $workload + * @param string|null $unique [optional] */ - public function doBackground (string $function_name, string $workload, string $unique = null): string {} + public function doBackground (string $function, string $workload, ?string $unique = NULL): string {} /** - * Run a high priority task in the background - * @link http://www.php.net/manual/en/gearmanclient.dohighbackground.php - * @param string $function_name - * @param string $workload - * @param string $unique [optional] - * @return string The job handle for the submitted task. + * {@inheritdoc} + * @param string $function + * @param string $workload + * @param string|null $unique [optional] */ - public function doHighBackground (string $function_name, string $workload, string $unique = null): string {} + public function doHighBackground (string $function, string $workload, ?string $unique = NULL): string {} /** - * Run a low priority task in the background - * @link http://www.php.net/manual/en/gearmanclient.dolowbackground.php - * @param string $function_name - * @param string $workload - * @param string $unique [optional] - * @return string The job handle for the submitted task. + * {@inheritdoc} + * @param string $function + * @param string $workload + * @param string|null $unique [optional] */ - public function doLowBackground (string $function_name, string $workload, string $unique = null): string {} + public function doLowBackground (string $function, string $workload, ?string $unique = NULL): string {} /** - * Get the job handle for the running task - * @link http://www.php.net/manual/en/gearmanclient.dojobhandle.php - * @return string The job handle for the running task. + * {@inheritdoc} */ public function doJobHandle (): string {} /** - * Get the status for the running task - * @link http://www.php.net/manual/en/gearmanclient.dostatus.php - * @return array An array representing the percentage completion given as a fraction, with the - * first element the numerator and the second element the denomintor. + * {@inheritdoc} */ public function doStatus (): array {} /** - * Get the status of a background job - * @link http://www.php.net/manual/en/gearmanclient.jobstatus.php - * @param string $job_handle - * @return array An array containing status information for the job corresponding to the supplied - * job handle. The first array element is a boolean indicating whether the job is - * even known, the second is a boolean indicating whether the job is still running, - * and the third and fourth elements correspond to the numerator and denominator - * of the fractional completion percentage, respectively. + * {@inheritdoc} + * @param string $job_handle */ public function jobStatus (string $job_handle): array {} @@ -205,180 +154,140 @@ public function jobStatus (string $job_handle): array {} public function jobStatusByUniqueKey (string $unique_key): array {} /** - * Send data to all job servers to see if they echo it back - * @link http://www.php.net/manual/en/gearmanclient.ping.php - * @param string $workload - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $workload */ public function ping (string $workload): bool {} /** - * Add a task to be run in parallel - * @link http://www.php.net/manual/en/gearmanclient.addtask.php - * @param string $function_name - * @param string $workload - * @param mixed $context [optional] - * @param string $unique [optional] - * @return GearmanTask A GearmanTask object or false if the task could not be added. + * {@inheritdoc} + * @param string $function_name + * @param string|int|float $workload + * @param mixed $context [optional] + * @param string|null $unique_key [optional] */ - public function addTask (string $function_name, string $workload, mixed &$context = null, string $unique = null): GearmanTask {} + public function addTask (string $function_name, string|int|float $workload, mixed $context = NULL, ?string $unique_key = NULL): GearmanTask|false {} /** - * Add a high priority task to run in parallel - * @link http://www.php.net/manual/en/gearmanclient.addtaskhigh.php - * @param string $function_name - * @param string $workload - * @param mixed $context [optional] - * @param string $unique [optional] - * @return GearmanTask A GearmanTask object or false if the task could not be added. + * {@inheritdoc} + * @param string $function_name + * @param string|int|float $workload + * @param mixed $context [optional] + * @param string|null $unique_key [optional] */ - public function addTaskHigh (string $function_name, string $workload, mixed &$context = null, string $unique = null): GearmanTask {} + public function addTaskHigh (string $function_name, string|int|float $workload, mixed $context = NULL, ?string $unique_key = NULL): GearmanTask|false {} /** - * Add a low priority task to run in parallel - * @link http://www.php.net/manual/en/gearmanclient.addtasklow.php - * @param string $function_name - * @param string $workload - * @param mixed $context [optional] - * @param string $unique [optional] - * @return GearmanTask A GearmanTask object or false if the task could not be added. + * {@inheritdoc} + * @param string $function_name + * @param string|int|float $workload + * @param mixed $context [optional] + * @param string|null $unique_key [optional] */ - public function addTaskLow (string $function_name, string $workload, mixed &$context = null, string $unique = null): GearmanTask {} + public function addTaskLow (string $function_name, string|int|float $workload, mixed $context = NULL, ?string $unique_key = NULL): GearmanTask|false {} /** - * Add a background task to be run in parallel - * @link http://www.php.net/manual/en/gearmanclient.addtaskbackground.php - * @param string $function_name - * @param string $workload - * @param mixed $context [optional] - * @param string $unique [optional] - * @return GearmanTask A GearmanTask object or false if the task could not be added. + * {@inheritdoc} + * @param string $function_name + * @param string|int|float $workload + * @param mixed $context [optional] + * @param string|null $unique_key [optional] */ - public function addTaskBackground (string $function_name, string $workload, mixed &$context = null, string $unique = null): GearmanTask {} + public function addTaskBackground (string $function_name, string|int|float $workload, mixed $context = NULL, ?string $unique_key = NULL): GearmanTask|false {} /** - * Add a high priority background task to be run in parallel - * @link http://www.php.net/manual/en/gearmanclient.addtaskhighbackground.php - * @param string $function_name - * @param string $workload - * @param mixed $context [optional] - * @param string $unique [optional] - * @return GearmanTask A GearmanTask object or false if the task could not be added. + * {@inheritdoc} + * @param string $function_name + * @param string|int|float $workload + * @param mixed $context [optional] + * @param string|null $unique_key [optional] */ - public function addTaskHighBackground (string $function_name, string $workload, mixed &$context = null, string $unique = null): GearmanTask {} + public function addTaskHighBackground (string $function_name, string|int|float $workload, mixed $context = NULL, ?string $unique_key = NULL): GearmanTask|false {} /** - * Add a low priority background task to be run in parallel - * @link http://www.php.net/manual/en/gearmanclient.addtasklowbackground.php - * @param string $function_name - * @param string $workload - * @param mixed $context [optional] - * @param string $unique [optional] - * @return GearmanTask A GearmanTask object or false if the task could not be added. + * {@inheritdoc} + * @param string $function_name + * @param string|int|float $workload + * @param mixed $context [optional] + * @param string|null $unique_key [optional] */ - public function addTaskLowBackground (string $function_name, string $workload, mixed &$context = null, string $unique = null): GearmanTask {} + public function addTaskLowBackground (string $function_name, string|int|float $workload, mixed $context = NULL, ?string $unique_key = NULL): GearmanTask|false {} /** - * Run a list of tasks in parallel - * @link http://www.php.net/manual/en/gearmanclient.runtasks.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ public function runTasks (): bool {} /** - * Add a task to get status - * @link http://www.php.net/manual/en/gearmanclient.addtaskstatus.php - * @param string $job_handle - * @param string $context [optional] - * @return GearmanTask A GearmanTask object. + * {@inheritdoc} + * @param string $job_handle + * @param mixed $context [optional] */ - public function addTaskStatus (string $job_handle, string &$context = null): GearmanTask {} + public function addTaskStatus (string $job_handle, mixed $context = NULL): GearmanTask {} /** - * Set a callback for accepting incremental data updates - * @link http://www.php.net/manual/en/gearmanclient.setworkloadcallback.php - * @param callable $callback - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param callable $function */ - public function setWorkloadCallback (callable $callback): bool {} + public function setWorkloadCallback (callable $function): bool {} /** - * Set a callback for when a task is queued - * @link http://www.php.net/manual/en/gearmanclient.setcreatedcallback.php - * @param string $callback - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param callable $function */ - public function setCreatedCallback (string $callback): bool {} + public function setCreatedCallback (callable $function): bool {} /** - * Callback function when there is a data packet for a task - * @link http://www.php.net/manual/en/gearmanclient.setdatacallback.php - * @param callable $callback - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param callable $function */ - public function setDataCallback (callable $callback): bool {} + public function setDataCallback (callable $function): bool {} /** - * Set a callback for worker warnings - * @link http://www.php.net/manual/en/gearmanclient.setwarningcallback.php - * @param callable $callback - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param callable $function */ - public function setWarningCallback (callable $callback): bool {} + public function setWarningCallback (callable $function): bool {} /** - * Set a callback for collecting task status - * @link http://www.php.net/manual/en/gearmanclient.setstatuscallback.php - * @param callable $callback - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param callable $function */ - public function setStatusCallback (callable $callback): bool {} + public function setStatusCallback (callable $function): bool {} /** - * Set a function to be called on task completion - * @link http://www.php.net/manual/en/gearmanclient.setcompletecallback.php - * @param callable $callback - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param callable $function */ - public function setCompleteCallback (callable $callback): bool {} + public function setCompleteCallback (callable $function): bool {} /** - * Set a callback for worker exceptions - * @link http://www.php.net/manual/en/gearmanclient.setexceptioncallback.php - * @param callable $callback - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param callable $function */ - public function setExceptionCallback (callable $callback): bool {} + public function setExceptionCallback (callable $function): bool {} /** - * Set callback for job failure - * @link http://www.php.net/manual/en/gearmanclient.setfailcallback.php - * @param callable $callback - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param callable $function */ - public function setFailCallback (callable $callback): bool {} + public function setFailCallback (callable $function): bool {} /** - * Clear all task callback functions - * @link http://www.php.net/manual/en/gearmanclient.clearcallbacks.php - * @return bool Always returns true. + * {@inheritdoc} */ public function clearCallbacks (): bool {} /** - * Get the application context - * @link http://www.php.net/manual/en/gearmanclient.context.php - * @return string The same context data structure set with GearmanClient::setContext + * {@inheritdoc} */ public function context (): string {} /** - * Set application context - * @link http://www.php.net/manual/en/gearmanclient.setcontext.php - * @param string $context - * @return bool Always returns true. + * {@inheritdoc} + * @param string $data */ - public function setContext (string $context): bool {} + public function setContext (string $data): bool {} /** * {@inheritdoc} @@ -387,118 +296,83 @@ public function enableExceptionHandler (): bool {} } -/** - * @link http://www.php.net/manual/en/class.gearmantask.php - */ class GearmanTask { /** - * Create a GearmanTask instance - * @link http://www.php.net/manual/en/gearmantask.construct.php - * @return void A GearmanTask object. + * {@inheritdoc} */ - public function __construct (): void {} + public function __construct () {} /** - * Get the last return code - * @link http://www.php.net/manual/en/gearmantask.returncode.php - * @return int A valid Gearman return code. + * {@inheritdoc} */ public function returnCode (): int {} /** - * Get associated function name - * @link http://www.php.net/manual/en/gearmantask.functionname.php - * @return string A function name. + * {@inheritdoc} */ - public function functionName (): string {} + public function functionName (): string|bool {} /** - * Get the unique identifier for a task - * @link http://www.php.net/manual/en/gearmantask.unique.php - * @return string The unique identifier, or false if no identifier is assigned. + * {@inheritdoc} */ - public function unique (): string {} + public function unique (): string|bool {} /** - * Get the job handle - * @link http://www.php.net/manual/en/gearmantask.jobhandle.php - * @return string The opaque job handle. + * {@inheritdoc} */ - public function jobHandle (): string {} + public function jobHandle (): string|bool {} /** - * Determine if task is known - * @link http://www.php.net/manual/en/gearmantask.isknown.php - * @return bool true if the task is known, false otherwise. + * {@inheritdoc} */ public function isKnown (): bool {} /** - * Test whether the task is currently running - * @link http://www.php.net/manual/en/gearmantask.isrunning.php - * @return bool true if the task is running, false otherwise. + * {@inheritdoc} */ public function isRunning (): bool {} /** - * Get completion percentage numerator - * @link http://www.php.net/manual/en/gearmantask.tasknumerator.php - * @return int A number between 0 and 100, or false if cannot be determined. + * {@inheritdoc} */ - public function taskNumerator (): int {} + public function taskNumerator (): int|bool {} /** - * Get completion percentage denominator - * @link http://www.php.net/manual/en/gearmantask.taskdenominator.php - * @return int A number between 0 and 100, or false if cannot be determined. + * {@inheritdoc} */ - public function taskDenominator (): int {} + public function taskDenominator (): int|bool {} /** - * Get data returned for a task - * @link http://www.php.net/manual/en/gearmantask.data.php - * @return string The serialized data, or false if no data is present. + * {@inheritdoc} */ - public function data (): string {} + public function data (): string|bool {} /** - * Get the size of returned data - * @link http://www.php.net/manual/en/gearmantask.datasize.php - * @return int The data size, or false if there is no data. + * {@inheritdoc} */ - public function dataSize (): int {} + public function dataSize (): int|false {} /** - * Send data for a task - * @link http://www.php.net/manual/en/gearmantask.sendworkload.php - * @param string $data - * @return int The length of data sent, or false if the send failed. + * {@inheritdoc} + * @param string $data */ - public function sendWorkload (string $data): int {} + public function sendWorkload (string $data): int|false {} /** - * Read work or result data into a buffer for a task - * @link http://www.php.net/manual/en/gearmantask.recvdata.php - * @param int $data_len - * @return array An array whose first element is the length of data read and the second is the data buffer. - * Returns false if the read failed. + * {@inheritdoc} + * @param int $data_len */ - public function recvData (int $data_len): array {} + public function recvData (int $data_len): array|bool {} } -/** - * @link http://www.php.net/manual/en/class.gearmanworker.php - */ class GearmanWorker { /** - * Create a GearmanWorker instance - * @link http://www.php.net/manual/en/gearmanworker.construct.php - * @return void A GearmanWorker object + * {@inheritdoc} */ - public function __construct (): void {} + public function __construct () {} /** * {@inheritdoc} @@ -506,125 +380,93 @@ public function __construct (): void {} public function __destruct () {} /** - * Get last Gearman return code - * @link http://www.php.net/manual/en/gearmanworker.returncode.php - * @return int A valid Gearman return code. + * {@inheritdoc} */ - public function returnCode (): int {} + public function returnCode (): ?int {} /** - * Get the last error encountered - * @link http://www.php.net/manual/en/gearmanworker.error.php - * @return string An error string. + * {@inheritdoc} */ - public function error (): string {} + public function error (): string|false {} /** - * Get errno - * @link http://www.php.net/manual/en/gearmanworker.geterrno.php - * @return int A valid errno. + * {@inheritdoc} */ - public function getErrno (): int {} + public function getErrno (): int|false {} /** - * Get worker options - * @link http://www.php.net/manual/en/gearmanworker.options.php - * @return int The options currently set for the worker. + * {@inheritdoc} */ - public function options (): int {} + public function options (): ?int {} /** - * Set worker options - * @link http://www.php.net/manual/en/gearmanworker.setoptions.php - * @param int $option - * @return bool Always returns true. + * {@inheritdoc} + * @param int $option */ - public function setOptions (int $option): bool {} + public function setOptions (int $option): ?bool {} /** - * Add worker options - * @link http://www.php.net/manual/en/gearmanworker.addoptions.php - * @param int $option - * @return bool Always returns true. + * {@inheritdoc} + * @param int $option */ - public function addOptions (int $option): bool {} + public function addOptions (int $option): ?bool {} /** - * Remove worker options - * @link http://www.php.net/manual/en/gearmanworker.removeoptions.php - * @param int $option - * @return bool Always returns true. + * {@inheritdoc} + * @param int $option */ - public function removeOptions (int $option): bool {} + public function removeOptions (int $option): ?bool {} /** - * Get socket I/O activity timeout - * @link http://www.php.net/manual/en/gearmanworker.timeout.php - * @return int A time period is milliseconds. A negative value indicates an infinite timeout. + * {@inheritdoc} */ - public function timeout (): int {} + public function timeout (): ?int {} /** - * Set socket I/O activity timeout - * @link http://www.php.net/manual/en/gearmanworker.settimeout.php - * @param int $timeout - * @return bool Always returns true. + * {@inheritdoc} + * @param int $timeout */ public function setTimeout (int $timeout): bool {} /** - * Give the worker an identifier so it can be tracked when asking gearmand for the list of available workers - * @link http://www.php.net/manual/en/gearmanworker.setid.php - * @param string $id A string identifier. - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $id */ public function setId (string $id): bool {} /** - * Add a job server - * @link http://www.php.net/manual/en/gearmanworker.addserver.php - * @param string $host [optional] - * @param int $port [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $host [optional] + * @param int $port [optional] */ - public function addServer (string $host = '127.0.0.1', int $port = 4730): bool {} + public function addServer (string $host = NULL, int $port = 0): bool {} /** - * Add job servers - * @link http://www.php.net/manual/en/gearmanworker.addservers.php - * @param string $servers - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $servers [optional] */ - public function addServers (string $servers): bool {} + public function addServers (string $servers = NULL): bool {} /** - * Wait for activity from one of the job servers - * @link http://www.php.net/manual/en/gearmanworker.wait.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ public function wait (): bool {} /** - * Register a function with the job server - * @link http://www.php.net/manual/en/gearmanworker.register.php - * @param string $function_name - * @param int $timeout [optional] - * @return bool A standard Gearman return value. + * {@inheritdoc} + * @param string $function_name + * @param int $timeout [optional] */ - public function register (string $function_name, int $timeout = null): bool {} + public function register (string $function_name, int $timeout = 0): bool {} /** - * Unregister a function name with the job servers - * @link http://www.php.net/manual/en/gearmanworker.unregister.php - * @param string $function_name - * @return bool A standard Gearman return value. + * {@inheritdoc} + * @param string $function_name */ public function unregister (string $function_name): bool {} /** - * Unregister all function names with the job servers - * @link http://www.php.net/manual/en/gearmanworker.unregisterall.php - * @return bool A standard Gearman return value. + * {@inheritdoc} */ public function unregisterAll (): bool {} @@ -634,20 +476,16 @@ public function unregisterAll (): bool {} public function grabJob (): GearmanWorker|false {} /** - * Register and add callback function - * @link http://www.php.net/manual/en/gearmanworker.addfunction.php - * @param string $function_name - * @param callable $function - * @param mixed $context [optional] - * @param int $timeout [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $function_name + * @param callable $function + * @param mixed $context [optional] + * @param int $timeout [optional] */ - public function addFunction (string $function_name, callable $function, mixed &$context = null, int $timeout = null): bool {} + public function addFunction (string $function_name, callable $function, mixed $context = NULL, int $timeout = 0): bool {} /** - * Wait for and perform jobs - * @link http://www.php.net/manual/en/gearmanworker.work.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ public function work (): bool {} @@ -659,9 +497,6 @@ public function ping (string $data): bool {} } -/** - * @link http://www.php.net/manual/en/class.gearmanjob.php - */ class GearmanJob { /** @@ -670,126 +505,90 @@ class GearmanJob { public function __destruct () {} /** - * Get last return code - * @link http://www.php.net/manual/en/gearmanjob.returncode.php - * @return int A valid Gearman return code. + * {@inheritdoc} */ - public function returnCode (): int {} + public function returnCode (): ?int {} /** - * Set a return value - * @link http://www.php.net/manual/en/gearmanjob.setreturn.php - * @param int $gearman_return_t - * @return bool Description... + * {@inheritdoc} + * @param int $gearman_return_t */ - public function setReturn (int $gearman_return_t): bool {} + public function setReturn (int $gearman_return_t): ?bool {} /** - * Send data for a running job - * @link http://www.php.net/manual/en/gearmanjob.senddata.php - * @param string $data - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $data */ - public function sendData (string $data): bool {} + public function sendData (string $data): ?bool {} /** - * Send a warning - * @link http://www.php.net/manual/en/gearmanjob.sendwarning.php - * @param string $warning - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $warning */ public function sendWarning (string $warning): bool {} /** - * Send status - * @link http://www.php.net/manual/en/gearmanjob.sendstatus.php - * @param int $numerator - * @param int $denominator - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $numerator + * @param int $denominator */ public function sendStatus (int $numerator, int $denominator): bool {} /** - * Send the result and complete status - * @link http://www.php.net/manual/en/gearmanjob.sendcomplete.php - * @param string $result - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $result */ public function sendComplete (string $result): bool {} /** - * Send exception for running job (exception) - * @link http://www.php.net/manual/en/gearmanjob.sendexception.php - * @param string $exception - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $exception */ public function sendException (string $exception): bool {} /** - * Send fail status - * @link http://www.php.net/manual/en/gearmanjob.sendfail.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ public function sendFail (): bool {} /** - * Get the job handle - * @link http://www.php.net/manual/en/gearmanjob.handle.php - * @return string An opaque job handle. + * {@inheritdoc} */ - public function handle (): string {} + public function handle (): string|bool {} /** - * Get function name - * @link http://www.php.net/manual/en/gearmanjob.functionname.php - * @return string The name of a function. + * {@inheritdoc} */ - public function functionName (): string {} + public function functionName (): string|bool {} /** - * Get the unique identifier - * @link http://www.php.net/manual/en/gearmanjob.unique.php - * @return string An opaque unique identifier. + * {@inheritdoc} */ - public function unique (): string {} + public function unique (): string|bool {} /** - * Get workload - * @link http://www.php.net/manual/en/gearmanjob.workload.php - * @return string Serialized data. + * {@inheritdoc} */ public function workload (): string {} /** - * Get size of work load - * @link http://www.php.net/manual/en/gearmanjob.workloadsize.php - * @return int The size in bytes. + * {@inheritdoc} */ - public function workloadSize (): int {} + public function workloadSize (): ?int {} } -/** - * @link http://www.php.net/manual/en/class.gearmanexception.php - */ final class GearmanException extends Exception implements Throwable, Stringable { - /** - * The exception code - * @var int - * @link http://www.php.net/manual/en/class.gearmanexception.php#gearmanexception.props.code - */ - protected int $code; + public $code; /** - * Construct the exception - * @link http://www.php.net/manual/en/exception.construct.php - * @param string $message [optional] - * @param int $code [optional] - * @param Throwable|null $previous [optional] - * @return string + * {@inheritdoc} + * @param string $message [optional] + * @param int $code [optional] + * @param Throwable|null $previous [optional] */ - public function __construct (string $message = '""', int $code = null, ?Throwable $previous = null): string {} + public function __construct (string $message = '', int $code = 0, ?Throwable $previous = NULL) {} /** * {@inheritdoc} @@ -797,62 +596,42 @@ public function __construct (string $message = '""', int $code = null, ?Throwabl public function __wakeup () {} /** - * Gets the Exception message - * @link http://www.php.net/manual/en/exception.getmessage.php - * @return string Returns the Exception message as a string. + * {@inheritdoc} */ final public function getMessage (): string {} /** - * Gets the Exception code - * @link http://www.php.net/manual/en/exception.getcode.php - * @return int Returns the exception code as int in - * Exception but possibly as other type in - * Exception descendants (for example as - * string in PDOException). + * {@inheritdoc} */ - final public function getCode (): int {} + final public function getCode () {} /** - * Gets the file in which the exception was created - * @link http://www.php.net/manual/en/exception.getfile.php - * @return string Returns the filename in which the exception was created. + * {@inheritdoc} */ final public function getFile (): string {} /** - * Gets the line in which the exception was created - * @link http://www.php.net/manual/en/exception.getline.php - * @return int Returns the line number where the exception was created. + * {@inheritdoc} */ final public function getLine (): int {} /** - * Gets the stack trace - * @link http://www.php.net/manual/en/exception.gettrace.php - * @return array Returns the Exception stack trace as an array. + * {@inheritdoc} */ final public function getTrace (): array {} /** - * Returns previous Throwable - * @link http://www.php.net/manual/en/exception.getprevious.php - * @return Throwable|null Returns the previous Throwable if available - * or null otherwise. + * {@inheritdoc} */ final public function getPrevious (): ?Throwable {} /** - * Gets the stack trace as a string - * @link http://www.php.net/manual/en/exception.gettraceasstring.php - * @return string Returns the Exception stack trace as a string. + * {@inheritdoc} */ final public function getTraceAsString (): string {} /** - * String representation of the exception - * @link http://www.php.net/manual/en/exception.tostring.php - * @return string Returns the string representation of the exception. + * {@inheritdoc} */ public function __toString (): string {} @@ -1263,12 +1042,10 @@ function gearman_job_send_exception (GearmanJob $obj, string $exception): bool { function gearman_job_send_fail (GearmanJob $obj): bool {} /** - * Get the job handle - * @link http://www.php.net/manual/en/gearmantask.jobhandle.php + * {@inheritdoc} * @param GearmanJob $obj - * @return string The opaque job handle. */ -function gearman_job_handle (GearmanJob $obj): string {} +function gearman_job_handle (GearmanJob $obj): string|bool {} /** * {@inheritdoc} @@ -1504,338 +1281,67 @@ function gearman_worker_work (GearmanWorker $obj): bool {} */ function gearman_worker_ping (GearmanWorker $obj, string $data): bool {} - -/** - * - * @link http://www.php.net/manual/en/gearman.constants.php - * @var string - */ define ('GEARMAN_DEFAULT_TCP_HOST', "localhost"); - -/** - * - * @link http://www.php.net/manual/en/gearman.constants.php - * @var int - */ define ('GEARMAN_DEFAULT_TCP_PORT', 4730); - -/** - * - * @link http://www.php.net/manual/en/gearman.constants.php - * @var int - */ define ('GEARMAN_DEFAULT_SOCKET_TIMEOUT', 10); - -/** - * - * @link http://www.php.net/manual/en/gearman.constants.php - * @var int - */ define ('GEARMAN_DEFAULT_SOCKET_SEND_SIZE', 32768); - -/** - * - * @link http://www.php.net/manual/en/gearman.constants.php - * @var int - */ define ('GEARMAN_DEFAULT_SOCKET_RECV_SIZE', 32768); - -/** - * - * @link http://www.php.net/manual/en/gearman.constants.php - * @var int - */ define ('GEARMAN_MAX_ERROR_SIZE', 2048); - -/** - * - * @link http://www.php.net/manual/en/gearman.constants.php - * @var int - */ define ('GEARMAN_PACKET_HEADER_SIZE', 12); - -/** - * - * @link http://www.php.net/manual/en/gearman.constants.php - * @var int - */ define ('GEARMAN_JOB_HANDLE_SIZE', 64); - -/** - * - * @link http://www.php.net/manual/en/gearman.constants.php - * @var int - */ define ('GEARMAN_OPTION_SIZE', 64); - -/** - * - * @link http://www.php.net/manual/en/gearman.constants.php - * @var int - */ define ('GEARMAN_UNIQUE_SIZE', 64); - -/** - * - * @link http://www.php.net/manual/en/gearman.constants.php - * @var int - */ define ('GEARMAN_MAX_COMMAND_ARGS', 8); - -/** - * - * @link http://www.php.net/manual/en/gearman.constants.php - * @var int - */ define ('GEARMAN_ARGS_BUFFER_SIZE', 128); - -/** - * - * @link http://www.php.net/manual/en/gearman.constants.php - * @var int - */ define ('GEARMAN_SEND_BUFFER_SIZE', 8192); - -/** - * - * @link http://www.php.net/manual/en/gearman.constants.php - * @var int - */ define ('GEARMAN_RECV_BUFFER_SIZE', 8192); - -/** - * - * @link http://www.php.net/manual/en/gearman.constants.php - * @var int - */ define ('GEARMAN_WORKER_WAIT_TIMEOUT', 10000); - -/** - * Whatever action was taken was successful. - * @link http://www.php.net/manual/en/gearman.constants.php - * @var int - */ define ('GEARMAN_SUCCESS', 0); - -/** - * When in non-blocking mode, an event is hit that would have blocked. - * @link http://www.php.net/manual/en/gearman.constants.php - * @var int - */ define ('GEARMAN_IO_WAIT', 1); define ('GEARMAN_SHUTDOWN', 2); define ('GEARMAN_SHUTDOWN_GRACEFUL', 3); - -/** - * A system error. Check GearmanClient::errno or - * GearmanWorker::errno for the system error code that - * was returned. - * @link http://www.php.net/manual/en/gearman.constants.php - * @var int - */ define ('GEARMAN_ERRNO', 4); define ('GEARMAN_EVENT', 5); define ('GEARMAN_TOO_MANY_ARGS', 6); - -/** - * GearmanClient::wait or GearmanWorker was - * called with no connections. - * @link http://www.php.net/manual/en/gearman.constants.php - * @var int - */ define ('GEARMAN_NO_ACTIVE_FDS', 7); define ('GEARMAN_INVALID_MAGIC', 8); define ('GEARMAN_INVALID_COMMAND', 9); define ('GEARMAN_INVALID_PACKET', 10); - -/** - * Indicates something going very wrong in gearmand. Applies only to - * GearmanWorker. - * @link http://www.php.net/manual/en/gearman.constants.php - * @var int - */ define ('GEARMAN_UNEXPECTED_PACKET', 11); - -/** - * DNS resolution failed (invalid host, port, etc). - * @link http://www.php.net/manual/en/gearman.constants.php - * @var int - */ define ('GEARMAN_GETADDRINFO', 12); - -/** - * Did not call GearmanClient::addServer before submitting jobs - * or tasks. - * @link http://www.php.net/manual/en/gearman.constants.php - * @var int - */ define ('GEARMAN_NO_SERVERS', 13); - -/** - * Lost a connection during a request. - * @link http://www.php.net/manual/en/gearman.constants.php - * @var int - */ define ('GEARMAN_LOST_CONNECTION', 14); - -/** - * Memory allocation failed (ran out of memory). - * @link http://www.php.net/manual/en/gearman.constants.php - * @var int - */ define ('GEARMAN_MEMORY_ALLOCATION_FAILURE', 15); define ('GEARMAN_JOB_EXISTS', 16); define ('GEARMAN_JOB_QUEUE_FULL', 17); - -/** - * Something went wrong in the Gearman server and it could not handle the - * request gracefully. - * @link http://www.php.net/manual/en/gearman.constants.php - * @var int - */ define ('GEARMAN_SERVER_ERROR', 18); define ('GEARMAN_WORK_ERROR', 19); - -/** - * Notice return code obtained with GearmanClient::returnCode - * when using GearmanClient::do. Sent to update the client - * with data from a running job. A worker uses this when it needs to send updates, - * send partial results, or flush data during long running jobs. - * @link http://www.php.net/manual/en/gearman.constants.php - * @var int - */ define ('GEARMAN_WORK_DATA', 20); - -/** - * Notice return code obtained with GearmanClient::returnCode - * when using GearmanClient::do. Updates the client with - * a warning. The behavior is just like GEARMAN_WORK_DATA, but - * should be treated as a warning instead of normal response data. - * @link http://www.php.net/manual/en/gearman.constants.php - * @var int - */ define ('GEARMAN_WORK_WARNING', 21); - -/** - * Notice return code obtained with GearmanClient::returnCode - * when using GearmanClient::do. Sent to update the status - * of a long running job. Use GearmanClient::doStatus to obtain - * the percentage complete of the task. - * @link http://www.php.net/manual/en/gearman.constants.php - * @var int - */ define ('GEARMAN_WORK_STATUS', 22); - -/** - * Notice return code obtained with GearmanClient::returnCode - * when using GearmanClient::do. Indicates that a job failed - * with a given exception. - * @link http://www.php.net/manual/en/gearman.constants.php - * @var int - */ define ('GEARMAN_WORK_EXCEPTION', 23); - -/** - * Notice return code obtained with GearmanClient::returnCode - * when using GearmanClient::do. Indicates that the job failed. - * @link http://www.php.net/manual/en/gearman.constants.php - * @var int - */ define ('GEARMAN_WORK_FAIL', 24); define ('GEARMAN_NOT_CONNECTED', 25); - -/** - * Failed to connect to servers. - * @link http://www.php.net/manual/en/gearman.constants.php - * @var int - */ define ('GEARMAN_COULD_NOT_CONNECT', 26); define ('GEARMAN_SEND_IN_PROGRESS', 27); define ('GEARMAN_RECV_IN_PROGRESS', 28); define ('GEARMAN_NOT_FLUSHING', 29); define ('GEARMAN_DATA_TOO_LARGE', 30); - -/** - * Trying to register a function name of NULL or using the callback interface - * without specifying callbacks. - * @link http://www.php.net/manual/en/gearman.constants.php - * @var int - */ define ('GEARMAN_INVALID_FUNCTION_NAME', 31); - -/** - * Trying to register a function with a NULL callback function. - * @link http://www.php.net/manual/en/gearman.constants.php - * @var int - */ define ('GEARMAN_INVALID_WORKER_FUNCTION', 32); - -/** - * When a worker gets a job for a function it did not register. - * @link http://www.php.net/manual/en/gearman.constants.php - * @var int - */ define ('GEARMAN_NO_REGISTERED_FUNCTIONS', 34); - -/** - * For a non-blocking worker, when GearmanWorker::work does not have - * any active jobs. - * @link http://www.php.net/manual/en/gearman.constants.php - * @var int - */ define ('GEARMAN_NO_JOBS', 35); - -/** - * After GearmanClient::echo or GearmanWorker::echo - * the data returned doesn't match the data sent. - * @link http://www.php.net/manual/en/gearman.constants.php - * @var int - */ define ('GEARMAN_ECHO_DATA_CORRUPTION', 36); - -/** - * When the client opted to stream the workload of a task, but did not - * specify a workload callback function. - * @link http://www.php.net/manual/en/gearman.constants.php - * @var int - */ define ('GEARMAN_NEED_WORKLOAD_FN', 37); - -/** - * For the non-blocking client task interface, can be returned from the task callback - * to "pause" the call and return from GearmanClient::runTasks. - * Call GearmanClient::runTasks again to continue. - * @link http://www.php.net/manual/en/gearman.constants.php - * @var int - */ define ('GEARMAN_PAUSE', 38); - -/** - * Internal client/worker state error. - * @link http://www.php.net/manual/en/gearman.constants.php - * @var int - */ define ('GEARMAN_UNKNOWN_STATE', 39); define ('GEARMAN_PTHREAD', 40); define ('GEARMAN_PIPE_EOF', 41); define ('GEARMAN_QUEUE_ERROR', 42); define ('GEARMAN_FLUSH_DATA', 43); - -/** - * Internal error: trying to flush more data in one atomic chunk than is possible - * due to hard-coded buffer sizes. - * @link http://www.php.net/manual/en/gearman.constants.php - * @var int - */ define ('GEARMAN_SEND_BUFFER_TOO_SMALL', 44); define ('GEARMAN_IGNORE_PACKET', 45); define ('GEARMAN_UNKNOWN_OPTION', 46); - -/** - * Hit the timeout limit set by the client/worker. - * @link http://www.php.net/manual/en/gearman.constants.php - * @var int - */ define ('GEARMAN_TIMEOUT', 47); define ('GEARMAN_MAX_RETURN', 53); define ('GEARMAN_VERBOSE_FATAL', 1); @@ -1908,54 +1414,22 @@ function gearman_worker_ping (GearmanWorker $obj, string $data): bool {} define ('GEARMAN_JOB_PRIORITY_LOW', 2); define ('GEARMAN_JOB_PRIORITY_MAX', 3); define ('GEARMAN_CLIENT_ALLOCATED', 1); - -/** - * Run the cient in a non-blocking mode. - * @link http://www.php.net/manual/en/gearman.constants.php - * @var int - */ define ('GEARMAN_CLIENT_NON_BLOCKING', 2); define ('GEARMAN_CLIENT_TASK_IN_USE', 4); - -/** - * Allow the client to read data in chunks rather than have the library - * buffer the entire data result and pass that back. - * @link http://www.php.net/manual/en/gearman.constants.php - * @var int - */ define ('GEARMAN_CLIENT_UNBUFFERED_RESULT', 8); define ('GEARMAN_CLIENT_NO_NEW', 16); - -/** - * Automatically free task objects once they are complete. This is the default - * setting in this extension to prevent memory leaks. - * @link http://www.php.net/manual/en/gearman.constants.php - * @var int - */ define ('GEARMAN_CLIENT_FREE_TASKS', 32); define ('GEARMAN_CLIENT_STATE_IDLE', 0); define ('GEARMAN_CLIENT_STATE_NEW', 1); define ('GEARMAN_CLIENT_STATE_SUBMIT', 2); define ('GEARMAN_CLIENT_STATE_PACKET', 3); define ('GEARMAN_WORKER_ALLOCATED', 1); - -/** - * Run the worker in non-blocking mode. - * @link http://www.php.net/manual/en/gearman.constants.php - * @var int - */ define ('GEARMAN_WORKER_NON_BLOCKING', 2); define ('GEARMAN_WORKER_PACKET_INIT', 4); define ('GEARMAN_WORKER_GRAB_JOB_IN_USE', 8); define ('GEARMAN_WORKER_PRE_SLEEP_IN_USE', 16); define ('GEARMAN_WORKER_WORK_JOB_IN_USE', 32); define ('GEARMAN_WORKER_CHANGE', 64); - -/** - * Return the client assigned unique ID in addition to the job handle. - * @link http://www.php.net/manual/en/gearman.constants.php - * @var int - */ define ('GEARMAN_WORKER_GRAB_UNIQ', 128); define ('GEARMAN_WORKER_TIMEOUT_RETURN', 256); define ('GEARMAN_WORKER_STATE_START', 0); diff --git a/plugins/org.eclipse.php.core/Resources/language/php8.3/gettext.php b/plugins/org.eclipse.php.core/Resources/language/php8.3/gettext.php index a5f61b3455..67f58968e3 100644 --- a/plugins/org.eclipse.php.core/Resources/language/php8.3/gettext.php +++ b/plugins/org.eclipse.php.core/Resources/language/php8.3/gettext.php @@ -1,22 +1,16 @@ No object-oriented interface is provided to manipulate - * GMP objects. Please use the - * procedural GMP API. - * @link http://www.php.net/manual/en/class.gmp.php - */ class GMP { /** @@ -22,560 +12,377 @@ class GMP { public function __construct (string|int $num = 0, int $base = 0) {} /** - * Serializes the GMP object - * @link http://www.php.net/manual/en/gmp.serialize.php - * @return array No value is returned. + * {@inheritdoc} */ public function __serialize (): array {} /** - * Deserializes the data parameter into a GMP object - * @link http://www.php.net/manual/en/gmp.unserialize.php - * @param array $data The value being deserialized. - * @return void No value is returned. + * {@inheritdoc} + * @param array $data */ public function __unserialize (array $data): void {} } /** - * Create GMP number - * @link http://www.php.net/manual/en/function.gmp-init.php - * @param int|string $num - * @param int $base [optional] - * @return GMP A GMP object. + * {@inheritdoc} + * @param string|int $num + * @param int $base [optional] */ -function gmp_init (int|string $num, int $base = null): GMP {} +function gmp_init (string|int $num, int $base = 0): GMP {} /** - * Import from a binary string - * @link http://www.php.net/manual/en/function.gmp-import.php - * @param string $data - * @param int $word_size [optional] - * @param int $flags [optional] - * @return GMP Returns a GMP number. + * {@inheritdoc} + * @param string $data + * @param int $word_size [optional] + * @param int $flags [optional] */ -function gmp_import (string $data, int $word_size = 1, int $flags = 'GMP_MSW_FIRST | GMP_NATIVE_ENDIAN'): GMP {} +function gmp_import (string $data, int $word_size = 1, int $flags = 17): GMP {} /** - * Export to a binary string - * @link http://www.php.net/manual/en/function.gmp-export.php - * @param GMP|int|string $num - * @param int $word_size [optional] - * @param int $flags [optional] - * @return string Returns a string. + * {@inheritdoc} + * @param GMP|string|int $num + * @param int $word_size [optional] + * @param int $flags [optional] */ -function gmp_export (GMP|int|string $num, int $word_size = 1, int $flags = 'GMP_MSW_FIRST | GMP_NATIVE_ENDIAN'): string {} +function gmp_export (GMP|string|int $num, int $word_size = 1, int $flags = 17): string {} /** - * Convert GMP number to integer - * @link http://www.php.net/manual/en/function.gmp-intval.php - * @param GMP|int|string $num - * @return int The int value of num. + * {@inheritdoc} + * @param GMP|string|int $num */ -function gmp_intval (GMP|int|string $num): int {} +function gmp_intval (GMP|string|int $num): int {} /** - * Convert GMP number to string - * @link http://www.php.net/manual/en/function.gmp-strval.php - * @param GMP|int|string $num - * @param int $base [optional] - * @return string The number, as a string. + * {@inheritdoc} + * @param GMP|string|int $num + * @param int $base [optional] */ -function gmp_strval (GMP|int|string $num, int $base = 10): string {} +function gmp_strval (GMP|string|int $num, int $base = 10): string {} /** - * Add numbers - * @link http://www.php.net/manual/en/function.gmp-add.php - * @param GMP|int|string $num1 - * @param GMP|int|string $num2 - * @return GMP A GMP number representing the sum of the arguments. + * {@inheritdoc} + * @param GMP|string|int $num1 + * @param GMP|string|int $num2 */ -function gmp_add (GMP|int|string $num1, GMP|int|string $num2): GMP {} +function gmp_add (GMP|string|int $num1, GMP|string|int $num2): GMP {} /** - * Subtract numbers - * @link http://www.php.net/manual/en/function.gmp-sub.php - * @param GMP|int|string $num1 - * @param GMP|int|string $num2 - * @return GMP A GMP object. + * {@inheritdoc} + * @param GMP|string|int $num1 + * @param GMP|string|int $num2 */ -function gmp_sub (GMP|int|string $num1, GMP|int|string $num2): GMP {} +function gmp_sub (GMP|string|int $num1, GMP|string|int $num2): GMP {} /** - * Multiply numbers - * @link http://www.php.net/manual/en/function.gmp-mul.php - * @param GMP|int|string $num1 - * @param GMP|int|string $num2 - * @return GMP A GMP object. + * {@inheritdoc} + * @param GMP|string|int $num1 + * @param GMP|string|int $num2 */ -function gmp_mul (GMP|int|string $num1, GMP|int|string $num2): GMP {} +function gmp_mul (GMP|string|int $num1, GMP|string|int $num2): GMP {} /** - * Divide numbers and get quotient and remainder - * @link http://www.php.net/manual/en/function.gmp-div-qr.php - * @param GMP|int|string $num1 - * @param GMP|int|string $num2 - * @param int $rounding_mode [optional] - * @return array Returns an array, with the first - * element being [n/d] (the integer result of the - * division) and the second being (n - [n/d] * d) - * (the remainder of the division). + * {@inheritdoc} + * @param GMP|string|int $num1 + * @param GMP|string|int $num2 + * @param int $rounding_mode [optional] */ -function gmp_div_qr (GMP|int|string $num1, GMP|int|string $num2, int $rounding_mode = GMP_ROUND_ZERO): array {} +function gmp_div_qr (GMP|string|int $num1, GMP|string|int $num2, int $rounding_mode = 0): array {} /** - * Divide numbers - * @link http://www.php.net/manual/en/function.gmp-div-q.php - * @param GMP|int|string $num1 - * @param GMP|int|string $num2 - * @param int $rounding_mode [optional] - * @return GMP A GMP object. + * {@inheritdoc} + * @param GMP|string|int $num1 + * @param GMP|string|int $num2 + * @param int $rounding_mode [optional] */ -function gmp_div_q (GMP|int|string $num1, GMP|int|string $num2, int $rounding_mode = GMP_ROUND_ZERO): GMP {} +function gmp_div_q (GMP|string|int $num1, GMP|string|int $num2, int $rounding_mode = 0): GMP {} /** - * Remainder of the division of numbers - * @link http://www.php.net/manual/en/function.gmp-div-r.php - * @param GMP|int|string $num1 - * @param GMP|int|string $num2 - * @param int $rounding_mode [optional] - * @return GMP The remainder, as a GMP number. + * {@inheritdoc} + * @param GMP|string|int $num1 + * @param GMP|string|int $num2 + * @param int $rounding_mode [optional] */ -function gmp_div_r (GMP|int|string $num1, GMP|int|string $num2, int $rounding_mode = GMP_ROUND_ZERO): GMP {} +function gmp_div_r (GMP|string|int $num1, GMP|string|int $num2, int $rounding_mode = 0): GMP {} /** - * Alias of gmp_div_q - * @link http://www.php.net/manual/en/function.gmp-div.php - * @param GMP|int|string $num1 - * @param GMP|int|string $num2 - * @param int $rounding_mode [optional] - * @return GMP A GMP object. + * {@inheritdoc} + * @param GMP|string|int $num1 + * @param GMP|string|int $num2 + * @param int $rounding_mode [optional] */ -function gmp_div (GMP|int|string $num1, GMP|int|string $num2, int $rounding_mode = GMP_ROUND_ZERO): GMP {} +function gmp_div (GMP|string|int $num1, GMP|string|int $num2, int $rounding_mode = 0): GMP {} /** - * Modulo operation - * @link http://www.php.net/manual/en/function.gmp-mod.php - * @param GMP|int|string $num1 - * @param GMP|int|string $num2 - * @return GMP A GMP object. + * {@inheritdoc} + * @param GMP|string|int $num1 + * @param GMP|string|int $num2 */ -function gmp_mod (GMP|int|string $num1, GMP|int|string $num2): GMP {} +function gmp_mod (GMP|string|int $num1, GMP|string|int $num2): GMP {} /** - * Exact division of numbers - * @link http://www.php.net/manual/en/function.gmp-divexact.php - * @param GMP|int|string $num1 - * @param GMP|int|string $num2 - * @return GMP A GMP object. + * {@inheritdoc} + * @param GMP|string|int $num1 + * @param GMP|string|int $num2 */ -function gmp_divexact (GMP|int|string $num1, GMP|int|string $num2): GMP {} +function gmp_divexact (GMP|string|int $num1, GMP|string|int $num2): GMP {} /** - * Negate number - * @link http://www.php.net/manual/en/function.gmp-neg.php - * @param GMP|int|string $num - * @return GMP Returns -num, as a GMP number. + * {@inheritdoc} + * @param GMP|string|int $num */ -function gmp_neg (GMP|int|string $num): GMP {} +function gmp_neg (GMP|string|int $num): GMP {} /** - * Absolute value - * @link http://www.php.net/manual/en/function.gmp-abs.php - * @param GMP|int|string $num - * @return GMP Returns the absolute value of num, as a GMP number. + * {@inheritdoc} + * @param GMP|string|int $num */ -function gmp_abs (GMP|int|string $num): GMP {} +function gmp_abs (GMP|string|int $num): GMP {} /** - * Factorial - * @link http://www.php.net/manual/en/function.gmp-fact.php - * @param GMP|int|string $num - * @return GMP A GMP object. + * {@inheritdoc} + * @param GMP|string|int $num */ -function gmp_fact (GMP|int|string $num): GMP {} +function gmp_fact (GMP|string|int $num): GMP {} /** - * Calculate square root - * @link http://www.php.net/manual/en/function.gmp-sqrt.php - * @param GMP|int|string $num - * @return GMP The integer portion of the square root, as a GMP number. + * {@inheritdoc} + * @param GMP|string|int $num */ -function gmp_sqrt (GMP|int|string $num): GMP {} +function gmp_sqrt (GMP|string|int $num): GMP {} /** - * Square root with remainder - * @link http://www.php.net/manual/en/function.gmp-sqrtrem.php - * @param GMP|int|string $num - * @return array Returns array where first element is the integer square root of - * num and the second is the remainder - * (i.e., the difference between num and the - * first element squared). + * {@inheritdoc} + * @param GMP|string|int $num */ -function gmp_sqrtrem (GMP|int|string $num): array {} +function gmp_sqrtrem (GMP|string|int $num): array {} /** - * Take the integer part of nth root - * @link http://www.php.net/manual/en/function.gmp-root.php - * @param GMP|int|string $num - * @param int $nth - * @return GMP The integer component of the resultant root, as a GMP number. + * {@inheritdoc} + * @param GMP|string|int $num + * @param int $nth */ -function gmp_root (GMP|int|string $num, int $nth): GMP {} +function gmp_root (GMP|string|int $num, int $nth): GMP {} /** - * Take the integer part and remainder of nth root - * @link http://www.php.net/manual/en/function.gmp-rootrem.php - * @param GMP|int|string $num - * @param int $nth - * @return array A two element array, where the first element is the integer component of - * the root, and the second element is the remainder, both represented as GMP - * numbers. + * {@inheritdoc} + * @param GMP|string|int $num + * @param int $nth */ -function gmp_rootrem (GMP|int|string $num, int $nth): array {} +function gmp_rootrem (GMP|string|int $num, int $nth): array {} /** - * Raise number into power - * @link http://www.php.net/manual/en/function.gmp-pow.php - * @param GMP|int|string $num - * @param int $exponent - * @return GMP The new (raised) number, as a GMP number. The case of - * 0^0 yields 1. + * {@inheritdoc} + * @param GMP|string|int $num + * @param int $exponent */ -function gmp_pow (GMP|int|string $num, int $exponent): GMP {} +function gmp_pow (GMP|string|int $num, int $exponent): GMP {} /** - * Raise number into power with modulo - * @link http://www.php.net/manual/en/function.gmp-powm.php - * @param GMP|int|string $num - * @param GMP|int|string $exponent - * @param GMP|int|string $modulus - * @return GMP The new (raised) number, as a GMP number. + * {@inheritdoc} + * @param GMP|string|int $num + * @param GMP|string|int $exponent + * @param GMP|string|int $modulus */ -function gmp_powm (GMP|int|string $num, GMP|int|string $exponent, GMP|int|string $modulus): GMP {} +function gmp_powm (GMP|string|int $num, GMP|string|int $exponent, GMP|string|int $modulus): GMP {} /** - * Perfect square check - * @link http://www.php.net/manual/en/function.gmp-perfect-square.php - * @param GMP|int|string $num - * @return bool Returns true if num is a perfect square, - * false otherwise. + * {@inheritdoc} + * @param GMP|string|int $num */ -function gmp_perfect_square (GMP|int|string $num): bool {} +function gmp_perfect_square (GMP|string|int $num): bool {} /** - * Perfect power check - * @link http://www.php.net/manual/en/function.gmp-perfect-power.php - * @param GMP|int|string $num >A GMP object, an int or a numeric string. - * @return bool Returns true if num is a perfect power, false otherwise. + * {@inheritdoc} + * @param GMP|string|int $num */ -function gmp_perfect_power (GMP|int|string $num): bool {} +function gmp_perfect_power (GMP|string|int $num): bool {} /** - * Check if number is "probably prime" - * @link http://www.php.net/manual/en/function.gmp-prob-prime.php - * @param GMP|int|string $num - * @param int $repetitions [optional] - * @return int If this function returns 0, num is - * definitely not prime. If it returns 1, then - * num is "probably" prime. If it returns 2, - * then num is surely prime. + * {@inheritdoc} + * @param GMP|string|int $num + * @param int $repetitions [optional] */ -function gmp_prob_prime (GMP|int|string $num, int $repetitions = 10): int {} +function gmp_prob_prime (GMP|string|int $num, int $repetitions = 10): int {} /** - * Calculate GCD - * @link http://www.php.net/manual/en/function.gmp-gcd.php - * @param GMP|int|string $num1 - * @param GMP|int|string $num2 - * @return GMP A positive GMP number that divides into both - * num1 and num2. + * {@inheritdoc} + * @param GMP|string|int $num1 + * @param GMP|string|int $num2 */ -function gmp_gcd (GMP|int|string $num1, GMP|int|string $num2): GMP {} +function gmp_gcd (GMP|string|int $num1, GMP|string|int $num2): GMP {} /** - * Calculate GCD and multipliers - * @link http://www.php.net/manual/en/function.gmp-gcdext.php - * @param GMP|int|string $num1 - * @param GMP|int|string $num2 - * @return array An array of GMP numbers. + * {@inheritdoc} + * @param GMP|string|int $num1 + * @param GMP|string|int $num2 */ -function gmp_gcdext (GMP|int|string $num1, GMP|int|string $num2): array {} +function gmp_gcdext (GMP|string|int $num1, GMP|string|int $num2): array {} /** - * Calculate LCM - * @link http://www.php.net/manual/en/function.gmp-lcm.php - * @param GMP|int|string $num1 >A GMP object, an int or a numeric string. - * @param GMP|int|string $num2 >A GMP object, an int or a numeric string. - * @return GMP A GMP object. + * {@inheritdoc} + * @param GMP|string|int $num1 + * @param GMP|string|int $num2 */ -function gmp_lcm (GMP|int|string $num1, GMP|int|string $num2): GMP {} +function gmp_lcm (GMP|string|int $num1, GMP|string|int $num2): GMP {} /** - * Inverse by modulo - * @link http://www.php.net/manual/en/function.gmp-invert.php - * @param GMP|int|string $num1 - * @param GMP|int|string $num2 - * @return GMP|false A GMP number on success or false if an inverse does not exist. + * {@inheritdoc} + * @param GMP|string|int $num1 + * @param GMP|string|int $num2 */ -function gmp_invert (GMP|int|string $num1, GMP|int|string $num2): GMP|false {} +function gmp_invert (GMP|string|int $num1, GMP|string|int $num2): GMP|false {} /** - * Jacobi symbol - * @link http://www.php.net/manual/en/function.gmp-jacobi.php - * @param GMP|int|string $num1 - * @param GMP|int|string $num2 - * @return int A GMP object. + * {@inheritdoc} + * @param GMP|string|int $num1 + * @param GMP|string|int $num2 */ -function gmp_jacobi (GMP|int|string $num1, GMP|int|string $num2): int {} +function gmp_jacobi (GMP|string|int $num1, GMP|string|int $num2): int {} /** - * Legendre symbol - * @link http://www.php.net/manual/en/function.gmp-legendre.php - * @param GMP|int|string $num1 - * @param GMP|int|string $num2 - * @return int A GMP object. + * {@inheritdoc} + * @param GMP|string|int $num1 + * @param GMP|string|int $num2 */ -function gmp_legendre (GMP|int|string $num1, GMP|int|string $num2): int {} +function gmp_legendre (GMP|string|int $num1, GMP|string|int $num2): int {} /** - * Kronecker symbol - * @link http://www.php.net/manual/en/function.gmp-kronecker.php - * @param GMP|int|string $num1 >A GMP object, an int or a numeric string. - * @param GMP|int|string $num2 >A GMP object, an int or a numeric string. - * @return int Returns the Kronecker symbol of num1 and - * num2 + * {@inheritdoc} + * @param GMP|string|int $num1 + * @param GMP|string|int $num2 */ -function gmp_kronecker (GMP|int|string $num1, GMP|int|string $num2): int {} +function gmp_kronecker (GMP|string|int $num1, GMP|string|int $num2): int {} /** - * Compare numbers - * @link http://www.php.net/manual/en/function.gmp-cmp.php - * @param GMP|int|string $num1 - * @param GMP|int|string $num2 - * @return int Returns a positive value if a > b, zero if - * a = b and a negative value if a < - * b. + * {@inheritdoc} + * @param GMP|string|int $num1 + * @param GMP|string|int $num2 */ -function gmp_cmp (GMP|int|string $num1, GMP|int|string $num2): int {} +function gmp_cmp (GMP|string|int $num1, GMP|string|int $num2): int {} /** - * Sign of number - * @link http://www.php.net/manual/en/function.gmp-sign.php - * @param GMP|int|string $num - * @return int Returns 1 if num is positive, - * -1 if num is negative, - * and 0 if num is zero. + * {@inheritdoc} + * @param GMP|string|int $num */ -function gmp_sign (GMP|int|string $num): int {} +function gmp_sign (GMP|string|int $num): int {} /** - * Sets the RNG seed - * @link http://www.php.net/manual/en/function.gmp-random-seed.php - * @param GMP|int|string $seed - * @return void No value is returned. + * {@inheritdoc} + * @param GMP|string|int $seed */ -function gmp_random_seed (GMP|int|string $seed): void {} +function gmp_random_seed (GMP|string|int $seed): void {} /** - * Random number - * @link http://www.php.net/manual/en/function.gmp-random-bits.php - * @param int $bits - * @return GMP A random GMP number. + * {@inheritdoc} + * @param int $bits */ function gmp_random_bits (int $bits): GMP {} /** - * Random number - * @link http://www.php.net/manual/en/function.gmp-random-range.php - * @param GMP|int|string $min - * @param GMP|int|string $max - * @return GMP A random GMP number. + * {@inheritdoc} + * @param GMP|string|int $min + * @param GMP|string|int $max */ -function gmp_random_range (GMP|int|string $min, GMP|int|string $max): GMP {} +function gmp_random_range (GMP|string|int $min, GMP|string|int $max): GMP {} /** - * Bitwise AND - * @link http://www.php.net/manual/en/function.gmp-and.php - * @param GMP|int|string $num1 - * @param GMP|int|string $num2 - * @return GMP A GMP number representing the bitwise AND comparison. + * {@inheritdoc} + * @param GMP|string|int $num1 + * @param GMP|string|int $num2 */ -function gmp_and (GMP|int|string $num1, GMP|int|string $num2): GMP {} +function gmp_and (GMP|string|int $num1, GMP|string|int $num2): GMP {} /** - * Bitwise OR - * @link http://www.php.net/manual/en/function.gmp-or.php - * @param GMP|int|string $num1 - * @param GMP|int|string $num2 - * @return GMP A GMP object. + * {@inheritdoc} + * @param GMP|string|int $num1 + * @param GMP|string|int $num2 */ -function gmp_or (GMP|int|string $num1, GMP|int|string $num2): GMP {} +function gmp_or (GMP|string|int $num1, GMP|string|int $num2): GMP {} /** - * Calculates one's complement - * @link http://www.php.net/manual/en/function.gmp-com.php - * @param GMP|int|string $num - * @return GMP Returns the one's complement of num, as a GMP number. + * {@inheritdoc} + * @param GMP|string|int $num */ -function gmp_com (GMP|int|string $num): GMP {} +function gmp_com (GMP|string|int $num): GMP {} /** - * Bitwise XOR - * @link http://www.php.net/manual/en/function.gmp-xor.php - * @param GMP|int|string $num1 - * @param GMP|int|string $num2 - * @return GMP A GMP object. + * {@inheritdoc} + * @param GMP|string|int $num1 + * @param GMP|string|int $num2 */ -function gmp_xor (GMP|int|string $num1, GMP|int|string $num2): GMP {} +function gmp_xor (GMP|string|int $num1, GMP|string|int $num2): GMP {} /** - * Set bit - * @link http://www.php.net/manual/en/function.gmp-setbit.php - * @param GMP $num - * @param int $index - * @param bool $value [optional] - * @return void A GMP object. + * {@inheritdoc} + * @param GMP $num + * @param int $index + * @param bool $value [optional] */ function gmp_setbit (GMP $num, int $index, bool $value = true): void {} /** - * Clear bit - * @link http://www.php.net/manual/en/function.gmp-clrbit.php - * @param GMP $num - * @param int $index - * @return void A GMP object. + * {@inheritdoc} + * @param GMP $num + * @param int $index */ function gmp_clrbit (GMP $num, int $index): void {} /** - * Tests if a bit is set - * @link http://www.php.net/manual/en/function.gmp-testbit.php - * @param GMP|int|string $num - * @param int $index - * @return bool Returns true if the bit is set in num, - * otherwise false. + * {@inheritdoc} + * @param GMP|string|int $num + * @param int $index */ -function gmp_testbit (GMP|int|string $num, int $index): bool {} +function gmp_testbit (GMP|string|int $num, int $index): bool {} /** - * Scan for 0 - * @link http://www.php.net/manual/en/function.gmp-scan0.php - * @param GMP|int|string $num1 - * @param int $start - * @return int Returns the index of the found bit, as an int. The - * index starts from 0. + * {@inheritdoc} + * @param GMP|string|int $num1 + * @param int $start */ -function gmp_scan0 (GMP|int|string $num1, int $start): int {} +function gmp_scan0 (GMP|string|int $num1, int $start): int {} /** - * Scan for 1 - * @link http://www.php.net/manual/en/function.gmp-scan1.php - * @param GMP|int|string $num1 - * @param int $start - * @return int Returns the index of the found bit, as an int. - * If no set bit is found, -1 is returned. + * {@inheritdoc} + * @param GMP|string|int $num1 + * @param int $start */ -function gmp_scan1 (GMP|int|string $num1, int $start): int {} +function gmp_scan1 (GMP|string|int $num1, int $start): int {} /** - * Population count - * @link http://www.php.net/manual/en/function.gmp-popcount.php - * @param GMP|int|string $num - * @return int The population count of num, as an int. + * {@inheritdoc} + * @param GMP|string|int $num */ -function gmp_popcount (GMP|int|string $num): int {} +function gmp_popcount (GMP|string|int $num): int {} /** - * Hamming distance - * @link http://www.php.net/manual/en/function.gmp-hamdist.php - * @param GMP|int|string $num1 - * @param GMP|int|string $num2 - * @return int The hamming distance between num1 and num2, as an int. + * {@inheritdoc} + * @param GMP|string|int $num1 + * @param GMP|string|int $num2 */ -function gmp_hamdist (GMP|int|string $num1, GMP|int|string $num2): int {} +function gmp_hamdist (GMP|string|int $num1, GMP|string|int $num2): int {} /** - * Find next prime number - * @link http://www.php.net/manual/en/function.gmp-nextprime.php - * @param GMP|int|string $num - * @return GMP Return the next prime number greater than num, - * as a GMP number. + * {@inheritdoc} + * @param GMP|string|int $num */ -function gmp_nextprime (GMP|int|string $num): GMP {} +function gmp_nextprime (GMP|string|int $num): GMP {} /** - * Calculates binomial coefficient - * @link http://www.php.net/manual/en/function.gmp-binomial.php - * @param GMP|int|string $n - * @param int $k - * @return GMP Returns the binomial coefficient C(n, k). + * {@inheritdoc} + * @param GMP|string|int $n + * @param int $k */ -function gmp_binomial (GMP|int|string $n, int $k): GMP {} +function gmp_binomial (GMP|string|int $n, int $k): GMP {} - -/** - * - * @link http://www.php.net/manual/en/gmp.constants.php - * @var int - */ define ('GMP_ROUND_ZERO', 0); - -/** - * - * @link http://www.php.net/manual/en/gmp.constants.php - * @var int - */ define ('GMP_ROUND_PLUSINF', 1); - -/** - * - * @link http://www.php.net/manual/en/gmp.constants.php - * @var int - */ define ('GMP_ROUND_MINUSINF', 2); - -/** - * The GMP library version - * @link http://www.php.net/manual/en/gmp.constants.php - * @var string - */ -define ('GMP_VERSION', "6.2.1"); - -/** - * - * @link http://www.php.net/manual/en/gmp.constants.php - * @var int - */ +define ('GMP_VERSION', "6.3.0"); define ('GMP_MSW_FIRST', 1); - -/** - * - * @link http://www.php.net/manual/en/gmp.constants.php - * @var int - */ define ('GMP_LSW_FIRST', 2); - -/** - * - * @link http://www.php.net/manual/en/gmp.constants.php - * @var int - */ define ('GMP_LITTLE_ENDIAN', 4); - -/** - * - * @link http://www.php.net/manual/en/gmp.constants.php - * @var int - */ define ('GMP_BIG_ENDIAN', 8); - -/** - * - * @link http://www.php.net/manual/en/gmp.constants.php - * @var int - */ define ('GMP_NATIVE_ENDIAN', 16); -// End of gmp v.8.2.6 +// End of gmp v.8.3.0 diff --git a/plugins/org.eclipse.php.core/Resources/language/php8.3/gnupg.php b/plugins/org.eclipse.php.core/Resources/language/php8.3/gnupg.php index fc4265eabf..3ec1642ffc 100644 --- a/plugins/org.eclipse.php.core/Resources/language/php8.3/gnupg.php +++ b/plugins/org.eclipse.php.core/Resources/language/php8.3/gnupg.php @@ -233,426 +233,210 @@ public function valid () {} } /** - * Initialize a connection - * @link http://www.php.net/manual/en/function.gnupg-init.php - * @param array|null $options [optional] - * @return resource A GnuPG resource connection used by other GnuPG functions. + * {@inheritdoc} + * @param mixed $options [optional] */ -function gnupg_init (?array $options = null) {} +function gnupg_init ($options = NULL) {} /** - * Returns an array with information about all keys that matches the given pattern - * @link http://www.php.net/manual/en/function.gnupg-keyinfo.php - * @param resource $identifier - * @param string $pattern - * @return array Returns an array with information about all keys that matches the given - * pattern or false, if an error has occurred. + * {@inheritdoc} + * @param mixed $res + * @param mixed $pattern + * @param mixed $secret_only [optional] */ -function gnupg_keyinfo ($identifier, string $pattern): array {} +function gnupg_keyinfo ($res = null, $pattern = null, $secret_only = NULL) {} /** - * Signs a given text - * @link http://www.php.net/manual/en/function.gnupg-sign.php - * @param resource $identifier - * @param string $plaintext - * @return string On success, this function returns the signed text or the signature. - * On failure, this function returns false. + * {@inheritdoc} + * @param mixed $res + * @param mixed $text */ -function gnupg_sign ($identifier, string $plaintext): string {} +function gnupg_sign ($res = null, $text = null) {} /** - * Verifies a signed text - * @link http://www.php.net/manual/en/function.gnupg-verify.php - * @param resource $identifier - * @param string $signed_text - * @param string $signature - * @param string $plaintext [optional] - * @return array On success, this function returns information about the signature. - * On failure, this function returns false. + * {@inheritdoc} + * @param mixed $res + * @param mixed $text + * @param mixed $signature + * @param mixed $plaintext [optional] */ -function gnupg_verify ($identifier, string $signed_text, string $signature, string &$plaintext = null): array {} +function gnupg_verify ($res = null, $text = null, $signature = null, &$plaintext = NULL) {} /** - * Removes all keys which were set for signing before - * @link http://www.php.net/manual/en/function.gnupg-clearsignkeys.php - * @param resource $identifier - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mixed $res */ -function gnupg_clearsignkeys ($identifier): bool {} +function gnupg_clearsignkeys ($res = null) {} /** - * Removes all keys which were set for encryption before - * @link http://www.php.net/manual/en/function.gnupg-clearencryptkeys.php - * @param resource $identifier - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mixed $res */ -function gnupg_clearencryptkeys ($identifier): bool {} +function gnupg_clearencryptkeys ($res = null) {} /** - * Removes all keys which were set for decryption before - * @link http://www.php.net/manual/en/function.gnupg-cleardecryptkeys.php - * @param resource $identifier - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mixed $res */ -function gnupg_cleardecryptkeys ($identifier): bool {} +function gnupg_cleardecryptkeys ($res = null) {} /** - * Toggle armored output - * @link http://www.php.net/manual/en/function.gnupg-setarmor.php - * @param resource $identifier - * @param int $armor - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mixed $res + * @param mixed $armor */ -function gnupg_setarmor ($identifier, int $armor): bool {} +function gnupg_setarmor ($res = null, $armor = null) {} /** - * Encrypts a given text - * @link http://www.php.net/manual/en/function.gnupg-encrypt.php - * @param resource $identifier - * @param string $plaintext - * @return string On success, this function returns the encrypted text. - * On failure, this function returns false. + * {@inheritdoc} + * @param mixed $res + * @param mixed $text */ -function gnupg_encrypt ($identifier, string $plaintext): string {} +function gnupg_encrypt ($res = null, $text = null) {} /** - * Decrypts a given text - * @link http://www.php.net/manual/en/function.gnupg-decrypt.php - * @param resource $identifier - * @param string $text - * @return string On success, this function returns the decrypted text. - * On failure, this function returns false. + * {@inheritdoc} + * @param mixed $res + * @param mixed $enctext */ -function gnupg_decrypt ($identifier, string $text): string {} +function gnupg_decrypt ($res = null, $enctext = null) {} /** - * Exports a key - * @link http://www.php.net/manual/en/function.gnupg-export.php - * @param resource $identifier - * @param string $fingerprint - * @return string On success, this function returns the keydata. - * On failure, this function returns false. + * {@inheritdoc} + * @param mixed $res + * @param mixed $pattern */ -function gnupg_export ($identifier, string $fingerprint): string {} +function gnupg_export ($res = null, $pattern = null) {} /** - * Imports a key - * @link http://www.php.net/manual/en/function.gnupg-import.php - * @param resource $identifier - * @param string $keydata - * @return array On success, this function returns and info-array about the importprocess. - * On failure, this function returns false. + * {@inheritdoc} + * @param mixed $res + * @param mixed $kye */ -function gnupg_import ($identifier, string $keydata): array {} +function gnupg_import ($res = null, $kye = null) {} /** - * Returns the engine info - * @link http://www.php.net/manual/en/function.gnupg-getengineinfo.php - * @param resource $identifier - * @return array Returns an array with engine info consting of protocol, - * file_name and home_dir. + * {@inheritdoc} + * @param mixed $res */ -function gnupg_getengineinfo ($identifier): array {} +function gnupg_getengineinfo ($res = null) {} /** - * Returns the currently active protocol for all operations - * @link http://www.php.net/manual/en/function.gnupg-getprotocol.php - * @param resource $identifier - * @return int Returns the currently active protocol, which can be one of - * GNUPG_PROTOCOL_OpenPGP or - * GNUPG_PROTOCOL_CMS. + * {@inheritdoc} + * @param mixed $res */ -function gnupg_getprotocol ($identifier): int {} +function gnupg_getprotocol ($res = null) {} /** - * Sets the mode for signing - * @link http://www.php.net/manual/en/function.gnupg-setsignmode.php - * @param resource $identifier - * @param int $signmode - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mixed $res + * @param mixed $signmode */ -function gnupg_setsignmode ($identifier, int $signmode): bool {} +function gnupg_setsignmode ($res = null, $signmode = null) {} /** - * Encrypts and signs a given text - * @link http://www.php.net/manual/en/function.gnupg-encryptsign.php - * @param resource $identifier - * @param string $plaintext - * @return string On success, this function returns the encrypted and signed text. - * On failure, this function returns false. + * {@inheritdoc} + * @param mixed $res + * @param mixed $text */ -function gnupg_encryptsign ($identifier, string $plaintext): string {} +function gnupg_encryptsign ($res = null, $text = null) {} /** - * Decrypts and verifies a given text - * @link http://www.php.net/manual/en/function.gnupg-decryptverify.php - * @param resource $identifier - * @param string $text - * @param string $plaintext - * @return array On success, this function returns information about the signature and - * fills the plaintext parameter with the decrypted text. - * On failure, this function returns false. + * {@inheritdoc} + * @param mixed $res + * @param mixed $enctext + * @param mixed $plaintext */ -function gnupg_decryptverify ($identifier, string $text, string &$plaintext): array {} +function gnupg_decryptverify ($res = null, $enctext = null, &$plaintext = null) {} /** - * Returns the errortext, if a function fails - * @link http://www.php.net/manual/en/function.gnupg-geterror.php - * @param resource $identifier - * @return string Returns an errortext, if an error has occurred, otherwise false. + * {@inheritdoc} + * @param mixed $res */ -function gnupg_geterror ($identifier): string {} +function gnupg_geterror ($res = null) {} /** - * Returns the error info - * @link http://www.php.net/manual/en/function.gnupg-geterrorinfo.php - * @param resource $identifier - * @return array Returns an array with error info. + * {@inheritdoc} + * @param mixed $res */ -function gnupg_geterrorinfo ($identifier): array {} +function gnupg_geterrorinfo ($res = null) {} /** - * Add a key for signing - * @link http://www.php.net/manual/en/function.gnupg-addsignkey.php - * @param resource $identifier - * @param string $fingerprint - * @param string $passphrase [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mixed $res + * @param mixed $kye + * @param mixed $passphrase */ -function gnupg_addsignkey ($identifier, string $fingerprint, string $passphrase = null): bool {} +function gnupg_addsignkey ($res = null, $kye = null, $passphrase = null) {} /** - * Add a key for encryption - * @link http://www.php.net/manual/en/function.gnupg-addencryptkey.php - * @param resource $identifier - * @param string $fingerprint - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mixed $res + * @param mixed $kye */ -function gnupg_addencryptkey ($identifier, string $fingerprint): bool {} +function gnupg_addencryptkey ($res = null, $kye = null) {} /** - * Add a key for decryption - * @link http://www.php.net/manual/en/function.gnupg-adddecryptkey.php - * @param resource $identifier - * @param string $fingerprint - * @param string $passphrase - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mixed $res + * @param mixed $kye + * @param mixed $passphrase */ -function gnupg_adddecryptkey ($identifier, string $fingerprint, string $passphrase): bool {} +function gnupg_adddecryptkey ($res = null, $kye = null, $passphrase = null) {} /** - * Delete a key from the keyring - * @link http://www.php.net/manual/en/function.gnupg-deletekey.php - * @param resource $identifier - * @param string $key - * @param bool $allow_secret - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mixed $res + * @param mixed $kye + * @param mixed $allow_secret */ -function gnupg_deletekey ($identifier, string $key, bool $allow_secret): bool {} +function gnupg_deletekey ($res = null, $kye = null, $allow_secret = null) {} /** - * Search the trust items - * @link http://www.php.net/manual/en/function.gnupg-gettrustlist.php - * @param resource $identifier - * @param string $pattern - * @return array On success, this function returns an array of trust items. - * On failure, this function returns null. + * {@inheritdoc} + * @param mixed $res + * @param mixed $pattern */ -function gnupg_gettrustlist ($identifier, string $pattern): array {} +function gnupg_gettrustlist ($res = null, $pattern = null) {} /** - * List key signatures - * @link http://www.php.net/manual/en/function.gnupg-listsignatures.php - * @param resource $identifier - * @param string $keyid - * @return array On success, this function returns an array of key signatures. - * On failure, this function returns null. + * {@inheritdoc} + * @param mixed $res + * @param mixed $kyeid */ -function gnupg_listsignatures ($identifier, string $keyid): array {} +function gnupg_listsignatures ($res = null, $kyeid = null) {} /** - * Sets the mode for error_reporting - * @link http://www.php.net/manual/en/function.gnupg-seterrormode.php - * @param resource $identifier - * @param int $errormode - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $res + * @param mixed $errnmode */ -function gnupg_seterrormode ($identifier, int $errormode): void {} +function gnupg_seterrormode ($res = null, $errnmode = null) {} - -/** - * - * @link http://www.php.net/manual/en/gnupg.constants.php - * @var int - */ define ('GNUPG_SIG_MODE_NORMAL', 0); - -/** - * - * @link http://www.php.net/manual/en/gnupg.constants.php - * @var int - */ define ('GNUPG_SIG_MODE_DETACH', 1); - -/** - * - * @link http://www.php.net/manual/en/gnupg.constants.php - * @var int - */ define ('GNUPG_SIG_MODE_CLEAR', 2); - -/** - * - * @link http://www.php.net/manual/en/gnupg.constants.php - * @var int - */ define ('GNUPG_VALIDITY_UNKNOWN', 0); - -/** - * - * @link http://www.php.net/manual/en/gnupg.constants.php - * @var int - */ define ('GNUPG_VALIDITY_UNDEFINED', 1); - -/** - * - * @link http://www.php.net/manual/en/gnupg.constants.php - * @var int - */ define ('GNUPG_VALIDITY_NEVER', 2); - -/** - * - * @link http://www.php.net/manual/en/gnupg.constants.php - * @var int - */ define ('GNUPG_VALIDITY_MARGINAL', 3); - -/** - * - * @link http://www.php.net/manual/en/gnupg.constants.php - * @var int - */ define ('GNUPG_VALIDITY_FULL', 4); - -/** - * - * @link http://www.php.net/manual/en/gnupg.constants.php - * @var int - */ define ('GNUPG_VALIDITY_ULTIMATE', 5); - -/** - * - * @link http://www.php.net/manual/en/gnupg.constants.php - * @var int - */ define ('GNUPG_PROTOCOL_OpenPGP', 0); - -/** - * - * @link http://www.php.net/manual/en/gnupg.constants.php - * @var int - */ define ('GNUPG_PROTOCOL_CMS', 1); - -/** - * - * @link http://www.php.net/manual/en/gnupg.constants.php - * @var int - */ define ('GNUPG_SIGSUM_VALID', 1); - -/** - * - * @link http://www.php.net/manual/en/gnupg.constants.php - * @var int - */ define ('GNUPG_SIGSUM_GREEN', 2); - -/** - * - * @link http://www.php.net/manual/en/gnupg.constants.php - * @var int - */ define ('GNUPG_SIGSUM_RED', 4); - -/** - * - * @link http://www.php.net/manual/en/gnupg.constants.php - * @var int - */ define ('GNUPG_SIGSUM_KEY_REVOKED', 16); - -/** - * - * @link http://www.php.net/manual/en/gnupg.constants.php - * @var int - */ define ('GNUPG_SIGSUM_KEY_EXPIRED', 32); - -/** - * - * @link http://www.php.net/manual/en/gnupg.constants.php - * @var int - */ define ('GNUPG_SIGSUM_SIG_EXPIRED', 64); - -/** - * - * @link http://www.php.net/manual/en/gnupg.constants.php - * @var int - */ define ('GNUPG_SIGSUM_KEY_MISSING', 128); - -/** - * - * @link http://www.php.net/manual/en/gnupg.constants.php - * @var int - */ define ('GNUPG_SIGSUM_CRL_MISSING', 256); - -/** - * - * @link http://www.php.net/manual/en/gnupg.constants.php - * @var int - */ define ('GNUPG_SIGSUM_CRL_TOO_OLD', 512); - -/** - * - * @link http://www.php.net/manual/en/gnupg.constants.php - * @var int - */ define ('GNUPG_SIGSUM_BAD_POLICY', 1024); - -/** - * - * @link http://www.php.net/manual/en/gnupg.constants.php - * @var int - */ define ('GNUPG_SIGSUM_SYS_ERROR', 2048); - -/** - * - * @link http://www.php.net/manual/en/gnupg.constants.php - * @var int - */ define ('GNUPG_ERROR_WARNING', 1); - -/** - * - * @link http://www.php.net/manual/en/gnupg.constants.php - * @var int - */ define ('GNUPG_ERROR_EXCEPTION', 2); - -/** - * - * @link http://www.php.net/manual/en/gnupg.constants.php - * @var int - */ define ('GNUPG_ERROR_SILENT', 3); define ('GNUPG_PK_RSA', 1); define ('GNUPG_PK_RSA_E', 2); @@ -664,6 +448,6 @@ function gnupg_seterrormode ($identifier, int $errormode): void {} define ('GNUPG_PK_ECDSA', 301); define ('GNUPG_PK_ECDH', 302); define ('GNUPG_PK_EDDSA', 303); -define ('GNUPG_GPGME_VERSION', "1.20.0"); +define ('GNUPG_GPGME_VERSION', "1.23.2"); // End of gnupg v.1.5.1 diff --git a/plugins/org.eclipse.php.core/Resources/language/php8.3/grpc.php b/plugins/org.eclipse.php.core/Resources/language/php8.3/grpc.php index 2d00f5ff0d..09cfaff20e 100644 --- a/plugins/org.eclipse.php.core/Resources/language/php8.3/grpc.php +++ b/plugins/org.eclipse.php.core/Resources/language/php8.3/grpc.php @@ -1,6 +1,6 @@ If string is shorter than offset - * characters long, false will be returned. - * If string is exactly offset - * characters long, an empty string will be returned. + * {@inheritdoc} + * @param string $string + * @param int $offset + * @param int|null $length [optional] + * @param string|null $encoding [optional] */ -function iconv_substr (string $string, int $offset, ?int $length = null, ?string $encoding = null): string|false {} +function iconv_substr (string $string, int $offset, ?int $length = NULL, ?string $encoding = NULL): string|false {} /** - * Finds position of first occurrence of a needle within a haystack - * @link http://www.php.net/manual/en/function.iconv-strpos.php - * @param string $haystack - * @param string $needle - * @param int $offset [optional] - * @param string|null $encoding [optional] - * @return int|false Returns the numeric position of the first occurrence of - * needle in haystack. - *If needle is not found, - * iconv_strpos will return false.
+ * {@inheritdoc} + * @param string $haystack + * @param string $needle + * @param int $offset [optional] + * @param string|null $encoding [optional] */ -function iconv_strpos (string $haystack, string $needle, int $offset = null, ?string $encoding = null): int|false {} +function iconv_strpos (string $haystack, string $needle, int $offset = 0, ?string $encoding = NULL): int|false {} /** - * Finds the last occurrence of a needle within a haystack - * @link http://www.php.net/manual/en/function.iconv-strrpos.php - * @param string $haystack - * @param string $needle - * @param string|null $encoding [optional] - * @return int|false Returns the numeric position of the last occurrence of - * needle in haystack. - *If needle is not found, - * iconv_strrpos will return false.
+ * {@inheritdoc} + * @param string $haystack + * @param string $needle + * @param string|null $encoding [optional] */ -function iconv_strrpos (string $haystack, string $needle, ?string $encoding = null): int|false {} +function iconv_strrpos (string $haystack, string $needle, ?string $encoding = NULL): int|false {} /** - * Composes a MIME header field - * @link http://www.php.net/manual/en/function.iconv-mime-encode.php - * @param string $field_name - * @param string $field_value - * @param array $options [optional] - * @return string|false Returns an encoded MIME field on success, - * or false if an error occurs during the encoding. + * {@inheritdoc} + * @param string $field_name + * @param string $field_value + * @param array $options [optional] */ -function iconv_mime_encode (string $field_name, string $field_value, array $options = '[]'): string|false {} +function iconv_mime_encode (string $field_name, string $field_value, array $options = array ( +)): string|false {} /** - * Decodes a MIME header field - * @link http://www.php.net/manual/en/function.iconv-mime-decode.php - * @param string $string - * @param int $mode [optional] - * @param string|null $encoding [optional] - * @return string|false Returns a decoded MIME field on success, - * or false if an error occurs during the decoding. + * {@inheritdoc} + * @param string $string + * @param int $mode [optional] + * @param string|null $encoding [optional] */ -function iconv_mime_decode (string $string, int $mode = null, ?string $encoding = null): string|false {} +function iconv_mime_decode (string $string, int $mode = 0, ?string $encoding = NULL): string|false {} /** - * Decodes multiple MIME header fields at once - * @link http://www.php.net/manual/en/function.iconv-mime-decode-headers.php - * @param string $headers - * @param int $mode [optional] - * @param string|null $encoding [optional] - * @return array|false Returns an associative array that holds a whole set of - * MIME header fields specified by - * headers on success, or false - * if an error occurs during the decoding. - *Each key of the return value represents an individual - * field name and the corresponding element represents a field value. - * If more than one field of the same name are present, - * iconv_mime_decode_headers automatically incorporates - * them into a numerically indexed array in the order of occurrence. - * Note that header names are not case-insensitive.
+ * {@inheritdoc} + * @param string $headers + * @param int $mode [optional] + * @param string|null $encoding [optional] */ -function iconv_mime_decode_headers (string $headers, int $mode = null, ?string $encoding = null): array|false {} +function iconv_mime_decode_headers (string $headers, int $mode = 0, ?string $encoding = NULL): array|false {} /** - * Convert a string from one character encoding to another - * @link http://www.php.net/manual/en/function.iconv.php - * @param string $from_encoding - * @param string $to_encoding - * @param string $string - * @return string|false Returns the converted string, or false on failure. + * {@inheritdoc} + * @param string $from_encoding + * @param string $to_encoding + * @param string $string */ function iconv (string $from_encoding, string $to_encoding, string $string): string|false {} /** - * Set current setting for character encoding conversion - * @link http://www.php.net/manual/en/function.iconv-set-encoding.php - * @param string $type - * @param string $encoding - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $type + * @param string $encoding */ function iconv_set_encoding (string $type, string $encoding): bool {} /** - * Retrieve internal configuration variables of iconv extension - * @link http://www.php.net/manual/en/function.iconv-get-encoding.php - * @param string $type [optional] - * @return array|string|false Returns the current value of the internal configuration variable if - * successful or false on failure. - *If type is omitted or set to "all", - * iconv_get_encoding returns an array that - * stores all these variables.
+ * {@inheritdoc} + * @param string $type [optional] */ -function iconv_get_encoding (string $type = '"all"'): array|string|false {} +function iconv_get_encoding (string $type = 'all'): array|string|false {} -define ('ICONV_IMPL', "unknown"); -define ('ICONV_VERSION', "unknown"); +define ('ICONV_IMPL', "libiconv"); +define ('ICONV_VERSION', 1.11); define ('ICONV_MIME_DECODE_STRICT', 1); define ('ICONV_MIME_DECODE_CONTINUE_ON_ERROR', 2); -// End of iconv v.8.2.6 +// End of iconv v.8.3.0 diff --git a/plugins/org.eclipse.php.core/Resources/language/php8.3/igbinary.php b/plugins/org.eclipse.php.core/Resources/language/php8.3/igbinary.php index 303ebd88ef..59ee313a3f 100644 --- a/plugins/org.eclipse.php.core/Resources/language/php8.3/igbinary.php +++ b/plugins/org.eclipse.php.core/Resources/language/php8.3/igbinary.php @@ -3,63 +3,15 @@ // Start of igbinary v.3.2.14 /** - * Generates a compact, storable binary representation of a value - * @link http://www.php.net/manual/en/function.igbinary-serialize.php - * @param mixed $value The value to be serialized. igbinary_serialize - * handles all types, except the resource-type and some objects (see note below). - * Even arrays that contain references to itself can be igbinary_serialized. - * Circular references inside the array or object that is being serializend will also be stored. - * Any other reference will be lost. - *When serializing objects, igbinary will attempt to call the member functions - * __serialize() or - * __sleep() prior to serialization. - * This is to allow the object to do any last minute clean-up, etc. prior - * to being serialized. Likewise, when the object is restored using - * igbinary_unserialize the __unserialize() or - * __wakeup() member function is called.
- *Private members of objects have the class name prepended to the member - * name; protected members have a '*' prepended to the member name. - * These prepended values have null bytes on either side.
- * @return string|false Returns a string containing a byte-stream representation of - * value that can be stored anywhere. - *Note that this is a binary string which can include any byte value, and needs - * to be stored and handled as such. For example, - * igbinary_serialize output should generally be stored in a BLOB - * field in a database, rather than a CHAR or TEXT field.
+ * {@inheritdoc} + * @param mixed $value */ -function igbinary_serialize (mixed $value): string|false {} +function igbinary_serialize ($value = null) {} /** - * Creates a PHP value from a stored representation from igbinary_serialize - * @link http://www.php.net/manual/en/function.igbinary-unserialize.php - * @param string $str The serialized string generated by igbinary_serialize. - *If the value being unserialized is an object, after successfully - * reconstructing the object igbinary will automatically attempt to call the - * __unserialize() or - * __wakeup() methods (if one exists).
- *unserialize_callback_func directive - *
- * It is possible to set a callback function which will be called, - * if an undefined class should be instantiated during unserializing. - * (to prevent getting an incomplete object __PHP_Incomplete_Class.) - * The php.ini, ini_set or .htaccess can be used - * to define unserialize_callback_func. - * Everytime an undefined class should be instantiated, it will be called. - * To disable this feature this setting should be emptied. - *
- *It is possible to set a callback function which will be called, - * if an undefined class should be instantiated during unserializing. - * (to prevent getting an incomplete object __PHP_Incomplete_Class.) - * The php.ini, ini_set or .htaccess can be used - * to define unserialize_callback_func. - * Everytime an undefined class should be instantiated, it will be called. - * To disable this feature this setting should be emptied.
- * @return mixed The converted value is returned, and can be a bool, - * int, float, string, - * array, object, or null. - *In case the passed string is not unserializeable, false is returned and - * E_NOTICE or E_WARNING is issued.
+ * {@inheritdoc} + * @param mixed $str */ -function igbinary_unserialize (string $str): mixed {} +function igbinary_unserialize ($str = null) {} // End of igbinary v.3.2.14 diff --git a/plugins/org.eclipse.php.core/Resources/language/php8.3/imagick.php b/plugins/org.eclipse.php.core/Resources/language/php8.3/imagick.php index 6b07d243de..d02c1e01b6 100644 --- a/plugins/org.eclipse.php.core/Resources/language/php8.3/imagick.php +++ b/plugins/org.eclipse.php.core/Resources/language/php8.3/imagick.php @@ -5,14 +5,12 @@ class ImagickException extends Exception implements Throwable, Stringable { /** - * Construct the exception - * @link http://www.php.net/manual/en/exception.construct.php - * @param string $message [optional] - * @param int $code [optional] - * @param Throwable|null $previous [optional] - * @return string + * {@inheritdoc} + * @param string $message [optional] + * @param int $code [optional] + * @param Throwable|null $previous [optional] */ - public function __construct (string $message = '""', int $code = null, ?Throwable $previous = null): string {} + public function __construct (string $message = '', int $code = 0, ?Throwable $previous = NULL) {} /** * {@inheritdoc} @@ -20,62 +18,42 @@ public function __construct (string $message = '""', int $code = null, ?Throwabl public function __wakeup () {} /** - * Gets the Exception message - * @link http://www.php.net/manual/en/exception.getmessage.php - * @return string Returns the Exception message as a string. + * {@inheritdoc} */ final public function getMessage (): string {} /** - * Gets the Exception code - * @link http://www.php.net/manual/en/exception.getcode.php - * @return int Returns the exception code as int in - * Exception but possibly as other type in - * Exception descendants (for example as - * string in PDOException). + * {@inheritdoc} */ - final public function getCode (): int {} + final public function getCode () {} /** - * Gets the file in which the exception was created - * @link http://www.php.net/manual/en/exception.getfile.php - * @return string Returns the filename in which the exception was created. + * {@inheritdoc} */ final public function getFile (): string {} /** - * Gets the line in which the exception was created - * @link http://www.php.net/manual/en/exception.getline.php - * @return int Returns the line number where the exception was created. + * {@inheritdoc} */ final public function getLine (): int {} /** - * Gets the stack trace - * @link http://www.php.net/manual/en/exception.gettrace.php - * @return array Returns the Exception stack trace as an array. + * {@inheritdoc} */ final public function getTrace (): array {} /** - * Returns previous Throwable - * @link http://www.php.net/manual/en/exception.getprevious.php - * @return Throwable|null Returns the previous Throwable if available - * or null otherwise. + * {@inheritdoc} */ final public function getPrevious (): ?Throwable {} /** - * Gets the stack trace as a string - * @link http://www.php.net/manual/en/exception.gettraceasstring.php - * @return string Returns the Exception stack trace as a string. + * {@inheritdoc} */ final public function getTraceAsString (): string {} /** - * String representation of the exception - * @link http://www.php.net/manual/en/exception.tostring.php - * @return string Returns the string representation of the exception. + * {@inheritdoc} */ public function __toString (): string {} @@ -84,14 +62,12 @@ public function __toString (): string {} class ImagickDrawException extends Exception implements Throwable, Stringable { /** - * Construct the exception - * @link http://www.php.net/manual/en/exception.construct.php - * @param string $message [optional] - * @param int $code [optional] - * @param Throwable|null $previous [optional] - * @return string + * {@inheritdoc} + * @param string $message [optional] + * @param int $code [optional] + * @param Throwable|null $previous [optional] */ - public function __construct (string $message = '""', int $code = null, ?Throwable $previous = null): string {} + public function __construct (string $message = '', int $code = 0, ?Throwable $previous = NULL) {} /** * {@inheritdoc} @@ -99,62 +75,42 @@ public function __construct (string $message = '""', int $code = null, ?Throwabl public function __wakeup () {} /** - * Gets the Exception message - * @link http://www.php.net/manual/en/exception.getmessage.php - * @return string Returns the Exception message as a string. + * {@inheritdoc} */ final public function getMessage (): string {} /** - * Gets the Exception code - * @link http://www.php.net/manual/en/exception.getcode.php - * @return int Returns the exception code as int in - * Exception but possibly as other type in - * Exception descendants (for example as - * string in PDOException). + * {@inheritdoc} */ - final public function getCode (): int {} + final public function getCode () {} /** - * Gets the file in which the exception was created - * @link http://www.php.net/manual/en/exception.getfile.php - * @return string Returns the filename in which the exception was created. + * {@inheritdoc} */ final public function getFile (): string {} /** - * Gets the line in which the exception was created - * @link http://www.php.net/manual/en/exception.getline.php - * @return int Returns the line number where the exception was created. + * {@inheritdoc} */ final public function getLine (): int {} /** - * Gets the stack trace - * @link http://www.php.net/manual/en/exception.gettrace.php - * @return array Returns the Exception stack trace as an array. + * {@inheritdoc} */ final public function getTrace (): array {} /** - * Returns previous Throwable - * @link http://www.php.net/manual/en/exception.getprevious.php - * @return Throwable|null Returns the previous Throwable if available - * or null otherwise. + * {@inheritdoc} */ final public function getPrevious (): ?Throwable {} /** - * Gets the stack trace as a string - * @link http://www.php.net/manual/en/exception.gettraceasstring.php - * @return string Returns the Exception stack trace as a string. + * {@inheritdoc} */ final public function getTraceAsString (): string {} /** - * String representation of the exception - * @link http://www.php.net/manual/en/exception.tostring.php - * @return string Returns the string representation of the exception. + * {@inheritdoc} */ public function __toString (): string {} @@ -163,14 +119,12 @@ public function __toString (): string {} class ImagickPixelIteratorException extends Exception implements Throwable, Stringable { /** - * Construct the exception - * @link http://www.php.net/manual/en/exception.construct.php - * @param string $message [optional] - * @param int $code [optional] - * @param Throwable|null $previous [optional] - * @return string + * {@inheritdoc} + * @param string $message [optional] + * @param int $code [optional] + * @param Throwable|null $previous [optional] */ - public function __construct (string $message = '""', int $code = null, ?Throwable $previous = null): string {} + public function __construct (string $message = '', int $code = 0, ?Throwable $previous = NULL) {} /** * {@inheritdoc} @@ -178,62 +132,42 @@ public function __construct (string $message = '""', int $code = null, ?Throwabl public function __wakeup () {} /** - * Gets the Exception message - * @link http://www.php.net/manual/en/exception.getmessage.php - * @return string Returns the Exception message as a string. + * {@inheritdoc} */ final public function getMessage (): string {} /** - * Gets the Exception code - * @link http://www.php.net/manual/en/exception.getcode.php - * @return int Returns the exception code as int in - * Exception but possibly as other type in - * Exception descendants (for example as - * string in PDOException). + * {@inheritdoc} */ - final public function getCode (): int {} + final public function getCode () {} /** - * Gets the file in which the exception was created - * @link http://www.php.net/manual/en/exception.getfile.php - * @return string Returns the filename in which the exception was created. + * {@inheritdoc} */ final public function getFile (): string {} /** - * Gets the line in which the exception was created - * @link http://www.php.net/manual/en/exception.getline.php - * @return int Returns the line number where the exception was created. + * {@inheritdoc} */ final public function getLine (): int {} /** - * Gets the stack trace - * @link http://www.php.net/manual/en/exception.gettrace.php - * @return array Returns the Exception stack trace as an array. + * {@inheritdoc} */ final public function getTrace (): array {} /** - * Returns previous Throwable - * @link http://www.php.net/manual/en/exception.getprevious.php - * @return Throwable|null Returns the previous Throwable if available - * or null otherwise. + * {@inheritdoc} */ final public function getPrevious (): ?Throwable {} /** - * Gets the stack trace as a string - * @link http://www.php.net/manual/en/exception.gettraceasstring.php - * @return string Returns the Exception stack trace as a string. + * {@inheritdoc} */ final public function getTraceAsString (): string {} /** - * String representation of the exception - * @link http://www.php.net/manual/en/exception.tostring.php - * @return string Returns the string representation of the exception. + * {@inheritdoc} */ public function __toString (): string {} @@ -242,14 +176,12 @@ public function __toString (): string {} class ImagickPixelException extends Exception implements Throwable, Stringable { /** - * Construct the exception - * @link http://www.php.net/manual/en/exception.construct.php - * @param string $message [optional] - * @param int $code [optional] - * @param Throwable|null $previous [optional] - * @return string + * {@inheritdoc} + * @param string $message [optional] + * @param int $code [optional] + * @param Throwable|null $previous [optional] */ - public function __construct (string $message = '""', int $code = null, ?Throwable $previous = null): string {} + public function __construct (string $message = '', int $code = 0, ?Throwable $previous = NULL) {} /** * {@inheritdoc} @@ -257,62 +189,42 @@ public function __construct (string $message = '""', int $code = null, ?Throwabl public function __wakeup () {} /** - * Gets the Exception message - * @link http://www.php.net/manual/en/exception.getmessage.php - * @return string Returns the Exception message as a string. + * {@inheritdoc} */ final public function getMessage (): string {} /** - * Gets the Exception code - * @link http://www.php.net/manual/en/exception.getcode.php - * @return int Returns the exception code as int in - * Exception but possibly as other type in - * Exception descendants (for example as - * string in PDOException). + * {@inheritdoc} */ - final public function getCode (): int {} + final public function getCode () {} /** - * Gets the file in which the exception was created - * @link http://www.php.net/manual/en/exception.getfile.php - * @return string Returns the filename in which the exception was created. + * {@inheritdoc} */ final public function getFile (): string {} /** - * Gets the line in which the exception was created - * @link http://www.php.net/manual/en/exception.getline.php - * @return int Returns the line number where the exception was created. + * {@inheritdoc} */ final public function getLine (): int {} /** - * Gets the stack trace - * @link http://www.php.net/manual/en/exception.gettrace.php - * @return array Returns the Exception stack trace as an array. + * {@inheritdoc} */ final public function getTrace (): array {} /** - * Returns previous Throwable - * @link http://www.php.net/manual/en/exception.getprevious.php - * @return Throwable|null Returns the previous Throwable if available - * or null otherwise. + * {@inheritdoc} */ final public function getPrevious (): ?Throwable {} /** - * Gets the stack trace as a string - * @link http://www.php.net/manual/en/exception.gettraceasstring.php - * @return string Returns the Exception stack trace as a string. + * {@inheritdoc} */ final public function getTraceAsString (): string {} /** - * String representation of the exception - * @link http://www.php.net/manual/en/exception.tostring.php - * @return string Returns the string representation of the exception. + * {@inheritdoc} */ public function __toString (): string {} @@ -321,14 +233,12 @@ public function __toString (): string {} class ImagickKernelException extends Exception implements Throwable, Stringable { /** - * Construct the exception - * @link http://www.php.net/manual/en/exception.construct.php - * @param string $message [optional] - * @param int $code [optional] - * @param Throwable|null $previous [optional] - * @return string + * {@inheritdoc} + * @param string $message [optional] + * @param int $code [optional] + * @param Throwable|null $previous [optional] */ - public function __construct (string $message = '""', int $code = null, ?Throwable $previous = null): string {} + public function __construct (string $message = '', int $code = 0, ?Throwable $previous = NULL) {} /** * {@inheritdoc} @@ -336,70 +246,47 @@ public function __construct (string $message = '""', int $code = null, ?Throwabl public function __wakeup () {} /** - * Gets the Exception message - * @link http://www.php.net/manual/en/exception.getmessage.php - * @return string Returns the Exception message as a string. + * {@inheritdoc} */ final public function getMessage (): string {} /** - * Gets the Exception code - * @link http://www.php.net/manual/en/exception.getcode.php - * @return int Returns the exception code as int in - * Exception but possibly as other type in - * Exception descendants (for example as - * string in PDOException). + * {@inheritdoc} */ - final public function getCode (): int {} + final public function getCode () {} /** - * Gets the file in which the exception was created - * @link http://www.php.net/manual/en/exception.getfile.php - * @return string Returns the filename in which the exception was created. + * {@inheritdoc} */ final public function getFile (): string {} /** - * Gets the line in which the exception was created - * @link http://www.php.net/manual/en/exception.getline.php - * @return int Returns the line number where the exception was created. + * {@inheritdoc} */ final public function getLine (): int {} /** - * Gets the stack trace - * @link http://www.php.net/manual/en/exception.gettrace.php - * @return array Returns the Exception stack trace as an array. + * {@inheritdoc} */ final public function getTrace (): array {} /** - * Returns previous Throwable - * @link http://www.php.net/manual/en/exception.getprevious.php - * @return Throwable|null Returns the previous Throwable if available - * or null otherwise. + * {@inheritdoc} */ final public function getPrevious (): ?Throwable {} /** - * Gets the stack trace as a string - * @link http://www.php.net/manual/en/exception.gettraceasstring.php - * @return string Returns the Exception stack trace as a string. + * {@inheritdoc} */ final public function getTraceAsString (): string {} /** - * String representation of the exception - * @link http://www.php.net/manual/en/exception.tostring.php - * @return string Returns the string representation of the exception. + * {@inheritdoc} */ public function __toString (): string {} } -/** - * @link http://www.php.net/manual/en/class.imagick.php - */ class Imagick implements Stringable, Iterator, Traversable, Countable { const COLOR_BLACK = 11; const COLOR_BLUE = 12; @@ -1033,65 +920,49 @@ class Imagick implements Stringable, Iterator, Traversable, Countable { /** - * Removes repeated portions of images to optimize - * @link http://www.php.net/manual/en/imagick.optimizeimagelayers.php - * @return bool Returns true on success. + * {@inheritdoc} */ public function optimizeImageLayers (): bool {} /** - * Returns the maximum bounding region between images - * @link http://www.php.net/manual/en/imagick.compareimagelayers.php - * @param int $method - * @return Imagick Returns true on success. + * {@inheritdoc} + * @param int $metric */ - public function compareImageLayers (int $method): Imagick {} + public function compareImageLayers (int $metric): Imagick {} /** - * Quickly fetch attributes - * @link http://www.php.net/manual/en/imagick.pingimageblob.php - * @param string $image - * @return bool Returns true on success. + * {@inheritdoc} + * @param string $image */ public function pingImageBlob (string $image): bool {} /** - * Get basic image attributes in a lightweight manner - * @link http://www.php.net/manual/en/imagick.pingimagefile.php - * @param resource $filehandle - * @param string $fileName [optional] - * @return bool Returns true on success. + * {@inheritdoc} + * @param mixed $filehandle + * @param string|null $filename [optional] */ - public function pingImageFile ($filehandle, string $fileName = null): bool {} + public function pingImageFile (mixed $filehandle = null, ?string $filename = NULL): bool {} /** - * Creates a vertical mirror image - * @link http://www.php.net/manual/en/imagick.transposeimage.php - * @return bool Returns true on success. + * {@inheritdoc} */ public function transposeImage (): bool {} /** - * Creates a horizontal mirror image - * @link http://www.php.net/manual/en/imagick.transverseimage.php - * @return bool Returns true on success. + * {@inheritdoc} */ public function transverseImage (): bool {} /** - * Remove edges from the image - * @link http://www.php.net/manual/en/imagick.trimimage.php - * @param float $fuzz - * @return bool Returns true on success. + * {@inheritdoc} + * @param float $fuzz */ public function trimImage (float $fuzz): bool {} /** - * Applies wave filter to the image - * @link http://www.php.net/manual/en/imagick.waveimage.php - * @param float $amplitude - * @param float $length - * @return bool Returns true on success. + * {@inheritdoc} + * @param float $amplitude + * @param float $length */ public function waveImage (float $amplitude, float $length): bool {} @@ -1104,118 +975,94 @@ public function waveImage (float $amplitude, float $length): bool {} public function waveImageWithMethod (float $amplitude, float $length, int $interpolate_method): bool {} /** - * Adds vignette filter to the image - * @link http://www.php.net/manual/en/imagick.vignetteimage.php - * @param float $blackPoint - * @param float $whitePoint - * @param int $x - * @param int $y - * @return bool Returns true on success. + * {@inheritdoc} + * @param float $black_point + * @param float $white_point + * @param int $x + * @param int $y */ - public function vignetteImage (float $blackPoint, float $whitePoint, int $x, int $y): bool {} + public function vignetteImage (float $black_point, float $white_point, int $x, int $y): bool {} /** - * Discards all but one of any pixel color - * @link http://www.php.net/manual/en/imagick.uniqueimagecolors.php - * @return bool Returns true on success. + * {@inheritdoc} */ public function uniqueImageColors (): bool {} /** - * Sets the image matte channel - * @link http://www.php.net/manual/en/imagick.setimagematte.php - * @param bool $matte - * @return bool Returns true on success. + * {@inheritdoc} + * @param bool $matte */ public function setImageMatte (bool $matte): bool {} /** - * Adaptively resize image with data dependent triangulation - * @link http://www.php.net/manual/en/imagick.adaptiveresizeimage.php - * @param int $columns - * @param int $rows - * @param bool $bestfit [optional] - * @param bool $legacy [optional] - * @return bool Returns true on success. + * {@inheritdoc} + * @param int $columns + * @param int $rows + * @param bool $bestfit [optional] + * @param bool $legacy [optional] */ public function adaptiveResizeImage (int $columns, int $rows, bool $bestfit = false, bool $legacy = false): bool {} /** - * Simulates a pencil sketch - * @link http://www.php.net/manual/en/imagick.sketchimage.php - * @param float $radius - * @param float $sigma - * @param float $angle - * @return bool Returns true on success. + * {@inheritdoc} + * @param float $radius + * @param float $sigma + * @param float $angle */ public function sketchImage (float $radius, float $sigma, float $angle): bool {} /** - * Creates a 3D effect - * @link http://www.php.net/manual/en/imagick.shadeimage.php - * @param bool $gray - * @param float $azimuth - * @param float $elevation - * @return bool Returns true on success. + * {@inheritdoc} + * @param bool $gray + * @param float $azimuth + * @param float $elevation */ public function shadeImage (bool $gray, float $azimuth, float $elevation): bool {} /** - * Returns the size offset - * @link http://www.php.net/manual/en/imagick.getsizeoffset.php - * @return int Returns the size offset associated with the Imagick object. + * {@inheritdoc} */ public function getSizeOffset (): int {} /** - * Sets the size and offset of the Imagick object - * @link http://www.php.net/manual/en/imagick.setsizeoffset.php - * @param int $columns - * @param int $rows - * @param int $offset - * @return bool Returns true on success. + * {@inheritdoc} + * @param int $columns + * @param int $rows + * @param int $offset */ public function setSizeOffset (int $columns, int $rows, int $offset): bool {} /** - * Adds adaptive blur filter to image - * @link http://www.php.net/manual/en/imagick.adaptiveblurimage.php - * @param float $radius - * @param float $sigma - * @param int $channel [optional] - * @return bool Returns true on success. + * {@inheritdoc} + * @param float $radius + * @param float $sigma + * @param int $channel [optional] */ - public function adaptiveBlurImage (float $radius, float $sigma, int $channel = \Imagick::CHANNEL_DEFAULT): bool {} + public function adaptiveBlurImage (float $radius, float $sigma, int $channel = 134217727): bool {} /** - * Enhances the contrast of a color image - * @link http://www.php.net/manual/en/imagick.contraststretchimage.php - * @param float $black_point - * @param float $white_point - * @param int $channel [optional] - * @return bool Returns true on success. + * {@inheritdoc} + * @param float $black_point + * @param float $white_point + * @param int $channel [optional] */ - public function contrastStretchImage (float $black_point, float $white_point, int $channel = \Imagick::CHANNEL_DEFAULT): bool {} + public function contrastStretchImage (float $black_point, float $white_point, int $channel = 134217727): bool {} /** - * Adaptively sharpen the image - * @link http://www.php.net/manual/en/imagick.adaptivesharpenimage.php - * @param float $radius - * @param float $sigma - * @param int $channel [optional] - * @return bool Returns true on success. + * {@inheritdoc} + * @param float $radius + * @param float $sigma + * @param int $channel [optional] */ - public function adaptiveSharpenImage (float $radius, float $sigma, int $channel = \Imagick::CHANNEL_DEFAULT): bool {} + public function adaptiveSharpenImage (float $radius, float $sigma, int $channel = 134217727): bool {} /** - * Creates a high-contrast, two-color image - * @link http://www.php.net/manual/en/imagick.randomthresholdimage.php - * @param float $low - * @param float $high - * @param int $channel [optional] - * @return bool Returns true on success. + * {@inheritdoc} + * @param float $low + * @param float $high + * @param int $channel [optional] */ - public function randomThresholdImage (float $low, float $high, int $channel = \Imagick::CHANNEL_DEFAULT): bool {} + public function randomThresholdImage (float $low, float $high, int $channel = 134217727): bool {} /** * {@inheritdoc} @@ -1228,30 +1075,23 @@ public function randomThresholdImage (float $low, float $high, int $channel = \I public function roundCornersImage (float $x_rounding, float $y_rounding, float $stroke_width = 10, float $displace = 5, float $size_correction = -6): bool {} /** - * Rounds image corners - * @link http://www.php.net/manual/en/imagick.roundcorners.php - * @param float $x_rounding - * @param float $y_rounding - * @param float $stroke_width [optional] - * @param float $displace [optional] - * @param float $size_correction [optional] - * @return bool Returns true on success. - * @deprecated 1 + * {@inheritdoc} + * @param float $x_rounding + * @param float $y_rounding + * @param float $stroke_width [optional] + * @param float $displace [optional] + * @param float $size_correction [optional] */ public function roundCorners (float $x_rounding, float $y_rounding, float $stroke_width = 10, float $displace = 5, float $size_correction = -6): bool {} /** - * Set the iterator position - * @link http://www.php.net/manual/en/imagick.setiteratorindex.php - * @param int $index - * @return bool Returns true on success. + * {@inheritdoc} + * @param int $index */ public function setIteratorIndex (int $index): bool {} /** - * Gets the index of the current active image - * @link http://www.php.net/manual/en/imagick.getiteratorindex.php - * @return int Returns an integer containing the index of the image in the stack. + * {@inheritdoc} */ public function getIteratorIndex (): int {} @@ -1271,396 +1111,303 @@ public function setImageAlpha (float $alpha): bool {} public function polaroidWithTextAndMethod (ImagickDraw $settings, float $angle, string $caption, int $method): bool {} /** - * Simulates a Polaroid picture - * @link http://www.php.net/manual/en/imagick.polaroidimage.php - * @param ImagickDraw $properties - * @param float $angle - * @return bool Returns true on success. + * {@inheritdoc} + * @param ImagickDraw $settings + * @param float $angle */ - public function polaroidImage (ImagickDraw $properties, float $angle): bool {} + public function polaroidImage (ImagickDraw $settings, float $angle): bool {} /** - * Returns the named image property - * @link http://www.php.net/manual/en/imagick.getimageproperty.php - * @param string $name - * @return string Returns a string containing the image property, false if a - * property with the given name does not exist. + * {@inheritdoc} + * @param string $name */ public function getImageProperty (string $name): string {} /** - * Sets an image property - * @link http://www.php.net/manual/en/imagick.setimageproperty.php - * @param string $name - * @param string $value - * @return bool Returns true on success. + * {@inheritdoc} + * @param string $name + * @param string $value */ public function setImageProperty (string $name, string $value): bool {} /** - * Deletes an image property - * @link http://www.php.net/manual/en/imagick.deleteimageproperty.php - * @param string $name The name of the property to delete. - * @return bool Returns true on success. + * {@inheritdoc} + * @param string $name */ public function deleteImageProperty (string $name): bool {} /** - * Formats a string with image details - * @link http://www.php.net/manual/en/imagick.identifyformat.php - * @param string $embedText A string containing formatting sequences e.g. "Trim box: %@ number of unique colors: %k". - * @return string|false Returns format or false on failure. + * {@inheritdoc} + * @param string $format */ - public function identifyFormat (string $embedText): string|false {} + public function identifyFormat (string $format): string {} /** - * Sets the image interpolate pixel method - * @link http://www.php.net/manual/en/imagick.setimageinterpolatemethod.php - * @param int $method - * @return bool Returns true on success. + * {@inheritdoc} + * @param int $method */ public function setImageInterpolateMethod (int $method): bool {} /** - * Returns the interpolation method - * @link http://www.php.net/manual/en/imagick.getimageinterpolatemethod.php - * @return int Returns the interpolate method on success. + * {@inheritdoc} */ public function getImageInterpolateMethod (): int {} /** - * Stretches with saturation the image intensity - * @link http://www.php.net/manual/en/imagick.linearstretchimage.php - * @param float $blackPoint - * @param float $whitePoint - * @return bool Returns true on success. + * {@inheritdoc} + * @param float $black_point + * @param float $white_point */ - public function linearStretchImage (float $blackPoint, float $whitePoint): bool {} + public function linearStretchImage (float $black_point, float $white_point): bool {} /** - * Returns the image length in bytes - * @link http://www.php.net/manual/en/imagick.getimagelength.php - * @return int Returns an int containing the current image size. + * {@inheritdoc} */ public function getImageLength (): int {} /** - * Set image size - * @link http://www.php.net/manual/en/imagick.extentimage.php - * @param int $width - * @param int $height - * @param int $x - * @param int $y - * @return bool Returns true on success. + * {@inheritdoc} + * @param int $width + * @param int $height + * @param int $x + * @param int $y */ public function extentImage (int $width, int $height, int $x, int $y): bool {} /** - * Gets the image orientation - * @link http://www.php.net/manual/en/imagick.getimageorientation.php - * @return int Returns an int on success. + * {@inheritdoc} */ public function getImageOrientation (): int {} /** - * Sets the image orientation - * @link http://www.php.net/manual/en/imagick.setimageorientation.php - * @param int $orientation - * @return bool Returns true on success. + * {@inheritdoc} + * @param int $orientation */ public function setImageOrientation (int $orientation): bool {} /** - * Replaces colors in the image - * @link http://www.php.net/manual/en/imagick.clutimage.php - * @param Imagick $lookup_table - * @param int $channel [optional] - * @return bool Returns true on success. + * {@inheritdoc} + * @param Imagick $lookup_table + * @param int $channel [optional] */ - public function clutImage (Imagick $lookup_table, int $channel = \Imagick::CHANNEL_DEFAULT): bool {} + public function clutImage (Imagick $lookup_table, int $channel = 134217727): bool {} /** - * Returns the image properties - * @link http://www.php.net/manual/en/imagick.getimageproperties.php - * @param string $pattern [optional] - * @param bool $include_values [optional] - * @return array Returns an array containing the image properties or property names. + * {@inheritdoc} + * @param string $pattern [optional] + * @param bool $include_values [optional] */ - public function getImageProperties (string $pattern = '"*"', bool $include_values = true): array {} + public function getImageProperties (string $pattern = '*', bool $include_values = true): array {} /** - * Returns the image profiles - * @link http://www.php.net/manual/en/imagick.getimageprofiles.php - * @param string $pattern [optional] - * @param bool $include_values [optional] - * @return array Returns an array containing the image profiles or profile names. + * {@inheritdoc} + * @param string $pattern [optional] + * @param bool $include_values [optional] */ - public function getImageProfiles (string $pattern = '"*"', bool $include_values = true): array {} + public function getImageProfiles (string $pattern = '*', bool $include_values = true): array {} /** - * Distorts an image using various distortion methods - * @link http://www.php.net/manual/en/imagick.distortimage.php - * @param int $method - * @param array $arguments - * @param bool $bestfit - * @return bool Returns true on success. + * {@inheritdoc} + * @param int $distortion + * @param array $arguments + * @param bool $bestfit */ - public function distortImage (int $method, array $arguments, bool $bestfit): bool {} + public function distortImage (int $distortion, array $arguments, bool $bestfit): bool {} /** - * Writes an image to a filehandle - * @link http://www.php.net/manual/en/imagick.writeimagefile.php - * @param resource $filehandle - * @param string $format [optional] - * @return bool Returns true on success. + * {@inheritdoc} + * @param mixed $filehandle + * @param string|null $format [optional] */ - public function writeImageFile ($filehandle, string $format = null): bool {} + public function writeImageFile (mixed $filehandle = null, ?string $format = NULL): bool {} /** - * Writes frames to a filehandle - * @link http://www.php.net/manual/en/imagick.writeimagesfile.php - * @param resource $filehandle - * @param string $format [optional] - * @return bool Returns true on success. + * {@inheritdoc} + * @param mixed $filehandle + * @param string|null $format [optional] */ - public function writeImagesFile ($filehandle, string $format = null): bool {} + public function writeImagesFile (mixed $filehandle = null, ?string $format = NULL): bool {} /** - * Reset image page - * @link http://www.php.net/manual/en/imagick.resetimagepage.php - * @param string $page - * @return bool Returns true on success. + * {@inheritdoc} + * @param string $page */ public function resetImagePage (string $page): bool {} /** - * Animates an image or images - * @link http://www.php.net/manual/en/imagick.animateimages.php - * @param string $x_server - * @return bool Returns true on success. + * {@inheritdoc} + * @param string $x_server */ public function animateImages (string $x_server): bool {} /** - * Sets font - * @link http://www.php.net/manual/en/imagick.setfont.php - * @param string $font - * @return bool Returns true on success. + * {@inheritdoc} + * @param string $font */ public function setFont (string $font): bool {} /** - * Gets font - * @link http://www.php.net/manual/en/imagick.getfont.php - * @return string Returns the string containing the font name or false if not font is set. + * {@inheritdoc} */ public function getFont (): string {} /** - * Sets point size - * @link http://www.php.net/manual/en/imagick.setpointsize.php - * @param float $point_size - * @return bool Returns true on success. + * {@inheritdoc} + * @param float $point_size */ public function setPointSize (float $point_size): bool {} /** - * Gets point size - * @link http://www.php.net/manual/en/imagick.getpointsize.php - * @return float Returns a float containing the point size. + * {@inheritdoc} */ public function getPointSize (): float {} /** - * Merges image layers - * @link http://www.php.net/manual/en/imagick.mergeimagelayers.php - * @param int $layer_method - * @return Imagick Returns an Imagick object containing the merged image. + * {@inheritdoc} + * @param int $layermethod */ - public function mergeImageLayers (int $layer_method): Imagick {} + public function mergeImageLayers (int $layermethod): Imagick {} /** - * Sets image alpha channel - * @link http://www.php.net/manual/en/imagick.setimagealphachannel.php - * @param int $mode - * @return bool Returns true on success. + * {@inheritdoc} + * @param int $alphachannel */ - public function setImageAlphaChannel (int $mode): bool {} + public function setImageAlphaChannel (int $alphachannel): bool {} /** - * Changes the color value of any pixel that matches target - * @link http://www.php.net/manual/en/imagick.floodfillpaintimage.php - * @param mixed $fill - * @param float $fuzz - * @param mixed $target - * @param int $x - * @param int $y - * @param bool $invert - * @param int $channel [optional] - * @return bool Returns true on success. + * {@inheritdoc} + * @param ImagickPixel|string $fill_color + * @param float $fuzz + * @param ImagickPixel|string $border_color + * @param int $x + * @param int $y + * @param bool $invert + * @param int|null $channel [optional] */ - public function floodfillPaintImage (mixed $fill, float $fuzz, mixed $target, int $x, int $y, bool $invert, int $channel = \Imagick::CHANNEL_DEFAULT): bool {} + public function floodfillPaintImage (ImagickPixel|string $fill_color, float $fuzz, ImagickPixel|string $border_color, int $x, int $y, bool $invert, ?int $channel = 134217727): bool {} /** - * Changes the color value of any pixel that matches target - * @link http://www.php.net/manual/en/imagick.opaquepaintimage.php - * @param mixed $target - * @param mixed $fill - * @param float $fuzz - * @param bool $invert - * @param int $channel [optional] - * @return bool Returns true on success. + * {@inheritdoc} + * @param ImagickPixel|string $target_color + * @param ImagickPixel|string $fill_color + * @param float $fuzz + * @param bool $invert + * @param int $channel [optional] */ - public function opaquePaintImage (mixed $target, mixed $fill, float $fuzz, bool $invert, int $channel = \Imagick::CHANNEL_DEFAULT): bool {} + public function opaquePaintImage (ImagickPixel|string $target_color, ImagickPixel|string $fill_color, float $fuzz, bool $invert, int $channel = 134217727): bool {} /** - * Paints pixels transparent - * @link http://www.php.net/manual/en/imagick.transparentpaintimage.php - * @param mixed $target - * @param float $alpha - * @param float $fuzz - * @param bool $invert - * @return bool Returns true on success. + * {@inheritdoc} + * @param ImagickPixel|string $target_color + * @param float $alpha + * @param float $fuzz + * @param bool $invert */ - public function transparentPaintImage (mixed $target, float $alpha, float $fuzz, bool $invert): bool {} + public function transparentPaintImage (ImagickPixel|string $target_color, float $alpha, float $fuzz, bool $invert): bool {} /** - * Animates an image or images - * @link http://www.php.net/manual/en/imagick.liquidrescaleimage.php - * @param int $width - * @param int $height - * @param float $delta_x - * @param float $rigidity - * @return bool Returns true on success. + * {@inheritdoc} + * @param int $width + * @param int $height + * @param float $delta_x + * @param float $rigidity */ public function liquidRescaleImage (int $width, int $height, float $delta_x, float $rigidity): bool {} /** - * Enciphers an image - * @link http://www.php.net/manual/en/imagick.encipherimage.php - * @param string $passphrase - * @return bool Returns true on success. + * {@inheritdoc} + * @param string $passphrase */ public function encipherImage (string $passphrase): bool {} /** - * Deciphers an image - * @link http://www.php.net/manual/en/imagick.decipherimage.php - * @param string $passphrase - * @return bool Returns true on success. + * {@inheritdoc} + * @param string $passphrase */ public function decipherImage (string $passphrase): bool {} /** - * Sets the gravity - * @link http://www.php.net/manual/en/imagick.setgravity.php - * @param int $gravity - * @return bool No value is returned. + * {@inheritdoc} + * @param int $gravity */ public function setGravity (int $gravity): bool {} /** - * Gets the gravity - * @link http://www.php.net/manual/en/imagick.getgravity.php - * @return int Returns the gravity property. Refer to the list of - * gravity constants. + * {@inheritdoc} */ public function getGravity (): int {} /** - * Gets channel range - * @link http://www.php.net/manual/en/imagick.getimagechannelrange.php - * @param int $channel - * @return array Returns an array containing minima and maxima values of the channel(s). + * {@inheritdoc} + * @param int $channel */ public function getImageChannelRange (int $channel): array {} /** - * Checks if the image has an alpha channel - * @link http://www.php.net/manual/en/imagick.getimagealphachannel.php - * @return bool Returns true if the image has an alpha channel value and false if not, - * i.e. the image is RGB rather than RGBA - * or CMYK rather than CMYKA. + * {@inheritdoc} */ public function getImageAlphaChannel (): bool {} /** - * Gets channel distortions - * @link http://www.php.net/manual/en/imagick.getimagechanneldistortions.php - * @param Imagick $reference - * @param int $metric - * @param int $channel [optional] - * @return float Returns a float describing the channel distortion. + * {@inheritdoc} + * @param Imagick $reference_image + * @param int $metric + * @param int $channel [optional] */ - public function getImageChannelDistortions (Imagick $reference, int $metric, int $channel = \Imagick::CHANNEL_DEFAULT): float {} + public function getImageChannelDistortions (Imagick $reference_image, int $metric, int $channel = 134217727): float {} /** - * Sets the image gravity - * @link http://www.php.net/manual/en/imagick.setimagegravity.php - * @param int $gravity - * @return bool No value is returned. + * {@inheritdoc} + * @param int $gravity */ public function setImageGravity (int $gravity): bool {} /** - * Gets the image gravity - * @link http://www.php.net/manual/en/imagick.getimagegravity.php - * @return int Returns the images gravity property. Refer to the list of - * gravity constants. + * {@inheritdoc} */ public function getImageGravity (): int {} /** - * Imports image pixels - * @link http://www.php.net/manual/en/imagick.importimagepixels.php - * @param int $x - * @param int $y - * @param int $width - * @param int $height - * @param string $map - * @param int $storage - * @param array $pixels - * @return bool Returns true on success. + * {@inheritdoc} + * @param int $x + * @param int $y + * @param int $width + * @param int $height + * @param string $map + * @param int $pixelstorage + * @param array $pixels */ - public function importImagePixels (int $x, int $y, int $width, int $height, string $map, int $storage, array $pixels): bool {} + public function importImagePixels (int $x, int $y, int $width, int $height, string $map, int $pixelstorage, array $pixels): bool {} /** - * Removes skew from the image - * @link http://www.php.net/manual/en/imagick.deskewimage.php - * @param float $threshold - * @return bool + * {@inheritdoc} + * @param float $threshold */ public function deskewImage (float $threshold): bool {} /** - * Segments an image - * @link http://www.php.net/manual/en/imagick.segmentimage.php - * @param int $COLORSPACE - * @param float $cluster_threshold - * @param float $smooth_threshold - * @param bool $verbose [optional] - * @return bool + * {@inheritdoc} + * @param int $colorspace + * @param float $cluster_threshold + * @param float $smooth_threshold + * @param bool $verbose [optional] */ - public function segmentImage (int $COLORSPACE, float $cluster_threshold, float $smooth_threshold, bool $verbose = false): bool {} + public function segmentImage (int $colorspace, float $cluster_threshold, float $smooth_threshold, bool $verbose = false): bool {} /** - * Interpolates colors - * @link http://www.php.net/manual/en/imagick.sparsecolorimage.php - * @param int $SPARSE_METHOD - * @param array $arguments - * @param int $channel [optional] - * @return bool Returns true on success. + * {@inheritdoc} + * @param int $sparsecolormethod + * @param array $arguments + * @param int $channel [optional] */ - public function sparseColorImage (int $SPARSE_METHOD, array $arguments, int $channel = \Imagick::CHANNEL_DEFAULT): bool {} + public function sparseColorImage (int $sparsecolormethod, array $arguments, int $channel = 134217727): bool {} /** - * Remaps image colors - * @link http://www.php.net/manual/en/imagick.remapimage.php - * @param Imagick $replacement - * @param int $DITHER - * @return bool Returns true on success. + * {@inheritdoc} + * @param Imagick $replacement + * @param int $dither_method */ - public function remapImage (Imagick $replacement, int $DITHER): bool {} + public function remapImage (Imagick $replacement, int $dither_method): bool {} /** * {@inheritdoc} @@ -1671,353 +1418,265 @@ public function remapImage (Imagick $replacement, int $DITHER): bool {} public function houghLineImage (int $width, int $height, float $threshold): bool {} /** - * Exports raw image pixels - * @link http://www.php.net/manual/en/imagick.exportimagepixels.php - * @param int $x - * @param int $y - * @param int $width - * @param int $height - * @param string $map - * @param int $STORAGE - * @return array Returns an array containing the pixels values. + * {@inheritdoc} + * @param int $x + * @param int $y + * @param int $width + * @param int $height + * @param string $map + * @param int $pixelstorage */ - public function exportImagePixels (int $x, int $y, int $width, int $height, string $map, int $STORAGE): array {} + public function exportImagePixels (int $x, int $y, int $width, int $height, string $map, int $pixelstorage): array {} /** - * The getImageChannelKurtosis purpose - * @link http://www.php.net/manual/en/imagick.getimagechannelkurtosis.php - * @param int $channel [optional] - * @return array Returns an array with kurtosis and skewness - * members. + * {@inheritdoc} + * @param int $channel [optional] */ - public function getImageChannelKurtosis (int $channel = \Imagick::CHANNEL_DEFAULT): array {} + public function getImageChannelKurtosis (int $channel = 134217727): array {} /** - * Applies a function on the image - * @link http://www.php.net/manual/en/imagick.functionimage.php - * @param int $function - * @param array $arguments - * @param int $channel [optional] - * @return bool Returns true on success. + * {@inheritdoc} + * @param int $function + * @param array $parameters + * @param int $channel [optional] */ - public function functionImage (int $function, array $arguments, int $channel = \Imagick::CHANNEL_DEFAULT): bool {} + public function functionImage (int $function, array $parameters, int $channel = 134217727): bool {} /** - * Transforms an image to a new colorspace - * @link http://www.php.net/manual/en/imagick.transformimagecolorspace.php - * @param int $colorspace The colorspace the image should be transformed to, one of the COLORSPACE constants e.g. Imagick::COLORSPACE_CMYK. - * @return bool Returns true on success. + * {@inheritdoc} + * @param int $colorspace */ public function transformImageColorspace (int $colorspace): bool {} /** - * Replaces colors in the image - * @link http://www.php.net/manual/en/imagick.haldclutimage.php - * @param Imagick $clut - * @param int $channel [optional] - * @return bool Returns true on success. + * {@inheritdoc} + * @param Imagick $clut + * @param int $channel [optional] */ - public function haldClutImage (Imagick $clut, int $channel = \Imagick::CHANNEL_DEFAULT): bool {} + public function haldClutImage (Imagick $clut, int $channel = 134217727): bool {} /** - * Adjusts the levels of a particular image channel - * @link http://www.php.net/manual/en/imagick.autolevelimage.php - * @param int $channel [optional] Which channel should the auto-levelling should be done on. - * @return bool Returns true on success. + * {@inheritdoc} + * @param int $channel [optional] */ - public function autoLevelImage (int $channel = \Imagick::CHANNEL_DEFAULT): bool {} + public function autoLevelImage (int $channel = 134217727): bool {} /** - * Mutes the colors of the image - * @link http://www.php.net/manual/en/imagick.blueshiftimage.php - * @param float $factor [optional] - * @return bool Returns true on success. + * {@inheritdoc} + * @param float $factor [optional] */ public function blueShiftImage (float $factor = 1.5): bool {} /** - * Get image artifact - * @link http://www.php.net/manual/en/imagick.getimageartifact.php - * @param string $artifact - * @return string Returns the artifact value on success. + * {@inheritdoc} + * @param string $artifact */ - public function getImageArtifact (string $artifact): string {} + public function getImageArtifact (string $artifact): ?string {} /** - * Set image artifact - * @link http://www.php.net/manual/en/imagick.setimageartifact.php - * @param string $artifact - * @param string $value - * @return bool Returns true on success. + * {@inheritdoc} + * @param string $artifact + * @param string|null $value */ - public function setImageArtifact (string $artifact, string $value): bool {} + public function setImageArtifact (string $artifact, ?string $value = null): bool {} /** - * Delete image artifact - * @link http://www.php.net/manual/en/imagick.deleteimageartifact.php - * @param string $artifact - * @return bool Returns true on success. + * {@inheritdoc} + * @param string $artifact */ public function deleteImageArtifact (string $artifact): bool {} /** - * Gets the colorspace - * @link http://www.php.net/manual/en/imagick.getcolorspace.php - * @return int Returns an integer which can be compared against COLORSPACE constants. + * {@inheritdoc} */ public function getColorspace (): int {} /** - * Set colorspace - * @link http://www.php.net/manual/en/imagick.setcolorspace.php - * @param int $COLORSPACE - * @return bool Returns true on success. + * {@inheritdoc} + * @param int $colorspace */ - public function setColorspace (int $COLORSPACE): bool {} + public function setColorspace (int $colorspace): bool {} /** - * Restricts the color range from 0 to the quantum depth. - * @link http://www.php.net/manual/en/imagick.clampimage.php - * @param int $channel [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $channel [optional] */ - public function clampImage (int $channel = \Imagick::CHANNEL_DEFAULT): bool {} + public function clampImage (int $channel = 134217727): bool {} /** - * Takes all images from the current image pointer to the end of the image list and smushs them - * @link http://www.php.net/manual/en/imagick.smushimages.php - * @param bool $stack - * @param int $offset - * @return Imagick The new smushed image. + * {@inheritdoc} + * @param bool $stack + * @param int $offset */ public function smushImages (bool $stack, int $offset): Imagick {} /** - * The Imagick constructor - * @link http://www.php.net/manual/en/imagick.construct.php - * @param mixed $files [optional] The path to an image to load or an array of paths. Paths can include - * wildcards for file names, or can be URLs. - * @return mixed + * {@inheritdoc} + * @param array|string|int|float|null $files [optional] */ - public function __construct (mixed $files = null): mixed {} + public function __construct (array|string|int|float|null $files = NULL) {} /** - * Returns the image as a string - * @link http://www.php.net/manual/en/imagick.tostring.php - * @return string Returns the string content on success or an empty string on failure. + * {@inheritdoc} */ public function __toString (): string {} /** - * Get the number of images - * @link http://www.php.net/manual/en/imagick.count.php - * @param int $mode [optional] An unused argument. Currently there is a non-particularly well defined feature in PHP where calling count() on a countable object might (or might not) require this method to accept a parameter. This parameter is here to be conformant with the interface of countable, even though the param is not used. - * @return int Returns the number of images. + * {@inheritdoc} + * @param int $mode [optional] */ - public function count (int $mode = null): int {} + public function count (int $mode = 0): int {} /** - * Returns a MagickPixelIterator - * @link http://www.php.net/manual/en/imagick.getpixeliterator.php - * @return ImagickPixelIterator Returns an ImagickPixelIterator on success. + * {@inheritdoc} */ public function getPixelIterator (): ImagickPixelIterator {} /** - * Get an ImagickPixelIterator for an image section - * @link http://www.php.net/manual/en/imagick.getpixelregioniterator.php - * @param int $x - * @param int $y - * @param int $columns - * @param int $rows - * @return ImagickPixelIterator Returns an ImagickPixelIterator for an image section. + * {@inheritdoc} + * @param int $x + * @param int $y + * @param int $columns + * @param int $rows */ public function getPixelRegionIterator (int $x, int $y, int $columns, int $rows): ImagickPixelIterator {} /** - * Reads image from filename - * @link http://www.php.net/manual/en/imagick.readimage.php - * @param string $filename - * @return bool Returns true on success. + * {@inheritdoc} + * @param string $filename */ public function readImage (string $filename): bool {} /** - * Reads image from an array of filenames - * @link http://www.php.net/manual/en/imagick.readimages.php - * @param array $filenames - * @return bool Returns true on success. + * {@inheritdoc} + * @param array $filenames */ public function readImages (array $filenames): bool {} /** - * Reads image from a binary string - * @link http://www.php.net/manual/en/imagick.readimageblob.php - * @param string $image - * @param string $filename [optional] - * @return bool Returns true on success. + * {@inheritdoc} + * @param string $image + * @param string|null $filename [optional] */ - public function readImageBlob (string $image, string $filename = null): bool {} + public function readImageBlob (string $image, ?string $filename = NULL): bool {} /** - * Sets the format of a particular image - * @link http://www.php.net/manual/en/imagick.setimageformat.php - * @param string $format - * @return bool Returns true on success. + * {@inheritdoc} + * @param string $format */ public function setImageFormat (string $format): bool {} /** - * Scales the size of an image - * @link http://www.php.net/manual/en/imagick.scaleimage.php - * @param int $cols - * @param int $rows - * @param bool $bestfit [optional] - * @param bool $legacy [optional] - * @return bool Returns true on success. + * {@inheritdoc} + * @param int $columns + * @param int $rows + * @param bool $bestfit [optional] + * @param bool $legacy [optional] */ - public function scaleImage (int $cols, int $rows, bool $bestfit = false, bool $legacy = false): bool {} + public function scaleImage (int $columns, int $rows, bool $bestfit = false, bool $legacy = false): bool {} /** - * Writes an image to the specified filename - * @link http://www.php.net/manual/en/imagick.writeimage.php - * @param string $filename [optional] - * @return bool Returns true on success. + * {@inheritdoc} + * @param string|null $filename [optional] */ - public function writeImage (string $filename = NULL): bool {} + public function writeImage (?string $filename = NULL): bool {} /** - * Writes an image or image sequence - * @link http://www.php.net/manual/en/imagick.writeimages.php - * @param string $filename - * @param bool $adjoin - * @return bool Returns true on success. + * {@inheritdoc} + * @param string $filename + * @param bool $adjoin */ public function writeImages (string $filename, bool $adjoin): bool {} /** - * Adds blur filter to image - * @link http://www.php.net/manual/en/imagick.blurimage.php - * @param float $radius - * @param float $sigma - * @param int $channel [optional] - * @return bool Returns true on success. + * {@inheritdoc} + * @param float $radius + * @param float $sigma + * @param int $channel [optional] */ - public function blurImage (float $radius, float $sigma, int $channel = null): bool {} + public function blurImage (float $radius, float $sigma, int $channel = 134217727): bool {} /** - * Changes the size of an image - * @link http://www.php.net/manual/en/imagick.thumbnailimage.php - * @param int $columns - * @param int $rows - * @param bool $bestfit [optional] - * @param bool $fill [optional] - * @param bool $legacy [optional] - * @return bool Returns true on success. + * {@inheritdoc} + * @param int|null $columns + * @param int|null $rows + * @param bool $bestfit [optional] + * @param bool $fill [optional] + * @param bool $legacy [optional] */ - public function thumbnailImage (int $columns, int $rows, bool $bestfit = false, bool $fill = false, bool $legacy = false): bool {} + public function thumbnailImage (?int $columns = null, ?int $rows = null, bool $bestfit = false, bool $fill = false, bool $legacy = false): bool {} /** - * Creates a crop thumbnail - * @link http://www.php.net/manual/en/imagick.cropthumbnailimage.php - * @param int $width - * @param int $height - * @param bool $legacy [optional] - * @return bool Returns true on success. + * {@inheritdoc} + * @param int $width + * @param int $height + * @param bool $legacy [optional] */ public function cropThumbnailImage (int $width, int $height, bool $legacy = false): bool {} /** - * Returns the filename of a particular image in a sequence - * @link http://www.php.net/manual/en/imagick.getimagefilename.php - * @return string Returns a string with the filename of the image. + * {@inheritdoc} */ public function getImageFilename (): string {} /** - * Sets the filename of a particular image - * @link http://www.php.net/manual/en/imagick.setimagefilename.php - * @param string $filename - * @return bool Returns true on success. + * {@inheritdoc} + * @param string $filename */ public function setImageFilename (string $filename): bool {} /** - * Returns the format of a particular image in a sequence - * @link http://www.php.net/manual/en/imagick.getimageformat.php - * @return string Returns a string containing the image format on success. + * {@inheritdoc} */ public function getImageFormat (): string {} /** - * Returns the image mime-type - * @link http://www.php.net/manual/en/imagick.getimagemimetype.php - * @return string + * {@inheritdoc} */ public function getImageMimeType (): string {} /** - * Removes an image from the image list - * @link http://www.php.net/manual/en/imagick.removeimage.php - * @return bool Returns true on success. + * {@inheritdoc} */ public function removeImage (): bool {} /** - * Destroys the Imagick object - * @link http://www.php.net/manual/en/imagick.destroy.php - * @return bool Returns true on success. + * {@inheritdoc} */ public function destroy (): bool {} /** - * Clears all resources associated to Imagick object - * @link http://www.php.net/manual/en/imagick.clear.php - * @return bool Returns true on success. + * {@inheritdoc} */ public function clear (): bool {} /** - * Makes an exact copy of the Imagick object - * @link http://www.php.net/manual/en/imagick.clone.php - * @return Imagick A copy of the Imagick object is returned. + * {@inheritdoc} */ public function clone (): Imagick {} /** - * Returns the image length in bytes - * @link http://www.php.net/manual/en/imagick.getimagesize.php - * @return int Returns an int containing the current image size. - * @deprecated 1 + * {@inheritdoc} */ public function getImageSize (): int {} /** - * Returns the image sequence as a blob - * @link http://www.php.net/manual/en/imagick.getimageblob.php - * @return string Returns a string containing the image. + * {@inheritdoc} */ public function getImageBlob (): string {} /** - * Returns all image sequences as a blob - * @link http://www.php.net/manual/en/imagick.getimagesblob.php - * @return string Returns a string containing the images. On failure, throws - * ImagickException. + * {@inheritdoc} */ public function getImagesBlob (): string {} /** - * Sets the Imagick iterator to the first image - * @link http://www.php.net/manual/en/imagick.setfirstiterator.php - * @return bool Returns true on success. + * {@inheritdoc} */ public function setFirstIterator (): bool {} /** - * Sets the Imagick iterator to the last image - * @link http://www.php.net/manual/en/imagick.setlastiterator.php - * @return bool Returns true on success. + * {@inheritdoc} */ public function setLastIterator (): bool {} @@ -2027,243 +1686,184 @@ public function setLastIterator (): bool {} public function resetIterator (): void {} /** - * Move to the previous image in the object - * @link http://www.php.net/manual/en/imagick.previousimage.php - * @return bool Returns true on success. + * {@inheritdoc} */ public function previousImage (): bool {} /** - * Moves to the next image - * @link http://www.php.net/manual/en/imagick.nextimage.php - * @return bool Returns true on success. + * {@inheritdoc} */ public function nextImage (): bool {} /** - * Checks if the object has a previous image - * @link http://www.php.net/manual/en/imagick.haspreviousimage.php - * @return bool Returnsfalse if there are none. + * {@inheritdoc} */ public function hasPreviousImage (): bool {} /** - * Checks if the object has more images - * @link http://www.php.net/manual/en/imagick.hasnextimage.php - * @return bool Returns
false if there are none. + * {@inheritdoc} */ public function hasNextImage (): bool {} /** - * Set the iterator position - * @link http://www.php.net/manual/en/imagick.setimageindex.php - * @param int $index - * @return bool Returns true on success. - * @deprecated 1 + * {@inheritdoc} + * @param int $index */ public function setImageIndex (int $index): bool {} /** - * Gets the index of the current active image - * @link http://www.php.net/manual/en/imagick.getimageindex.php - * @return int Returns an integer containing the index of the image in the stack. - * @deprecated 1 + * {@inheritdoc} */ public function getImageIndex (): int {} /** - * Adds a comment to your image - * @link http://www.php.net/manual/en/imagick.commentimage.php - * @param string $comment - * @return bool Returns true on success. + * {@inheritdoc} + * @param string $comment */ public function commentImage (string $comment): bool {} /** - * Extracts a region of the image - * @link http://www.php.net/manual/en/imagick.cropimage.php - * @param int $width - * @param int $height - * @param int $x - * @param int $y - * @return bool Returns true on success. + * {@inheritdoc} + * @param int $width + * @param int $height + * @param int $x + * @param int $y */ public function cropImage (int $width, int $height, int $x, int $y): bool {} /** - * Adds a label to an image - * @link http://www.php.net/manual/en/imagick.labelimage.php - * @param string $label - * @return bool Returns true on success. + * {@inheritdoc} + * @param string $label */ public function labelImage (string $label): bool {} /** - * Gets the width and height as an associative array - * @link http://www.php.net/manual/en/imagick.getimagegeometry.php - * @return array Returns an array with the width/height of the image. + * {@inheritdoc} */ public function getImageGeometry (): array {} /** - * Renders the ImagickDraw object on the current image - * @link http://www.php.net/manual/en/imagick.drawimage.php - * @param ImagickDraw $draw - * @return bool Returns true on success. + * {@inheritdoc} + * @param ImagickDraw $drawing */ - public function drawImage (ImagickDraw $draw): bool {} + public function drawImage (ImagickDraw $drawing): bool {} /** - * Sets the image compression quality - * @link http://www.php.net/manual/en/imagick.setimagecompressionquality.php - * @param int $quality - * @return bool Returns true on success. + * {@inheritdoc} + * @param int $quality */ public function setImageCompressionQuality (int $quality): bool {} /** - * Gets the current image's compression quality - * @link http://www.php.net/manual/en/imagick.getimagecompressionquality.php - * @return int Returns integer describing the images compression quality + * {@inheritdoc} */ public function getImageCompressionQuality (): int {} /** - * Sets the image compression - * @link http://www.php.net/manual/en/imagick.setimagecompression.php - * @param int $compression - * @return bool Returns true on success. + * {@inheritdoc} + * @param int $compression */ public function setImageCompression (int $compression): bool {} /** - * Gets the current image's compression type - * @link http://www.php.net/manual/en/imagick.getimagecompression.php - * @return int Returns the compression constant + * {@inheritdoc} */ public function getImageCompression (): int {} /** - * Annotates an image with text - * @link http://www.php.net/manual/en/imagick.annotateimage.php - * @param ImagickDraw $draw_settings - * @param float $x - * @param float $y - * @param float $angle - * @param string $text - * @return bool Returns true on success. + * {@inheritdoc} + * @param ImagickDraw $settings + * @param float $x + * @param float $y + * @param float $angle + * @param string $text */ - public function annotateImage (ImagickDraw $draw_settings, float $x, float $y, float $angle, string $text): bool {} + public function annotateImage (ImagickDraw $settings, float $x, float $y, float $angle, string $text): bool {} /** - * Composite one image onto another - * @link http://www.php.net/manual/en/imagick.compositeimage.php - * @param Imagick $composite_object - * @param int $composite - * @param int $x - * @param int $y - * @param int $channel [optional] - * @return bool Returns true on success. + * {@inheritdoc} + * @param Imagick $composite_image + * @param int $composite + * @param int $x + * @param int $y + * @param int $channel [optional] */ - public function compositeImage (Imagick $composite_object, int $composite, int $x, int $y, int $channel = \Imagick::CHANNEL_DEFAULT): bool {} + public function compositeImage (Imagick $composite_image, int $composite, int $x, int $y, int $channel = 134217727): bool {} /** - * Control the brightness, saturation, and hue - * @link http://www.php.net/manual/en/imagick.modulateimage.php - * @param float $brightness - * @param float $saturation - * @param float $hue - * @return bool Returns true on success. + * {@inheritdoc} + * @param float $brightness + * @param float $saturation + * @param float $hue */ public function modulateImage (float $brightness, float $saturation, float $hue): bool {} /** - * Gets the number of unique colors in the image - * @link http://www.php.net/manual/en/imagick.getimagecolors.php - * @return int Returns an int, the number of unique colors in the image. + * {@inheritdoc} */ public function getImageColors (): int {} /** - * Creates a composite image - * @link http://www.php.net/manual/en/imagick.montageimage.php - * @param ImagickDraw $draw - * @param string $tile_geometry - * @param string $thumbnail_geometry - * @param int $mode - * @param string $frame - * @return Imagick Creates a composite image and returns it as a new Imagick object. + * {@inheritdoc} + * @param ImagickDraw $settings + * @param string $tile_geometry + * @param string $thumbnail_geometry + * @param int $monatgemode + * @param string $frame */ - public function montageImage (ImagickDraw $draw, string $tile_geometry, string $thumbnail_geometry, int $mode, string $frame): Imagick {} + public function montageImage (ImagickDraw $settings, string $tile_geometry, string $thumbnail_geometry, int $monatgemode, string $frame): Imagick {} /** - * Identifies an image and fetches attributes - * @link http://www.php.net/manual/en/imagick.identifyimage.php - * @param bool $appendRawOutput [optional] - * @return array Identifies an image and returns the attributes. Attributes include - * the image width, height, size, and others. + * {@inheritdoc} + * @param bool $append_raw_output [optional] */ - public function identifyImage (bool $appendRawOutput = false): array {} + public function identifyImage (bool $append_raw_output = false): array {} /** - * Changes the value of individual pixels based on a threshold - * @link http://www.php.net/manual/en/imagick.thresholdimage.php - * @param float $threshold - * @param int $channel [optional] - * @return bool Returns true on success. + * {@inheritdoc} + * @param float $threshold + * @param int $channel [optional] */ - public function thresholdImage (float $threshold, int $channel = \Imagick::CHANNEL_DEFAULT): bool {} + public function thresholdImage (float $threshold, int $channel = 134217727): bool {} /** - * Selects a threshold for each pixel based on a range of intensity - * @link http://www.php.net/manual/en/imagick.adaptivethresholdimage.php - * @param int $width - * @param int $height - * @param int $offset - * @return bool Returns true on success. + * {@inheritdoc} + * @param int $width + * @param int $height + * @param int $offset */ public function adaptiveThresholdImage (int $width, int $height, int $offset): bool {} /** - * Forces all pixels below the threshold into black - * @link http://www.php.net/manual/en/imagick.blackthresholdimage.php - * @param mixed $threshold - * @return bool Returns true on success. + * {@inheritdoc} + * @param ImagickPixel|string $threshold_color */ - public function blackThresholdImage (mixed $threshold): bool {} + public function blackThresholdImage (ImagickPixel|string $threshold_color): bool {} /** - * Force all pixels above the threshold into white - * @link http://www.php.net/manual/en/imagick.whitethresholdimage.php - * @param mixed $threshold - * @return bool Returns true on success. + * {@inheritdoc} + * @param ImagickPixel|string $threshold_color */ - public function whiteThresholdImage (mixed $threshold): bool {} + public function whiteThresholdImage (ImagickPixel|string $threshold_color): bool {} /** - * Append a set of images - * @link http://www.php.net/manual/en/imagick.appendimages.php - * @param bool $stack - * @return Imagick Returns Imagick instance on success. + * {@inheritdoc} + * @param bool $stack */ public function appendImages (bool $stack): Imagick {} /** - * Simulates a charcoal drawing - * @link http://www.php.net/manual/en/imagick.charcoalimage.php - * @param float $radius - * @param float $sigma - * @return bool Returns true on success. + * {@inheritdoc} + * @param float $radius + * @param float $sigma */ public function charcoalImage (float $radius, float $sigma): bool {} /** - * Enhances the contrast of a color image - * @link http://www.php.net/manual/en/imagick.normalizeimage.php - * @param int $channel [optional] - * @return bool Returns true on success. + * {@inheritdoc} + * @param int $channel [optional] */ - public function normalizeImage (int $channel = \Imagick::CHANNEL_DEFAULT): bool {} + public function normalizeImage (int $channel = 134217727): bool {} /** * {@inheritdoc} @@ -2273,111 +1873,89 @@ public function normalizeImage (int $channel = \Imagick::CHANNEL_DEFAULT): bool public function oilPaintImageWithSigma (float $radius, float $sigma): bool {} /** - * Simulates an oil painting - * @link http://www.php.net/manual/en/imagick.oilpaintimage.php - * @param float $radius - * @return bool Returns true on success. + * {@inheritdoc} + * @param float $radius */ public function oilPaintImage (float $radius): bool {} /** - * Reduces the image to a limited number of color level - * @link http://www.php.net/manual/en/imagick.posterizeimage.php - * @param int $levels - * @param bool $dither - * @return bool Returns true on success. + * {@inheritdoc} + * @param int $levels + * @param bool $dither */ public function posterizeImage (int $levels, bool $dither): bool {} /** - * Creates a simulated 3d button-like effect - * @link http://www.php.net/manual/en/imagick.raiseimage.php - * @param int $width - * @param int $height - * @param int $x - * @param int $y - * @param bool $raise - * @return bool Returns true on success. + * {@inheritdoc} + * @param int $width + * @param int $height + * @param int $x + * @param int $y + * @param bool $raise */ public function raiseImage (int $width, int $height, int $x, int $y, bool $raise): bool {} /** - * Resample image to desired resolution - * @link http://www.php.net/manual/en/imagick.resampleimage.php - * @param float $x_resolution - * @param float $y_resolution - * @param int $filter - * @param float $blur - * @return bool Returns true on success. + * {@inheritdoc} + * @param float $x_resolution + * @param float $y_resolution + * @param int $filter + * @param float $blur */ public function resampleImage (float $x_resolution, float $y_resolution, int $filter, float $blur): bool {} /** - * Scales an image - * @link http://www.php.net/manual/en/imagick.resizeimage.php - * @param int $columns - * @param int $rows - * @param int $filter - * @param float $blur - * @param bool $bestfit [optional] - * @param bool $legacy [optional] - * @return bool Returns true on success. + * {@inheritdoc} + * @param int $columns + * @param int $rows + * @param int $filter + * @param float $blur + * @param bool $bestfit [optional] + * @param bool $legacy [optional] */ public function resizeImage (int $columns, int $rows, int $filter, float $blur, bool $bestfit = false, bool $legacy = false): bool {} /** - * Offsets an image - * @link http://www.php.net/manual/en/imagick.rollimage.php - * @param int $x - * @param int $y - * @return bool Returns true on success. + * {@inheritdoc} + * @param int $x + * @param int $y */ public function rollImage (int $x, int $y): bool {} /** - * Rotates an image - * @link http://www.php.net/manual/en/imagick.rotateimage.php - * @param mixed $background - * @param float $degrees - * @return bool Returns true on success. + * {@inheritdoc} + * @param ImagickPixel|string $background_color + * @param float $degrees */ - public function rotateImage (mixed $background, float $degrees): bool {} + public function rotateImage (ImagickPixel|string $background_color, float $degrees): bool {} /** - * Scales an image with pixel sampling - * @link http://www.php.net/manual/en/imagick.sampleimage.php - * @param int $columns - * @param int $rows - * @return bool Returns true on success. + * {@inheritdoc} + * @param int $columns + * @param int $rows */ public function sampleImage (int $columns, int $rows): bool {} /** - * Applies a solarizing effect to the image - * @link http://www.php.net/manual/en/imagick.solarizeimage.php - * @param int $threshold - * @return bool Returns true on success. + * {@inheritdoc} + * @param int $threshold */ public function solarizeImage (int $threshold): bool {} /** - * Simulates an image shadow - * @link http://www.php.net/manual/en/imagick.shadowimage.php - * @param float $opacity - * @param float $sigma - * @param int $x - * @param int $y - * @return bool Returns true on success. + * {@inheritdoc} + * @param float $opacity + * @param float $sigma + * @param int $x + * @param int $y */ public function shadowImage (float $opacity, float $sigma, int $x, int $y): bool {} /** - * Sets the image background color - * @link http://www.php.net/manual/en/imagick.setimagebackgroundcolor.php - * @param mixed $background - * @return bool Returns true on success. + * {@inheritdoc} + * @param ImagickPixel|string $background_color */ - public function setImageBackgroundColor (mixed $background): bool {} + public function setImageBackgroundColor (ImagickPixel|string $background_color): bool {} /** * {@inheritdoc} @@ -2386,62 +1964,47 @@ public function setImageBackgroundColor (mixed $background): bool {} public function setImageChannelMask (int $channel): int {} /** - * Sets the image composite operator - * @link http://www.php.net/manual/en/imagick.setimagecompose.php - * @param int $compose - * @return bool Returns true on success. + * {@inheritdoc} + * @param int $compose */ public function setImageCompose (int $compose): bool {} /** - * Sets the image delay - * @link http://www.php.net/manual/en/imagick.setimagedelay.php - * @param int $delay - * @return bool Returns true on success. + * {@inheritdoc} + * @param int $delay */ public function setImageDelay (int $delay): bool {} /** - * Sets the image depth - * @link http://www.php.net/manual/en/imagick.setimagedepth.php - * @param int $depth - * @return bool Returns true on success. + * {@inheritdoc} + * @param int $depth */ public function setImageDepth (int $depth): bool {} /** - * Sets the image gamma - * @link http://www.php.net/manual/en/imagick.setimagegamma.php - * @param float $gamma - * @return bool Returns true on success. + * {@inheritdoc} + * @param float $gamma */ public function setImageGamma (float $gamma): bool {} /** - * Sets the image iterations - * @link http://www.php.net/manual/en/imagick.setimageiterations.php - * @param int $iterations - * @return bool Returns true on success. + * {@inheritdoc} + * @param int $iterations */ public function setImageIterations (int $iterations): bool {} /** - * Sets the image matte color - * @link http://www.php.net/manual/en/imagick.setimagemattecolor.php - * @param mixed $matte - * @return bool Returns true on success. - * @deprecated 1 + * {@inheritdoc} + * @param ImagickPixel|string $matte_color */ - public function setImageMatteColor (mixed $matte): bool {} + public function setImageMatteColor (ImagickPixel|string $matte_color): bool {} /** - * Sets the page geometry of the image - * @link http://www.php.net/manual/en/imagick.setimagepage.php - * @param int $width - * @param int $height - * @param int $x - * @param int $y - * @return bool Returns true on success. + * {@inheritdoc} + * @param int $width + * @param int $height + * @param int $x + * @param int $y */ public function setImagePage (int $width, int $height, int $x, int $y): bool {} @@ -2452,133 +2015,102 @@ public function setImagePage (int $width, int $height, int $x, int $y): bool {} public function setImageProgressMonitor (string $filename): bool {} /** - * Set a callback to be called during processing - * @link http://www.php.net/manual/en/imagick.setprogressmonitor.php - * @param callable $callback The progress function to call. It should return true if image processing should continue, or false if it should be cancelled. The offset parameter indicates the progress and the span parameter indicates the total amount of work needed to be done. - *
The values passed to the callback function are not consistent. In particular the span parameter can increase during image processing. Because of this calculating the percentage complete of an image operation is not trivial.
- * @return bool Returns true on success. + * {@inheritdoc} + * @param callable $callback */ public function setProgressMonitor (callable $callback): bool {} /** - * Sets the image resolution - * @link http://www.php.net/manual/en/imagick.setimageresolution.php - * @param float $x_resolution - * @param float $y_resolution - * @return bool Returns true on success. + * {@inheritdoc} + * @param float $x_resolution + * @param float $y_resolution */ public function setImageResolution (float $x_resolution, float $y_resolution): bool {} /** - * Sets the image scene - * @link http://www.php.net/manual/en/imagick.setimagescene.php - * @param int $scene - * @return bool Returns true on success. + * {@inheritdoc} + * @param int $scene */ public function setImageScene (int $scene): bool {} /** - * Sets the image ticks-per-second - * @link http://www.php.net/manual/en/imagick.setimagetickspersecond.php - * @param int $ticks_per_second - * @return bool Returns true on success. + * {@inheritdoc} + * @param int $ticks_per_second */ public function setImageTicksPerSecond (int $ticks_per_second): bool {} /** - * Sets the image type - * @link http://www.php.net/manual/en/imagick.setimagetype.php - * @param int $image_type - * @return bool Returns true on success. + * {@inheritdoc} + * @param int $image_type */ public function setImageType (int $image_type): bool {} /** - * Sets the image units of resolution - * @link http://www.php.net/manual/en/imagick.setimageunits.php - * @param int $units - * @return bool Returns true on success. + * {@inheritdoc} + * @param int $units */ public function setImageUnits (int $units): bool {} /** - * Sharpens an image - * @link http://www.php.net/manual/en/imagick.sharpenimage.php - * @param float $radius - * @param float $sigma - * @param int $channel [optional] - * @return bool Returns true on success. + * {@inheritdoc} + * @param float $radius + * @param float $sigma + * @param int $channel [optional] */ - public function sharpenImage (float $radius, float $sigma, int $channel = \Imagick::CHANNEL_DEFAULT): bool {} + public function sharpenImage (float $radius, float $sigma, int $channel = 134217727): bool {} /** - * Shaves pixels from the image edges - * @link http://www.php.net/manual/en/imagick.shaveimage.php - * @param int $columns - * @param int $rows - * @return bool Returns true on success. + * {@inheritdoc} + * @param int $columns + * @param int $rows */ public function shaveImage (int $columns, int $rows): bool {} /** - * Creating a parallelogram - * @link http://www.php.net/manual/en/imagick.shearimage.php - * @param mixed $background - * @param float $x_shear - * @param float $y_shear - * @return bool Returns true on success. + * {@inheritdoc} + * @param ImagickPixel|string $background_color + * @param float $x_shear + * @param float $y_shear */ - public function shearImage (mixed $background, float $x_shear, float $y_shear): bool {} + public function shearImage (ImagickPixel|string $background_color, float $x_shear, float $y_shear): bool {} /** - * Splices a solid color into the image - * @link http://www.php.net/manual/en/imagick.spliceimage.php - * @param int $width - * @param int $height - * @param int $x - * @param int $y - * @return bool Returns true on success. + * {@inheritdoc} + * @param int $width + * @param int $height + * @param int $x + * @param int $y */ public function spliceImage (int $width, int $height, int $x, int $y): bool {} /** - * Fetch basic attributes about the image - * @link http://www.php.net/manual/en/imagick.pingimage.php - * @param string $filename - * @return bool Returns true on success. + * {@inheritdoc} + * @param string $filename */ public function pingImage (string $filename): bool {} /** - * Reads image from open filehandle - * @link http://www.php.net/manual/en/imagick.readimagefile.php - * @param resource $filehandle - * @param string $fileName [optional] - * @return bool Returns true on success. + * {@inheritdoc} + * @param mixed $filehandle + * @param string|null $filename [optional] */ - public function readImageFile ($filehandle, string $fileName = null): bool {} + public function readImageFile (mixed $filehandle = null, ?string $filename = NULL): bool {} /** - * Displays an image - * @link http://www.php.net/manual/en/imagick.displayimage.php - * @param string $servername - * @return bool Returns true on success. + * {@inheritdoc} + * @param string $servername */ public function displayImage (string $servername): bool {} /** - * Displays an image or image sequence - * @link http://www.php.net/manual/en/imagick.displayimages.php - * @param string $servername - * @return bool Returns true on success. + * {@inheritdoc} + * @param string $servername */ public function displayImages (string $servername): bool {} /** - * Randomly displaces each pixel in a block - * @link http://www.php.net/manual/en/imagick.spreadimage.php - * @param float $radius - * @return bool Returns true on success. + * {@inheritdoc} + * @param float $radius */ public function spreadImage (float $radius): bool {} @@ -2590,10 +2122,8 @@ public function spreadImage (float $radius): bool {} public function spreadImageWithMethod (float $radius, int $interpolate_method): bool {} /** - * Swirls the pixels about the center of the image - * @link http://www.php.net/manual/en/imagick.swirlimage.php - * @param float $degrees - * @return bool Returns true on success. + * {@inheritdoc} + * @param float $degrees */ public function swirlImage (float $degrees): bool {} @@ -2605,55 +2135,43 @@ public function swirlImage (float $degrees): bool {} public function swirlImageWithMethod (float $degrees, int $interpolate_method): bool {} /** - * Strips an image of all profiles and comments - * @link http://www.php.net/manual/en/imagick.stripimage.php - * @return bool Returns true on success. + * {@inheritdoc} */ public function stripImage (): bool {} /** - * Returns formats supported by Imagick - * @link http://www.php.net/manual/en/imagick.queryformats.php - * @param string $pattern [optional] - * @return array Returns an array containing the formats supported by Imagick. + * {@inheritdoc} + * @param string $pattern [optional] */ - public static function queryFormats (string $pattern = '"*"'): array {} + public static function queryFormats (string $pattern = '*'): array {} /** - * Returns the configured fonts - * @link http://www.php.net/manual/en/imagick.queryfonts.php - * @param string $pattern [optional] - * @return array Returns an array containing the configured fonts. + * {@inheritdoc} + * @param string $pattern [optional] */ - public static function queryFonts (string $pattern = '"*"'): array {} + public static function queryFonts (string $pattern = '*'): array {} /** - * Returns an array representing the font metrics - * @link http://www.php.net/manual/en/imagick.queryfontmetrics.php - * @param ImagickDraw $properties - * @param string $text - * @param bool $multiline [optional] - * @return array Returns a multi-dimensional array representing the font metrics. + * {@inheritdoc} + * @param ImagickDraw $settings + * @param string $text + * @param bool|null $multiline [optional] */ - public function queryFontMetrics (ImagickDraw $properties, string $text, bool $multiline = null): array {} + public function queryFontMetrics (ImagickDraw $settings, string $text, ?bool $multiline = NULL): array {} /** - * Hides a digital watermark within the image - * @link http://www.php.net/manual/en/imagick.steganoimage.php - * @param Imagick $watermark_wand - * @param int $offset - * @return Imagick Returns true on success. + * {@inheritdoc} + * @param Imagick $watermark + * @param int $offset */ - public function steganoImage (Imagick $watermark_wand, int $offset): Imagick {} + public function steganoImage (Imagick $watermark, int $offset): Imagick {} /** - * Adds random noise to the image - * @link http://www.php.net/manual/en/imagick.addnoiseimage.php - * @param int $noise_type - * @param int $channel [optional] - * @return bool Returns true on success. + * {@inheritdoc} + * @param int $noise + * @param int $channel [optional] */ - public function addNoiseImage (int $noise_type, int $channel = \Imagick::CHANNEL_DEFAULT): bool {} + public function addNoiseImage (int $noise, int $channel = 134217727): bool {} /** * {@inheritdoc} @@ -2664,58 +2182,43 @@ public function addNoiseImage (int $noise_type, int $channel = \Imagick::CHANNEL public function addNoiseImageWithAttenuate (int $noise, float $attenuate, int $channel = 134217727): bool {} /** - * Simulates motion blur - * @link http://www.php.net/manual/en/imagick.motionblurimage.php - * @param float $radius - * @param float $sigma - * @param float $angle - * @param int $channel [optional] - * @return bool Returns true on success. + * {@inheritdoc} + * @param float $radius + * @param float $sigma + * @param float $angle + * @param int $channel [optional] */ - public function motionBlurImage (float $radius, float $sigma, float $angle, int $channel = \Imagick::CHANNEL_DEFAULT): bool {} + public function motionBlurImage (float $radius, float $sigma, float $angle, int $channel = 134217727): bool {} /** - * Method morphs a set of images - * @link http://www.php.net/manual/en/imagick.morphimages.php - * @param int $number_frames - * @return Imagick This method returns a new Imagick object on success. - * Throw an - * ImagickException on error. + * {@inheritdoc} + * @param int $number_frames */ public function morphImages (int $number_frames): Imagick {} /** - * Scales an image proportionally to half its size - * @link http://www.php.net/manual/en/imagick.minifyimage.php - * @return bool Returns true on success. + * {@inheritdoc} */ public function minifyImage (): bool {} /** - * Transforms an image - * @link http://www.php.net/manual/en/imagick.affinetransformimage.php - * @param ImagickDraw $matrix - * @return bool Returns true on success. + * {@inheritdoc} + * @param ImagickDraw $settings */ - public function affineTransformImage (ImagickDraw $matrix): bool {} + public function affineTransformImage (ImagickDraw $settings): bool {} /** - * Average a set of images - * @link http://www.php.net/manual/en/imagick.averageimages.php - * @return Imagick Returns a new Imagick object on success. - * @deprecated 1 + * {@inheritdoc} */ public function averageImages (): Imagick {} /** - * Surrounds the image with a border - * @link http://www.php.net/manual/en/imagick.borderimage.php - * @param mixed $bordercolor - * @param int $width - * @param int $height - * @return bool Returns true on success. + * {@inheritdoc} + * @param ImagickPixel|string $border_color + * @param int $width + * @param int $height */ - public function borderImage (mixed $bordercolor, int $width, int $height): bool {} + public function borderImage (ImagickPixel|string $border_color, int $width, int $height): bool {} /** * {@inheritdoc} @@ -2737,165 +2240,126 @@ public function borderImageWithComposite (ImagickPixel|string $border_color, int public static function calculateCrop (int $original_width, int $original_height, int $desired_width, int $desired_height, bool $legacy = false): array {} /** - * Removes a region of an image and trims - * @link http://www.php.net/manual/en/imagick.chopimage.php - * @param int $width - * @param int $height - * @param int $x - * @param int $y - * @return bool Returns true on success. + * {@inheritdoc} + * @param int $width + * @param int $height + * @param int $x + * @param int $y */ public function chopImage (int $width, int $height, int $x, int $y): bool {} /** - * Clips along the first path from the 8BIM profile - * @link http://www.php.net/manual/en/imagick.clipimage.php - * @return bool Returns true on success. + * {@inheritdoc} */ public function clipImage (): bool {} /** - * Clips along the named paths from the 8BIM profile - * @link http://www.php.net/manual/en/imagick.clippathimage.php - * @param string $pathname - * @param bool $inside - * @return bool Returns true on success. + * {@inheritdoc} + * @param string $pathname + * @param bool $inside */ public function clipPathImage (string $pathname, bool $inside): bool {} /** - * Clips along the named paths from the 8BIM profile, if present - * @link http://www.php.net/manual/en/imagick.clipimagepath.php - * @param string $pathname - * @param string $inside - * @return void + * {@inheritdoc} + * @param string $pathname + * @param bool $inside */ - public function clipImagePath (string $pathname, string $inside): void {} + public function clipImagePath (string $pathname, bool $inside): void {} /** - * Composites a set of images - * @link http://www.php.net/manual/en/imagick.coalesceimages.php - * @return Imagick Returns a new Imagick object on success. + * {@inheritdoc} */ public function coalesceImages (): Imagick {} /** - * Blends the fill color with the image - * @link http://www.php.net/manual/en/imagick.colorizeimage.php - * @param mixed $colorize - * @param mixed $opacity - * @param bool $legacy [optional] - * @return bool Returns true on success. + * {@inheritdoc} + * @param ImagickPixel|string $colorize_color + * @param ImagickPixel|string|false $opacity_color + * @param bool|null $legacy [optional] */ - public function colorizeImage (mixed $colorize, mixed $opacity, bool $legacy = false): bool {} + public function colorizeImage (ImagickPixel|string $colorize_color, ImagickPixel|string|false $opacity_color, ?bool $legacy = false): bool {} /** - * Returns the difference in one or more images - * @link http://www.php.net/manual/en/imagick.compareimagechannels.php - * @param Imagick $image - * @param int $channelType - * @param int $metricType - * @return array Array consisting of new_wand and - * distortion. + * {@inheritdoc} + * @param Imagick $reference + * @param int $channel + * @param int $metric */ - public function compareImageChannels (Imagick $image, int $channelType, int $metricType): array {} + public function compareImageChannels (Imagick $reference, int $channel, int $metric): array {} /** - * Compares an image to a reconstructed image - * @link http://www.php.net/manual/en/imagick.compareimages.php - * @param Imagick $compare - * @param int $metric - * @return array Returns an array containing a reconstructed image and the difference between images. + * {@inheritdoc} + * @param Imagick $reference + * @param int $metric */ - public function compareImages (Imagick $compare, int $metric): array {} + public function compareImages (Imagick $reference, int $metric): array {} /** - * Change the contrast of the image - * @link http://www.php.net/manual/en/imagick.contrastimage.php - * @param bool $sharpen - * @return bool Returns true on success. + * {@inheritdoc} + * @param bool $sharpen */ public function contrastImage (bool $sharpen): bool {} /** - * Combines one or more images into a single image - * @link http://www.php.net/manual/en/imagick.combineimages.php - * @param int $channelType - * @return Imagick Returns true on success. + * {@inheritdoc} + * @param int $colorspace */ - public function combineImages (int $channelType): Imagick {} + public function combineImages (int $colorspace): Imagick {} /** - * Applies a custom convolution kernel to the image - * @link http://www.php.net/manual/en/imagick.convolveimage.php - * @param array $kernel - * @param int $channel [optional] - * @return bool Returns true on success. + * {@inheritdoc} + * @param array $kernel + * @param int $channel [optional] */ - public function convolveImage (array $kernel, int $channel = \Imagick::CHANNEL_DEFAULT): bool {} + public function convolveImage (array $kernel, int $channel = 134217727): bool {} /** - * Displaces an image's colormap - * @link http://www.php.net/manual/en/imagick.cyclecolormapimage.php - * @param int $displace - * @return bool Returns true on success. + * {@inheritdoc} + * @param int $displace */ public function cycleColormapImage (int $displace): bool {} /** - * Returns certain pixel differences between images - * @link http://www.php.net/manual/en/imagick.deconstructimages.php - * @return Imagick Returns a new Imagick object on success. + * {@inheritdoc} */ public function deconstructImages (): Imagick {} /** - * Reduces the speckle noise in an image - * @link http://www.php.net/manual/en/imagick.despeckleimage.php - * @return bool Returns true on success. + * {@inheritdoc} */ public function despeckleImage (): bool {} /** - * Enhance edges within the image - * @link http://www.php.net/manual/en/imagick.edgeimage.php - * @param float $radius - * @return bool Returns true on success. + * {@inheritdoc} + * @param float $radius */ public function edgeImage (float $radius): bool {} /** - * Returns a grayscale image with a three-dimensional effect - * @link http://www.php.net/manual/en/imagick.embossimage.php - * @param float $radius - * @param float $sigma - * @return bool Returns true on success. + * {@inheritdoc} + * @param float $radius + * @param float $sigma */ public function embossImage (float $radius, float $sigma): bool {} /** - * Improves the quality of a noisy image - * @link http://www.php.net/manual/en/imagick.enhanceimage.php - * @return bool Returns true on success. + * {@inheritdoc} */ public function enhanceImage (): bool {} /** - * Equalizes the image histogram - * @link http://www.php.net/manual/en/imagick.equalizeimage.php - * @return bool Returns true on success. + * {@inheritdoc} */ public function equalizeImage (): bool {} /** - * Applies an expression to an image - * @link http://www.php.net/manual/en/imagick.evaluateimage.php - * @param int $op - * @param float $constant - * @param int $channel [optional] - * @return bool Returns true on success. + * {@inheritdoc} + * @param int $evaluate + * @param float $constant + * @param int $channel [optional] */ - public function evaluateImage (int $op, float $constant, int $channel = \Imagick::CHANNEL_DEFAULT): bool {} + public function evaluateImage (int $evaluate, float $constant, int $channel = 134217727): bool {} /** * {@inheritdoc} @@ -2904,46 +2368,35 @@ public function evaluateImage (int $op, float $constant, int $channel = \Imagick public function evaluateImages (int $evaluate): bool {} /** - * Merges a sequence of images - * @link http://www.php.net/manual/en/imagick.flattenimages.php - * @return Imagick Returns true on success. - * @deprecated 1 + * {@inheritdoc} */ public function flattenImages (): Imagick {} /** - * Creates a vertical mirror image - * @link http://www.php.net/manual/en/imagick.flipimage.php - * @return bool Returns true on success. + * {@inheritdoc} */ public function flipImage (): bool {} /** - * Creates a horizontal mirror image - * @link http://www.php.net/manual/en/imagick.flopimage.php - * @return bool Returns true on success. + * {@inheritdoc} */ public function flopImage (): bool {} /** - * Implements the discrete Fourier transform (DFT) - * @link http://www.php.net/manual/en/imagick.forwardfouriertransformimage.php - * @param bool $magnitude If true, return as magnitude / phase pair otherwise a real / imaginary image pair. - * @return bool Returns true on success. + * {@inheritdoc} + * @param bool $magnitude */ public function forwardFourierTransformImage (bool $magnitude): bool {} /** - * Adds a simulated three-dimensional border - * @link http://www.php.net/manual/en/imagick.frameimage.php - * @param mixed $matte_color - * @param int $width - * @param int $height - * @param int $inner_bevel - * @param int $outer_bevel - * @return bool Returns true on success. + * {@inheritdoc} + * @param ImagickPixel|string $matte_color + * @param int $width + * @param int $height + * @param int $inner_bevel + * @param int $outer_bevel */ - public function frameImage (mixed $matte_color, int $width, int $height, int $inner_bevel, int $outer_bevel): bool {} + public function frameImage (ImagickPixel|string $matte_color, int $width, int $height, int $inner_bevel, int $outer_bevel): bool {} /** * {@inheritdoc} @@ -2957,200 +2410,144 @@ public function frameImage (mixed $matte_color, int $width, int $height, int $in public function frameImageWithComposite (ImagickPixel|string $matte_color, int $width, int $height, int $inner_bevel, int $outer_bevel, int $composite): bool {} /** - * Evaluate expression for each pixel in the image - * @link http://www.php.net/manual/en/imagick.fximage.php - * @param string $expression - * @param int $channel [optional] - * @return Imagick Returns true on success. + * {@inheritdoc} + * @param string $expression + * @param int $channel [optional] */ - public function fxImage (string $expression, int $channel = \Imagick::CHANNEL_DEFAULT): Imagick {} + public function fxImage (string $expression, int $channel = 134217727): Imagick {} /** - * Gamma-corrects an image - * @link http://www.php.net/manual/en/imagick.gammaimage.php - * @param float $gamma - * @param int $channel [optional] - * @return bool Returns true on success. + * {@inheritdoc} + * @param float $gamma + * @param int $channel [optional] */ - public function gammaImage (float $gamma, int $channel = \Imagick::CHANNEL_DEFAULT): bool {} + public function gammaImage (float $gamma, int $channel = 134217727): bool {} /** - * Blurs an image - * @link http://www.php.net/manual/en/imagick.gaussianblurimage.php - * @param float $radius - * @param float $sigma - * @param int $channel [optional] - * @return bool Returns true on success. + * {@inheritdoc} + * @param float $radius + * @param float $sigma + * @param int $channel [optional] */ - public function gaussianBlurImage (float $radius, float $sigma, int $channel = \Imagick::CHANNEL_DEFAULT): bool {} + public function gaussianBlurImage (float $radius, float $sigma, int $channel = 134217727): bool {} /** - * Returns the image background color - * @link http://www.php.net/manual/en/imagick.getimagebackgroundcolor.php - * @return ImagickPixel Returns an ImagickPixel set to the background color of the image. + * {@inheritdoc} */ public function getImageBackgroundColor (): ImagickPixel {} /** - * Returns the chromaticy blue primary point - * @link http://www.php.net/manual/en/imagick.getimageblueprimary.php - * @return array Array consisting of "x" and "y" coordinates of point. + * {@inheritdoc} */ public function getImageBluePrimary (): array {} /** - * Returns the image border color - * @link http://www.php.net/manual/en/imagick.getimagebordercolor.php - * @return ImagickPixel Returns true on success. + * {@inheritdoc} */ public function getImageBorderColor (): ImagickPixel {} /** - * Gets the depth for a particular image channel - * @link http://www.php.net/manual/en/imagick.getimagechanneldepth.php - * @param int $channel - * @return int Returns true on success. + * {@inheritdoc} + * @param int $channel */ public function getImageChannelDepth (int $channel): int {} /** - * Compares image channels of an image to a reconstructed image - * @link http://www.php.net/manual/en/imagick.getimagechanneldistortion.php - * @param Imagick $reference - * @param int $channel - * @param int $metric - * @return float Returns true on success. + * {@inheritdoc} + * @param Imagick $reference + * @param int $channel + * @param int $metric */ public function getImageChannelDistortion (Imagick $reference, int $channel, int $metric): float {} /** - * Gets the mean and standard deviation - * @link http://www.php.net/manual/en/imagick.getimagechannelmean.php - * @param int $channel - * @return array Returns an array with "mean" and "standardDeviation" - * members. + * {@inheritdoc} + * @param int $channel */ public function getImageChannelMean (int $channel): array {} /** - * Returns statistics for each channel in the image - * @link http://www.php.net/manual/en/imagick.getimagechannelstatistics.php - * @return array Returns true on success. + * {@inheritdoc} */ public function getImageChannelStatistics (): array {} /** - * Returns the color of the specified colormap index - * @link http://www.php.net/manual/en/imagick.getimagecolormapcolor.php - * @param int $index - * @return ImagickPixel Returns true on success. + * {@inheritdoc} + * @param int $index */ public function getImageColormapColor (int $index): ImagickPixel {} /** - * Gets the image colorspace - * @link http://www.php.net/manual/en/imagick.getimagecolorspace.php - * @return int Returns an integer which can be compared against COLORSPACE constants. + * {@inheritdoc} */ public function getImageColorspace (): int {} /** - * Returns the composite operator associated with the image - * @link http://www.php.net/manual/en/imagick.getimagecompose.php - * @return int Returns true on success. + * {@inheritdoc} */ public function getImageCompose (): int {} /** - * Gets the image delay - * @link http://www.php.net/manual/en/imagick.getimagedelay.php - * @return int Returns the image delay. + * {@inheritdoc} */ public function getImageDelay (): int {} /** - * Gets the image depth - * @link http://www.php.net/manual/en/imagick.getimagedepth.php - * @return int The image depth. + * {@inheritdoc} */ public function getImageDepth (): int {} /** - * Compares an image to a reconstructed image - * @link http://www.php.net/manual/en/imagick.getimagedistortion.php - * @param MagickWand $reference - * @param int $metric - * @return float Returns the distortion metric used on the image (or the best guess - * thereof). + * {@inheritdoc} + * @param Imagick $reference + * @param int $metric */ - public function getImageDistortion ($reference, int $metric): float {} + public function getImageDistortion (Imagick $reference, int $metric): float {} /** - * Gets the image disposal method - * @link http://www.php.net/manual/en/imagick.getimagedispose.php - * @return int Returns the dispose method on success. + * {@inheritdoc} */ public function getImageDispose (): int {} /** - * Gets the image gamma - * @link http://www.php.net/manual/en/imagick.getimagegamma.php - * @return float Returns the image gamma on success. + * {@inheritdoc} */ public function getImageGamma (): float {} /** - * Returns the chromaticy green primary point - * @link http://www.php.net/manual/en/imagick.getimagegreenprimary.php - * @return array Returns an array with the keys "x" and "y" on success, throws an - * ImagickException on failure. + * {@inheritdoc} */ public function getImageGreenPrimary (): array {} /** - * Returns the image height - * @link http://www.php.net/manual/en/imagick.getimageheight.php - * @return int Returns the image height in pixels. + * {@inheritdoc} */ public function getImageHeight (): int {} /** - * Gets the image histogram - * @link http://www.php.net/manual/en/imagick.getimagehistogram.php - * @return array Returns the image histogram as an array of ImagickPixel objects. + * {@inheritdoc} */ public function getImageHistogram (): array {} /** - * Gets the image interlace scheme - * @link http://www.php.net/manual/en/imagick.getimageinterlacescheme.php - * @return int Returns the interlace scheme as an integer on success. - * Throw an - * ImagickException on error. + * {@inheritdoc} */ public function getImageInterlaceScheme (): int {} /** - * Gets the image iterations - * @link http://www.php.net/manual/en/imagick.getimageiterations.php - * @return int Returns the image iterations as an integer. + * {@inheritdoc} */ public function getImageIterations (): int {} /** - * Returns the page geometry - * @link http://www.php.net/manual/en/imagick.getimagepage.php - * @return array Returns the page geometry associated with the image in an array with the - * keys "width", "height", "x", and "y". + * {@inheritdoc} */ public function getImagePage (): array {} /** - * Returns the color of the specified pixel - * @link http://www.php.net/manual/en/imagick.getimagepixelcolor.php - * @param int $x - * @param int $y - * @return ImagickPixel Returns an ImagickPixel instance for the color at the coordinates given. + * {@inheritdoc} + * @param int $x + * @param int $y */ public function getImagePixelColor (int $x, int $y): ImagickPixel {} @@ -3163,150 +2560,88 @@ public function getImagePixelColor (int $x, int $y): ImagickPixel {} public function setImagePixelColor (int $x, int $y, ImagickPixel|string $color): ImagickPixel {} /** - * Returns the named image profile - * @link http://www.php.net/manual/en/imagick.getimageprofile.php - * @param string $name - * @return string Returns a string containing the image profile. + * {@inheritdoc} + * @param string $name */ public function getImageProfile (string $name): string {} /** - * Returns the chromaticity red primary point - * @link http://www.php.net/manual/en/imagick.getimageredprimary.php - * @return array Returns the chromaticity red primary point as an array with the keys "x" - * and "y". - * Throw an - * ImagickException on error. + * {@inheritdoc} */ public function getImageRedPrimary (): array {} /** - * Gets the image rendering intent - * @link http://www.php.net/manual/en/imagick.getimagerenderingintent.php - * @return int Returns the image rendering intent. + * {@inheritdoc} */ public function getImageRenderingIntent (): int {} /** - * Gets the image X and Y resolution - * @link http://www.php.net/manual/en/imagick.getimageresolution.php - * @return array Returns the resolution as an array. + * {@inheritdoc} */ public function getImageResolution (): array {} /** - * Gets the image scene - * @link http://www.php.net/manual/en/imagick.getimagescene.php - * @return int Returns the image scene. + * {@inheritdoc} */ public function getImageScene (): int {} /** - * Generates an SHA-256 message digest - * @link http://www.php.net/manual/en/imagick.getimagesignature.php - * @return string Returns a string containing the SHA-256 hash of the file. + * {@inheritdoc} */ public function getImageSignature (): string {} /** - * Gets the image ticks-per-second - * @link http://www.php.net/manual/en/imagick.getimagetickspersecond.php - * @return int Returns the image ticks-per-second. + * {@inheritdoc} */ public function getImageTicksPerSecond (): int {} /** - * Gets the potential image type - * @link http://www.php.net/manual/en/imagick.getimagetype.php - * @return int Returns the potential image type. - *
- *
- * imagick::IMGTYPE_UNDEFINED
- *
- * imagick::IMGTYPE_BILEVEL
- *
- * imagick::IMGTYPE_GRAYSCALE
- *
- * imagick::IMGTYPE_GRAYSCALEMATTE
- *
- * imagick::IMGTYPE_PALETTE
- *
- * imagick::IMGTYPE_PALETTEMATTE
- *
- * imagick::IMGTYPE_TRUECOLOR
- *
- * imagick::IMGTYPE_TRUECOLORMATTE
- *
- * imagick::IMGTYPE_COLORSEPARATION
- *
- * imagick::IMGTYPE_COLORSEPARATIONMATTE
- *
- * imagick::IMGTYPE_OPTIMIZE
- *
channel constants - * @return bool Returns true on success. + * {@inheritdoc} + * @param float $radius + * @param float $sigma + * @param float $threshold + * @param int $channel [optional] */ - public function selectiveBlurImage (float $radius, float $sigma, float $threshold, int $channel = \Imagick::CHANNEL_DEFAULT): bool {} + public function selectiveBlurImage (float $radius, float $sigma, float $threshold, int $channel = 134217727): bool {} /** - * Rotational blurs an image - * @link http://www.php.net/manual/en/imagick.rotationalblurimage.php - * @param float $angle The angle to apply the blur over. - * @param int $channel [optional] Provide any channel constant that is valid for your channel mode. To apply to more than one channel, combine
channel constants
- * @return bool Returns true on success.
+ * {@inheritdoc}
+ * @param float $angle
+ * @param int $channel [optional]
*/
- public function rotationalBlurImage (float $angle, int $channel = \Imagick::CHANNEL_DEFAULT): bool {}
+ public function rotationalBlurImage (float $angle, int $channel = 134217727): bool {}
/**
- * Modifies image using a statistics function
- * @link http://www.php.net/manual/en/imagick.statisticimage.php
- * @param int $type
- * @param int $width
- * @param int $height
- * @param int $channel [optional]
- * @return bool Returns true on success.
+ * {@inheritdoc}
+ * @param int $type
+ * @param int $width
+ * @param int $height
+ * @param int $channel [optional]
*/
- public function statisticImage (int $type, int $width, int $height, int $channel = \Imagick::CHANNEL_DEFAULT): bool {}
+ public function statisticImage (int $type, int $width, int $height, int $channel = 134217727): bool {}
/**
- * Searches for a subimage in the current image and returns a similarity image
- * @link http://www.php.net/manual/en/imagick.subimagematch.php
- * @param Imagick $Imagick
- * @param array $offset [optional]
- * @param float $similarity [optional] A new image that displays the amount of similarity at each pixel.
- * @return Imagick
+ * {@inheritdoc}
+ * @param Imagick $image
+ * @param array|null $offset [optional]
+ * @param float|null $similarity [optional]
+ * @param float $threshold [optional]
+ * @param int $metric [optional]
*/
- public function subimageMatch (Imagick $Imagick, array &$offset = null, float &$similarity = null): Imagick {}
+ public function subimageMatch (Imagick $image, ?array &$offset = NULL, ?float &$similarity = NULL, float $threshold = 0.0, int $metric = 0): Imagick {}
/**
* {@inheritdoc}
@@ -4002,39 +3180,31 @@ public function subimageMatch (Imagick $Imagick, array &$offset = null, float &$
public function similarityImage (Imagick $image, ?array &$offset = NULL, ?float &$similarity = NULL, float $threshold = 0.0, int $metric = 0): Imagick {}
/**
- * Sets the ImageMagick registry entry named key to value
- * @link http://www.php.net/manual/en/imagick.setregistry.php
- * @param string $key
- * @param string $value
- * @return bool Returns true on success.
+ * {@inheritdoc}
+ * @param string $key
+ * @param string $value
*/
public static function setRegistry (string $key, string $value): bool {}
/**
- * Get a StringRegistry entry
- * @link http://www.php.net/manual/en/imagick.getregistry.php
- * @param string $key The entry to get.
- * @return string
+ * {@inheritdoc}
+ * @param string $key
*/
public static function getRegistry (string $key): string {}
/**
- * List all the registry settings
- * @link http://www.php.net/manual/en/imagick.listregistry.php
- * @return array An array containing the key/values from the registry.
+ * {@inheritdoc}
*/
public static function listRegistry (): array {}
/**
- * Applies a user supplied kernel to the image according to the given morphology method.
- * @link http://www.php.net/manual/en/imagick.morphology.php
- * @param int $morphologyMethod Which morphology method to use one of the \Imagick::MORPHOLOGY_* constants.
- * @param int $iterations The number of iteration to apply the morphology function. A value of -1 means loop until no change found. How this is applied may depend on the morphology method. Typically this is a value of 1.
- * @param ImagickKernel $ImagickKernel
- * @param int $channel [optional]
- * @return bool Returns true on success.
+ * {@inheritdoc}
+ * @param int $morphology
+ * @param int $iterations
+ * @param ImagickKernel $kernel
+ * @param int $channel [optional]
*/
- public function morphology (int $morphologyMethod, int $iterations, ImagickKernel $ImagickKernel, int $channel = \Imagick::CHANNEL_DEFAULT): bool {}
+ public function morphology (int $morphology, int $iterations, ImagickKernel $kernel, int $channel = 134217727): bool {}
/**
* {@inheritdoc}
@@ -4322,332 +3492,251 @@ public function setOrientation (int $orientation): bool {}
}
-/**
- * @link http://www.php.net/manual/en/class.imagickdraw.php
- */
class ImagickDraw {
/**
- * Resets the vector graphics
- * @link http://www.php.net/manual/en/imagickdraw.resetvectorgraphics.php
- * @return bool Returns true on success.
+ * {@inheritdoc}
*/
public function resetVectorGraphics (): bool {}
/**
- * Gets the text kerning
- * @link http://www.php.net/manual/en/imagickdraw.gettextkerning.php
- * @return float
+ * {@inheritdoc}
*/
public function getTextKerning (): float {}
/**
- * Sets the text kerning
- * @link http://www.php.net/manual/en/imagickdraw.settextkerning.php
- * @param float $kerning
- * @return bool Returns true on success.
+ * {@inheritdoc}
+ * @param float $kerning
*/
public function setTextKerning (float $kerning): bool {}
/**
- * Gets the text interword spacing
- * @link http://www.php.net/manual/en/imagickdraw.gettextinterwordspacing.php
- * @return float
+ * {@inheritdoc}
*/
public function getTextInterwordSpacing (): float {}
/**
- * Sets the text interword spacing
- * @link http://www.php.net/manual/en/imagickdraw.settextinterwordspacing.php
- * @param float $spacing
- * @return bool Returns true on success.
+ * {@inheritdoc}
+ * @param float $spacing
*/
public function setTextInterwordSpacing (float $spacing): bool {}
/**
- * Gets the text interword spacing
- * @link http://www.php.net/manual/en/imagickdraw.gettextinterlinespacing.php
- * @return float
+ * {@inheritdoc}
*/
public function getTextInterlineSpacing (): float {}
/**
- * Sets the text interline spacing
- * @link http://www.php.net/manual/en/imagickdraw.settextinterlinespacing.php
- * @param float $spacing
- * @return bool Returns true on success.
+ * {@inheritdoc}
+ * @param float $spacing
*/
public function setTextInterlineSpacing (float $spacing): bool {}
/**
- * The ImagickDraw constructor
- * @link http://www.php.net/manual/en/imagickdraw.construct.php
- * @return void No value is returned.
+ * {@inheritdoc}
*/
- public function __construct (): void {}
+ public function __construct () {}
/**
- * Sets the fill color to be used for drawing filled objects
- * @link http://www.php.net/manual/en/imagickdraw.setfillcolor.php
- * @param ImagickPixel $fill_pixel
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param ImagickPixel|string $fill_color
*/
- public function setFillColor (ImagickPixel $fill_pixel): bool {}
+ public function setFillColor (ImagickPixel|string $fill_color): bool {}
/**
- * Sets the opacity to use when drawing using the fill color or fill texture
- * @link http://www.php.net/manual/en/imagickdraw.setfillalpha.php
- * @param float $opacity
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param float $alpha
*/
- public function setFillAlpha (float $opacity): bool {}
+ public function setFillAlpha (float $alpha): bool {}
/**
- * Sets the resolution
- * @link http://www.php.net/manual/en/imagickdraw.setresolution.php
- * @param float $x_resolution
- * @param float $y_resolution
- * @return bool Returns true on success.
+ * {@inheritdoc}
+ * @param float $resolution_x
+ * @param float $resolution_y
*/
- public function setResolution (float $x_resolution, float $y_resolution): bool {}
+ public function setResolution (float $resolution_x, float $resolution_y): bool {}
/**
- * Sets the color used for stroking object outlines
- * @link http://www.php.net/manual/en/imagickdraw.setstrokecolor.php
- * @param ImagickPixel $stroke_pixel
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param ImagickPixel|string $color
*/
- public function setStrokeColor (ImagickPixel $stroke_pixel): bool {}
+ public function setStrokeColor (ImagickPixel|string $color): bool {}
/**
- * Specifies the opacity of stroked object outlines
- * @link http://www.php.net/manual/en/imagickdraw.setstrokealpha.php
- * @param float $opacity
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param float $alpha
*/
- public function setStrokeAlpha (float $opacity): bool {}
+ public function setStrokeAlpha (float $alpha): bool {}
/**
- * Sets the width of the stroke used to draw object outlines
- * @link http://www.php.net/manual/en/imagickdraw.setstrokewidth.php
- * @param float $stroke_width
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param float $width
*/
- public function setStrokeWidth (float $stroke_width): bool {}
+ public function setStrokeWidth (float $width): bool {}
/**
- * Clears the ImagickDraw
- * @link http://www.php.net/manual/en/imagickdraw.clear.php
- * @return bool Returns an ImagickDraw object.
+ * {@inheritdoc}
*/
public function clear (): bool {}
/**
- * Draws a circle
- * @link http://www.php.net/manual/en/imagickdraw.circle.php
- * @param float $ox
- * @param float $oy
- * @param float $px
- * @param float $py
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param float $origin_x
+ * @param float $origin_y
+ * @param float $perimeter_x
+ * @param float $perimeter_y
*/
- public function circle (float $ox, float $oy, float $px, float $py): bool {}
+ public function circle (float $origin_x, float $origin_y, float $perimeter_x, float $perimeter_y): bool {}
/**
- * Draws text on the image
- * @link http://www.php.net/manual/en/imagickdraw.annotation.php
- * @param float $x
- * @param float $y
- * @param string $text
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param float $x
+ * @param float $y
+ * @param string $text
*/
public function annotation (float $x, float $y, string $text): bool {}
/**
- * Controls whether text is antialiased
- * @link http://www.php.net/manual/en/imagickdraw.settextantialias.php
- * @param bool $antiAlias
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param bool $antialias
*/
- public function setTextAntialias (bool $antiAlias): bool {}
+ public function setTextAntialias (bool $antialias): bool {}
/**
- * Specifies the text code set
- * @link http://www.php.net/manual/en/imagickdraw.settextencoding.php
- * @param string $encoding
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param string $encoding
*/
public function setTextEncoding (string $encoding): bool {}
/**
- * Sets the fully-specified font to use when annotating with text
- * @link http://www.php.net/manual/en/imagickdraw.setfont.php
- * @param string $font_name
- * @return bool Returns true on success.
+ * {@inheritdoc}
+ * @param string $font_name
*/
public function setFont (string $font_name): bool {}
/**
- * Sets the font family to use when annotating with text
- * @link http://www.php.net/manual/en/imagickdraw.setfontfamily.php
- * @param string $font_family
- * @return bool Returns true on success.
+ * {@inheritdoc}
+ * @param string $font_family
*/
public function setFontFamily (string $font_family): bool {}
/**
- * Sets the font pointsize to use when annotating with text
- * @link http://www.php.net/manual/en/imagickdraw.setfontsize.php
- * @param float $pointsize
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param float $point_size
*/
- public function setFontSize (float $pointsize): bool {}
+ public function setFontSize (float $point_size): bool {}
/**
- * Sets the font style to use when annotating with text
- * @link http://www.php.net/manual/en/imagickdraw.setfontstyle.php
- * @param int $style
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param int $style
*/
public function setFontStyle (int $style): bool {}
/**
- * Sets the font weight
- * @link http://www.php.net/manual/en/imagickdraw.setfontweight.php
- * @param int $font_weight
- * @return bool
+ * {@inheritdoc}
+ * @param int $weight
*/
- public function setFontWeight (int $font_weight): bool {}
+ public function setFontWeight (int $weight): bool {}
/**
- * Returns the font
- * @link http://www.php.net/manual/en/imagickdraw.getfont.php
- * @return string Returns a string on success and false if no font is set.
+ * {@inheritdoc}
*/
public function getFont (): string {}
/**
- * Returns the font family
- * @link http://www.php.net/manual/en/imagickdraw.getfontfamily.php
- * @return string Returns the font family currently selected or false if font family is not set.
+ * {@inheritdoc}
*/
public function getFontFamily (): string {}
/**
- * Returns the font pointsize
- * @link http://www.php.net/manual/en/imagickdraw.getfontsize.php
- * @return float Returns the font size associated with the current ImagickDraw object.
+ * {@inheritdoc}
*/
public function getFontSize (): float {}
/**
- * Returns the font style
- * @link http://www.php.net/manual/en/imagickdraw.getfontstyle.php
- * @return int Returns a STYLE constant
- * (imagick::STYLE_*) associated with the ImagickDraw object
- * or 0 if no style is set.
+ * {@inheritdoc}
*/
public function getFontStyle (): int {}
/**
- * Returns the font weight
- * @link http://www.php.net/manual/en/imagickdraw.getfontweight.php
- * @return int Returns an int on success and 0 if no weight is set.
+ * {@inheritdoc}
*/
public function getFontWeight (): int {}
/**
- * Frees all associated resources
- * @link http://www.php.net/manual/en/imagickdraw.destroy.php
- * @return bool No value is returned.
+ * {@inheritdoc}
*/
public function destroy (): bool {}
/**
- * Draws a rectangle
- * @link http://www.php.net/manual/en/imagickdraw.rectangle.php
- * @param float $x1
- * @param float $y1
- * @param float $x2
- * @param float $y2
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param float $top_left_x
+ * @param float $top_left_y
+ * @param float $bottom_right_x
+ * @param float $bottom_right_y
*/
- public function rectangle (float $x1, float $y1, float $x2, float $y2): bool {}
+ public function rectangle (float $top_left_x, float $top_left_y, float $bottom_right_x, float $bottom_right_y): bool {}
/**
- * Draws a rounded rectangle
- * @link http://www.php.net/manual/en/imagickdraw.roundrectangle.php
- * @param float $x1
- * @param float $y1
- * @param float $x2
- * @param float $y2
- * @param float $rx
- * @param float $ry
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param float $top_left_x
+ * @param float $top_left_y
+ * @param float $bottom_right_x
+ * @param float $bottom_right_y
+ * @param float $rounding_x
+ * @param float $rounding_y
*/
- public function roundRectangle (float $x1, float $y1, float $x2, float $y2, float $rx, float $ry): bool {}
+ public function roundRectangle (float $top_left_x, float $top_left_y, float $bottom_right_x, float $bottom_right_y, float $rounding_x, float $rounding_y): bool {}
/**
- * Draws an ellipse on the image
- * @link http://www.php.net/manual/en/imagickdraw.ellipse.php
- * @param float $ox
- * @param float $oy
- * @param float $rx
- * @param float $ry
- * @param float $start
- * @param float $end
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param float $origin_x
+ * @param float $origin_y
+ * @param float $radius_x
+ * @param float $radius_y
+ * @param float $angle_start
+ * @param float $angle_end
*/
- public function ellipse (float $ox, float $oy, float $rx, float $ry, float $start, float $end): bool {}
+ public function ellipse (float $origin_x, float $origin_y, float $radius_x, float $radius_y, float $angle_start, float $angle_end): bool {}
/**
- * Skews the current coordinate system in the horizontal direction
- * @link http://www.php.net/manual/en/imagickdraw.skewx.php
- * @param float $degrees
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param float $degrees
*/
public function skewX (float $degrees): bool {}
/**
- * Skews the current coordinate system in the vertical direction
- * @link http://www.php.net/manual/en/imagickdraw.skewy.php
- * @param float $degrees
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param float $degrees
*/
public function skewY (float $degrees): bool {}
/**
- * Applies a translation to the current coordinate system
- * @link http://www.php.net/manual/en/imagickdraw.translate.php
- * @param float $x
- * @param float $y
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param float $x
+ * @param float $y
*/
public function translate (float $x, float $y): bool {}
/**
- * Draws a line
- * @link http://www.php.net/manual/en/imagickdraw.line.php
- * @param float $sx
- * @param float $sy
- * @param float $ex
- * @param float $ey
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param float $start_x
+ * @param float $start_y
+ * @param float $end_x
+ * @param float $end_y
*/
- public function line (float $sx, float $sy, float $ex, float $ey): bool {}
+ public function line (float $start_x, float $start_y, float $end_x, float $end_y): bool {}
/**
- * Draws an arc
- * @link http://www.php.net/manual/en/imagickdraw.arc.php
- * @param float $sx
- * @param float $sy
- * @param float $ex
- * @param float $ey
- * @param float $sd
- * @param float $ed
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param float $start_x
+ * @param float $start_y
+ * @param float $end_x
+ * @param float $end_y
+ * @param float $start_angle
+ * @param float $end_angle
*/
- public function arc (float $sx, float $sy, float $ex, float $ey, float $sd, float $ed): bool {}
+ public function arc (float $start_x, float $start_y, float $end_x, float $end_y, float $start_angle, float $end_angle): bool {}
/**
* {@inheritdoc}
@@ -4658,715 +3747,536 @@ public function arc (float $sx, float $sy, float $ex, float $ey, float $sd, floa
public function alpha (float $x, float $y, int $paint): bool {}
/**
- * Draws a polygon
- * @link http://www.php.net/manual/en/imagickdraw.polygon.php
- * @param array $coordinates
- * @return bool Returns true on success.
+ * {@inheritdoc}
+ * @param array $coordinates
*/
public function polygon (array $coordinates): bool {}
/**
- * Draws a point
- * @link http://www.php.net/manual/en/imagickdraw.point.php
- * @param float $x
- * @param float $y
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param float $x
+ * @param float $y
*/
public function point (float $x, float $y): bool {}
/**
- * Returns the text decoration
- * @link http://www.php.net/manual/en/imagickdraw.gettextdecoration.php
- * @return int Returns a DECORATION constant
- * (imagick::DECORATION_*), and 0 if no decoration is set.
+ * {@inheritdoc}
*/
public function getTextDecoration (): int {}
/**
- * Returns the code set used for text annotations
- * @link http://www.php.net/manual/en/imagickdraw.gettextencoding.php
- * @return string Returns a string specifying the code set
- * or false if text encoding is not set.
+ * {@inheritdoc}
*/
public function getTextEncoding (): string {}
/**
- * Gets the font stretch to use when annotating with text
- * @link http://www.php.net/manual/en/imagickdraw.getfontstretch.php
- * @return int
+ * {@inheritdoc}
*/
public function getFontStretch (): int {}
/**
- * Sets the font stretch to use when annotating with text
- * @link http://www.php.net/manual/en/imagickdraw.setfontstretch.php
- * @param int $fontStretch
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param int $stretch
*/
- public function setFontStretch (int $fontStretch): bool {}
+ public function setFontStretch (int $stretch): bool {}
/**
- * Controls whether stroked outlines are antialiased
- * @link http://www.php.net/manual/en/imagickdraw.setstrokeantialias.php
- * @param bool $stroke_antialias
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param bool $enabled
*/
- public function setStrokeAntialias (bool $stroke_antialias): bool {}
+ public function setStrokeAntialias (bool $enabled): bool {}
/**
- * Specifies a text alignment
- * @link http://www.php.net/manual/en/imagickdraw.settextalignment.php
- * @param int $alignment
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param int $align
*/
- public function setTextAlignment (int $alignment): bool {}
+ public function setTextAlignment (int $align): bool {}
/**
- * Specifies a decoration
- * @link http://www.php.net/manual/en/imagickdraw.settextdecoration.php
- * @param int $decoration
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param int $decoration
*/
public function setTextDecoration (int $decoration): bool {}
/**
- * Specifies the color of a background rectangle
- * @link http://www.php.net/manual/en/imagickdraw.settextundercolor.php
- * @param ImagickPixel $under_color
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param ImagickPixel|string $under_color
*/
- public function setTextUnderColor (ImagickPixel $under_color): bool {}
+ public function setTextUnderColor (ImagickPixel|string $under_color): bool {}
/**
- * Sets the overall canvas size
- * @link http://www.php.net/manual/en/imagickdraw.setviewbox.php
- * @param int $x1
- * @param int $y1
- * @param int $x2
- * @param int $y2
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param int $left_x
+ * @param int $top_y
+ * @param int $right_x
+ * @param int $bottom_y
*/
- public function setViewbox (int $x1, int $y1, int $x2, int $y2): bool {}
+ public function setViewbox (int $left_x, int $top_y, int $right_x, int $bottom_y): bool {}
/**
- * Makes an exact copy of the specified ImagickDraw object
- * @link http://www.php.net/manual/en/imagickdraw.clone.php
- * @return ImagickDraw returns an exact copy of the specified ImagickDraw object.
+ * {@inheritdoc}
*/
public function clone (): ImagickDraw {}
/**
- * Adjusts the current affine transformation matrix
- * @link http://www.php.net/manual/en/imagickdraw.affine.php
- * @param array $affine
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param array $affine
*/
public function affine (array $affine): bool {}
/**
- * Draws a bezier curve
- * @link http://www.php.net/manual/en/imagickdraw.bezier.php
- * @param array $coordinates
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param array $coordinates
*/
public function bezier (array $coordinates): bool {}
/**
- * Composites an image onto the current image
- * @link http://www.php.net/manual/en/imagickdraw.composite.php
- * @param int $compose
- * @param float $x
- * @param float $y
- * @param float $width
- * @param float $height
- * @param Imagick $compositeWand
- * @return bool Returns true on success.
+ * {@inheritdoc}
+ * @param int $composite
+ * @param float $x
+ * @param float $y
+ * @param float $width
+ * @param float $height
+ * @param Imagick $image
*/
- public function composite (int $compose, float $x, float $y, float $width, float $height, Imagick $compositeWand): bool {}
+ public function composite (int $composite, float $x, float $y, float $width, float $height, Imagick $image): bool {}
/**
- * Draws color on image
- * @link http://www.php.net/manual/en/imagickdraw.color.php
- * @param float $x
- * @param float $y
- * @param int $paintMethod
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param float $x
+ * @param float $y
+ * @param int $paint
*/
- public function color (float $x, float $y, int $paintMethod): bool {}
+ public function color (float $x, float $y, int $paint): bool {}
/**
- * Adds a comment
- * @link http://www.php.net/manual/en/imagickdraw.comment.php
- * @param string $comment
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param string $comment
*/
public function comment (string $comment): bool {}
/**
- * Obtains the current clipping path ID
- * @link http://www.php.net/manual/en/imagickdraw.getclippath.php
- * @return string Returns a string containing the clip path ID or false if no clip path exists.
+ * {@inheritdoc}
*/
public function getClipPath (): string {}
/**
- * Returns the current polygon fill rule
- * @link http://www.php.net/manual/en/imagickdraw.getcliprule.php
- * @return int Returns a FILLRULE constant
- * (imagick::FILLRULE_*).
+ * {@inheritdoc}
*/
public function getClipRule (): int {}
/**
- * Returns the interpretation of clip path units
- * @link http://www.php.net/manual/en/imagickdraw.getclipunits.php
- * @return int Returns an int on success.
+ * {@inheritdoc}
*/
public function getClipUnits (): int {}
/**
- * Returns the fill color
- * @link http://www.php.net/manual/en/imagickdraw.getfillcolor.php
- * @return ImagickPixel Returns an ImagickPixel object.
+ * {@inheritdoc}
*/
public function getFillColor (): ImagickPixel {}
/**
- * Returns the opacity used when drawing
- * @link http://www.php.net/manual/en/imagickdraw.getfillopacity.php
- * @return float The opacity.
+ * {@inheritdoc}
*/
public function getFillOpacity (): float {}
/**
- * Returns the fill rule
- * @link http://www.php.net/manual/en/imagickdraw.getfillrule.php
- * @return int Returns a FILLRULE constant
- * (imagick::FILLRULE_*).
+ * {@inheritdoc}
*/
public function getFillRule (): int {}
/**
- * Returns the text placement gravity
- * @link http://www.php.net/manual/en/imagickdraw.getgravity.php
- * @return int Returns a GRAVITY constant
- * (imagick::GRAVITY_*) on success and 0 if no gravity is set.
+ * {@inheritdoc}
*/
public function getGravity (): int {}
/**
- * Returns the current stroke antialias setting
- * @link http://www.php.net/manual/en/imagickdraw.getstrokeantialias.php
- * @return bool Returns true if antialiasing is on and false if it is off.
+ * {@inheritdoc}
*/
public function getStrokeAntialias (): bool {}
/**
- * Returns the color used for stroking object outlines
- * @link http://www.php.net/manual/en/imagickdraw.getstrokecolor.php
- * @return ImagickPixel Returns an ImagickPixel object which describes the color.
+ * {@inheritdoc}
*/
public function getStrokeColor (): ImagickPixel {}
/**
- * Returns an array representing the pattern of dashes and gaps used to stroke paths
- * @link http://www.php.net/manual/en/imagickdraw.getstrokedasharray.php
- * @return array Returns an array on success and empty array if not set.
+ * {@inheritdoc}
*/
public function getStrokeDashArray (): array {}
/**
- * Returns the offset into the dash pattern to start the dash
- * @link http://www.php.net/manual/en/imagickdraw.getstrokedashoffset.php
- * @return float Returns a float representing the offset and 0 if it's not set.
+ * {@inheritdoc}
*/
public function getStrokeDashOffset (): float {}
/**
- * Returns the shape to be used at the end of open subpaths when they are stroked
- * @link http://www.php.net/manual/en/imagickdraw.getstrokelinecap.php
- * @return int Returns a LINECAP constant
- * (imagick::LINECAP_*), or 0 if stroke linecap is not set.
+ * {@inheritdoc}
*/
public function getStrokeLineCap (): int {}
/**
- * Returns the shape to be used at the corners of paths when they are stroked
- * @link http://www.php.net/manual/en/imagickdraw.getstrokelinejoin.php
- * @return int Returns a LINEJOIN constant
- * (imagick::LINEJOIN_*), or 0 if stroke line join is not set.
+ * {@inheritdoc}
*/
public function getStrokeLineJoin (): int {}
/**
- * Returns the stroke miter limit
- * @link http://www.php.net/manual/en/imagickdraw.getstrokemiterlimit.php
- * @return int Returns an int describing the miter limit
- * and 0 if no miter limit is set.
+ * {@inheritdoc}
*/
public function getStrokeMiterLimit (): int {}
/**
- * Returns the opacity of stroked object outlines
- * @link http://www.php.net/manual/en/imagickdraw.getstrokeopacity.php
- * @return float Returns a float describing the opacity.
+ * {@inheritdoc}
*/
public function getStrokeOpacity (): float {}
/**
- * Returns the width of the stroke used to draw object outlines
- * @link http://www.php.net/manual/en/imagickdraw.getstrokewidth.php
- * @return float Returns a float describing the stroke width.
+ * {@inheritdoc}
*/
public function getStrokeWidth (): float {}
/**
- * Returns the text alignment
- * @link http://www.php.net/manual/en/imagickdraw.gettextalignment.php
- * @return int Returns a ALIGN constant
- * (imagick::ALIGN_*), and 0 if no align is set.
+ * {@inheritdoc}
*/
public function getTextAlignment (): int {}
/**
- * Returns the current text antialias setting
- * @link http://www.php.net/manual/en/imagickdraw.gettextantialias.php
- * @return bool Returns true if text is antialiased and false if not.
+ * {@inheritdoc}
*/
public function getTextAntialias (): bool {}
/**
- * Returns a string containing vector graphics
- * @link http://www.php.net/manual/en/imagickdraw.getvectorgraphics.php
- * @return string Returns a string containing the vector graphics.
+ * {@inheritdoc}
*/
public function getVectorGraphics (): string {}
/**
- * Returns the text under color
- * @link http://www.php.net/manual/en/imagickdraw.gettextundercolor.php
- * @return ImagickPixel Returns an ImagickPixel object describing the color.
+ * {@inheritdoc}
*/
public function getTextUnderColor (): ImagickPixel {}
/**
- * Adds a path element to the current path
- * @link http://www.php.net/manual/en/imagickdraw.pathclose.php
- * @return bool No value is returned.
+ * {@inheritdoc}
*/
public function pathClose (): bool {}
/**
- * Draws a cubic Bezier curve
- * @link http://www.php.net/manual/en/imagickdraw.pathcurvetoabsolute.php
- * @param float $x1
- * @param float $y1
- * @param float $x2
- * @param float $y2
- * @param float $x
- * @param float $y
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param float $x1
+ * @param float $y1
+ * @param float $x2
+ * @param float $y2
+ * @param float $x
+ * @param float $y
*/
public function pathCurveToAbsolute (float $x1, float $y1, float $x2, float $y2, float $x, float $y): bool {}
/**
- * Draws a cubic Bezier curve
- * @link http://www.php.net/manual/en/imagickdraw.pathcurvetorelative.php
- * @param float $x1
- * @param float $y1
- * @param float $x2
- * @param float $y2
- * @param float $x
- * @param float $y
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param float $x1
+ * @param float $y1
+ * @param float $x2
+ * @param float $y2
+ * @param float $x
+ * @param float $y
*/
public function pathCurveToRelative (float $x1, float $y1, float $x2, float $y2, float $x, float $y): bool {}
/**
- * Draws a quadratic Bezier curve
- * @link http://www.php.net/manual/en/imagickdraw.pathcurvetoquadraticbezierabsolute.php
- * @param float $x1
- * @param float $y1
- * @param float $x
- * @param float $y
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param float $x1
+ * @param float $y1
+ * @param float $x_end
+ * @param float $y
*/
- public function pathCurveToQuadraticBezierAbsolute (float $x1, float $y1, float $x, float $y): bool {}
+ public function pathCurveToQuadraticBezierAbsolute (float $x1, float $y1, float $x_end, float $y): bool {}
/**
- * Draws a quadratic Bezier curve
- * @link http://www.php.net/manual/en/imagickdraw.pathcurvetoquadraticbezierrelative.php
- * @param float $x1
- * @param float $y1
- * @param float $x
- * @param float $y
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param float $x1
+ * @param float $y1
+ * @param float $x_end
+ * @param float $y
*/
- public function pathCurveToQuadraticBezierRelative (float $x1, float $y1, float $x, float $y): bool {}
+ public function pathCurveToQuadraticBezierRelative (float $x1, float $y1, float $x_end, float $y): bool {}
/**
- * Draws a quadratic Bezier curve
- * @link http://www.php.net/manual/en/imagickdraw.pathcurvetoquadraticbeziersmoothabsolute.php
- * @param float $x
- * @param float $y
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param float $x
+ * @param float $y
*/
public function pathCurveToQuadraticBezierSmoothAbsolute (float $x, float $y): bool {}
/**
- * Draws a quadratic Bezier curve
- * @link http://www.php.net/manual/en/imagickdraw.pathcurvetoquadraticbeziersmoothrelative.php
- * @param float $x
- * @param float $y
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param float $x
+ * @param float $y
*/
public function pathCurveToQuadraticBezierSmoothRelative (float $x, float $y): bool {}
/**
- * Draws a cubic Bezier curve
- * @link http://www.php.net/manual/en/imagickdraw.pathcurvetosmoothabsolute.php
- * @param float $x2
- * @param float $y2
- * @param float $x
- * @param float $y
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param float $x2
+ * @param float $y2
+ * @param float $x
+ * @param float $y
*/
public function pathCurveToSmoothAbsolute (float $x2, float $y2, float $x, float $y): bool {}
/**
- * Draws a cubic Bezier curve
- * @link http://www.php.net/manual/en/imagickdraw.pathcurvetosmoothrelative.php
- * @param float $x2
- * @param float $y2
- * @param float $x
- * @param float $y
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param float $x2
+ * @param float $y2
+ * @param float $x
+ * @param float $y
*/
public function pathCurveToSmoothRelative (float $x2, float $y2, float $x, float $y): bool {}
/**
- * Draws an elliptical arc
- * @link http://www.php.net/manual/en/imagickdraw.pathellipticarcabsolute.php
- * @param float $rx
- * @param float $ry
- * @param float $x_axis_rotation
- * @param bool $large_arc_flag
- * @param bool $sweep_flag
- * @param float $x
- * @param float $y
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param float $rx
+ * @param float $ry
+ * @param float $x_axis_rotation
+ * @param bool $large_arc
+ * @param bool $sweep
+ * @param float $x
+ * @param float $y
*/
- public function pathEllipticArcAbsolute (float $rx, float $ry, float $x_axis_rotation, bool $large_arc_flag, bool $sweep_flag, float $x, float $y): bool {}
+ public function pathEllipticArcAbsolute (float $rx, float $ry, float $x_axis_rotation, bool $large_arc, bool $sweep, float $x, float $y): bool {}
/**
- * Draws an elliptical arc
- * @link http://www.php.net/manual/en/imagickdraw.pathellipticarcrelative.php
- * @param float $rx
- * @param float $ry
- * @param float $x_axis_rotation
- * @param bool $large_arc_flag
- * @param bool $sweep_flag
- * @param float $x
- * @param float $y
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param float $rx
+ * @param float $ry
+ * @param float $x_axis_rotation
+ * @param bool $large_arc
+ * @param bool $sweep
+ * @param float $x
+ * @param float $y
*/
- public function pathEllipticArcRelative (float $rx, float $ry, float $x_axis_rotation, bool $large_arc_flag, bool $sweep_flag, float $x, float $y): bool {}
+ public function pathEllipticArcRelative (float $rx, float $ry, float $x_axis_rotation, bool $large_arc, bool $sweep, float $x, float $y): bool {}
/**
- * Terminates the current path
- * @link http://www.php.net/manual/en/imagickdraw.pathfinish.php
- * @return bool No value is returned.
+ * {@inheritdoc}
*/
public function pathFinish (): bool {}
/**
- * Draws a line path
- * @link http://www.php.net/manual/en/imagickdraw.pathlinetoabsolute.php
- * @param float $x
- * @param float $y
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param float $x
+ * @param float $y
*/
public function pathLineToAbsolute (float $x, float $y): bool {}
/**
- * Draws a line path
- * @link http://www.php.net/manual/en/imagickdraw.pathlinetorelative.php
- * @param float $x
- * @param float $y
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param float $x
+ * @param float $y
*/
public function pathLineToRelative (float $x, float $y): bool {}
/**
- * Draws a horizontal line path
- * @link http://www.php.net/manual/en/imagickdraw.pathlinetohorizontalabsolute.php
- * @param float $x
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param float $x
*/
public function pathLineToHorizontalAbsolute (float $x): bool {}
/**
- * Draws a horizontal line
- * @link http://www.php.net/manual/en/imagickdraw.pathlinetohorizontalrelative.php
- * @param float $x
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param float $x
*/
public function pathLineToHorizontalRelative (float $x): bool {}
/**
- * Draws a vertical line
- * @link http://www.php.net/manual/en/imagickdraw.pathlinetoverticalabsolute.php
- * @param float $y
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param float $y
*/
public function pathLineToVerticalAbsolute (float $y): bool {}
/**
- * Draws a vertical line path
- * @link http://www.php.net/manual/en/imagickdraw.pathlinetoverticalrelative.php
- * @param float $y
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param float $y
*/
public function pathLineToVerticalRelative (float $y): bool {}
/**
- * Starts a new sub-path
- * @link http://www.php.net/manual/en/imagickdraw.pathmovetoabsolute.php
- * @param float $x
- * @param float $y
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param float $x
+ * @param float $y
*/
public function pathMoveToAbsolute (float $x, float $y): bool {}
/**
- * Starts a new sub-path
- * @link http://www.php.net/manual/en/imagickdraw.pathmovetorelative.php
- * @param float $x
- * @param float $y
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param float $x
+ * @param float $y
*/
public function pathMoveToRelative (float $x, float $y): bool {}
/**
- * Declares the start of a path drawing list
- * @link http://www.php.net/manual/en/imagickdraw.pathstart.php
- * @return bool No value is returned.
+ * {@inheritdoc}
*/
public function pathStart (): bool {}
/**
- * Draws a polyline
- * @link http://www.php.net/manual/en/imagickdraw.polyline.php
- * @param array $coordinates
- * @return bool Returns true on success.
+ * {@inheritdoc}
+ * @param array $coordinates
*/
public function polyline (array $coordinates): bool {}
/**
- * Terminates a clip path definition
- * @link http://www.php.net/manual/en/imagickdraw.popclippath.php
- * @return bool No value is returned.
+ * {@inheritdoc}
*/
public function popClipPath (): bool {}
/**
- * Terminates a definition list
- * @link http://www.php.net/manual/en/imagickdraw.popdefs.php
- * @return bool No value is returned.
+ * {@inheritdoc}
*/
public function popDefs (): bool {}
/**
- * Terminates a pattern definition
- * @link http://www.php.net/manual/en/imagickdraw.poppattern.php
- * @return bool Returns true on success or false on failure.
+ * {@inheritdoc}
*/
public function popPattern (): bool {}
/**
- * Starts a clip path definition
- * @link http://www.php.net/manual/en/imagickdraw.pushclippath.php
- * @param string $clip_mask_id
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param string $clip_mask_id
*/
public function pushClipPath (string $clip_mask_id): bool {}
/**
- * Indicates that following commands create named elements for early processing
- * @link http://www.php.net/manual/en/imagickdraw.pushdefs.php
- * @return bool No value is returned.
+ * {@inheritdoc}
*/
public function pushDefs (): bool {}
/**
- * Indicates that subsequent commands up to a ImagickDraw::opPattern() command comprise the definition of a named pattern
- * @link http://www.php.net/manual/en/imagickdraw.pushpattern.php
- * @param string $pattern_id
- * @param float $x
- * @param float $y
- * @param float $width
- * @param float $height
- * @return bool Returns true on success or false on failure.
+ * {@inheritdoc}
+ * @param string $pattern_id
+ * @param float $x
+ * @param float $y
+ * @param float $width
+ * @param float $height
*/
public function pushPattern (string $pattern_id, float $x, float $y, float $width, float $height): bool {}
/**
- * Renders all preceding drawing commands onto the image
- * @link http://www.php.net/manual/en/imagickdraw.render.php
- * @return bool Returns true on success or false on failure.
+ * {@inheritdoc}
*/
public function render (): bool {}
/**
- * Applies the specified rotation to the current coordinate space
- * @link http://www.php.net/manual/en/imagickdraw.rotate.php
- * @param float $degrees
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param float $degrees
*/
public function rotate (float $degrees): bool {}
/**
- * Adjusts the scaling factor
- * @link http://www.php.net/manual/en/imagickdraw.scale.php
- * @param float $x
- * @param float $y
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param float $x
+ * @param float $y
*/
public function scale (float $x, float $y): bool {}
/**
- * Associates a named clipping path with the image
- * @link http://www.php.net/manual/en/imagickdraw.setclippath.php
- * @param string $clip_mask
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param string $clip_mask
*/
public function setClipPath (string $clip_mask): bool {}
/**
- * Set the polygon fill rule to be used by the clipping path
- * @link http://www.php.net/manual/en/imagickdraw.setcliprule.php
- * @param int $fill_rule
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param int $fillrule
*/
- public function setClipRule (int $fill_rule): bool {}
+ public function setClipRule (int $fillrule): bool {}
/**
- * Sets the interpretation of clip path units
- * @link http://www.php.net/manual/en/imagickdraw.setclipunits.php
- * @param int $clip_units
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param int $pathunits
*/
- public function setClipUnits (int $clip_units): bool {}
+ public function setClipUnits (int $pathunits): bool {}
/**
- * Sets the opacity to use when drawing using the fill color or fill texture
- * @link http://www.php.net/manual/en/imagickdraw.setfillopacity.php
- * @param float $fillOpacity
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param float $opacity
*/
- public function setFillOpacity (float $fillOpacity): bool {}
+ public function setFillOpacity (float $opacity): bool {}
/**
- * Sets the URL to use as a fill pattern for filling objects
- * @link http://www.php.net/manual/en/imagickdraw.setfillpatternurl.php
- * @param string $fill_url
- * @return bool Returns true on success or false on failure.
+ * {@inheritdoc}
+ * @param string $fill_url
*/
public function setFillPatternUrl (string $fill_url): bool {}
/**
- * Sets the fill rule to use while drawing polygons
- * @link http://www.php.net/manual/en/imagickdraw.setfillrule.php
- * @param int $fill_rule
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param int $fillrule
*/
- public function setFillRule (int $fill_rule): bool {}
+ public function setFillRule (int $fillrule): bool {}
/**
- * Sets the text placement gravity
- * @link http://www.php.net/manual/en/imagickdraw.setgravity.php
- * @param int $gravity
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param int $gravity
*/
public function setGravity (int $gravity): bool {}
/**
- * Sets the pattern used for stroking object outlines
- * @link http://www.php.net/manual/en/imagickdraw.setstrokepatternurl.php
- * @param string $stroke_url
- * @return bool Returns true on success.
+ * {@inheritdoc}
+ * @param string $stroke_url
*/
public function setStrokePatternUrl (string $stroke_url): bool {}
/**
- * Specifies the offset into the dash pattern to start the dash
- * @link http://www.php.net/manual/en/imagickdraw.setstrokedashoffset.php
- * @param float $dash_offset
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param float $dash_offset
*/
public function setStrokeDashOffset (float $dash_offset): bool {}
/**
- * Specifies the shape to be used at the end of open subpaths when they are stroked
- * @link http://www.php.net/manual/en/imagickdraw.setstrokelinecap.php
- * @param int $linecap
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param int $linecap
*/
public function setStrokeLineCap (int $linecap): bool {}
/**
- * Specifies the shape to be used at the corners of paths when they are stroked
- * @link http://www.php.net/manual/en/imagickdraw.setstrokelinejoin.php
- * @param int $linejoin
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param int $linejoin
*/
public function setStrokeLineJoin (int $linejoin): bool {}
/**
- * Specifies the miter limit
- * @link http://www.php.net/manual/en/imagickdraw.setstrokemiterlimit.php
- * @param int $miterlimit
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param int $miterlimit
*/
public function setStrokeMiterLimit (int $miterlimit): bool {}
/**
- * Specifies the opacity of stroked object outlines
- * @link http://www.php.net/manual/en/imagickdraw.setstrokeopacity.php
- * @param float $stroke_opacity
- * @return bool No value is returned.
+ * {@inheritdoc}
+ * @param float $opacity
*/
- public function setStrokeOpacity (float $stroke_opacity): bool {}
+ public function setStrokeOpacity (float $opacity): bool {}
/**
- * Sets the vector graphics
- * @link http://www.php.net/manual/en/imagickdraw.setvectorgraphics.php
- * @param string $xml
- * @return bool Returns true on success or false on failure.
+ * {@inheritdoc}
+ * @param string $xml
*/
public function setVectorGraphics (string $xml): bool {}
/**
- * Destroys the current ImagickDraw in the stack, and returns to the previously pushed ImagickDraw
- * @link http://www.php.net/manual/en/imagickdraw.pop.php
- * @return bool Returns true on success or false on failure.
+ * {@inheritdoc}
*/
public function pop (): bool {}
/**
- * Clones the current ImagickDraw and pushes it to the stack
- * @link http://www.php.net/manual/en/imagickdraw.push.php
- * @return bool Returns true on success or false on failure.
+ * {@inheritdoc}
*/
public function push (): bool {}
/**
- * Specifies the pattern of dashes and gaps used to stroke paths
- * @link http://www.php.net/manual/en/imagickdraw.setstrokedasharray.php
- * @param array $dashArray
- * @return bool Returns true on success.
+ * {@inheritdoc}
+ * @param array $dashes
*/
- public function setStrokeDashArray (array $dashArray): bool {}
+ public function setStrokeDashArray (array $dashes): bool {}
/**
* {@inheritdoc}
@@ -5426,23 +4336,16 @@ public function setTextDirection (int $direction): bool {}
}
-/**
- * @link http://www.php.net/manual/en/class.imagickpixeliterator.php
- */
class ImagickPixelIterator implements Iterator, Traversable {
/**
- * The ImagickPixelIterator constructor
- * @link http://www.php.net/manual/en/imagickpixeliterator.construct.php
- * @param Imagick $wand
- * @return Imagick Returns true on success.
+ * {@inheritdoc}
+ * @param Imagick $imagick
*/
- public function __construct (Imagick $wand): Imagick {}
+ public function __construct (Imagick $imagick) {}
/**
- * Clear resources associated with a PixelIterator
- * @link http://www.php.net/manual/en/imagickpixeliterator.clear.php
- * @return bool Returns true on success.
+ * {@inheritdoc}
*/
public function clear (): bool {}
@@ -5463,40 +4366,27 @@ public static function getPixelIterator (Imagick $imagick): ImagickPixelIterator
public static function getPixelRegionIterator (Imagick $imagick, int $x, int $y, int $columns, int $rows): ImagickPixelIterator {}
/**
- * Deallocates resources associated with a PixelIterator
- * @link http://www.php.net/manual/en/imagickpixeliterator.destroy.php
- * @return bool Returns true on success.
+ * {@inheritdoc}
*/
public function destroy (): bool {}
/**
- * Returns the current row of ImagickPixel objects
- * @link http://www.php.net/manual/en/imagickpixeliterator.getcurrentiteratorrow.php
- * @return array Returns a row as an array of ImagickPixel objects that can themselves be iterated.
+ * {@inheritdoc}
*/
public function getCurrentIteratorRow (): array {}
/**
- * Returns the current pixel iterator row
- * @link http://www.php.net/manual/en/imagickpixeliterator.getiteratorrow.php
- * @return int Returns the integer offset of the row, throwing
- * ImagickPixelIteratorException on error.
+ * {@inheritdoc}
*/
public function getIteratorRow (): int {}
/**
- * Returns the next row of the pixel iterator
- * @link http://www.php.net/manual/en/imagickpixeliterator.getnextiteratorrow.php
- * @return array Returns the next row as an array of ImagickPixel objects, throwing
- * ImagickPixelIteratorException on error.
+ * {@inheritdoc}
*/
public function getNextIteratorRow (): array {}
/**
- * Returns the previous row
- * @link http://www.php.net/manual/en/imagickpixeliterator.getpreviousiteratorrow.php
- * @return array Returns the previous row as an array of ImagickPixelWand objects from the
- * ImagickPixelIterator, throwing ImagickPixelIteratorException on error.
+ * {@inheritdoc}
*/
public function getPreviousIteratorRow (): array {}
@@ -5521,59 +4411,44 @@ public function rewind () {}
public function current (): array {}
/**
- * Returns a new pixel iterator
- * @link http://www.php.net/manual/en/imagickpixeliterator.newpixeliterator.php
- * @param Imagick $wand
- * @return bool Returns true on success. Throwing ImagickPixelIteratorException.
+ * {@inheritdoc}
+ * @param Imagick $imagick
*/
- public function newPixelIterator (Imagick $wand): bool {}
+ public function newPixelIterator (Imagick $imagick): bool {}
/**
- * Returns a new pixel iterator
- * @link http://www.php.net/manual/en/imagickpixeliterator.newpixelregioniterator.php
- * @param Imagick $wand
- * @param int $x
- * @param int $y
- * @param int $columns
- * @param int $rows
- * @return bool Returns a new ImagickPixelIterator on success; on failure, throws
- * ImagickPixelIteratorException.
+ * {@inheritdoc}
+ * @param Imagick $imagick
+ * @param int $x
+ * @param int $y
+ * @param int $columns
+ * @param int $rows
*/
- public function newPixelRegionIterator (Imagick $wand, int $x, int $y, int $columns, int $rows): bool {}
+ public function newPixelRegionIterator (Imagick $imagick, int $x, int $y, int $columns, int $rows): bool {}
/**
- * Resets the pixel iterator
- * @link http://www.php.net/manual/en/imagickpixeliterator.resetiterator.php
- * @return bool Returns true on success.
+ * {@inheritdoc}
*/
public function resetIterator (): bool {}
/**
- * Sets the pixel iterator to the first pixel row
- * @link http://www.php.net/manual/en/imagickpixeliterator.setiteratorfirstrow.php
- * @return bool Returns true on success.
+ * {@inheritdoc}
*/
public function setIteratorFirstRow (): bool {}
/**
- * Sets the pixel iterator to the last pixel row
- * @link http://www.php.net/manual/en/imagickpixeliterator.setiteratorlastrow.php
- * @return bool Returns true on success.
+ * {@inheritdoc}
*/
public function setIteratorLastRow (): bool {}
/**
- * Set the pixel iterator row
- * @link http://www.php.net/manual/en/imagickpixeliterator.setiteratorrow.php
- * @param int $row
- * @return bool Returns true on success.
+ * {@inheritdoc}
+ * @param int $row
*/
public function setIteratorRow (int $row): bool {}
/**
- * Syncs the pixel iterator
- * @link http://www.php.net/manual/en/imagickpixeliterator.synciterator.php
- * @return bool Returns true on success.
+ * {@inheritdoc}
*/
public function syncIterator (): bool {}
@@ -5584,175 +4459,127 @@ public function valid (): bool {}
}
-/**
- * @link http://www.php.net/manual/en/class.imagickpixel.php
- */
class ImagickPixel {
/**
- * The ImagickPixel constructor
- * @link http://www.php.net/manual/en/imagickpixel.construct.php
- * @param string $color [optional]
- * @return string Returns an ImagickPixel object on success, throwing ImagickPixelException on
- * failure.
+ * {@inheritdoc}
+ * @param string|null $color [optional]
*/
- public function __construct (string $color = null): string {}
+ public function __construct (?string $color = NULL) {}
/**
- * Clears resources associated with this object
- * @link http://www.php.net/manual/en/imagickpixel.clear.php
- * @return bool Returns true on success.
+ * {@inheritdoc}
*/
public function clear (): bool {}
/**
- * Deallocates resources associated with this object
- * @link http://www.php.net/manual/en/imagickpixel.destroy.php
- * @return bool Returns true on success.
+ * {@inheritdoc}
*/
public function destroy (): bool {}
/**
- * Returns the color
- * @link http://www.php.net/manual/en/imagickpixel.getcolor.php
- * @param int $normalized [optional]
- * @return array An array of channel values. Throws ImagickPixelException on error.
+ * {@inheritdoc}
+ * @param int $normalized [optional]
*/
- public function getColor (int $normalized = null): array {}
+ public function getColor (int $normalized = 0): array {}
/**
- * Returns the color as a string
- * @link http://www.php.net/manual/en/imagickpixel.getcolorasstring.php
- * @return string Returns the color of the ImagickPixel object as a string.
+ * {@inheritdoc}
*/
public function getColorAsString (): string {}
/**
- * Returns the color count associated with this color
- * @link http://www.php.net/manual/en/imagickpixel.getcolorcount.php
- * @return int Returns the color count as an integer on success, throws
- * ImagickPixelException on failure.
+ * {@inheritdoc}
*/
public function getColorCount (): int {}
/**
- * Returns the color of the pixel in an array as Quantum values
- * @link http://www.php.net/manual/en/imagickpixel.getcolorquantum.php
- * @return array Returns an array with keys "r", "g",
- * "b", "a".
+ * {@inheritdoc}
*/
public function getColorQuantum (): array {}
/**
- * Gets the normalized value of the provided color channel
- * @link http://www.php.net/manual/en/imagickpixel.getcolorvalue.php
- * @param int $color
- * @return float The value of the channel, as a normalized floating-point number, throwing
- * ImagickPixelException on error.
+ * {@inheritdoc}
+ * @param int $color
*/
public function getColorValue (int $color): float {}
/**
- * Gets the quantum value of a color in the ImagickPixel
- * @link http://www.php.net/manual/en/imagickpixel.getcolorvaluequantum.php
- * @param int $color
- * @return int|float The quantum value of the color element. Float if ImageMagick was compiled with HDRI, otherwise an int.
+ * {@inheritdoc}
+ * @param int $color
*/
- public function getColorValueQuantum (int $color): int|float {}
+ public function getColorValueQuantum (int $color): float {}
/**
- * Returns the normalized HSL color of the ImagickPixel object
- * @link http://www.php.net/manual/en/imagickpixel.gethsl.php
- * @return array Returns the HSL value in an array with the keys "hue",
- * "saturation", and "luminosity". Throws ImagickPixelException on failure.
+ * {@inheritdoc}
*/
public function getHSL (): array {}
/**
- * Gets the colormap index of the pixel wand
- * @link http://www.php.net/manual/en/imagickpixel.getindex.php
- * @return int
+ * {@inheritdoc}
*/
public function getIndex (): int {}
/**
- * Check the distance between this color and another
- * @link http://www.php.net/manual/en/imagickpixel.ispixelsimilar.php
- * @param ImagickPixel $color
- * @param float $fuzz
- * @return bool Returns true on success.
+ * {@inheritdoc}
+ * @param ImagickPixel|string $color
+ * @param float $fuzz
*/
- public function isPixelSimilar (ImagickPixel $color, float $fuzz): bool {}
+ public function isPixelSimilar (ImagickPixel|string $color, float $fuzz): bool {}
/**
- * Returns whether two colors differ by less than the specified distance
- * @link http://www.php.net/manual/en/imagickpixel.ispixelsimilarquantum.php
- * @param string $color
- * @param string $fuzz [optional]
- * @return bool
+ * {@inheritdoc}
+ * @param ImagickPixel|string $color
+ * @param float $fuzz_quantum_range_scaled_by_square_root_of_three
*/
- public function isPixelSimilarQuantum (string $color, string $fuzz = null): bool {}
+ public function isPixelSimilarQuantum (ImagickPixel|string $color, float $fuzz_quantum_range_scaled_by_square_root_of_three): bool {}
/**
- * Check the distance between this color and another
- * @link http://www.php.net/manual/en/imagickpixel.issimilar.php
- * @param ImagickPixel $color
- * @param float $fuzz
- * @return bool Returns true on success.
+ * {@inheritdoc}
+ * @param ImagickPixel|string $color
+ * @param float $fuzz_quantum_range_scaled_by_square_root_of_three
*/
- public function isSimilar (ImagickPixel $color, float $fuzz): bool {}
+ public function isSimilar (ImagickPixel|string $color, float $fuzz_quantum_range_scaled_by_square_root_of_three): bool {}
/**
- * Sets the color
- * @link http://www.php.net/manual/en/imagickpixel.setcolor.php
- * @param string $color
- * @return bool Returns true if the specified color was set, false otherwise.
+ * {@inheritdoc}
+ * @param string $color
*/
public function setColor (string $color): bool {}
/**
- * Sets the color count associated with this color
- * @link http://www.php.net/manual/en/imagickpixel.setcolorcount.php
- * @param int $colorCount
- * @return bool Returns true on success.
+ * {@inheritdoc}
+ * @param int $color_count
*/
- public function setColorCount (int $colorCount): bool {}
+ public function setColorCount (int $color_count): bool {}
/**
- * Sets the normalized value of one of the channels
- * @link http://www.php.net/manual/en/imagickpixel.setcolorvalue.php
- * @param int $color
- * @param float $value
- * @return bool Returns true on success.
+ * {@inheritdoc}
+ * @param int $color
+ * @param float $value
*/
public function setColorValue (int $color, float $value): bool {}
/**
- * Sets the quantum value of a color element of the ImagickPixel
- * @link http://www.php.net/manual/en/imagickpixel.setcolorvaluequantum.php
- * @param int $color Which color element to set e.g. \Imagick::COLOR_GREEN.
- * @param int|float $value The quantum value to set the color element to. This should be a float if ImageMagick was compiled with HDRI otherwise an int in the range 0 to Imagick::getQuantum().
- * @return bool Returns true on success.
+ * {@inheritdoc}
+ * @param int $color
+ * @param float $value
*/
- public function setColorValueQuantum (int $color, int|float $value): bool {}
+ public function setColorValueQuantum (int $color, float $value): bool {}
/**
- * Sets the normalized HSL color
- * @link http://www.php.net/manual/en/imagickpixel.sethsl.php
- * @param float $hue
- * @param float $saturation
- * @param float $luminosity
- * @return bool Returns true on success.
+ * {@inheritdoc}
+ * @param float $hue
+ * @param float $saturation
+ * @param float $luminosity
*/
public function setHSL (float $hue, float $saturation, float $luminosity): bool {}
/**
- * Sets the colormap index of the pixel wand
- * @link http://www.php.net/manual/en/imagickpixel.setindex.php
- * @param int $index
- * @return bool Returns true on success.
+ * {@inheritdoc}
+ * @param float $index
*/
- public function setIndex (int $index): bool {}
+ public function setIndex (float $index): bool {}
/**
* {@inheritdoc}
@@ -5762,65 +4589,48 @@ public function setColorFromPixel (ImagickPixel $pixel): bool {}
}
-/**
- * @link http://www.php.net/manual/en/class.imagickkernel.php
- */
class ImagickKernel {
/**
- * Attach another kernel to a kernel list
- * @link http://www.php.net/manual/en/imagickkernel.addkernel.php
- * @param ImagickKernel $ImagickKernel
- * @return void
+ * {@inheritdoc}
+ * @param ImagickKernel $kernel
*/
- public function addKernel (ImagickKernel $ImagickKernel): void {}
+ public function addKernel (ImagickKernel $kernel): void {}
/**
- * Adds a Unity Kernel to the kernel list
- * @link http://www.php.net/manual/en/imagickkernel.addunitykernel.php
- * @param float $scale
- * @return void
+ * {@inheritdoc}
+ * @param float $scale
*/
public function addUnityKernel (float $scale): void {}
/**
- * Create a kernel from a builtin in kernel
- * @link http://www.php.net/manual/en/imagickkernel.frombuiltin.php
- * @param int $kernelType
- * @param string $kernelString A string that describes the parameters e.g. "4,2.5"
- * @return ImagickKernel
+ * {@inheritdoc}
+ * @param int $kernel
+ * @param string $shape
*/
- public static function fromBuiltin (int $kernelType, string $kernelString): ImagickKernel {}
+ public static function fromBuiltin (int $kernel, string $shape): ImagickKernel {}
/**
- * Create a kernel from a 2d matrix of values
- * @link http://www.php.net/manual/en/imagickkernel.frommatrix.php
- * @param array $matrix
- * @param array $origin [optional]
- * @return ImagickKernel The generated ImagickKernel.
+ * {@inheritdoc}
+ * @param array $matrix
+ * @param array|null $origin
*/
- public static function fromMatrix (array $matrix, array $origin = null): ImagickKernel {}
+ public static function fromMatrix (array $matrix, ?array $origin = null): ImagickKernel {}
/**
- * Get the 2d matrix of values used in this kernel
- * @link http://www.php.net/manual/en/imagickkernel.getmatrix.php
- * @return array A matrix (2d array) of the values that represent the kernel.
+ * {@inheritdoc}
*/
public function getMatrix (): array {}
/**
- * Scales a kernel list by the given amount
- * @link http://www.php.net/manual/en/imagickkernel.scale.php
- * @param float $scale
- * @param int $normalizeFlag [optional]
- * @return void
+ * {@inheritdoc}
+ * @param float $scale
+ * @param int|null $normalize_kernel [optional]
*/
- public function scale (float $scale, int $normalizeFlag = null): void {}
+ public function scale (float $scale, ?int $normalize_kernel = NULL): void {}
/**
- * Separates a linked set of kernels and returns an array of ImagickKernels
- * @link http://www.php.net/manual/en/imagickkernel.separate.php
- * @return array
+ * {@inheritdoc}
*/
public function separate (): array {}
diff --git a/plugins/org.eclipse.php.core/Resources/language/php8.3/imap.php b/plugins/org.eclipse.php.core/Resources/language/php8.3/imap.php
index 4960e17181..fc7c11f203 100644
--- a/plugins/org.eclipse.php.core/Resources/language/php8.3/imap.php
+++ b/plugins/org.eclipse.php.core/Resources/language/php8.3/imap.php
@@ -1,13 +1,9 @@
- *
- * toaddress - full to: line, up to 1024 characters
- *
- * to - an array of objects from the To: line, with the following
- * properties: personal, adl,
- * mailbox, and host
- *
- * fromaddress - full from: line, up to 1024 characters
- *
- * from - an array of objects from the From: line, with the following
- * properties: personal, adl,
- * mailbox, and host
- *
- * ccaddress - full cc: line, up to 1024 characters
- *
- * cc - an array of objects from the Cc: line, with the following
- * properties: personal, adl,
- * mailbox, and host
- *
- * bccaddress - full bcc: line, up to 1024 characters
- *
- * bcc - an array of objects from the Bcc: line, with the following
- * properties: personal, adl,
- * mailbox, and host
- *
- * reply_toaddress - full Reply-To: line, up to 1024 characters
- *
- * reply_to - an array of objects from the Reply-To: line, with the following
- * properties: personal, adl,
- * mailbox, and host
- *
- * senderaddress - full sender: line, up to 1024 characters
- *
- * sender - an array of objects from the Sender: line, with the following
- * properties: personal, adl,
- * mailbox, and host
- *
- * return_pathaddress - full Return-Path: line, up to 1024 characters
- *
- * return_path - an array of objects from the Return-Path: line, with the
- * following properties: personal,
- * adl, mailbox, and
- * host
- *
- * remail -
- *
- * date - The message date as found in its headers
- *
- * Date - Same as date
- *
- * subject - The message subject
- *
- * Subject - Same as subject
- *
- * in_reply_to -
- *
- * message_id -
- *
- * newsgroups -
- *
- * followup_to -
- *
- * references -
- *
- * Recent - R if recent and seen, N
- * if recent and not seen, ' ' if not recent.
- *
- * Unseen - U if not seen AND not recent, ' ' if seen
- * OR not seen and recent
- *
- * Flagged - F if flagged, ' ' if not flagged
- *
- * Answered - A if answered, ' ' if unanswered
- *
- * Deleted - D if deleted, ' ' if not deleted
- *
- * Draft - X if draft, ' ' if not draft
- *
- * Msgno - The message number
- *
- * MailDate -
- *
- * Size - The message size
- *
- * udate - mail message date in Unix time
- *
- * fetchfrom - from line formatted to fit from_length
- * characters
- *
- * fetchsubject - subject line formatted to fit
- * subject_length characters
- *
- * mailbox - the mailbox name (username)
- *
- * host - the host name
- *
- * personal - the personal name
- *
- * adl - at domain source route
type | - *Primary body type | - *
encoding | - *Body transfer encoding | - *
ifsubtype | - *true if there is a subtype string | - *
subtype | - *MIME subtype | - *
ifdescription | - *true if there is a description string | - *
description | - *Content description string | - *
ifid | - *true if there is an identification string | - *
id | - *Identification string | - *
lines | - *Number of lines | - *
bytes | - *Number of bytes | - *
ifdisposition | - *true if there is a disposition string | - *
disposition | - *Disposition string | - *
ifdparameters | - *true if the dparameters array exists | - *
dparameters | - *An array of objects where each object has an - * "attribute" and a "value" - * property corresponding to the parameters on the - * Content-disposition MIME - * header. | - *
ifparameters | - *true if the parameters array exists | - *
parameters | - *An array of objects where each object has an - * "attribute" and a "value" - * property. | - *
parts | - *An array of objects identical in structure to the top-level - * object, each of which corresponds to a MIME body - * part. | - *
Value | Type | Constant |
0 | text | TYPETEXT |
1 | multipart | TYPEMULTIPART |
2 | message | TYPEMESSAGE |
3 | application | TYPEAPPLICATION |
4 | audio | TYPEAUDIO |
5 | image | TYPEIMAGE |
6 | video | TYPEVIDEO |
7 | model | TYPEMODEL |
8 | other | TYPEOTHER |
Value | Type | Constant |
0 | 7bit | ENC7BIT |
1 | 8bit | ENC8BIT |
2 | Binary | ENCBINARY |
3 | Base64 | ENCBASE64 |
4 | Quoted-Printable | ENCQUOTEDPRINTABLE |
5 | other | ENCOTHER |
- *
- * Date - current system time formatted according to RFC2822
- *
- * Driver - protocol used to access this mailbox:
- * POP3, IMAP, NNTP
- *
- * Mailbox - the mailbox name
- *
- * Nmsgs - number of messages in the mailbox
- *
- * Recent - number of recent messages in the mailbox
- *
Returns false on failure.
+ * {@inheritdoc} + * @param IMAP\Connection $imap + * @param int $message_num + * @param string $section + * @param int $flags [optional] + */ +function imap_fetchbody (IMAP\Connection $imap, int $message_num, string $section, int $flags = 0): string|false {} + +/** + * {@inheritdoc} + * @param IMAP\Connection $imap + * @param int $message_num + * @param string $section + * @param int $flags [optional] + */ +function imap_fetchmime (IMAP\Connection $imap, int $message_num, string $section, int $flags = 0): string|false {} + +/** + * {@inheritdoc} + * @param IMAP\Connection $imap + * @param mixed $file + * @param int $message_num + * @param string $section [optional] + * @param int $flags [optional] + */ +function imap_savebody (IMAP\Connection $imap, $file = null, int $message_num, string $section = '', int $flags = 0): bool {} + +/** + * {@inheritdoc} + * @param IMAP\Connection $imap + * @param int $message_num + * @param int $flags [optional] + */ +function imap_fetchheader (IMAP\Connection $imap, int $message_num, int $flags = 0): string|false {} + +/** + * {@inheritdoc} + * @param IMAP\Connection $imap + * @param int $message_num + * @param int $flags [optional] + */ +function imap_fetchstructure (IMAP\Connection $imap, int $message_num, int $flags = 0): stdClass|false {} + +/** + * {@inheritdoc} + * @param IMAP\Connection $imap + * @param int $flags + */ +function imap_gc (IMAP\Connection $imap, int $flags): true {} + +/** + * {@inheritdoc} + * @param IMAP\Connection $imap + */ +function imap_expunge (IMAP\Connection $imap): true {} + +/** + * {@inheritdoc} + * @param IMAP\Connection $imap + * @param string $message_nums + * @param int $flags [optional] + */ +function imap_delete (IMAP\Connection $imap, string $message_nums, int $flags = 0): true {} + +/** + * {@inheritdoc} + * @param IMAP\Connection $imap + * @param string $message_nums + * @param int $flags [optional] + */ +function imap_undelete (IMAP\Connection $imap, string $message_nums, int $flags = 0): true {} + +/** + * {@inheritdoc} + * @param IMAP\Connection $imap */ function imap_check (IMAP\Connection $imap): stdClass|false {} /** - * Returns the list of mailboxes that matches the given text - * @link http://www.php.net/manual/en/function.imap-listscan.php - * @param IMAP\Connection $imap - * @param string $reference - * @param string $pattern - * @param string $content - * @return array|false Returns an array containing the names of the mailboxes that have - * content in the text of the mailbox, or false on failure. + * {@inheritdoc} + * @param IMAP\Connection $imap + * @param string $reference + * @param string $pattern + * @param string $content */ function imap_listscan (IMAP\Connection $imap, string $reference, string $pattern, string $content): array|false {} /** - * Alias of imap_listscan - * @link http://www.php.net/manual/en/function.imap-scan.php - * @param IMAP\Connection $imap - * @param string $reference - * @param string $pattern - * @param string $content - * @return array|false Returns an array containing the names of the mailboxes that have - * content in the text of the mailbox, or false on failure. + * {@inheritdoc} + * @param IMAP\Connection $imap + * @param string $reference + * @param string $pattern + * @param string $content */ function imap_scan (IMAP\Connection $imap, string $reference, string $pattern, string $content): array|false {} /** - * Alias of imap_listscan - * @link http://www.php.net/manual/en/function.imap-scanmailbox.php - * @param IMAP\Connection $imap - * @param string $reference - * @param string $pattern - * @param string $content - * @return array|false Returns an array containing the names of the mailboxes that have - * content in the text of the mailbox, or false on failure. + * {@inheritdoc} + * @param IMAP\Connection $imap + * @param string $reference + * @param string $pattern + * @param string $content */ function imap_scanmailbox (IMAP\Connection $imap, string $reference, string $pattern, string $content): array|false {} /** - * Copy specified messages to a mailbox - * @link http://www.php.net/manual/en/function.imap-mail-copy.php - * @param IMAP\Connection $imap - * @param string $message_nums - * @param string $mailbox - * @param int $flags [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param IMAP\Connection $imap + * @param string $message_nums + * @param string $mailbox + * @param int $flags [optional] */ -function imap_mail_copy (IMAP\Connection $imap, string $message_nums, string $mailbox, int $flags = null): bool {} +function imap_mail_copy (IMAP\Connection $imap, string $message_nums, string $mailbox, int $flags = 0): bool {} /** - * Move specified messages to a mailbox - * @link http://www.php.net/manual/en/function.imap-mail-move.php - * @param IMAP\Connection $imap - * @param string $message_nums - * @param string $mailbox - * @param int $flags [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param IMAP\Connection $imap + * @param string $message_nums + * @param string $mailbox + * @param int $flags [optional] */ -function imap_mail_move (IMAP\Connection $imap, string $message_nums, string $mailbox, int $flags = null): bool {} +function imap_mail_move (IMAP\Connection $imap, string $message_nums, string $mailbox, int $flags = 0): bool {} /** - * Create a MIME message based on given envelope and body sections - * @link http://www.php.net/manual/en/function.imap-mail-compose.php - * @param array $envelope - * @param array $bodies - * @return string|false Returns the MIME message as string, or false on failure. + * {@inheritdoc} + * @param array $envelope + * @param array $bodies */ function imap_mail_compose (array $envelope, array $bodies): string|false {} /** - * Create a new mailbox - * @link http://www.php.net/manual/en/function.imap-createmailbox.php - * @param IMAP\Connection $imap - * @param string $mailbox - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param IMAP\Connection $imap + * @param string $mailbox */ function imap_createmailbox (IMAP\Connection $imap, string $mailbox): bool {} /** - * Alias of imap_createmailbox - * @link http://www.php.net/manual/en/function.imap-create.php - * @param IMAP\Connection $imap - * @param string $mailbox - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param IMAP\Connection $imap + * @param string $mailbox */ function imap_create (IMAP\Connection $imap, string $mailbox): bool {} /** - * Rename an old mailbox to new mailbox - * @link http://www.php.net/manual/en/function.imap-renamemailbox.php - * @param IMAP\Connection $imap - * @param string $from - * @param string $to - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param IMAP\Connection $imap + * @param string $from + * @param string $to */ function imap_renamemailbox (IMAP\Connection $imap, string $from, string $to): bool {} /** - * Alias of imap_renamemailbox - * @link http://www.php.net/manual/en/function.imap-rename.php - * @param IMAP\Connection $imap - * @param string $from - * @param string $to - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param IMAP\Connection $imap + * @param string $from + * @param string $to */ function imap_rename (IMAP\Connection $imap, string $from, string $to): bool {} /** - * Delete a mailbox - * @link http://www.php.net/manual/en/function.imap-deletemailbox.php - * @param IMAP\Connection $imap - * @param string $mailbox - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param IMAP\Connection $imap + * @param string $mailbox */ function imap_deletemailbox (IMAP\Connection $imap, string $mailbox): bool {} /** - * Subscribe to a mailbox - * @link http://www.php.net/manual/en/function.imap-subscribe.php - * @param IMAP\Connection $imap - * @param string $mailbox - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param IMAP\Connection $imap + * @param string $mailbox */ function imap_subscribe (IMAP\Connection $imap, string $mailbox): bool {} /** - * Unsubscribe from a mailbox - * @link http://www.php.net/manual/en/function.imap-unsubscribe.php - * @param IMAP\Connection $imap - * @param string $mailbox - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param IMAP\Connection $imap + * @param string $mailbox */ function imap_unsubscribe (IMAP\Connection $imap, string $mailbox): bool {} /** - * Append a string message to a specified mailbox - * @link http://www.php.net/manual/en/function.imap-append.php - * @param IMAP\Connection $imap - * @param string $folder - * @param string $message - * @param string|null $options [optional] - * @param string|null $internal_date [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param IMAP\Connection $imap + * @param string $folder + * @param string $message + * @param string|null $options [optional] + * @param string|null $internal_date [optional] */ -function imap_append (IMAP\Connection $imap, string $folder, string $message, ?string $options = null, ?string $internal_date = null): bool {} +function imap_append (IMAP\Connection $imap, string $folder, string $message, ?string $options = NULL, ?string $internal_date = NULL): bool {} /** - * Check if the IMAP stream is still active - * @link http://www.php.net/manual/en/function.imap-ping.php - * @param IMAP\Connection $imap - * @return bool Returns true if the stream is still alive, false otherwise. + * {@inheritdoc} + * @param IMAP\Connection $imap */ function imap_ping (IMAP\Connection $imap): bool {} /** - * Decode BASE64 encoded text - * @link http://www.php.net/manual/en/function.imap-base64.php - * @param string $string - * @return string|false Returns the decoded message as a string, or false on failure. + * {@inheritdoc} + * @param string $string */ function imap_base64 (string $string): string|false {} /** - * Convert a quoted-printable string to an 8 bit string - * @link http://www.php.net/manual/en/function.imap-qprint.php - * @param string $string - * @return string|false Returns an 8 bits string, or false on failure. + * {@inheritdoc} + * @param string $string */ function imap_qprint (string $string): string|false {} /** - * Convert an 8bit string to a quoted-printable string - * @link http://www.php.net/manual/en/function.imap-8bit.php - * @param string $string - * @return string|false Returns a quoted-printable string, or false on failure. + * {@inheritdoc} + * @param string $string */ function imap_8bit (string $string): string|false {} /** - * Convert an 8bit string to a base64 string - * @link http://www.php.net/manual/en/function.imap-binary.php - * @param string $string - * @return string|false Returns a base64 encoded string, or false on failure. + * {@inheritdoc} + * @param string $string */ function imap_binary (string $string): string|false {} /** - * Converts MIME-encoded text to UTF-8 - * @link http://www.php.net/manual/en/function.imap-utf8.php - * @param string $mime_encoded_text - * @return string Returns the decoded string, if possible converted to UTF-8. + * {@inheritdoc} + * @param string $mime_encoded_text */ function imap_utf8 (string $mime_encoded_text): string {} /** - * Returns status information on a mailbox - * @link http://www.php.net/manual/en/function.imap-status.php - * @param IMAP\Connection $imap - * @param string $mailbox - * @param int $flags - * @return stdClass|false This function returns an object containing status information, or false on failure. - * The object has the following properties: messages, - * recent, unseen, - * uidnext, and uidvalidity. - *flags is also set, which contains a bitmask which can - * be checked against any of the above constants.
+ * {@inheritdoc} + * @param IMAP\Connection $imap + * @param string $mailbox + * @param int $flags */ function imap_status (IMAP\Connection $imap, string $mailbox, int $flags): stdClass|false {} /** - * Get information about the current mailbox - * @link http://www.php.net/manual/en/function.imap-mailboxmsginfo.php - * @param IMAP\Connection $imap - * @return stdClass Returns the information in an object with following properties: - *Date | - *date of last change (current datetime) | - *
Driver | - *driver | - *
Mailbox | - *name of the mailbox | - *
Nmsgs | - *number of messages | - *
Recent | - *number of recent messages | - *
Unread | - *number of unread messages | - *
Deleted | - *number of deleted messages | - *
Size | - *mailbox size | - *
- *
- * LATT_NOINFERIORS - This mailbox has no
- * "children" (there are no mailboxes below this one).
- *
- * LATT_NOSELECT - This is only a container,
- * not a mailbox - you cannot open it.
- *
- * LATT_MARKED - This mailbox is marked.
- * Only used by UW-IMAPD.
- *
- * LATT_UNMARKED - This mailbox is not marked.
- * Only used by UW-IMAPD.
- *
- * LATT_REFERRAL - This container has a referral to a remote mailbox.
- *
- * LATT_HASCHILDREN - This mailbox has selectable inferiors.
- *
- * LATT_HASNOCHILDREN - This mailbox has no selectable inferiors.
- *
- *
- *
- * LATT_NOINFERIORS - This mailbox not contains, and may not contain any - * "children" (there are no mailboxes below this one). Calling - * imap_createmailbox will not work on this mailbox. - *
- *- * LATT_NOSELECT - This is only a container, - * not a mailbox - you cannot open it. - *
- *- * LATT_MARKED - This mailbox is marked. This means that it may - * contain new messages since the last time it was checked. Not provided by all IMAP - * servers. - *
- *- * LATT_UNMARKED - This mailbox is not marked, does not contain new - * messages. If either MARKED or UNMARKED is - * provided, you can assume the IMAP server supports this feature for this mailbox. - *
- *- * LATT_REFERRAL - This container has a referral to a remote mailbox. - *
- *- * LATT_HASCHILDREN - This mailbox has selectable inferiors. - *
- *- * LATT_HASNOCHILDREN - This mailbox has no selectable inferiors. - *
- * - * The function returns false on failure. - *LATT_NOINFERIORS - This mailbox not contains, and may not contain any - * "children" (there are no mailboxes below this one). Calling - * imap_createmailbox will not work on this mailbox.
- *LATT_NOSELECT - This is only a container, - * not a mailbox - you cannot open it.
- *LATT_MARKED - This mailbox is marked. This means that it may - * contain new messages since the last time it was checked. Not provided by all IMAP - * servers.
- *LATT_UNMARKED - This mailbox is not marked, does not contain new - * messages. If either MARKED or UNMARKED is - * provided, you can assume the IMAP server supports this feature for this mailbox.
- *LATT_REFERRAL - This container has a referral to a remote mailbox.
- *LATT_HASCHILDREN - This mailbox has selectable inferiors.
- *LATT_HASNOCHILDREN - This mailbox has no selectable inferiors.
+ * {@inheritdoc} + * @param IMAP\Connection $imap + * @param string $reference + * @param string $pattern */ function imap_getmailboxes (IMAP\Connection $imap, string $reference, string $pattern): array|false {} /** - * Read an overview of the information in the headers of the given message - * @link http://www.php.net/manual/en/function.imap-fetch-overview.php - * @param IMAP\Connection $imap - * @param string $sequence - * @param int $flags [optional] - * @return array|false Returns an array of objects describing one message header each. - * The object will only define a property if it exists. The possible - * properties are: - *
- *
- * subject - the messages subject
- *
- * from - who sent it
- *
- * to - recipient
- *
- * date - when was it sent
- *
- * message_id - Message-ID
- *
- * references - is a reference to this message id
- *
- * in_reply_to - is a reply to this message id
- *
- * size - size in bytes
- *
- * uid - UID the message has in the mailbox
- *
- * msgno - message sequence number in the mailbox
- *
- * recent - this message is flagged as recent
- *
- * flagged - this message is flagged
- *
- * answered - this message is flagged as answered
- *
- * deleted - this message is flagged for deletion
- *
- * seen - this message is flagged as already read
- *
- * draft - this message is flagged as being a draft
- *
- * udate - the UNIX timestamp of the arrival date
- *
Return false if it does not understand the search - * criteria or no messages have been found.
+ * {@inheritdoc} + * @param IMAP\Connection $imap + * @param string $criteria + * @param int $flags [optional] + * @param string $charset [optional] */ -function imap_search (IMAP\Connection $imap, string $criteria, int $flags = SE_FREE, string $charset = '""'): array|false {} +function imap_search (IMAP\Connection $imap, string $criteria, int $flags = 2, string $charset = ''): array|false {} /** - * Decodes a modified UTF-7 encoded string - * @link http://www.php.net/manual/en/function.imap-utf7-decode.php - * @param string $string - * @return string|false Returns a string that is encoded in ISO-8859-1 and consists of the same - * sequence of characters in string, or false - * if string contains invalid modified UTF-7 sequence - * or string contains a character that is not part of - * ISO-8859-1 character set. + * {@inheritdoc} + * @param string $string */ function imap_utf7_decode (string $string): string|false {} /** - * Converts ISO-8859-1 string to modified UTF-7 text - * @link http://www.php.net/manual/en/function.imap-utf7-encode.php - * @param string $string - * @return string Returns string encoded with the modified UTF-7 - * encoding as defined in RFC 2060, - * section 5.1.3. + * {@inheritdoc} + * @param string $string */ function imap_utf7_encode (string $string): string {} /** - * Encode a UTF-8 string to modified UTF-7 - * @link http://www.php.net/manual/en/function.imap-utf8-to-mutf7.php - * @param string $string A UTF-8 encoded string. - * @return string|false Returns string converted to modified UTF-7, - * or false on failure. + * {@inheritdoc} + * @param string $string */ function imap_utf8_to_mutf7 (string $string): string|false {} /** - * Decode a modified UTF-7 string to UTF-8 - * @link http://www.php.net/manual/en/function.imap-mutf7-to-utf8.php - * @param string $string A string encoded in modified UTF-7. - * @return string|false Returns string converted to UTF-8, - * or false on failure. + * {@inheritdoc} + * @param string $string */ function imap_mutf7_to_utf8 (string $string): string|false {} /** - * Decode MIME header elements - * @link http://www.php.net/manual/en/function.imap-mime-header-decode.php - * @param string $string - * @return array|false The decoded elements are returned in an array of objects, where each - * object has two properties, charset and - * text. - *If the element hasn't been encoded, and in other words is in - * plain US-ASCII, the charset property of that element is - * set to default.
- *The function returns false on failure.
+ * {@inheritdoc} + * @param string $string */ function imap_mime_header_decode (string $string): array|false {} /** - * Returns a tree of threaded message - * @link http://www.php.net/manual/en/function.imap-thread.php - * @param IMAP\Connection $imap - * @param int $flags [optional] - * @return array|false imap_thread returns an associative array containing - * a tree of messages threaded by REFERENCES, or false - * on error. - *Every message in the current mailbox will be represented by three entries - * in the resulting array: - *
- *
- * $thread["XX.num"] - current message number - *
- *- * $thread["XX.next"] - *
- *- * $thread["XX.branch"] - *
- * - *$thread["XX.num"] - current message number
- *$thread["XX.next"]
- *$thread["XX.branch"]
- */ -function imap_thread (IMAP\Connection $imap, int $flags = SE_FREE): array|false {} - -/** - * Set or fetch imap timeout - * @link http://www.php.net/manual/en/function.imap-timeout.php - * @param int $timeout_type - * @param int $timeout [optional] - * @return int|bool If the timeout parameter is set, this function - * returns true on success and false on failure. - *If timeout is not provided or evaluates to -1, - * the current timeout value of timeout_type is - * returned as an integer.
+ * {@inheritdoc} + * @param IMAP\Connection $imap + * @param int $flags [optional] + */ +function imap_thread (IMAP\Connection $imap, int $flags = 2): array|false {} + +/** + * {@inheritdoc} + * @param int $timeout_type + * @param int $timeout [optional] */ function imap_timeout (int $timeout_type, int $timeout = -1): int|bool {} /** - * Retrieve the quota level settings, and usage statics per mailbox - * @link http://www.php.net/manual/en/function.imap-get-quota.php - * @param IMAP\Connection $imap - * @param string $quota_root - * @return array|false Returns an array with integer values limit and usage for the given - * mailbox. The value of limit represents the total amount of space - * allowed for this mailbox. The usage value represents the mailboxes - * current level of capacity. Will return false in the case of failure. - *As of PHP 4.3, the function more properly reflects the - * functionality as dictated by the RFC2087. - * The array return value has changed to support an unlimited number of returned - * resources (i.e. messages, or sub-folders) with each named resource receiving - * an individual array key. Each key value then contains an another array with - * the usage and limit values within it.
- *For backwards compatibility reasons, the original access methods are - * still available for use, although it is suggested to update.
+ * {@inheritdoc} + * @param IMAP\Connection $imap + * @param string $quota_root */ function imap_get_quota (IMAP\Connection $imap, string $quota_root): array|false {} /** - * Retrieve the quota settings per user - * @link http://www.php.net/manual/en/function.imap-get-quotaroot.php - * @param IMAP\Connection $imap - * @param string $mailbox - * @return array|false Returns an array of integer values pertaining to the specified user - * mailbox. All values contain a key based upon the resource name, and a - * corresponding array with the usage and limit values within. - *This function will return false in the case of call failure, and an - * array of information about the connection upon an un-parsable response - * from the server.
+ * {@inheritdoc} + * @param IMAP\Connection $imap + * @param string $mailbox */ function imap_get_quotaroot (IMAP\Connection $imap, string $mailbox): array|false {} /** - * Sets a quota for a given mailbox - * @link http://www.php.net/manual/en/function.imap-set-quota.php - * @param IMAP\Connection $imap - * @param string $quota_root - * @param int $mailbox_size - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param IMAP\Connection $imap + * @param string $quota_root + * @param int $mailbox_size */ function imap_set_quota (IMAP\Connection $imap, string $quota_root, int $mailbox_size): bool {} /** - * Sets the ACL for a given mailbox - * @link http://www.php.net/manual/en/function.imap-setacl.php - * @param IMAP\Connection $imap - * @param string $mailbox - * @param string $user_id - * @param string $rights - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param IMAP\Connection $imap + * @param string $mailbox + * @param string $user_id + * @param string $rights */ function imap_setacl (IMAP\Connection $imap, string $mailbox, string $user_id, string $rights): bool {} /** - * Gets the ACL for a given mailbox - * @link http://www.php.net/manual/en/function.imap-getacl.php - * @param IMAP\Connection $imap - * @param string $mailbox - * @return array|false Returns an associative array of "folder" => "acl" pairs, or false on failure. + * {@inheritdoc} + * @param IMAP\Connection $imap + * @param string $mailbox */ function imap_getacl (IMAP\Connection $imap, string $mailbox): array|false {} /** - * Send an email message - * @link http://www.php.net/manual/en/function.imap-mail.php - * @param string $to - * @param string $subject - * @param string $message - * @param string|null $additional_headers [optional] - * @param string|null $cc [optional] - * @param string|null $bcc [optional] - * @param string|null $return_path [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $to + * @param string $subject + * @param string $message + * @param string|null $additional_headers [optional] + * @param string|null $cc [optional] + * @param string|null $bcc [optional] + * @param string|null $return_path [optional] */ -function imap_mail (string $to, string $subject, string $message, ?string $additional_headers = null, ?string $cc = null, ?string $bcc = null, ?string $return_path = null): bool {} - +function imap_mail (string $to, string $subject, string $message, ?string $additional_headers = NULL, ?string $cc = NULL, ?string $bcc = NULL, ?string $return_path = NULL): bool {} -/** - * Deprecated as of PHP 8.1.0. - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('NIL', 0); - -/** - * - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('IMAP_OPENTIMEOUT', 1); - -/** - * - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('IMAP_READTIMEOUT', 2); - -/** - * - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('IMAP_WRITETIMEOUT', 3); - -/** - * - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('IMAP_CLOSETIMEOUT', 4); - -/** - * - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('OP_DEBUG', 1); - -/** - * Open mailbox read-only - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('OP_READONLY', 2); - -/** - * Don't use or update a .newsrc for news - * (NNTP only) - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('OP_ANONYMOUS', 4); - -/** - * - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('OP_SHORTCACHE', 8); - -/** - * - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('OP_SILENT', 16); - -/** - * - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('OP_PROTOTYPE', 32); - -/** - * For IMAP and NNTP - * names, open a connection but don't open a mailbox. - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('OP_HALFOPEN', 64); - -/** - * - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('OP_EXPUNGE', 128); - -/** - * - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('OP_SECURE', 256); - -/** - * silently expunge the mailbox before closing when - * calling imap_close - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('CL_EXPUNGE', 32768); - -/** - * The parameter is a UID - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('FT_UID', 1); - -/** - * Do not set the \Seen flag if not already set - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('FT_PEEK', 2); - -/** - * - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('FT_NOT', 4); - -/** - * The return string is in internal format, will not canonicalize to CRLF. - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('FT_INTERNAL', 8); - -/** - * - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('FT_PREFETCHTEXT', 32); - -/** - * The sequence argument contains UIDs instead of sequence numbers - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('ST_UID', 1); - -/** - * - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('ST_SILENT', 2); - -/** - * - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('ST_SET', 4); - -/** - * the sequence numbers contain UIDS - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('CP_UID', 1); - -/** - * Delete the messages from the current mailbox after copying - * with imap_mail_copy - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('CP_MOVE', 2); - -/** - * Return UIDs instead of sequence numbers - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('SE_UID', 1); - -/** - * - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('SE_FREE', 2); - -/** - * Don't prefetch searched messages - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('SE_NOPREFETCH', 4); - -/** - * - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('SO_FREE', 8); - -/** - * - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('SO_NOSERVER', 8); - -/** - * - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('SA_MESSAGES', 1); - -/** - * - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('SA_RECENT', 2); - -/** - * - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('SA_UNSEEN', 4); - -/** - * - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('SA_UIDNEXT', 8); - -/** - * - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('SA_UIDVALIDITY', 16); - -/** - * - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('SA_ALL', 31); - -/** - * This mailbox has no "children" (there are no - * mailboxes below this one). - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('LATT_NOINFERIORS', 1); - -/** - * This is only a container, not a mailbox - you - * cannot open it. - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('LATT_NOSELECT', 2); - -/** - * This mailbox is marked. Only used by UW-IMAPD. - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('LATT_MARKED', 4); - -/** - * This mailbox is not marked. Only used by - * UW-IMAPD. - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('LATT_UNMARKED', 8); - -/** - * This container has a referral to a remote mailbox. - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('LATT_REFERRAL', 16); - -/** - * This mailbox has selectable inferiors. - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('LATT_HASCHILDREN', 32); - -/** - * This mailbox has no selectable inferiors. - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('LATT_HASNOCHILDREN', 64); - -/** - * Sort criteria for imap_sort: - * message Date - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('SORTDATE', 0); - -/** - * Sort criteria for imap_sort: - * arrival date - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('SORTARRIVAL', 1); - -/** - * Sort criteria for imap_sort: - * mailbox in first From address - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('SORTFROM', 2); - -/** - * Sort criteria for imap_sort: - * message subject - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('SORTSUBJECT', 3); - -/** - * Sort criteria for imap_sort: - * mailbox in first To address - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('SORTTO', 4); - -/** - * Sort criteria for imap_sort: - * mailbox in first cc address - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('SORTCC', 5); - -/** - * Sort criteria for imap_sort: - * size of message in octets - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('SORTSIZE', 6); - -/** - * Primary body type: unformatted text - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('TYPETEXT', 0); - -/** - * Primary body type: multiple part - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('TYPEMULTIPART', 1); - -/** - * Primary body type: encapsulated message - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('TYPEMESSAGE', 2); - -/** - * Primary body type: application data - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('TYPEAPPLICATION', 3); - -/** - * Primary body type: audio - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('TYPEAUDIO', 4); - -/** - * Primary body type: static image - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('TYPEIMAGE', 5); - -/** - * Primary body type: video - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('TYPEVIDEO', 6); - -/** - * Primary body type: model - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('TYPEMODEL', 7); - -/** - * Primary body type: unknown - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('TYPEOTHER', 8); - -/** - * Body encoding: 7 bit SMTP semantic data - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('ENC7BIT', 0); - -/** - * Body encoding: 8 bit SMTP semantic data - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('ENC8BIT', 1); - -/** - * Body encoding: 8 bit binary data - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('ENCBINARY', 2); - -/** - * Body encoding: base-64 encoded data - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('ENCBASE64', 3); - -/** - * Body encoding: human-readable 8-as-7 bit data - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('ENCQUOTEDPRINTABLE', 4); - -/** - * Body encoding: unknown - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('ENCOTHER', 5); - -/** - * Garbage collector, clear message cache elements. - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('IMAP_GC_ELT', 1); - -/** - * Garbage collector, clear envelopes and bodies. - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('IMAP_GC_ENV', 2); - -/** - * Garbage collector, clear texts. - * @link http://www.php.net/manual/en/imap.constants.php - * @var int - */ define ('IMAP_GC_TEXTS', 4); } -// End of imap v.8.2.6 +// End of imap v.8.3.0 diff --git a/plugins/org.eclipse.php.core/Resources/language/php8.3/intl.php b/plugins/org.eclipse.php.core/Resources/language/php8.3/intl.php index f8d2dd61b9..544a694685 100644 --- a/plugins/org.eclipse.php.core/Resources/language/php8.3/intl.php +++ b/plugins/org.eclipse.php.core/Resources/language/php8.3/intl.php @@ -1,12 +1,7 @@ - * Collator::ON - * Collator::OFF(default) - * Collator::DEFAULT_VALUE - * - *FRENCH_COLLATION rules - *
- *
- * F=OFF cote < coté < côte < côté - * F=ON cote < côte < coté < côté - *
- * - *F=OFF cote < coté < côte < côté - * F=ON cote < côte < coté < côté
const FRENCH_COLLATION = 0; - /** - * The Alternate attribute is used to control the handling of the so called - * variable characters in the UCA: whitespace, punctuation and symbols. If - * Alternate is set to NonIgnorable - * (N), then differences among these characters are of the same importance - * as differences among letters. If Alternate is set to - * Shifted - * (S), then these characters are of only minor importance. The - * Shifted value is often used in combination with - * Strength - * set to Quaternary. In such a case, whitespace, punctuation, and symbols - * are considered when comparing strings, but only if all other aspects of - * the strings (base letters, accents, and case) are identical. If - * Alternate is not set to Shifted, then there is no difference between a - * Strength of 3 and a Strength of 4. For more information and examples, - * see Variable_Weighting in the - * UCA. - * The reason the Alternate values are not simply - * On and Off - * is that additional Alternate values may be added in the future. The UCA - * option Blanked is expressed with Strength set to 3, and Alternate set to - * Shifted. The default for most locales is NonIgnorable. If Shifted is - * selected, it may be slower if there are many strings that are the same - * except for punctuation; sort key length will not be affected unless the - * strength level is also increased. - *Possible values are: - *
- * Collator::NON_IGNORABLE(default) - * Collator::SHIFTED - * Collator::DEFAULT_VALUE - *
- *ALTERNATE_HANDLING rules - *
- *
- * S=3, A=N di Silva < Di Silva < diSilva < U.S.A. < USA - * S=3, A=S di Silva = diSilva < Di Silva < U.S.A. = USA - * S=4, A=S di Silva < diSilva < Di Silva < U.S.A. < USA - *
- * - *S=3, A=N di Silva < Di Silva < diSilva < U.S.A. < USA - * S=3, A=S di Silva = diSilva < Di Silva < U.S.A. = USA - * S=4, A=S di Silva < diSilva < Di Silva < U.S.A. < USA
const ALTERNATE_HANDLING = 1; - /** - * The Case_First attribute is used to control whether uppercase letters - * come before lowercase letters or vice versa, in the absence of other - * differences in the strings. The possible values are - * Uppercase_First - * (U) and Lowercase_First - * (L), plus the standard Default - * and Off. - * There is almost no difference between the Off and Lowercase_First - * options in terms of results, so typically users will not use - * Lowercase_First: only Off or Uppercase_First. (People interested in the - * detailed differences between X and L should consult the Collation - * Customization). Specifying either L or U won't affect string comparison - * performance, but will affect the sort key length. - *Possible values are: - *
- * Collator::OFF(default) - * Collator::LOWER_FIRST - * Collator::UPPER_FIRST - * Collator:DEFAULT - *
- *CASE_FIRST rules - *
- *
- * C=X or C=L "china" < "China" < "denmark" < "Denmark" - * C=U "China" < "china" < "Denmark" < "denmark" - *
- * - *C=X or C=L "china" < "China" < "denmark" < "Denmark" - * C=U "China" < "china" < "Denmark" < "denmark"
const CASE_FIRST = 2; - /** - * The Case_Level attribute is used when ignoring accents but not case. In - * such a situation, set Strength to be Primary, - * and Case_Level to be On. - * In most locales, this setting is Off by default. There is a small - * string comparison performance and sort key impact if this attribute is - * set to be On. - *Possible values are: - *
- * Collator::OFF(default) - * Collator::ON - * Collator::DEFAULT_VALUE - *
- *CASE_LEVEL rules - *
- *
- * S=1, E=X role = Role = rôle - * S=1, E=O role = rôle < Role - *
- * - *S=1, E=X role = Role = rôle - * S=1, E=O role = rôle < Role
const CASE_LEVEL = 3; - /** - * The Normalization setting determines whether text is thoroughly - * normalized or not in comparison. Even if the setting is off (which is - * the default for many locales), text as represented in common usage will - * compare correctly (for details, see UTN #5). Only if the accent marks - * are in noncanonical order will there be a problem. If the setting is - * On, - * then the best results are guaranteed for all possible text input. - * There is a medium string comparison performance cost if this attribute - * is On, - * depending on the frequency of sequences that require normalization. - * There is no significant effect on sort key length. If the input text is - * known to be in NFD or NFKD normalization forms, there is no need to - * enable this Normalization option. - *Possible values are: - *
- * Collator::OFF(default) - * Collator::ON - * Collator::DEFAULT_VALUE - *
const NORMALIZATION_MODE = 4; - /** - * The ICU Collation Service supports many levels of comparison (named - * "Levels", but also known as "Strengths"). Having these categories - * enables ICU to sort strings precisely according to local conventions. - * However, by allowing the levels to be selectively employed, searching - * for a string in text can be performed with various matching conditions. - * For more detailed information, see - * collator_set_strength chapter. - *Possible values are: - *
- * Collator::PRIMARY - * Collator::SECONDARY - * Collator::TERTIARY(default) - * Collator::QUATERNARY - * Collator::IDENTICAL - * Collator::DEFAULT_VALUE - *
const STRENGTH = 5; - /** - * Compatibility with JIS x 4061 requires the introduction of an additional - * level to distinguish Hiragana and Katakana characters. If compatibility - * with that standard is required, then this attribute should be set - * On, - * and the strength set to Quaternary. This will affect sort key length - * and string comparison string comparison performance. - *Possible values are: - *
- * Collator::OFF(default) - * Collator::ON - * Collator::DEFAULT_VALUE - *
const HIRAGANA_QUATERNARY_MODE = 6; - /** - * When turned on, this attribute generates a collation key for the numeric - * value of substrings of digits. This is a way to get '100' to sort AFTER - * '2'. - *Possible values are: - *
- * Collator::OFF(default) - * Collator::ON - * Collator::DEFAULT_VALUE - *
const NUMERIC_COLLATION = 7; const SORT_REGULAR = 0; const SORT_STRING = 1; @@ -211,578 +30,290 @@ class Collator { /** - * Create a collator - * @link http://www.php.net/manual/en/collator.construct.php - * @param string $locale - * @return string + * {@inheritdoc} + * @param string $locale */ - public function __construct (string $locale): string {} + public function __construct (string $locale) {} /** - * Create a collator - * @link http://www.php.net/manual/en/collator.create.php - * @param string $locale - * @return Collator|null Return new instance of Collator object, or null - * on error. + * {@inheritdoc} + * @param string $locale */ - public static function create (string $locale): ?Collator {} + public static function create (string $locale) {} /** - * Compare two Unicode strings - * @link http://www.php.net/manual/en/collator.compare.php - * @param string $string1 - * @param string $string2 - * @return int|false Return comparison result: - *
- *
- *
- * 1 if string1 is greater than - * string2 ; - *
- *- * 0 if string1 is equal to - * string2; - *
- *- * -1 if string1 is less than - * string2 . - *
- * - * Returns false on failure. - *1 if string1 is greater than - * string2 ;
- *0 if string1 is equal to - * string2;
- *-1 if string1 is less than - * string2 .
+ * {@inheritdoc} + * @param string $string1 + * @param string $string2 */ - public function compare (string $string1, string $string2): int|false {} + public function compare (string $string1, string $string2) {} /** - * Sort array using specified collator - * @link http://www.php.net/manual/en/collator.sort.php - * @param array $array - * @param int $flags [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param array $array + * @param int $flags [optional] */ - public function sort (array &$array, int $flags = \Collator::SORT_REGULAR): bool {} + public function sort (array &$array, int $flags = 0) {} /** - * Sort array using specified collator and sort keys - * @link http://www.php.net/manual/en/collator.sortwithsortkeys.php - * @param array $array - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param array $array */ - public function sortWithSortKeys (array &$array): bool {} + public function sortWithSortKeys (array &$array) {} /** - * Sort array maintaining index association - * @link http://www.php.net/manual/en/collator.asort.php - * @param array $array - * @param int $flags [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param array $array + * @param int $flags [optional] */ - public function asort (array &$array, int $flags = \Collator::SORT_REGULAR): bool {} + public function asort (array &$array, int $flags = 0) {} /** - * Get collation attribute value - * @link http://www.php.net/manual/en/collator.getattribute.php - * @param int $attribute - * @return int|false Attribute value, or false on failure. + * {@inheritdoc} + * @param int $attribute */ - public function getAttribute (int $attribute): int|false {} + public function getAttribute (int $attribute) {} /** - * Set collation attribute - * @link http://www.php.net/manual/en/collator.setattribute.php - * @param int $attribute - * @param int $value - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $attribute + * @param int $value */ - public function setAttribute (int $attribute, int $value): bool {} + public function setAttribute (int $attribute, int $value) {} /** - * Get current collation strength - * @link http://www.php.net/manual/en/collator.getstrength.php - * @return int Returns current collation strength, or false on failure. + * {@inheritdoc} */ - public function getStrength (): int {} + public function getStrength () {} /** - * Set collation strength - * @link http://www.php.net/manual/en/collator.setstrength.php - * @param int $strength - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $strength */ - public function setStrength (int $strength): bool {} + public function setStrength (int $strength) {} /** - * Get the locale name of the collator - * @link http://www.php.net/manual/en/collator.getlocale.php - * @param int $type - * @return string|false Real locale name from which the collation data comes. If the collator was - * instantiated from rules or an error occurred, returns false. + * {@inheritdoc} + * @param int $type */ - public function getLocale (int $type): string|false {} + public function getLocale (int $type) {} /** - * Get collator's last error code - * @link http://www.php.net/manual/en/collator.geterrorcode.php - * @return int|false Error code returned by the last Collator API function call, - * or false on failure. + * {@inheritdoc} */ - public function getErrorCode (): int|false {} + public function getErrorCode () {} /** - * Get text for collator's last error code - * @link http://www.php.net/manual/en/collator.geterrormessage.php - * @return string|false Description of an error occurred in the last Collator API function call, - * or false on failure. + * {@inheritdoc} */ - public function getErrorMessage (): string|false {} + public function getErrorMessage () {} /** - * Get sorting key for a string - * @link http://www.php.net/manual/en/collator.getsortkey.php - * @param string $string - * @return string|false Returns the collation key for the string, or false on failure. + * {@inheritdoc} + * @param string $string */ - public function getSortKey (string $string): string|false {} + public function getSortKey (string $string) {} } -/** - * For currencies you can use currency format type to create a formatter that - * returns a string with the formatted number and the appropriate currency - * sign. Of course, the NumberFormatter class is unaware of exchange rates - * so, the number output is the same regardless of the specified currency. - * This means that the same number has different monetary values depending on - * the currency locale. If the number is 9988776.65 the results will be: - *- * 9 988 776,65 € in France - * 9.988.776,65 € in Germany - * $9,988,776.65 in the United States - *
- * @link http://www.php.net/manual/en/class.numberformatter.php - */ class NumberFormatter { - /** - * Decimal format defined by pattern const PATTERN_DECIMAL = 0; - /** - * Decimal format const DECIMAL = 1; - /** - * Currency format const CURRENCY = 2; - /** - * Percent format const PERCENT = 3; - /** - * Scientific format const SCIENTIFIC = 4; - /** - * Spellout rule-based format const SPELLOUT = 5; - /** - * Ordinal rule-based format const ORDINAL = 6; - /** - * Duration rule-based format const DURATION = 7; - /** - * Rule-based format defined by pattern const PATTERN_RULEBASED = 9; - /** - * Alias for PATTERN_DECIMAL const IGNORE = 0; - /** - * Currency format for accounting, e.g., ($3.00) for negative currency amount - * instead of -$3.00. Available as of PHP 7.4.1 and ICU 53. const CURRENCY_ACCOUNTING = 12; - /** - * Default format for the locale const DEFAULT_STYLE = 1; - /** - * Rounding mode to round towards positive infinity. const ROUND_CEILING = 0; - /** - * Rounding mode to round towards negative infinity. const ROUND_FLOOR = 1; - /** - * Rounding mode to round towards zero. const ROUND_DOWN = 2; - /** - * Rounding mode to round away from zero. const ROUND_UP = 3; - /** - * Rounding mode to round towards the "nearest neighbor" unless both - * neighbors are equidistant, in which case, round towards the even - * neighbor. const ROUND_HALFEVEN = 4; - /** - * Rounding mode to round towards "nearest neighbor" unless both neighbors - * are equidistant, in which case round down. const ROUND_HALFDOWN = 5; - /** - * Rounding mode to round towards "nearest neighbor" unless both neighbors - * are equidistant, in which case round up. const ROUND_HALFUP = 6; - /** - * Pad characters inserted before the prefix. const PAD_BEFORE_PREFIX = 0; - /** - * Pad characters inserted after the prefix. const PAD_AFTER_PREFIX = 1; - /** - * Pad characters inserted before the suffix. const PAD_BEFORE_SUFFIX = 2; - /** - * Pad characters inserted after the suffix. const PAD_AFTER_SUFFIX = 3; - /** - * Parse integers only. const PARSE_INT_ONLY = 0; - /** - * Use grouping separator. const GROUPING_USED = 1; - /** - * Always show decimal point. const DECIMAL_ALWAYS_SHOWN = 2; - /** - * Maximum integer digits. const MAX_INTEGER_DIGITS = 3; - /** - * Minimum integer digits. const MIN_INTEGER_DIGITS = 4; - /** - * Integer digits. const INTEGER_DIGITS = 5; - /** - * Maximum fraction digits. const MAX_FRACTION_DIGITS = 6; - /** - * Minimum fraction digits. const MIN_FRACTION_DIGITS = 7; - /** - * Fraction digits. const FRACTION_DIGITS = 8; - /** - * Multiplier. const MULTIPLIER = 9; - /** - * Grouping size. const GROUPING_SIZE = 10; - /** - * Rounding Mode. const ROUNDING_MODE = 11; - /** - * Rounding increment. const ROUNDING_INCREMENT = 12; - /** - * The width to which the output of format() is padded. const FORMAT_WIDTH = 13; - /** - * The position at which padding will take place. See pad position - * constants for possible argument values. const PADDING_POSITION = 14; - /** - * Secondary grouping size. const SECONDARY_GROUPING_SIZE = 15; - /** - * Use significant digits. const SIGNIFICANT_DIGITS_USED = 16; - /** - * Minimum significant digits. const MIN_SIGNIFICANT_DIGITS = 17; - /** - * Maximum significant digits. const MAX_SIGNIFICANT_DIGITS = 18; - /** - * Lenient parse mode used by rule-based formats. const LENIENT_PARSE = 19; - /** - * Positive prefix. const POSITIVE_PREFIX = 0; - /** - * Positive suffix. const POSITIVE_SUFFIX = 1; - /** - * Negative prefix. const NEGATIVE_PREFIX = 2; - /** - * Negative suffix. const NEGATIVE_SUFFIX = 3; - /** - * The character used to pad to the format width. const PADDING_CHARACTER = 4; - /** - * The ISO currency code. const CURRENCY_CODE = 5; - /** - * The default rule set. This is only available with rule-based - * formatters. const DEFAULT_RULESET = 6; - /** - * The public rule sets. This is only available with rule-based - * formatters. This is a read-only attribute. The public rulesets are - * returned as a single string, with each ruleset name delimited by ';' - * (semicolon). const PUBLIC_RULESETS = 7; - /** - * The decimal separator. const DECIMAL_SEPARATOR_SYMBOL = 0; - /** - * The grouping separator. const GROUPING_SEPARATOR_SYMBOL = 1; - /** - * The pattern separator. const PATTERN_SEPARATOR_SYMBOL = 2; - /** - * The percent sign. const PERCENT_SYMBOL = 3; - /** - * Zero. const ZERO_DIGIT_SYMBOL = 4; - /** - * Character representing a digit in the pattern. const DIGIT_SYMBOL = 5; - /** - * The minus sign. const MINUS_SIGN_SYMBOL = 6; - /** - * The plus sign. const PLUS_SIGN_SYMBOL = 7; - /** - * The currency symbol. const CURRENCY_SYMBOL = 8; - /** - * The international currency symbol. const INTL_CURRENCY_SYMBOL = 9; - /** - * The monetary separator. const MONETARY_SEPARATOR_SYMBOL = 10; - /** - * The exponential symbol. const EXPONENTIAL_SYMBOL = 11; - /** - * Per mill symbol. const PERMILL_SYMBOL = 12; - /** - * Escape padding character. const PAD_ESCAPE_SYMBOL = 13; - /** - * Infinity symbol. const INFINITY_SYMBOL = 14; - /** - * Not-a-number symbol. const NAN_SYMBOL = 15; - /** - * Significant digit symbol. const SIGNIFICANT_DIGIT_SYMBOL = 16; - /** - * The monetary grouping separator. const MONETARY_GROUPING_SEPARATOR_SYMBOL = 17; - /** - * Derive the type from variable type const TYPE_DEFAULT = 0; - /** - * Format/parse as 32-bit integer const TYPE_INT32 = 1; - /** - * Format/parse as 64-bit integer const TYPE_INT64 = 2; - /** - * Format/parse as floating point value const TYPE_DOUBLE = 3; - /** - * Format/parse as currency value const TYPE_CURRENCY = 4; /** - * Create a number formatter - * @link http://www.php.net/manual/en/numberformatter.create.php - * @param string $locale - * @param int $style - * @param string|null $pattern [optional] - * @return NumberFormatter|null Returns NumberFormatter object or null on error. + * {@inheritdoc} + * @param string $locale + * @param int $style + * @param string|null $pattern [optional] */ - public function __construct (string $locale, int $style, ?string $pattern = null): ?NumberFormatter {} + public function __construct (string $locale, int $style, ?string $pattern = NULL) {} /** - * Create a number formatter - * @link http://www.php.net/manual/en/numberformatter.create.php - * @param string $locale - * @param int $style - * @param string|null $pattern [optional] - * @return NumberFormatter|null Returns NumberFormatter object or null on error. + * {@inheritdoc} + * @param string $locale + * @param int $style + * @param string|null $pattern [optional] */ - public static function create (string $locale, int $style, ?string $pattern = null): ?NumberFormatter {} + public static function create (string $locale, int $style, ?string $pattern = NULL) {} /** - * Format a number - * @link http://www.php.net/manual/en/numberformatter.format.php - * @param int|float $num - * @param int $type [optional] - * @return string|false Returns the string containing formatted value, or false on error. + * {@inheritdoc} + * @param int|float $num + * @param int $type [optional] */ - public function format (int|float $num, int $type = \NumberFormatter::TYPE_DEFAULT): string|false {} + public function format (int|float $num, int $type = 0) {} /** - * Parse a number - * @link http://www.php.net/manual/en/numberformatter.parse.php - * @param string $string - * @param int $type [optional] - * @param int $offset [optional] - * @return int|float|false The value of the parsed number or false on error. + * {@inheritdoc} + * @param string $string + * @param int $type [optional] + * @param mixed $offset [optional] */ - public function parse (string $string, int $type = \NumberFormatter::TYPE_DOUBLE, int &$offset = null): int|float|false {} + public function parse (string $string, int $type = 3, &$offset = NULL) {} /** - * Format a currency value - * @link http://www.php.net/manual/en/numberformatter.formatcurrency.php - * @param float $amount - * @param string $currency - * @return string|false String representing the formatted currency value, or false on failure. + * {@inheritdoc} + * @param float $amount + * @param string $currency */ - public function formatCurrency (float $amount, string $currency): string|false {} + public function formatCurrency (float $amount, string $currency) {} /** - * Parse a currency number - * @link http://www.php.net/manual/en/numberformatter.parsecurrency.php - * @param string $string - * @param string $currency - * @param int $offset [optional] - * @return float|false The parsed numeric value or false on error. + * {@inheritdoc} + * @param string $string + * @param mixed $currency + * @param mixed $offset [optional] */ - public function parseCurrency (string $string, string &$currency, int &$offset = null): float|false {} + public function parseCurrency (string $string, &$currency = null, &$offset = NULL) {} /** - * Set an attribute - * @link http://www.php.net/manual/en/numberformatter.setattribute.php - * @param int $attribute - * @param int|float $value - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $attribute + * @param int|float $value */ - public function setAttribute (int $attribute, int|float $value): bool {} + public function setAttribute (int $attribute, int|float $value) {} /** - * Get an attribute - * @link http://www.php.net/manual/en/numberformatter.getattribute.php - * @param int $attribute - * @return int|float|false Return attribute value on success, or false on error. + * {@inheritdoc} + * @param int $attribute */ - public function getAttribute (int $attribute): int|float|false {} + public function getAttribute (int $attribute) {} /** - * Set a text attribute - * @link http://www.php.net/manual/en/numberformatter.settextattribute.php - * @param int $attribute - * @param string $value - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $attribute + * @param string $value */ - public function setTextAttribute (int $attribute, string $value): bool {} + public function setTextAttribute (int $attribute, string $value) {} /** - * Get a text attribute - * @link http://www.php.net/manual/en/numberformatter.gettextattribute.php - * @param int $attribute - * @return string|false Return attribute value on success, or false on error. + * {@inheritdoc} + * @param int $attribute */ - public function getTextAttribute (int $attribute): string|false {} + public function getTextAttribute (int $attribute) {} /** - * Set a symbol value - * @link http://www.php.net/manual/en/numberformatter.setsymbol.php - * @param int $symbol - * @param string $value - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $symbol + * @param string $value */ - public function setSymbol (int $symbol, string $value): bool {} + public function setSymbol (int $symbol, string $value) {} /** - * Get a symbol value - * @link http://www.php.net/manual/en/numberformatter.getsymbol.php - * @param int $symbol - * @return string|false The symbol string or false on error. + * {@inheritdoc} + * @param int $symbol */ - public function getSymbol (int $symbol): string|false {} + public function getSymbol (int $symbol) {} /** - * Set formatter pattern - * @link http://www.php.net/manual/en/numberformatter.setpattern.php - * @param string $pattern - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $pattern */ - public function setPattern (string $pattern): bool {} + public function setPattern (string $pattern) {} /** - * Get formatter pattern - * @link http://www.php.net/manual/en/numberformatter.getpattern.php - * @return string|false Pattern string that is used by the formatter, or false if an error happens. + * {@inheritdoc} */ - public function getPattern (): string|false {} + public function getPattern () {} /** - * Get formatter locale - * @link http://www.php.net/manual/en/numberformatter.getlocale.php - * @param int $type [optional] - * @return string|false The locale name used to create the formatter, or false on failure. + * {@inheritdoc} + * @param int $type [optional] */ - public function getLocale (int $type = ULOC_ACTUAL_LOCALE): string|false {} + public function getLocale (int $type = 0) {} /** - * Get formatter's last error code - * @link http://www.php.net/manual/en/numberformatter.geterrorcode.php - * @return int Returns error code from last formatter call. + * {@inheritdoc} */ - public function getErrorCode (): int {} + public function getErrorCode () {} /** - * Get formatter's last error message - * @link http://www.php.net/manual/en/numberformatter.geterrormessage.php - * @return string Returns error message from last formatter call. + * {@inheritdoc} */ - public function getErrorMessage (): string {} + public function getErrorMessage () {} } -/** - * The Unicode Consortium has defined a number of normalization forms - * reflecting the various needs of applications: - *- * Normalization Form D (NFD) - Canonical Decomposition - * Normalization Form C (NFC) - Canonical Decomposition followed by - * Canonical Composition - * Normalization Form KD (NFKD) - Compatibility Decomposition - * Normalization Form KC (NFKC) - Compatibility Decomposition followed by - * Canonical Composition - *
- * The different forms are defined in terms of a set of transformations on - * the text, transformations that are expressed by both an algorithm and a - * set of data files. - * @link http://www.php.net/manual/en/class.normalizer.php - */ class Normalizer { - /** - * Normalization Form D (NFD) - Canonical Decomposition const FORM_D = 4; const NFD = 4; - /** - * Normalization Form KD (NFKD) - Compatibility Decomposition const FORM_KD = 8; const NFKD = 8; - /** - * Normalization Form C (NFC) - Canonical Decomposition followed by - * Canonical Composition const FORM_C = 16; const NFC = 16; - /** - * Normalization Form KC (NFKC) - Compatibility Decomposition, followed by - * Canonical Composition const FORM_KC = 32; const NFKC = 32; const FORM_KC_CF = 48; @@ -790,706 +321,445 @@ class Normalizer { /** - * Normalizes the input provided and returns the normalized string - * @link http://www.php.net/manual/en/normalizer.normalize.php - * @param string $string - * @param int $form [optional] - * @return string|false The normalized string or false if an error occurred. + * {@inheritdoc} + * @param string $string + * @param int $form [optional] */ - public static function normalize (string $string, int $form = \Normalizer::FORM_C): string|false {} + public static function normalize (string $string, int $form = 16) {} /** - * Checks if the provided string is already in the specified normalization - * form - * @link http://www.php.net/manual/en/normalizer.isnormalized.php - * @param string $string - * @param int $form [optional] - * @return bool true if normalized, false otherwise or if there an error + * {@inheritdoc} + * @param string $string + * @param int $form [optional] */ - public static function isNormalized (string $string, int $form = \Normalizer::FORM_C): bool {} + public static function isNormalized (string $string, int $form = 16) {} /** - * Gets the Decomposition_Mapping property for the given UTF-8 encoded code point - * @link http://www.php.net/manual/en/normalizer.getrawdecomposition.php - * @param string $string The input string, which should be a single, UTF-8 encoded, code point. - * @param int $form [optional] - * @return string|null Returns a string containing the Decomposition_Mapping property, if present in the UCD. - *Returns null if there is no Decomposition_Mapping property for the character.
+ * {@inheritdoc} + * @param string $string + * @param int $form [optional] */ - public static function getRawDecomposition (string $string, int $form = \Normalizer::FORM_C): ?string {} + public static function getRawDecomposition (string $string, int $form = 16) {} } -/** - * Examples of identifiers include: - *- * en-US (English, United States) - * zh-Hant-TW (Chinese, Traditional Script, Taiwan) - * fr-CA, fr-FR (French for Canada and France respectively) - *
- * @link http://www.php.net/manual/en/class.locale.php - */ class Locale { - /** - * This is locale the data actually comes from. const ACTUAL_LOCALE = 0; - /** - * This is the most specific locale supported by ICU. const VALID_LOCALE = 1; - /** - * Used as locale parameter with the methods of the various locale affected classes, - * such as NumberFormatter. This constant would make the methods to use default - * locale. const DEFAULT_LOCALE = null; - /** - * Language subtag const LANG_TAG = "language"; - /** - * Extended language subtag const EXTLANG_TAG = "extlang"; - /** - * Script subtag const SCRIPT_TAG = "script"; - /** - * Region subtag const REGION_TAG = "region"; - /** - * Variant subtag const VARIANT_TAG = "variant"; - /** - * Grandfathered Language subtag const GRANDFATHERED_LANG_TAG = "grandfathered"; - /** - * Private subtag const PRIVATE_TAG = "private"; /** - * Gets the default locale value from the INTL global 'default_locale' - * @link http://www.php.net/manual/en/locale.getdefault.php - * @return string The current runtime locale + * {@inheritdoc} */ - public static function getDefault (): string {} + public static function getDefault () {} /** - * Sets the default runtime locale - * @link http://www.php.net/manual/en/locale.setdefault.php - * @param string $locale - * @return bool Returns true. + * {@inheritdoc} + * @param string $locale */ - public static function setDefault (string $locale): bool {} + public static function setDefault (string $locale) {} /** - * Gets the primary language for the input locale - * @link http://www.php.net/manual/en/locale.getprimarylanguage.php - * @param string $locale - * @return string|null The language code associated with the language. - *>Returns null when the length of locale exceeds INTL_MAX_LOCALE_LEN.
+ * {@inheritdoc} + * @param string $locale */ - public static function getPrimaryLanguage (string $locale): ?string {} + public static function getPrimaryLanguage (string $locale) {} /** - * Gets the script for the input locale - * @link http://www.php.net/manual/en/locale.getscript.php - * @param string $locale - * @return string|null The script subtag for the locale or null if not present + * {@inheritdoc} + * @param string $locale */ - public static function getScript (string $locale): ?string {} + public static function getScript (string $locale) {} /** - * Gets the region for the input locale - * @link http://www.php.net/manual/en/locale.getregion.php - * @param string $locale - * @return string|null The region subtag for the locale or null if not present - *>Returns null when the length of locale exceeds INTL_MAX_LOCALE_LEN.
+ * {@inheritdoc} + * @param string $locale */ - public static function getRegion (string $locale): ?string {} + public static function getRegion (string $locale) {} /** - * Gets the keywords for the input locale - * @link http://www.php.net/manual/en/locale.getkeywords.php - * @param string $locale - * @return array|false|null Associative array containing the keyword-value pairs for this locale - *>Returns null when the length of locale exceeds INTL_MAX_LOCALE_LEN.
+ * {@inheritdoc} + * @param string $locale */ - public static function getKeywords (string $locale): array|false|null {} + public static function getKeywords (string $locale) {} /** - * Returns an appropriately localized display name for script of the input locale - * @link http://www.php.net/manual/en/locale.getdisplayscript.php - * @param string $locale - * @param string|null $displayLocale [optional] - * @return string|false Display name of the script for the locale in the format appropriate for - * displayLocale, or false on failure. + * {@inheritdoc} + * @param string $locale + * @param string|null $displayLocale [optional] */ - public static function getDisplayScript (string $locale, ?string $displayLocale = null): string|false {} + public static function getDisplayScript (string $locale, ?string $displayLocale = NULL) {} /** - * Returns an appropriately localized display name for region of the input locale - * @link http://www.php.net/manual/en/locale.getdisplayregion.php - * @param string $locale - * @param string|null $displayLocale [optional] - * @return string|false Display name of the region for the locale in the format appropriate for - * displayLocale, or false on failure. + * {@inheritdoc} + * @param string $locale + * @param string|null $displayLocale [optional] */ - public static function getDisplayRegion (string $locale, ?string $displayLocale = null): string|false {} + public static function getDisplayRegion (string $locale, ?string $displayLocale = NULL) {} /** - * Returns an appropriately localized display name for the input locale - * @link http://www.php.net/manual/en/locale.getdisplayname.php - * @param string $locale - * @param string|null $displayLocale [optional] - * @return string|false Display name of the locale in the format appropriate for displayLocale, or false on failure. + * {@inheritdoc} + * @param string $locale + * @param string|null $displayLocale [optional] */ - public static function getDisplayName (string $locale, ?string $displayLocale = null): string|false {} + public static function getDisplayName (string $locale, ?string $displayLocale = NULL) {} /** - * Returns an appropriately localized display name for language of the inputlocale - * @link http://www.php.net/manual/en/locale.getdisplaylanguage.php - * @param string $locale - * @param string|null $displayLocale [optional] - * @return string|false Display name of the language for the locale in the format appropriate for - * displayLocale, or false on failure. + * {@inheritdoc} + * @param string $locale + * @param string|null $displayLocale [optional] */ - public static function getDisplayLanguage (string $locale, ?string $displayLocale = null): string|false {} + public static function getDisplayLanguage (string $locale, ?string $displayLocale = NULL) {} /** - * Returns an appropriately localized display name for variants of the input locale - * @link http://www.php.net/manual/en/locale.getdisplayvariant.php - * @param string $locale - * @param string|null $displayLocale [optional] - * @return string|false Display name of the variant for the locale in the format appropriate for - * displayLocale, or false on failure. + * {@inheritdoc} + * @param string $locale + * @param string|null $displayLocale [optional] */ - public static function getDisplayVariant (string $locale, ?string $displayLocale = null): string|false {} + public static function getDisplayVariant (string $locale, ?string $displayLocale = NULL) {} /** - * Returns a correctly ordered and delimited locale ID - * @link http://www.php.net/manual/en/locale.composelocale.php - * @param array $subtags - * @return string|false The corresponding locale identifier, or false when subtags is empty. + * {@inheritdoc} + * @param array $subtags */ - public static function composeLocale (array $subtags): string|false {} + public static function composeLocale (array $subtags) {} /** - * Returns a key-value array of locale ID subtag elements - * @link http://www.php.net/manual/en/locale.parselocale.php - * @param string $locale - * @return array|null Returns an array containing a list of key-value pairs, where the keys - * identify the particular locale ID subtags, and the values are the - * associated subtag values. The array will be ordered as the locale id - * subtags e.g. in the locale id if variants are '-varX-varY-varZ' then the - * returned array will have variant0=>varX , variant1=>varY , - * variant2=>varZ - *Returns null when the length of locale exceeds - * INTL_MAX_LOCALE_LEN.
+ * {@inheritdoc} + * @param string $locale */ - public static function parseLocale (string $locale): ?array {} + public static function parseLocale (string $locale) {} /** - * Gets the variants for the input locale - * @link http://www.php.net/manual/en/locale.getallvariants.php - * @param string $locale - * @return array|null Thenull if not present - *
>Returns null when the length of locale exceeds INTL_MAX_LOCALE_LEN.
+ * {@inheritdoc} + * @param string $locale */ - public static function getAllVariants (string $locale): ?array {} + public static function getAllVariants (string $locale) {} /** - * Checks if a language tag filter matches with locale - * @link http://www.php.net/manual/en/locale.filtermatches.php - * @param string $languageTag - * @param string $locale - * @param bool $canonicalize [optional] - * @return bool|null true if locale matches languageTag false otherwise. - *>Returns null when the length of locale exceeds INTL_MAX_LOCALE_LEN.
+ * {@inheritdoc} + * @param string $languageTag + * @param string $locale + * @param bool $canonicalize [optional] */ - public static function filterMatches (string $languageTag, string $locale, bool $canonicalize = false): ?bool {} + public static function filterMatches (string $languageTag, string $locale, bool $canonicalize = false) {} /** - * Searches the language tag list for the best match to the language - * @link http://www.php.net/manual/en/locale.lookup.php - * @param array $languageTag - * @param string $locale - * @param bool $canonicalize [optional] - * @param string|null $defaultLocale [optional] - * @return string|null The closest matching language tag or default value. - *>Returns null when the length of locale exceeds INTL_MAX_LOCALE_LEN.
+ * {@inheritdoc} + * @param array $languageTag + * @param string $locale + * @param bool $canonicalize [optional] + * @param string|null $defaultLocale [optional] */ - public static function lookup (array $languageTag, string $locale, bool $canonicalize = false, ?string $defaultLocale = null): ?string {} + public static function lookup (array $languageTag, string $locale, bool $canonicalize = false, ?string $defaultLocale = NULL) {} /** - * Canonicalize the locale string - * @link http://www.php.net/manual/en/locale.canonicalize.php - * @param string $locale - * @return string|null Canonicalized locale string. - *>Returns null when the length of locale exceeds INTL_MAX_LOCALE_LEN.
+ * {@inheritdoc} + * @param string $locale */ - public static function canonicalize (string $locale): ?string {} + public static function canonicalize (string $locale) {} /** - * Tries to find out best available locale based on HTTP "Accept-Language" header - * @link http://www.php.net/manual/en/locale.acceptfromhttp.php - * @param string $header - * @return string|false The corresponding locale identifier. - *Returns false when the length of header exceeds - * INTL_MAX_LOCALE_LEN.
+ * {@inheritdoc} + * @param string $header */ - public static function acceptFromHttp (string $header): string|false {} + public static function acceptFromHttp (string $header) {} } -/** - * @link http://www.php.net/manual/en/class.messageformatter.php - */ class MessageFormatter { /** - * Constructs a new Message Formatter - * @link http://www.php.net/manual/en/messageformatter.create.php - * @param string $locale - * @param string $pattern - * @return MessageFormatter|null The formatter object, or null on failure. + * {@inheritdoc} + * @param string $locale + * @param string $pattern */ - public function __construct (string $locale, string $pattern): ?MessageFormatter {} + public function __construct (string $locale, string $pattern) {} /** - * Constructs a new Message Formatter - * @link http://www.php.net/manual/en/messageformatter.create.php - * @param string $locale - * @param string $pattern - * @return MessageFormatter|null The formatter object, or null on failure. + * {@inheritdoc} + * @param string $locale + * @param string $pattern */ - public static function create (string $locale, string $pattern): ?MessageFormatter {} + public static function create (string $locale, string $pattern) {} /** - * Format the message - * @link http://www.php.net/manual/en/messageformatter.format.php - * @param array $values - * @return string|false The formatted string, or false if an error occurred + * {@inheritdoc} + * @param array $values */ - public function format (array $values): string|false {} + public function format (array $values) {} /** - * Quick format message - * @link http://www.php.net/manual/en/messageformatter.formatmessage.php - * @param string $locale - * @param string $pattern - * @param array $values - * @return string|false The formatted pattern string or false if an error occurred + * {@inheritdoc} + * @param string $locale + * @param string $pattern + * @param array $values */ - public static function formatMessage (string $locale, string $pattern, array $values): string|false {} + public static function formatMessage (string $locale, string $pattern, array $values) {} /** - * Parse input string according to pattern - * @link http://www.php.net/manual/en/messageformatter.parse.php - * @param string $string - * @return array|false An array containing the items extracted, or false on error + * {@inheritdoc} + * @param string $string */ - public function parse (string $string): array|false {} + public function parse (string $string) {} /** - * Quick parse input string - * @link http://www.php.net/manual/en/messageformatter.parsemessage.php - * @param string $locale - * @param string $pattern - * @param string $message - * @return array|false An array containing items extracted, or false on error + * {@inheritdoc} + * @param string $locale + * @param string $pattern + * @param string $message */ - public static function parseMessage (string $locale, string $pattern, string $message): array|false {} + public static function parseMessage (string $locale, string $pattern, string $message) {} /** - * Set the pattern used by the formatter - * @link http://www.php.net/manual/en/messageformatter.setpattern.php - * @param string $pattern - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $pattern */ - public function setPattern (string $pattern): bool {} + public function setPattern (string $pattern) {} /** - * Get the pattern used by the formatter - * @link http://www.php.net/manual/en/messageformatter.getpattern.php - * @return string|false The pattern string for this message formatter, or false on failure. + * {@inheritdoc} */ - public function getPattern (): string|false {} + public function getPattern () {} /** - * Get the locale for which the formatter was created - * @link http://www.php.net/manual/en/messageformatter.getlocale.php - * @return string The locale name + * {@inheritdoc} */ - public function getLocale (): string {} + public function getLocale () {} /** - * Get the error code from last operation - * @link http://www.php.net/manual/en/messageformatter.geterrorcode.php - * @return int The error code, one of UErrorCode values. Initial value is U_ZERO_ERROR. + * {@inheritdoc} */ - public function getErrorCode (): int {} + public function getErrorCode () {} /** - * Get the error text from the last operation - * @link http://www.php.net/manual/en/messageformatter.geterrormessage.php - * @return string Description of the last error. + * {@inheritdoc} */ - public function getErrorMessage (): string {} + public function getErrorMessage () {} } -/** - * @link http://www.php.net/manual/en/class.intldateformatter.php - */ class IntlDateFormatter { - /** - * Completely specified style (Tuesday, April 12, 1952 AD or 3:30:42pm PST) const FULL = 0; - /** - * Long style (January 12, 1952 or 3:30:32pm) const LONG = 1; - /** - * Medium style (Jan 12, 1952) const MEDIUM = 2; - /** - * Most abbreviated style, only essential data (12/13/52 or 3:30pm) const SHORT = 3; - /** - * Do not include this element const NONE = -1; - /** - * The same as IntlDateFormatter::FULL, but yesterday, today, and tomorrow - * show as yesterday, today, and tomorrow, - * respectively. Available as of PHP 8.0.0, for dateType only. const RELATIVE_FULL = 128; - /** - * The same as IntlDateFormatter::LONG, but yesterday, today, and tomorrow - * show as yesterday, today, and tomorrow, - * respectively. Available as of PHP 8.0.0, for dateType only. const RELATIVE_LONG = 129; - /** - * The same as IntlDateFormatter::MEDIUM, but yesterday, today, and tomorrow - * show as yesterday, today, and tomorrow, - * respectively. Available as of PHP 8.0.0, for dateType only. const RELATIVE_MEDIUM = 130; - /** - * The same as IntlDateFormatter::SHORT, but yesterday, today, and tomorrow - * show as yesterday, today, and tomorrow, - * respectively. Available as of PHP 8.0.0, for dateType only. const RELATIVE_SHORT = 131; - /** - * Gregorian Calendar const GREGORIAN = 1; - /** - * Non-Gregorian Calendar const TRADITIONAL = 0; /** - * Create a date formatter - * @link http://www.php.net/manual/en/intldateformatter.create.php - * @param string|null $locale - * @param int $dateType [optional] - * @param int $timeType [optional] - * @param IntlTimeZone|DateTimeZone|string|null $timezone [optional] - * @param IntlCalendar|int|null $calendar [optional] - * @param string|null $pattern [optional] - * @return IntlDateFormatter|null The created IntlDateFormatter or null in case of - * failure. + * {@inheritdoc} + * @param string|null $locale + * @param int $dateType [optional] + * @param int $timeType [optional] + * @param mixed $timezone [optional] + * @param mixed $calendar [optional] + * @param string|null $pattern [optional] */ - public function __construct (?string $locale, int $dateType = \IntlDateFormatter::FULL, int $timeType = \IntlDateFormatter::FULL, IntlTimeZone|DateTimeZone|string|null $timezone = null, IntlCalendar|int|null $calendar = null, ?string $pattern = null): ?IntlDateFormatter {} + public function __construct (?string $locale = null, int $dateType = 0, int $timeType = 0, $timezone = NULL, $calendar = NULL, ?string $pattern = NULL) {} /** - * Create a date formatter - * @link http://www.php.net/manual/en/intldateformatter.create.php - * @param string|null $locale - * @param int $dateType [optional] - * @param int $timeType [optional] - * @param IntlTimeZone|DateTimeZone|string|null $timezone [optional] - * @param IntlCalendar|int|null $calendar [optional] - * @param string|null $pattern [optional] - * @return IntlDateFormatter|null The created IntlDateFormatter or null in case of - * failure. + * {@inheritdoc} + * @param string|null $locale + * @param int $dateType [optional] + * @param int $timeType [optional] + * @param mixed $timezone [optional] + * @param IntlCalendar|int|null $calendar [optional] + * @param string|null $pattern [optional] */ - public static function create (?string $locale, int $dateType = \IntlDateFormatter::FULL, int $timeType = \IntlDateFormatter::FULL, IntlTimeZone|DateTimeZone|string|null $timezone = null, IntlCalendar|int|null $calendar = null, ?string $pattern = null): ?IntlDateFormatter {} + public static function create (?string $locale = null, int $dateType = 0, int $timeType = 0, $timezone = NULL, IntlCalendar|int|null $calendar = NULL, ?string $pattern = NULL) {} /** - * Get the datetype used for the IntlDateFormatter - * @link http://www.php.net/manual/en/intldateformatter.getdatetype.php - * @return int|false The current date type value of the formatter, - * or false on failure. + * {@inheritdoc} */ - public function getDateType (): int|false {} + public function getDateType () {} /** - * Get the timetype used for the IntlDateFormatter - * @link http://www.php.net/manual/en/intldateformatter.gettimetype.php - * @return int|false The current date type value of the formatter, - * or false on failure. + * {@inheritdoc} */ - public function getTimeType (): int|false {} + public function getTimeType () {} /** - * Get the calendar type used for the IntlDateFormatter - * @link http://www.php.net/manual/en/intldateformatter.getcalendar.php - * @return int|false The calendar - * type being used by the formatter. Either - * IntlDateFormatter::TRADITIONAL or - * IntlDateFormatter::GREGORIAN. - * Returns false on failure. + * {@inheritdoc} */ - public function getCalendar (): int|false {} + public function getCalendar () {} /** - * Sets the calendar type used by the formatter - * @link http://www.php.net/manual/en/intldateformatter.setcalendar.php - * @param IntlCalendar|int|null $calendar - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param IntlCalendar|int|null $calendar */ - public function setCalendar (IntlCalendar|int|null $calendar): bool {} + public function setCalendar (IntlCalendar|int|null $calendar = null) {} /** - * Get the timezone-id used for the IntlDateFormatter - * @link http://www.php.net/manual/en/intldateformatter.gettimezoneid.php - * @return string|false ID string for the time zone used by this formatter, or false on failure. + * {@inheritdoc} */ - public function getTimeZoneId (): string|false {} + public function getTimeZoneId () {} /** - * Get copy of formatterʼs calendar object - * @link http://www.php.net/manual/en/intldateformatter.getcalendarobject.php - * @return IntlCalendar|false|null A copy of the internal calendar object used by this formatter, - * or null if none has been set, or false on failure. + * {@inheritdoc} */ - public function getCalendarObject (): IntlCalendar|false|null {} + public function getCalendarObject () {} /** - * Get formatterʼs timezone - * @link http://www.php.net/manual/en/intldateformatter.gettimezone.php - * @return IntlTimeZone|false The associated IntlTimeZone - * object or false on failure. + * {@inheritdoc} */ - public function getTimeZone (): IntlTimeZone|false {} + public function getTimeZone () {} /** - * Sets formatterʼs timezone - * @link http://www.php.net/manual/en/intldateformatter.settimezone.php - * @param IntlTimeZone|DateTimeZone|string|null $timezone The timezone to use for this formatter. This can be specified in the - * following forms: - *null, in which case the default timezone will be used, as specified in - * the ini setting date.timezone or - * through the function date_default_timezone_set and as - * returned by date_default_timezone_get.
- *An IntlTimeZone, which will be used directly.
- *A DateTimeZone. Its identifier will be extracted - * and an ICU timezone object will be created; the timezone will be backed - * by ICUʼs database, not PHPʼs.
- *A string, which should be a valid ICU timezone identifier. - * See IntlTimeZone::createTimeZoneIDEnumeration. Raw - * offsets such as "GMT+08:30" are also accepted.
- * @return bool|null Returns null on success and false on failure. + * {@inheritdoc} + * @param mixed $timezone */ - public function setTimeZone (IntlTimeZone|DateTimeZone|string|null $timezone): ?bool {} + public function setTimeZone ($timezone = null) {} /** - * Set the pattern used for the IntlDateFormatter - * @link http://www.php.net/manual/en/intldateformatter.setpattern.php - * @param string $pattern - * @return bool Returns true on success or false on failure. - * Bad formatstrings are usually the cause of the failure. + * {@inheritdoc} + * @param string $pattern */ - public function setPattern (string $pattern): bool {} + public function setPattern (string $pattern) {} /** - * Get the pattern used for the IntlDateFormatter - * @link http://www.php.net/manual/en/intldateformatter.getpattern.php - * @return string|false The pattern string being used to format/parse, or false on failure. + * {@inheritdoc} */ - public function getPattern (): string|false {} + public function getPattern () {} /** - * Get the locale used by formatter - * @link http://www.php.net/manual/en/intldateformatter.getlocale.php - * @param int $type [optional] - * @return string|false The locale of this formatter, or false on failure. + * {@inheritdoc} + * @param int $type [optional] */ - public function getLocale (int $type = ULOC_ACTUAL_LOCALE): string|false {} + public function getLocale (int $type = 0) {} /** - * Set the leniency of the parser - * @link http://www.php.net/manual/en/intldateformatter.setlenient.php - * @param bool $lenient - * @return void Returns true on success or false on failure. + * {@inheritdoc} + * @param bool $lenient */ - public function setLenient (bool $lenient): void {} + public function setLenient (bool $lenient) {} /** - * Get the lenient used for the IntlDateFormatter - * @link http://www.php.net/manual/en/intldateformatter.islenient.php - * @return bool true if parser is lenient, false if parser is strict. By default the parser is lenient. + * {@inheritdoc} */ - public function isLenient (): bool {} + public function isLenient () {} /** - * Format the date/time value as a string - * @link http://www.php.net/manual/en/intldateformatter.format.php - * @param IntlCalendar|DateTimeInterface|array|string|int|float $datetime - * @return string|false The formatted string or, if an error occurred, false. + * {@inheritdoc} + * @param mixed $datetime */ - public function format (IntlCalendar|DateTimeInterface|array|string|int|float $datetime): string|false {} + public function format ($datetime = null) {} /** - * Formats an object - * @link http://www.php.net/manual/en/intldateformatter.formatobject.php - * @param IntlCalendar|DateTimeInterface $datetime An object of type IntlCalendar or - * DateTime. The timezone information in the object - * will be used. - * @param array|int|string|null $format [optional] How to format the date/time. This can either be an array with - * two elements (first the date style, then the time style, these being one - * of the constants IntlDateFormatter::NONE, - * IntlDateFormatter::SHORT, - * IntlDateFormatter::MEDIUM, - * IntlDateFormatter::LONG, - * IntlDateFormatter::FULL), an int with - * the value of one of these constants (in which case it will be used both - * for the time and the date) or a string with the format - * described in the ICU - * documentation. If null, the default style will be used. - * @param string|null $locale [optional] The locale to use, or null to use the default one. - * @return string|false A string with result or false on failure. + * {@inheritdoc} + * @param mixed $datetime + * @param mixed $format [optional] + * @param string|null $locale [optional] */ - public static function formatObject (IntlCalendar|DateTimeInterface $datetime, array|int|string|null $format = null, ?string $locale = null): string|false {} + public static function formatObject ($datetime = null, $format = NULL, ?string $locale = NULL) {} /** - * Parse string to a timestamp value - * @link http://www.php.net/manual/en/intldateformatter.parse.php - * @param string $string - * @param int $offset [optional] - * @return int|float|false Timestamp of parsed value, or false if value cannot be parsed. + * {@inheritdoc} + * @param string $string + * @param mixed $offset [optional] */ - public function parse (string $string, int &$offset = null): int|float|false {} + public function parse (string $string, &$offset = NULL) {} /** - * Parse string to a field-based time value - * @link http://www.php.net/manual/en/intldateformatter.localtime.php - * @param string $string - * @param int $offset [optional] - * @return array|false Localtime compatible array of integers : contains 24 hour clock value in tm_hour field, - * or false on failure. + * {@inheritdoc} + * @param string $string + * @param mixed $offset [optional] */ - public function localtime (string $string, int &$offset = null): array|false {} + public function localtime (string $string, &$offset = NULL) {} /** - * Get the error code from last operation - * @link http://www.php.net/manual/en/intldateformatter.geterrorcode.php - * @return int The error code, one of UErrorCode values. Initial value is U_ZERO_ERROR. + * {@inheritdoc} */ - public function getErrorCode (): int {} + public function getErrorCode () {} /** - * Get the error text from the last operation - * @link http://www.php.net/manual/en/intldateformatter.geterrormessage.php - * @return string Description of the last error. + * {@inheritdoc} */ - public function getErrorMessage (): string {} + public function getErrorMessage () {} } -/** - * @link http://www.php.net/manual/en/class.intldatepatterngenerator.php - */ class IntlDatePatternGenerator { /** - * Creates a new IntlDatePatternGenerator instance - * @link http://www.php.net/manual/en/intldatepatterngenerator.create.php - * @param string|null $locale [optional] The locale. - * If null is passed, uses the ini setting intl.default_locale. - * @return IntlDatePatternGenerator|null Returns an IntlDatePatternGenerator instance on success, or null on failure. + * {@inheritdoc} + * @param string|null $locale [optional] */ - public function __construct (?string $locale = null): ?IntlDatePatternGenerator {} + public function __construct (?string $locale = NULL) {} /** - * Creates a new IntlDatePatternGenerator instance - * @link http://www.php.net/manual/en/intldatepatterngenerator.create.php - * @param string|null $locale [optional] The locale. - * If null is passed, uses the ini setting intl.default_locale. - * @return IntlDatePatternGenerator|null Returns an IntlDatePatternGenerator instance on success, or null on failure. + * {@inheritdoc} + * @param string|null $locale [optional] */ - public static function create (?string $locale = null): ?IntlDatePatternGenerator {} + public static function create (?string $locale = NULL): ?IntlDatePatternGenerator {} /** - * Determines the most suitable date/time format - * @link http://www.php.net/manual/en/intldatepatterngenerator.getbestpattern.php - * @param string $skeleton The skeleton. - * @return string|false Returns a format, accepted by DateTimeInterface::format on success, or false on failure. + * {@inheritdoc} + * @param string $skeleton */ public function getBestPattern (string $skeleton): string|false {} } -/** - * @link http://www.php.net/manual/en/class.resourcebundle.php - */ class ResourceBundle implements IteratorAggregate, Traversable, Countable { /** - * Create a resource bundle - * @link http://www.php.net/manual/en/resourcebundle.create.php - * @param string|null $locale - * @param string|null $bundle - * @param bool $fallback [optional] - * @return ResourceBundle|null Returns ResourceBundle object or null on error. + * {@inheritdoc} + * @param string|null $locale + * @param string|null $bundle + * @param bool $fallback [optional] */ - public function __construct (?string $locale, ?string $bundle, bool $fallback = true): ?ResourceBundle {} + public function __construct (?string $locale = null, ?string $bundle = null, bool $fallback = true) {} /** - * Create a resource bundle - * @link http://www.php.net/manual/en/resourcebundle.create.php - * @param string|null $locale - * @param string|null $bundle - * @param bool $fallback [optional] - * @return ResourceBundle|null Returns ResourceBundle object or null on error. + * {@inheritdoc} + * @param string|null $locale + * @param string|null $bundle + * @param bool $fallback [optional] */ - public static function create (?string $locale, ?string $bundle, bool $fallback = true): ?ResourceBundle {} + public static function create (?string $locale = null, ?string $bundle = null, bool $fallback = true) {} /** - * Get data from the bundle - * @link http://www.php.net/manual/en/resourcebundle.get.php - * @param string|int $index - * @param bool $fallback [optional] - * @return mixed Returns the data located at the index or null on error. Strings, integers and binary data strings - * are returned as corresponding PHP types, integer array is returned as PHP array. Complex types are - * returned as ResourceBundle object. + * {@inheritdoc} + * @param mixed $index + * @param bool $fallback [optional] */ - public function get (string|int $index, bool $fallback = true): mixed {} + public function get ($index = null, bool $fallback = true) {} /** - * Get number of elements in the bundle - * @link http://www.php.net/manual/en/resourcebundle.count.php - * @return int Returns number of elements in the bundle. + * {@inheritdoc} */ - public function count (): int {} + public function count () {} /** - * Get supported locales - * @link http://www.php.net/manual/en/resourcebundle.locales.php - * @param string $bundle - * @return array|false Returns the list of locales supported by the bundle, or false on failure. + * {@inheritdoc} + * @param string $bundle */ - public static function getLocales (string $bundle): array|false {} + public static function getLocales (string $bundle) {} /** - * Get bundle's last error code - * @link http://www.php.net/manual/en/resourcebundle.geterrorcode.php - * @return int Returns error code from last bundle object call. + * {@inheritdoc} */ - public function getErrorCode (): int {} + public function getErrorCode () {} /** - * Get bundle's last error message - * @link http://www.php.net/manual/en/resourcebundle.geterrormessage.php - * @return string Returns error message from last bundle object's call. + * {@inheritdoc} */ - public function getErrorMessage (): string {} + public function getErrorMessage () {} /** * {@inheritdoc} @@ -1498,9 +768,6 @@ public function getIterator (): Iterator {} } -/** - * @link http://www.php.net/manual/en/class.transliterator.php - */ class Transliterator { const FORWARD = 0; const REVERSE = 1; @@ -1509,89 +776,54 @@ class Transliterator { public readonly string $id; /** - * Private constructor to deny instantiation - * @link http://www.php.net/manual/en/transliterator.construct.php + * {@inheritdoc} */ final private function __construct () {} /** - * Create a transliterator - * @link http://www.php.net/manual/en/transliterator.create.php - * @param string $id The ID. A list of all registered transliterator IDs can be retrieved by using - * Transliterator::listIDs. - * @param int $direction [optional] The direction, defaults to - * Transliterator::FORWARD. - * May also be set to - * Transliterator::REVERSE. - * @return Transliterator|null Returns a Transliterator object on success, - * or null on failure. + * {@inheritdoc} + * @param string $id + * @param int $direction [optional] */ - public static function create (string $id, int $direction = \Transliterator::FORWARD): ?Transliterator {} + public static function create (string $id, int $direction = 0) {} /** - * Create transliterator from rules - * @link http://www.php.net/manual/en/transliterator.createfromrules.php - * @param string $rules The rules as defined in Transform Rules Syntax of UTS #35: Unicode LDML. - * @param int $direction [optional] The direction, defaults to - * Transliterator::FORWARD. - * May also be set to - * Transliterator::REVERSE. - * @return Transliterator|null Returns a Transliterator object on success, - * or null on failure. + * {@inheritdoc} + * @param string $rules + * @param int $direction [optional] */ - public static function createFromRules (string $rules, int $direction = \Transliterator::FORWARD): ?Transliterator {} + public static function createFromRules (string $rules, int $direction = 0) {} /** - * Create an inverse transliterator - * @link http://www.php.net/manual/en/transliterator.createinverse.php - * @return Transliterator|null Returns a Transliterator object on success, - * or null on failure + * {@inheritdoc} */ - public function createInverse (): ?Transliterator {} + public function createInverse () {} /** - * Get transliterator IDs - * @link http://www.php.net/manual/en/transliterator.listids.php - * @return array|false An array of registered transliterator IDs on success, - * or false on failure. + * {@inheritdoc} */ - public static function listIDs (): array|false {} + public static function listIDs () {} /** - * Transliterate a string - * @link http://www.php.net/manual/en/transliterator.transliterate.php - * @param string $string The string to be transformed. - * @param int $start [optional] The start index (in UTF-16 code units) from which the string will start - * to be transformed, inclusive. Indexing starts at 0. The text before will - * be left as is. - * @param int $end [optional] The end index (in UTF-16 code units) until which the string will be - * transformed, exclusive. Indexing starts at 0. The text after will be - * left as is. - * @return string|false The transformed string on success, or false on failure. + * {@inheritdoc} + * @param string $string + * @param int $start [optional] + * @param int $end [optional] */ - public function transliterate (string $string, int $start = null, int $end = -1): string|false {} + public function transliterate (string $string, int $start = 0, int $end = -1) {} /** - * Get last error code - * @link http://www.php.net/manual/en/transliterator.geterrorcode.php - * @return int|false The error code on success, - * or false if none exists, or on failure. + * {@inheritdoc} */ - public function getErrorCode (): int|false {} + public function getErrorCode () {} /** - * Get last error message - * @link http://www.php.net/manual/en/transliterator.geterrormessage.php - * @return string|false The error message on success, - * or false if none exists, or on failure. + * {@inheritdoc} */ - public function getErrorMessage (): string|false {} + public function getErrorMessage () {} } -/** - * @link http://www.php.net/manual/en/class.intltimezone.php - */ class IntlTimeZone { const DISPLAY_SHORT = 1; const DISPLAY_LONG = 2; @@ -1607,937 +839,491 @@ class IntlTimeZone { /** - * Private constructor to disallow direct instantiation - * @link http://www.php.net/manual/en/intltimezone.construct.php + * {@inheritdoc} */ private function __construct () {} /** - * Get the number of IDs in the equivalency group that includes the given ID - * @link http://www.php.net/manual/en/intltimezone.countequivalentids.php - * @param string $timezoneId - * @return int|false + * {@inheritdoc} + * @param string $timezoneId */ - public static function countEquivalentIDs (string $timezoneId): int|false {} + public static function countEquivalentIDs (string $timezoneId) {} /** - * Create a new copy of the default timezone for this host - * @link http://www.php.net/manual/en/intltimezone.createdefault.php - * @return IntlTimeZone + * {@inheritdoc} */ - public static function createDefault (): IntlTimeZone {} + public static function createDefault () {} /** - * Get an enumeration over time zone IDs associated with the - * given country or offset - * @link http://www.php.net/manual/en/intltimezone.createenumeration.php - * @param IntlTimeZone|string|int|float|null $countryOrRawOffset [optional] - * @return IntlIterator|false + * {@inheritdoc} + * @param mixed $countryOrRawOffset [optional] */ - public static function createEnumeration (IntlTimeZone|string|int|float|null $countryOrRawOffset = null): IntlIterator|false {} + public static function createEnumeration ($countryOrRawOffset = NULL) {} /** - * Create a timezone object for the given ID - * @link http://www.php.net/manual/en/intltimezone.createtimezone.php - * @param string $timezoneId - * @return IntlTimeZone|null + * {@inheritdoc} + * @param string $timezoneId */ - public static function createTimeZone (string $timezoneId): ?IntlTimeZone {} + public static function createTimeZone (string $timezoneId) {} /** - * Get an enumeration over system time zone IDs with the given filter conditions - * @link http://www.php.net/manual/en/intltimezone.createtimezoneidenumeration.php - * @param int $type - * @param string|null $region [optional] - * @param int|null $rawOffset [optional] - * @return IntlIterator|false Returns IntlIterator or false on failure. + * {@inheritdoc} + * @param int $type + * @param string|null $region [optional] + * @param int|null $rawOffset [optional] */ - public static function createTimeZoneIDEnumeration (int $type, ?string $region = null, ?int $rawOffset = null): IntlIterator|false {} + public static function createTimeZoneIDEnumeration (int $type, ?string $region = NULL, ?int $rawOffset = NULL) {} /** - * Create a timezone object from DateTimeZone - * @link http://www.php.net/manual/en/intltimezone.fromdatetimezone.php - * @param DateTimeZone $timezone - * @return IntlTimeZone|null + * {@inheritdoc} + * @param DateTimeZone $timezone */ - public static function fromDateTimeZone (DateTimeZone $timezone): ?IntlTimeZone {} + public static function fromDateTimeZone (DateTimeZone $timezone) {} /** - * Get the canonical system timezone ID or the normalized custom time zone ID for the given time zone ID - * @link http://www.php.net/manual/en/intltimezone.getcanonicalid.php - * @param string $timezoneId - * @param bool $isSystemId [optional] - * @return string|false + * {@inheritdoc} + * @param string $timezoneId + * @param mixed $isSystemId [optional] */ - public static function getCanonicalID (string $timezoneId, bool &$isSystemId = null): string|false {} + public static function getCanonicalID (string $timezoneId, &$isSystemId = NULL) {} /** - * Get a name of this time zone suitable for presentation to the user - * @link http://www.php.net/manual/en/intltimezone.getdisplayname.php - * @param bool $dst [optional] - * @param int $style [optional] - * @param string|null $locale [optional] - * @return string|false + * {@inheritdoc} + * @param bool $dst [optional] + * @param int $style [optional] + * @param string|null $locale [optional] */ - public function getDisplayName (bool $dst = false, int $style = \IntlTimeZone::DISPLAY_LONG, ?string $locale = null): string|false {} + public function getDisplayName (bool $dst = false, int $style = 2, ?string $locale = NULL) {} /** - * Get the amount of time to be added to local standard time to get local wall clock time - * @link http://www.php.net/manual/en/intltimezone.getdstsavings.php - * @return int + * {@inheritdoc} */ - public function getDSTSavings (): int {} + public function getDSTSavings () {} /** - * Get an ID in the equivalency group that includes the given ID - * @link http://www.php.net/manual/en/intltimezone.getequivalentid.php - * @param string $timezoneId - * @param int $offset - * @return string|false + * {@inheritdoc} + * @param string $timezoneId + * @param int $offset */ - public static function getEquivalentID (string $timezoneId, int $offset): string|false {} + public static function getEquivalentID (string $timezoneId, int $offset) {} /** - * Get last error code on the object - * @link http://www.php.net/manual/en/intltimezone.geterrorcode.php - * @return int|false + * {@inheritdoc} */ - public function getErrorCode (): int|false {} + public function getErrorCode () {} /** - * Get last error message on the object - * @link http://www.php.net/manual/en/intltimezone.geterrormessage.php - * @return string|false + * {@inheritdoc} */ - public function getErrorMessage (): string|false {} + public function getErrorMessage () {} /** - * Create GMT (UTC) timezone - * @link http://www.php.net/manual/en/intltimezone.getgmt.php - * @return IntlTimeZone + * {@inheritdoc} */ - public static function getGMT (): IntlTimeZone {} + public static function getGMT () {} /** - * Get timezone ID - * @link http://www.php.net/manual/en/intltimezone.getid.php - * @return string|false + * {@inheritdoc} */ - public function getID (): string|false {} + public function getID () {} /** - * Get the time zone raw and GMT offset for the given moment in time - * @link http://www.php.net/manual/en/intltimezone.getoffset.php - * @param float $timestamp - * @param bool $local - * @param int $rawOffset - * @param int $dstOffset - * @return bool + * {@inheritdoc} + * @param float $timestamp + * @param bool $local + * @param mixed $rawOffset + * @param mixed $dstOffset */ - public function getOffset (float $timestamp, bool $local, int &$rawOffset, int &$dstOffset): bool {} + public function getOffset (float $timestamp, bool $local, &$rawOffset = null, &$dstOffset = null) {} /** - * Get the raw GMT offset (before taking daylight savings time into account - * @link http://www.php.net/manual/en/intltimezone.getrawoffset.php - * @return int + * {@inheritdoc} */ - public function getRawOffset (): int {} + public function getRawOffset () {} /** - * Get the region code associated with the given system time zone ID - * @link http://www.php.net/manual/en/intltimezone.getregion.php - * @param string $timezoneId - * @return string|false Return region or false on failure. + * {@inheritdoc} + * @param string $timezoneId */ - public static function getRegion (string $timezoneId): string|false {} + public static function getRegion (string $timezoneId) {} /** - * Get the timezone data version currently used by ICU - * @link http://www.php.net/manual/en/intltimezone.gettzdataversion.php - * @return string|false + * {@inheritdoc} */ - public static function getTZDataVersion (): string|false {} + public static function getTZDataVersion () {} /** - * Get the "unknown" time zone - * @link http://www.php.net/manual/en/intltimezone.getunknown.php - * @return IntlTimeZone Returns IntlTimeZone or null on failure. + * {@inheritdoc} */ - public static function getUnknown (): IntlTimeZone {} + public static function getUnknown () {} /** - * Translate a system timezone into a Windows timezone - * @link http://www.php.net/manual/en/intltimezone.getwindowsid.php - * @param string $timezoneId - * @return string|false Returns the Windows timezone or false on failure. + * {@inheritdoc} + * @param string $timezoneId */ - public static function getWindowsID (string $timezoneId): string|false {} + public static function getWindowsID (string $timezoneId) {} /** - * Translate a Windows timezone into a system timezone - * @link http://www.php.net/manual/en/intltimezone.getidforwindowsid.php - * @param string $timezoneId - * @param string|null $region [optional] - * @return string|false Returns the system timezone or false on failure. + * {@inheritdoc} + * @param string $timezoneId + * @param string|null $region [optional] */ - public static function getIDForWindowsID (string $timezoneId, ?string $region = null): string|false {} + public static function getIDForWindowsID (string $timezoneId, ?string $region = NULL) {} /** - * Check if this zone has the same rules and offset as another zone - * @link http://www.php.net/manual/en/intltimezone.hassamerules.php - * @param IntlTimeZone $other - * @return bool + * {@inheritdoc} + * @param IntlTimeZone $other */ - public function hasSameRules (IntlTimeZone $other): bool {} + public function hasSameRules (IntlTimeZone $other) {} /** - * Convert to DateTimeZone object - * @link http://www.php.net/manual/en/intltimezone.todatetimezone.php - * @return DateTimeZone|false + * {@inheritdoc} */ - public function toDateTimeZone (): DateTimeZone|false {} + public function toDateTimeZone () {} /** - * Check if this time zone uses daylight savings time - * @link http://www.php.net/manual/en/intltimezone.usedaylighttime.php - * @return bool + * {@inheritdoc} */ - public function useDaylightTime (): bool {} + public function useDaylightTime () {} } -/** - * @link http://www.php.net/manual/en/class.intlcalendar.php - */ class IntlCalendar { - /** - * Calendar field numerically representing an era, for instance - * 1 for AD and 0 for BC in the - * Gregorian/Julian calendars and 235 for the Heisei - * (平成) era in the Japanese calendar. Not all calendars have more than - * one era. const FIELD_ERA = 0; - /** - * Calendar field for the year. This is not unique across eras. If the - * calendar type has more than one era, generally the minimum value for - * this field will be 1. const FIELD_YEAR = 1; - /** - * Calendar field for the month. The month sequence is zero-based, so - * January (here used to signify the first month of the calendar; this - * may be called another name, such as Muharram in the Islamic calendar) - * is represented by 0, February by - * 1, …, December by 11 and, for - * calendars that have it, the 13th or leap month by - * 12. const FIELD_MONTH = 2; - /** - * Calendar field for the number of the week of the year. This depends on - * which day of the week is deemed to start the - * week and the minimal number of days - * in a week. const FIELD_WEEK_OF_YEAR = 3; - /** - * Calendar field for the number of the week of the month. This depends on - * which day of the week is deemed to start the - * week and the minimal number of days - * in a week. const FIELD_WEEK_OF_MONTH = 4; - /** - * Calendar field for the day of the month. The same as - * IntlCalendar::FIELD_DAY_OF_MONTH, which has a - * clearer name. const FIELD_DATE = 5; - /** - * Calendar field for the day of the year. For the Gregorian calendar, - * starts with 1 and ends with - * 365 or 366. const FIELD_DAY_OF_YEAR = 6; - /** - * Calendar field for the day of the week. Its values start with - * 1 (Sunday, see IntlCalendar::DOW_SUNDAY - * and subsequent constants) and the last valid value is 7 (Saturday). const FIELD_DAY_OF_WEEK = 7; - /** - * Given a day of the week (Sunday, Monday, …), this calendar - * field assigns an ordinal to such a day of the week in a specific month. - * Thus, if the value of this field is 1 and the value of the day of the - * week is 2 (Monday), then the set day of the month is the 1st Monday of the - * month; the maximum value is 5. - *Additionally, the value 0 and negative values are - * also allowed. The value 0 encompasses the seven days - * that occur immediately before the first seven days of a month (which - * therefore have a ‘day of week in month’ with value - * 1). Negative values starts counting from the end of - * the month – -1 points to the last occurrence of a - * day of the week in a month, -2 to the second last, - * and so on.
- *Unlike IntlCalendar::FIELD_WEEK_OF_MONTH - * and IntlCalendar::FIELD_WEEK_OF_YEAR, - * this value does not depend on - * IntlCalendar::getFirstDayOfWeek or on - * IntlCalendar::getMinimalDaysInFirstWeek. The first - * Monday is the first Monday, even if it occurs in a week that belongs to - * the previous month.
const FIELD_DAY_OF_WEEK_IN_MONTH = 8; - /** - * Calendar field indicating whether a time is before noon (value - * 0, AM) or after (1). Midnight is - * AM, noon is PM. const FIELD_AM_PM = 9; - /** - * Calendar field for the hour, without specifying whether itʼs in the - * morning or in the afternoon. Valid values are 0 to - * 11. const FIELD_HOUR = 10; - /** - * Calendar field for the full (24h) hour of the day. Valid values are - * 0 to 23. const FIELD_HOUR_OF_DAY = 11; - /** - * Calendar field for the minutes component of the time. const FIELD_MINUTE = 12; - /** - * Calendar field for the seconds component of the time. const FIELD_SECOND = 13; - /** - * Calendar field the milliseconds component of the time. const FIELD_MILLISECOND = 14; - /** - * Calendar field indicating the raw offset of the timezone, in - * milliseconds. The raw offset is the timezone offset, excluding any - * offset due to daylight saving time. const FIELD_ZONE_OFFSET = 15; - /** - * Calendar field for the daylight saving time offset of the calendarʼs - * timezone, in milliseconds, if active for calendarʼs time. const FIELD_DST_OFFSET = 16; - /** - * Calendar field representing the year for week of year - * purposes. const FIELD_YEAR_WOY = 17; - /** - * Calendar field for the localized day of the week. This is a value - * between 1 and 7, - * 1 being used for the day of the week that matches - * the value returned by - * IntlCalendar::getFirstDayOfWeek. const FIELD_DOW_LOCAL = 18; - /** - * Calendar field for a year number representation that is continuous - * across eras. For the Gregorian calendar, the value of this field - * matches that of IntlCalendar::FIELD_YEAR for AD - * years; a BC year y is represented by -y + - * 1. const FIELD_EXTENDED_YEAR = 19; - /** - * Calendar field for a modified Julian day number. It is different from a - * conventional Julian day number in that its transitions occur at local - * zone midnight rather than at noon UTC. It uniquely identifies a date. const FIELD_JULIAN_DAY = 20; - /** - * Calendar field encompassing the information in - * IntlCalendar::FIELD_HOUR_OF_DAY, - * IntlCalendar::FIELD_MINUTE, - * IntlCalendar::FIELD_SECOND and - * IntlCalendar::FIELD_MILLISECOND. Range is from the - * 0 to 24 * 3600 * 1000 - 1. It is - * not the amount of milliseconds elapsed in the day since on DST - * transitions it will have discontinuities analog to those of the wall - * time. const FIELD_MILLISECONDS_IN_DAY = 21; - /** - * Calendar field whose value is 1 for indicating a - * leap month and 0 otherwise. const FIELD_IS_LEAP_MONTH = 22; - /** - * The total number of fields. - const FIELD_FIELD_COUNT = 23; - /** - * Alias for IntlCalendar::FIELD_DATE. + const FIELD_FIELD_COUNT = 24; const FIELD_DAY_OF_MONTH = 5; - /** - * Sunday. const DOW_SUNDAY = 1; - /** - * Monday. const DOW_MONDAY = 2; - /** - * Tuesday. const DOW_TUESDAY = 3; - /** - * Wednesday. const DOW_WEDNESDAY = 4; - /** - * Thursday. const DOW_THURSDAY = 5; - /** - * Friday. const DOW_FRIDAY = 6; - /** - * Saturday. const DOW_SATURDAY = 7; - /** - * Output of IntlCalendar::getDayOfWeekType - * indicating a day of week is a weekday. const DOW_TYPE_WEEKDAY = 0; - /** - * Output of IntlCalendar::getDayOfWeekType - * indicating a day of week belongs to the weekend. const DOW_TYPE_WEEKEND = 1; - /** - * Output of IntlCalendar::getDayOfWeekType - * indicating the weekend begins during the given day of week. const DOW_TYPE_WEEKEND_OFFSET = 2; - /** - * Output of IntlCalendar::getDayOfWeekType - * indicating the weekend ends during the given day of week. const DOW_TYPE_WEEKEND_CEASE = 3; - /** - * Output of IntlCalendar::getSkippedWallTimeOption - * indicating that wall times in the skipped range should refer to the - * same instant as wall times with one hour less and of - * IntlCalendar::getRepeatedWallTimeOption - * indicating the wall times in the repeated range should refer to the - * instant of the first occurrence of such wall time. const WALLTIME_FIRST = 1; - /** - * Output of IntlCalendar::getSkippedWallTimeOption - * indicating that wall times in the skipped range should refer to the - * same instant as wall times with one hour after and of - * IntlCalendar::getRepeatedWallTimeOption - * indicating the wall times in the repeated range should refer to the - * instant of the second occurrence of such wall time. const WALLTIME_LAST = 0; - /** - * Output of IntlCalendar::getSkippedWallTimeOption - * indicating that wall times in the skipped range should refer to the - * instant when the daylight saving time transition occurs (begins). const WALLTIME_NEXT_VALID = 2; /** - * Private constructor for disallowing instantiation - * @link http://www.php.net/manual/en/intlcalendar.construct.php + * {@inheritdoc} */ private function __construct () {} /** - * Create a new IntlCalendar - * @link http://www.php.net/manual/en/intlcalendar.createinstance.php - * @param IntlTimeZone|DateTimeZone|string|null $timezone [optional] The timezone to use. - *null, in which case the default timezone will be used, as specified in - * the ini setting date.timezone or - * through the function date_default_timezone_set and as - * returned by date_default_timezone_get.
- *An IntlTimeZone, which will be used directly.
- *A DateTimeZone. Its identifier will be extracted - * and an ICU timezone object will be created; the timezone will be backed - * by ICUʼs database, not PHPʼs.
- *A string, which should be a valid ICU timezone identifier. - * See IntlTimeZone::createTimeZoneIDEnumeration. Raw - * offsets such as "GMT+08:30" are also accepted.
- * @param string|null $locale [optional] A locale to use or null to use the default locale. - * @return IntlCalendar|null The created IntlCalendar instance or null on - * failure. - */ - public static function createInstance (IntlTimeZone|DateTimeZone|string|null $timezone = null, ?string $locale = null): ?IntlCalendar {} - - /** - * Compare time of two IntlCalendar objects for equality - * @link http://www.php.net/manual/en/intlcalendar.equals.php - * @param IntlCalendar $other The calendar to compare with the primary object. - * @return bool Returns true if the current time of both this and the passed in - * IntlCalendar object are the same, or false - * otherwise. - *>On failure false is also returned. To detect error conditions use intl_get_error_code, or set up Intl to throw exceptions.
- */ - public function equals (IntlCalendar $other): bool {} - - /** - * Calculate difference between given time and this objectʼs time - * @link http://www.php.net/manual/en/intlcalendar.fielddifference.php - * @param float $timestamp The time against which to compare the quantity represented by the - * field. For the result to be positive, the time - * given for this parameter must be ahead of the time of the object the - * method is being invoked on. - * @param int $field The field that represents the quantity being compared. - *> - * One of the IntlCalendar date/time field constants. These are integer - * values between 0 and - * IntlCalendar::FIELD_COUNT.
- * @return int|false Returns a (signed) difference of time in the unit associated with the - * specified field or false on failure. - */ - public function fieldDifference (float $timestamp, int $field): int|false {} + * {@inheritdoc} + * @param mixed $timezone [optional] + * @param string|null $locale [optional] + */ + public static function createInstance ($timezone = NULL, ?string $locale = NULL) {} + + /** + * {@inheritdoc} + * @param IntlCalendar $other + */ + public function equals (IntlCalendar $other) {} /** - * Add a (signed) amount of time to a field - * @link http://www.php.net/manual/en/intlcalendar.add.php - * @param int $field > - * One of the IntlCalendar date/time field constants. These are integer - * values between 0 and - * IntlCalendar::FIELD_COUNT. - * @param int $value The signed amount to add to the current field. If the amount is positive, - * the instant will be moved forward; if it is negative, the instant will be - * moved into the past. The unit is implicit to the field type. For instance, - * hours for IntlCalendar::FIELD_HOUR_OF_DAY. - * @return bool Returns true on success or false on failure. - */ - public function add (int $field, int $value): bool {} + * {@inheritdoc} + * @param float $timestamp + * @param int $field + */ + public function fieldDifference (float $timestamp, int $field) {} /** - * Whether this objectʼs time is after that of the passed object - * @link http://www.php.net/manual/en/intlcalendar.after.php - * @param IntlCalendar $other The calendar whose time will be checked against the primary objectʼs time. - * @return bool Returns true if this objectʼs current time is after that of the - * calendar argumentʼs time. Returns false otherwise. - *>On failure false is also returned. To detect error conditions use intl_get_error_code, or set up Intl to throw exceptions.
+ * {@inheritdoc} + * @param int $field + * @param int $value */ - public function after (IntlCalendar $other): bool {} + public function add (int $field, int $value) {} /** - * Whether this objectʼs time is before that of the passed object - * @link http://www.php.net/manual/en/intlcalendar.before.php - * @param IntlCalendar $other The calendar whose time will be checked against the primary objectʼs time. - * @return bool Returns true if this objectʼs current time is before that of the - * calendar argumentʼs time. Returns false otherwise. - *>On failure false is also returned. To detect error conditions use intl_get_error_code, or set up Intl to throw exceptions.
+ * {@inheritdoc} + * @param IntlCalendar $other */ - public function before (IntlCalendar $other): bool {} + public function after (IntlCalendar $other) {} /** - * Clear a field or all fields - * @link http://www.php.net/manual/en/intlcalendar.clear.php - * @param int|null $field [optional] > - * One of the IntlCalendar date/time field constants. These are integer - * values between 0 and - * IntlCalendar::FIELD_COUNT. - * @return true Always returns true. + * {@inheritdoc} + * @param IntlCalendar $other + */ + public function before (IntlCalendar $other) {} + + /** + * {@inheritdoc} + * @param int|null $field [optional] + */ + public function clear (?int $field = NULL) {} + + /** + * {@inheritdoc} + * @param DateTime|string $datetime + * @param string|null $locale [optional] + */ + public static function fromDateTime (DateTime|string $datetime, ?string $locale = NULL) {} + + /** + * {@inheritdoc} + * @param int $field + */ + public function get (int $field) {} + + /** + * {@inheritdoc} + * @param int $field + */ + public function getActualMaximum (int $field) {} + + /** + * {@inheritdoc} + * @param int $field + */ + public function getActualMinimum (int $field) {} + + /** + * {@inheritdoc} */ - public function clear (?int $field = null): true {} + public static function getAvailableLocales () {} /** - * Create an IntlCalendar from a DateTime object or string - * @link http://www.php.net/manual/en/intlcalendar.fromdatetime.php - * @param DateTime|string $datetime A DateTime object or a string that - * can be passed to DateTime::__construct. - * @param string|null $locale [optional] - * @return IntlCalendar|null The created IntlCalendar object or null in case of - * failure. If a string is passed, any exception that occurs - * inside the DateTime constructor is propagated. + * {@inheritdoc} + * @param int $dayOfWeek */ - public static function fromDateTime (DateTime|string $datetime, ?string $locale = null): ?IntlCalendar {} + public function getDayOfWeekType (int $dayOfWeek) {} /** - * Get the value for a field - * @link http://www.php.net/manual/en/intlcalendar.get.php - * @param int $field > - * One of the IntlCalendar date/time field constants. These are integer - * values between 0 and - * IntlCalendar::FIELD_COUNT. - * @return int|false An integer with the value of the time field. + * {@inheritdoc} */ - public function get (int $field): int|false {} + public function getErrorCode () {} /** - * The maximum value for a field, considering the objectʼs current time - * @link http://www.php.net/manual/en/intlcalendar.getactualmaximum.php - * @param int $field > - * One of the IntlCalendar date/time field constants. These are integer - * values between 0 and - * IntlCalendar::FIELD_COUNT. - * @return int|false An int representing the maximum value in the units associated - * with the given field or false on failure. + * {@inheritdoc} */ - public function getActualMaximum (int $field): int|false {} + public function getErrorMessage () {} /** - * The minimum value for a field, considering the objectʼs current time - * @link http://www.php.net/manual/en/intlcalendar.getactualminimum.php - * @param int $field > - * One of the IntlCalendar date/time field constants. These are integer - * values between 0 and - * IntlCalendar::FIELD_COUNT. - * @return int|false An int representing the minimum value in the fieldʼs - * unit or false on failure. + * {@inheritdoc} */ - public function getActualMinimum (int $field): int|false {} + public function getFirstDayOfWeek () {} /** - * Get array of locales for which there is data - * @link http://www.php.net/manual/en/intlcalendar.getavailablelocales.php - * @return array An array of strings, one for which locale. + * {@inheritdoc} + * @param int $field */ - public static function getAvailableLocales (): array {} + public function getGreatestMinimum (int $field) {} /** - * Tell whether a day is a weekday, weekend or a day that has a transition between the two - * @link http://www.php.net/manual/en/intlcalendar.getdayofweektype.php - * @param int $dayOfWeek One of the constants IntlCalendar::DOW_SUNDAY, - * IntlCalendar::DOW_MONDAY, …, - * IntlCalendar::DOW_SATURDAY. - * @return int|false Returns one of the constants - * IntlCalendar::DOW_TYPE_WEEKDAY, - * IntlCalendar::DOW_TYPE_WEEKEND, - * IntlCalendar::DOW_TYPE_WEEKEND_OFFSET or - * IntlCalendar::DOW_TYPE_WEEKEND_CEASE or false on failure. + * {@inheritdoc} + * @param string $keyword + * @param string $locale + * @param bool $onlyCommon */ - public function getDayOfWeekType (int $dayOfWeek): int|false {} + public static function getKeywordValuesForLocale (string $keyword, string $locale, bool $onlyCommon) {} /** - * Get last error code on the object - * @link http://www.php.net/manual/en/intlcalendar.geterrorcode.php - * @return int|false An ICU error code indicating either success, failure or a warning. - * Returns false on failure. + * {@inheritdoc} + * @param int $field */ - public function getErrorCode (): int|false {} + public function getLeastMaximum (int $field) {} /** - * Get last error message on the object - * @link http://www.php.net/manual/en/intlcalendar.geterrormessage.php - * @return string|false The error message associated with last error that occurred in a function call - * on this object, or a string indicating the non-existence of an error. - * Returns false on failure. + * {@inheritdoc} + * @param int $type */ - public function getErrorMessage (): string|false {} + public function getLocale (int $type) {} /** - * Get the first day of the week for the calendarʼs locale - * @link http://www.php.net/manual/en/intlcalendar.getfirstdayofweek.php - * @return int|false One of the constants IntlCalendar::DOW_SUNDAY, - * IntlCalendar::DOW_MONDAY, …, - * IntlCalendar::DOW_SATURDAY or false on failure. + * {@inheritdoc} + * @param int $field */ - public function getFirstDayOfWeek (): int|false {} + public function getMaximum (int $field) {} /** - * Get the largest local minimum value for a field - * @link http://www.php.net/manual/en/intlcalendar.getgreatestminimum.php - * @param int $field > - * One of the IntlCalendar date/time field constants. These are integer - * values between 0 and - * IntlCalendar::FIELD_COUNT. - * @return int|false An int representing a field value, in the fieldʼs - * unit, or false on failure. + * {@inheritdoc} */ - public function getGreatestMinimum (int $field): int|false {} + public function getMinimalDaysInFirstWeek () {} /** - * Get set of locale keyword values - * @link http://www.php.net/manual/en/intlcalendar.getkeywordvaluesforlocale.php - * @param string $keyword The locale keyword for which relevant values are to be queried. Only - * 'calendar' is supported. - * @param string $locale The locale onto which the keyword/value pair are to be appended. - * @param bool $onlyCommon Whether to show only the values commonly used for the specified locale. - * @return IntlIterator|false An iterator that yields strings with the locale keyword - * values or false on failure. + * {@inheritdoc} + * @param int $days */ - public static function getKeywordValuesForLocale (string $keyword, string $locale, bool $onlyCommon): IntlIterator|false {} + public function setMinimalDaysInFirstWeek (int $days) {} /** - * Get the smallest local maximum for a field - * @link http://www.php.net/manual/en/intlcalendar.getleastmaximum.php - * @param int $field > - * One of the IntlCalendar date/time field constants. These are integer - * values between 0 and - * IntlCalendar::FIELD_COUNT. - * @return int|false An int representing a field value in the fieldʼs - * unit or false on failure. + * {@inheritdoc} + * @param int $field */ - public function getLeastMaximum (int $field): int|false {} + public function getMinimum (int $field) {} /** - * Get the locale associated with the object - * @link http://www.php.net/manual/en/intlcalendar.getlocale.php - * @param int $type Whether to fetch the actual locale (the locale from which the calendar - * data originates, with Locale::ACTUAL_LOCALE) or the - * valid locale, i.e., the most specific locale supported by ICU relatively - * to the requested locale – see Locale::VALID_LOCALE. - * From the most general to the most specific, the locales are ordered in - * this fashion – actual locale, valid locale, requested locale. - * @return string|false A locale string or false on failure. + * {@inheritdoc} */ - public function getLocale (int $type): string|false {} + public static function getNow () {} /** - * Get the global maximum value for a field - * @link http://www.php.net/manual/en/intlcalendar.getmaximum.php - * @param int $field > - * One of the IntlCalendar date/time field constants. These are integer - * values between 0 and - * IntlCalendar::FIELD_COUNT. - * @return int|false An int representing a field value in the fieldʼs - * unit or false on failure. + * {@inheritdoc} */ - public function getMaximum (int $field): int|false {} + public function getRepeatedWallTimeOption () {} /** - * Get minimal number of days the first week in a year or month can have - * @link http://www.php.net/manual/en/intlcalendar.getminimaldaysinfirstweek.php - * @return int|false An int representing a number of days or false on failure. + * {@inheritdoc} */ - public function getMinimalDaysInFirstWeek (): int|false {} + public function getSkippedWallTimeOption () {} /** - * Set minimal number of days the first week in a year or month can have - * @link http://www.php.net/manual/en/intlcalendar.setminimaldaysinfirstweek.php - * @param int $days The number of minimal days to set. - * @return bool true on success, false on failure. + * {@inheritdoc} */ - public function setMinimalDaysInFirstWeek (int $days): bool {} + public function getTime () {} /** - * Get the global minimum value for a field - * @link http://www.php.net/manual/en/intlcalendar.getminimum.php - * @param int $field > - * One of the IntlCalendar date/time field constants. These are integer - * values between 0 and - * IntlCalendar::FIELD_COUNT. - * @return int|false An int representing a value for the given - * field in the fieldʼs unit or false on failure. + * {@inheritdoc} */ - public function getMinimum (int $field): int|false {} + public function getTimeZone () {} /** - * Get number representing the current time - * @link http://www.php.net/manual/en/intlcalendar.getnow.php - * @return float A float representing a number of milliseconds since the epoch, - * not counting leap seconds. + * {@inheritdoc} */ - public static function getNow (): float {} + public function getType () {} /** - * Get behavior for handling repeating wall time - * @link http://www.php.net/manual/en/intlcalendar.getrepeatedwalltimeoption.php - * @return int One of the constants IntlCalendar::WALLTIME_FIRST or - * IntlCalendar::WALLTIME_LAST. + * {@inheritdoc} + * @param int $dayOfWeek */ - public function getRepeatedWallTimeOption (): int {} + public function getWeekendTransition (int $dayOfWeek) {} /** - * Get behavior for handling skipped wall time - * @link http://www.php.net/manual/en/intlcalendar.getskippedwalltimeoption.php - * @return int One of the constants IntlCalendar::WALLTIME_FIRST, - * IntlCalendar::WALLTIME_LAST or - * IntlCalendar::WALLTIME_NEXT_VALID. + * {@inheritdoc} */ - public function getSkippedWallTimeOption (): int {} + public function inDaylightTime () {} /** - * Get time currently represented by the object - * @link http://www.php.net/manual/en/intlcalendar.gettime.php - * @return float|false A float representing the number of milliseconds elapsed since the - * reference time (1 Jan 1970 00:00:00 UTC), or false on failure + * {@inheritdoc} + * @param IntlCalendar $other */ - public function getTime (): float|false {} + public function isEquivalentTo (IntlCalendar $other) {} /** - * Get the objectʼs timezone - * @link http://www.php.net/manual/en/intlcalendar.gettimezone.php - * @return IntlTimeZone|false An IntlTimeZone object corresponding to the one used - * internally in this object. Returns false on failure. + * {@inheritdoc} */ - public function getTimeZone (): IntlTimeZone|false {} + public function isLenient () {} /** - * Get the calendar type - * @link http://www.php.net/manual/en/intlcalendar.gettype.php - * @return string A string representing the calendar type, such as - * 'gregorian', 'islamic', etc. + * {@inheritdoc} + * @param float|null $timestamp [optional] */ - public function getType (): string {} + public function isWeekend (?float $timestamp = NULL) {} /** - * Get time of the day at which weekend begins or ends - * @link http://www.php.net/manual/en/intlcalendar.getweekendtransition.php - * @param int $dayOfWeek One of the constants IntlCalendar::DOW_SUNDAY, - * IntlCalendar::DOW_MONDAY, …, - * IntlCalendar::DOW_SATURDAY. - * @return int|false The number of milliseconds into the day at which the weekend begins or - * ends or false on failure. + * {@inheritdoc} + * @param int $field + * @param mixed $value */ - public function getWeekendTransition (int $dayOfWeek): int|false {} + public function roll (int $field, $value = null) {} /** - * Whether the objectʼs time is in Daylight Savings Time - * @link http://www.php.net/manual/en/intlcalendar.indaylighttime.php - * @return bool Returns true if the date is in Daylight Savings Time, false otherwise. - *>On failure false is also returned. To detect error conditions use intl_get_error_code, or set up Intl to throw exceptions.
+ * {@inheritdoc} + * @param int $field */ - public function inDaylightTime (): bool {} + public function isSet (int $field) {} /** - * Whether another calendar is equal but for a different time - * @link http://www.php.net/manual/en/intlcalendar.isequivalentto.php - * @param IntlCalendar $other The other calendar against which the comparison is to be made. - * @return bool Assuming there are no argument errors, returns true if the calendars are - * equivalent except possibly for their set time. + * {@inheritdoc} + * @param int $year + * @param int $month + * @param int $dayOfMonth [optional] + * @param int $hour [optional] + * @param int $minute [optional] + * @param int $second [optional] */ - public function isEquivalentTo (IntlCalendar $other): bool {} + public function set (int $year, int $month, int $dayOfMonth = NULL, int $hour = NULL, int $minute = NULL, int $second = NULL) {} /** - * Whether date/time interpretation is in lenient mode - * @link http://www.php.net/manual/en/intlcalendar.islenient.php - * @return bool A bool representing whether the calendar is set to lenient mode. + * {@inheritdoc} + * @param int $year + * @param int $month + * @param int $dayOfMonth */ - public function isLenient (): bool {} + public function setDate (int $year, int $month, int $dayOfMonth): void {} /** - * Whether a certain date/time is in the weekend - * @link http://www.php.net/manual/en/intlcalendar.isweekend.php - * @param float|null $timestamp [optional] An optional timestamp representing the number of milliseconds since the - * epoch, excluding leap seconds. If null, this objectʼs current time is - * used instead. - * @return bool A bool indicating whether the given or this objectʼs time occurs - * in a weekend. - *>On failure false is also returned. To detect error conditions use intl_get_error_code, or set up Intl to throw exceptions.
+ * {@inheritdoc} + * @param int $year + * @param int $month + * @param int $dayOfMonth + * @param int $hour + * @param int $minute + * @param int|null $second [optional] */ - public function isWeekend (?float $timestamp = null): bool {} + public function setDateTime (int $year, int $month, int $dayOfMonth, int $hour, int $minute, ?int $second = NULL): void {} /** - * Add value to field without carrying into more significant fields - * @link http://www.php.net/manual/en/intlcalendar.roll.php - * @param int $field > - * One of the IntlCalendar date/time field constants. These are integer - * values between 0 and - * IntlCalendar::FIELD_COUNT. - * @param int|bool $value The (signed) amount to add to the field, true for rolling up (adding - * 1), or false for rolling down (subtracting - * 1). - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $dayOfWeek */ - public function roll (int $field, int|bool $value): bool {} + public function setFirstDayOfWeek (int $dayOfWeek) {} /** - * Whether a field is set - * @link http://www.php.net/manual/en/intlcalendar.isset.php - * @param int $field > - * One of the IntlCalendar date/time field constants. These are integer - * values between 0 and - * IntlCalendar::FIELD_COUNT. - * @return bool Assuming there are no argument errors, returns true if the field is set. + * {@inheritdoc} + * @param bool $lenient */ - public function isSet (int $field): bool {} + public function setLenient (bool $lenient) {} /** - * Set a time field or several common fields at once - * @link http://www.php.net/manual/en/intlcalendar.set.php - * @param int $field > - * One of the IntlCalendar date/time field constants. These are integer - * values between 0 and - * IntlCalendar::FIELD_COUNT. - * @param int $value The new value of the given field. - * @return true Always returns true. + * {@inheritdoc} + * @param int $option */ - public function set (int $field, int $value): true {} + public function setRepeatedWallTimeOption (int $option) {} /** - * Set the day on which the week is deemed to start - * @link http://www.php.net/manual/en/intlcalendar.setfirstdayofweek.php - * @param int $dayOfWeek One of the constants IntlCalendar::DOW_SUNDAY, - * IntlCalendar::DOW_MONDAY, …, - * IntlCalendar::DOW_SATURDAY. - * @return true Always returns true. + * {@inheritdoc} + * @param int $option */ - public function setFirstDayOfWeek (int $dayOfWeek): true {} - + public function setSkippedWallTimeOption (int $option) {} + /** - * Set whether date/time interpretation is to be lenient - * @link http://www.php.net/manual/en/intlcalendar.setlenient.php - * @param bool $lenient Use true to activate the lenient mode; false otherwise. - * @return true Always returns true. + * {@inheritdoc} + * @param float $timestamp */ - public function setLenient (bool $lenient): true {} - - /** - * Set behavior for handling repeating wall times at negative timezone offset transitions - * @link http://www.php.net/manual/en/intlcalendar.setrepeatedwalltimeoption.php - * @param int $option One of the constants IntlCalendar::WALLTIME_FIRST or - * IntlCalendar::WALLTIME_LAST. - * @return true Always returns true. + public function setTime (float $timestamp) {} + + /** + * {@inheritdoc} + * @param mixed $timezone */ - public function setRepeatedWallTimeOption (int $option): true {} + public function setTimeZone ($timezone = null) {} - /** - * Set behavior for handling skipped wall times at positive timezone offset transitions - * @link http://www.php.net/manual/en/intlcalendar.setskippedwalltimeoption.php - * @param int $option One of the constants IntlCalendar::WALLTIME_FIRST, - * IntlCalendar::WALLTIME_LAST or - * IntlCalendar::WALLTIME_NEXT_VALID. - * @return true Always returns true. - */ - public function setSkippedWallTimeOption (int $option): true {} - - /** - * Set the calendar time in milliseconds since the epoch - * @link http://www.php.net/manual/en/intlcalendar.settime.php - * @param float $timestamp An instant represented by the number of number of milliseconds between - * such instant and the epoch, ignoring leap seconds. - * @return bool Returns true on success and false on failure. - */ - public function setTime (float $timestamp): bool {} - - /** - * Set the timezone used by this calendar - * @link http://www.php.net/manual/en/intlcalendar.settimezone.php - * @param IntlTimeZone|DateTimeZone|string|null $timezone The new timezone to be used by this calendar. It can be specified in the - * following ways: - *
- *
- *
- * null, in which case the default timezone will be used, as specified in - * the ini setting date.timezone or - * through the function date_default_timezone_set and as - * returned by date_default_timezone_get. - *
- *- * An IntlTimeZone, which will be used directly. - *
- *- * A DateTimeZone. Its identifier will be extracted - * and an ICU timezone object will be created; the timezone will be backed - * by ICUʼs database, not PHPʼs. - *
- *- * A string, which should be a valid ICU timezone identifier. - * See IntlTimeZone::createTimeZoneIDEnumeration. Raw - * offsets such as "GMT+08:30" are also accepted. - *
- * - *null, in which case the default timezone will be used, as specified in - * the ini setting date.timezone or - * through the function date_default_timezone_set and as - * returned by date_default_timezone_get.
- *An IntlTimeZone, which will be used directly.
- *A DateTimeZone. Its identifier will be extracted - * and an ICU timezone object will be created; the timezone will be backed - * by ICUʼs database, not PHPʼs.
- *A string, which should be a valid ICU timezone identifier. - * See IntlTimeZone::createTimeZoneIDEnumeration. Raw - * offsets such as "GMT+08:30" are also accepted.
- * @return bool Returns true on success and false on failure. - */ - public function setTimeZone (IntlTimeZone|DateTimeZone|string|null $timezone): bool {} - - /** - * Convert an IntlCalendar into a DateTime object - * @link http://www.php.net/manual/en/intlcalendar.todatetime.php - * @return DateTime|false A DateTime object with the same timezone as this - * object (though using PHPʼs database instead of ICUʼs) and the same time, - * except for the smaller precision (second precision instead of millisecond). - * Returns false on failure. - */ - public function toDateTime (): DateTime|false {} + /** + * {@inheritdoc} + */ + public function toDateTime () {} } -/** - * @link http://www.php.net/manual/en/class.intlgregoriancalendar.php - */ class IntlGregorianCalendar extends IntlCalendar { const FIELD_ERA = 0; const FIELD_YEAR = 1; @@ -2562,7 +1348,7 @@ class IntlGregorianCalendar extends IntlCalendar { const FIELD_JULIAN_DAY = 20; const FIELD_MILLISECONDS_IN_DAY = 21; const FIELD_IS_LEAP_MONTH = 22; - const FIELD_FIELD_COUNT = 23; + const FIELD_FIELD_COUNT = 24; const FIELD_DAY_OF_MONTH = 5; const DOW_SUNDAY = 1; const DOW_MONDAY = 2; @@ -2581,560 +1367,341 @@ class IntlGregorianCalendar extends IntlCalendar { /** - * Create the Gregorian Calendar class - * @link http://www.php.net/manual/en/intlgregoriancalendar.construct.php - * @param IntlTimeZone $tz [optional] - * @param string $locale [optional] - * @return IntlTimeZone + * {@inheritdoc} + * @param int $year + * @param int $month + * @param int $dayOfMonth + */ + public static function createFromDate (int $year, int $month, int $dayOfMonth): static {} + + /** + * {@inheritdoc} + * @param int $year + * @param int $month + * @param int $dayOfMonth + * @param int $hour + * @param int $minute + * @param int|null $second [optional] + */ + public static function createFromDateTime (int $year, int $month, int $dayOfMonth, int $hour, int $minute, ?int $second = NULL): static {} + + /** + * {@inheritdoc} + * @param mixed $timezoneOrYear [optional] + * @param mixed $localeOrMonth [optional] + * @param mixed $day [optional] + * @param mixed $hour [optional] + * @param mixed $minute [optional] + * @param mixed $second [optional] + */ + public function __construct ($timezoneOrYear = NULL, $localeOrMonth = NULL, $day = NULL, $hour = NULL, $minute = NULL, $second = NULL) {} + + /** + * {@inheritdoc} + * @param float $timestamp + */ + public function setGregorianChange (float $timestamp) {} + + /** + * {@inheritdoc} + */ + public function getGregorianChange () {} + + /** + * {@inheritdoc} + * @param int $year + */ + public function isLeapYear (int $year) {} + + /** + * {@inheritdoc} + * @param mixed $timezone [optional] + * @param string|null $locale [optional] + */ + public static function createInstance ($timezone = NULL, ?string $locale = NULL) {} + + /** + * {@inheritdoc} + * @param IntlCalendar $other */ - public function __construct (IntlTimeZone $tz = null, string $locale = null): IntlTimeZone {} + public function equals (IntlCalendar $other) {} /** - * Set the Gregorian Calendar the change date - * @link http://www.php.net/manual/en/intlgregoriancalendar.setgregorianchange.php - * @param float $timestamp - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param float $timestamp + * @param int $field */ - public function setGregorianChange (float $timestamp): bool {} + public function fieldDifference (float $timestamp, int $field) {} /** - * Get the Gregorian Calendar change date - * @link http://www.php.net/manual/en/intlgregoriancalendar.getgregorianchange.php - * @return float Returns the change date. + * {@inheritdoc} + * @param int $field + * @param int $value */ - public function getGregorianChange (): float {} + public function add (int $field, int $value) {} /** - * Determine if the given year is a leap year - * @link http://www.php.net/manual/en/intlgregoriancalendar.isleapyear.php - * @param int $year - * @return bool Returns true for leap years, false otherwise and on failure. + * {@inheritdoc} + * @param IntlCalendar $other */ - public function isLeapYear (int $year): bool {} + public function after (IntlCalendar $other) {} /** - * Create a new IntlCalendar - * @link http://www.php.net/manual/en/intlcalendar.createinstance.php - * @param IntlTimeZone|DateTimeZone|string|null $timezone [optional] The timezone to use. - *null, in which case the default timezone will be used, as specified in - * the ini setting date.timezone or - * through the function date_default_timezone_set and as - * returned by date_default_timezone_get.
- *An IntlTimeZone, which will be used directly.
- *A DateTimeZone. Its identifier will be extracted - * and an ICU timezone object will be created; the timezone will be backed - * by ICUʼs database, not PHPʼs.
- *A string, which should be a valid ICU timezone identifier. - * See IntlTimeZone::createTimeZoneIDEnumeration. Raw - * offsets such as "GMT+08:30" are also accepted.
- * @param string|null $locale [optional] A locale to use or null to use the default locale. - * @return IntlCalendar|null The created IntlCalendar instance or null on - * failure. + * {@inheritdoc} + * @param IntlCalendar $other */ - public static function createInstance (IntlTimeZone|DateTimeZone|string|null $timezone = null, ?string $locale = null): ?IntlCalendar {} + public function before (IntlCalendar $other) {} /** - * Compare time of two IntlCalendar objects for equality - * @link http://www.php.net/manual/en/intlcalendar.equals.php - * @param IntlCalendar $other The calendar to compare with the primary object. - * @return bool Returns true if the current time of both this and the passed in - * IntlCalendar object are the same, or false - * otherwise. - *>On failure false is also returned. To detect error conditions use intl_get_error_code, or set up Intl to throw exceptions.
+ * {@inheritdoc} + * @param int|null $field [optional] */ - public function equals (IntlCalendar $other): bool {} + public function clear (?int $field = NULL) {} /** - * Calculate difference between given time and this objectʼs time - * @link http://www.php.net/manual/en/intlcalendar.fielddifference.php - * @param float $timestamp The time against which to compare the quantity represented by the - * field. For the result to be positive, the time - * given for this parameter must be ahead of the time of the object the - * method is being invoked on. - * @param int $field The field that represents the quantity being compared. - *> - * One of the IntlCalendar date/time field constants. These are integer - * values between 0 and - * IntlCalendar::FIELD_COUNT.
- * @return int|false Returns a (signed) difference of time in the unit associated with the - * specified field or false on failure. + * {@inheritdoc} + * @param DateTime|string $datetime + * @param string|null $locale [optional] */ - public function fieldDifference (float $timestamp, int $field): int|false {} + public static function fromDateTime (DateTime|string $datetime, ?string $locale = NULL) {} /** - * Add a (signed) amount of time to a field - * @link http://www.php.net/manual/en/intlcalendar.add.php - * @param int $field > - * One of the IntlCalendar date/time field constants. These are integer - * values between 0 and - * IntlCalendar::FIELD_COUNT. - * @param int $value The signed amount to add to the current field. If the amount is positive, - * the instant will be moved forward; if it is negative, the instant will be - * moved into the past. The unit is implicit to the field type. For instance, - * hours for IntlCalendar::FIELD_HOUR_OF_DAY. - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $field */ - public function add (int $field, int $value): bool {} + public function get (int $field) {} /** - * Whether this objectʼs time is after that of the passed object - * @link http://www.php.net/manual/en/intlcalendar.after.php - * @param IntlCalendar $other The calendar whose time will be checked against the primary objectʼs time. - * @return bool Returns true if this objectʼs current time is after that of the - * calendar argumentʼs time. Returns false otherwise. - *>On failure false is also returned. To detect error conditions use intl_get_error_code, or set up Intl to throw exceptions.
+ * {@inheritdoc} + * @param int $field */ - public function after (IntlCalendar $other): bool {} + public function getActualMaximum (int $field) {} /** - * Whether this objectʼs time is before that of the passed object - * @link http://www.php.net/manual/en/intlcalendar.before.php - * @param IntlCalendar $other The calendar whose time will be checked against the primary objectʼs time. - * @return bool Returns true if this objectʼs current time is before that of the - * calendar argumentʼs time. Returns false otherwise. - *>On failure false is also returned. To detect error conditions use intl_get_error_code, or set up Intl to throw exceptions.
+ * {@inheritdoc} + * @param int $field */ - public function before (IntlCalendar $other): bool {} + public function getActualMinimum (int $field) {} /** - * Clear a field or all fields - * @link http://www.php.net/manual/en/intlcalendar.clear.php - * @param int|null $field [optional] > - * One of the IntlCalendar date/time field constants. These are integer - * values between 0 and - * IntlCalendar::FIELD_COUNT. - * @return true Always returns true. + * {@inheritdoc} */ - public function clear (?int $field = null): true {} + public static function getAvailableLocales () {} /** - * Create an IntlCalendar from a DateTime object or string - * @link http://www.php.net/manual/en/intlcalendar.fromdatetime.php - * @param DateTime|string $datetime A DateTime object or a string that - * can be passed to DateTime::__construct. - * @param string|null $locale [optional] - * @return IntlCalendar|null The created IntlCalendar object or null in case of - * failure. If a string is passed, any exception that occurs - * inside the DateTime constructor is propagated. + * {@inheritdoc} + * @param int $dayOfWeek */ - public static function fromDateTime (DateTime|string $datetime, ?string $locale = null): ?IntlCalendar {} + public function getDayOfWeekType (int $dayOfWeek) {} /** - * Get the value for a field - * @link http://www.php.net/manual/en/intlcalendar.get.php - * @param int $field > - * One of the IntlCalendar date/time field constants. These are integer - * values between 0 and - * IntlCalendar::FIELD_COUNT. - * @return int|false An integer with the value of the time field. + * {@inheritdoc} */ - public function get (int $field): int|false {} + public function getErrorCode () {} /** - * The maximum value for a field, considering the objectʼs current time - * @link http://www.php.net/manual/en/intlcalendar.getactualmaximum.php - * @param int $field > - * One of the IntlCalendar date/time field constants. These are integer - * values between 0 and - * IntlCalendar::FIELD_COUNT. - * @return int|false An int representing the maximum value in the units associated - * with the given field or false on failure. + * {@inheritdoc} */ - public function getActualMaximum (int $field): int|false {} + public function getErrorMessage () {} /** - * The minimum value for a field, considering the objectʼs current time - * @link http://www.php.net/manual/en/intlcalendar.getactualminimum.php - * @param int $field > - * One of the IntlCalendar date/time field constants. These are integer - * values between 0 and - * IntlCalendar::FIELD_COUNT. - * @return int|false An int representing the minimum value in the fieldʼs - * unit or false on failure. + * {@inheritdoc} */ - public function getActualMinimum (int $field): int|false {} + public function getFirstDayOfWeek () {} /** - * Get array of locales for which there is data - * @link http://www.php.net/manual/en/intlcalendar.getavailablelocales.php - * @return array An array of strings, one for which locale. + * {@inheritdoc} + * @param int $field */ - public static function getAvailableLocales (): array {} + public function getGreatestMinimum (int $field) {} /** - * Tell whether a day is a weekday, weekend or a day that has a transition between the two - * @link http://www.php.net/manual/en/intlcalendar.getdayofweektype.php - * @param int $dayOfWeek One of the constants IntlCalendar::DOW_SUNDAY, - * IntlCalendar::DOW_MONDAY, …, - * IntlCalendar::DOW_SATURDAY. - * @return int|false Returns one of the constants - * IntlCalendar::DOW_TYPE_WEEKDAY, - * IntlCalendar::DOW_TYPE_WEEKEND, - * IntlCalendar::DOW_TYPE_WEEKEND_OFFSET or - * IntlCalendar::DOW_TYPE_WEEKEND_CEASE or false on failure. + * {@inheritdoc} + * @param string $keyword + * @param string $locale + * @param bool $onlyCommon */ - public function getDayOfWeekType (int $dayOfWeek): int|false {} + public static function getKeywordValuesForLocale (string $keyword, string $locale, bool $onlyCommon) {} /** - * Get last error code on the object - * @link http://www.php.net/manual/en/intlcalendar.geterrorcode.php - * @return int|false An ICU error code indicating either success, failure or a warning. - * Returns false on failure. + * {@inheritdoc} + * @param int $field */ - public function getErrorCode (): int|false {} + public function getLeastMaximum (int $field) {} /** - * Get last error message on the object - * @link http://www.php.net/manual/en/intlcalendar.geterrormessage.php - * @return string|false The error message associated with last error that occurred in a function call - * on this object, or a string indicating the non-existence of an error. - * Returns false on failure. + * {@inheritdoc} + * @param int $type */ - public function getErrorMessage (): string|false {} + public function getLocale (int $type) {} /** - * Get the first day of the week for the calendarʼs locale - * @link http://www.php.net/manual/en/intlcalendar.getfirstdayofweek.php - * @return int|false One of the constants IntlCalendar::DOW_SUNDAY, - * IntlCalendar::DOW_MONDAY, …, - * IntlCalendar::DOW_SATURDAY or false on failure. + * {@inheritdoc} + * @param int $field */ - public function getFirstDayOfWeek (): int|false {} + public function getMaximum (int $field) {} /** - * Get the largest local minimum value for a field - * @link http://www.php.net/manual/en/intlcalendar.getgreatestminimum.php - * @param int $field > - * One of the IntlCalendar date/time field constants. These are integer - * values between 0 and - * IntlCalendar::FIELD_COUNT. - * @return int|false An int representing a field value, in the fieldʼs - * unit, or false on failure. + * {@inheritdoc} */ - public function getGreatestMinimum (int $field): int|false {} + public function getMinimalDaysInFirstWeek () {} /** - * Get set of locale keyword values - * @link http://www.php.net/manual/en/intlcalendar.getkeywordvaluesforlocale.php - * @param string $keyword The locale keyword for which relevant values are to be queried. Only - * 'calendar' is supported. - * @param string $locale The locale onto which the keyword/value pair are to be appended. - * @param bool $onlyCommon Whether to show only the values commonly used for the specified locale. - * @return IntlIterator|false An iterator that yields strings with the locale keyword - * values or false on failure. + * {@inheritdoc} + * @param int $days */ - public static function getKeywordValuesForLocale (string $keyword, string $locale, bool $onlyCommon): IntlIterator|false {} + public function setMinimalDaysInFirstWeek (int $days) {} /** - * Get the smallest local maximum for a field - * @link http://www.php.net/manual/en/intlcalendar.getleastmaximum.php - * @param int $field > - * One of the IntlCalendar date/time field constants. These are integer - * values between 0 and - * IntlCalendar::FIELD_COUNT. - * @return int|false An int representing a field value in the fieldʼs - * unit or false on failure. + * {@inheritdoc} + * @param int $field */ - public function getLeastMaximum (int $field): int|false {} + public function getMinimum (int $field) {} /** - * Get the locale associated with the object - * @link http://www.php.net/manual/en/intlcalendar.getlocale.php - * @param int $type Whether to fetch the actual locale (the locale from which the calendar - * data originates, with Locale::ACTUAL_LOCALE) or the - * valid locale, i.e., the most specific locale supported by ICU relatively - * to the requested locale – see Locale::VALID_LOCALE. - * From the most general to the most specific, the locales are ordered in - * this fashion – actual locale, valid locale, requested locale. - * @return string|false A locale string or false on failure. + * {@inheritdoc} */ - public function getLocale (int $type): string|false {} + public static function getNow () {} /** - * Get the global maximum value for a field - * @link http://www.php.net/manual/en/intlcalendar.getmaximum.php - * @param int $field > - * One of the IntlCalendar date/time field constants. These are integer - * values between 0 and - * IntlCalendar::FIELD_COUNT. - * @return int|false An int representing a field value in the fieldʼs - * unit or false on failure. + * {@inheritdoc} */ - public function getMaximum (int $field): int|false {} + public function getRepeatedWallTimeOption () {} /** - * Get minimal number of days the first week in a year or month can have - * @link http://www.php.net/manual/en/intlcalendar.getminimaldaysinfirstweek.php - * @return int|false An int representing a number of days or false on failure. + * {@inheritdoc} */ - public function getMinimalDaysInFirstWeek (): int|false {} + public function getSkippedWallTimeOption () {} /** - * Set minimal number of days the first week in a year or month can have - * @link http://www.php.net/manual/en/intlcalendar.setminimaldaysinfirstweek.php - * @param int $days The number of minimal days to set. - * @return bool true on success, false on failure. + * {@inheritdoc} */ - public function setMinimalDaysInFirstWeek (int $days): bool {} + public function getTime () {} /** - * Get the global minimum value for a field - * @link http://www.php.net/manual/en/intlcalendar.getminimum.php - * @param int $field > - * One of the IntlCalendar date/time field constants. These are integer - * values between 0 and - * IntlCalendar::FIELD_COUNT. - * @return int|false An int representing a value for the given - * field in the fieldʼs unit or false on failure. + * {@inheritdoc} */ - public function getMinimum (int $field): int|false {} + public function getTimeZone () {} /** - * Get number representing the current time - * @link http://www.php.net/manual/en/intlcalendar.getnow.php - * @return float A float representing a number of milliseconds since the epoch, - * not counting leap seconds. + * {@inheritdoc} */ - public static function getNow (): float {} + public function getType () {} /** - * Get behavior for handling repeating wall time - * @link http://www.php.net/manual/en/intlcalendar.getrepeatedwalltimeoption.php - * @return int One of the constants IntlCalendar::WALLTIME_FIRST or - * IntlCalendar::WALLTIME_LAST. + * {@inheritdoc} + * @param int $dayOfWeek */ - public function getRepeatedWallTimeOption (): int {} + public function getWeekendTransition (int $dayOfWeek) {} /** - * Get behavior for handling skipped wall time - * @link http://www.php.net/manual/en/intlcalendar.getskippedwalltimeoption.php - * @return int One of the constants IntlCalendar::WALLTIME_FIRST, - * IntlCalendar::WALLTIME_LAST or - * IntlCalendar::WALLTIME_NEXT_VALID. + * {@inheritdoc} */ - public function getSkippedWallTimeOption (): int {} + public function inDaylightTime () {} /** - * Get time currently represented by the object - * @link http://www.php.net/manual/en/intlcalendar.gettime.php - * @return float|false A float representing the number of milliseconds elapsed since the - * reference time (1 Jan 1970 00:00:00 UTC), or false on failure + * {@inheritdoc} + * @param IntlCalendar $other */ - public function getTime (): float|false {} + public function isEquivalentTo (IntlCalendar $other) {} /** - * Get the objectʼs timezone - * @link http://www.php.net/manual/en/intlcalendar.gettimezone.php - * @return IntlTimeZone|false An IntlTimeZone object corresponding to the one used - * internally in this object. Returns false on failure. + * {@inheritdoc} */ - public function getTimeZone (): IntlTimeZone|false {} + public function isLenient () {} /** - * Get the calendar type - * @link http://www.php.net/manual/en/intlcalendar.gettype.php - * @return string A string representing the calendar type, such as - * 'gregorian', 'islamic', etc. + * {@inheritdoc} + * @param float|null $timestamp [optional] */ - public function getType (): string {} + public function isWeekend (?float $timestamp = NULL) {} /** - * Get time of the day at which weekend begins or ends - * @link http://www.php.net/manual/en/intlcalendar.getweekendtransition.php - * @param int $dayOfWeek One of the constants IntlCalendar::DOW_SUNDAY, - * IntlCalendar::DOW_MONDAY, …, - * IntlCalendar::DOW_SATURDAY. - * @return int|false The number of milliseconds into the day at which the weekend begins or - * ends or false on failure. + * {@inheritdoc} + * @param int $field + * @param mixed $value */ - public function getWeekendTransition (int $dayOfWeek): int|false {} + public function roll (int $field, $value = null) {} /** - * Whether the objectʼs time is in Daylight Savings Time - * @link http://www.php.net/manual/en/intlcalendar.indaylighttime.php - * @return bool Returns true if the date is in Daylight Savings Time, false otherwise. - *>On failure false is also returned. To detect error conditions use intl_get_error_code, or set up Intl to throw exceptions.
+ * {@inheritdoc} + * @param int $field */ - public function inDaylightTime (): bool {} + public function isSet (int $field) {} /** - * Whether another calendar is equal but for a different time - * @link http://www.php.net/manual/en/intlcalendar.isequivalentto.php - * @param IntlCalendar $other The other calendar against which the comparison is to be made. - * @return bool Assuming there are no argument errors, returns true if the calendars are - * equivalent except possibly for their set time. + * {@inheritdoc} + * @param int $year + * @param int $month + * @param int $dayOfMonth [optional] + * @param int $hour [optional] + * @param int $minute [optional] + * @param int $second [optional] */ - public function isEquivalentTo (IntlCalendar $other): bool {} + public function set (int $year, int $month, int $dayOfMonth = NULL, int $hour = NULL, int $minute = NULL, int $second = NULL) {} /** - * Whether date/time interpretation is in lenient mode - * @link http://www.php.net/manual/en/intlcalendar.islenient.php - * @return bool A bool representing whether the calendar is set to lenient mode. + * {@inheritdoc} + * @param int $year + * @param int $month + * @param int $dayOfMonth */ - public function isLenient (): bool {} + public function setDate (int $year, int $month, int $dayOfMonth): void {} /** - * Whether a certain date/time is in the weekend - * @link http://www.php.net/manual/en/intlcalendar.isweekend.php - * @param float|null $timestamp [optional] An optional timestamp representing the number of milliseconds since the - * epoch, excluding leap seconds. If null, this objectʼs current time is - * used instead. - * @return bool A bool indicating whether the given or this objectʼs time occurs - * in a weekend. - *>On failure false is also returned. To detect error conditions use intl_get_error_code, or set up Intl to throw exceptions.
+ * {@inheritdoc} + * @param int $year + * @param int $month + * @param int $dayOfMonth + * @param int $hour + * @param int $minute + * @param int|null $second [optional] */ - public function isWeekend (?float $timestamp = null): bool {} + public function setDateTime (int $year, int $month, int $dayOfMonth, int $hour, int $minute, ?int $second = NULL): void {} /** - * Add value to field without carrying into more significant fields - * @link http://www.php.net/manual/en/intlcalendar.roll.php - * @param int $field > - * One of the IntlCalendar date/time field constants. These are integer - * values between 0 and - * IntlCalendar::FIELD_COUNT. - * @param int|bool $value The (signed) amount to add to the field, true for rolling up (adding - * 1), or false for rolling down (subtracting - * 1). - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $dayOfWeek */ - public function roll (int $field, int|bool $value): bool {} + public function setFirstDayOfWeek (int $dayOfWeek) {} /** - * Whether a field is set - * @link http://www.php.net/manual/en/intlcalendar.isset.php - * @param int $field > - * One of the IntlCalendar date/time field constants. These are integer - * values between 0 and - * IntlCalendar::FIELD_COUNT. - * @return bool Assuming there are no argument errors, returns true if the field is set. + * {@inheritdoc} + * @param bool $lenient */ - public function isSet (int $field): bool {} + public function setLenient (bool $lenient) {} /** - * Set a time field or several common fields at once - * @link http://www.php.net/manual/en/intlcalendar.set.php - * @param int $field > - * One of the IntlCalendar date/time field constants. These are integer - * values between 0 and - * IntlCalendar::FIELD_COUNT. - * @param int $value The new value of the given field. - * @return true Always returns true. + * {@inheritdoc} + * @param int $option */ - public function set (int $field, int $value): true {} + public function setRepeatedWallTimeOption (int $option) {} /** - * Set the day on which the week is deemed to start - * @link http://www.php.net/manual/en/intlcalendar.setfirstdayofweek.php - * @param int $dayOfWeek One of the constants IntlCalendar::DOW_SUNDAY, - * IntlCalendar::DOW_MONDAY, …, - * IntlCalendar::DOW_SATURDAY. - * @return true Always returns true. + * {@inheritdoc} + * @param int $option */ - public function setFirstDayOfWeek (int $dayOfWeek): true {} - + public function setSkippedWallTimeOption (int $option) {} + /** - * Set whether date/time interpretation is to be lenient - * @link http://www.php.net/manual/en/intlcalendar.setlenient.php - * @param bool $lenient Use true to activate the lenient mode; false otherwise. - * @return true Always returns true. + * {@inheritdoc} + * @param float $timestamp */ - public function setLenient (bool $lenient): true {} - - /** - * Set behavior for handling repeating wall times at negative timezone offset transitions - * @link http://www.php.net/manual/en/intlcalendar.setrepeatedwalltimeoption.php - * @param int $option One of the constants IntlCalendar::WALLTIME_FIRST or - * IntlCalendar::WALLTIME_LAST. - * @return true Always returns true. + public function setTime (float $timestamp) {} + + /** + * {@inheritdoc} + * @param mixed $timezone */ - public function setRepeatedWallTimeOption (int $option): true {} + public function setTimeZone ($timezone = null) {} - /** - * Set behavior for handling skipped wall times at positive timezone offset transitions - * @link http://www.php.net/manual/en/intlcalendar.setskippedwalltimeoption.php - * @param int $option One of the constants IntlCalendar::WALLTIME_FIRST, - * IntlCalendar::WALLTIME_LAST or - * IntlCalendar::WALLTIME_NEXT_VALID. - * @return true Always returns true. - */ - public function setSkippedWallTimeOption (int $option): true {} - - /** - * Set the calendar time in milliseconds since the epoch - * @link http://www.php.net/manual/en/intlcalendar.settime.php - * @param float $timestamp An instant represented by the number of number of milliseconds between - * such instant and the epoch, ignoring leap seconds. - * @return bool Returns true on success and false on failure. - */ - public function setTime (float $timestamp): bool {} - - /** - * Set the timezone used by this calendar - * @link http://www.php.net/manual/en/intlcalendar.settimezone.php - * @param IntlTimeZone|DateTimeZone|string|null $timezone The new timezone to be used by this calendar. It can be specified in the - * following ways: - *
- *
- *
- * null, in which case the default timezone will be used, as specified in - * the ini setting date.timezone or - * through the function date_default_timezone_set and as - * returned by date_default_timezone_get. - *
- *- * An IntlTimeZone, which will be used directly. - *
- *- * A DateTimeZone. Its identifier will be extracted - * and an ICU timezone object will be created; the timezone will be backed - * by ICUʼs database, not PHPʼs. - *
- *- * A string, which should be a valid ICU timezone identifier. - * See IntlTimeZone::createTimeZoneIDEnumeration. Raw - * offsets such as "GMT+08:30" are also accepted. - *
- * - *null, in which case the default timezone will be used, as specified in - * the ini setting date.timezone or - * through the function date_default_timezone_set and as - * returned by date_default_timezone_get.
- *An IntlTimeZone, which will be used directly.
- *A DateTimeZone. Its identifier will be extracted - * and an ICU timezone object will be created; the timezone will be backed - * by ICUʼs database, not PHPʼs.
- *A string, which should be a valid ICU timezone identifier. - * See IntlTimeZone::createTimeZoneIDEnumeration. Raw - * offsets such as "GMT+08:30" are also accepted.
- * @return bool Returns true on success and false on failure. - */ - public function setTimeZone (IntlTimeZone|DateTimeZone|string|null $timezone): bool {} - - /** - * Convert an IntlCalendar into a DateTime object - * @link http://www.php.net/manual/en/intlcalendar.todatetime.php - * @return DateTime|false A DateTime object with the same timezone as this - * object (though using PHPʼs database instead of ICUʼs) and the same time, - * except for the smaller precision (second precision instead of millisecond). - * Returns false on failure. - */ - public function toDateTime (): DateTime|false {} + /** + * {@inheritdoc} + */ + public function toDateTime () {} } -/** - * This class is provided because Unicode contains large number of characters - * and incorporates the varied writing systems of the world and their incorrect - * usage can expose programs or systems to possible security attacks using - * characters similarity. - *Provided methods allow to check whether an individual string is likely an attempt - * at confusing the reader (spoof detection), such as "pаypаl" - * spelled with Cyrillic 'а' characters.
- * @link http://www.php.net/manual/en/class.spoofchecker.php - */ class Spoofchecker { const SINGLE_SCRIPT_CONFUSABLE = 1; const MIXED_SCRIPT_CONFUSABLE = 2; @@ -3149,60 +1716,41 @@ class Spoofchecker { const MINIMALLY_RESTRICTIVE = 1342177280; const UNRESTRICTIVE = 1610612736; const SINGLE_SCRIPT_RESTRICTIVE = 536870912; + const MIXED_NUMBERS = 128; + const HIDDEN_OVERLAY = 256; /** - * Constructor - * @link http://www.php.net/manual/en/spoofchecker.construct.php + * {@inheritdoc} */ public function __construct () {} /** - * Checks if a given text contains any suspicious characters - * @link http://www.php.net/manual/en/spoofchecker.issuspicious.php - * @param string $string String to test. - * @param int $errorCode [optional] This variable is set by-reference to int containing an error, if there - * was any. - * @return bool Returns true if there are suspicious characters, false otherwise. + * {@inheritdoc} + * @param string $string + * @param mixed $errorCode [optional] */ - public function isSuspicious (string $string, int &$errorCode = null): bool {} + public function isSuspicious (string $string, &$errorCode = NULL) {} /** - * Checks if given strings can be confused - * @link http://www.php.net/manual/en/spoofchecker.areconfusable.php - * @param string $string1 First string to check. - * @param string $string2 Second string to check. - * @param int $errorCode [optional] This variable is set by-reference to int containing an error, if there - * was any. - * @return bool Returns true if two given strings can be confused, false otherwise. + * {@inheritdoc} + * @param string $string1 + * @param string $string2 + * @param mixed $errorCode [optional] */ - public function areConfusable (string $string1, string $string2, int &$errorCode = null): bool {} + public function areConfusable (string $string1, string $string2, &$errorCode = NULL) {} /** - * Locales to use when running checks - * @link http://www.php.net/manual/en/spoofchecker.setallowedlocales.php - * @param string $locales - * @return void + * {@inheritdoc} + * @param string $locales */ - public function setAllowedLocales (string $locales): void {} + public function setAllowedLocales (string $locales) {} /** - * Set the checks to run - * @link http://www.php.net/manual/en/spoofchecker.setchecks.php - * @param int $checks The checks that will be performed by SpoofChecker::isSuspicious. - * A bitmask of - * Spoofchecker::SINGLE_SCRIPT_CONFUSABLE, - * Spoofchecker::MIXED_SCRIPT_CONFUSABLE, - * Spoofchecker::WHOLE_SCRIPT_CONFUSABLE, - * Spoofchecker::ANY_CASE, - * Spoofchecker::SINGLE_SCRIPT, - * Spoofchecker::INVISIBLE, or - * Spoofchecker::CHAR_LIMIT. - * Defaults to all checks as of ICU 58; prior to that version, - * Spoofchecker::SINGLE_SCRIPT was excluded. - * @return void No value is returned. + * {@inheritdoc} + * @param int $checks */ - public function setChecks (int $checks): void {} + public function setChecks (int $checks) {} /** * {@inheritdoc} @@ -3212,22 +1760,15 @@ public function setRestrictionLevel (int $level) {} } -/** - * This class is used for generating exceptions when errors occur inside intl - * functions. Such exceptions are only generated when intl.use_exceptions is enabled. - * @link http://www.php.net/manual/en/class.intlexception.php - */ class IntlException extends Exception implements Throwable, Stringable { /** - * Construct the exception - * @link http://www.php.net/manual/en/exception.construct.php - * @param string $message [optional] - * @param int $code [optional] - * @param Throwable|null $previous [optional] - * @return string + * {@inheritdoc} + * @param string $message [optional] + * @param int $code [optional] + * @param Throwable|null $previous [optional] */ - public function __construct (string $message = '""', int $code = null, ?Throwable $previous = null): string {} + public function __construct (string $message = '', int $code = 0, ?Throwable $previous = NULL) {} /** * {@inheritdoc} @@ -3235,140 +1776,76 @@ public function __construct (string $message = '""', int $code = null, ?Throwabl public function __wakeup () {} /** - * Gets the Exception message - * @link http://www.php.net/manual/en/exception.getmessage.php - * @return string Returns the Exception message as a string. + * {@inheritdoc} */ final public function getMessage (): string {} /** - * Gets the Exception code - * @link http://www.php.net/manual/en/exception.getcode.php - * @return int Returns the exception code as int in - * Exception but possibly as other type in - * Exception descendants (for example as - * string in PDOException). + * {@inheritdoc} */ - final public function getCode (): int {} + final public function getCode () {} /** - * Gets the file in which the exception was created - * @link http://www.php.net/manual/en/exception.getfile.php - * @return string Returns the filename in which the exception was created. + * {@inheritdoc} */ final public function getFile (): string {} /** - * Gets the line in which the exception was created - * @link http://www.php.net/manual/en/exception.getline.php - * @return int Returns the line number where the exception was created. + * {@inheritdoc} */ final public function getLine (): int {} /** - * Gets the stack trace - * @link http://www.php.net/manual/en/exception.gettrace.php - * @return array Returns the Exception stack trace as an array. + * {@inheritdoc} */ final public function getTrace (): array {} /** - * Returns previous Throwable - * @link http://www.php.net/manual/en/exception.getprevious.php - * @return Throwable|null Returns the previous Throwable if available - * or null otherwise. + * {@inheritdoc} */ final public function getPrevious (): ?Throwable {} /** - * Gets the stack trace as a string - * @link http://www.php.net/manual/en/exception.gettraceasstring.php - * @return string Returns the Exception stack trace as a string. + * {@inheritdoc} */ final public function getTraceAsString (): string {} /** - * String representation of the exception - * @link http://www.php.net/manual/en/exception.tostring.php - * @return string Returns the string representation of the exception. + * {@inheritdoc} */ public function __toString (): string {} } -/** - * This class represents iterator objects throughout the intl extension - * whenever the iterator cannot be identified with any other object provided - * by the extension. The distinct iterator object used internally by the - * foreach - * construct can only be obtained (in the relevant part here) from - * objects, so objects of this class serve the purpose of providing the hook - * through which this internal object can be obtained. As a convenience, this - * class also implements the Iterator interface, - * allowing the collection of values to be navigated using the methods - * defined in that interface. Both these methods and the internal iterator - * objects provided to foreach are backed by the same - * state (e.g. the position of the iterator and its current value). - *Subclasses may provide richer functionality.
- * @link http://www.php.net/manual/en/class.intliterator.php - */ class IntlIterator implements Iterator, Traversable { /** - * Get the current element - * @link http://www.php.net/manual/en/intliterator.current.php - * @return mixed + * {@inheritdoc} */ - public function current (): mixed {} + public function current () {} /** - * Get the current key - * @link http://www.php.net/manual/en/intliterator.key.php - * @return mixed + * {@inheritdoc} */ - public function key (): mixed {} + public function key () {} /** - * Move forward to the next element - * @link http://www.php.net/manual/en/intliterator.next.php - * @return void + * {@inheritdoc} */ - public function next (): void {} + public function next () {} /** - * Rewind the iterator to the first element - * @link http://www.php.net/manual/en/intliterator.rewind.php - * @return void + * {@inheritdoc} */ - public function rewind (): void {} + public function rewind () {} /** - * Check if current position is valid - * @link http://www.php.net/manual/en/intliterator.valid.php - * @return bool + * {@inheritdoc} */ - public function valid (): bool {} + public function valid () {} } -/** - * A “break iterator” is an ICU object that exposes methods for locating - * boundaries in text (e.g. word or sentence boundaries). - * The PHP IntlBreakIterator serves as the base class - * for all types of ICU break iterators. Where extra functionality is - * available, the intl extension may expose the ICU break iterator with - * suitable subclasses, such as - * IntlRuleBasedBreakIterator or - * IntlCodePointBreakIterator. - *This class implements IteratorAggregate. Traversing an - * IntlBreakIterator yields non-negative integer - * values representing the successive locations of the text boundaries, - * expressed as UTF-8 code units (byte) counts, taken from the beginning of - * the text (which has the location 0). The keys yielded - * by the iterator simply form the sequence of natural numbers - * {0, 1, 2, …}.
- * @link http://www.php.net/manual/en/class.intlbreakiterator.php - */ class IntlBreakIterator implements IteratorAggregate, Traversable { const DONE = -1; const WORD_NONE = 0; @@ -3392,170 +1869,121 @@ class IntlBreakIterator implements IteratorAggregate, Traversable { /** - * Create break iterator for boundaries of combining character sequences - * @link http://www.php.net/manual/en/intlbreakiterator.createcharacterinstance.php - * @param string|null $locale [optional] - * @return IntlBreakIterator|null + * {@inheritdoc} + * @param string|null $locale [optional] */ - public static function createCharacterInstance (?string $locale = null): ?IntlBreakIterator {} + public static function createCharacterInstance (?string $locale = NULL) {} /** - * Create break iterator for boundaries of code points - * @link http://www.php.net/manual/en/intlbreakiterator.createcodepointinstance.php - * @return IntlCodePointBreakIterator + * {@inheritdoc} */ - public static function createCodePointInstance (): IntlCodePointBreakIterator {} + public static function createCodePointInstance () {} /** - * Create break iterator for logically possible line breaks - * @link http://www.php.net/manual/en/intlbreakiterator.createlineinstance.php - * @param string|null $locale [optional] - * @return IntlBreakIterator|null + * {@inheritdoc} + * @param string|null $locale [optional] */ - public static function createLineInstance (?string $locale = null): ?IntlBreakIterator {} + public static function createLineInstance (?string $locale = NULL) {} /** - * Create break iterator for sentence breaks - * @link http://www.php.net/manual/en/intlbreakiterator.createsentenceinstance.php - * @param string|null $locale [optional] - * @return IntlBreakIterator|null + * {@inheritdoc} + * @param string|null $locale [optional] */ - public static function createSentenceInstance (?string $locale = null): ?IntlBreakIterator {} + public static function createSentenceInstance (?string $locale = NULL) {} /** - * Create break iterator for title-casing breaks - * @link http://www.php.net/manual/en/intlbreakiterator.createtitleinstance.php - * @param string|null $locale [optional] - * @return IntlBreakIterator|null + * {@inheritdoc} + * @param string|null $locale [optional] */ - public static function createTitleInstance (?string $locale = null): ?IntlBreakIterator {} + public static function createTitleInstance (?string $locale = NULL) {} /** - * Create break iterator for word breaks - * @link http://www.php.net/manual/en/intlbreakiterator.createwordinstance.php - * @param string|null $locale [optional] - * @return IntlBreakIterator|null + * {@inheritdoc} + * @param string|null $locale [optional] */ - public static function createWordInstance (?string $locale = null): ?IntlBreakIterator {} + public static function createWordInstance (?string $locale = NULL) {} /** - * Private constructor for disallowing instantiation - * @link http://www.php.net/manual/en/intlbreakiterator.construct.php + * {@inheritdoc} */ private function __construct () {} /** - * Get index of current position - * @link http://www.php.net/manual/en/intlbreakiterator.current.php - * @return int + * {@inheritdoc} */ - public function current (): int {} + public function current () {} /** - * Set position to the first character in the text - * @link http://www.php.net/manual/en/intlbreakiterator.first.php - * @return int + * {@inheritdoc} */ - public function first (): int {} + public function first () {} /** - * Advance the iterator to the first boundary following specified offset - * @link http://www.php.net/manual/en/intlbreakiterator.following.php - * @param int $offset - * @return int + * {@inheritdoc} + * @param int $offset */ - public function following (int $offset): int {} + public function following (int $offset) {} /** - * Get last error code on the object - * @link http://www.php.net/manual/en/intlbreakiterator.geterrorcode.php - * @return int + * {@inheritdoc} */ - public function getErrorCode (): int {} + public function getErrorCode () {} /** - * Get last error message on the object - * @link http://www.php.net/manual/en/intlbreakiterator.geterrormessage.php - * @return string + * {@inheritdoc} */ - public function getErrorMessage (): string {} + public function getErrorMessage () {} /** - * Get the locale associated with the object - * @link http://www.php.net/manual/en/intlbreakiterator.getlocale.php - * @param int $type - * @return string|false + * {@inheritdoc} + * @param int $type */ - public function getLocale (int $type): string|false {} + public function getLocale (int $type) {} /** - * Create iterator for navigating fragments between boundaries - * @link http://www.php.net/manual/en/intlbreakiterator.getpartsiterator.php - * @param string $type [optional] Optional key type. Possible values are: - *- * IntlPartsIterator::KEY_SEQUENTIAL - * - The default. Sequentially increasing integers used as key. - * IntlPartsIterator::KEY_LEFT - * - Byte offset left of current part used as key. - * IntlPartsIterator::KEY_RIGHT - * - Byte offset right of current part used as key. - *
- * @return IntlPartsIterator + * {@inheritdoc} + * @param string $type [optional] */ - public function getPartsIterator (string $type = \IntlPartsIterator::KEY_SEQUENTIAL): IntlPartsIterator {} + public function getPartsIterator (string $type = 0) {} /** - * Get the text being scanned - * @link http://www.php.net/manual/en/intlbreakiterator.gettext.php - * @return string|null + * {@inheritdoc} */ - public function getText (): ?string {} + public function getText () {} /** - * Tell whether an offset is a boundaryʼs offset - * @link http://www.php.net/manual/en/intlbreakiterator.isboundary.php - * @param int $offset - * @return bool + * {@inheritdoc} + * @param int $offset */ - public function isBoundary (int $offset): bool {} + public function isBoundary (int $offset) {} /** - * Set the iterator position to index beyond the last character - * @link http://www.php.net/manual/en/intlbreakiterator.last.php - * @return int + * {@inheritdoc} */ - public function last (): int {} + public function last () {} /** - * Advance the iterator the next boundary - * @link http://www.php.net/manual/en/intlbreakiterator.next.php - * @param int|null $offset [optional] - * @return int + * {@inheritdoc} + * @param int|null $offset [optional] */ - public function next (?int $offset = null): int {} + public function next (?int $offset = NULL) {} /** - * Set the iterator position to the first boundary before an offset - * @link http://www.php.net/manual/en/intlbreakiterator.preceding.php - * @param int $offset - * @return int + * {@inheritdoc} + * @param int $offset */ - public function preceding (int $offset): int {} + public function preceding (int $offset) {} /** - * Set the iterator position to the boundary immediately before the current - * @link http://www.php.net/manual/en/intlbreakiterator.previous.php - * @return int + * {@inheritdoc} */ - public function previous (): int {} + public function previous () {} /** - * Set the text being scanned - * @link http://www.php.net/manual/en/intlbreakiterator.settext.php - * @param string $text - * @return bool|null + * {@inheritdoc} + * @param string $text */ - public function setText (string $text): ?bool {} + public function setText (string $text) {} /** * {@inheritdoc} @@ -3564,14 +1992,6 @@ public function getIterator (): Iterator {} } -/** - * A subclass of IntlBreakIterator that encapsulates - * ICU break iterators whose behavior is specified using a set of rules. This - * is the most common kind of break iterators. - *These rules are described in the ICU Boundary Analysis - * User Guide.
- * @link http://www.php.net/manual/en/class.intlrulebasedbreakiterator.php - */ class IntlRuleBasedBreakIterator extends IntlBreakIterator implements Traversable, IteratorAggregate { const DONE = -1; const WORD_NONE = 0; @@ -3595,201 +2015,143 @@ class IntlRuleBasedBreakIterator extends IntlBreakIterator implements Traversabl /** - * Create iterator from ruleset - * @link http://www.php.net/manual/en/intlrulebasedbreakiterator.construct.php - * @param string $rules - * @param bool $compiled [optional] - * @return string + * {@inheritdoc} + * @param string $rules + * @param bool $compiled [optional] */ - public function __construct (string $rules, bool $compiled = false): string {} + public function __construct (string $rules, bool $compiled = false) {} /** - * Get the binary form of compiled rules - * @link http://www.php.net/manual/en/intlrulebasedbreakiterator.getbinaryrules.php - * @return string|false + * {@inheritdoc} */ - public function getBinaryRules (): string|false {} + public function getBinaryRules () {} /** - * Get the rule set used to create this object - * @link http://www.php.net/manual/en/intlrulebasedbreakiterator.getrules.php - * @return string|false + * {@inheritdoc} */ - public function getRules (): string|false {} + public function getRules () {} /** - * Get the largest status value from the break rules that determined the current break position - * @link http://www.php.net/manual/en/intlrulebasedbreakiterator.getrulestatus.php - * @return int + * {@inheritdoc} */ - public function getRuleStatus (): int {} + public function getRuleStatus () {} /** - * Get the status values from the break rules that determined the current break position - * @link http://www.php.net/manual/en/intlrulebasedbreakiterator.getrulestatusvec.php - * @return array|false + * {@inheritdoc} */ - public function getRuleStatusVec (): array|false {} + public function getRuleStatusVec () {} /** - * Create break iterator for boundaries of combining character sequences - * @link http://www.php.net/manual/en/intlbreakiterator.createcharacterinstance.php - * @param string|null $locale [optional] - * @return IntlBreakIterator|null + * {@inheritdoc} + * @param string|null $locale [optional] */ - public static function createCharacterInstance (?string $locale = null): ?IntlBreakIterator {} + public static function createCharacterInstance (?string $locale = NULL) {} /** - * Create break iterator for boundaries of code points - * @link http://www.php.net/manual/en/intlbreakiterator.createcodepointinstance.php - * @return IntlCodePointBreakIterator + * {@inheritdoc} */ - public static function createCodePointInstance (): IntlCodePointBreakIterator {} + public static function createCodePointInstance () {} /** - * Create break iterator for logically possible line breaks - * @link http://www.php.net/manual/en/intlbreakiterator.createlineinstance.php - * @param string|null $locale [optional] - * @return IntlBreakIterator|null + * {@inheritdoc} + * @param string|null $locale [optional] */ - public static function createLineInstance (?string $locale = null): ?IntlBreakIterator {} + public static function createLineInstance (?string $locale = NULL) {} /** - * Create break iterator for sentence breaks - * @link http://www.php.net/manual/en/intlbreakiterator.createsentenceinstance.php - * @param string|null $locale [optional] - * @return IntlBreakIterator|null + * {@inheritdoc} + * @param string|null $locale [optional] */ - public static function createSentenceInstance (?string $locale = null): ?IntlBreakIterator {} + public static function createSentenceInstance (?string $locale = NULL) {} /** - * Create break iterator for title-casing breaks - * @link http://www.php.net/manual/en/intlbreakiterator.createtitleinstance.php - * @param string|null $locale [optional] - * @return IntlBreakIterator|null + * {@inheritdoc} + * @param string|null $locale [optional] */ - public static function createTitleInstance (?string $locale = null): ?IntlBreakIterator {} + public static function createTitleInstance (?string $locale = NULL) {} /** - * Create break iterator for word breaks - * @link http://www.php.net/manual/en/intlbreakiterator.createwordinstance.php - * @param string|null $locale [optional] - * @return IntlBreakIterator|null + * {@inheritdoc} + * @param string|null $locale [optional] */ - public static function createWordInstance (?string $locale = null): ?IntlBreakIterator {} + public static function createWordInstance (?string $locale = NULL) {} /** - * Get index of current position - * @link http://www.php.net/manual/en/intlbreakiterator.current.php - * @return int + * {@inheritdoc} */ - public function current (): int {} + public function current () {} /** - * Set position to the first character in the text - * @link http://www.php.net/manual/en/intlbreakiterator.first.php - * @return int + * {@inheritdoc} */ - public function first (): int {} + public function first () {} /** - * Advance the iterator to the first boundary following specified offset - * @link http://www.php.net/manual/en/intlbreakiterator.following.php - * @param int $offset - * @return int + * {@inheritdoc} + * @param int $offset */ - public function following (int $offset): int {} + public function following (int $offset) {} /** - * Get last error code on the object - * @link http://www.php.net/manual/en/intlbreakiterator.geterrorcode.php - * @return int + * {@inheritdoc} */ - public function getErrorCode (): int {} + public function getErrorCode () {} /** - * Get last error message on the object - * @link http://www.php.net/manual/en/intlbreakiterator.geterrormessage.php - * @return string + * {@inheritdoc} */ - public function getErrorMessage (): string {} + public function getErrorMessage () {} /** - * Get the locale associated with the object - * @link http://www.php.net/manual/en/intlbreakiterator.getlocale.php - * @param int $type - * @return string|false + * {@inheritdoc} + * @param int $type */ - public function getLocale (int $type): string|false {} + public function getLocale (int $type) {} /** - * Create iterator for navigating fragments between boundaries - * @link http://www.php.net/manual/en/intlbreakiterator.getpartsiterator.php - * @param string $type [optional] Optional key type. Possible values are: - *- * IntlPartsIterator::KEY_SEQUENTIAL - * - The default. Sequentially increasing integers used as key. - * IntlPartsIterator::KEY_LEFT - * - Byte offset left of current part used as key. - * IntlPartsIterator::KEY_RIGHT - * - Byte offset right of current part used as key. - *
- * @return IntlPartsIterator + * {@inheritdoc} + * @param string $type [optional] */ - public function getPartsIterator (string $type = \IntlPartsIterator::KEY_SEQUENTIAL): IntlPartsIterator {} + public function getPartsIterator (string $type = 0) {} /** - * Get the text being scanned - * @link http://www.php.net/manual/en/intlbreakiterator.gettext.php - * @return string|null + * {@inheritdoc} */ - public function getText (): ?string {} + public function getText () {} /** - * Tell whether an offset is a boundaryʼs offset - * @link http://www.php.net/manual/en/intlbreakiterator.isboundary.php - * @param int $offset - * @return bool + * {@inheritdoc} + * @param int $offset */ - public function isBoundary (int $offset): bool {} + public function isBoundary (int $offset) {} /** - * Set the iterator position to index beyond the last character - * @link http://www.php.net/manual/en/intlbreakiterator.last.php - * @return int + * {@inheritdoc} */ - public function last (): int {} + public function last () {} /** - * Advance the iterator the next boundary - * @link http://www.php.net/manual/en/intlbreakiterator.next.php - * @param int|null $offset [optional] - * @return int + * {@inheritdoc} + * @param int|null $offset [optional] */ - public function next (?int $offset = null): int {} + public function next (?int $offset = NULL) {} /** - * Set the iterator position to the first boundary before an offset - * @link http://www.php.net/manual/en/intlbreakiterator.preceding.php - * @param int $offset - * @return int + * {@inheritdoc} + * @param int $offset */ - public function preceding (int $offset): int {} + public function preceding (int $offset) {} /** - * Set the iterator position to the boundary immediately before the current - * @link http://www.php.net/manual/en/intlbreakiterator.previous.php - * @return int + * {@inheritdoc} */ - public function previous (): int {} + public function previous () {} /** - * Set the text being scanned - * @link http://www.php.net/manual/en/intlbreakiterator.settext.php - * @param string $text - * @return bool|null + * {@inheritdoc} + * @param string $text */ - public function setText (string $text): ?bool {} + public function setText (string $text) {} /** * {@inheritdoc} @@ -3798,11 +2160,6 @@ public function getIterator (): Iterator {} } -/** - * This break iterator - * identifies the boundaries between UTF-8 code points. - * @link http://www.php.net/manual/en/class.intlcodepointbreakiterator.php - */ class IntlCodePointBreakIterator extends IntlBreakIterator implements Traversable, IteratorAggregate { const DONE = -1; const WORD_NONE = 0; @@ -3826,171 +2183,121 @@ class IntlCodePointBreakIterator extends IntlBreakIterator implements Traversabl /** - * Get last code point passed over after advancing or receding the iterator - * @link http://www.php.net/manual/en/intlcodepointbreakiterator.getlastcodepoint.php - * @return int + * {@inheritdoc} */ - public function getLastCodePoint (): int {} + public function getLastCodePoint () {} /** - * Create break iterator for boundaries of combining character sequences - * @link http://www.php.net/manual/en/intlbreakiterator.createcharacterinstance.php - * @param string|null $locale [optional] - * @return IntlBreakIterator|null + * {@inheritdoc} + * @param string|null $locale [optional] */ - public static function createCharacterInstance (?string $locale = null): ?IntlBreakIterator {} + public static function createCharacterInstance (?string $locale = NULL) {} /** - * Create break iterator for boundaries of code points - * @link http://www.php.net/manual/en/intlbreakiterator.createcodepointinstance.php - * @return IntlCodePointBreakIterator + * {@inheritdoc} */ - public static function createCodePointInstance (): IntlCodePointBreakIterator {} + public static function createCodePointInstance () {} /** - * Create break iterator for logically possible line breaks - * @link http://www.php.net/manual/en/intlbreakiterator.createlineinstance.php - * @param string|null $locale [optional] - * @return IntlBreakIterator|null + * {@inheritdoc} + * @param string|null $locale [optional] */ - public static function createLineInstance (?string $locale = null): ?IntlBreakIterator {} + public static function createLineInstance (?string $locale = NULL) {} /** - * Create break iterator for sentence breaks - * @link http://www.php.net/manual/en/intlbreakiterator.createsentenceinstance.php - * @param string|null $locale [optional] - * @return IntlBreakIterator|null + * {@inheritdoc} + * @param string|null $locale [optional] */ - public static function createSentenceInstance (?string $locale = null): ?IntlBreakIterator {} + public static function createSentenceInstance (?string $locale = NULL) {} /** - * Create break iterator for title-casing breaks - * @link http://www.php.net/manual/en/intlbreakiterator.createtitleinstance.php - * @param string|null $locale [optional] - * @return IntlBreakIterator|null + * {@inheritdoc} + * @param string|null $locale [optional] */ - public static function createTitleInstance (?string $locale = null): ?IntlBreakIterator {} + public static function createTitleInstance (?string $locale = NULL) {} /** - * Create break iterator for word breaks - * @link http://www.php.net/manual/en/intlbreakiterator.createwordinstance.php - * @param string|null $locale [optional] - * @return IntlBreakIterator|null + * {@inheritdoc} + * @param string|null $locale [optional] */ - public static function createWordInstance (?string $locale = null): ?IntlBreakIterator {} + public static function createWordInstance (?string $locale = NULL) {} /** - * Get index of current position - * @link http://www.php.net/manual/en/intlbreakiterator.current.php - * @return int + * {@inheritdoc} */ - public function current (): int {} + public function current () {} /** - * Set position to the first character in the text - * @link http://www.php.net/manual/en/intlbreakiterator.first.php - * @return int + * {@inheritdoc} */ - public function first (): int {} + public function first () {} /** - * Advance the iterator to the first boundary following specified offset - * @link http://www.php.net/manual/en/intlbreakiterator.following.php - * @param int $offset - * @return int + * {@inheritdoc} + * @param int $offset */ - public function following (int $offset): int {} + public function following (int $offset) {} /** - * Get last error code on the object - * @link http://www.php.net/manual/en/intlbreakiterator.geterrorcode.php - * @return int + * {@inheritdoc} */ - public function getErrorCode (): int {} + public function getErrorCode () {} /** - * Get last error message on the object - * @link http://www.php.net/manual/en/intlbreakiterator.geterrormessage.php - * @return string + * {@inheritdoc} */ - public function getErrorMessage (): string {} + public function getErrorMessage () {} /** - * Get the locale associated with the object - * @link http://www.php.net/manual/en/intlbreakiterator.getlocale.php - * @param int $type - * @return string|false + * {@inheritdoc} + * @param int $type */ - public function getLocale (int $type): string|false {} + public function getLocale (int $type) {} /** - * Create iterator for navigating fragments between boundaries - * @link http://www.php.net/manual/en/intlbreakiterator.getpartsiterator.php - * @param string $type [optional] Optional key type. Possible values are: - *- * IntlPartsIterator::KEY_SEQUENTIAL - * - The default. Sequentially increasing integers used as key. - * IntlPartsIterator::KEY_LEFT - * - Byte offset left of current part used as key. - * IntlPartsIterator::KEY_RIGHT - * - Byte offset right of current part used as key. - *
- * @return IntlPartsIterator + * {@inheritdoc} + * @param string $type [optional] */ - public function getPartsIterator (string $type = \IntlPartsIterator::KEY_SEQUENTIAL): IntlPartsIterator {} + public function getPartsIterator (string $type = 0) {} /** - * Get the text being scanned - * @link http://www.php.net/manual/en/intlbreakiterator.gettext.php - * @return string|null + * {@inheritdoc} */ - public function getText (): ?string {} + public function getText () {} /** - * Tell whether an offset is a boundaryʼs offset - * @link http://www.php.net/manual/en/intlbreakiterator.isboundary.php - * @param int $offset - * @return bool + * {@inheritdoc} + * @param int $offset */ - public function isBoundary (int $offset): bool {} + public function isBoundary (int $offset) {} /** - * Set the iterator position to index beyond the last character - * @link http://www.php.net/manual/en/intlbreakiterator.last.php - * @return int + * {@inheritdoc} */ - public function last (): int {} + public function last () {} /** - * Advance the iterator the next boundary - * @link http://www.php.net/manual/en/intlbreakiterator.next.php - * @param int|null $offset [optional] - * @return int + * {@inheritdoc} + * @param int|null $offset [optional] */ - public function next (?int $offset = null): int {} + public function next (?int $offset = NULL) {} /** - * Set the iterator position to the first boundary before an offset - * @link http://www.php.net/manual/en/intlbreakiterator.preceding.php - * @param int $offset - * @return int + * {@inheritdoc} + * @param int $offset */ - public function preceding (int $offset): int {} + public function preceding (int $offset) {} /** - * Set the iterator position to the boundary immediately before the current - * @link http://www.php.net/manual/en/intlbreakiterator.previous.php - * @return int + * {@inheritdoc} */ - public function previous (): int {} + public function previous () {} /** - * Set the text being scanned - * @link http://www.php.net/manual/en/intlbreakiterator.settext.php - * @param string $text - * @return bool|null + * {@inheritdoc} + * @param string $text */ - public function setText (string $text): ?bool {} + public function setText (string $text) {} /** * {@inheritdoc} @@ -3999,18 +2306,6 @@ public function getIterator (): Iterator {} } -/** - * Objects of this class can be obtained from - * IntlBreakIterator objects. While the break - * iterators provide a sequence of boundary positions when iterated, - * IntlPartsIterator objects provide, as a - * convenience, the text fragments comprehended between two successive - * boundaries. - *The keys may represent the offset of the left boundary, right boundary, or - * they may just the sequence of non-negative integers. See - * IntlBreakIterator::getPartsIterator.
- * @link http://www.php.net/manual/en/class.intlpartsiterator.php - */ class IntlPartsIterator extends IntlIterator implements Traversable, Iterator { const KEY_SEQUENTIAL = 0; const KEY_LEFT = 1; @@ -4018,11 +2313,9 @@ class IntlPartsIterator extends IntlIterator implements Traversable, Iterator { /** - * Get IntlBreakIterator backing this parts iterator - * @link http://www.php.net/manual/en/intlpartsiterator.getbreakiterator.php - * @return IntlBreakIterator + * {@inheritdoc} */ - public function getBreakIterator (): IntlBreakIterator {} + public function getBreakIterator () {} /** * {@inheritdoc} @@ -4030,45 +2323,32 @@ public function getBreakIterator (): IntlBreakIterator {} public function getRuleStatus () {} /** - * Get the current element - * @link http://www.php.net/manual/en/intliterator.current.php - * @return mixed + * {@inheritdoc} */ - public function current (): mixed {} + public function current () {} /** - * Get the current key - * @link http://www.php.net/manual/en/intliterator.key.php - * @return mixed + * {@inheritdoc} */ - public function key (): mixed {} + public function key () {} /** - * Move forward to the next element - * @link http://www.php.net/manual/en/intliterator.next.php - * @return void + * {@inheritdoc} */ - public function next (): void {} + public function next () {} /** - * Rewind the iterator to the first element - * @link http://www.php.net/manual/en/intliterator.rewind.php - * @return void + * {@inheritdoc} */ - public function rewind (): void {} + public function rewind () {} /** - * Check if current position is valid - * @link http://www.php.net/manual/en/intliterator.valid.php - * @return bool + * {@inheritdoc} */ - public function valid (): bool {} + public function valid () {} } -/** - * @link http://www.php.net/manual/en/class.uconverter.php - */ class UConverter { const REASON_UNASSIGNED = 0; const REASON_ILLEGAL = 1; @@ -4114,181 +2394,127 @@ class UConverter { /** - * Create UConverter object - * @link http://www.php.net/manual/en/uconverter.construct.php - * @param string|null $destination_encoding [optional] - * @param string|null $source_encoding [optional] - * @return string|null + * {@inheritdoc} + * @param string|null $destination_encoding [optional] + * @param string|null $source_encoding [optional] */ - public function __construct (?string $destination_encoding = null, ?string $source_encoding = null): ?string {} + public function __construct (?string $destination_encoding = NULL, ?string $source_encoding = NULL) {} /** - * Convert string from one charset to another - * @link http://www.php.net/manual/en/uconverter.convert.php - * @param string $str - * @param bool $reverse [optional] - * @return string|false + * {@inheritdoc} + * @param string $str + * @param bool $reverse [optional] */ - public function convert (string $str, bool $reverse = false): string|false {} + public function convert (string $str, bool $reverse = false) {} /** - * Default "from" callback function - * @link http://www.php.net/manual/en/uconverter.fromucallback.php - * @param int $reason - * @param array $source - * @param int $codePoint - * @param int $error - * @return string|int|array|null + * {@inheritdoc} + * @param int $reason + * @param array $source + * @param int $codePoint + * @param mixed $error */ - public function fromUCallback (int $reason, array $source, int $codePoint, int &$error): string|int|array|null {} + public function fromUCallback (int $reason, array $source, int $codePoint, &$error = null) {} /** - * Get the aliases of the given name - * @link http://www.php.net/manual/en/uconverter.getaliases.php - * @param string $name - * @return array|false|null + * {@inheritdoc} + * @param string $name */ - public static function getAliases (string $name): array|false|null {} + public static function getAliases (string $name) {} /** - * Get the available canonical converter names - * @link http://www.php.net/manual/en/uconverter.getavailable.php - * @return array + * {@inheritdoc} */ - public static function getAvailable (): array {} + public static function getAvailable () {} /** - * Get the destination encoding - * @link http://www.php.net/manual/en/uconverter.getdestinationencoding.php - * @return string|false|null + * {@inheritdoc} */ - public function getDestinationEncoding (): string|false|null {} + public function getDestinationEncoding () {} /** - * Get the destination converter type - * @link http://www.php.net/manual/en/uconverter.getdestinationtype.php - * @return int|false|null + * {@inheritdoc} */ - public function getDestinationType (): int|false|null {} + public function getDestinationType () {} /** - * Get last error code on the object - * @link http://www.php.net/manual/en/uconverter.geterrorcode.php - * @return int + * {@inheritdoc} */ - public function getErrorCode (): int {} + public function getErrorCode () {} /** - * Get last error message on the object - * @link http://www.php.net/manual/en/uconverter.geterrormessage.php - * @return string|null + * {@inheritdoc} */ - public function getErrorMessage (): ?string {} + public function getErrorMessage () {} /** - * Get the source encoding - * @link http://www.php.net/manual/en/uconverter.getsourceencoding.php - * @return string|false|null + * {@inheritdoc} */ - public function getSourceEncoding (): string|false|null {} + public function getSourceEncoding () {} /** - * Get the source converter type - * @link http://www.php.net/manual/en/uconverter.getsourcetype.php - * @return int|false|null + * {@inheritdoc} */ - public function getSourceType (): int|false|null {} + public function getSourceType () {} /** - * Get standards associated to converter names - * @link http://www.php.net/manual/en/uconverter.getstandards.php - * @return array|null + * {@inheritdoc} */ - public static function getStandards (): ?array {} + public static function getStandards () {} /** - * Get substitution chars - * @link http://www.php.net/manual/en/uconverter.getsubstchars.php - * @return string|false|null + * {@inheritdoc} */ - public function getSubstChars (): string|false|null {} + public function getSubstChars () {} /** - * Get string representation of the callback reason - * @link http://www.php.net/manual/en/uconverter.reasontext.php - * @param int $reason - * @return string + * {@inheritdoc} + * @param int $reason */ - public static function reasonText (int $reason): string {} + public static function reasonText (int $reason) {} /** - * Set the destination encoding - * @link http://www.php.net/manual/en/uconverter.setdestinationencoding.php - * @param string $encoding - * @return bool + * {@inheritdoc} + * @param string $encoding */ - public function setDestinationEncoding (string $encoding): bool {} + public function setDestinationEncoding (string $encoding) {} /** - * Set the source encoding - * @link http://www.php.net/manual/en/uconverter.setsourceencoding.php - * @param string $encoding - * @return bool + * {@inheritdoc} + * @param string $encoding */ - public function setSourceEncoding (string $encoding): bool {} + public function setSourceEncoding (string $encoding) {} /** - * Set the substitution chars - * @link http://www.php.net/manual/en/uconverter.setsubstchars.php - * @param string $chars - * @return bool + * {@inheritdoc} + * @param string $chars */ - public function setSubstChars (string $chars): bool {} + public function setSubstChars (string $chars) {} /** - * Default "to" callback function - * @link http://www.php.net/manual/en/uconverter.toucallback.php - * @param int $reason - * @param string $source - * @param string $codeUnits - * @param int $error - * @return string|int|array|null + * {@inheritdoc} + * @param int $reason + * @param string $source + * @param string $codeUnits + * @param mixed $error */ - public function toUCallback (int $reason, string $source, string $codeUnits, int &$error): string|int|array|null {} + public function toUCallback (int $reason, string $source, string $codeUnits, &$error = null) {} /** - * Convert a string from one character encoding to another - * @link http://www.php.net/manual/en/uconverter.transcode.php - * @param string $str The string to be converted. - * @param string $toEncoding The desired encoding of the result. - * @param string $fromEncoding The current encoding used to interpret str. - * @param array|null $options [optional] An optional array, which may contain the following keys: - *- * 'to_subst' - the substitution character to use - * in place of any character of str which cannot - * be encoded in toEncoding. If specified, it must - * represent a single character in the target encoding. - *
- * @return string|false Returns the converted string or false on failure. + * {@inheritdoc} + * @param string $str + * @param string $toEncoding + * @param string $fromEncoding + * @param array|null $options [optional] */ - public static function transcode (string $str, string $toEncoding, string $fromEncoding, ?array $options = null): string|false {} + public static function transcode (string $str, string $toEncoding, string $fromEncoding, ?array $options = NULL) {} } -/** - * IntlChar provides access to a number of utility - * methods that can be used to access information about Unicode characters. - *The methods and constants adhere closely to the names and behavior used by the underlying ICU library.
- * @link http://www.php.net/manual/en/class.intlchar.php - */ class IntlChar { const UNICODE_VERSION = 15.0; const CODEPOINT_MIN = 0; const CODEPOINT_MAX = 1114111; - /** - * Special value that is returned by - * IntlChar::getNumericValue when no numeric value - * is defined for a code point. const NO_NUMERIC_VALUE = -123456789; const PROPERTY_ALPHABETIC = 0; const PROPERTY_BINARY_START = 0; @@ -4952,667 +3178,371 @@ class IntlChar { /** - * Check a binary Unicode property for a code point - * @link http://www.php.net/manual/en/intlchar.hasbinaryproperty.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @param int $property >The Unicode property to lookup (see the IntlChar::PROPERTY_* constants). - * @return bool|null Returns true or false according to the binary Unicode property value for codepoint. - * Also false if property is out of bounds or if the Unicode version does not have data for - * the property at all, or not for this code point. Returns null on failure. - */ - public static function hasBinaryProperty (int|string $codepoint, int $property): ?bool {} - - /** - * Get the "age" of the code point - * @link http://www.php.net/manual/en/intlchar.charage.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @return array|null The Unicode version number, as an array. - * For example, version 1.3.31.2 would be represented as [1, 3, 31, 2]. - * Returns null on failure. - */ - public static function charAge (int|string $codepoint): ?array {} - - /** - * Get the decimal digit value of a decimal digit character - * @link http://www.php.net/manual/en/intlchar.chardigitvalue.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @return int|null The decimal digit value of codepoint, - * or -1 if it is not a decimal digit character. Returns null on failure. - */ - public static function charDigitValue (int|string $codepoint): ?int {} - - /** - * Get bidirectional category value for a code point - * @link http://www.php.net/manual/en/intlchar.chardirection.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @return int|null The bidirectional category value; one of the following constants: - *- * IntlChar::CHAR_DIRECTION_LEFT_TO_RIGHT - * IntlChar::CHAR_DIRECTION_RIGHT_TO_LEFT - * IntlChar::CHAR_DIRECTION_EUROPEAN_NUMBER - * IntlChar::CHAR_DIRECTION_EUROPEAN_NUMBER_SEPARATOR - * IntlChar::CHAR_DIRECTION_EUROPEAN_NUMBER_TERMINATOR - * IntlChar::CHAR_DIRECTION_ARABIC_NUMBER - * IntlChar::CHAR_DIRECTION_COMMON_NUMBER_SEPARATOR - * IntlChar::CHAR_DIRECTION_BLOCK_SEPARATOR - * IntlChar::CHAR_DIRECTION_SEGMENT_SEPARATOR - * IntlChar::CHAR_DIRECTION_WHITE_SPACE_NEUTRAL - * IntlChar::CHAR_DIRECTION_OTHER_NEUTRAL - * IntlChar::CHAR_DIRECTION_LEFT_TO_RIGHT_EMBEDDING - * IntlChar::CHAR_DIRECTION_LEFT_TO_RIGHT_OVERRIDE - * IntlChar::CHAR_DIRECTION_RIGHT_TO_LEFT_ARABIC - * IntlChar::CHAR_DIRECTION_RIGHT_TO_LEFT_EMBEDDING - * IntlChar::CHAR_DIRECTION_RIGHT_TO_LEFT_OVERRIDE - * IntlChar::CHAR_DIRECTION_POP_DIRECTIONAL_FORMAT - * IntlChar::CHAR_DIRECTION_DIR_NON_SPACING_MARK - * IntlChar::CHAR_DIRECTION_BOUNDARY_NEUTRAL - * IntlChar::CHAR_DIRECTION_FIRST_STRONG_ISOLATE - * IntlChar::CHAR_DIRECTION_LEFT_TO_RIGHT_ISOLATE - * IntlChar::CHAR_DIRECTION_RIGHT_TO_LEFT_ISOLATE - * IntlChar::CHAR_DIRECTION_POP_DIRECTIONAL_ISOLATE - * IntlChar::CHAR_DIRECTION_CHAR_DIRECTION_COUNT - *
- * Returns null on failure. - */ - public static function charDirection (int|string $codepoint): ?int {} - - /** - * Find Unicode character by name and return its code point value - * @link http://www.php.net/manual/en/intlchar.charfromname.php - * @param string $name Full name of the Unicode character. - * @param int $type [optional] Which set of names to use for the lookup. Can be any of these constants: - *- * IntlChar::UNICODE_CHAR_NAME (default) - * IntlChar::UNICODE_10_CHAR_NAME - * IntlChar::EXTENDED_CHAR_NAME - * IntlChar::CHAR_NAME_ALIAS - * IntlChar::CHAR_NAME_CHOICE_COUNT - *
- * @return int|null The Unicode value of the code point with the given name (as an int), or null if there is no such code point. - */ - public static function charFromName (string $name, int $type = \IntlChar::UNICODE_CHAR_NAME): ?int {} - - /** - * Get the "mirror-image" character for a code point - * @link http://www.php.net/manual/en/intlchar.charmirror.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @return int|string|null Returns another Unicode code point that may serve as a mirror-image substitute, or codepoint - * itself if there is no such mapping or codepoint does not have the - * Bidi_Mirrored property. - *>The return type is int unless the code point was passed as a UTF-8 string, in which case a string is returned. Returns null on failure.
- */ - public static function charMirror (int|string $codepoint): int|string|null {} - - /** - * Retrieve the name of a Unicode character - * @link http://www.php.net/manual/en/intlchar.charname.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @param int $type [optional] Which set of names to use for the lookup. Can be any of these constants: - *- * IntlChar::UNICODE_CHAR_NAME (default) - * IntlChar::UNICODE_10_CHAR_NAME - * IntlChar::EXTENDED_CHAR_NAME - * IntlChar::CHAR_NAME_ALIAS - * IntlChar::CHAR_NAME_CHOICE_COUNT - *
- * @return string|null The corresponding name, or an empty string if there is no name for this character, - * or null if there is no such code point. - */ - public static function charName (int|string $codepoint, int $type = \IntlChar::UNICODE_CHAR_NAME): ?string {} - - /** - * Get the general category value for a code point - * @link http://www.php.net/manual/en/intlchar.chartype.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @return int|null Returns the general category type, which may be one of the following constants: - *- * IntlChar::CHAR_CATEGORY_UNASSIGNED - * IntlChar::CHAR_CATEGORY_GENERAL_OTHER_TYPES - * IntlChar::CHAR_CATEGORY_UPPERCASE_LETTER - * IntlChar::CHAR_CATEGORY_LOWERCASE_LETTER - * IntlChar::CHAR_CATEGORY_TITLECASE_LETTER - * IntlChar::CHAR_CATEGORY_MODIFIER_LETTER - * IntlChar::CHAR_CATEGORY_OTHER_LETTER - * IntlChar::CHAR_CATEGORY_NON_SPACING_MARK - * IntlChar::CHAR_CATEGORY_ENCLOSING_MARK - * IntlChar::CHAR_CATEGORY_COMBINING_SPACING_MARK - * IntlChar::CHAR_CATEGORY_DECIMAL_DIGIT_NUMBER - * IntlChar::CHAR_CATEGORY_LETTER_NUMBER - * IntlChar::CHAR_CATEGORY_OTHER_NUMBER - * IntlChar::CHAR_CATEGORY_SPACE_SEPARATOR - * IntlChar::CHAR_CATEGORY_LINE_SEPARATOR - * IntlChar::CHAR_CATEGORY_PARAGRAPH_SEPARATOR - * IntlChar::CHAR_CATEGORY_CONTROL_CHAR - * IntlChar::CHAR_CATEGORY_FORMAT_CHAR - * IntlChar::CHAR_CATEGORY_PRIVATE_USE_CHAR - * IntlChar::CHAR_CATEGORY_SURROGATE - * IntlChar::CHAR_CATEGORY_DASH_PUNCTUATION - * IntlChar::CHAR_CATEGORY_START_PUNCTUATION - * IntlChar::CHAR_CATEGORY_END_PUNCTUATION - * IntlChar::CHAR_CATEGORY_CONNECTOR_PUNCTUATION - * IntlChar::CHAR_CATEGORY_OTHER_PUNCTUATION - * IntlChar::CHAR_CATEGORY_MATH_SYMBOL - * IntlChar::CHAR_CATEGORY_CURRENCY_SYMBOL - * IntlChar::CHAR_CATEGORY_MODIFIER_SYMBOL - * IntlChar::CHAR_CATEGORY_OTHER_SYMBOL - * IntlChar::CHAR_CATEGORY_INITIAL_PUNCTUATION - * IntlChar::CHAR_CATEGORY_FINAL_PUNCTUATION - * IntlChar::CHAR_CATEGORY_CHAR_CATEGORY_COUNT - *
- */ - public static function charType (int|string $codepoint): ?int {} - - /** - * Return Unicode character by code point value - * @link http://www.php.net/manual/en/intlchar.chr.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @return string|null A string containing the single character specified by the Unicode code point value, or null on failure. - */ - public static function chr (int|string $codepoint): ?string {} - - /** - * Get the decimal digit value of a code point for a given radix - * @link http://www.php.net/manual/en/intlchar.digit.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @param int $base [optional] The radix (defaults to 10). - * @return int|false|null Returns the numeric value represented by the character in the specified radix, - * or false if there is no value or if the value exceeds the radix. Returns null on failure. - */ - public static function digit (int|string $codepoint, int $base = 10): int|false|null {} - - /** - * Enumerate all assigned Unicode characters within a range - * @link http://www.php.net/manual/en/intlchar.enumcharnames.php - * @param int|string $start The first code point in the enumeration range. - * @param int|string $end One more than the last code point in the enumeration range (the first one after the range). - * @param callable $callback The function that is to be called for each character name. The following three arguments will be passed into it: - *- * int $codepoint - The numeric code point value - * int $nameChoice - The same value as the type parameter below - * string $name - The name of the character - *
- * @param int $type [optional] Selector for which kind of names to enumerate. Can be any of these constants: - *- * IntlChar::UNICODE_CHAR_NAME (default) - * IntlChar::UNICODE_10_CHAR_NAME - * IntlChar::EXTENDED_CHAR_NAME - * IntlChar::CHAR_NAME_ALIAS - * IntlChar::CHAR_NAME_CHOICE_COUNT - *
- * @return bool|null Returns null on success or false on failure. - */ - public static function enumCharNames (int|string $start, int|string $end, callable $callback, int $type = \IntlChar::UNICODE_CHAR_NAME): ?bool {} - - /** - * Enumerate all code points with their Unicode general categories - * @link http://www.php.net/manual/en/intlchar.enumchartypes.php - * @param callable $callback The function that is to be called for each contiguous range of code points with the same general category. - * The following three arguments will be passed into it: - *- * int $start - The starting code point of the range - * int $end - The ending code point of the range - * int $name - The category type (one of the IntlChar::CHAR_CATEGORY_* constants) - *
- * @return void No value is returned. - */ - public static function enumCharTypes (callable $callback): void {} - - /** - * Perform case folding on a code point - * @link http://www.php.net/manual/en/intlchar.foldcase.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @param int $options [optional] Either IntlChar::FOLD_CASE_DEFAULT (default) - * or IntlChar::FOLD_CASE_EXCLUDE_SPECIAL_I. - * @return int|string|null Returns the Simple_Case_Folding of the code point, if any; otherwise the code point itself on success, - * or null on failure. - */ - public static function foldCase (int|string $codepoint, int $options = \IntlChar::FOLD_CASE_DEFAULT): int|string|null {} - - /** - * Get character representation for a given digit and radix - * @link http://www.php.net/manual/en/intlchar.fordigit.php - * @param int $digit The number to convert to a character. - * @param int $base [optional] The radix (defaults to 10). - * @return int The character representation (as a string) of the specified digit in the specified radix. - */ - public static function forDigit (int $digit, int $base = 10): int {} - - /** - * Get the paired bracket character for a code point - * @link http://www.php.net/manual/en/intlchar.getbidipairedbracket.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @return int|string|null Returns the paired bracket code point, or codepoint itself if there is no such mapping. Returns - * null on failure. - *>The return type is int unless the code point was passed as a UTF-8 string, in which case a string is returned. Returns null on failure.
+ * {@inheritdoc} + * @param string|int $codepoint + * @param int $property + */ + public static function hasBinaryProperty (string|int $codepoint, int $property) {} + + /** + * {@inheritdoc} + * @param string|int $codepoint + */ + public static function charAge (string|int $codepoint) {} + + /** + * {@inheritdoc} + * @param string|int $codepoint + */ + public static function charDigitValue (string|int $codepoint) {} + + /** + * {@inheritdoc} + * @param string|int $codepoint + */ + public static function charDirection (string|int $codepoint) {} + + /** + * {@inheritdoc} + * @param string $name + * @param int $type [optional] + */ + public static function charFromName (string $name, int $type = 0) {} + + /** + * {@inheritdoc} + * @param string|int $codepoint + */ + public static function charMirror (string|int $codepoint) {} + + /** + * {@inheritdoc} + * @param string|int $codepoint + * @param int $type [optional] + */ + public static function charName (string|int $codepoint, int $type = 0) {} + + /** + * {@inheritdoc} + * @param string|int $codepoint + */ + public static function charType (string|int $codepoint) {} + + /** + * {@inheritdoc} + * @param string|int $codepoint + */ + public static function chr (string|int $codepoint) {} + + /** + * {@inheritdoc} + * @param string|int $codepoint + * @param int $base [optional] + */ + public static function digit (string|int $codepoint, int $base = 10) {} + + /** + * {@inheritdoc} + * @param string|int $start + * @param string|int $end + * @param callable $callback + * @param int $type [optional] + */ + public static function enumCharNames (string|int $start, string|int $end, callable $callback, int $type = 0) {} + + /** + * {@inheritdoc} + * @param callable $callback + */ + public static function enumCharTypes (callable $callback) {} + + /** + * {@inheritdoc} + * @param string|int $codepoint + * @param int $options [optional] + */ + public static function foldCase (string|int $codepoint, int $options = 0) {} + + /** + * {@inheritdoc} + * @param int $digit + * @param int $base [optional] + */ + public static function forDigit (int $digit, int $base = 10) {} + + /** + * {@inheritdoc} + * @param string|int $codepoint + */ + public static function getBidiPairedBracket (string|int $codepoint) {} + + /** + * {@inheritdoc} + * @param string|int $codepoint */ - public static function getBidiPairedBracket (int|string $codepoint): int|string|null {} + public static function getBlockCode (string|int $codepoint) {} /** - * Get the Unicode allocation block containing a code point - * @link http://www.php.net/manual/en/intlchar.getblockcode.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @return int|null Returns the block value for codepoint. - * See the IntlChar::BLOCK_CODE_* constants for possible return values. Returns null on failure. + * {@inheritdoc} + * @param string|int $codepoint */ - public static function getBlockCode (int|string $codepoint): ?int {} + public static function getCombiningClass (string|int $codepoint) {} /** - * Get the combining class of a code point - * @link http://www.php.net/manual/en/intlchar.getcombiningclass.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @return int|null Returns the combining class of the character. Returns null on failure. + * {@inheritdoc} + * @param string|int $codepoint */ - public static function getCombiningClass (int|string $codepoint): ?int {} + public static function getFC_NFKC_Closure (string|int $codepoint) {} /** - * Get the FC_NFKC_Closure property for a code point - * @link http://www.php.net/manual/en/intlchar.getfc-nfkc-closure.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @return string|false|null Returns the FC_NFKC_Closure property string for the codepoint, or an empty string if there is none. - * Returns null or false on failure. - */ - public static function getFC_NFKC_Closure (int|string $codepoint): string|false|null {} - - /** - * Get the max value for a Unicode property - * @link http://www.php.net/manual/en/intlchar.getintpropertymaxvalue.php - * @param int $property >The Unicode property to lookup (see the IntlChar::PROPERTY_* constants). - * @return int The maximum value returned by IntlChar::getIntPropertyValue for a Unicode property. - * <=0 if the property selector is out of range. + * {@inheritdoc} + * @param int $property */ - public static function getIntPropertyMaxValue (int $property): int {} - - /** - * Get the min value for a Unicode property - * @link http://www.php.net/manual/en/intlchar.getintpropertyminvalue.php - * @param int $property >The Unicode property to lookup (see the IntlChar::PROPERTY_* constants). - * @return int The minimum value returned by IntlChar::getIntPropertyValue for a Unicode property. - * 0 if the property selector is out of range. + public static function getIntPropertyMaxValue (int $property) {} + + /** + * {@inheritdoc} + * @param int $property */ - public static function getIntPropertyMinValue (int $property): int {} + public static function getIntPropertyMinValue (int $property) {} /** - * Get the value for a Unicode property for a code point - * @link http://www.php.net/manual/en/intlchar.getintpropertyvalue.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @param int $property >The Unicode property to lookup (see the IntlChar::PROPERTY_* constants). - * @return int|null Returns the numeric value that is directly the property value or, for enumerated properties, corresponds to the - * numeric value of the enumerated constant of the respective property value enumeration type. Returns null on failure. - *Returns 0 or 1 (for false/true) for binary Unicode properties.
- *Returns a bit-mask for mask properties.
- *Returns 0 if property is out of bounds or if the Unicode version does not - * have data for the property at all, or not for this code point.
+ * {@inheritdoc} + * @param string|int $codepoint + * @param int $property */ - public static function getIntPropertyValue (int|string $codepoint, int $property): ?int {} + public static function getIntPropertyValue (string|int $codepoint, int $property) {} /** - * Get the numeric value for a Unicode code point - * @link http://www.php.net/manual/en/intlchar.getnumericvalue.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @return float|null Numeric value of codepoint, - * or IntlChar::NO_NUMERIC_VALUE if none is defined. This - * constant was added in PHP 7.0.6, prior to this version the literal value - * (float)-123456789 may be used instead. Returns null on failure. + * {@inheritdoc} + * @param string|int $codepoint */ - public static function getNumericValue (int|string $codepoint): ?float {} + public static function getNumericValue (string|int $codepoint) {} /** - * Get the property constant value for a given property name - * @link http://www.php.net/manual/en/intlchar.getpropertyenum.php - * @param string $alias The property name to be matched. The name is compared using "loose matching" as described in PropertyAliases.txt. - * @return int Returns an IntlChar::PROPERTY_ constant value, - * or IntlChar::PROPERTY_INVALID_CODE if the given name does not match any property. + * {@inheritdoc} + * @param string $alias */ - public static function getPropertyEnum (string $alias): int {} + public static function getPropertyEnum (string $alias) {} /** - * Get the Unicode name for a property - * @link http://www.php.net/manual/en/intlchar.getpropertyname.php - * @param int $property >The Unicode property to lookup (see the IntlChar::PROPERTY_* constants). - *IntlChar::PROPERTY_INVALID_CODE should not be used. - * Also, if property is out of range, false is returned.
- * @param int $type [optional] Selector for which name to get. If out of range, false is returned. - *All properties have a long name. Most have a short name, but some do not. Unicode allows for additional names; - * if present these will be returned by adding 1, 2, etc. to IntlChar::LONG_PROPERTY_NAME.
- * @return string|false Returns the name, or false if either the property or the type - * is out of range. - *If a given type returns false, then all larger values of - * type will return false, with one exception: if false is returned for - * IntlChar::SHORT_PROPERTY_NAME, then IntlChar::LONG_PROPERTY_NAME - * (and higher) may still return a non-false value.
+ * {@inheritdoc} + * @param int $property + * @param int $type [optional] */ - public static function getPropertyName (int $property, int $type = \IntlChar::LONG_PROPERTY_NAME): string|false {} + public static function getPropertyName (int $property, int $type = 1) {} /** - * Get the property value for a given value name - * @link http://www.php.net/manual/en/intlchar.getpropertyvalueenum.php - * @param int $property >The Unicode property to lookup (see the IntlChar::PROPERTY_* constants). - *If out of range, or this method doesn't work with the given value, - * IntlChar::PROPERTY_INVALID_CODE is returned.
- * @param string $name The value name to be matched. The name is compared using "loose matching" as described in PropertyValueAliases.txt. - * @return int Returns the corresponding value integer, or IntlChar::PROPERTY_INVALID_CODE if the given name - * does not match any value of the given property, or if the property is invalid. + * {@inheritdoc} + * @param int $property + * @param string $name */ - public static function getPropertyValueEnum (int $property, string $name): int {} + public static function getPropertyValueEnum (int $property, string $name) {} /** - * Get the Unicode name for a property value - * @link http://www.php.net/manual/en/intlchar.getpropertyvaluename.php - * @param int $property >The Unicode property to lookup (see the IntlChar::PROPERTY_* constants). - *If out of range, or this method doesn't work with the given value, false is returned.
- * @param int $value Selector for a value for the given property. If out of range, false is returned. - *In general, valid values range from 0 up to some maximum. There are a couple exceptions: - *
- * IntlChar::PROPERTY_BLOCK values begin at the non-zero value IntlChar::BLOCK_CODE_BASIC_LATIN - * IntlChar::PROPERTY_CANONICAL_COMBINING_CLASS values are not contiguous and range from 0..240. - *
- * @param int $type [optional] Selector for which name to get. If out of range, false is returned. - *All values have a long name. Most have a short name, but some do not. Unicode allows for additional names; - * if present these will be returned by adding 1, 2, etc. to IntlChar::LONG_PROPERTY_NAME.
- * @return string|false Returns the name, or false if either the property or the type - * is out of range. Returns null on failure. - *If a given type returns false, then all larger values of type - * will return false, with one exception: if false is returned for IntlChar::SHORT_PROPERTY_NAME, - * then IntlChar::LONG_PROPERTY_NAME (and higher) may still return a non-false value.
+ * {@inheritdoc} + * @param int $property + * @param int $value + * @param int $type [optional] */ - public static function getPropertyValueName (int $property, int $value, int $type = \IntlChar::LONG_PROPERTY_NAME): string|false {} + public static function getPropertyValueName (int $property, int $value, int $type = 1) {} /** - * Get the Unicode version - * @link http://www.php.net/manual/en/intlchar.getunicodeversion.php - * @return array An array containing the Unicode version number. + * {@inheritdoc} */ - public static function getUnicodeVersion (): array {} + public static function getUnicodeVersion () {} /** - * Check if code point is an alphanumeric character - * @link http://www.php.net/manual/en/intlchar.isalnum.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @return bool|null Returns true if - * codepoint is an alphanumeric character, false if not. Returns null on failure. + * {@inheritdoc} + * @param string|int $codepoint */ - public static function isalnum (int|string $codepoint): ?bool {} + public static function isalnum (string|int $codepoint) {} /** - * Check if code point is a letter character - * @link http://www.php.net/manual/en/intlchar.isalpha.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @return bool|null Returns true if - * codepoint is a letter character, false if not. Returns null on failure. + * {@inheritdoc} + * @param string|int $codepoint */ - public static function isalpha (int|string $codepoint): ?bool {} + public static function isalpha (string|int $codepoint) {} /** - * Check if code point is a base character - * @link http://www.php.net/manual/en/intlchar.isbase.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @return bool|null Returns true if - * codepoint is a base character, false if not. Returns null on failure. + * {@inheritdoc} + * @param string|int $codepoint */ - public static function isbase (int|string $codepoint): ?bool {} + public static function isbase (string|int $codepoint) {} /** - * Check if code point is a "blank" or "horizontal space" character - * @link http://www.php.net/manual/en/intlchar.isblank.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @return bool|null Returns true if - * codepoint is either a "blank" or "horizontal space" character, false if not. Returns null on failure. + * {@inheritdoc} + * @param string|int $codepoint */ - public static function isblank (int|string $codepoint): ?bool {} + public static function isblank (string|int $codepoint) {} /** - * Check if code point is a control character - * @link http://www.php.net/manual/en/intlchar.iscntrl.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @return bool|null Returns true if - * codepoint is a control character, false if not. Returns null on failure. + * {@inheritdoc} + * @param string|int $codepoint */ - public static function iscntrl (int|string $codepoint): ?bool {} + public static function iscntrl (string|int $codepoint) {} /** - * Check whether the code point is defined - * @link http://www.php.net/manual/en/intlchar.isdefined.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @return bool|null Returns true if - * codepoint is a defined character, false if not. Returns null on failure. + * {@inheritdoc} + * @param string|int $codepoint */ - public static function isdefined (int|string $codepoint): ?bool {} + public static function isdefined (string|int $codepoint) {} /** - * Check if code point is a digit character - * @link http://www.php.net/manual/en/intlchar.isdigit.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @return bool|null Returns true if - * codepoint is a digit character, false if not. Returns null on failure. + * {@inheritdoc} + * @param string|int $codepoint */ - public static function isdigit (int|string $codepoint): ?bool {} + public static function isdigit (string|int $codepoint) {} /** - * Check if code point is a graphic character - * @link http://www.php.net/manual/en/intlchar.isgraph.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @return bool|null Returns true if - * codepoint is a "graphic" character, false if not. Returns null on failure. + * {@inheritdoc} + * @param string|int $codepoint */ - public static function isgraph (int|string $codepoint): ?bool {} + public static function isgraph (string|int $codepoint) {} /** - * Check if code point is an ignorable character - * @link http://www.php.net/manual/en/intlchar.isidignorable.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @return bool|null Returns true if - * codepoint is ignorable in identifiers, false if not. Returns null on failure. + * {@inheritdoc} + * @param string|int $codepoint */ - public static function isIDIgnorable (int|string $codepoint): ?bool {} + public static function isIDIgnorable (string|int $codepoint) {} /** - * Check if code point is permissible in an identifier - * @link http://www.php.net/manual/en/intlchar.isidpart.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @return bool|null Returns true if - * codepoint is the code point may occur in an identifier, false if not. Returns null on failure. + * {@inheritdoc} + * @param string|int $codepoint */ - public static function isIDPart (int|string $codepoint): ?bool {} + public static function isIDPart (string|int $codepoint) {} /** - * Check if code point is permissible as the first character in an identifier - * @link http://www.php.net/manual/en/intlchar.isidstart.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @return bool|null Returns true if - * codepoint may start an identifier, false if not. Returns null on failure. + * {@inheritdoc} + * @param string|int $codepoint */ - public static function isIDStart (int|string $codepoint): ?bool {} + public static function isIDStart (string|int $codepoint) {} /** - * Check if code point is an ISO control code - * @link http://www.php.net/manual/en/intlchar.isisocontrol.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @return bool|null Returns true if - * codepoint is an ISO control code, false if not. Returns null on failure. + * {@inheritdoc} + * @param string|int $codepoint */ - public static function isISOControl (int|string $codepoint): ?bool {} + public static function isISOControl (string|int $codepoint) {} /** - * Check if code point is permissible in a Java identifier - * @link http://www.php.net/manual/en/intlchar.isjavaidpart.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @return bool|null Returns true if - * codepoint may occur in a Java identifier, false if not. Returns null on failure. + * {@inheritdoc} + * @param string|int $codepoint */ - public static function isJavaIDPart (int|string $codepoint): ?bool {} + public static function isJavaIDPart (string|int $codepoint) {} /** - * Check if code point is permissible as the first character in a Java identifier - * @link http://www.php.net/manual/en/intlchar.isjavaidstart.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @return bool|null Returns true if - * codepoint may start a Java identifier, false if not. Returns null on failure. + * {@inheritdoc} + * @param string|int $codepoint */ - public static function isJavaIDStart (int|string $codepoint): ?bool {} + public static function isJavaIDStart (string|int $codepoint) {} /** - * Check if code point is a space character according to Java - * @link http://www.php.net/manual/en/intlchar.isjavaspacechar.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @return bool|null Returns true if - * codepoint is a space character according to Java, false if not. Returns null on failure. + * {@inheritdoc} + * @param string|int $codepoint */ - public static function isJavaSpaceChar (int|string $codepoint): ?bool {} + public static function isJavaSpaceChar (string|int $codepoint) {} /** - * Check if code point is a lowercase letter - * @link http://www.php.net/manual/en/intlchar.islower.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @return bool|null Returns true if - * codepoint is an Ll lowercase letter, false if not. Returns null on failure. + * {@inheritdoc} + * @param string|int $codepoint */ - public static function islower (int|string $codepoint): ?bool {} + public static function islower (string|int $codepoint) {} /** - * Check if code point has the Bidi_Mirrored property - * @link http://www.php.net/manual/en/intlchar.ismirrored.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @return bool|null Returns true if - * codepoint has the Bidi_Mirrored property, false if not. Returns null on failure. + * {@inheritdoc} + * @param string|int $codepoint */ - public static function isMirrored (int|string $codepoint): ?bool {} + public static function isMirrored (string|int $codepoint) {} /** - * Check if code point is a printable character - * @link http://www.php.net/manual/en/intlchar.isprint.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @return bool|null Returns true if - * codepoint is a printable character, false if not. Returns null on failure. + * {@inheritdoc} + * @param string|int $codepoint */ - public static function isprint (int|string $codepoint): ?bool {} + public static function isprint (string|int $codepoint) {} /** - * Check if code point is punctuation character - * @link http://www.php.net/manual/en/intlchar.ispunct.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @return bool|null Returns true if - * codepoint is a punctuation character, false if not. Returns null on failure. + * {@inheritdoc} + * @param string|int $codepoint */ - public static function ispunct (int|string $codepoint): ?bool {} + public static function ispunct (string|int $codepoint) {} /** - * Check if code point is a space character - * @link http://www.php.net/manual/en/intlchar.isspace.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @return bool|null Returns true if - * codepoint is a space character, false if not. Returns null on failure. + * {@inheritdoc} + * @param string|int $codepoint */ - public static function isspace (int|string $codepoint): ?bool {} + public static function isspace (string|int $codepoint) {} /** - * Check if code point is a titlecase letter - * @link http://www.php.net/manual/en/intlchar.istitle.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @return bool|null Returns true if - * codepoint is a titlecase letter, false if not. Returns null on failure. + * {@inheritdoc} + * @param string|int $codepoint */ - public static function istitle (int|string $codepoint): ?bool {} + public static function istitle (string|int $codepoint) {} /** - * Check if code point has the Alphabetic Unicode property - * @link http://www.php.net/manual/en/intlchar.isualphabetic.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @return bool|null Returns true if - * codepoint has the Alphabetic Unicode property, false if not. Returns null on failure. + * {@inheritdoc} + * @param string|int $codepoint */ - public static function isUAlphabetic (int|string $codepoint): ?bool {} + public static function isUAlphabetic (string|int $codepoint) {} /** - * Check if code point has the Lowercase Unicode property - * @link http://www.php.net/manual/en/intlchar.isulowercase.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @return bool|null Returns true if - * codepoint has the Lowercase Unicode property, false if not. Returns null on failure. + * {@inheritdoc} + * @param string|int $codepoint */ - public static function isULowercase (int|string $codepoint): ?bool {} + public static function isULowercase (string|int $codepoint) {} /** - * Check if code point has the general category "Lu" (uppercase letter) - * @link http://www.php.net/manual/en/intlchar.isupper.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @return bool|null Returns true if - * codepoint is an Lu uppercase letter, false if not. Returns null on failure. + * {@inheritdoc} + * @param string|int $codepoint */ - public static function isupper (int|string $codepoint): ?bool {} + public static function isupper (string|int $codepoint) {} /** - * Check if code point has the Uppercase Unicode property - * @link http://www.php.net/manual/en/intlchar.isuuppercase.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @return bool|null Returns true if - * codepoint has the Uppercase Unicode property, false if not. Returns null on failure. + * {@inheritdoc} + * @param string|int $codepoint */ - public static function isUUppercase (int|string $codepoint): ?bool {} + public static function isUUppercase (string|int $codepoint) {} /** - * Check if code point has the White_Space Unicode property - * @link http://www.php.net/manual/en/intlchar.isuwhitespace.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @return bool|null Returns true if - * codepoint has the White_Space Unicode property, false if not. Returns null on failure. + * {@inheritdoc} + * @param string|int $codepoint */ - public static function isUWhiteSpace (int|string $codepoint): ?bool {} + public static function isUWhiteSpace (string|int $codepoint) {} /** - * Check if code point is a whitespace character according to ICU - * @link http://www.php.net/manual/en/intlchar.iswhitespace.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @return bool|null Returns true if - * codepoint is a whitespace character according to ICU, false if not. Returns null on failure. + * {@inheritdoc} + * @param string|int $codepoint */ - public static function isWhitespace (int|string $codepoint): ?bool {} + public static function isWhitespace (string|int $codepoint) {} /** - * Check if code point is a hexadecimal digit - * @link http://www.php.net/manual/en/intlchar.isxdigit.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @return bool|null Returns true if - * codepoint is a hexadecimal character, false if not. Returns null on failure. + * {@inheritdoc} + * @param string|int $codepoint */ - public static function isxdigit (int|string $codepoint): ?bool {} + public static function isxdigit (string|int $codepoint) {} /** - * Return Unicode code point value of character - * @link http://www.php.net/manual/en/intlchar.ord.php - * @param int|string $character >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @return int|null Returns the Unicode code point value as an integer. + * {@inheritdoc} + * @param string|int $character */ - public static function ord (int|string $character): ?int {} + public static function ord (string|int $character) {} /** - * Make Unicode character lowercase - * @link http://www.php.net/manual/en/intlchar.tolower.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @return int|string|null Returns the Simple_Lowercase_Mapping of the code point, if any; - * otherwise the code point itself. Returns null on failure. - *>The return type is int unless the code point was passed as a UTF-8 string, in which case a string is returned. Returns null on failure.
+ * {@inheritdoc} + * @param string|int $codepoint */ - public static function tolower (int|string $codepoint): int|string|null {} + public static function tolower (string|int $codepoint) {} /** - * Make Unicode character titlecase - * @link http://www.php.net/manual/en/intlchar.totitle.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @return int|string|null Returns the Simple_Titlecase_Mapping of the code point, if any; - * otherwise the code point itself. Returns null on failure. - *>The return type is int unless the code point was passed as a UTF-8 string, in which case a string is returned. Returns null on failure.
+ * {@inheritdoc} + * @param string|int $codepoint */ - public static function totitle (int|string $codepoint): int|string|null {} + public static function totitle (string|int $codepoint) {} /** - * Make Unicode character uppercase - * @link http://www.php.net/manual/en/intlchar.toupper.php - * @param int|string $codepoint >The int codepoint value (e.g. 0x2603 for U+2603 SNOWMAN), or the character encoded as a UTF-8 string (e.g. "\u{2603}") - * @return int|string|null Returns the Simple_Uppercase_Mapping of the code point, if any; - * otherwise the code point itself. - *>The return type is int unless the code point was passed as a UTF-8 string, in which case a string is returned. Returns null on failure.
+ * {@inheritdoc} + * @param string|int $codepoint */ - public static function toupper (int|string $codepoint): int|string|null {} + public static function toupper (string|int $codepoint) {} } @@ -5700,7 +3630,7 @@ function intlcal_before (IntlCalendar $calendar, IntlCalendar $other): bool {} * @param int $minute [optional] * @param int $second [optional] */ -function intlcal_set (IntlCalendar $calendar, int $year, int $month, int $dayOfMonth = NULL, int $hour = NULL, int $minute = NULL, int $second = NULL): bool {} +function intlcal_set (IntlCalendar $calendar, int $year, int $month, int $dayOfMonth = NULL, int $hour = NULL, int $minute = NULL, int $second = NULL): true {} /** * {@inheritdoc} @@ -5715,7 +3645,7 @@ function intlcal_roll (IntlCalendar $calendar, int $field, $value = null): bool * @param IntlCalendar $calendar * @param int|null $field [optional] */ -function intlcal_clear (IntlCalendar $calendar, ?int $field = NULL): bool {} +function intlcal_clear (IntlCalendar $calendar, ?int $field = NULL): true {} /** * {@inheritdoc} @@ -5791,7 +3721,7 @@ function intlcal_get_minimal_days_in_first_week (IntlCalendar $calendar): int|fa * @param IntlCalendar $calendar * @param int $days */ -function intlcal_set_minimal_days_in_first_week (IntlCalendar $calendar, int $days): bool {} +function intlcal_set_minimal_days_in_first_week (IntlCalendar $calendar, int $days): true {} /** * {@inheritdoc} @@ -5857,14 +3787,14 @@ function intlcal_is_weekend (IntlCalendar $calendar, ?float $timestamp = NULL): * @param IntlCalendar $calendar * @param int $dayOfWeek */ -function intlcal_set_first_day_of_week (IntlCalendar $calendar, int $dayOfWeek): bool {} +function intlcal_set_first_day_of_week (IntlCalendar $calendar, int $dayOfWeek): true {} /** * {@inheritdoc} * @param IntlCalendar $calendar * @param bool $lenient */ -function intlcal_set_lenient (IntlCalendar $calendar, bool $lenient): bool {} +function intlcal_set_lenient (IntlCalendar $calendar, bool $lenient): true {} /** * {@inheritdoc} @@ -5890,14 +3820,14 @@ function intlcal_get_skipped_wall_time_option (IntlCalendar $calendar): int {} * @param IntlCalendar $calendar * @param int $option */ -function intlcal_set_repeated_wall_time_option (IntlCalendar $calendar, int $option): bool {} +function intlcal_set_repeated_wall_time_option (IntlCalendar $calendar, int $option): true {} /** * {@inheritdoc} * @param IntlCalendar $calendar * @param int $option */ -function intlcal_set_skipped_wall_time_option (IntlCalendar $calendar, int $option): bool {} +function intlcal_set_skipped_wall_time_option (IntlCalendar $calendar, int $option): true {} /** * {@inheritdoc} @@ -5913,21 +3843,14 @@ function intlcal_from_date_time (DateTime|string $datetime, ?string $locale = NU function intlcal_to_date_time (IntlCalendar $calendar): DateTime|false {} /** - * Get last error code on the object - * @link http://www.php.net/manual/en/intlcalendar.geterrorcode.php - * @param IntlCalendar $calendar The calendar object, on the procedural style interface. - * @return int|false An ICU error code indicating either success, failure or a warning. - * Returns false on failure. + * {@inheritdoc} + * @param IntlCalendar $calendar */ function intlcal_get_error_code (IntlCalendar $calendar): int|false {} /** - * Get last error message on the object - * @link http://www.php.net/manual/en/intlcalendar.geterrormessage.php - * @param IntlCalendar $calendar The calendar object, on the procedural style interface. - * @return string|false The error message associated with last error that occurred in a function call - * on this object, or a string indicating the non-existence of an error. - * Returns false on failure. + * {@inheritdoc} + * @param IntlCalendar $calendar */ function intlcal_get_error_message (IntlCalendar $calendar): string|false {} @@ -5963,1376 +3886,923 @@ function intlgregcal_get_gregorian_change (IntlGregorianCalendar $calendar): flo function intlgregcal_is_leap_year (IntlGregorianCalendar $calendar, int $year): bool {} /** - * Create a collator - * @link http://www.php.net/manual/en/collator.create.php - * @param string $locale - * @return Collator|null Return new instance of Collator object, or null - * on error. + * {@inheritdoc} + * @param string $locale */ function collator_create (string $locale): ?Collator {} /** - * Compare two Unicode strings - * @link http://www.php.net/manual/en/collator.compare.php - * @param Collator $object - * @param string $string1 - * @param string $string2 - * @return int|false Return comparison result: - *
- *
- *
- * 1 if string1 is greater than - * string2 ; - *
- *- * 0 if string1 is equal to - * string2; - *
- *- * -1 if string1 is less than - * string2 . - *
- * - * Returns false on failure. - *1 if string1 is greater than - * string2 ;
- *0 if string1 is equal to - * string2;
- *-1 if string1 is less than - * string2 .
+ * {@inheritdoc} + * @param Collator $object + * @param string $string1 + * @param string $string2 */ function collator_compare (Collator $object, string $string1, string $string2): int|false {} /** - * Get collation attribute value - * @link http://www.php.net/manual/en/collator.getattribute.php - * @param Collator $object - * @param int $attribute - * @return int|false Attribute value, or false on failure. + * {@inheritdoc} + * @param Collator $object + * @param int $attribute */ function collator_get_attribute (Collator $object, int $attribute): int|false {} /** - * Set collation attribute - * @link http://www.php.net/manual/en/collator.setattribute.php - * @param Collator $object - * @param int $attribute - * @param int $value - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param Collator $object + * @param int $attribute + * @param int $value */ function collator_set_attribute (Collator $object, int $attribute, int $value): bool {} /** - * Get current collation strength - * @link http://www.php.net/manual/en/collator.getstrength.php - * @param Collator $object - * @return int Returns current collation strength, or false on failure. + * {@inheritdoc} + * @param Collator $object */ function collator_get_strength (Collator $object): int {} /** - * Set collation strength - * @link http://www.php.net/manual/en/collator.setstrength.php - * @param Collator $object - * @param int $strength - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param Collator $object + * @param int $strength */ function collator_set_strength (Collator $object, int $strength): bool {} /** - * Sort array using specified collator - * @link http://www.php.net/manual/en/collator.sort.php - * @param Collator $object - * @param array $array - * @param int $flags [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param Collator $object + * @param array $array + * @param int $flags [optional] */ -function collator_sort (Collator $object, array &$array, int $flags = \Collator::SORT_REGULAR): bool {} +function collator_sort (Collator $object, array &$array, int $flags = 0): bool {} /** - * Sort array using specified collator and sort keys - * @link http://www.php.net/manual/en/collator.sortwithsortkeys.php - * @param Collator $object - * @param array $array - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param Collator $object + * @param array $array */ function collator_sort_with_sort_keys (Collator $object, array &$array): bool {} /** - * Sort array maintaining index association - * @link http://www.php.net/manual/en/collator.asort.php - * @param Collator $object - * @param array $array - * @param int $flags [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param Collator $object + * @param array $array + * @param int $flags [optional] */ -function collator_asort (Collator $object, array &$array, int $flags = \Collator::SORT_REGULAR): bool {} +function collator_asort (Collator $object, array &$array, int $flags = 0): bool {} /** - * Get the locale name of the collator - * @link http://www.php.net/manual/en/collator.getlocale.php - * @param Collator $object - * @param int $type - * @return string|false Real locale name from which the collation data comes. If the collator was - * instantiated from rules or an error occurred, returns false. + * {@inheritdoc} + * @param Collator $object + * @param int $type */ function collator_get_locale (Collator $object, int $type): string|false {} /** - * Get collator's last error code - * @link http://www.php.net/manual/en/collator.geterrorcode.php - * @param Collator $object - * @return int|false Error code returned by the last Collator API function call, - * or false on failure. + * {@inheritdoc} + * @param Collator $object */ function collator_get_error_code (Collator $object): int|false {} /** - * Get text for collator's last error code - * @link http://www.php.net/manual/en/collator.geterrormessage.php - * @param Collator $object - * @return string|false Description of an error occurred in the last Collator API function call, - * or false on failure. + * {@inheritdoc} + * @param Collator $object */ function collator_get_error_message (Collator $object): string|false {} /** - * Get sorting key for a string - * @link http://www.php.net/manual/en/collator.getsortkey.php - * @param Collator $object - * @param string $string - * @return string|false Returns the collation key for the string, or false on failure. + * {@inheritdoc} + * @param Collator $object + * @param string $string */ function collator_get_sort_key (Collator $object, string $string): string|false {} /** - * Get the last error code - * @link http://www.php.net/manual/en/function.intl-get-error-code.php - * @return int Error code returned by the last API function call. + * {@inheritdoc} */ function intl_get_error_code (): int {} /** - * Get description of the last error - * @link http://www.php.net/manual/en/function.intl-get-error-message.php - * @return string Description of an error occurred in the last API function call. + * {@inheritdoc} */ function intl_get_error_message (): string {} /** - * Check whether the given error code indicates failure - * @link http://www.php.net/manual/en/function.intl-is-failure.php - * @param int $errorCode - * @return bool true if it the code indicates some failure, and false - * in case of success or a warning. + * {@inheritdoc} + * @param int $errorCode */ function intl_is_failure (int $errorCode): bool {} /** - * Get symbolic name for a given error code - * @link http://www.php.net/manual/en/function.intl-error-name.php - * @param int $errorCode - * @return string The returned string will be the same as the name of the error code - * constant. + * {@inheritdoc} + * @param int $errorCode */ function intl_error_name (int $errorCode): string {} /** - * Create a date formatter - * @link http://www.php.net/manual/en/intldateformatter.create.php - * @param string|null $locale - * @param int $dateType [optional] - * @param int $timeType [optional] - * @param IntlTimeZone|DateTimeZone|string|null $timezone [optional] - * @param IntlCalendar|int|null $calendar [optional] - * @param string|null $pattern [optional] - * @return IntlDateFormatter|null The created IntlDateFormatter or null in case of - * failure. + * {@inheritdoc} + * @param string|null $locale + * @param int $dateType [optional] + * @param int $timeType [optional] + * @param mixed $timezone [optional] + * @param IntlCalendar|int|null $calendar [optional] + * @param string|null $pattern [optional] */ -function datefmt_create (?string $locale, int $dateType = \IntlDateFormatter::FULL, int $timeType = \IntlDateFormatter::FULL, IntlTimeZone|DateTimeZone|string|null $timezone = null, IntlCalendar|int|null $calendar = null, ?string $pattern = null): ?IntlDateFormatter {} +function datefmt_create (?string $locale = null, int $dateType = 0, int $timeType = 0, $timezone = NULL, IntlCalendar|int|null $calendar = NULL, ?string $pattern = NULL): ?IntlDateFormatter {} /** - * Get the datetype used for the IntlDateFormatter - * @link http://www.php.net/manual/en/intldateformatter.getdatetype.php - * @param IntlDateFormatter $formatter - * @return int|false The current date type value of the formatter, - * or false on failure. + * {@inheritdoc} + * @param IntlDateFormatter $formatter */ function datefmt_get_datetype (IntlDateFormatter $formatter): int|false {} /** - * Get the timetype used for the IntlDateFormatter - * @link http://www.php.net/manual/en/intldateformatter.gettimetype.php - * @param IntlDateFormatter $formatter - * @return int|false The current date type value of the formatter, - * or false on failure. + * {@inheritdoc} + * @param IntlDateFormatter $formatter */ function datefmt_get_timetype (IntlDateFormatter $formatter): int|false {} /** - * Get the calendar type used for the IntlDateFormatter - * @link http://www.php.net/manual/en/intldateformatter.getcalendar.php - * @param IntlDateFormatter $formatter - * @return int|false The calendar - * type being used by the formatter. Either - * IntlDateFormatter::TRADITIONAL or - * IntlDateFormatter::GREGORIAN. - * Returns false on failure. + * {@inheritdoc} + * @param IntlDateFormatter $formatter */ function datefmt_get_calendar (IntlDateFormatter $formatter): int|false {} /** - * Sets the calendar type used by the formatter - * @link http://www.php.net/manual/en/intldateformatter.setcalendar.php - * @param IntlDateFormatter $formatter - * @param IntlCalendar|int|null $calendar - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param IntlDateFormatter $formatter + * @param IntlCalendar|int|null $calendar */ -function datefmt_set_calendar (IntlDateFormatter $formatter, IntlCalendar|int|null $calendar): bool {} +function datefmt_set_calendar (IntlDateFormatter $formatter, IntlCalendar|int|null $calendar = null): bool {} /** - * Get the timezone-id used for the IntlDateFormatter - * @link http://www.php.net/manual/en/intldateformatter.gettimezoneid.php - * @param IntlDateFormatter $formatter - * @return string|false ID string for the time zone used by this formatter, or false on failure. + * {@inheritdoc} + * @param IntlDateFormatter $formatter */ function datefmt_get_timezone_id (IntlDateFormatter $formatter): string|false {} /** - * Get copy of formatterʼs calendar object - * @link http://www.php.net/manual/en/intldateformatter.getcalendarobject.php - * @param IntlDateFormatter $formatter - * @return IntlCalendar|false|null A copy of the internal calendar object used by this formatter, - * or null if none has been set, or false on failure. + * {@inheritdoc} + * @param IntlDateFormatter $formatter */ function datefmt_get_calendar_object (IntlDateFormatter $formatter): IntlCalendar|false|null {} /** - * Get formatterʼs timezone - * @link http://www.php.net/manual/en/intldateformatter.gettimezone.php - * @param IntlDateFormatter $formatter - * @return IntlTimeZone|false The associated IntlTimeZone - * object or false on failure. + * {@inheritdoc} + * @param IntlDateFormatter $formatter */ function datefmt_get_timezone (IntlDateFormatter $formatter): IntlTimeZone|false {} /** - * Sets formatterʼs timezone - * @link http://www.php.net/manual/en/intldateformatter.settimezone.php - * @param IntlDateFormatter $formatter The formatter resource. - * @param IntlTimeZone|DateTimeZone|string|null $timezone The timezone to use for this formatter. This can be specified in the - * following forms: - *null, in which case the default timezone will be used, as specified in - * the ini setting date.timezone or - * through the function date_default_timezone_set and as - * returned by date_default_timezone_get.
- *An IntlTimeZone, which will be used directly.
- *A DateTimeZone. Its identifier will be extracted - * and an ICU timezone object will be created; the timezone will be backed - * by ICUʼs database, not PHPʼs.
- *A string, which should be a valid ICU timezone identifier. - * See IntlTimeZone::createTimeZoneIDEnumeration. Raw - * offsets such as "GMT+08:30" are also accepted.
- * @return bool|null Returns null on success and false on failure. - */ -function datefmt_set_timezone (IntlDateFormatter $formatter, IntlTimeZone|DateTimeZone|string|null $timezone): ?bool {} - -/** - * Set the pattern used for the IntlDateFormatter - * @link http://www.php.net/manual/en/intldateformatter.setpattern.php - * @param IntlDateFormatter $formatter - * @param string $pattern - * @return bool Returns true on success or false on failure. - * Bad formatstrings are usually the cause of the failure. + * {@inheritdoc} + * @param IntlDateFormatter $formatter + * @param mixed $timezone + */ +function datefmt_set_timezone (IntlDateFormatter $formatter, $timezone = null): bool {} + +/** + * {@inheritdoc} + * @param IntlDateFormatter $formatter + * @param string $pattern */ function datefmt_set_pattern (IntlDateFormatter $formatter, string $pattern): bool {} /** - * Get the pattern used for the IntlDateFormatter - * @link http://www.php.net/manual/en/intldateformatter.getpattern.php - * @param IntlDateFormatter $formatter - * @return string|false The pattern string being used to format/parse, or false on failure. + * {@inheritdoc} + * @param IntlDateFormatter $formatter */ function datefmt_get_pattern (IntlDateFormatter $formatter): string|false {} /** - * Get the locale used by formatter - * @link http://www.php.net/manual/en/intldateformatter.getlocale.php - * @param IntlDateFormatter $formatter - * @param int $type [optional] - * @return string|false The locale of this formatter, or false on failure. + * {@inheritdoc} + * @param IntlDateFormatter $formatter + * @param int $type [optional] */ -function datefmt_get_locale (IntlDateFormatter $formatter, int $type = ULOC_ACTUAL_LOCALE): string|false {} +function datefmt_get_locale (IntlDateFormatter $formatter, int $type = 0): string|false {} /** - * Set the leniency of the parser - * @link http://www.php.net/manual/en/intldateformatter.setlenient.php - * @param IntlDateFormatter $formatter - * @param bool $lenient - * @return void Returns true on success or false on failure. + * {@inheritdoc} + * @param IntlDateFormatter $formatter + * @param bool $lenient */ function datefmt_set_lenient (IntlDateFormatter $formatter, bool $lenient): void {} /** - * Get the lenient used for the IntlDateFormatter - * @link http://www.php.net/manual/en/intldateformatter.islenient.php - * @param IntlDateFormatter $formatter - * @return bool true if parser is lenient, false if parser is strict. By default the parser is lenient. + * {@inheritdoc} + * @param IntlDateFormatter $formatter */ function datefmt_is_lenient (IntlDateFormatter $formatter): bool {} /** - * Format the date/time value as a string - * @link http://www.php.net/manual/en/intldateformatter.format.php - * @param IntlDateFormatter $formatter - * @param IntlCalendar|DateTimeInterface|array|string|int|float $datetime - * @return string|false The formatted string or, if an error occurred, false. + * {@inheritdoc} + * @param IntlDateFormatter $formatter + * @param mixed $datetime */ -function datefmt_format (IntlDateFormatter $formatter, IntlCalendar|DateTimeInterface|array|string|int|float $datetime): string|false {} +function datefmt_format (IntlDateFormatter $formatter, $datetime = null): string|false {} /** - * Formats an object - * @link http://www.php.net/manual/en/intldateformatter.formatobject.php - * @param IntlCalendar|DateTimeInterface $datetime An object of type IntlCalendar or - * DateTime. The timezone information in the object - * will be used. - * @param array|int|string|null $format [optional] How to format the date/time. This can either be an array with - * two elements (first the date style, then the time style, these being one - * of the constants IntlDateFormatter::NONE, - * IntlDateFormatter::SHORT, - * IntlDateFormatter::MEDIUM, - * IntlDateFormatter::LONG, - * IntlDateFormatter::FULL), an int with - * the value of one of these constants (in which case it will be used both - * for the time and the date) or a string with the format - * described in the ICU - * documentation. If null, the default style will be used. - * @param string|null $locale [optional] The locale to use, or null to use the default one. - * @return string|false A string with result or false on failure. + * {@inheritdoc} + * @param mixed $datetime + * @param mixed $format [optional] + * @param string|null $locale [optional] */ -function datefmt_format_object (IntlCalendar|DateTimeInterface $datetime, array|int|string|null $format = null, ?string $locale = null): string|false {} +function datefmt_format_object ($datetime = null, $format = NULL, ?string $locale = NULL): string|false {} /** - * Parse string to a timestamp value - * @link http://www.php.net/manual/en/intldateformatter.parse.php - * @param IntlDateFormatter $formatter - * @param string $string - * @param int $offset [optional] - * @return int|float|false Timestamp of parsed value, or false if value cannot be parsed. + * {@inheritdoc} + * @param IntlDateFormatter $formatter + * @param string $string + * @param mixed $offset [optional] */ -function datefmt_parse (IntlDateFormatter $formatter, string $string, int &$offset = null): int|float|false {} +function datefmt_parse (IntlDateFormatter $formatter, string $string, &$offset = NULL): int|float|false {} /** - * Parse string to a field-based time value - * @link http://www.php.net/manual/en/intldateformatter.localtime.php - * @param IntlDateFormatter $formatter - * @param string $string - * @param int $offset [optional] - * @return array|false Localtime compatible array of integers : contains 24 hour clock value in tm_hour field, - * or false on failure. + * {@inheritdoc} + * @param IntlDateFormatter $formatter + * @param string $string + * @param mixed $offset [optional] */ -function datefmt_localtime (IntlDateFormatter $formatter, string $string, int &$offset = null): array|false {} +function datefmt_localtime (IntlDateFormatter $formatter, string $string, &$offset = NULL): array|false {} /** - * Get the error code from last operation - * @link http://www.php.net/manual/en/intldateformatter.geterrorcode.php - * @param IntlDateFormatter $formatter - * @return int The error code, one of UErrorCode values. Initial value is U_ZERO_ERROR. + * {@inheritdoc} + * @param IntlDateFormatter $formatter */ function datefmt_get_error_code (IntlDateFormatter $formatter): int {} /** - * Get the error text from the last operation - * @link http://www.php.net/manual/en/intldateformatter.geterrormessage.php - * @param IntlDateFormatter $formatter - * @return string Description of the last error. + * {@inheritdoc} + * @param IntlDateFormatter $formatter */ function datefmt_get_error_message (IntlDateFormatter $formatter): string {} /** - * Create a number formatter - * @link http://www.php.net/manual/en/numberformatter.create.php - * @param string $locale - * @param int $style - * @param string|null $pattern [optional] - * @return NumberFormatter|null Returns NumberFormatter object or null on error. + * {@inheritdoc} + * @param string $locale + * @param int $style + * @param string|null $pattern [optional] */ -function numfmt_create (string $locale, int $style, ?string $pattern = null): ?NumberFormatter {} +function numfmt_create (string $locale, int $style, ?string $pattern = NULL): ?NumberFormatter {} /** - * Format a number - * @link http://www.php.net/manual/en/numberformatter.format.php - * @param NumberFormatter $formatter - * @param int|float $num - * @param int $type [optional] - * @return string|false Returns the string containing formatted value, or false on error. + * {@inheritdoc} + * @param NumberFormatter $formatter + * @param int|float $num + * @param int $type [optional] */ -function numfmt_format (NumberFormatter $formatter, int|float $num, int $type = \NumberFormatter::TYPE_DEFAULT): string|false {} +function numfmt_format (NumberFormatter $formatter, int|float $num, int $type = 0): string|false {} /** - * Parse a number - * @link http://www.php.net/manual/en/numberformatter.parse.php - * @param NumberFormatter $formatter - * @param string $string - * @param int $type [optional] - * @param int $offset [optional] - * @return int|float|false The value of the parsed number or false on error. + * {@inheritdoc} + * @param NumberFormatter $formatter + * @param string $string + * @param int $type [optional] + * @param mixed $offset [optional] */ -function numfmt_parse (NumberFormatter $formatter, string $string, int $type = \NumberFormatter::TYPE_DOUBLE, int &$offset = null): int|float|false {} +function numfmt_parse (NumberFormatter $formatter, string $string, int $type = 3, &$offset = NULL): int|float|false {} /** - * Format a currency value - * @link http://www.php.net/manual/en/numberformatter.formatcurrency.php - * @param NumberFormatter $formatter - * @param float $amount - * @param string $currency - * @return string|false String representing the formatted currency value, or false on failure. + * {@inheritdoc} + * @param NumberFormatter $formatter + * @param float $amount + * @param string $currency */ function numfmt_format_currency (NumberFormatter $formatter, float $amount, string $currency): string|false {} /** - * Parse a currency number - * @link http://www.php.net/manual/en/numberformatter.parsecurrency.php - * @param NumberFormatter $formatter - * @param string $string - * @param string $currency - * @param int $offset [optional] - * @return float|false The parsed numeric value or false on error. + * {@inheritdoc} + * @param NumberFormatter $formatter + * @param string $string + * @param mixed $currency + * @param mixed $offset [optional] */ -function numfmt_parse_currency (NumberFormatter $formatter, string $string, string &$currency, int &$offset = null): float|false {} +function numfmt_parse_currency (NumberFormatter $formatter, string $string, &$currency = null, &$offset = NULL): float|false {} /** - * Set an attribute - * @link http://www.php.net/manual/en/numberformatter.setattribute.php - * @param NumberFormatter $formatter - * @param int $attribute - * @param int|float $value - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param NumberFormatter $formatter + * @param int $attribute + * @param int|float $value */ function numfmt_set_attribute (NumberFormatter $formatter, int $attribute, int|float $value): bool {} /** - * Get an attribute - * @link http://www.php.net/manual/en/numberformatter.getattribute.php - * @param NumberFormatter $formatter - * @param int $attribute - * @return int|float|false Return attribute value on success, or false on error. + * {@inheritdoc} + * @param NumberFormatter $formatter + * @param int $attribute */ function numfmt_get_attribute (NumberFormatter $formatter, int $attribute): int|float|false {} /** - * Set a text attribute - * @link http://www.php.net/manual/en/numberformatter.settextattribute.php - * @param NumberFormatter $formatter - * @param int $attribute - * @param string $value - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param NumberFormatter $formatter + * @param int $attribute + * @param string $value */ function numfmt_set_text_attribute (NumberFormatter $formatter, int $attribute, string $value): bool {} /** - * Get a text attribute - * @link http://www.php.net/manual/en/numberformatter.gettextattribute.php - * @param NumberFormatter $formatter - * @param int $attribute - * @return string|false Return attribute value on success, or false on error. + * {@inheritdoc} + * @param NumberFormatter $formatter + * @param int $attribute */ function numfmt_get_text_attribute (NumberFormatter $formatter, int $attribute): string|false {} /** - * Set a symbol value - * @link http://www.php.net/manual/en/numberformatter.setsymbol.php - * @param NumberFormatter $formatter - * @param int $symbol - * @param string $value - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param NumberFormatter $formatter + * @param int $symbol + * @param string $value */ function numfmt_set_symbol (NumberFormatter $formatter, int $symbol, string $value): bool {} /** - * Get a symbol value - * @link http://www.php.net/manual/en/numberformatter.getsymbol.php - * @param NumberFormatter $formatter - * @param int $symbol - * @return string|false The symbol string or false on error. + * {@inheritdoc} + * @param NumberFormatter $formatter + * @param int $symbol */ function numfmt_get_symbol (NumberFormatter $formatter, int $symbol): string|false {} /** - * Set formatter pattern - * @link http://www.php.net/manual/en/numberformatter.setpattern.php - * @param NumberFormatter $formatter - * @param string $pattern - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param NumberFormatter $formatter + * @param string $pattern */ function numfmt_set_pattern (NumberFormatter $formatter, string $pattern): bool {} /** - * Get formatter pattern - * @link http://www.php.net/manual/en/numberformatter.getpattern.php - * @param NumberFormatter $formatter - * @return string|false Pattern string that is used by the formatter, or false if an error happens. + * {@inheritdoc} + * @param NumberFormatter $formatter */ function numfmt_get_pattern (NumberFormatter $formatter): string|false {} /** - * Get formatter locale - * @link http://www.php.net/manual/en/numberformatter.getlocale.php - * @param NumberFormatter $formatter - * @param int $type [optional] - * @return string|false The locale name used to create the formatter, or false on failure. + * {@inheritdoc} + * @param NumberFormatter $formatter + * @param int $type [optional] */ -function numfmt_get_locale (NumberFormatter $formatter, int $type = ULOC_ACTUAL_LOCALE): string|false {} +function numfmt_get_locale (NumberFormatter $formatter, int $type = 0): string|false {} /** - * Get formatter's last error code - * @link http://www.php.net/manual/en/numberformatter.geterrorcode.php - * @param NumberFormatter $formatter - * @return int Returns error code from last formatter call. + * {@inheritdoc} + * @param NumberFormatter $formatter */ function numfmt_get_error_code (NumberFormatter $formatter): int {} /** - * Get formatter's last error message - * @link http://www.php.net/manual/en/numberformatter.geterrormessage.php - * @param NumberFormatter $formatter - * @return string Returns error message from last formatter call. + * {@inheritdoc} + * @param NumberFormatter $formatter */ function numfmt_get_error_message (NumberFormatter $formatter): string {} /** - * Get string length in grapheme units - * @link http://www.php.net/manual/en/function.grapheme-strlen.php - * @param string $string - * @return int|false|null The length of the string on success, or false on failure. + * {@inheritdoc} + * @param string $string */ function grapheme_strlen (string $string): int|false|null {} /** - * Find position (in grapheme units) of first occurrence of a string - * @link http://www.php.net/manual/en/function.grapheme-strpos.php - * @param string $haystack - * @param string $needle - * @param int $offset [optional] - * @return int|false Returns the position as an integer. If needle is not found, grapheme_strpos will return false. + * {@inheritdoc} + * @param string $haystack + * @param string $needle + * @param int $offset [optional] */ -function grapheme_strpos (string $haystack, string $needle, int $offset = null): int|false {} +function grapheme_strpos (string $haystack, string $needle, int $offset = 0): int|false {} /** - * Find position (in grapheme units) of first occurrence of a case-insensitive string - * @link http://www.php.net/manual/en/function.grapheme-stripos.php - * @param string $haystack - * @param string $needle - * @param int $offset [optional] - * @return int|false Returns the position as an integer. If needle is not found, grapheme_stripos will return false. + * {@inheritdoc} + * @param string $haystack + * @param string $needle + * @param int $offset [optional] */ -function grapheme_stripos (string $haystack, string $needle, int $offset = null): int|false {} +function grapheme_stripos (string $haystack, string $needle, int $offset = 0): int|false {} /** - * Find position (in grapheme units) of last occurrence of a string - * @link http://www.php.net/manual/en/function.grapheme-strrpos.php - * @param string $haystack - * @param string $needle - * @param int $offset [optional] - * @return int|false Returns the position as an integer. If needle is not found, grapheme_strrpos will return false. + * {@inheritdoc} + * @param string $haystack + * @param string $needle + * @param int $offset [optional] */ -function grapheme_strrpos (string $haystack, string $needle, int $offset = null): int|false {} +function grapheme_strrpos (string $haystack, string $needle, int $offset = 0): int|false {} /** - * Find position (in grapheme units) of last occurrence of a case-insensitive string - * @link http://www.php.net/manual/en/function.grapheme-strripos.php - * @param string $haystack - * @param string $needle - * @param int $offset [optional] - * @return int|false Returns the position as an integer. If needle is not found, grapheme_strripos will return false. + * {@inheritdoc} + * @param string $haystack + * @param string $needle + * @param int $offset [optional] */ -function grapheme_strripos (string $haystack, string $needle, int $offset = null): int|false {} +function grapheme_strripos (string $haystack, string $needle, int $offset = 0): int|false {} /** - * Return part of a string - * @link http://www.php.net/manual/en/function.grapheme-substr.php - * @param string $string - * @param int $offset - * @param int|null $length [optional] - * @return string|false Returns the extracted part of string, or false on failure. + * {@inheritdoc} + * @param string $string + * @param int $offset + * @param int|null $length [optional] */ -function grapheme_substr (string $string, int $offset, ?int $length = null): string|false {} +function grapheme_substr (string $string, int $offset, ?int $length = NULL): string|false {} /** - * Returns part of haystack string from the first occurrence of needle to the end of haystack - * @link http://www.php.net/manual/en/function.grapheme-strstr.php - * @param string $haystack - * @param string $needle - * @param bool $beforeNeedle [optional] - * @return string|false Returns the portion of haystack, or false if needle is not found. + * {@inheritdoc} + * @param string $haystack + * @param string $needle + * @param bool $beforeNeedle [optional] */ function grapheme_strstr (string $haystack, string $needle, bool $beforeNeedle = false): string|false {} /** - * Returns part of haystack string from the first occurrence of case-insensitive needle to the end of haystack - * @link http://www.php.net/manual/en/function.grapheme-stristr.php - * @param string $haystack - * @param string $needle - * @param bool $beforeNeedle [optional] - * @return string|false Returns the portion of haystack, or false if needle is not found. + * {@inheritdoc} + * @param string $haystack + * @param string $needle + * @param bool $beforeNeedle [optional] */ function grapheme_stristr (string $haystack, string $needle, bool $beforeNeedle = false): string|false {} /** - * Function to extract a sequence of default grapheme clusters from a text buffer, which must be encoded in UTF-8 - * @link http://www.php.net/manual/en/function.grapheme-extract.php - * @param string $haystack - * @param int $size - * @param int $type [optional] - * @param int $offset [optional] - * @param int $next [optional] - * @return string|false A string starting at offset offset and ending on a default grapheme cluster - * boundary that conforms to the size and type specified, - * or false on failure. + * {@inheritdoc} + * @param string $haystack + * @param int $size + * @param int $type [optional] + * @param int $offset [optional] + * @param mixed $next [optional] */ -function grapheme_extract (string $haystack, int $size, int $type = GRAPHEME_EXTR_COUNT, int $offset = null, int &$next = null): string|false {} +function grapheme_extract (string $haystack, int $size, int $type = 0, int $offset = 0, &$next = NULL): string|false {} /** - * Convert domain name to IDNA ASCII form - * @link http://www.php.net/manual/en/function.idn-to-ascii.php - * @param string $domain - * @param int $flags [optional] - * @param int $variant [optional] - * @param array $idna_info [optional] - * @return string|false The domain name encoded in ASCII-compatible form, or false on failure + * {@inheritdoc} + * @param string $domain + * @param int $flags [optional] + * @param int $variant [optional] + * @param mixed $idna_info [optional] */ -function idn_to_ascii (string $domain, int $flags = IDNA_DEFAULT, int $variant = INTL_IDNA_VARIANT_UTS46, array &$idna_info = null): string|false {} +function idn_to_ascii (string $domain, int $flags = 0, int $variant = 1, &$idna_info = NULL): string|false {} /** - * Convert domain name from IDNA ASCII to Unicode - * @link http://www.php.net/manual/en/function.idn-to-utf8.php - * @param string $domain - * @param int $flags [optional] - * @param int $variant [optional] - * @param array $idna_info [optional] - * @return string|false The domain name in Unicode, encoded in UTF-8, or false on failure + * {@inheritdoc} + * @param string $domain + * @param int $flags [optional] + * @param int $variant [optional] + * @param mixed $idna_info [optional] */ -function idn_to_utf8 (string $domain, int $flags = IDNA_DEFAULT, int $variant = INTL_IDNA_VARIANT_UTS46, array &$idna_info = null): string|false {} +function idn_to_utf8 (string $domain, int $flags = 0, int $variant = 1, &$idna_info = NULL): string|false {} /** - * Gets the default locale value from the INTL global 'default_locale' - * @link http://www.php.net/manual/en/locale.getdefault.php - * @return string The current runtime locale + * {@inheritdoc} */ function locale_get_default (): string {} /** - * Sets the default runtime locale - * @link http://www.php.net/manual/en/locale.setdefault.php - * @param string $locale - * @return bool Returns true. + * {@inheritdoc} + * @param string $locale */ function locale_set_default (string $locale): bool {} /** - * Gets the primary language for the input locale - * @link http://www.php.net/manual/en/locale.getprimarylanguage.php - * @param string $locale - * @return string|null The language code associated with the language. - *>Returns null when the length of locale exceeds INTL_MAX_LOCALE_LEN.
+ * {@inheritdoc} + * @param string $locale */ function locale_get_primary_language (string $locale): ?string {} /** - * Gets the script for the input locale - * @link http://www.php.net/manual/en/locale.getscript.php - * @param string $locale - * @return string|null The script subtag for the locale or null if not present + * {@inheritdoc} + * @param string $locale */ function locale_get_script (string $locale): ?string {} /** - * Gets the region for the input locale - * @link http://www.php.net/manual/en/locale.getregion.php - * @param string $locale - * @return string|null The region subtag for the locale or null if not present - *>Returns null when the length of locale exceeds INTL_MAX_LOCALE_LEN.
+ * {@inheritdoc} + * @param string $locale */ function locale_get_region (string $locale): ?string {} /** - * Gets the keywords for the input locale - * @link http://www.php.net/manual/en/locale.getkeywords.php - * @param string $locale - * @return array|false|null Associative array containing the keyword-value pairs for this locale - *>Returns null when the length of locale exceeds INTL_MAX_LOCALE_LEN.
+ * {@inheritdoc} + * @param string $locale */ function locale_get_keywords (string $locale): array|false|null {} /** - * Returns an appropriately localized display name for script of the input locale - * @link http://www.php.net/manual/en/locale.getdisplayscript.php - * @param string $locale - * @param string|null $displayLocale [optional] - * @return string|false Display name of the script for the locale in the format appropriate for - * displayLocale, or false on failure. + * {@inheritdoc} + * @param string $locale + * @param string|null $displayLocale [optional] */ -function locale_get_display_script (string $locale, ?string $displayLocale = null): string|false {} +function locale_get_display_script (string $locale, ?string $displayLocale = NULL): string|false {} /** - * Returns an appropriately localized display name for region of the input locale - * @link http://www.php.net/manual/en/locale.getdisplayregion.php - * @param string $locale - * @param string|null $displayLocale [optional] - * @return string|false Display name of the region for the locale in the format appropriate for - * displayLocale, or false on failure. + * {@inheritdoc} + * @param string $locale + * @param string|null $displayLocale [optional] */ -function locale_get_display_region (string $locale, ?string $displayLocale = null): string|false {} +function locale_get_display_region (string $locale, ?string $displayLocale = NULL): string|false {} /** - * Returns an appropriately localized display name for the input locale - * @link http://www.php.net/manual/en/locale.getdisplayname.php - * @param string $locale - * @param string|null $displayLocale [optional] - * @return string|false Display name of the locale in the format appropriate for displayLocale, or false on failure. + * {@inheritdoc} + * @param string $locale + * @param string|null $displayLocale [optional] */ -function locale_get_display_name (string $locale, ?string $displayLocale = null): string|false {} +function locale_get_display_name (string $locale, ?string $displayLocale = NULL): string|false {} /** - * Returns an appropriately localized display name for language of the inputlocale - * @link http://www.php.net/manual/en/locale.getdisplaylanguage.php - * @param string $locale - * @param string|null $displayLocale [optional] - * @return string|false Display name of the language for the locale in the format appropriate for - * displayLocale, or false on failure. + * {@inheritdoc} + * @param string $locale + * @param string|null $displayLocale [optional] */ -function locale_get_display_language (string $locale, ?string $displayLocale = null): string|false {} +function locale_get_display_language (string $locale, ?string $displayLocale = NULL): string|false {} /** - * Returns an appropriately localized display name for variants of the input locale - * @link http://www.php.net/manual/en/locale.getdisplayvariant.php - * @param string $locale - * @param string|null $displayLocale [optional] - * @return string|false Display name of the variant for the locale in the format appropriate for - * displayLocale, or false on failure. + * {@inheritdoc} + * @param string $locale + * @param string|null $displayLocale [optional] */ -function locale_get_display_variant (string $locale, ?string $displayLocale = null): string|false {} +function locale_get_display_variant (string $locale, ?string $displayLocale = NULL): string|false {} /** - * Returns a correctly ordered and delimited locale ID - * @link http://www.php.net/manual/en/locale.composelocale.php - * @param array $subtags - * @return string|false The corresponding locale identifier, or false when subtags is empty. + * {@inheritdoc} + * @param array $subtags */ function locale_compose (array $subtags): string|false {} /** - * Returns a key-value array of locale ID subtag elements - * @link http://www.php.net/manual/en/locale.parselocale.php - * @param string $locale - * @return array|null Returns an array containing a list of key-value pairs, where the keys - * identify the particular locale ID subtags, and the values are the - * associated subtag values. The array will be ordered as the locale id - * subtags e.g. in the locale id if variants are '-varX-varY-varZ' then the - * returned array will have variant0=>varX , variant1=>varY , - * variant2=>varZ - *Returns null when the length of locale exceeds - * INTL_MAX_LOCALE_LEN.
+ * {@inheritdoc} + * @param string $locale */ function locale_parse (string $locale): ?array {} /** - * Gets the variants for the input locale - * @link http://www.php.net/manual/en/locale.getallvariants.php - * @param string $locale - * @return array|null Thenull if not present - *
>Returns null when the length of locale exceeds INTL_MAX_LOCALE_LEN.
+ * {@inheritdoc} + * @param string $locale */ function locale_get_all_variants (string $locale): ?array {} /** - * Checks if a language tag filter matches with locale - * @link http://www.php.net/manual/en/locale.filtermatches.php - * @param string $languageTag - * @param string $locale - * @param bool $canonicalize [optional] - * @return bool|null true if locale matches languageTag false otherwise. - *>Returns null when the length of locale exceeds INTL_MAX_LOCALE_LEN.
+ * {@inheritdoc} + * @param string $languageTag + * @param string $locale + * @param bool $canonicalize [optional] */ function locale_filter_matches (string $languageTag, string $locale, bool $canonicalize = false): ?bool {} /** - * Canonicalize the locale string - * @link http://www.php.net/manual/en/locale.canonicalize.php - * @param string $locale - * @return string|null Canonicalized locale string. - *>Returns null when the length of locale exceeds INTL_MAX_LOCALE_LEN.
+ * {@inheritdoc} + * @param string $locale */ function locale_canonicalize (string $locale): ?string {} /** - * Searches the language tag list for the best match to the language - * @link http://www.php.net/manual/en/locale.lookup.php - * @param array $languageTag - * @param string $locale - * @param bool $canonicalize [optional] - * @param string|null $defaultLocale [optional] - * @return string|null The closest matching language tag or default value. - *>Returns null when the length of locale exceeds INTL_MAX_LOCALE_LEN.
+ * {@inheritdoc} + * @param array $languageTag + * @param string $locale + * @param bool $canonicalize [optional] + * @param string|null $defaultLocale [optional] */ -function locale_lookup (array $languageTag, string $locale, bool $canonicalize = false, ?string $defaultLocale = null): ?string {} +function locale_lookup (array $languageTag, string $locale, bool $canonicalize = false, ?string $defaultLocale = NULL): ?string {} /** - * Tries to find out best available locale based on HTTP "Accept-Language" header - * @link http://www.php.net/manual/en/locale.acceptfromhttp.php - * @param string $header - * @return string|false The corresponding locale identifier. - *Returns false when the length of header exceeds - * INTL_MAX_LOCALE_LEN.
+ * {@inheritdoc} + * @param string $header */ function locale_accept_from_http (string $header): string|false {} /** - * Constructs a new Message Formatter - * @link http://www.php.net/manual/en/messageformatter.create.php - * @param string $locale - * @param string $pattern - * @return MessageFormatter|null The formatter object, or null on failure. + * {@inheritdoc} + * @param string $locale + * @param string $pattern */ function msgfmt_create (string $locale, string $pattern): ?MessageFormatter {} /** - * Format the message - * @link http://www.php.net/manual/en/messageformatter.format.php - * @param MessageFormatter $formatter - * @param array $values - * @return string|false The formatted string, or false if an error occurred + * {@inheritdoc} + * @param MessageFormatter $formatter + * @param array $values */ function msgfmt_format (MessageFormatter $formatter, array $values): string|false {} /** - * Quick format message - * @link http://www.php.net/manual/en/messageformatter.formatmessage.php - * @param string $locale - * @param string $pattern - * @param array $values - * @return string|false The formatted pattern string or false if an error occurred + * {@inheritdoc} + * @param string $locale + * @param string $pattern + * @param array $values */ function msgfmt_format_message (string $locale, string $pattern, array $values): string|false {} /** - * Parse input string according to pattern - * @link http://www.php.net/manual/en/messageformatter.parse.php - * @param MessageFormatter $formatter - * @param string $string - * @return array|false An array containing the items extracted, or false on error + * {@inheritdoc} + * @param MessageFormatter $formatter + * @param string $string */ function msgfmt_parse (MessageFormatter $formatter, string $string): array|false {} /** - * Quick parse input string - * @link http://www.php.net/manual/en/messageformatter.parsemessage.php - * @param string $locale - * @param string $pattern - * @param string $message - * @return array|false An array containing items extracted, or false on error + * {@inheritdoc} + * @param string $locale + * @param string $pattern + * @param string $message */ function msgfmt_parse_message (string $locale, string $pattern, string $message): array|false {} /** - * Set the pattern used by the formatter - * @link http://www.php.net/manual/en/messageformatter.setpattern.php - * @param MessageFormatter $formatter - * @param string $pattern - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param MessageFormatter $formatter + * @param string $pattern */ function msgfmt_set_pattern (MessageFormatter $formatter, string $pattern): bool {} /** - * Get the pattern used by the formatter - * @link http://www.php.net/manual/en/messageformatter.getpattern.php - * @param MessageFormatter $formatter - * @return string|false The pattern string for this message formatter, or false on failure. + * {@inheritdoc} + * @param MessageFormatter $formatter */ function msgfmt_get_pattern (MessageFormatter $formatter): string|false {} /** - * Get the locale for which the formatter was created - * @link http://www.php.net/manual/en/messageformatter.getlocale.php - * @param MessageFormatter $formatter - * @return string The locale name + * {@inheritdoc} + * @param MessageFormatter $formatter */ function msgfmt_get_locale (MessageFormatter $formatter): string {} /** - * Get the error code from last operation - * @link http://www.php.net/manual/en/messageformatter.geterrorcode.php - * @param MessageFormatter $formatter - * @return int The error code, one of UErrorCode values. Initial value is U_ZERO_ERROR. + * {@inheritdoc} + * @param MessageFormatter $formatter */ function msgfmt_get_error_code (MessageFormatter $formatter): int {} /** - * Get the error text from the last operation - * @link http://www.php.net/manual/en/messageformatter.geterrormessage.php - * @param MessageFormatter $formatter - * @return string Description of the last error. + * {@inheritdoc} + * @param MessageFormatter $formatter */ function msgfmt_get_error_message (MessageFormatter $formatter): string {} /** - * Normalizes the input provided and returns the normalized string - * @link http://www.php.net/manual/en/normalizer.normalize.php - * @param string $string - * @param int $form [optional] - * @return string|false The normalized string or false if an error occurred. + * {@inheritdoc} + * @param string $string + * @param int $form [optional] */ -function normalizer_normalize (string $string, int $form = \Normalizer::FORM_C): string|false {} +function normalizer_normalize (string $string, int $form = 16): string|false {} /** - * Checks if the provided string is already in the specified normalization - * form - * @link http://www.php.net/manual/en/normalizer.isnormalized.php - * @param string $string - * @param int $form [optional] - * @return bool true if normalized, false otherwise or if there an error + * {@inheritdoc} + * @param string $string + * @param int $form [optional] */ -function normalizer_is_normalized (string $string, int $form = \Normalizer::FORM_C): bool {} +function normalizer_is_normalized (string $string, int $form = 16): bool {} /** - * Gets the Decomposition_Mapping property for the given UTF-8 encoded code point - * @link http://www.php.net/manual/en/normalizer.getrawdecomposition.php - * @param string $string The input string, which should be a single, UTF-8 encoded, code point. - * @param int $form [optional] - * @return string|null Returns a string containing the Decomposition_Mapping property, if present in the UCD. - *Returns null if there is no Decomposition_Mapping property for the character.
+ * {@inheritdoc} + * @param string $string + * @param int $form [optional] */ -function normalizer_get_raw_decomposition (string $string, int $form = \Normalizer::FORM_C): ?string {} +function normalizer_get_raw_decomposition (string $string, int $form = 16): ?string {} /** - * Create a resource bundle - * @link http://www.php.net/manual/en/resourcebundle.create.php - * @param string|null $locale - * @param string|null $bundle - * @param bool $fallback [optional] - * @return ResourceBundle|null Returns ResourceBundle object or null on error. + * {@inheritdoc} + * @param string|null $locale + * @param string|null $bundle + * @param bool $fallback [optional] */ -function resourcebundle_create (?string $locale, ?string $bundle, bool $fallback = true): ?ResourceBundle {} +function resourcebundle_create (?string $locale = null, ?string $bundle = null, bool $fallback = true): ?ResourceBundle {} /** - * Get data from the bundle - * @link http://www.php.net/manual/en/resourcebundle.get.php - * @param ResourceBundle $bundle - * @param string|int $index - * @param bool $fallback [optional] - * @return mixed Returns the data located at the index or null on error. Strings, integers and binary data strings - * are returned as corresponding PHP types, integer array is returned as PHP array. Complex types are - * returned as ResourceBundle object. + * {@inheritdoc} + * @param ResourceBundle $bundle + * @param mixed $index + * @param bool $fallback [optional] */ -function resourcebundle_get (ResourceBundle $bundle, string|int $index, bool $fallback = true): mixed {} +function resourcebundle_get (ResourceBundle $bundle, $index = null, bool $fallback = true): mixed {} /** - * Get number of elements in the bundle - * @link http://www.php.net/manual/en/resourcebundle.count.php - * @param ResourceBundle $bundle - * @return int Returns number of elements in the bundle. + * {@inheritdoc} + * @param ResourceBundle $bundle */ function resourcebundle_count (ResourceBundle $bundle): int {} /** - * Get supported locales - * @link http://www.php.net/manual/en/resourcebundle.locales.php - * @param string $bundle - * @return array|false Returns the list of locales supported by the bundle, or false on failure. + * {@inheritdoc} + * @param string $bundle */ function resourcebundle_locales (string $bundle): array|false {} /** - * Get bundle's last error code - * @link http://www.php.net/manual/en/resourcebundle.geterrorcode.php - * @param ResourceBundle $bundle - * @return int Returns error code from last bundle object call. + * {@inheritdoc} + * @param ResourceBundle $bundle */ function resourcebundle_get_error_code (ResourceBundle $bundle): int {} /** - * Get bundle's last error message - * @link http://www.php.net/manual/en/resourcebundle.geterrormessage.php - * @param ResourceBundle $bundle - * @return string Returns error message from last bundle object's call. + * {@inheritdoc} + * @param ResourceBundle $bundle */ function resourcebundle_get_error_message (ResourceBundle $bundle): string {} /** - * Get the number of IDs in the equivalency group that includes the given ID - * @link http://www.php.net/manual/en/intltimezone.countequivalentids.php - * @param string $timezoneId - * @return int|false + * {@inheritdoc} + * @param string $timezoneId */ function intltz_count_equivalent_ids (string $timezoneId): int|false {} /** - * Create a new copy of the default timezone for this host - * @link http://www.php.net/manual/en/intltimezone.createdefault.php - * @return IntlTimeZone + * {@inheritdoc} */ function intltz_create_default (): IntlTimeZone {} /** - * Get an enumeration over time zone IDs associated with the - * given country or offset - * @link http://www.php.net/manual/en/intltimezone.createenumeration.php - * @param IntlTimeZone|string|int|float|null $countryOrRawOffset [optional] - * @return IntlIterator|false + * {@inheritdoc} + * @param mixed $countryOrRawOffset [optional] */ -function intltz_create_enumeration (IntlTimeZone|string|int|float|null $countryOrRawOffset = null): IntlIterator|false {} +function intltz_create_enumeration ($countryOrRawOffset = NULL): IntlIterator|false {} /** - * Create a timezone object for the given ID - * @link http://www.php.net/manual/en/intltimezone.createtimezone.php - * @param string $timezoneId - * @return IntlTimeZone|null + * {@inheritdoc} + * @param string $timezoneId */ function intltz_create_time_zone (string $timezoneId): ?IntlTimeZone {} /** - * Get an enumeration over system time zone IDs with the given filter conditions - * @link http://www.php.net/manual/en/intltimezone.createtimezoneidenumeration.php - * @param int $type - * @param string|null $region [optional] - * @param int|null $rawOffset [optional] - * @return IntlIterator|false Returns IntlIterator or false on failure. + * {@inheritdoc} + * @param int $type + * @param string|null $region [optional] + * @param int|null $rawOffset [optional] */ -function intltz_create_time_zone_id_enumeration (int $type, ?string $region = null, ?int $rawOffset = null): IntlIterator|false {} +function intltz_create_time_zone_id_enumeration (int $type, ?string $region = NULL, ?int $rawOffset = NULL): IntlIterator|false {} /** - * Create a timezone object from DateTimeZone - * @link http://www.php.net/manual/en/intltimezone.fromdatetimezone.php - * @param DateTimeZone $timezone - * @return IntlTimeZone|null + * {@inheritdoc} + * @param DateTimeZone $timezone */ function intltz_from_date_time_zone (DateTimeZone $timezone): ?IntlTimeZone {} /** - * Get the canonical system timezone ID or the normalized custom time zone ID for the given time zone ID - * @link http://www.php.net/manual/en/intltimezone.getcanonicalid.php - * @param string $timezoneId - * @param bool $isSystemId [optional] - * @return string|false + * {@inheritdoc} + * @param string $timezoneId + * @param mixed $isSystemId [optional] */ -function intltz_get_canonical_id (string $timezoneId, bool &$isSystemId = null): string|false {} +function intltz_get_canonical_id (string $timezoneId, &$isSystemId = NULL): string|false {} /** - * Get a name of this time zone suitable for presentation to the user - * @link http://www.php.net/manual/en/intltimezone.getdisplayname.php - * @param IntlTimeZone $timezone - * @param bool $dst [optional] - * @param int $style [optional] - * @param string|null $locale [optional] - * @return string|false + * {@inheritdoc} + * @param IntlTimeZone $timezone + * @param bool $dst [optional] + * @param int $style [optional] + * @param string|null $locale [optional] */ -function intltz_get_display_name (IntlTimeZone $timezone, bool $dst = false, int $style = \IntlTimeZone::DISPLAY_LONG, ?string $locale = null): string|false {} +function intltz_get_display_name (IntlTimeZone $timezone, bool $dst = false, int $style = 2, ?string $locale = NULL): string|false {} /** - * Get the amount of time to be added to local standard time to get local wall clock time - * @link http://www.php.net/manual/en/intltimezone.getdstsavings.php - * @param IntlTimeZone $timezone - * @return int + * {@inheritdoc} + * @param IntlTimeZone $timezone */ function intltz_get_dst_savings (IntlTimeZone $timezone): int {} /** - * Get an ID in the equivalency group that includes the given ID - * @link http://www.php.net/manual/en/intltimezone.getequivalentid.php - * @param string $timezoneId - * @param int $offset - * @return string|false + * {@inheritdoc} + * @param string $timezoneId + * @param int $offset */ function intltz_get_equivalent_id (string $timezoneId, int $offset): string|false {} /** - * Get last error code on the object - * @link http://www.php.net/manual/en/intltimezone.geterrorcode.php - * @param IntlTimeZone $timezone - * @return int|false + * {@inheritdoc} + * @param IntlTimeZone $timezone */ function intltz_get_error_code (IntlTimeZone $timezone): int|false {} /** - * Get last error message on the object - * @link http://www.php.net/manual/en/intltimezone.geterrormessage.php - * @param IntlTimeZone $timezone - * @return string|false + * {@inheritdoc} + * @param IntlTimeZone $timezone */ function intltz_get_error_message (IntlTimeZone $timezone): string|false {} /** - * Create GMT (UTC) timezone - * @link http://www.php.net/manual/en/intltimezone.getgmt.php - * @return IntlTimeZone + * {@inheritdoc} */ function intltz_get_gmt (): IntlTimeZone {} /** - * Get timezone ID - * @link http://www.php.net/manual/en/intltimezone.getid.php - * @param IntlTimeZone $timezone - * @return string|false + * {@inheritdoc} + * @param IntlTimeZone $timezone */ function intltz_get_id (IntlTimeZone $timezone): string|false {} /** - * Get the time zone raw and GMT offset for the given moment in time - * @link http://www.php.net/manual/en/intltimezone.getoffset.php - * @param IntlTimeZone $timezone - * @param float $timestamp - * @param bool $local - * @param int $rawOffset - * @param int $dstOffset - * @return bool + * {@inheritdoc} + * @param IntlTimeZone $timezone + * @param float $timestamp + * @param bool $local + * @param mixed $rawOffset + * @param mixed $dstOffset */ -function intltz_get_offset (IntlTimeZone $timezone, float $timestamp, bool $local, int &$rawOffset, int &$dstOffset): bool {} +function intltz_get_offset (IntlTimeZone $timezone, float $timestamp, bool $local, &$rawOffset = null, &$dstOffset = null): bool {} /** - * Get the raw GMT offset (before taking daylight savings time into account - * @link http://www.php.net/manual/en/intltimezone.getrawoffset.php - * @param IntlTimeZone $timezone - * @return int + * {@inheritdoc} + * @param IntlTimeZone $timezone */ function intltz_get_raw_offset (IntlTimeZone $timezone): int {} /** - * Get the region code associated with the given system time zone ID - * @link http://www.php.net/manual/en/intltimezone.getregion.php - * @param string $timezoneId - * @return string|false Return region or false on failure. + * {@inheritdoc} + * @param string $timezoneId */ function intltz_get_region (string $timezoneId): string|false {} /** - * Get the timezone data version currently used by ICU - * @link http://www.php.net/manual/en/intltimezone.gettzdataversion.php - * @return string|false + * {@inheritdoc} */ function intltz_get_tz_data_version (): string|false {} /** - * Get the "unknown" time zone - * @link http://www.php.net/manual/en/intltimezone.getunknown.php - * @return IntlTimeZone Returns IntlTimeZone or null on failure. + * {@inheritdoc} */ function intltz_get_unknown (): IntlTimeZone {} /** - * Translate a system timezone into a Windows timezone - * @link http://www.php.net/manual/en/intltimezone.getwindowsid.php - * @param string $timezoneId - * @return string|false Returns the Windows timezone or false on failure. + * {@inheritdoc} + * @param string $timezoneId */ function intltz_get_windows_id (string $timezoneId): string|false {} /** - * Translate a Windows timezone into a system timezone - * @link http://www.php.net/manual/en/intltimezone.getidforwindowsid.php - * @param string $timezoneId - * @param string|null $region [optional] - * @return string|false Returns the system timezone or false on failure. + * {@inheritdoc} + * @param string $timezoneId + * @param string|null $region [optional] */ -function intltz_get_id_for_windows_id (string $timezoneId, ?string $region = null): string|false {} +function intltz_get_id_for_windows_id (string $timezoneId, ?string $region = NULL): string|false {} /** - * Check if this zone has the same rules and offset as another zone - * @link http://www.php.net/manual/en/intltimezone.hassamerules.php - * @param IntlTimeZone $timezone - * @param IntlTimeZone $other - * @return bool + * {@inheritdoc} + * @param IntlTimeZone $timezone + * @param IntlTimeZone $other */ function intltz_has_same_rules (IntlTimeZone $timezone, IntlTimeZone $other): bool {} /** - * Convert to DateTimeZone object - * @link http://www.php.net/manual/en/intltimezone.todatetimezone.php - * @param IntlTimeZone $timezone - * @return DateTimeZone|false + * {@inheritdoc} + * @param IntlTimeZone $timezone */ function intltz_to_date_time_zone (IntlTimeZone $timezone): DateTimeZone|false {} /** - * Check if this time zone uses daylight savings time - * @link http://www.php.net/manual/en/intltimezone.usedaylighttime.php - * @param IntlTimeZone $timezone - * @return bool + * {@inheritdoc} + * @param IntlTimeZone $timezone */ function intltz_use_daylight_time (IntlTimeZone $timezone): bool {} /** - * Create a transliterator - * @link http://www.php.net/manual/en/transliterator.create.php - * @param string $id The ID. A list of all registered transliterator IDs can be retrieved by using - * Transliterator::listIDs. - * @param int $direction [optional] The direction, defaults to - * Transliterator::FORWARD. - * May also be set to - * Transliterator::REVERSE. - * @return Transliterator|null Returns a Transliterator object on success, - * or null on failure. + * {@inheritdoc} + * @param string $id + * @param int $direction [optional] */ -function transliterator_create (string $id, int $direction = \Transliterator::FORWARD): ?Transliterator {} +function transliterator_create (string $id, int $direction = 0): ?Transliterator {} /** - * Create transliterator from rules - * @link http://www.php.net/manual/en/transliterator.createfromrules.php - * @param string $rules The rules as defined in Transform Rules Syntax of UTS #35: Unicode LDML. - * @param int $direction [optional] The direction, defaults to - * Transliterator::FORWARD. - * May also be set to - * Transliterator::REVERSE. - * @return Transliterator|null Returns a Transliterator object on success, - * or null on failure. + * {@inheritdoc} + * @param string $rules + * @param int $direction [optional] */ -function transliterator_create_from_rules (string $rules, int $direction = \Transliterator::FORWARD): ?Transliterator {} +function transliterator_create_from_rules (string $rules, int $direction = 0): ?Transliterator {} /** - * Get transliterator IDs - * @link http://www.php.net/manual/en/transliterator.listids.php - * @return array|false An array of registered transliterator IDs on success, - * or false on failure. + * {@inheritdoc} */ function transliterator_list_ids (): array|false {} /** - * Create an inverse transliterator - * @link http://www.php.net/manual/en/transliterator.createinverse.php - * @param Transliterator $transliterator - * @return Transliterator|null Returns a Transliterator object on success, - * or null on failure + * {@inheritdoc} + * @param Transliterator $transliterator */ function transliterator_create_inverse (Transliterator $transliterator): ?Transliterator {} /** - * Transliterate a string - * @link http://www.php.net/manual/en/transliterator.transliterate.php - * @param Transliterator|string $transliterator In the procedural version, either a Transliterator - * or a string from which a - * Transliterator can be built. - * @param string $string The string to be transformed. - * @param int $start [optional] The start index (in UTF-16 code units) from which the string will start - * to be transformed, inclusive. Indexing starts at 0. The text before will - * be left as is. - * @param int $end [optional] The end index (in UTF-16 code units) until which the string will be - * transformed, exclusive. Indexing starts at 0. The text after will be - * left as is. - * @return string|false The transformed string on success, or false on failure. + * {@inheritdoc} + * @param Transliterator|string $transliterator + * @param string $string + * @param int $start [optional] + * @param int $end [optional] */ -function transliterator_transliterate (Transliterator|string $transliterator, string $string, int $start = null, int $end = -1): string|false {} +function transliterator_transliterate (Transliterator|string $transliterator, string $string, int $start = 0, int $end = -1): string|false {} /** - * Get last error code - * @link http://www.php.net/manual/en/transliterator.geterrorcode.php - * @param Transliterator $transliterator - * @return int|false The error code on success, - * or false if none exists, or on failure. + * {@inheritdoc} + * @param Transliterator $transliterator */ function transliterator_get_error_code (Transliterator $transliterator): int|false {} /** - * Get last error message - * @link http://www.php.net/manual/en/transliterator.geterrormessage.php - * @param Transliterator $transliterator - * @return string|false The error message on success, - * or false if none exists, or on failure. + * {@inheritdoc} + * @param Transliterator $transliterator */ function transliterator_get_error_message (Transliterator $transliterator): string|false {} - -/** - * Limit on locale length, set to 80 in PHP code. Locale names longer - * than this limit will not be accepted. - * @link http://www.php.net/manual/en/intl.constants.php - * @var int - */ define ('INTL_MAX_LOCALE_LEN', 156); - -/** - * The current ICU library version as a dotted-decimal string. - * @link http://www.php.net/manual/en/intl.constants.php - * @var string - */ -define ('INTL_ICU_VERSION', 72.1); -define ('INTL_ICU_DATA_VERSION', 72.1); +define ('INTL_ICU_VERSION', 73.2); +define ('INTL_ICU_DATA_VERSION', 73.2); define ('GRAPHEME_EXTR_COUNT', 0); define ('GRAPHEME_EXTR_MAXBYTES', 1); define ('GRAPHEME_EXTR_MAXCHARS', 2); - -/** - * Prohibit processing of unassigned codepoints in the input for IDN - * functions and do not check if the input conforms to domain name ASCII rules. - * @link http://www.php.net/manual/en/intl.constants.php - * @var int - */ define ('IDNA_DEFAULT', 0); - -/** - * Allow processing of unassigned codepoints in the input for IDN functions. - * @link http://www.php.net/manual/en/intl.constants.php - * @var int - */ define ('IDNA_ALLOW_UNASSIGNED', 1); - -/** - * Check if the input for IDN functions conforms to domain name ASCII rules. - * @link http://www.php.net/manual/en/intl.constants.php - * @var int - */ define ('IDNA_USE_STD3_RULES', 2); - -/** - * Check whether the input conforms to the BiDi rules. - * Ignored by the IDNA2003 implementation, which always performs this check. - * @link http://www.php.net/manual/en/intl.constants.php - * @var int - */ define ('IDNA_CHECK_BIDI', 4); - -/** - * Check whether the input conforms to the CONTEXTJ rules. - * Ignored by the IDNA2003 implementation, as this check is new in IDNA2008. - * @link http://www.php.net/manual/en/intl.constants.php - * @var int - */ define ('IDNA_CHECK_CONTEXTJ', 8); - -/** - * Option for nontransitional processing in - * idn_to_ascii. Transitional processing is activated - * by default. This option is ignored by the IDNA2003 implementation. - * @link http://www.php.net/manual/en/intl.constants.php - * @var int - */ define ('IDNA_NONTRANSITIONAL_TO_ASCII', 16); - -/** - * Option for nontransitional processing in - * idn_to_utf8. Transitional processing is activated - * by default. This option is ignored by the IDNA2003 implementation. - * @link http://www.php.net/manual/en/intl.constants.php - * @var int - */ define ('IDNA_NONTRANSITIONAL_TO_UNICODE', 32); - -/** - * Use UTS #46 algorithm in idn_to_utf8 and - * idn_to_ascii. - * Available as of ICU 4.6. - * @link http://www.php.net/manual/en/intl.constants.php - * @var int - */ define ('INTL_IDNA_VARIANT_UTS46', 1); - -/** - * Errors reported in a bitset returned by the UTS #46 algorithm in - * idn_to_utf8 and - * idn_to_ascii. - * @link http://www.php.net/manual/en/intl.constants.php - * @var int - */ define ('IDNA_ERROR_EMPTY_LABEL', 1); define ('IDNA_ERROR_LABEL_TOO_LONG', 2); define ('IDNA_ERROR_DOMAIN_NAME_TOO_LONG', 4); @@ -7490,4 +4960,4 @@ function transliterator_get_error_message (Transliterator $transliterator): stri define ('U_STRINGPREP_CHECK_BIDI_ERROR', 66562); define ('U_ERROR_LIMIT', 66818); -// End of intl v.8.2.6 +// End of intl v.8.3.0 diff --git a/plugins/org.eclipse.php.core/Resources/language/php8.3/json.php b/plugins/org.eclipse.php.core/Resources/language/php8.3/json.php index 6a46210034..ce5b882c29 100644 --- a/plugins/org.eclipse.php.core/Resources/language/php8.3/json.php +++ b/plugins/org.eclipse.php.core/Resources/language/php8.3/json.php @@ -1,43 +1,25 @@ If no argument is specified then the LDAP\Connection instance of the already - * opened connection will be returned. + * {@inheritdoc} + * @param string|null $uri [optional] + * @param int $port [optional] */ -function ldap_connect (?string $uri = null): LDAP\Connection|false {} +function ldap_connect (?string $uri = NULL, int $port = 389): LDAP\Connection|false {} /** - * Unbind from LDAP directory - * @link http://www.php.net/manual/en/function.ldap-unbind.php - * @param LDAP\Connection $ldap - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param LDAP\Connection $ldap */ function ldap_unbind (LDAP\Connection $ldap): bool {} /** - * Alias of ldap_unbind - * @link http://www.php.net/manual/en/function.ldap-close.php - * @param LDAP\Connection $ldap - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param LDAP\Connection $ldap */ function ldap_close (LDAP\Connection $ldap): bool {} /** - * Bind to LDAP directory - * @link http://www.php.net/manual/en/function.ldap-bind.php - * @param LDAP\Connection $ldap - * @param string|null $dn [optional] - * @param string|null $password [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param LDAP\Connection $ldap + * @param string|null $dn [optional] + * @param string|null $password [optional] */ -function ldap_bind (LDAP\Connection $ldap, ?string $dn = null, ?string $password = null): bool {} +function ldap_bind (LDAP\Connection $ldap, ?string $dn = NULL, ?string $password = NULL): bool {} /** - * Bind to LDAP directory - * @link http://www.php.net/manual/en/function.ldap-bind-ext.php - * @param LDAP\Connection $ldap - * @param string|null $dn [optional] - * @param string|null $password [optional] - * @param array|null $controls [optional] - * @return LDAP\Result|false Returns an LDAP\Result instance, or false on failure. + * {@inheritdoc} + * @param LDAP\Connection $ldap + * @param string|null $dn [optional] + * @param string|null $password [optional] + * @param array|null $controls [optional] */ -function ldap_bind_ext (LDAP\Connection $ldap, ?string $dn = null, ?string $password = null, ?array $controls = null): LDAP\Result|false {} +function ldap_bind_ext (LDAP\Connection $ldap, ?string $dn = NULL, ?string $password = NULL, ?array $controls = NULL): LDAP\Result|false {} /** - * Bind to LDAP directory using SASL - * @link http://www.php.net/manual/en/function.ldap-sasl-bind.php - * @param LDAP\Connection $ldap - * @param string|null $dn [optional] - * @param string|null $password [optional] - * @param string|null $mech [optional] - * @param string|null $realm [optional] - * @param string|null $authc_id [optional] - * @param string|null $authz_id [optional] - * @param string|null $props [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param LDAP\Connection $ldap + * @param string|null $dn [optional] + * @param string|null $password [optional] + * @param string|null $mech [optional] + * @param string|null $realm [optional] + * @param string|null $authc_id [optional] + * @param string|null $authz_id [optional] + * @param string|null $props [optional] */ -function ldap_sasl_bind (LDAP\Connection $ldap, ?string $dn = null, ?string $password = null, ?string $mech = null, ?string $realm = null, ?string $authc_id = null, ?string $authz_id = null, ?string $props = null): bool {} +function ldap_sasl_bind (LDAP\Connection $ldap, ?string $dn = NULL, ?string $password = NULL, ?string $mech = NULL, ?string $realm = NULL, ?string $authc_id = NULL, ?string $authz_id = NULL, ?string $props = NULL): bool {} /** - * Read an entry - * @link http://www.php.net/manual/en/function.ldap-read.php - * @param LDAP\Connection|array $ldap - * @param array|string $base - * @param array|string $filter - * @param array $attributes [optional] - * @param int $attributes_only [optional] - * @param int $sizelimit [optional] - * @param int $timelimit [optional] - * @param int $deref [optional] - * @param array|null $controls [optional] - * @return LDAP\Result|array|false Returns an LDAP\Result instance, an array of LDAP\Result instances, or false on failure. + * {@inheritdoc} + * @param mixed $ldap + * @param array|string $base + * @param array|string $filter + * @param array $attributes [optional] + * @param int $attributes_only [optional] + * @param int $sizelimit [optional] + * @param int $timelimit [optional] + * @param int $deref [optional] + * @param array|null $controls [optional] */ -function ldap_read (LDAP\Connection|array $ldap, array|string $base, array|string $filter, array $attributes = '[]', int $attributes_only = null, int $sizelimit = -1, int $timelimit = -1, int $deref = LDAP_DEREF_NEVER, ?array $controls = null): LDAP\Result|array|false {} +function ldap_read ($ldap = null, array|string $base, array|string $filter, array $attributes = array ( +), int $attributes_only = 0, int $sizelimit = -1, int $timelimit = -1, int $deref = 0, ?array $controls = NULL): LDAP\Result|array|false {} /** - * Single-level search - * @link http://www.php.net/manual/en/function.ldap-list.php - * @param LDAP\Connection|array $ldap - * @param array|string $base - * @param array|string $filter - * @param array $attributes [optional] - * @param int $attributes_only [optional] - * @param int $sizelimit [optional] - * @param int $timelimit [optional] - * @param int $deref [optional] - * @param array|null $controls [optional] - * @return LDAP\Result|array|false Returns an LDAP\Result instance, an array of LDAP\Result instances, or false on failure. + * {@inheritdoc} + * @param mixed $ldap + * @param array|string $base + * @param array|string $filter + * @param array $attributes [optional] + * @param int $attributes_only [optional] + * @param int $sizelimit [optional] + * @param int $timelimit [optional] + * @param int $deref [optional] + * @param array|null $controls [optional] */ -function ldap_list (LDAP\Connection|array $ldap, array|string $base, array|string $filter, array $attributes = '[]', int $attributes_only = null, int $sizelimit = -1, int $timelimit = -1, int $deref = LDAP_DEREF_NEVER, ?array $controls = null): LDAP\Result|array|false {} +function ldap_list ($ldap = null, array|string $base, array|string $filter, array $attributes = array ( +), int $attributes_only = 0, int $sizelimit = -1, int $timelimit = -1, int $deref = 0, ?array $controls = NULL): LDAP\Result|array|false {} /** - * Search LDAP tree - * @link http://www.php.net/manual/en/function.ldap-search.php - * @param LDAP\Connection|array $ldap - * @param array|string $base - * @param array|string $filter - * @param array $attributes [optional] - * @param int $attributes_only [optional] - * @param int $sizelimit [optional] - * @param int $timelimit [optional] - * @param int $deref [optional] - * @param array|null $controls [optional] - * @return LDAP\Result|array|false Returns an LDAP\Result instance, an array of LDAP\Result instances, or false on failure. + * {@inheritdoc} + * @param mixed $ldap + * @param array|string $base + * @param array|string $filter + * @param array $attributes [optional] + * @param int $attributes_only [optional] + * @param int $sizelimit [optional] + * @param int $timelimit [optional] + * @param int $deref [optional] + * @param array|null $controls [optional] */ -function ldap_search (LDAP\Connection|array $ldap, array|string $base, array|string $filter, array $attributes = '[]', int $attributes_only = null, int $sizelimit = -1, int $timelimit = -1, int $deref = LDAP_DEREF_NEVER, ?array $controls = null): LDAP\Result|array|false {} +function ldap_search ($ldap = null, array|string $base, array|string $filter, array $attributes = array ( +), int $attributes_only = 0, int $sizelimit = -1, int $timelimit = -1, int $deref = 0, ?array $controls = NULL): LDAP\Result|array|false {} /** - * Free result memory - * @link http://www.php.net/manual/en/function.ldap-free-result.php - * @param LDAP\Result $result - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param LDAP\Result $result */ function ldap_free_result (LDAP\Result $result): bool {} /** - * Count the number of entries in a search - * @link http://www.php.net/manual/en/function.ldap-count-entries.php - * @param LDAP\Connection $ldap - * @param LDAP\Result $result - * @return int Returns number of entries in the result, or false on failure. + * {@inheritdoc} + * @param LDAP\Connection $ldap + * @param LDAP\Result $result */ function ldap_count_entries (LDAP\Connection $ldap, LDAP\Result $result): int {} /** - * Return first result id - * @link http://www.php.net/manual/en/function.ldap-first-entry.php - * @param LDAP\Connection $ldap - * @param LDAP\Result $result - * @return LDAP\ResultEntry|false Returns an LDAP\ResultEntry instance, or false on failure. + * {@inheritdoc} + * @param LDAP\Connection $ldap + * @param LDAP\Result $result */ function ldap_first_entry (LDAP\Connection $ldap, LDAP\Result $result): LDAP\ResultEntry|false {} /** - * Get next result entry - * @link http://www.php.net/manual/en/function.ldap-next-entry.php - * @param LDAP\Connection $ldap - * @param LDAP\ResultEntry $entry - * @return LDAP\ResultEntry|false Returns an LDAP\ResultEntry instance for the next entry in the result whose entries - * are being read starting with ldap_first_entry. If - * there are no more entries in the result then it returns false. + * {@inheritdoc} + * @param LDAP\Connection $ldap + * @param LDAP\ResultEntry $entry */ function ldap_next_entry (LDAP\Connection $ldap, LDAP\ResultEntry $entry): LDAP\ResultEntry|false {} /** - * Get all result entries - * @link http://www.php.net/manual/en/function.ldap-get-entries.php - * @param LDAP\Connection $ldap - * @param LDAP\Result $result - * @return array|false Returns a complete result information in a multi-dimensional array on - * success, or false on failure. - *The structure of the array is as follows. - * The attribute index is converted to lowercase. (Attributes are - * case-insensitive for directory servers, but not when used as - * array indices.) - *
- * return_value["count"] = number of entries in the result - * return_value[0] : refers to the details of first entry - * return_value[i]["dn"] = DN of the ith entry in the result - * return_value[i]["count"] = number of attributes in ith entry - * return_value[i][j] = NAME of the jth attribute in the ith entry in the result - * return_value[i]["attribute"]["count"] = number of values for - * attribute in ith entry - * return_value[i]["attribute"][j] = jth value of attribute in ith entry - *+ * {@inheritdoc} + * @param LDAP\Connection $ldap + * @param LDAP\Result $result */ function ldap_get_entries (LDAP\Connection $ldap, LDAP\Result $result): array|false {} /** - * Return first attribute - * @link http://www.php.net/manual/en/function.ldap-first-attribute.php - * @param LDAP\Connection $ldap - * @param LDAP\ResultEntry $entry - * @return string|false Returns the first attribute in the entry on success and false on - * error. + * {@inheritdoc} + * @param LDAP\Connection $ldap + * @param LDAP\ResultEntry $entry */ function ldap_first_attribute (LDAP\Connection $ldap, LDAP\ResultEntry $entry): string|false {} /** - * Get the next attribute in result - * @link http://www.php.net/manual/en/function.ldap-next-attribute.php - * @param LDAP\Connection $ldap - * @param LDAP\ResultEntry $entry - * @return string|false Returns the next attribute in an entry on success and false on - * error. + * {@inheritdoc} + * @param LDAP\Connection $ldap + * @param LDAP\ResultEntry $entry */ function ldap_next_attribute (LDAP\Connection $ldap, LDAP\ResultEntry $entry): string|false {} /** - * Get attributes from a search result entry - * @link http://www.php.net/manual/en/function.ldap-get-attributes.php - * @param LDAP\Connection $ldap - * @param LDAP\ResultEntry $entry - * @return array Returns a complete entry information in a multi-dimensional array. + * {@inheritdoc} + * @param LDAP\Connection $ldap + * @param LDAP\ResultEntry $entry */ function ldap_get_attributes (LDAP\Connection $ldap, LDAP\ResultEntry $entry): array {} /** - * Get all binary values from a result entry - * @link http://www.php.net/manual/en/function.ldap-get-values-len.php - * @param LDAP\Connection $ldap - * @param LDAP\ResultEntry $entry - * @param string $attribute - * @return array|false Returns an array of values for the attribute on success and false on - * error. Individual values are accessed by integer index in the array. The - * first index is 0. The number of values can be found by indexing "count" - * in the resultant array. + * {@inheritdoc} + * @param LDAP\Connection $ldap + * @param LDAP\ResultEntry $entry + * @param string $attribute */ function ldap_get_values_len (LDAP\Connection $ldap, LDAP\ResultEntry $entry, string $attribute): array|false {} /** - * Get all values from a result entry - * @link http://www.php.net/manual/en/function.ldap-get-values.php - * @param LDAP\Connection $ldap - * @param LDAP\ResultEntry $entry - * @param string $attribute - * @return array|false Returns an array of values for the attribute on success and false on - * error. The number of values can be found by indexing "count" in the - * resultant array. Individual values are accessed by integer index in the - * array. The first index is 0. - *
LDAP allows more than one entry for an attribute, so it can, for example, - * store a number of email addresses for one person's directory entry all - * labeled with the attribute "mail" - * return_value["count"] = number of values for attribute - * return_value[0] = first value of attribute - * return_value[i] = ith value of attribute
+ * {@inheritdoc} + * @param LDAP\Connection $ldap + * @param LDAP\ResultEntry $entry + * @param string $attribute */ function ldap_get_values (LDAP\Connection $ldap, LDAP\ResultEntry $entry, string $attribute): array|false {} /** - * Get the DN of a result entry - * @link http://www.php.net/manual/en/function.ldap-get-dn.php - * @param LDAP\Connection $ldap - * @param LDAP\ResultEntry $entry - * @return string|false Returns the DN of the result entry and false on error. + * {@inheritdoc} + * @param LDAP\Connection $ldap + * @param LDAP\ResultEntry $entry */ function ldap_get_dn (LDAP\Connection $ldap, LDAP\ResultEntry $entry): string|false {} /** - * Splits DN into its component parts - * @link http://www.php.net/manual/en/function.ldap-explode-dn.php - * @param string $dn - * @param int $with_attrib - * @return array|false Returns an array of all DN components, or false on failure. - * The first element in the array has count key and - * represents the number of returned values, next elements are numerically - * indexed DN components. + * {@inheritdoc} + * @param string $dn + * @param int $with_attrib */ function ldap_explode_dn (string $dn, int $with_attrib): array|false {} /** - * Convert DN to User Friendly Naming format - * @link http://www.php.net/manual/en/function.ldap-dn2ufn.php - * @param string $dn - * @return string|false Returns the user friendly name, or false on failure. + * {@inheritdoc} + * @param string $dn */ function ldap_dn2ufn (string $dn): string|false {} /** - * Add entries to LDAP directory - * @link http://www.php.net/manual/en/function.ldap-add.php - * @param LDAP\Connection $ldap - * @param string $dn - * @param array $entry - * @param array|null $controls [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param LDAP\Connection $ldap + * @param string $dn + * @param array $entry + * @param array|null $controls [optional] */ -function ldap_add (LDAP\Connection $ldap, string $dn, array $entry, ?array $controls = null): bool {} +function ldap_add (LDAP\Connection $ldap, string $dn, array $entry, ?array $controls = NULL): bool {} /** - * Add entries to LDAP directory - * @link http://www.php.net/manual/en/function.ldap-add-ext.php - * @param LDAP\Connection $ldap - * @param string $dn - * @param array $entry - * @param array|null $controls [optional] - * @return LDAP\Result|false Returns an LDAP\Result instance, or false on failure. + * {@inheritdoc} + * @param LDAP\Connection $ldap + * @param string $dn + * @param array $entry + * @param array|null $controls [optional] */ -function ldap_add_ext (LDAP\Connection $ldap, string $dn, array $entry, ?array $controls = null): LDAP\Result|false {} +function ldap_add_ext (LDAP\Connection $ldap, string $dn, array $entry, ?array $controls = NULL): LDAP\Result|false {} /** - * Delete an entry from a directory - * @link http://www.php.net/manual/en/function.ldap-delete.php - * @param LDAP\Connection $ldap - * @param string $dn - * @param array|null $controls [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param LDAP\Connection $ldap + * @param string $dn + * @param array|null $controls [optional] */ -function ldap_delete (LDAP\Connection $ldap, string $dn, ?array $controls = null): bool {} +function ldap_delete (LDAP\Connection $ldap, string $dn, ?array $controls = NULL): bool {} /** - * Delete an entry from a directory - * @link http://www.php.net/manual/en/function.ldap-delete-ext.php - * @param LDAP\Connection $ldap - * @param string $dn - * @param array|null $controls [optional] - * @return LDAP\Result|false Returns an LDAP\Result instance, or false on failure. + * {@inheritdoc} + * @param LDAP\Connection $ldap + * @param string $dn + * @param array|null $controls [optional] */ -function ldap_delete_ext (LDAP\Connection $ldap, string $dn, ?array $controls = null): LDAP\Result|false {} +function ldap_delete_ext (LDAP\Connection $ldap, string $dn, ?array $controls = NULL): LDAP\Result|false {} /** - * Batch and execute modifications on an LDAP entry - * @link http://www.php.net/manual/en/function.ldap-modify-batch.php - * @param LDAP\Connection $ldap - * @param string $dn - * @param array $modifications_info - * @param array|null $controls [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param LDAP\Connection $ldap + * @param string $dn + * @param array $modifications_info + * @param array|null $controls [optional] */ -function ldap_modify_batch (LDAP\Connection $ldap, string $dn, array $modifications_info, ?array $controls = null): bool {} +function ldap_modify_batch (LDAP\Connection $ldap, string $dn, array $modifications_info, ?array $controls = NULL): bool {} /** - * Add attribute values to current attributes - * @link http://www.php.net/manual/en/function.ldap-mod-add.php - * @param LDAP\Connection $ldap - * @param string $dn - * @param array $entry - * @param array|null $controls [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param LDAP\Connection $ldap + * @param string $dn + * @param array $entry + * @param array|null $controls [optional] */ -function ldap_mod_add (LDAP\Connection $ldap, string $dn, array $entry, ?array $controls = null): bool {} +function ldap_mod_add (LDAP\Connection $ldap, string $dn, array $entry, ?array $controls = NULL): bool {} /** - * Add attribute values to current attributes - * @link http://www.php.net/manual/en/function.ldap-mod_add-ext.php - * @param LDAP\Connection $ldap - * @param string $dn - * @param array $entry - * @param array|null $controls [optional] - * @return LDAP\Result|false Returns an LDAP\Result instance, or false on failure. + * {@inheritdoc} + * @param LDAP\Connection $ldap + * @param string $dn + * @param array $entry + * @param array|null $controls [optional] */ -function ldap_mod_add_ext (LDAP\Connection $ldap, string $dn, array $entry, ?array $controls = null): LDAP\Result|false {} +function ldap_mod_add_ext (LDAP\Connection $ldap, string $dn, array $entry, ?array $controls = NULL): LDAP\Result|false {} /** - * Replace attribute values with new ones - * @link http://www.php.net/manual/en/function.ldap-mod-replace.php - * @param LDAP\Connection $ldap - * @param string $dn - * @param array $entry - * @param array|null $controls [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param LDAP\Connection $ldap + * @param string $dn + * @param array $entry + * @param array|null $controls [optional] */ -function ldap_mod_replace (LDAP\Connection $ldap, string $dn, array $entry, ?array $controls = null): bool {} +function ldap_mod_replace (LDAP\Connection $ldap, string $dn, array $entry, ?array $controls = NULL): bool {} /** - * Alias of ldap_mod_replace - * @link http://www.php.net/manual/en/function.ldap-modify.php - * @param LDAP\Connection $ldap - * @param string $dn - * @param array $entry - * @param array|null $controls [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param LDAP\Connection $ldap + * @param string $dn + * @param array $entry + * @param array|null $controls [optional] */ -function ldap_modify (LDAP\Connection $ldap, string $dn, array $entry, ?array $controls = null): bool {} +function ldap_modify (LDAP\Connection $ldap, string $dn, array $entry, ?array $controls = NULL): bool {} /** - * Replace attribute values with new ones - * @link http://www.php.net/manual/en/function.ldap-mod_replace-ext.php - * @param LDAP\Connection $ldap - * @param string $dn - * @param array $entry - * @param array|null $controls [optional] - * @return LDAP\Result|false Returns an LDAP\Result instance, or false on failure. + * {@inheritdoc} + * @param LDAP\Connection $ldap + * @param string $dn + * @param array $entry + * @param array|null $controls [optional] */ -function ldap_mod_replace_ext (LDAP\Connection $ldap, string $dn, array $entry, ?array $controls = null): LDAP\Result|false {} +function ldap_mod_replace_ext (LDAP\Connection $ldap, string $dn, array $entry, ?array $controls = NULL): LDAP\Result|false {} /** - * Delete attribute values from current attributes - * @link http://www.php.net/manual/en/function.ldap-mod-del.php - * @param LDAP\Connection $ldap - * @param string $dn - * @param array $entry - * @param array|null $controls [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param LDAP\Connection $ldap + * @param string $dn + * @param array $entry + * @param array|null $controls [optional] */ -function ldap_mod_del (LDAP\Connection $ldap, string $dn, array $entry, ?array $controls = null): bool {} +function ldap_mod_del (LDAP\Connection $ldap, string $dn, array $entry, ?array $controls = NULL): bool {} /** - * Delete attribute values from current attributes - * @link http://www.php.net/manual/en/function.ldap-mod_del-ext.php - * @param LDAP\Connection $ldap - * @param string $dn - * @param array $entry - * @param array|null $controls [optional] - * @return LDAP\Result|false Returns an LDAP\Result instance, or false on failure. + * {@inheritdoc} + * @param LDAP\Connection $ldap + * @param string $dn + * @param array $entry + * @param array|null $controls [optional] */ -function ldap_mod_del_ext (LDAP\Connection $ldap, string $dn, array $entry, ?array $controls = null): LDAP\Result|false {} +function ldap_mod_del_ext (LDAP\Connection $ldap, string $dn, array $entry, ?array $controls = NULL): LDAP\Result|false {} /** - * Return the LDAP error number of the last LDAP command - * @link http://www.php.net/manual/en/function.ldap-errno.php - * @param LDAP\Connection $ldap - * @return int Return the LDAP error number of the last LDAP command for this - * link. + * {@inheritdoc} + * @param LDAP\Connection $ldap */ function ldap_errno (LDAP\Connection $ldap): int {} /** - * Return the LDAP error message of the last LDAP command - * @link http://www.php.net/manual/en/function.ldap-error.php - * @param LDAP\Connection $ldap - * @return string Returns string error message. + * {@inheritdoc} + * @param LDAP\Connection $ldap */ function ldap_error (LDAP\Connection $ldap): string {} /** - * Convert LDAP error number into string error message - * @link http://www.php.net/manual/en/function.ldap-err2str.php - * @param int $errno - * @return string Returns the error message, as a string. + * {@inheritdoc} + * @param int $errno */ function ldap_err2str (int $errno): string {} /** - * Compare value of attribute found in entry specified with DN - * @link http://www.php.net/manual/en/function.ldap-compare.php - * @param LDAP\Connection $ldap - * @param string $dn - * @param string $attribute - * @param string $value - * @param array|null $controls [optional] - * @return bool|int Returns true if value matches otherwise returns - * false. Returns -1 on error. + * {@inheritdoc} + * @param LDAP\Connection $ldap + * @param string $dn + * @param string $attribute + * @param string $value + * @param array|null $controls [optional] */ -function ldap_compare (LDAP\Connection $ldap, string $dn, string $attribute, string $value, ?array $controls = null): bool|int {} +function ldap_compare (LDAP\Connection $ldap, string $dn, string $attribute, string $value, ?array $controls = NULL): int|bool {} /** - * Modify the name of an entry - * @link http://www.php.net/manual/en/function.ldap-rename.php - * @param LDAP\Connection $ldap - * @param string $dn - * @param string $new_rdn - * @param string $new_parent - * @param bool $delete_old_rdn - * @param array|null $controls [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param LDAP\Connection $ldap + * @param string $dn + * @param string $new_rdn + * @param string $new_parent + * @param bool $delete_old_rdn + * @param array|null $controls [optional] */ -function ldap_rename (LDAP\Connection $ldap, string $dn, string $new_rdn, string $new_parent, bool $delete_old_rdn, ?array $controls = null): bool {} +function ldap_rename (LDAP\Connection $ldap, string $dn, string $new_rdn, string $new_parent, bool $delete_old_rdn, ?array $controls = NULL): bool {} /** - * Modify the name of an entry - * @link http://www.php.net/manual/en/function.ldap-rename-ext.php - * @param LDAP\Connection $ldap - * @param string $dn - * @param string $new_rdn - * @param string $new_parent - * @param bool $delete_old_rdn - * @param array|null $controls [optional] - * @return LDAP\Result|false Returns an LDAP\Result instance, or false on failure. + * {@inheritdoc} + * @param LDAP\Connection $ldap + * @param string $dn + * @param string $new_rdn + * @param string $new_parent + * @param bool $delete_old_rdn + * @param array|null $controls [optional] */ -function ldap_rename_ext (LDAP\Connection $ldap, string $dn, string $new_rdn, string $new_parent, bool $delete_old_rdn, ?array $controls = null): LDAP\Result|false {} +function ldap_rename_ext (LDAP\Connection $ldap, string $dn, string $new_rdn, string $new_parent, bool $delete_old_rdn, ?array $controls = NULL): LDAP\Result|false {} /** - * Get the current value for given option - * @link http://www.php.net/manual/en/function.ldap-get-option.php - * @param LDAP\Connection $ldap - * @param int $option - * @param array|string|int $value [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param LDAP\Connection $ldap + * @param int $option + * @param mixed $value [optional] */ -function ldap_get_option (LDAP\Connection $ldap, int $option, array|string|int &$value = null): bool {} +function ldap_get_option (LDAP\Connection $ldap, int $option, &$value = NULL): bool {} /** - * Set the value of the given option - * @link http://www.php.net/manual/en/function.ldap-set-option.php - * @param LDAP\Connection|null $ldap - * @param int $option - * @param array|string|int|bool $value - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param LDAP\Connection|null $ldap + * @param int $option + * @param mixed $value */ -function ldap_set_option (?LDAP\Connection $ldap, int $option, array|string|int|bool $value): bool {} +function ldap_set_option (?LDAP\Connection $ldap = null, int $option, $value = null): bool {} /** - * Counts the number of references in a search result - * @link http://www.php.net/manual/en/function.ldap-count-references.php - * @param LDAP\Connection $ldap An LDAP\Connection instance, returned by ldap_connect. - * @param LDAP\Result $result An LDAP\Result instance, returned by ldap_list or ldap_search. - * @return int Returns the number of references in a search result. + * {@inheritdoc} + * @param LDAP\Connection $ldap + * @param LDAP\Result $result */ function ldap_count_references (LDAP\Connection $ldap, LDAP\Result $result): int {} /** - * Return first reference - * @link http://www.php.net/manual/en/function.ldap-first-reference.php - * @param LDAP\Connection $ldap - * @param LDAP\Result $result - * @return LDAP\ResultEntry|false + * {@inheritdoc} + * @param LDAP\Connection $ldap + * @param LDAP\Result $result */ function ldap_first_reference (LDAP\Connection $ldap, LDAP\Result $result): LDAP\ResultEntry|false {} /** - * Get next reference - * @link http://www.php.net/manual/en/function.ldap-next-reference.php - * @param LDAP\Connection $ldap - * @param LDAP\ResultEntry $entry - * @return LDAP\ResultEntry|false + * {@inheritdoc} + * @param LDAP\Connection $ldap + * @param LDAP\ResultEntry $entry */ function ldap_next_reference (LDAP\Connection $ldap, LDAP\ResultEntry $entry): LDAP\ResultEntry|false {} /** - * Extract information from reference entry - * @link http://www.php.net/manual/en/function.ldap-parse-reference.php - * @param LDAP\Connection $ldap - * @param LDAP\ResultEntry $entry - * @param array $referrals - * @return bool + * {@inheritdoc} + * @param LDAP\Connection $ldap + * @param LDAP\ResultEntry $entry + * @param mixed $referrals */ -function ldap_parse_reference (LDAP\Connection $ldap, LDAP\ResultEntry $entry, array &$referrals): bool {} +function ldap_parse_reference (LDAP\Connection $ldap, LDAP\ResultEntry $entry, &$referrals = null): bool {} /** - * Extract information from result - * @link http://www.php.net/manual/en/function.ldap-parse-result.php - * @param LDAP\Connection $ldap - * @param LDAP\Result $result - * @param int $error_code - * @param string $matched_dn [optional] - * @param string $error_message [optional] - * @param array $referrals [optional] - * @param array $controls [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param LDAP\Connection $ldap + * @param LDAP\Result $result + * @param mixed $error_code + * @param mixed $matched_dn [optional] + * @param mixed $error_message [optional] + * @param mixed $referrals [optional] + * @param mixed $controls [optional] */ -function ldap_parse_result (LDAP\Connection $ldap, LDAP\Result $result, int &$error_code, string &$matched_dn = null, string &$error_message = null, array &$referrals = null, array &$controls = null): bool {} +function ldap_parse_result (LDAP\Connection $ldap, LDAP\Result $result, &$error_code = null, &$matched_dn = NULL, &$error_message = NULL, &$referrals = NULL, &$controls = NULL): bool {} /** - * Set a callback function to do re-binds on referral chasing - * @link http://www.php.net/manual/en/function.ldap-set-rebind-proc.php - * @param LDAP\Connection $ldap - * @param callable|null $callback - * @return bool + * {@inheritdoc} + * @param LDAP\Connection $ldap + * @param callable|null $callback */ -function ldap_set_rebind_proc (LDAP\Connection $ldap, ?callable $callback): bool {} +function ldap_set_rebind_proc (LDAP\Connection $ldap, ?callable $callback = null): bool {} /** - * Start TLS - * @link http://www.php.net/manual/en/function.ldap-start-tls.php - * @param LDAP\Connection $ldap - * @return bool + * {@inheritdoc} + * @param LDAP\Connection $ldap */ function ldap_start_tls (LDAP\Connection $ldap): bool {} /** - * Escape a string for use in an LDAP filter or DN - * @link http://www.php.net/manual/en/function.ldap-escape.php - * @param string $value - * @param string $ignore [optional] - * @param int $flags [optional] - * @return string Returns the escaped string. + * {@inheritdoc} + * @param string $value + * @param string $ignore [optional] + * @param int $flags [optional] */ -function ldap_escape (string $value, string $ignore = '""', int $flags = null): string {} +function ldap_escape (string $value, string $ignore = '', int $flags = 0): string {} /** - * Performs an extended operation - * @link http://www.php.net/manual/en/function.ldap-exop.php - * @param LDAP\Connection $ldap An LDAP\Connection instance, returned by ldap_connect. - * @param string $request_oid The extended operation request OID. You may use one of LDAP_EXOP_START_TLS, LDAP_EXOP_MODIFY_PASSWD, LDAP_EXOP_REFRESH, LDAP_EXOP_WHO_AM_I, LDAP_EXOP_TURN, or a string with the OID of the operation you want to send. - * @param string $request_data [optional] The extended operation request data. May be NULL for some operations like LDAP_EXOP_WHO_AM_I, may also need to be BER encoded. - * @param array $controls [optional] Array of LDAP Controls to send with the request. - * @param string $response_data [optional] Will be filled with the extended operation response data if provided. - * If not provided you may use ldap_parse_exop on the result object - * later to get this data. - * @param string $response_oid [optional] Will be filled with the response OID if provided, usually equal to the request OID. - * @return mixed When used with response_data, returns true on success or false on error. - * When used without response_data, returns a result identifier or false on error. + * {@inheritdoc} + * @param LDAP\Connection $ldap + * @param string $request_oid + * @param string|null $request_data [optional] + * @param array|null $controls [optional] + * @param mixed $response_data [optional] + * @param mixed $response_oid [optional] */ -function ldap_exop (LDAP\Connection $ldap, string $request_oid, string $request_data = null, array $controls = null, string &$response_data = null, string &$response_oid = null): mixed {} +function ldap_exop (LDAP\Connection $ldap, string $request_oid, ?string $request_data = NULL, ?array $controls = NULL, &$response_data = NULL, &$response_oid = NULL): LDAP\Result|bool {} /** - * PASSWD extended operation helper - * @link http://www.php.net/manual/en/function.ldap-exop-passwd.php - * @param LDAP\Connection $ldap An LDAP\Connection instance, returned by ldap_connect. - * @param string $user [optional] dn of the user to change the password of. - * @param string $old_password [optional] The old password of this user. May be ommited depending of server configuration. - * @param string $new_password [optional] The new password for this user. May be omitted or empty to have a generated password. - * @param array $controls [optional] If provided, a password policy request control is send with the request and this is - * filled with an array of LDAP Controls - * returned with the request. - * @return string|bool Returns the generated password if new_password is empty or omitted. - * Otherwise returns true on success and false on failure. + * {@inheritdoc} + * @param LDAP\Connection $ldap + * @param string $request_oid + * @param string|null $request_data [optional] + * @param array|null $controls [optional] + * @param mixed $response_data [optional] + * @param mixed $response_oid [optional] */ -function ldap_exop_passwd (LDAP\Connection $ldap, string $user = '""', string $old_password = '""', string $new_password = '""', array &$controls = null): string|bool {} +function ldap_exop_sync (LDAP\Connection $ldap, string $request_oid, ?string $request_data = NULL, ?array $controls = NULL, &$response_data = NULL, &$response_oid = NULL): LDAP\Result|bool {} /** - * WHOAMI extended operation helper - * @link http://www.php.net/manual/en/function.ldap-exop-whoami.php - * @param LDAP\Connection $ldap An LDAP\Connection instance, returned by ldap_connect. - * @return string|false The data returned by the server, or false on error. + * {@inheritdoc} + * @param LDAP\Connection $ldap + * @param string $user [optional] + * @param string $old_password [optional] + * @param string $new_password [optional] + * @param mixed $controls [optional] */ -function ldap_exop_whoami (LDAP\Connection $ldap): string|false {} +function ldap_exop_passwd (LDAP\Connection $ldap, string $user = '', string $old_password = '', string $new_password = '', &$controls = NULL): string|bool {} /** - * Refresh extended operation helper - * @link http://www.php.net/manual/en/function.ldap-exop-refresh.php - * @param LDAP\Connection $ldap An LDAP\Connection instance, returned by ldap_connect. - * @param string $dn dn of the entry to refresh. - * @param int $ttl Time in seconds (between 1 and 31557600) that the - * client requests that the entry exists in the directory before being - * automatically removed. - * @return int|false From RFC: - * The responseTtl field is the time in seconds which the server chooses - * to have as the time-to-live field for that entry. It must not be any - * smaller than that which the client requested, and it may be larger. - * However, to allow servers to maintain a relatively accurate - * directory, and to prevent clients from abusing the dynamic - * extensions, servers are permitted to shorten a client-requested - * time-to-live value, down to a minimum of 86400 seconds (one day). - * false will be returned on error. + * {@inheritdoc} + * @param LDAP\Connection $ldap */ -function ldap_exop_refresh (LDAP\Connection $ldap, string $dn, int $ttl): int|false {} +function ldap_exop_whoami (LDAP\Connection $ldap): string|false {} /** - * Parse result object from an LDAP extended operation - * @link http://www.php.net/manual/en/function.ldap-parse-exop.php - * @param LDAP\Connection $ldap An LDAP\Connection instance, returned by ldap_connect. - * @param LDAP\Result $result An LDAP\Result instance, returned by ldap_list or ldap_search. - * @param string $response_data [optional] Will be filled by the response data. - * @param string $response_oid [optional] Will be filled by the response OID. - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param LDAP\Connection $ldap + * @param string $dn + * @param int $ttl */ -function ldap_parse_exop (LDAP\Connection $ldap, LDAP\Result $result, string &$response_data = null, string &$response_oid = null): bool {} - +function ldap_exop_refresh (LDAP\Connection $ldap, string $dn, int $ttl): int|false {} /** - * Alias dereferencing rule - Never. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var int + * {@inheritdoc} + * @param LDAP\Connection $ldap + * @param LDAP\Result $result + * @param mixed $response_data [optional] + * @param mixed $response_oid [optional] */ -define ('LDAP_DEREF_NEVER', 0); +function ldap_parse_exop (LDAP\Connection $ldap, LDAP\Result $result, &$response_data = NULL, &$response_oid = NULL): bool {} -/** - * Alias dereferencing rule - Searching. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var int - */ +define ('LDAP_DEREF_NEVER', 0); define ('LDAP_DEREF_SEARCHING', 1); - -/** - * Alias dereferencing rule - Finding. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var int - */ define ('LDAP_DEREF_FINDING', 2); - -/** - * Alias dereferencing rule - Always. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var int - */ define ('LDAP_DEREF_ALWAYS', 3); define ('LDAP_MODIFY_BATCH_ADD', 1); define ('LDAP_MODIFY_BATCH_REMOVE', 2); @@ -696,117 +504,21 @@ function ldap_parse_exop (LDAP\Connection $ldap, LDAP\Result $result, string &$r define ('LDAP_MODIFY_BATCH_ATTRIB', "attrib"); define ('LDAP_MODIFY_BATCH_MODTYPE', "modtype"); define ('LDAP_MODIFY_BATCH_VALUES', "values"); - -/** - * Specifies alternative rules for following aliases at the server. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var int - */ define ('LDAP_OPT_DEREF', 2); - -/** - * Specifies the maximum number of entries that can be - * returned on a search operation. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var int - */ define ('LDAP_OPT_SIZELIMIT', 3); - -/** - * Specifies the number of seconds to wait for search results. - * The actual time limit for operations is also bounded - * by the server's configured maximum time. - * The lesser of these two settings is the actual time limit. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var int - */ define ('LDAP_OPT_TIMELIMIT', 4); - -/** - * Option for ldap_set_option to allow setting network timeout. - * (Available as of PHP 5.3.0) - * @link http://www.php.net/manual/en/ldap.constants.php - * @var int - */ define ('LDAP_OPT_NETWORK_TIMEOUT', 20485); define ('LDAP_OPT_TIMEOUT', 20482); - -/** - * Specifies the LDAP protocol to be used (V2 or V3). - * @link http://www.php.net/manual/en/ldap.constants.php - * @var int - */ define ('LDAP_OPT_PROTOCOL_VERSION', 17); - -/** - * Latest session error number. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var int - */ define ('LDAP_OPT_ERROR_NUMBER', 49); - -/** - * Specifies whether to automatically follow referrals returned - * by the LDAP server. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var int - */ define ('LDAP_OPT_REFERRALS', 8); - -/** - * Determines whether or not the connection should be implicitly restarted. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var int - */ define ('LDAP_OPT_RESTART', 9); - -/** - * Sets/gets a space-separated of hosts when trying to connect. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var int - */ define ('LDAP_OPT_HOST_NAME', 48); - -/** - * Alias of LDAP_OPT_DIAGNOSTIC_MESSAGE. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var int - */ define ('LDAP_OPT_ERROR_STRING', 50); - -/** - * Sets/gets the matched DN associated with the connection. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var int - */ define ('LDAP_OPT_MATCHED_DN', 51); - -/** - * Specifies a default list of server controls to be sent with each request. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var int - */ define ('LDAP_OPT_SERVER_CONTROLS', 18); - -/** - * Specifies a default list of client controls to be processed with each request. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var int - */ define ('LDAP_OPT_CLIENT_CONTROLS', 19); - -/** - * Specifies a bitwise level for debug traces. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var int - */ define ('LDAP_OPT_DEBUG_LEVEL', 20481); - -/** - * Gets the latest session error message. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var int - */ define ('LDAP_OPT_DIAGNOSTIC_MESSAGE', 50); define ('LDAP_OPT_X_SASL_MECH', 24832); define ('LDAP_OPT_X_SASL_REALM', 24833); @@ -814,95 +526,24 @@ function ldap_parse_exop (LDAP\Connection $ldap, LDAP\Result $result, string &$r define ('LDAP_OPT_X_SASL_AUTHZID', 24835); define ('LDAP_OPT_X_SASL_NOCANON', 24843); define ('LDAP_OPT_X_SASL_USERNAME', 24844); - -/** - * Specifies the certificate checking strategy. This must be one of: LDAP_OPT_X_TLS_NEVER,LDAP_OPT_X_TLS_HARD, LDAP_OPT_X_TLS_DEMAND, - * LDAP_OPT_X_TLS_ALLOW, LDAP_OPT_X_TLS_TRY. - * (Available as of PHP 7.0.0) - * @link http://www.php.net/manual/en/ldap.constants.php - * @var int - */ define ('LDAP_OPT_X_TLS_REQUIRE_CERT', 24582); define ('LDAP_OPT_X_TLS_NEVER', 0); define ('LDAP_OPT_X_TLS_HARD', 1); define ('LDAP_OPT_X_TLS_DEMAND', 2); define ('LDAP_OPT_X_TLS_ALLOW', 3); define ('LDAP_OPT_X_TLS_TRY', 4); - -/** - * Specifies the path of the directory containing CA certificates. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var string - */ define ('LDAP_OPT_X_TLS_CACERTDIR', 24579); - -/** - * Specifies the full-path of the CA certificate file. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var string - */ define ('LDAP_OPT_X_TLS_CACERTFILE', 24578); - -/** - * Specifies the full-path of the certificate file. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var string - */ define ('LDAP_OPT_X_TLS_CERTFILE', 24580); - -/** - * Specifies the allowed cipher suite. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var string - */ define ('LDAP_OPT_X_TLS_CIPHER_SUITE', 24584); - -/** - * Specifies the full-path of the certificate key file. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var string - */ define ('LDAP_OPT_X_TLS_KEYFILE', 24581); - -/** - * Sets/gets the random file when one of the system default ones are not available. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var string - */ define ('LDAP_OPT_X_TLS_RANDOM_FILE', 24585); - -/** - * Specifies the CRL evaluation strategy. This must be one of: LDAP_OPT_X_TLS_CRL_NONE,LDAP_OPT_X_TLS_CRL_PEER, LDAP_OPT_X_TLS_CRL_ALL. - * This option is only valid for OpenSSL. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var int - */ define ('LDAP_OPT_X_TLS_CRLCHECK', 24587); define ('LDAP_OPT_X_TLS_CRL_NONE', 0); define ('LDAP_OPT_X_TLS_CRL_PEER', 1); define ('LDAP_OPT_X_TLS_CRL_ALL', 2); - -/** - * Specifies the full-path of the file containing the parameters for Diffie-Hellman ephemeral key exchange. - * This option is ignored by GnuTLS and Mozilla NSS. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var string - */ define ('LDAP_OPT_X_TLS_DHFILE', 24590); - -/** - * Specifies the full-path of the CRL file. - * This option is only valid for GnuTLS. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var string - */ define ('LDAP_OPT_X_TLS_CRLFILE', 24592); - -/** - * Specifies the minimum protocol version. This can be one of: LDAP_OPT_X_TLS_PROTOCOL_SSL2,LDAP_OPT_X_TLS_PROTOCOL_SSL3, LDAP_OPT_X_TLS_PROTOCOL_TLS1_0, LDAP_OPT_X_TLS_PROTOCOL_TLS1_1, LDAP_OPT_X_TLS_PROTOCOL_TLS1_2 - * @link http://www.php.net/manual/en/ldap.constants.php - * @var int - */ define ('LDAP_OPT_X_TLS_PROTOCOL_MIN', 24583); define ('LDAP_OPT_X_TLS_PROTOCOL_SSL2', 512); define ('LDAP_OPT_X_TLS_PROTOCOL_SSL3', 768); @@ -910,274 +551,44 @@ function ldap_parse_exop (LDAP\Connection $ldap, LDAP\Result $result, string &$r define ('LDAP_OPT_X_TLS_PROTOCOL_TLS1_1', 770); define ('LDAP_OPT_X_TLS_PROTOCOL_TLS1_2', 771); define ('LDAP_OPT_X_TLS_PACKAGE', 24593); - -/** - * Specifies the number of seconds a connection needs to remain idle before TCP starts sending keepalive probes. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var int - */ define ('LDAP_OPT_X_KEEPALIVE_IDLE', 25344); - -/** - * Specifies the maximum number of keepalive probes TCP should send before dropping the connection. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var int - */ define ('LDAP_OPT_X_KEEPALIVE_PROBES', 25345); - -/** - * Specifies the interval in seconds between individual keepalive probes. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var int - */ define ('LDAP_OPT_X_KEEPALIVE_INTERVAL', 25346); define ('LDAP_ESCAPE_FILTER', 1); define ('LDAP_ESCAPE_DN', 2); - -/** - * Extended Operation constant - Start TLS (RFC 4511). - * @link http://www.php.net/manual/en/ldap.constants.php - * @var string - */ define ('LDAP_EXOP_START_TLS', "1.3.6.1.4.1.1466.20037"); - -/** - * Extended Operation constant - Modify password (RFC 3062). - * @link http://www.php.net/manual/en/ldap.constants.php - * @var string - */ define ('LDAP_EXOP_MODIFY_PASSWD', "1.3.6.1.4.1.4203.1.11.1"); - -/** - * Extended Operation Constant - Refresh (RFC 2589). - * @link http://www.php.net/manual/en/ldap.constants.php - * @var string - */ define ('LDAP_EXOP_REFRESH', "1.3.6.1.4.1.1466.101.119.1"); - -/** - * Extended Operation Constant - WHOAMI (RFC 4532). - * @link http://www.php.net/manual/en/ldap.constants.php - * @var string - */ define ('LDAP_EXOP_WHO_AM_I', "1.3.6.1.4.1.4203.1.11.3"); - -/** - * Extended Operation Constant - Turn (RFC 4531). - * @link http://www.php.net/manual/en/ldap.constants.php - * @var string - */ define ('LDAP_EXOP_TURN', "1.3.6.1.1.19"); - -/** - * Control Constant - Manage DSA IT (RFC 3296). - * Available as of PHP 7.3.0. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var string - */ define ('LDAP_CONTROL_MANAGEDSAIT', "2.16.840.1.113730.3.4.2"); - -/** - * Control Constant - Proxied Authorization (RFC 4370). - * Available as of PHP 7.3.0. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var string - */ define ('LDAP_CONTROL_PROXY_AUTHZ', "2.16.840.1.113730.3.4.18"); - -/** - * Control Constant - Subentries (RFC 3672). - * Available as of PHP 7.3.0. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var string - */ define ('LDAP_CONTROL_SUBENTRIES', "1.3.6.1.4.1.4203.1.10.1"); - -/** - * Control Constant - Filter returned values (RFC 3876). - * Available as of PHP 7.3.0. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var string - */ define ('LDAP_CONTROL_VALUESRETURNFILTER', "1.2.826.0.1.3344810.2.3"); - -/** - * Control Constant - Assertion (RFC 4528). - * Available as of PHP 7.3.0. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var string - */ define ('LDAP_CONTROL_ASSERT', "1.3.6.1.1.12"); - -/** - * Control Constant - Pre read (RFC 4527). - * Available as of PHP 7.3.0. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var string - */ define ('LDAP_CONTROL_PRE_READ', "1.3.6.1.1.13.1"); - -/** - * Control Constant - Post read (RFC 4527). - * Available as of PHP 7.3.0. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var string - */ define ('LDAP_CONTROL_POST_READ', "1.3.6.1.1.13.2"); - -/** - * Control Constant - Sort request (RFC 2891). - * Available as of PHP 7.3.0. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var string - */ define ('LDAP_CONTROL_SORTREQUEST', "1.2.840.113556.1.4.473"); - -/** - * Control Constant - Sort response (RFC 2891). - * Available as of PHP 7.3.0. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var string - */ define ('LDAP_CONTROL_SORTRESPONSE', "1.2.840.113556.1.4.474"); - -/** - * Control Constant - Paged results (RFC 2696). - * Available as of PHP 7.3.0. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var string - */ define ('LDAP_CONTROL_PAGEDRESULTS', "1.2.840.113556.1.4.319"); - -/** - * Control Constant - Authorization Identity Request (RFC 3829). - * Available as of PHP 7.3.0. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var string - */ define ('LDAP_CONTROL_AUTHZID_REQUEST', "2.16.840.1.113730.3.4.16"); - -/** - * Control Constant - Authorization Identity Response (RFC 3829). - * Available as of PHP 7.3.0. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var string - */ define ('LDAP_CONTROL_AUTHZID_RESPONSE', "2.16.840.1.113730.3.4.15"); - -/** - * Control Constant - Content Synchronization Operation (RFC 4533). - * Available as of PHP 7.3.0. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var string - */ define ('LDAP_CONTROL_SYNC', "1.3.6.1.4.1.4203.1.9.1.1"); - -/** - * Control Constant - Content Synchronization Operation State (RFC 4533). - * Available as of PHP 7.3.0. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var string - */ define ('LDAP_CONTROL_SYNC_STATE', "1.3.6.1.4.1.4203.1.9.1.2"); - -/** - * Control Constant - Content Synchronization Operation Done (RFC 4533). - * Available as of PHP 7.3.0. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var string - */ define ('LDAP_CONTROL_SYNC_DONE', "1.3.6.1.4.1.4203.1.9.1.3"); - -/** - * Control Constant - Don't Use Copy (RFC 6171). - * Available as of PHP 7.3.0. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var string - */ define ('LDAP_CONTROL_DONTUSECOPY', "1.3.6.1.1.22"); - -/** - * Control Constant - Password Policy Request. - * Available as of PHP 7.3.0. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var string - */ define ('LDAP_CONTROL_PASSWORDPOLICYREQUEST', "1.3.6.1.4.1.42.2.27.8.5.1"); - -/** - * Control Constant - Password Policy Response. - * Available as of PHP 7.3.0. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var string - */ define ('LDAP_CONTROL_PASSWORDPOLICYRESPONSE', "1.3.6.1.4.1.42.2.27.8.5.1"); - -/** - * Control Constant - Active Directory Incremental Values. - * Available as of PHP 7.3.0. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var string - */ define ('LDAP_CONTROL_X_INCREMENTAL_VALUES', "1.2.840.113556.1.4.802"); - -/** - * Control Constant - Active Directory Domain Scope. - * Available as of PHP 7.3.0. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var string - */ define ('LDAP_CONTROL_X_DOMAIN_SCOPE', "1.2.840.113556.1.4.1339"); - -/** - * Control Constant - Active Directory Permissive Modify. - * Available as of PHP 7.3.0. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var string - */ define ('LDAP_CONTROL_X_PERMISSIVE_MODIFY', "1.2.840.113556.1.4.1413"); - -/** - * Control Constant - Active Directory Search Options. - * Available as of PHP 7.3.0. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var string - */ define ('LDAP_CONTROL_X_SEARCH_OPTIONS', "1.2.840.113556.1.4.1340"); - -/** - * Control Constant - Active Directory Tree Delete. - * Available as of PHP 7.3.0. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var string - */ define ('LDAP_CONTROL_X_TREE_DELETE', "1.2.840.113556.1.4.805"); - -/** - * Control Constant - Active Directory Extended DN. - * Available as of PHP 7.3.0. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var string - */ define ('LDAP_CONTROL_X_EXTENDED_DN', "1.2.840.113556.1.4.529"); - -/** - * Control Constant - Virtual List View Request. - * Available as of PHP 7.3.0. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var string - */ define ('LDAP_CONTROL_VLVREQUEST', "2.16.840.1.113730.3.4.9"); - -/** - * Control Constant - Virtual List View Response. - * Available as of PHP 7.3.0. - * @link http://www.php.net/manual/en/ldap.constants.php - * @var string - */ define ('LDAP_CONTROL_VLVRESPONSE', "2.16.840.1.113730.3.4.10"); } -// End of ldap v.8.2.6 +// End of ldap v.8.3.0 diff --git a/plugins/org.eclipse.php.core/Resources/language/php8.3/libxml.php b/plugins/org.eclipse.php.core/Resources/language/php8.3/libxml.php index 6f3847be6e..44c23d0116 100644 --- a/plugins/org.eclipse.php.core/Resources/language/php8.3/libxml.php +++ b/plugins/org.eclipse.php.core/Resources/language/php8.3/libxml.php @@ -1,330 +1,93 @@ - * public_id - *Returns false on error.
+ * {@inheritdoc} + * @param mixed $fp + * @param mixed $filename + * @param mixed $callback [optional] */ -function mailparse_msg_extract_part_file ($mimemail, mixed $filename, callable $callbackfunc = null): string {} +function mailparse_msg_extract_part_file ($fp = null, $filename = null, $callback = NULL) {} /** - * Extracts a message section including headers without decoding the transfer encoding - * @link http://www.php.net/manual/en/function.mailparse-msg-extract-whole-part-file.php - * @param resource $mimemail - * @param string $filename - * @param callable $callbackfunc [optional] - * @return string + * {@inheritdoc} + * @param mixed $fp + * @param mixed $filename + * @param mixed $callback [optional] */ -function mailparse_msg_extract_whole_part_file ($mimemail, string $filename, callable $callbackfunc = null): string {} +function mailparse_msg_extract_whole_part_file ($fp = null, $filename = null, $callback = NULL) {} /** - * Create a mime mail resource - * @link http://www.php.net/manual/en/function.mailparse-msg-create.php - * @return resource Returns a handle that can be used to parse a message. + * {@inheritdoc} */ function mailparse_msg_create () {} /** - * Frees a MIME resource - * @link http://www.php.net/manual/en/function.mailparse-msg-free.php - * @param resource $mimemail - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mixed $fp */ -function mailparse_msg_free ($mimemail): bool {} +function mailparse_msg_free ($fp = null) {} /** - * Incrementally parse data into buffer - * @link http://www.php.net/manual/en/function.mailparse-msg-parse.php - * @param resource $mimemail - * @param string $data - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mixed $fp + * @param mixed $data */ -function mailparse_msg_parse ($mimemail, string $data): bool {} +function mailparse_msg_parse ($fp = null, $data = null) {} /** - * Parse RFC 822 compliant addresses - * @link http://www.php.net/manual/en/function.mailparse-rfc822-parse-addresses.php - * @param string $addresses - * @return array Returns an array of associative arrays with the following keys for each - * recipient: - *display | - *- * The recipient name, for display purpose. If this part is not set for a - * recipient, this key will hold the same value as - * address. - * | - *
address | - *The email address | - *
is_group | - *true if the recipient is a newsgroup, false otherwise. | - *
filename | - *Path to the temporary file name created | - *
origfilename | - *The original filename, for uuencoded parts only | - *
Type: bool, default: true.
const OPT_COMPRESSION = -1001; const OPT_COMPRESSION_TYPE = -1004; - /** - * This can be used to create a "domain" for your item keys. The value - * specified here will be prefixed to each of the keys. It cannot be - * longer than 128 characters and will reduce the - * maximum available key size. The prefix is applied only to the item keys, - * not to the server keys. - *Type: string, default: "".
const OPT_PREFIX_KEY = -1002; - /** - * Specifies the serializer to use for serializing non-scalar values. - * The valid serializers are Memcached::SERIALIZER_PHP - * or Memcached::SERIALIZER_IGBINARY. The latter is - * supported only when memcached is configured with - * --enable-memcached-igbinary option and the - * igbinary extension is loaded. - *Type: int, default: Memcached::SERIALIZER_PHP.
const OPT_SERIALIZER = -1003; const OPT_USER_FLAGS = -1006; const OPT_STORE_RETRY_COUNT = -1005; - /** - * Indicates whether igbinary serializer support is available. - *Type: bool.
const HAVE_IGBINARY = true; - /** - * Indicates whether JSON serializer support is available. - *Type: bool.
const HAVE_JSON = true; - /** - * Indicates whether msgpack serializer support is available. - *Type: bool.
- *Available as of Memcached 3.0.0.
const HAVE_MSGPACK = true; const HAVE_ENCODING = true; - /** - * Type: bool. - *Available as of Memcached 3.0.0.
const HAVE_SESSION = true; - /** - * Type: bool. - *Available as of Memcached 3.0.0.
const HAVE_SASL = false; - /** - * Specifies the hashing algorithm used for the item keys. The valid - * values are supplied via Memcached::HASH_* constants. - * Each hash algorithm has its advantages and its disadvantages. Go with the - * default if you don't know or don't care. - *Type: int, default: Memcached::HASH_DEFAULT
const OPT_HASH = 2; - /** - * The default (Jenkins one-at-a-time) item key hashing algorithm. const HASH_DEFAULT = 0; - /** - * MD5 item key hashing algorithm. const HASH_MD5 = 1; - /** - * CRC item key hashing algorithm. const HASH_CRC = 2; - /** - * FNV1_64 item key hashing algorithm. const HASH_FNV1_64 = 3; - /** - * FNV1_64A item key hashing algorithm. const HASH_FNV1A_64 = 4; - /** - * FNV1_32 item key hashing algorithm. const HASH_FNV1_32 = 5; - /** - * FNV1_32A item key hashing algorithm. const HASH_FNV1A_32 = 6; - /** - * Hsieh item key hashing algorithm. const HASH_HSIEH = 7; - /** - * Murmur item key hashing algorithm. const HASH_MURMUR = 8; - /** - * Specifies the method of distributing item keys to the servers. - * Currently supported methods are modulo and consistent hashing. Consistent - * hashing delivers better distribution and allows servers to be added to - * the cluster with minimal cache losses. - *Type: int, default: Memcached::DISTRIBUTION_MODULA.
const OPT_DISTRIBUTION = 9; - /** - * Modulo-based key distribution algorithm. const DISTRIBUTION_MODULA = 0; - /** - * Consistent hashing key distribution algorithm (based on libketama). const DISTRIBUTION_CONSISTENT = 1; const DISTRIBUTION_VIRTUAL_BUCKET = 6; - /** - * Enables or disables compatibility with libketama-like behavior. When - * enabled, the item key hashing algorithm is set to MD5 and distribution is - * set to be weighted consistent hashing distribution. This is useful - * because other libketama-based clients (Python, Ruby, etc.) with the same - * server configuration will be able to access the keys transparently. - *It is highly recommended to enable this option if you want to use - * consistent hashing, and it may be enabled by default in future - * releases.
- *Type: bool, default: false.
const OPT_LIBKETAMA_COMPATIBLE = 16; const OPT_LIBKETAMA_HASH = 17; const OPT_TCP_KEEPALIVE = 32; - /** - * Enables or disables buffered I/O. Enabling buffered I/O causes - * storage commands to "buffer" instead of being sent. Any action that - * retrieves data causes this buffer to be sent to the remote connection. - * Quitting the connection or closing down the connection will also cause - * the buffered data to be pushed to the remote connection. - *Type: bool, default: false.
const OPT_BUFFER_WRITES = 10; - /** - * Enable the use of the binary protocol. Please note that you cannot - * toggle this option on an open connection. - *Type: bool, default: false.
const OPT_BINARY_PROTOCOL = 18; - /** - * Enables or disables asynchronous I/O. This is the fastest transport - * available for storage functions. - *Type: bool, default: false.
const OPT_NO_BLOCK = 0; - /** - * Enables or disables the no-delay feature for connecting sockets (may - * be faster in some environments). - *Type: bool, default: false.
const OPT_TCP_NODELAY = 1; - /** - * The maximum socket send buffer in bytes. - *Type: int, default: varies by platform/kernel - * configuration.
const OPT_SOCKET_SEND_SIZE = 4; - /** - * The maximum socket receive buffer in bytes. - *Type: int, default: varies by platform/kernel - * configuration.
const OPT_SOCKET_RECV_SIZE = 5; - /** - * In non-blocking mode this set the value of the timeout during socket - * connection, in milliseconds. - *Type: int, default: 1000.
const OPT_CONNECT_TIMEOUT = 14; - /** - * The amount of time, in seconds, to wait until retrying a failed - * connection attempt. - *Type: int, default: 0.
const OPT_RETRY_TIMEOUT = 15; const OPT_DEAD_TIMEOUT = 36; - /** - * Socket sending timeout, in microseconds. In cases where you cannot - * use non-blocking I/O this will allow you to still have timeouts on the - * sending of data. - *Type: int, default: 0.
const OPT_SEND_TIMEOUT = 19; - /** - * Socket reading timeout, in microseconds. In cases where you cannot - * use non-blocking I/O this will allow you to still have timeouts on the - * reading of data. - *Type: int, default: 0.
const OPT_RECV_TIMEOUT = 20; - /** - * Timeout for connection polling, in milliseconds. - *Type: int, default: 1000.
const OPT_POLL_TIMEOUT = 8; - /** - * Enables or disables caching of DNS lookups. - *Type: bool, default: false.
const OPT_CACHE_LOOKUPS = 6; - /** - * Specifies the failure limit for server connection attempts. The - * server will be removed after this many continuous connection - * failures. - *Type: int, default: 0.
const OPT_SERVER_FAILURE_LIMIT = 21; const OPT_AUTO_EJECT_HOSTS = 28; const OPT_HASH_WITH_PREFIX_KEY = 25; - /** - * Enables or disables ignoring the result of storage commands - * (set, add, replace, append, prepend, delete, increment, decrement, etc.). - * Storage commands will be sent without spending time waiting for a reply - * (there would be no reply). - * Retrieval commands such as Memcached::get are unaffected by this setting. - *Type: bool, default: false.
const OPT_NOREPLY = 26; const OPT_SORT_HOSTS = 12; const OPT_VERIFY_KEY = 13; @@ -205,79 +57,37 @@ class Memcached { const OPT_RANDOMIZE_REPLICA_READ = 30; const OPT_REMOVE_FAILED_SERVERS = 35; const OPT_SERVER_TIMEOUT_LIMIT = 37; - /** - * The operation was successful. const RES_SUCCESS = 0; - /** - * The operation failed in some fashion. const RES_FAILURE = 1; - /** - * DNS lookup failed. const RES_HOST_LOOKUP_FAILURE = 2; const RES_CONNECTION_FAILURE = 3; const RES_CONNECTION_BIND_FAILURE = 4; - /** - * Failed to write network data. const RES_WRITE_FAILURE = 5; const RES_READ_FAILURE = 6; - /** - * Failed to read network data. const RES_UNKNOWN_READ_FAILURE = 7; - /** - * Bad command in memcached protocol. const RES_PROTOCOL_ERROR = 8; - /** - * Error on the client side. const RES_CLIENT_ERROR = 9; - /** - * Error on the server side. const RES_SERVER_ERROR = 10; - /** - * Failed to do compare-and-swap: item you are trying to store has been - * modified since you last fetched it. const RES_DATA_EXISTS = 12; const RES_DATA_DOES_NOT_EXIST = 13; - /** - * Item was not stored: but not because of an error. This normally - * means that either the condition for an "add" or a "replace" command - * wasn't met, or that the item is in a delete queue. const RES_NOTSTORED = 14; const RES_STORED = 15; - /** - * Item with this key was not found (with "get" operation or "cas" - * operations). const RES_NOTFOUND = 16; - /** - * Partial network data read error. const RES_PARTIAL_READ = 18; - /** - * Some errors occurred during multi-get. const RES_SOME_ERRORS = 19; - /** - * Server list is empty. const RES_NO_SERVERS = 20; - /** - * End of result set. const RES_END = 21; const RES_DELETED = 22; const RES_VALUE = 23; const RES_STAT = 24; const RES_ITEM = 25; - /** - * System error. const RES_ERRNO = 26; const RES_FAIL_UNIX_SOCKET = 27; const RES_NOT_SUPPORTED = 28; const RES_NO_KEY_PROVIDED = 29; const RES_FETCH_NOTFINISHED = 30; - /** - * The operation timed out. const RES_TIMEOUT = 31; - /** - * The operation was buffered. const RES_BUFFERED = 32; - /** - * Bad key. const RES_BAD_KEY_PROVIDED = 33; const RES_INVALID_HOST_PROTOCOL = 34; const RES_SERVER_MARKED_DEAD = 35; @@ -289,505 +99,331 @@ class Memcached { const RES_IN_PROGRESS = 46; const RES_MAXIMUM_RETURN = 49; const RES_MEMORY_ALLOCATION_FAILURE = 17; - /** - * Failed to create network socket. const RES_CONNECTION_SOCKET_CREATE_FAILURE = 11; - /** - * Available as of Memcached 3.0.0. const RES_E2BIG = 37; - /** - * Available as of Memcached 3.0.0. const RES_KEY_TOO_BIG = 39; - /** - * Available as of Memcached 3.0.0. const RES_SERVER_TEMPORARILY_DISABLED = 47; - /** - * Available as of Memcached 3.0.0. const RES_SERVER_MEMORY_ALLOCATION_FAILURE = 48; - /** - * Payload failure: could not compress/decompress or serialize/unserialize the value. const RES_PAYLOAD_FAILURE = -1001; - /** - * The default PHP serializer. const SERIALIZER_PHP = 1; - /** - * The igbinary serializer. - * Instead of textual representation it stores PHP data structures in a - * compact binary form, resulting in space and time gains. const SERIALIZER_IGBINARY = 2; - /** - * The JSON serializer. const SERIALIZER_JSON = 3; const SERIALIZER_JSON_ARRAY = 4; const SERIALIZER_MSGPACK = 5; const COMPRESSION_FASTLZ = 2; const COMPRESSION_ZLIB = 1; - /** - * A flag for Memcached::getMulti and - * Memcached::getMultiByKey to ensure that the keys are - * returned in the same order as they were requested in. Non-existing keys - * get a default value of NULL. const GET_PRESERVE_ORDER = 1; - /** - * A flag for Memcached::get, Memcached::getMulti and - * Memcached::getMultiByKey to ensure that the CAS token values - * are returned as well. - *Available as of Memcached 3.0.0.
const GET_EXTENDED = 2; const GET_ERROR_RETURN_VALUE = false; /** - * Create a Memcached instance - * @link http://www.php.net/manual/en/memcached.construct.php - * @param string|null $persistent_id [optional] - * @return string|null + * {@inheritdoc} + * @param string|null $persistent_id [optional] + * @param callable|null $callback [optional] + * @param string|null $connection_str [optional] */ - public function __construct (?string $persistent_id = null): ?string {} + public function __construct (?string $persistent_id = NULL, ?callable $callback = NULL, ?string $connection_str = NULL) {} /** - * Return the result code of the last operation - * @link http://www.php.net/manual/en/memcached.getresultcode.php - * @return int Result code of the last Memcached operation. + * {@inheritdoc} */ public function getResultCode (): int {} /** - * Return the message describing the result of the last operation - * @link http://www.php.net/manual/en/memcached.getresultmessage.php - * @return string Message describing the result of the last Memcached operation. + * {@inheritdoc} */ public function getResultMessage (): string {} /** - * Retrieve an item - * @link http://www.php.net/manual/en/memcached.get.php - * @param string $key - * @param callable $cache_cb [optional] - * @param int $flags [optional] - * @return mixed Returns the value stored in the cache or false otherwise. - * If the flags is set to Memcached::GET_EXTENDED, - * an array containing the value and the CAS token is returned instead of only the value. - * The Memcached::getResultCode will return - * Memcached::RES_NOTFOUND if the key does not exist. + * {@inheritdoc} + * @param string $key + * @param callable|null $cache_cb [optional] + * @param int $get_flags [optional] */ - public function get (string $key, callable $cache_cb = null, int $flags = null): mixed {} + public function get (string $key, ?callable $cache_cb = NULL, int $get_flags = 0): mixed {} /** - * Retrieve an item from a specific server - * @link http://www.php.net/manual/en/memcached.getbykey.php - * @param string $server_key - * @param string $key - * @param callable $cache_cb [optional] - * @param int $flags [optional] - * @return mixed Returns the value stored in the cache or false otherwise. - * The Memcached::getResultCode will return - * Memcached::RES_NOTFOUND if the key does not exist. + * {@inheritdoc} + * @param string $server_key + * @param string $key + * @param callable|null $cache_cb [optional] + * @param int $get_flags [optional] */ - public function getByKey (string $server_key, string $key, callable $cache_cb = null, int $flags = null): mixed {} + public function getByKey (string $server_key, string $key, ?callable $cache_cb = NULL, int $get_flags = 0): mixed {} /** - * Retrieve multiple items - * @link http://www.php.net/manual/en/memcached.getmulti.php - * @param array $keys - * @param int $flags [optional] - * @return mixed Returns the array of found items or false on failure. - * Use Memcached::getResultCode if necessary. + * {@inheritdoc} + * @param array $keys + * @param int $get_flags [optional] */ - public function getMulti (array $keys, int $flags = null): mixed {} + public function getMulti (array $keys, int $get_flags = 0): array|false {} /** - * Retrieve multiple items from a specific server - * @link http://www.php.net/manual/en/memcached.getmultibykey.php - * @param string $server_key - * @param array $keys - * @param int $flags [optional] - * @return array|false Returns the array of found items or false on failure. - * Use Memcached::getResultCode if necessary. + * {@inheritdoc} + * @param string $server_key + * @param array $keys + * @param int $get_flags [optional] */ - public function getMultiByKey (string $server_key, array $keys, int $flags = null): array|false {} + public function getMultiByKey (string $server_key, array $keys, int $get_flags = 0): array|false {} /** - * Request multiple items - * @link http://www.php.net/manual/en/memcached.getdelayed.php - * @param array $keys - * @param bool $with_cas [optional] - * @param callable $value_cb [optional] - * @return bool Returns true on success or false on failure. - * Use Memcached::getResultCode if necessary. + * {@inheritdoc} + * @param array $keys + * @param bool $with_cas [optional] + * @param callable|null $value_cb [optional] */ - public function getDelayed (array $keys, bool $with_cas = null, callable $value_cb = null): bool {} + public function getDelayed (array $keys, bool $with_cas = false, ?callable $value_cb = NULL): bool {} /** - * Request multiple items from a specific server - * @link http://www.php.net/manual/en/memcached.getdelayedbykey.php - * @param string $server_key - * @param array $keys - * @param bool $with_cas [optional] - * @param callable $value_cb [optional] - * @return bool Returns true on success or false on failure. - * Use Memcached::getResultCode if necessary. + * {@inheritdoc} + * @param string $server_key + * @param array $keys + * @param bool $with_cas [optional] + * @param callable|null $value_cb [optional] */ - public function getDelayedByKey (string $server_key, array $keys, bool $with_cas = null, callable $value_cb = null): bool {} + public function getDelayedByKey (string $server_key, array $keys, bool $with_cas = false, ?callable $value_cb = NULL): bool {} /** - * Fetch the next result - * @link http://www.php.net/manual/en/memcached.fetch.php - * @return array Returns the next result or false otherwise. - * The Memcached::getResultCode will return - * Memcached::RES_END if result set is exhausted. + * {@inheritdoc} */ - public function fetch (): array {} + public function fetch (): array|false {} /** - * Fetch all the remaining results - * @link http://www.php.net/manual/en/memcached.fetchall.php - * @return array|false Returns the results or false on failure. - * Use Memcached::getResultCode if necessary. + * {@inheritdoc} */ public function fetchAll (): array|false {} /** - * Store an item - * @link http://www.php.net/manual/en/memcached.set.php - * @param string $key - * @param mixed $value - * @param int $expiration [optional] - * @return bool Returns true on success or false on failure. - * Use Memcached::getResultCode if necessary. + * {@inheritdoc} + * @param string $key + * @param mixed $value + * @param int $expiration [optional] */ - public function set (string $key, mixed $value, int $expiration = null): bool {} + public function set (string $key, mixed $value = null, int $expiration = 0): bool {} /** - * Store an item on a specific server - * @link http://www.php.net/manual/en/memcached.setbykey.php - * @param string $server_key - * @param string $key - * @param mixed $value - * @param int $expiration [optional] - * @return bool Returns true on success or false on failure. - * Use Memcached::getResultCode if necessary. + * {@inheritdoc} + * @param string $server_key + * @param string $key + * @param mixed $value + * @param int $expiration [optional] */ - public function setByKey (string $server_key, string $key, mixed $value, int $expiration = null): bool {} + public function setByKey (string $server_key, string $key, mixed $value = null, int $expiration = 0): bool {} /** - * Set a new expiration on an item - * @link http://www.php.net/manual/en/memcached.touch.php - * @param string $key - * @param int $expiration - * @return bool Returns true on success or false on failure. - * Use Memcached::getResultCode if necessary. + * {@inheritdoc} + * @param string $key + * @param int $expiration [optional] */ - public function touch (string $key, int $expiration): bool {} + public function touch (string $key, int $expiration = 0): bool {} /** - * Set a new expiration on an item on a specific server - * @link http://www.php.net/manual/en/memcached.touchbykey.php - * @param string $server_key - * @param string $key - * @param int $expiration - * @return bool Returns true on success or false on failure. - * Use Memcached::getResultCode if necessary. + * {@inheritdoc} + * @param string $server_key + * @param string $key + * @param int $expiration [optional] */ - public function touchByKey (string $server_key, string $key, int $expiration): bool {} + public function touchByKey (string $server_key, string $key, int $expiration = 0): bool {} /** - * Store multiple items - * @link http://www.php.net/manual/en/memcached.setmulti.php - * @param array $items - * @param int $expiration [optional] - * @return bool Returns true on success or false on failure. - * Use Memcached::getResultCode if necessary. + * {@inheritdoc} + * @param array $items + * @param int $expiration [optional] */ - public function setMulti (array $items, int $expiration = null): bool {} + public function setMulti (array $items, int $expiration = 0): bool {} /** - * Store multiple items on a specific server - * @link http://www.php.net/manual/en/memcached.setmultibykey.php - * @param string $server_key - * @param array $items - * @param int $expiration [optional] - * @return bool Returns true on success or false on failure. - * Use Memcached::getResultCode if necessary. + * {@inheritdoc} + * @param string $server_key + * @param array $items + * @param int $expiration [optional] */ - public function setMultiByKey (string $server_key, array $items, int $expiration = null): bool {} + public function setMultiByKey (string $server_key, array $items, int $expiration = 0): bool {} /** - * Compare and swap an item - * @link http://www.php.net/manual/en/memcached.cas.php - * @param float $cas_token - * @param string $key - * @param mixed $value - * @param int $expiration [optional] - * @return bool Returns true on success or false on failure. - * The Memcached::getResultCode will return - * Memcached::RES_DATA_EXISTS if the item you are trying - * to store has been modified since you last fetched it. + * {@inheritdoc} + * @param string $cas_token + * @param string $key + * @param mixed $value + * @param int $expiration [optional] */ - public function cas (float $cas_token, string $key, mixed $value, int $expiration = null): bool {} + public function cas (string $cas_token, string $key, mixed $value = null, int $expiration = 0): bool {} /** - * Compare and swap an item on a specific server - * @link http://www.php.net/manual/en/memcached.casbykey.php - * @param float $cas_token - * @param string $server_key - * @param string $key - * @param mixed $value - * @param int $expiration [optional] - * @return bool Returns true on success or false on failure. - * The Memcached::getResultCode will return - * Memcached::RES_DATA_EXISTS if the item you are trying - * to store has been modified since you last fetched it. + * {@inheritdoc} + * @param string $cas_token + * @param string $server_key + * @param string $key + * @param mixed $value + * @param int $expiration [optional] + */ + public function casByKey (string $cas_token, string $server_key, string $key, mixed $value = null, int $expiration = 0): bool {} + + /** + * {@inheritdoc} + * @param string $key + * @param mixed $value + * @param int $expiration [optional] + */ + public function add (string $key, mixed $value = null, int $expiration = 0): bool {} + + /** + * {@inheritdoc} + * @param string $server_key + * @param string $key + * @param mixed $value + * @param int $expiration [optional] + */ + public function addByKey (string $server_key, string $key, mixed $value = null, int $expiration = 0): bool {} + + /** + * {@inheritdoc} + * @param string $key + * @param string $value + */ + public function append (string $key, string $value): ?bool {} + + /** + * {@inheritdoc} + * @param string $server_key + * @param string $key + * @param string $value + */ + public function appendByKey (string $server_key, string $key, string $value): ?bool {} + + /** + * {@inheritdoc} + * @param string $key + * @param string $value */ - public function casByKey (float $cas_token, string $server_key, string $key, mixed $value, int $expiration = null): bool {} + public function prepend (string $key, string $value): ?bool {} /** - * Add an item under a new key - * @link http://www.php.net/manual/en/memcached.add.php - * @param string $key - * @param mixed $value - * @param int $expiration [optional] - * @return bool Returns true on success or false on failure. - * The Memcached::getResultCode will return - * Memcached::RES_NOTSTORED if the key already exists. + * {@inheritdoc} + * @param string $server_key + * @param string $key + * @param string $value */ - public function add (string $key, mixed $value, int $expiration = null): bool {} + public function prependByKey (string $server_key, string $key, string $value): ?bool {} /** - * Add an item under a new key on a specific server - * @link http://www.php.net/manual/en/memcached.addbykey.php - * @param string $server_key - * @param string $key - * @param mixed $value - * @param int $expiration [optional] - * @return bool Returns true on success or false on failure. - * The Memcached::getResultCode will return - * Memcached::RES_NOTSTORED if the key already exists. - */ - public function addByKey (string $server_key, string $key, mixed $value, int $expiration = null): bool {} + * {@inheritdoc} + * @param string $key + * @param mixed $value + * @param int $expiration [optional] + */ + public function replace (string $key, mixed $value = null, int $expiration = 0): bool {} /** - * Append data to an existing item - * @link http://www.php.net/manual/en/memcached.append.php - * @param string $key - * @param string $value - * @return bool Returns true on success or false on failure. - * The Memcached::getResultCode will return - * Memcached::RES_NOTSTORED if the key does not exist. - */ - public function append (string $key, string $value): bool {} + * {@inheritdoc} + * @param string $server_key + * @param string $key + * @param mixed $value + * @param int $expiration [optional] + */ + public function replaceByKey (string $server_key, string $key, mixed $value = null, int $expiration = 0): bool {} /** - * Append data to an existing item on a specific server - * @link http://www.php.net/manual/en/memcached.appendbykey.php - * @param string $server_key - * @param string $key - * @param string $value - * @return bool Returns true on success or false on failure. - * The Memcached::getResultCode will return - * Memcached::RES_NOTSTORED if the key does not exist. - */ - public function appendByKey (string $server_key, string $key, string $value): bool {} - - /** - * Prepend data to an existing item - * @link http://www.php.net/manual/en/memcached.prepend.php - * @param string $key - * @param string $value - * @return bool Returns true on success or false on failure. - * The Memcached::getResultCode will return - * Memcached::RES_NOTSTORED if the key does not exist. - */ - public function prepend (string $key, string $value): bool {} - - /** - * Prepend data to an existing item on a specific server - * @link http://www.php.net/manual/en/memcached.prependbykey.php - * @param string $server_key - * @param string $key - * @param string $value - * @return bool Returns true on success or false on failure. - * The Memcached::getResultCode will return - * Memcached::RES_NOTSTORED if the key does not exist. - */ - public function prependByKey (string $server_key, string $key, string $value): bool {} - - /** - * Replace the item under an existing key - * @link http://www.php.net/manual/en/memcached.replace.php - * @param string $key - * @param mixed $value - * @param int $expiration [optional] - * @return bool Returns true on success or false on failure. - * The Memcached::getResultCode will return - * Memcached::RES_NOTSTORED if the key does not exist. - */ - public function replace (string $key, mixed $value, int $expiration = null): bool {} - - /** - * Replace the item under an existing key on a specific server - * @link http://www.php.net/manual/en/memcached.replacebykey.php - * @param string $server_key - * @param string $key - * @param mixed $value - * @param int $expiration [optional] - * @return bool Returns true on success or false on failure. - * The Memcached::getResultCode will return - * Memcached::RES_NOTSTORED if the key does not exist. - */ - public function replaceByKey (string $server_key, string $key, mixed $value, int $expiration = null): bool {} - - /** - * Delete an item - * @link http://www.php.net/manual/en/memcached.delete.php - * @param string $key - * @param int $time [optional] - * @return bool Returns true on success or false on failure. - * The Memcached::getResultCode will return - * Memcached::RES_NOTFOUND if the key does not exist. - */ - public function delete (string $key, int $time = null): bool {} - - /** - * Delete multiple items - * @link http://www.php.net/manual/en/memcached.deletemulti.php - * @param array $keys - * @param int $time [optional] - * @return array > - * Returns an array indexed by keys. Each element - * is true if the corresponding key was deleted, or one of the - * Memcached::RES_* constants if the corresponding deletion - * failed. - *> - * The Memcached::getResultCode will return - * the result code for the last executed delete operation, that is, the delete - * operation for the last element of keys.
+ * {@inheritdoc} + * @param string $key + * @param int $time [optional] */ - public function deleteMulti (array $keys, int $time = null): array {} + public function delete (string $key, int $time = 0): bool {} /** - * Delete an item from a specific server - * @link http://www.php.net/manual/en/memcached.deletebykey.php - * @param string $server_key - * @param string $key - * @param int $time [optional] - * @return bool Returns true on success or false on failure. - * The Memcached::getResultCode will return - * Memcached::RES_NOTFOUND if the key does not exist. + * {@inheritdoc} + * @param array $keys + * @param int $time [optional] */ - public function deleteByKey (string $server_key, string $key, int $time = null): bool {} + public function deleteMulti (array $keys, int $time = 0): array {} - /** - * Delete multiple items from a specific server - * @link http://www.php.net/manual/en/memcached.deletemultibykey.php - * @param string $server_key - * @param array $keys - * @param int $time [optional] - * @return bool > - * Returns an array indexed by keys. Each element - * is true if the corresponding key was deleted, or one of the - * Memcached::RES_* constants if the corresponding deletion - * failed. - *> - * The Memcached::getResultCode will return - * the result code for the last executed delete operation, that is, the delete - * operation for the last element of keys.
- */ - public function deleteMultiByKey (string $server_key, array $keys, int $time = null): bool {} + /** + * {@inheritdoc} + * @param string $server_key + * @param string $key + * @param int $time [optional] + */ + public function deleteByKey (string $server_key, string $key, int $time = 0): bool {} /** - * Increment numeric item's value - * @link http://www.php.net/manual/en/memcached.increment.php - * @param string $key - * @param int $offset [optional] - * @param int $initial_value [optional] - * @param int $expiry [optional] - * @return int|false Returns new item's value on success or false on failure. - */ - public function increment (string $key, int $offset = 1, int $initial_value = null, int $expiry = null): int|false {} - + * {@inheritdoc} + * @param string $server_key + * @param array $keys + * @param int $time [optional] + */ + public function deleteMultiByKey (string $server_key, array $keys, int $time = 0): array {} + /** - * Decrement numeric item's value - * @link http://www.php.net/manual/en/memcached.decrement.php - * @param string $key - * @param int $offset [optional] - * @param int $initial_value [optional] - * @param int $expiry [optional] - * @return int|false Returns item's new value on success or false on failure. - */ - public function decrement (string $key, int $offset = 1, int $initial_value = null, int $expiry = null): int|false {} - - /** - * Increment numeric item's value, stored on a specific server - * @link http://www.php.net/manual/en/memcached.incrementbykey.php - * @param string $server_key - * @param string $key - * @param int $offset [optional] - * @param int $initial_value [optional] - * @param int $expiry [optional] - * @return int|false Returns new item's value on success or false on failure. - */ - public function incrementByKey (string $server_key, string $key, int $offset = 1, int $initial_value = null, int $expiry = null): int|false {} - - /** - * Decrement numeric item's value, stored on a specific server - * @link http://www.php.net/manual/en/memcached.decrementbykey.php - * @param string $server_key - * @param string $key - * @param int $offset [optional] - * @param int $initial_value [optional] - * @param int $expiry [optional] - * @return int|false Returns item's new value on success or false on failure. - */ - public function decrementByKey (string $server_key, string $key, int $offset = 1, int $initial_value = null, int $expiry = null): int|false {} - - /** - * Add a server to the server pool - * @link http://www.php.net/manual/en/memcached.addserver.php - * @param string $host - * @param int $port - * @param int $weight [optional] - * @return bool Returns true on success or false on failure. - */ - public function addServer (string $host, int $port, int $weight = null): bool {} - - /** - * Add multiple servers to the server pool - * @link http://www.php.net/manual/en/memcached.addservers.php - * @param array $servers - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $key + * @param int $offset [optional] + * @param int $initial_value [optional] + * @param int $expiry [optional] + */ + public function increment (string $key, int $offset = 1, int $initial_value = 0, int $expiry = 0): int|false {} + + /** + * {@inheritdoc} + * @param string $key + * @param int $offset [optional] + * @param int $initial_value [optional] + * @param int $expiry [optional] + */ + public function decrement (string $key, int $offset = 1, int $initial_value = 0, int $expiry = 0): int|false {} + + /** + * {@inheritdoc} + * @param string $server_key + * @param string $key + * @param int $offset [optional] + * @param int $initial_value [optional] + * @param int $expiry [optional] + */ + public function incrementByKey (string $server_key, string $key, int $offset = 1, int $initial_value = 0, int $expiry = 0): int|false {} + + /** + * {@inheritdoc} + * @param string $server_key + * @param string $key + * @param int $offset [optional] + * @param int $initial_value [optional] + * @param int $expiry [optional] + */ + public function decrementByKey (string $server_key, string $key, int $offset = 1, int $initial_value = 0, int $expiry = 0): int|false {} + + /** + * {@inheritdoc} + * @param string $host + * @param int $port + * @param int $weight [optional] + */ + public function addServer (string $host, int $port, int $weight = 0): bool {} + + /** + * {@inheritdoc} + * @param array $servers */ public function addServers (array $servers): bool {} /** - * Get the list of the servers in the pool - * @link http://www.php.net/manual/en/memcached.getserverlist.php - * @return array The list of all servers in the server pool. + * {@inheritdoc} */ public function getServerList (): array {} /** - * Map a key to a server - * @link http://www.php.net/manual/en/memcached.getserverbykey.php - * @param string $server_key - * @return array Returns an array containing three keys of host, - * port, and weight on success or false - * on failure. - * Use Memcached::getResultCode if necessary. + * {@inheritdoc} + * @param string $server_key */ - public function getServerByKey (string $server_key): array {} + public function getServerByKey (string $server_key): array|false {} /** - * Clears all servers from the server list - * @link http://www.php.net/manual/en/memcached.resetserverlist.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ public function resetServerList (): bool {} /** - * Close any open connections - * @link http://www.php.net/manual/en/memcached.quit.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ public function quit (): bool {} @@ -817,60 +453,43 @@ public function getLastErrorErrno (): int {} public function getLastDisconnectedServer (): array|false {} /** - * Get server pool statistics - * @link http://www.php.net/manual/en/memcached.getstats.php + * {@inheritdoc} * @param string|null $type [optional] - * @return array|false Array of server statistics, one entry per server, or false on failure. */ public function getStats (?string $type = NULL): array|false {} /** - * Get server pool version info - * @link http://www.php.net/manual/en/memcached.getversion.php - * @return array Array of server versions, one entry per server. + * {@inheritdoc} */ - public function getVersion (): array {} + public function getVersion (): array|false {} /** - * Gets the keys stored on all the servers - * @link http://www.php.net/manual/en/memcached.getallkeys.php - * @return array|false Returns the keys stored on all the servers on success or false on failure. + * {@inheritdoc} */ public function getAllKeys (): array|false {} /** - * Invalidate all items in the cache - * @link http://www.php.net/manual/en/memcached.flush.php - * @param int $delay [optional] - * @return bool Returns true on success or false on failure. - * Use Memcached::getResultCode if necessary. + * {@inheritdoc} + * @param int $delay [optional] */ - public function flush (int $delay = null): bool {} + public function flush (int $delay = 0): bool {} /** - * Retrieve a Memcached option value - * @link http://www.php.net/manual/en/memcached.getoption.php - * @param int $option - * @return mixed Returns the value of the requested option, or false on - * error. + * {@inheritdoc} + * @param int $option */ public function getOption (int $option): mixed {} /** - * Set a Memcached option - * @link http://www.php.net/manual/en/memcached.setoption.php - * @param int $option - * @param mixed $value - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $option + * @param mixed $value */ - public function setOption (int $option, mixed $value): bool {} + public function setOption (int $option, mixed $value = null): bool {} /** - * Set Memcached options - * @link http://www.php.net/manual/en/memcached.setoptions.php - * @param array $options An associative array of options where the key is the option to set and - * the value is the new value for the option. - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param array $options */ public function setOptions (array $options): bool {} @@ -889,16 +508,12 @@ public function setBucket (array $host_map, ?array $forward_map = null, int $rep public function setEncodingKey (string $key): bool {} /** - * Check if a persitent connection to memcache is being used - * @link http://www.php.net/manual/en/memcached.ispersistent.php - * @return bool Returns true if Memcache instance uses a persistent connection, false otherwise. + * {@inheritdoc} */ public function isPersistent (): bool {} /** - * Check if the instance was recently created - * @link http://www.php.net/manual/en/memcached.ispristine.php - * @return bool Returns the true if instance is recently created, false otherwise. + * {@inheritdoc} */ public function isPristine (): bool {} @@ -910,20 +525,15 @@ public function checkKey (string $key): bool {} } -/** - * @link http://www.php.net/manual/en/class.memcachedexception.php - */ class MemcachedException extends RuntimeException implements Stringable, Throwable { /** - * Construct the exception - * @link http://www.php.net/manual/en/exception.construct.php - * @param string $message [optional] - * @param int $code [optional] - * @param Throwable|null $previous [optional] - * @return string + * {@inheritdoc} + * @param string $message [optional] + * @param int $code [optional] + * @param Throwable|null $previous [optional] */ - public function __construct (string $message = '""', int $code = null, ?Throwable $previous = null): string {} + public function __construct (string $message = '', int $code = 0, ?Throwable $previous = NULL) {} /** * {@inheritdoc} @@ -931,62 +541,42 @@ public function __construct (string $message = '""', int $code = null, ?Throwabl public function __wakeup () {} /** - * Gets the Exception message - * @link http://www.php.net/manual/en/exception.getmessage.php - * @return string Returns the Exception message as a string. + * {@inheritdoc} */ final public function getMessage (): string {} /** - * Gets the Exception code - * @link http://www.php.net/manual/en/exception.getcode.php - * @return int Returns the exception code as int in - * Exception but possibly as other type in - * Exception descendants (for example as - * string in PDOException). + * {@inheritdoc} */ - final public function getCode (): int {} + final public function getCode () {} /** - * Gets the file in which the exception was created - * @link http://www.php.net/manual/en/exception.getfile.php - * @return string Returns the filename in which the exception was created. + * {@inheritdoc} */ final public function getFile (): string {} /** - * Gets the line in which the exception was created - * @link http://www.php.net/manual/en/exception.getline.php - * @return int Returns the line number where the exception was created. + * {@inheritdoc} */ final public function getLine (): int {} /** - * Gets the stack trace - * @link http://www.php.net/manual/en/exception.gettrace.php - * @return array Returns the Exception stack trace as an array. + * {@inheritdoc} */ final public function getTrace (): array {} /** - * Returns previous Throwable - * @link http://www.php.net/manual/en/exception.getprevious.php - * @return Throwable|null Returns the previous Throwable if available - * or null otherwise. + * {@inheritdoc} */ final public function getPrevious (): ?Throwable {} /** - * Gets the stack trace as a string - * @link http://www.php.net/manual/en/exception.gettraceasstring.php - * @return string Returns the Exception stack trace as a string. + * {@inheritdoc} */ final public function getTraceAsString (): string {} /** - * String representation of the exception - * @link http://www.php.net/manual/en/exception.tostring.php - * @return string Returns the string representation of the exception. + * {@inheritdoc} */ public function __toString (): string {} diff --git a/plugins/org.eclipse.php.core/Resources/language/php8.3/mongodb.php b/plugins/org.eclipse.php.core/Resources/language/php8.3/mongodb.php index 354e67f09a..1d20723bd6 100644 --- a/plugins/org.eclipse.php.core/Resources/language/php8.3/mongodb.php +++ b/plugins/org.eclipse.php.core/Resources/language/php8.3/mongodb.php @@ -1,314 +1,430 @@ Historically, other drivers encoded values with this type based on their language conventions (e.g. varying endianness), which makes it non-portable. The PHP driver applies no special handling for encoding or decoding data with this type. - const TYPE_OLD_UUID = 3; + * {@inheritdoc} + */ + final public function next (): void {} + /** - * Universally unique identifier. When using this type, the Binary's data should be 16 bytes in length and encoded according to RFC 4122. - const TYPE_UUID = 4; + * {@inheritdoc} + */ + final public function rewind (): void {} + /** - * MD5 hash. When using this type, the Binary's data should be 16 bytes in length. - const TYPE_MD5 = 5; + * {@inheritdoc} + */ + final public function valid (): bool {} + /** - * Encrypted value. This subtype is used for client-side encryption. - const TYPE_ENCRYPTED = 6; + * {@inheritdoc} + */ + final public function __wakeup (): void {} + +} + +final class PackedArray implements \Stringable, \IteratorAggregate, \Traversable, \Serializable, \ArrayAccess, \MongoDB\BSON\Type { + /** - * Column data. This subtype is used for time-series collections. - const TYPE_COLUMN = 7; + * {@inheritdoc} + */ + private function __construct () {} + + /** + * {@inheritdoc} + * @param array $value + */ + final public static function fromPHP (array $value): \MongoDB\BSON\PackedArray {} + + /** + * {@inheritdoc} + * @param int $index + */ + final public function get (int $index): mixed {} + + /** + * {@inheritdoc} + */ + final public function getIterator (): \MongoDB\BSON\Iterator {} + + /** + * {@inheritdoc} + * @param int $index + */ + final public function has (int $index): bool {} + + /** + * {@inheritdoc} + * @param array|null $typeMap [optional] + */ + final public function toPHP (?array $typeMap = NULL): object|array {} + + /** + * {@inheritdoc} + * @param mixed $key + */ + public function offsetExists (mixed $key = null): bool {} + + /** + * {@inheritdoc} + * @param mixed $key + */ + public function offsetGet (mixed $key = null): mixed {} + + /** + * {@inheritdoc} + * @param mixed $key + * @param mixed $value + */ + public function offsetSet (mixed $key = null, mixed $value = null): void {} + + /** + * {@inheritdoc} + * @param mixed $key + */ + public function offsetUnset (mixed $key = null): void {} + /** - * User-defined type. While types between 0 and 127 are predefined or reserved, types between 128 and 255 are user-defined and may be used for anything. + * {@inheritdoc} + */ + final public function __toString (): string {} + + /** + * {@inheritdoc} + * @param array $properties + */ + final public static function __set_state (array $properties): \MongoDB\BSON\PackedArray {} + + /** + * {@inheritdoc} + */ + final public function serialize (): string {} + + /** + * {@inheritdoc} + * @param string $data + */ + final public function unserialize (string $data): void {} + + /** + * {@inheritdoc} + * @param array $data + */ + final public function __unserialize (array $data): void {} + + /** + * {@inheritdoc} + */ + final public function __serialize (): array {} + +} + +final class Document implements \Stringable, \IteratorAggregate, \Traversable, \Serializable, \ArrayAccess, \MongoDB\BSON\Type { + + /** + * {@inheritdoc} + */ + private function __construct () {} + + /** + * {@inheritdoc} + * @param string $bson + */ + final public static function fromBSON (string $bson): \MongoDB\BSON\Document {} + + /** + * {@inheritdoc} + * @param string $json + */ + final public static function fromJSON (string $json): \MongoDB\BSON\Document {} + + /** + * {@inheritdoc} + * @param object|array $value + */ + final public static function fromPHP (object|array $value): \MongoDB\BSON\Document {} + + /** + * {@inheritdoc} + * @param string $key + */ + final public function get (string $key): mixed {} + + /** + * {@inheritdoc} + */ + final public function getIterator (): \MongoDB\BSON\Iterator {} + + /** + * {@inheritdoc} + * @param string $key + */ + final public function has (string $key): bool {} + + /** + * {@inheritdoc} + * @param array|null $typeMap [optional] + */ + final public function toPHP (?array $typeMap = NULL): object|array {} + + /** + * {@inheritdoc} + */ + final public function toCanonicalExtendedJSON (): string {} + + /** + * {@inheritdoc} + */ + final public function toRelaxedExtendedJSON (): string {} + + /** + * {@inheritdoc} + * @param mixed $key + */ + public function offsetExists (mixed $key = null): bool {} + + /** + * {@inheritdoc} + * @param mixed $key + */ + public function offsetGet (mixed $key = null): mixed {} + + /** + * {@inheritdoc} + * @param mixed $key + * @param mixed $value + */ + public function offsetSet (mixed $key = null, mixed $value = null): void {} + + /** + * {@inheritdoc} + * @param mixed $key + */ + public function offsetUnset (mixed $key = null): void {} + + /** + * {@inheritdoc} + */ + final public function __toString (): string {} + + /** + * {@inheritdoc} + * @param array $properties + */ + final public static function __set_state (array $properties): \MongoDB\BSON\Document {} + + /** + * {@inheritdoc} + */ + final public function serialize (): string {} + + /** + * {@inheritdoc} + * @param string $data + */ + final public function unserialize (string $data): void {} + + /** + * {@inheritdoc} + * @param array $data + */ + final public function __unserialize (array $data): void {} + + /** + * {@inheritdoc} + */ + final public function __serialize (): array {} + +} + +final class Binary implements \Stringable, \MongoDB\BSON\BinaryInterface, \JsonSerializable, \MongoDB\BSON\Type, \Serializable { + const TYPE_GENERIC = 0; + const TYPE_FUNCTION = 1; + const TYPE_OLD_BINARY = 2; + const TYPE_OLD_UUID = 3; + const TYPE_UUID = 4; + const TYPE_MD5 = 5; + const TYPE_ENCRYPTED = 6; + const TYPE_COLUMN = 7; + const TYPE_SENSITIVE = 8; const TYPE_USER_DEFINED = 128; /** - * Construct a new Binary - * @link http://www.php.net/manual/en/mongodb-bson-binary.construct.php - * @param string $data Binary data. - * @param int $type [optional] Unsigned 8-bit integer denoting the data's type. Defaults to MongoDB\BSON\Binary::TYPE_GENERIC if not specified. - * @return string + * {@inheritdoc} + * @param string $data + * @param int $type [optional] */ - final public function __construct (string $data, int $type = \MongoDB\BSON\Binary::TYPE_GENERIC): string {} + final public function __construct (string $data, int $type = 0) {} /** - * Returns the Binary's data - * @link http://www.php.net/manual/en/mongodb-bson-binary.getdata.php - * @return string Returns the Binary's data. + * {@inheritdoc} */ final public function getData (): string {} /** - * Returns the Binary's type - * @link http://www.php.net/manual/en/mongodb-bson-binary.gettype.php - * @return int Returns the Binary's type. + * {@inheritdoc} */ final public function getType (): int {} @@ -319,27 +435,20 @@ final public function getType (): int {} final public static function __set_state (array $properties): \MongoDB\BSON\Binary {} /** - * Returns the Binary's data - * @link http://www.php.net/manual/en/mongodb-bson-binary.tostring.php - * @return string Returns the Binary's data. + * {@inheritdoc} */ final public function __toString (): string {} /** - * Serialize a Binary - * @link http://www.php.net/manual/en/mongodb-bson-binary.serialize.php - * @return string Returns the serialized representation of the - * MongoDB\BSON\Binary. + * {@inheritdoc} */ final public function serialize (): string {} /** - * Unserialize a Binary - * @link http://www.php.net/manual/en/mongodb-bson-binary.unserialize.php - * @param string $serialized - * @return void No value is returned. + * {@inheritdoc} + * @param string $data */ - final public function unserialize (string $serialized): void {} + final public function unserialize (string $data): void {} /** * {@inheritdoc} @@ -353,54 +462,40 @@ final public function __unserialize (array $data): void {} final public function __serialize (): array {} /** - * Returns a representation that can be converted to JSON - * @link http://www.php.net/manual/en/mongodb-bson-binary.jsonserialize.php - * @return mixed Returns data which can be serialized by json_encode to - * produce an extended JSON representation of the - * MongoDB\BSON\Binary. + * {@inheritdoc} */ final public function jsonSerialize (): mixed {} } -/** - * BSON type for the "DBPointer" type. This BSON type is deprecated, and this - * class can not be instantiated. It will be created from a BSON DBPointer - * type while converting BSON to PHP, and can also be converted back into - * BSON while storing documents in the database. - * @link http://www.php.net/manual/en/class.mongodb-bson-dbpointer.php - */ final class DBPointer implements \Stringable, \JsonSerializable, \MongoDB\BSON\Type, \Serializable { /** - * Construct a new DBPointer (unused) - * @link http://www.php.net/manual/en/mongodb-bson-dbpointer.construct.php - * @return void + * {@inheritdoc} + */ + final private function __construct () {} + + /** + * {@inheritdoc} + * @param array $properties */ - final private function __construct (): void {} + final public static function __set_state (array $properties): \MongoDB\BSON\DBPointer {} /** - * Returns an empty string - * @link http://www.php.net/manual/en/mongodb-bson-dbpointer.tostring.php - * @return string Returns an empty string. + * {@inheritdoc} */ final public function __toString (): string {} /** - * Serialize a DBPointer - * @link http://www.php.net/manual/en/mongodb-bson-dbpointer.serialize.php - * @return string Returns the serialized representation of the - * MongoDB\BSON\DBPointer. + * {@inheritdoc} */ final public function serialize (): string {} /** - * Unserialize a DBPointer - * @link http://www.php.net/manual/en/mongodb-bson-dbpointer.unserialize.php - * @param string $serialized - * @return void No value is returned. + * {@inheritdoc} + * @param string $data */ - final public function unserialize (string $serialized): void {} + final public function unserialize (string $data): void {} /** * {@inheritdoc} @@ -414,42 +509,22 @@ final public function __unserialize (array $data): void {} final public function __serialize (): array {} /** - * Returns a representation that can be converted to JSON - * @link http://www.php.net/manual/en/mongodb-bson-dbpointer.jsonserialize.php - * @return mixed Returns data which can be serialized by json_encode to - * produce an extended JSON representation of the - * MongoDB\BSON\DBPointer. + * {@inheritdoc} */ final public function jsonSerialize (): mixed {} } -/** - * BSON type for the - * Decimal128 floating-point format, - * which supports numbers with up to 34 decimal digits (i.e. significant - * digits) and an exponent range of −6143 to +6144. - *Unlike the double BSON type (i.e. float in PHP), which only - * stores an approximation of the decimal values, the decimal data type stores - * the exact value. For example, MongoDB\BSON\Decimal128('9.99') - * has a precise value of 9.99 where as a double 9.99 would have an approximate - * value of 9.9900000000000002131628….
- * @link http://www.php.net/manual/en/class.mongodb-bson-decimal128.php - */ final class Decimal128 implements \Stringable, \MongoDB\BSON\Decimal128Interface, \JsonSerializable, \MongoDB\BSON\Type, \Serializable { /** - * Construct a new Decimal128 - * @link http://www.php.net/manual/en/mongodb-bson-decimal128.construct.php - * @param string $value A decimal string. - * @return string + * {@inheritdoc} + * @param string $value */ - final public function __construct (string $value): string {} + final public function __construct (string $value) {} /** - * Returns the string representation of this Decimal128 - * @link http://www.php.net/manual/en/mongodb-bson-decimal128.tostring.php - * @return string Returns the string representation of this Decimal128. + * {@inheritdoc} */ final public function __toString (): string {} @@ -460,20 +535,15 @@ final public function __toString (): string {} final public static function __set_state (array $properties): \MongoDB\BSON\Decimal128 {} /** - * Serialize a Decimal128 - * @link http://www.php.net/manual/en/mongodb-bson-decimal128.serialize.php - * @return string Returns the serialized representation of the - * MongoDB\BSON\Decimal128. + * {@inheritdoc} */ final public function serialize (): string {} /** - * Unserialize a Decimal128 - * @link http://www.php.net/manual/en/mongodb-bson-decimal128.unserialize.php - * @param string $serialized - * @return void No value is returned. + * {@inheritdoc} + * @param string $data */ - final public function unserialize (string $serialized): void {} + final public function unserialize (string $data): void {} /** * {@inheritdoc} @@ -487,60 +557,41 @@ final public function __unserialize (array $data): void {} final public function __serialize (): array {} /** - * Returns a representation that can be converted to JSON - * @link http://www.php.net/manual/en/mongodb-bson-decimal128.jsonserialize.php - * @return mixed Returns data which can be serialized by json_encode to - * produce an extended JSON representation of the - * MongoDB\BSON\Decimal128. + * {@inheritdoc} */ final public function jsonSerialize (): mixed {} } -/** - * BSON type for a 64-bit integer. This class cannot be instantiated and is - * only created during BSON decoding when a 64-bit integer cannot be - * represented as a PHP integer on a 32-bit platform. Versions of the driver - * before 1.5.0 would throw an exception when attempting to decode a 64-bit - * integer on a 32-bit platform. - *During BSON encoding, objects of this class will convert back to a 64-bit - * integer type. This allows 64-bit integers to be roundtripped through a - * 32-bit PHP environment without any loss of precision. The - * __toString() method allows the 64-bit - * integer value to be accessed as a string.
- * @link http://www.php.net/manual/en/class.mongodb-bson-int64.php - */ final class Int64 implements \Stringable, \JsonSerializable, \MongoDB\BSON\Type, \Serializable { /** - * Construct a new Int64 (unused) - * @link http://www.php.net/manual/en/mongodb-bson-int64.construct.php - * @return void + * {@inheritdoc} + * @param string|int $value */ - final private function __construct (): void {} + final public function __construct (string|int $value) {} /** - * Returns the string representation of this Int64 - * @link http://www.php.net/manual/en/mongodb-bson-int64.tostring.php - * @return string Returns the string representation of this Int64. + * {@inheritdoc} */ final public function __toString (): string {} /** - * Serialize an Int64 - * @link http://www.php.net/manual/en/mongodb-bson-int64.serialize.php - * @return string Returns the serialized representation of the - * MongoDB\BSON\Int64. + * {@inheritdoc} + * @param array $properties + */ + final public static function __set_state (array $properties): \MongoDB\BSON\Int64 {} + + /** + * {@inheritdoc} */ final public function serialize (): string {} /** - * Unserialize an Int64 - * @link http://www.php.net/manual/en/mongodb-bson-int64.unserialize.php - * @param string $serialized - * @return void No value is returned. + * {@inheritdoc} + * @param string $data */ - final public function unserialize (string $serialized): void {} + final public function unserialize (string $data): void {} /** * {@inheritdoc} @@ -554,32 +605,20 @@ final public function __unserialize (array $data): void {} final public function __serialize (): array {} /** - * Returns a representation that can be converted to JSON - * @link http://www.php.net/manual/en/mongodb-bson-int64.jsonserialize.php - * @return mixed Returns data which can be serialized by json_encode to - * produce an extended JSON representation of the - * MongoDB\BSON\Int64. + * {@inheritdoc} */ final public function jsonSerialize (): mixed {} } -/** - * BSON type for Javascript code. An optional scope document may be specified - * that maps identifiers to values and defines the scope in which the code - * should be evaluated by the server. - * @link http://www.php.net/manual/en/class.mongodb-bson-javascript.php - */ final class Javascript implements \Stringable, \MongoDB\BSON\JavascriptInterface, \JsonSerializable, \MongoDB\BSON\Type, \Serializable { /** - * Construct a new Javascript - * @link http://www.php.net/manual/en/mongodb-bson-javascript.construct.php - * @param string $code Javascript code. - * @param array|object|null $scope [optional] Javascript scope. - * @return string + * {@inheritdoc} + * @param string $code + * @param object|array|null $scope [optional] */ - final public function __construct (string $code, array|object|null $scope = null): string {} + final public function __construct (string $code, object|array|null $scope = NULL) {} /** * {@inheritdoc} @@ -588,41 +627,30 @@ final public function __construct (string $code, array|object|null $scope = null final public static function __set_state (array $properties): \MongoDB\BSON\Javascript {} /** - * Returns the Javascript's code - * @link http://www.php.net/manual/en/mongodb-bson-javascript.getcode.php - * @return string Returns the Javascript's code. + * {@inheritdoc} */ final public function getCode (): string {} /** - * Returns the Javascript's scope document - * @link http://www.php.net/manual/en/mongodb-bson-javascript.getscope.php - * @return object|null Returns the Javascript's scope document, or null if the is no scope. + * {@inheritdoc} */ final public function getScope (): ?object {} /** - * Returns the Javascript's code - * @link http://www.php.net/manual/en/mongodb-bson-javascript.tostring.php - * @return string Returns the Javascript's code. + * {@inheritdoc} */ final public function __toString (): string {} /** - * Serialize a Javascript - * @link http://www.php.net/manual/en/mongodb-bson-javascript.serialize.php - * @return string Returns the serialized representation of the - * MongoDB\BSON\Javascript. + * {@inheritdoc} */ final public function serialize (): string {} /** - * Unserialize a Javascript - * @link http://www.php.net/manual/en/mongodb-bson-javascript.unserialize.php - * @param string $serialized - * @return void No value is returned. + * {@inheritdoc} + * @param string $data */ - final public function unserialize (string $serialized): void {} + final public function unserialize (string $data): void {} /** * {@inheritdoc} @@ -636,21 +664,12 @@ final public function __unserialize (array $data): void {} final public function __serialize (): array {} /** - * Returns a representation that can be converted to JSON - * @link http://www.php.net/manual/en/mongodb-bson-javascript.jsonserialize.php - * @return mixed Returns data which can be serialized by json_encode to - * produce an extended JSON representation of the - * MongoDB\BSON\Javascript. + * {@inheritdoc} */ final public function jsonSerialize (): mixed {} } -/** - * Special BSON type which compares higher than all other possible BSON element - * values. - * @link http://www.php.net/manual/en/class.mongodb-bson-maxkey.php - */ final class MaxKey implements \MongoDB\BSON\MaxKeyInterface, \JsonSerializable, \MongoDB\BSON\Type, \Serializable { /** @@ -660,20 +679,15 @@ final class MaxKey implements \MongoDB\BSON\MaxKeyInterface, \JsonSerializable, final public static function __set_state (array $properties): \MongoDB\BSON\MaxKey {} /** - * Serialize a MaxKey - * @link http://www.php.net/manual/en/mongodb-bson-maxkey.serialize.php - * @return string Returns the serialized representation of the - * MongoDB\BSON\MaxKey. + * {@inheritdoc} */ final public function serialize (): string {} /** - * Unserialize a MaxKey - * @link http://www.php.net/manual/en/mongodb-bson-maxkey.unserialize.php - * @param string $serialized - * @return void No value is returned. + * {@inheritdoc} + * @param string $data */ - final public function unserialize (string $serialized): void {} + final public function unserialize (string $data): void {} /** * {@inheritdoc} @@ -687,21 +701,12 @@ final public function __unserialize (array $data): void {} final public function __serialize (): array {} /** - * Returns a representation that can be converted to JSON - * @link http://www.php.net/manual/en/mongodb-bson-maxkey.jsonserialize.php - * @return mixed Returns data which can be serialized by json_encode to - * produce an extended JSON representation of the - * MongoDB\BSON\MaxKey. + * {@inheritdoc} */ final public function jsonSerialize (): mixed {} } -/** - * Special BSON type which compares lower than all other possible BSON element - * values. - * @link http://www.php.net/manual/en/class.mongodb-bson-minkey.php - */ final class MinKey implements \MongoDB\BSON\MinKeyInterface, \JsonSerializable, \MongoDB\BSON\Type, \Serializable { /** @@ -711,20 +716,15 @@ final class MinKey implements \MongoDB\BSON\MinKeyInterface, \JsonSerializable, final public static function __set_state (array $properties): \MongoDB\BSON\MinKey {} /** - * Serialize a MinKey - * @link http://www.php.net/manual/en/mongodb-bson-minkey.serialize.php - * @return string Returns the serialized representation of the - * MongoDB\BSON\MinKey. + * {@inheritdoc} */ final public function serialize (): string {} /** - * Unserialize a MinKey - * @link http://www.php.net/manual/en/mongodb-bson-minkey.unserialize.php - * @param string $serialized - * @return void No value is returned. + * {@inheritdoc} + * @param string $data */ - final public function unserialize (string $serialized): void {} + final public function unserialize (string $data): void {} /** * {@inheritdoc} @@ -738,51 +738,27 @@ final public function __unserialize (array $data): void {} final public function __serialize (): array {} /** - * Returns a representation that can be converted to JSON - * @link http://www.php.net/manual/en/mongodb-bson-minkey.jsonserialize.php - * @return mixed Returns data which can be serialized by json_encode to - * produce an extended JSON representation of the - * MongoDB\BSON\MinKey. + * {@inheritdoc} */ final public function jsonSerialize (): mixed {} } -/** - * BSON type for an - * ObjectId. The - * value consists of 12 bytes, where the first four bytes are a timestamp - * that reflect the ObjectId's creation. Specifically, the value consists of: - *In MongoDB, each document stored in a collection requires a unique - * _id field that acts as a primary key. If an inserted - * document omits the _id field, the driver automatically - * generates an ObjectId for the _id field.
- *Using ObjectIds for the _id field provides the following - * additional benefits:
- * @link http://www.php.net/manual/en/class.mongodb-bson-objectid.php - */ final class ObjectId implements \Stringable, \MongoDB\BSON\ObjectIdInterface, \JsonSerializable, \MongoDB\BSON\Type, \Serializable { /** - * Construct a new ObjectId - * @link http://www.php.net/manual/en/mongodb-bson-objectid.construct.php - * @param string|null $id [optional] A 24-character hexadecimal string. If not provided, the driver will - * generate an ObjectId. - * @return string|null + * {@inheritdoc} + * @param string|null $id [optional] */ - final public function __construct (?string $id = null): ?string {} + final public function __construct (?string $id = NULL) {} /** - * Returns the timestamp component of this ObjectId - * @link http://www.php.net/manual/en/mongodb-bson-objectid.gettimestamp.php - * @return int Returns the timestamp component of this ObjectId. + * {@inheritdoc} */ final public function getTimestamp (): int {} /** - * Returns the hexidecimal representation of this ObjectId - * @link http://www.php.net/manual/en/mongodb-bson-objectid.tostring.php - * @return string Returns the hexidecimal representation of this ObjectId. + * {@inheritdoc} */ final public function __toString (): string {} @@ -793,20 +769,15 @@ final public function __toString (): string {} final public static function __set_state (array $properties): \MongoDB\BSON\ObjectId {} /** - * Serialize an ObjectId - * @link http://www.php.net/manual/en/mongodb-bson-objectid.serialize.php - * @return string Returns the serialized representation of the - * MongoDB\BSON\ObjectId. + * {@inheritdoc} */ final public function serialize (): string {} /** - * Unserialize an ObjectId - * @link http://www.php.net/manual/en/mongodb-bson-objectid.unserialize.php - * @param string $serialized - * @return void No value is returned. + * {@inheritdoc} + * @param string $data */ - final public function unserialize (string $serialized): void {} + final public function unserialize (string $data): void {} /** * {@inheritdoc} @@ -820,87 +791,48 @@ final public function __unserialize (array $data): void {} final public function __serialize (): array {} /** - * Returns a representation that can be converted to JSON - * @link http://www.php.net/manual/en/mongodb-bson-objectid.jsonserialize.php - * @return mixed Returns data which can be serialized by json_encode to - * produce an extended JSON representation of the - * MongoDB\BSON\ObjectId. + * {@inheritdoc} */ final public function jsonSerialize (): mixed {} } -/** - * Classes may implement this interface to take advantage of automatic ODM - * (object document mapping) behavior in the driver. During serialization, the - * driver will inject a __pclass property containing the - * PHP class name into the data returned by - * MongoDB\BSON\Serializable::bsonSerialize. During - * unserialization, the same __pclass property will then - * be used to infer the PHP class (independent of any - * type map configuration) - * to be constructed before - * MongoDB\BSON\Unserializable::bsonUnserialize is - * invoked. See for additional - * information. - * @link http://www.php.net/manual/en/class.mongodb-bson-persistable.php - */ interface Persistable extends \MongoDB\BSON\Serializable, \MongoDB\BSON\Type, \MongoDB\BSON\Unserializable { /** - * Provides an array or document to serialize as BSON - * @link http://www.php.net/manual/en/mongodb-bson-serializable.bsonserialize.php - * @return array|object An array or stdClass to be serialized as - * a BSON array or document. + * {@inheritdoc} */ - abstract public function bsonSerialize (): array|object; + abstract public function bsonSerialize (); /** - * Constructs the object from a BSON array or document - * @link http://www.php.net/manual/en/mongodb-bson-unserializable.bsonunserialize.php - * @param array $data Properties within the BSON array or document. - * @return void The return value from this method is ignored. + * {@inheritdoc} + * @param array $data */ - abstract public function bsonUnserialize (array $data): void; + abstract public function bsonUnserialize (array $data); } -/** - * BSON type for a regular expression pattern and optional - * flags. - * @link http://www.php.net/manual/en/class.mongodb-bson-regex.php - */ final class Regex implements \Stringable, \MongoDB\BSON\RegexInterface, \JsonSerializable, \MongoDB\BSON\Type, \Serializable { /** - * Construct a new Regex - * @link http://www.php.net/manual/en/mongodb-bson-regex.construct.php - * @param string $pattern The regular expression pattern. - * @param string $flags [optional] The regular - * expression flags. Characters in this argument will be sorted - * alphabetically. - * @return string + * {@inheritdoc} + * @param string $pattern + * @param string $flags [optional] */ - final public function __construct (string $pattern, string $flags = '""'): string {} + final public function __construct (string $pattern, string $flags = '') {} /** - * Returns the Regex's pattern - * @link http://www.php.net/manual/en/mongodb-bson-regex.getpattern.php - * @return string Returns the Regex's pattern. + * {@inheritdoc} */ final public function getPattern (): string {} /** - * Returns the Regex's flags - * @link http://www.php.net/manual/en/mongodb-bson-regex.getflags.php - * @return string Returns the Regex's flags. + * {@inheritdoc} */ final public function getFlags (): string {} /** - * Returns the string representation of this Regex - * @link http://www.php.net/manual/en/mongodb-bson-regex.tostring.php - * @return string Returns the string representation of this Regex. + * {@inheritdoc} */ final public function __toString (): string {} @@ -911,20 +843,15 @@ final public function __toString (): string {} final public static function __set_state (array $properties): \MongoDB\BSON\Regex {} /** - * Serialize a Regex - * @link http://www.php.net/manual/en/mongodb-bson-regex.serialize.php - * @return string Returns the serialized representation of the - * MongoDB\BSON\Regex. + * {@inheritdoc} */ final public function serialize (): string {} /** - * Unserialize a Regex - * @link http://www.php.net/manual/en/mongodb-bson-regex.unserialize.php - * @param string $serialized - * @return void No value is returned. + * {@inheritdoc} + * @param string $data */ - final public function unserialize (string $serialized): void {} + final public function unserialize (string $data): void {} /** * {@inheritdoc} @@ -938,54 +865,40 @@ final public function __unserialize (array $data): void {} final public function __serialize (): array {} /** - * Returns a representation that can be converted to JSON - * @link http://www.php.net/manual/en/mongodb-bson-regex.jsonserialize.php - * @return mixed Returns data which can be serialized by json_encode to - * produce an extended JSON representation of the - * MongoDB\BSON\Regex. + * {@inheritdoc} */ final public function jsonSerialize (): mixed {} } -/** - * BSON type for the "Symbol" type. This BSON type is deprecated, and this - * class can not be instantiated. It will be created from a BSON symbol - * type while converting BSON to PHP, and can also be converted back into - * BSON while storing documents in the database. - * @link http://www.php.net/manual/en/class.mongodb-bson-symbol.php - */ final class Symbol implements \Stringable, \JsonSerializable, \MongoDB\BSON\Type, \Serializable { /** - * Construct a new Symbol (unused) - * @link http://www.php.net/manual/en/mongodb-bson-symbol.construct.php - * @return void + * {@inheritdoc} */ - final private function __construct (): void {} + final private function __construct () {} /** - * Returns the Symbol as a string - * @link http://www.php.net/manual/en/mongodb-bson-symbol.tostring.php - * @return string Returns the string representation of this Symbol. + * {@inheritdoc} */ final public function __toString (): string {} /** - * Serialize a Symbol - * @link http://www.php.net/manual/en/mongodb-bson-symbol.serialize.php - * @return string Returns the serialized representation of the - * MongoDB\BSON\Symbol. + * {@inheritdoc} + * @param array $properties + */ + final public static function __set_state (array $properties): \MongoDB\BSON\Symbol {} + + /** + * {@inheritdoc} */ final public function serialize (): string {} /** - * Unserialize a Symbol - * @link http://www.php.net/manual/en/mongodb-bson-symbol.unserialize.php - * @param string $serialized - * @return void No value is returned. + * {@inheritdoc} + * @param string $data */ - final public function unserialize (string $serialized): void {} + final public function unserialize (string $data): void {} /** * {@inheritdoc} @@ -999,53 +912,33 @@ final public function __unserialize (array $data): void {} final public function __serialize (): array {} /** - * Returns a representation that can be converted to JSON - * @link http://www.php.net/manual/en/mongodb-bson-symbol.jsonserialize.php - * @return mixed Returns data which can be serialized by json_encode to - * produce an extended JSON representation of the - * MongoDB\BSON\Symbol. + * {@inheritdoc} */ final public function jsonSerialize (): mixed {} } -/** - * Represents a - * BSON timestamp, - * The value consists of a 4-byte timestamp (i.e. seconds since the epoch) and - * a 4-byte increment. - * @link http://www.php.net/manual/en/class.mongodb-bson-timestamp.php - */ final class Timestamp implements \Stringable, \MongoDB\BSON\TimestampInterface, \JsonSerializable, \MongoDB\BSON\Type, \Serializable { /** - * Construct a new Timestamp - * @link http://www.php.net/manual/en/mongodb-bson-timestamp.construct.php - * @param int $increment 32-bit integer denoting the incrementing ordinal for operations within a - * given second. - * @param int $timestamp 32-bit integer denoting seconds since the Unix epoch. - * @return int + * {@inheritdoc} + * @param string|int $increment + * @param string|int $timestamp */ - final public function __construct (int $increment, int $timestamp): int {} + final public function __construct (string|int $increment, string|int $timestamp) {} /** - * Returns the timestamp component of this Timestamp - * @link http://www.php.net/manual/en/mongodb-bson-timestamp.gettimestamp.php - * @return int Returns the timestamp component of this Timestamp. + * {@inheritdoc} */ final public function getTimestamp (): int {} /** - * Returns the increment component of this Timestamp - * @link http://www.php.net/manual/en/mongodb-bson-timestamp.getincrement.php - * @return int Returns the increment component of this Timestamp. + * {@inheritdoc} */ final public function getIncrement (): int {} /** - * Returns the string representation of this Timestamp - * @link http://www.php.net/manual/en/mongodb-bson-timestamp.tostring.php - * @return string Returns the string representation of this Timestamp. + * {@inheritdoc} */ final public function __toString (): string {} @@ -1056,20 +949,15 @@ final public function __toString (): string {} final public static function __set_state (array $properties): \MongoDB\BSON\Timestamp {} /** - * Serialize a Timestamp - * @link http://www.php.net/manual/en/mongodb-bson-timestamp.serialize.php - * @return string Returns the serialized representation of the - * MongoDB\BSON\Timestamp. + * {@inheritdoc} */ final public function serialize (): string {} /** - * Unserialize a Timestamp - * @link http://www.php.net/manual/en/mongodb-bson-timestamp.unserialize.php - * @param string $serialized - * @return void No value is returned. + * {@inheritdoc} + * @param string $data */ - final public function unserialize (string $serialized): void {} + final public function unserialize (string $data): void {} /** * {@inheritdoc} @@ -1083,54 +971,40 @@ final public function __unserialize (array $data): void {} final public function __serialize (): array {} /** - * Returns a representation that can be converted to JSON - * @link http://www.php.net/manual/en/mongodb-bson-timestamp.jsonserialize.php - * @return mixed Returns data which can be serialized by json_encode to - * produce an extended JSON representation of the - * MongoDB\BSON\Timestamp. + * {@inheritdoc} */ final public function jsonSerialize (): mixed {} } -/** - * BSON type for the "Undefined" type. This BSON type is deprecated, and this - * class can not be instantiated. It will be created from a BSON undefined - * type while converting BSON to PHP, and can also be converted back into - * BSON while storing documents in the database. - * @link http://www.php.net/manual/en/class.mongodb-bson-undefined.php - */ final class Undefined implements \Stringable, \JsonSerializable, \MongoDB\BSON\Type, \Serializable { /** - * Construct a new Undefined (unused) - * @link http://www.php.net/manual/en/mongodb-bson-undefined.construct.php - * @return void + * {@inheritdoc} */ - final private function __construct (): void {} + final private function __construct () {} /** - * Returns an empty string - * @link http://www.php.net/manual/en/mongodb-bson-undefined.tostring.php - * @return string Returns an empty string. + * {@inheritdoc} */ final public function __toString (): string {} /** - * Serialize a Undefined - * @link http://www.php.net/manual/en/mongodb-bson-undefined.serialize.php - * @return string Returns the serialized representation of the - * MongoDB\BSON\Undefined. + * {@inheritdoc} + * @param array $properties + */ + final public static function __set_state (array $properties): \MongoDB\BSON\Undefined {} + + /** + * {@inheritdoc} */ final public function serialize (): string {} /** - * Unserialize a Undefined - * @link http://www.php.net/manual/en/mongodb-bson-undefined.unserialize.php - * @param string $serialized - * @return void No value is returned. + * {@inheritdoc} + * @param string $data */ - final public function unserialize (string $serialized): void {} + final public function unserialize (string $data): void {} /** * {@inheritdoc} @@ -1144,52 +1018,27 @@ final public function __unserialize (array $data): void {} final public function __serialize (): array {} /** - * Returns a representation that can be converted to JSON - * @link http://www.php.net/manual/en/mongodb-bson-undefined.jsonserialize.php - * @return mixed Returns data which can be serialized by json_encode to - * produce an extended JSON representation of the - * MongoDB\BSON\Undefined. + * {@inheritdoc} */ final public function jsonSerialize (): mixed {} } -/** - * Represents a - * BSON date. The value - * is a 64-bit integer that represents the number of milliseconds since the - * Unix epoch (Jan 1, 1970). Negative values represent dates before 1970. - * @link http://www.php.net/manual/en/class.mongodb-bson-utcdatetime.php - */ final class UTCDateTime implements \Stringable, \MongoDB\BSON\UTCDateTimeInterface, \JsonSerializable, \MongoDB\BSON\Type, \Serializable { /** - * Construct a new UTCDateTime - * @link http://www.php.net/manual/en/mongodb-bson-utcdatetime.construct.php - * @param int|float|string|\DateTimeInterface|null $milliseconds [optional] Number of milliseconds since the Unix epoch (Jan 1, 1970). Negative values - * represent dates before 1970. This value may be provided as a 64-bit - * int. For compatibility on 32-bit systems, this parameter - * may also be provided as a float or string. - *If the argument is a DateTimeInterface, the number - * of milliseconds since the Unix epoch will be derived from that value.
- *If this argument is null, the current time will be used by default.
- * @return int|float|string|\DateTimeInterface|null + * {@inheritdoc} + * @param \DateTimeInterface|string|int|float|null $milliseconds [optional] */ - final public function __construct (int|float|string|\DateTimeInterface|null $milliseconds = null): int|float|string|\DateTimeInterface|null {} + final public function __construct (\DateTimeInterface|string|int|float|null $milliseconds = NULL) {} /** - * Returns the DateTime representation of this UTCDateTime - * @link http://www.php.net/manual/en/mongodb-bson-utcdatetime.todatetime.php - * @return \DateTime Returns the DateTime representation of this - * UTCDateTime. The returned DateTime will use the UTC - * time zone. + * {@inheritdoc} */ final public function toDateTime (): \DateTime {} /** - * Returns the string representation of this UTCDateTime - * @link http://www.php.net/manual/en/mongodb-bson-utcdatetime.tostring.php - * @return string Returns the string representation of this UTCDateTime. + * {@inheritdoc} */ final public function __toString (): string {} @@ -1200,20 +1049,15 @@ final public function __toString (): string {} final public static function __set_state (array $properties): \MongoDB\BSON\UTCDateTime {} /** - * Serialize a UTCDateTime - * @link http://www.php.net/manual/en/mongodb-bson-utcdatetime.serialize.php - * @return string Returns the serialized representation of the - * MongoDB\BSON\UTCDateTime. + * {@inheritdoc} */ final public function serialize (): string {} /** - * Unserialize a UTCDateTime - * @link http://www.php.net/manual/en/mongodb-bson-utcdatetime.unserialize.php - * @param string $serialized - * @return void No value is returned. + * {@inheritdoc} + * @param string $data */ - final public function unserialize (string $serialized): void {} + final public function unserialize (string $data): void {} /** * {@inheritdoc} @@ -1227,11 +1071,7 @@ final public function __unserialize (array $data): void {} final public function __serialize (): array {} /** - * Returns a representation that can be converted to JSON - * @link http://www.php.net/manual/en/mongodb-bson-utcdatetime.jsonserialize.php - * @return mixed Returns data which can be serialized by json_encode to - * produce an extended JSON representation of the - * MongoDB\BSON\UTCDateTime. + * {@inheritdoc} */ final public function jsonSerialize (): mixed {} @@ -1243,346 +1083,69 @@ final public function jsonSerialize (): mixed {} namespace MongoDB\Driver { -/** - * This interface is implemented by - * MongoDB\Driver\Cursor to be used as - * a parameter, return, or property type in userland classes. - * @link http://www.php.net/manual/en/class.mongodb-driver-cursorinterface.php - */ interface CursorInterface extends \Traversable { /** - * Returns the ID for this cursor - * @link http://www.php.net/manual/en/mongodb-driver-cursorinterface.getid.php - * @return \MongoDB\Driver\CursorId Returns the MongoDB\Driver\CursorId for this cursor. + * {@inheritdoc} */ - abstract public function getId (): \MongoDB\Driver\CursorId; + abstract public function getId (); /** - * Returns the server associated with this cursor - * @link http://www.php.net/manual/en/mongodb-driver-cursorinterface.getserver.php - * @return \MongoDB\Driver\Server Returns the MongoDB\Driver\Server associated with this - * cursor. + * {@inheritdoc} */ - abstract public function getServer (): \MongoDB\Driver\Server; + abstract public function getServer (); /** - * Checks if the cursor may have additional results - * @link http://www.php.net/manual/en/mongodb-driver-cursorinterface.isdead.php - * @return bool Returns true if additional results are not available, and false - * otherwise. + * {@inheritdoc} */ - abstract public function isDead (): bool; + abstract public function isDead (); /** - * Sets a type map to use for BSON unserialization - * @link http://www.php.net/manual/en/mongodb-driver-cursorinterface.settypemap.php - * @param array $typemap - * @return void No value is returned. + * {@inheritdoc} + * @param array $typemap */ - abstract public function setTypeMap (array $typemap): void; + abstract public function setTypeMap (array $typemap); /** - * Returns an array containing all results for this cursor - * @link http://www.php.net/manual/en/mongodb-driver-cursorinterface.toarray.php - * @return array Returns an array containing all results for this cursor. + * {@inheritdoc} */ - abstract public function toArray (): array; + abstract public function toArray (); } -/** - * The MongoDB\Driver\BulkWrite collects one or more - * write operations that should be sent to the server. After adding any - * number of insert, update, and delete operations, the collection may be - * executed via - * MongoDB\Driver\Manager::executeBulkWrite. - *Write operations may either be ordered (default) or unordered. Ordered write - * operations are sent to the server, in the order provided, for serial - * execution. If a write fails, any remaining operations will be aborted. - * Unordered operations are sent to the server in an arbitrary order - * where they may be executed in parallel. Any errors that occur are reported - * after all operations have been attempted.
- * @link http://www.php.net/manual/en/class.mongodb-driver-bulkwrite.php - */ final class BulkWrite implements \Countable { /** - * Create a new BulkWrite - * @link http://www.php.net/manual/en/mongodb-driver-bulkwrite.construct.php - * @param array|null $options [optional]Option | - *Type | - *Description | - *Default | - *
bypassDocumentValidation | - *bool | - *
- * - * If true, allows insert and update operations to circumvent - * document level validation. - * - *- * This option is available in MongoDB 3.2+ and is ignored for older - * server versions, which do not support document level validation. - * - * |
- * false | - *
comment | - *mixed | - *
- * - * An arbitrary comment to help trace the operation through the - * database profiler, currentOp output, and logs. - * - *- * This option is available in MongoDB 4.4+ and will result in an - * exception at execution time if specified for an older server - * version. - * - * |
- * |
let | - *arrayobject | - *
- * - * Map of parameter names and values. Values must be constant or closed expressions that do not reference document fields. Parameters can then be accessed as variables in an aggregate expression context (e.g. $$var). - * - *- * This option is available in MongoDB 5.0+ and will result in an exception at execution time if specified for an older server version. - * - * |
- * |
ordered | - *bool | - *- * Ordered operations (true) are executed serially on the MongoDB - * server, while unordered operations (false) are sent to the server - * in an arbitrary order and may be executed in parallel. - * | - *true | - *
If true, allows insert and update operations to circumvent - * document level validation.
- *This option is available in MongoDB 3.2+ and is ignored for older - * server versions, which do not support document level validation.
- *An arbitrary comment to help trace the operation through the - * database profiler, currentOp output, and logs.
- *This option is available in MongoDB 4.4+ and will result in an - * exception at execution time if specified for an older server - * version.
- *Map of parameter names and values. Values must be constant or closed expressions that do not reference document fields. Parameters can then be accessed as variables in an aggregate expression context (e.g. $$var).
- *This option is available in MongoDB 5.0+ and will result in an exception at execution time if specified for an older server version.
- * @return array|null - */ - final public function __construct (?array $options = null): ?array {} - - /** - * Count number of write operations in the bulk - * @link http://www.php.net/manual/en/mongodb-driver-bulkwrite.count.php - * @return int Returns number of write operations added to the - * MongoDB\Driver\BulkWrite object. + * {@inheritdoc} + * @param array|null $options [optional] + */ + final public function __construct (?array $options = NULL) {} + + /** + * {@inheritdoc} */ public function count (): int {} /** - * Add a delete operation to the bulk - * @link http://www.php.net/manual/en/mongodb-driver-bulkwrite.delete.php - * @param array|object $filter The query predicate. - * An empty predicate will match all documents in the collection. - * @param array|null $deleteOptions [optional]Option | - *Type | - *Description | - *Default | - *
collation | - *arrayobject | - *
- * - * Collation allows users to specify language-specific rules for string comparison, such as rules for lettercase and accent marks. When specifying collation, the "locale" field is mandatory; all other collation fields are optional. For descriptions of the fields, see Collation Document. - * - *- * If the collation is unspecified but the collection has a default collation, the operation uses the collation specified for the collection. If no collation is specified for the collection or for the operation, MongoDB uses the simple binary comparison used in prior versions for string comparisons. - * - *- * This option is available in MongoDB 3.4+ and will result in an exception at execution time if specified for an older server version. - * - * |
- * |
hint | - *stringarrayobject | - *
- * - * Index specification. Specify either the index name as a string or - * the index key pattern. If specified, then the query system will only - * consider plans using the hinted index. - * - *- * This option is available in MongoDB 4.4+ and will result in an - * exception at execution time if specified for an older server - * version. - * - * |
- * |
limit | - *bool | - *Delete all matching documents (false), or only the first matching document (true) | - *false | - *
Collation allows users to specify language-specific rules for string comparison, such as rules for lettercase and accent marks. When specifying collation, the "locale" field is mandatory; all other collation fields are optional. For descriptions of the fields, see Collation Document.
- *If the collation is unspecified but the collection has a default collation, the operation uses the collation specified for the collection. If no collation is specified for the collection or for the operation, MongoDB uses the simple binary comparison used in prior versions for string comparisons.
- *This option is available in MongoDB 3.4+ and will result in an exception at execution time if specified for an older server version.
- *Index specification. Specify either the index name as a string or - * the index key pattern. If specified, then the query system will only - * consider plans using the hinted index.
- *This option is available in MongoDB 4.4+ and will result in an - * exception at execution time if specified for an older server - * version.
- * @return void No value is returned. - */ - public function delete (array|object $filter, ?array $deleteOptions = null): void {} - - /** - * Add an insert operation to the bulk - * @link http://www.php.net/manual/en/mongodb-driver-bulkwrite.insert.php - * @param array|object $document A document to insert. - * @return mixed Returns the _id of the inserted document. If the - * document did not have an _id, the - * MongoDB\BSON\ObjectId generated for the insert will - * be returned. - */ - final public function insert (array|object $document): mixed {} - - /** - * Add an update operation to the bulk - * @link http://www.php.net/manual/en/mongodb-driver-bulkwrite.update.php - * @param array|object $filter The query predicate. - * An empty predicate will match all documents in the collection. - * @param array|object $newObj A document containing either update operators (e.g. - * $set), a replacement document (i.e. - * only field:value expressions), or - * an aggregation pipeline. - * @param array|null $updateOptions [optional]Option | - *Type | - *Description | - *Default | - *
arrayFilters | - *array | - *
- * - * An array of filter documents that determines which array elements to - * modify for an update operation on an array field. See - * Specify arrayFilters for Array Update Operations - * in the MongoDB manual for more information. - * - *- * This option is available in MongoDB 3.6+ and will result in an - * exception at execution time if specified for an older server - * version. - * - * |
- * |
collation | - *arrayobject | - *
- * - * Collation allows users to specify language-specific rules for string comparison, such as rules for lettercase and accent marks. When specifying collation, the "locale" field is mandatory; all other collation fields are optional. For descriptions of the fields, see Collation Document. - * - *- * If the collation is unspecified but the collection has a default collation, the operation uses the collation specified for the collection. If no collation is specified for the collection or for the operation, MongoDB uses the simple binary comparison used in prior versions for string comparisons. - * - *- * This option is available in MongoDB 3.4+ and will result in an exception at execution time if specified for an older server version. - * - * |
- * |
hint | - *stringarrayobject | - *
- * - * Index specification. Specify either the index name as a string or - * the index key pattern. If specified, then the query system will only - * consider plans using the hinted index. - * - *- * This option is available in MongoDB 4.2+ and will result in an - * exception at execution time if specified for an older server - * version. - * - * |
- * |
multi | - *bool | - *- * Update only the first matching document if false, or all - * matching documents true. This option cannot be true if - * newObj is a replacement document. - * | - *false | - *
upsert | - *bool | - *- * If filter does not match an existing document, - * insert a single document. The document will be - * created from newObj if it is a replacement - * document (i.e. no update operators); otherwise, the operators in - * newObj will be applied to - * filter to create the new document. - * | - *false | - *
An array of filter documents that determines which array elements to - * modify for an update operation on an array field. See - * Specify arrayFilters for Array Update Operations - * in the MongoDB manual for more information.
- *This option is available in MongoDB 3.6+ and will result in an - * exception at execution time if specified for an older server - * version.
- *Collation allows users to specify language-specific rules for string comparison, such as rules for lettercase and accent marks. When specifying collation, the "locale" field is mandatory; all other collation fields are optional. For descriptions of the fields, see Collation Document.
- *If the collation is unspecified but the collection has a default collation, the operation uses the collation specified for the collection. If no collation is specified for the collection or for the operation, MongoDB uses the simple binary comparison used in prior versions for string comparisons.
- *This option is available in MongoDB 3.4+ and will result in an exception at execution time if specified for an older server version.
- *Index specification. Specify either the index name as a string or - * the index key pattern. If specified, then the query system will only - * consider plans using the hinted index.
- *This option is available in MongoDB 4.2+ and will result in an - * exception at execution time if specified for an older server - * version.
- * @return void No value is returned. - */ - public function update (array|object $filter, array|object $newObj, ?array $updateOptions = null): void {} + * {@inheritdoc} + * @param object|array $filter + * @param array|null $deleteOptions [optional] + */ + public function delete (object|array $filter, ?array $deleteOptions = NULL): void {} + + /** + * {@inheritdoc} + * @param object|array $document + */ + final public function insert (object|array $document): mixed {} + + /** + * {@inheritdoc} + * @param object|array $filter + * @param object|array $newObj + * @param array|null $updateOptions [optional] + */ + public function update (object|array $filter, object|array $newObj, ?array $updateOptions = NULL): void {} /** * {@inheritdoc} @@ -1591,915 +1154,92 @@ final public function __wakeup (): void {} } -/** - * The MongoDB\Driver\ClientEncryption class handles - * creation of data keys for client-side encryption, as well as manually - * encrypting and decrypting values. - * @link http://www.php.net/manual/en/class.mongodb-driver-clientencryption.php - */ final class ClientEncryption { - /** - * Specifies an algorithm for deterministic encryption, which is suitable for querying. const AEAD_AES_256_CBC_HMAC_SHA_512_DETERMINISTIC = "AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic"; - /** - * Specifies an algorithm for randomized encryption const AEAD_AES_256_CBC_HMAC_SHA_512_RANDOM = "AEAD_AES_256_CBC_HMAC_SHA_512-Random"; - /** - * Specifies an algorithm for an indexed, encrypted payload, which can be used with queryable encryption. - *To insert or query with an indexed, encrypted payload, the MongoDB\Driver\Manager must be configured with the "autoEncryption" driver option. The "bypassQueryAnalysis" auto encryption option may be true. The "bypassAutoEncryption" auto encryption option must be false.
const ALGORITHM_INDEXED = "Indexed"; - /** - * Specifies an algorithm for an unindexed, encrypted payload. const ALGORITHM_UNINDEXED = "Unindexed"; - /** - * Specifies an equality query type, which is used in conjunction with MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED. + const ALGORITHM_RANGE_PREVIEW = "RangePreview"; const QUERY_TYPE_EQUALITY = "equality"; + const QUERY_TYPE_RANGE_PREVIEW = "rangePreview"; /** - * Create a new ClientEncryption object - * @link http://www.php.net/manual/en/mongodb-driver-clientencryption.construct.php - * @param array $optionsOption | - *Type | - *Description | - *
keyVaultClient | - *MongoDB\Driver\Manager | - *The Manager used to route data key queries. This option is required (unlike with MongoDB\Driver\Manager::createClientEncryption). | - *
keyVaultNamespace | - *string | - *A fully qualified namespace (e.g. "databaseName.collectionName") denoting the collection that contains all data keys used for encryption and decryption. This option is required. | - *
kmsProviders | - *array | - *
- * - * A document containing the configuration for one or more KMS providers, which are used to encrypt data keys. Supported providers include "aws", "azure", "gcp", "kmip", and "local" and at least one must be specified. - * - *- * The format for "aws" is as follows: - * - *- * aws: { - * accessKeyId: , - * secretAccessKey: , - * sessionToken: - * } - *- * - * The format for "azure" is as follows: - * - *- * azure: { - * tenantId: , - * clientId: , - * clientSecret: , - * identityPlatformEndpoint: // Defaults to "login.microsoftonline.com" - * } - *- * - * The format for "gcp" is as follows: - * - *- * gcp: { - * email: , - * privateKey: |, - * endpoint: // Defaults to "oauth2.googleapis.com" - * } - *- * - * The format for "kmip" is as follows: - * - *- * kmip: { - * endpoint: - * } - *- * - * The format for "local" is as follows: - * - *- * local: { - * // 96-byte master key used to encrypt/decrypt data keys - * key: | - * } - *- * |
- *
tlsOptions | - *array | - *
- * - * A document containing the TLS configuration for one or more KMS providers. Supported providers include "aws", "azure", "gcp", and "kmip". All providers support the following options: - * - *- * : { - * tlsCaFile: , - * tlsCertificateKeyFile: , - * tlsCertificateKeyFilePassword: , - * tlsDisableOCSPEndpointCheck: - * } - *- * |
- *
A document containing the configuration for one or more KMS providers, which are used to encrypt data keys. Supported providers include "aws", "azure", "gcp", "kmip", and "local" and at least one must be specified.
- *The format for "aws" is as follows:
- *The format for "azure" is as follows:
- *The format for "gcp" is as follows:
- *The format for "kmip" is as follows:
- *The format for "local" is as follows:
- *A document containing the TLS configuration for one or more KMS providers. Supported providers include "aws", "azure", "gcp", and "kmip". All providers support the following options:
- * @return array - */ - final public function __construct (array $options): array {} - - /** - * Adds an alternate name to a key document - * @link http://www.php.net/manual/en/mongodb-driver-clientencryption.addkeyaltname.php - * @param \MongoDB\BSON\Binary $keyId A MongoDB\BSON\Binary instance with subtype 4 - * (UUID) identifying the key document. - * @param string $keyAltName Alternate name to add to the key document. - * @return object|null Returns the previous version of the key document, or null if no document - * matched. + * {@inheritdoc} + * @param array $options + */ + final public function __construct (array $options) {} + + /** + * {@inheritdoc} + * @param \MongoDB\BSON\Binary $keyId + * @param string $keyAltName */ final public function addKeyAltName (\MongoDB\BSON\Binary $keyId, string $keyAltName): ?object {} /** - * Creates a key document - * @link http://www.php.net/manual/en/mongodb-driver-clientencryption.createdatakey.php - * @param string $kmsProvider The KMS provider (e.g. "local", - * "aws") that will be used to encrypt the new data key. - * @param array|null $options [optional]Option | - *Type | - *Description | - *||||||||||||||||||||||||||||||||||||||||||||||||||||||
masterKey | - *array | - *
- * - * The masterKey document identifies a KMS-specific key used to encrypt - * the new data key. This option is required unless - * kmsProvider is "local". - * - *- *
- *
- *
- *
|
- * ||||||||||||||||||||||||||||||||||||||||||||||||||||||
keyAltNames | - *array | - *
- * - * An optional list of string alternate names used to reference a key. - * If a key is created with alternate names, then encryption may refer - * to the key by the unique alternate name instead of by - * _id. - * - * |
- * ||||||||||||||||||||||||||||||||||||||||||||||||||||||
keyMaterial | - *MongoDB\BSON\Binary | - *
- * - * An optional 96-byte value to use as custom key material for the data - * key being created. If keyMaterial is given, the custom key material - * is used for encrypting and decrypting data. Otherwise, the key - * material for the new data key is generated from a cryptographically - * secure random device. - * - * |
- *
The masterKey document identifies a KMS-specific key used to encrypt - * the new data key. This option is required unless - * kmsProvider is "local".
- *> - *
Option | - *Type | - *Description | - *
region | - *string | - *Required. | - *
key | - *string | - *Required. The Amazon Resource Name (ARN) to the AWS customer master key (CMK). | - *
endpoint | - *string | - *Optional. An alternate host identifier to send KMS requests to. May include port number. | - *
> - *
Option | - *Type | - *Description | - *
keyVaultEndpoint | - *string | - *Required. Host with optional port (e.g. "example.vault.azure.net"). | - *
keyName | - *string | - *Required. | - *
keyVersion | - *string | - *Optional. A specific version of the named key. Defaults to using the key's primary version. | - *
> - *
Option | - *Type | - *Description | - *
projectId | - *string | - *Required. | - *
location | - *string | - *Required. | - *
keyRing | - *string | - *Required. | - *
keyName | - *string | - *Required. | - *
keyVersion | - *string | - *Optional. A specific version of the named key. Defaults to using the key's primary version. | - *
endpoint | - *string | - *Optional. Host with optional port. Defaults to "cloudkms.googleapis.com". | - *
> - *
Option | - *Type | - *Description | - *
keyId | - *string | - *Optional. Unique identifier to a 96-byte KMIP secret data managed object. If unspecified, the driver creates a random 96-byte KMIP secret data managed object. | - *
endpoint | - *string | - *Optional. Host with optional port. | - *
An optional list of string alternate names used to reference a key. - * If a key is created with alternate names, then encryption may refer - * to the key by the unique alternate name instead of by - * _id.
- *An optional 96-byte value to use as custom key material for the data - * key being created. If keyMaterial is given, the custom key material - * is used for encrypting and decrypting data. Otherwise, the key - * material for the new data key is generated from a cryptographically - * secure random device.
- * @return \MongoDB\BSON\Binary Returns the identifier of the new key as a - * MongoDB\BSON\Binary object with subtype 4 (UUID). - */ - final public function createDataKey (string $kmsProvider, ?array $options = null): \MongoDB\BSON\Binary {} - - /** - * Decrypt a value - * @link http://www.php.net/manual/en/mongodb-driver-clientencryption.decrypt.php - * @param \MongoDB\BSON\Binary $value A MongoDB\BSON\Binary instance with subtype 6 - * containing the encrypted value. - * @return mixed Returns the decrypted value as it was passed to - * MongoDB\Driver\ClientEncryption::encrypt. + * {@inheritdoc} + * @param string $kmsProvider + * @param array|null $options [optional] + */ + final public function createDataKey (string $kmsProvider, ?array $options = NULL): \MongoDB\BSON\Binary {} + + /** + * {@inheritdoc} + * @param \MongoDB\BSON\Binary $value */ final public function decrypt (\MongoDB\BSON\Binary $value): mixed {} /** - * Deletes a key document - * @link http://www.php.net/manual/en/mongodb-driver-clientencryption.deletekey.php - * @param \MongoDB\BSON\Binary $keyId A MongoDB\BSON\Binary instance with subtype 4 - * (UUID) identifying the key document. - * @return object Returns the result of the internal deleteOne operation on - * the key vault collection. + * {@inheritdoc} + * @param \MongoDB\BSON\Binary $keyId */ final public function deleteKey (\MongoDB\BSON\Binary $keyId): object {} /** - * Encrypt a value - * @link http://www.php.net/manual/en/mongodb-driver-clientencryption.encrypt.php - * @param mixed $value The value to be encrypted. Any value that can be inserted into MongoDB can - * be encrypted using this method. - * @param array|null $options [optional]Option | - *Type | - *Description | - *
algorithm | - *string | - *
- * - * The encryption algorithm to be used. This option is required. - * Specify one of the following - * ClientEncryption constants: - * - *- * MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_DETERMINISTIC - * MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_RANDOM - * MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED - * MongoDB\Driver\ClientEncryption::ALGORITHM_UNINDEXED - * - * |
- *
contentionFactor | - *int | - *
- * - * The contention factor for evaluating queries with indexed, encrypted - * payloads. - * - *- * This option only applies and may only be specified when - * algorithm is - * MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED. - * - * Queryable Encryption is in public preview and available for evaluation - * purposes. It is not yet recommended for production deployments as breaking - * changes may be introduced. See the Queryable Encryption Preview blog post for more information. - * |
- *
keyAltName | - *string | - *
- * - * Identifies a key vault collection document by - * keyAltName. This option is mutually exclusive - * with keyId and exactly one is required. - * - * |
- *
keyId | - *MongoDB\BSON\Binary | - *
- * - * Identifies a data key by _id. The value is a UUID - * (binary subtype 4). This option is mutually exclusive with - * keyAltName and exactly one is required. - * - * |
- *
queryType | - *int | - *
- * - * The query type for evaluating queries with indexed, encrypted - * payloads. Specify one of the following - * ClientEncryption constants: - * - *- * MongoDB\Driver\ClientEncryption::QUERY_TYPE_EQUALITY - * - *This option only applies and may only be specified when - * algorithm is - * MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED. - * - * Queryable Encryption is in public preview and available for evaluation - * purposes. It is not yet recommended for production deployments as breaking - * changes may be introduced. See the Queryable Encryption Preview blog post for more information. - * |
- *
The encryption algorithm to be used. This option is required. - * Specify one of the following - * ClientEncryption constants:
- *The contention factor for evaluating queries with indexed, encrypted - * payloads.
- *This option only applies and may only be specified when - * algorithm is - * MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED.
- *Identifies a key vault collection document by - * keyAltName. This option is mutually exclusive - * with keyId and exactly one is required.
- *Identifies a data key by _id. The value is a UUID - * (binary subtype 4). This option is mutually exclusive with - * keyAltName and exactly one is required.
- *The query type for evaluating queries with indexed, encrypted - * payloads. Specify one of the following - * ClientEncryption constants:
- *This option only applies and may only be specified when - * algorithm is - * MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED.
- * @return \MongoDB\BSON\Binary Returns the encrypted value as - * MongoDB\BSON\Binary object with subtype 6. - */ - final public function encrypt (mixed $value, ?array $options = null): \MongoDB\BSON\Binary {} - - /** - * Gets a key document - * @link http://www.php.net/manual/en/mongodb-driver-clientencryption.getkey.php - * @param \MongoDB\BSON\Binary $keyId A MongoDB\BSON\Binary instance with subtype 4 - * (UUID) identifying the key document. - * @return object|null Returns the key document, or null if no document matched. + * {@inheritdoc} + * @param mixed $value + * @param array|null $options [optional] + */ + final public function encrypt (mixed $value = null, ?array $options = NULL): \MongoDB\BSON\Binary {} + + /** + * {@inheritdoc} + * @param object|array $expr + * @param array|null $options [optional] + */ + final public function encryptExpression (object|array $expr, ?array $options = NULL): object {} + + /** + * {@inheritdoc} + * @param \MongoDB\BSON\Binary $keyId */ final public function getKey (\MongoDB\BSON\Binary $keyId): ?object {} /** - * Gets a key document by an alternate name - * @link http://www.php.net/manual/en/mongodb-driver-clientencryption.getkeybyaltname.php - * @param string $keyAltName Alternate name for the key document. - * @return object|null Returns the key document, or null if no document matched. + * {@inheritdoc} + * @param string $keyAltName */ final public function getKeyByAltName (string $keyAltName): ?object {} /** - * Gets all key documents - * @link http://www.php.net/manual/en/mongodb-driver-clientencryption.getkeys.php - * @return \MongoDB\Driver\Cursor >Returns MongoDB\Driver\Cursor on success. + * {@inheritdoc} */ final public function getKeys (): \MongoDB\Driver\Cursor {} /** - * Removes an alternate name from a key document - * @link http://www.php.net/manual/en/mongodb-driver-clientencryption.removekeyaltname.php - * @param \MongoDB\BSON\Binary $keyId A MongoDB\BSON\Binary instance with subtype 4 - * (UUID) identifying the key document. - * @param string $keyAltName Alternate name to remove from the key document. - * @return object|null Returns the previous version of the key document, or null if no document - * matched. + * {@inheritdoc} + * @param \MongoDB\BSON\Binary $keyId + * @param string $keyAltName */ final public function removeKeyAltName (\MongoDB\BSON\Binary $keyId, string $keyAltName): ?object {} /** - * Rewraps data keys - * @link http://www.php.net/manual/en/mongodb-driver-clientencryption.rewrapmanydatakey.php - * @param array|object $filter The query predicate. - * An empty predicate will match all documents in the collection. - * @param array|null $options [optional]Option | - *Type | - *Description | - *||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider | - *string | - *
- * - * The KMS provider (e.g. "local", - * "aws") that will be used to re-encrypt the - * matched data keys. - * - *- * If a KMS provider is not specified, matched data keys will be - * re-encrypted with their current KMS provider. - * - * |
- * ||||||||||||||||||||||||||||||||||||||||||||||||||||||
masterKey | - *array | - *
- * - * The masterKey identifies a KMS-specific key used to encrypt the new - * data key. This option should not be specified without the - * "provider" option. This option is required if - * "provider" is specified and not - * "local". - * - *- *
- *
- *
- *
|
- *
The KMS provider (e.g. "local", - * "aws") that will be used to re-encrypt the - * matched data keys.
- *If a KMS provider is not specified, matched data keys will be - * re-encrypted with their current KMS provider.
- *The masterKey identifies a KMS-specific key used to encrypt the new - * data key. This option should not be specified without the - * "provider" option. This option is required if - * "provider" is specified and not - * "local".
- *> - *
Option | - *Type | - *Description | - *
region | - *string | - *Required. | - *
key | - *string | - *Required. The Amazon Resource Name (ARN) to the AWS customer master key (CMK). | - *
endpoint | - *string | - *Optional. An alternate host identifier to send KMS requests to. May include port number. | - *
> - *
Option | - *Type | - *Description | - *
keyVaultEndpoint | - *string | - *Required. Host with optional port (e.g. "example.vault.azure.net"). | - *
keyName | - *string | - *Required. | - *
keyVersion | - *string | - *Optional. A specific version of the named key. Defaults to using the key's primary version. | - *
> - *
Option | - *Type | - *Description | - *
projectId | - *string | - *Required. | - *
location | - *string | - *Required. | - *
keyRing | - *string | - *Required. | - *
keyName | - *string | - *Required. | - *
keyVersion | - *string | - *Optional. A specific version of the named key. Defaults to using the key's primary version. | - *
endpoint | - *string | - *Optional. Host with optional port. Defaults to "cloudkms.googleapis.com". | - *
> - *
Option | - *Type | - *Description | - *
keyId | - *string | - *Optional. Unique identifier to a 96-byte KMIP secret data managed object. If unspecified, the driver creates a random 96-byte KMIP secret data managed object. | - *
endpoint | - *string | - *Optional. Host with optional port. | - *
To provide Command Helpers the MongoDB\Driver\Command object should be composed.
- * @link http://www.php.net/manual/en/class.mongodb-driver-command.php - */ final class Command { /** - * Create a new Command - * @link http://www.php.net/manual/en/mongodb-driver-command.construct.php - * @param array|object $document The complete command document, which will be sent to the server. - * @param array|null $commandOptions [optional]Option | - *Type | - *Description | - *
maxAwaitTimeMS | - *int | - *
- * - * Positive integer denoting the time limit in milliseconds for the - * server to block a getMore operation if no data is available. This - * option should only be used in conjunction with commands that return - * a tailable cursor (e.g. Change - * Streams). - * - * |
- *
Positive integer denoting the time limit in milliseconds for the - * server to block a getMore operation if no data is available. This - * option should only be used in conjunction with commands that return - * a tailable cursor (e.g. Change - * Streams).
- * @return array|object - */ - final public function __construct (array|object $document, ?array $commandOptions = null): array|object {} + * {@inheritdoc} + * @param object|array $document + * @param array|null $commandOptions [optional] + */ + final public function __construct (object|array $document, ?array $commandOptions = NULL) {} /** * {@inheritdoc} @@ -2559,94 +1264,61 @@ final public function __wakeup (): void {} } -/** - * The MongoDB\Driver\Cursor class encapsulates - * the results of a MongoDB command or query and may be returned by - * MongoDB\Driver\Manager::executeCommand or - * MongoDB\Driver\Manager::executeQuery, respectively. - * @link http://www.php.net/manual/en/class.mongodb-driver-cursor.php - */ final class Cursor implements \Iterator, \Traversable, \MongoDB\Driver\CursorInterface { /** - * Create a new Cursor (not used) - * @link http://www.php.net/manual/en/mongodb-driver-cursor.construct.php - * @return void + * {@inheritdoc} */ - final private function __construct (): void {} + final private function __construct () {} /** - * Returns the current element - * @link http://www.php.net/manual/en/mongodb-driver-cursor.current.php - * @return array|object|null Returns the current result document as an array or object, depending on the - * cursor's type map. If iteration has not started or the current position - * is not valid, null will be returned. + * {@inheritdoc} */ - public function current (): array|object|null {} + public function current (): object|array|null {} /** - * Returns the ID for this cursor - * @link http://www.php.net/manual/en/mongodb-driver-cursor.getid.php - * @return \MongoDB\Driver\CursorId Returns the MongoDB\Driver\CursorId for this cursor. + * {@inheritdoc} */ final public function getId (): \MongoDB\Driver\CursorId {} /** - * Returns the server associated with this cursor - * @link http://www.php.net/manual/en/mongodb-driver-cursor.getserver.php - * @return \MongoDB\Driver\Server Returns the MongoDB\Driver\Server associated with this - * cursor. + * {@inheritdoc} */ final public function getServer (): \MongoDB\Driver\Server {} /** - * Checks if the cursor is exhausted or may have additional results - * @link http://www.php.net/manual/en/mongodb-driver-cursor.isdead.php - * @return bool Returns true if there are definitely no additional results available on the - * cursor, and false otherwise. + * {@inheritdoc} */ final public function isDead (): bool {} /** - * Returns the current result's index within the cursor - * @link http://www.php.net/manual/en/mongodb-driver-cursor.key.php - * @return int The current result's numeric index within the cursor. + * {@inheritdoc} */ - public function key (): int {} + public function key (): ?int {} /** - * Advances the cursor to the next result - * @link http://www.php.net/manual/en/mongodb-driver-cursor.next.php - * @return void Moves the current position to the next element in the cursor. + * {@inheritdoc} */ public function next (): void {} /** - * Rewind the cursor to the first result - * @link http://www.php.net/manual/en/mongodb-driver-cursor.rewind.php - * @return void null. + * {@inheritdoc} */ public function rewind (): void {} /** - * Sets a type map to use for BSON unserialization - * @link http://www.php.net/manual/en/mongodb-driver-cursor.settypemap.php - * @param array $typemap - * @return void No value is returned. + * {@inheritdoc} + * @param array $typemap */ final public function setTypeMap (array $typemap): void {} /** - * Returns an array containing all results for this cursor - * @link http://www.php.net/manual/en/mongodb-driver-cursor.toarray.php - * @return array Returns an array containing all results for this cursor. + * {@inheritdoc} */ final public function toArray (): array {} /** - * Checks if the current position in the cursor is valid - * @link http://www.php.net/manual/en/mongodb-driver-cursor.valid.php - * @return bool true if the current cursor position is valid, false otherwise. + * {@inheritdoc} */ public function valid (): bool {} @@ -2657,20 +1329,12 @@ final public function __wakeup (): void {} } -/** - * The MongoDB\Driver\CursorID class is a value object - * that represents a cursor ID. Instances of this class are returned by - * MongoDB\Driver\Cursor::getId. - * @link http://www.php.net/manual/en/class.mongodb-driver-cursorid.php - */ final class CursorId implements \Stringable, \Serializable { /** - * Create a new CursorId (not used) - * @link http://www.php.net/manual/en/mongodb-driver-cursorid.construct.php - * @return void + * {@inheritdoc} */ - final private function __construct (): void {} + final private function __construct () {} /** * {@inheritdoc} @@ -2679,27 +1343,20 @@ final private function __construct (): void {} final public static function __set_state (array $properties): \MongoDB\Driver\CursorId {} /** - * String representation of the cursor ID - * @link http://www.php.net/manual/en/mongodb-driver-cursorid.tostring.php - * @return string Returns the string representation of the cursor ID. + * {@inheritdoc} */ final public function __toString (): string {} /** - * Serialize a CursorId - * @link http://www.php.net/manual/en/mongodb-driver-cursorid.serialize.php - * @return string Returns the serialized representation of the - * MongoDB\Driver\CursorId. + * {@inheritdoc} */ final public function serialize (): string {} /** - * Unserialize a CursorId - * @link http://www.php.net/manual/en/mongodb-driver-cursorid.unserialize.php - * @param string $serialized - * @return void No value is returned. + * {@inheritdoc} + * @param string $data */ - final public function unserialize (string $serialized): void {} + final public function unserialize (string $data): void {} /** * {@inheritdoc} @@ -2714,2206 +1371,118 @@ final public function __serialize (): array {} } -/** - * The MongoDB\Driver\Manager is the main entry point - * to the extension. It is responsible for maintaining connections to MongoDB - * (be it standalone server, replica set, or sharded cluster). - *No connection to MongoDB is made upon instantiating the Manager. - * This means the MongoDB\Driver\Manager can always be - * constructed, even though one or more MongoDB servers are down.
- *Any write or query can throw connection exceptions as connections are created lazily. - * A MongoDB server may also become unavailable during the life time of the script. - * It is therefore important that all actions on the Manager to be wrapped in try/catch statements.
- * @link http://www.php.net/manual/en/class.mongodb-driver-manager.php - */ final class Manager { /** - * Create new MongoDB Manager - * @link http://www.php.net/manual/en/mongodb-driver-manager.construct.php - * @param string|null $uri [optional] A mongodb:// connection URI: - *- * mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][/[defaultAuthDb][?options]] - *- *
For details on supported URI options, see - * Connection String Options - * in the MongoDB manual. - * Connection pool options - * are not supported, as the PHP driver does not implement connection pools.
- *The uri is a URL, hence any special characters in - * its components need to be URL encoded according to - * RFC 3986. This is particularly - * relevant to the username and password, which can often include special - * characters such as @, :, or - * %. When connecting via a Unix domain socket, the socket - * path may contain special characters such as slashes and must be encoded. - * The rawurlencode function may be used to encode - * constituent parts of the URI.
- *The defaultAuthDb component may be used to specify the - * database name associated with the user's credentials; however the - * authSource URI option will take priority if specified. - * If neither defaultAuthDb nor - * authSource are specified, the admin - * database will be used by default. The defaultAuthDb - * component has no effect in the absence of user credentials.
- * @param array|null $uriOptions [optional] Additional - * connection string options, - * which will overwrite any options with the same name in the - * uri parameter. - *Option | - *Type | - *Description | - *
appname | - *string | - *
- * - * MongoDB 3.4+ has the ability to annotate connections with metadata - * provided by the connecting client. This metadata is included in the - * server's logs upon establishing a connection and also recorded in - * slow query logs when database profiling is enabled. - * - *- * This option may be used to specify an application name, which will - * be included in the metadata. The value cannot exceed 128 characters - * in length. - * - * |
- *
authMechanism | - *string | - *
- * - * The authentication mechanism that MongoDB will use to authenticate - * the connection. For additional details and a list of supported - * values, see - * Authentication Options - * in the MongoDB manual. - * - * |
- *
authMechanismProperties | - *array | - *
- * - * Properties for the selected authentication mechanism. For additional - * details and a list of supported properties, see the - * Driver Authentication Specification. - * - * When not specified in the URI string, this option is expressed as - * an array of key/value pairs. The keys and values in this array - * should be strings. - * |
- *
authSource | - *string | - *
- * - * The database name associated with the user's credentials. Defaults - * to the database component of the connection URI, or the - * admin database if both are unspecified. - * - *- * For authentication mechanisms that delegate credential storage to - * other services (e.g. GSSAPI), this should be - * "$external". - * - * |
- *
canonicalizeHostname | - *bool | - *
- * - * If true, the driver will resolve the real hostname for the server - * IP address before authenticating via SASL. Some underlying GSSAPI - * layers already do this, but the functionality may be disabled in - * their config (e.g. krb.conf). Defaults to - * false. - * - *- * This option is a deprecated alias for the - * "CANONICALIZE_HOST_NAME" property of the - * "authMechanismProperties" URI option. - * - * |
- *
compressors | - *string | - *
- * - * A prioritized, comma-delimited list of compressors that the client - * wants to use. Messages are only compressed if the client and server - * share any compressors in common, and the compressor used in each - * direction will depend on the individual configuration of the server - * or driver. See the - * Driver Compression Specification - * for more information. - * - * |
- *
connectTimeoutMS | - *int | - *
- * - * The time in milliseconds to attempt a connection before timing out. - * Defaults to 10,000 milliseconds. - * - * |
- *
directConnection | - *bool | - *
- * - * This option can be used to control replica set discovery behavior - * when only a single host is provided in the connection string. By - * default, providing a single member in the connection string will - * establish a direct connection or discover additional members - * depending on whether the "replicaSet" URI option - * is omitted or present, respectively. Specify false to force - * discovery to occur (if "replicaSet" is omitted) - * or specify true to force a direct connection (if - * "replicaSet" is present). - * - * |
- *
gssapiServiceName | - *string | - *
- * - * Set the Kerberos service name when connecting to Kerberized MongoDB - * instances. This value must match the service name set on MongoDB - * instances (i.e. - * saslServiceName - * server parameter). Defaults to "mongodb". - * - *- * This option is a deprecated alias for the - * "SERVICE_NAME" property of the - * "authMechanismProperties" URI option. - * - * |
- *
heartbeatFrequencyMS | - *int | - *
- * - * Specifies the interval in milliseconds between the driver's checks - * of the MongoDB topology, counted from the end of the previous check - * until the beginning of the next one. Defaults to 60,000 - * milliseconds. - * - *- * Per the - * Server Discovery and Monitoring Specification, - * this value cannot be less than 500 milliseconds. - * - * |
- *
journal | - *bool | - *
- * - * Corresponds to the default write concern's - * journal parameter. If true, writes will - * require acknowledgement from MongoDB that the operation has been - * written to the journal. For details, see - * MongoDB\Driver\WriteConcern. - * - * |
- *
loadBalanced | - *bool | - *
- * - * Specifies whether the driver is connecting to a MongoDB cluster - * through a load balancer. If true, the driver may only connect to a - * single host (specified by either the connection string or SRV - * lookup), the "directConnection" URI option - * cannot be true, and the "replicaSet" URI option - * must be omitted. Defaults to false. - * - * |
- *
localThresholdMS | - *int | - *
- * - * The size in milliseconds of the latency window for selecting among - * multiple suitable MongoDB instances while resolving a read - * preference. Defaults to 15 milliseconds. - * - * |
- *
maxStalenessSeconds | - *int | - *
- * - * Corresponds to the read preference's - * "maxStalenessSeconds". Specifies, in seconds, how - * stale a secondary can be before the client stops using it for read - * operations. By default, there is no maximum staleness and clients - * will not consider a secondary’s lag when choosing where to direct a - * read operation. For details, see - * MongoDB\Driver\ReadPreference. - * - *- * If specified, the max staleness must be a signed 32-bit integer - * greater than or equal to - * MongoDB\Driver\ReadPreference::SMALLEST_MAX_STALENESS_SECONDS - * (i.e. 90 seconds). - * - * |
- *
password | - *string | - *- * The password for the user being authenticated. This option is useful - * if the password contains special characters, which would otherwise - * need to be URL encoded for the connection URI. - * | - *
readConcernLevel | - *string | - *- * Corresponds to the read concern's level - * parameter. Specifies the level of read isolation. For details, see - * MongoDB\Driver\ReadConcern. - * | - *
readPreference | - *string | - *
- * - * Corresponds to the read preference's mode - * parameter. Defaults to "primary". For details, - * see MongoDB\Driver\ReadPreference. - * - * |
- *
readPreferenceTags | - *array | - *
- * - * Corresponds to the read preference's tagSets - * parameter. Tag sets allow you to target read operations to specific - * members of a replica set. For details, see - * MongoDB\Driver\ReadPreference. - * - * When not specified in the URI string, this option is expressed as - * an array consistent with the format expected by - * MongoDB\Driver\ReadPreference::__construct. - * |
- *
replicaSet | - *string | - *
- * - * Specifies the name of the replica set. - * - * |
- *
retryReads | - *bool | - *
- * - * Specifies whether or not the driver should automatically retry - * certain read operations that fail due to transient network errors - * or replica set elections. This functionality requires MongoDB 3.6+. - * Defaults to true. - * - *- * See the - * Retryable Reads Specification - * for more information. - * - * |
- *
retryWrites | - *bool | - *
- * - * Specifies whether or not the driver should automatically retry - * certain write operations that fail due to transient network errors - * or replica set elections. This functionality requires MongoDB 3.6+. - * Defaults to true. - * - *- * See - * Retryable Writes - * in the MongoDB manual for more information. - * - * |
- *
safe | - *bool | - *
- * - * If true, specifies 1 for the default write - * concern's w parameter. If false, - * 0 is specified. For details, see - * MongoDB\Driver\WriteConcern. - * - *- * This option is deprecated and should not be used. - * - * |
- *
serverSelectionTimeoutMS | - *int | - *
- * - * Specifies how long in milliseconds to block for server selection - * before throwing an exception. Defaults to 30,000 milliseconds. - * - * |
- *
serverSelectionTryOnce | - *bool | - *
- * - * When true, instructs the driver to scan the MongoDB deployment - * exactly once after server selection fails and then either select a - * server or raise an error. When false, the driver blocks and - * searches for a server up to the - * "serverSelectionTimeoutMS" value. Defaults to - * true. - * - * |
- *
socketCheckIntervalMS | - *int | - *
- * - * If a socket has not been used recently, the driver must check it via - * a hello command before using it for any - * operation. Defaults to 5,000 milliseconds. - * - * |
- *
socketTimeoutMS | - *int | - *
- * - * The time in milliseconds to attempt a send or receive on a socket - * before timing out. Defaults to 300,000 milliseconds (i.e. five - * minutes). - * - * |
- *
srvMaxHosts | - *int | - *
- * - * The maximum number of SRV results to randomly select when initially - * populating the seedlist or, during SRV polling, adding new hosts to - * the topology. Defaults to 0 (i.e. no maximum). - * - * |
- *
srvServiceName | - *string | - *
- * - * The service name to use for SRV lookup in initial DNS seedlist - * discovery and SRV polling. Defaults to "mongodb". - * - * |
- *
ssl | - *bool | - *
- * - * Initiates the connection with TLS/SSL if true. Defaults to - * false. - * - *- * This option is a deprecated alias for the "tls" - * URI option. - * - * |
- *
tls | - *bool | - *
- * - * Initiates the connection with TLS/SSL if true. Defaults to - * false. - * - * |
- *
tlsAllowInvalidCertificates | - *bool | - *
- * - * Specifies whether or not the driver should error when the server's - * TLS certificate is invalid. Defaults to false. - * - * Disabling certificate validation creates a vulnerability. - * |
- *
tlsAllowInvalidHostnames | - *bool | - *
- * - * Specifies whether or not the driver should error when there is a - * mismatch between the server's hostname and the hostname specified by - * the TLS certificate. Defaults to false. - * - * Disabling certificate validation creates a vulnerability. Allowing - * invalid hostnames may expose the driver to a - * man-in-the-middle attack. - * |
- *
tlsCAFile | - *string | - *
- * - * Path to file with either a single or bundle of certificate - * authorities to be considered trusted when making a TLS connection. - * The system certificate store will be used by default. - * - * |
- *
tlsCertificateKeyFile | - *string | - *
- * - * Path to the client certificate file or the client private key file; - * in the case that they both are needed, the files should be - * concatenated. - * - * |
- *
tlsCertificateKeyFilePassword | - *string | - *
- * - * Password to decrypt the client private key (i.e. - * "tlsCertificateKeyFile" URI option) to be used - * for TLS connections. - * - * |
- *
tlsDisableCertificateRevocationCheck | - *bool | - *
- * - * If true, the driver will not attempt to check certificate - * revocation status (e.g. OCSP, CRL). Defaults to false. - * - * |
- *
tlsDisableOCSPEndpointCheck | - *bool | - *
- * - * If true, the driver will not attempt to contact an OCSP responder - * endpoint if needed (i.e. an OCSP response is not stapled). Defaults - * to false. - * - * |
- *
tlsInsecure | - *bool | - *
- * - * Relax TLS constraints as much as possible. Specifying true for - * this option has the same effect as specifying true for both the - * "tlsAllowInvalidCertificates" and - * "tlsAllowInvalidHostnames" URI options. Defaults - * to false. - * - * Disabling certificate validation creates a vulnerability. Allowing - * invalid hostnames may expose the driver to a - * man-in-the-middle attack. - * |
- *
username | - *string | - *- * The username for the user being authenticated. This option is useful - * if the username contains special characters, which would otherwise - * need to be URL encoded for the connection URI. - * | - *
w | - *intstring | - *
- * - * Corresponds to the default write concern's w - * parameter. For details, see - * MongoDB\Driver\WriteConcern. - * - * |
- *
wTimeoutMS | - *intstring | - *
- * - * Corresponds to the default write concern's - * wtimeout parameter. Specifies a time limit, - * in milliseconds, for the write concern. For details, see - * MongoDB\Driver\WriteConcern. - * - *- * If specified, wTimeoutMS must be a signed 32-bit - * integer greater than or equal to zero. - * - * |
- *
zlibCompressionLevel | - *int | - *
- * - * Specifies the compression level to use for the zlib compressor. This - * option has no effect if zlib is not included in - * the "compressors" URI option. See the - * Driver Compression Specification - * for more information. - * - * |
- *
MongoDB 3.4+ has the ability to annotate connections with metadata - * provided by the connecting client. This metadata is included in the - * server's logs upon establishing a connection and also recorded in - * slow query logs when database profiling is enabled.
- *This option may be used to specify an application name, which will - * be included in the metadata. The value cannot exceed 128 characters - * in length.
- *The authentication mechanism that MongoDB will use to authenticate - * the connection. For additional details and a list of supported - * values, see - * Authentication Options - * in the MongoDB manual.
- *Properties for the selected authentication mechanism. For additional - * details and a list of supported properties, see the - * Driver Authentication Specification.
- *The database name associated with the user's credentials. Defaults - * to the database component of the connection URI, or the - * admin database if both are unspecified.
- *For authentication mechanisms that delegate credential storage to - * other services (e.g. GSSAPI), this should be - * "$external".
- *If true, the driver will resolve the real hostname for the server - * IP address before authenticating via SASL. Some underlying GSSAPI - * layers already do this, but the functionality may be disabled in - * their config (e.g. krb.conf). Defaults to - * false.
- *This option is a deprecated alias for the - * "CANONICALIZE_HOST_NAME" property of the - * "authMechanismProperties" URI option.
- *A prioritized, comma-delimited list of compressors that the client - * wants to use. Messages are only compressed if the client and server - * share any compressors in common, and the compressor used in each - * direction will depend on the individual configuration of the server - * or driver. See the - * Driver Compression Specification - * for more information.
- *The time in milliseconds to attempt a connection before timing out. - * Defaults to 10,000 milliseconds.
- *This option can be used to control replica set discovery behavior - * when only a single host is provided in the connection string. By - * default, providing a single member in the connection string will - * establish a direct connection or discover additional members - * depending on whether the "replicaSet" URI option - * is omitted or present, respectively. Specify false to force - * discovery to occur (if "replicaSet" is omitted) - * or specify true to force a direct connection (if - * "replicaSet" is present).
- *Set the Kerberos service name when connecting to Kerberized MongoDB - * instances. This value must match the service name set on MongoDB - * instances (i.e. - * saslServiceName - * server parameter). Defaults to "mongodb".
- *This option is a deprecated alias for the - * "SERVICE_NAME" property of the - * "authMechanismProperties" URI option.
- *Specifies the interval in milliseconds between the driver's checks - * of the MongoDB topology, counted from the end of the previous check - * until the beginning of the next one. Defaults to 60,000 - * milliseconds.
- *Per the - * Server Discovery and Monitoring Specification, - * this value cannot be less than 500 milliseconds.
- *Corresponds to the default write concern's - * journal parameter. If true, writes will - * require acknowledgement from MongoDB that the operation has been - * written to the journal. For details, see - * MongoDB\Driver\WriteConcern.
- *Specifies whether the driver is connecting to a MongoDB cluster - * through a load balancer. If true, the driver may only connect to a - * single host (specified by either the connection string or SRV - * lookup), the "directConnection" URI option - * cannot be true, and the "replicaSet" URI option - * must be omitted. Defaults to false.
- *The size in milliseconds of the latency window for selecting among - * multiple suitable MongoDB instances while resolving a read - * preference. Defaults to 15 milliseconds.
- *Corresponds to the read preference's - * "maxStalenessSeconds". Specifies, in seconds, how - * stale a secondary can be before the client stops using it for read - * operations. By default, there is no maximum staleness and clients - * will not consider a secondary’s lag when choosing where to direct a - * read operation. For details, see - * MongoDB\Driver\ReadPreference.
- *If specified, the max staleness must be a signed 32-bit integer - * greater than or equal to - * MongoDB\Driver\ReadPreference::SMALLEST_MAX_STALENESS_SECONDS - * (i.e. 90 seconds).
- *Corresponds to the read preference's mode - * parameter. Defaults to "primary". For details, - * see MongoDB\Driver\ReadPreference.
- *Corresponds to the read preference's tagSets - * parameter. Tag sets allow you to target read operations to specific - * members of a replica set. For details, see - * MongoDB\Driver\ReadPreference.
- *Specifies the name of the replica set.
- *Specifies whether or not the driver should automatically retry - * certain read operations that fail due to transient network errors - * or replica set elections. This functionality requires MongoDB 3.6+. - * Defaults to true.
- *See the - * Retryable Reads Specification - * for more information.
- *Specifies whether or not the driver should automatically retry - * certain write operations that fail due to transient network errors - * or replica set elections. This functionality requires MongoDB 3.6+. - * Defaults to true.
- *See - * Retryable Writes - * in the MongoDB manual for more information.
- *If true, specifies 1 for the default write - * concern's w parameter. If false, - * 0 is specified. For details, see - * MongoDB\Driver\WriteConcern.
- *This option is deprecated and should not be used.
- *Specifies how long in milliseconds to block for server selection - * before throwing an exception. Defaults to 30,000 milliseconds.
- *When true, instructs the driver to scan the MongoDB deployment - * exactly once after server selection fails and then either select a - * server or raise an error. When false, the driver blocks and - * searches for a server up to the - * "serverSelectionTimeoutMS" value. Defaults to - * true.
- *If a socket has not been used recently, the driver must check it via - * a hello command before using it for any - * operation. Defaults to 5,000 milliseconds.
- *The time in milliseconds to attempt a send or receive on a socket - * before timing out. Defaults to 300,000 milliseconds (i.e. five - * minutes).
- *The maximum number of SRV results to randomly select when initially - * populating the seedlist or, during SRV polling, adding new hosts to - * the topology. Defaults to 0 (i.e. no maximum).
- *The service name to use for SRV lookup in initial DNS seedlist - * discovery and SRV polling. Defaults to "mongodb".
- *Initiates the connection with TLS/SSL if true. Defaults to - * false.
- *This option is a deprecated alias for the "tls" - * URI option.
- *Initiates the connection with TLS/SSL if true. Defaults to - * false.
- *Specifies whether or not the driver should error when the server's - * TLS certificate is invalid. Defaults to false.
- *Specifies whether or not the driver should error when there is a - * mismatch between the server's hostname and the hostname specified by - * the TLS certificate. Defaults to false.
- *Path to file with either a single or bundle of certificate - * authorities to be considered trusted when making a TLS connection. - * The system certificate store will be used by default.
- *Path to the client certificate file or the client private key file; - * in the case that they both are needed, the files should be - * concatenated.
- *Password to decrypt the client private key (i.e. - * "tlsCertificateKeyFile" URI option) to be used - * for TLS connections.
- *If true, the driver will not attempt to check certificate - * revocation status (e.g. OCSP, CRL). Defaults to false.
- *If true, the driver will not attempt to contact an OCSP responder - * endpoint if needed (i.e. an OCSP response is not stapled). Defaults - * to false.
- *Relax TLS constraints as much as possible. Specifying true for - * this option has the same effect as specifying true for both the - * "tlsAllowInvalidCertificates" and - * "tlsAllowInvalidHostnames" URI options. Defaults - * to false.
- *Corresponds to the default write concern's w - * parameter. For details, see - * MongoDB\Driver\WriteConcern.
- *Corresponds to the default write concern's - * wtimeout parameter. Specifies a time limit, - * in milliseconds, for the write concern. For details, see - * MongoDB\Driver\WriteConcern.
- *If specified, wTimeoutMS must be a signed 32-bit - * integer greater than or equal to zero.
- *Specifies the compression level to use for the zlib compressor. This - * option has no effect if zlib is not included in - * the "compressors" URI option. See the - * Driver Compression Specification - * for more information.
- * @param array|null $driverOptions [optional]Option | - *Type | - *Description | - *||||||||||||||||||||||||||||||
allow_invalid_hostname | - *bool | - *
- * - * Disables hostname validation if true. Defaults to false. - * - *- * Allowing invalid hostnames may expose the driver to a - * man-in-the-middle attack. - * - *- * This option is a deprecated alias for the - * "tlsAllowInvalidHostnames" URI option. - * - * |
- * ||||||||||||||||||||||||||||||
autoEncryption | - *array | - *
- * - * Provides options to enable automatic client-side field level - * encryption. - * - *- * Automatic encryption is an enterprise-only feature that only - * applies to operations on a collection. Automatic encryption is not - * supported for operations on a database or view, and operations that - * are not bypassed will result in error (see - * libmongocrypt: Auto Encryption Allow-List). To bypass automatic encryption - * for all operations, set bypassAutoEncryption to - * true. - * - *- * Automatic encryption requires the authenticated user to have the - * listCollections - * privilege action. - * - *- * Explicit encryption/decryption and automatic decryption is a - * community feature. The driver can still automatically decrypt when - * bypassAutoEncryption is true. - * - *- * The following options are supported: - *
|
- * ||||||||||||||||||||||||||||||
ca_dir | - *string | - *
- * - * Path to a correctly hashed certificate directory. The system - * certificate store will be used by default. - * - * |
- * ||||||||||||||||||||||||||||||
ca_file | - *string | - *
- * - * Path to file with either a single or bundle of certificate - * authorities to be considered trusted when making a TLS connection. - * The system certificate store will be used by default. - * - *- * This option is a deprecated alias for the - * "tlsCAFile" URI option. - * - * |
- * ||||||||||||||||||||||||||||||
context | - *resource | - *
- * - * SSL context options to be used as - * fallbacks if a driver option or its equivalent URI option, if any, - * is not specified. Note that the driver does not consult the default - * stream context (i.e. - * stream_context_get_default). The following - * context options are supported: - * - *
- * This option is supported for backwards compatibility, but should be - * considered deprecated. - * - * |
- * ||||||||||||||||||||||||||||||
crl_file | - *string | - *Path to a certificate revocation list file. | - *||||||||||||||||||||||||||||||
disableClientPersistence | - *bool | - *
- * - * If true, this Manager will use a new libmongoc client, which will - * not be persisted or shared with other Manager objects. When this - * Manager object is freed, its client will be destroyed and any - * connections will be closed. Defaults to false. - * - * Disabling client persistence is not generally recommended. - * |
- * ||||||||||||||||||||||||||||||
driver | - *array | - *
- * - * Allows custom drivers to append their own metadata to the server - * handshake. By default, the driver submits its own name, version, and - * platform (i.e. PHP version) in the handshake. Custom drivers can - * specify strings for the "name", - * "version", and - * "platform" keys of this array, which will be - * appended to the respective field(s) in the handshake document. - * - * Handshake information is limited to 512 bytes. The driver will - * truncate handshake data to fit within this 512-byte string. Drivers - * and ODMs are encouraged to keep their own metadata concise. - * |
- * ||||||||||||||||||||||||||||||
pem_file | - *string | - *
- * - * Path to a PEM encoded certificate to use for client authentication. - * - *- * This option is a deprecated alias for the - * "tlsCertificateKeyFile" URI option. - * - * |
- * ||||||||||||||||||||||||||||||
pem_pwd | - *string | - *
- * - * Passphrase for the PEM encoded certificate (if applicable). - * - *- * This option is a deprecated alias for the - * "tlsCertificateKeyFilePassword" URI option. - * - * |
- * ||||||||||||||||||||||||||||||
serverApi | - *MongoDB\Driver\ServerApi | - *
- * - * This option is used to declare a server API version for the manager. - * If omitted, no API version is declared. - * - * |
- * ||||||||||||||||||||||||||||||
weak_cert_validation | - *bool | - *
- * - * Disables certificate validation if true. Defaults to false - * - *- * This option is a deprecated alias for the - * "tlsAllowInvalidCertificates" URI option. - * - * |
- *
Disables hostname validation if true. Defaults to false.
- *Allowing invalid hostnames may expose the driver to a - * man-in-the-middle attack.
- *This option is a deprecated alias for the - * "tlsAllowInvalidHostnames" URI option.
- *Provides options to enable automatic client-side field level - * encryption.
- *Automatic encryption is an enterprise-only feature that only - * applies to operations on a collection. Automatic encryption is not - * supported for operations on a database or view, and operations that - * are not bypassed will result in error (see - * libmongocrypt: Auto Encryption Allow-List). To bypass automatic encryption - * for all operations, set bypassAutoEncryption to - * true.
- *Automatic encryption requires the authenticated user to have the - * listCollections - * privilege action.
- *Explicit encryption/decryption and automatic decryption is a - * community feature. The driver can still automatically decrypt when - * bypassAutoEncryption is true.
- *The following options are supported: - *
Option | - *Type | - *Description | - *
keyVaultClient | - *MongoDB\Driver\Manager | - *The Manager used to route data key queries to a separate MongoDB cluster. By default, the current Manager and cluster is used. | - *
keyVaultNamespace | - *string | - *A fully qualified namespace (e.g. "databaseName.collectionName") denoting the collection that contains all data keys used for encryption and decryption. This option is required. | - *
kmsProviders | - *array | - *
- * - * A document containing the configuration for one or more KMS providers, which are used to encrypt data keys. Supported providers include "aws", "azure", "gcp", "kmip", and "local" and at least one must be specified. - * - *- * The format for "aws" is as follows: - * - *- * aws: { - * accessKeyId: , - * secretAccessKey: , - * sessionToken: - * } - *- * - * The format for "azure" is as follows: - * - *- * azure: { - * tenantId: , - * clientId: , - * clientSecret: , - * identityPlatformEndpoint: // Defaults to "login.microsoftonline.com" - * } - *- * - * The format for "gcp" is as follows: - * - *- * gcp: { - * email: , - * privateKey: |, - * endpoint: // Defaults to "oauth2.googleapis.com" - * } - *- * - * The format for "kmip" is as follows: - * - *- * kmip: { - * endpoint: - * } - *- * - * The format for "local" is as follows: - * - *- * local: { - * // 96-byte master key used to encrypt/decrypt data keys - * key: | - * } - *- * |
- *
tlsOptions | - *array | - *
- * - * A document containing the TLS configuration for one or more KMS providers. Supported providers include "aws", "azure", "gcp", and "kmip". All providers support the following options: - * - *- * : { - * tlsCaFile: , - * tlsCertificateKeyFile: , - * tlsCertificateKeyFilePassword: , - * tlsDisableOCSPEndpointCheck: - * } - *- * |
- *
schemaMap | - *arrayobject | - *
- * - * Map of collection namespaces to a local JSON schema. This is - * used to configure automatic encryption. See - * Automatic Encryption Rules - * in the MongoDB manual for more information. It is an error to - * specify a collection in both schemaMap and - * encryptedFieldsMap. - * - * Supplying a schemaMap provides more - * security than relying on JSON schemas obtained from the - * server. It protects against a malicious server advertising a - * false JSON schema, which could trick the client into sending - * unencrypted data that should be encrypted. - * Schemas supplied in the schemaMap only - * apply to configuring automatic encryption for client side - * encryption. Other validation rules in the JSON schema will - * not be enforced by the driver and will result in an error. - * |
- *
bypassAutoEncryption | - *bool | - *- * If true, mongocryptd will not be spawned - * automatically. This is used to disable automatic encryption. - * Defaults to false. - * | - *
bypassQueryAnalysis | - *bool | - *
- * - * If true, automatic analysis of outgoing commands will be - * disabled and mongocryptd will not be - * spawned automatically. This enables the use case of explicit - * encryption for querying indexed fields without requiring the - * enterprise licensed crypt_shared library or - * mongocryptd process. Defaults to false. - * - * Queryable Encryption is in public preview and available for evaluation - * purposes. It is not yet recommended for production deployments as breaking - * changes may be introduced. See the Queryable Encryption Preview blog post for more information. - * |
- *
encryptedFieldsMap | - *arrayobject | - *
- * - * Map of collection namespaces to an - * encryptedFields document. This is used to - * configure queryable encryption. See - * Field Encryption and Queryability - * in the MongoDB manual for more information. It is an error to - * specify a collection in both - * encryptedFieldsMap and - * schemaMap. - * - * Supplying an encryptedFieldsMap provides - * more security than relying on an - * encryptedFields obtained from the server. - * It protects against a malicious server advertising a false - * encryptedFields. - * Queryable Encryption is in public preview and available for evaluation - * purposes. It is not yet recommended for production deployments as breaking - * changes may be introduced. See the Queryable Encryption Preview blog post for more information. - * |
- *
extraOptions | - *array | - *
- * - * The extraOptions relate to the - * mongocryptd process. The following options - * are supported: - * - *- * mongocryptdURI (string): URI to connect to an existing mongocryptd process. Defaults to "mongodb://localhost:27020". - * mongocryptdBypassSpawn (bool): If true, prevent the driver from spawning mongocryptd. Defaults to false. - * mongocryptdSpawnPath (string): Absolute path to search for mongocryptd binary. Defaults to empty string and consults system paths. - * mongocryptdSpawnArgs (array): Array of string arguments to pass to mongocryptd when spawning. Defaults to ["--idleShutdownTimeoutSecs=60"]. - * cryptSharedLibPath (string): Absolute path to crypt_shared shared library. Defaults to empty string and consults system paths. - * cryptSharedLibRequired (bool): If true, require the driver to load crypt_shared. Defaults to false. - * - *- * See the Client-Side Encryption Specification for more information. - * - * |
- *
A document containing the configuration for one or more KMS providers, which are used to encrypt data keys. Supported providers include "aws", "azure", "gcp", "kmip", and "local" and at least one must be specified.
- *The format for "aws" is as follows:
- *The format for "azure" is as follows:
- *The format for "gcp" is as follows:
- *The format for "kmip" is as follows:
- *The format for "local" is as follows:
- *A document containing the TLS configuration for one or more KMS providers. Supported providers include "aws", "azure", "gcp", and "kmip". All providers support the following options:
- *Map of collection namespaces to a local JSON schema. This is - * used to configure automatic encryption. See - * Automatic Encryption Rules - * in the MongoDB manual for more information. It is an error to - * specify a collection in both schemaMap and - * encryptedFieldsMap.
- *If true, automatic analysis of outgoing commands will be - * disabled and mongocryptd will not be - * spawned automatically. This enables the use case of explicit - * encryption for querying indexed fields without requiring the - * enterprise licensed crypt_shared library or - * mongocryptd process. Defaults to false.
- *Map of collection namespaces to an - * encryptedFields document. This is used to - * configure queryable encryption. See - * Field Encryption and Queryability - * in the MongoDB manual for more information. It is an error to - * specify a collection in both - * encryptedFieldsMap and - * schemaMap.
- *The extraOptions relate to the - * mongocryptd process. The following options - * are supported:
- *See the Client-Side Encryption Specification for more information.
- *Path to a correctly hashed certificate directory. The system - * certificate store will be used by default.
- *Path to file with either a single or bundle of certificate - * authorities to be considered trusted when making a TLS connection. - * The system certificate store will be used by default.
- *This option is a deprecated alias for the - * "tlsCAFile" URI option.
- *SSL context options to be used as - * fallbacks if a driver option or its equivalent URI option, if any, - * is not specified. Note that the driver does not consult the default - * stream context (i.e. - * stream_context_get_default). The following - * context options are supported:
- *This option is supported for backwards compatibility, but should be - * considered deprecated.
- *If true, this Manager will use a new libmongoc client, which will - * not be persisted or shared with other Manager objects. When this - * Manager object is freed, its client will be destroyed and any - * connections will be closed. Defaults to false.
- *Allows custom drivers to append their own metadata to the server - * handshake. By default, the driver submits its own name, version, and - * platform (i.e. PHP version) in the handshake. Custom drivers can - * specify strings for the "name", - * "version", and - * "platform" keys of this array, which will be - * appended to the respective field(s) in the handshake document.
- *Path to a PEM encoded certificate to use for client authentication.
- *This option is a deprecated alias for the - * "tlsCertificateKeyFile" URI option.
- *Passphrase for the PEM encoded certificate (if applicable).
- *This option is a deprecated alias for the - * "tlsCertificateKeyFilePassword" URI option.
- *This option is used to declare a server API version for the manager. - * If omitted, no API version is declared.
- *Disables certificate validation if true. Defaults to false
- *This option is a deprecated alias for the - * "tlsAllowInvalidCertificates" URI option.
- * @return string|null - */ - final public function __construct (?string $uri = null, ?array $uriOptions = null, ?array $driverOptions = null): ?string {} - - /** - * Registers a monitoring event subscriber with this Manager - * @link http://www.php.net/manual/en/mongodb-driver-manager.addsubscriber.php - * @param \MongoDB\Driver\Monitoring\Subscriber $subscriber A monitoring event subscriber to register with this Manager. - * @return void No value is returned. + * {@inheritdoc} + * @param string|null $uri [optional] + * @param array|null $uriOptions [optional] + * @param array|null $driverOptions [optional] + */ + final public function __construct (?string $uri = NULL, ?array $uriOptions = NULL, ?array $driverOptions = NULL) {} + + /** + * {@inheritdoc} + * @param \MongoDB\Driver\Monitoring\Subscriber $subscriber */ final public function addSubscriber (\MongoDB\Driver\Monitoring\Subscriber $subscriber): void {} /** - * Create a new ClientEncryption object - * @link http://www.php.net/manual/en/mongodb-driver-manager.createclientencryption.php - * @param array $optionsOption | - *Type | - *Description | - *
keyVaultClient | - *MongoDB\Driver\Manager | - *The Manager used to route data key queries to a separate MongoDB cluster. By default, the current Manager and cluster is used. | - *
keyVaultNamespace | - *string | - *A fully qualified namespace (e.g. "databaseName.collectionName") denoting the collection that contains all data keys used for encryption and decryption. This option is required. | - *
kmsProviders | - *array | - *
- * - * A document containing the configuration for one or more KMS providers, which are used to encrypt data keys. Supported providers include "aws", "azure", "gcp", "kmip", and "local" and at least one must be specified. - * - *- * The format for "aws" is as follows: - * - *- * aws: { - * accessKeyId: , - * secretAccessKey: , - * sessionToken: - * } - *- * - * The format for "azure" is as follows: - * - *- * azure: { - * tenantId: , - * clientId: , - * clientSecret: , - * identityPlatformEndpoint: // Defaults to "login.microsoftonline.com" - * } - *- * - * The format for "gcp" is as follows: - * - *- * gcp: { - * email: , - * privateKey: |, - * endpoint: // Defaults to "oauth2.googleapis.com" - * } - *- * - * The format for "kmip" is as follows: - * - *- * kmip: { - * endpoint: - * } - *- * - * The format for "local" is as follows: - * - *- * local: { - * // 96-byte master key used to encrypt/decrypt data keys - * key: | - * } - *- * |
- *
tlsOptions | - *array | - *
- * - * A document containing the TLS configuration for one or more KMS providers. Supported providers include "aws", "azure", "gcp", and "kmip". All providers support the following options: - * - *- * : { - * tlsCaFile: , - * tlsCertificateKeyFile: , - * tlsCertificateKeyFilePassword: , - * tlsDisableOCSPEndpointCheck: - * } - *- * |
- *
A document containing the configuration for one or more KMS providers, which are used to encrypt data keys. Supported providers include "aws", "azure", "gcp", "kmip", and "local" and at least one must be specified.
- *The format for "aws" is as follows:
- *The format for "azure" is as follows:
- *The format for "gcp" is as follows:
- *The format for "kmip" is as follows:
- *The format for "local" is as follows:
- *A document containing the TLS configuration for one or more KMS providers. Supported providers include "aws", "azure", "gcp", and "kmip". All providers support the following options:
- * @return \MongoDB\Driver\ClientEncryption Returns a new MongoDB\Driver\ClientEncryption instance. + * {@inheritdoc} + * @param array $options */ final public function createClientEncryption (array $options): \MongoDB\Driver\ClientEncryption {} /** - * Execute one or more write operations - * @link http://www.php.net/manual/en/mongodb-driver-manager.executebulkwrite.php - * @param string $namespace A fully qualified namespace (e.g. "databaseName.collectionName"). - * @param \MongoDB\Driver\BulkWrite $bulk The write(s) to execute. - * @param array|\MongoDB\Driver\WriteConcern|null $options [optional]Option | - *Type | - *Description | - *
session | - *MongoDB\Driver\Session | - *
- * - * A session to associate with the operation. - * - * |
- *
writeConcern | - *MongoDB\Driver\WriteConcern | - *
- * - * A write concern to apply to the operation. - * - * |
- *
A session to associate with the operation.
- *A write concern to apply to the operation.
- * @return \MongoDB\Driver\WriteResult >Returns MongoDB\Driver\WriteResult on success. - */ - final public function executeBulkWrite (string $namespace, \MongoDB\Driver\BulkWrite $bulk, array|\MongoDB\Driver\WriteConcern|null $options = null): \MongoDB\Driver\WriteResult {} - - /** - * Execute a database command - * @link http://www.php.net/manual/en/mongodb-driver-manager.executecommand.php - * @param string $db The name of the database on which to execute the command. - * @param \MongoDB\Driver\Command $command The command to execute. - * @param array|\MongoDB\Driver\ReadPreference|null $options [optional]Option | - *Type | - *Description | - *
readConcern | - *MongoDB\Driver\ReadConcern | - *
- * - * A read concern to apply to the operation. - * - *- * This option is available in MongoDB 3.2+ and will result in an - * exception at execution time if specified for an older server - * version. - * - * |
- *
readPreference | - *MongoDB\Driver\ReadPreference | - *
- * - * A read preference to use for selecting a server for the operation. - * - * |
- *
session | - *MongoDB\Driver\Session | - *
- * - * A session to associate with the operation. - * - * |
- *
writeConcern | - *MongoDB\Driver\WriteConcern | - *
- * - * A write concern to apply to the operation. - * - * |
- *
A read concern to apply to the operation.
- *This option is available in MongoDB 3.2+ and will result in an - * exception at execution time if specified for an older server - * version.
- *A read preference to use for selecting a server for the operation.
- *A session to associate with the operation.
- *A write concern to apply to the operation.
- *If you are using a "session" which has a transaction - * in progress, you cannot specify a "readConcern" or - * "writeConcern" option. This will result in an - * MongoDB\Driver\Exception\InvalidArgumentException - * being thrown. Instead, you should set these two options when you create - * the transaction with - * MongoDB\Driver\Session::startTransaction.
- * @return \MongoDB\Driver\Cursor >Returns MongoDB\Driver\Cursor on success. - */ - final public function executeCommand (string $db, \MongoDB\Driver\Command $command, array|\MongoDB\Driver\ReadPreference|null $options = null): \MongoDB\Driver\Cursor {} - - /** - * Execute a database query - * @link http://www.php.net/manual/en/mongodb-driver-manager.executequery.php - * @param string $namespace A fully qualified namespace (e.g. "databaseName.collectionName"). - * @param \MongoDB\Driver\Query $query The query to execute. - * @param array|\MongoDB\Driver\ReadPreference|null $options [optional]Option | - *Type | - *Description | - *
readPreference | - *MongoDB\Driver\ReadPreference | - *
- * - * A read preference to use for selecting a server for the operation. - * - * |
- *
session | - *MongoDB\Driver\Session | - *
- * - * A session to associate with the operation. - * - * |
- *
A read preference to use for selecting a server for the operation.
- *A session to associate with the operation.
- * @return \MongoDB\Driver\Cursor >Returns MongoDB\Driver\Cursor on success. - */ - final public function executeQuery (string $namespace, \MongoDB\Driver\Query $query, array|\MongoDB\Driver\ReadPreference|null $options = null): \MongoDB\Driver\Cursor {} - - /** - * Execute a database command that reads - * @link http://www.php.net/manual/en/mongodb-driver-manager.executereadcommand.php - * @param string $db The name of the database on which to execute the command. - * @param \MongoDB\Driver\Command $command The command to execute. - * @param array|null $options [optional]Option | - *Type | - *Description | - *
readConcern | - *MongoDB\Driver\ReadConcern | - *
- * - * A read concern to apply to the operation. - * - *- * This option is available in MongoDB 3.2+ and will result in an - * exception at execution time if specified for an older server - * version. - * - * |
- *
readPreference | - *MongoDB\Driver\ReadPreference | - *
- * - * A read preference to use for selecting a server for the operation. - * - * |
- *
session | - *MongoDB\Driver\Session | - *
- * - * A session to associate with the operation. - * - * |
- *
A read concern to apply to the operation.
- *This option is available in MongoDB 3.2+ and will result in an - * exception at execution time if specified for an older server - * version.
- *A read preference to use for selecting a server for the operation.
- *A session to associate with the operation.
- *If you are using a "session" which has a transaction - * in progress, you cannot specify a "readConcern" or - * "writeConcern" option. This will result in an - * MongoDB\Driver\Exception\InvalidArgumentException - * being thrown. Instead, you should set these two options when you create - * the transaction with - * MongoDB\Driver\Session::startTransaction.
- * @return \MongoDB\Driver\Cursor >Returns MongoDB\Driver\Cursor on success. - */ - final public function executeReadCommand (string $db, \MongoDB\Driver\Command $command, ?array $options = null): \MongoDB\Driver\Cursor {} - - /** - * Execute a database command that reads and writes - * @link http://www.php.net/manual/en/mongodb-driver-manager.executereadwritecommand.php - * @param string $db The name of the database on which to execute the command. - * @param \MongoDB\Driver\Command $command The command to execute. - * @param array|null $options [optional]Option | - *Type | - *Description | - *
readConcern | - *MongoDB\Driver\ReadConcern | - *
- * - * A read concern to apply to the operation. - * - *- * This option is available in MongoDB 3.2+ and will result in an - * exception at execution time if specified for an older server - * version. - * - * |
- *
session | - *MongoDB\Driver\Session | - *
- * - * A session to associate with the operation. - * - * |
- *
writeConcern | - *MongoDB\Driver\WriteConcern | - *
- * - * A write concern to apply to the operation. - * - * |
- *
A read concern to apply to the operation.
- *This option is available in MongoDB 3.2+ and will result in an - * exception at execution time if specified for an older server - * version.
- *A session to associate with the operation.
- *A write concern to apply to the operation.
- *If you are using a "session" which has a transaction - * in progress, you cannot specify a "readConcern" or - * "writeConcern" option. This will result in an - * MongoDB\Driver\Exception\InvalidArgumentException - * being thrown. Instead, you should set these two options when you create - * the transaction with - * MongoDB\Driver\Session::startTransaction.
- * @return \MongoDB\Driver\Cursor >Returns MongoDB\Driver\Cursor on success. - */ - final public function executeReadWriteCommand (string $db, \MongoDB\Driver\Command $command, ?array $options = null): \MongoDB\Driver\Cursor {} - - /** - * Execute a database command that writes - * @link http://www.php.net/manual/en/mongodb-driver-manager.executewritecommand.php - * @param string $db The name of the database on which to execute the command. - * @param \MongoDB\Driver\Command $command The command to execute. - * @param array|null $options [optional]Option | - *Type | - *Description | - *
session | - *MongoDB\Driver\Session | - *
- * - * A session to associate with the operation. - * - * |
- *
writeConcern | - *MongoDB\Driver\WriteConcern | - *
- * - * A write concern to apply to the operation. - * - * |
- *
A session to associate with the operation.
- *A write concern to apply to the operation.
- *If you are using a "session" which has a transaction - * in progress, you cannot specify a "readConcern" or - * "writeConcern" option. This will result in an - * MongoDB\Driver\Exception\InvalidArgumentException - * being thrown. Instead, you should set these two options when you create - * the transaction with - * MongoDB\Driver\Session::startTransaction.
- * @return \MongoDB\Driver\Cursor >Returns MongoDB\Driver\Cursor on success. - */ - final public function executeWriteCommand (string $db, \MongoDB\Driver\Command $command, ?array $options = null): \MongoDB\Driver\Cursor {} - - /** - * Return the encryptedFieldsMap auto encryption option for the Manager - * @link http://www.php.net/manual/en/mongodb-driver-manager.getencryptedfieldsmap.php - * @return array|object|null The encryptedFieldsMap auto encryption option for the - * Manager, or null if it was not specified. - */ - final public function getEncryptedFieldsMap (): array|object|null {} - - /** - * Return the ReadConcern for the Manager - * @link http://www.php.net/manual/en/mongodb-driver-manager.getreadconcern.php - * @return \MongoDB\Driver\ReadConcern The MongoDB\Driver\ReadConcern for the Manager. + * {@inheritdoc} + * @param string $namespace + * @param \MongoDB\Driver\BulkWrite $bulk + * @param \MongoDB\Driver\WriteConcern|array|null $options [optional] + */ + final public function executeBulkWrite (string $namespace, \MongoDB\Driver\BulkWrite $bulk, \MongoDB\Driver\WriteConcern|array|null $options = NULL): \MongoDB\Driver\WriteResult {} + + /** + * {@inheritdoc} + * @param string $db + * @param \MongoDB\Driver\Command $command + * @param \MongoDB\Driver\ReadPreference|array|null $options [optional] + */ + final public function executeCommand (string $db, \MongoDB\Driver\Command $command, \MongoDB\Driver\ReadPreference|array|null $options = NULL): \MongoDB\Driver\Cursor {} + + /** + * {@inheritdoc} + * @param string $namespace + * @param \MongoDB\Driver\Query $query + * @param \MongoDB\Driver\ReadPreference|array|null $options [optional] + */ + final public function executeQuery (string $namespace, \MongoDB\Driver\Query $query, \MongoDB\Driver\ReadPreference|array|null $options = NULL): \MongoDB\Driver\Cursor {} + + /** + * {@inheritdoc} + * @param string $db + * @param \MongoDB\Driver\Command $command + * @param array|null $options [optional] + */ + final public function executeReadCommand (string $db, \MongoDB\Driver\Command $command, ?array $options = NULL): \MongoDB\Driver\Cursor {} + + /** + * {@inheritdoc} + * @param string $db + * @param \MongoDB\Driver\Command $command + * @param array|null $options [optional] + */ + final public function executeReadWriteCommand (string $db, \MongoDB\Driver\Command $command, ?array $options = NULL): \MongoDB\Driver\Cursor {} + + /** + * {@inheritdoc} + * @param string $db + * @param \MongoDB\Driver\Command $command + * @param array|null $options [optional] + */ + final public function executeWriteCommand (string $db, \MongoDB\Driver\Command $command, ?array $options = NULL): \MongoDB\Driver\Cursor {} + + /** + * {@inheritdoc} + */ + final public function getEncryptedFieldsMap (): object|array|null {} + + /** + * {@inheritdoc} */ final public function getReadConcern (): \MongoDB\Driver\ReadConcern {} /** - * Return the ReadPreference for the Manager - * @link http://www.php.net/manual/en/mongodb-driver-manager.getreadpreference.php - * @return \MongoDB\Driver\ReadPreference The MongoDB\Driver\ReadPreference for the Manager. + * {@inheritdoc} */ final public function getReadPreference (): \MongoDB\Driver\ReadPreference {} /** - * Return the servers to which this manager is connected - * @link http://www.php.net/manual/en/mongodb-driver-manager.getservers.php - * @return array Returns an array of MongoDB\Driver\Server - * instances to which this manager is connected. + * {@inheritdoc} */ final public function getServers (): array {} /** - * Return the WriteConcern for the Manager - * @link http://www.php.net/manual/en/mongodb-driver-manager.getwriteconcern.php - * @return \MongoDB\Driver\WriteConcern The MongoDB\Driver\WriteConcern for the Manager. + * {@inheritdoc} */ final public function getWriteConcern (): \MongoDB\Driver\WriteConcern {} /** - * Unregisters a monitoring event subscriber with this Manager - * @link http://www.php.net/manual/en/mongodb-driver-manager.removesubscriber.php - * @param \MongoDB\Driver\Monitoring\Subscriber $subscriber A monitoring event subscriber to unregister with this Manager. - * @return void No value is returned. + * {@inheritdoc} + * @param \MongoDB\Driver\Monitoring\Subscriber $subscriber + */ + final public function removeSubscriber (\MongoDB\Driver\Monitoring\Subscriber $subscriber): void {} + + /** + * {@inheritdoc} + * @param \MongoDB\Driver\ReadPreference|null $readPreference [optional] */ - final public function removeSubscriber (\MongoDB\Driver\Monitoring\Subscriber $subscriber): void {} + final public function selectServer (?\MongoDB\Driver\ReadPreference $readPreference = NULL): \MongoDB\Driver\Server {} /** - * Select a server matching a read preference - * @link http://www.php.net/manual/en/mongodb-driver-manager.selectserver.php - * @param \MongoDB\Driver\ReadPreference|null $readPreference [optional] The read preference to use for selecting a server. If null or omitted, - * the primary server will be selected by default. - * @return \MongoDB\Driver\Server Returns a MongoDB\Driver\Server matching the read - * preference. - */ - final public function selectServer (?\MongoDB\Driver\ReadPreference $readPreference = null): \MongoDB\Driver\Server {} - - /** - * Start a new client session for use with this client - * @link http://www.php.net/manual/en/mongodb-driver-manager.startsession.php - * @param array|null $options [optional]Option | - *Type | - *Description | - *Default | - *|||||||||||||||
causalConsistency | - *bool | - *
- * - * Configure causal consistency in a session. If true, each operation - * in the session will be causally ordered after the previous read or - * write operation. Set to false to disable causal consistency. - * - *- * See - * Casual Consistency - * in the MongoDB manual for more information. - * - * |
- * true | - *|||||||||||||||
defaultTransactionOptions | - *array | - *
- * - * Default options to apply to newly created transactions. These - * options are used unless they are overridden when a transaction is - * started with different value for each option. - * - *- *
- * This option is available in MongoDB 4.0+. - * - * |
- * [] | - *|||||||||||||||
snapshot | - *bool | - *
- * - * Configure snapshot reads in a session. If true, a timestamp will - * be obtained from the first supported read operation in the session - * (i.e. find, aggregate, or - * unsharded distinct). Subsequent read operations - * within the session will then utilize a "snapshot" - * read concern level to read majority-committed data from that - * timestamp. Set to false to disable snapshot reads. - * - *- * Snapshot reads require MongoDB 5.0+ and cannot be used with causal - * consistency, transactions, or write operations. If - * "snapshot" is true, - * "causalConsistency" will default to false. - * - *- * See - * Read Concern "snapshot" - * in the MongoDB manual for more information. - * - * |
- * false | - *
Configure causal consistency in a session. If true, each operation - * in the session will be causally ordered after the previous read or - * write operation. Set to false to disable causal consistency.
- *See - * Casual Consistency - * in the MongoDB manual for more information.
- *Default options to apply to newly created transactions. These - * options are used unless they are overridden when a transaction is - * started with different value for each option.
- *Option | - *Type | - *Description | - *
maxCommitTimeMS | - *integer | - *
- * - * The maximum amount of time in milliseconds to allow a single - * commitTransaction command to run. - * - *- * If specified, maxCommitTimeMS must be a signed - * 32-bit integer greater than or equal to zero. - * - * |
- *
readConcern | - *MongoDB\Driver\ReadConcern | - *
- * - * A read concern to apply to the operation. - * - *- * This option is available in MongoDB 3.2+ and will result in an - * exception at execution time if specified for an older server - * version. - * - * |
- *
readPreference | - *MongoDB\Driver\ReadPreference | - *
- * - * A read preference to use for selecting a server for the operation. - * - * |
- *
writeConcern | - *MongoDB\Driver\WriteConcern | - *
- * - * A write concern to apply to the operation. - * - * |
- *
The maximum amount of time in milliseconds to allow a single - * commitTransaction command to run.
- *If specified, maxCommitTimeMS must be a signed - * 32-bit integer greater than or equal to zero.
- *A read concern to apply to the operation.
- *This option is available in MongoDB 3.2+ and will result in an - * exception at execution time if specified for an older server - * version.
- *A read preference to use for selecting a server for the operation.
- *A write concern to apply to the operation.
- *This option is available in MongoDB 4.0+.
- *Configure snapshot reads in a session. If true, a timestamp will - * be obtained from the first supported read operation in the session - * (i.e. find, aggregate, or - * unsharded distinct). Subsequent read operations - * within the session will then utilize a "snapshot" - * read concern level to read majority-committed data from that - * timestamp. Set to false to disable snapshot reads.
- *Snapshot reads require MongoDB 5.0+ and cannot be used with causal - * consistency, transactions, or write operations. If - * "snapshot" is true, - * "causalConsistency" will default to false.
- *See - * Read Concern "snapshot" - * in the MongoDB manual for more information.
- * @return \MongoDB\Driver\Session Returns a MongoDB\Driver\Session. - */ - final public function startSession (?array $options = null): \MongoDB\Driver\Session {} + * {@inheritdoc} + * @param array|null $options [optional] + */ + final public function startSession (?array $options = NULL): \MongoDB\Driver\Session {} /** * {@inheritdoc} @@ -4922,525 +1491,14 @@ final public function __wakeup (): void {} } -/** - * The MongoDB\Driver\Query class is a value object that - * represents a database query. - * @link http://www.php.net/manual/en/class.mongodb-driver-query.php - */ final class Query { /** - * Create a new Query - * @link http://www.php.net/manual/en/mongodb-driver-query.construct.php - * @param array|object $filter The query predicate. - * An empty predicate will match all documents in the collection. - * @param array|null $queryOptions [optional]Option | - *Type | - *Description | - *
allowDiskUse | - *bool | - *
- * - * Allows MongoDB to use temporary disk files to store data exceeding - * the 100 megabyte system memory limit while processing a blocking - * sort operation. - * - * |
- *
allowPartialResults | - *bool | - *
- * - * For queries against a sharded collection, returns partial results - * from the mongos if some shards are unavailable instead of throwing - * an error. - * - *- * Falls back to the deprecated "partial" option if - * not specified. - * - * |
- *
awaitData | - *bool | - *- * Use in conjunction with the "tailable" option to - * block a getMore operation on the cursor temporarily if at the end of - * data rather than returning no data. After a timeout period, the query - * returns as normal. - * | - *
batchSize | - *int | - *
- * - * The number of documents to return in the first batch. Defaults to - * 101. A batch size of 0 means that the cursor will be established, - * but no documents will be returned in the first batch. - * - *- * In versions of MongoDB before 3.2, where queries use the legacy wire - * protocol OP_QUERY, a batch size of 1 will close the cursor - * irrespective of the number of matched documents. - * - * |
- *
collation | - *arrayobject | - *
- * - * Collation allows users to specify language-specific rules for string comparison, such as rules for lettercase and accent marks. When specifying collation, the "locale" field is mandatory; all other collation fields are optional. For descriptions of the fields, see Collation Document. - * - *- * If the collation is unspecified but the collection has a default collation, the operation uses the collation specified for the collection. If no collation is specified for the collection or for the operation, MongoDB uses the simple binary comparison used in prior versions for string comparisons. - * - *- * This option is available in MongoDB 3.4+ and will result in an exception at execution time if specified for an older server version. - * - * |
- *
comment | - *mixed | - *
- * - * An arbitrary comment to help trace the operation through the - * database profiler, currentOp output, and logs. - * - *- * The comment can be any valid BSON type for MongoDB 4.4+. Earlier - * server versions only support string values. - * - *- * Falls back to the deprecated "$comment" modifier - * if not specified. - * - * |
- *
exhaust | - *bool | - *
- * - * Stream the data down full blast in multiple "more" packages, on the - * assumption that the client will fully read all data queried. Faster - * when you are pulling a lot of data and know you want to pull it all - * down. Note: the client is not allowed to not read all the data - * unless it closes the connection. - * - *- * This option is not supported by the find command in MongoDB 3.2+ and - * will force the driver to use the legacy wire protocol version (i.e. - * OP_QUERY). - * - * |
- *
explain | - *bool | - *
- * - * If true, the returned MongoDB\Driver\Cursor - * will contain a single document that describes the process and - * indexes used to return the query. - * - *- * Falls back to the deprecated "$explain" modifier - * if not specified. - * - *- * This option is not supported by the find command in MongoDB 3.2+ and - * will only be respected when using the legacy wire protocol version - * (i.e. OP_QUERY). The - * explain - * command should be used on MongoDB 3.0+. - * - * |
- *
hint | - *stringarrayobject | - *
- * - * Index specification. Specify either the index name as a string or - * the index key pattern. If specified, then the query system will only - * consider plans using the hinted index. - * - *- * Falls back to the deprecated "hint" option if not - * specified. - * - * |
- *
let | - *arrayobject | - *
- * - * Map of parameter names and values. Values must be constant or closed expressions that do not reference document fields. Parameters can then be accessed as variables in an aggregate expression context (e.g. $$var). - * - *- * This option is available in MongoDB 5.0+ and will result in an exception at execution time if specified for an older server version. - * - * |
- *
limit | - *int | - *
- * - * The maximum number of documents to return. If unspecified, then - * defaults to no limit. A limit of 0 is equivalent to setting no - * limit. - * - *- * A negative limit is will be interpreted as a positive limit with the - * "singleBatch" option set to true. This behavior - * is supported for backwards compatibility, but should be considered - * deprecated. - * - * |
- *
max | - *arrayobject | - *
- * - * The exclusive upper bound for a specific index. - * - *- * Falls back to the deprecated "$max" modifier if - * not specified. - * - * |
- *
maxAwaitTimeMS | - *int | - *
- * - * Positive integer denoting the time limit in milliseconds for the - * server to block a getMore operation if no data is available. This - * option should only be used in conjunction with the - * "tailable" and "awaitData" - * options. - * - * |
- *
maxScan | - *int | - *
- * This option is deprecated and should not be used.
- * - * Positive integer denoting the maximum number of documents or index - * keys to scan when executing the query. - * - *- * Falls back to the deprecated "$maxScan" modifier - * if not specified. - * - * |
- *
maxTimeMS | - *int | - *
- * - * The cumulative time limit in milliseconds for processing operations - * on the cursor. MongoDB aborts the operation at the earliest - * following interrupt point. - * - *- * Falls back to the deprecated "$maxTimeMS" - * modifier if not specified. - * - * |
- *
min | - *arrayobject | - *
- * - * The inclusive lower bound for a specific index. - * - *- * Falls back to the deprecated "$min" modifier if - * not specified. - * - * |
- *
modifiers | - *array | - *- * Meta operators - * modifying the output or behavior of a query. Use of these operators - * is deprecated in favor of named options. - * | - *
noCursorTimeout | - *bool | - *- * Prevents the server from timing out idle cursors after an inactivity - * period (10 minutes). - * | - *
oplogReplay | - *bool | - *
- * - * Internal use for replica sets. To use oplogReplay, you must include - * the following condition in the filter: - * - *- * - * [ 'ts' => [ '$gte' => ] ] - *- * - * This option is deprecated as of the 1.8.0 release. - * |
- *
projection | - *arrayobject | - *
- * - * The projection specification - * to determine which fields to include in the returned documents. - * - *- * If you are using the ODM - * functionality to deserialise documents as their original - * PHP class, make sure that you include the - * __pclass field in the projection. This is - * required for the deserialization to work and without it, the - * driver will return (by default) a stdClass - * object instead. - * - * |
- *
readConcern | - *MongoDB\Driver\ReadConcern | - *
- * - * A read concern to apply to the operation. By default, the read - * concern from the - * MongoDB - * Connection URI will be used. - * - *- * This option is available in MongoDB 3.2+ and will result in an - * exception at execution time if specified for an older server - * version. - * - * |
- *
returnKey | - *bool | - *
- * - * If true, returns only the index keys in the resulting documents. - * Default value is false. If true and the find command does not - * use an index, the returned documents will be empty. - * - *- * Falls back to the deprecated "$returnKey" - * modifier if not specified. - * - * |
- *
showRecordId | - *bool | - *
- * - * Determines whether to return the record identifier for each - * document. If true, adds a top-level "$recordId" - * field to the returned documents. - * - *- * Falls back to the deprecated "$showDiskLoc" - * modifier if not specified. - * - * |
- *
singleBatch | - *bool | - *- * Determines whether to close the cursor after the first batch. - * Defaults to false. - * | - *
skip | - *int | - *Number of documents to skip. Defaults to 0. | - *
snapshot | - *bool | - *
- * This option is deprecated and should not be used.
- * - * Prevents the cursor from returning a document more than once because - * of an intervening write operation. - * - *- * Falls back to the deprecated "$snapshot" modifier - * if not specified. - * - * |
- *
sort | - *arrayobject | - *
- * The sort specification for the ordering of the results. - *- * Falls back to the deprecated "$orderby" modifier - * if not specified. - * - * |
- *
tailable | - *bool | - *Returns a tailable cursor for a capped collection. | - *
Allows MongoDB to use temporary disk files to store data exceeding - * the 100 megabyte system memory limit while processing a blocking - * sort operation.
- *For queries against a sharded collection, returns partial results - * from the mongos if some shards are unavailable instead of throwing - * an error.
- *Falls back to the deprecated "partial" option if - * not specified.
- *The number of documents to return in the first batch. Defaults to - * 101. A batch size of 0 means that the cursor will be established, - * but no documents will be returned in the first batch.
- *In versions of MongoDB before 3.2, where queries use the legacy wire - * protocol OP_QUERY, a batch size of 1 will close the cursor - * irrespective of the number of matched documents.
- *Collation allows users to specify language-specific rules for string comparison, such as rules for lettercase and accent marks. When specifying collation, the "locale" field is mandatory; all other collation fields are optional. For descriptions of the fields, see Collation Document.
- *If the collation is unspecified but the collection has a default collation, the operation uses the collation specified for the collection. If no collation is specified for the collection or for the operation, MongoDB uses the simple binary comparison used in prior versions for string comparisons.
- *This option is available in MongoDB 3.4+ and will result in an exception at execution time if specified for an older server version.
- *An arbitrary comment to help trace the operation through the - * database profiler, currentOp output, and logs.
- *The comment can be any valid BSON type for MongoDB 4.4+. Earlier - * server versions only support string values.
- *Falls back to the deprecated "$comment" modifier - * if not specified.
- *Stream the data down full blast in multiple "more" packages, on the - * assumption that the client will fully read all data queried. Faster - * when you are pulling a lot of data and know you want to pull it all - * down. Note: the client is not allowed to not read all the data - * unless it closes the connection.
- *This option is not supported by the find command in MongoDB 3.2+ and - * will force the driver to use the legacy wire protocol version (i.e. - * OP_QUERY).
- *If true, the returned MongoDB\Driver\Cursor - * will contain a single document that describes the process and - * indexes used to return the query.
- *Falls back to the deprecated "$explain" modifier - * if not specified.
- *This option is not supported by the find command in MongoDB 3.2+ and - * will only be respected when using the legacy wire protocol version - * (i.e. OP_QUERY). The - * explain - * command should be used on MongoDB 3.0+.
- *Index specification. Specify either the index name as a string or - * the index key pattern. If specified, then the query system will only - * consider plans using the hinted index.
- *Falls back to the deprecated "hint" option if not - * specified.
- *Map of parameter names and values. Values must be constant or closed expressions that do not reference document fields. Parameters can then be accessed as variables in an aggregate expression context (e.g. $$var).
- *This option is available in MongoDB 5.0+ and will result in an exception at execution time if specified for an older server version.
- *The maximum number of documents to return. If unspecified, then - * defaults to no limit. A limit of 0 is equivalent to setting no - * limit.
- *A negative limit is will be interpreted as a positive limit with the - * "singleBatch" option set to true. This behavior - * is supported for backwards compatibility, but should be considered - * deprecated.
- *The exclusive upper bound for a specific index.
- *Falls back to the deprecated "$max" modifier if - * not specified.
- *Positive integer denoting the time limit in milliseconds for the - * server to block a getMore operation if no data is available. This - * option should only be used in conjunction with the - * "tailable" and "awaitData" - * options.
- *Positive integer denoting the maximum number of documents or index - * keys to scan when executing the query.
- *Falls back to the deprecated "$maxScan" modifier - * if not specified.
- *The cumulative time limit in milliseconds for processing operations - * on the cursor. MongoDB aborts the operation at the earliest - * following interrupt point.
- *Falls back to the deprecated "$maxTimeMS" - * modifier if not specified.
- *The inclusive lower bound for a specific index.
- *Falls back to the deprecated "$min" modifier if - * not specified.
- *Internal use for replica sets. To use oplogReplay, you must include - * the following condition in the filter:
- *- * [ 'ts' => [ '$gte' => ] ] - *- *
The projection specification - * to determine which fields to include in the returned documents.
- *If you are using the ODM - * functionality to deserialise documents as their original - * PHP class, make sure that you include the - * __pclass field in the projection. This is - * required for the deserialization to work and without it, the - * driver will return (by default) a stdClass - * object instead.
- *A read concern to apply to the operation. By default, the read - * concern from the - * MongoDB - * Connection URI will be used.
- *This option is available in MongoDB 3.2+ and will result in an - * exception at execution time if specified for an older server - * version.
- *If true, returns only the index keys in the resulting documents. - * Default value is false. If true and the find command does not - * use an index, the returned documents will be empty.
- *Falls back to the deprecated "$returnKey" - * modifier if not specified.
- *Determines whether to return the record identifier for each - * document. If true, adds a top-level "$recordId" - * field to the returned documents.
- *Falls back to the deprecated "$showDiskLoc" - * modifier if not specified.
- *Prevents the cursor from returning a document more than once because - * of an intervening write operation.
- *Falls back to the deprecated "$snapshot" modifier - * if not specified.
- *The sort specification for the ordering of the results.
- *Falls back to the deprecated "$orderby" modifier - * if not specified.
- * @return array|object - */ - final public function __construct (array|object $filter, ?array $queryOptions = null): array|object {} + * {@inheritdoc} + * @param object|array $filter + * @param array|null $queryOptions [optional] + */ + final public function __construct (object|array $filter, ?array $queryOptions = NULL) {} /** * {@inheritdoc} @@ -5449,108 +1507,27 @@ final public function __wakeup (): void {} } -/** - * MongoDB\Driver\ReadConcern controls the level of - * isolation for read operations for replica sets and replica set shards. This - * option requires MongoDB 3.2 or later. - * @link http://www.php.net/manual/en/class.mongodb-driver-readconcern.php - */ final class ReadConcern implements \MongoDB\BSON\Serializable, \MongoDB\BSON\Type, \Serializable { - /** - * The query returns data that reflects all successful writes issued with a - * write concern of "majority" and - * acknowledged prior to the start of the read operation. For replica sets - * that run with writeConcernMajorityJournalDefault set - * to true, linearizable read concern returns data that will never be - * rolled back. - *With writeConcernMajorityJournalDefault set to - * false, MongoDB will not wait for w: "majority" - * writes to be durable before acknowledging the writes. As such, - * "majority" write operations could possibly roll back - * in the event of a loss of a replica set member.
- *You can specify linearizable read concern for read operations on the - * primary only.
- *Linearizable read concern guarantees only apply if read - * operations specify a query filter that uniquely identifies a single - * document.
- *Linearizable read concern requires MongoDB 3.4.
const LINEARIZABLE = "linearizable"; - /** - * Default for reads against primary if level is - * unspecified and for reads against secondaries if level - * is unspecified but afterClusterTime is specified. - *The query returns the instance's most recent data. Provides no - * guarantee that the data has been written to a majority of the replica set - * members (i.e. may be rolled back).
const LOCAL = "local"; - /** - * The query returns the instance's most recent data acknowledged as - * having been written to a majority of members in the replica set. - *To use read concern level of "majority", replica sets - * must use WiredTiger storage engine and election protocol version 1.
const MAJORITY = "majority"; - /** - * Default for reads against secondaries when - * afterClusterTimeand level are - * unspecified. - *The query returns the instance's most recent data. Provides no - * guarantee that the data has been written to a majority of the replica set - * members (i.e. may be rolled back).
- *For unsharded collections (including collections in a standalone - * deployment or a replica set deployment), "local" and - * "available" read concerns behave identically.
- *For a sharded cluster, "available" read concern - * provides greater tolerance for partitions since it does not wait to - * ensure consistency guarantees. However, a query with - * "available" read concern may return orphan documents - * if the shard is undergoing chunk migrations since the - * "available" read concern, unlike - * "local" read concern, does not contact the - * shard's primary nor the config servers for updated metadata.
const AVAILABLE = "available"; - /** - * Read concern "snapshot" is available for - * multi-document transactions, and starting in MongoDB 5.0, certain read - * operations outside of multi-document transactions. - *If the transaction is not part of a causally consistent session, upon - * transaction commit with write concern "majority", the - * transaction operations are guaranteed to have read from a snapshot of - * majority-committed data.
- *If the transaction is part of a causally consistent session, upon - * transaction commit with write concern "majority", the - * transaction operations are guaranteed to have read from a snapshot of - * majority-committed data that provides causal consistency with the - * operation immediately preceding the transaction start.
- *Outside of multi-document transactions, read concern - * "snapshot" is available on primaries and secondaries - * for the following read operations: find, - * aggregate, and distinct (on - * unsharded collections). All other read commands prohibit - * "snapshot".
const SNAPSHOT = "snapshot"; /** - * Create a new ReadConcern - * @link http://www.php.net/manual/en/mongodb-driver-readconcern.construct.php - * @param string|null $level [optional] The read concern level. - * You may use, but are not limited to, one of the - * class constants. - * @return string|null + * {@inheritdoc} + * @param string|null $level [optional] */ - final public function __construct (?string $level = null): ?string {} + final public function __construct (?string $level = NULL) {} /** - * Returns the ReadConcern's "level" option - * @link http://www.php.net/manual/en/mongodb-driver-readconcern.getlevel.php - * @return string|null Returns the ReadConcern's "level" option. + * {@inheritdoc} */ final public function getLevel (): ?string {} /** - * Checks if this is the default read concern - * @link http://www.php.net/manual/en/mongodb-driver-readconcern.isdefault.php - * @return bool Returns true if this is the default read concern and false otherwise. + * {@inheritdoc} */ final public function isDefault (): bool {} @@ -5561,27 +1538,20 @@ final public function isDefault (): bool {} final public static function __set_state (array $properties): \MongoDB\Driver\ReadConcern {} /** - * Returns an object for BSON serialization - * @link http://www.php.net/manual/en/mongodb-driver-readconcern.bsonserialize.php - * @return object Returns an object for serializing the ReadConcern as BSON. + * {@inheritdoc} */ - final public function bsonSerialize (): object {} + final public function bsonSerialize (): \stdClass {} /** - * Serialize a ReadConcern - * @link http://www.php.net/manual/en/mongodb-driver-readconcern.serialize.php - * @return string Returns the serialized representation of the - * MongoDB\Driver\ReadConcern. + * {@inheritdoc} */ final public function serialize (): string {} /** - * Unserialize a ReadConcern - * @link http://www.php.net/manual/en/mongodb-driver-readconcern.unserialize.php - * @param string $serialized - * @return void No value is returned. + * {@inheritdoc} + * @param string $data */ - final public function unserialize (string $serialized): void {} + final public function unserialize (string $data): void {} /** * {@inheritdoc} @@ -5596,263 +1566,51 @@ final public function __serialize (): array {} } -/** - * @link http://www.php.net/manual/en/class.mongodb-driver-readpreference.php - */ final class ReadPreference implements \MongoDB\BSON\Serializable, \MongoDB\BSON\Type, \Serializable { - /** - * All operations read from the current replica set primary. This is the - * default read preference for MongoDB. const RP_PRIMARY = 1; - /** - * In most situations, operations read from the primary but if it is - * unavailable, operations read from secondary members. const RP_PRIMARY_PREFERRED = 5; - /** - * All operations read from the secondary members of the replica set. const RP_SECONDARY = 2; - /** - * In most situations, operations read from secondary members but if no - * secondary members are available, operations read from the primary. const RP_SECONDARY_PREFERRED = 6; - /** - * Operations read from member of the replica set with the least network - * latency, irrespective of the member's type. const RP_NEAREST = 10; - /** - * All operations read from the current replica set primary. This is the - * default read preference for MongoDB. const PRIMARY = "primary"; - /** - * In most situations, operations read from the primary but if it is - * unavailable, operations read from secondary members. const PRIMARY_PREFERRED = "primaryPreferred"; - /** - * All operations read from the secondary members of the replica set. const SECONDARY = "secondary"; - /** - * In most situations, operations read from secondary members but if no - * secondary members are available, operations read from the primary. const SECONDARY_PREFERRED = "secondaryPreferred"; - /** - * Operations read from member of the replica set with the least network - * latency, irrespective of the member's type. const NEAREST = "nearest"; - /** - * The default value for the "maxStalenessSeconds" - * option is to specify no limit on maximum staleness, which means that the - * driver will not consider a secondary's lag when choosing where to - * direct a read operation. const NO_MAX_STALENESS = -1; - /** - * The minimum value for the "maxStalenessSeconds" option - * is 90 seconds. The driver estimates secondaries' staleness by - * periodically checking the latest write date of each replica set member. - * Since these checks are infrequent, the staleness estimate is coarse. - * Thus, the driver cannot enforce a max staleness value of less than 90 - * seconds. const SMALLEST_MAX_STALENESS_SECONDS = 90; /** - * Create a new ReadPreference - * @link http://www.php.net/manual/en/mongodb-driver-readpreference.construct.php - * @param string|int $modeValue | - *Description | - *
MongoDB\Driver\ReadPreference::RP_PRIMARY or "primary" | - *
- * - * All operations read from the current replica set primary. This is - * the default read preference for MongoDB. - * - * |
- *
MongoDB\Driver\ReadPreference::RP_PRIMARY_PREFERRED or "primaryPreferred" | - *
- * - * In most situations, operations read from the primary but if it is - * unavailable, operations read from secondary members. - * - * |
- *
MongoDB\Driver\ReadPreference::RP_SECONDARY or "secondary" | - *
- * - * All operations read from the secondary members of the replica set. - * - * |
- *
MongoDB\Driver\ReadPreference::RP_SECONDARY_PREFERRED or "secondaryPreferred" | - *
- * - * In most situations, operations read from secondary members but if no - * secondary members are available, operations read from the primary. - * - * |
- *
MongoDB\Driver\ReadPreference::RP_NEAREST or "nearest" | - *
- * - * Operations read from member of the replica set with the least - * network latency, irrespective of the member's type. - * - * |
- *
All operations read from the current replica set primary. This is - * the default read preference for MongoDB.
- *In most situations, operations read from the primary but if it is - * unavailable, operations read from secondary members.
- *All operations read from the secondary members of the replica set.
- *In most situations, operations read from secondary members but if no - * secondary members are available, operations read from the primary.
- *Operations read from member of the replica set with the least - * network latency, irrespective of the member's type.
- * @param array|null $tagSets [optional] Tag sets allow you to target read operations to specific members of a - * replica set. This parameter should be an array of associative arrays, each - * of which contain zero or more key/value pairs. When selecting a server for - * a read operation, the driver attempt to select a node having all tags in a - * set (i.e. the associative array of key/value pairs). If selection fails, - * the driver will attempt subsequent sets. An empty tag set - * (array()) will match any node and may be used as a - * fallback. - *Tags are not compatible with the - * MongoDB\Driver\ReadPreference::RP_PRIMARY mode and, - * in general, only apply when selecting a secondary member of a set for a - * read operation. However, the - * MongoDB\Driver\ReadPreference::RP_NEAREST mode, when - * combined with a tag set, selects the matching member with the lowest - * network latency. This member may be a primary or secondary.
- * @param array|null $options [optional]Option | - *Type | - *Description | - *
hedge | - *objectarray | - *
- * Specifies whether to use hedged reads, which are supported by MongoDB 4.4+ for sharded queries. - *- * Server hedged reads are available for all non-primary read preferences - * and are enabled by default when using the "nearest" - * mode. This option allows explicitly enabling server hedged reads for - * non-primary read preferences by specifying - * ['enabled' => true], or explicitly disabling - * server hedged reads for the "nearest" read - * preference by specifying ['enabled' => false]. - * - * |
- *
maxStalenessSeconds | - *int | - *
- * - * Specifies a maximum replication lag, or "staleness", for reads from - * secondaries. When a secondary's estimated staleness exceeds - * this value, the driver stops using it for read operations. - * - *- * If specified, the max staleness must be a signed 32-bit integer - * greater than or equal to - * MongoDB\Driver\ReadPreference::SMALLEST_MAX_STALENESS_SECONDS. - * - *- * Defaults to - * MongoDB\Driver\ReadPreference::NO_MAX_STALENESS, - * which means that the driver will not consider a secondary's lag - * when choosing where to direct a read operation. - * - *- * This option is not compatible with the - * MongoDB\Driver\ReadPreference::RP_PRIMARY mode. - * Specifying a max staleness also requires all MongoDB instances in - * the deployment to be using MongoDB 3.4+. An exception will be thrown - * at execution time if any MongoDB instances in the deployment are of - * an older server version. - * - * |
- *
Specifies whether to use hedged reads, which are supported by MongoDB 4.4+ for sharded queries.
- *Server hedged reads are available for all non-primary read preferences - * and are enabled by default when using the "nearest" - * mode. This option allows explicitly enabling server hedged reads for - * non-primary read preferences by specifying - * ['enabled' => true], or explicitly disabling - * server hedged reads for the "nearest" read - * preference by specifying ['enabled' => false].
- *Specifies a maximum replication lag, or "staleness", for reads from - * secondaries. When a secondary's estimated staleness exceeds - * this value, the driver stops using it for read operations.
- *If specified, the max staleness must be a signed 32-bit integer - * greater than or equal to - * MongoDB\Driver\ReadPreference::SMALLEST_MAX_STALENESS_SECONDS.
- *Defaults to - * MongoDB\Driver\ReadPreference::NO_MAX_STALENESS, - * which means that the driver will not consider a secondary's lag - * when choosing where to direct a read operation.
- *This option is not compatible with the - * MongoDB\Driver\ReadPreference::RP_PRIMARY mode. - * Specifying a max staleness also requires all MongoDB instances in - * the deployment to be using MongoDB 3.4+. An exception will be thrown - * at execution time if any MongoDB instances in the deployment are of - * an older server version.
- * @return string|int - */ - final public function __construct (string|int $mode, ?array $tagSets = null, ?array $options = null): string|int {} - - /** - * Returns the ReadPreference's "hedge" option - * @link http://www.php.net/manual/en/mongodb-driver-readpreference.gethedge.php - * @return object|null Returns the ReadPreference's "hedge" option. + * {@inheritdoc} + * @param string|int $mode + * @param array|null $tagSets [optional] + * @param array|null $options [optional] + */ + final public function __construct (string|int $mode, ?array $tagSets = NULL, ?array $options = NULL) {} + + /** + * {@inheritdoc} */ final public function getHedge (): ?object {} /** - * Returns the ReadPreference's "maxStalenessSeconds" option - * @link http://www.php.net/manual/en/mongodb-driver-readpreference.getmaxstalenessseconds.php - * @return int Returns the ReadPreference's "maxStalenessSeconds" option. If no max - * staleness has been specified, - * MongoDB\Driver\ReadPreference::NO_MAX_STALENESS will be - * returned. + * {@inheritdoc} */ final public function getMaxStalenessSeconds (): int {} /** - * Returns the ReadPreference's "mode" option - * @link http://www.php.net/manual/en/mongodb-driver-readpreference.getmode.php - * @return int Returns the ReadPreference's "mode" option. + * {@inheritdoc} */ final public function getMode (): int {} /** - * Returns the ReadPreference's "mode" option as a string - * @link http://www.php.net/manual/en/mongodb-driver-readpreference.getmodestring.php - * @return string Returns the ReadPreference's "mode" option as a string. + * {@inheritdoc} */ final public function getModeString (): string {} /** - * Returns the ReadPreference's "tagSets" option - * @link http://www.php.net/manual/en/mongodb-driver-readpreference.gettagsets.php - * @return array Returns the ReadPreference's "tagSets" option. + * {@inheritdoc} */ final public function getTagSets (): array {} @@ -5863,27 +1621,20 @@ final public function getTagSets (): array {} final public static function __set_state (array $properties): \MongoDB\Driver\ReadPreference {} /** - * Returns an object for BSON serialization - * @link http://www.php.net/manual/en/mongodb-driver-readpreference.bsonserialize.php - * @return object Returns an object for serializing the ReadPreference as BSON. + * {@inheritdoc} */ - final public function bsonSerialize (): object {} + final public function bsonSerialize (): \stdClass {} /** - * Serialize a ReadPreference - * @link http://www.php.net/manual/en/mongodb-driver-readpreference.serialize.php - * @return string Returns the serialized representation of the - * MongoDB\Driver\ReadPreference. + * {@inheritdoc} */ final public function serialize (): string {} /** - * Unserialize a ReadPreference - * @link http://www.php.net/manual/en/mongodb-driver-readpreference.unserialize.php - * @param string $serialized - * @return void No value is returned. + * {@inheritdoc} + * @param string $data */ - final public function unserialize (string $serialized): void {} + final public function unserialize (string $data): void {} /** * {@inheritdoc} @@ -5898,467 +1649,129 @@ final public function __serialize (): array {} } -/** - * @link http://www.php.net/manual/en/class.mongodb-driver-server.php - */ final class Server { - /** - * Unknown server type, returned by MongoDB\Driver\Server::getType. const TYPE_UNKNOWN = 0; - /** - * Standalone server type, returned by MongoDB\Driver\Server::getType. const TYPE_STANDALONE = 1; - /** - * Mongos server type, returned by MongoDB\Driver\Server::getType. const TYPE_MONGOS = 2; - /** - * Replica set possible primary server type, returned by MongoDB\Driver\Server::getType. - *A server may be identified as a possible primary if it has not yet been checked but another memory of the replica set thinks it is the primary.
const TYPE_POSSIBLE_PRIMARY = 3; - /** - * Replica set primary server type, returned by MongoDB\Driver\Server::getType. const TYPE_RS_PRIMARY = 4; - /** - * Replica set secondary server type, returned by MongoDB\Driver\Server::getType. const TYPE_RS_SECONDARY = 5; - /** - * Replica set arbiter server type, returned by MongoDB\Driver\Server::getType. const TYPE_RS_ARBITER = 6; - /** - * Replica set other server type, returned by MongoDB\Driver\Server::getType. - *Such servers may be hidden, starting up, or recovering. They cannot be queried, but their hosts lists are useful for discovering the current replica set configuration.
const TYPE_RS_OTHER = 7; - /** - * Replica set ghost server type, returned by MongoDB\Driver\Server::getType. - *Servers may be identified as such in at least three situations: briefly during server startup; in an uninitialized replica set; or when the server is shunned (i.e. removed from the replica set config). They cannot be queried, nor can their host list be used to discover the current replica set configuration; however, the client may monitor this server in hope that it transitions to a more useful state.
const TYPE_RS_GHOST = 8; - /** - * Load balancer server type, returned by MongoDB\Driver\Server::getType. const TYPE_LOAD_BALANCER = 9; /** - * Create a new Server (not used) - * @link http://www.php.net/manual/en/mongodb-driver-server.construct.php - * @return void - */ - final private function __construct (): void {} - - /** - * Execute one or more write operations on this server - * @link http://www.php.net/manual/en/mongodb-driver-server.executebulkwrite.php - * @param string $namespace A fully qualified namespace (e.g. "databaseName.collectionName"). - * @param \MongoDB\Driver\BulkWrite $bulk The write(s) to execute. - * @param array|\MongoDB\Driver\WriteConcern|null $options [optional]Option | - *Type | - *Description | - *
session | - *MongoDB\Driver\Session | - *
- * - * A session to associate with the operation. - * - * |
- *
writeConcern | - *MongoDB\Driver\WriteConcern | - *
- * - * A write concern to apply to the operation. - * - * |
- *
A session to associate with the operation.
- *A write concern to apply to the operation.
- * @return \MongoDB\Driver\WriteResult >Returns MongoDB\Driver\WriteResult on success. - */ - final public function executeBulkWrite (string $namespace, \MongoDB\Driver\BulkWrite $bulk, array|\MongoDB\Driver\WriteConcern|null $options = null): \MongoDB\Driver\WriteResult {} - - /** - * Execute a database command on this server - * @link http://www.php.net/manual/en/mongodb-driver-server.executecommand.php - * @param string $db The name of the database on which to execute the command. - * @param \MongoDB\Driver\Command $command The command to execute. - * @param array|\MongoDB\Driver\ReadPreference|null $options [optional]Option | - *Type | - *Description | - *
readConcern | - *MongoDB\Driver\ReadConcern | - *
- * - * A read concern to apply to the operation. - * - *- * This option is available in MongoDB 3.2+ and will result in an - * exception at execution time if specified for an older server - * version. - * - * |
- *
readPreference | - *MongoDB\Driver\ReadPreference | - *
- * - * A read preference to use for selecting a server for the operation. - * - * |
- *
session | - *MongoDB\Driver\Session | - *
- * - * A session to associate with the operation. - * - * |
- *
writeConcern | - *MongoDB\Driver\WriteConcern | - *
- * - * A write concern to apply to the operation. - * - * |
- *
A read concern to apply to the operation.
- *This option is available in MongoDB 3.2+ and will result in an - * exception at execution time if specified for an older server - * version.
- *A read preference to use for selecting a server for the operation.
- *A session to associate with the operation.
- *A write concern to apply to the operation.
- *If you are using a "session" which has a transaction - * in progress, you cannot specify a "readConcern" or - * "writeConcern" option. This will result in an - * MongoDB\Driver\Exception\InvalidArgumentException - * being thrown. Instead, you should set these two options when you create - * the transaction with - * MongoDB\Driver\Session::startTransaction.
- * @return \MongoDB\Driver\Cursor >Returns MongoDB\Driver\Cursor on success. - */ - final public function executeCommand (string $db, \MongoDB\Driver\Command $command, array|\MongoDB\Driver\ReadPreference|null $options = null): \MongoDB\Driver\Cursor {} - - /** - * Execute a database query on this server - * @link http://www.php.net/manual/en/mongodb-driver-server.executequery.php - * @param string $namespace A fully qualified namespace (e.g. "databaseName.collectionName"). - * @param \MongoDB\Driver\Query $query The query to execute. - * @param array|\MongoDB\Driver\ReadPreference|null $options [optional]Option | - *Type | - *Description | - *
readPreference | - *MongoDB\Driver\ReadPreference | - *
- * - * A read preference to use for selecting a server for the operation. - * - * |
- *
session | - *MongoDB\Driver\Session | - *
- * - * A session to associate with the operation. - * - * |
- *
A read preference to use for selecting a server for the operation.
- *A session to associate with the operation.
- * @return \MongoDB\Driver\Cursor >Returns MongoDB\Driver\Cursor on success. - */ - final public function executeQuery (string $namespace, \MongoDB\Driver\Query $query, array|\MongoDB\Driver\ReadPreference|null $options = null): \MongoDB\Driver\Cursor {} - - /** - * Execute a database command that reads on this server - * @link http://www.php.net/manual/en/mongodb-driver-server.executereadcommand.php - * @param string $db The name of the database on which to execute the command. - * @param \MongoDB\Driver\Command $command The command to execute. - * @param array|null $options [optional]Option | - *Type | - *Description | - *
readConcern | - *MongoDB\Driver\ReadConcern | - *
- * - * A read concern to apply to the operation. - * - *- * This option is available in MongoDB 3.2+ and will result in an - * exception at execution time if specified for an older server - * version. - * - * |
- *
readPreference | - *MongoDB\Driver\ReadPreference | - *
- * - * A read preference to use for selecting a server for the operation. - * - * |
- *
session | - *MongoDB\Driver\Session | - *
- * - * A session to associate with the operation. - * - * |
- *
A read concern to apply to the operation.
- *This option is available in MongoDB 3.2+ and will result in an - * exception at execution time if specified for an older server - * version.
- *A read preference to use for selecting a server for the operation.
- *A session to associate with the operation.
- *If you are using a "session" which has a transaction - * in progress, you cannot specify a "readConcern" or - * "writeConcern" option. This will result in an - * MongoDB\Driver\Exception\InvalidArgumentException - * being thrown. Instead, you should set these two options when you create - * the transaction with - * MongoDB\Driver\Session::startTransaction.
- * @return \MongoDB\Driver\Cursor >Returns MongoDB\Driver\Cursor on success. - */ - final public function executeReadCommand (string $db, \MongoDB\Driver\Command $command, ?array $options = null): \MongoDB\Driver\Cursor {} - - /** - * Execute a database command that reads and writes on this server - * @link http://www.php.net/manual/en/mongodb-driver-server.executereadwritecommand.php - * @param string $db The name of the database on which to execute the command. - * @param \MongoDB\Driver\Command $command The command to execute. - * @param array|null $options [optional]Option | - *Type | - *Description | - *
readConcern | - *MongoDB\Driver\ReadConcern | - *
- * - * A read concern to apply to the operation. - * - *- * This option is available in MongoDB 3.2+ and will result in an - * exception at execution time if specified for an older server - * version. - * - * |
- *
session | - *MongoDB\Driver\Session | - *
- * - * A session to associate with the operation. - * - * |
- *
writeConcern | - *MongoDB\Driver\WriteConcern | - *
- * - * A write concern to apply to the operation. - * - * |
- *
A read concern to apply to the operation.
- *This option is available in MongoDB 3.2+ and will result in an - * exception at execution time if specified for an older server - * version.
- *A session to associate with the operation.
- *A write concern to apply to the operation.
- *If you are using a "session" which has a transaction - * in progress, you cannot specify a "readConcern" or - * "writeConcern" option. This will result in an - * MongoDB\Driver\Exception\InvalidArgumentException - * being thrown. Instead, you should set these two options when you create - * the transaction with - * MongoDB\Driver\Session::startTransaction.
- * @return \MongoDB\Driver\Cursor >Returns MongoDB\Driver\Cursor on success. - */ - final public function executeReadWriteCommand (string $db, \MongoDB\Driver\Command $command, ?array $options = null): \MongoDB\Driver\Cursor {} - - /** - * Execute a database command that writes on this server - * @link http://www.php.net/manual/en/mongodb-driver-server.executewritecommand.php - * @param string $db The name of the database on which to execute the command. - * @param \MongoDB\Driver\Command $command The command to execute. - * @param array|null $options [optional]Option | - *Type | - *Description | - *
session | - *MongoDB\Driver\Session | - *
- * - * A session to associate with the operation. - * - * |
- *
writeConcern | - *MongoDB\Driver\WriteConcern | - *
- * - * A write concern to apply to the operation. - * - * |
- *
A session to associate with the operation.
- *A write concern to apply to the operation.
- *If you are using a "session" which has a transaction - * in progress, you cannot specify a "readConcern" or - * "writeConcern" option. This will result in an - * MongoDB\Driver\Exception\InvalidArgumentException - * being thrown. Instead, you should set these two options when you create - * the transaction with - * MongoDB\Driver\Session::startTransaction.
- * @return \MongoDB\Driver\Cursor >Returns MongoDB\Driver\Cursor on success. - */ - final public function executeWriteCommand (string $db, \MongoDB\Driver\Command $command, ?array $options = null): \MongoDB\Driver\Cursor {} - - /** - * Returns the hostname of this server - * @link http://www.php.net/manual/en/mongodb-driver-server.gethost.php - * @return string Returns the hostname of this server. + * {@inheritdoc} + */ + final private function __construct () {} + + /** + * {@inheritdoc} + * @param string $namespace + * @param \MongoDB\Driver\BulkWrite $bulkWrite + * @param \MongoDB\Driver\WriteConcern|array|null $options [optional] + */ + final public function executeBulkWrite (string $namespace, \MongoDB\Driver\BulkWrite $bulkWrite, \MongoDB\Driver\WriteConcern|array|null $options = NULL): \MongoDB\Driver\WriteResult {} + + /** + * {@inheritdoc} + * @param string $db + * @param \MongoDB\Driver\Command $command + * @param \MongoDB\Driver\ReadPreference|array|null $options [optional] + */ + final public function executeCommand (string $db, \MongoDB\Driver\Command $command, \MongoDB\Driver\ReadPreference|array|null $options = NULL): \MongoDB\Driver\Cursor {} + + /** + * {@inheritdoc} + * @param string $namespace + * @param \MongoDB\Driver\Query $query + * @param \MongoDB\Driver\ReadPreference|array|null $options [optional] + */ + final public function executeQuery (string $namespace, \MongoDB\Driver\Query $query, \MongoDB\Driver\ReadPreference|array|null $options = NULL): \MongoDB\Driver\Cursor {} + + /** + * {@inheritdoc} + * @param string $db + * @param \MongoDB\Driver\Command $command + * @param array|null $options [optional] + */ + final public function executeReadCommand (string $db, \MongoDB\Driver\Command $command, ?array $options = NULL): \MongoDB\Driver\Cursor {} + + /** + * {@inheritdoc} + * @param string $db + * @param \MongoDB\Driver\Command $command + * @param array|null $options [optional] + */ + final public function executeReadWriteCommand (string $db, \MongoDB\Driver\Command $command, ?array $options = NULL): \MongoDB\Driver\Cursor {} + + /** + * {@inheritdoc} + * @param string $db + * @param \MongoDB\Driver\Command $command + * @param array|null $options [optional] + */ + final public function executeWriteCommand (string $db, \MongoDB\Driver\Command $command, ?array $options = NULL): \MongoDB\Driver\Cursor {} + + /** + * {@inheritdoc} */ final public function getHost (): string {} /** - * Returns an array of information describing this server - * @link http://www.php.net/manual/en/mongodb-driver-server.getinfo.php - * @return array Returns an array of information describing this server. + * {@inheritdoc} */ final public function getInfo (): array {} /** - * Returns the latency of this server in milliseconds - * @link http://www.php.net/manual/en/mongodb-driver-server.getlatency.php - * @return integer|null Returns the latency of this server in milliseconds, or null if no latency - * has been measured (e.g. client is connected to a load balancer). + * {@inheritdoc} */ final public function getLatency (): ?int {} /** - * Returns the port on which this server is listening - * @link http://www.php.net/manual/en/mongodb-driver-server.getport.php - * @return int Returns the port on which this server is listening. + * {@inheritdoc} */ final public function getPort (): int {} /** - * Returns a ServerDescription for this server - * @link http://www.php.net/manual/en/mongodb-driver-server.getserverdescription.php - * @return \MongoDB\Driver\ServerDescription Returns a MongoDB\Driver\ServerDescription for this - * server. + * {@inheritdoc} */ final public function getServerDescription (): \MongoDB\Driver\ServerDescription {} /** - * Returns an array of tags describing this server in a replica set - * @link http://www.php.net/manual/en/mongodb-driver-server.gettags.php - * @return array Returns an array of tags used to describe this server in a - * replica set. + * {@inheritdoc} */ final public function getTags (): array {} /** - * Returns an integer denoting the type of this server - * @link http://www.php.net/manual/en/mongodb-driver-server.gettype.php - * @return int Returns an int denoting the type of this server. + * {@inheritdoc} */ final public function getType (): int {} /** - * Checks if this server is an arbiter member of a replica set - * @link http://www.php.net/manual/en/mongodb-driver-server.isarbiter.php - * @return bool Returns true if this server is an arbiter member of a replica set, and - * false otherwise. + * {@inheritdoc} */ final public function isArbiter (): bool {} /** - * Checks if this server is a hidden member of a replica set - * @link http://www.php.net/manual/en/mongodb-driver-server.ishidden.php - * @return bool Returns true if this server is a hidden member of a replica set, and - * false otherwise. + * {@inheritdoc} */ final public function isHidden (): bool {} /** - * Checks if this server is a passive member of a replica set - * @link http://www.php.net/manual/en/mongodb-driver-server.ispassive.php - * @return bool Returns true if this server is a passive member of a replica set, and - * false otherwise. + * {@inheritdoc} */ final public function isPassive (): bool {} /** - * Checks if this server is a primary member of a replica set - * @link http://www.php.net/manual/en/mongodb-driver-server.isprimary.php - * @return bool Returns true if this server is a primary member of a replica set, and - * false otherwise. + * {@inheritdoc} */ final public function isPrimary (): bool {} /** - * Checks if this server is a secondary member of a replica set - * @link http://www.php.net/manual/en/mongodb-driver-server.issecondary.php - * @return bool Returns true if this server is a secondary member of a replica set, and - * false otherwise. + * {@inheritdoc} */ final public function isSecondary (): bool {} @@ -6369,33 +1782,17 @@ final public function __wakeup (): void {} } -/** - * @link http://www.php.net/manual/en/class.mongodb-driver-serverapi.php - */ final class ServerApi implements \MongoDB\BSON\Serializable, \MongoDB\BSON\Type, \Serializable { - /** - * Server API version 1. const V1 = 1; /** - * Create a new ServerApi instance - * @link http://www.php.net/manual/en/mongodb-driver-serverapi.construct.php - * @param string $version A server API version. - *Supported API versions are provided as constants in - * MongoDB\Driver\ServerApi. The only supported API - * version is MongoDB\Driver\ServerApi::V1.
- * @param bool|null $strict [optional] If the strict parameter is set to true, the - * server will yield an error for any command that is not part of the - * specified API version. If no value is provided, the server default value - * (false) is used. - * @param bool|null $deprecationErrors [optional] If the deprecationErrors parameter is set to true, - * the server will yield an error when using a command that is deprecated in - * the specified API version. If no value is provided, the server default value - * (false) is used. - * @return string + * {@inheritdoc} + * @param string $version + * @param bool|null $strict [optional] + * @param bool|null $deprecationErrors [optional] */ - final public function __construct (string $version, ?bool $strict = null, ?bool $deprecationErrors = null): string {} + final public function __construct (string $version, ?bool $strict = NULL, ?bool $deprecationErrors = NULL) {} /** * {@inheritdoc} @@ -6404,27 +1801,20 @@ final public function __construct (string $version, ?bool $strict = null, ?bool final public static function __set_state (array $properties): \MongoDB\Driver\ServerApi {} /** - * Returns an object for BSON serialization - * @link http://www.php.net/manual/en/mongodb-driver-serverapi.bsonserialize.php - * @return object Returns an object for serializing the ServerApi as BSON. + * {@inheritdoc} */ - final public function bsonSerialize (): object {} + final public function bsonSerialize (): \stdClass {} /** - * Serialize a ServerApi - * @link http://www.php.net/manual/en/mongodb-driver-serverapi.serialize.php - * @return string Returns the serialized representation of the - * MongoDB\Driver\ServerApi. + * {@inheritdoc} */ final public function serialize (): string {} /** - * Unserialize a ServerApi - * @link http://www.php.net/manual/en/mongodb-driver-serverapi.unserialize.php - * @param string $serialized - * @return void No value is returned. + * {@inheritdoc} + * @param string $data */ - final public function unserialize (string $serialized): void {} + final public function unserialize (string $data): void {} /** * {@inheritdoc} @@ -6439,47 +1829,16 @@ final public function __serialize (): array {} } -/** - * The MongoDB\Driver\ServerDescription class is a value - * object that represents a server to which the driver is connected. Instances - * of this class are returned by - * MongoDB\Driver\Server::getServerDescription and - * MongoDB\Driver\Monitoring\ServerChangedEvent methods. - * @link http://www.php.net/manual/en/class.mongodb-driver-serverdescription.php - */ final class ServerDescription { - /** - * Unknown server type, returned by MongoDB\Driver\ServerDescription::getType. const TYPE_UNKNOWN = "Unknown"; - /** - * Standalone server type, returned by MongoDB\Driver\ServerDescription::getType. const TYPE_STANDALONE = "Standalone"; - /** - * Mongos server type, returned by MongoDB\Driver\ServerDescription::getType. const TYPE_MONGOS = "Mongos"; - /** - * Replica set possible primary server type, returned by MongoDB\Driver\ServerDescription::getType. - *A server may be identified as a possible primary if it has not yet been checked but another memory of the replica set thinks it is the primary.
const TYPE_POSSIBLE_PRIMARY = "PossiblePrimary"; - /** - * Replica set primary server type, returned by MongoDB\Driver\ServerDescription::getType. const TYPE_RS_PRIMARY = "RSPrimary"; - /** - * Replica set secondary server type, returned by MongoDB\Driver\ServerDescription::getType. const TYPE_RS_SECONDARY = "RSSecondary"; - /** - * Replica set arbiter server type, returned by MongoDB\Driver\ServerDescription::getType. const TYPE_RS_ARBITER = "RSArbiter"; - /** - * Replica set other server type, returned by MongoDB\Driver\ServerDescription::getType. - *Such servers may be hidden, starting up, or recovering. They cannot be queried, but their hosts lists are useful for discovering the current replica set configuration.
const TYPE_RS_OTHER = "RSOther"; - /** - * Replica set ghost server type, returned by MongoDB\Driver\ServerDescription::getType. - *Servers may be identified as such in at least three situations: briefly during server startup; in an uninitialized replica set; or when the server is shunned (i.e. removed from the replica set config). They cannot be queried, nor can their host list be used to discover the current replica set configuration; however, the client may monitor this server in hope that it transitions to a more useful state.
const TYPE_RS_GHOST = "RSGhost"; - /** - * Load balancer server type, returned by MongoDB\Driver\ServerDescription::getType. const TYPE_LOAD_BALANCER = "LoadBalancer"; @@ -6489,44 +1848,32 @@ final class ServerDescription { final private function __construct () {} /** - * Returns the server's most recent "hello" response - * @link http://www.php.net/manual/en/mongodb-driver-serverdescription.gethelloresponse.php - * @return array Returns an array of information describing this server. + * {@inheritdoc} */ final public function getHelloResponse (): array {} /** - * Returns the hostname of this server - * @link http://www.php.net/manual/en/mongodb-driver-serverdescription.gethost.php - * @return string Returns the hostname of this server. + * {@inheritdoc} */ final public function getHost (): string {} /** - * Returns the server's last update time in microseconds - * @link http://www.php.net/manual/en/mongodb-driver-serverdescription.getlastupdatetime.php - * @return int Returns the server's last update time in microseconds. + * {@inheritdoc} */ final public function getLastUpdateTime (): int {} /** - * Returns the port on which this server is listening - * @link http://www.php.net/manual/en/mongodb-driver-serverdescription.getport.php - * @return int Returns the port on which this server is listening. + * {@inheritdoc} */ final public function getPort (): int {} /** - * Returns the server's round trip time in milliseconds - * @link http://www.php.net/manual/en/mongodb-driver-serverdescription.getroundtriptime.php - * @return int|null Returns the server's round trip time in milliseconds. + * {@inheritdoc} */ final public function getRoundTripTime (): ?int {} /** - * Returns a string denoting the type of this server - * @link http://www.php.net/manual/en/mongodb-driver-serverdescription.gettype.php - * @return string Returns a string denoting the type of this server. + * {@inheritdoc} */ final public function getType (): string {} @@ -6537,32 +1884,12 @@ final public function __wakeup (): void {} } -/** - * The MongoDB\Driver\TopologyDescription class is a - * value object that represents a topology to which the driver is connected. - * Instances of this class are returned by - * MongoDB\Driver\Monitoring\TopologyChangedEvent - * methods. - * @link http://www.php.net/manual/en/class.mongodb-driver-topologydescription.php - */ final class TopologyDescription { - /** - * Unknown topology type, returned by MongoDB\Driver\TopologyDescription::getType. const TYPE_UNKNOWN = "Unknown"; - /** - * Single server (i.e. direct connection), returned by MongoDB\Driver\TopologyDescription::getType. const TYPE_SINGLE = "Single"; - /** - * Sharded cluster, returned by MongoDB\Driver\TopologyDescription::getType. const TYPE_SHARDED = "Sharded"; - /** - * Replica set with no primary server, returned by MongoDB\Driver\TopologyDescription::getType. const TYPE_REPLICA_SET_NO_PRIMARY = "ReplicaSetNoPrimary"; - /** - * Replica set with a primary server, returned by MongoDB\Driver\TopologyDescription::getType. const TYPE_REPLICA_SET_WITH_PRIMARY = "ReplicaSetWithPrimary"; - /** - * Load balanced topology, returned by MongoDB\Driver\TopologyDescription::getType. const TYPE_LOAD_BALANCED = "LoadBalanced"; @@ -6572,34 +1899,23 @@ final class TopologyDescription { final private function __construct () {} /** - * Returns the servers in the topology - * @link http://www.php.net/manual/en/mongodb-driver-topologydescription.getservers.php - * @return array Returns an array of MongoDB\Driver\ServerDescription - * objects corresponding to the known servers in the topology. + * {@inheritdoc} */ final public function getServers (): array {} /** - * Returns a string denoting the type of this topology - * @link http://www.php.net/manual/en/mongodb-driver-topologydescription.gettype.php - * @return string Returns a string denoting the type of this topology. + * {@inheritdoc} */ final public function getType (): string {} /** - * Returns whether the topology has a readable server - * @link http://www.php.net/manual/en/mongodb-driver-topologydescription.hasreadableserver.php - * @param \MongoDB\Driver\ReadPreference|null $readPreference [optional] - * @return bool Returns whether the topology has a readable server or, if - * readPreference is specified, a server matching the - * specified read preference. + * {@inheritdoc} + * @param \MongoDB\Driver\ReadPreference|null $readPreference [optional] */ - final public function hasReadableServer (?\MongoDB\Driver\ReadPreference $readPreference = null): bool {} + final public function hasReadableServer (?\MongoDB\Driver\ReadPreference $readPreference = NULL): bool {} /** - * Returns whether the topology has a writable server - * @link http://www.php.net/manual/en/mongodb-driver-topologydescription.haswritableserver.php - * @return bool Returns whether the topology has a writable server. + * {@inheritdoc} */ final public function hasWritableServer (): bool {} @@ -6610,219 +1926,91 @@ final public function __wakeup (): void {} } -/** - * The MongoDB\Driver\Session class represents a - * client session and is returned by - * MongoDB\Driver\Manager::startSession. Commands, - * queries, and write operations may then be associated the session. - * @link http://www.php.net/manual/en/class.mongodb-driver-session.php - */ final class Session { - /** - * There is no transaction in progress. const TRANSACTION_NONE = "none"; - /** - * A transaction has been started, but no operation has been sent to the server. const TRANSACTION_STARTING = "starting"; - /** - * A transaction is in progress. const TRANSACTION_IN_PROGRESS = "in_progress"; - /** - * The transaction was committed. const TRANSACTION_COMMITTED = "committed"; - /** - * The transaction was aborted. const TRANSACTION_ABORTED = "aborted"; /** - * Create a new Session (not used) - * @link http://www.php.net/manual/en/mongodb-driver-session.construct.php - * @return void + * {@inheritdoc} */ - final private function __construct (): void {} + final private function __construct () {} /** - * Aborts a transaction - * @link http://www.php.net/manual/en/mongodb-driver-session.aborttransaction.php - * @return void No value is returned. + * {@inheritdoc} */ final public function abortTransaction (): void {} /** - * Advances the cluster time for this session - * @link http://www.php.net/manual/en/mongodb-driver-session.advanceclustertime.php - * @param array|object $clusterTime The cluster time is a document containing a logical timestamp and server - * signature. Typically, this value will be obtained by calling - * MongoDB\Driver\Session::getClusterTime on another - * session object. - * @return void No value is returned. + * {@inheritdoc} + * @param object|array $clusterTime */ - final public function advanceClusterTime (array|object $clusterTime): void {} + final public function advanceClusterTime (object|array $clusterTime): void {} /** - * Advances the operation time for this session - * @link http://www.php.net/manual/en/mongodb-driver-session.advanceoperationtime.php - * @param \MongoDB\BSON\TimestampInterface $operationTime The operation time is a logical timestamp. Typically, this value will be - * obtained by calling - * MongoDB\Driver\Session::getOperationTime on - * another session object. - * @return void No value is returned. + * {@inheritdoc} + * @param \MongoDB\BSON\TimestampInterface $operationTime */ final public function advanceOperationTime (\MongoDB\BSON\TimestampInterface $operationTime): void {} /** - * Commits a transaction - * @link http://www.php.net/manual/en/mongodb-driver-session.committransaction.php - * @return void No value is returned. + * {@inheritdoc} */ final public function commitTransaction (): void {} /** - * Terminates a session - * @link http://www.php.net/manual/en/mongodb-driver-session.endsession.php - * @return void No value is returned. + * {@inheritdoc} */ final public function endSession (): void {} /** - * Returns the cluster time for this session - * @link http://www.php.net/manual/en/mongodb-driver-session.getclustertime.php - * @return object|null Returns the cluster time for this session, or null if the session has no - * cluster time. + * {@inheritdoc} */ final public function getClusterTime (): ?object {} /** - * Returns the logical session ID for this session - * @link http://www.php.net/manual/en/mongodb-driver-session.getlogicalsessionid.php - * @return object Returns the logical session ID for this session. + * {@inheritdoc} */ final public function getLogicalSessionId (): object {} /** - * Returns the operation time for this session - * @link http://www.php.net/manual/en/mongodb-driver-session.getoperationtime.php - * @return \MongoDB\BSON\Timestamp|null Returns the operation time for this session, or null if the session has no - * operation time. + * {@inheritdoc} */ final public function getOperationTime (): ?\MongoDB\BSON\Timestamp {} /** - * Returns the server to which this session is pinned - * @link http://www.php.net/manual/en/mongodb-driver-session.getserver.php - * @return \MongoDB\Driver\Server|null Returns the MongoDB\Driver\Server to which this - * session is pinned, or null if the session is not pinned to any server. + * {@inheritdoc} */ final public function getServer (): ?\MongoDB\Driver\Server {} /** - * Returns options for the currently running transaction - * @link http://www.php.net/manual/en/mongodb-driver-session.gettransactionoptions.php - * @return array|null Returns a array containing current transaction options, or - * null if no transaction is running. + * {@inheritdoc} */ final public function getTransactionOptions (): ?array {} /** - * Returns the current transaction state for this session - * @link http://www.php.net/manual/en/mongodb-driver-session.gettransactionstate.php - * @return string Returns the current transaction state for this session. + * {@inheritdoc} */ final public function getTransactionState (): string {} /** - * Returns whether the session has been marked as dirty - * @link http://www.php.net/manual/en/mongodb-driver-session.isdirty.php - * @return bool Returns whether the session has been marked as dirty. + * {@inheritdoc} */ final public function isDirty (): bool {} /** - * Returns whether a multi-document transaction is in progress - * @link http://www.php.net/manual/en/mongodb-driver-session.isintransaction.php - * @return bool Returns true if a transaction is currently in progress for this session, - * and false otherwise. + * {@inheritdoc} */ final public function isInTransaction (): bool {} /** - * Starts a transaction - * @link http://www.php.net/manual/en/mongodb-driver-session.starttransaction.php - * @param array|null $options [optional] Options can be passed as argument to this method. Each element in this - * options array overrides the corresponding option from the - * "defaultTransactionOptions" option, if set when - * starting the session with - * MongoDB\Driver\Manager::startSession. - *Option | - *Type | - *Description | - *
maxCommitTimeMS | - *integer | - *
- * - * The maximum amount of time in milliseconds to allow a single - * commitTransaction command to run. - * - *- * If specified, maxCommitTimeMS must be a signed - * 32-bit integer greater than or equal to zero. - * - * |
- *
readConcern | - *MongoDB\Driver\ReadConcern | - *
- * - * A read concern to apply to the operation. - * - *- * This option is available in MongoDB 3.2+ and will result in an - * exception at execution time if specified for an older server - * version. - * - * |
- *
readPreference | - *MongoDB\Driver\ReadPreference | - *
- * - * A read preference to use for selecting a server for the operation. - * - * |
- *
writeConcern | - *MongoDB\Driver\WriteConcern | - *
- * - * A write concern to apply to the operation. - * - * |
- *
The maximum amount of time in milliseconds to allow a single - * commitTransaction command to run.
- *If specified, maxCommitTimeMS must be a signed - * 32-bit integer greater than or equal to zero.
- *A read concern to apply to the operation.
- *This option is available in MongoDB 3.2+ and will result in an - * exception at execution time if specified for an older server - * version.
- *A read preference to use for selecting a server for the operation.
- *A write concern to apply to the operation.
- * @return void No value is returned. - */ - final public function startTransaction (?array $options = null): void {} + * {@inheritdoc} + * @param array|null $options [optional] + */ + final public function startTransaction (?array $options = NULL): void {} /** * {@inheritdoc} @@ -6831,143 +2019,35 @@ final public function __wakeup (): void {} } -/** - * MongoDB\Driver\WriteConcern describes the level of - * acknowledgement requested from MongoDB for write operations to a standalone - * mongod or to replica sets or to sharded clusters. In - * sharded clusters, mongos instances will pass the write - * concern on to the shards. - * @link http://www.php.net/manual/en/class.mongodb-driver-writeconcern.php - */ final class WriteConcern implements \MongoDB\BSON\Serializable, \MongoDB\BSON\Type, \Serializable { - /** - * Majority of all the members in the set; arbiters, non-voting members, - * passive members, hidden members and delayed members are all included in - * the definition of majority write concern. const MAJORITY = "majority"; /** - * Create a new WriteConcern - * @link http://www.php.net/manual/en/mongodb-driver-writeconcern.construct.php - * @param string|int $wValue | - *Description | - *
1 | - *- * Requests acknowledgement that the write operation has propagated to - * the standalone mongod or the primary in a replica - * set. This is the default write concern for MongoDB. - * | - *
0 | - *- * Requests no acknowledgment of the write operation. However, this may - * return information about socket exceptions and networking errors to - * the application. - * | - *
<integer greater than 1> | - *- * Numbers greater than 1 are valid only for replica sets to request - * acknowledgement from specified number of members, including the - * primary. - * | - *
MongoDB\Driver\WriteConcern::MAJORITY | - *
- * - * Requests acknowledgment that write operations have propagated to the - * majority of voting nodes, including the primary, and have been - * written to the on-disk journal for these nodes. - * - *- * Prior to MongoDB 3.0, this refers to the majority of replica set - * members (not just voting nodes). - * - * |
- *
string | - *- * A string value is interpereted as a tag set. Requests acknowledgement - * that the write operations have propagated to a replica set member - * with the specified tag. - * | - *
Requests acknowledgment that write operations have propagated to the - * majority of voting nodes, including the primary, and have been - * written to the on-disk journal for these nodes.
- *Prior to MongoDB 3.0, this refers to the majority of replica set - * members (not just voting nodes).
- * @param int|null $wtimeout [optional] How long to wait (in milliseconds) for secondaries before failing. - *wtimeout causes write operations to return with an - * error (WriteConcernError) after the specified - * limit, even if the required write concern will eventually succeed. When - * these write operations return, MongoDB does not undo successful data - * modifications performed before the write concern exceeded the - * wtimeout time limit.
- *If specified, wtimeout must be a signed 64-bit integer - * greater than or equal to zero.
- *Value | - *Description | - *
0 | - *Block indefinitely. This is the default. | - *
<integer greater than 0> | - *- * Milliseconds to wait until returning. - * | - *
The modified count is not available on versions of MongoDB before 2.6, which - * used the legacy wire protocol version (i.e. OP_UPDATE). If this is the case, - * the modified count will also be null.
+ * {@inheritdoc} */ final public function getModifiedCount (): ?int {} /** - * Returns the number of documents deleted - * @link http://www.php.net/manual/en/mongodb-driver-writeresult.getdeletedcount.php - * @return int|null Returns the number of documents deleted, or null if the write was not - * acknowledged. + * {@inheritdoc} */ final public function getDeletedCount (): ?int {} /** - * Returns the number of documents inserted by an upsert - * @link http://www.php.net/manual/en/mongodb-driver-writeresult.getupsertedcount.php - * @return int|null Returns the number of documents inserted by an upsert. + * {@inheritdoc} */ final public function getUpsertedCount (): ?int {} /** - * Returns the server associated with this write result - * @link http://www.php.net/manual/en/mongodb-driver-writeresult.getserver.php - * @return \MongoDB\Driver\Server Returns the MongoDB\Driver\Server associated with this - * write result. + * {@inheritdoc} */ final public function getServer (): \MongoDB\Driver\Server {} /** - * Returns an array of identifiers for upserted documents - * @link http://www.php.net/manual/en/mongodb-driver-writeresult.getupsertedids.php - * @return array Returns an array of identifiers (i.e. "_id" field values) - * for upserted documents. The array keys will correspond to the index of the - * write operation (from MongoDB\Driver\BulkWrite) - * responsible for the upsert. + * {@inheritdoc} */ final public function getUpsertedIds (): array {} /** - * Returns any write concern error that occurred - * @link http://www.php.net/manual/en/mongodb-driver-writeresult.getwriteconcernerror.php - * @return \MongoDB\Driver\WriteConcernError|null Returns a MongoDB\Driver\WriteConcernError if a write - * concern error was encountered during the write operation, and null - * otherwise. + * {@inheritdoc} */ final public function getWriteConcernError (): ?\MongoDB\Driver\WriteConcernError {} /** - * Returns any write errors that occurred - * @link http://www.php.net/manual/en/mongodb-driver-writeresult.getwriteerrors.php - * @return array Returns an array of MongoDB\Driver\WriteError objects - * for any write errors encountered during the write operation. The array will - * be empty if no write errors occurred. + * {@inheritdoc} */ final public function getWriteErrors (): array {} /** - * Returns whether the write was acknowledged - * @link http://www.php.net/manual/en/mongodb-driver-writeresult.isacknowledged.php - * @return bool Returns true if the write was acknowledged, and false otherwise. + * {@inheritdoc} + */ + final public function getErrorReplies (): array {} + + /** + * {@inheritdoc} */ final public function isAcknowledged (): bool {} @@ -7218,115 +2224,67 @@ final public function __wakeup (): void {} namespace MongoDB\Driver\Exception { -/** - * Common interface for all driver exceptions. This may be used to catch only - * exceptions originating from the driver itself. - * @link http://www.php.net/manual/en/class.mongodb-driver-exception-exception.php - */ interface Exception extends \Throwable, \Stringable { /** - * Gets the message - * @link http://www.php.net/manual/en/throwable.getmessage.php - * @return string Returns the message associated with the thrown object. + * {@inheritdoc} */ abstract public function getMessage (): string; /** - * Gets the exception code - * @link http://www.php.net/manual/en/throwable.getcode.php - * @return int Returns the exception code as int in - * Exception but possibly as other type in - * Exception descendants (for example as - * string in PDOException). + * {@inheritdoc} */ - abstract public function getCode (): int; + abstract public function getCode (); /** - * Gets the file in which the object was created - * @link http://www.php.net/manual/en/throwable.getfile.php - * @return string Returns the filename in which the thrown object was created. + * {@inheritdoc} */ abstract public function getFile (): string; /** - * Gets the line on which the object was instantiated - * @link http://www.php.net/manual/en/throwable.getline.php - * @return int Returns the line number where the thrown object was instantiated. + * {@inheritdoc} */ abstract public function getLine (): int; /** - * Gets the stack trace - * @link http://www.php.net/manual/en/throwable.gettrace.php - * @return array Returns the stack trace as an array in the same format as - * debug_backtrace. + * {@inheritdoc} */ abstract public function getTrace (): array; /** - * Returns the previous Throwable - * @link http://www.php.net/manual/en/throwable.getprevious.php - * @return \Throwable|null Returns the previous Throwable if available, or - * null otherwise. + * {@inheritdoc} */ abstract public function getPrevious (): ?\Throwable; /** - * Gets the stack trace as a string - * @link http://www.php.net/manual/en/throwable.gettraceasstring.php - * @return string Returns the stack trace as a string. + * {@inheritdoc} */ abstract public function getTraceAsString (): string; /** - * Gets a string representation of the object - * @link http://www.php.net/manual/en/stringable.tostring.php - * @return string Returns the string representation of the object. + * {@inheritdoc} */ abstract public function __toString (): string; } -/** - * Thrown when the driver encounters a runtime error (e.g. internal error from - * libmongoc). - * @link http://www.php.net/manual/en/class.mongodb-driver-exception-runtimeexception.php - */ class RuntimeException extends \RuntimeException implements \Stringable, \Throwable, \MongoDB\Driver\Exception\Exception { - /** - * Contains an array of error labels to go with an exception. For example, - * error labels can be used to detect whether a transaction can be retried - * safely if the TransientTransactionError label is - * present. The existence of a specific error label should be tested for - * with the - * MongoDB\Driver\Exception\RuntimeException::hasErrorLabel, - * instead of interpreting this errorLabels property - * manually. - * @var array|null - * @link http://www.php.net/manual/en/class.mongodb-driver-exception-runtimeexception.php#mongodb\driver\exception\runtimeexception.props.errorlabels - */ - protected ?array $errorLabels; + protected $errorLabels; /** - * Returns whether an error label is associated with an exception - * @link http://www.php.net/manual/en/mongodb-driver-runtimeexception.haserrorlabel.php - * @param string $errorLabel The name of the errorLabel to test for. - * @return bool Whether the given errorLabel is associated with this - * exception. + * {@inheritdoc} + * @param string $errorLabel */ final public function hasErrorLabel (string $errorLabel): bool {} /** - * Construct the exception - * @link http://www.php.net/manual/en/exception.construct.php - * @param string $message [optional] - * @param int $code [optional] - * @param \Throwable|null $previous [optional] - * @return string + * {@inheritdoc} + * @param string $message [optional] + * @param int $code [optional] + * @param \Throwable|null $previous [optional] */ - public function __construct (string $message = '""', int $code = null, ?\Throwable $previous = null): string {} + public function __construct (string $message = '', int $code = 0, ?\Throwable $previous = NULL) {} /** * {@inheritdoc} @@ -7334,91 +2292,62 @@ public function __construct (string $message = '""', int $code = null, ?\Throwab public function __wakeup () {} /** - * Gets the Exception message - * @link http://www.php.net/manual/en/exception.getmessage.php - * @return string Returns the Exception message as a string. + * {@inheritdoc} */ final public function getMessage (): string {} /** - * Gets the Exception code - * @link http://www.php.net/manual/en/exception.getcode.php - * @return int Returns the exception code as int in - * Exception but possibly as other type in - * Exception descendants (for example as - * string in PDOException). + * {@inheritdoc} */ - final public function getCode (): int {} + final public function getCode () {} /** - * Gets the file in which the exception was created - * @link http://www.php.net/manual/en/exception.getfile.php - * @return string Returns the filename in which the exception was created. + * {@inheritdoc} */ final public function getFile (): string {} /** - * Gets the line in which the exception was created - * @link http://www.php.net/manual/en/exception.getline.php - * @return int Returns the line number where the exception was created. + * {@inheritdoc} */ final public function getLine (): int {} /** - * Gets the stack trace - * @link http://www.php.net/manual/en/exception.gettrace.php - * @return array Returns the Exception stack trace as an array. + * {@inheritdoc} */ final public function getTrace (): array {} /** - * Returns previous Throwable - * @link http://www.php.net/manual/en/exception.getprevious.php - * @return \Throwable|null Returns the previous Throwable if available - * or null otherwise. + * {@inheritdoc} */ final public function getPrevious (): ?\Throwable {} /** - * Gets the stack trace as a string - * @link http://www.php.net/manual/en/exception.gettraceasstring.php - * @return string Returns the Exception stack trace as a string. + * {@inheritdoc} */ final public function getTraceAsString (): string {} /** - * String representation of the exception - * @link http://www.php.net/manual/en/exception.tostring.php - * @return string Returns the string representation of the exception. + * {@inheritdoc} */ public function __toString (): string {} } -/** - * Base class for exceptions thrown by the server. The code of this exception and its subclasses will correspond to the original error code from the server. - * @link http://www.php.net/manual/en/class.mongodb-driver-exception-serverexception.php - */ class ServerException extends \MongoDB\Driver\Exception\RuntimeException implements \MongoDB\Driver\Exception\Exception, \Throwable, \Stringable { /** - * Returns whether an error label is associated with an exception - * @link http://www.php.net/manual/en/mongodb-driver-runtimeexception.haserrorlabel.php - * @param string $errorLabel The name of the errorLabel to test for. - * @return bool Whether the given errorLabel is associated with this - * exception. + * {@inheritdoc} + * @param string $errorLabel */ final public function hasErrorLabel (string $errorLabel): bool {} /** - * Construct the exception - * @link http://www.php.net/manual/en/exception.construct.php - * @param string $message [optional] - * @param int $code [optional] - * @param \Throwable|null $previous [optional] - * @return string + * {@inheritdoc} + * @param string $message [optional] + * @param int $code [optional] + * @param \Throwable|null $previous [optional] */ - public function __construct (string $message = '""', int $code = null, ?\Throwable $previous = null): string {} + public function __construct (string $message = '', int $code = 0, ?\Throwable $previous = NULL) {} /** * {@inheritdoc} @@ -7426,92 +2355,62 @@ public function __construct (string $message = '""', int $code = null, ?\Throwab public function __wakeup () {} /** - * Gets the Exception message - * @link http://www.php.net/manual/en/exception.getmessage.php - * @return string Returns the Exception message as a string. + * {@inheritdoc} */ final public function getMessage (): string {} /** - * Gets the Exception code - * @link http://www.php.net/manual/en/exception.getcode.php - * @return int Returns the exception code as int in - * Exception but possibly as other type in - * Exception descendants (for example as - * string in PDOException). + * {@inheritdoc} */ - final public function getCode (): int {} + final public function getCode () {} /** - * Gets the file in which the exception was created - * @link http://www.php.net/manual/en/exception.getfile.php - * @return string Returns the filename in which the exception was created. + * {@inheritdoc} */ final public function getFile (): string {} /** - * Gets the line in which the exception was created - * @link http://www.php.net/manual/en/exception.getline.php - * @return int Returns the line number where the exception was created. + * {@inheritdoc} */ final public function getLine (): int {} /** - * Gets the stack trace - * @link http://www.php.net/manual/en/exception.gettrace.php - * @return array Returns the Exception stack trace as an array. + * {@inheritdoc} */ final public function getTrace (): array {} /** - * Returns previous Throwable - * @link http://www.php.net/manual/en/exception.getprevious.php - * @return \Throwable|null Returns the previous Throwable if available - * or null otherwise. + * {@inheritdoc} */ final public function getPrevious (): ?\Throwable {} /** - * Gets the stack trace as a string - * @link http://www.php.net/manual/en/exception.gettraceasstring.php - * @return string Returns the Exception stack trace as a string. + * {@inheritdoc} */ final public function getTraceAsString (): string {} /** - * String representation of the exception - * @link http://www.php.net/manual/en/exception.tostring.php - * @return string Returns the string representation of the exception. + * {@inheritdoc} */ public function __toString (): string {} } -/** - * Base class for exceptions thrown when the driver fails to establish a - * database connection. - * @link http://www.php.net/manual/en/class.mongodb-driver-exception-connectionexception.php - */ class ConnectionException extends \MongoDB\Driver\Exception\RuntimeException implements \MongoDB\Driver\Exception\Exception, \Throwable, \Stringable { /** - * Returns whether an error label is associated with an exception - * @link http://www.php.net/manual/en/mongodb-driver-runtimeexception.haserrorlabel.php - * @param string $errorLabel The name of the errorLabel to test for. - * @return bool Whether the given errorLabel is associated with this - * exception. + * {@inheritdoc} + * @param string $errorLabel */ final public function hasErrorLabel (string $errorLabel): bool {} /** - * Construct the exception - * @link http://www.php.net/manual/en/exception.construct.php - * @param string $message [optional] - * @param int $code [optional] - * @param \Throwable|null $previous [optional] - * @return string + * {@inheritdoc} + * @param string $message [optional] + * @param int $code [optional] + * @param \Throwable|null $previous [optional] */ - public function __construct (string $message = '""', int $code = null, ?\Throwable $previous = null): string {} + public function __construct (string $message = '', int $code = 0, ?\Throwable $previous = NULL) {} /** * {@inheritdoc} @@ -7519,108 +2418,69 @@ public function __construct (string $message = '""', int $code = null, ?\Throwab public function __wakeup () {} /** - * Gets the Exception message - * @link http://www.php.net/manual/en/exception.getmessage.php - * @return string Returns the Exception message as a string. + * {@inheritdoc} */ final public function getMessage (): string {} /** - * Gets the Exception code - * @link http://www.php.net/manual/en/exception.getcode.php - * @return int Returns the exception code as int in - * Exception but possibly as other type in - * Exception descendants (for example as - * string in PDOException). + * {@inheritdoc} */ - final public function getCode (): int {} + final public function getCode () {} /** - * Gets the file in which the exception was created - * @link http://www.php.net/manual/en/exception.getfile.php - * @return string Returns the filename in which the exception was created. + * {@inheritdoc} */ final public function getFile (): string {} /** - * Gets the line in which the exception was created - * @link http://www.php.net/manual/en/exception.getline.php - * @return int Returns the line number where the exception was created. + * {@inheritdoc} */ final public function getLine (): int {} /** - * Gets the stack trace - * @link http://www.php.net/manual/en/exception.gettrace.php - * @return array Returns the Exception stack trace as an array. + * {@inheritdoc} */ final public function getTrace (): array {} /** - * Returns previous Throwable - * @link http://www.php.net/manual/en/exception.getprevious.php - * @return \Throwable|null Returns the previous Throwable if available - * or null otherwise. + * {@inheritdoc} */ final public function getPrevious (): ?\Throwable {} /** - * Gets the stack trace as a string - * @link http://www.php.net/manual/en/exception.gettraceasstring.php - * @return string Returns the Exception stack trace as a string. + * {@inheritdoc} */ final public function getTraceAsString (): string {} /** - * String representation of the exception - * @link http://www.php.net/manual/en/exception.tostring.php - * @return string Returns the string representation of the exception. + * {@inheritdoc} */ public function __toString (): string {} } -/** - * Base class for exceptions thrown by a failed write operation. The exception - * encapsulates a MongoDB\Driver\WriteResult object. - * @link http://www.php.net/manual/en/class.mongodb-driver-exception-writeexception.php - */ abstract class WriteException extends \MongoDB\Driver\Exception\ServerException implements \Stringable, \Throwable, \MongoDB\Driver\Exception\Exception { - /** - * The MongoDB\Driver\WriteResult associated with - * the failed write operation. - * @var \MongoDB\Driver\WriteResult - * @link http://www.php.net/manual/en/class.mongodb-driver-exception-writeexception.php#mongodb\driver\exception\writeexception.props.writeresult - */ - protected \MongoDB\Driver\WriteResult $writeResult; + protected $writeResult; /** - * Returns the WriteResult for the failed write operation - * @link http://www.php.net/manual/en/mongodb-driver-writeexception.getwriteresult.php - * @return \MongoDB\Driver\WriteResult The MongoDB\Driver\WriteResult for the failed write - * operation. + * {@inheritdoc} */ final public function getWriteResult (): \MongoDB\Driver\WriteResult {} /** - * Returns whether an error label is associated with an exception - * @link http://www.php.net/manual/en/mongodb-driver-runtimeexception.haserrorlabel.php - * @param string $errorLabel The name of the errorLabel to test for. - * @return bool Whether the given errorLabel is associated with this - * exception. + * {@inheritdoc} + * @param string $errorLabel */ final public function hasErrorLabel (string $errorLabel): bool {} /** - * Construct the exception - * @link http://www.php.net/manual/en/exception.construct.php - * @param string $message [optional] - * @param int $code [optional] - * @param \Throwable|null $previous [optional] - * @return string + * {@inheritdoc} + * @param string $message [optional] + * @param int $code [optional] + * @param \Throwable|null $previous [optional] */ - public function __construct (string $message = '""', int $code = null, ?\Throwable $previous = null): string {} + public function __construct (string $message = '', int $code = 0, ?\Throwable $previous = NULL) {} /** * {@inheritdoc} @@ -7628,91 +2488,62 @@ public function __construct (string $message = '""', int $code = null, ?\Throwab public function __wakeup () {} /** - * Gets the Exception message - * @link http://www.php.net/manual/en/exception.getmessage.php - * @return string Returns the Exception message as a string. + * {@inheritdoc} */ final public function getMessage (): string {} /** - * Gets the Exception code - * @link http://www.php.net/manual/en/exception.getcode.php - * @return int Returns the exception code as int in - * Exception but possibly as other type in - * Exception descendants (for example as - * string in PDOException). + * {@inheritdoc} */ - final public function getCode (): int {} + final public function getCode () {} /** - * Gets the file in which the exception was created - * @link http://www.php.net/manual/en/exception.getfile.php - * @return string Returns the filename in which the exception was created. + * {@inheritdoc} */ final public function getFile (): string {} /** - * Gets the line in which the exception was created - * @link http://www.php.net/manual/en/exception.getline.php - * @return int Returns the line number where the exception was created. + * {@inheritdoc} */ final public function getLine (): int {} /** - * Gets the stack trace - * @link http://www.php.net/manual/en/exception.gettrace.php - * @return array Returns the Exception stack trace as an array. + * {@inheritdoc} */ final public function getTrace (): array {} /** - * Returns previous Throwable - * @link http://www.php.net/manual/en/exception.getprevious.php - * @return \Throwable|null Returns the previous Throwable if available - * or null otherwise. + * {@inheritdoc} */ final public function getPrevious (): ?\Throwable {} /** - * Gets the stack trace as a string - * @link http://www.php.net/manual/en/exception.gettraceasstring.php - * @return string Returns the Exception stack trace as a string. + * {@inheritdoc} */ final public function getTraceAsString (): string {} /** - * String representation of the exception - * @link http://www.php.net/manual/en/exception.tostring.php - * @return string Returns the string representation of the exception. + * {@inheritdoc} */ public function __toString (): string {} } -/** - * Thrown when the driver fails to authenticate with the server. - * @link http://www.php.net/manual/en/class.mongodb-driver-exception-authenticationexception.php - */ class AuthenticationException extends \MongoDB\Driver\Exception\ConnectionException implements \Stringable, \Throwable, \MongoDB\Driver\Exception\Exception { /** - * Returns whether an error label is associated with an exception - * @link http://www.php.net/manual/en/mongodb-driver-runtimeexception.haserrorlabel.php - * @param string $errorLabel The name of the errorLabel to test for. - * @return bool Whether the given errorLabel is associated with this - * exception. + * {@inheritdoc} + * @param string $errorLabel */ final public function hasErrorLabel (string $errorLabel): bool {} /** - * Construct the exception - * @link http://www.php.net/manual/en/exception.construct.php - * @param string $message [optional] - * @param int $code [optional] - * @param \Throwable|null $previous [optional] - * @return string + * {@inheritdoc} + * @param string $message [optional] + * @param int $code [optional] + * @param \Throwable|null $previous [optional] */ - public function __construct (string $message = '""', int $code = null, ?\Throwable $previous = null): string {} + public function __construct (string $message = '', int $code = 0, ?\Throwable $previous = NULL) {} /** * {@inheritdoc} @@ -7720,99 +2551,67 @@ public function __construct (string $message = '""', int $code = null, ?\Throwab public function __wakeup () {} /** - * Gets the Exception message - * @link http://www.php.net/manual/en/exception.getmessage.php - * @return string Returns the Exception message as a string. + * {@inheritdoc} */ final public function getMessage (): string {} /** - * Gets the Exception code - * @link http://www.php.net/manual/en/exception.getcode.php - * @return int Returns the exception code as int in - * Exception but possibly as other type in - * Exception descendants (for example as - * string in PDOException). + * {@inheritdoc} */ - final public function getCode (): int {} + final public function getCode () {} /** - * Gets the file in which the exception was created - * @link http://www.php.net/manual/en/exception.getfile.php - * @return string Returns the filename in which the exception was created. + * {@inheritdoc} */ final public function getFile (): string {} /** - * Gets the line in which the exception was created - * @link http://www.php.net/manual/en/exception.getline.php - * @return int Returns the line number where the exception was created. + * {@inheritdoc} */ final public function getLine (): int {} /** - * Gets the stack trace - * @link http://www.php.net/manual/en/exception.gettrace.php - * @return array Returns the Exception stack trace as an array. + * {@inheritdoc} */ final public function getTrace (): array {} /** - * Returns previous Throwable - * @link http://www.php.net/manual/en/exception.getprevious.php - * @return \Throwable|null Returns the previous Throwable if available - * or null otherwise. + * {@inheritdoc} */ final public function getPrevious (): ?\Throwable {} /** - * Gets the stack trace as a string - * @link http://www.php.net/manual/en/exception.gettraceasstring.php - * @return string Returns the Exception stack trace as a string. + * {@inheritdoc} */ final public function getTraceAsString (): string {} /** - * String representation of the exception - * @link http://www.php.net/manual/en/exception.tostring.php - * @return string Returns the string representation of the exception. + * {@inheritdoc} */ public function __toString (): string {} } -/** - * Thrown when a bulk write operation fails. - * @link http://www.php.net/manual/en/class.mongodb-driver-exception-bulkwriteexception.php - */ class BulkWriteException extends \MongoDB\Driver\Exception\WriteException implements \MongoDB\Driver\Exception\Exception, \Throwable, \Stringable { /** - * Returns the WriteResult for the failed write operation - * @link http://www.php.net/manual/en/mongodb-driver-writeexception.getwriteresult.php - * @return \MongoDB\Driver\WriteResult The MongoDB\Driver\WriteResult for the failed write - * operation. + * {@inheritdoc} */ final public function getWriteResult (): \MongoDB\Driver\WriteResult {} /** - * Returns whether an error label is associated with an exception - * @link http://www.php.net/manual/en/mongodb-driver-runtimeexception.haserrorlabel.php - * @param string $errorLabel The name of the errorLabel to test for. - * @return bool Whether the given errorLabel is associated with this - * exception. + * {@inheritdoc} + * @param string $errorLabel */ final public function hasErrorLabel (string $errorLabel): bool {} /** - * Construct the exception - * @link http://www.php.net/manual/en/exception.construct.php - * @param string $message [optional] - * @param int $code [optional] - * @param \Throwable|null $previous [optional] - * @return string + * {@inheritdoc} + * @param string $message [optional] + * @param int $code [optional] + * @param \Throwable|null $previous [optional] */ - public function __construct (string $message = '""', int $code = null, ?\Throwable $previous = null): string {} + public function __construct (string $message = '', int $code = 0, ?\Throwable $previous = NULL) {} /** * {@inheritdoc} @@ -7820,105 +2619,69 @@ public function __construct (string $message = '""', int $code = null, ?\Throwab public function __wakeup () {} /** - * Gets the Exception message - * @link http://www.php.net/manual/en/exception.getmessage.php - * @return string Returns the Exception message as a string. + * {@inheritdoc} */ final public function getMessage (): string {} /** - * Gets the Exception code - * @link http://www.php.net/manual/en/exception.getcode.php - * @return int Returns the exception code as int in - * Exception but possibly as other type in - * Exception descendants (for example as - * string in PDOException). + * {@inheritdoc} */ - final public function getCode (): int {} + final public function getCode () {} /** - * Gets the file in which the exception was created - * @link http://www.php.net/manual/en/exception.getfile.php - * @return string Returns the filename in which the exception was created. + * {@inheritdoc} */ final public function getFile (): string {} /** - * Gets the line in which the exception was created - * @link http://www.php.net/manual/en/exception.getline.php - * @return int Returns the line number where the exception was created. + * {@inheritdoc} */ final public function getLine (): int {} /** - * Gets the stack trace - * @link http://www.php.net/manual/en/exception.gettrace.php - * @return array Returns the Exception stack trace as an array. + * {@inheritdoc} */ final public function getTrace (): array {} /** - * Returns previous Throwable - * @link http://www.php.net/manual/en/exception.getprevious.php - * @return \Throwable|null Returns the previous Throwable if available - * or null otherwise. + * {@inheritdoc} */ final public function getPrevious (): ?\Throwable {} /** - * Gets the stack trace as a string - * @link http://www.php.net/manual/en/exception.gettraceasstring.php - * @return string Returns the Exception stack trace as a string. + * {@inheritdoc} */ final public function getTraceAsString (): string {} /** - * String representation of the exception - * @link http://www.php.net/manual/en/exception.tostring.php - * @return string Returns the string representation of the exception. + * {@inheritdoc} */ public function __toString (): string {} } -/** - * Thrown when a command fails. - * @link http://www.php.net/manual/en/class.mongodb-driver-exception-commandexception.php - */ class CommandException extends \MongoDB\Driver\Exception\ServerException implements \Stringable, \Throwable, \MongoDB\Driver\Exception\Exception { - /** - * The result document associated with the failed command. - * @var object - * @link http://www.php.net/manual/en/class.mongodb-driver-exception-commandexception.php#mongodb\driver\exception\commandexception.props.resultdocument - */ - protected object $resultDocument; + protected $resultDocument; /** - * Returns the result document for the failed command - * @link http://www.php.net/manual/en/mongodb-driver-commandexception.getresultdocument.php - * @return object The result document for the failed command. + * {@inheritdoc} */ final public function getResultDocument (): object {} /** - * Returns whether an error label is associated with an exception - * @link http://www.php.net/manual/en/mongodb-driver-runtimeexception.haserrorlabel.php - * @param string $errorLabel The name of the errorLabel to test for. - * @return bool Whether the given errorLabel is associated with this - * exception. + * {@inheritdoc} + * @param string $errorLabel */ final public function hasErrorLabel (string $errorLabel): bool {} /** - * Construct the exception - * @link http://www.php.net/manual/en/exception.construct.php - * @param string $message [optional] - * @param int $code [optional] - * @param \Throwable|null $previous [optional] - * @return string + * {@inheritdoc} + * @param string $message [optional] + * @param int $code [optional] + * @param \Throwable|null $previous [optional] */ - public function __construct (string $message = '""', int $code = null, ?\Throwable $previous = null): string {} + public function __construct (string $message = '', int $code = 0, ?\Throwable $previous = NULL) {} /** * {@inheritdoc} @@ -7926,95 +2689,62 @@ public function __construct (string $message = '""', int $code = null, ?\Throwab public function __wakeup () {} /** - * Gets the Exception message - * @link http://www.php.net/manual/en/exception.getmessage.php - * @return string Returns the Exception message as a string. + * {@inheritdoc} */ final public function getMessage (): string {} /** - * Gets the Exception code - * @link http://www.php.net/manual/en/exception.getcode.php - * @return int Returns the exception code as int in - * Exception but possibly as other type in - * Exception descendants (for example as - * string in PDOException). + * {@inheritdoc} */ - final public function getCode (): int {} + final public function getCode () {} /** - * Gets the file in which the exception was created - * @link http://www.php.net/manual/en/exception.getfile.php - * @return string Returns the filename in which the exception was created. + * {@inheritdoc} */ final public function getFile (): string {} /** - * Gets the line in which the exception was created - * @link http://www.php.net/manual/en/exception.getline.php - * @return int Returns the line number where the exception was created. + * {@inheritdoc} */ final public function getLine (): int {} /** - * Gets the stack trace - * @link http://www.php.net/manual/en/exception.gettrace.php - * @return array Returns the Exception stack trace as an array. + * {@inheritdoc} */ final public function getTrace (): array {} /** - * Returns previous Throwable - * @link http://www.php.net/manual/en/exception.getprevious.php - * @return \Throwable|null Returns the previous Throwable if available - * or null otherwise. + * {@inheritdoc} */ final public function getPrevious (): ?\Throwable {} /** - * Gets the stack trace as a string - * @link http://www.php.net/manual/en/exception.gettraceasstring.php - * @return string Returns the Exception stack trace as a string. + * {@inheritdoc} */ final public function getTraceAsString (): string {} /** - * String representation of the exception - * @link http://www.php.net/manual/en/exception.tostring.php - * @return string Returns the string representation of the exception. + * {@inheritdoc} */ public function __toString (): string {} } -/** - * Thrown when the driver fails to establish a database connection within a - * specified time limit - * (connectTimeoutMS) - * or server selection fails - * (serverSelectionTimeoutMS). - * @link http://www.php.net/manual/en/class.mongodb-driver-exception-connectiontimeoutexception.php - */ final class ConnectionTimeoutException extends \MongoDB\Driver\Exception\ConnectionException implements \Stringable, \Throwable, \MongoDB\Driver\Exception\Exception { /** - * Returns whether an error label is associated with an exception - * @link http://www.php.net/manual/en/mongodb-driver-runtimeexception.haserrorlabel.php - * @param string $errorLabel The name of the errorLabel to test for. - * @return bool Whether the given errorLabel is associated with this - * exception. + * {@inheritdoc} + * @param string $errorLabel */ final public function hasErrorLabel (string $errorLabel): bool {} /** - * Construct the exception - * @link http://www.php.net/manual/en/exception.construct.php - * @param string $message [optional] - * @param int $code [optional] - * @param \Throwable|null $previous [optional] - * @return string + * {@inheritdoc} + * @param string $message [optional] + * @param int $code [optional] + * @param \Throwable|null $previous [optional] */ - public function __construct (string $message = '""', int $code = null, ?\Throwable $previous = null): string {} + public function __construct (string $message = '', int $code = 0, ?\Throwable $previous = NULL) {} /** * {@inheritdoc} @@ -8022,91 +2752,62 @@ public function __construct (string $message = '""', int $code = null, ?\Throwab public function __wakeup () {} /** - * Gets the Exception message - * @link http://www.php.net/manual/en/exception.getmessage.php - * @return string Returns the Exception message as a string. + * {@inheritdoc} */ final public function getMessage (): string {} /** - * Gets the Exception code - * @link http://www.php.net/manual/en/exception.getcode.php - * @return int Returns the exception code as int in - * Exception but possibly as other type in - * Exception descendants (for example as - * string in PDOException). + * {@inheritdoc} */ - final public function getCode (): int {} + final public function getCode () {} /** - * Gets the file in which the exception was created - * @link http://www.php.net/manual/en/exception.getfile.php - * @return string Returns the filename in which the exception was created. + * {@inheritdoc} */ final public function getFile (): string {} /** - * Gets the line in which the exception was created - * @link http://www.php.net/manual/en/exception.getline.php - * @return int Returns the line number where the exception was created. + * {@inheritdoc} */ final public function getLine (): int {} /** - * Gets the stack trace - * @link http://www.php.net/manual/en/exception.gettrace.php - * @return array Returns the Exception stack trace as an array. + * {@inheritdoc} */ final public function getTrace (): array {} /** - * Returns previous Throwable - * @link http://www.php.net/manual/en/exception.getprevious.php - * @return \Throwable|null Returns the previous Throwable if available - * or null otherwise. + * {@inheritdoc} */ final public function getPrevious (): ?\Throwable {} /** - * Gets the stack trace as a string - * @link http://www.php.net/manual/en/exception.gettraceasstring.php - * @return string Returns the Exception stack trace as a string. + * {@inheritdoc} */ final public function getTraceAsString (): string {} /** - * String representation of the exception - * @link http://www.php.net/manual/en/exception.tostring.php - * @return string Returns the string representation of the exception. + * {@inheritdoc} */ public function __toString (): string {} } -/** - * Base class for exceptions thrown during client-side encryption. - * @link http://www.php.net/manual/en/class.mongodb-driver-exception-encryptionexception.php - */ class EncryptionException extends \MongoDB\Driver\Exception\RuntimeException implements \MongoDB\Driver\Exception\Exception, \Throwable, \Stringable { /** - * Returns whether an error label is associated with an exception - * @link http://www.php.net/manual/en/mongodb-driver-runtimeexception.haserrorlabel.php - * @param string $errorLabel The name of the errorLabel to test for. - * @return bool Whether the given errorLabel is associated with this - * exception. + * {@inheritdoc} + * @param string $errorLabel */ final public function hasErrorLabel (string $errorLabel): bool {} /** - * Construct the exception - * @link http://www.php.net/manual/en/exception.construct.php - * @param string $message [optional] - * @param int $code [optional] - * @param \Throwable|null $previous [optional] - * @return string + * {@inheritdoc} + * @param string $message [optional] + * @param int $code [optional] + * @param \Throwable|null $previous [optional] */ - public function __construct (string $message = '""', int $code = null, ?\Throwable $previous = null): string {} + public function __construct (string $message = '', int $code = 0, ?\Throwable $previous = NULL) {} /** * {@inheritdoc} @@ -8114,93 +2815,62 @@ public function __construct (string $message = '""', int $code = null, ?\Throwab public function __wakeup () {} /** - * Gets the Exception message - * @link http://www.php.net/manual/en/exception.getmessage.php - * @return string Returns the Exception message as a string. + * {@inheritdoc} */ final public function getMessage (): string {} /** - * Gets the Exception code - * @link http://www.php.net/manual/en/exception.getcode.php - * @return int Returns the exception code as int in - * Exception but possibly as other type in - * Exception descendants (for example as - * string in PDOException). + * {@inheritdoc} */ - final public function getCode (): int {} + final public function getCode () {} /** - * Gets the file in which the exception was created - * @link http://www.php.net/manual/en/exception.getfile.php - * @return string Returns the filename in which the exception was created. + * {@inheritdoc} */ final public function getFile (): string {} /** - * Gets the line in which the exception was created - * @link http://www.php.net/manual/en/exception.getline.php - * @return int Returns the line number where the exception was created. + * {@inheritdoc} */ final public function getLine (): int {} /** - * Gets the stack trace - * @link http://www.php.net/manual/en/exception.gettrace.php - * @return array Returns the Exception stack trace as an array. + * {@inheritdoc} */ final public function getTrace (): array {} /** - * Returns previous Throwable - * @link http://www.php.net/manual/en/exception.getprevious.php - * @return \Throwable|null Returns the previous Throwable if available - * or null otherwise. + * {@inheritdoc} */ final public function getPrevious (): ?\Throwable {} /** - * Gets the stack trace as a string - * @link http://www.php.net/manual/en/exception.gettraceasstring.php - * @return string Returns the Exception stack trace as a string. + * {@inheritdoc} */ final public function getTraceAsString (): string {} /** - * String representation of the exception - * @link http://www.php.net/manual/en/exception.tostring.php - * @return string Returns the string representation of the exception. + * {@inheritdoc} */ public function __toString (): string {} } -/** - * Thrown when a query or command fails to complete within a specified time - * limit (e.g. - * maxTimeMS). - * @link http://www.php.net/manual/en/class.mongodb-driver-exception-executiontimeoutexception.php - */ final class ExecutionTimeoutException extends \MongoDB\Driver\Exception\ServerException implements \Stringable, \Throwable, \MongoDB\Driver\Exception\Exception { /** - * Returns whether an error label is associated with an exception - * @link http://www.php.net/manual/en/mongodb-driver-runtimeexception.haserrorlabel.php - * @param string $errorLabel The name of the errorLabel to test for. - * @return bool Whether the given errorLabel is associated with this - * exception. + * {@inheritdoc} + * @param string $errorLabel */ final public function hasErrorLabel (string $errorLabel): bool {} /** - * Construct the exception - * @link http://www.php.net/manual/en/exception.construct.php - * @param string $message [optional] - * @param int $code [optional] - * @param \Throwable|null $previous [optional] - * @return string + * {@inheritdoc} + * @param string $message [optional] + * @param int $code [optional] + * @param \Throwable|null $previous [optional] */ - public function __construct (string $message = '""', int $code = null, ?\Throwable $previous = null): string {} + public function __construct (string $message = '', int $code = 0, ?\Throwable $previous = NULL) {} /** * {@inheritdoc} @@ -8208,83 +2878,56 @@ public function __construct (string $message = '""', int $code = null, ?\Throwab public function __wakeup () {} /** - * Gets the Exception message - * @link http://www.php.net/manual/en/exception.getmessage.php - * @return string Returns the Exception message as a string. + * {@inheritdoc} */ final public function getMessage (): string {} /** - * Gets the Exception code - * @link http://www.php.net/manual/en/exception.getcode.php - * @return int Returns the exception code as int in - * Exception but possibly as other type in - * Exception descendants (for example as - * string in PDOException). + * {@inheritdoc} */ - final public function getCode (): int {} + final public function getCode () {} /** - * Gets the file in which the exception was created - * @link http://www.php.net/manual/en/exception.getfile.php - * @return string Returns the filename in which the exception was created. + * {@inheritdoc} */ final public function getFile (): string {} /** - * Gets the line in which the exception was created - * @link http://www.php.net/manual/en/exception.getline.php - * @return int Returns the line number where the exception was created. + * {@inheritdoc} */ final public function getLine (): int {} /** - * Gets the stack trace - * @link http://www.php.net/manual/en/exception.gettrace.php - * @return array Returns the Exception stack trace as an array. + * {@inheritdoc} */ final public function getTrace (): array {} /** - * Returns previous Throwable - * @link http://www.php.net/manual/en/exception.getprevious.php - * @return \Throwable|null Returns the previous Throwable if available - * or null otherwise. + * {@inheritdoc} */ final public function getPrevious (): ?\Throwable {} /** - * Gets the stack trace as a string - * @link http://www.php.net/manual/en/exception.gettraceasstring.php - * @return string Returns the Exception stack trace as a string. + * {@inheritdoc} */ final public function getTraceAsString (): string {} /** - * String representation of the exception - * @link http://www.php.net/manual/en/exception.tostring.php - * @return string Returns the string representation of the exception. + * {@inheritdoc} */ public function __toString (): string {} } -/** - * Thrown when a driver method is given invalid arguments (e.g. invalid option - * types). - * @link http://www.php.net/manual/en/class.mongodb-driver-exception-invalidargumentexception.php - */ class InvalidArgumentException extends \InvalidArgumentException implements \Throwable, \Stringable, \MongoDB\Driver\Exception\Exception { /** - * Construct the exception - * @link http://www.php.net/manual/en/exception.construct.php - * @param string $message [optional] - * @param int $code [optional] - * @param \Throwable|null $previous [optional] - * @return string + * {@inheritdoc} + * @param string $message [optional] + * @param int $code [optional] + * @param \Throwable|null $previous [optional] */ - public function __construct (string $message = '""', int $code = null, ?\Throwable $previous = null): string {} + public function __construct (string $message = '', int $code = 0, ?\Throwable $previous = NULL) {} /** * {@inheritdoc} @@ -8292,82 +2935,56 @@ public function __construct (string $message = '""', int $code = null, ?\Throwab public function __wakeup () {} /** - * Gets the Exception message - * @link http://www.php.net/manual/en/exception.getmessage.php - * @return string Returns the Exception message as a string. + * {@inheritdoc} */ final public function getMessage (): string {} /** - * Gets the Exception code - * @link http://www.php.net/manual/en/exception.getcode.php - * @return int Returns the exception code as int in - * Exception but possibly as other type in - * Exception descendants (for example as - * string in PDOException). + * {@inheritdoc} */ - final public function getCode (): int {} + final public function getCode () {} /** - * Gets the file in which the exception was created - * @link http://www.php.net/manual/en/exception.getfile.php - * @return string Returns the filename in which the exception was created. + * {@inheritdoc} */ final public function getFile (): string {} /** - * Gets the line in which the exception was created - * @link http://www.php.net/manual/en/exception.getline.php - * @return int Returns the line number where the exception was created. + * {@inheritdoc} */ final public function getLine (): int {} /** - * Gets the stack trace - * @link http://www.php.net/manual/en/exception.gettrace.php - * @return array Returns the Exception stack trace as an array. + * {@inheritdoc} */ final public function getTrace (): array {} /** - * Returns previous Throwable - * @link http://www.php.net/manual/en/exception.getprevious.php - * @return \Throwable|null Returns the previous Throwable if available - * or null otherwise. + * {@inheritdoc} */ final public function getPrevious (): ?\Throwable {} /** - * Gets the stack trace as a string - * @link http://www.php.net/manual/en/exception.gettraceasstring.php - * @return string Returns the Exception stack trace as a string. + * {@inheritdoc} */ final public function getTraceAsString (): string {} /** - * String representation of the exception - * @link http://www.php.net/manual/en/exception.tostring.php - * @return string Returns the string representation of the exception. + * {@inheritdoc} */ public function __toString (): string {} } -/** - * Thrown when the driver is incorrectly used (e.g. rewinding a cursor). - * @link http://www.php.net/manual/en/class.mongodb-driver-exception-logicexception.php - */ class LogicException extends \LogicException implements \Stringable, \Throwable, \MongoDB\Driver\Exception\Exception { /** - * Construct the exception - * @link http://www.php.net/manual/en/exception.construct.php - * @param string $message [optional] - * @param int $code [optional] - * @param \Throwable|null $previous [optional] - * @return string + * {@inheritdoc} + * @param string $message [optional] + * @param int $code [optional] + * @param \Throwable|null $previous [optional] */ - public function __construct (string $message = '""', int $code = null, ?\Throwable $previous = null): string {} + public function __construct (string $message = '', int $code = 0, ?\Throwable $previous = NULL) {} /** * {@inheritdoc} @@ -8375,91 +2992,62 @@ public function __construct (string $message = '""', int $code = null, ?\Throwab public function __wakeup () {} /** - * Gets the Exception message - * @link http://www.php.net/manual/en/exception.getmessage.php - * @return string Returns the Exception message as a string. + * {@inheritdoc} */ final public function getMessage (): string {} /** - * Gets the Exception code - * @link http://www.php.net/manual/en/exception.getcode.php - * @return int Returns the exception code as int in - * Exception but possibly as other type in - * Exception descendants (for example as - * string in PDOException). + * {@inheritdoc} */ - final public function getCode (): int {} + final public function getCode () {} /** - * Gets the file in which the exception was created - * @link http://www.php.net/manual/en/exception.getfile.php - * @return string Returns the filename in which the exception was created. + * {@inheritdoc} */ final public function getFile (): string {} /** - * Gets the line in which the exception was created - * @link http://www.php.net/manual/en/exception.getline.php - * @return int Returns the line number where the exception was created. + * {@inheritdoc} */ final public function getLine (): int {} /** - * Gets the stack trace - * @link http://www.php.net/manual/en/exception.gettrace.php - * @return array Returns the Exception stack trace as an array. + * {@inheritdoc} */ final public function getTrace (): array {} /** - * Returns previous Throwable - * @link http://www.php.net/manual/en/exception.getprevious.php - * @return \Throwable|null Returns the previous Throwable if available - * or null otherwise. + * {@inheritdoc} */ final public function getPrevious (): ?\Throwable {} /** - * Gets the stack trace as a string - * @link http://www.php.net/manual/en/exception.gettraceasstring.php - * @return string Returns the Exception stack trace as a string. + * {@inheritdoc} */ final public function getTraceAsString (): string {} /** - * String representation of the exception - * @link http://www.php.net/manual/en/exception.tostring.php - * @return string Returns the string representation of the exception. + * {@inheritdoc} */ public function __toString (): string {} } -/** - * Thrown when the driver fails to establish an SSL connection with the server. - * @link http://www.php.net/manual/en/class.mongodb-driver-exception-sslconnectionexception.php - */ final class SSLConnectionException extends \MongoDB\Driver\Exception\ConnectionException implements \Stringable, \Throwable, \MongoDB\Driver\Exception\Exception { /** - * Returns whether an error label is associated with an exception - * @link http://www.php.net/manual/en/mongodb-driver-runtimeexception.haserrorlabel.php - * @param string $errorLabel The name of the errorLabel to test for. - * @return bool Whether the given errorLabel is associated with this - * exception. + * {@inheritdoc} + * @param string $errorLabel */ final public function hasErrorLabel (string $errorLabel): bool {} /** - * Construct the exception - * @link http://www.php.net/manual/en/exception.construct.php - * @param string $message [optional] - * @param int $code [optional] - * @param \Throwable|null $previous [optional] - * @return string + * {@inheritdoc} + * @param string $message [optional] + * @param int $code [optional] + * @param \Throwable|null $previous [optional] */ - public function __construct (string $message = '""', int $code = null, ?\Throwable $previous = null): string {} + public function __construct (string $message = '', int $code = 0, ?\Throwable $previous = NULL) {} /** * {@inheritdoc} @@ -8467,83 +3055,56 @@ public function __construct (string $message = '""', int $code = null, ?\Throwab public function __wakeup () {} /** - * Gets the Exception message - * @link http://www.php.net/manual/en/exception.getmessage.php - * @return string Returns the Exception message as a string. + * {@inheritdoc} */ final public function getMessage (): string {} /** - * Gets the Exception code - * @link http://www.php.net/manual/en/exception.getcode.php - * @return int Returns the exception code as int in - * Exception but possibly as other type in - * Exception descendants (for example as - * string in PDOException). + * {@inheritdoc} */ - final public function getCode (): int {} + final public function getCode () {} /** - * Gets the file in which the exception was created - * @link http://www.php.net/manual/en/exception.getfile.php - * @return string Returns the filename in which the exception was created. + * {@inheritdoc} */ final public function getFile (): string {} /** - * Gets the line in which the exception was created - * @link http://www.php.net/manual/en/exception.getline.php - * @return int Returns the line number where the exception was created. + * {@inheritdoc} */ final public function getLine (): int {} /** - * Gets the stack trace - * @link http://www.php.net/manual/en/exception.gettrace.php - * @return array Returns the Exception stack trace as an array. + * {@inheritdoc} */ final public function getTrace (): array {} /** - * Returns previous Throwable - * @link http://www.php.net/manual/en/exception.getprevious.php - * @return \Throwable|null Returns the previous Throwable if available - * or null otherwise. + * {@inheritdoc} */ final public function getPrevious (): ?\Throwable {} /** - * Gets the stack trace as a string - * @link http://www.php.net/manual/en/exception.gettraceasstring.php - * @return string Returns the Exception stack trace as a string. + * {@inheritdoc} */ final public function getTraceAsString (): string {} /** - * String representation of the exception - * @link http://www.php.net/manual/en/exception.tostring.php - * @return string Returns the string representation of the exception. + * {@inheritdoc} */ public function __toString (): string {} } -/** - * Thrown when the driver encounters an unexpected value (e.g. during BSON - * serialization or deserialization). - * @link http://www.php.net/manual/en/class.mongodb-driver-exception-unexpectedvalueexception.php - */ class UnexpectedValueException extends \UnexpectedValueException implements \Throwable, \Stringable, \MongoDB\Driver\Exception\Exception { /** - * Construct the exception - * @link http://www.php.net/manual/en/exception.construct.php - * @param string $message [optional] - * @param int $code [optional] - * @param \Throwable|null $previous [optional] - * @return string + * {@inheritdoc} + * @param string $message [optional] + * @param int $code [optional] + * @param \Throwable|null $previous [optional] */ - public function __construct (string $message = '""', int $code = null, ?\Throwable $previous = null): string {} + public function __construct (string $message = '', int $code = 0, ?\Throwable $previous = NULL) {} /** * {@inheritdoc} @@ -8551,62 +3112,42 @@ public function __construct (string $message = '""', int $code = null, ?\Throwab public function __wakeup () {} /** - * Gets the Exception message - * @link http://www.php.net/manual/en/exception.getmessage.php - * @return string Returns the Exception message as a string. + * {@inheritdoc} */ final public function getMessage (): string {} /** - * Gets the Exception code - * @link http://www.php.net/manual/en/exception.getcode.php - * @return int Returns the exception code as int in - * Exception but possibly as other type in - * Exception descendants (for example as - * string in PDOException). + * {@inheritdoc} */ - final public function getCode (): int {} + final public function getCode () {} /** - * Gets the file in which the exception was created - * @link http://www.php.net/manual/en/exception.getfile.php - * @return string Returns the filename in which the exception was created. + * {@inheritdoc} */ final public function getFile (): string {} /** - * Gets the line in which the exception was created - * @link http://www.php.net/manual/en/exception.getline.php - * @return int Returns the line number where the exception was created. + * {@inheritdoc} */ final public function getLine (): int {} /** - * Gets the stack trace - * @link http://www.php.net/manual/en/exception.gettrace.php - * @return array Returns the Exception stack trace as an array. + * {@inheritdoc} */ final public function getTrace (): array {} /** - * Returns previous Throwable - * @link http://www.php.net/manual/en/exception.getprevious.php - * @return \Throwable|null Returns the previous Throwable if available - * or null otherwise. + * {@inheritdoc} */ final public function getPrevious (): ?\Throwable {} /** - * Gets the stack trace as a string - * @link http://www.php.net/manual/en/exception.gettraceasstring.php - * @return string Returns the Exception stack trace as a string. + * {@inheritdoc} */ final public function getTraceAsString (): string {} /** - * String representation of the exception - * @link http://www.php.net/manual/en/exception.tostring.php - * @return string Returns the string representation of the exception. + * {@inheritdoc} */ public function __toString (): string {} @@ -8618,55 +3159,31 @@ public function __toString (): string {} namespace MongoDB\Driver\Monitoring { -/** - * Base interface for event subscribers. This is used as a parameter type in the functions - * MongoDB\Driver\Monitoring\addSubscriber and - * MongoDB\Driver\Monitoring\removeSubscriber and should - * not be implemented directly. - * @link http://www.php.net/manual/en/class.mongodb-driver-monitoring-subscriber.php - */ interface Subscriber { } -/** - * Classes may implement this interface to register an event subscriber that is - * notified for each started, successful, and failed command event. See - * for additional information. - * @link http://www.php.net/manual/en/class.mongodb-driver-monitoring-commandsubscriber.php - */ interface CommandSubscriber extends \MongoDB\Driver\Monitoring\Subscriber { /** - * Notification method for a started command - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-commandsubscriber.commandstarted.php - * @param \MongoDB\Driver\Monitoring\CommandStartedEvent $event An event object encapsulating information about the started command. - * @return void No value is returned. + * {@inheritdoc} + * @param \MongoDB\Driver\Monitoring\CommandStartedEvent $event */ - abstract public function commandStarted (\MongoDB\Driver\Monitoring\CommandStartedEvent $event): void; + abstract public function commandStarted (\MongoDB\Driver\Monitoring\CommandStartedEvent $event); /** - * Notification method for a successful command - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-commandsubscriber.commandsucceeded.php - * @param \MongoDB\Driver\Monitoring\CommandSucceededEvent $event An event object encapsulating information about the successful command. - * @return void No value is returned. + * {@inheritdoc} + * @param \MongoDB\Driver\Monitoring\CommandSucceededEvent $event */ - abstract public function commandSucceeded (\MongoDB\Driver\Monitoring\CommandSucceededEvent $event): void; + abstract public function commandSucceeded (\MongoDB\Driver\Monitoring\CommandSucceededEvent $event); /** - * Notification method for a failed command - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-commandsubscriber.commandfailed.php - * @param \MongoDB\Driver\Monitoring\CommandFailedEvent $event An event object encapsulating information about the failed command. - * @return void No value is returned. + * {@inheritdoc} + * @param \MongoDB\Driver\Monitoring\CommandFailedEvent $event */ - abstract public function commandFailed (\MongoDB\Driver\Monitoring\CommandFailedEvent $event): void; + abstract public function commandFailed (\MongoDB\Driver\Monitoring\CommandFailedEvent $event); } -/** - * The MongoDB\Driver\Monitoring\CommandFailedEvent - * class encapsulates information about a failed command. - * @link http://www.php.net/manual/en/class.mongodb-driver-monitoring-commandfailedevent.php - */ final class CommandFailedEvent { /** @@ -8675,68 +3192,47 @@ final class CommandFailedEvent { final private function __construct () {} /** - * Returns the command name - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-commandfailedevent.getcommandname.php - * @return string Returns the command name. + * {@inheritdoc} */ final public function getCommandName (): string {} /** - * Returns the command's duration in microseconds - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-commandfailedevent.getdurationmicros.php - * @return int Returns the command's duration in microseconds. + * {@inheritdoc} */ final public function getDurationMicros (): int {} /** - * Returns the Exception associated with the failed command - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-commandfailedevent.geterror.php - * @return \Exception Returns the Exception associated with the failed command. + * {@inheritdoc} */ final public function getError (): \Exception {} /** - * Returns the command's operation ID - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-commandfailedevent.getoperationid.php - * @return string Returns the command's operation ID. + * {@inheritdoc} */ final public function getOperationId (): string {} /** - * Returns the command reply document - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-commandfailedevent.getreply.php - * @return object Returns the command reply document as a stdClass - * object. + * {@inheritdoc} */ final public function getReply (): object {} /** - * Returns the command's request ID - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-commandfailedevent.getrequestid.php - * @return string Returns the command's request ID. + * {@inheritdoc} */ final public function getRequestId (): string {} /** - * Returns the Server on which the command was executed - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-commandfailedevent.getserver.php - * @return \MongoDB\Driver\Server Returns the MongoDB\Driver\Server on which the command - * was executed. + * {@inheritdoc} */ final public function getServer (): \MongoDB\Driver\Server {} /** - * Returns the load balancer service ID for the command - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-commandfailedevent.getserviceid.php - * @return \MongoDB\BSON\ObjectId|null Returns the load balancer service ID, or null if the driver is not - * connected to a load balancer. + * {@inheritdoc} */ final public function getServiceId (): ?\MongoDB\BSON\ObjectId {} /** - * Returns the server connection ID for the command - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-commandfailedevent.getserverconnectionid.php - * @return int|null Returns the server connection ID, or null if it is not available. + * {@inheritdoc} */ final public function getServerConnectionId (): ?int {} @@ -8747,11 +3243,6 @@ final public function __wakeup (): void {} } -/** - * The MongoDB\Driver\Monitoring\CommandStartedEvent - * class encapsulates information about a started command. - * @link http://www.php.net/manual/en/class.mongodb-driver-monitoring-commandstartedevent.php - */ final class CommandStartedEvent { /** @@ -8760,60 +3251,42 @@ final class CommandStartedEvent { final private function __construct () {} /** - * Returns the command document - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-commandstartedevent.getcommand.php - * @return object Returns the command document as a stdClass object. + * {@inheritdoc} */ final public function getCommand (): object {} /** - * Returns the command name - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-commandstartedevent.getcommandname.php - * @return string Returns the command name. + * {@inheritdoc} */ final public function getCommandName (): string {} /** - * Returns the database on which the command was executed - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-commandstartedevent.getdatabasename.php - * @return string Returns the database on which the command was executed. + * {@inheritdoc} */ final public function getDatabaseName (): string {} /** - * Returns the command's operation ID - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-commandstartedevent.getoperationid.php - * @return string Returns the command's operation ID. + * {@inheritdoc} */ final public function getOperationId (): string {} /** - * Returns the command's request ID - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-commandstartedevent.getrequestid.php - * @return string Returns the command's request ID. + * {@inheritdoc} */ final public function getRequestId (): string {} /** - * Returns the Server on which the command was executed - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-commandstartedevent.getserver.php - * @return \MongoDB\Driver\Server Returns the MongoDB\Driver\Server on which the command - * was executed. + * {@inheritdoc} */ final public function getServer (): \MongoDB\Driver\Server {} /** - * Returns the load balancer service ID for the command - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-commandstartedevent.getserviceid.php - * @return \MongoDB\BSON\ObjectId|null Returns the load balancer service ID, or null if the driver is not - * connected to a load balancer. + * {@inheritdoc} */ final public function getServiceId (): ?\MongoDB\BSON\ObjectId {} /** - * Returns the server connection ID for the command - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-commandstartedevent.getserverconnectionid.php - * @return int|null Returns the server connection ID, or null if it is not available. + * {@inheritdoc} */ final public function getServerConnectionId (): ?int {} @@ -8824,11 +3297,6 @@ final public function __wakeup (): void {} } -/** - * The MongoDB\Driver\Monitoring\CommandSucceededEvent - * class encapsulates information about a successful command. - * @link http://www.php.net/manual/en/class.mongodb-driver-monitoring-commandsucceededevent.php - */ final class CommandSucceededEvent { /** @@ -8837,61 +3305,42 @@ final class CommandSucceededEvent { final private function __construct () {} /** - * Returns the command name - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-commandsucceededevent.getcommandname.php - * @return string Returns the command name. + * {@inheritdoc} */ final public function getCommandName (): string {} /** - * Returns the command's duration in microseconds - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-commandsucceededevent.getdurationmicros.php - * @return int Returns the command's duration in microseconds. + * {@inheritdoc} */ final public function getDurationMicros (): int {} /** - * Returns the command's operation ID - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-commandsucceededevent.getoperationid.php - * @return string Returns the command's operation ID. + * {@inheritdoc} */ final public function getOperationId (): string {} /** - * Returns the command reply document - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-commandsucceededevent.getreply.php - * @return object Returns the command reply document as a stdClass - * object. + * {@inheritdoc} */ final public function getReply (): object {} /** - * Returns the command's request ID - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-commandsucceededevent.getrequestid.php - * @return string Returns the command's request ID. + * {@inheritdoc} */ final public function getRequestId (): string {} /** - * Returns the Server on which the command was executed - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-commandsucceededevent.getserver.php - * @return \MongoDB\Driver\Server Returns the MongoDB\Driver\Server on which the command - * was executed. + * {@inheritdoc} */ final public function getServer (): \MongoDB\Driver\Server {} /** - * Returns the load balancer service ID for the command - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-commandsucceededevent.getserviceid.php - * @return \MongoDB\BSON\ObjectId|null Returns the load balancer service ID, or null if the driver is not - * connected to a load balancer. + * {@inheritdoc} */ final public function getServiceId (): ?\MongoDB\BSON\ObjectId {} /** - * Returns the server connection ID for the command - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-commandsucceededevent.getserverconnectionid.php - * @return int|null Returns the server connection ID, or null if it is not available. + * {@inheritdoc} */ final public function getServerConnectionId (): ?int {} @@ -8902,100 +3351,83 @@ final public function __wakeup (): void {} } -/** - * Classes may implement this interface to register an event subscriber that is - * notified for various SDAM events. See the - * Server Discovery and Monitoring - * and SDAM Monitoring - * specifications for additional information. - * @link http://www.php.net/manual/en/class.mongodb-driver-monitoring-sdamsubscriber.php - */ +interface LogSubscriber extends \MongoDB\Driver\Monitoring\Subscriber { + const LEVEL_ERROR = 0; + const LEVEL_CRITICAL = 1; + const LEVEL_WARNING = 2; + const LEVEL_MESSAGE = 3; + const LEVEL_INFO = 4; + const LEVEL_DEBUG = 5; + + + /** + * {@inheritdoc} + * @param int $level + * @param string $domain + * @param string $message + */ + abstract public function log (int $level, string $domain, string $message): void; + +} + interface SDAMSubscriber extends \MongoDB\Driver\Monitoring\Subscriber { /** - * Notification method for a server description change - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-sdamsubscriber.serverchanged.php - * @param \MongoDB\Driver\Monitoring\ServerChangedEvent $event An event object encapsulating information about the changed server - * description. - * @return void No value is returned. + * {@inheritdoc} + * @param \MongoDB\Driver\Monitoring\ServerChangedEvent $event */ - abstract public function serverChanged (\MongoDB\Driver\Monitoring\ServerChangedEvent $event): void; + abstract public function serverChanged (\MongoDB\Driver\Monitoring\ServerChangedEvent $event); /** - * Notification method for closing a server - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-sdamsubscriber.serverclosed.php - * @param \MongoDB\Driver\Monitoring\ServerClosedEvent $event An event object encapsulating information about the closed server. - * @return void No value is returned. + * {@inheritdoc} + * @param \MongoDB\Driver\Monitoring\ServerClosedEvent $event */ - abstract public function serverClosed (\MongoDB\Driver\Monitoring\ServerClosedEvent $event): void; + abstract public function serverClosed (\MongoDB\Driver\Monitoring\ServerClosedEvent $event); /** - * Notification method for opening a server - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-sdamsubscriber.serveropening.php - * @param \MongoDB\Driver\Monitoring\ServerOpeningEvent $event An event object encapsulating information about the opened server. - * @return void No value is returned. + * {@inheritdoc} + * @param \MongoDB\Driver\Monitoring\ServerOpeningEvent $event */ - abstract public function serverOpening (\MongoDB\Driver\Monitoring\ServerOpeningEvent $event): void; + abstract public function serverOpening (\MongoDB\Driver\Monitoring\ServerOpeningEvent $event); /** - * Notification method for a failed server heartbeat - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-sdamsubscriber.serverheartbeatfailed.php - * @param \MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent $event An event object encapsulating information about the failed server - * heartbeat. - * @return void No value is returned. + * {@inheritdoc} + * @param \MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent $event */ - abstract public function serverHeartbeatFailed (\MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent $event): void; + abstract public function serverHeartbeatFailed (\MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent $event); /** - * Notification method for a started server heartbeat - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-sdamsubscriber.serverheartbeatstarted.php - * @param \MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent $event An event object encapsulating information about the started server - * heartbeat. - * @return void No value is returned. + * {@inheritdoc} + * @param \MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent $event */ - abstract public function serverHeartbeatStarted (\MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent $event): void; + abstract public function serverHeartbeatStarted (\MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent $event); /** - * Notification method for a successful server heartbeat - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-sdamsubscriber.serverheartbeatsucceeded.php - * @param \MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent $event An event object encapsulating information about the successful server - * heartbeat. - * @return void No value is returned. + * {@inheritdoc} + * @param \MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent $event */ - abstract public function serverHeartbeatSucceeded (\MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent $event): void; + abstract public function serverHeartbeatSucceeded (\MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent $event); /** - * Notification method for a topology description change - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-sdamsubscriber.topologychanged.php - * @param \MongoDB\Driver\Monitoring\TopologyChangedEvent $event An event object encapsulating information about the changed topology - * description. - * @return void No value is returned. + * {@inheritdoc} + * @param \MongoDB\Driver\Monitoring\TopologyChangedEvent $event */ - abstract public function topologyChanged (\MongoDB\Driver\Monitoring\TopologyChangedEvent $event): void; + abstract public function topologyChanged (\MongoDB\Driver\Monitoring\TopologyChangedEvent $event); /** - * Notification method for closing the topology - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-sdamsubscriber.topologyclosed.php - * @param \MongoDB\Driver\Monitoring\TopologyClosedEvent $event An event object encapsulating information about the closed topology. - * @return void No value is returned. + * {@inheritdoc} + * @param \MongoDB\Driver\Monitoring\TopologyClosedEvent $event */ - abstract public function topologyClosed (\MongoDB\Driver\Monitoring\TopologyClosedEvent $event): void; + abstract public function topologyClosed (\MongoDB\Driver\Monitoring\TopologyClosedEvent $event); /** - * Notification method for opening the topology - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-sdamsubscriber.topologyopening.php - * @param \MongoDB\Driver\Monitoring\TopologyOpeningEvent $event An event object encapsulating information about the opened topology. - * @return void No value is returned. + * {@inheritdoc} + * @param \MongoDB\Driver\Monitoring\TopologyOpeningEvent $event */ - abstract public function topologyOpening (\MongoDB\Driver\Monitoring\TopologyOpeningEvent $event): void; + abstract public function topologyOpening (\MongoDB\Driver\Monitoring\TopologyOpeningEvent $event); } -/** - * The MongoDB\Driver\Monitoring\ServerChangedEvent - * class encapsulates information about a changed server description. - * @link http://www.php.net/manual/en/class.mongodb-driver-monitoring-serverchangedevent.php - */ final class ServerChangedEvent { /** @@ -9004,39 +3436,27 @@ final class ServerChangedEvent { final private function __construct () {} /** - * Returns the port on which this server is listening - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-serverchangedevent.getport.php - * @return int Returns the port on which this server is listening. + * {@inheritdoc} */ final public function getPort (): int {} /** - * Returns the hostname of the server - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-serverchangedevent.gethost.php - * @return string Returns the hostname of the server. + * {@inheritdoc} */ final public function getHost (): string {} /** - * Returns the new description for the server - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-serverchangedevent.getnewdescription.php - * @return \MongoDB\Driver\ServerDescription Returns the new MongoDB\Driver\ServerDescription - * for the server. + * {@inheritdoc} */ final public function getNewDescription (): \MongoDB\Driver\ServerDescription {} /** - * Returns the previous description for the server - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-serverchangedevent.getpreviousdescription.php - * @return \MongoDB\Driver\ServerDescription Returns the previous MongoDB\Driver\ServerDescription - * for the server. + * {@inheritdoc} */ final public function getPreviousDescription (): \MongoDB\Driver\ServerDescription {} /** - * Returns the topology ID associated with this server - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-serverchangedevent.gettopologyid.php - * @return \MongoDB\BSON\ObjectId Returns the topology ID. + * {@inheritdoc} */ final public function getTopologyId (): \MongoDB\BSON\ObjectId {} @@ -9047,11 +3467,6 @@ final public function __wakeup (): void {} } -/** - * The MongoDB\Driver\Monitoring\ServerClosedEvent - * class encapsulates information about a closed server. - * @link http://www.php.net/manual/en/class.mongodb-driver-monitoring-serverclosedevent.php - */ final class ServerClosedEvent { /** @@ -9060,23 +3475,17 @@ final class ServerClosedEvent { final private function __construct () {} /** - * Returns the port on which this server is listening - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-serverclosedevent.getport.php - * @return int Returns the port on which this server is listening. + * {@inheritdoc} */ final public function getPort (): int {} /** - * Returns the hostname of the server - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-serverclosedevent.gethost.php - * @return string Returns the hostname of the server. + * {@inheritdoc} */ final public function getHost (): string {} /** - * Returns the topology ID associated with this server - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-serverclosedevent.gettopologyid.php - * @return \MongoDB\BSON\ObjectId Returns the topology ID. + * {@inheritdoc} */ final public function getTopologyId (): \MongoDB\BSON\ObjectId {} @@ -9087,11 +3496,6 @@ final public function __wakeup (): void {} } -/** - * The MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent - * class encapsulates information about a failed server heartbeat. - * @link http://www.php.net/manual/en/class.mongodb-driver-monitoring-serverheartbeatfailedevent.php - */ final class ServerHeartbeatFailedEvent { /** @@ -9100,38 +3504,27 @@ final class ServerHeartbeatFailedEvent { final private function __construct () {} /** - * Returns the heartbeat's duration in microseconds - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-serverheartbeatfailedevent.getdurationmicros.php - * @return int Returns the heartbeat's duration in microseconds. + * {@inheritdoc} */ final public function getDurationMicros (): int {} /** - * Returns the Exception associated with the failed heartbeat - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-serverheartbeatfailedevent.geterror.php - * @return \Exception Returns the Exception associated with the failed - * heartbeat. + * {@inheritdoc} */ final public function getError (): \Exception {} /** - * Returns the port on which this server is listening - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-serverheartbeatfailedevent.getport.php - * @return int Returns the port on which this server is listening. + * {@inheritdoc} */ final public function getPort (): int {} /** - * Returns the hostname of the server - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-serverheartbeatfailedevent.gethost.php - * @return string Returns the hostname of the server. + * {@inheritdoc} */ final public function getHost (): string {} /** - * Returns whether the heartbeat used a streaming protocol - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-serverheartbeatfailedevent.isawaited.php - * @return bool Returns false. + * {@inheritdoc} */ final public function isAwaited (): bool {} @@ -9142,11 +3535,6 @@ final public function __wakeup (): void {} } -/** - * The MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent - * class encapsulates information about a started server heartbeat. - * @link http://www.php.net/manual/en/class.mongodb-driver-monitoring-serverheartbeatstartedevent.php - */ final class ServerHeartbeatStartedEvent { /** @@ -9155,23 +3543,17 @@ final class ServerHeartbeatStartedEvent { final private function __construct () {} /** - * Returns the port on which this server is listening - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-serverheartbeatstartedevent.getport.php - * @return int Returns the port on which this server is listening. + * {@inheritdoc} */ final public function getPort (): int {} /** - * Returns the hostname of the server - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-serverheartbeatstartedevent.gethost.php - * @return string Returns the hostname of the server. + * {@inheritdoc} */ final public function getHost (): string {} /** - * Returns whether the heartbeat used a streaming protocol - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-serverheartbeatstartedevent.isawaited.php - * @return bool Returns false. + * {@inheritdoc} */ final public function isAwaited (): bool {} @@ -9182,11 +3564,6 @@ final public function __wakeup (): void {} } -/** - * The MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent - * class encapsulates information about a successful server heartbeat. - * @link http://www.php.net/manual/en/class.mongodb-driver-monitoring-serverheartbeatsucceededevent.php - */ final class ServerHeartbeatSucceededEvent { /** @@ -9195,38 +3572,27 @@ final class ServerHeartbeatSucceededEvent { final private function __construct () {} /** - * Returns the heartbeat's duration in microseconds - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-serverheartbeatsucceededevent.getdurationmicros.php - * @return int Returns the heartbeat's duration in microseconds. + * {@inheritdoc} */ final public function getDurationMicros (): int {} /** - * Returns the heartbeat reply document - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-serverheartbeatsucceededevent.getreply.php - * @return object Returns the heartbeat reply document as a stdClass - * object. + * {@inheritdoc} */ final public function getReply (): object {} /** - * Returns the port on which this server is listening - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-serverheartbeatsucceededevent.getport.php - * @return int Returns the port on which this server is listening. + * {@inheritdoc} */ final public function getPort (): int {} /** - * Returns the hostname of the server - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-serverheartbeatsucceededevent.gethost.php - * @return string Returns the hostname of the server. + * {@inheritdoc} */ final public function getHost (): string {} /** - * Returns whether the heartbeat used a streaming protocol - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-serverheartbeatsucceededevent.isawaited.php - * @return bool Returns false. + * {@inheritdoc} */ final public function isAwaited (): bool {} @@ -9237,11 +3603,6 @@ final public function __wakeup (): void {} } -/** - * The MongoDB\Driver\Monitoring\ServerOpeningEvent - * class encapsulates information about an opened server. - * @link http://www.php.net/manual/en/class.mongodb-driver-monitoring-serveropeningevent.php - */ final class ServerOpeningEvent { /** @@ -9250,23 +3611,17 @@ final class ServerOpeningEvent { final private function __construct () {} /** - * Returns the port on which this server is listening - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-serveropeningevent.getport.php - * @return int Returns the port on which this server is listening. + * {@inheritdoc} */ final public function getPort (): int {} /** - * Returns the hostname of the server - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-serveropeningevent.gethost.php - * @return string Returns the hostname of the server. + * {@inheritdoc} */ final public function getHost (): string {} /** - * Returns the topology ID associated with this server - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-serveropeningevent.gettopologyid.php - * @return \MongoDB\BSON\ObjectId Returns the topology ID. + * {@inheritdoc} */ final public function getTopologyId (): \MongoDB\BSON\ObjectId {} @@ -9277,11 +3632,6 @@ final public function __wakeup (): void {} } -/** - * The MongoDB\Driver\Monitoring\TopologyChangedEvent - * class encapsulates information about a changed topology description. - * @link http://www.php.net/manual/en/class.mongodb-driver-monitoring-topologychangedevent.php - */ final class TopologyChangedEvent { /** @@ -9290,25 +3640,17 @@ final class TopologyChangedEvent { final private function __construct () {} /** - * Returns the new description for the topology - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-topologychangedevent.getnewdescription.php - * @return \MongoDB\Driver\TopologyDescription Returns the new MongoDB\Driver\TopologyDescription - * for the topology. + * {@inheritdoc} */ final public function getNewDescription (): \MongoDB\Driver\TopologyDescription {} /** - * Returns the previous description for the topology - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-topologychangedevent.getpreviousdescription.php - * @return \MongoDB\Driver\TopologyDescription Returns the previous MongoDB\Driver\TopologyDescription - * for the topology. + * {@inheritdoc} */ final public function getPreviousDescription (): \MongoDB\Driver\TopologyDescription {} /** - * Returns the topology ID - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-topologychangedevent.gettopologyid.php - * @return \MongoDB\BSON\ObjectId Returns the topology ID. + * {@inheritdoc} */ final public function getTopologyId (): \MongoDB\BSON\ObjectId {} @@ -9319,11 +3661,6 @@ final public function __wakeup (): void {} } -/** - * The MongoDB\Driver\Monitoring\TopologyClosedEvent - * class encapsulates information about a closed topology. - * @link http://www.php.net/manual/en/class.mongodb-driver-monitoring-topologyclosedevent.php - */ final class TopologyClosedEvent { /** @@ -9332,9 +3669,7 @@ final class TopologyClosedEvent { final private function __construct () {} /** - * Returns the topology ID - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-topologyclosedevent.gettopologyid.php - * @return \MongoDB\BSON\ObjectId Returns the topology ID. + * {@inheritdoc} */ final public function getTopologyId (): \MongoDB\BSON\ObjectId {} @@ -9345,11 +3680,6 @@ final public function __wakeup (): void {} } -/** - * The MongoDB\Driver\Monitoring\TopologyOpeningEvent - * class encapsulates information about an opened topology. - * @link http://www.php.net/manual/en/class.mongodb-driver-monitoring-topologyopeningevent.php - */ final class TopologyOpeningEvent { /** @@ -9358,9 +3688,7 @@ final class TopologyOpeningEvent { final private function __construct () {} /** - * Returns the topology ID - * @link http://www.php.net/manual/en/mongodb-driver-monitoring-topologyopeningevent.gettopologyid.php - * @return \MongoDB\BSON\ObjectId Returns the topology ID. + * {@inheritdoc} */ final public function getTopologyId (): \MongoDB\BSON\ObjectId {} @@ -9378,51 +3706,39 @@ final public function __wakeup (): void {} namespace mongodb\bson { /** - * Returns the BSON representation of a JSON value - * @link http://www.php.net/manual/en/function.mongodb.bson-fromjson.php - * @param string $json JSON value to be converted. - * @return string The serialized BSON document as a binary string. + * {@inheritdoc} + * @param string $json */ function fromJSON (string $json): string {} /** - * Returns the BSON representation of a PHP value - * @link http://www.php.net/manual/en/function.mongodb.bson-fromphp.php - * @param array|object $value PHP value to be serialized. - * @return string The serialized BSON document as a binary string. + * {@inheritdoc} + * @param object|array $value */ -function fromPHP (array|object $value): string {} +function fromPHP (object|array $value): string {} /** - * Returns the Canonical Extended JSON representation of a BSON value - * @link http://www.php.net/manual/en/function.mongodb.bson-tocanonicalextendedjson.php - * @param string $bson BSON value to be converted. - * @return string The converted JSON value. + * {@inheritdoc} + * @param string $bson */ function toCanonicalExtendedJSON (string $bson): string {} /** - * Returns the Legacy Extended JSON representation of a BSON value - * @link http://www.php.net/manual/en/function.mongodb.bson-tojson.php - * @param string $bson BSON value to be converted. - * @return string The converted JSON value. + * {@inheritdoc} + * @param string $bson */ function toJSON (string $bson): string {} /** - * Returns the PHP representation of a BSON value - * @link http://www.php.net/manual/en/function.mongodb.bson-tophp.php - * @param string $bson BSON value to be unserialized. - * @param array $typeMap [optional] Type map configuration. - * @return array|object The unserialized PHP value. + * {@inheritdoc} + * @param string $bson + * @param array|null $typemap [optional] */ -function toPHP (string $bson, array $typeMap = 'array()'): array|object {} +function toPHP (string $bson, ?array $typemap = NULL): object|array {} /** - * Returns the Relaxed Extended JSON representation of a BSON value - * @link http://www.php.net/manual/en/function.mongodb.bson-torelaxedextendedjson.php - * @param string $bson BSON value to be converted. - * @return string The converted JSON value. + * {@inheritdoc} + * @param string $bson */ function toRelaxedExtendedJSON (string $bson): string {} @@ -9433,18 +3749,22 @@ function toRelaxedExtendedJSON (string $bson): string {} namespace mongodb\driver\monitoring { /** - * Registers a monitoring event subscriber globally - * @link http://www.php.net/manual/en/function.mongodb.driver.monitoring.addsubscriber.php - * @param \MongoDB\Driver\Monitoring\Subscriber $subscriber A monitoring event subscriber to register globally. - * @return void No value is returned. + * {@inheritdoc} + * @param \MongoDB\Driver\Monitoring\Subscriber $subscriber */ function addSubscriber (\MongoDB\Driver\Monitoring\Subscriber $subscriber): void {} /** - * Unregisters a monitoring event subscriber globally - * @link http://www.php.net/manual/en/function.mongodb.driver.monitoring.removesubscriber.php - * @param \MongoDB\Driver\Monitoring\Subscriber $subscriber A monitoring event subscriber to unregister globally. - * @return void No value is returned. + * {@inheritdoc} + * @param int $level + * @param string $domain + * @param string $message + */ +function mongoc_log (int $level, string $domain, string $message): void {} + +/** + * {@inheritdoc} + * @param \MongoDB\Driver\Monitoring\Subscriber $subscriber */ function removeSubscriber (\MongoDB\Driver\Monitoring\Subscriber $subscriber): void {} @@ -9454,22 +3774,10 @@ function removeSubscriber (\MongoDB\Driver\Monitoring\Subscriber $subscriber): v namespace { - -/** - * x.y.z style version number of the extension - * @link http://www.php.net/manual/en/mongodb.constants.php - * @var string - */ -define ('MONGODB_VERSION', "1.15.3"); - -/** - * Current stability (alpha/beta/stable) - * @link http://www.php.net/manual/en/mongodb.constants.php - * @var string - */ +define ('MONGODB_VERSION', "1.17.0"); define ('MONGODB_STABILITY', "stable"); } -// End of mongodb v.1.15.3 +// End of mongodb v.1.17.0 diff --git a/plugins/org.eclipse.php.core/Resources/language/php8.3/mysqli.php b/plugins/org.eclipse.php.core/Resources/language/php8.3/mysqli.php index 853a15a0ac..f0956f66ef 100644 --- a/plugins/org.eclipse.php.core/Resources/language/php8.3/mysqli.php +++ b/plugins/org.eclipse.php.core/Resources/language/php8.3/mysqli.php @@ -1,36 +1,23 @@ mysqli_connect returns an object which represents the connection to a MySQL Server, - * or false on failure. - *mysqli::connect returns null on success or false on failure.
+ * {@inheritdoc} + * @param string|null $hostname [optional] + * @param string|null $username [optional] + * @param string|null $password [optional] + * @param string|null $database [optional] + * @param int|null $port [optional] + * @param string|null $socket [optional] */ - public function __construct (?string $hostname = null, ?string $username = null, ?string $password = null, ?string $database = null, ?int $port = null, ?string $socket = null): bool {} + public function __construct (?string $hostname = NULL, ?string $username = NULL, ?string $password = NULL, ?string $database = NULL, ?int $port = NULL, ?string $socket = NULL) {} /** - * Turns on or off auto-committing database modifications - * @link http://www.php.net/manual/en/mysqli.autocommit.php - * @param bool $enable - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param bool $enable */ - public function autocommit (bool $enable): bool {} + public function autocommit (bool $enable) {} /** - * Starts a transaction - * @link http://www.php.net/manual/en/mysqli.begin-transaction.php - * @param int $flags [optional] - * @param string|null $name [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $flags [optional] + * @param string|null $name [optional] */ - public function begin_transaction (int $flags = null, ?string $name = null): bool {} + public function begin_transaction (int $flags = 0, ?string $name = NULL) {} /** - * Changes the user of the specified database connection - * @link http://www.php.net/manual/en/mysqli.change-user.php - * @param string $username - * @param string $password - * @param string|null $database - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $username + * @param string $password + * @param string|null $database */ - public function change_user (string $username, string $password, ?string $database): bool {} + public function change_user (string $username, string $password, ?string $database = null) {} /** - * Returns the current character set of the database connection - * @link http://www.php.net/manual/en/mysqli.character-set-name.php - * @return string The current character set of the connection + * {@inheritdoc} */ - public function character_set_name (): string {} + public function character_set_name () {} /** - * Closes a previously opened database connection - * @link http://www.php.net/manual/en/mysqli.close.php - * @return true Always returns true. + * {@inheritdoc} */ - public function close (): true {} + public function close () {} /** - * Commits the current transaction - * @link http://www.php.net/manual/en/mysqli.commit.php - * @param int $flags [optional] - * @param string|null $name [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $flags [optional] + * @param string|null $name [optional] */ - public function commit (int $flags = null, ?string $name = null): bool {} + public function commit (int $flags = 0, ?string $name = NULL) {} /** - * Open a new connection to the MySQL server - * @link http://www.php.net/manual/en/mysqli.construct.php - * @param string|null $hostname [optional] - * @param string|null $username [optional] - * @param string|null $password [optional] - * @param string|null $database [optional] - * @param int|null $port [optional] - * @param string|null $socket [optional] - * @return bool mysqli::__construct always returns an object which represents the connection to a MySQL Server, - * regardless of it being successful or not. - *mysqli_connect returns an object which represents the connection to a MySQL Server, - * or false on failure.
- *mysqli::connect returns null on success or false on failure.
+ * {@inheritdoc} + * @param string|null $hostname [optional] + * @param string|null $username [optional] + * @param string|null $password [optional] + * @param string|null $database [optional] + * @param int|null $port [optional] + * @param string|null $socket [optional] */ - public function connect (?string $hostname = null, ?string $username = null, ?string $password = null, ?string $database = null, ?int $port = null, ?string $socket = null): bool {} + public function connect (?string $hostname = NULL, ?string $username = NULL, ?string $password = NULL, ?string $database = NULL, ?int $port = NULL, ?string $socket = NULL) {} /** - * Dump debugging information into the log - * @link http://www.php.net/manual/en/mysqli.dump-debug-info.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function dump_debug_info (): bool {} + public function dump_debug_info () {} /** - * Performs debugging operations - * @link http://www.php.net/manual/en/mysqli.debug.php - * @param string $options - * @return true Always returns true. + * {@inheritdoc} + * @param string $options */ - public function debug (string $options): true {} + public function debug (string $options) {} /** - * Returns a character set object - * @link http://www.php.net/manual/en/mysqli.get-charset.php - * @return object|null The function returns a character set object with the following properties: - *
- * charset
- *
Character set name
- * collation - *Collation name
- * dir - *Directory the charset description was fetched from (?) or "" for built-in character sets
- * min_length - *Minimum character length in bytes
- * max_length - *Maximum character length in bytes
- * number - *Internal character set number
- * state - *Character set status (?)
- * - *Character set name
- *Collation name
- *Directory the charset description was fetched from (?) or "" for built-in character sets
- *Minimum character length in bytes
- *Maximum character length in bytes
- *Internal character set number
- *Character set status (?)
+ * {@inheritdoc} */ - public function get_charset (): ?object {} + public function get_charset () {} /** - * Prepares, binds parameters, and executes SQL statement - * @link http://www.php.net/manual/en/mysqli.execute-query.php - * @param string $query - * @param array|null $params [optional] - * @return mysqli_result|bool Returns false on failure. For successful queries which produce a result - * set, such as SELECT, SHOW, DESCRIBE or - * EXPLAIN, returns - * a mysqli_result object. For other successful queries, - * returns true. + * {@inheritdoc} + * @param string $query + * @param array|null $params [optional] */ - public function execute_query (string $query, ?array $params = null): mysqli_result|bool {} + public function execute_query (string $query, ?array $params = NULL): mysqli_result|bool {} /** - * Get MySQL client info - * @link http://www.php.net/manual/en/mysqli.get-client-info.php - * @return string A string that represents the MySQL client library version. + * {@inheritdoc} * @deprecated */ - public function get_client_info (): string {} + public function get_client_info () {} /** - * Returns statistics about the client connection - * @link http://www.php.net/manual/en/mysqli.get-connection-stats.php - * @return array Returns an array with connection stats. + * {@inheritdoc} */ - public function get_connection_stats (): array {} + public function get_connection_stats () {} /** - * Returns the version of the MySQL server - * @link http://www.php.net/manual/en/mysqli.get-server-info.php - * @return string A character string representing the server version. + * {@inheritdoc} */ - public function get_server_info (): string {} + public function get_server_info () {} /** - * Get result of SHOW WARNINGS - * @link http://www.php.net/manual/en/mysqli.get-warnings.php - * @return mysqli_warning|false + * {@inheritdoc} */ - public function get_warnings (): mysqli_warning|false {} + public function get_warnings () {} /** - * Initializes MySQLi and returns an object for use with mysqli_real_connect() - * @link http://www.php.net/manual/en/mysqli.init.php - * @return bool|null mysqli::init returns null on success, or false on failure. - * mysqli_init returns an object on success, or false on failure. + * {@inheritdoc} * @deprecated */ - public function init (): ?bool {} + public function init () {} /** - * Asks the server to kill a MySQL thread - * @link http://www.php.net/manual/en/mysqli.kill.php - * @param int $process_id - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $process_id */ - public function kill (int $process_id): bool {} + public function kill (int $process_id) {} /** - * Performs one or more queries on the database - * @link http://www.php.net/manual/en/mysqli.multi-query.php - * @param string $query - * @return bool Returns false if the first statement failed. - * To retrieve subsequent errors from other statements you have to call - * mysqli_next_result first. + * {@inheritdoc} + * @param string $query */ - public function multi_query (string $query): bool {} + public function multi_query (string $query) {} /** - * Check if there are any more query results from a multi query - * @link http://www.php.net/manual/en/mysqli.more-results.php - * @return bool Returns true if one or more result sets (including errors) are available from a previous call to - * mysqli_multi_query, otherwise false. + * {@inheritdoc} */ - public function more_results (): bool {} + public function more_results () {} /** - * Prepare next result from multi_query - * @link http://www.php.net/manual/en/mysqli.next-result.php - * @return bool Returns true on success or false on failure. Also returns false if the next statement resulted in an error, unlike mysqli_more_results. + * {@inheritdoc} */ - public function next_result (): bool {} + public function next_result () {} /** - * Pings a server connection, or tries to reconnect if the connection has gone down - * @link http://www.php.net/manual/en/mysqli.ping.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function ping (): bool {} + public function ping () {} /** - * Poll connections - * @link http://www.php.net/manual/en/mysqli.poll.php - * @param array|null $read - * @param array|null $error - * @param array $reject - * @param int $seconds - * @param int $microseconds [optional] - * @return int|false Returns number of ready connections upon success, false otherwise. + * {@inheritdoc} + * @param array|null $read + * @param array|null $error + * @param array $reject + * @param int $seconds + * @param int $microseconds [optional] */ - public static function poll (?array &$read, ?array &$error, array &$reject, int $seconds, int $microseconds = null): int|false {} + public static function poll (?array &$read = null, ?array &$error = null, array &$reject, int $seconds, int $microseconds = 0) {} /** - * Prepares an SQL statement for execution - * @link http://www.php.net/manual/en/mysqli.prepare.php - * @param string $query - * @return mysqli_stmt|false mysqli_prepare returns a statement object or false if an error occurred. + * {@inheritdoc} + * @param string $query */ - public function prepare (string $query): mysqli_stmt|false {} + public function prepare (string $query) {} /** - * Performs a query on the database - * @link http://www.php.net/manual/en/mysqli.query.php - * @param string $query - * @param int $result_mode [optional] - * @return mysqli_result|bool Returns false on failure. For successful queries which produce a result - * set, such as SELECT, SHOW, DESCRIBE or - * EXPLAIN, mysqli_query will return - * a mysqli_result object. For other successful queries, - * mysqli_query will - * return true. + * {@inheritdoc} + * @param string $query + * @param int $result_mode [optional] */ - public function query (string $query, int $result_mode = MYSQLI_STORE_RESULT): mysqli_result|bool {} + public function query (string $query, int $result_mode = 0) {} /** - * Opens a connection to a mysql server - * @link http://www.php.net/manual/en/mysqli.real-connect.php - * @param string|null $hostname [optional] - * @param string|null $username [optional] - * @param string|null $password [optional] - * @param string|null $database [optional] - * @param int|null $port [optional] - * @param string|null $socket [optional] - * @param int $flags [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string|null $hostname [optional] + * @param string|null $username [optional] + * @param string|null $password [optional] + * @param string|null $database [optional] + * @param int|null $port [optional] + * @param string|null $socket [optional] + * @param int $flags [optional] */ - public function real_connect (?string $hostname = null, ?string $username = null, ?string $password = null, ?string $database = null, ?int $port = null, ?string $socket = null, int $flags = null): bool {} + public function real_connect (?string $hostname = NULL, ?string $username = NULL, ?string $password = NULL, ?string $database = NULL, ?int $port = NULL, ?string $socket = NULL, int $flags = 0) {} /** - * Escapes special characters in a string for use in an SQL statement, taking into account the current charset of the connection - * @link http://www.php.net/manual/en/mysqli.real-escape-string.php - * @param string $string - * @return string Returns an escaped string. + * {@inheritdoc} + * @param string $string */ - public function real_escape_string (string $string): string {} + public function real_escape_string (string $string) {} /** - * Get result from async query - * @link http://www.php.net/manual/en/mysqli.reap-async-query.php - * @return mysqli_result|bool Returns false on failure. For successful queries which produce a result set, such as SELECT, SHOW, DESCRIBE or - * EXPLAIN, mysqli_reap_async_query will return - * a mysqli_result object. For other successful queries, mysqli_reap_async_query will - * return true. + * {@inheritdoc} */ - public function reap_async_query (): mysqli_result|bool {} + public function reap_async_query () {} /** * {@inheritdoc} @@ -561,62 +305,48 @@ public function reap_async_query (): mysqli_result|bool {} public function escape_string (string $string) {} /** - * Execute an SQL query - * @link http://www.php.net/manual/en/mysqli.real-query.php - * @param string $query - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $query */ - public function real_query (string $query): bool {} + public function real_query (string $query) {} /** - * Removes the named savepoint from the set of savepoints of the current transaction - * @link http://www.php.net/manual/en/mysqli.release-savepoint.php - * @param string $name - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $name */ - public function release_savepoint (string $name): bool {} + public function release_savepoint (string $name) {} /** - * Rolls back current transaction - * @link http://www.php.net/manual/en/mysqli.rollback.php - * @param int $flags [optional] - * @param string|null $name [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $flags [optional] + * @param string|null $name [optional] */ - public function rollback (int $flags = null, ?string $name = null): bool {} + public function rollback (int $flags = 0, ?string $name = NULL) {} /** - * Set a named transaction savepoint - * @link http://www.php.net/manual/en/mysqli.savepoint.php - * @param string $name - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $name */ - public function savepoint (string $name): bool {} + public function savepoint (string $name) {} /** - * Selects the default database for database queries - * @link http://www.php.net/manual/en/mysqli.select-db.php - * @param string $database - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $database */ - public function select_db (string $database): bool {} + public function select_db (string $database) {} /** - * Sets the client character set - * @link http://www.php.net/manual/en/mysqli.set-charset.php - * @param string $charset - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $charset */ - public function set_charset (string $charset): bool {} + public function set_charset (string $charset) {} /** - * Set options - * @link http://www.php.net/manual/en/mysqli.options.php - * @param int $option - * @param string|int $value - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $option + * @param mixed $value */ - public function options (int $option, string|int $value): bool {} + public function options (int $option, $value = null) {} /** * {@inheritdoc} @@ -626,888 +356,425 @@ public function options (int $option, string|int $value): bool {} public function set_opt (int $option, $value = null) {} /** - * Used for establishing secure connections using SSL - * @link http://www.php.net/manual/en/mysqli.ssl-set.php - * @param string|null $key - * @param string|null $certificate - * @param string|null $ca_certificate - * @param string|null $ca_path - * @param string|null $cipher_algos - * @return true Always returns true. If SSL setup is - * incorrect mysqli_real_connect will return an error - * when you attempt to connect. + * {@inheritdoc} + * @param string|null $key + * @param string|null $certificate + * @param string|null $ca_certificate + * @param string|null $ca_path + * @param string|null $cipher_algos */ - public function ssl_set (?string $key, ?string $certificate, ?string $ca_certificate, ?string $ca_path, ?string $cipher_algos): true {} + public function ssl_set (?string $key = null, ?string $certificate = null, ?string $ca_certificate = null, ?string $ca_path = null, ?string $cipher_algos = null) {} /** - * Gets the current system status - * @link http://www.php.net/manual/en/mysqli.stat.php - * @return string|false A string describing the server status. false if an error occurred. + * {@inheritdoc} */ - public function stat (): string|false {} + public function stat () {} /** - * Initializes a statement and returns an object for use with mysqli_stmt_prepare - * @link http://www.php.net/manual/en/mysqli.stmt-init.php - * @return mysqli_stmt|false Returns an object. + * {@inheritdoc} */ - public function stmt_init (): mysqli_stmt|false {} + public function stmt_init () {} /** - * Transfers a result set from the last query - * @link http://www.php.net/manual/en/mysqli.store-result.php - * @param int $mode [optional] - * @return mysqli_result|false Returns a buffered result object or false if an error occurred. - *mysqli_store_result returns false in case the query - * didn't return a result set (if the query was, for example an INSERT - * statement). This function also returns false if the reading of the - * result set failed. You can check if you have got an error by checking - * if mysqli_error doesn't return an empty string, if - * mysqli_errno returns a non zero value, or if - * mysqli_field_count returns a non zero value. - * Also possible reason for this function returning false after - * successful call to mysqli_query can be too large - * result set (memory for it cannot be allocated). If - * mysqli_field_count returns a non-zero value, the - * statement should have produced a non-empty result set.
+ * {@inheritdoc} + * @param int $mode [optional] */ - public function store_result (int $mode = null): mysqli_result|false {} + public function store_result (int $mode = 0) {} /** - * Returns whether thread safety is given or not - * @link http://www.php.net/manual/en/mysqli.thread-safe.php - * @return bool true if the client library is thread-safe, otherwise false. + * {@inheritdoc} */ - public function thread_safe (): bool {} + public function thread_safe () {} /** - * Initiate a result set retrieval - * @link http://www.php.net/manual/en/mysqli.use-result.php - * @return mysqli_result|false Returns an unbuffered result object or false if an error occurred. + * {@inheritdoc} */ - public function use_result (): mysqli_result|false {} + public function use_result () {} /** - * Refreshes - * @link http://www.php.net/manual/en/mysqli.refresh.php - * @param int $flags - * @return bool true if the refresh was a success, otherwise false + * {@inheritdoc} + * @param int $flags */ - public function refresh (int $flags): bool {} + public function refresh (int $flags) {} } -/** - * Represents a MySQL warning. - * @link http://www.php.net/manual/en/class.mysqli_warning.php - */ final class mysqli_warning { - /** - * Message string - * @var string - * @link http://www.php.net/manual/en/class.mysqli_warning.php#mysqli_warning.props.message - */ public string $message; - /** - * SQL state - * @var string - * @link http://www.php.net/manual/en/class.mysqli_warning.php#mysqli_warning.props.sqlstate - */ public string $sqlstate; - /** - * Error number - * @var int - * @link http://www.php.net/manual/en/class.mysqli_warning.php#mysqli_warning.props.errno - */ public int $errno; /** - * Private constructor to disallow direct instantiation - * @link http://www.php.net/manual/en/mysqli-warning.construct.php + * {@inheritdoc} */ private function __construct () {} /** - * Fetch next warning - * @link http://www.php.net/manual/en/mysqli-warning.next.php - * @return bool Returns true if next warning was fetched successfully. - * If there are no more warnings, it will return false + * {@inheritdoc} */ public function next (): bool {} } -/** - * Represents the result set obtained from a query against the database. - * @link http://www.php.net/manual/en/class.mysqli_result.php - */ class mysqli_result implements IteratorAggregate, Traversable { - /** - * Get current field offset of a result pointer - * @var int - * @link http://www.php.net/manual/en/class.mysqli_result.php#mysqli_result.props.current_field - */ public int $current_field; - /** - * Gets the number of fields in the result set - * @var int - * @link http://www.php.net/manual/en/class.mysqli_result.php#mysqli_result.props.field_count - */ public int $field_count; - /** - * Returns the lengths of the columns of the current row in the result set - * @var array|null - * @link http://www.php.net/manual/en/class.mysqli_result.php#mysqli_result.props.lengths - */ public ?array $lengths; + public string|int $num_rows; + + public int $type; + /** - * Gets the number of rows in the result set - * @var int|string - * @link http://www.php.net/manual/en/class.mysqli_result.php#mysqli_result.props.num_rows + * {@inheritdoc} + * @param mysqli $mysql + * @param int $result_mode [optional] */ - public int|string $num_rows; + public function __construct (mysqli $mysql, int $result_mode = 0) {} /** - * Stores whether the result is buffered or unbuffered as an int - * (MYSQLI_STORE_RESULT or - * MYSQLI_USE_RESULT, respectively). - * @var int - * @link http://www.php.net/manual/en/class.mysqli_result.php#mysqli_result.props.type + * {@inheritdoc} */ - public int $type; + public function close () {} /** - * Constructs a mysqli_result object - * @link http://www.php.net/manual/en/mysqli-result.construct.php - * @param mysqli $mysql Procedural style only: A mysqli object - * returned by mysqli_connect or mysqli_init - * @param int $result_mode [optional] The result mode can be one of 2 constants indicating how the result will - * be returned from the MySQL server. - *MYSQLI_STORE_RESULT (default) - creates a - * mysqli_result object with buffered result set.
- *MYSQLI_USE_RESULT - creates a - * mysqli_result object with unbuffered result set. - * As long as there are pending records waiting to be fetched, the - * connection line will be busy and all subsequent calls will return error - * Commands out of sync. To avoid the error all records - * must be fetched from the server or the result set must be discarded by - * calling mysqli_free_result. The connection must - * remain open for the rows to be fetched.
- * @return mysqli - */ - public function __construct (mysqli $mysql, int $result_mode = MYSQLI_STORE_RESULT): mysqli {} - - /** - * Frees the memory associated with a result - * @link http://www.php.net/manual/en/mysqli-result.free.php - * @return void No value is returned. - */ - public function close (): void {} - - /** - * Frees the memory associated with a result - * @link http://www.php.net/manual/en/mysqli-result.free.php - * @return void No value is returned. - */ - public function free (): void {} - - /** - * Adjusts the result pointer to an arbitrary row in the result - * @link http://www.php.net/manual/en/mysqli-result.data-seek.php - * @param int $offset - * @return bool Returns true on success or false on failure. - */ - public function data_seek (int $offset): bool {} - - /** - * Returns the next field in the result set - * @link http://www.php.net/manual/en/mysqli-result.fetch-field.php - * @return object|false Returns an object which contains field definition information or false - * if no field information is available. - *Property | - *Description | - *
name | - *The name of the column | - *
orgname | - *Original column name if an alias was specified | - *
table | - *The name of the table this field belongs to (if not calculated) | - *
orgtable | - *Original table name if an alias was specified | - *
def | - *Reserved for default value, currently always "" | - *
db | - *The name of the database | - *
catalog | - *The catalog name, always "def" | - *
max_length | - *The maximum width of the field for the result set. | - *
length | - *The width of the field, as specified in the table definition. | - *
charsetnr | - *The character set number for the field. | - *
flags | - *An integer representing the bit-flags for the field. | - *
type | - *The data type used for this field | - *
decimals | - *The number of decimals used (for integer fields) | - *
Property | - *Description | - *
name | - *The name of the column | - *
orgname | - *Original column name if an alias was specified | - *
table | - *The name of the table this field belongs to (if not calculated) | - *
orgtable | - *Original table name if an alias was specified | - *
max_length | - *The maximum width of the field for the result set. As of PHP 8.1, this value is always 0. | - *
length | - *- * The width of the field, in bytes, as specified in the table definition. Note that - * this number (bytes) might differ from your table definition value (characters), depending on - * the character set you use. For example, the character set utf8 has 3 bytes per character, - * so varchar(10) will return a length of 30 for utf8 (10*3), but return 10 for latin1 (10*1). - * | - *
charsetnr | - *The character set number (id) for the field. | - *
flags | - *An integer representing the bit-flags for the field. | - *
type | - *The data type used for this field | - *
decimals | - *The number of decimals used (for integer fields) | - *
Attribute | - *Description | - *
name | - *The name of the column | - *
orgname | - *Original column name if an alias was specified | - *
table | - *The name of the table this field belongs to (if not calculated) | - *
orgtable | - *Original table name if an alias was specified | - *
def | - *The default value for this field, represented as a string | - *
max_length | - *The maximum width of the field for the result set. As of PHP 8.1, this value is always 0. | - *
length | - *The width of the field, as specified in the table definition. | - *
charsetnr | - *The character set number for the field. | - *
flags | - *An integer representing the bit-flags for the field. | - *
type | - *The data type used for this field | - *
decimals | - *The number of decimals used (for numeric fields) | - *
There is no way to return another column from the same row if you - * use this function to retrieve data.
- */ - public function fetch_column (int $column = null): null|int|float|string|false {} - - /** - * Set result pointer to a specified field offset - * @link http://www.php.net/manual/en/mysqli-result.field-seek.php - * @param int $index - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function field_seek (int $index): bool {} + public function free () {} /** - * Frees the memory associated with a result - * @link http://www.php.net/manual/en/mysqli-result.free.php - * @return void No value is returned. + * {@inheritdoc} + * @param int $offset */ - public function free_result (): void {} + public function data_seek (int $offset) {} /** - * Retrieve an external iterator - * @link http://www.php.net/manual/en/mysqli-result.getiterator.php - * @return Iterator + * {@inheritdoc} */ - public function getIterator (): Iterator {} - -} + public function fetch_field () {} -/** - * Represents a prepared statement. - * @link http://www.php.net/manual/en/class.mysqli_stmt.php - */ -class mysqli_stmt { + /** + * {@inheritdoc} + */ + public function fetch_fields () {} /** - * Returns the total number of rows changed, deleted, inserted, or - * matched by the last statement executed - * - * @var int|string - * @link http://www.php.net/manual/en/class.mysqli_stmt.php#mysqli_stmt.props.affected_rows + * {@inheritdoc} + * @param int $index */ - public int|string $affected_rows; + public function fetch_field_direct (int $index) {} /** - * Get the ID generated from the previous INSERT operation - * @var int|string - * @link http://www.php.net/manual/en/class.mysqli_stmt.php#mysqli_stmt.props.insert_id + * {@inheritdoc} + * @param int $mode [optional] */ - public int|string $insert_id; + public function fetch_all (int $mode = 2) {} /** - * Returns the number of rows fetched from the server - * @var int|string - * @link http://www.php.net/manual/en/class.mysqli_stmt.php#mysqli_stmt.props.num_rows + * {@inheritdoc} + * @param int $mode [optional] */ - public int|string $num_rows; + public function fetch_array (int $mode = 3) {} /** - * Returns the number of parameters for the given statement - * @var int - * @link http://www.php.net/manual/en/class.mysqli_stmt.php#mysqli_stmt.props.param_count + * {@inheritdoc} */ - public int $param_count; + public function fetch_assoc () {} /** - * Returns the number of columns in the given statement - * @var int - * @link http://www.php.net/manual/en/class.mysqli_stmt.php#mysqli_stmt.props.field_count + * {@inheritdoc} + * @param string $class [optional] + * @param array $constructor_args [optional] */ - public int $field_count; + public function fetch_object (string $class = 'stdClass', array $constructor_args = array ( +)) {} /** - * Returns the error code for the most recent statement call - * @var int - * @link http://www.php.net/manual/en/class.mysqli_stmt.php#mysqli_stmt.props.errno + * {@inheritdoc} */ - public int $errno; + public function fetch_row () {} /** - * Returns a string description for last statement error - * @var string - * @link http://www.php.net/manual/en/class.mysqli_stmt.php#mysqli_stmt.props.error + * {@inheritdoc} + * @param int $column [optional] */ - public string $error; + public function fetch_column (int $column = 0): string|int|float|false|null {} /** - * Returns a list of errors from the last statement executed - * @var array - * @link http://www.php.net/manual/en/class.mysqli_stmt.php#mysqli_stmt.props.error_list + * {@inheritdoc} + * @param int $index */ - public array $error_list; + public function field_seek (int $index) {} /** - * Returns SQLSTATE error from previous statement operation - * @var string - * @link http://www.php.net/manual/en/class.mysqli_stmt.php#mysqli_stmt.props.sqlstate + * {@inheritdoc} */ - public string $sqlstate; + public function free_result () {} /** - * Stores the statement ID. - * @var int - * @link http://www.php.net/manual/en/class.mysqli_stmt.php#mysqli_stmt.props.id + * {@inheritdoc} */ + public function getIterator (): Iterator {} + +} + +class mysqli_stmt { + + public string|int $affected_rows; + + public string|int $insert_id; + + public string|int $num_rows; + + public int $param_count; + + public int $field_count; + + public int $errno; + + public string $error; + + public array $error_list; + + public string $sqlstate; + public int $id; /** - * Constructs a new mysqli_stmt object - * @link http://www.php.net/manual/en/mysqli-stmt.construct.php - * @param mysqli $mysql - * @param string|null $query [optional] - * @return mysqli + * {@inheritdoc} + * @param mysqli $mysql + * @param string|null $query [optional] */ - public function __construct (mysqli $mysql, ?string $query = null): mysqli {} + public function __construct (mysqli $mysql, ?string $query = NULL) {} /** - * Used to get the current value of a statement attribute - * @link http://www.php.net/manual/en/mysqli-stmt.attr-get.php - * @param int $attribute - * @return int Returns the value of the attribute. + * {@inheritdoc} + * @param int $attribute */ - public function attr_get (int $attribute): int {} + public function attr_get (int $attribute) {} /** - * Used to modify the behavior of a prepared statement - * @link http://www.php.net/manual/en/mysqli-stmt.attr-set.php - * @param int $attribute - * @param int $value - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $attribute + * @param int $value */ - public function attr_set (int $attribute, int $value): bool {} + public function attr_set (int $attribute, int $value) {} /** - * Binds variables to a prepared statement as parameters - * @link http://www.php.net/manual/en/mysqli-stmt.bind-param.php - * @param string $types - * @param mixed $var - * @param mixed $vars - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $types + * @param mixed $vars [optional] */ - public function bind_param (string $types, mixed &$var, mixed &...$vars): bool {} + public function bind_param (string $types, mixed &...$vars) {} /** - * Binds variables to a prepared statement for result storage - * @link http://www.php.net/manual/en/mysqli-stmt.bind-result.php - * @param mixed $var - * @param mixed $vars - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mixed $vars [optional] */ - public function bind_result (mixed &$var, mixed &...$vars): bool {} + public function bind_result (mixed &...$vars) {} /** - * Closes a prepared statement - * @link http://www.php.net/manual/en/mysqli-stmt.close.php - * @return true Always returns true. + * {@inheritdoc} */ - public function close (): true {} + public function close () {} /** - * Adjusts the result pointer to an arbitrary row in the buffered result - * @link http://www.php.net/manual/en/mysqli-stmt.data-seek.php - * @param int $offset - * @return void No value is returned. + * {@inheritdoc} + * @param int $offset */ - public function data_seek (int $offset): void {} + public function data_seek (int $offset) {} /** - * Executes a prepared statement - * @link http://www.php.net/manual/en/mysqli-stmt.execute.php - * @param array|null $params [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param array|null $params [optional] */ - public function execute (?array $params = null): bool {} + public function execute (?array $params = NULL) {} /** - * Fetch results from a prepared statement into the bound variables - * @link http://www.php.net/manual/en/mysqli-stmt.fetch.php - * @return bool|null + * {@inheritdoc} */ - public function fetch (): ?bool {} + public function fetch () {} /** - * Get result of SHOW WARNINGS - * @link http://www.php.net/manual/en/mysqli-stmt.get-warnings.php - * @return mysqli_warning|false + * {@inheritdoc} */ - public function get_warnings (): mysqli_warning|false {} + public function get_warnings () {} /** - * Returns result set metadata from a prepared statement - * @link http://www.php.net/manual/en/mysqli-stmt.result-metadata.php - * @return mysqli_result|false Returns a result object or false if an error occurred. + * {@inheritdoc} */ - public function result_metadata (): mysqli_result|false {} + public function result_metadata () {} /** - * Check if there are more query results from a multiple query - * @link http://www.php.net/manual/en/mysqli-stmt.more-results.php - * @return bool Returns true if more results exist, otherwise false. + * {@inheritdoc} */ - public function more_results (): bool {} + public function more_results () {} /** - * Reads the next result from a multiple query - * @link http://www.php.net/manual/en/mysqli-stmt.next-result.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function next_result (): bool {} + public function next_result () {} /** - * Returns the number of rows fetched from the server - * @link http://www.php.net/manual/en/mysqli-stmt.num-rows.php - * @return int|string An int representing the number of buffered rows. - * Returns 0 in unbuffered mode unless all rows have been - * fetched from the server. - *If the number of rows is greater than PHP_INT_MAX, - * the number will be returned as a string.
+ * {@inheritdoc} */ - public function num_rows (): int|string {} + public function num_rows () {} /** - * Send data in blocks - * @link http://www.php.net/manual/en/mysqli-stmt.send-long-data.php - * @param int $param_num - * @param string $data - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $param_num + * @param string $data */ - public function send_long_data (int $param_num, string $data): bool {} + public function send_long_data (int $param_num, string $data) {} /** - * Frees stored result memory for the given statement handle - * @link http://www.php.net/manual/en/mysqli-stmt.free-result.php - * @return void No value is returned. + * {@inheritdoc} */ - public function free_result (): void {} + public function free_result () {} /** - * Resets a prepared statement - * @link http://www.php.net/manual/en/mysqli-stmt.reset.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function reset (): bool {} + public function reset () {} /** - * Prepares an SQL statement for execution - * @link http://www.php.net/manual/en/mysqli-stmt.prepare.php - * @param string $query - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $query */ - public function prepare (string $query): bool {} + public function prepare (string $query) {} /** - * Stores a result set in an internal buffer - * @link http://www.php.net/manual/en/mysqli-stmt.store-result.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function store_result (): bool {} + public function store_result () {} /** - * Gets a result set from a prepared statement as a mysqli_result object - * @link http://www.php.net/manual/en/mysqli-stmt.get-result.php - * @return mysqli_result|false Returns false on failure. For successful queries which produce a result set, such as SELECT, SHOW, DESCRIBE or - * EXPLAIN, mysqli_stmt_get_result will return - * a mysqli_result object. For other successful queries, mysqli_stmt_get_result will - * return false. The mysqli_stmt_errno function can be - * used to distinguish between the two reasons for false; due to a bug, prior to PHP 7.4.13, - * mysqli_errno had to be used for this purpose. + * {@inheritdoc} */ - public function get_result (): mysqli_result|false {} + public function get_result () {} } /** - * Gets the number of affected rows in a previous MySQL operation - * @link http://www.php.net/manual/en/mysqli.affected-rows.php - * @param mysqli $mysql - * @return int|string An integer greater than zero indicates the number of rows affected or - * retrieved. Zero indicates that no records were updated for an - * UPDATE statement, no rows matched the - * WHERE clause in the query or that no query has yet been - * executed. -1 indicates that the query returned an error or - * that mysqli_affected_rows was called for an unbuffered - * SELECT query. - *If the number of affected rows is greater than the maximum int value - * (PHP_INT_MAX), the number of affected rows will be - * returned as a string.
+ * {@inheritdoc} + * @param mysqli $mysql */ -function mysqli_affected_rows (mysqli $mysql): int|string {} +function mysqli_affected_rows (mysqli $mysql): string|int {} /** - * Turns on or off auto-committing database modifications - * @link http://www.php.net/manual/en/mysqli.autocommit.php - * @param mysqli $mysql - * @param bool $enable - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mysqli $mysql + * @param bool $enable */ function mysqli_autocommit (mysqli $mysql, bool $enable): bool {} /** - * Starts a transaction - * @link http://www.php.net/manual/en/mysqli.begin-transaction.php - * @param mysqli $mysql - * @param int $flags [optional] - * @param string|null $name [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mysqli $mysql + * @param int $flags [optional] + * @param string|null $name [optional] */ -function mysqli_begin_transaction (mysqli $mysql, int $flags = null, ?string $name = null): bool {} +function mysqli_begin_transaction (mysqli $mysql, int $flags = 0, ?string $name = NULL): bool {} /** - * Changes the user of the specified database connection - * @link http://www.php.net/manual/en/mysqli.change-user.php - * @param mysqli $mysql - * @param string $username - * @param string $password - * @param string|null $database - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mysqli $mysql + * @param string $username + * @param string $password + * @param string|null $database */ -function mysqli_change_user (mysqli $mysql, string $username, string $password, ?string $database): bool {} +function mysqli_change_user (mysqli $mysql, string $username, string $password, ?string $database = null): bool {} /** - * Returns the current character set of the database connection - * @link http://www.php.net/manual/en/mysqli.character-set-name.php - * @param mysqli $mysql - * @return string The current character set of the connection + * {@inheritdoc} + * @param mysqli $mysql */ function mysqli_character_set_name (mysqli $mysql): string {} /** - * Closes a previously opened database connection - * @link http://www.php.net/manual/en/mysqli.close.php - * @param mysqli $mysql - * @return true Always returns true. + * {@inheritdoc} + * @param mysqli $mysql */ function mysqli_close (mysqli $mysql): true {} /** - * Commits the current transaction - * @link http://www.php.net/manual/en/mysqli.commit.php - * @param mysqli $mysql - * @param int $flags [optional] - * @param string|null $name [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mysqli $mysql + * @param int $flags [optional] + * @param string|null $name [optional] */ -function mysqli_commit (mysqli $mysql, int $flags = null, ?string $name = null): bool {} +function mysqli_commit (mysqli $mysql, int $flags = 0, ?string $name = NULL): bool {} /** - * Open a new connection to the MySQL server - * @link http://www.php.net/manual/en/mysqli.construct.php - * @param string|null $hostname [optional] - * @param string|null $username [optional] - * @param string|null $password [optional] - * @param string|null $database [optional] - * @param int|null $port [optional] - * @param string|null $socket [optional] - * @return mysqli|false mysqli::__construct always returns an object which represents the connection to a MySQL Server, - * regardless of it being successful or not. - *mysqli_connect returns an object which represents the connection to a MySQL Server, - * or false on failure.
- *mysqli::connect returns null on success or false on failure.
+ * {@inheritdoc} + * @param string|null $hostname [optional] + * @param string|null $username [optional] + * @param string|null $password [optional] + * @param string|null $database [optional] + * @param int|null $port [optional] + * @param string|null $socket [optional] */ -function mysqli_connect (?string $hostname = null, ?string $username = null, ?string $password = null, ?string $database = null, ?int $port = null, ?string $socket = null): mysqli|false {} +function mysqli_connect (?string $hostname = NULL, ?string $username = NULL, ?string $password = NULL, ?string $database = NULL, ?int $port = NULL, ?string $socket = NULL): mysqli|false {} /** - * Returns the error code from last connect call - * @link http://www.php.net/manual/en/mysqli.connect-errno.php - * @return int An error code for the last connection attempt, if it failed. - * Zero means no error occurred. + * {@inheritdoc} */ function mysqli_connect_errno (): int {} /** - * Returns a description of the last connection error - * @link http://www.php.net/manual/en/mysqli.connect-error.php - * @return string|null A string that describes the error. null is returned if no error occurred. + * {@inheritdoc} */ function mysqli_connect_error (): ?string {} /** - * Adjusts the result pointer to an arbitrary row in the result - * @link http://www.php.net/manual/en/mysqli-result.data-seek.php - * @param mysqli_result $result - * @param int $offset - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mysqli_result $result + * @param int $offset */ function mysqli_data_seek (mysqli_result $result, int $offset): bool {} /** - * Dump debugging information into the log - * @link http://www.php.net/manual/en/mysqli.dump-debug-info.php - * @param mysqli $mysql - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mysqli $mysql */ function mysqli_dump_debug_info (mysqli $mysql): bool {} /** - * Performs debugging operations - * @link http://www.php.net/manual/en/mysqli.debug.php - * @param string $options - * @return true Always returns true. + * {@inheritdoc} + * @param string $options */ function mysqli_debug (string $options): true {} /** - * Returns the error code for the most recent function call - * @link http://www.php.net/manual/en/mysqli.errno.php - * @param mysqli $mysql - * @return int An error code value for the last call, if it failed. zero means no error - * occurred. + * {@inheritdoc} + * @param mysqli $mysql */ function mysqli_errno (mysqli $mysql): int {} /** - * Returns a string description of the last error - * @link http://www.php.net/manual/en/mysqli.error.php - * @param mysqli $mysql - * @return string A string that describes the error. An empty string if no error occurred. + * {@inheritdoc} + * @param mysqli $mysql */ function mysqli_error (mysqli $mysql): string {} /** - * Returns a list of errors from the last command executed - * @link http://www.php.net/manual/en/mysqli.error-list.php - * @param mysqli $mysql - * @return array A list of errors, each as an associative array - * containing the errno, error, and sqlstate. + * {@inheritdoc} + * @param mysqli $mysql */ function mysqli_error_list (mysqli $mysql): array {} /** - * Executes a prepared statement - * @link http://www.php.net/manual/en/mysqli-stmt.execute.php - * @param mysqli_stmt $statement - * @param array|null $params [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mysqli_stmt $statement + * @param array|null $params [optional] */ -function mysqli_stmt_execute (mysqli_stmt $statement, ?array $params = null): bool {} +function mysqli_stmt_execute (mysqli_stmt $statement, ?array $params = NULL): bool {} /** * {@inheritdoc} @@ -1517,563 +784,230 @@ function mysqli_stmt_execute (mysqli_stmt $statement, ?array $params = null): bo function mysqli_execute (mysqli_stmt $statement, ?array $params = NULL): bool {} /** - * Prepares, binds parameters, and executes SQL statement - * @link http://www.php.net/manual/en/mysqli.execute-query.php - * @param mysqli $mysql - * @param string $query - * @param array|null $params [optional] - * @return mysqli_result|bool Returns false on failure. For successful queries which produce a result - * set, such as SELECT, SHOW, DESCRIBE or - * EXPLAIN, returns - * a mysqli_result object. For other successful queries, - * returns true. - */ -function mysqli_execute_query (mysqli $mysql, string $query, ?array $params = null): mysqli_result|bool {} - -/** - * Returns the next field in the result set - * @link http://www.php.net/manual/en/mysqli-result.fetch-field.php - * @param mysqli_result $result - * @return object|false Returns an object which contains field definition information or false - * if no field information is available. - *Property | - *Description | - *
name | - *The name of the column | - *
orgname | - *Original column name if an alias was specified | - *
table | - *The name of the table this field belongs to (if not calculated) | - *
orgtable | - *Original table name if an alias was specified | - *
def | - *Reserved for default value, currently always "" | - *
db | - *The name of the database | - *
catalog | - *The catalog name, always "def" | - *
max_length | - *The maximum width of the field for the result set. | - *
length | - *The width of the field, as specified in the table definition. | - *
charsetnr | - *The character set number for the field. | - *
flags | - *An integer representing the bit-flags for the field. | - *
type | - *The data type used for this field | - *
decimals | - *The number of decimals used (for integer fields) | - *
Property | - *Description | - *
name | - *The name of the column | - *
orgname | - *Original column name if an alias was specified | - *
table | - *The name of the table this field belongs to (if not calculated) | - *
orgtable | - *Original table name if an alias was specified | - *
max_length | - *The maximum width of the field for the result set. As of PHP 8.1, this value is always 0. | - *
length | - *- * The width of the field, in bytes, as specified in the table definition. Note that - * this number (bytes) might differ from your table definition value (characters), depending on - * the character set you use. For example, the character set utf8 has 3 bytes per character, - * so varchar(10) will return a length of 30 for utf8 (10*3), but return 10 for latin1 (10*1). - * | - *
charsetnr | - *The character set number (id) for the field. | - *
flags | - *An integer representing the bit-flags for the field. | - *
type | - *The data type used for this field | - *
decimals | - *The number of decimals used (for integer fields) | - *
Attribute | - *Description | - *
name | - *The name of the column | - *
orgname | - *Original column name if an alias was specified | - *
table | - *The name of the table this field belongs to (if not calculated) | - *
orgtable | - *Original table name if an alias was specified | - *
def | - *The default value for this field, represented as a string | - *
max_length | - *The maximum width of the field for the result set. As of PHP 8.1, this value is always 0. | - *
length | - *The width of the field, as specified in the table definition. | - *
charsetnr | - *The character set number for the field. | - *
flags | - *An integer representing the bit-flags for the field. | - *
type | - *The data type used for this field | - *
decimals | - *The number of decimals used (for numeric fields) | - *
mysqli_fetch_lengths is valid only for the current - * row of the result set. It returns false if you call it before calling - * mysqli_fetch_row/array/object or after retrieving all rows in the result.
+ * {@inheritdoc} + * @param mysqli_result $result */ function mysqli_fetch_lengths (mysqli_result $result): array|false {} /** - * Fetch all result rows as an associative array, a numeric array, or both - * @link http://www.php.net/manual/en/mysqli-result.fetch-all.php - * @param mysqli_result $result - * @param int $mode [optional] - * @return array Returns an array of associative or numeric arrays holding result rows. + * {@inheritdoc} + * @param mysqli_result $result + * @param int $mode [optional] */ -function mysqli_fetch_all (mysqli_result $result, int $mode = MYSQLI_NUM): array {} +function mysqli_fetch_all (mysqli_result $result, int $mode = 2): array {} /** - * Fetch the next row of a result set as an associative, a numeric array, or both - * @link http://www.php.net/manual/en/mysqli-result.fetch-array.php - * @param mysqli_result $result - * @param int $mode [optional] - * @return array|null|false Returns an array representing the fetched row, null if there - * are no more rows in the result set, or false on failure. + * {@inheritdoc} + * @param mysqli_result $result + * @param int $mode [optional] */ -function mysqli_fetch_array (mysqli_result $result, int $mode = MYSQLI_BOTH): array|null|false {} +function mysqli_fetch_array (mysqli_result $result, int $mode = 3): array|false|null {} /** - * Fetch the next row of a result set as an associative array - * @link http://www.php.net/manual/en/mysqli-result.fetch-assoc.php - * @param mysqli_result $result - * @return array|null|false Returns an associative array representing the fetched row, - * where each key in the array represents the name of one of the result - * set's columns, null if there - * are no more rows in the result set, or false on failure. + * {@inheritdoc} + * @param mysqli_result $result */ -function mysqli_fetch_assoc (mysqli_result $result): array|null|false {} +function mysqli_fetch_assoc (mysqli_result $result): array|false|null {} /** - * Fetch the next row of a result set as an object - * @link http://www.php.net/manual/en/mysqli-result.fetch-object.php - * @param mysqli_result $result - * @param string $class [optional] - * @param array $constructor_args [optional] - * @return object|null|false Returns an object representing the fetched row, where each property - * represents the name of the result set's column, null if there - * are no more rows in the result set, or false on failure. + * {@inheritdoc} + * @param mysqli_result $result + * @param string $class [optional] + * @param array $constructor_args [optional] */ -function mysqli_fetch_object (mysqli_result $result, string $class = '"stdClass"', array $constructor_args = '[]'): object|null|false {} +function mysqli_fetch_object (mysqli_result $result, string $class = 'stdClass', array $constructor_args = array ( +)): object|false|null {} /** - * Fetch the next row of a result set as an enumerated array - * @link http://www.php.net/manual/en/mysqli-result.fetch-row.php - * @param mysqli_result $result - * @return array|null|false Returns an enumerated array representing the fetched row, null if there - * are no more rows in the result set, or false on failure. + * {@inheritdoc} + * @param mysqli_result $result */ -function mysqli_fetch_row (mysqli_result $result): array|null|false {} +function mysqli_fetch_row (mysqli_result $result): array|false|null {} /** - * Fetch a single column from the next row of a result set - * @link http://www.php.net/manual/en/mysqli-result.fetch-column.php - * @param mysqli_result $result - * @param int $column [optional] - * @return null|int|float|string|false Returns a single column - * from the next row of a result set or false if there are no more rows. - *There is no way to return another column from the same row if you - * use this function to retrieve data.
+ * {@inheritdoc} + * @param mysqli_result $result + * @param int $column [optional] */ -function mysqli_fetch_column (mysqli_result $result, int $column = null): null|int|float|string|false {} +function mysqli_fetch_column (mysqli_result $result, int $column = 0): string|int|float|false|null {} /** - * Returns the number of columns for the most recent query - * @link http://www.php.net/manual/en/mysqli.field-count.php - * @param mysqli $mysql - * @return int An integer representing the number of fields in a result set. + * {@inheritdoc} + * @param mysqli $mysql */ function mysqli_field_count (mysqli $mysql): int {} /** - * Set result pointer to a specified field offset - * @link http://www.php.net/manual/en/mysqli-result.field-seek.php - * @param mysqli_result $result - * @param int $index - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mysqli_result $result + * @param int $index */ -function mysqli_field_seek (mysqli_result $result, int $index): bool {} +function mysqli_field_seek (mysqli_result $result, int $index): true {} /** - * Get current field offset of a result pointer - * @link http://www.php.net/manual/en/mysqli-result.current-field.php - * @param mysqli_result $result - * @return int Returns current offset of field cursor. + * {@inheritdoc} + * @param mysqli_result $result */ function mysqli_field_tell (mysqli_result $result): int {} /** - * Frees the memory associated with a result - * @link http://www.php.net/manual/en/mysqli-result.free.php - * @param mysqli_result $result - * @return void No value is returned. + * {@inheritdoc} + * @param mysqli_result $result */ function mysqli_free_result (mysqli_result $result): void {} /** - * Returns statistics about the client connection - * @link http://www.php.net/manual/en/mysqli.get-connection-stats.php - * @param mysqli $mysql Procedural style only: A mysqli object - * returned by mysqli_connect or mysqli_init - * @return array Returns an array with connection stats. + * {@inheritdoc} + * @param mysqli $mysql */ function mysqli_get_connection_stats (mysqli $mysql): array {} /** - * Returns client per-process statistics - * @link http://www.php.net/manual/en/function.mysqli-get-client-stats.php - * @return array Returns an array with client stats. + * {@inheritdoc} */ function mysqli_get_client_stats (): array {} /** - * Returns a character set object - * @link http://www.php.net/manual/en/mysqli.get-charset.php - * @param mysqli $mysql - * @return object|null The function returns a character set object with the following properties: - *
- * charset
- *
Character set name
- * collation - *Collation name
- * dir - *Directory the charset description was fetched from (?) or "" for built-in character sets
- * min_length - *Minimum character length in bytes
- * max_length - *Maximum character length in bytes
- * number - *Internal character set number
- * state - *Character set status (?)
- * - *Character set name
- *Collation name
- *Directory the charset description was fetched from (?) or "" for built-in character sets
- *Minimum character length in bytes
- *Maximum character length in bytes
- *Internal character set number
- *Character set status (?)
+ * {@inheritdoc} + * @param mysqli $mysql */ function mysqli_get_charset (mysqli $mysql): ?object {} /** - * Get MySQL client info - * @link http://www.php.net/manual/en/mysqli.get-client-info.php - * @param mysqli|null $mysql [optional] - * @return string A string that represents the MySQL client library version. + * {@inheritdoc} + * @param mysqli|null $mysql [optional] */ -function mysqli_get_client_info (?mysqli $mysql = null): string {} +function mysqli_get_client_info (?mysqli $mysql = NULL): string {} /** - * Returns the MySQL client version as an integer - * @link http://www.php.net/manual/en/mysqli.get-client-version.php - * @return int A number that represents the MySQL client library version in format: - * main_version*10000 + minor_version *100 + sub_version. - * For example, 4.1.0 is returned as 40100. - *This is useful to quickly determine the version of the client library - * to know if some capability exists.
+ * {@inheritdoc} */ function mysqli_get_client_version (): int {} /** - * Return information about open and cached links - * @link http://www.php.net/manual/en/function.mysqli-get-links-stats.php - * @return array mysqli_get_links_stats returns an associative array - * with three elements, keyed as follows: - *
- * total
- *
- *
- * An int indicating the total number of open links in - * any state. - *
- * active_plinks - *- * An int representing the number of active persistent - * connections. - *
- * cached_plinks - *- * An int representing the number of inactive persistent - * connections. - *
- * - *An int indicating the total number of open links in - * any state.
- *An int representing the number of active persistent - * connections.
- *An int representing the number of inactive persistent - * connections.
+ * {@inheritdoc} */ function mysqli_get_links_stats (): array {} /** - * Returns a string representing the type of connection used - * @link http://www.php.net/manual/en/mysqli.get-host-info.php - * @param mysqli $mysql - * @return string A character string representing the server hostname and the connection type. + * {@inheritdoc} + * @param mysqli $mysql */ function mysqli_get_host_info (mysqli $mysql): string {} /** - * Returns the version of the MySQL protocol used - * @link http://www.php.net/manual/en/mysqli.get-proto-info.php - * @param mysqli $mysql - * @return int Returns an integer representing the protocol version. + * {@inheritdoc} + * @param mysqli $mysql */ function mysqli_get_proto_info (mysqli $mysql): int {} /** - * Returns the version of the MySQL server - * @link http://www.php.net/manual/en/mysqli.get-server-info.php - * @param mysqli $mysql - * @return string A character string representing the server version. + * {@inheritdoc} + * @param mysqli $mysql */ function mysqli_get_server_info (mysqli $mysql): string {} /** - * Returns the version of the MySQL server as an integer - * @link http://www.php.net/manual/en/mysqli.get-server-version.php - * @param mysqli $mysql - * @return int An integer representing the server version. - *The form of this version number is - * main_version * 10000 + minor_version * 100 + sub_version - * (i.e. version 4.1.0 is 40100).
+ * {@inheritdoc} + * @param mysqli $mysql */ function mysqli_get_server_version (mysqli $mysql): int {} /** - * Get result of SHOW WARNINGS - * @link http://www.php.net/manual/en/mysqli.get-warnings.php - * @param mysqli $mysql - * @return mysqli_warning|false + * {@inheritdoc} + * @param mysqli $mysql */ function mysqli_get_warnings (mysqli $mysql): mysqli_warning|false {} /** - * Initializes MySQLi and returns an object for use with mysqli_real_connect() - * @link http://www.php.net/manual/en/mysqli.init.php - * @return mysqli|false mysqli::init returns null on success, or false on failure. - * mysqli_init returns an object on success, or false on failure. + * {@inheritdoc} */ function mysqli_init (): mysqli|false {} /** - * Retrieves information about the most recently executed query - * @link http://www.php.net/manual/en/mysqli.info.php - * @param mysqli $mysql - * @return string|null A character string representing additional information about the most recently executed query. + * {@inheritdoc} + * @param mysqli $mysql */ function mysqli_info (mysqli $mysql): ?string {} /** - * Returns the value generated for an AUTO_INCREMENT column by the last query - * @link http://www.php.net/manual/en/mysqli.insert-id.php - * @param mysqli $mysql - * @return int|string The value of the AUTO_INCREMENT field that was updated - * by the previous query. Returns zero if there was no previous query on the - * connection or if the query did not update an AUTO_INCREMENT - * value. - *Only statements issued using the current connection affect the return value. The - * value is not affected by statements issued using other connections or clients.
- *If the number is greater than the maximum int value, it will be returned as - * a string.
+ * {@inheritdoc} + * @param mysqli $mysql */ -function mysqli_insert_id (mysqli $mysql): int|string {} +function mysqli_insert_id (mysqli $mysql): string|int {} /** - * Asks the server to kill a MySQL thread - * @link http://www.php.net/manual/en/mysqli.kill.php - * @param mysqli $mysql - * @param int $process_id - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mysqli $mysql + * @param int $process_id */ function mysqli_kill (mysqli $mysql, int $process_id): bool {} /** - * Check if there are any more query results from a multi query - * @link http://www.php.net/manual/en/mysqli.more-results.php - * @param mysqli $mysql - * @return bool Returns true if one or more result sets (including errors) are available from a previous call to - * mysqli_multi_query, otherwise false. + * {@inheritdoc} + * @param mysqli $mysql */ function mysqli_more_results (mysqli $mysql): bool {} /** - * Performs one or more queries on the database - * @link http://www.php.net/manual/en/mysqli.multi-query.php - * @param mysqli $mysql - * @param string $query - * @return bool Returns false if the first statement failed. - * To retrieve subsequent errors from other statements you have to call - * mysqli_next_result first. + * {@inheritdoc} + * @param mysqli $mysql + * @param string $query */ function mysqli_multi_query (mysqli $mysql, string $query): bool {} /** - * Prepare next result from multi_query - * @link http://www.php.net/manual/en/mysqli.next-result.php - * @param mysqli $mysql - * @return bool Returns true on success or false on failure. Also returns false if the next statement resulted in an error, unlike mysqli_more_results. + * {@inheritdoc} + * @param mysqli $mysql */ function mysqli_next_result (mysqli $mysql): bool {} /** - * Gets the number of fields in the result set - * @link http://www.php.net/manual/en/mysqli-result.field-count.php - * @param mysqli_result $result - * @return int An int representing the number of fields. + * {@inheritdoc} + * @param mysqli_result $result */ function mysqli_num_fields (mysqli_result $result): int {} /** - * Gets the number of rows in the result set - * @link http://www.php.net/manual/en/mysqli-result.num-rows.php - * @param mysqli_result $result - * @return int|string An int representing the number of fetched rows. - * Returns 0 in unbuffered mode unless all rows have been - * fetched from the server. - *If the number of rows is greater than PHP_INT_MAX, - * the number will be returned as a string.
+ * {@inheritdoc} + * @param mysqli_result $result */ -function mysqli_num_rows (mysqli_result $result): int|string {} +function mysqli_num_rows (mysqli_result $result): string|int {} /** - * Set options - * @link http://www.php.net/manual/en/mysqli.options.php - * @param mysqli $mysql - * @param int $option - * @param string|int $value - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mysqli $mysql + * @param int $option + * @param mixed $value */ -function mysqli_options (mysqli $mysql, int $option, string|int $value): bool {} +function mysqli_options (mysqli $mysql, int $option, $value = null): bool {} /** * {@inheritdoc} @@ -2084,78 +1018,59 @@ function mysqli_options (mysqli $mysql, int $option, string|int $value): bool {} function mysqli_set_opt (mysqli $mysql, int $option, $value = null): bool {} /** - * Pings a server connection, or tries to reconnect if the connection has gone down - * @link http://www.php.net/manual/en/mysqli.ping.php - * @param mysqli $mysql - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mysqli $mysql */ function mysqli_ping (mysqli $mysql): bool {} /** - * Poll connections - * @link http://www.php.net/manual/en/mysqli.poll.php - * @param array|null $read - * @param array|null $error - * @param array $reject - * @param int $seconds - * @param int $microseconds [optional] - * @return int|false Returns number of ready connections upon success, false otherwise. + * {@inheritdoc} + * @param array|null $read + * @param array|null $error + * @param array $reject + * @param int $seconds + * @param int $microseconds [optional] */ -function mysqli_poll (?array &$read, ?array &$error, array &$reject, int $seconds, int $microseconds = null): int|false {} +function mysqli_poll (?array &$read = null, ?array &$error = null, array &$reject, int $seconds, int $microseconds = 0): int|false {} /** - * Prepares an SQL statement for execution - * @link http://www.php.net/manual/en/mysqli.prepare.php - * @param mysqli $mysql - * @param string $query - * @return mysqli_stmt|false mysqli_prepare returns a statement object or false if an error occurred. + * {@inheritdoc} + * @param mysqli $mysql + * @param string $query */ function mysqli_prepare (mysqli $mysql, string $query): mysqli_stmt|false {} /** - * Sets mysqli error reporting mode - * @link http://www.php.net/manual/en/mysqli-driver.report-mode.php - * @param int $flags - * @return bool Returns true. + * {@inheritdoc} + * @param int $flags */ function mysqli_report (int $flags): bool {} /** - * Performs a query on the database - * @link http://www.php.net/manual/en/mysqli.query.php - * @param mysqli $mysql - * @param string $query - * @param int $result_mode [optional] - * @return mysqli_result|bool Returns false on failure. For successful queries which produce a result - * set, such as SELECT, SHOW, DESCRIBE or - * EXPLAIN, mysqli_query will return - * a mysqli_result object. For other successful queries, - * mysqli_query will - * return true. + * {@inheritdoc} + * @param mysqli $mysql + * @param string $query + * @param int $result_mode [optional] */ -function mysqli_query (mysqli $mysql, string $query, int $result_mode = MYSQLI_STORE_RESULT): mysqli_result|bool {} +function mysqli_query (mysqli $mysql, string $query, int $result_mode = 0): mysqli_result|bool {} /** - * Opens a connection to a mysql server - * @link http://www.php.net/manual/en/mysqli.real-connect.php - * @param mysqli $mysql - * @param string|null $hostname [optional] - * @param string|null $username [optional] - * @param string|null $password [optional] - * @param string|null $database [optional] - * @param int|null $port [optional] - * @param string|null $socket [optional] - * @param int $flags [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mysqli $mysql + * @param string|null $hostname [optional] + * @param string|null $username [optional] + * @param string|null $password [optional] + * @param string|null $database [optional] + * @param int|null $port [optional] + * @param string|null $socket [optional] + * @param int $flags [optional] */ -function mysqli_real_connect (mysqli $mysql, ?string $hostname = null, ?string $username = null, ?string $password = null, ?string $database = null, ?int $port = null, ?string $socket = null, int $flags = null): bool {} +function mysqli_real_connect (mysqli $mysql, ?string $hostname = NULL, ?string $username = NULL, ?string $password = NULL, ?string $database = NULL, ?int $port = NULL, ?string $socket = NULL, int $flags = 0): bool {} /** - * Escapes special characters in a string for use in an SQL statement, taking into account the current charset of the connection - * @link http://www.php.net/manual/en/mysqli.real-escape-string.php - * @param mysqli $mysql - * @param string $string - * @return string Returns an escaped string. + * {@inheritdoc} + * @param mysqli $mysql + * @param string $string */ function mysqli_real_escape_string (mysqli $mysql, string $string): string {} @@ -2167,1051 +1082,399 @@ function mysqli_real_escape_string (mysqli $mysql, string $string): string {} function mysqli_escape_string (mysqli $mysql, string $string): string {} /** - * Execute an SQL query - * @link http://www.php.net/manual/en/mysqli.real-query.php - * @param mysqli $mysql - * @param string $query - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mysqli $mysql + * @param string $query */ function mysqli_real_query (mysqli $mysql, string $query): bool {} /** - * Get result from async query - * @link http://www.php.net/manual/en/mysqli.reap-async-query.php - * @param mysqli $mysql - * @return mysqli_result|bool Returns false on failure. For successful queries which produce a result set, such as SELECT, SHOW, DESCRIBE or - * EXPLAIN, mysqli_reap_async_query will return - * a mysqli_result object. For other successful queries, mysqli_reap_async_query will - * return true. + * {@inheritdoc} + * @param mysqli $mysql */ function mysqli_reap_async_query (mysqli $mysql): mysqli_result|bool {} /** - * Removes the named savepoint from the set of savepoints of the current transaction - * @link http://www.php.net/manual/en/mysqli.release-savepoint.php - * @param mysqli $mysql - * @param string $name - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mysqli $mysql + * @param string $name */ function mysqli_release_savepoint (mysqli $mysql, string $name): bool {} /** - * Rolls back current transaction - * @link http://www.php.net/manual/en/mysqli.rollback.php - * @param mysqli $mysql - * @param int $flags [optional] - * @param string|null $name [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mysqli $mysql + * @param int $flags [optional] + * @param string|null $name [optional] */ -function mysqli_rollback (mysqli $mysql, int $flags = null, ?string $name = null): bool {} +function mysqli_rollback (mysqli $mysql, int $flags = 0, ?string $name = NULL): bool {} /** - * Set a named transaction savepoint - * @link http://www.php.net/manual/en/mysqli.savepoint.php - * @param mysqli $mysql - * @param string $name - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mysqli $mysql + * @param string $name */ function mysqli_savepoint (mysqli $mysql, string $name): bool {} /** - * Selects the default database for database queries - * @link http://www.php.net/manual/en/mysqli.select-db.php - * @param mysqli $mysql - * @param string $database - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mysqli $mysql + * @param string $database */ function mysqli_select_db (mysqli $mysql, string $database): bool {} /** - * Sets the client character set - * @link http://www.php.net/manual/en/mysqli.set-charset.php - * @param mysqli $mysql - * @param string $charset - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mysqli $mysql + * @param string $charset */ function mysqli_set_charset (mysqli $mysql, string $charset): bool {} /** - * Returns the total number of rows changed, deleted, inserted, or - * matched by the last statement executed - * @link http://www.php.net/manual/en/mysqli-stmt.affected-rows.php - * @param mysqli_stmt $statement - * @return int|string An integer greater than zero indicates the number of rows affected or - * retrieved. Zero indicates that no records were updated for an - * UPDATE statement, no rows matched the - * WHERE clause in the query or that no query has yet been - * executed. -1 indicates that the query returned an error or - * that, for a SELECT query, - * mysqli_stmt_affected_rows was called prior to calling - * mysqli_stmt_store_result. - *If the number of affected rows is greater than maximum PHP int value, the - * number of affected rows will be returned as a string value.
+ * {@inheritdoc} + * @param mysqli_stmt $statement */ -function mysqli_stmt_affected_rows (mysqli_stmt $statement): int|string {} +function mysqli_stmt_affected_rows (mysqli_stmt $statement): string|int {} /** - * Used to get the current value of a statement attribute - * @link http://www.php.net/manual/en/mysqli-stmt.attr-get.php - * @param mysqli_stmt $statement - * @param int $attribute - * @return int Returns the value of the attribute. + * {@inheritdoc} + * @param mysqli_stmt $statement + * @param int $attribute */ function mysqli_stmt_attr_get (mysqli_stmt $statement, int $attribute): int {} /** - * Used to modify the behavior of a prepared statement - * @link http://www.php.net/manual/en/mysqli-stmt.attr-set.php - * @param mysqli_stmt $statement - * @param int $attribute - * @param int $value - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mysqli_stmt $statement + * @param int $attribute + * @param int $value */ function mysqli_stmt_attr_set (mysqli_stmt $statement, int $attribute, int $value): bool {} /** - * Binds variables to a prepared statement as parameters - * @link http://www.php.net/manual/en/mysqli-stmt.bind-param.php - * @param mysqli_stmt $statement - * @param string $types - * @param mixed $var - * @param mixed $vars - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mysqli_stmt $statement + * @param string $types + * @param mixed $vars [optional] */ -function mysqli_stmt_bind_param (mysqli_stmt $statement, string $types, mixed &$var, mixed &...$vars): bool {} +function mysqli_stmt_bind_param (mysqli_stmt $statement, string $types, mixed &...$vars): bool {} /** - * Binds variables to a prepared statement for result storage - * @link http://www.php.net/manual/en/mysqli-stmt.bind-result.php - * @param mysqli_stmt $statement - * @param mixed $var - * @param mixed $vars - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mysqli_stmt $statement + * @param mixed $vars [optional] */ -function mysqli_stmt_bind_result (mysqli_stmt $statement, mixed &$var, mixed &...$vars): bool {} +function mysqli_stmt_bind_result (mysqli_stmt $statement, mixed &...$vars): bool {} /** - * Closes a prepared statement - * @link http://www.php.net/manual/en/mysqli-stmt.close.php - * @param mysqli_stmt $statement - * @return true Always returns true. + * {@inheritdoc} + * @param mysqli_stmt $statement */ function mysqli_stmt_close (mysqli_stmt $statement): true {} /** - * Adjusts the result pointer to an arbitrary row in the buffered result - * @link http://www.php.net/manual/en/mysqli-stmt.data-seek.php - * @param mysqli_stmt $statement - * @param int $offset - * @return void No value is returned. + * {@inheritdoc} + * @param mysqli_stmt $statement + * @param int $offset */ function mysqli_stmt_data_seek (mysqli_stmt $statement, int $offset): void {} /** - * Returns the error code for the most recent statement call - * @link http://www.php.net/manual/en/mysqli-stmt.errno.php - * @param mysqli_stmt $statement - * @return int An error code value. Zero means no error occurred. + * {@inheritdoc} + * @param mysqli_stmt $statement */ function mysqli_stmt_errno (mysqli_stmt $statement): int {} /** - * Returns a string description for last statement error - * @link http://www.php.net/manual/en/mysqli-stmt.error.php - * @param mysqli_stmt $statement - * @return string A string that describes the error. An empty string if no error occurred. + * {@inheritdoc} + * @param mysqli_stmt $statement */ function mysqli_stmt_error (mysqli_stmt $statement): string {} /** - * Returns a list of errors from the last statement executed - * @link http://www.php.net/manual/en/mysqli-stmt.error-list.php - * @param mysqli_stmt $statement - * @return array A list of errors, each as an associative array - * containing the errno, error, and sqlstate. + * {@inheritdoc} + * @param mysqli_stmt $statement */ function mysqli_stmt_error_list (mysqli_stmt $statement): array {} /** - * Fetch results from a prepared statement into the bound variables - * @link http://www.php.net/manual/en/mysqli-stmt.fetch.php - * @param mysqli_stmt $statement - * @return bool|null + * {@inheritdoc} + * @param mysqli_stmt $statement */ function mysqli_stmt_fetch (mysqli_stmt $statement): ?bool {} /** - * Returns the number of columns in the given statement - * @link http://www.php.net/manual/en/mysqli-stmt.field-count.php - * @param mysqli_stmt $statement - * @return int Returns an integer representing the number of columns. + * {@inheritdoc} + * @param mysqli_stmt $statement */ function mysqli_stmt_field_count (mysqli_stmt $statement): int {} /** - * Frees stored result memory for the given statement handle - * @link http://www.php.net/manual/en/mysqli-stmt.free-result.php - * @param mysqli_stmt $statement - * @return void No value is returned. + * {@inheritdoc} + * @param mysqli_stmt $statement */ function mysqli_stmt_free_result (mysqli_stmt $statement): void {} /** - * Gets a result set from a prepared statement as a mysqli_result object - * @link http://www.php.net/manual/en/mysqli-stmt.get-result.php - * @param mysqli_stmt $statement - * @return mysqli_result|false Returns false on failure. For successful queries which produce a result set, such as SELECT, SHOW, DESCRIBE or - * EXPLAIN, mysqli_stmt_get_result will return - * a mysqli_result object. For other successful queries, mysqli_stmt_get_result will - * return false. The mysqli_stmt_errno function can be - * used to distinguish between the two reasons for false; due to a bug, prior to PHP 7.4.13, - * mysqli_errno had to be used for this purpose. + * {@inheritdoc} + * @param mysqli_stmt $statement */ function mysqli_stmt_get_result (mysqli_stmt $statement): mysqli_result|false {} /** - * Get result of SHOW WARNINGS - * @link http://www.php.net/manual/en/mysqli-stmt.get-warnings.php - * @param mysqli_stmt $statement - * @return mysqli_warning|false + * {@inheritdoc} + * @param mysqli_stmt $statement */ function mysqli_stmt_get_warnings (mysqli_stmt $statement): mysqli_warning|false {} /** - * Initializes a statement and returns an object for use with mysqli_stmt_prepare - * @link http://www.php.net/manual/en/mysqli.stmt-init.php - * @param mysqli $mysql - * @return mysqli_stmt|false Returns an object. + * {@inheritdoc} + * @param mysqli $mysql */ function mysqli_stmt_init (mysqli $mysql): mysqli_stmt|false {} /** - * Get the ID generated from the previous INSERT operation - * @link http://www.php.net/manual/en/mysqli-stmt.insert-id.php - * @param mysqli_stmt $statement - * @return int|string + * {@inheritdoc} + * @param mysqli_stmt $statement */ -function mysqli_stmt_insert_id (mysqli_stmt $statement): int|string {} +function mysqli_stmt_insert_id (mysqli_stmt $statement): string|int {} /** - * Check if there are more query results from a multiple query - * @link http://www.php.net/manual/en/mysqli-stmt.more-results.php - * @param mysqli_stmt $statement - * @return bool Returns true if more results exist, otherwise false. + * {@inheritdoc} + * @param mysqli_stmt $statement */ function mysqli_stmt_more_results (mysqli_stmt $statement): bool {} /** - * Reads the next result from a multiple query - * @link http://www.php.net/manual/en/mysqli-stmt.next-result.php - * @param mysqli_stmt $statement - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mysqli_stmt $statement */ function mysqli_stmt_next_result (mysqli_stmt $statement): bool {} /** - * Returns the number of rows fetched from the server - * @link http://www.php.net/manual/en/mysqli-stmt.num-rows.php - * @param mysqli_stmt $statement - * @return int|string An int representing the number of buffered rows. - * Returns 0 in unbuffered mode unless all rows have been - * fetched from the server. - *If the number of rows is greater than PHP_INT_MAX, - * the number will be returned as a string.
+ * {@inheritdoc} + * @param mysqli_stmt $statement */ -function mysqli_stmt_num_rows (mysqli_stmt $statement): int|string {} +function mysqli_stmt_num_rows (mysqli_stmt $statement): string|int {} /** - * Returns the number of parameters for the given statement - * @link http://www.php.net/manual/en/mysqli-stmt.param-count.php - * @param mysqli_stmt $statement - * @return int Returns an integer representing the number of parameters. + * {@inheritdoc} + * @param mysqli_stmt $statement */ function mysqli_stmt_param_count (mysqli_stmt $statement): int {} /** - * Prepares an SQL statement for execution - * @link http://www.php.net/manual/en/mysqli-stmt.prepare.php - * @param mysqli_stmt $statement - * @param string $query - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mysqli_stmt $statement + * @param string $query */ function mysqli_stmt_prepare (mysqli_stmt $statement, string $query): bool {} /** - * Resets a prepared statement - * @link http://www.php.net/manual/en/mysqli-stmt.reset.php - * @param mysqli_stmt $statement - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mysqli_stmt $statement */ function mysqli_stmt_reset (mysqli_stmt $statement): bool {} /** - * Returns result set metadata from a prepared statement - * @link http://www.php.net/manual/en/mysqli-stmt.result-metadata.php - * @param mysqli_stmt $statement - * @return mysqli_result|false Returns a result object or false if an error occurred. + * {@inheritdoc} + * @param mysqli_stmt $statement */ function mysqli_stmt_result_metadata (mysqli_stmt $statement): mysqli_result|false {} /** - * Send data in blocks - * @link http://www.php.net/manual/en/mysqli-stmt.send-long-data.php - * @param mysqli_stmt $statement - * @param int $param_num - * @param string $data - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mysqli_stmt $statement + * @param int $param_num + * @param string $data */ function mysqli_stmt_send_long_data (mysqli_stmt $statement, int $param_num, string $data): bool {} /** - * Stores a result set in an internal buffer - * @link http://www.php.net/manual/en/mysqli-stmt.store-result.php - * @param mysqli_stmt $statement - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mysqli_stmt $statement */ function mysqli_stmt_store_result (mysqli_stmt $statement): bool {} /** - * Returns SQLSTATE error from previous statement operation - * @link http://www.php.net/manual/en/mysqli-stmt.sqlstate.php - * @param mysqli_stmt $statement - * @return string Returns a string containing the SQLSTATE error code for the last error. - * The error code consists of five characters. '00000' means no error. + * {@inheritdoc} + * @param mysqli_stmt $statement */ function mysqli_stmt_sqlstate (mysqli_stmt $statement): string {} /** - * Returns the SQLSTATE error from previous MySQL operation - * @link http://www.php.net/manual/en/mysqli.sqlstate.php - * @param mysqli $mysql - * @return string Returns a string containing the SQLSTATE error code for the last error. - * The error code consists of five characters. '00000' means no error. + * {@inheritdoc} + * @param mysqli $mysql */ function mysqli_sqlstate (mysqli $mysql): string {} /** - * Used for establishing secure connections using SSL - * @link http://www.php.net/manual/en/mysqli.ssl-set.php - * @param mysqli $mysql - * @param string|null $key - * @param string|null $certificate - * @param string|null $ca_certificate - * @param string|null $ca_path - * @param string|null $cipher_algos - * @return true Always returns true. If SSL setup is - * incorrect mysqli_real_connect will return an error - * when you attempt to connect. + * {@inheritdoc} + * @param mysqli $mysql + * @param string|null $key + * @param string|null $certificate + * @param string|null $ca_certificate + * @param string|null $ca_path + * @param string|null $cipher_algos */ -function mysqli_ssl_set (mysqli $mysql, ?string $key, ?string $certificate, ?string $ca_certificate, ?string $ca_path, ?string $cipher_algos): true {} +function mysqli_ssl_set (mysqli $mysql, ?string $key = null, ?string $certificate = null, ?string $ca_certificate = null, ?string $ca_path = null, ?string $cipher_algos = null): true {} /** - * Gets the current system status - * @link http://www.php.net/manual/en/mysqli.stat.php - * @param mysqli $mysql - * @return string|false A string describing the server status. false if an error occurred. + * {@inheritdoc} + * @param mysqli $mysql */ function mysqli_stat (mysqli $mysql): string|false {} /** - * Transfers a result set from the last query - * @link http://www.php.net/manual/en/mysqli.store-result.php - * @param mysqli $mysql - * @param int $mode [optional] - * @return mysqli_result|false Returns a buffered result object or false if an error occurred. - *mysqli_store_result returns false in case the query - * didn't return a result set (if the query was, for example an INSERT - * statement). This function also returns false if the reading of the - * result set failed. You can check if you have got an error by checking - * if mysqli_error doesn't return an empty string, if - * mysqli_errno returns a non zero value, or if - * mysqli_field_count returns a non zero value. - * Also possible reason for this function returning false after - * successful call to mysqli_query can be too large - * result set (memory for it cannot be allocated). If - * mysqli_field_count returns a non-zero value, the - * statement should have produced a non-empty result set.
- */ -function mysqli_store_result (mysqli $mysql, int $mode = null): mysqli_result|false {} - -/** - * Returns the thread ID for the current connection - * @link http://www.php.net/manual/en/mysqli.thread-id.php - * @param mysqli $mysql - * @return int Returns the Thread ID for the current connection. + * {@inheritdoc} + * @param mysqli $mysql + * @param int $mode [optional] + */ +function mysqli_store_result (mysqli $mysql, int $mode = 0): mysqli_result|false {} + +/** + * {@inheritdoc} + * @param mysqli $mysql */ function mysqli_thread_id (mysqli $mysql): int {} /** - * Returns whether thread safety is given or not - * @link http://www.php.net/manual/en/mysqli.thread-safe.php - * @return bool true if the client library is thread-safe, otherwise false. + * {@inheritdoc} */ function mysqli_thread_safe (): bool {} /** - * Initiate a result set retrieval - * @link http://www.php.net/manual/en/mysqli.use-result.php - * @param mysqli $mysql - * @return mysqli_result|false Returns an unbuffered result object or false if an error occurred. + * {@inheritdoc} + * @param mysqli $mysql */ function mysqli_use_result (mysqli $mysql): mysqli_result|false {} /** - * Returns the number of warnings from the last query for the given link - * @link http://www.php.net/manual/en/mysqli.warning-count.php - * @param mysqli $mysql - * @return int Number of warnings or zero if there are no warnings. + * {@inheritdoc} + * @param mysqli $mysql */ function mysqli_warning_count (mysqli $mysql): int {} /** - * Refreshes - * @link http://www.php.net/manual/en/mysqli.refresh.php - * @param mysqli $mysql - * @param int $flags - * @return bool true if the refresh was a success, otherwise false + * {@inheritdoc} + * @param mysqli $mysql + * @param int $flags */ function mysqli_refresh (mysqli $mysql, int $flags): bool {} - -/** - * Read options from the named group from my.cnf - * or the file specified with MYSQLI_READ_DEFAULT_FILE - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_READ_DEFAULT_GROUP', 5); - -/** - * Read options from the named option file instead of from my.cnf - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_READ_DEFAULT_FILE', 4); - -/** - * Connect timeout in seconds - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_OPT_CONNECT_TIMEOUT', 0); - -/** - * Enables command LOAD LOCAL INFILE - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_OPT_LOCAL_INFILE', 8); define ('MYSQLI_OPT_LOAD_DATA_LOCAL_DIR', 43); - -/** - * Command to execute when connecting to MySQL server. Will automatically be re-executed when reconnecting. - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_INIT_COMMAND', 3); - -/** - * Command execution result timeout in seconds. Available as of PHP 7.2.0. - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_OPT_READ_TIMEOUT', 11); - -/** - * The size of the internal command/network buffer. Only valid for mysqlnd. - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_OPT_NET_CMD_BUFFER_SIZE', 202); - -/** - * Maximum read chunk size in bytes when reading the body of a MySQL command packet. - * Only valid for mysqlnd. - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_OPT_NET_READ_BUFFER_SIZE', 203); - -/** - * Convert integer and float columns back to PHP numbers. Only valid for mysqlnd. - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_OPT_INT_AND_FLOAT_NATIVE', 201); - -/** - * Requires MySQL 5.1.10 and up - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_OPT_SSL_VERIFY_SERVER_CERT', 21); - -/** - * - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_SERVER_PUBLIC_KEY', 35); - -/** - * Use SSL (encrypted protocol). This option should not be set by application programs; - * it is set internally in the MySQL client library - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_CLIENT_SSL', 2048); - -/** - * Use compression protocol - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_CLIENT_COMPRESS', 32); - -/** - * Allow interactive_timeout seconds - * (instead of wait_timeout seconds) of inactivity before - * closing the connection. The client's session - * wait_timeout variable will be set to - * the value of the session interactive_timeout variable. - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_CLIENT_INTERACTIVE', 1024); - -/** - * Allow spaces after function names. Makes all functions names reserved words. - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_CLIENT_IGNORE_SPACE', 256); - -/** - * Don't allow the db_name.tbl_name.col_name syntax. - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_CLIENT_NO_SCHEMA', 16); define ('MYSQLI_CLIENT_FOUND_ROWS', 2); define ('MYSQLI_CLIENT_SSL_VERIFY_SERVER_CERT', 1073741824); - -/** - * Requires MySQL 5.6.5 and up. - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_CLIENT_SSL_DONT_VERIFY_SERVER_CERT', 64); define ('MYSQLI_CLIENT_CAN_HANDLE_EXPIRED_PASSWORDS', 4194304); define ('MYSQLI_OPT_CAN_HANDLE_EXPIRED_PASSWORDS', 37); - -/** - * For using buffered result sets. It has a value of 0. - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_STORE_RESULT', 0); - -/** - * For using unbuffered result sets. It has a value of 1. - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_USE_RESULT', 1); define ('MYSQLI_ASYNC', 8); define ('MYSQLI_STORE_RESULT_COPY_DATA', 16); - -/** - * Columns are returned into the array having the fieldname as the array index. - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_ASSOC', 1); - -/** - * Columns are returned into the array having an enumerated index. - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_NUM', 2); - -/** - * Columns are returned into the array having both a numerical index and the fieldname as the associative index. - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_BOTH', 3); - -/** - * - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_STMT_ATTR_UPDATE_MAX_LENGTH', 0); - -/** - * - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_STMT_ATTR_CURSOR_TYPE', 1); - -/** - * - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_CURSOR_TYPE_NO_CURSOR', 0); - -/** - * - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_CURSOR_TYPE_READ_ONLY', 1); - -/** - * - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_CURSOR_TYPE_FOR_UPDATE', 2); - -/** - * - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_CURSOR_TYPE_SCROLLABLE', 4); - -/** - * - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_STMT_ATTR_PREFETCH_ROWS', 2); - -/** - * Indicates that a field is defined as NOT NULL - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_NOT_NULL_FLAG', 1); - -/** - * Field is part of a primary index - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_PRI_KEY_FLAG', 2); - -/** - * Field is part of a unique index. - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_UNIQUE_KEY_FLAG', 4); - -/** - * Field is part of an index. - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_MULTIPLE_KEY_FLAG', 8); - -/** - * Field is defined as BLOB - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_BLOB_FLAG', 16); - -/** - * Field is defined as UNSIGNED - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_UNSIGNED_FLAG', 32); - -/** - * Field is defined as ZEROFILL - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_ZEROFILL_FLAG', 64); - -/** - * Field is defined as AUTO_INCREMENT - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_AUTO_INCREMENT_FLAG', 512); - -/** - * Field is defined as TIMESTAMP - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_TIMESTAMP_FLAG', 1024); - -/** - * Field is defined as SET - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_SET_FLAG', 2048); - -/** - * Field is defined as NUMERIC - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_NUM_FLAG', 32768); - -/** - * Field is part of an multi-index - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_PART_KEY_FLAG', 16384); - -/** - * Field is part of GROUP BY - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_GROUP_FLAG', 32768); - -/** - * Field is defined as ENUM. - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_ENUM_FLAG', 256); - -/** - * Field is defined as BINARY. - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_BINARY_FLAG', 128); define ('MYSQLI_NO_DEFAULT_VALUE_FLAG', 4096); define ('MYSQLI_ON_UPDATE_NOW_FLAG', 8192); - -/** - * Field is defined as DECIMAL - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_TYPE_DECIMAL', 0); - -/** - * Field is defined as TINYINT - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_TYPE_TINY', 1); - -/** - * Field is defined as SMALLINT - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_TYPE_SHORT', 2); - -/** - * Field is defined as INT - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_TYPE_LONG', 3); - -/** - * Field is defined as FLOAT - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_TYPE_FLOAT', 4); - -/** - * Field is defined as DOUBLE - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_TYPE_DOUBLE', 5); - -/** - * Field is defined as DEFAULT NULL - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_TYPE_NULL', 6); - -/** - * Field is defined as TIMESTAMP - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_TYPE_TIMESTAMP', 7); - -/** - * Field is defined as BIGINT - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_TYPE_LONGLONG', 8); - -/** - * Field is defined as MEDIUMINT - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_TYPE_INT24', 9); - -/** - * Field is defined as DATE - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_TYPE_DATE', 10); - -/** - * Field is defined as TIME - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_TYPE_TIME', 11); - -/** - * Field is defined as DATETIME - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_TYPE_DATETIME', 12); - -/** - * Field is defined as YEAR - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_TYPE_YEAR', 13); - -/** - * Field is defined as DATE - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_TYPE_NEWDATE', 14); - -/** - * Field is defined as ENUM - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_TYPE_ENUM', 247); - -/** - * Field is defined as SET - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_TYPE_SET', 248); - -/** - * Field is defined as TINYBLOB - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_TYPE_TINY_BLOB', 249); - -/** - * Field is defined as MEDIUMBLOB - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_TYPE_MEDIUM_BLOB', 250); - -/** - * Field is defined as LONGBLOB - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_TYPE_LONG_BLOB', 251); - -/** - * Field is defined as BLOB - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_TYPE_BLOB', 252); - -/** - * Field is defined as VARCHAR - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_TYPE_VAR_STRING', 253); - -/** - * Field is defined as CHAR or BINARY - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_TYPE_STRING', 254); - -/** - * Field is defined as TINYINT. - * For CHAR, see MYSQLI_TYPE_STRING - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_TYPE_CHAR', 1); - -/** - * Field is defined as INTERVAL - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_TYPE_INTERVAL', 247); - -/** - * Field is defined as GEOMETRY - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_TYPE_GEOMETRY', 255); - -/** - * Field is defined as JSON. - * Only valid for mysqlnd and MySQL 5.7.8 and up. - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_TYPE_JSON', 245); - -/** - * Precision math DECIMAL or NUMERIC field (MySQL 5.0.3 and up) - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_TYPE_NEWDECIMAL', 246); - -/** - * Field is defined as BIT (MySQL 5.0.3 and up) - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_TYPE_BIT', 16); - -/** - * - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_SET_CHARSET_NAME', 7); define ('MYSQLI_SET_CHARSET_DIR', 6); - -/** - * No more data available for bind variable - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_NO_DATA', 100); - -/** - * Data truncation occurred. Available since MySQL 5.0.5. - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_DATA_TRUNCATED', 101); - -/** - * Report if no index or bad index was used in a query. - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_REPORT_INDEX', 4); - -/** - * Report errors from mysqli function calls. - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_REPORT_ERROR', 1); - -/** - * Throw a mysqli_sql_exception for errors instead of warnings. - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_REPORT_STRICT', 2); - -/** - * Set all options on (report all). - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_REPORT_ALL', 255); - -/** - * Turns reporting off. - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_REPORT_OFF', 0); - -/** - * Is set to 1 if mysqli_debug functionality is enabled. - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_DEBUG_TRACE_ENABLED', 0); - -/** - * - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_SERVER_QUERY_NO_GOOD_INDEX_USED', 16); - -/** - * - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_SERVER_QUERY_NO_INDEX_USED', 32); define ('MYSQLI_SERVER_QUERY_WAS_SLOW', 2048); define ('MYSQLI_SERVER_PS_OUT_PARAMS', 4096); - -/** - * Refreshes the grant tables. - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_REFRESH_GRANT', 1); - -/** - * Flushes the logs, like executing the - * FLUSH LOGS SQL statement. - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_REFRESH_LOG', 2); - -/** - * Flushes the table cache, like executing the - * FLUSH TABLES SQL statement. - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_REFRESH_TABLES', 4); - -/** - * Flushes the host cache, like executing the - * FLUSH HOSTS SQL statement. - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_REFRESH_HOSTS', 8); - -/** - * Reset the status variables, like executing the - * FLUSH STATUS SQL statement. - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_REFRESH_STATUS', 16); - -/** - * Flushes the thread cache. - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_REFRESH_THREADS', 32); - -/** - * Alias of MYSQLI_REFRESH_SLAVE constant. - * Available as of PHP 8.1.0. - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_REFRESH_REPLICA', 64); - -/** - * On a slave replication server: resets the master server information, and - * restarts the slave. Like executing the RESET SLAVE - * SQL statement. - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_REFRESH_SLAVE', 64); - -/** - * On a master replication server: removes the binary log files listed in the - * binary log index, and truncates the index file. Like executing the - * RESET MASTER SQL statement. - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_REFRESH_MASTER', 128); define ('MYSQLI_REFRESH_BACKUP_LOG', 2097152); define ('MYSQLI_TRANS_START_WITH_CONSISTENT_SNAPSHOT', 1); - -/** - * Start the transaction as "START TRANSACTION READ WRITE" with - * mysqli_begin_transaction. - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_TRANS_START_READ_WRITE', 2); - -/** - * Start the transaction as "START TRANSACTION READ ONLY" with - * mysqli_begin_transaction. - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_TRANS_START_READ_ONLY', 4); - -/** - * Appends "AND CHAIN" to mysqli_commit or - * mysqli_rollback. - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_TRANS_COR_AND_CHAIN', 1); - -/** - * Appends "AND NO CHAIN" to mysqli_commit or - * mysqli_rollback. - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_TRANS_COR_AND_NO_CHAIN', 2); - -/** - * Appends "RELEASE" to mysqli_commit or - * mysqli_rollback. - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_TRANS_COR_RELEASE', 4); - -/** - * Appends "NO RELEASE" to mysqli_commit or - * mysqli_rollback. - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_TRANS_COR_NO_RELEASE', 8); - -/** - * Whether the mysqli extension has been built against a MariaDB client library. - * Available as of PHP 8.1.2. - * @link http://www.php.net/manual/en/mysqli.constants.php - */ define ('MYSQLI_IS_MARIADB', false); -// End of mysqli v.8.2.6 +// End of mysqli v.8.3.0 diff --git a/plugins/org.eclipse.php.core/Resources/language/php8.3/mysqlnd.php b/plugins/org.eclipse.php.core/Resources/language/php8.3/mysqlnd.php index 8312eeedad..0f8d28d856 100644 --- a/plugins/org.eclipse.php.core/Resources/language/php8.3/mysqlnd.php +++ b/plugins/org.eclipse.php.core/Resources/language/php8.3/mysqlnd.php @@ -1,4 +1,4 @@ If enable is set, this function returns true on - * success and false on failure. + * {@inheritdoc} + * @param mixed $odbc + * @param bool|null $enable [optional] */ -function odbc_autocommit ($odbc, bool $enable = false): int|bool {} +function odbc_autocommit ($odbc = null, ?bool $enable = NULL): int|bool {} /** - * Commit an ODBC transaction - * @link http://www.php.net/manual/en/function.odbc-commit.php - * @param resource $odbc - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mixed $odbc */ -function odbc_commit ($odbc): bool {} +function odbc_commit ($odbc = null): bool {} /** - * Rollback a transaction - * @link http://www.php.net/manual/en/function.odbc-rollback.php - * @param resource $odbc - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mixed $odbc */ -function odbc_rollback ($odbc): bool {} +function odbc_rollback ($odbc = null): bool {} /** - * Get the last error code - * @link http://www.php.net/manual/en/function.odbc-error.php - * @param resource|null $odbc [optional] - * @return string If odbc is specified, the last state - * of that connection is returned, else the last state of any connection - * is returned. - *This function returns meaningful value only if last odbc query failed - * (i.e. odbc_exec returned false).
+ * {@inheritdoc} + * @param mixed $odbc [optional] */ -function odbc_error ($odbc = null): string {} +function odbc_error ($odbc = NULL): string {} /** - * Get the last error message - * @link http://www.php.net/manual/en/function.odbc-errormsg.php - * @param resource|null $odbc [optional] - * @return string If odbc is specified, the last state - * of that connection is returned, else the last state of any connection - * is returned. - *This function returns meaningful value only if last odbc query failed - * (i.e. odbc_exec returned false).
+ * {@inheritdoc} + * @param mixed $odbc [optional] */ -function odbc_errormsg ($odbc = null): string {} +function odbc_errormsg ($odbc = NULL): string {} /** - * Adjust ODBC settings - * @link http://www.php.net/manual/en/function.odbc-setoption.php - * @param resource $odbc - * @param int $which - * @param int $option - * @param int $value - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mixed $odbc + * @param int $which + * @param int $option + * @param int $value */ -function odbc_setoption ($odbc, int $which, int $option, int $value): bool {} +function odbc_setoption ($odbc = null, int $which, int $option, int $value): bool {} /** - * Get the list of table names stored in a specific data source - * @link http://www.php.net/manual/en/function.odbc-tables.php - * @param resource $odbc - * @param string|null $catalog [optional] - * @param string|null $schema [optional] - * @param string|null $table [optional] - * @param string|null $types [optional] - * @return resource|false Returns an ODBC result identifier containing the information - * or false on failure. - *The result set has the following columns: - *
- *
TABLE_CAT
- *
TABLE_SCHEM
- *
TABLE_NAME
- *
TABLE_TYPE
- *
REMARKS
- *
The result set has the following columns: - *
- *
TABLE_CAT
- *
TABLE_SCHEM
- *
TABLE_NAME
- *
COLUMN_NAME
- *
DATA_TYPE
- *
TYPE_NAME
- *
COLUMN_SIZE
- *
BUFFER_LENGTH
- *
DECIMAL_DIGITS
- *
NUM_PREC_RADIX
- *
NULLABLE
- *
REMARKS
- *
COLUMN_DEF
- *
SQL_DATA_TYPE
- *
SQL_DATETIME_SUB
- *
CHAR_OCTET_LENGTH
- *
ORDINAL_POSITION
- *
IS_NULLABLE
- *
The result set has the following columns: - *
- *
TYPE_NAME
- *
DATA_TYPE
- *
PRECISION
- *
LITERAL_PREFIX
- *
LITERAL_SUFFIX
- *
CREATE_PARAMS
- *
NULLABLE
- *
CASE_SENSITIVE
- *
SEARCHABLE
- *
UNSIGNED_ATTRIBUTE
- *
MONEY
- *
AUTO_INCREMENT
- *
LOCAL_TYPE_NAME
- *
MINIMUM_SCALE
- *
MAXIMUM_SCALE
- *
The result set is ordered by DATA_TYPE and TYPE_NAME.
+ * {@inheritdoc} + * @param mixed $odbc + * @param int $data_type [optional] */ -function odbc_gettypeinfo ($odbc, int $data_type = null) {} +function odbc_gettypeinfo ($odbc = null, int $data_type = 0) {} /** - * Gets the primary keys for a table - * @link http://www.php.net/manual/en/function.odbc-primarykeys.php - * @param resource $odbc - * @param string|null $catalog - * @param string $schema - * @param string $table - * @return resource|false Returns an ODBC result identifier or false on failure. - *The result set has the following columns: - *
- *
TABLE_CAT
- *
TABLE_SCHEM
- *
TABLE_NAME
- *
COLUMN_NAME
- *
KEY_SEQ
- *
PK_NAME
- *
The result set has the following columns: - *
- *
PROCEDURE_CAT
- *
PROCEDURE_SCHEM
- *
PROCEDURE_NAME
- *
COLUMN_NAME
- *
COLUMN_TYPE
- *
DATA_TYPE
- *
TYPE_NAME
- *
COLUMN_SIZE
- *
BUFFER_LENGTH
- *
DECIMAL_DIGITS
- *
NUM_PREC_RADIX
- *
NULLABLE
- *
REMARKS
- *
COLUMN_DEF
- *
SQL_DATA_TYPE
- *
SQL_DATETIME_SUB
- *
CHAR_OCTET_LENGTH
- *
ORDINAL_POSITION
- *
IS_NULLABLE
- *
The result set has the following columns: - *
- *
PROCEDURE_CAT
- *
PROCEDURE_SCHEM
- *
PROCEDURE_NAME
- *
NUM_INPUT_PARAMS
- *
NUM_OUTPUT_PARAMS
- *
NUM_RESULT_SETS
- *
REMARKS
- *
PROCEDURE_TYPE
- *
The result set has the following columns: - *
- *
PKTABLE_CAT
- *
PKTABLE_SCHEM
- *
PKTABLE_NAME
- *
PKCOLUMN_NAME
- *
FKTABLE_CAT
- *
FKTABLE_SCHEM
- *
FKTABLE_NAME
- *
FKCOLUMN_NAME
- *
KEY_SEQ
- *
UPDATE_RULE
- *
DELETE_RULE
- *
FK_NAME
- *
PK_NAME
- *
DEFERRABILITY
- *
The result set has the following columns: - *
- *
SCOPE
- *
COLUMN_NAME
- *
DATA_TYPE
- *
TYPE_NAME
- *
COLUMN_SIZE
- *
BUFFER_LENGTH
- *
DECIMAL_DIGITS
- *
PSEUDO_COLUMN
- *
The result set has the following columns: - *
- *
TABLE_CAT
- *
TABLE_SCHEM
- *
TABLE_NAME
- *
NON_UNIQUE
- *
INDEX_QUALIFIER
- *
INDEX_NAME
- *
TYPE
- *
ORDINAL_POSITION
- *
COLUMN_NAME
- *
ASC_OR_DESC
- *
CARDINALITY
- *
PAGES
- *
FILTER_CONDITION
- *
The result set has the following columns: - *
- *
TABLE_CAT
- *
TABLE_SCHEM
- *
TABLE_NAME
- *
GRANTOR
- *
GRANTEE
- *
PRIVILEGE
- *
IS_GRANTABLE
- *
The result set has the following columns: - *
- *
TABLE_CAT
- *
TABLE_SCHEM
- *
TABLE_NAME
- *
COLUMN_NAME
- *
GRANTOR
- *
GRANTEE
- *
PRIVILEGE
- *
IS_GRANTABLE
- *
Depending on the key type used, additional details may be returned. Note that - * some elements may not always be available.
+ * {@inheritdoc} + * @param OpenSSLAsymmetricKey $key */ function openssl_pkey_get_details (OpenSSLAsymmetricKey $key): array|false {} /** - * Generates a PKCS5 v2 PBKDF2 string - * @link http://www.php.net/manual/en/function.openssl-pbkdf2.php - * @param string $password Password from which the derived key is generated. - * @param string $salt PBKDF2 recommends a crytographic salt of at least 64 bits (8 bytes). - * @param int $key_length Length of desired output key. - * @param int $iterations The number of iterations desired. NIST - * recommends at least 10,000. - * @param string $digest_algo [optional] Optional hash or digest algorithm from openssl_get_md_methods. Defaults to SHA-1. - * @return string|false Returns raw binary string or false on failure. - */ -function openssl_pbkdf2 (string $password, string $salt, int $key_length, int $iterations, string $digest_algo = '"sha1"'): string|false {} - -/** - * Verifies the signature of an S/MIME signed message - * @link http://www.php.net/manual/en/function.openssl-pkcs7-verify.php - * @param string $input_filename - * @param int $flags - * @param string|null $signers_certificates_filename [optional] - * @param array $ca_info [optional] - * @param string|null $untrusted_certificates_filename [optional] - * @param string|null $content [optional] - * @param string|null $output_filename [optional] - * @return bool|int Returns true if the signature is verified, false if it is not correct - * (the message has been tampered with, or the signing certificate is invalid), - * or -1 on error. - */ -function openssl_pkcs7_verify (string $input_filename, int $flags, ?string $signers_certificates_filename = null, array $ca_info = '[]', ?string $untrusted_certificates_filename = null, ?string $content = null, ?string $output_filename = null): bool|int {} - -/** - * Encrypt an S/MIME message - * @link http://www.php.net/manual/en/function.openssl-pkcs7-encrypt.php - * @param string $input_filename - * @param string $output_filename - * @param OpenSSLCertificate|array|string $certificate - * @param array|null $headers - * @param int $flags [optional] - * @param int $cipher_algo [optional] - * @return bool Returns true on success or false on failure. - */ -function openssl_pkcs7_encrypt (string $input_filename, string $output_filename, OpenSSLCertificate|array|string $certificate, ?array $headers, int $flags = null, int $cipher_algo = OPENSSL_CIPHER_AES_128_CBC): bool {} - -/** - * Sign an S/MIME message - * @link http://www.php.net/manual/en/function.openssl-pkcs7-sign.php - * @param string $input_filename - * @param string $output_filename - * @param OpenSSLCertificate|string $certificate - * @param OpenSSLAsymmetricKey|OpenSSLCertificate|array|string $private_key - * @param array|null $headers - * @param int $flags [optional] - * @param string|null $untrusted_certificates_filename [optional] - * @return bool Returns true on success or false on failure. - */ -function openssl_pkcs7_sign (string $input_filename, string $output_filename, OpenSSLCertificate|string $certificate, OpenSSLAsymmetricKey|OpenSSLCertificate|array|string $private_key, ?array $headers, int $flags = PKCS7_DETACHED, ?string $untrusted_certificates_filename = null): bool {} - -/** - * Decrypts an S/MIME encrypted message - * @link http://www.php.net/manual/en/function.openssl-pkcs7-decrypt.php - * @param string $input_filename - * @param string $output_filename - * @param OpenSSLCertificate|string $certificate - * @param OpenSSLAsymmetricKey|OpenSSLCertificate|array|string|null $private_key [optional] - * @return bool Returns true on success or false on failure. - */ -function openssl_pkcs7_decrypt (string $input_filename, string $output_filename, OpenSSLCertificate|string $certificate, OpenSSLAsymmetricKey|OpenSSLCertificate|array|string|null $private_key = null): bool {} - -/** - * Export the PKCS7 file to an array of PEM certificates - * @link http://www.php.net/manual/en/function.openssl-pkcs7-read.php - * @param string $data The string of data you wish to parse (p7b format). - * @param array $certificates The array of PEM certificates from the p7b input data. - * @return bool Returns true on success or false on failure. - */ -function openssl_pkcs7_read (string $data, array &$certificates): bool {} - -/** - * Verify a CMS signature - * @link http://www.php.net/manual/en/function.openssl-cms-verify.php - * @param string $input_filename The input file. - * @param int $flags [optional] Flags to pass to cms_verify. - * @param string|null $certificates [optional] A file with the signer certificate and optionally intermediate certificates. - * @param array $ca_info [optional] An array containing self-signed certificate authority certificates. - * @param string|null $untrusted_certificates_filename [optional] A file containing additional intermediate certificates. - * @param string|null $content [optional] A file pointing to the content when signatures are detached. - * @param string|null $pk7 [optional] - * @param string|null $sigfile [optional] A file to save the signature to. - * @param int $encoding [optional] The encoding of the input file. One of OPENSSL_ENCODING_SMIME, - * OPENSSL_ENCODING_DER or OPENSSL_ENCODING_PEM. - * @return bool Returns true on success or false on failure. - */ -function openssl_cms_verify (string $input_filename, int $flags = null, ?string $certificates = null, array $ca_info = '[]', ?string $untrusted_certificates_filename = null, ?string $content = null, ?string $pk7 = null, ?string $sigfile = null, int $encoding = OPENSSL_ENCODING_SMIME): bool {} - -/** - * Encrypt a CMS message - * @link http://www.php.net/manual/en/function.openssl-cms-encrypt.php - * @param string $input_filename The file to be encrypted. - * @param string $output_filename The output file. - * @param OpenSSLCertificate|array|string $certificate Recipients to encrypt to. - * @param array|null $headers Headers to include when S/MIME is used. - * @param int $flags [optional] Flags to be passed to CMS_sign. - * @param int $encoding [optional] An encoding to output. One of OPENSSL_ENCODING_SMIME, - * OPENSSL_ENCODING_DER or OPENSSL_ENCODING_PEM. - * @param int $cipher_algo [optional] A cypher to use. - * @return bool Returns true on success or false on failure. - */ -function openssl_cms_encrypt (string $input_filename, string $output_filename, OpenSSLCertificate|array|string $certificate, ?array $headers, int $flags = null, int $encoding = OPENSSL_ENCODING_SMIME, int $cipher_algo = OPENSSL_CIPHER_AES_128_CBC): bool {} - -/** - * Sign a file - * @link http://www.php.net/manual/en/function.openssl-cms-sign.php - * @param string $input_filename The name of the file to be signed. - * @param string $output_filename The name of the file to deposit the results. - * @param OpenSSLCertificate|string $certificate The signing certificate. - * See Key/Certificate parameters for a list of valid values. - * @param OpenSSLAsymmetricKey|OpenSSLCertificate|array|string $private_key The key associated with certificate. - * See Key/Certificate parameters for a list of valid values. - * @param array|null $headers An array of headers to be included in S/MIME output. - * @param int $flags [optional] Flags to be passed to cms_sign. - * @param int $encoding [optional] The encoding of the output file. One of OPENSSL_ENCODING_SMIME, - * OPENSSL_ENCODING_DER or OPENSSL_ENCODING_PEM. - * @param string|null $untrusted_certificates_filename [optional] Intermediate certificates to be included in the signature. - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $password + * @param string $salt + * @param int $key_length + * @param int $iterations + * @param string $digest_algo [optional] */ -function openssl_cms_sign (string $input_filename, string $output_filename, OpenSSLCertificate|string $certificate, OpenSSLAsymmetricKey|OpenSSLCertificate|array|string $private_key, ?array $headers, int $flags = null, int $encoding = OPENSSL_ENCODING_SMIME, ?string $untrusted_certificates_filename = null): bool {} +function openssl_pbkdf2 (string $password, string $salt, int $key_length, int $iterations, string $digest_algo = 'sha1'): string|false {} /** - * Decrypt a CMS message - * @link http://www.php.net/manual/en/function.openssl-cms-decrypt.php - * @param string $input_filename The name of a file containing encrypted content. - * @param string $output_filename The name of the file to deposit the decrypted content. - * @param OpenSSLCertificate|string $certificate The name of the file containing a certificate of the recipient. - * @param OpenSSLAsymmetricKey|OpenSSLCertificate|array|string|null $private_key [optional] The name of the file containing a PKCS#8 key. - * @param int $encoding [optional] The encoding of the input file. One of OPENSSL_ENCODING_SMIME, - * OPENSSL_ENCODING_DER or OPENSSL_ENCODING_PEM. - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $input_filename + * @param int $flags + * @param string|null $signers_certificates_filename [optional] + * @param array $ca_info [optional] + * @param string|null $untrusted_certificates_filename [optional] + * @param string|null $content [optional] + * @param string|null $output_filename [optional] */ -function openssl_cms_decrypt (string $input_filename, string $output_filename, OpenSSLCertificate|string $certificate, OpenSSLAsymmetricKey|OpenSSLCertificate|array|string|null $private_key = null, int $encoding = OPENSSL_ENCODING_SMIME): bool {} - -/** - * Export the CMS file to an array of PEM certificates - * @link http://www.php.net/manual/en/function.openssl-cms-read.php - * @param string $input_filename - * @param array $certificates - * @return bool Returns true on success or false on failure. - */ -function openssl_cms_read (string $input_filename, array &$certificates): bool {} +function openssl_pkcs7_verify (string $input_filename, int $flags, ?string $signers_certificates_filename = NULL, array $ca_info = array ( +), ?string $untrusted_certificates_filename = NULL, ?string $content = NULL, ?string $output_filename = NULL): int|bool {} /** - * Encrypts data with private key - * @link http://www.php.net/manual/en/function.openssl-private-encrypt.php - * @param string $data - * @param string $encrypted_data - * @param OpenSSLAsymmetricKey|OpenSSLCertificate|array|string $private_key - * @param int $padding [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $input_filename + * @param string $output_filename + * @param mixed $certificate + * @param array|null $headers + * @param int $flags [optional] + * @param int $cipher_algo [optional] */ -function openssl_private_encrypt (string $data, string &$encrypted_data, OpenSSLAsymmetricKey|OpenSSLCertificate|array|string $private_key, int $padding = OPENSSL_PKCS1_PADDING): bool {} - -/** - * Decrypts data with private key - * @link http://www.php.net/manual/en/function.openssl-private-decrypt.php - * @param string $data - * @param string $decrypted_data - * @param OpenSSLAsymmetricKey|OpenSSLCertificate|array|string $private_key - * @param int $padding [optional] - * @return bool Returns true on success or false on failure. - */ -function openssl_private_decrypt (string $data, string &$decrypted_data, OpenSSLAsymmetricKey|OpenSSLCertificate|array|string $private_key, int $padding = OPENSSL_PKCS1_PADDING): bool {} - -/** - * Encrypts data with public key - * @link http://www.php.net/manual/en/function.openssl-public-encrypt.php - * @param string $data - * @param string $encrypted_data - * @param OpenSSLAsymmetricKey|OpenSSLCertificate|array|string $public_key - * @param int $padding [optional] - * @return bool Returns true on success or false on failure. - */ -function openssl_public_encrypt (string $data, string &$encrypted_data, OpenSSLAsymmetricKey|OpenSSLCertificate|array|string $public_key, int $padding = OPENSSL_PKCS1_PADDING): bool {} - -/** - * Decrypts data with public key - * @link http://www.php.net/manual/en/function.openssl-public-decrypt.php - * @param string $data - * @param string $decrypted_data - * @param OpenSSLAsymmetricKey|OpenSSLCertificate|array|string $public_key - * @param int $padding [optional] - * @return bool Returns true on success or false on failure. - */ -function openssl_public_decrypt (string $data, string &$decrypted_data, OpenSSLAsymmetricKey|OpenSSLCertificate|array|string $public_key, int $padding = OPENSSL_PKCS1_PADDING): bool {} +function openssl_pkcs7_encrypt (string $input_filename, string $output_filename, $certificate = null, ?array $headers = null, int $flags = 0, int $cipher_algo = 5): bool {} /** - * Return openSSL error message - * @link http://www.php.net/manual/en/function.openssl-error-string.php - * @return string|false Returns an error message string, or false if there are no more error - * messages to return. + * {@inheritdoc} + * @param string $input_filename + * @param string $output_filename + * @param OpenSSLCertificate|string $certificate + * @param mixed $private_key + * @param array|null $headers + * @param int $flags [optional] + * @param string|null $untrusted_certificates_filename [optional] */ -function openssl_error_string (): string|false {} +function openssl_pkcs7_sign (string $input_filename, string $output_filename, OpenSSLCertificate|string $certificate, $private_key = null, ?array $headers = null, int $flags = 64, ?string $untrusted_certificates_filename = NULL): bool {} /** - * Generate signature - * @link http://www.php.net/manual/en/function.openssl-sign.php - * @param string $data - * @param string $signature - * @param OpenSSLAsymmetricKey|OpenSSLCertificate|array|string $private_key - * @param string|int $algorithm [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $input_filename + * @param string $output_filename + * @param mixed $certificate + * @param mixed $private_key [optional] */ -function openssl_sign (string $data, string &$signature, OpenSSLAsymmetricKey|OpenSSLCertificate|array|string $private_key, string|int $algorithm = OPENSSL_ALGO_SHA1): bool {} +function openssl_pkcs7_decrypt (string $input_filename, string $output_filename, $certificate = null, $private_key = NULL): bool {} /** - * Verify signature - * @link http://www.php.net/manual/en/function.openssl-verify.php - * @param string $data - * @param string $signature - * @param OpenSSLAsymmetricKey|OpenSSLCertificate|array|string $public_key - * @param string|int $algorithm [optional] - * @return int|false Returns 1 if the signature is correct, 0 if it is incorrect, and - * -1 or false on error. + * {@inheritdoc} + * @param string $data + * @param mixed $certificates */ -function openssl_verify (string $data, string $signature, OpenSSLAsymmetricKey|OpenSSLCertificate|array|string $public_key, string|int $algorithm = OPENSSL_ALGO_SHA1): int|false {} +function openssl_pkcs7_read (string $data, &$certificates = null): bool {} /** - * Seal (encrypt) data - * @link http://www.php.net/manual/en/function.openssl-seal.php - * @param string $data - * @param string $sealed_data - * @param array $encrypted_keys - * @param array $public_key - * @param string $cipher_algo - * @param string $iv [optional] - * @return int|false Returns the length of the sealed data on success, or false on error. - * If successful the sealed data is returned in - * sealed_data, and the envelope keys in - * encrypted_keys. + * {@inheritdoc} + * @param string $input_filename + * @param int $flags [optional] + * @param string|null $certificates [optional] + * @param array $ca_info [optional] + * @param string|null $untrusted_certificates_filename [optional] + * @param string|null $content [optional] + * @param string|null $pk7 [optional] + * @param string|null $sigfile [optional] + * @param int $encoding [optional] */ -function openssl_seal (string $data, string &$sealed_data, array &$encrypted_keys, array $public_key, string $cipher_algo, string &$iv = null): int|false {} +function openssl_cms_verify (string $input_filename, int $flags = 0, ?string $certificates = NULL, array $ca_info = array ( +), ?string $untrusted_certificates_filename = NULL, ?string $content = NULL, ?string $pk7 = NULL, ?string $sigfile = NULL, int $encoding = 1): bool {} /** - * Open sealed data - * @link http://www.php.net/manual/en/function.openssl-open.php - * @param string $data - * @param string $output - * @param string $encrypted_key - * @param OpenSSLAsymmetricKey|OpenSSLCertificate|array|string $private_key - * @param string $cipher_algo - * @param string|null $iv [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $input_filename + * @param string $output_filename + * @param mixed $certificate + * @param array|null $headers + * @param int $flags [optional] + * @param int $encoding [optional] + * @param int $cipher_algo [optional] */ -function openssl_open (string $data, string &$output, string $encrypted_key, OpenSSLAsymmetricKey|OpenSSLCertificate|array|string $private_key, string $cipher_algo, ?string $iv = null): bool {} +function openssl_cms_encrypt (string $input_filename, string $output_filename, $certificate = null, ?array $headers = null, int $flags = 0, int $encoding = 1, int $cipher_algo = 5): bool {} /** - * Gets available digest methods - * @link http://www.php.net/manual/en/function.openssl-get-md-methods.php - * @param bool $aliases [optional] - * @return array An array of available digest methods. + * {@inheritdoc} + * @param string $input_filename + * @param string $output_filename + * @param OpenSSLCertificate|string $certificate + * @param mixed $private_key + * @param array|null $headers + * @param int $flags [optional] + * @param int $encoding [optional] + * @param string|null $untrusted_certificates_filename [optional] */ -function openssl_get_md_methods (bool $aliases = false): array {} +function openssl_cms_sign (string $input_filename, string $output_filename, OpenSSLCertificate|string $certificate, $private_key = null, ?array $headers = null, int $flags = 0, int $encoding = 1, ?string $untrusted_certificates_filename = NULL): bool {} /** - * Gets available cipher methods - * @link http://www.php.net/manual/en/function.openssl-get-cipher-methods.php - * @param bool $aliases [optional] - * @return array An array of available cipher methods. - * Note that prior to OpenSSL 1.1.1, the cipher methods have been returned in - * upper case and lower case spelling; as of OpenSSL 1.1.1 only the lower case - * variants are returned. + * {@inheritdoc} + * @param string $input_filename + * @param string $output_filename + * @param mixed $certificate + * @param mixed $private_key [optional] + * @param int $encoding [optional] */ -function openssl_get_cipher_methods (bool $aliases = false): array {} +function openssl_cms_decrypt (string $input_filename, string $output_filename, $certificate = null, $private_key = NULL, int $encoding = 1): bool {} /** - * Gets list of available curve names for ECC - * @link http://www.php.net/manual/en/function.openssl-get-curve-names.php - * @return array|false An array of available curve names, or false on failure. + * {@inheritdoc} + * @param string $input_filename + * @param mixed $certificates */ -function openssl_get_curve_names (): array|false {} +function openssl_cms_read (string $input_filename, &$certificates = null): bool {} /** - * Computes a digest - * @link http://www.php.net/manual/en/function.openssl-digest.php - * @param string $data - * @param string $digest_algo - * @param bool $binary [optional] - * @return string|false Returns the digested hash value on success or false on failure. + * {@inheritdoc} + * @param string $data + * @param mixed $encrypted_data + * @param mixed $private_key + * @param int $padding [optional] */ -function openssl_digest (string $data, string $digest_algo, bool $binary = false): string|false {} +function openssl_private_encrypt (string $data, &$encrypted_data = null, $private_key = null, int $padding = 1): bool {} /** - * Encrypts data - * @link http://www.php.net/manual/en/function.openssl-encrypt.php - * @param string $data - * @param string $cipher_algo - * @param string $passphrase - * @param int $options [optional] - * @param string $iv [optional] - * @param string $tag [optional] - * @param string $aad [optional] - * @param int $tag_length [optional] - * @return string|false Returns the encrypted string on success or false on failure. + * {@inheritdoc} + * @param string $data + * @param mixed $decrypted_data + * @param mixed $private_key + * @param int $padding [optional] */ -function openssl_encrypt (string $data, string $cipher_algo, string $passphrase, int $options = null, string $iv = '""', string &$tag = null, string $aad = '""', int $tag_length = 16): string|false {} +function openssl_private_decrypt (string $data, &$decrypted_data = null, $private_key = null, int $padding = 1): bool {} /** - * Decrypts data - * @link http://www.php.net/manual/en/function.openssl-decrypt.php - * @param string $data - * @param string $cipher_algo - * @param string $passphrase - * @param int $options [optional] - * @param string $iv [optional] - * @param string|null $tag [optional] - * @param string $aad [optional] - * @return string|false The decrypted string on success or false on failure. + * {@inheritdoc} + * @param string $data + * @param mixed $encrypted_data + * @param mixed $public_key + * @param int $padding [optional] */ -function openssl_decrypt (string $data, string $cipher_algo, string $passphrase, int $options = null, string $iv = '""', ?string $tag = null, string $aad = '""'): string|false {} +function openssl_public_encrypt (string $data, &$encrypted_data = null, $public_key = null, int $padding = 1): bool {} /** - * Gets the cipher iv length - * @link http://www.php.net/manual/en/function.openssl-cipher-iv-length.php - * @param string $cipher_algo The cipher method, see openssl_get_cipher_methods for a list of potential values. - * @return int|false Returns the cipher length on success, or false on failure. + * {@inheritdoc} + * @param string $data + * @param mixed $decrypted_data + * @param mixed $public_key + * @param int $padding [optional] */ -function openssl_cipher_iv_length (string $cipher_algo): int|false {} +function openssl_public_decrypt (string $data, &$decrypted_data = null, $public_key = null, int $padding = 1): bool {} /** - * Gets the cipher key length - * @link http://www.php.net/manual/en/function.openssl-cipher-key-length.php - * @param string $cipher_algo The cipher method, see openssl_get_cipher_methods for a list of potential values. - * @return int|false Returns the cipher length on success, or false on failure. + * {@inheritdoc} */ -function openssl_cipher_key_length (string $cipher_algo): int|false {} +function openssl_error_string (): string|false {} /** - * Computes shared secret for public value of remote DH public key and local DH key - * @link http://www.php.net/manual/en/function.openssl-dh-compute-key.php - * @param string $public_key - * @param OpenSSLAsymmetricKey $private_key - * @return string|false Returns shared secret on success or false on failure. + * {@inheritdoc} + * @param string $data + * @param mixed $signature + * @param mixed $private_key + * @param string|int $algorithm [optional] */ -function openssl_dh_compute_key (string $public_key, OpenSSLAsymmetricKey $private_key): string|false {} +function openssl_sign (string $data, &$signature = null, $private_key = null, string|int $algorithm = 1): bool {} /** - * Computes shared secret for public value of remote and local DH or ECDH key - * @link http://www.php.net/manual/en/function.openssl-pkey-derive.php - * @param OpenSSLAsymmetricKey|OpenSSLCertificate|array|string $public_key public_key is the public key for the derivation. - * See Public/Private Key parameters for a list of valid values. - * @param OpenSSLAsymmetricKey|OpenSSLCertificate|array|string $private_key private_key is the private key for the derivation. - * See Public/Private Key parameters for a list of valid values. - * @param int $key_length [optional] If not zero, will set the desired length of the derived secret. - * @return string|false The derived secret on success or false on failure. + * {@inheritdoc} + * @param string $data + * @param string $signature + * @param mixed $public_key + * @param string|int $algorithm [optional] */ -function openssl_pkey_derive (OpenSSLAsymmetricKey|OpenSSLCertificate|array|string $public_key, OpenSSLAsymmetricKey|OpenSSLCertificate|array|string $private_key, int $key_length = null): string|false {} +function openssl_verify (string $data, string $signature, $public_key = null, string|int $algorithm = 1): int|false {} /** - * Generate a pseudo-random string of bytes - * @link http://www.php.net/manual/en/function.openssl-random-pseudo-bytes.php - * @param int $length - * @param bool $strong_result [optional] - * @return string Returns the generated string of bytes. + * {@inheritdoc} + * @param string $data + * @param mixed $sealed_data + * @param mixed $encrypted_keys + * @param array $public_key + * @param string $cipher_algo + * @param mixed $iv [optional] */ -function openssl_random_pseudo_bytes (int $length, bool &$strong_result = null): string {} +function openssl_seal (string $data, &$sealed_data = null, &$encrypted_keys = null, array $public_key, string $cipher_algo, &$iv = NULL): int|false {} /** - * Generate a new signed public key and challenge - * @link http://www.php.net/manual/en/function.openssl-spki-new.php - * @param OpenSSLAsymmetricKey $private_key private_key should be set to a private key that was - * previously generated by openssl_pkey_new (or - * otherwise obtained from the other openssl_pkey family of functions). - * The corresponding public portion of the key will be used to sign the - * CSR. - * @param string $challenge The challenge associated to associate with the SPKAC - * @param int $digest_algo [optional] The digest algorithm. See openssl_get_md_method(). - * @return string|false Returns a signed public key and challenge string or false on failure. + * {@inheritdoc} + * @param string $data + * @param mixed $output + * @param string $encrypted_key + * @param mixed $private_key + * @param string $cipher_algo + * @param string|null $iv [optional] */ -function openssl_spki_new (OpenSSLAsymmetricKey $private_key, string $challenge, int $digest_algo = OPENSSL_ALGO_MD5): string|false {} +function openssl_open (string $data, &$output = null, string $encrypted_key, $private_key = null, string $cipher_algo, ?string $iv = NULL): bool {} /** - * Verifies a signed public key and challenge - * @link http://www.php.net/manual/en/function.openssl-spki-verify.php - * @param string $spki Expects a valid signed public key and challenge - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param bool $aliases [optional] */ -function openssl_spki_verify (string $spki): bool {} +function openssl_get_md_methods (bool $aliases = false): array {} /** - * Exports a valid PEM formatted public key signed public key and challenge - * @link http://www.php.net/manual/en/function.openssl-spki-export.php - * @param string $spki Expects a valid signed public key and challenge - * @return string|false Returns the associated PEM formatted public key or false on failure. + * {@inheritdoc} + * @param bool $aliases [optional] */ -function openssl_spki_export (string $spki): string|false {} +function openssl_get_cipher_methods (bool $aliases = false): array {} /** - * Exports the challenge associated with a signed public key and challenge - * @link http://www.php.net/manual/en/function.openssl-spki-export-challenge.php - * @param string $spki Expects a valid signed public key and challenge - * @return string|false Returns the associated challenge string or false on failure. + * {@inheritdoc} */ -function openssl_spki_export_challenge (string $spki): string|false {} +function openssl_get_curve_names (): array|false {} /** - * Retrieve the available certificate locations - * @link http://www.php.net/manual/en/function.openssl-get-cert-locations.php - * @return array Returns an array with the available certificate locations. + * {@inheritdoc} + * @param string $data + * @param string $digest_algo + * @param bool $binary [optional] */ -function openssl_get_cert_locations (): array {} - +function openssl_digest (string $data, string $digest_algo, bool $binary = false): string|false {} /** - * - * @link http://www.php.net/manual/en/openssl.constversion.php - * @var string + * {@inheritdoc} + * @param string $data + * @param string $cipher_algo + * @param string $passphrase + * @param int $options [optional] + * @param string $iv [optional] + * @param mixed $tag [optional] + * @param string $aad [optional] + * @param int $tag_length [optional] */ -define ('OPENSSL_VERSION_TEXT', "OpenSSL 1.1.1t 7 Feb 2023"); +function openssl_encrypt (string $data, string $cipher_algo, string $passphrase, int $options = 0, string $iv = '', &$tag = NULL, string $aad = '', int $tag_length = 16): string|false {} /** - * - * @link http://www.php.net/manual/en/openssl.constversion.php - * @var int + * {@inheritdoc} + * @param string $data + * @param string $cipher_algo + * @param string $passphrase + * @param int $options [optional] + * @param string $iv [optional] + * @param string|null $tag [optional] + * @param string $aad [optional] */ -define ('OPENSSL_VERSION_NUMBER', 269488463); +function openssl_decrypt (string $data, string $cipher_algo, string $passphrase, int $options = 0, string $iv = '', ?string $tag = NULL, string $aad = ''): string|false {} /** - * - * @link http://www.php.net/manual/en/openssl.purpose-check.php - * @var int + * {@inheritdoc} + * @param string $cipher_algo */ -define ('X509_PURPOSE_SSL_CLIENT', 1); +function openssl_cipher_iv_length (string $cipher_algo): int|false {} /** - * - * @link http://www.php.net/manual/en/openssl.purpose-check.php - * @var int + * {@inheritdoc} + * @param string $cipher_algo */ -define ('X509_PURPOSE_SSL_SERVER', 2); +function openssl_cipher_key_length (string $cipher_algo): int|false {} /** - * - * @link http://www.php.net/manual/en/openssl.purpose-check.php - * @var int + * {@inheritdoc} + * @param string $public_key + * @param OpenSSLAsymmetricKey $private_key */ -define ('X509_PURPOSE_NS_SSL_SERVER', 3); +function openssl_dh_compute_key (string $public_key, OpenSSLAsymmetricKey $private_key): string|false {} /** - * - * @link http://www.php.net/manual/en/openssl.purpose-check.php - * @var int + * {@inheritdoc} + * @param mixed $public_key + * @param mixed $private_key + * @param int $key_length [optional] */ -define ('X509_PURPOSE_SMIME_SIGN', 4); +function openssl_pkey_derive ($public_key = null, $private_key = null, int $key_length = 0): string|false {} /** - * - * @link http://www.php.net/manual/en/openssl.purpose-check.php - * @var int + * {@inheritdoc} + * @param int $length + * @param mixed $strong_result [optional] */ -define ('X509_PURPOSE_SMIME_ENCRYPT', 5); +function openssl_random_pseudo_bytes (int $length, &$strong_result = NULL): string {} /** - * - * @link http://www.php.net/manual/en/openssl.purpose-check.php - * @var int + * {@inheritdoc} + * @param OpenSSLAsymmetricKey $private_key + * @param string $challenge + * @param int $digest_algo [optional] */ -define ('X509_PURPOSE_CRL_SIGN', 6); +function openssl_spki_new (OpenSSLAsymmetricKey $private_key, string $challenge, int $digest_algo = 2): string|false {} /** - * - * @link http://www.php.net/manual/en/openssl.purpose-check.php - * @var int + * {@inheritdoc} + * @param string $spki */ -define ('X509_PURPOSE_ANY', 7); +function openssl_spki_verify (string $spki): bool {} /** - * Used as default algorithm by openssl_sign and - * openssl_verify. - * @link http://www.php.net/manual/en/openssl.signature-algos.php - * @var int + * {@inheritdoc} + * @param string $spki */ -define ('OPENSSL_ALGO_SHA1', 1); +function openssl_spki_export (string $spki): string|false {} /** - * - * @link http://www.php.net/manual/en/openssl.signature-algos.php - * @var int + * {@inheritdoc} + * @param string $spki */ -define ('OPENSSL_ALGO_MD5', 2); +function openssl_spki_export_challenge (string $spki): string|false {} /** - * - * @link http://www.php.net/manual/en/openssl.signature-algos.php - * @var int + * {@inheritdoc} */ -define ('OPENSSL_ALGO_MD4', 3); +function openssl_get_cert_locations (): array {} -/** - * - * @link http://www.php.net/manual/en/openssl.signature-algos.php - * @var int - */ +define ('OPENSSL_VERSION_TEXT', "OpenSSL 3.1.4 24 Oct 2023"); +define ('OPENSSL_VERSION_NUMBER', 806355008); +define ('X509_PURPOSE_SSL_CLIENT', 1); +define ('X509_PURPOSE_SSL_SERVER', 2); +define ('X509_PURPOSE_NS_SSL_SERVER', 3); +define ('X509_PURPOSE_SMIME_SIGN', 4); +define ('X509_PURPOSE_SMIME_ENCRYPT', 5); +define ('X509_PURPOSE_CRL_SIGN', 6); +define ('X509_PURPOSE_ANY', 7); +define ('OPENSSL_ALGO_SHA1', 1); +define ('OPENSSL_ALGO_MD5', 2); +define ('OPENSSL_ALGO_MD4', 3); define ('OPENSSL_ALGO_SHA224', 6); - -/** - * - * @link http://www.php.net/manual/en/openssl.signature-algos.php - * @var int - */ define ('OPENSSL_ALGO_SHA256', 7); - -/** - * - * @link http://www.php.net/manual/en/openssl.signature-algos.php - * @var int - */ define ('OPENSSL_ALGO_SHA384', 8); - -/** - * - * @link http://www.php.net/manual/en/openssl.signature-algos.php - * @var int - */ define ('OPENSSL_ALGO_SHA512', 9); - -/** - * - * @link http://www.php.net/manual/en/openssl.signature-algos.php - * @var int - */ define ('OPENSSL_ALGO_RMD160', 10); define ('PKCS7_DETACHED', 64); define ('PKCS7_TEXT', 1); @@ -847,6 +570,7 @@ function openssl_get_cert_locations (): array {} define ('PKCS7_NOATTR', 256); define ('PKCS7_BINARY', 128); define ('PKCS7_NOSIGS', 4); +define ('PKCS7_NOOLDMIMETYPE', 1024); define ('OPENSSL_CMS_DETACHED', 64); define ('OPENSSL_CMS_TEXT', 1); define ('OPENSSL_CMS_NOINTERN', 16); @@ -855,170 +579,29 @@ function openssl_get_cert_locations (): array {} define ('OPENSSL_CMS_NOATTR', 256); define ('OPENSSL_CMS_BINARY', 128); define ('OPENSSL_CMS_NOSIGS', 12); - -/** - * - * @link http://www.php.net/manual/en/openssl.padding.php - * @var int - */ +define ('OPENSSL_CMS_OLDMIMETYPE', 1024); define ('OPENSSL_PKCS1_PADDING', 1); - -/** - * - * @link http://www.php.net/manual/en/openssl.padding.php - * @var int - */ -define ('OPENSSL_SSLV23_PADDING', 2); - -/** - * - * @link http://www.php.net/manual/en/openssl.padding.php - * @var int - */ define ('OPENSSL_NO_PADDING', 3); - -/** - * - * @link http://www.php.net/manual/en/openssl.padding.php - * @var int - */ define ('OPENSSL_PKCS1_OAEP_PADDING', 4); define ('OPENSSL_DEFAULT_STREAM_CIPHERS', "ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES256-GCM-SHA384:DHE-RSA-AES128-GCM-SHA256:DHE-DSS-AES128-GCM-SHA256:kEDH+AESGCM:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:DHE-RSA-AES128-SHA256:DHE-RSA-AES128-SHA:DHE-DSS-AES128-SHA256:DHE-RSA-AES256-SHA256:DHE-DSS-AES256-SHA:DHE-RSA-AES256-SHA:AES128-GCM-SHA256:AES256-GCM-SHA384:AES128:AES256:HIGH:!SSLv2:!aNULL:!eNULL:!EXPORT:!DES:!MD5:!RC4:!ADH"); - -/** - * - * @link http://www.php.net/manual/en/openssl.ciphers.php - * @var int - */ define ('OPENSSL_CIPHER_RC2_40', 0); - -/** - * - * @link http://www.php.net/manual/en/openssl.ciphers.php - * @var int - */ define ('OPENSSL_CIPHER_RC2_128', 1); - -/** - * - * @link http://www.php.net/manual/en/openssl.ciphers.php - * @var int - */ define ('OPENSSL_CIPHER_RC2_64', 2); - -/** - * - * @link http://www.php.net/manual/en/openssl.ciphers.php - * @var int - */ define ('OPENSSL_CIPHER_DES', 3); - -/** - * - * @link http://www.php.net/manual/en/openssl.ciphers.php - * @var int - */ define ('OPENSSL_CIPHER_3DES', 4); - -/** - * - * @link http://www.php.net/manual/en/openssl.ciphers.php - * @var int - */ define ('OPENSSL_CIPHER_AES_128_CBC', 5); - -/** - * - * @link http://www.php.net/manual/en/openssl.ciphers.php - * @var int - */ define ('OPENSSL_CIPHER_AES_192_CBC', 6); - -/** - * - * @link http://www.php.net/manual/en/openssl.ciphers.php - * @var int - */ define ('OPENSSL_CIPHER_AES_256_CBC', 7); - -/** - * - * @link http://www.php.net/manual/en/openssl.key-types.php - * @var int - */ define ('OPENSSL_KEYTYPE_RSA', 0); - -/** - * - * @link http://www.php.net/manual/en/openssl.key-types.php - * @var int - */ define ('OPENSSL_KEYTYPE_DSA', 1); - -/** - * - * @link http://www.php.net/manual/en/openssl.key-types.php - * @var int - */ define ('OPENSSL_KEYTYPE_DH', 2); - -/** - * This constant is only available when PHP is compiled with OpenSSL 0.9.8+. - * @link http://www.php.net/manual/en/openssl.key-types.php - * @var int - */ define ('OPENSSL_KEYTYPE_EC', 3); - -/** - * If OPENSSL_RAW_DATA is set in the - * openssl_encrypt or openssl_decrypt, - * the returned data is returned as-is. - * When it is not specified, Base64 encoded data is returned to the caller. - * @link http://www.php.net/manual/en/openssl.constants.other.php - * @var bool - */ define ('OPENSSL_RAW_DATA', 1); - -/** - * By default encryption operations are padded using standard block - * padding and the padding is checked and removed when decrypting. - * If OPENSSL_ZERO_PADDING is set in the - * openssl_encrypt or openssl_decrypt - * options then no padding is performed, the total - * amount of data encrypted or decrypted must then be a multiple of the - * block size or an error will occur. - * @link http://www.php.net/manual/en/openssl.constants.other.php - * @var bool - */ define ('OPENSSL_ZERO_PADDING', 2); define ('OPENSSL_DONT_ZERO_PAD_KEY', 4); - -/** - * Whether SNI support is available or not. - * @link http://www.php.net/manual/en/openssl.constsni.php - * @var string - */ define ('OPENSSL_TLSEXT_SERVER_NAME', 1); - -/** - * Indicates that encoding is DER (Distinguished Encoding Rules). - * @link http://www.php.net/manual/en/openssl.constants.other.php - * @var int - */ define ('OPENSSL_ENCODING_DER', 0); - -/** - * Indicates that encoding is S/MIME. - * @link http://www.php.net/manual/en/openssl.constants.other.php - * @var int - */ define ('OPENSSL_ENCODING_SMIME', 1); - -/** - * Indicates that encoding is PEM (Privacy-Enhanced Mail). - * @link http://www.php.net/manual/en/openssl.constants.other.php - * @var int - */ define ('OPENSSL_ENCODING_PEM', 2); -// End of openssl v.8.2.6 +// End of openssl v.8.3.0 diff --git a/plugins/org.eclipse.php.core/Resources/language/php8.3/pcntl.php b/plugins/org.eclipse.php.core/Resources/language/php8.3/pcntl.php index eec8063d92..916a13fe34 100644 --- a/plugins/org.eclipse.php.core/Resources/language/php8.3/pcntl.php +++ b/plugins/org.eclipse.php.core/Resources/language/php8.3/pcntl.php @@ -1,94 +1,67 @@ If matches are found, the new subject will - * be returned, otherwise subject will be - * returned unchanged or null if an error occurred. + * {@inheritdoc} + * @param array|string $pattern + * @param array|string $replacement + * @param array|string $subject + * @param int $limit [optional] + * @param mixed $count [optional] */ -function preg_replace (string|array $pattern, string|array $replacement, string|array $subject, int $limit = -1, int &$count = null): string|array|null {} +function preg_replace (array|string $pattern, array|string $replacement, array|string $subject, int $limit = -1, &$count = NULL): array|string|null {} /** - * Perform a regular expression search and replace - * @link http://www.php.net/manual/en/function.preg-filter.php - * @param string|array $pattern - * @param string|array $replacement - * @param string|array $subject - * @param int $limit [optional] - * @param int $count [optional] - * @return string|array|null Returns an array if the subject - * parameter is an array, or a string otherwise. - *If no matches are found or an error occurred, an empty array - * is returned when subject is an array - * or null otherwise.
+ * {@inheritdoc} + * @param array|string $pattern + * @param array|string $replacement + * @param array|string $subject + * @param int $limit [optional] + * @param mixed $count [optional] */ -function preg_filter (string|array $pattern, string|array $replacement, string|array $subject, int $limit = -1, int &$count = null): string|array|null {} +function preg_filter (array|string $pattern, array|string $replacement, array|string $subject, int $limit = -1, &$count = NULL): array|string|null {} /** - * Perform a regular expression search and replace using a callback - * @link http://www.php.net/manual/en/function.preg-replace-callback.php - * @param string|array $pattern - * @param callable $callback - * @param string|array $subject - * @param int $limit [optional] - * @param int $count [optional] - * @param int $flags [optional] - * @return string|array|null preg_replace_callback returns an array if the - * subject parameter is an array, or a string - * otherwise. On errors the return value is null - *If matches are found, the new subject will be returned, otherwise - * subject will be returned unchanged.
+ * {@inheritdoc} + * @param array|string $pattern + * @param callable $callback + * @param array|string $subject + * @param int $limit [optional] + * @param mixed $count [optional] + * @param int $flags [optional] */ -function preg_replace_callback (string|array $pattern, callable $callback, string|array $subject, int $limit = -1, int &$count = null, int $flags = null): string|array|null {} +function preg_replace_callback (array|string $pattern, callable $callback, array|string $subject, int $limit = -1, &$count = NULL, int $flags = 0): array|string|null {} /** - * Perform a regular expression search and replace using callbacks - * @link http://www.php.net/manual/en/function.preg-replace-callback-array.php - * @param array $pattern - * @param string|array $subject - * @param int $limit [optional] - * @param int $count [optional] - * @param int $flags [optional] - * @return string|array|null preg_replace_callback_array returns an array if the - * subject parameter is an array, or a string - * otherwise. On errors the return value is null - *If matches are found, the new subject will be returned, otherwise - * subject will be returned unchanged.
+ * {@inheritdoc} + * @param array $pattern + * @param array|string $subject + * @param int $limit [optional] + * @param mixed $count [optional] + * @param int $flags [optional] */ -function preg_replace_callback_array (array $pattern, string|array $subject, int $limit = -1, int &$count = null, int $flags = null): string|array|null {} +function preg_replace_callback_array (array $pattern, array|string $subject, int $limit = -1, &$count = NULL, int $flags = 0): array|string|null {} /** - * Split string by a regular expression - * @link http://www.php.net/manual/en/function.preg-split.php - * @param string $pattern - * @param string $subject - * @param int $limit [optional] - * @param int $flags [optional] - * @return array|false Returns an array containing substrings of subject - * split along boundaries matched by pattern, or false on failure. + * {@inheritdoc} + * @param string $pattern + * @param string $subject + * @param int $limit [optional] + * @param int $flags [optional] */ -function preg_split (string $pattern, string $subject, int $limit = -1, int $flags = null): array|false {} +function preg_split (string $pattern, string $subject, int $limit = -1, int $flags = 0): array|false {} /** - * Quote regular expression characters - * @link http://www.php.net/manual/en/function.preg-quote.php - * @param string $str - * @param string|null $delimiter [optional] - * @return string Returns the quoted (escaped) string. + * {@inheritdoc} + * @param string $str + * @param string|null $delimiter [optional] */ -function preg_quote (string $str, ?string $delimiter = null): string {} +function preg_quote (string $str, ?string $delimiter = NULL): string {} /** - * Return array entries that match the pattern - * @link http://www.php.net/manual/en/function.preg-grep.php - * @param string $pattern - * @param array $array - * @param int $flags [optional] - * @return array|false Returns an array indexed using the keys from the - * array array, or false on failure. + * {@inheritdoc} + * @param string $pattern + * @param array $array + * @param int $flags [optional] */ -function preg_grep (string $pattern, array $array, int $flags = null): array|false {} +function preg_grep (string $pattern, array $array, int $flags = 0): array|false {} /** - * Returns the error code of the last PCRE regex execution - * @link http://www.php.net/manual/en/function.preg-last-error.php - * @return int Returns one of the following constants (explained on their own page): - *- * PREG_NO_ERROR - * PREG_INTERNAL_ERROR - * PREG_BACKTRACK_LIMIT_ERROR (see also pcre.backtrack_limit) - * PREG_RECURSION_LIMIT_ERROR (see also pcre.recursion_limit) - * PREG_BAD_UTF8_ERROR - * PREG_BAD_UTF8_OFFSET_ERROR - * PREG_JIT_STACKLIMIT_ERROR - *
+ * {@inheritdoc} */ function preg_last_error (): int {} /** - * Returns the error message of the last PCRE regex execution - * @link http://www.php.net/manual/en/function.preg-last-error-msg.php - * @return string Returns the error message on success, or "No error" if no - * error has occurred. + * {@inheritdoc} */ function preg_last_error_msg (): string {} @@ -169,4 +117,4 @@ function preg_last_error_msg (): string {} define ('PCRE_VERSION_MINOR', 42); define ('PCRE_JIT_SUPPORT', true); -// End of pcre v.8.2.6 +// End of pcre v.8.3.0 diff --git a/plugins/org.eclipse.php.core/Resources/language/php8.3/pdo_dblib.php b/plugins/org.eclipse.php.core/Resources/language/php8.3/pdo_dblib.php index a084898bf6..2e15694da8 100644 --- a/plugins/org.eclipse.php.core/Resources/language/php8.3/pdo_dblib.php +++ b/plugins/org.eclipse.php.core/Resources/language/php8.3/pdo_dblib.php @@ -1,4 +1,4 @@ An PgSql\Connection instance. - * @return int Returns PGSQL_POLLING_FAILED, - * PGSQL_POLLING_READING, - * PGSQL_POLLING_WRITING, - * PGSQL_POLLING_OK, or - * PGSQL_POLLING_ACTIVE. + * {@inheritdoc} + * @param PgSql\Connection $connection */ function pg_connect_poll (PgSql\Connection $connection): int {} /** - * Closes a PostgreSQL connection - * @link http://www.php.net/manual/en/function.pg-close.php - * @param PgSql\Connection|null $connection [optional] - * @return true Always returns true. + * {@inheritdoc} + * @param PgSql\Connection|null $connection [optional] */ -function pg_close (?PgSql\Connection $connection = null): true {} +function pg_close (?PgSql\Connection $connection = NULL): true {} /** - * Get the database name - * @link http://www.php.net/manual/en/function.pg-dbname.php - * @param PgSql\Connection|null $connection [optional] - * @return string A string containing the name of the database the - * connection is to. + * {@inheritdoc} + * @param PgSql\Connection|null $connection [optional] */ -function pg_dbname (?PgSql\Connection $connection = null): string {} +function pg_dbname (?PgSql\Connection $connection = NULL): string {} /** - * Get the last error message string of a connection - * @link http://www.php.net/manual/en/function.pg-last-error.php - * @param PgSql\Connection|null $connection [optional] - * @return string A string containing the last error message on the - * given connection. + * {@inheritdoc} + * @param PgSql\Connection|null $connection [optional] */ -function pg_last_error (?PgSql\Connection $connection = null): string {} +function pg_last_error (?PgSql\Connection $connection = NULL): string {} /** * {@inheritdoc} @@ -96,76 +65,54 @@ function pg_last_error (?PgSql\Connection $connection = null): string {} function pg_errormessage (?PgSql\Connection $connection = NULL): string {} /** - * Get the options associated with the connection - * @link http://www.php.net/manual/en/function.pg-options.php - * @param PgSql\Connection|null $connection [optional] - * @return string A string containing the connection - * options. + * {@inheritdoc} + * @param PgSql\Connection|null $connection [optional] */ -function pg_options (?PgSql\Connection $connection = null): string {} +function pg_options (?PgSql\Connection $connection = NULL): string {} /** - * Return the port number associated with the connection - * @link http://www.php.net/manual/en/function.pg-port.php - * @param PgSql\Connection|null $connection [optional] - * @return string A string containing the port number of the database - * server the connection is to, - * or empty string on error. + * {@inheritdoc} + * @param PgSql\Connection|null $connection [optional] */ -function pg_port (?PgSql\Connection $connection = null): string {} +function pg_port (?PgSql\Connection $connection = NULL): string {} /** - * Return the TTY name associated with the connection - * @link http://www.php.net/manual/en/function.pg-tty.php - * @param PgSql\Connection|null $connection [optional] - * @return string A string containing the debug TTY of the connection. + * {@inheritdoc} + * @param PgSql\Connection|null $connection [optional] */ -function pg_tty (?PgSql\Connection $connection = null): string {} +function pg_tty (?PgSql\Connection $connection = NULL): string {} /** - * Returns the host name associated with the connection - * @link http://www.php.net/manual/en/function.pg-host.php - * @param PgSql\Connection|null $connection [optional] - * @return string A string containing the name of the host the - * connection is to, or an empty string on error. + * {@inheritdoc} + * @param PgSql\Connection|null $connection [optional] */ -function pg_host (?PgSql\Connection $connection = null): string {} +function pg_host (?PgSql\Connection $connection = NULL): string {} /** - * Returns an array with client, protocol and server version (when available) - * @link http://www.php.net/manual/en/function.pg-version.php - * @param PgSql\Connection|null $connection [optional] - * @return array Returns an array with client, protocol - * and server keys and values (if available). + * {@inheritdoc} + * @param PgSql\Connection|null $connection [optional] */ -function pg_version (?PgSql\Connection $connection = null): array {} +function pg_version (?PgSql\Connection $connection = NULL): array {} /** - * Looks up a current parameter setting of the server - * @link http://www.php.net/manual/en/function.pg-parameter-status.php - * @param PgSql\Connection $connection [optional] - * @param string $param_name - * @return string A string containing the value of the parameter, false on failure or invalid - * param_name. + * {@inheritdoc} + * @param mixed $connection + * @param string $name [optional] */ -function pg_parameter_status (PgSql\Connection $connection = null, string $param_name): string {} +function pg_parameter_status ($connection = null, string $name = NULL): string|false {} /** - * Ping database connection - * @link http://www.php.net/manual/en/function.pg-ping.php - * @param PgSql\Connection|null $connection [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param PgSql\Connection|null $connection [optional] */ -function pg_ping (?PgSql\Connection $connection = null): bool {} +function pg_ping (?PgSql\Connection $connection = NULL): bool {} /** - * Execute a query - * @link http://www.php.net/manual/en/function.pg-query.php - * @param PgSql\Connection $connection [optional] - * @param string $query - * @return PgSql\Result|false An PgSql\Result instance on success, or false on failure. + * {@inheritdoc} + * @param mixed $connection + * @param string $query [optional] */ -function pg_query (PgSql\Connection $connection = null, string $query): PgSql\Result|false {} +function pg_query ($connection = null, string $query = NULL): PgSql\Result|false {} /** * {@inheritdoc} @@ -175,41 +122,32 @@ function pg_query (PgSql\Connection $connection = null, string $query): PgSql\Re function pg_exec ($connection = null, string $query = NULL): PgSql\Result|false {} /** - * Submits a command to the server and waits for the result, with the ability to pass parameters separately from the SQL command text - * @link http://www.php.net/manual/en/function.pg-query-params.php - * @param PgSql\Connection $connection [optional] - * @param string $query - * @param array $params - * @return PgSql\Result|false An PgSql\Result instance on success, or false on failure. + * {@inheritdoc} + * @param mixed $connection + * @param mixed $query + * @param array $params [optional] */ -function pg_query_params (PgSql\Connection $connection = null, string $query, array $params): PgSql\Result|false {} +function pg_query_params ($connection = null, $query = null, array $params = NULL): PgSql\Result|false {} /** - * Submits a request to create a prepared statement with the - * given parameters, and waits for completion - * @link http://www.php.net/manual/en/function.pg-prepare.php - * @param PgSql\Connection $connection [optional] - * @param string $stmtname - * @param string $query - * @return PgSql\Result|false An PgSql\Result instance on success, or false on failure. + * {@inheritdoc} + * @param mixed $connection + * @param string $statement_name + * @param string $query [optional] */ -function pg_prepare (PgSql\Connection $connection = null, string $stmtname, string $query): PgSql\Result|false {} +function pg_prepare ($connection = null, string $statement_name, string $query = NULL): PgSql\Result|false {} /** - * Sends a request to execute a prepared statement with given parameters, and waits for the result - * @link http://www.php.net/manual/en/function.pg-execute.php - * @param PgSql\Connection $connection [optional] - * @param string $stmtname - * @param array $params - * @return PgSql\Result|false An PgSql\Result instance on success, or false on failure. + * {@inheritdoc} + * @param mixed $connection + * @param mixed $statement_name + * @param array $params [optional] */ -function pg_execute (PgSql\Connection $connection = null, string $stmtname, array $params): PgSql\Result|false {} +function pg_execute ($connection = null, $statement_name = null, array $params = NULL): PgSql\Result|false {} /** - * Returns the number of rows in a result - * @link http://www.php.net/manual/en/function.pg-num-rows.php - * @param PgSql\Result $result - * @return int The number of rows in the result. On error, -1 is returned. + * {@inheritdoc} + * @param PgSql\Result $result */ function pg_num_rows (PgSql\Result $result): int {} @@ -221,10 +159,8 @@ function pg_num_rows (PgSql\Result $result): int {} function pg_numrows (PgSql\Result $result): int {} /** - * Returns the number of fields in a result - * @link http://www.php.net/manual/en/function.pg-num-fields.php - * @param PgSql\Result $result - * @return int The number of fields (columns) in the result. On error, -1 is returned. + * {@inheritdoc} + * @param PgSql\Result $result */ function pg_num_fields (PgSql\Result $result): int {} @@ -236,11 +172,8 @@ function pg_num_fields (PgSql\Result $result): int {} function pg_numfields (PgSql\Result $result): int {} /** - * Returns number of affected records (tuples) - * @link http://www.php.net/manual/en/function.pg-affected-rows.php - * @param PgSql\Result $result - * @return int The number of rows affected by the query. If no tuple is - * affected, it will return 0. + * {@inheritdoc} + * @param PgSql\Result $result */ function pg_affected_rows (PgSql\Result $result): int {} @@ -252,34 +185,24 @@ function pg_affected_rows (PgSql\Result $result): int {} function pg_cmdtuples (PgSql\Result $result): int {} /** - * Returns the last notice message from PostgreSQL server - * @link http://www.php.net/manual/en/function.pg-last-notice.php - * @param PgSql\Connection $connection - * @param int $mode [optional] - * @return array|string|bool A string containing the last notice on the - * given connection with - * PGSQL_NOTICE_LAST, - * an array with PGSQL_NOTICE_ALL, - * a bool with PGSQL_NOTICE_CLEAR. + * {@inheritdoc} + * @param PgSql\Connection $connection + * @param int $mode [optional] */ -function pg_last_notice (PgSql\Connection $connection, int $mode = PGSQL_NOTICE_LAST): array|string|bool {} +function pg_last_notice (PgSql\Connection $connection, int $mode = 1): array|string|bool {} /** - * Returns the name or oid of the tables field - * @link http://www.php.net/manual/en/function.pg-field-table.php - * @param PgSql\Result $result - * @param int $field - * @param bool $oid_only [optional] - * @return string|int|false On success either the fields table name or oid, or false on failure. + * {@inheritdoc} + * @param PgSql\Result $result + * @param int $field + * @param bool $oid_only [optional] */ function pg_field_table (PgSql\Result $result, int $field, bool $oid_only = false): string|int|false {} /** - * Returns the name of a field - * @link http://www.php.net/manual/en/function.pg-field-name.php - * @param PgSql\Result $result - * @param int $field - * @return string The field name. + * {@inheritdoc} + * @param PgSql\Result $result + * @param int $field */ function pg_field_name (PgSql\Result $result, int $field): string {} @@ -292,12 +215,9 @@ function pg_field_name (PgSql\Result $result, int $field): string {} function pg_fieldname (PgSql\Result $result, int $field): string {} /** - * Returns the internal storage size of the named field - * @link http://www.php.net/manual/en/function.pg-field-size.php - * @param PgSql\Result $result - * @param int $field - * @return int The internal field storage size (in bytes). -1 indicates a variable - * length field. + * {@inheritdoc} + * @param PgSql\Result $result + * @param int $field */ function pg_field_size (PgSql\Result $result, int $field): int {} @@ -310,11 +230,9 @@ function pg_field_size (PgSql\Result $result, int $field): int {} function pg_fieldsize (PgSql\Result $result, int $field): int {} /** - * Returns the type name for the corresponding field number - * @link http://www.php.net/manual/en/function.pg-field-type.php - * @param PgSql\Result $result - * @param int $field - * @return string A string containing the base name of the field's type. + * {@inheritdoc} + * @param PgSql\Result $result + * @param int $field */ function pg_field_type (PgSql\Result $result, int $field): string {} @@ -327,20 +245,16 @@ function pg_field_type (PgSql\Result $result, int $field): string {} function pg_fieldtype (PgSql\Result $result, int $field): string {} /** - * Returns the type ID (OID) for the corresponding field number - * @link http://www.php.net/manual/en/function.pg-field-type-oid.php - * @param PgSql\Result $result - * @param int $field - * @return string|int The OID of the field's base type. + * {@inheritdoc} + * @param PgSql\Result $result + * @param int $field */ function pg_field_type_oid (PgSql\Result $result, int $field): string|int {} /** - * Returns the field number of the named field - * @link http://www.php.net/manual/en/function.pg-field-num.php - * @param PgSql\Result $result - * @param string $field - * @return int The field number (numbered from 0), or -1 on error. + * {@inheritdoc} + * @param PgSql\Result $result + * @param string $field */ function pg_field_num (PgSql\Result $result, string $field): int {} @@ -353,20 +267,12 @@ function pg_field_num (PgSql\Result $result, string $field): int {} function pg_fieldnum (PgSql\Result $result, string $field): int {} /** - * Returns values from a result instance - * @link http://www.php.net/manual/en/function.pg-fetch-result.php - * @param PgSql\Result $result - * @param int $row - * @param mixed $field - * @return string|false|null Boolean is returned as "t" or "f". All - * other types, including arrays are returned as strings formatted - * in the same default PostgreSQL manner that you would see in the - * psql program. Database NULL - * values are returned as null. - *false is returned if row exceeds the number - * of rows in the set, or on any other error.
+ * {@inheritdoc} + * @param PgSql\Result $result + * @param mixed $row + * @param string|int $field [optional] */ -function pg_fetch_result (PgSql\Result $result, int $row, mixed $field): string|false|null {} +function pg_fetch_result (PgSql\Result $result, $row = null, string|int $field = NULL): string|false|null {} /** * {@inheritdoc} @@ -378,102 +284,66 @@ function pg_fetch_result (PgSql\Result $result, int $row, mixed $field): string| function pg_result (PgSql\Result $result, $row = null, string|int $field = NULL): string|false|null {} /** - * Get a row as an enumerated array - * @link http://www.php.net/manual/en/function.pg-fetch-row.php - * @param PgSql\Result $result - * @param int|null $row [optional] - * @param int $mode [optional] - * @return array|false An array, indexed from 0 upwards, with each value - * represented as a string. Database NULL - * values are returned as null. - *false is returned if row exceeds the number - * of rows in the set, there are no more rows, or on any other error.
+ * {@inheritdoc} + * @param PgSql\Result $result + * @param int|null $row [optional] + * @param int $mode [optional] */ -function pg_fetch_row (PgSql\Result $result, ?int $row = null, int $mode = PGSQL_NUM): array|false {} +function pg_fetch_row (PgSql\Result $result, ?int $row = NULL, int $mode = 2): array|false {} /** - * Fetch a row as an associative array - * @link http://www.php.net/manual/en/function.pg-fetch-assoc.php - * @param PgSql\Result $result - * @param int|null $row [optional] - * @return array|false An array indexed associatively (by field name). - * Each value in the array is represented as a - * string. Database NULL - * values are returned as null. - *false is returned if row exceeds the number - * of rows in the set, there are no more rows, or on any other error.
+ * {@inheritdoc} + * @param PgSql\Result $result + * @param int|null $row [optional] */ -function pg_fetch_assoc (PgSql\Result $result, ?int $row = null): array|false {} +function pg_fetch_assoc (PgSql\Result $result, ?int $row = NULL): array|false {} /** - * Fetch a row as an array - * @link http://www.php.net/manual/en/function.pg-fetch-array.php - * @param PgSql\Result $result - * @param int|null $row [optional] - * @param int $mode [optional] - * @return array|false An array indexed numerically (beginning with 0) or - * associatively (indexed by field name), or both. - * Each value in the array is represented as a - * string. Database NULL - * values are returned as null. - *false is returned if row exceeds the number - * of rows in the set, there are no more rows, or on any other error. - * Fetching from the result of a query other than SELECT will also return false.
+ * {@inheritdoc} + * @param PgSql\Result $result + * @param int|null $row [optional] + * @param int $mode [optional] */ -function pg_fetch_array (PgSql\Result $result, ?int $row = null, int $mode = PGSQL_BOTH): array|false {} +function pg_fetch_array (PgSql\Result $result, ?int $row = NULL, int $mode = 3): array|false {} /** - * Fetch a row as an object - * @link http://www.php.net/manual/en/function.pg-fetch-object.php - * @param PgSql\Result $result - * @param int|null $row [optional] - * @param string $class [optional] - * @param array $constructor_args [optional] - * @return object|false An object with one attribute for each field - * name in the result. Database NULL - * values are returned as null. - *false is returned if row exceeds the number - * of rows in the set, there are no more rows, or on any other error.
+ * {@inheritdoc} + * @param PgSql\Result $result + * @param int|null $row [optional] + * @param string $class [optional] + * @param array $constructor_args [optional] */ -function pg_fetch_object (PgSql\Result $result, ?int $row = null, string $class = '"stdClass"', array $constructor_args = '[]'): object|false {} +function pg_fetch_object (PgSql\Result $result, ?int $row = NULL, string $class = 'stdClass', array $constructor_args = array ( +)): object|false {} /** - * Fetches all rows from a result as an array - * @link http://www.php.net/manual/en/function.pg-fetch-all.php - * @param PgSql\Result $result - * @param int $mode [optional] - * @return array An array with all rows in the result. Each row is an array - * of field values indexed by field name. + * {@inheritdoc} + * @param PgSql\Result $result + * @param int $mode [optional] */ -function pg_fetch_all (PgSql\Result $result, int $mode = PGSQL_ASSOC): array {} +function pg_fetch_all (PgSql\Result $result, int $mode = 1): array {} /** - * Fetches all rows in a particular result column as an array - * @link http://www.php.net/manual/en/function.pg-fetch-all-columns.php - * @param PgSql\Result $result - * @param int $field [optional] - * @return array An array with all values in the result column. + * {@inheritdoc} + * @param PgSql\Result $result + * @param int $field [optional] */ -function pg_fetch_all_columns (PgSql\Result $result, int $field = null): array {} +function pg_fetch_all_columns (PgSql\Result $result, int $field = 0): array {} /** - * Set internal row offset in result instance - * @link http://www.php.net/manual/en/function.pg-result-seek.php - * @param PgSql\Result $result - * @param int $row - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param PgSql\Result $result + * @param int $row */ function pg_result_seek (PgSql\Result $result, int $row): bool {} /** - * Returns the printed length - * @link http://www.php.net/manual/en/function.pg-field-prtlen.php - * @param PgSql\Result $result - * @param int $row_number - * @param mixed $field_name_or_number - * @return int The field printed length. + * {@inheritdoc} + * @param PgSql\Result $result + * @param mixed $row + * @param string|int $field [optional] */ -function pg_field_prtlen (PgSql\Result $result, int $row_number, mixed $field_name_or_number): int {} +function pg_field_prtlen (PgSql\Result $result, $row = null, string|int $field = NULL): int|false {} /** * {@inheritdoc} @@ -485,15 +355,12 @@ function pg_field_prtlen (PgSql\Result $result, int $row_number, mixed $field_na function pg_fieldprtlen (PgSql\Result $result, $row = null, string|int $field = NULL): int|false {} /** - * Test if a field is SQL NULL - * @link http://www.php.net/manual/en/function.pg-field-is-null.php - * @param PgSql\Result $result - * @param int $row - * @param mixed $field - * @return int Returns 1 if the field in the given row is SQL NULL, 0 - * if not. false is returned if the row is out of range, or upon any other error. + * {@inheritdoc} + * @param PgSql\Result $result + * @param mixed $row + * @param string|int $field [optional] */ -function pg_field_is_null (PgSql\Result $result, int $row, mixed $field): int {} +function pg_field_is_null (PgSql\Result $result, $row = null, string|int $field = NULL): int|false {} /** * {@inheritdoc} @@ -505,10 +372,8 @@ function pg_field_is_null (PgSql\Result $result, int $row, mixed $field): int {} function pg_fieldisnull (PgSql\Result $result, $row = null, string|int $field = NULL): int|false {} /** - * Free result memory - * @link http://www.php.net/manual/en/function.pg-free-result.php - * @param PgSql\Result $result - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param PgSql\Result $result */ function pg_free_result (PgSql\Result $result): bool {} @@ -520,12 +385,8 @@ function pg_free_result (PgSql\Result $result): bool {} function pg_freeresult (PgSql\Result $result): bool {} /** - * Returns the last row's OID - * @link http://www.php.net/manual/en/function.pg-last-oid.php - * @param PgSql\Result $result - * @return string|int|false An int or string containing the OID assigned to the most recently inserted - * row in the specified connection, or false on error or - * no available OID. + * {@inheritdoc} + * @param PgSql\Result $result */ function pg_last_oid (PgSql\Result $result): string|int|false {} @@ -537,31 +398,26 @@ function pg_last_oid (PgSql\Result $result): string|int|false {} function pg_getlastoid (PgSql\Result $result): string|int|false {} /** - * Enable tracing a PostgreSQL connection - * @link http://www.php.net/manual/en/function.pg-trace.php - * @param string $filename - * @param string $mode [optional] - * @param PgSql\Connection|null $connection [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $filename + * @param string $mode [optional] + * @param PgSql\Connection|null $connection [optional] + * @param int $trace_mode [optional] */ -function pg_trace (string $filename, string $mode = '"w"', ?PgSql\Connection $connection = null): bool {} +function pg_trace (string $filename, string $mode = 'w', ?PgSql\Connection $connection = NULL, int $trace_mode = 0): bool {} /** - * Disable tracing of a PostgreSQL connection - * @link http://www.php.net/manual/en/function.pg-untrace.php - * @param PgSql\Connection|null $connection [optional] - * @return true Always returns true. + * {@inheritdoc} + * @param PgSql\Connection|null $connection [optional] */ -function pg_untrace (?PgSql\Connection $connection = null): true {} +function pg_untrace (?PgSql\Connection $connection = NULL): true {} /** - * Create a large object - * @link http://www.php.net/manual/en/function.pg-lo-create.php - * @param PgSql\Connection $connection [optional] - * @param mixed $object_id [optional] - * @return int A large object OID, or false on failure. + * {@inheritdoc} + * @param mixed $connection [optional] + * @param mixed $oid [optional] */ -function pg_lo_create (PgSql\Connection $connection = null, mixed $object_id = null): int {} +function pg_lo_create ($connection = NULL, $oid = NULL): string|int|false {} /** * {@inheritdoc} @@ -572,13 +428,11 @@ function pg_lo_create (PgSql\Connection $connection = null, mixed $object_id = n function pg_locreate ($connection = NULL, $oid = NULL): string|int|false {} /** - * Delete a large object - * @link http://www.php.net/manual/en/function.pg-lo-unlink.php - * @param PgSql\Connection $connection - * @param int $oid - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mixed $connection + * @param mixed $oid [optional] */ -function pg_lo_unlink (PgSql\Connection $connection, int $oid): bool {} +function pg_lo_unlink ($connection = null, $oid = NULL): bool {} /** * {@inheritdoc} @@ -589,14 +443,12 @@ function pg_lo_unlink (PgSql\Connection $connection, int $oid): bool {} function pg_lounlink ($connection = null, $oid = NULL): bool {} /** - * Open a large object - * @link http://www.php.net/manual/en/function.pg-lo-open.php - * @param PgSql\Connection $connection - * @param int $oid - * @param string $mode - * @return PgSql\Lob|false An PgSql\Lob instance, or false on failure. + * {@inheritdoc} + * @param mixed $connection + * @param mixed $oid [optional] + * @param string $mode [optional] */ -function pg_lo_open (PgSql\Connection $connection, int $oid, string $mode): PgSql\Lob|false {} +function pg_lo_open ($connection = null, $oid = NULL, string $mode = NULL): PgSql\Lob|false {} /** * {@inheritdoc} @@ -608,10 +460,8 @@ function pg_lo_open (PgSql\Connection $connection, int $oid, string $mode): PgSq function pg_loopen ($connection = null, $oid = NULL, string $mode = NULL): PgSql\Lob|false {} /** - * Close a large object - * @link http://www.php.net/manual/en/function.pg-lo-close.php - * @param PgSql\Lob $lob - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param PgSql\Lob $lob */ function pg_lo_close (PgSql\Lob $lob): bool {} @@ -623,12 +473,9 @@ function pg_lo_close (PgSql\Lob $lob): bool {} function pg_loclose (PgSql\Lob $lob): bool {} /** - * Read a large object - * @link http://www.php.net/manual/en/function.pg-lo-read.php - * @param PgSql\Lob $lob - * @param int $length [optional] - * @return string|false A string containing length bytes from the - * large object, or false on error. + * {@inheritdoc} + * @param PgSql\Lob $lob + * @param int $length [optional] */ function pg_lo_read (PgSql\Lob $lob, int $length = 8192): string|false {} @@ -641,14 +488,12 @@ function pg_lo_read (PgSql\Lob $lob, int $length = 8192): string|false {} function pg_loread (PgSql\Lob $lob, int $length = 8192): string|false {} /** - * Write to a large object - * @link http://www.php.net/manual/en/function.pg-lo-write.php - * @param PgSql\Lob $lob - * @param string $data - * @param int|null $length [optional] - * @return int|false The number of bytes written to the large object, or false on error. + * {@inheritdoc} + * @param PgSql\Lob $lob + * @param string $data + * @param int|null $length [optional] */ -function pg_lo_write (PgSql\Lob $lob, string $data, ?int $length = null): int|false {} +function pg_lo_write (PgSql\Lob $lob, string $data, ?int $length = NULL): int|false {} /** * {@inheritdoc} @@ -660,10 +505,8 @@ function pg_lo_write (PgSql\Lob $lob, string $data, ?int $length = null): int|fa function pg_lowrite (PgSql\Lob $lob, string $data, ?int $length = NULL): int|false {} /** - * Reads an entire large object and send straight to browser - * @link http://www.php.net/manual/en/function.pg-lo-read-all.php - * @param PgSql\Lob $lob - * @return int Number of bytes read. + * {@inheritdoc} + * @param PgSql\Lob $lob */ function pg_lo_read_all (PgSql\Lob $lob): int {} @@ -675,14 +518,12 @@ function pg_lo_read_all (PgSql\Lob $lob): int {} function pg_loreadall (PgSql\Lob $lob): int {} /** - * Import a large object from file - * @link http://www.php.net/manual/en/function.pg-lo-import.php - * @param PgSql\Connection $connection [optional] - * @param string $pathname - * @param mixed $object_id [optional] - * @return int The OID of the newly created large object, or false on failure. + * {@inheritdoc} + * @param mixed $connection + * @param mixed $filename [optional] + * @param mixed $oid [optional] */ -function pg_lo_import (PgSql\Connection $connection = null, string $pathname, mixed $object_id = null): int {} +function pg_lo_import ($connection = null, $filename = NULL, $oid = NULL): string|int|false {} /** * {@inheritdoc} @@ -694,14 +535,12 @@ function pg_lo_import (PgSql\Connection $connection = null, string $pathname, mi function pg_loimport ($connection = null, $filename = NULL, $oid = NULL): string|int|false {} /** - * Export a large object to file - * @link http://www.php.net/manual/en/function.pg-lo-export.php - * @param PgSql\Connection $connection [optional] - * @param int $oid - * @param string $pathname - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mixed $connection + * @param mixed $oid [optional] + * @param mixed $filename [optional] */ -function pg_lo_export (PgSql\Connection $connection = null, int $oid, string $pathname): bool {} +function pg_lo_export ($connection = null, $oid = NULL, $filename = NULL): bool {} /** * {@inheritdoc} @@ -713,53 +552,39 @@ function pg_lo_export (PgSql\Connection $connection = null, int $oid, string $pa function pg_loexport ($connection = null, $oid = NULL, $filename = NULL): bool {} /** - * Seeks position within a large object - * @link http://www.php.net/manual/en/function.pg-lo-seek.php - * @param PgSql\Lob $lob - * @param int $offset - * @param int $whence [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param PgSql\Lob $lob + * @param int $offset + * @param int $whence [optional] */ -function pg_lo_seek (PgSql\Lob $lob, int $offset, int $whence = SEEK_CUR): bool {} +function pg_lo_seek (PgSql\Lob $lob, int $offset, int $whence = 1): bool {} /** - * Returns current seek position a of large object - * @link http://www.php.net/manual/en/function.pg-lo-tell.php - * @param PgSql\Lob $lob - * @return int The current seek offset (in number of bytes) from the beginning of the large - * object. If there is an error, the return value is negative. + * {@inheritdoc} + * @param PgSql\Lob $lob */ function pg_lo_tell (PgSql\Lob $lob): int {} /** - * Truncates a large object - * @link http://www.php.net/manual/en/function.pg-lo-truncate.php - * @param PgSql\Lob $lob - * @param int $size - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param PgSql\Lob $lob + * @param int $size */ function pg_lo_truncate (PgSql\Lob $lob, int $size): bool {} /** - * Determines the verbosity of messages returned by pg_last_error - * and pg_result_error - * @link http://www.php.net/manual/en/function.pg-set-error-verbosity.php - * @param PgSql\Connection $connection [optional] - * @param int $verbosity - * @return int The previous verbosity level: PGSQL_ERRORS_TERSE, - * PGSQL_ERRORS_DEFAULT - * or PGSQL_ERRORS_VERBOSE. + * {@inheritdoc} + * @param mixed $connection + * @param int $verbosity [optional] */ -function pg_set_error_verbosity (PgSql\Connection $connection = null, int $verbosity): int {} +function pg_set_error_verbosity ($connection = null, int $verbosity = NULL): int|false {} /** - * Set the client encoding - * @link http://www.php.net/manual/en/function.pg-set-client-encoding.php - * @param PgSql\Connection $connection [optional] - * @param string $encoding - * @return int Returns 0 on success or -1 on error. + * {@inheritdoc} + * @param mixed $connection + * @param string $encoding [optional] */ -function pg_set_client_encoding (PgSql\Connection $connection = null, string $encoding): int {} +function pg_set_client_encoding ($connection = null, string $encoding = NULL): int {} /** * {@inheritdoc} @@ -770,12 +595,10 @@ function pg_set_client_encoding (PgSql\Connection $connection = null, string $en function pg_setclientencoding ($connection = null, string $encoding = NULL): int {} /** - * Gets the client encoding - * @link http://www.php.net/manual/en/function.pg-client-encoding.php - * @param PgSql\Connection|null $connection [optional] - * @return string The client encoding. + * {@inheritdoc} + * @param PgSql\Connection|null $connection [optional] */ -function pg_client_encoding (?PgSql\Connection $connection = null): string {} +function pg_client_encoding (?PgSql\Connection $connection = NULL): string {} /** * {@inheritdoc} @@ -785,911 +608,327 @@ function pg_client_encoding (?PgSql\Connection $connection = null): string {} function pg_clientencoding (?PgSql\Connection $connection = NULL): string {} /** - * Sync with PostgreSQL backend - * @link http://www.php.net/manual/en/function.pg-end-copy.php - * @param PgSql\Connection|null $connection [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param PgSql\Connection|null $connection [optional] */ -function pg_end_copy (?PgSql\Connection $connection = null): bool {} +function pg_end_copy (?PgSql\Connection $connection = NULL): bool {} /** - * Send a NULL-terminated string to PostgreSQL backend - * @link http://www.php.net/manual/en/function.pg-put-line.php - * @param PgSql\Connection $connection [optional] - * @param string $data - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mixed $connection + * @param string $query [optional] */ -function pg_put_line (PgSql\Connection $connection = null, string $data): bool {} +function pg_put_line ($connection = null, string $query = NULL): bool {} /** - * Copy a table to an array - * @link http://www.php.net/manual/en/function.pg-copy-to.php - * @param PgSql\Connection $connection - * @param string $table_name - * @param string $separator [optional] - * @param string $null_as [optional] - * @return array|false An array with one element for each line of COPY data, or false on failure. + * {@inheritdoc} + * @param PgSql\Connection $connection + * @param string $table_name + * @param string $separator [optional] + * @param string $null_as [optional] */ -function pg_copy_to (PgSql\Connection $connection, string $table_name, string $separator = '"\\t"', string $null_as = '"\\\\\\\\N"'): array|false {} +function pg_copy_to (PgSql\Connection $connection, string $table_name, string $separator = ' ', string $null_as = '\\\\N'): array|false {} /** - * Insert records into a table from an array - * @link http://www.php.net/manual/en/function.pg-copy-from.php - * @param PgSql\Connection $connection - * @param string $table_name - * @param array $rows - * @param string $separator [optional] - * @param string $null_as [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param PgSql\Connection $connection + * @param string $table_name + * @param array $rows + * @param string $separator [optional] + * @param string $null_as [optional] */ -function pg_copy_from (PgSql\Connection $connection, string $table_name, array $rows, string $separator = '"\\t"', string $null_as = '"\\\\\\\\N"'): bool {} +function pg_copy_from (PgSql\Connection $connection, string $table_name, array $rows, string $separator = ' ', string $null_as = '\\\\N'): bool {} /** - * Escape a string for query - * @link http://www.php.net/manual/en/function.pg-escape-string.php - * @param PgSql\Connection $connection [optional] - * @param string $data - * @return string A string containing the escaped data. + * {@inheritdoc} + * @param mixed $connection + * @param string $string [optional] */ -function pg_escape_string (PgSql\Connection $connection = null, string $data): string {} +function pg_escape_string ($connection = null, string $string = NULL): string {} /** - * Escape a string for insertion into a bytea field - * @link http://www.php.net/manual/en/function.pg-escape-bytea.php - * @param PgSql\Connection $connection [optional] - * @param string $data - * @return string A string containing the escaped data. + * {@inheritdoc} + * @param mixed $connection + * @param string $string [optional] */ -function pg_escape_bytea (PgSql\Connection $connection = null, string $data): string {} +function pg_escape_bytea ($connection = null, string $string = NULL): string {} /** - * Unescape binary for bytea type - * @link http://www.php.net/manual/en/function.pg-unescape-bytea.php - * @param string $string - * @return string A string containing the unescaped data. + * {@inheritdoc} + * @param string $string */ function pg_unescape_bytea (string $string): string {} /** - * Escape a literal for insertion into a text field - * @link http://www.php.net/manual/en/function.pg-escape-literal.php - * @param PgSql\Connection $connection [optional] - * @param string $data - * @return string A string containing the escaped data. + * {@inheritdoc} + * @param mixed $connection + * @param string $string [optional] */ -function pg_escape_literal (PgSql\Connection $connection = null, string $data): string {} +function pg_escape_literal ($connection = null, string $string = NULL): string|false {} /** - * Escape a identifier for insertion into a text field - * @link http://www.php.net/manual/en/function.pg-escape-identifier.php - * @param PgSql\Connection $connection [optional] - * @param string $data - * @return string A string containing the escaped data. + * {@inheritdoc} + * @param mixed $connection + * @param string $string [optional] */ -function pg_escape_identifier (PgSql\Connection $connection = null, string $data): string {} +function pg_escape_identifier ($connection = null, string $string = NULL): string|false {} /** - * Get error message associated with result - * @link http://www.php.net/manual/en/function.pg-result-error.php - * @param PgSql\Result $result - * @return string|false Returns a string. Returns empty string if there is no error. If there is an error associated with the - * result parameter, returns false. + * {@inheritdoc} + * @param PgSql\Result $result */ function pg_result_error (PgSql\Result $result): string|false {} /** - * Returns an individual field of an error report - * @link http://www.php.net/manual/en/function.pg-result-error-field.php - * @param PgSql\Result $result - * @param int $field_code - * @return string|false|null A string containing the contents of the error field, null if the field does not exist or false - * on failure. + * {@inheritdoc} + * @param PgSql\Result $result + * @param int $field_code */ function pg_result_error_field (PgSql\Result $result, int $field_code): string|false|null {} /** - * Get connection status - * @link http://www.php.net/manual/en/function.pg-connection-status.php - * @param PgSql\Connection $connection - * @return int PGSQL_CONNECTION_OK or - * PGSQL_CONNECTION_BAD. + * {@inheritdoc} + * @param PgSql\Connection $connection */ function pg_connection_status (PgSql\Connection $connection): int {} /** - * Returns the current in-transaction status of the server - * @link http://www.php.net/manual/en/function.pg-transaction-status.php - * @param PgSql\Connection $connection - * @return int The status can be PGSQL_TRANSACTION_IDLE (currently idle), - * PGSQL_TRANSACTION_ACTIVE (a command is in progress), - * PGSQL_TRANSACTION_INTRANS (idle, in a valid transaction block), - * or PGSQL_TRANSACTION_INERROR (idle, in a failed transaction block). - * PGSQL_TRANSACTION_UNKNOWN is reported if the connection is bad. - * PGSQL_TRANSACTION_ACTIVE is reported only when a query - * has been sent to the server and not yet completed. + * {@inheritdoc} + * @param PgSql\Connection $connection */ function pg_transaction_status (PgSql\Connection $connection): int {} /** - * Reset connection (reconnect) - * @link http://www.php.net/manual/en/function.pg-connection-reset.php - * @param PgSql\Connection $connection - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param PgSql\Connection $connection */ function pg_connection_reset (PgSql\Connection $connection): bool {} /** - * Cancel an asynchronous query - * @link http://www.php.net/manual/en/function.pg-cancel-query.php - * @param PgSql\Connection $connection - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param PgSql\Connection $connection */ function pg_cancel_query (PgSql\Connection $connection): bool {} /** - * Get connection is busy or not - * @link http://www.php.net/manual/en/function.pg-connection-busy.php - * @param PgSql\Connection $connection - * @return bool Returns true if the connection is busy, false otherwise. + * {@inheritdoc} + * @param PgSql\Connection $connection */ function pg_connection_busy (PgSql\Connection $connection): bool {} /** - * Sends asynchronous query - * @link http://www.php.net/manual/en/function.pg-send-query.php - * @param PgSql\Connection $connection - * @param string $query - * @return int|bool Returns true on success, false or 0 on failure. Use pg_get_result - * to determine the query result. + * {@inheritdoc} + * @param PgSql\Connection $connection + * @param string $query */ function pg_send_query (PgSql\Connection $connection, string $query): int|bool {} /** - * Submits a command and separate parameters to the server without waiting for the result(s) - * @link http://www.php.net/manual/en/function.pg-send-query-params.php - * @param PgSql\Connection $connection - * @param string $query - * @param array $params - * @return int|bool Returns true on success, false or 0 on failure. Use pg_get_result - * to determine the query result. + * {@inheritdoc} + * @param PgSql\Connection $connection + * @param string $query + * @param array $params */ function pg_send_query_params (PgSql\Connection $connection, string $query, array $params): int|bool {} /** - * Sends a request to create a prepared statement with the given parameters, without waiting for completion - * @link http://www.php.net/manual/en/function.pg-send-prepare.php - * @param PgSql\Connection $connection - * @param string $statement_name - * @param string $query - * @return int|bool Returns true on success, false or 0 on failure. Use pg_get_result - * to determine the query result. + * {@inheritdoc} + * @param PgSql\Connection $connection + * @param string $statement_name + * @param string $query */ function pg_send_prepare (PgSql\Connection $connection, string $statement_name, string $query): int|bool {} /** - * Sends a request to execute a prepared statement with given parameters, without waiting for the result(s) - * @link http://www.php.net/manual/en/function.pg-send-execute.php - * @param PgSql\Connection $connection - * @param string $statement_name - * @param array $params - * @return int|bool Returns true on success, false or 0 on failure. Use pg_get_result - * to determine the query result. + * {@inheritdoc} + * @param PgSql\Connection $connection + * @param string $statement_name + * @param array $params */ function pg_send_execute (PgSql\Connection $connection, string $statement_name, array $params): int|bool {} /** - * Get asynchronous query result - * @link http://www.php.net/manual/en/function.pg-get-result.php - * @param PgSql\Connection $connection - * @return PgSql\Result|false An PgSql\Result instance, or false if no more results are available. + * {@inheritdoc} + * @param PgSql\Connection $connection */ function pg_get_result (PgSql\Connection $connection): PgSql\Result|false {} /** - * Get status of query result - * @link http://www.php.net/manual/en/function.pg-result-status.php - * @param PgSql\Result $result - * @param int $mode [optional] - * @return string|int Possible return values are PGSQL_EMPTY_QUERY, - * PGSQL_COMMAND_OK, PGSQL_TUPLES_OK, PGSQL_COPY_OUT, - * PGSQL_COPY_IN, PGSQL_BAD_RESPONSE, PGSQL_NONFATAL_ERROR and - * PGSQL_FATAL_ERROR if PGSQL_STATUS_LONG is - * specified. Otherwise, a string containing the PostgreSQL command tag is returned. + * {@inheritdoc} + * @param PgSql\Result $result + * @param int $mode [optional] */ -function pg_result_status (PgSql\Result $result, int $mode = PGSQL_STATUS_LONG): string|int {} +function pg_result_status (PgSql\Result $result, int $mode = 1): string|int {} /** - * Gets SQL NOTIFY message - * @link http://www.php.net/manual/en/function.pg-get-notify.php - * @param PgSql\Connection $connection - * @param int $mode [optional] - * @return array|false An array containing the NOTIFY message name and backend PID. - * If supported by the server, the array also contains the server version and the payload. - * Otherwise if no NOTIFY is waiting, then false is returned. + * {@inheritdoc} + * @param PgSql\Connection $connection + * @param int $mode [optional] */ -function pg_get_notify (PgSql\Connection $connection, int $mode = PGSQL_ASSOC): array|false {} +function pg_get_notify (PgSql\Connection $connection, int $mode = 1): array|false {} /** - * Gets the backend's process ID - * @link http://www.php.net/manual/en/function.pg-get-pid.php - * @param PgSql\Connection $connection - * @return int The backend database process ID. + * {@inheritdoc} + * @param PgSql\Connection $connection */ function pg_get_pid (PgSql\Connection $connection): int {} /** - * Get a read only handle to the socket underlying a PostgreSQL connection - * @link http://www.php.net/manual/en/function.pg-socket.php - * @param PgSql\Connection $connection >An PgSql\Connection instance. - * @return resource|false A socket resource on success or false on failure. + * {@inheritdoc} + * @param PgSql\Connection $connection */ function pg_socket (PgSql\Connection $connection) {} /** - * Reads input on the connection - * @link http://www.php.net/manual/en/function.pg-consume-input.php - * @param PgSql\Connection $connection >An PgSql\Connection instance. - * @return bool true if no error occurred, or false if there was an error. Note that - * true does not necessarily indicate that input was waiting to be read. + * {@inheritdoc} + * @param PgSql\Connection $connection */ function pg_consume_input (PgSql\Connection $connection): bool {} /** - * Flush outbound query data on the connection - * @link http://www.php.net/manual/en/function.pg-flush.php - * @param PgSql\Connection $connection >An PgSql\Connection instance. - * @return int|bool Returns true if the flush was successful or no data was waiting to be - * flushed, 0 if part of the pending data was flushed but - * more remains or false on failure. + * {@inheritdoc} + * @param PgSql\Connection $connection */ function pg_flush (PgSql\Connection $connection): int|bool {} /** - * Get meta data for table - * @link http://www.php.net/manual/en/function.pg-meta-data.php - * @param PgSql\Connection $connection - * @param string $table_name - * @param bool $extended [optional] - * @return array|false An array of the table definition, or false on failure. + * {@inheritdoc} + * @param PgSql\Connection $connection + * @param string $table_name + * @param bool $extended [optional] */ function pg_meta_data (PgSql\Connection $connection, string $table_name, bool $extended = false): array|false {} /** - * Convert associative array values into forms suitable for SQL statements - * @link http://www.php.net/manual/en/function.pg-convert.php - * @param PgSql\Connection $connection - * @param string $table_name - * @param array $values - * @param int $flags [optional] - * @return array|false An array of converted values, or false on failure. - */ -function pg_convert (PgSql\Connection $connection, string $table_name, array $values, int $flags = null): array|false {} - -/** - * Insert array into table - * @link http://www.php.net/manual/en/function.pg-insert.php - * @param PgSql\Connection $connection - * @param string $table_name - * @param array $values - * @param int $flags [optional] - * @return PgSql\Result|string|bool Returns true on success or false on failure.. Or returns a string on success if PGSQL_DML_STRING is passed - * via flags. + * {@inheritdoc} + * @param PgSql\Connection $connection + * @param string $table_name + * @param array $values + * @param int $flags [optional] */ -function pg_insert (PgSql\Connection $connection, string $table_name, array $values, int $flags = PGSQL_DML_EXEC): PgSql\Result|string|bool {} +function pg_convert (PgSql\Connection $connection, string $table_name, array $values, int $flags = 0): array|false {} /** - * Update table - * @link http://www.php.net/manual/en/function.pg-update.php - * @param PgSql\Connection $connection - * @param string $table_name - * @param array $values - * @param array $conditions - * @param int $flags [optional] - * @return string|bool Returns true on success or false on failure. Returns string if PGSQL_DML_STRING is passed - * via flags. + * {@inheritdoc} + * @param PgSql\Connection $connection + * @param string $table_name + * @param array $values + * @param int $flags [optional] */ -function pg_update (PgSql\Connection $connection, string $table_name, array $values, array $conditions, int $flags = PGSQL_DML_EXEC): string|bool {} +function pg_insert (PgSql\Connection $connection, string $table_name, array $values, int $flags = 512): PgSql\Result|string|bool {} /** - * Deletes records - * @link http://www.php.net/manual/en/function.pg-delete.php - * @param PgSql\Connection $connection - * @param string $table_name - * @param array $conditions - * @param int $flags [optional] - * @return string|bool Returns true on success or false on failure. Returns string if PGSQL_DML_STRING is passed - * via flags. + * {@inheritdoc} + * @param PgSql\Connection $connection + * @param string $table_name + * @param array $values + * @param array $conditions + * @param int $flags [optional] */ -function pg_delete (PgSql\Connection $connection, string $table_name, array $conditions, int $flags = PGSQL_DML_EXEC): string|bool {} +function pg_update (PgSql\Connection $connection, string $table_name, array $values, array $conditions, int $flags = 512): string|bool {} /** - * Select records - * @link http://www.php.net/manual/en/function.pg-select.php - * @param PgSql\Connection $connection - * @param string $table_name - * @param array $conditions - * @param int $flags [optional] - * @param int $mode [optional] - * @return array|string|false Returns string if PGSQL_DML_STRING is passed - * via flags, otherwise it returns an array on success, or false on failure. + * {@inheritdoc} + * @param PgSql\Connection $connection + * @param string $table_name + * @param array $conditions + * @param int $flags [optional] */ -function pg_select (PgSql\Connection $connection, string $table_name, array $conditions, int $flags = PGSQL_DML_EXEC, int $mode = PGSQL_ASSOC): array|string|false {} - +function pg_delete (PgSql\Connection $connection, string $table_name, array $conditions, int $flags = 512): string|bool {} /** - * Short libpq version that contains only numbers and dots. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var string + * {@inheritdoc} + * @param PgSql\Connection $connection + * @param string $table_name + * @param array $conditions + * @param int $flags [optional] + * @param int $mode [optional] */ -define ('PGSQL_LIBPQ_VERSION', 15.3); +function pg_select (PgSql\Connection $connection, string $table_name, array $conditions, int $flags = 512, int $mode = 1): array|string|false {} /** - * Prior to PHP 8.0.0, the long libpq version that includes compiler information. - * As of PHP 8.0.0, the value is identical to PGSQL_LIBPQ_VERSION, - * and using PGSQL_LIBPQ_VERSION_STR is deprecated. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var string + * {@inheritdoc} + * @param PgSql\Connection $connection + * @param int $visibility */ -define ('PGSQL_LIBPQ_VERSION_STR', 15.3); +function pg_set_error_context_visibility (PgSql\Connection $connection, int $visibility): int {} -/** - * Passed to pg_connect to force the creation of a new connection, - * rather than re-using an existing identical connection. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ +define ('PGSQL_LIBPQ_VERSION', 16.1); +define ('PGSQL_LIBPQ_VERSION_STR', 16.1); define ('PGSQL_CONNECT_FORCE_NEW', 2); - -/** - * Passed to pg_connect to create an asynchronous - * connection. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_CONNECT_ASYNC', 4); - -/** - * Passed to pg_fetch_array. Return an associative array of field - * names and values. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_ASSOC', 1); - -/** - * Passed to pg_fetch_array. Return a numerically indexed array of field - * numbers and values. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_NUM', 2); - -/** - * Passed to pg_fetch_array. Return an array of field values - * that is both numerically indexed (by field number) and associated (by field name). - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_BOTH', 3); - -/** - * Used by pg_last_notice. - * Available since PHP 7.1.0. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_NOTICE_LAST', 1); - -/** - * Used by pg_last_notice. - * Available since PHP 7.1.0. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_NOTICE_ALL', 2); - -/** - * Used by pg_last_notice. - * Available since PHP 7.1.0. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_NOTICE_CLEAR', 3); - -/** - * Returned by pg_connection_status indicating that the database - * connection is in an invalid state. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_CONNECTION_BAD', 1); - -/** - * Returned by pg_connection_status indicating that the database - * connection is in a valid state. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_CONNECTION_OK', 0); - -/** - * - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_CONNECTION_STARTED', 2); - -/** - * - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_CONNECTION_MADE', 3); - -/** - * - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_CONNECTION_AWAITING_RESPONSE', 4); - -/** - * - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_CONNECTION_AUTH_OK', 5); - -/** - * - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_CONNECTION_SETENV', 6); - -/** - * Returned by pg_connect_poll to indicate that the - * connection attempt failed. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_POLLING_FAILED', 0); - -/** - * Returned by pg_connect_poll to indicate that the - * connection is waiting for the PostgreSQL socket to be readable. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_POLLING_READING', 1); - -/** - * Returned by pg_connect_poll to indicate that the - * connection is waiting for the PostgreSQL socket to be writable. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_POLLING_WRITING', 2); - -/** - * Returned by pg_connect_poll to indicate that the - * connection is ready to be used. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_POLLING_OK', 3); - -/** - * Returned by pg_connect_poll to indicate that the - * connection is currently active. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_POLLING_ACTIVE', 4); - -/** - * Returned by pg_transaction_status. Connection is - * currently idle, not in a transaction. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_TRANSACTION_IDLE', 0); - -/** - * Returned by pg_transaction_status. A command - * is in progress on the connection. A query has been sent via the connection - * and not yet completed. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_TRANSACTION_ACTIVE', 1); - -/** - * Returned by pg_transaction_status. The connection - * is idle, in a transaction block. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_TRANSACTION_INTRANS', 2); - -/** - * Returned by pg_transaction_status. The connection - * is idle, in a failed transaction block. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_TRANSACTION_INERROR', 3); - -/** - * Returned by pg_transaction_status. The connection - * is bad. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_TRANSACTION_UNKNOWN', 4); - -/** - * Passed to pg_set_error_verbosity. - * Specified that returned messages include severity, primary text, - * and position only; this will normally fit on a single line. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_ERRORS_TERSE', 0); - -/** - * Passed to pg_set_error_verbosity. - * The default mode produces messages that include the above - * plus any detail, hint, or context fields (these may span - * multiple lines). - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_ERRORS_DEFAULT', 1); - -/** - * Passed to pg_set_error_verbosity. - * The verbose mode includes all available fields. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_ERRORS_VERBOSE', 2); - -/** - * Passed to pg_lo_seek. Seek operation is to begin - * from the start of the object. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ +define ('PGSQL_ERRORS_SQLSTATE', 0); define ('PGSQL_SEEK_SET', 0); - -/** - * Passed to pg_lo_seek. Seek operation is to begin - * from the current position. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_SEEK_CUR', 1); - -/** - * Passed to pg_lo_seek. Seek operation is to begin - * from the end of the object. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_SEEK_END', 2); - -/** - * Passed to pg_result_status. Indicates that - * numerical result code is desired. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_STATUS_LONG', 1); - -/** - * Passed to pg_result_status. Indicates that - * textual result command tag is desired. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_STATUS_STRING', 2); - -/** - * Returned by pg_result_status. The string sent to the server - * was empty. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_EMPTY_QUERY', 0); - -/** - * Returned by pg_result_status. Successful completion of a - * command returning no data. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_COMMAND_OK', 1); - -/** - * Returned by pg_result_status. Successful completion of a command - * returning data (such as a SELECT or SHOW). - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_TUPLES_OK', 2); - -/** - * Returned by pg_result_status. Copy Out (from server) data - * transfer started. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_COPY_OUT', 3); - -/** - * Returned by pg_result_status. Copy In (to server) data - * transfer started. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_COPY_IN', 4); - -/** - * Returned by pg_result_status. The server's response - * was not understood. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_BAD_RESPONSE', 5); - -/** - * Returned by pg_result_status. A nonfatal error - * (a notice or warning) occurred. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_NONFATAL_ERROR', 6); - -/** - * Returned by pg_result_status. A fatal error - * occurred. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_FATAL_ERROR', 7); - -/** - * Passed to pg_result_error_field. - * The severity; the field contents are ERROR, - * FATAL, or PANIC (in an error message), or - * WARNING, NOTICE, DEBUG, - * INFO, or LOG (in a notice message), or a localized - * translation of one of these. Always present. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_DIAG_SEVERITY', 83); - -/** - * Passed to pg_result_error_field. - * The SQLSTATE code for the error. The SQLSTATE code identifies the type of error - * that has occurred; it can be used by front-end applications to perform specific - * operations (such as error handling) in response to a particular database error. - * This field is not localizable, and is always present. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_DIAG_SQLSTATE', 67); - -/** - * Passed to pg_result_error_field. - * The primary human-readable error message (typically one line). Always present. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_DIAG_MESSAGE_PRIMARY', 77); - -/** - * Passed to pg_result_error_field. - * Detail: an optional secondary error message carrying more detail about the problem. May run to multiple lines. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_DIAG_MESSAGE_DETAIL', 68); - -/** - * Passed to pg_result_error_field. - * Hint: an optional suggestion what to do about the problem. This is intended to differ from detail in that it - * offers advice (potentially inappropriate) rather than hard facts. May run to multiple lines. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_DIAG_MESSAGE_HINT', 72); - -/** - * Passed to pg_result_error_field. - * A string containing a decimal integer indicating an error cursor position as an index into the original - * statement string. The first character has index 1, and positions are measured in characters not bytes. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_DIAG_STATEMENT_POSITION', 80); - -/** - * Passed to pg_result_error_field. - * This is defined the same as the PG_DIAG_STATEMENT_POSITION field, but - * it is used when the cursor position refers to an internally generated - * command rather than the one submitted by the client. The - * PG_DIAG_INTERNAL_QUERY field will always appear when this - * field appears. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_DIAG_INTERNAL_POSITION', 112); - -/** - * Passed to pg_result_error_field. - * The text of a failed internally-generated command. This could be, for example, a - * SQL query issued by a PL/pgSQL function. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_DIAG_INTERNAL_QUERY', 113); - -/** - * Passed to pg_result_error_field. - * An indication of the context in which the error occurred. Presently - * this includes a call stack traceback of active procedural language - * functions and internally-generated queries. The trace is one entry - * per line, most recent first. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_DIAG_CONTEXT', 87); - -/** - * Passed to pg_result_error_field. - * The file name of the PostgreSQL source-code location where the error - * was reported. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_DIAG_SOURCE_FILE', 70); - -/** - * Passed to pg_result_error_field. - * The line number of the PostgreSQL source-code location where the - * error was reported. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_DIAG_SOURCE_LINE', 76); - -/** - * Passed to pg_result_error_field. - * The name of the PostgreSQL source-code function reporting the error. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_DIAG_SOURCE_FUNCTION', 82); - -/** - * Available since PHP 7.3.0. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var string - */ define ('PGSQL_DIAG_SCHEMA_NAME', 115); - -/** - * Available since PHP 7.3.0. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var string - */ define ('PGSQL_DIAG_TABLE_NAME', 116); - -/** - * Available since PHP 7.3.0. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var string - */ define ('PGSQL_DIAG_COLUMN_NAME', 99); - -/** - * Available since PHP 7.3.0. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var string - */ define ('PGSQL_DIAG_DATATYPE_NAME', 100); - -/** - * Available since PHP 7.3.0. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var string - */ define ('PGSQL_DIAG_CONSTRAINT_NAME', 110); - -/** - * The severity; the field contents are ERROR, FATAL, or PANIC (in an error message), or WARNING, NOTICE, DEBUG, INFO, or LOG (in a notice message). This is identical to the PG_DIAG_SEVERITY field except that the contents are never localized. This is present only in versions 9.6 and later / PHP 7.3.0 and later. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_DIAG_SEVERITY_NONLOCALIZED', 86); - -/** - * Passed to pg_convert. - * Ignore default values in the table during conversion. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_CONV_IGNORE_DEFAULT', 2); - -/** - * Passed to pg_convert. - * Use SQL NULL in place of an empty string. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_CONV_FORCE_NULL', 4); - -/** - * Passed to pg_convert. - * Ignore conversion of null into SQL NOT NULL columns. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_CONV_IGNORE_NOT_NULL', 8); - -/** - * Passed to pg_insert, pg_select, - * pg_update and pg_delete. - * Apply escape to all parameters instead of calling pg_convert - * internally. This option omits meta data look up. Query could be as fast as - * pg_query and pg_send_query. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_DML_ESCAPE', 4096); - -/** - * Passed to pg_insert, pg_select, - * pg_update and pg_delete. - * All parameters passed as is. Manual escape is required - * if parameters contain user supplied data. Use pg_escape_string - * for it. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_DML_NO_CONV', 256); - -/** - * Passed to pg_insert, pg_select, - * pg_update and pg_delete. - * Execute query by these functions. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_DML_EXEC', 512); - -/** - * Passed to pg_insert, pg_select, - * pg_update and pg_delete. - * Execute asynchronous query by these functions. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_DML_ASYNC', 1024); - -/** - * Passed to pg_insert, pg_select, - * pg_update and pg_delete. - * Return executed query string. - * @link http://www.php.net/manual/en/pgsql.constants.php - * @var int - */ define ('PGSQL_DML_STRING', 2048); +define ('PGSQL_TRACE_REGRESS_MODE', 2); +define ('PGSQL_SHOW_CONTEXT_NEVER', 0); +define ('PGSQL_SHOW_CONTEXT_ERRORS', 1); +define ('PGSQL_SHOW_CONTEXT_ALWAYS', 2); } -// End of pgsql v.8.2.6 +// End of pgsql v.8.3.0 diff --git a/plugins/org.eclipse.php.core/Resources/language/php8.3/posix.php b/plugins/org.eclipse.php.core/Resources/language/php8.3/posix.php index b0bb91d3ec..feafcccf7c 100644 --- a/plugins/org.eclipse.php.core/Resources/language/php8.3/posix.php +++ b/plugins/org.eclipse.php.core/Resources/language/php8.3/posix.php @@ -1,791 +1,276 @@ - *domainname is a GNU extension and not part of POSIX.1, so this - * field is only available on GNU systems or when using the GNU - * libc.
- *The function returns false on failure.
+ * {@inheritdoc} */ function posix_uname (): array|false {} /** - * Get process times - * @link http://www.php.net/manual/en/function.posix-times.php - * @return array|false Returns a hash of strings with information about the current - * process CPU usage. The indices of the hash are: - *
- *
- * ticks - the number of clock ticks that have elapsed since
- * reboot.
- *
- * utime - user time used by the current process.
- *
- * stime - system time used by the current process.
- *
- * cutime - user time used by current process and children.
- *
- * cstime - system time used by current process and children.
- *
Element | - *Description | - *
name | - *- * The name element contains the name of the group. This is - * a short, usually less than 16 character "handle" of the - * group, not the real, full name. This should be the same as - * the name parameter used when - * calling the function, and hence redundant. - * | - *
passwd | - *- * The passwd element contains the group's password in an - * encrypted format. Often, for example on a system employing - * "shadow" passwords, an asterisk is returned instead. - * | - *
gid | - *- * Group ID of the group in numeric form. - * | - *
members | - *- * This consists of an array of - * string's for all the members in the group. - * | - *
Element | - *Description | - *
name | - *- * The name element contains the name of the group. This is - * a short, usually less than 16 character "handle" of the - * group, not the real, full name. - * | - *
passwd | - *- * The passwd element contains the group's password in an - * encrypted format. Often, for example on a system employing - * "shadow" passwords, an asterisk is returned instead. - * | - *
gid | - *- * Group ID, should be the same as the - * group_id parameter used when calling the - * function, and hence redundant. - * | - *
members | - *- * This consists of an array of - * string's for all the members in the group. - * | - *
Element | - *Description | - *
name | - *- * The name element contains the username of the user. This is - * a short, usually less than 16 character "handle" of the - * user, not the real, full name. This should be the same as - * the username parameter used when - * calling the function, and hence redundant. - * | - *
passwd | - *- * The passwd element contains the user's password in an - * encrypted format. Often, for example on a system employing - * "shadow" passwords, an asterisk is returned instead. - * | - *
uid | - *- * User ID of the user in numeric form. - * | - *
gid | - *- * The group ID of the user. Use the function - * posix_getgrgid to resolve the group - * name and a list of its members. - * | - *
gecos | - *- * GECOS is an obsolete term that refers to the finger - * information field on a Honeywell batch processing system. - * The field, however, lives on, and its contents have been - * formalized by POSIX. The field contains a comma separated - * list containing the user's full name, office phone, office - * number, and home phone number. On most systems, only the - * user's full name is available. - * | - *
dir | - *- * This element contains the absolute path to the home - * directory of the user. - * | - *
shell | - *- * The shell element contains the absolute path to the - * executable of the user's default shell. - * | - *
Element | - *Description | - *
name | - *- * The name element contains the username of the user. This is - * a short, usually less than 16 character "handle" of the - * user, not the real, full name. - * | - *
passwd | - *- * The passwd element contains the user's password in an - * encrypted format. Often, for example on a system employing - * "shadow" passwords, an asterisk is returned instead. - * | - *
uid | - *- * User ID, should be the same as the - * user_id parameter used when calling the - * function, and hence redundant. - * | - *
gid | - *- * The group ID of the user. Use the function - * posix_getgrgid to resolve the group - * name and a list of its members. - * | - *
gecos | - *- * GECOS is an obsolete term that refers to the finger - * information field on a Honeywell batch processing system. - * The field, however, lives on, and its contents have been - * formalized by POSIX. The field contains a comma separated - * list containing the user's full name, office phone, office - * number, and home phone number. On most systems, only the - * user's full name is available. - * | - *
dir | - *- * This element contains the absolute path to the - * home directory of the user. - * | - *
shell | - *- * The shell element contains the absolute path to the - * executable of the user's default shell. - * | - *
Limit name | - *Limit description | - *
core | - *- * The maximum size of the core file. When 0, not core files are - * created. When core files are larger than this size, they will - * be truncated at this size. - * | - *
totalmem | - *- * The maximum size of the memory of the process, in bytes. - * | - *
virtualmem | - *- * The maximum size of the virtual memory for the process, in bytes. - * | - *
data | - *- * The maximum size of the data segment for the process, in bytes. - * | - *
stack | - *- * The maximum size of the process stack, in bytes. - * | - *
rss | - *- * The maximum number of virtual pages resident in RAM - * | - *
maxproc | - *- * The maximum number of processes that can be created for the - * real user ID of the calling process. - * | - *
memlock | - *- * The maximum number of bytes of memory that may be locked into RAM. - * | - *
cpu | - *- * The amount of time the process is allowed to use the CPU. - * | - *
filesize | - *- * The maximum size of the data segment for the process, in bytes. - * | - *
openfiles | - *- * One more than the maximum number of open file descriptors. - * | - *
If seed is omitted or null, a random unsigned - * 32 bit integer will be used.
- * @param int $mode [optional] Use one of the following constants to specify the implementation of the algorithm to use. - *- * MT_RAND_MT19937: - * The correct Mt19937 implementation. - * MT_RAND_PHP: - * An incorrect implementation for backwards compatibility with mt_srand prior to - * PHP 7.1.0. - *
- * @return int|null + * {@inheritdoc} + * @param int|null $seed [optional] + * @param int $mode [optional] */ - public function __construct (?int $seed = null, int $mode = MT_RAND_MT19937): ?int {} + public function __construct (?int $seed = NULL, int $mode = 0) {} /** - * Generate 32 bits of randomness - * @link http://www.php.net/manual/en/random-engine-mt19937.generate.php - * @return string A string representing an unsigned 32 bit integer in little-endian order. + * {@inheritdoc} */ public function generate (): string {} /** - * Serializes the Mt19937 object - * @link http://www.php.net/manual/en/random-engine-mt19937.serialize.php - * @return array + * {@inheritdoc} */ public function __serialize (): array {} /** - * Deserializes the data parameter into a Mt19937 object - * @link http://www.php.net/manual/en/random-engine-mt19937.unserialize.php - * @param array $data - * @return void No value is returned. + * {@inheritdoc} + * @param array $data */ public function __unserialize (array $data): void {} /** - * Returns the internal state of the engine - * @link http://www.php.net/manual/en/random-engine-mt19937.debuginfo.php - * @return array + * {@inheritdoc} */ public function __debugInfo (): array {} } -/** - * Implements a Permuted congruential generator (PCG) with - * 128 bits of state, XSL and RR output transformations, and 64 bits of output. - * @link http://www.php.net/manual/en/class.random-engine-pcgoneseq128xslrr64.php - */ final class PcgOneseq128XslRr64 implements \Random\Engine { /** - * Constructs a new PCG Oneseq 128 XSL RR 64 engine - * @link http://www.php.net/manual/en/random-engine-pcgoneseq128xslrr64.construct.php - * @param string|int|null $seed [optional] How the internal 128 bit (16 byte) state consisting of one unsigned 128 bit integer is - * seeded depends on the type used as the seed. - *Type | - *Description | - *
null | - *- * Fills the state with 16 random bytes generated using the CSPRNG. - * | - *
int | - *- * Fills the state by setting the state to 0, advancing the engine one step, - * adding the value of seed interpreted as an unsigned 64 bit integer, - * and advancing the engine another step. - * | - *
string | - *- * Fills the state by interpreting a 16 byte string as a little-endian unsigned - * 128 bit integer. - * | - *
Type | - *Description | - *
null | - *- * Fills the state with 32 random bytes generated using the CSPRNG. - * | - *
int | - *- * Fills the state with four consecutive values generated with the SplitMix64 algorithm - * that was seeded with seed interpreted as an unsigned 64 bit integer. - * | - *
string | - *- * Fills the state by interpreting a 32 byte string as four little-endian unsigned - * 64 bit integers. - * | - *
The randomness generated by this Random\Engine is suitable - * for all applications, including the generation of long-term secrets, such as - * encryption keys.
- *The Random\Engine\Secure engine is the recommended safe default choice, - * unless the application requires either reproducible sequences or very high performance.
- * @link http://www.php.net/manual/en/class.random-engine-secure.php - */ final class Secure implements \Random\CryptoSafeEngine, \Random\Engine { /** - * Generate cryptographically secure randomness - * @link http://www.php.net/manual/en/random-engine-secure.generate.php - * @return string A string containing PHP_INT_SIZE cryptographically secure random bytes. + * {@inheritdoc} */ public function generate (): string {} @@ -545,104 +324,102 @@ public function generate (): string {} namespace Random { -/** - * Provides a high-level API to the randomness provided by an Random\Engine. - * @link http://www.php.net/manual/en/class.random-randomizer.php - */ final class Randomizer { - /** - * The low-level source of randomness for the Random\Randomizer’s methods. - * @var \Random\Engine - * @link http://www.php.net/manual/en/class.random-randomizer.php#random\randomizer.props.engine - */ public readonly \Random\Engine $engine; /** - * Constructs a new Randomizer - * @link http://www.php.net/manual/en/random-randomizer.construct.php - * @param \Random\Engine|null $engine [optional] The Random\Engine to use to generate randomness. - *If engine is omitted or null, a new Random\Engine\Secure object will be used.
- * @return \Random\Engine|null + * {@inheritdoc} + * @param \Random\Engine|null $engine [optional] */ - public function __construct (?\Random\Engine $engine = null): ?\Random\Engine {} + public function __construct (?\Random\Engine $engine = NULL) {} /** - * Get a positive integer - * @link http://www.php.net/manual/en/random-randomizer.nextint.php - * @return int + * {@inheritdoc} */ public function nextInt (): int {} /** - * Get a uniformly selected integer - * @link http://www.php.net/manual/en/random-randomizer.getint.php - * @param int $min The lowest value to be returned. - * @param int $max The highest value to be returned. - * @return int A uniformly selected integer from the closed interval - * [min, max]. Both - * min and max are - * possible return values. + * {@inheritdoc} + */ + public function nextFloat (): float {} + + /** + * {@inheritdoc} + * @param float $min + * @param float $max + * @param \Random\IntervalBoundary $boundary [optional] + */ + public function getFloat (float $min, float $max, \Random\IntervalBoundary $boundary = \Random\IntervalBoundary::ClosedOpen): float {} + + /** + * {@inheritdoc} + * @param int $min + * @param int $max */ public function getInt (int $min, int $max): int {} /** - * Get random bytes - * @link http://www.php.net/manual/en/random-randomizer.getbytes.php - * @param int $length The length of the random string that should be returned in bytes; must be 1 or greater. - * @return string A string containing the requested number of random bytes. + * {@inheritdoc} + * @param int $length */ public function getBytes (int $length): string {} /** - * Get a permutation of an array - * @link http://www.php.net/manual/en/random-randomizer.shufflearray.php - * @param array $array The array whose values are shuffled. - *The input array will not be modified.
- * @return array A permutation of the values of array. - *Array keys of the input array will not be preserved; - * the returned
array_is_list).
+ * {@inheritdoc} + * @param string $string + * @param int $length + */ + public function getBytesFromString (string $string, int $length): string {} + + /** + * {@inheritdoc} + * @param array $array */ public function shuffleArray (array $array): array {} /** - * Get a byte-wise permutation of a string - * @link http://www.php.net/manual/en/random-randomizer.shufflebytes.php - * @param string $bytes The string whose bytes are shuffled. - *The input string will not be modified.
- * @return string A permutation of the bytes of bytes. + * {@inheritdoc} + * @param string $bytes */ public function shuffleBytes (string $bytes): string {} /** - * Select random array keys - * @link http://www.php.net/manual/en/random-randomizer.pickarraykeys.php - * @param array $array The array whose array keys are selected. - * @param int $num The number of array keys to return; must be between 1 - * and the number of elements in array. - * @return array An array containing num distinct array keys of array. - *The returned
array_is_list). It will be a subset - * of the array returned by array_keys.
+ * {@inheritdoc} + * @param array $array + * @param int $num */ public function pickArrayKeys (array $array, int $num): array {} /** - * Serializes the Randomizer object - * @link http://www.php.net/manual/en/random-randomizer.serialize.php - * @return array + * {@inheritdoc} */ public function __serialize (): array {} /** - * Deserializes the data parameter into a Randomizer object - * @link http://www.php.net/manual/en/random-randomizer.unserialize.php - * @param array $data - * @return void No value is returned. + * {@inheritdoc} + * @param array $data */ public function __unserialize (array $data): void {} } +enum IntervalBoundary implements \UnitEnum { + const ClosedOpen = ; + const ClosedClosed = ; + const OpenClosed = ; + const OpenOpen = ; + + + public readonly string $name; + + /** + * {@inheritdoc} + */ + public static function cases (): array {} + +} + } @@ -650,112 +427,65 @@ public function __unserialize (array $data): void {} namespace { /** - * Combined linear congruential generator - * @link http://www.php.net/manual/en/function.lcg-value.php - * @return float A pseudo random float value between 0.0 and 1.0, inclusive. + * {@inheritdoc} */ function lcg_value (): float {} /** - * Seeds the Mersenne Twister Random Number Generator - * @link http://www.php.net/manual/en/function.mt-srand.php - * @param int $seed [optional] - * @param int $mode [optional] - * @return void No value is returned. + * {@inheritdoc} + * @param int|null $seed [optional] + * @param int $mode [optional] */ -function mt_srand (int $seed = null, int $mode = MT_RAND_MT19937): void {} +function mt_srand (?int $seed = NULL, int $mode = 0): void {} /** - * Seed the random number generator - * @link http://www.php.net/manual/en/function.srand.php - * @param int $seed [optional] - * @param int $mode [optional] - * @return void No value is returned. + * {@inheritdoc} + * @param int|null $seed [optional] + * @param int $mode [optional] */ -function srand (int $seed = null, int $mode = MT_RAND_MT19937): void {} +function srand (?int $seed = NULL, int $mode = 0): void {} /** - * Generate a random integer - * @link http://www.php.net/manual/en/function.rand.php + * {@inheritdoc} * @param int $min [optional] * @param int $max [optional] - * @return int A pseudo random value between min - * (or 0) and max (or getrandmax, inclusive). */ function rand (int $min = NULL, int $max = NULL): int {} /** - * Generate a random value via the Mersenne Twister Random Number Generator - * @link http://www.php.net/manual/en/function.mt-rand.php + * {@inheritdoc} * @param int $min [optional] * @param int $max [optional] - * @return int A random integer value between min (or 0) - * and max (or mt_getrandmax, inclusive), - * or false if max is less than min. */ function mt_rand (int $min = NULL, int $max = NULL): int {} /** - * Show largest possible random value - * @link http://www.php.net/manual/en/function.mt-getrandmax.php - * @return int Returns the maximum random value returned by a call to - * mt_rand without arguments, which is the maximum value - * that can be used for its max parameter without the - * result being scaled up (and therefore less random). + * {@inheritdoc} */ function mt_getrandmax (): int {} /** - * Show largest possible random value - * @link http://www.php.net/manual/en/function.getrandmax.php - * @return int The largest possible random value returned by rand + * {@inheritdoc} */ function getrandmax (): int {} /** - * Get cryptographically secure random bytes - * @link http://www.php.net/manual/en/function.random-bytes.php - * @param int $length The length of the random string that should be returned in bytes; must be 1 or greater. - * @return string A string containing the requested number of cryptographically - * secure random bytes. + * {@inheritdoc} + * @param int $length */ function random_bytes (int $length): string {} /** - * Get a cryptographically secure, uniformly selected integer - * @link http://www.php.net/manual/en/function.random-int.php - * @param int $min The lowest value to be returned. - * @param int $max The highest value to be returned. - * @return int A cryptographically secure, uniformly selected integer from the closed interval - * [min, max]. Both - * min and max are - * possible return values. + * {@inheritdoc} + * @param int $min + * @param int $max */ function random_int (int $min, int $max): int {} - -/** - * Indicates that the correct Mt19937 (Mersenne Twister) - * implementation will be used by the algorithm, when creating a Random\Engine\Mt19937 instance - * using Random\Engine\Mt19937::__construct or seeding the global Mersenne Twister - * with mt_srand. - * @link http://www.php.net/manual/en/random.constants.php - * @var integer - */ define ('MT_RAND_MT19937', 0); - -/** - * Indicates that an incorrect Mersenne Twister implementation will be used by the algorithm, when - * creating a Random\Engine\Mt19937 instance using Random\Engine\Mt19937::__construct - * or seeding the global Mersenne Twister with mt_srand. - * The incorrect implementation is available for backwards compatibility with - * mt_srand prior to PHP 7.1.0. - * @link http://www.php.net/manual/en/random.constants.php - * @var integer - */ define ('MT_RAND_PHP', 1); } -// End of random v.8.2.6 +// End of random v.8.3.0 diff --git a/plugins/org.eclipse.php.core/Resources/language/php8.3/rdkafka.php b/plugins/org.eclipse.php.core/Resources/language/php8.3/rdkafka.php index 08b2e58176..ebe2e3bebf 100644 --- a/plugins/org.eclipse.php.core/Resources/language/php8.3/rdkafka.php +++ b/plugins/org.eclipse.php.core/Resources/language/php8.3/rdkafka.php @@ -377,14 +377,12 @@ public function resumePartitions (array $topic_partitions) {} class Exception extends \Exception implements \Throwable, \Stringable { /** - * Construct the exception - * @link http://www.php.net/manual/en/exception.construct.php - * @param string $message [optional] - * @param int $code [optional] - * @param \Throwable|null $previous [optional] - * @return string + * {@inheritdoc} + * @param string $message [optional] + * @param int $code [optional] + * @param \Throwable|null $previous [optional] */ - public function __construct (string $message = '""', int $code = null, ?\Throwable $previous = null): string {} + public function __construct (string $message = '', int $code = 0, ?\Throwable $previous = NULL) {} /** * {@inheritdoc} @@ -392,62 +390,42 @@ public function __construct (string $message = '""', int $code = null, ?\Throwab public function __wakeup () {} /** - * Gets the Exception message - * @link http://www.php.net/manual/en/exception.getmessage.php - * @return string Returns the Exception message as a string. + * {@inheritdoc} */ final public function getMessage (): string {} /** - * Gets the Exception code - * @link http://www.php.net/manual/en/exception.getcode.php - * @return int Returns the exception code as int in - * Exception but possibly as other type in - * Exception descendants (for example as - * string in PDOException). + * {@inheritdoc} */ - final public function getCode (): int {} + final public function getCode () {} /** - * Gets the file in which the exception was created - * @link http://www.php.net/manual/en/exception.getfile.php - * @return string Returns the filename in which the exception was created. + * {@inheritdoc} */ final public function getFile (): string {} /** - * Gets the line in which the exception was created - * @link http://www.php.net/manual/en/exception.getline.php - * @return int Returns the line number where the exception was created. + * {@inheritdoc} */ final public function getLine (): int {} /** - * Gets the stack trace - * @link http://www.php.net/manual/en/exception.gettrace.php - * @return array Returns the Exception stack trace as an array. + * {@inheritdoc} */ final public function getTrace (): array {} /** - * Returns previous Throwable - * @link http://www.php.net/manual/en/exception.getprevious.php - * @return \Throwable|null Returns the previous Throwable if available - * or null otherwise. + * {@inheritdoc} */ final public function getPrevious (): ?\Throwable {} /** - * Gets the stack trace as a string - * @link http://www.php.net/manual/en/exception.gettraceasstring.php - * @return string Returns the Exception stack trace as a string. + * {@inheritdoc} */ final public function getTraceAsString (): string {} /** - * String representation of the exception - * @link http://www.php.net/manual/en/exception.tostring.php - * @return string Returns the string representation of the exception. + * {@inheritdoc} */ public function __toString (): string {} @@ -589,62 +567,42 @@ public function transactionRequiresAbort () {} public function __wakeup () {} /** - * Gets the Exception message - * @link http://www.php.net/manual/en/exception.getmessage.php - * @return string Returns the Exception message as a string. + * {@inheritdoc} */ final public function getMessage (): string {} /** - * Gets the Exception code - * @link http://www.php.net/manual/en/exception.getcode.php - * @return int Returns the exception code as int in - * Exception but possibly as other type in - * Exception descendants (for example as - * string in PDOException). + * {@inheritdoc} */ - final public function getCode (): int {} + final public function getCode () {} /** - * Gets the file in which the exception was created - * @link http://www.php.net/manual/en/exception.getfile.php - * @return string Returns the filename in which the exception was created. + * {@inheritdoc} */ final public function getFile (): string {} /** - * Gets the line in which the exception was created - * @link http://www.php.net/manual/en/exception.getline.php - * @return int Returns the line number where the exception was created. + * {@inheritdoc} */ final public function getLine (): int {} /** - * Gets the stack trace - * @link http://www.php.net/manual/en/exception.gettrace.php - * @return array Returns the Exception stack trace as an array. + * {@inheritdoc} */ final public function getTrace (): array {} /** - * Returns previous Throwable - * @link http://www.php.net/manual/en/exception.getprevious.php - * @return \Throwable|null Returns the previous Throwable if available - * or null otherwise. + * {@inheritdoc} */ final public function getPrevious (): ?\Throwable {} /** - * Gets the stack trace as a string - * @link http://www.php.net/manual/en/exception.gettraceasstring.php - * @return string Returns the Exception stack trace as a string. + * {@inheritdoc} */ final public function getTraceAsString (): string {} /** - * String representation of the exception - * @link http://www.php.net/manual/en/exception.tostring.php - * @return string Returns the string representation of the exception. + * {@inheritdoc} */ public function __toString (): string {} @@ -1186,8 +1144,8 @@ function rd_kafka_thread_cnt (): int {} define ('RD_KAFKA_PURGE_F_QUEUE', 1); define ('RD_KAFKA_PURGE_F_INFLIGHT', 2); define ('RD_KAFKA_PURGE_F_NON_BLOCKING', 4); -define ('RD_KAFKA_VERSION', 33620479); -define ('RD_KAFKA_BUILD_VERSION', 17367807); +define ('RD_KAFKA_VERSION', 33751295); +define ('RD_KAFKA_BUILD_VERSION', 33685759); define ('RD_KAFKA_RESP_ERR__BEGIN', -200); define ('RD_KAFKA_RESP_ERR__BAD_MSG', -199); define ('RD_KAFKA_RESP_ERR__BAD_COMPRESSION', -198); diff --git a/plugins/org.eclipse.php.core/Resources/language/php8.3/readline.php b/plugins/org.eclipse.php.core/Resources/language/php8.3/readline.php index ce68f2d64f..72cef0514a 100644 --- a/plugins/org.eclipse.php.core/Resources/language/php8.3/readline.php +++ b/plugins/org.eclipse.php.core/Resources/language/php8.3/readline.php @@ -1,117 +1,76 @@ If called with one or two parameters, the old value is returned. + * {@inheritdoc} + * @param string|null $var_name [optional] + * @param mixed $value [optional] */ -function readline_info (?string $var_name = null, int|string|bool|null $value = null): mixed {} +function readline_info (?string $var_name = NULL, $value = NULL): mixed {} /** - * Adds a line to the history - * @link http://www.php.net/manual/en/function.readline-add-history.php - * @param string $prompt - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $prompt */ function readline_add_history (string $prompt): bool {} /** - * Clears the history - * @link http://www.php.net/manual/en/function.readline-clear-history.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ function readline_clear_history (): bool {} /** - * Reads the history - * @link http://www.php.net/manual/en/function.readline-read-history.php - * @param string|null $filename [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string|null $filename [optional] */ -function readline_read_history (?string $filename = null): bool {} +function readline_read_history (?string $filename = NULL): bool {} /** - * Writes the history - * @link http://www.php.net/manual/en/function.readline-write-history.php - * @param string|null $filename [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string|null $filename [optional] */ -function readline_write_history (?string $filename = null): bool {} +function readline_write_history (?string $filename = NULL): bool {} /** - * Registers a completion function - * @link http://www.php.net/manual/en/function.readline-completion-function.php - * @param callable $callback - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param callable $callback */ function readline_completion_function (callable $callback): bool {} /** - * Initializes the readline callback interface and terminal, prints the prompt and returns immediately - * @link http://www.php.net/manual/en/function.readline-callback-handler-install.php - * @param string $prompt - * @param callable $callback - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $prompt + * @param callable $callback */ function readline_callback_handler_install (string $prompt, callable $callback): bool {} /** - * Reads a character and informs the readline callback interface when a line is received - * @link http://www.php.net/manual/en/function.readline-callback-read-char.php - * @return void No value is returned. + * {@inheritdoc} */ function readline_callback_read_char (): void {} /** - * Removes a previously installed callback handler and restores terminal settings - * @link http://www.php.net/manual/en/function.readline-callback-handler-remove.php - * @return bool Returns true if a previously installed callback handler was removed, or - * false if one could not be found. + * {@inheritdoc} */ function readline_callback_handler_remove (): bool {} /** - * Redraws the display - * @link http://www.php.net/manual/en/function.readline-redisplay.php - * @return void No value is returned. + * {@inheritdoc} */ function readline_redisplay (): void {} /** - * Inform readline that the cursor has moved to a new line - * @link http://www.php.net/manual/en/function.readline-on-new-line.php - * @return void No value is returned. + * {@inheritdoc} */ function readline_on_new_line (): void {} - -/** - * The library which is used for readline support; currently either - * readline or libedit. - * @link http://www.php.net/manual/en/readline.constants.php - * @var string - */ define ('READLINE_LIB', "libedit"); -// End of readline v.8.2.6 +// End of readline v.8.3.0 diff --git a/plugins/org.eclipse.php.core/Resources/language/php8.3/redis.php b/plugins/org.eclipse.php.core/Resources/language/php8.3/redis.php index 30fef7a003..cf8333303c 100644 --- a/plugins/org.eclipse.php.core/Resources/language/php8.3/redis.php +++ b/plugins/org.eclipse.php.core/Resources/language/php8.3/redis.php @@ -1,6 +1,6 @@ Please note the callback methods of this class are designed to be called internally by - * PHP and are not meant to be called from user-space code. - * @link http://www.php.net/manual/en/class.sessionhandlerinterface.php - */ interface SessionHandlerInterface { /** - * Initialize session - * @link http://www.php.net/manual/en/sessionhandlerinterface.open.php - * @param string $path The path where to store/retrieve the session. - * @param string $name The session name. - * @return bool The return value (usually true on success, false on failure). Note this value is returned internally to PHP for processing. + * {@inheritdoc} + * @param string $path + * @param string $name */ - abstract public function open (string $path, string $name): bool; + abstract public function open (string $path, string $name); /** - * Close the session - * @link http://www.php.net/manual/en/sessionhandlerinterface.close.php - * @return bool The return value (usually true on success, false on failure). Note this value is returned internally to PHP for processing. + * {@inheritdoc} */ - abstract public function close (): bool; + abstract public function close (); /** - * Read session data - * @link http://www.php.net/manual/en/sessionhandlerinterface.read.php - * @param string $id The session id. - * @return string|false Returns an encoded string of the read data. If nothing was read, it must return false. Note this value is returned internally to PHP for processing. + * {@inheritdoc} + * @param string $id */ - abstract public function read (string $id): string|false; + abstract public function read (string $id); /** - * Write session data - * @link http://www.php.net/manual/en/sessionhandlerinterface.write.php - * @param string $id The session id. - * @param string $data The encoded session data. This data is the result of the PHP internally encoding the $_SESSION superglobal to a serialized - * string and passing it as this parameter. Please note sessions use an alternative serialization method. - * @return bool The return value (usually true on success, false on failure). Note this value is returned internally to PHP for processing. + * {@inheritdoc} + * @param string $id + * @param string $data */ - abstract public function write (string $id, string $data): bool; + abstract public function write (string $id, string $data); /** - * Destroy a session - * @link http://www.php.net/manual/en/sessionhandlerinterface.destroy.php - * @param string $id - * @return bool The return value (usually true on success, false on failure). Note this value is returned internally to PHP for processing. + * {@inheritdoc} + * @param string $id */ - abstract public function destroy (string $id): bool; + abstract public function destroy (string $id); /** - * Cleanup old sessions - * @link http://www.php.net/manual/en/sessionhandlerinterface.gc.php - * @param int $max_lifetime Sessions that have not updated for the last max_lifetime seconds will be removed. - * @return int|false Returns the number of deleted sessions on success, or false on failure. - * Note this value is returned internally to PHP for processing. + * {@inheritdoc} + * @param int $max_lifetime */ - abstract public function gc (int $max_lifetime): int|false; + abstract public function gc (int $max_lifetime); } -/** - * SessionIdInterface is an interface which defines optional methods - * for creating a custom session handler. In order to pass a custom - * session handler to session_set_save_handler using its - * OOP invocation, the class can implement this interface. - *Note that the callback methods of classes implementing this interface are designed to be called - * internally by PHP and are not meant to be called from user-space code.
- * @link http://www.php.net/manual/en/class.sessionidinterface.php - */ interface SessionIdInterface { /** - * Create session ID - * @link http://www.php.net/manual/en/sessionidinterface.create-sid.php - * @return string The new session ID. - * Note that this value is returned internally to PHP for processing. + * {@inheritdoc} */ - abstract public function create_sid (): string; + abstract public function create_sid (); } -/** - * SessionUpdateTimestampHandlerInterface is an interface which defines optional methods - * for creating a custom session handler. In order to pass a custom - * session handler to session_set_save_handler using its - * OOP invocation, the class can implement this interface. - *Note that the callback methods of classes implementing this interface are designed to be called - * internally by PHP and are not meant to be called from user-space code.
- * @link http://www.php.net/manual/en/class.sessionupdatetimestamphandlerinterface.php - */ interface SessionUpdateTimestampHandlerInterface { /** - * Validate ID - * @link http://www.php.net/manual/en/sessionupdatetimestamphandlerinterface.validateid.php - * @param string $id The session ID. - * @return bool Returns true for valid ID, false otherwise. - * Note that this value is returned internally to PHP for processing. + * {@inheritdoc} + * @param string $id */ - abstract public function validateId (string $id): bool; + abstract public function validateId (string $id); /** - * Update timestamp - * @link http://www.php.net/manual/en/sessionupdatetimestamphandlerinterface.updatetimestamp.php - * @param string $id The session ID. - * @param string $data The session data. - * @return bool Returns true if the timestamp was updated, false otherwise. - * Note that this value is returned internally to PHP for processing. + * {@inheritdoc} + * @param string $id + * @param string $data */ - abstract public function updateTimestamp (string $id, string $data): bool; + abstract public function updateTimestamp (string $id, string $data); } -/** - * SessionHandler is a special class that can be used - * to expose the current internal PHP session save handler by inheritance. - * There are seven methods which wrap the seven internal session save handler - * callbacks (open, close, - * read, write, - * destroy, gc and - * create_sid). By default, this class will wrap - * whatever internal save handler is set as defined by the - * session.save_handler - * configuration directive which is usually files by - * default. Other internal session save handlers are provided by PHP - * extensions such as SQLite (as sqlite), Memcache (as - * memcache), and Memcached (as - * memcached). - *When a plain instance of SessionHandler is set as the save handler using - * session_set_save_handler it will wrap the current save handlers. - * A class extending from SessionHandler allows you to override - * the methods or intercept or filter them by calls the parent class methods which ultimately wrap - * the internal PHP session handlers.
- *This allows you, for example, to intercept the read and write - * methods to encrypt/decrypt the session data and then pass the result to and from the parent class. - * Alternatively one might chose to entirely override a method like the garbage collection callback - * gc.
- *Because the SessionHandler wraps the current internal save handler - * methods, the above example of encryption can be applied to any internal save handler without - * having to know the internals of the handlers.
- *To use this class, first set the save handler you wish to expose using - * session.save_handler and then pass an instance of - * SessionHandler or one extending it to session_set_save_handler.
- *Please note that the callback methods of this class are designed to be called internally by - * PHP and are not meant to be called from user-space code. The return values are equally processed internally - * by PHP. For more information on the session workflow, please refer to session_set_save_handler.
- * @link http://www.php.net/manual/en/class.sessionhandler.php - */ class SessionHandler implements SessionHandlerInterface, SessionIdInterface { /** - * Initialize session - * @link http://www.php.net/manual/en/sessionhandler.open.php - * @param string $path The path where to store/retrieve the session. - * @param string $name The session name. - * @return bool The return value (usually true on success, false on failure). Note this value is returned internally to PHP for processing. + * {@inheritdoc} + * @param string $path + * @param string $name */ - public function open (string $path, string $name): bool {} + public function open (string $path, string $name) {} /** - * Close the session - * @link http://www.php.net/manual/en/sessionhandler.close.php - * @return bool The return value (usually true on success, false on failure). Note this value is returned internally to PHP for processing. + * {@inheritdoc} */ - public function close (): bool {} + public function close () {} /** - * Read session data - * @link http://www.php.net/manual/en/sessionhandler.read.php - * @param string $id The session id to read data for. - * @return string|false Returns an encoded string of the read data. If nothing was read, it must return false. Note this value is returned internally to PHP for processing. + * {@inheritdoc} + * @param string $id */ - public function read (string $id): string|false {} + public function read (string $id) {} /** - * Write session data - * @link http://www.php.net/manual/en/sessionhandler.write.php - * @param string $id The session id. - * @param string $data The encoded session data. This data is the result of the PHP internally encoding the $_SESSION superglobal to a serialized - * string and passing it as this parameter. Please note sessions use an alternative serialization method. - * @return bool The return value (usually true on success, false on failure). Note this value is returned internally to PHP for processing. + * {@inheritdoc} + * @param string $id + * @param string $data */ - public function write (string $id, string $data): bool {} + public function write (string $id, string $data) {} /** - * Destroy a session - * @link http://www.php.net/manual/en/sessionhandler.destroy.php - * @param string $id - * @return bool The return value (usually true on success, false on failure). Note this value is returned internally to PHP for processing. + * {@inheritdoc} + * @param string $id */ - public function destroy (string $id): bool {} + public function destroy (string $id) {} /** - * Cleanup old sessions - * @link http://www.php.net/manual/en/sessionhandler.gc.php - * @param int $max_lifetime Sessions that have not updated for the last max_lifetime seconds will be removed. - * @return int|false Returns the number of deleted sessions on success, or false on failure. - * Note this value is returned internally to PHP for processing. + * {@inheritdoc} + * @param int $max_lifetime */ - public function gc (int $max_lifetime): int|false {} + public function gc (int $max_lifetime) {} /** - * Return a new session ID - * @link http://www.php.net/manual/en/sessionhandler.create-sid.php - * @return string A session ID valid for the default session handler. + * {@inheritdoc} */ - public function create_sid (): string {} + public function create_sid () {} } /** - * Get and/or set the current session name - * @link http://www.php.net/manual/en/function.session-name.php - * @param string|null $name [optional] - * @return string|false Returns the name of the current session. If name is given - * and function updates the session name, name of the old session - * is returned, or false on failure. + * {@inheritdoc} + * @param string|null $name [optional] */ -function session_name (?string $name = null): string|false {} +function session_name (?string $name = NULL): string|false {} /** - * Get and/or set the current session module - * @link http://www.php.net/manual/en/function.session-module-name.php - * @param string|null $module [optional] - * @return string|false Returns the name of the current session module, or false on failure. + * {@inheritdoc} + * @param string|null $module [optional] */ -function session_module_name (?string $module = null): string|false {} +function session_module_name (?string $module = NULL): string|false {} /** - * Get and/or set the current session save path - * @link http://www.php.net/manual/en/function.session-save-path.php - * @param string|null $path [optional] - * @return string|false Returns the path of the current directory used for data storage, or false on failure. + * {@inheritdoc} + * @param string|null $path [optional] */ -function session_save_path (?string $path = null): string|false {} +function session_save_path (?string $path = NULL): string|false {} /** - * Get and/or set the current session id - * @link http://www.php.net/manual/en/function.session-id.php - * @param string|null $id [optional] - * @return string|false session_id returns the session id for the current - * session or the empty string ("") if there is no current - * session (no current session id exists). - * On failure, false is returned. + * {@inheritdoc} + * @param string|null $id [optional] */ -function session_id (?string $id = null): string|false {} +function session_id (?string $id = NULL): string|false {} /** - * Create new session id - * @link http://www.php.net/manual/en/function.session-create-id.php - * @param string $prefix [optional] - * @return string|false session_create_id returns new collision free - * session id for the current session. If it is used without active - * session, it omits collision check. - * On failure, false is returned. + * {@inheritdoc} + * @param string $prefix [optional] */ -function session_create_id (string $prefix = '""'): string|false {} +function session_create_id (string $prefix = ''): string|false {} /** - * Update the current session id with a newly generated one - * @link http://www.php.net/manual/en/function.session-regenerate-id.php - * @param bool $delete_old_session [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param bool $delete_old_session [optional] */ function session_regenerate_id (bool $delete_old_session = false): bool {} /** - * Decodes session data from a session encoded string - * @link http://www.php.net/manual/en/function.session-decode.php - * @param string $data - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $data */ function session_decode (string $data): bool {} /** - * Encodes the current session data as a session encoded string - * @link http://www.php.net/manual/en/function.session-encode.php - * @return string|false Returns the contents of the current session encoded, or false on failure. + * {@inheritdoc} */ function session_encode (): string|false {} /** - * Destroys all data registered to a session - * @link http://www.php.net/manual/en/function.session-destroy.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ function session_destroy (): bool {} /** - * Free all session variables - * @link http://www.php.net/manual/en/function.session-unset.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ function session_unset (): bool {} /** - * Perform session data garbage collection - * @link http://www.php.net/manual/en/function.session-gc.php - * @return int|false session_gc returns number of deleted session - * data for success, false for failure. - *Old save handlers do not return number of deleted session data, but - * only success/failure flag. If this is the case, number of deleted - * session data became 1 regardless of actually deleted data.
+ * {@inheritdoc} */ function session_gc (): int|false {} /** - * Get the session cookie parameters - * @link http://www.php.net/manual/en/function.session-get-cookie-params.php - * @return array Returns an array with the current session cookie information, the array - * contains the following items: - *
- *
- * "lifetime" - The
- * lifetime of the cookie in seconds.
- *
- * "path" - The path where
- * information is stored.
- *
- * "domain" - The domain
- * of the cookie.
- *
- * "secure" - The cookie
- * should only be sent over secure connections.
- *
- * "httponly" - The
- * cookie can only be accessed through the HTTP protocol.
- *
- * "samesite" - Controls
- * the cross-domain sending of the cookie.
- *
In addition to the normal set of configuration directives, a - * read_and_close option may also be provided. If set to - * true, this will result in the session being closed immediately after - * being read, thereby avoiding unnecessary locking if the session data - * won't be changed.
- * @return bool This function returns true if a session was successfully started, - * otherwise false. + * {@inheritdoc} + * @param array $options [optional] */ -function session_start (array $options = '[]'): bool {} - +function session_start (array $options = array ( +)): bool {} -/** - * Return value of session_status if sessions are disabled. - * @link http://www.php.net/manual/en/session.constants.php - * @var int - */ define ('PHP_SESSION_DISABLED', 0); - -/** - * Return value of session_status if sessions are enabled, - * but no session exists. - * @link http://www.php.net/manual/en/session.constants.php - * @var int - */ define ('PHP_SESSION_NONE', 1); - -/** - * Return value of session_status if sessions are enabled, - * and a session exists. - * @link http://www.php.net/manual/en/session.constants.php - * @var int - */ define ('PHP_SESSION_ACTIVE', 2); -// End of session v.8.2.6 +// End of session v.8.3.0 diff --git a/plugins/org.eclipse.php.core/Resources/language/php8.3/shmop.php b/plugins/org.eclipse.php.core/Resources/language/php8.3/shmop.php index f58edd5f02..a5ed389390 100644 --- a/plugins/org.eclipse.php.core/Resources/language/php8.3/shmop.php +++ b/plugins/org.eclipse.php.core/Resources/language/php8.3/shmop.php @@ -1,71 +1,52 @@ Sets the value of quick_print within the NET-SNMP library. When this - * is set (1), the SNMP library will return 'quick printed' values. This - * means that just the value will be printed. When quick_print is not - * enabled (default) the NET-SNMP library prints extra information - * including the type of the value (i.e. IpAddress or OID). Additionally, - * if quick_print is not enabled, the library prints additional hex values - * for all strings of three characters or less. - * @var bool - * @link http://www.php.net/manual/en/class.snmp.php#snmp.props.quick_print - */ public bool $quick_print; - /** - * Controls the way enum values are printed - *Parameter toggles if walk/get etc. should automatically lookup enum values - * in the MIB and return them together with their human readable string.
- * @var bool - * @link http://www.php.net/manual/en/class.snmp.php#snmp.props.enum_print - */ public bool $enum_print; - /** - * Controls OID output format - * @var int - * @link http://www.php.net/manual/en/class.snmp.php#snmp.props.oid_output_format - */ public int $oid_output_format; - /** - * Controls disabling check for increasing OID while walking OID tree - *Some SNMP agents are known for returning OIDs out - * of order but can complete the walk anyway. Other agents return OIDs - * that are out of order and can cause SNMP::walk - * to loop indefinitely until memory limit will be reached. - * PHP SNMP library by default performs OID increasing check and stops - * walking on OID tree when it detects possible loop with issuing warning - * about non-increasing OID faced. - * Set oid_increasing_check to false to disable this - * check.
- * @var bool - * @link http://www.php.net/manual/en/class.snmp.php#snmp.props.oid_increasing_check - */ public bool $oid_increasing_check; - /** - * Controls which failures will raise SNMPException instead of - * warning. Use bitwise OR'ed SNMP::ERRNO_* constants. - * By default all SNMP exceptions are disabled. - * @var int - * @link http://www.php.net/manual/en/class.snmp.php#snmp.props.exceptions_enabled - */ public int $exceptions_enabled; /** - * Creates SNMP instance representing session to remote SNMP agent - * @link http://www.php.net/manual/en/snmp.construct.php - * @param int $version SNMP protocol version: - * SNMP::VERSION_1, - * SNMP::VERSION_2C, - * SNMP::VERSION_3. - * @param string $hostname The SNMP agent. hostname may be suffixed with - * optional SNMP agent port after colon. IPv6 addresses must be enclosed in square - * brackets if used with port. If FQDN is used for hostname - * it will be resolved by php-snmp library, not by Net-SNMP engine. Usage - * of IPv6 addresses when specifying FQDN may be forced by enclosing FQDN - * into square brackets. Here it is some examples: - *IPv4 with default port | 127.0.0.1 |
IPv6 with default port | ::1 or [::1] |
IPv4 with specific port | 127.0.0.1:1161 |
IPv6 with specific port | [::1]:1161 |
FQDN with default port | host.domain |
FQDN with specific port | host.domain:1161 |
FQDN with default port, force usage of IPv6 address | [host.domain] |
FQDN with specific port, force usage of IPv6 address | [host.domain]:1161 |
When count of OIDs in object_id array is greater than - * max_oids object property set method will have to use multiple queries - * to perform requested value updates. In this case type and value checks - * are made per-chunk so second or subsequent requests may fail due to - * wrong type or value for OID requested. To mark this a warning is - * raised when count of OIDs in object_id array is greater than max_oids.
- * @param array|string $type > - * The MIB defines the type of each object id. It has to be specified as a single character from the below list. - *> - * If OPAQUE_SPECIAL_TYPES was defined while compiling the SNMP library, the following are also valid:
- *> - * Most of these will use the obvious corresponding ASN.1 type. 's', 'x', 'd' and 'b' are all different ways of specifying an OCTET STRING value, and - * the 'u' unsigned type is also used for handling Gauge32 values.
- *> - * If the MIB-Files are loaded by into the MIB Tree with "snmp_read_mib" or by specifying it in the libsnmp config, '=' may be used as - * the type parameter for all object ids as the type can then be automatically read from the MIB.
- *> - * Note that there are two ways to set a variable of the type BITS like e.g. - * "SYNTAX BITS {telnet(0), ftp(1), http(2), icmp(3), snmp(4), ssh(5), https(6)}":
- *> - * See examples section for more details.
- * @param array|string $value The new value. - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param array|string $objectId + * @param array|string $type + * @param array|string $value */ - public function set (array|string $objectId, array|string $type, array|string $value): bool {} + public function set (array|string $objectId, array|string $type, array|string $value) {} /** - * Get last error code - * @link http://www.php.net/manual/en/snmp.geterrno.php - * @return int Returns one of SNMP error code values described in constants chapter. + * {@inheritdoc} */ - public function getErrno (): int {} + public function getErrno () {} /** - * Get last error message - * @link http://www.php.net/manual/en/snmp.geterror.php - * @return string String describing error from last SNMP request. + * {@inheritdoc} */ - public function getError (): string {} + public function getError () {} } -/** - * Represents an error raised by SNMP. You should not throw a - * SNMPException from your own code. - * See Exceptions for more - * information about Exceptions in PHP. - * @link http://www.php.net/manual/en/class.snmpexception.php - */ class SNMPException extends RuntimeException implements Stringable, Throwable { /** - * Construct the exception - * @link http://www.php.net/manual/en/exception.construct.php - * @param string $message [optional] - * @param int $code [optional] - * @param Throwable|null $previous [optional] - * @return string + * {@inheritdoc} + * @param string $message [optional] + * @param int $code [optional] + * @param Throwable|null $previous [optional] */ - public function __construct (string $message = '""', int $code = null, ?Throwable $previous = null): string {} + public function __construct (string $message = '', int $code = 0, ?Throwable $previous = NULL) {} /** * {@inheritdoc} @@ -283,176 +118,129 @@ public function __construct (string $message = '""', int $code = null, ?Throwabl public function __wakeup () {} /** - * Gets the Exception message - * @link http://www.php.net/manual/en/exception.getmessage.php - * @return string Returns the Exception message as a string. + * {@inheritdoc} */ final public function getMessage (): string {} /** - * Gets the Exception code - * @link http://www.php.net/manual/en/exception.getcode.php - * @return int Returns the exception code as int in - * Exception but possibly as other type in - * Exception descendants (for example as - * string in PDOException). + * {@inheritdoc} */ - final public function getCode (): int {} + final public function getCode () {} /** - * Gets the file in which the exception was created - * @link http://www.php.net/manual/en/exception.getfile.php - * @return string Returns the filename in which the exception was created. + * {@inheritdoc} */ final public function getFile (): string {} /** - * Gets the line in which the exception was created - * @link http://www.php.net/manual/en/exception.getline.php - * @return int Returns the line number where the exception was created. + * {@inheritdoc} */ final public function getLine (): int {} /** - * Gets the stack trace - * @link http://www.php.net/manual/en/exception.gettrace.php - * @return array Returns the Exception stack trace as an array. + * {@inheritdoc} */ final public function getTrace (): array {} /** - * Returns previous Throwable - * @link http://www.php.net/manual/en/exception.getprevious.php - * @return Throwable|null Returns the previous Throwable if available - * or null otherwise. + * {@inheritdoc} */ final public function getPrevious (): ?Throwable {} /** - * Gets the stack trace as a string - * @link http://www.php.net/manual/en/exception.gettraceasstring.php - * @return string Returns the Exception stack trace as a string. + * {@inheritdoc} */ final public function getTraceAsString (): string {} /** - * String representation of the exception - * @link http://www.php.net/manual/en/exception.tostring.php - * @return string Returns the string representation of the exception. + * {@inheritdoc} */ public function __toString (): string {} } /** - * Fetch an SNMP object - * @link http://www.php.net/manual/en/function.snmpget.php - * @param string $hostname - * @param string $community - * @param array|string $object_id - * @param int $timeout [optional] - * @param int $retries [optional] - * @return mixed Returns SNMP object value on success or false on error. + * {@inheritdoc} + * @param string $hostname + * @param string $community + * @param array|string $object_id + * @param int $timeout [optional] + * @param int $retries [optional] */ function snmpget (string $hostname, string $community, array|string $object_id, int $timeout = -1, int $retries = -1): mixed {} /** - * Fetch the SNMP object which follows the given object id - * @link http://www.php.net/manual/en/function.snmpgetnext.php - * @param string $hostname - * @param string $community - * @param array|string $object_id - * @param int $timeout [optional] - * @param int $retries [optional] - * @return mixed Returns SNMP object value on success or false on error. - * In case of an error, an E_WARNING message is shown. + * {@inheritdoc} + * @param string $hostname + * @param string $community + * @param array|string $object_id + * @param int $timeout [optional] + * @param int $retries [optional] */ function snmpgetnext (string $hostname, string $community, array|string $object_id, int $timeout = -1, int $retries = -1): mixed {} /** - * Fetch all the SNMP objects from an agent - * @link http://www.php.net/manual/en/function.snmpwalk.php - * @param string $hostname - * @param string $community - * @param array|string $object_id - * @param int $timeout [optional] - * @param int $retries [optional] - * @return array|false Returns an array of SNMP object values starting from the - * object_id as root or false on error. + * {@inheritdoc} + * @param string $hostname + * @param string $community + * @param array|string $object_id + * @param int $timeout [optional] + * @param int $retries [optional] */ function snmpwalk (string $hostname, string $community, array|string $object_id, int $timeout = -1, int $retries = -1): array|false {} /** - * Return all objects including their respective object ID within the specified one - * @link http://www.php.net/manual/en/function.snmprealwalk.php - * @param string $hostname - * @param string $community - * @param array|string $object_id - * @param int $timeout [optional] - * @param int $retries [optional] - * @return array|false Returns an associative array of the SNMP object ids and their values on success or false on error. - * In case of an error, an E_WARNING message is shown. + * {@inheritdoc} + * @param string $hostname + * @param string $community + * @param array|string $object_id + * @param int $timeout [optional] + * @param int $retries [optional] */ function snmprealwalk (string $hostname, string $community, array|string $object_id, int $timeout = -1, int $retries = -1): array|false {} /** - * Query for a tree of information about a network entity - * @link http://www.php.net/manual/en/function.snmpwalkoid.php - * @param string $hostname - * @param string $community - * @param array|string $object_id - * @param int $timeout [optional] - * @param int $retries [optional] - * @return array|false Returns an associative array with object ids and their respective - * object value starting from the object_id - * as root or false on error. + * {@inheritdoc} + * @param string $hostname + * @param string $community + * @param array|string $object_id + * @param int $timeout [optional] + * @param int $retries [optional] */ function snmpwalkoid (string $hostname, string $community, array|string $object_id, int $timeout = -1, int $retries = -1): array|false {} /** - * Set the value of an SNMP object - * @link http://www.php.net/manual/en/function.snmpset.php - * @param string $hostname - * @param string $community - * @param array|string $object_id - * @param array|string $type - * @param array|string $value - * @param int $timeout [optional] - * @param int $retries [optional] - * @return bool Returns true on success or false on failure. - *If the SNMP host rejects the data type, an E_WARNING message like "Warning: Error in packet. Reason: (badValue) The value given has the wrong type or length." is shown. - * If an unknown or invalid OID is specified the warning probably reads "Could not add variable".
+ * {@inheritdoc} + * @param string $hostname + * @param string $community + * @param array|string $object_id + * @param array|string $type + * @param array|string $value + * @param int $timeout [optional] + * @param int $retries [optional] */ function snmpset (string $hostname, string $community, array|string $object_id, array|string $type, array|string $value, int $timeout = -1, int $retries = -1): bool {} /** - * Fetches the current value of the NET-SNMP library's quick_print setting - * @link http://www.php.net/manual/en/function.snmp-get-quick-print.php - * @return bool Returns true if quick_print is on, false otherwise. + * {@inheritdoc} */ function snmp_get_quick_print (): bool {} /** - * Set the value of enable within the NET-SNMP library - * @link http://www.php.net/manual/en/function.snmp-set-quick-print.php - * @param bool $enable - * @return true Always returns true. + * {@inheritdoc} + * @param bool $enable */ function snmp_set_quick_print (bool $enable): true {} /** - * Return all values that are enums with their enum value instead of the raw integer - * @link http://www.php.net/manual/en/function.snmp-set-enum-print.php - * @param bool $enable As the value is interpreted as boolean by the Net-SNMP library, it can only be "0" or "1". - * @return true Always returns true. + * {@inheritdoc} + * @param bool $enable */ function snmp_set_enum_print (bool $enable): true {} /** - * Set the OID output format - * @link http://www.php.net/manual/en/function.snmp-set-oid-output-format.php - * @param int $format - * @return true Always returns true. + * {@inheritdoc} + * @param int $format */ function snmp_set_oid_output_format (int $format): true {} @@ -460,381 +248,174 @@ function snmp_set_oid_output_format (int $format): true {} * {@inheritdoc} * @param int $format */ -function snmp_set_oid_numeric_print (int $format): bool {} +function snmp_set_oid_numeric_print (int $format): true {} /** - * Fetch an SNMP object - * @link http://www.php.net/manual/en/function.snmp2-get.php - * @param string $hostname The SNMP agent. - * @param string $community The read community. - * @param array|string $object_id The SNMP object. - * @param int $timeout [optional] The number of microseconds until the first timeout. - * @param int $retries [optional] The number of times to retry if timeouts occur. - * @return mixed Returns SNMP object value on success or false on error. + * {@inheritdoc} + * @param string $hostname + * @param string $community + * @param array|string $object_id + * @param int $timeout [optional] + * @param int $retries [optional] */ function snmp2_get (string $hostname, string $community, array|string $object_id, int $timeout = -1, int $retries = -1): mixed {} /** - * Fetch the SNMP object which follows the given object id - * @link http://www.php.net/manual/en/function.snmp2-getnext.php - * @param string $hostname The hostname of the SNMP agent (server). - * @param string $community The read community. - * @param array|string $object_id The SNMP object id which precedes the wanted one. - * @param int $timeout [optional] The number of microseconds until the first timeout. - * @param int $retries [optional] The number of times to retry if timeouts occur. - * @return mixed Returns SNMP object value on success or false on error. - * In case of an error, an E_WARNING message is shown. + * {@inheritdoc} + * @param string $hostname + * @param string $community + * @param array|string $object_id + * @param int $timeout [optional] + * @param int $retries [optional] */ function snmp2_getnext (string $hostname, string $community, array|string $object_id, int $timeout = -1, int $retries = -1): mixed {} /** - * Fetch all the SNMP objects from an agent - * @link http://www.php.net/manual/en/function.snmp2-walk.php - * @param string $hostname The SNMP agent (server). - * @param string $community The read community. - * @param array|string $object_id If null, object_id is taken as the root of - * the SNMP objects tree and all objects under that tree are returned as - * an array. - *If object_id is specified, all the SNMP objects - * below that object_id are returned.
- * @param int $timeout [optional] The number of microseconds until the first timeout. - * @param int $retries [optional] The number of times to retry if timeouts occur. - * @return array|false Returns an array of SNMP object values starting from the - * object_id as root or false on error. + * {@inheritdoc} + * @param string $hostname + * @param string $community + * @param array|string $object_id + * @param int $timeout [optional] + * @param int $retries [optional] */ function snmp2_walk (string $hostname, string $community, array|string $object_id, int $timeout = -1, int $retries = -1): array|false {} /** - * Return all objects including their respective object ID within the specified one - * @link http://www.php.net/manual/en/function.snmp2-real-walk.php - * @param string $hostname The hostname of the SNMP agent (server). - * @param string $community The read community. - * @param array|string $object_id The SNMP object id which precedes the wanted one. - * @param int $timeout [optional] The number of microseconds until the first timeout. - * @param int $retries [optional] The number of times to retry if timeouts occur. - * @return array|false Returns an associative array of the SNMP object ids and their values on success or false on error. - * In case of an error, an E_WARNING message is shown. + * {@inheritdoc} + * @param string $hostname + * @param string $community + * @param array|string $object_id + * @param int $timeout [optional] + * @param int $retries [optional] */ function snmp2_real_walk (string $hostname, string $community, array|string $object_id, int $timeout = -1, int $retries = -1): array|false {} /** - * Set the value of an SNMP object - * @link http://www.php.net/manual/en/function.snmp2-set.php - * @param string $hostname The hostname of the SNMP agent (server). - * @param string $community The write community. - * @param array|string $object_id The SNMP object id. - * @param array|string $type > - * The MIB defines the type of each object id. It has to be specified as a single character from the below list. - *> - * If OPAQUE_SPECIAL_TYPES was defined while compiling the SNMP library, the following are also valid:
- *> - * Most of these will use the obvious corresponding ASN.1 type. 's', 'x', 'd' and 'b' are all different ways of specifying an OCTET STRING value, and - * the 'u' unsigned type is also used for handling Gauge32 values.
- *> - * If the MIB-Files are loaded by into the MIB Tree with "snmp_read_mib" or by specifying it in the libsnmp config, '=' may be used as - * the type parameter for all object ids as the type can then be automatically read from the MIB.
- *> - * Note that there are two ways to set a variable of the type BITS like e.g. - * "SYNTAX BITS {telnet(0), ftp(1), http(2), icmp(3), snmp(4), ssh(5), https(6)}":
- *> - * See examples section for more details.
- * @param array|string $value The new value. - * @param int $timeout [optional] The number of microseconds until the first timeout. - * @param int $retries [optional] The number of times to retry if timeouts occur. - * @return bool Returns true on success or false on failure. - *If the SNMP host rejects the data type, an E_WARNING message like "Warning: Error in packet. Reason: (badValue) The value given has the wrong type or length." is shown. - * If an unknown or invalid OID is specified the warning probably reads "Could not add variable".
+ * {@inheritdoc} + * @param string $hostname + * @param string $community + * @param array|string $object_id + * @param array|string $type + * @param array|string $value + * @param int $timeout [optional] + * @param int $retries [optional] */ function snmp2_set (string $hostname, string $community, array|string $object_id, array|string $type, array|string $value, int $timeout = -1, int $retries = -1): bool {} /** - * Fetch an SNMP object - * @link http://www.php.net/manual/en/function.snmp3-get.php - * @param string $hostname The hostname of the SNMP agent (server). - * @param string $security_name the security name, usually some kind of username - * @param string $security_level the security level (noAuthNoPriv|authNoPriv|authPriv) - * @param string $auth_protocol the authentication protocol ("MD5", "SHA", - * "SHA256", or "SHA512") - * @param string $auth_passphrase the authentication pass phrase - * @param string $privacy_protocol the privacy protocol (DES or AES) - * @param string $privacy_passphrase the privacy pass phrase - * @param array|string $object_id The SNMP object id. - * @param int $timeout [optional] The number of microseconds until the first timeout. - * @param int $retries [optional] The number of times to retry if timeouts occur. - * @return mixed Returns SNMP object value on success or false on error. + * {@inheritdoc} + * @param string $hostname + * @param string $security_name + * @param string $security_level + * @param string $auth_protocol + * @param string $auth_passphrase + * @param string $privacy_protocol + * @param string $privacy_passphrase + * @param array|string $object_id + * @param int $timeout [optional] + * @param int $retries [optional] */ function snmp3_get (string $hostname, string $security_name, string $security_level, string $auth_protocol, string $auth_passphrase, string $privacy_protocol, string $privacy_passphrase, array|string $object_id, int $timeout = -1, int $retries = -1): mixed {} /** - * Fetch the SNMP object which follows the given object id - * @link http://www.php.net/manual/en/function.snmp3-getnext.php - * @param string $hostname The hostname of the - * SNMP agent (server). - * @param string $security_name the security name, usually some kind of username - * @param string $security_level the security level (noAuthNoPriv|authNoPriv|authPriv) - * @param string $auth_protocol the authentication protocol ("MD5", "SHA", - * "SHA256", or "SHA512") - * @param string $auth_passphrase the authentication pass phrase - * @param string $privacy_protocol the privacy protocol (DES or AES) - * @param string $privacy_passphrase the privacy pass phrase - * @param array|string $object_id The SNMP object id. - * @param int $timeout [optional] The number of microseconds until the first timeout. - * @param int $retries [optional] The number of times to retry if timeouts occur. - * @return mixed Returns SNMP object value on success or false on error. - * In case of an error, an E_WARNING message is shown. + * {@inheritdoc} + * @param string $hostname + * @param string $security_name + * @param string $security_level + * @param string $auth_protocol + * @param string $auth_passphrase + * @param string $privacy_protocol + * @param string $privacy_passphrase + * @param array|string $object_id + * @param int $timeout [optional] + * @param int $retries [optional] */ function snmp3_getnext (string $hostname, string $security_name, string $security_level, string $auth_protocol, string $auth_passphrase, string $privacy_protocol, string $privacy_passphrase, array|string $object_id, int $timeout = -1, int $retries = -1): mixed {} /** - * Fetch all the SNMP objects from an agent - * @link http://www.php.net/manual/en/function.snmp3-walk.php - * @param string $hostname The hostname of the SNMP agent (server). - * @param string $security_name the security name, usually some kind of username - * @param string $security_level the security level (noAuthNoPriv|authNoPriv|authPriv) - * @param string $auth_protocol the authentication protocol ("MD5", "SHA", - * "SHA256", or "SHA512") - * @param string $auth_passphrase the authentication pass phrase - * @param string $privacy_protocol the privacy protocol (DES or AES) - * @param string $privacy_passphrase the privacy pass phrase - * @param array|string $object_id If null, object_id is taken as the root of - * the SNMP objects tree and all objects under that tree are returned as - * an array. - *If object_id is specified, all the SNMP objects - * below that object_id are returned.
- * @param int $timeout [optional] The number of microseconds until the first timeout. - * @param int $retries [optional] The number of times to retry if timeouts occur. - * @return array|false Returns an array of SNMP object values starting from the - * object_id as root or false on error. + * {@inheritdoc} + * @param string $hostname + * @param string $security_name + * @param string $security_level + * @param string $auth_protocol + * @param string $auth_passphrase + * @param string $privacy_protocol + * @param string $privacy_passphrase + * @param array|string $object_id + * @param int $timeout [optional] + * @param int $retries [optional] */ function snmp3_walk (string $hostname, string $security_name, string $security_level, string $auth_protocol, string $auth_passphrase, string $privacy_protocol, string $privacy_passphrase, array|string $object_id, int $timeout = -1, int $retries = -1): array|false {} /** - * Return all objects including their respective object ID within the specified one - * @link http://www.php.net/manual/en/function.snmp3-real-walk.php - * @param string $hostname The hostname of the - * SNMP agent (server). - * @param string $security_name the security name, usually some kind of username - * @param string $security_level the security level (noAuthNoPriv|authNoPriv|authPriv) - * @param string $auth_protocol the authentication protocol (MD5 or SHA) - * @param string $auth_passphrase the authentication pass phrase - * @param string $privacy_protocol the authentication protocol ("MD5", "SHA", - * "SHA256", or "SHA512") - * @param string $privacy_passphrase the privacy pass phrase - * @param array|string $object_id The SNMP object id. - * @param int $timeout [optional] The number of microseconds until the first timeout. - * @param int $retries [optional] The number of times to retry if timeouts occur. - * @return array|false Returns an associative array of the - * SNMP object ids and their values on success or false on error. - * In case of an error, an E_WARNING message is shown. + * {@inheritdoc} + * @param string $hostname + * @param string $security_name + * @param string $security_level + * @param string $auth_protocol + * @param string $auth_passphrase + * @param string $privacy_protocol + * @param string $privacy_passphrase + * @param array|string $object_id + * @param int $timeout [optional] + * @param int $retries [optional] */ function snmp3_real_walk (string $hostname, string $security_name, string $security_level, string $auth_protocol, string $auth_passphrase, string $privacy_protocol, string $privacy_passphrase, array|string $object_id, int $timeout = -1, int $retries = -1): array|false {} /** - * Set the value of an SNMP object - * @link http://www.php.net/manual/en/function.snmp3-set.php - * @param string $hostname The hostname of the SNMP agent (server). - * @param string $security_name the security name, usually some kind of username - * @param string $security_level the security level (noAuthNoPriv|authNoPriv|authPriv) - * @param string $auth_protocol the authentication protocol (MD5 or SHA) - * @param string $auth_passphrase the authentication pass phrase - * @param string $privacy_protocol the privacy protocol (DES or AES) - * @param string $privacy_passphrase the privacy pass phrase - * @param array|string $object_id The SNMP object id. - * @param array|string $type > - * The MIB defines the type of each object id. It has to be specified as a single character from the below list. - *> - * If OPAQUE_SPECIAL_TYPES was defined while compiling the SNMP library, the following are also valid:
- *> - * Most of these will use the obvious corresponding ASN.1 type. 's', 'x', 'd' and 'b' are all different ways of specifying an OCTET STRING value, and - * the 'u' unsigned type is also used for handling Gauge32 values.
- *> - * If the MIB-Files are loaded by into the MIB Tree with "snmp_read_mib" or by specifying it in the libsnmp config, '=' may be used as - * the type parameter for all object ids as the type can then be automatically read from the MIB.
- *> - * Note that there are two ways to set a variable of the type BITS like e.g. - * "SYNTAX BITS {telnet(0), ftp(1), http(2), icmp(3), snmp(4), ssh(5), https(6)}":
- *> - * See examples section for more details.
- * @param array|string $value The new value - * @param int $timeout [optional] The number of microseconds until the first timeout. - * @param int $retries [optional] The number of times to retry if timeouts occur. - * @return bool Returns true on success or false on failure. - *If the SNMP host rejects the data type, an E_WARNING message like "Warning: Error in packet. Reason: (badValue) The value given has the wrong type or length." is shown. - * If an unknown or invalid OID is specified the warning probably reads "Could not add variable".
+ * {@inheritdoc} + * @param string $hostname + * @param string $security_name + * @param string $security_level + * @param string $auth_protocol + * @param string $auth_passphrase + * @param string $privacy_protocol + * @param string $privacy_passphrase + * @param array|string $object_id + * @param array|string $type + * @param array|string $value + * @param int $timeout [optional] + * @param int $retries [optional] */ function snmp3_set (string $hostname, string $security_name, string $security_level, string $auth_protocol, string $auth_passphrase, string $privacy_protocol, string $privacy_passphrase, array|string $object_id, array|string $type, array|string $value, int $timeout = -1, int $retries = -1): bool {} /** - * Specify the method how the SNMP values will be returned - * @link http://www.php.net/manual/en/function.snmp-set-valueretrieval.php - * @param int $method - * @return true Always returns true. + * {@inheritdoc} + * @param int $method */ function snmp_set_valueretrieval (int $method): true {} /** - * Return the method how the SNMP values will be returned - * @link http://www.php.net/manual/en/function.snmp-get-valueretrieval.php - * @return int OR-ed combitantion of constants ( SNMP_VALUE_LIBRARY or - * SNMP_VALUE_PLAIN ) with - * possible SNMP_VALUE_OBJECT set. + * {@inheritdoc} */ function snmp_get_valueretrieval (): int {} /** - * Reads and parses a MIB file into the active MIB tree - * @link http://www.php.net/manual/en/function.snmp-read-mib.php - * @param string $filename - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $filename */ function snmp_read_mib (string $filename): bool {} - -/** - * - * @link http://www.php.net/manual/en/snmp.constants.php - * @var int - */ define ('SNMP_OID_OUTPUT_SUFFIX', 1); - -/** - * - * @link http://www.php.net/manual/en/snmp.constants.php - * @var int - */ define ('SNMP_OID_OUTPUT_MODULE', 2); - -/** - * - * @link http://www.php.net/manual/en/snmp.constants.php - * @var int - */ define ('SNMP_OID_OUTPUT_FULL', 3); - -/** - * - * @link http://www.php.net/manual/en/snmp.constants.php - * @var int - */ define ('SNMP_OID_OUTPUT_NUMERIC', 4); - -/** - * - * @link http://www.php.net/manual/en/snmp.constants.php - * @var int - */ define ('SNMP_OID_OUTPUT_UCD', 5); - -/** - * - * @link http://www.php.net/manual/en/snmp.constants.php - * @var int - */ define ('SNMP_OID_OUTPUT_NONE', 6); - -/** - * - * @link http://www.php.net/manual/en/snmp.constants.php - * @var int - */ define ('SNMP_VALUE_LIBRARY', 0); - -/** - * - * @link http://www.php.net/manual/en/snmp.constants.php - * @var int - */ define ('SNMP_VALUE_PLAIN', 1); - -/** - * - * @link http://www.php.net/manual/en/snmp.constants.php - * @var int - */ define ('SNMP_VALUE_OBJECT', 2); - -/** - * - * @link http://www.php.net/manual/en/snmp.constants.php - * @var int - */ define ('SNMP_BIT_STR', 3); - -/** - * - * @link http://www.php.net/manual/en/snmp.constants.php - * @var int - */ define ('SNMP_OCTET_STR', 4); - -/** - * - * @link http://www.php.net/manual/en/snmp.constants.php - * @var int - */ define ('SNMP_OPAQUE', 68); - -/** - * - * @link http://www.php.net/manual/en/snmp.constants.php - * @var int - */ define ('SNMP_NULL', 5); - -/** - * - * @link http://www.php.net/manual/en/snmp.constants.php - * @var int - */ define ('SNMP_OBJECT_ID', 6); - -/** - * - * @link http://www.php.net/manual/en/snmp.constants.php - * @var int - */ define ('SNMP_IPADDRESS', 64); - -/** - * - * @link http://www.php.net/manual/en/snmp.constants.php - * @var int - */ define ('SNMP_COUNTER', 66); - -/** - * - * @link http://www.php.net/manual/en/snmp.constants.php - * @var int - */ define ('SNMP_UNSIGNED', 66); - -/** - * - * @link http://www.php.net/manual/en/snmp.constants.php - * @var int - */ define ('SNMP_TIMETICKS', 67); - -/** - * - * @link http://www.php.net/manual/en/snmp.constants.php - * @var int - */ define ('SNMP_UINTEGER', 71); - -/** - * - * @link http://www.php.net/manual/en/snmp.constants.php - * @var int - */ define ('SNMP_INTEGER', 2); - -/** - * - * @link http://www.php.net/manual/en/snmp.constants.php - * @var int - */ define ('SNMP_COUNTER64', 70); -// End of snmp v.8.2.6 +// End of snmp v.8.3.0 diff --git a/plugins/org.eclipse.php.core/Resources/language/php8.3/soap.php b/plugins/org.eclipse.php.core/Resources/language/php8.3/soap.php index d8d382b870..d3315f67e8 100644 --- a/plugins/org.eclipse.php.core/Resources/language/php8.3/soap.php +++ b/plugins/org.eclipse.php.core/Resources/language/php8.3/soap.php @@ -1,150 +1,100 @@ On error, if the SoapClient object was constructed - * with the exceptions option set to false, - * a SoapFault object will be returned. + * {@inheritdoc} + * @param string $name + * @param array $args */ - public function __call (string $name, array $args): mixed {} + public function __call (string $name, array $args) {} /** - * Calls a SOAP function - * @link http://www.php.net/manual/en/soapclient.soapcall.php - * @param string $name - * @param array $args - * @param array|null $options [optional] - * @param SoapHeader|array|null $inputHeaders [optional] - * @param array $outputHeaders [optional] - * @return mixed SOAP functions may return one, or multiple values. If only one value is - * returned by the SOAP function, the return value will be a scalar. - * If multiple values are returned, an associative array of named output - * parameters is returned instead. - *On error, if the SoapClient object was constructed - * with the exceptions option set to false, - * a SoapFault object will be returned.
+ * {@inheritdoc} + * @param string $name + * @param array $args + * @param array|null $options [optional] + * @param mixed $inputHeaders [optional] + * @param mixed $outputHeaders [optional] */ - public function __soapCall (string $name, array $args, ?array $options = null, SoapHeader|array|null $inputHeaders = null, array &$outputHeaders = null): mixed {} + public function __soapCall (string $name, array $args, ?array $options = NULL, $inputHeaders = NULL, &$outputHeaders = NULL) {} /** - * Returns list of available SOAP functions - * @link http://www.php.net/manual/en/soapclient.getfunctions.php - * @return array|null The array of SOAP function prototypes, detailing the return type, - * the function name and parameter types. + * {@inheritdoc} */ - public function __getFunctions (): ?array {} + public function __getFunctions () {} /** - * Returns a list of SOAP types - * @link http://www.php.net/manual/en/soapclient.gettypes.php - * @return array|null The array of SOAP types, detailing all structures and types. + * {@inheritdoc} */ - public function __getTypes (): ?array {} + public function __getTypes () {} /** - * Returns last SOAP request - * @link http://www.php.net/manual/en/soapclient.getlastrequest.php - * @return string|null The last SOAP request, as an XML string. + * {@inheritdoc} */ - public function __getLastRequest (): ?string {} + public function __getLastRequest () {} /** - * Returns last SOAP response - * @link http://www.php.net/manual/en/soapclient.getlastresponse.php - * @return string|null The last SOAP response, as an XML string. + * {@inheritdoc} */ - public function __getLastResponse (): ?string {} + public function __getLastResponse () {} /** - * Returns the SOAP headers from the last request - * @link http://www.php.net/manual/en/soapclient.getlastrequestheaders.php - * @return string|null The last SOAP request headers. + * {@inheritdoc} */ - public function __getLastRequestHeaders (): ?string {} + public function __getLastRequestHeaders () {} /** - * Returns the SOAP headers from the last response - * @link http://www.php.net/manual/en/soapclient.getlastresponseheaders.php - * @return string|null The last SOAP response headers. + * {@inheritdoc} */ - public function __getLastResponseHeaders (): ?string {} + public function __getLastResponseHeaders () {} /** - * Performs a SOAP request - * @link http://www.php.net/manual/en/soapclient.dorequest.php - * @param string $request - * @param string $location - * @param string $action - * @param int $version - * @param bool $oneWay [optional] - * @return string|null The XML SOAP response. + * {@inheritdoc} + * @param string $request + * @param string $location + * @param string $action + * @param int $version + * @param bool $oneWay [optional] */ - public function __doRequest (string $request, string $location, string $action, int $version, bool $oneWay = false): ?string {} + public function __doRequest (string $request, string $location, string $action, int $version, bool $oneWay = false) {} /** - * Defines a cookie for SOAP requests - * @link http://www.php.net/manual/en/soapclient.setcookie.php - * @param string $name - * @param string|null $value [optional] - * @return void No value is returned. + * {@inheritdoc} + * @param string $name + * @param string|null $value [optional] */ - public function __setCookie (string $name, ?string $value = null): void {} + public function __setCookie (string $name, ?string $value = NULL) {} /** - * Get list of cookies - * @link http://www.php.net/manual/en/soapclient.getcookies.php - * @return array + * {@inheritdoc} */ - public function __getCookies (): array {} + public function __getCookies () {} /** - * Sets SOAP headers for subsequent calls - * @link http://www.php.net/manual/en/soapclient.setsoapheaders.php - * @param SoapHeader|array|null $headers [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mixed $headers [optional] */ - public function __setSoapHeaders (SoapHeader|array|null $headers = null): bool {} + public function __setSoapHeaders ($headers = NULL) {} /** - * Sets the location of the Web service to use - * @link http://www.php.net/manual/en/soapclient.setlocation.php - * @param string|null $location [optional] - * @return string|null The old endpoint URL. + * {@inheritdoc} + * @param string|null $location [optional] */ - public function __setLocation (?string $location = null): ?string {} + public function __setLocation (?string $location = NULL) {} } -/** - * A class representing a variable or object for use with SOAP services. - * @link http://www.php.net/manual/en/class.soapvar.php - */ class SoapVar { public int $enc_type; @@ -160,111 +110,82 @@ class SoapVar { public ?string $enc_namens; /** - * SoapVar constructor - * @link http://www.php.net/manual/en/soapvar.construct.php - * @param mixed $data - * @param int|null $encoding - * @param string|null $typeName [optional] - * @param string|null $typeNamespace [optional] - * @param string|null $nodeName [optional] - * @param string|null $nodeNamespace [optional] - * @return mixed + * {@inheritdoc} + * @param mixed $data + * @param int|null $encoding + * @param string|null $typeName [optional] + * @param string|null $typeNamespace [optional] + * @param string|null $nodeName [optional] + * @param string|null $nodeNamespace [optional] */ - public function __construct (mixed $data, ?int $encoding, ?string $typeName = null, ?string $typeNamespace = null, ?string $nodeName = null, ?string $nodeNamespace = null): mixed {} + public function __construct (mixed $data = null, ?int $encoding = null, ?string $typeName = NULL, ?string $typeNamespace = NULL, ?string $nodeName = NULL, ?string $nodeNamespace = NULL) {} } -/** - * The SoapServer class provides a server for the SOAP 1.1 - * and SOAP 1.2 protocols. It can be - * used with or without a WSDL service description. - * @link http://www.php.net/manual/en/class.soapserver.php - */ class SoapServer { /** - * SoapServer constructor - * @link http://www.php.net/manual/en/soapserver.construct.php - * @param string|null $wsdl - * @param array $options [optional] - * @return string|null + * {@inheritdoc} + * @param string|null $wsdl + * @param array $options [optional] */ - public function __construct (?string $wsdl, array $options = '[]'): ?string {} + public function __construct (?string $wsdl = null, array $options = array ( +)) {} /** - * Issue SoapServer fault indicating an error - * @link http://www.php.net/manual/en/soapserver.fault.php - * @param string $code - * @param string $string - * @param string $actor [optional] - * @param mixed $details [optional] - * @param string $name [optional] - * @return void No value is returned. + * {@inheritdoc} + * @param string $code + * @param string $string + * @param string $actor [optional] + * @param mixed $details [optional] + * @param string $name [optional] */ - public function fault (string $code, string $string, string $actor = '""', mixed $details = null, string $name = '""'): void {} + public function fault (string $code, string $string, string $actor = '', mixed $details = NULL, string $name = '') {} /** - * Add a SOAP header to the response - * @link http://www.php.net/manual/en/soapserver.addsoapheader.php - * @param SoapHeader $header - * @return void No value is returned. + * {@inheritdoc} + * @param SoapHeader $header */ - public function addSoapHeader (SoapHeader $header): void {} + public function addSoapHeader (SoapHeader $header) {} /** - * Sets SoapServer persistence mode - * @link http://www.php.net/manual/en/soapserver.setpersistence.php - * @param int $mode - * @return void No value is returned. + * {@inheritdoc} + * @param int $mode */ - public function setPersistence (int $mode): void {} + public function setPersistence (int $mode) {} /** - * Sets the class which handles SOAP requests - * @link http://www.php.net/manual/en/soapserver.setclass.php - * @param string $class - * @param mixed $args - * @return void No value is returned. + * {@inheritdoc} + * @param string $class + * @param mixed $args [optional] */ - public function setClass (string $class, mixed ...$args): void {} + public function setClass (string $class, mixed ...$args) {} /** - * Sets the object which will be used to handle SOAP requests - * @link http://www.php.net/manual/en/soapserver.setobject.php - * @param object $object - * @return void No value is returned. + * {@inheritdoc} + * @param object $object */ - public function setObject (object $object): void {} + public function setObject (object $object) {} /** - * Returns list of defined functions - * @link http://www.php.net/manual/en/soapserver.getfunctions.php - * @return array An array of the defined functions. + * {@inheritdoc} */ - public function getFunctions (): array {} + public function getFunctions () {} /** - * Adds one or more functions to handle SOAP requests - * @link http://www.php.net/manual/en/soapserver.addfunction.php - * @param array|string|int $functions - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $functions */ - public function addFunction (array|string|int $functions): void {} + public function addFunction ($functions = null) {} /** - * Handles a SOAP request - * @link http://www.php.net/manual/en/soapserver.handle.php - * @param string|null $request [optional] - * @return void No value is returned. + * {@inheritdoc} + * @param string|null $request [optional] */ - public function handle (?string $request = null): void {} + public function handle (?string $request = NULL) {} } -/** - * Represents a SOAP fault. - * @link http://www.php.net/manual/en/class.soapfault.php - */ class SoapFault extends Exception implements Stringable, Throwable { public string $faultstring; @@ -282,22 +203,18 @@ class SoapFault extends Exception implements Stringable, Throwable { public mixed $headerfault; /** - * SoapFault constructor - * @link http://www.php.net/manual/en/soapfault.construct.php - * @param array|string|null $code - * @param string $string - * @param string|null $actor [optional] - * @param mixed $details [optional] - * @param string|null $name [optional] - * @param mixed $headerFault [optional] - * @return array|string|null + * {@inheritdoc} + * @param array|string|null $code + * @param string $string + * @param string|null $actor [optional] + * @param mixed $details [optional] + * @param string|null $name [optional] + * @param mixed $headerFault [optional] */ - public function __construct (array|string|null $code, string $string, ?string $actor = null, mixed $details = null, ?string $name = null, mixed $headerFault = null): array|string|null {} + public function __construct (array|string|null $code = null, string $string, ?string $actor = NULL, mixed $details = NULL, ?string $name = NULL, mixed $headerFault = NULL) {} /** - * Obtain a string representation of a SoapFault - * @link http://www.php.net/manual/en/soapfault.tostring.php - * @return string A string describing the SoapFault. + * {@inheritdoc} */ public function __toString (): string {} @@ -307,64 +224,42 @@ public function __toString (): string {} public function __wakeup () {} /** - * Gets the Exception message - * @link http://www.php.net/manual/en/exception.getmessage.php - * @return string Returns the Exception message as a string. + * {@inheritdoc} */ final public function getMessage (): string {} /** - * Gets the Exception code - * @link http://www.php.net/manual/en/exception.getcode.php - * @return int Returns the exception code as int in - * Exception but possibly as other type in - * Exception descendants (for example as - * string in PDOException). + * {@inheritdoc} */ - final public function getCode (): int {} + final public function getCode () {} /** - * Gets the file in which the exception was created - * @link http://www.php.net/manual/en/exception.getfile.php - * @return string Returns the filename in which the exception was created. + * {@inheritdoc} */ final public function getFile (): string {} /** - * Gets the line in which the exception was created - * @link http://www.php.net/manual/en/exception.getline.php - * @return int Returns the line number where the exception was created. + * {@inheritdoc} */ final public function getLine (): int {} /** - * Gets the stack trace - * @link http://www.php.net/manual/en/exception.gettrace.php - * @return array Returns the Exception stack trace as an array. + * {@inheritdoc} */ final public function getTrace (): array {} /** - * Returns previous Throwable - * @link http://www.php.net/manual/en/exception.getprevious.php - * @return Throwable|null Returns the previous Throwable if available - * or null otherwise. + * {@inheritdoc} */ final public function getPrevious (): ?Throwable {} /** - * Gets the stack trace as a string - * @link http://www.php.net/manual/en/exception.gettraceasstring.php - * @return string Returns the Exception stack trace as a string. + * {@inheritdoc} */ final public function getTraceAsString (): string {} } -/** - * Represents parameter to a SOAP call. - * @link http://www.php.net/manual/en/class.soapparam.php - */ class SoapParam { public string $param_name; @@ -372,20 +267,14 @@ class SoapParam { public mixed $param_data; /** - * SoapParam constructor - * @link http://www.php.net/manual/en/soapparam.construct.php - * @param mixed $data - * @param string $name - * @return mixed + * {@inheritdoc} + * @param mixed $data + * @param string $name */ - public function __construct (mixed $data, string $name): mixed {} + public function __construct (mixed $data = null, string $name) {} } -/** - * Represents a SOAP header. - * @link http://www.php.net/manual/en/class.soapheader.php - */ class SoapHeader { public string $namespace; @@ -399,34 +288,28 @@ class SoapHeader { public string|int|null $actor; /** - * SoapHeader constructor - * @link http://www.php.net/manual/en/soapheader.construct.php - * @param string $namespace - * @param string $name - * @param mixed $data [optional] - * @param bool $mustunderstand [optional] - * @param string $actor [optional] - * @return string + * {@inheritdoc} + * @param string $namespace + * @param string $name + * @param mixed $data [optional] + * @param bool $mustUnderstand [optional] + * @param string|int|null $actor [optional] */ - public function __construct (string $namespace, string $name, mixed $data = null, bool $mustunderstand = null, string $actor = null): string {} + public function __construct (string $namespace, string $name, mixed $data = NULL, bool $mustUnderstand = false, string|int|null $actor = NULL) {} } /** - * Set whether to use the SOAP error handler - * @link http://www.php.net/manual/en/function.use-soap-error-handler.php - * @param bool $enable [optional] - * @return bool Returns the original value. + * {@inheritdoc} + * @param bool $enable [optional] */ function use_soap_error_handler (bool $enable = true): bool {} /** - * Checks if a SOAP call has failed - * @link http://www.php.net/manual/en/function.is-soap-fault.php - * @param mixed $object - * @return bool This will return true on error, and false otherwise. + * {@inheritdoc} + * @param mixed $object */ -function is_soap_fault (mixed $object): bool {} +function is_soap_fault (mixed $object = null): bool {} define ('SOAP_1_1', 1); define ('SOAP_1_2', 2); @@ -510,4 +393,4 @@ function is_soap_fault (mixed $object): bool {} define ('SOAP_SSL_METHOD_SSLv3', 2); define ('SOAP_SSL_METHOD_SSLv23', 3); -// End of soap v.8.2.6 +// End of soap v.8.3.0 diff --git a/plugins/org.eclipse.php.core/Resources/language/php8.3/sockets.php b/plugins/org.eclipse.php.core/Resources/language/php8.3/sockets.php index c6abd10cf6..6fad1a92eb 100644 --- a/plugins/org.eclipse.php.core/Resources/language/php8.3/sockets.php +++ b/plugins/org.eclipse.php.core/Resources/language/php8.3/sockets.php @@ -1,713 +1,336 @@ Be sure to use the === operator when checking for an - * error. Since the socket_select may return 0 the - * comparison with == would evaluate to true: - * Understanding socket_select's result - *
- * <?php
- * $e = NULL;
- * if (false === socket_select($r, $w, $e, 0)) {
- * echo "socket_select() failed, reason: " .
- * socket_strerror(socket_last_error()) . "\n";
- * }
- * ?>
- *
+ * {@inheritdoc}
+ * @param array|null $read
+ * @param array|null $write
+ * @param array|null $except
+ * @param int|null $seconds
+ * @param int $microseconds [optional]
*/
-function socket_select (?array &$read, ?array &$write, ?array &$except, ?int $seconds, int $microseconds = null): int|false {}
+function socket_select (?array &$read = null, ?array &$write = null, ?array &$except = null, ?int $seconds = null, int $microseconds = 0): int|false {}
/**
- * Opens a socket on port to accept connections
- * @link http://www.php.net/manual/en/function.socket-create-listen.php
- * @param int $port
- * @param int $backlog [optional]
- * @return Socket|false socket_create_listen returns a new Socket instance
- * on success or false on error. The error code can be retrieved with
- * socket_last_error. This code may be passed to
- * socket_strerror to get a textual explanation of the
- * error.
+ * {@inheritdoc}
+ * @param int $port
+ * @param int $backlog [optional]
*/
function socket_create_listen (int $port, int $backlog = 128): Socket|false {}
/**
- * Accepts a connection on a socket
- * @link http://www.php.net/manual/en/function.socket-accept.php
- * @param Socket $socket
- * @return Socket|false Returns a new Socket instance on success, or false on error. The actual
- * error code can be retrieved by calling
- * socket_last_error. This error code may be passed to
- * socket_strerror to get a textual explanation of the
- * error.
+ * {@inheritdoc}
+ * @param Socket $socket
*/
function socket_accept (Socket $socket): Socket|false {}
/**
- * Sets nonblocking mode for file descriptor fd
- * @link http://www.php.net/manual/en/function.socket-set-nonblock.php
- * @param Socket $socket
- * @return bool Returns true on success or false on failure.
+ * {@inheritdoc}
+ * @param Socket $socket
*/
function socket_set_nonblock (Socket $socket): bool {}
/**
- * Sets blocking mode on a socket
- * @link http://www.php.net/manual/en/function.socket-set-block.php
- * @param Socket $socket
- * @return bool Returns true on success or false on failure.
+ * {@inheritdoc}
+ * @param Socket $socket
*/
function socket_set_block (Socket $socket): bool {}
/**
- * Listens for a connection on a socket
- * @link http://www.php.net/manual/en/function.socket-listen.php
- * @param Socket $socket
- * @param int $backlog [optional]
- * @return bool Returns true on success or false on failure. The error code can be retrieved with
- * socket_last_error. This code may be passed to
- * socket_strerror to get a textual explanation of the
- * error.
+ * {@inheritdoc}
+ * @param Socket $socket
+ * @param int $backlog [optional]
*/
-function socket_listen (Socket $socket, int $backlog = null): bool {}
+function socket_listen (Socket $socket, int $backlog = 0): bool {}
/**
- * Closes a Socket instance
- * @link http://www.php.net/manual/en/function.socket-close.php
- * @param Socket $socket
- * @return void No value is returned.
+ * {@inheritdoc}
+ * @param Socket $socket
*/
function socket_close (Socket $socket): void {}
/**
- * Write to a socket
- * @link http://www.php.net/manual/en/function.socket-write.php
- * @param Socket $socket
- * @param string $data
- * @param int|null $length [optional]
- * @return int|false Returns the number of bytes successfully written to the socket or false on failure.
- * The error code can be retrieved with
- * socket_last_error. This code may be passed to
- * socket_strerror to get a textual explanation of the
- * error.
- * It is perfectly valid for socket_write to - * return zero which means no bytes have been written. Be sure to use the - * === operator to check for false in case of an - * error.
+ * {@inheritdoc} + * @param Socket $socket + * @param string $data + * @param int|null $length [optional] */ -function socket_write (Socket $socket, string $data, ?int $length = null): int|false {} +function socket_write (Socket $socket, string $data, ?int $length = NULL): int|false {} /** - * Reads a maximum of length bytes from a socket - * @link http://www.php.net/manual/en/function.socket-read.php - * @param Socket $socket - * @param int $length - * @param int $mode [optional] - * @return string|false socket_read returns the data as a string on success, - * or false on error (including if the remote host has closed the - * connection). The error code can be retrieved with - * socket_last_error. This code may be passed to - * socket_strerror to get a textual representation of - * the error. - *socket_read returns a zero length string ("") - * when there is no more data to read.
+ * {@inheritdoc} + * @param Socket $socket + * @param int $length + * @param int $mode [optional] */ -function socket_read (Socket $socket, int $length, int $mode = PHP_BINARY_READ): string|false {} +function socket_read (Socket $socket, int $length, int $mode = 2): string|false {} /** - * Queries the local side of the given socket which may either result in host/port or in a Unix filesystem path, dependent on its type - * @link http://www.php.net/manual/en/function.socket-getsockname.php - * @param Socket $socket - * @param string $address - * @param int $port [optional] - * @return bool Returns true on success or false on failure. socket_getsockname may also return - * false if the socket type is not any of AF_INET, - * AF_INET6, or AF_UNIX, in which - * case the last socket error code is not updated. + * {@inheritdoc} + * @param Socket $socket + * @param mixed $address + * @param mixed $port [optional] */ -function socket_getsockname (Socket $socket, string &$address, int &$port = null): bool {} +function socket_getsockname (Socket $socket, &$address = null, &$port = NULL): bool {} /** - * Queries the remote side of the given socket which may either result in host/port or in a Unix filesystem path, dependent on its type - * @link http://www.php.net/manual/en/function.socket-getpeername.php - * @param Socket $socket - * @param string $address - * @param int $port [optional] - * @return bool Returns true on success or false on failure. socket_getpeername may also return - * false if the socket type is not any of AF_INET, - * AF_INET6, or AF_UNIX, in which - * case the last socket error code is not updated. + * {@inheritdoc} + * @param Socket $socket + * @param mixed $address + * @param mixed $port [optional] */ -function socket_getpeername (Socket $socket, string &$address, int &$port = null): bool {} +function socket_getpeername (Socket $socket, &$address = null, &$port = NULL): bool {} /** - * Create a socket (endpoint for communication) - * @link http://www.php.net/manual/en/function.socket-create.php - * @param int $domain - * @param int $type - * @param int $protocol - * @return Socket|false socket_create returns a Socket instance on success, - * or false on error. The actual error code can be retrieved by calling - * socket_last_error. This error code may be passed to - * socket_strerror to get a textual explanation of the - * error. + * {@inheritdoc} + * @param int $domain + * @param int $type + * @param int $protocol */ function socket_create (int $domain, int $type, int $protocol): Socket|false {} /** - * Initiates a connection on a socket - * @link http://www.php.net/manual/en/function.socket-connect.php - * @param Socket $socket - * @param string $address - * @param int|null $port [optional] - * @return bool Returns true on success or false on failure. The error code can be retrieved with - * socket_last_error. This code may be passed to - * socket_strerror to get a textual explanation of the - * error. - *If the socket is non-blocking then this function returns false with an - * error Operation now in progress.
+ * {@inheritdoc} + * @param Socket $socket + * @param string $address + * @param int|null $port [optional] */ -function socket_connect (Socket $socket, string $address, ?int $port = null): bool {} +function socket_connect (Socket $socket, string $address, ?int $port = NULL): bool {} /** - * Return a string describing a socket error - * @link http://www.php.net/manual/en/function.socket-strerror.php - * @param int $error_code - * @return string Returns the error message associated with the error_code - * parameter. + * {@inheritdoc} + * @param int $error_code */ function socket_strerror (int $error_code): string {} /** - * Binds a name to a socket - * @link http://www.php.net/manual/en/function.socket-bind.php - * @param Socket $socket - * @param string $address - * @param int $port [optional] - * @return bool Returns true on success or false on failure. - *The error code can be retrieved with socket_last_error. - * This code may be passed to socket_strerror to get a - * textual explanation of the error.
+ * {@inheritdoc} + * @param Socket $socket + * @param string $address + * @param int $port [optional] */ -function socket_bind (Socket $socket, string $address, int $port = null): bool {} +function socket_bind (Socket $socket, string $address, int $port = 0): bool {} /** - * Receives data from a connected socket - * @link http://www.php.net/manual/en/function.socket-recv.php - * @param Socket $socket - * @param string|null $data - * @param int $length - * @param int $flags - * @return int|false socket_recv returns the number of bytes received, - * or false if there was an error. The actual error code can be retrieved by - * calling socket_last_error. This error code may be - * passed to socket_strerror to get a textual explanation - * of the error. + * {@inheritdoc} + * @param Socket $socket + * @param mixed $data + * @param int $length + * @param int $flags */ -function socket_recv (Socket $socket, ?string &$data, int $length, int $flags): int|false {} +function socket_recv (Socket $socket, &$data = null, int $length, int $flags): int|false {} /** - * Sends data to a connected socket - * @link http://www.php.net/manual/en/function.socket-send.php - * @param Socket $socket - * @param string $data - * @param int $length - * @param int $flags - * @return int|false socket_send returns the number of bytes sent, or false on error. + * {@inheritdoc} + * @param Socket $socket + * @param string $data + * @param int $length + * @param int $flags */ function socket_send (Socket $socket, string $data, int $length, int $flags): int|false {} /** - * Receives data from a socket whether or not it is connection-oriented - * @link http://www.php.net/manual/en/function.socket-recvfrom.php - * @param Socket $socket - * @param string $data - * @param int $length - * @param int $flags - * @param string $address - * @param int $port [optional] - * @return int|false socket_recvfrom returns the number of bytes received, - * or false if there was an error. The actual error code can be retrieved by - * calling socket_last_error. This error code may be - * passed to socket_strerror to get a textual explanation - * of the error. + * {@inheritdoc} + * @param Socket $socket + * @param mixed $data + * @param int $length + * @param int $flags + * @param mixed $address + * @param mixed $port [optional] */ -function socket_recvfrom (Socket $socket, string &$data, int $length, int $flags, string &$address, int &$port = null): int|false {} +function socket_recvfrom (Socket $socket, &$data = null, int $length, int $flags, &$address = null, &$port = NULL): int|false {} /** - * Sends a message to a socket, whether it is connected or not - * @link http://www.php.net/manual/en/function.socket-sendto.php - * @param Socket $socket - * @param string $data - * @param int $length - * @param int $flags - * @param string $address - * @param int|null $port [optional] - * @return int|false socket_sendto returns the number of bytes sent to the - * remote host, or false if an error occurred. + * {@inheritdoc} + * @param Socket $socket + * @param string $data + * @param int $length + * @param int $flags + * @param string $address + * @param int|null $port [optional] */ -function socket_sendto (Socket $socket, string $data, int $length, int $flags, string $address, ?int $port = null): int|false {} +function socket_sendto (Socket $socket, string $data, int $length, int $flags, string $address, ?int $port = NULL): int|false {} /** - * Gets socket options for the socket - * @link http://www.php.net/manual/en/function.socket-get-option.php - * @param Socket $socket - * @param int $level - * @param int $option - * @return array|int|false Returns the value of the given option, or false on failure. + * {@inheritdoc} + * @param Socket $socket + * @param int $level + * @param int $option */ function socket_get_option (Socket $socket, int $level, int $option): array|int|false {} /** - * Alias of socket_get_option - * @link http://www.php.net/manual/en/function.socket-getopt.php - * @param Socket $socket - * @param int $level - * @param int $option - * @return array|int|false Returns the value of the given option, or false on failure. + * {@inheritdoc} + * @param Socket $socket + * @param int $level + * @param int $option */ function socket_getopt (Socket $socket, int $level, int $option): array|int|false {} /** - * Sets socket options for the socket - * @link http://www.php.net/manual/en/function.socket-set-option.php - * @param Socket $socket - * @param int $level - * @param int $option - * @param array|string|int $value - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param Socket $socket + * @param int $level + * @param int $option + * @param mixed $value */ -function socket_set_option (Socket $socket, int $level, int $option, array|string|int $value): bool {} +function socket_set_option (Socket $socket, int $level, int $option, $value = null): bool {} /** - * Alias of socket_set_option - * @link http://www.php.net/manual/en/function.socket-setopt.php - * @param Socket $socket - * @param int $level - * @param int $option - * @param array|string|int $value - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param Socket $socket + * @param int $level + * @param int $option + * @param mixed $value */ -function socket_setopt (Socket $socket, int $level, int $option, array|string|int $value): bool {} +function socket_setopt (Socket $socket, int $level, int $option, $value = null): bool {} /** - * Creates a pair of indistinguishable sockets and stores them in an array - * @link http://www.php.net/manual/en/function.socket-create-pair.php - * @param int $domain - * @param int $type - * @param int $protocol - * @param array $pair - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $domain + * @param int $type + * @param int $protocol + * @param mixed $pair */ -function socket_create_pair (int $domain, int $type, int $protocol, array &$pair): bool {} +function socket_create_pair (int $domain, int $type, int $protocol, &$pair = null): bool {} /** - * Shuts down a socket for receiving, sending, or both - * @link http://www.php.net/manual/en/function.socket-shutdown.php - * @param Socket $socket - * @param int $mode [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param Socket $socket + * @param int $mode [optional] */ function socket_shutdown (Socket $socket, int $mode = 2): bool {} /** - * Returns the last error on the socket - * @link http://www.php.net/manual/en/function.socket-last-error.php - * @param Socket|null $socket [optional] - * @return int This function returns a socket error code. + * {@inheritdoc} + * @param Socket $socket */ -function socket_last_error (?Socket $socket = null): int {} +function socket_atmark (Socket $socket): bool {} /** - * Clears the error on the socket or the last error code - * @link http://www.php.net/manual/en/function.socket-clear-error.php - * @param Socket|null $socket [optional] - * @return void No value is returned. + * {@inheritdoc} + * @param Socket|null $socket [optional] */ -function socket_clear_error (?Socket $socket = null): void {} +function socket_last_error (?Socket $socket = NULL): int {} /** - * Import a stream - * @link http://www.php.net/manual/en/function.socket-import-stream.php - * @param resource $stream - * @return Socket|false Returns false on failure. + * {@inheritdoc} + * @param Socket|null $socket [optional] */ -function socket_import_stream ($stream): Socket|false {} +function socket_clear_error (?Socket $socket = NULL): void {} /** - * Export a socket into a stream that encapsulates a socket - * @link http://www.php.net/manual/en/function.socket-export-stream.php - * @param Socket $socket - * @return resource|false Return resource or false on failure. + * {@inheritdoc} + * @param mixed $stream + */ +function socket_import_stream ($stream = null): Socket|false {} + +/** + * {@inheritdoc} + * @param Socket $socket */ function socket_export_stream (Socket $socket) {} /** - * Send a message - * @link http://www.php.net/manual/en/function.socket-sendmsg.php - * @param Socket $socket - * @param array $message - * @param int $flags [optional] - * @return int|false Returns the number of bytes sent, or false on failure. + * {@inheritdoc} + * @param Socket $socket + * @param array $message + * @param int $flags [optional] */ -function socket_sendmsg (Socket $socket, array $message, int $flags = null): int|false {} +function socket_sendmsg (Socket $socket, array $message, int $flags = 0): int|false {} /** - * Read a message - * @link http://www.php.net/manual/en/function.socket-recvmsg.php - * @param Socket $socket - * @param array $message - * @param int $flags [optional] - * @return int|false + * {@inheritdoc} + * @param Socket $socket + * @param array $message + * @param int $flags [optional] */ -function socket_recvmsg (Socket $socket, array &$message, int $flags = null): int|false {} +function socket_recvmsg (Socket $socket, array &$message, int $flags = 0): int|false {} /** - * Calculate message buffer size - * @link http://www.php.net/manual/en/function.socket-cmsg-space.php - * @param int $level - * @param int $type - * @param int $num [optional] - * @return int|null + * {@inheritdoc} + * @param int $level + * @param int $type + * @param int $num [optional] */ -function socket_cmsg_space (int $level, int $type, int $num = null): ?int {} +function socket_cmsg_space (int $level, int $type, int $num = 0): ?int {} /** - * Get array with contents of getaddrinfo about the given hostname - * @link http://www.php.net/manual/en/function.socket-addrinfo-lookup.php - * @param string $host Hostname to search. - * @param string|null $service [optional] The service to connect to. If service is a numeric string, it designates the port. - * Otherwise it designates a network service name, which is mapped to a port by the operating system. - * @param array $hints [optional] Hints provide criteria for selecting addresses returned. You may specify the - * hints as defined by getaddrinfo. - * @return array|false Returns an array of AddressInfo instances that can be used with the other socket_addrinfo functions. - * On failure, false is returned. + * {@inheritdoc} + * @param string $host + * @param string|null $service [optional] + * @param array $hints [optional] */ -function socket_addrinfo_lookup (string $host, ?string $service = null, array $hints = '[]'): array|false {} +function socket_addrinfo_lookup (string $host, ?string $service = NULL, array $hints = array ( +)): array|false {} /** - * Create and connect to a socket from a given addrinfo - * @link http://www.php.net/manual/en/function.socket-addrinfo-connect.php - * @param AddressInfo $address AddressInfo instance created from socket_addrinfo_lookup - * @return Socket|false Returns a Socket instance on success or false on failure. + * {@inheritdoc} + * @param AddressInfo $address */ function socket_addrinfo_connect (AddressInfo $address): Socket|false {} /** - * Create and bind to a socket from a given addrinfo - * @link http://www.php.net/manual/en/function.socket-addrinfo-bind.php - * @param AddressInfo $address AddressInfo instance created from socket_addrinfo_lookup. - * @return Socket|false Returns a Socket instance on success or false on failure. + * {@inheritdoc} + * @param AddressInfo $address */ function socket_addrinfo_bind (AddressInfo $address): Socket|false {} /** - * Get information about addrinfo - * @link http://www.php.net/manual/en/function.socket-addrinfo-explain.php - * @param AddressInfo $address AddressInfo instance created from socket_addrinfo_lookup - * @return array Returns an array containing the fields in the addrinfo structure. + * {@inheritdoc} + * @param AddressInfo $address */ function socket_addrinfo_explain (AddressInfo $address): array {} - -/** - * - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('AF_UNIX', 1); - -/** - * - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('AF_INET', 2); - -/** - * Only available if compiled with IPv6 support. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('AF_INET6', 30); - -/** - * - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCK_STREAM', 1); - -/** - * - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCK_DGRAM', 2); - -/** - * - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCK_RAW', 3); - -/** - * - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCK_SEQPACKET', 5); - -/** - * - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCK_RDM', 4); - -/** - * - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('MSG_OOB', 1); - -/** - * - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('MSG_WAITALL', 64); define ('MSG_CTRUNC', 32); define ('MSG_TRUNC', 16); - -/** - * - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('MSG_PEEK', 2); - -/** - * - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('MSG_DONTROUTE', 4); - -/** - * Not available on Windows platforms. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('MSG_EOR', 8); - -/** - * Not available on Windows platforms. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('MSG_EOF', 256); define ('MSG_NOSIGNAL', 524288); define ('MSG_DONTWAIT', 128); - -/** - * - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SO_DEBUG', 1); - -/** - * - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SO_REUSEADDR', 4); - -/** - * This constant is only available on platforms that - * support the SO_REUSEPORT socket option: this - * includes Linux, macOS and *BSD, but does not include Windows. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SO_REUSEPORT', 512); - -/** - * - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SO_KEEPALIVE', 8); - -/** - * - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SO_DONTROUTE', 16); - -/** - * - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SO_LINGER', 128); - -/** - * - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SO_BROADCAST', 32); - -/** - * - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SO_OOBINLINE', 256); - -/** - * - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SO_SNDBUF', 4097); - -/** - * - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SO_RCVBUF', 4098); - -/** - * - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SO_SNDLOWAT', 4099); - -/** - * - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SO_RCVLOWAT', 4100); - -/** - * - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SO_SNDTIMEO', 4101); - -/** - * - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SO_RCVTIMEO', 4102); - -/** - * - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SO_TYPE', 4104); - -/** - * - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SO_ERROR', 4103); - -/** - * Available as of PHP 8.1.0 - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SO_DONTTRUNC', 8192); - -/** - * Available as of PHP 8.1.0 - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SO_WANTMORE', 16384); - -/** - * - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOL_SOCKET', 65535); define ('SOMAXCONN', 128); - -/** - * Used to disable Nagle TCP algorithm. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('TCP_NODELAY', 1); - -/** - * Available as of PHP 8.2.0 - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('TCP_NOTSENT_LOWAT', 513); - -/** - * Available as of PHP 8.2.0 - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('TCP_KEEPALIVE', 16); - -/** - * - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('PHP_NORMAL_READ', 1); - -/** - * - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('PHP_BINARY_READ', 2); define ('MCAST_JOIN_GROUP', 12); define ('MCAST_LEAVE_GROUP', 13); @@ -718,539 +341,83 @@ function socket_addrinfo_explain (AddressInfo $address): array {} define ('IPV6_MULTICAST_HOPS', 10); define ('IPV6_MULTICAST_LOOP', 11); define ('IPV6_V6ONLY', 27); - -/** - * Operation not permitted. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_EPERM', 1); - -/** - * No such file or directory. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_ENOENT', 2); - -/** - * Interrupted system call. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_EINTR', 4); - -/** - * I/O error. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_EIO', 5); - -/** - * No such device or address. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_ENXIO', 6); - -/** - * Arg list too long. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_E2BIG', 7); - -/** - * Bad file descriptor number. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_EBADF', 9); - -/** - * Try again. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_EAGAIN', 35); - -/** - * Out of memory. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_ENOMEM', 12); - -/** - * Permission denied. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_EACCES', 13); - -/** - * Bad address. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_EFAULT', 14); - -/** - * Block device required. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_ENOTBLK', 15); - -/** - * Device or resource busy. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_EBUSY', 16); - -/** - * File exists. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_EEXIST', 17); - -/** - * Cross-device link. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_EXDEV', 18); - -/** - * No such device. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_ENODEV', 19); - -/** - * Not a directory. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_ENOTDIR', 20); - -/** - * Is a directory. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_EISDIR', 21); - -/** - * Invalid argument. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_EINVAL', 22); - -/** - * File table overflow. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_ENFILE', 23); - -/** - * Too many open files. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_EMFILE', 24); - -/** - * Not a typewriter. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_ENOTTY', 25); - -/** - * No space left on device. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_ENOSPC', 28); - -/** - * Illegal seek. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_ESPIPE', 29); - -/** - * Read-only file system. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_EROFS', 30); - -/** - * Too many links. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_EMLINK', 31); - -/** - * Broken pipe. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_EPIPE', 32); - -/** - * File name too long. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_ENAMETOOLONG', 63); - -/** - * No record locks available. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_ENOLCK', 77); - -/** - * Function not implemented. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_ENOSYS', 78); - -/** - * Directory not empty. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_ENOTEMPTY', 66); - -/** - * Too many symbolic links encountered. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_ELOOP', 62); - -/** - * Operation would block. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_EWOULDBLOCK', 35); - -/** - * No message of desired type. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_ENOMSG', 91); - -/** - * Identifier removed. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_EIDRM', 90); - -/** - * Device not a stream. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_ENOSTR', 99); - -/** - * No data available. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_ENODATA', 96); - -/** - * Timer expired. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_ETIME', 101); - -/** - * Out of streams resources. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_ENOSR', 98); - -/** - * Object is remote. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_EREMOTE', 71); - -/** - * Link has been severed. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_ENOLINK', 97); - -/** - * Protocol error. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_EPROTO', 100); - -/** - * Multihop attempted. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_EMULTIHOP', 95); - -/** - * Not a data message. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_EBADMSG', 94); - -/** - * Too many users. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_EUSERS', 68); - -/** - * Socket operation on non-socket. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_ENOTSOCK', 38); - -/** - * Destination address required. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_EDESTADDRREQ', 39); - -/** - * Message too long. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_EMSGSIZE', 40); - -/** - * Protocol wrong type for socket. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_EPROTOTYPE', 41); - -/** - * - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_ENOPROTOOPT', 42); - -/** - * Protocol not supported. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_EPROTONOSUPPORT', 43); - -/** - * Socket type not supported. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_ESOCKTNOSUPPORT', 44); - -/** - * Operation not supported on transport endpoint. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_EOPNOTSUPP', 102); - -/** - * Protocol family not supported. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_EPFNOSUPPORT', 46); - -/** - * Address family not supported by protocol. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_EAFNOSUPPORT', 47); - -/** - * - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_EADDRINUSE', 48); - -/** - * Cannot assign requested address. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_EADDRNOTAVAIL', 49); - -/** - * Network is down. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_ENETDOWN', 50); - -/** - * Network is unreachable. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_ENETUNREACH', 51); - -/** - * Network dropped connection because of reset. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_ENETRESET', 52); - -/** - * Software caused connection abort. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_ECONNABORTED', 53); - -/** - * Connection reset by peer. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_ECONNRESET', 54); - -/** - * No buffer space available. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_ENOBUFS', 55); - -/** - * Transport endpoint is already connected. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_EISCONN', 56); - -/** - * Transport endpoint is not connected. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_ENOTCONN', 57); - -/** - * Cannot send after transport endpoint shutdown. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_ESHUTDOWN', 58); - -/** - * Too many references: cannot splice. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_ETOOMANYREFS', 59); - -/** - * Connection timed out. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_ETIMEDOUT', 60); - -/** - * Connection refused. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_ECONNREFUSED', 61); - -/** - * Host is down. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_EHOSTDOWN', 64); - -/** - * No route to host. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_EHOSTUNREACH', 65); - -/** - * Operation already in progress. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_EALREADY', 37); - -/** - * Operation now in progress. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_EINPROGRESS', 36); - -/** - * Quota exceeded. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOCKET_EDQUOT', 69); define ('IPPROTO_IP', 0); define ('IPPROTO_IPV6', 41); - -/** - * - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOL_TCP', 6); - -/** - * - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SOL_UDP', 17); define ('IPV6_UNICAST_HOPS', 4); define ('AI_PASSIVE', 1); @@ -1267,12 +434,7 @@ function socket_addrinfo_explain (AddressInfo $address): array {} define ('IPV6_HOPLIMIT', 47); define ('IPV6_RECVTCLASS', 35); define ('IPV6_TCLASS', 36); - -/** - * Send or receive a set of open file descriptors from another process. - * @link http://www.php.net/manual/en/sockets.constants.php - * @var int - */ define ('SCM_RIGHTS', 1); +define ('IP_DONTFRAG', 28); -// End of sockets v.8.2.6 +// End of sockets v.8.3.0 diff --git a/plugins/org.eclipse.php.core/Resources/language/php8.3/sodium.php b/plugins/org.eclipse.php.core/Resources/language/php8.3/sodium.php index 38266fc0f5..d9004c3d32 100644 --- a/plugins/org.eclipse.php.core/Resources/language/php8.3/sodium.php +++ b/plugins/org.eclipse.php.core/Resources/language/php8.3/sodium.php @@ -1,22 +1,16 @@ In order to produce the same password hash from the same password, the same values for opslimit and memlimit must be used. These are embedded within the generated hash, so - * everything that's needed to verify the hash is included. This allows - * the sodium_crypto_pwhash_str_verify function to verify the hash without - * needing separate storage for the other parameters. + * {@inheritdoc} + * @param string $password + * @param int $opslimit + * @param int $memlimit */ function sodium_crypto_pwhash_str (string $password, int $opslimit, int $memlimit): string {} /** - * Verifies that a password matches a hash - * @link http://www.php.net/manual/en/function.sodium-crypto-pwhash-str-verify.php - * @param string $hash A hash created by password_hash. - * @param string $password The user's password. - * @return bool Returns true if the password and hash match, or false otherwise. + * {@inheritdoc} + * @param string $hash + * @param string $password */ function sodium_crypto_pwhash_str_verify (string $hash, string $password): bool {} /** - * Determine whether or not to rehash a password - * @link http://www.php.net/manual/en/function.sodium-crypto-pwhash-str-needs-rehash.php - * @param string $password Password hash - * @param int $opslimit Configured opslimit; see sodium_crypto_pwhash_str - * @param int $memlimit Configured memlimit; see sodium_crypto_pwhash_str - * @return bool Returns true if the provided memlimit/opslimit do not match what's stored in the hash. - * Returns false if they match. + * {@inheritdoc} + * @param string $password + * @param int $opslimit + * @param int $memlimit */ function sodium_crypto_pwhash_str_needs_rehash (string $password, int $opslimit, int $memlimit): bool {} /** - * Derives a key from a password, using scrypt - * @link http://www.php.net/manual/en/function.sodium-crypto-pwhash-scryptsalsa208sha256.php - * @param int $length The length of the password hash to generate, in bytes. - * @param string $password The password to generate a hash for. - * @param string $salt A salt to add to the password before hashing. The salt should be unpredictable, ideally generated from a good random number source such as random_bytes, and have a length of at least SODIUM_CRYPTO_PWHASH_SCRYPTSALSA208SHA256_SALTBYTES bytes. - * @param int $opslimit Represents a maximum amount of computations to perform. Raising this number will make the function require more CPU cycles to compute a key. There are some constants available to set the operations limit to appropriate values depending on intended use, in order of strength: SODIUM_CRYPTO_PWHASH_SCRYPTSALSA208SHA256_OPSLIMIT_INTERACTIVE and SODIUM_CRYPTO_PWHASH_SCRYPTSALSA208SHA256_OPSLIMIT_SENSITIVE. - * @param int $memlimit The maximum amount of RAM that the function will use, in bytes. There are constants to help you choose an appropriate value, in order of size: SODIUM_CRYPTO_PWHASH_SCRYPTSALSA208SHA256_MEMLIMIT_INTERACTIVE and SODIUM_CRYPTO_PWHASH_SCRYPTSALSA208SHA256_MEMLIMIT_SENSITIVE. Typically these should be paired with the matching opslimit values. - * @return string A string of bytes of the desired length. + * {@inheritdoc} + * @param int $length + * @param string $password + * @param string $salt + * @param int $opslimit + * @param int $memlimit */ function sodium_crypto_pwhash_scryptsalsa208sha256 (int $length, string $password, string $salt, int $opslimit, int $memlimit): string {} /** - * Get an ASCII encoded hash - * @link http://www.php.net/manual/en/function.sodium-crypto-pwhash-scryptsalsa208sha256-str.php - * @param string $password - * @param int $opslimit - * @param int $memlimit - * @return string + * {@inheritdoc} + * @param string $password + * @param int $opslimit + * @param int $memlimit */ function sodium_crypto_pwhash_scryptsalsa208sha256_str (string $password, int $opslimit, int $memlimit): string {} /** - * Verify that the password is a valid password verification string - * @link http://www.php.net/manual/en/function.sodium-crypto-pwhash-scryptsalsa208sha256-str-verify.php - * @param string $hash - * @param string $password - * @return bool + * {@inheritdoc} + * @param string $hash + * @param string $password */ function sodium_crypto_pwhash_scryptsalsa208sha256_str_verify (string $hash, string $password): bool {} /** - * Compute a shared secret given a user's secret key and another user's public key - * @link http://www.php.net/manual/en/function.sodium-crypto-scalarmult.php - * @param string $n scalar, which is typically a secret key - * @param string $p point (x-coordinate), which is typically a public key - * @return string A 32-byte random string. + * {@inheritdoc} + * @param string $n + * @param string $p */ function sodium_crypto_scalarmult (string $n, string $p): string {} /** - * Computes a shared secret - * @link http://www.php.net/manual/en/function.sodium-crypto-scalarmult-ristretto255.php - * @param string $n A scalar, which is typically a secret key. - * @param string $p A point (x-coordinate), which is typically a public key. - * @return string Returns a 32-byte random string. + * {@inheritdoc} + * @param string $n + * @param string $p */ function sodium_crypto_scalarmult_ristretto255 (string $n, string $p): string {} /** - * Calculates the public key from a secret key - * @link http://www.php.net/manual/en/function.sodium-crypto-scalarmult-ristretto255-base.php - * @param string $n A secret key. - * @return string Returns a 32-byte random string. + * {@inheritdoc} + * @param string $n */ function sodium_crypto_scalarmult_ristretto255_base (string $n): string {} /** - * Authenticated shared-key encryption - * @link http://www.php.net/manual/en/function.sodium-crypto-secretbox.php - * @param string $message The plaintext message to encrypt. - * @param string $nonce A number that must be only used once, per message. 24 bytes long. - * This is a large enough bound to generate randomly (i.e. random_bytes). - * @param string $key Encryption key (256-bit). - * @return string Returns the encrypted string. + * {@inheritdoc} + * @param string $message + * @param string $nonce + * @param string $key */ function sodium_crypto_secretbox (string $message, string $nonce, string $key): string {} /** - * Generate random key for sodium_crypto_secretbox - * @link http://www.php.net/manual/en/function.sodium-crypto-secretbox-keygen.php - * @return string Returns the generated string of cryptographically secure random bytes. + * {@inheritdoc} */ function sodium_crypto_secretbox_keygen (): string {} /** - * Authenticated shared-key decryption - * @link http://www.php.net/manual/en/function.sodium-crypto-secretbox-open.php - * @param string $ciphertext Must be in the format provided by sodium_crypto_secretbox - * (ciphertext and tag, concatenated). - * @param string $nonce A number that must be only used once, per message. 24 bytes long. - * This is a large enough bound to generate randomly (i.e. random_bytes). - * @param string $key Encryption key (256-bit). - * @return string|false The decrypted string on success or false on failure. + * {@inheritdoc} + * @param string $ciphertext + * @param string $nonce + * @param string $key */ function sodium_crypto_secretbox_open (string $ciphertext, string $nonce, string $key): string|false {} /** - * Generate a random secretstream key. - * @link http://www.php.net/manual/en/function.sodium-crypto-secretstream-xchacha20poly1305-keygen.php - * @return string Returns a string of random bytes. + * {@inheritdoc} */ function sodium_crypto_secretstream_xchacha20poly1305_keygen (): string {} /** - * Initialize a secretstream context for encryption - * @link http://www.php.net/manual/en/function.sodium-crypto-secretstream-xchacha20poly1305-init-push.php - * @param string $key Cryptography key. See sodium_crypto_secretstream_xchacha20poly1305_keygen. - * @return array An array with two string values: + * {@inheritdoc} + * @param string $key */ function sodium_crypto_secretstream_xchacha20poly1305_init_push (string $key): array {} /** - * Encrypt a chunk of data so that it can safely be decrypted in a streaming API - * @link http://www.php.net/manual/en/function.sodium-crypto-secretstream-xchacha20poly1305-push.php - * @param string $state See sodium_crypto_secretstream_xchacha20poly1305_init_pull - * and sodium_crypto_secretstream_xchacha20poly1305_init_push - * @param string $message - * @param string $additional_data [optional] - * @param int $tag [optional] Optional. Can be used to assert decryption behavior - * (i.e. re-keying or indicating the final chunk in a stream). - * @return string Returns the encrypted ciphertext. + * {@inheritdoc} + * @param string $state + * @param string $message + * @param string $additional_data [optional] + * @param int $tag [optional] */ -function sodium_crypto_secretstream_xchacha20poly1305_push (string &$state, string $message, string $additional_data = '""', int $tag = SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_MESSAGE): string {} +function sodium_crypto_secretstream_xchacha20poly1305_push (string &$state, string $message, string $additional_data = '', int $tag = 0): string {} /** - * Initialize a secretstream context for decryption - * @link http://www.php.net/manual/en/function.sodium-crypto-secretstream-xchacha20poly1305-init-pull.php - * @param string $header The header of the secretstream. This should be one of the values produced by - * sodium_crypto_secretstream_xchacha20poly1305_init_push. - * @param string $key Encryption key (256-bit). - * @return string Secretstream state. + * {@inheritdoc} + * @param string $header + * @param string $key */ function sodium_crypto_secretstream_xchacha20poly1305_init_pull (string $header, string $key): string {} /** - * Decrypt a chunk of data from an encrypted stream - * @link http://www.php.net/manual/en/function.sodium-crypto-secretstream-xchacha20poly1305-pull.php - * @param string $state See sodium_crypto_secretstream_xchacha20poly1305_init_pull - * and sodium_crypto_secretstream_xchacha20poly1305_init_push - * @param string $ciphertext The ciphertext chunk to decrypt. - * @param string $additional_data [optional] Optional additional data to include in the authentication tag. - * @return array|false An array with two values: - *
- *
- *
- * string; The decrypted chunk - *
- *- * int; An optional tag (if provided during push). Possible values: - *
- * SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_MESSAGE: - * the most common tag, that doesn't add any information about the nature of the message. - * SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_FINAL: - * indicates that the message marks the end of the stream, and erases the secret key used to encrypt the previous sequence. - * SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_PUSH: - * indicates that the message marks the end of a set of messages, but not the end of the stream. - * For example, a huge JSON string sent as multiple chunks can use this tag to indicate to the application that the - * string is complete and that it can be decoded. But the stream itself is not closed, and more data may follow. - * SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_REKEY: - * "forget" the key used to encrypt this message and the previous ones, and derive a new secret key. - *
- * - * - *string; The decrypted chunk
- *int; An optional tag (if provided during push). Possible values: - *
- * SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_MESSAGE: - * the most common tag, that doesn't add any information about the nature of the message. - * SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_FINAL: - * indicates that the message marks the end of the stream, and erases the secret key used to encrypt the previous sequence. - * SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_PUSH: - * indicates that the message marks the end of a set of messages, but not the end of the stream. - * For example, a huge JSON string sent as multiple chunks can use this tag to indicate to the application that the - * string is complete and that it can be decoded. But the stream itself is not closed, and more data may follow. - * SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_REKEY: - * "forget" the key used to encrypt this message and the previous ones, and derive a new secret key. - *
- */ -function sodium_crypto_secretstream_xchacha20poly1305_pull (string &$state, string $ciphertext, string $additional_data = '""'): array|false {} - -/** - * Explicitly rotate the key in the secretstream state - * @link http://www.php.net/manual/en/function.sodium-crypto-secretstream-xchacha20poly1305-rekey.php - * @param string $state Secretstream state. - * @return void No value is returned. + * {@inheritdoc} + * @param string $state + * @param string $ciphertext + * @param string $additional_data [optional] + */ +function sodium_crypto_secretstream_xchacha20poly1305_pull (string &$state, string $ciphertext, string $additional_data = ''): array|false {} + +/** + * {@inheritdoc} + * @param string $state */ function sodium_crypto_secretstream_xchacha20poly1305_rekey (string &$state): void {} /** - * Compute a short hash of a message and key - * @link http://www.php.net/manual/en/function.sodium-crypto-shorthash.php - * @param string $message The message to hash. - * @param string $key The hash key. - * @return string + * {@inheritdoc} + * @param string $message + * @param string $key */ function sodium_crypto_shorthash (string $message, string $key): string {} /** - * Get random bytes for key - * @link http://www.php.net/manual/en/function.sodium-crypto-shorthash-keygen.php - * @return string + * {@inheritdoc} */ function sodium_crypto_shorthash_keygen (): string {} /** - * Sign a message - * @link http://www.php.net/manual/en/function.sodium-crypto-sign.php - * @param string $message Message to sign. - * @param string $secret_key Secret key. See sodium_crypto_sign_secretkey - * @return string Signed message (not encrypted). + * {@inheritdoc} + * @param string $message + * @param string $secret_key */ function sodium_crypto_sign (string $message, string $secret_key): string {} /** - * Sign the message - * @link http://www.php.net/manual/en/function.sodium-crypto-sign-detached.php - * @param string $message Message to sign. - * @param string $secret_key Secret key. See sodium_crypto_sign_secretkey - * @return string Cryptographic signature. + * {@inheritdoc} + * @param string $message + * @param string $secret_key */ function sodium_crypto_sign_detached (string $message, string $secret_key): string {} /** - * Convert an Ed25519 public key to a Curve25519 public key - * @link http://www.php.net/manual/en/function.sodium-crypto-sign-ed25519-pk-to-curve25519.php - * @param string $public_key Public key suitable for the crypto_sign functions. - * @return string Public key suitable for the crypto_box functions. + * {@inheritdoc} + * @param string $public_key */ function sodium_crypto_sign_ed25519_pk_to_curve25519 (string $public_key): string {} /** - * Convert an Ed25519 secret key to a Curve25519 secret key - * @link http://www.php.net/manual/en/function.sodium-crypto-sign-ed25519-sk-to-curve25519.php - * @param string $secret_key Secret key suitable for the crypto_sign functions. - * @return string Secret key suitable for the crypto_box functions. + * {@inheritdoc} + * @param string $secret_key */ function sodium_crypto_sign_ed25519_sk_to_curve25519 (string $secret_key): string {} /** - * Randomly generate a secret key and a corresponding public key - * @link http://www.php.net/manual/en/function.sodium-crypto-sign-keypair.php - * @return string Ed25519 keypair. + * {@inheritdoc} */ function sodium_crypto_sign_keypair (): string {} /** - * Join a secret key and public key together - * @link http://www.php.net/manual/en/function.sodium-crypto-sign-keypair-from-secretkey-and-publickey.php - * @param string $secret_key Ed25519 secret key - * @param string $public_key Ed25519 public key - * @return string Keypair + * {@inheritdoc} + * @param string $secret_key + * @param string $public_key */ function sodium_crypto_sign_keypair_from_secretkey_and_publickey (string $secret_key, string $public_key): string {} /** - * Check that the signed message has a valid signature - * @link http://www.php.net/manual/en/function.sodium-crypto-sign-open.php - * @param string $signed_message A message signed with sodium_crypto_sign - * @param string $public_key An Ed25519 public key - * @return string|false Returns the original signed message on success, or false on failure. + * {@inheritdoc} + * @param string $signed_message + * @param string $public_key */ function sodium_crypto_sign_open (string $signed_message, string $public_key): string|false {} /** - * Extract the Ed25519 public key from a keypair - * @link http://www.php.net/manual/en/function.sodium-crypto-sign-publickey.php - * @param string $key_pair Ed25519 keypair (see: sodium_crypto_sign_keypair) - * @return string Ed25519 public key + * {@inheritdoc} + * @param string $key_pair */ function sodium_crypto_sign_publickey (string $key_pair): string {} /** - * Extract the Ed25519 secret key from a keypair - * @link http://www.php.net/manual/en/function.sodium-crypto-sign-secretkey.php - * @param string $key_pair Ed25519 keypair (see: sodium_crypto_sign_keypair) - * @return string Ed25519 secret key + * {@inheritdoc} + * @param string $key_pair */ function sodium_crypto_sign_secretkey (string $key_pair): string {} /** - * Extract the Ed25519 public key from the secret key - * @link http://www.php.net/manual/en/function.sodium-crypto-sign-publickey-from-secretkey.php - * @param string $secret_key Ed25519 secret key - * @return string Ed25519 public key + * {@inheritdoc} + * @param string $secret_key */ function sodium_crypto_sign_publickey_from_secretkey (string $secret_key): string {} /** - * Deterministically derive the key pair from a single key - * @link http://www.php.net/manual/en/function.sodium-crypto-sign-seed-keypair.php - * @param string $seed Some cryptographic input. Must be 32 bytes. - * @return string Keypair (secret key and public key) + * {@inheritdoc} + * @param string $seed */ function sodium_crypto_sign_seed_keypair (string $seed): string {} /** - * Verify signature for the message - * @link http://www.php.net/manual/en/function.sodium-crypto-sign-verify-detached.php - * @param string $signature The cryptographic signature obtained from sodium_crypto_sign_detached - * @param string $message The message being verified - * @param string $public_key Ed25519 public key - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $signature + * @param string $message + * @param string $public_key */ function sodium_crypto_sign_verify_detached (string $signature, string $message, string $public_key): bool {} /** - * Generate a deterministic sequence of bytes from a seed - * @link http://www.php.net/manual/en/function.sodium-crypto-stream.php - * @param int $length The number of bytes to return. - * @param string $nonce A number that must be only used once, per message. 24 bytes long. - * This is a large enough bound to generate randomly (i.e. random_bytes). - * @param string $key Encryption key (256-bit). - * @return string String of pseudorandom bytes. + * {@inheritdoc} + * @param int $length + * @param string $nonce + * @param string $key */ function sodium_crypto_stream (int $length, string $nonce, string $key): string {} /** - * Generate a random sodium_crypto_stream key. - * @link http://www.php.net/manual/en/function.sodium-crypto-stream-keygen.php - * @return string Encryption key (256-bit). + * {@inheritdoc} */ function sodium_crypto_stream_keygen (): string {} /** - * Encrypt a message without authentication - * @link http://www.php.net/manual/en/function.sodium-crypto-stream-xor.php - * @param string $message The message to encrypt - * @param string $nonce A number that must be only used once, per message. 24 bytes long. - * This is a large enough bound to generate randomly (i.e. random_bytes). - * @param string $key Encryption key (256-bit). - * @return string Encrypted message. + * {@inheritdoc} + * @param string $message + * @param string $nonce + * @param string $key */ function sodium_crypto_stream_xor (string $message, string $nonce, string $key): string {} /** - * Expands the key and nonce into a keystream of pseudorandom bytes - * @link http://www.php.net/manual/en/function.sodium-crypto-stream-xchacha20.php - * @param int $length Number of bytes desired. - * @param string $nonce 24-byte nonce. - * @param string $key Key, possibly generated from sodium_crypto_stream_xchacha20_keygen. - * @return string Returns a pseudorandom stream that can be used with sodium_crypto_stream_xchacha20_xor. + * {@inheritdoc} + * @param int $length + * @param string $nonce + * @param string $key */ function sodium_crypto_stream_xchacha20 (int $length, string $nonce, string $key): string {} /** - * Returns a secure random key - * @link http://www.php.net/manual/en/function.sodium-crypto-stream-xchacha20-keygen.php - * @return string Returns a 32-byte secure random key for use with sodium_crypto_stream_xchacha20. + * {@inheritdoc} */ function sodium_crypto_stream_xchacha20_keygen (): string {} /** - * Encrypts a message using a nonce and a secret key (no authentication) - * @link http://www.php.net/manual/en/function.sodium-crypto-stream-xchacha20-xor.php - * @param string $message The message to encrypt. - * @param string $nonce 24-byte nonce. - * @param string $key Key, possibly generated from sodium_crypto_stream_xchacha20_keygen. - * @return string Encrypted message. + * {@inheritdoc} + * @param string $message + * @param string $nonce + * @param string $key */ function sodium_crypto_stream_xchacha20_xor (string $message, string $nonce, string $key): string {} /** - * Encrypts a message using a nonce and a secret key (no authentication) - * @link http://www.php.net/manual/en/function.sodium-crypto-stream-xchacha20-xor-ic.php - * @param string $message The message to encrypt. - * @param string $nonce 24-byte nonce. - * @param int $counter The initial value of the block counter. - * @param string $key Key, possibly generated from sodium_crypto_stream_xchacha20_keygen. - * @return string Encrypted message, or false on failure. + * {@inheritdoc} + * @param string $message + * @param string $nonce + * @param int $counter + * @param string $key */ function sodium_crypto_stream_xchacha20_xor_ic (string $message, string $nonce, int $counter, string $key): string {} /** - * Add large numbers - * @link http://www.php.net/manual/en/function.sodium-add.php - * @param string $string1 String representing an arbitrary-length unsigned integer in little-endian byte order. - * This parameter is passed by reference and will hold the sum of the two parameters. - * @param string $string2 String representing an arbitrary-length unsigned integer in little-endian byte order. - * @return void No value is returned. + * {@inheritdoc} + * @param string $string1 + * @param string $string2 */ function sodium_add (string &$string1, string $string2): void {} /** - * Compare large numbers - * @link http://www.php.net/manual/en/function.sodium-compare.php - * @param string $string1 Left operand - * @param string $string2 Right operand - * @return int Returns -1 if string1 is less than string2. - *Returns 1 if string1 is greater than string2.
- *Returns 0 if both strings are equal.
+ * {@inheritdoc} + * @param string $string1 + * @param string $string2 */ function sodium_compare (string $string1, string $string2): int {} /** - * Increment large number - * @link http://www.php.net/manual/en/function.sodium-increment.php - * @param string $string String to increment. - * @return void No value is returned. + * {@inheritdoc} + * @param string $string */ function sodium_increment (string &$string): void {} /** - * Test for equality in constant-time - * @link http://www.php.net/manual/en/function.sodium-memcmp.php - * @param string $string1 String to compare - * @param string $string2 Other string to compare - * @return int Returns 0 if both strings are equal; -1 otherwise. + * {@inheritdoc} + * @param string $string1 + * @param string $string2 */ function sodium_memcmp (string $string1, string $string2): int {} /** - * Overwrite a string with NUL characters - * @link http://www.php.net/manual/en/function.sodium-memzero.php - * @param string $string String. - * @return void No value is returned. + * {@inheritdoc} + * @param string $string */ function sodium_memzero (string &$string): void {} /** - * Add padding data - * @link http://www.php.net/manual/en/function.sodium-pad.php - * @param string $string Unpadded string. - * @param int $block_size The string will be padded until it is an even multiple of the block size. - * @return string Padded string. + * {@inheritdoc} + * @param string $string + * @param int $block_size */ function sodium_pad (string $string, int $block_size): string {} /** - * Remove padding data - * @link http://www.php.net/manual/en/function.sodium-unpad.php - * @param string $string Padded string. - * @param int $block_size The block size for padding. - * @return string Unpadded string. + * {@inheritdoc} + * @param string $string + * @param int $block_size */ function sodium_unpad (string $string, int $block_size): string {} /** - * Encode to hexadecimal - * @link http://www.php.net/manual/en/function.sodium-bin2hex.php - * @param string $string Raw binary string. - * @return string Hex encoded string. + * {@inheritdoc} + * @param string $string */ function sodium_bin2hex (string $string): string {} /** - * Decodes a hexadecimally encoded binary string - * @link http://www.php.net/manual/en/function.sodium-hex2bin.php - * @param string $string Hexadecimal representation of data. - * @param string $ignore [optional] Optional string argument for characters to ignore. - * @return string Returns the binary representation of the given string data. + * {@inheritdoc} + * @param string $string + * @param string $ignore [optional] */ -function sodium_hex2bin (string $string, string $ignore = '""'): string {} +function sodium_hex2bin (string $string, string $ignore = ''): string {} /** - * Encodes a raw binary string with base64. - * @link http://www.php.net/manual/en/function.sodium-bin2base64.php - * @param string $string Raw binary string. - * @param int $id SODIUM_BASE64_VARIANT_ORIGINAL for standard (A-Za-z0-9/\+) - * Base64 encoding. - * SODIUM_BASE64_VARIANT_ORIGINAL_NO_PADDING for standard (A-Za-z0-9/\+) - * Base64 encoding, without = padding characters. - * SODIUM_BASE64_VARIANT_URLSAFE for URL-safe (A-Za-z0-9\-_) Base64 encoding. - * SODIUM_BASE64_VARIANT_URLSAFE_NO_PADDING for URL-safe (A-Za-z0-9\-_) - * Base64 encoding, without = padding characters. - * @return string Base64-encoded string. + * {@inheritdoc} + * @param string $string + * @param int $id */ function sodium_bin2base64 (string $string, int $id): string {} /** - * Decodes a base64-encoded string into raw binary. - * @link http://www.php.net/manual/en/function.sodium-base642bin.php - * @param string $string string; Encoded string. - * @param int $id SODIUM_BASE64_VARIANT_ORIGINAL for standard (A-Za-z0-9/\+) - * Base64 encoding. - * SODIUM_BASE64_VARIANT_ORIGINAL_NO_PADDING for standard (A-Za-z0-9/\+) - * Base64 encoding, without = padding characters. - * SODIUM_BASE64_VARIANT_URLSAFE for URL-safe (A-Za-z0-9\-_) Base64 encoding. - * SODIUM_BASE64_VARIANT_URLSAFE_NO_PADDING for URL-safe (A-Za-z0-9\-_) - * Base64 encoding, without = padding characters. - * @param string $ignore [optional] Characters to ignore when decoding (e.g. whitespace characters). - * @return string Decoded string. + * {@inheritdoc} + * @param string $string + * @param int $id + * @param string $ignore [optional] */ -function sodium_base642bin (string $string, int $id, string $ignore = '""'): string {} +function sodium_base642bin (string $string, int $id, string $ignore = ''): string {} /** - * Alias of sodium_crypto_box_publickey_from_secretkey - * @link http://www.php.net/manual/en/function.sodium-crypto-scalarmult-base.php - * @param string $secret_key X25519 secret key - * @return string X25519 public key. + * {@inheritdoc} + * @param string $secret_key */ function sodium_crypto_scalarmult_base (string $secret_key): string {} - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var string - */ -define ('SODIUM_LIBRARY_VERSION', "1.0.18"); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ -define ('SODIUM_LIBRARY_MAJOR_VERSION', 10); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ -define ('SODIUM_LIBRARY_MINOR_VERSION', 3); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ +define ('SODIUM_LIBRARY_VERSION', "1.0.19"); +define ('SODIUM_LIBRARY_MAJOR_VERSION', 26); +define ('SODIUM_LIBRARY_MINOR_VERSION', 1); define ('SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_KEYBYTES', 32); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_NSECBYTES', 0); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_NPUBBYTES', 8); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_ABYTES', 16); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_IETF_KEYBYTES', 32); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_IETF_NSECBYTES', 0); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_IETF_NPUBBYTES', 12); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_IETF_ABYTES', 16); define ('SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_KEYBYTES', 32); define ('SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NSECBYTES', 0); define ('SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTES', 24); define ('SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_ABYTES', 16); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_AUTH_BYTES', 32); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_AUTH_KEYBYTES', 32); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_BOX_SEALBYTES', 48); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_BOX_SECRETKEYBYTES', 32); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_BOX_PUBLICKEYBYTES', 32); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_BOX_KEYPAIRBYTES', 64); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_BOX_MACBYTES', 16); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_BOX_NONCEBYTES', 24); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_BOX_SEEDBYTES', 32); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_KDF_BYTES_MIN', 16); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_KDF_BYTES_MAX', 64); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_KDF_CONTEXTBYTES', 8); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_KDF_KEYBYTES', 32); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_KX_SEEDBYTES', 32); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_KX_SESSIONKEYBYTES', 32); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_KX_PUBLICKEYBYTES', 32); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_KX_SECRETKEYBYTES', 32); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_KX_KEYPAIRBYTES', 64); define ('SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_ABYTES', 17); define ('SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_HEADERBYTES', 24); @@ -1280,324 +788,54 @@ function sodium_crypto_scalarmult_base (string $secret_key): string {} define ('SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_PUSH', 1); define ('SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_REKEY', 2); define ('SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_FINAL', 3); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_GENERICHASH_BYTES', 32); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_GENERICHASH_BYTES_MIN', 16); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_GENERICHASH_BYTES_MAX', 64); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_GENERICHASH_KEYBYTES', 32); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_GENERICHASH_KEYBYTES_MIN', 16); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_GENERICHASH_KEYBYTES_MAX', 64); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_PWHASH_ALG_ARGON2I13', 1); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_PWHASH_ALG_ARGON2ID13', 2); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_PWHASH_ALG_DEFAULT', 2); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_PWHASH_SALTBYTES', 16); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var string - */ define ('SODIUM_CRYPTO_PWHASH_STRPREFIX', "$argon2id$"); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_PWHASH_OPSLIMIT_INTERACTIVE', 2); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_PWHASH_MEMLIMIT_INTERACTIVE', 67108864); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_PWHASH_OPSLIMIT_MODERATE', 3); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_PWHASH_MEMLIMIT_MODERATE', 268435456); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_PWHASH_OPSLIMIT_SENSITIVE', 4); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_PWHASH_MEMLIMIT_SENSITIVE', 1073741824); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_PWHASH_SCRYPTSALSA208SHA256_SALTBYTES', 32); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var string - */ define ('SODIUM_CRYPTO_PWHASH_SCRYPTSALSA208SHA256_STRPREFIX', "$7$"); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_PWHASH_SCRYPTSALSA208SHA256_OPSLIMIT_INTERACTIVE', 524288); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_PWHASH_SCRYPTSALSA208SHA256_MEMLIMIT_INTERACTIVE', 16777216); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_PWHASH_SCRYPTSALSA208SHA256_OPSLIMIT_SENSITIVE', 33554432); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_PWHASH_SCRYPTSALSA208SHA256_MEMLIMIT_SENSITIVE', 1073741824); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_SCALARMULT_BYTES', 32); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_SCALARMULT_SCALARBYTES', 32); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_SHORTHASH_BYTES', 8); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_SHORTHASH_KEYBYTES', 16); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_SECRETBOX_KEYBYTES', 32); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_SECRETBOX_MACBYTES', 16); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_SECRETBOX_NONCEBYTES', 24); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_SIGN_BYTES', 64); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_SIGN_SEEDBYTES', 32); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_SIGN_PUBLICKEYBYTES', 32); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_SIGN_SECRETKEYBYTES', 64); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_SIGN_KEYPAIRBYTES', 96); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_STREAM_NONCEBYTES', 24); - -/** - * - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_STREAM_KEYBYTES', 32); - -/** - * Available as of PHP 8.1.0. - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_STREAM_XCHACHA20_NONCEBYTES', 24); - -/** - * Available as of PHP 8.1.0. - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_STREAM_XCHACHA20_KEYBYTES', 32); define ('SODIUM_BASE64_VARIANT_ORIGINAL', 1); define ('SODIUM_BASE64_VARIANT_ORIGINAL_NO_PADDING', 3); define ('SODIUM_BASE64_VARIANT_URLSAFE', 5); define ('SODIUM_BASE64_VARIANT_URLSAFE_NO_PADDING', 7); - -/** - * Available as of PHP 8.1.0. - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_SCALARMULT_RISTRETTO255_BYTES', 32); - -/** - * Available as of PHP 8.1.0. - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_SCALARMULT_RISTRETTO255_SCALARBYTES', 32); - -/** - * Available as of PHP 8.1.0. - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_CORE_RISTRETTO255_BYTES', 32); - -/** - * Available as of PHP 8.1.0. - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_CORE_RISTRETTO255_HASHBYTES', 64); - -/** - * Available as of PHP 8.1.0. - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_CORE_RISTRETTO255_SCALARBYTES', 32); - -/** - * Available as of PHP 8.1.0. - * @link http://www.php.net/manual/en/sodium.constants.php - * @var int - */ define ('SODIUM_CRYPTO_CORE_RISTRETTO255_NONREDUCEDSCALARBYTES', 64); -// End of sodium v.8.2.6 +// End of sodium v.8.3.0 diff --git a/plugins/org.eclipse.php.core/Resources/language/php8.3/sqlite3.php b/plugins/org.eclipse.php.core/Resources/language/php8.3/sqlite3.php index b62f485882..92fadf4b2c 100644 --- a/plugins/org.eclipse.php.core/Resources/language/php8.3/sqlite3.php +++ b/plugins/org.eclipse.php.core/Resources/language/php8.3/sqlite3.php @@ -1,11 +1,64 @@ If the query is valid but no results are returned, then null will be - * returned if entireRow is false, otherwise an - * empty array is returned. - *Invalid or failing queries will return false.
+ * {@inheritdoc} + * @param string $query + * @param bool $entireRow [optional] */ - public function querySingle (string $query, bool $entireRow = false): mixed {} + public function querySingle (string $query, bool $entireRow = false) {} /** - * Registers a PHP function for use as an SQL scalar function - * @link http://www.php.net/manual/en/sqlite3.createfunction.php - * @param string $name - * @param callable $callback - * @param int $argCount [optional] - * @param int $flags [optional] - * @return bool Returns true upon successful creation of the function, false on failure. + * {@inheritdoc} + * @param string $name + * @param callable $callback + * @param int $argCount [optional] + * @param int $flags [optional] */ - public function createFunction (string $name, callable $callback, int $argCount = -1, int $flags = null): bool {} + public function createFunction (string $name, callable $callback, int $argCount = -1, int $flags = 0) {} /** - * Registers a PHP function for use as an SQL aggregate function - * @link http://www.php.net/manual/en/sqlite3.createaggregate.php - * @param string $name - * @param callable $stepCallback - * @param callable $finalCallback - * @param int $argCount [optional] - * @return bool Returns true upon successful creation of the aggregate, or false on failure. + * {@inheritdoc} + * @param string $name + * @param callable $stepCallback + * @param callable $finalCallback + * @param int $argCount [optional] */ - public function createAggregate (string $name, callable $stepCallback, callable $finalCallback, int $argCount = -1): bool {} + public function createAggregate (string $name, callable $stepCallback, callable $finalCallback, int $argCount = -1) {} /** - * Registers a PHP function for use as an SQL collating function - * @link http://www.php.net/manual/en/sqlite3.createcollation.php - * @param string $name Name of the SQL collating function to be created or redefined - * @param callable $callback The name of a PHP function or user-defined function to apply as a - * callback, defining the behavior of the collation. It should accept two - * values and return as strcmp does, i.e. it should - * return -1, 1, or 0 if the first string sorts before, sorts after, or is - * equal to the second. - *This function need to be defined as: - * intcollation - * mixedvalue1 - * mixedvalue2
- * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $name + * @param callable $callback */ - public function createCollation (string $name, callable $callback): bool {} + public function createCollation (string $name, callable $callback) {} /** - * Opens a stream resource to read a BLOB - * @link http://www.php.net/manual/en/sqlite3.openblob.php - * @param string $table - * @param string $column - * @param int $rowid - * @param string $database [optional] - * @param int $flags [optional] - * @return resource|false Returns a stream resource, or false on failure. + * {@inheritdoc} + * @param string $table + * @param string $column + * @param int $rowid + * @param string $database [optional] + * @param int $flags [optional] */ - public function openBlob (string $table, string $column, int $rowid, string $database = '"main"', int $flags = SQLITE3_OPEN_READONLY) {} + public function openBlob (string $table, string $column, int $rowid, string $database = 'main', int $flags = 1) {} /** - * Enable throwing exceptions - * @link http://www.php.net/manual/en/sqlite3.enableexceptions.php - * @param bool $enable [optional] When true, the SQLite3 instance, and - * SQLite3Stmt and SQLite3Result - * instances derived from it, will throw exceptions on error. - *When false, the SQLite3 instance, and - * SQLite3Stmt and SQLite3Result - * instances derived from it, will raise warnings on error.
- *For either mode, the error code and message, if any, will be available via - * SQLite3::lastErrorCode and - * SQLite3::lastErrorMsg respectively.
- * @return bool Returns the old value; true if exceptions were enabled, false otherwise. + * {@inheritdoc} + * @param bool $enable [optional] */ - public function enableExceptions (bool $enable = false): bool {} + public function enableExceptions (bool $enable = false) {} /** * {@inheritdoc} @@ -271,270 +249,128 @@ public function enableExceptions (bool $enable = false): bool {} public function enableExtendedResultCodes (bool $enable = true) {} /** - * Configures a callback to be used as an authorizer to limit what a statement can do - * @link http://www.php.net/manual/en/sqlite3.setauthorizer.php - * @param callable|null $callback The callable to be called. - *If null is passed instead, this will disable the current authorizer callback.
- * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param callable|null $callback */ - public function setAuthorizer (?callable $callback): bool {} + public function setAuthorizer (?callable $callback = null) {} } -/** - * A class that handles prepared statements for the SQLite 3 extension. - * @link http://www.php.net/manual/en/class.sqlite3stmt.php - */ class SQLite3Stmt { /** - * Constructs an SQLite3Stmt object - * @link http://www.php.net/manual/en/sqlite3stmt.construct.php - * @param SQLite3 $sqlite3 - * @param string $query - * @return SQLite3 + * {@inheritdoc} + * @param SQLite3 $sqlite3 + * @param string $query */ - private function __construct (SQLite3 $sqlite3, string $query): SQLite3 {} + private function __construct (SQLite3 $sqlite3, string $query) {} /** - * Binds a parameter to a statement variable - * @link http://www.php.net/manual/en/sqlite3stmt.bindparam.php - * @param string|int $param - * @param mixed $var - * @param int $type [optional] - * @return bool Returns true if the parameter is bound to the statement variable, false - * on failure. + * {@inheritdoc} + * @param string|int $param + * @param mixed $var + * @param int $type [optional] */ - public function bindParam (string|int $param, mixed &$var, int $type = SQLITE3_TEXT): bool {} + public function bindParam (string|int $param, mixed &$var = null, int $type = 3) {} /** - * Binds the value of a parameter to a statement variable - * @link http://www.php.net/manual/en/sqlite3stmt.bindvalue.php - * @param string|int $param - * @param mixed $value - * @param int $type [optional] - * @return bool Returns true if the value is bound to the statement variable, or false on failure. + * {@inheritdoc} + * @param string|int $param + * @param mixed $value + * @param int $type [optional] */ - public function bindValue (string|int $param, mixed $value, int $type = SQLITE3_TEXT): bool {} + public function bindValue (string|int $param, mixed $value = null, int $type = 3) {} /** - * Clears all current bound parameters - * @link http://www.php.net/manual/en/sqlite3stmt.clear.php - * @return bool Returns true on successful clearing of bound parameters, false on - * failure. + * {@inheritdoc} */ - public function clear (): bool {} + public function clear () {} /** - * Closes the prepared statement - * @link http://www.php.net/manual/en/sqlite3stmt.close.php - * @return bool Returns true + * {@inheritdoc} */ - public function close (): bool {} + public function close () {} /** - * Executes a prepared statement and returns a result set object - * @link http://www.php.net/manual/en/sqlite3stmt.execute.php - * @return SQLite3Result|false Returns an SQLite3Result object on successful execution of the prepared - * statement, false on failure. + * {@inheritdoc} */ - public function execute (): SQLite3Result|false {} + public function execute () {} /** - * Get the SQL of the statement - * @link http://www.php.net/manual/en/sqlite3stmt.getsql.php - * @param bool $expand [optional] Whether to retrieve the expanded SQL. Passing true is only supported as - * of libsqlite 3.14. - * @return string|false Returns the SQL of the prepared statement, or false on failure. + * {@inheritdoc} + * @param bool $expand [optional] */ - public function getSQL (bool $expand = false): string|false {} + public function getSQL (bool $expand = false) {} /** - * Returns the number of parameters within the prepared statement - * @link http://www.php.net/manual/en/sqlite3stmt.paramcount.php - * @return int Returns the number of parameters within the prepared statement. + * {@inheritdoc} */ - public function paramCount (): int {} + public function paramCount () {} /** - * Returns whether a statement is definitely read only - * @link http://www.php.net/manual/en/sqlite3stmt.readonly.php - * @return bool Returns true if a statement is definitely read only, false otherwise. + * {@inheritdoc} */ - public function readOnly (): bool {} + public function readOnly () {} /** - * Resets the prepared statement - * @link http://www.php.net/manual/en/sqlite3stmt.reset.php - * @return bool Returns true if the statement is successfully reset, or false on failure. + * {@inheritdoc} */ - public function reset (): bool {} + public function reset () {} } -/** - * A class that handles result sets for the SQLite 3 extension. - * @link http://www.php.net/manual/en/class.sqlite3result.php - */ class SQLite3Result { /** - * Constructs an SQLite3Result - * @link http://www.php.net/manual/en/sqlite3result.construct.php + * {@inheritdoc} */ private function __construct () {} /** - * Returns the number of columns in the result set - * @link http://www.php.net/manual/en/sqlite3result.numcolumns.php - * @return int Returns the number of columns in the result set. + * {@inheritdoc} */ - public function numColumns (): int {} + public function numColumns () {} /** - * Returns the name of the nth column - * @link http://www.php.net/manual/en/sqlite3result.columnname.php - * @param int $column - * @return string|false Returns the string name of the column identified by - * column, or false if the column does not exist. + * {@inheritdoc} + * @param int $column */ - public function columnName (int $column): string|false {} + public function columnName (int $column) {} /** - * Returns the type of the nth column - * @link http://www.php.net/manual/en/sqlite3result.columntype.php - * @param int $column - * @return int|false Returns the data type index of the column identified by - * column (one of - * SQLITE3_INTEGER, SQLITE3_FLOAT, - * SQLITE3_TEXT, SQLITE3_BLOB, or - * SQLITE3_NULL), or false if the column does not exist. + * {@inheritdoc} + * @param int $column */ - public function columnType (int $column): int|false {} + public function columnType (int $column) {} /** - * Fetches a result row as an associative or numerically indexed array or both - * @link http://www.php.net/manual/en/sqlite3result.fetcharray.php - * @param int $mode [optional] - * @return array|false Returns a result row as an associatively or numerically indexed array or - * both. Alternately will return false if there are no more rows. - *The types of the values of the returned array are mapped from SQLite3 types - * as follows: integers are mapped to int if they fit into the - * range PHP_INT_MIN..PHP_INT_MAX, and - * to string otherwise. Floats are mapped to float, - * NULL values are mapped to null, and strings - * and blobs are mapped to string.
+ * {@inheritdoc} + * @param int $mode [optional] */ - public function fetchArray (int $mode = SQLITE3_BOTH): array|false {} + public function fetchArray (int $mode = 3) {} /** - * Resets the result set back to the first row - * @link http://www.php.net/manual/en/sqlite3result.reset.php - * @return bool Returns true if the result set is successfully reset - * back to the first row, false on failure. + * {@inheritdoc} */ - public function reset (): bool {} + public function reset () {} /** - * Closes the result set - * @link http://www.php.net/manual/en/sqlite3result.finalize.php - * @return bool Returns true. + * {@inheritdoc} */ - public function finalize (): bool {} + public function finalize () {} } - -/** - * Specifies that the Sqlite3Result::fetchArray - * method shall return an array indexed by column name as returned in the - * corresponding result set. - * @link http://www.php.net/manual/en/sqlite3.constants.php - * @var int - */ define ('SQLITE3_ASSOC', 1); - -/** - * Specifies that the Sqlite3Result::fetchArray - * method shall return an array indexed by column number as returned in the - * corresponding result set, starting at column 0. - * @link http://www.php.net/manual/en/sqlite3.constants.php - * @var int - */ define ('SQLITE3_NUM', 2); - -/** - * Specifies that the Sqlite3Result::fetchArray - * method shall return an array indexed by both column name and number as - * returned in the corresponding result set, starting at column 0. - * @link http://www.php.net/manual/en/sqlite3.constants.php - * @var int - */ define ('SQLITE3_BOTH', 3); - -/** - * Represents the SQLite3 INTEGER storage class. - * @link http://www.php.net/manual/en/sqlite3.constants.php - * @var int - */ define ('SQLITE3_INTEGER', 1); - -/** - * Represents the SQLite3 REAL (FLOAT) storage class. - * @link http://www.php.net/manual/en/sqlite3.constants.php - * @var int - */ define ('SQLITE3_FLOAT', 2); - -/** - * Represents the SQLite3 TEXT storage class. - * @link http://www.php.net/manual/en/sqlite3.constants.php - * @var int - */ define ('SQLITE3_TEXT', 3); - -/** - * Represents the SQLite3 BLOB storage class. - * @link http://www.php.net/manual/en/sqlite3.constants.php - * @var int - */ define ('SQLITE3_BLOB', 4); - -/** - * Represents the SQLite3 NULL storage class. - * @link http://www.php.net/manual/en/sqlite3.constants.php - * @var int - */ define ('SQLITE3_NULL', 5); - -/** - * Specifies that the SQLite3 database be opened for reading only. - * @link http://www.php.net/manual/en/sqlite3.constants.php - * @var int - */ define ('SQLITE3_OPEN_READONLY', 1); - -/** - * Specifies that the SQLite3 database be opened for reading and writing. - * @link http://www.php.net/manual/en/sqlite3.constants.php - * @var int - */ define ('SQLITE3_OPEN_READWRITE', 2); - -/** - * Specifies that the SQLite3 database be created if it does not already - * exist. - * @link http://www.php.net/manual/en/sqlite3.constants.php - * @var int - */ define ('SQLITE3_OPEN_CREATE', 4); - -/** - * Specifies that a function created with SQLite3::createFunction - * is deterministic, i.e. it always returns the same result given the same inputs within - * a single SQL statement. (Available as of PHP 7.1.4.) - * @link http://www.php.net/manual/en/sqlite3.constants.php - * @var int - */ define ('SQLITE3_DETERMINISTIC', 2048); -// End of sqlite3 v.8.2.6 +// End of sqlite3 v.8.3.0 diff --git a/plugins/org.eclipse.php.core/Resources/language/php8.3/sqlsrv.php b/plugins/org.eclipse.php.core/Resources/language/php8.3/sqlsrv.php index b06c4808f2..d9320e3cdc 100644 --- a/plugins/org.eclipse.php.core/Resources/language/php8.3/sqlsrv.php +++ b/plugins/org.eclipse.php.core/Resources/language/php8.3/sqlsrv.php @@ -1,228 +1,145 @@ - * Array returned by sqlsrv_errors - *Key | - *Description | - *
SQLSTATE | - *For errors that originate from the ODBC driver, the SQLSTATE returned - * by ODBC. For errors that originate from the Microsoft Drivers for PHP for - * SQL Server, a SQLSTATE of IMSSP. For warnings that originate from the - * Microsoft Drivers for PHP for SQL Server, a SQLSTATE of 01SSP. - * | - *
code | - *For errors that originate from SQL Server, the native SQL Server - * error code. For errors that originate from the ODBC driver, the error - * code returned by ODBC. For errors that originate from the Microsoft Drivers - * for PHP for SQL Server, the Microsoft Drivers for PHP for SQL Server error code. - * | - *
message | - *A description of the error. | - *
Key | - *Description | - *
DriverDllName | - *SQLNCLI10.DLL | - *
DriverODBCVer | - *ODBC version (xx.yy) | - *
DriverVer | - *SQL Server Native Client DLL version (10.5.xxx) | - *
ExtensionVer | - *php_sqlsrv.dll version (2.0.xxx.x) | - *
CurrentDatabase | - *The connected-to database. | - *
SQLServerVersion | - *The SQL Server version. | - *
SQLServerName | - *The name of the server. | - *
Key | - *Description | - *
Name | - *The name of the field. | - *
Type | - *The numeric value for the SQL type. | - *
Size | - *The number of characters for fields of character type, the number of - * bytes for fields of binary type, or null for other types. | - *
Precision | - *The precision for types of variable precision, null for other types. | - *
Scale | - *The scale for types of variable scale, null for other types. | - *
Nullable | - *An enumeration indicating whether the column is nullable, not nullable, - * or if it is not known. | - *
- * Array - * ( - * [level] => 2 - * [type] => 0 - * [status] => 0 - * [name] => URL-Rewriter - * [del] => 1 - * ) - *- *
- * Simple ob_get_status results - * KeyValue - * levelOutput nesting level - * type0 (internal handler) or 1 (user supplied handler) - * statusOne of PHP_OUTPUT_HANDLER_START (0), PHP_OUTPUT_HANDLER_CONT (1) or PHP_OUTPUT_HANDLER_END (2) - * nameName of active output handler or ' default output handler' if none is set - * delErase-flag as set by ob_start - *
- *If called with full_status = true an array - * with one element for each active output buffer level is returned. - * The output level is used as key of the top level array and each array - * element itself is another array holding status information - * on one active output level. - *
- * Array - * ( - * [0] => Array - * ( - * [chunk_size] => 0 - * [size] => 40960 - * [block_size] => 10240 - * [type] => 1 - * [status] => 0 - * [name] => default output handler - * [del] => 1 - * ) - * [1] => Array - * ( - * [chunk_size] => 0 - * [size] => 40960 - * [block_size] => 10240 - * [type] => 0 - * [buffer_size] => 0 - * [status] => 0 - * [name] => URL-Rewriter - * [del] => 1 - * ) - * ) - *- *
The full output contains these additional elements: - *
- * Full ob_get_status results - * KeyValue - * chunk_sizeChunk size as set by ob_start - * size... - * blocksize... - *
+ * {@inheritdoc} + * @param bool $full_status [optional] */ function ob_get_status (bool $full_status = false): array {} /** - * Turn implicit flush on/off - * @link http://www.php.net/manual/en/function.ob-implicit-flush.php - * @param bool $enable [optional] - * @return void No value is returned. + * {@inheritdoc} + * @param bool $enable [optional] */ function ob_implicit_flush (bool $enable = true): void {} /** - * Reset URL rewriter values - * @link http://www.php.net/manual/en/function.output-reset-rewrite-vars.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ function output_reset_rewrite_vars (): bool {} /** - * Add URL rewriter values - * @link http://www.php.net/manual/en/function.output-add-rewrite-var.php - * @param string $name - * @param string $value - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $name + * @param string $value */ function output_add_rewrite_var (string $name, string $value): bool {} /** - * Register a URL wrapper implemented as a PHP class - * @link http://www.php.net/manual/en/function.stream-wrapper-register.php - * @param string $protocol - * @param string $class - * @param int $flags [optional] - * @return bool Returns true on success or false on failure. - *stream_wrapper_register will return false if the - * protocol already has a handler.
+ * {@inheritdoc} + * @param string $protocol + * @param string $class + * @param int $flags [optional] */ -function stream_wrapper_register (string $protocol, string $class, int $flags = null): bool {} +function stream_wrapper_register (string $protocol, string $class, int $flags = 0): bool {} /** * {@inheritdoc} @@ -440,1484 +226,950 @@ function stream_wrapper_register (string $protocol, string $class, int $flags = function stream_register_wrapper (string $protocol, string $class, int $flags = 0): bool {} /** - * Unregister a URL wrapper - * @link http://www.php.net/manual/en/function.stream-wrapper-unregister.php - * @param string $protocol - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $protocol */ function stream_wrapper_unregister (string $protocol): bool {} /** - * Restores a previously unregistered built-in wrapper - * @link http://www.php.net/manual/en/function.stream-wrapper-restore.php - * @param string $protocol - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $protocol */ function stream_wrapper_restore (string $protocol): bool {} /** - * Push one or more elements onto the end of array - * @link http://www.php.net/manual/en/function.array-push.php - * @param array $array - * @param mixed $values - * @return int Returns the new number of elements in the array. + * {@inheritdoc} + * @param array $array + * @param mixed $values [optional] */ function array_push (array &$array, mixed ...$values): int {} /** - * Sort an array by key in descending order - * @link http://www.php.net/manual/en/function.krsort.php - * @param array $array - * @param int $flags [optional] - * @return true Always returns true. + * {@inheritdoc} + * @param array $array + * @param int $flags [optional] */ -function krsort (array &$array, int $flags = SORT_REGULAR): true {} +function krsort (array &$array, int $flags = 0): true {} /** - * Sort an array by key in ascending order - * @link http://www.php.net/manual/en/function.ksort.php - * @param array $array - * @param int $flags [optional] - * @return true Always returns true. + * {@inheritdoc} + * @param array $array + * @param int $flags [optional] */ -function ksort (array &$array, int $flags = SORT_REGULAR): true {} +function ksort (array &$array, int $flags = 0): true {} /** - * Counts all elements in an array or in a Countable object - * @link http://www.php.net/manual/en/function.count.php - * @param Countable|array $value - * @param int $mode [optional] - * @return int Returns the number of elements in value. - * Prior to PHP 8.0.0, if the parameter was neither an array nor an object that - * implements the Countable interface, - * 1 would be returned, - * unless value was null, in which case - * 0 would be returned. + * {@inheritdoc} + * @param Countable|array $value + * @param int $mode [optional] */ -function count (Countable|array $value, int $mode = COUNT_NORMAL): int {} +function count (Countable|array $value, int $mode = 0): int {} /** - * Alias of count - * @link http://www.php.net/manual/en/function.sizeof.php - * @param Countable|array $value - * @param int $mode [optional] - * @return int Returns the number of elements in value. - * Prior to PHP 8.0.0, if the parameter was neither an array nor an object that - * implements the Countable interface, - * 1 would be returned, - * unless value was null, in which case - * 0 would be returned. + * {@inheritdoc} + * @param Countable|array $value + * @param int $mode [optional] */ -function sizeof (Countable|array $value, int $mode = COUNT_NORMAL): int {} +function sizeof (Countable|array $value, int $mode = 0): int {} /** - * Sort an array using a "natural order" algorithm - * @link http://www.php.net/manual/en/function.natsort.php - * @param array $array - * @return true Always returns true. + * {@inheritdoc} + * @param array $array */ function natsort (array &$array): true {} /** - * Sort an array using a case insensitive "natural order" algorithm - * @link http://www.php.net/manual/en/function.natcasesort.php - * @param array $array - * @return true Always returns true. + * {@inheritdoc} + * @param array $array */ function natcasesort (array &$array): true {} /** - * Sort an array in ascending order and maintain index association - * @link http://www.php.net/manual/en/function.asort.php - * @param array $array - * @param int $flags [optional] - * @return true Always returns true. + * {@inheritdoc} + * @param array $array + * @param int $flags [optional] */ -function asort (array &$array, int $flags = SORT_REGULAR): true {} +function asort (array &$array, int $flags = 0): true {} /** - * Sort an array in descending order and maintain index association - * @link http://www.php.net/manual/en/function.arsort.php - * @param array $array - * @param int $flags [optional] - * @return true Always returns true. + * {@inheritdoc} + * @param array $array + * @param int $flags [optional] */ -function arsort (array &$array, int $flags = SORT_REGULAR): true {} +function arsort (array &$array, int $flags = 0): true {} /** - * Sort an array in ascending order - * @link http://www.php.net/manual/en/function.sort.php - * @param array $array - * @param int $flags [optional] - * @return true Always returns true. + * {@inheritdoc} + * @param array $array + * @param int $flags [optional] */ -function sort (array &$array, int $flags = SORT_REGULAR): true {} +function sort (array &$array, int $flags = 0): true {} /** - * Sort an array in descending order - * @link http://www.php.net/manual/en/function.rsort.php - * @param array $array - * @param int $flags [optional] - * @return true Always returns true. + * {@inheritdoc} + * @param array $array + * @param int $flags [optional] */ -function rsort (array &$array, int $flags = SORT_REGULAR): true {} +function rsort (array &$array, int $flags = 0): true {} /** - * Sort an array by values using a user-defined comparison function - * @link http://www.php.net/manual/en/function.usort.php - * @param array $array - * @param callable $callback - * @return true Always returns true. + * {@inheritdoc} + * @param array $array + * @param callable $callback */ function usort (array &$array, callable $callback): true {} /** - * Sort an array with a user-defined comparison function and maintain index association - * @link http://www.php.net/manual/en/function.uasort.php - * @param array $array - * @param callable $callback - * @return true Always returns true. + * {@inheritdoc} + * @param array $array + * @param callable $callback */ function uasort (array &$array, callable $callback): true {} /** - * Sort an array by keys using a user-defined comparison function - * @link http://www.php.net/manual/en/function.uksort.php - * @param array $array - * @param callable $callback - * @return true Always returns true. + * {@inheritdoc} + * @param array $array + * @param callable $callback */ function uksort (array &$array, callable $callback): true {} /** - * Set the internal pointer of an array to its last element - * @link http://www.php.net/manual/en/function.end.php - * @param array|object $array - * @return mixed Returns the value of the last element or false for empty array. + * {@inheritdoc} + * @param object|array $array */ -function end (array|object &$array): mixed {} +function end (object|array &$array): mixed {} /** - * Rewind the internal array pointer - * @link http://www.php.net/manual/en/function.prev.php - * @param array|object $array - * @return mixed Returns the array value in the previous place that's pointed to by - * the internal array pointer, or false if there are no more - * elements. + * {@inheritdoc} + * @param object|array $array */ -function prev (array|object &$array): mixed {} +function prev (object|array &$array): mixed {} /** - * Advance the internal pointer of an array - * @link http://www.php.net/manual/en/function.next.php - * @param array|object $array - * @return mixed Returns the array value in the next place that's pointed to by the - * internal array pointer, or false if there are no more elements. + * {@inheritdoc} + * @param object|array $array */ -function next (array|object &$array): mixed {} +function next (object|array &$array): mixed {} /** - * Set the internal pointer of an array to its first element - * @link http://www.php.net/manual/en/function.reset.php - * @param array|object $array - * @return mixed Returns the value of the first array element, or false if the array is - * empty. + * {@inheritdoc} + * @param object|array $array */ -function reset (array|object &$array): mixed {} +function reset (object|array &$array): mixed {} /** - * Return the current element in an array - * @link http://www.php.net/manual/en/function.current.php - * @param array|object $array - * @return mixed The current function simply returns the - * value of the array element that's currently being pointed to by the - * internal pointer. It does not move the pointer in any way. If the - * internal pointer points beyond the end of the elements list or the array is - * empty, current returns false. + * {@inheritdoc} + * @param object|array $array */ -function current (array|object $array): mixed {} +function current (object|array $array): mixed {} /** - * Alias of current - * @link http://www.php.net/manual/en/function.pos.php - * @param array|object $array - * @return mixed The current function simply returns the - * value of the array element that's currently being pointed to by the - * internal pointer. It does not move the pointer in any way. If the - * internal pointer points beyond the end of the elements list or the array is - * empty, current returns false. + * {@inheritdoc} + * @param object|array $array */ -function pos (array|object $array): mixed {} +function pos (object|array $array): mixed {} /** - * Fetch a key from an array - * @link http://www.php.net/manual/en/function.key.php - * @param array|object $array - * @return int|string|null The key function simply returns the - * key of the array element that's currently being pointed to by the - * internal pointer. It does not move the pointer in any way. If the - * internal pointer points beyond the end of the elements list or the array is - * empty, key returns null. + * {@inheritdoc} + * @param object|array $array */ -function key (array|object $array): int|string|null {} +function key (object|array $array): string|int|null {} /** - * Find lowest value - * @link http://www.php.net/manual/en/function.min.php - * @param mixed $value - * @param mixed $values - * @return mixed min returns the parameter value considered "lowest" according to standard - * comparisons. If multiple values of different types evaluate as equal (e.g. 0 - * and 'abc') the first provided to the function will be returned. + * {@inheritdoc} + * @param mixed $value + * @param mixed $values [optional] */ -function min (mixed $value, mixed ...$values): mixed {} +function min (mixed $value = null, mixed ...$values): mixed {} /** - * Find highest value - * @link http://www.php.net/manual/en/function.max.php - * @param mixed $value - * @param mixed $values - * @return mixed max returns the parameter value considered "highest" according to standard - * comparisons. If multiple values of different types evaluate as equal (e.g. 0 - * and 'abc') the first provided to the function will be returned. + * {@inheritdoc} + * @param mixed $value + * @param mixed $values [optional] */ -function max (mixed $value, mixed ...$values): mixed {} +function max (mixed $value = null, mixed ...$values): mixed {} /** - * Apply a user supplied function to every member of an array - * @link http://www.php.net/manual/en/function.array-walk.php - * @param array|object $array - * @param callable $callback - * @param mixed $arg [optional] - * @return bool Returns true. + * {@inheritdoc} + * @param object|array $array + * @param callable $callback + * @param mixed $arg [optional] */ -function array_walk (array|object &$array, callable $callback, mixed $arg = null): bool {} +function array_walk (object|array &$array, callable $callback, mixed $arg = NULL): true {} /** - * Apply a user function recursively to every member of an array - * @link http://www.php.net/manual/en/function.array-walk-recursive.php - * @param array|object $array - * @param callable $callback - * @param mixed $arg [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param object|array $array + * @param callable $callback + * @param mixed $arg [optional] */ -function array_walk_recursive (array|object &$array, callable $callback, mixed $arg = null): bool {} +function array_walk_recursive (object|array &$array, callable $callback, mixed $arg = NULL): true {} /** - * Checks if a value exists in an array - * @link http://www.php.net/manual/en/function.in-array.php - * @param mixed $needle - * @param array $haystack - * @param bool $strict [optional] - * @return bool Returns true if needle is found in the array, - * false otherwise. + * {@inheritdoc} + * @param mixed $needle + * @param array $haystack + * @param bool $strict [optional] */ -function in_array (mixed $needle, array $haystack, bool $strict = false): bool {} +function in_array (mixed $needle = null, array $haystack, bool $strict = false): bool {} /** - * Searches the array for a given value and returns the first corresponding key if successful - * @link http://www.php.net/manual/en/function.array-search.php - * @param mixed $needle - * @param array $haystack - * @param bool $strict [optional] - * @return int|string|false Returns the key for needle if it is found in the - * array, false otherwise. - *If needle is found in haystack - * more than once, the first matching key is returned. To return the keys for - * all matching values, use array_keys with the optional - * search_value parameter instead.
+ * {@inheritdoc} + * @param mixed $needle + * @param array $haystack + * @param bool $strict [optional] */ -function array_search (mixed $needle, array $haystack, bool $strict = false): int|string|false {} +function array_search (mixed $needle = null, array $haystack, bool $strict = false): string|int|false {} /** - * Import variables into the current symbol table from an array - * @link http://www.php.net/manual/en/function.extract.php - * @param array $array - * @param int $flags [optional] - * @param string $prefix [optional] - * @return int Returns the number of variables successfully imported into the symbol - * table. + * {@inheritdoc} + * @param array $array + * @param int $flags [optional] + * @param string $prefix [optional] */ -function extract (array &$array, int $flags = EXTR_OVERWRITE, string $prefix = '""'): int {} +function extract (array &$array, int $flags = 0, string $prefix = ''): int {} /** - * Create array containing variables and their values - * @link http://www.php.net/manual/en/function.compact.php - * @param array|string $var_name - * @param array|string $var_names - * @return array Returns the output array with all the variables added to it. + * {@inheritdoc} + * @param mixed $var_name + * @param mixed $var_names [optional] */ -function compact (array|string $var_name, array|string ...$var_names): array {} +function compact ($var_name = null, ...$var_names): array {} /** - * Fill an array with values - * @link http://www.php.net/manual/en/function.array-fill.php - * @param int $start_index - * @param int $count - * @param mixed $value - * @return array Returns the filled array + * {@inheritdoc} + * @param int $start_index + * @param int $count + * @param mixed $value */ -function array_fill (int $start_index, int $count, mixed $value): array {} +function array_fill (int $start_index, int $count, mixed $value = null): array {} /** - * Fill an array with values, specifying keys - * @link http://www.php.net/manual/en/function.array-fill-keys.php - * @param array $keys - * @param mixed $value - * @return array Returns the filled array + * {@inheritdoc} + * @param array $keys + * @param mixed $value */ -function array_fill_keys (array $keys, mixed $value): array {} +function array_fill_keys (array $keys, mixed $value = null): array {} /** - * Create an array containing a range of elements - * @link http://www.php.net/manual/en/function.range.php - * @param string|int|float $start - * @param string|int|float $end - * @param int|float $step [optional] - * @return array Returns an array of elements from start to - * end, inclusive. + * {@inheritdoc} + * @param string|int|float $start + * @param string|int|float $end + * @param int|float $step [optional] */ function range (string|int|float $start, string|int|float $end, int|float $step = 1): array {} /** - * Shuffle an array - * @link http://www.php.net/manual/en/function.shuffle.php - * @param array $array - * @return true Always returns true. + * {@inheritdoc} + * @param array $array */ function shuffle (array &$array): true {} /** - * Pop the element off the end of array - * @link http://www.php.net/manual/en/function.array-pop.php - * @param array $array - * @return mixed Returns the value of the last element of array. - * If array is empty, - * null will be returned. + * {@inheritdoc} + * @param array $array */ function array_pop (array &$array): mixed {} /** - * Shift an element off the beginning of array - * @link http://www.php.net/manual/en/function.array-shift.php - * @param array $array - * @return mixed Returns the shifted value, or null if array is - * empty or is not an array. + * {@inheritdoc} + * @param array $array */ function array_shift (array &$array): mixed {} /** - * Prepend one or more elements to the beginning of an array - * @link http://www.php.net/manual/en/function.array-unshift.php - * @param array $array - * @param mixed $values - * @return int Returns the new number of elements in the array. + * {@inheritdoc} + * @param array $array + * @param mixed $values [optional] */ function array_unshift (array &$array, mixed ...$values): int {} /** - * Remove a portion of the array and replace it with something else - * @link http://www.php.net/manual/en/function.array-splice.php - * @param array $array - * @param int $offset - * @param int|null $length [optional] - * @param mixed $replacement [optional] - * @return array Returns an array consisting of the extracted elements. + * {@inheritdoc} + * @param array $array + * @param int $offset + * @param int|null $length [optional] + * @param mixed $replacement [optional] */ -function array_splice (array &$array, int $offset, ?int $length = null, mixed $replacement = '[]'): array {} +function array_splice (array &$array, int $offset, ?int $length = NULL, mixed $replacement = array ( +)): array {} /** - * Extract a slice of the array - * @link http://www.php.net/manual/en/function.array-slice.php - * @param array $array - * @param int $offset - * @param int|null $length [optional] - * @param bool $preserve_keys [optional] - * @return array Returns the slice. If the offset is larger than the size of the array, - * an empty array is returned. + * {@inheritdoc} + * @param array $array + * @param int $offset + * @param int|null $length [optional] + * @param bool $preserve_keys [optional] */ -function array_slice (array $array, int $offset, ?int $length = null, bool $preserve_keys = false): array {} +function array_slice (array $array, int $offset, ?int $length = NULL, bool $preserve_keys = false): array {} /** - * Merge one or more arrays - * @link http://www.php.net/manual/en/function.array-merge.php - * @param array $arrays - * @return array Returns the resulting array. - * If called without any arguments, returns an empty array. + * {@inheritdoc} + * @param array $arrays [optional] */ function array_merge (array ...$arrays): array {} /** - * Merge one or more arrays recursively - * @link http://www.php.net/manual/en/function.array-merge-recursive.php - * @param array $arrays - * @return array An array of values resulted from merging the arguments together. - * If called without any arguments, returns an empty array. + * {@inheritdoc} + * @param array $arrays [optional] */ function array_merge_recursive (array ...$arrays): array {} /** - * Replaces elements from passed arrays into the first array - * @link http://www.php.net/manual/en/function.array-replace.php - * @param array $array - * @param array $replacements - * @return array Returns an array. + * {@inheritdoc} + * @param array $array + * @param array $replacements [optional] */ function array_replace (array $array, array ...$replacements): array {} /** - * Replaces elements from passed arrays into the first array recursively - * @link http://www.php.net/manual/en/function.array-replace-recursive.php - * @param array $array - * @param array $replacements - * @return array Returns an array. + * {@inheritdoc} + * @param array $array + * @param array $replacements [optional] */ function array_replace_recursive (array $array, array ...$replacements): array {} /** - * Return all the keys or a subset of the keys of an array - * @link http://www.php.net/manual/en/function.array-keys.php - * @param array $array - * @return array Returns an array of all the keys in array. + * {@inheritdoc} + * @param array $array + * @param mixed $filter_value [optional] + * @param bool $strict [optional] */ -function array_keys (array $array): array {} +function array_keys (array $array, mixed $filter_value = NULL, bool $strict = false): array {} /** - * Gets the first key of an array - * @link http://www.php.net/manual/en/function.array-key-first.php - * @param array $array An array. - * @return int|string|null Returns the first key of array if the array is not empty; - * null otherwise. + * {@inheritdoc} + * @param array $array */ -function array_key_first (array $array): int|string|null {} +function array_key_first (array $array): string|int|null {} /** - * Gets the last key of an array - * @link http://www.php.net/manual/en/function.array-key-last.php - * @param array $array An array. - * @return int|string|null Returns the last key of array if the array is not empty; - * null otherwise. + * {@inheritdoc} + * @param array $array */ -function array_key_last (array $array): int|string|null {} +function array_key_last (array $array): string|int|null {} /** - * Return all the values of an array - * @link http://www.php.net/manual/en/function.array-values.php - * @param array $array - * @return array Returns an indexed array of values. + * {@inheritdoc} + * @param array $array */ function array_values (array $array): array {} /** - * Counts all the values of an array - * @link http://www.php.net/manual/en/function.array-count-values.php - * @param array $array - * @return array Returns an associative array of values from array as - * keys and their count as value. + * {@inheritdoc} + * @param array $array */ function array_count_values (array $array): array {} /** - * Return the values from a single column in the input array - * @link http://www.php.net/manual/en/function.array-column.php - * @param array $array - * @param int|string|null $column_key - * @param int|string|null $index_key [optional] - * @return array Returns an array of values representing a single column from the input array. + * {@inheritdoc} + * @param array $array + * @param string|int|null $column_key + * @param string|int|null $index_key [optional] */ -function array_column (array $array, int|string|null $column_key, int|string|null $index_key = null): array {} +function array_column (array $array, string|int|null $column_key = null, string|int|null $index_key = NULL): array {} /** - * Return an array with elements in reverse order - * @link http://www.php.net/manual/en/function.array-reverse.php - * @param array $array - * @param bool $preserve_keys [optional] - * @return array Returns the reversed array. + * {@inheritdoc} + * @param array $array + * @param bool $preserve_keys [optional] */ function array_reverse (array $array, bool $preserve_keys = false): array {} /** - * Pad array to the specified length with a value - * @link http://www.php.net/manual/en/function.array-pad.php - * @param array $array - * @param int $length - * @param mixed $value - * @return array Returns a copy of the array padded to size specified - * by length with value - * value. If length is - * positive then the array is padded on the right, if it's negative then - * on the left. If the absolute value of length is less - * than or equal to the length of the array then no - * padding takes place. + * {@inheritdoc} + * @param array $array + * @param int $length + * @param mixed $value */ -function array_pad (array $array, int $length, mixed $value): array {} +function array_pad (array $array, int $length, mixed $value = null): array {} /** - * Exchanges all keys with their associated values in an array - * @link http://www.php.net/manual/en/function.array-flip.php - * @param array $array - * @return array Returns the flipped array. + * {@inheritdoc} + * @param array $array */ function array_flip (array $array): array {} /** - * Changes the case of all keys in an array - * @link http://www.php.net/manual/en/function.array-change-key-case.php - * @param array $array - * @param int $case [optional] - * @return array Returns an array with its keys lower or uppercased, or null if - * array is not an array. + * {@inheritdoc} + * @param array $array + * @param int $case [optional] */ -function array_change_key_case (array $array, int $case = CASE_LOWER): array {} +function array_change_key_case (array $array, int $case = 0): array {} /** - * Removes duplicate values from an array - * @link http://www.php.net/manual/en/function.array-unique.php - * @param array $array - * @param int $flags [optional] - * @return array Returns the filtered array. + * {@inheritdoc} + * @param array $array + * @param int $flags [optional] */ -function array_unique (array $array, int $flags = SORT_STRING): array {} +function array_unique (array $array, int $flags = 2): array {} /** - * Computes the intersection of arrays using keys for comparison - * @link http://www.php.net/manual/en/function.array-intersect-key.php - * @param array $array - * @param array $arrays - * @return array Returns an associative array containing all the entries of - * array which have keys that are present in all - * arguments. + * {@inheritdoc} + * @param array $array + * @param array $arrays [optional] */ function array_intersect_key (array $array, array ...$arrays): array {} /** - * Computes the intersection of arrays using a callback function on the keys for comparison - * @link http://www.php.net/manual/en/function.array-intersect-ukey.php - * @param array $array - * @param array $arrays - * @param callable $key_compare_func - * @return array Returns the values of array whose keys exist - * in all the arguments. + * {@inheritdoc} + * @param array $array + * @param mixed $rest [optional] */ -function array_intersect_ukey (array $array, array $arrays, callable $key_compare_func): array {} +function array_intersect_ukey (array $array, ...$rest): array {} /** - * Computes the intersection of arrays - * @link http://www.php.net/manual/en/function.array-intersect.php - * @param array $array - * @param array $arrays - * @return array Returns an array containing all of the values in - * array whose values exist in all of the parameters. + * {@inheritdoc} + * @param array $array + * @param array $arrays [optional] */ function array_intersect (array $array, array ...$arrays): array {} /** - * Computes the intersection of arrays, compares data by a callback function - * @link http://www.php.net/manual/en/function.array-uintersect.php - * @param array $array - * @param array $arrays - * @param callable $value_compare_func - * @return array Returns an array containing all the values of array - * that are present in all the arguments. + * {@inheritdoc} + * @param array $array + * @param mixed $rest [optional] */ -function array_uintersect (array $array, array $arrays, callable $value_compare_func): array {} +function array_uintersect (array $array, ...$rest): array {} /** - * Computes the intersection of arrays with additional index check - * @link http://www.php.net/manual/en/function.array-intersect-assoc.php - * @param array $array - * @param array $arrays - * @return array Returns an associative array containing all the values in - * array that are present in all of the arguments. + * {@inheritdoc} + * @param array $array + * @param array $arrays [optional] */ function array_intersect_assoc (array $array, array ...$arrays): array {} /** - * Computes the intersection of arrays with additional index check, compares data by a callback function - * @link http://www.php.net/manual/en/function.array-uintersect-assoc.php - * @param array $array - * @param array $arrays - * @param callable $value_compare_func - * @return array Returns an array containing all the values of - * array that are present in all the arguments. + * {@inheritdoc} + * @param array $array + * @param mixed $rest [optional] */ -function array_uintersect_assoc (array $array, array $arrays, callable $value_compare_func): array {} +function array_uintersect_assoc (array $array, ...$rest): array {} /** - * Computes the intersection of arrays with additional index check, compares indexes by a callback function - * @link http://www.php.net/manual/en/function.array-intersect-uassoc.php - * @param array $array - * @param array $arrays - * @param callable $key_compare_func - * @return array Returns the values of array whose values exist - * in all of the arguments. + * {@inheritdoc} + * @param array $array + * @param mixed $rest [optional] */ -function array_intersect_uassoc (array $array, array $arrays, callable $key_compare_func): array {} +function array_intersect_uassoc (array $array, ...$rest): array {} /** - * Computes the intersection of arrays with additional index check, compares data and indexes by separate callback functions - * @link http://www.php.net/manual/en/function.array-uintersect-uassoc.php - * @param array $array1 - * @param array $arrays - * @param callable $value_compare_func - * @param callable $key_compare_func - * @return array Returns an array containing all the values of - * array1 that are present in all the arguments. + * {@inheritdoc} + * @param array $array + * @param mixed $rest [optional] */ -function array_uintersect_uassoc (array $array1, array $arrays, callable $value_compare_func, callable $key_compare_func): array {} +function array_uintersect_uassoc (array $array, ...$rest): array {} /** - * Computes the difference of arrays using keys for comparison - * @link http://www.php.net/manual/en/function.array-diff-key.php - * @param array $array - * @param array $arrays - * @return array Returns an array containing all the entries from - * array whose keys are absent from all of the - * other arrays. + * {@inheritdoc} + * @param array $array + * @param array $arrays [optional] */ function array_diff_key (array $array, array ...$arrays): array {} /** - * Computes the difference of arrays using a callback function on the keys for comparison - * @link http://www.php.net/manual/en/function.array-diff-ukey.php - * @param array $array - * @param array $arrays - * @param callable $key_compare_func - * @return array Returns an array containing all the entries from - * array that are not present in any of the other arrays. + * {@inheritdoc} + * @param array $array + * @param mixed $rest [optional] */ -function array_diff_ukey (array $array, array $arrays, callable $key_compare_func): array {} +function array_diff_ukey (array $array, ...$rest): array {} /** - * Computes the difference of arrays - * @link http://www.php.net/manual/en/function.array-diff.php - * @param array $array - * @param array $arrays - * @return array Returns an array containing all the entries from - * array that are not present in any of the other arrays. - * Keys in the array array are preserved. + * {@inheritdoc} + * @param array $array + * @param array $arrays [optional] */ function array_diff (array $array, array ...$arrays): array {} /** - * Computes the difference of arrays by using a callback function for data comparison - * @link http://www.php.net/manual/en/function.array-udiff.php - * @param array $array - * @param array $arrays - * @param callable $value_compare_func - * @return array Returns an array containing all the values of array - * that are not present in any of the other arguments. + * {@inheritdoc} + * @param array $array + * @param mixed $rest [optional] */ -function array_udiff (array $array, array $arrays, callable $value_compare_func): array {} +function array_udiff (array $array, ...$rest): array {} /** - * Computes the difference of arrays with additional index check - * @link http://www.php.net/manual/en/function.array-diff-assoc.php - * @param array $array - * @param array $arrays - * @return array Returns an array containing all the values from - * array that are not present in any of the other arrays. + * {@inheritdoc} + * @param array $array + * @param array $arrays [optional] */ function array_diff_assoc (array $array, array ...$arrays): array {} /** - * Computes the difference of arrays with additional index check which is performed by a user supplied callback function - * @link http://www.php.net/manual/en/function.array-diff-uassoc.php - * @param array $array - * @param array $arrays - * @param callable $key_compare_func - * @return array Returns an array containing all the entries from - * array that are not present in any of the other arrays. - */ -function array_diff_uassoc (array $array, array $arrays, callable $key_compare_func): array {} - -/** - * Computes the difference of arrays with additional index check, compares data by a callback function - * @link http://www.php.net/manual/en/function.array-udiff-assoc.php - * @param array $array - * @param array $arrays - * @param callable $value_compare_func - * @return array array_udiff_assoc returns an array - * containing all the values from array - * that are not present in any of the other arguments. - * Note that the keys are used in the comparison unlike - * array_diff and array_udiff. - * The comparison of arrays' data is performed by using an user-supplied - * callback. In this aspect the behaviour is opposite to the behaviour of - * array_diff_assoc which uses internal function for - * comparison. - */ -function array_udiff_assoc (array $array, array $arrays, callable $value_compare_func): array {} - -/** - * Computes the difference of arrays with additional index check, compares data and indexes by a callback function - * @link http://www.php.net/manual/en/function.array-udiff-uassoc.php - * @param array $array - * @param array $arrays - * @param callable $value_compare_func - * @param callable $key_compare_func - * @return array Returns an array containing all the values from - * array that are not present in any of the other - * arguments. - */ -function array_udiff_uassoc (array $array, array $arrays, callable $value_compare_func, callable $key_compare_func): array {} - -/** - * Sort multiple or multi-dimensional arrays - * @link http://www.php.net/manual/en/function.array-multisort.php - * @param array $array1 - * @param mixed $array1_sort_order [optional] - * @param mixed $array1_sort_flags [optional] - * @param mixed $rest - * @return bool Returns true on success or false on failure. - */ -function array_multisort (array &$array1, mixed $array1_sort_order = SORT_ASC, mixed $array1_sort_flags = SORT_REGULAR, mixed ...$rest): bool {} - -/** - * Pick one or more random keys out of an array - * @link http://www.php.net/manual/en/function.array-rand.php - * @param array $array - * @param int $num [optional] - * @return int|string|array When picking only one entry, array_rand returns - * the key for a random entry. Otherwise, an array of keys for the random - * entries is returned. This is done so that random keys can be picked - * from the array as well as random values. If multiple keys are returned, - * they will be returned in the order they were present in the original array. - * Trying to pick more elements - * than there are in the array will result in an - * E_WARNING level error, and NULL will be returned. - */ -function array_rand (array $array, int $num = 1): int|string|array {} - -/** - * Calculate the sum of values in an array - * @link http://www.php.net/manual/en/function.array-sum.php - * @param array $array - * @return int|float Returns the sum of values as an integer or float; 0 if the - * array is empty. + * {@inheritdoc} + * @param array $array + * @param mixed $rest [optional] + */ +function array_diff_uassoc (array $array, ...$rest): array {} + +/** + * {@inheritdoc} + * @param array $array + * @param mixed $rest [optional] + */ +function array_udiff_assoc (array $array, ...$rest): array {} + +/** + * {@inheritdoc} + * @param array $array + * @param mixed $rest [optional] + */ +function array_udiff_uassoc (array $array, ...$rest): array {} + +/** + * {@inheritdoc} + * @param mixed $array + * @param mixed $rest [optional] + */ +function array_multisort (&$array = null, &...$rest): bool {} + +/** + * {@inheritdoc} + * @param array $array + * @param int $num [optional] + */ +function array_rand (array $array, int $num = 1): array|string|int {} + +/** + * {@inheritdoc} + * @param array $array */ function array_sum (array $array): int|float {} /** - * Calculate the product of values in an array - * @link http://www.php.net/manual/en/function.array-product.php - * @param array $array - * @return int|float Returns the product as an integer or float. + * {@inheritdoc} + * @param array $array */ function array_product (array $array): int|float {} /** - * Iteratively reduce the array to a single value using a callback function - * @link http://www.php.net/manual/en/function.array-reduce.php - * @param array $array - * @param callable $callback - * @param mixed $initial [optional] - * @return mixed Returns the resulting value. - *If the array is empty and initial is not passed, - * array_reduce returns null.
+ * {@inheritdoc} + * @param array $array + * @param callable $callback + * @param mixed $initial [optional] */ -function array_reduce (array $array, callable $callback, mixed $initial = null): mixed {} +function array_reduce (array $array, callable $callback, mixed $initial = NULL): mixed {} /** - * Filters elements of an array using a callback function - * @link http://www.php.net/manual/en/function.array-filter.php - * @param array $array - * @param callable|null $callback [optional] - * @param int $mode [optional] - * @return array Returns the filtered array. + * {@inheritdoc} + * @param array $array + * @param callable|null $callback [optional] + * @param int $mode [optional] */ -function array_filter (array $array, ?callable $callback = null, int $mode = null): array {} +function array_filter (array $array, ?callable $callback = NULL, int $mode = 0): array {} /** - * Applies the callback to the elements of the given arrays - * @link http://www.php.net/manual/en/function.array-map.php - * @param callable|null $callback - * @param array $array - * @param array $arrays - * @return array Returns an array containing the results of applying the callback - * function to the corresponding value of array - * (and arrays if more arrays are provided) - * used as arguments for the callback. - *The returned array will preserve the keys of the array argument if and only - * if exactly one array is passed. If more than one array is passed, the - * returned array will have sequential integer keys.
+ * {@inheritdoc} + * @param callable|null $callback + * @param array $array + * @param array $arrays [optional] */ -function array_map (?callable $callback, array $array, array ...$arrays): array {} +function array_map (?callable $callback = null, array $array, array ...$arrays): array {} /** - * Checks if the given key or index exists in the array - * @link http://www.php.net/manual/en/function.array-key-exists.php - * @param string|int $key - * @param array $array - * @return bool Returns true on success or false on failure. - *array_key_exists will search for the keys in the first dimension only. - * Nested keys in multidimensional arrays will not be found.
+ * {@inheritdoc} + * @param mixed $key + * @param array $array */ -function array_key_exists (string|int $key, array $array): bool {} +function array_key_exists ($key = null, array $array): bool {} /** - * Alias of array_key_exists - * @link http://www.php.net/manual/en/function.key-exists.php - * @param string|int $key - * @param array $array - * @return bool Returns true on success or false on failure. - *array_key_exists will search for the keys in the first dimension only. - * Nested keys in multidimensional arrays will not be found.
+ * {@inheritdoc} + * @param mixed $key + * @param array $array */ -function key_exists (string|int $key, array $array): bool {} +function key_exists ($key = null, array $array): bool {} /** - * Split an array into chunks - * @link http://www.php.net/manual/en/function.array-chunk.php - * @param array $array - * @param int $length - * @param bool $preserve_keys [optional] - * @return array Returns a multidimensional numerically indexed array, starting with zero, - * with each dimension containing length elements. + * {@inheritdoc} + * @param array $array + * @param int $length + * @param bool $preserve_keys [optional] */ function array_chunk (array $array, int $length, bool $preserve_keys = false): array {} /** - * Creates an array by using one array for keys and another for its values - * @link http://www.php.net/manual/en/function.array-combine.php - * @param array $keys - * @param array $values - * @return array Returns the combined array. + * {@inheritdoc} + * @param array $keys + * @param array $values */ function array_combine (array $keys, array $values): array {} /** - * Checks whether a given array is a list - * @link http://www.php.net/manual/en/function.array-is-list.php - * @param array $array - * @return bool Returns true if array is a list, false - * otherwise. + * {@inheritdoc} + * @param array $array */ function array_is_list (array $array): bool {} /** - * Encodes data with MIME base64 - * @link http://www.php.net/manual/en/function.base64-encode.php - * @param string $string - * @return string The encoded data, as a string. + * {@inheritdoc} + * @param string $string */ function base64_encode (string $string): string {} /** - * Decodes data encoded with MIME base64 - * @link http://www.php.net/manual/en/function.base64-decode.php - * @param string $string - * @param bool $strict [optional] - * @return string|false Returns the decoded data or false on failure. The returned data may be - * binary. + * {@inheritdoc} + * @param string $string + * @param bool $strict [optional] */ function base64_decode (string $string, bool $strict = false): string|false {} /** - * Returns the value of a constant - * @link http://www.php.net/manual/en/function.constant.php - * @param string $name - * @return mixed Returns the value of the constant. + * {@inheritdoc} + * @param string $name */ function constant (string $name): mixed {} /** - * Converts a string containing an (IPv4) Internet Protocol dotted address into a long integer - * @link http://www.php.net/manual/en/function.ip2long.php - * @param string $ip - * @return int|false Returns the long integer or false if ip - * is invalid. + * {@inheritdoc} + * @param string $ip */ function ip2long (string $ip): int|false {} /** - * Converts a long integer address into a string in (IPv4) Internet standard dotted format - * @link http://www.php.net/manual/en/function.long2ip.php - * @param int $ip - * @return string|false Returns the Internet IP address as a string, or false on failure. + * {@inheritdoc} + * @param int $ip */ function long2ip (int $ip): string|false {} /** - * Gets the value of an environment variable - * @link http://www.php.net/manual/en/function.getenv.php - * @param string $varname - * @param bool $local_only [optional] - * @return string|false Returns the value of the environment variable - * varname, or false if the environment - * variable varname does not exist. - * If varname is omitted, all environment variables are - * returned as associative array. + * {@inheritdoc} + * @param string|null $name [optional] + * @param bool $local_only [optional] */ -function getenv (string $varname, bool $local_only = false): string|false {} +function getenv (?string $name = NULL, bool $local_only = false): array|string|false {} /** - * Sets the value of an environment variable - * @link http://www.php.net/manual/en/function.putenv.php - * @param string $assignment - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $assignment */ function putenv (string $assignment): bool {} /** - * Gets options from the command line argument list - * @link http://www.php.net/manual/en/function.getopt.php - * @param string $short_options - * @param array $long_options [optional] - * @param int $rest_index [optional] - * @return array|false This function will return an array of option / argument pairs, or false on failure. - *The parsing of options will end at the first non-option found, anything - * that follows is discarded.
+ * {@inheritdoc} + * @param string $short_options + * @param array $long_options [optional] + * @param mixed $rest_index [optional] */ -function getopt (string $short_options, array $long_options = '[]', int &$rest_index = null): array|false {} +function getopt (string $short_options, array $long_options = array ( +), &$rest_index = NULL): array|false {} /** - * Flush system output buffer - * @link http://www.php.net/manual/en/function.flush.php - * @return void No value is returned. + * {@inheritdoc} */ function flush (): void {} /** - * Delay execution - * @link http://www.php.net/manual/en/function.sleep.php - * @param int $seconds - * @return int Returns zero on success. - *If the call was interrupted by a signal, sleep returns - * a non-zero value. On Windows, this value will always be - * 192 (the value of the - * WAIT_IO_COMPLETION constant within the Windows API). - * On other platforms, the return value will be the number of seconds left to - * sleep.
+ * {@inheritdoc} + * @param int $seconds */ function sleep (int $seconds): int {} /** - * Delay execution in microseconds - * @link http://www.php.net/manual/en/function.usleep.php - * @param int $microseconds - * @return void No value is returned. + * {@inheritdoc} + * @param int $microseconds */ function usleep (int $microseconds): void {} /** - * Delay for a number of seconds and nanoseconds - * @link http://www.php.net/manual/en/function.time-nanosleep.php - * @param int $seconds - * @param int $nanoseconds - * @return array|bool Returns true on success or false on failure. - *If the delay was interrupted by a signal, an associative array will be - * returned with the components: - *
- *
- * seconds - number of seconds remaining in
- * the delay
- *
- * nanoseconds - number of nanoseconds
- * remaining in the delay
- *
This function respects the value of the - * short_open_tag - * ini directive.
+ * {@inheritdoc} + * @param string $filename */ function php_strip_whitespace (string $filename): string {} /** - * Syntax highlighting of a string - * @link http://www.php.net/manual/en/function.highlight-string.php - * @param string $string - * @param bool $return [optional] - * @return string|bool If return is set to true, returns the highlighted - * code as a string instead of printing it out. Otherwise, it will return - * true on success, false on failure. + * {@inheritdoc} + * @param string $string + * @param bool $return [optional] */ function highlight_string (string $string, bool $return = false): string|bool {} /** - * Gets the value of a configuration option - * @link http://www.php.net/manual/en/function.ini-get.php - * @param string $option - * @return string|false Returns the value of the configuration option as a string on success, or an - * empty string for null values. Returns false if the - * configuration option doesn't exist. + * {@inheritdoc} + * @param string $option */ function ini_get (string $option): string|false {} /** - * Gets all configuration options - * @link http://www.php.net/manual/en/function.ini-get-all.php - * @param string|null $extension [optional] - * @param bool $details [optional] - * @return array|false Returns an associative array with directive name as the array key. - * Returns false and raises an E_WARNING level error - * if the extension doesn't exist. - *When details is true (default) the array will - * contain global_value (set in - * php.ini), local_value (perhaps set with - * ini_set or .htaccess), and - * access (the access level).
- *When details is false the value will be the - * current value of the option.
- *See the manual section - * for information on what access levels mean.
- *It's possible for a directive to have multiple access levels, which is - * why access shows the appropriate bitmask values.
+ * {@inheritdoc} + * @param string|null $extension [optional] + * @param bool $details [optional] */ -function ini_get_all (?string $extension = null, bool $details = true): array|false {} +function ini_get_all (?string $extension = NULL, bool $details = true): array|false {} /** - * Sets the value of a configuration option - * @link http://www.php.net/manual/en/function.ini-set.php - * @param string $option - * @param string|int|float|bool|null $value - * @return string|false Returns the old value on success, false on failure. + * {@inheritdoc} + * @param string $option + * @param string|int|float|bool|null $value */ -function ini_set (string $option, string|int|float|bool|null $value): string|false {} +function ini_set (string $option, string|int|float|bool|null $value = null): string|false {} /** - * Alias of ini_set - * @link http://www.php.net/manual/en/function.ini-alter.php - * @param string $option - * @param string|int|float|bool|null $value - * @return string|false Returns the old value on success, false on failure. + * {@inheritdoc} + * @param string $option + * @param string|int|float|bool|null $value */ -function ini_alter (string $option, string|int|float|bool|null $value): string|false {} +function ini_alter (string $option, string|int|float|bool|null $value = null): string|false {} /** - * Restores the value of a configuration option - * @link http://www.php.net/manual/en/function.ini-restore.php - * @param string $option - * @return void No value is returned. + * {@inheritdoc} + * @param string $option */ function ini_restore (string $option): void {} /** - * Get interpreted size from ini shorthand syntax - * @link http://www.php.net/manual/en/function.ini-parse-quantity.php - * @param string $shorthand - * @return int Returns the interpreted size in bytes as an int. + * {@inheritdoc} + * @param string $shorthand */ function ini_parse_quantity (string $shorthand): int {} /** - * Sets the include_path configuration option - * @link http://www.php.net/manual/en/function.set-include-path.php - * @param string $include_path - * @return string|false Returns the old include_path on - * success or false on failure. + * {@inheritdoc} + * @param string $include_path */ function set_include_path (string $include_path): string|false {} /** - * Gets the current include_path configuration option - * @link http://www.php.net/manual/en/function.get-include-path.php - * @return string|false Returns the path, as a string, or false on failure. + * {@inheritdoc} */ function get_include_path (): string|false {} /** - * Prints human-readable information about a variable - * @link http://www.php.net/manual/en/function.print-r.php - * @param mixed $value - * @param bool $return [optional] - * @return string|bool If given a string, int or float, - * the value itself will be printed. If given an array, values - * will be presented in a format that shows keys and elements. Similar - * notation is used for objects. - *When the return parameter is true, this function - * will return a string. Otherwise, the return value is true.
+ * {@inheritdoc} + * @param mixed $value + * @param bool $return [optional] */ -function print_r (mixed $value, bool $return = false): string|bool {} +function print_r (mixed $value = null, bool $return = false): string|bool {} /** - * Check whether client disconnected - * @link http://www.php.net/manual/en/function.connection-aborted.php - * @return int Returns 1 if client disconnected, 0 otherwise. + * {@inheritdoc} */ function connection_aborted (): int {} /** - * Returns connection status bitfield - * @link http://www.php.net/manual/en/function.connection-status.php - * @return int Returns the connection status bitfield, which can be used against the - * CONNECTION_XXX constants to determine the connection - * status. + * {@inheritdoc} */ function connection_status (): int {} /** - * Set whether a client disconnect should abort script execution - * @link http://www.php.net/manual/en/function.ignore-user-abort.php - * @param bool|null $enable [optional] - * @return int Returns the previous setting, as an integer. + * {@inheritdoc} + * @param bool|null $enable [optional] */ -function ignore_user_abort (?bool $enable = null): int {} +function ignore_user_abort (?bool $enable = NULL): int {} /** - * Get port number associated with an Internet service and protocol - * @link http://www.php.net/manual/en/function.getservbyname.php - * @param string $service - * @param string $protocol - * @return int|false Returns the port number, or false if service or - * protocol is not found. + * {@inheritdoc} + * @param string $service + * @param string $protocol */ function getservbyname (string $service, string $protocol): int|false {} /** - * Get Internet service which corresponds to port and protocol - * @link http://www.php.net/manual/en/function.getservbyport.php - * @param int $port - * @param string $protocol - * @return string|false Returns the Internet service name as a string, or false on failure. + * {@inheritdoc} + * @param int $port + * @param string $protocol */ function getservbyport (int $port, string $protocol): string|false {} /** - * Get protocol number associated with protocol name - * @link http://www.php.net/manual/en/function.getprotobyname.php - * @param string $protocol - * @return int|false Returns the protocol number, or false on failure. + * {@inheritdoc} + * @param string $protocol */ function getprotobyname (string $protocol): int|false {} /** - * Get protocol name associated with protocol number - * @link http://www.php.net/manual/en/function.getprotobynumber.php - * @param int $protocol - * @return string|false Returns the protocol name as a string, or false on failure. + * {@inheritdoc} + * @param int $protocol */ function getprotobynumber (int $protocol): string|false {} /** - * Register a function for execution on each tick - * @link http://www.php.net/manual/en/function.register-tick-function.php - * @param callable $callback - * @param mixed $args - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param callable $callback + * @param mixed $args [optional] */ function register_tick_function (callable $callback, mixed ...$args): bool {} /** - * De-register a function for execution on each tick - * @link http://www.php.net/manual/en/function.unregister-tick-function.php - * @param callable $callback - * @return void No value is returned. + * {@inheritdoc} + * @param callable $callback */ function unregister_tick_function (callable $callback): void {} /** - * Tells whether the file was uploaded via HTTP POST - * @link http://www.php.net/manual/en/function.is-uploaded-file.php - * @param string $filename - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $filename */ function is_uploaded_file (string $filename): bool {} /** - * Moves an uploaded file to a new location - * @link http://www.php.net/manual/en/function.move-uploaded-file.php - * @param string $from - * @param string $to - * @return bool Returns true on success. - *If from is not a valid upload file, - * then no action will occur, and - * move_uploaded_file will return - * false.
- *If from is a valid upload file, but - * cannot be moved for some reason, no action will occur, and - * move_uploaded_file will return - * false. Additionally, a warning will be issued.
+ * {@inheritdoc} + * @param string $from + * @param string $to */ function move_uploaded_file (string $from, string $to): bool {} /** - * Parse a configuration file - * @link http://www.php.net/manual/en/function.parse-ini-file.php - * @param string $filename - * @param bool $process_sections [optional] - * @param int $scanner_mode [optional] - * @return array|false The settings are returned as an associative array on success, - * and false on failure. + * {@inheritdoc} + * @param string $filename + * @param bool $process_sections [optional] + * @param int $scanner_mode [optional] */ -function parse_ini_file (string $filename, bool $process_sections = false, int $scanner_mode = INI_SCANNER_NORMAL): array|false {} +function parse_ini_file (string $filename, bool $process_sections = false, int $scanner_mode = 0): array|false {} /** - * Parse a configuration string - * @link http://www.php.net/manual/en/function.parse-ini-string.php - * @param string $ini_string - * @param bool $process_sections [optional] - * @param int $scanner_mode [optional] - * @return array|false The settings are returned as an associative array on success, - * and false on failure. + * {@inheritdoc} + * @param string $ini_string + * @param bool $process_sections [optional] + * @param int $scanner_mode [optional] */ -function parse_ini_string (string $ini_string, bool $process_sections = false, int $scanner_mode = INI_SCANNER_NORMAL): array|false {} +function parse_ini_string (string $ini_string, bool $process_sections = false, int $scanner_mode = 0): array|false {} /** - * Gets system load average - * @link http://www.php.net/manual/en/function.sys-getloadavg.php - * @return array|false Returns an array with three samples (last 1, 5 and 15 - * minutes). + * {@inheritdoc} */ function sys_getloadavg (): array|false {} /** - * Tells what the user's browser is capable of - * @link http://www.php.net/manual/en/function.get-browser.php - * @param string|null $user_agent [optional] - * @param bool $return_array [optional] - * @return object|array|false The information is returned in an object or an array which will contain - * various data elements representing, for instance, the browser's major and - * minor version numbers and ID string; true/false values for features - * such as frames, JavaScript, and cookies; and so forth. - *The cookies value simply means that the browser - * itself is capable of accepting cookies and does not mean the user has - * enabled the browser to accept cookies or not. The only way to test if - * cookies are accepted is to set one with setcookie, - * reload, and check for the value.
- *Returns false when no information can be retrieved, such as when the - * browscap configuration setting in - * php.ini has not been set.
+ * {@inheritdoc} + * @param string|null $user_agent [optional] + * @param bool $return_array [optional] */ -function get_browser (?string $user_agent = null, bool $return_array = false): object|array|false {} +function get_browser (?string $user_agent = NULL, bool $return_array = false): object|array|false {} /** - * Calculates the crc32 polynomial of a string - * @link http://www.php.net/manual/en/function.crc32.php - * @param string $string - * @return int Returns the crc32 checksum of string as an integer. + * {@inheritdoc} + * @param string $string */ function crc32 (string $string): int {} /** - * One-way string hashing - * @link http://www.php.net/manual/en/function.crypt.php - * @param string $string - * @param string $salt - * @return string Returns the hashed string or a string that is shorter than 13 characters - * and is guaranteed to differ from the salt on failure. + * {@inheritdoc} + * @param string $string + * @param string $salt */ function crypt (string $string, string $salt): string {} /** - * Parse a time/date generated with strftime - * @link http://www.php.net/manual/en/function.strptime.php - * @param string $timestamp - * @param string $format - * @return array|false Returns an array or false on failure. - *parameters | - *Description | - *
"tm_sec" | - *Seconds after the minute (0-61) | - *
"tm_min" | - *Minutes after the hour (0-59) | - *
"tm_hour" | - *Hour since midnight (0-23) | - *
"tm_mday" | - *Day of the month (1-31) | - *
"tm_mon" | - *Months since January (0-11) | - *
"tm_year" | - *Years since 1900 | - *
"tm_wday" | - *Days since Sunday (0-6) | - *
"tm_yday" | - *Days since January 1 (0-365) | - *
"unparsed" | - *the timestamp part which was not - * recognized using the specified format | - *
Attribute | - *Meaning | - *
host | - *- * The record in the DNS namespace to which the rest of the associated data refers. - * | - *
class | - *- * dns_get_record only returns Internet class records and as - * such this parameter will always return IN. - * | - *
type | - *- * String containing the record type. Additional attributes will also be contained - * in the resulting array dependant on the value of type. See table below. - * | - *
ttl | - *- * "Time To Live" remaining for this record. This will not equal - * the record's original ttl, but will rather equal the original ttl minus whatever - * length of time has passed since the authoritative name server was queried. - * | - *
Type | - *Extra Columns | - *
A | - *- * ip: An IPv4 addresses in dotted decimal notation. - * | - *
MX | - *- * pri: Priority of mail exchanger. - * Lower numbers indicate greater priority. - * target: FQDN of the mail exchanger. - * See also dns_get_mx. - * | - *
CNAME | - *- * target: FQDN of location in DNS namespace to which - * the record is aliased. - * | - *
NS | - *- * target: FQDN of the name server which is authoritative - * for this hostname. - * | - *
PTR | - *- * target: Location within the DNS namespace to which - * this record points. - * | - *
TXT | - *- * txt: Arbitrary string data associated with this record. - * | - *
HINFO | - *- * cpu: IANA number designating the CPU of the machine - * referenced by this record. - * os: IANA number designating the Operating System on - * the machine referenced by this record. - * See IANA's Operating System - * Names for the meaning of these values. - * | - *
CAA | - *- * flags: A one-byte bitfield; currently only bit 0 is defined, - * meaning 'critical'; other bits are reserved and should be ignored. - * tag: The CAA tag name (alphanumeric ASCII string). - * value: The CAA tag value (binary string, may use subformats). - * For additional information see: RFC 6844 - * | - *
SOA | - *- * mname: FQDN of the machine from which the resource - * records originated. - * rname: Email address of the administrative contact - * for this domain. - * serial: Serial # of this revision of the requested - * domain. - * refresh: Refresh interval (seconds) secondary name - * servers should use when updating remote copies of this domain. - * retry: Length of time (seconds) to wait after a - * failed refresh before making a second attempt. - * expire: Maximum length of time (seconds) a secondary - * DNS server should retain remote copies of the zone data without a - * successful refresh before discarding. - * minimum-ttl: Minimum length of time (seconds) a - * client can continue to use a DNS resolution before it should request - * a new resolution from the server. Can be overridden by individual - * resource records. - * | - *
AAAA | - *- * ipv6: IPv6 address - * | - *
A6 | - *- * masklen: Length (in bits) to inherit from the target - * specified by chain. - * ipv6: Address for this specific record to merge with - * chain. - * chain: Parent record to merge with - * ipv6 data. - * | - *
SRV | - *- * pri: (Priority) lowest priorities should be used first. - * weight: Ranking to weight which of commonly prioritized - * targets should be chosen at random. - * target and port: hostname and port - * where the requested service can be found. - * For additional information see: RFC 2782 - * | - *
NAPTR | - *- * order and pref: Equivalent to - * pri and weight above. - * flags, services, regex, - * and replacement: Parameters as defined by - * RFC 2915. - * | - *
Each interface associative array contains: - *
Name | - *Description | - *
description | - *- * Optional string value for description of the interface. - * Windows only. - * | - *
mac | - *- * Optional string value for MAC address of the interface. - * Windows only. - * | - *
mtu | - *- * Integer value for Maximum transmission unit (MTU) of the interface. - * Windows only. - * | - *
unicast | - *- * Array of associative arrays, see Unicast attributes below. - * | - *
up | - *- * Boolean status (on/off) for interface. - * | - *
Name | - *Description | - *
flags | - *- * Integer value. - * | - *
family | - *- * Integer value. - * | - *
address | - *- * String value for address in either IPv4 or IPv6. - * | - *
netmask | - *- * String value for netmask in either IPv4 or IPv6. - * | - *
false will be returned if response_code is not - * provided and it is not invoked in a web server environment (such as from a - * CLI application). true will be returned if - * response_code is provided and it is not invoked in a - * web server environment (but only when no previous response status has been - * set).
+ * {@inheritdoc} + * @param int $response_code [optional] */ -function http_response_code (int $response_code = null): int|bool {} +function http_response_code (int $response_code = 0): int|bool {} /** - * Checks if or where headers have been sent - * @link http://www.php.net/manual/en/function.headers-sent.php - * @param string $filename [optional] - * @param int $line [optional] - * @return bool headers_sent will return false if no HTTP headers - * have already been sent or true otherwise. + * {@inheritdoc} + * @param mixed $filename [optional] + * @param mixed $line [optional] */ -function headers_sent (string &$filename = null, int &$line = null): bool {} +function headers_sent (&$filename = NULL, &$line = NULL): bool {} /** - * Returns a list of response headers sent (or ready to send) - * @link http://www.php.net/manual/en/function.headers-list.php - * @return array Returns a numerically indexed array of headers. + * {@inheritdoc} */ function headers_list (): array {} /** - * Convert special characters to HTML entities - * @link http://www.php.net/manual/en/function.htmlspecialchars.php - * @param string $string - * @param int $flags [optional] - * @param string|null $encoding [optional] - * @param bool $double_encode [optional] - * @return string The converted string. - *If the input string contains an invalid code unit - * sequence within the given encoding an empty string - * will be returned, unless either the ENT_IGNORE or - * ENT_SUBSTITUTE flags are set.
+ * {@inheritdoc} + * @param string $string + * @param int $flags [optional] + * @param string|null $encoding [optional] + * @param bool $double_encode [optional] */ -function htmlspecialchars (string $string, int $flags = 'ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401', ?string $encoding = null, bool $double_encode = true): string {} +function htmlspecialchars (string $string, int $flags = 11, ?string $encoding = NULL, bool $double_encode = true): string {} /** - * Convert special HTML entities back to characters - * @link http://www.php.net/manual/en/function.htmlspecialchars-decode.php - * @param string $string - * @param int $flags [optional] - * @return string Returns the decoded string. + * {@inheritdoc} + * @param string $string + * @param int $flags [optional] */ -function htmlspecialchars_decode (string $string, int $flags = 'ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401'): string {} +function htmlspecialchars_decode (string $string, int $flags = 11): string {} /** - * Convert HTML entities to their corresponding characters - * @link http://www.php.net/manual/en/function.html-entity-decode.php - * @param string $string - * @param int $flags [optional] - * @param string|null $encoding [optional] - * @return string Returns the decoded string. + * {@inheritdoc} + * @param string $string + * @param int $flags [optional] + * @param string|null $encoding [optional] */ -function html_entity_decode (string $string, int $flags = 'ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401', ?string $encoding = null): string {} +function html_entity_decode (string $string, int $flags = 11, ?string $encoding = NULL): string {} /** - * Convert all applicable characters to HTML entities - * @link http://www.php.net/manual/en/function.htmlentities.php - * @param string $string - * @param int $flags [optional] - * @param string|null $encoding [optional] - * @param bool $double_encode [optional] - * @return string Returns the encoded string. - *If the input string contains an invalid code unit - * sequence within the given encoding an empty string - * will be returned, unless either the ENT_IGNORE or - * ENT_SUBSTITUTE flags are set.
+ * {@inheritdoc} + * @param string $string + * @param int $flags [optional] + * @param string|null $encoding [optional] + * @param bool $double_encode [optional] */ -function htmlentities (string $string, int $flags = 'ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401', ?string $encoding = null, bool $double_encode = true): string {} +function htmlentities (string $string, int $flags = 11, ?string $encoding = NULL, bool $double_encode = true): string {} /** - * Returns the translation table used by htmlspecialchars and htmlentities - * @link http://www.php.net/manual/en/function.get-html-translation-table.php - * @param int $table [optional] - * @param int $flags [optional] - * @param string $encoding [optional] - * @return array Returns the translation table as an array, with the original characters - * as keys and entities as values. + * {@inheritdoc} + * @param int $table [optional] + * @param int $flags [optional] + * @param string $encoding [optional] */ -function get_html_translation_table (int $table = HTML_SPECIALCHARS, int $flags = 'ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401', string $encoding = '"UTF-8"'): array {} +function get_html_translation_table (int $table = 0, int $flags = 11, string $encoding = 'UTF-8'): array {} /** - * Checks if assertion is false - * @link http://www.php.net/manual/en/function.assert.php - * @param mixed $assertion - * @param string $description [optional] - * @return bool false if the assertion is false, true otherwise. + * {@inheritdoc} + * @param mixed $assertion + * @param Throwable|string|null $description [optional] */ -function assert (mixed $assertion, string $description = null): bool {} +function assert (mixed $assertion = null, Throwable|string|null $description = NULL): bool {} /** - * Set/get the various assert flags - * @link http://www.php.net/manual/en/function.assert-options.php - * @param int $what - * @param mixed $value [optional] - * @return mixed Returns the original setting of any option or false on errors. + * {@inheritdoc} + * @param int $option + * @param mixed $value [optional] + * @deprecated */ -function assert_options (int $what, mixed $value = null): mixed {} +function assert_options (int $option, mixed $value = NULL): mixed {} /** - * Convert binary data into hexadecimal representation - * @link http://www.php.net/manual/en/function.bin2hex.php - * @param string $string - * @return string Returns the hexadecimal representation of the given string. + * {@inheritdoc} + * @param string $string */ function bin2hex (string $string): string {} /** - * Decodes a hexadecimally encoded binary string - * @link http://www.php.net/manual/en/function.hex2bin.php - * @param string $string Hexadecimal representation of data. - * @return string|false Returns the binary representation of the given data or false on failure. + * {@inheritdoc} + * @param string $string */ function hex2bin (string $string): string|false {} /** - * Finds the length of the initial segment of a string consisting - * entirely of characters contained within a given mask - * @link http://www.php.net/manual/en/function.strspn.php - * @param string $string - * @param string $characters - * @param int $offset [optional] - * @param int|null $length [optional] - * @return int Returns the length of the initial segment of string - * which consists entirely of characters in characters. - *When a offset parameter is set, the returned length - * is counted starting from this position, not from the beginning of - * string.
+ * {@inheritdoc} + * @param string $string + * @param string $characters + * @param int $offset [optional] + * @param int|null $length [optional] */ -function strspn (string $string, string $characters, int $offset = null, ?int $length = null): int {} +function strspn (string $string, string $characters, int $offset = 0, ?int $length = NULL): int {} /** - * Find length of initial segment not matching mask - * @link http://www.php.net/manual/en/function.strcspn.php - * @param string $string - * @param string $characters - * @param int $offset [optional] - * @param int|null $length [optional] - * @return int Returns the length of the initial segment of string - * which consists entirely of characters not in characters. - *When a offset parameter is set, the returned length - * is counted starting from this position, not from the beginning of - * string.
+ * {@inheritdoc} + * @param string $string + * @param string $characters + * @param int $offset [optional] + * @param int|null $length [optional] */ -function strcspn (string $string, string $characters, int $offset = null, ?int $length = null): int {} +function strcspn (string $string, string $characters, int $offset = 0, ?int $length = NULL): int {} /** - * Query language and locale information - * @link http://www.php.net/manual/en/function.nl-langinfo.php - * @param int $item - * @return string|false Returns the element as a string, or false if item - * is not valid. + * {@inheritdoc} + * @param int $item */ function nl_langinfo (int $item): string|false {} /** - * Locale based string comparison - * @link http://www.php.net/manual/en/function.strcoll.php - * @param string $string1 - * @param string $string2 - * @return int Returns < 0 if string1 is less than - * string2; > 0 if - * string1 is greater than - * string2, and 0 if they are equal. + * {@inheritdoc} + * @param string $string1 + * @param string $string2 */ function strcoll (string $string1, string $string2): int {} /** - * Strip whitespace (or other characters) from the beginning and end of a string - * @link http://www.php.net/manual/en/function.trim.php - * @param string $string - * @param string $characters [optional] - * @return string The trimmed string. - */ -function trim (string $string, string $characters = '" \\n\\r\\t\\v\\x00"'): string {} - -/** - * Strip whitespace (or other characters) from the end of a string - * @link http://www.php.net/manual/en/function.rtrim.php - * @param string $string - * @param string $characters [optional] - * @return string Returns the modified string. - */ -function rtrim (string $string, string $characters = '" \\n\\r\\t\\v\\x00"'): string {} - -/** - * Alias of rtrim - * @link http://www.php.net/manual/en/function.chop.php - * @param string $string - * @param string $characters [optional] - * @return string Returns the modified string. - */ -function chop (string $string, string $characters = '" \\n\\r\\t\\v\\x00"'): string {} - -/** - * Strip whitespace (or other characters) from the beginning of a string - * @link http://www.php.net/manual/en/function.ltrim.php - * @param string $string - * @param string $characters [optional] - * @return string This function returns a string with whitespace stripped from the - * beginning of string. - * Without the second parameter, - * ltrim will strip these characters: - *
- *
- * " " (ASCII 32
- * (0x20)), an ordinary space.
- *
- * "\t" (ASCII 9
- * (0x09)), a tab.
- *
- * "\n" (ASCII 10
- * (0x0A)), a new line (line feed).
- *
- * "\r" (ASCII 13
- * (0x0D)), a carriage return.
- *
- * "\0" (ASCII 0
- * (0x00)), the NUL-byte.
- *
- * "\v" (ASCII 11
- * (0x0B)), a vertical tab.
- *
If separator is an empty string (""), - * explode throws a ValueError. - * If separator contains a value that is not - * contained in string and a negative - * limit is used, then an empty array will be - * returned, otherwise an array containing - * string will be returned. If separator - * values appear at the start or end of string, said values - * will be added as an empty array value either in the first or last - * position of the returned array respectively.
- */ -function explode (string $separator, string $string, int $limit = PHP_INT_MAX): array {} - -/** - * Join array elements with a string - * @link http://www.php.net/manual/en/function.implode.php - * @param string $separator - * @param array $array - * @return string Returns a string containing a string representation of all the array - * elements in the same order, with the separator string between each element. - */ -function implode (string $separator, array $array): string {} - -/** - * Alias of implode - * @link http://www.php.net/manual/en/function.join.php - * @param string $separator - * @param array $array - * @return string Returns a string containing a string representation of all the array - * elements in the same order, with the separator string between each element. - */ -function join (string $separator, array $array): string {} - -/** - * Tokenize string - * @link http://www.php.net/manual/en/function.strtok.php - * @param string $string - * @param string $token - * @return string|false A string token, or false if no more tokens are available. - */ -function strtok (string $string, string $token): string|false {} - -/** - * Make a string uppercase - * @link http://www.php.net/manual/en/function.strtoupper.php - * @param string $string - * @return string Returns the uppercased string. + * {@inheritdoc} + * @param string $string + * @param string $characters [optional] + */ +function trim (string $string, string $characters = ' + ' . "\0" . ''): string {} + +/** + * {@inheritdoc} + * @param string $string + * @param string $characters [optional] + */ +function rtrim (string $string, string $characters = ' + ' . "\0" . ''): string {} + +/** + * {@inheritdoc} + * @param string $string + * @param string $characters [optional] + */ +function chop (string $string, string $characters = ' + ' . "\0" . ''): string {} + +/** + * {@inheritdoc} + * @param string $string + * @param string $characters [optional] + */ +function ltrim (string $string, string $characters = ' + ' . "\0" . ''): string {} + +/** + * {@inheritdoc} + * @param string $string + * @param int $width [optional] + * @param string $break [optional] + * @param bool $cut_long_words [optional] + */ +function wordwrap (string $string, int $width = 75, string $break = ' +', bool $cut_long_words = false): string {} + +/** + * {@inheritdoc} + * @param string $separator + * @param string $string + * @param int $limit [optional] + */ +function explode (string $separator, string $string, int $limit = 9223372036854775807): array {} + +/** + * {@inheritdoc} + * @param array|string $separator + * @param array|null $array [optional] + */ +function implode (array|string $separator, ?array $array = NULL): string {} + +/** + * {@inheritdoc} + * @param array|string $separator + * @param array|null $array [optional] + */ +function join (array|string $separator, ?array $array = NULL): string {} + +/** + * {@inheritdoc} + * @param string $string + * @param string|null $token [optional] + */ +function strtok (string $string, ?string $token = NULL): string|false {} + +/** + * {@inheritdoc} + * @param string $string */ function strtoupper (string $string): string {} /** - * Make a string lowercase - * @link http://www.php.net/manual/en/function.strtolower.php - * @param string $string - * @return string Returns the lowercased string. + * {@inheritdoc} + * @param string $string */ function strtolower (string $string): string {} /** - * Returns trailing name component of path - * @link http://www.php.net/manual/en/function.basename.php - * @param string $path - * @param string $suffix [optional] - * @return string Returns the base name of the given path. - */ -function basename (string $path, string $suffix = '""'): string {} - -/** - * Returns a parent directory's path - * @link http://www.php.net/manual/en/function.dirname.php - * @param string $path - * @param int $levels [optional] - * @return string Returns the path of a parent directory. If there are no slashes in - * path, a dot ('.') is returned, - * indicating the current directory. Otherwise, the returned string is - * path with any trailing - * /component removed. - *Be careful when using this function in a loop that can reach the - * top-level directory as this can result in an infinite loop. - *
- * <?php
- * dirname('.'); // Will return '.'.
- * dirname('/'); // Will return `\` on Windows and '/' on *nix systems.
- * dirname('\\'); // Will return `\` on Windows and '.' on *nix systems.
- * dirname('C:\\'); // Will return 'C:\' on Windows and '.' on *nix systems.
- * ?>
- *
+ * {@inheritdoc}
+ * @param string $string
+ */
+function str_increment (string $string): string {}
+
+/**
+ * {@inheritdoc}
+ * @param string $string
+ */
+function str_decrement (string $string): string {}
+
+/**
+ * {@inheritdoc}
+ * @param string $path
+ * @param string $suffix [optional]
+ */
+function basename (string $path, string $suffix = ''): string {}
+
+/**
+ * {@inheritdoc}
+ * @param string $path
+ * @param int $levels [optional]
*/
function dirname (string $path, int $levels = 1): string {}
/**
- * Returns information about a file path
- * @link http://www.php.net/manual/en/function.pathinfo.php
- * @param string $path
- * @param int $flags [optional]
- * @return array|string If the flags parameter is not passed, an
- * associative array containing the following elements is
- * returned:
- * dirname, basename,
- * extension (if any), and filename.
- * If the path has more than one extension, - * PATHINFO_EXTENSION returns only the last one and - * PATHINFO_FILENAME only strips the last one. - * (see first example below).
- *If the path does not have an extension, no - * extension element will be returned - * (see second example below).
- *If the basename of the path starts - * with a dot, the following characters are interpreted as - * extension, and the filename is empty - * (see third example below).
- *If flags is present, returns a - * string containing the requested element.
- */ -function pathinfo (string $path, int $flags = PATHINFO_ALL): array|string {} - -/** - * Case-insensitive strstr - * @link http://www.php.net/manual/en/function.stristr.php - * @param string $haystack - * @param string $needle - * @param bool $before_needle [optional] - * @return string|false Returns the matched substring. If needle is not - * found, returns false. + * {@inheritdoc} + * @param string $path + * @param int $flags [optional] + */ +function pathinfo (string $path, int $flags = 15): array|string {} + +/** + * {@inheritdoc} + * @param string $haystack + * @param string $needle + * @param bool $before_needle [optional] */ function stristr (string $haystack, string $needle, bool $before_needle = false): string|false {} /** - * Find the first occurrence of a string - * @link http://www.php.net/manual/en/function.strstr.php - * @param string $haystack - * @param string $needle - * @param bool $before_needle [optional] - * @return string|false Returns the portion of string, or false if needle - * is not found. + * {@inheritdoc} + * @param string $haystack + * @param string $needle + * @param bool $before_needle [optional] */ function strstr (string $haystack, string $needle, bool $before_needle = false): string|false {} /** - * Alias of strstr - * @link http://www.php.net/manual/en/function.strchr.php - * @param string $haystack - * @param string $needle - * @param bool $before_needle [optional] - * @return string|false Returns the portion of string, or false if needle - * is not found. + * {@inheritdoc} + * @param string $haystack + * @param string $needle + * @param bool $before_needle [optional] */ function strchr (string $haystack, string $needle, bool $before_needle = false): string|false {} /** - * Find the position of the first occurrence of a substring in a string - * @link http://www.php.net/manual/en/function.strpos.php - * @param string $haystack - * @param string $needle - * @param int $offset [optional] - * @return int|false Returns the position of where the needle exists relative to the beginning of - * the haystack string (independent of offset). - * Also note that string positions start at 0, and not 1. - *Returns false if the needle was not found.
+ * {@inheritdoc} + * @param string $haystack + * @param string $needle + * @param int $offset [optional] */ -function strpos (string $haystack, string $needle, int $offset = null): int|false {} +function strpos (string $haystack, string $needle, int $offset = 0): int|false {} /** - * Find the position of the first occurrence of a case-insensitive substring in a string - * @link http://www.php.net/manual/en/function.stripos.php - * @param string $haystack - * @param string $needle - * @param int $offset [optional] - * @return int|false Returns the position of where the needle exists relative to the beginning of - * the haystack string (independent of offset). - * Also note that string positions start at 0, and not 1. - *Returns false if the needle was not found.
+ * {@inheritdoc} + * @param string $haystack + * @param string $needle + * @param int $offset [optional] */ -function stripos (string $haystack, string $needle, int $offset = null): int|false {} +function stripos (string $haystack, string $needle, int $offset = 0): int|false {} /** - * Find the position of the last occurrence of a substring in a string - * @link http://www.php.net/manual/en/function.strrpos.php - * @param string $haystack - * @param string $needle - * @param int $offset [optional] - * @return int|false Returns the position where the needle exists relative to the beginning of - * the haystack string (independent of search direction - * or offset). - * String positions start at 0, and not 1. - *Returns false if the needle was not found.
+ * {@inheritdoc} + * @param string $haystack + * @param string $needle + * @param int $offset [optional] */ -function strrpos (string $haystack, string $needle, int $offset = null): int|false {} +function strrpos (string $haystack, string $needle, int $offset = 0): int|false {} /** - * Find the position of the last occurrence of a case-insensitive substring in a string - * @link http://www.php.net/manual/en/function.strripos.php - * @param string $haystack - * @param string $needle - * @param int $offset [optional] - * @return int|false Returns the position where the needle exists relative to the beginnning of - * the haystack string (independent of search direction - * or offset). - * String positions start at 0, and not 1. - *Returns false if the needle was not found.
+ * {@inheritdoc} + * @param string $haystack + * @param string $needle + * @param int $offset [optional] */ -function strripos (string $haystack, string $needle, int $offset = null): int|false {} +function strripos (string $haystack, string $needle, int $offset = 0): int|false {} /** - * Find the last occurrence of a character in a string - * @link http://www.php.net/manual/en/function.strrchr.php - * @param string $haystack - * @param string $needle - * @return string|false This function returns the portion of string, or false if - * needle is not found. + * {@inheritdoc} + * @param string $haystack + * @param string $needle + * @param bool $before_needle [optional] */ -function strrchr (string $haystack, string $needle): string|false {} +function strrchr (string $haystack, string $needle, bool $before_needle = false): string|false {} /** - * Determine if a string contains a given substring - * @link http://www.php.net/manual/en/function.str-contains.php - * @param string $haystack - * @param string $needle - * @return bool Returns true if needle is in - * haystack, false otherwise. + * {@inheritdoc} + * @param string $haystack + * @param string $needle */ function str_contains (string $haystack, string $needle): bool {} /** - * Checks if a string starts with a given substring - * @link http://www.php.net/manual/en/function.str-starts-with.php - * @param string $haystack - * @param string $needle - * @return bool Returns true if haystack begins with - * needle, false otherwise. + * {@inheritdoc} + * @param string $haystack + * @param string $needle */ function str_starts_with (string $haystack, string $needle): bool {} /** - * Checks if a string ends with a given substring - * @link http://www.php.net/manual/en/function.str-ends-with.php - * @param string $haystack - * @param string $needle - * @return bool Returns true if haystack ends with - * needle, false otherwise. + * {@inheritdoc} + * @param string $haystack + * @param string $needle */ function str_ends_with (string $haystack, string $needle): bool {} /** - * Split a string into smaller chunks - * @link http://www.php.net/manual/en/function.chunk-split.php - * @param string $string - * @param int $length [optional] - * @param string $separator [optional] - * @return string Returns the chunked string. + * {@inheritdoc} + * @param string $string + * @param int $length [optional] + * @param string $separator [optional] */ -function chunk_split (string $string, int $length = 76, string $separator = '"\\r\\n"'): string {} +function chunk_split (string $string, int $length = 76, string $separator = ' +'): string {} /** - * Return part of a string - * @link http://www.php.net/manual/en/function.substr.php - * @param string $string - * @param int $offset - * @param int|null $length [optional] - * @return string Returns the extracted part of string, or - * an empty string. + * {@inheritdoc} + * @param string $string + * @param int $offset + * @param int|null $length [optional] */ -function substr (string $string, int $offset, ?int $length = null): string {} +function substr (string $string, int $offset, ?int $length = NULL): string {} /** - * Replace text within a portion of a string - * @link http://www.php.net/manual/en/function.substr-replace.php - * @param array|string $string - * @param array|string $replace - * @param array|int $offset - * @param array|int|null $length [optional] - * @return string|array The result string is returned. If string is an - * array then array is returned. + * {@inheritdoc} + * @param array|string $string + * @param array|string $replace + * @param array|int $offset + * @param array|int|null $length [optional] */ -function substr_replace (array|string $string, array|string $replace, array|int $offset, array|int|null $length = null): string|array {} +function substr_replace (array|string $string, array|string $replace, array|int $offset, array|int|null $length = NULL): array|string {} /** - * Quote meta characters - * @link http://www.php.net/manual/en/function.quotemeta.php - * @param string $string - * @return string Returns the string with meta characters quoted, or false if an empty - * string is given as string. + * {@inheritdoc} + * @param string $string */ function quotemeta (string $string): string {} /** - * Convert the first byte of a string to a value between 0 and 255 - * @link http://www.php.net/manual/en/function.ord.php - * @param string $character - * @return int An integer between 0 and 255. + * {@inheritdoc} + * @param string $character */ function ord (string $character): int {} /** - * Generate a single-byte string from a number - * @link http://www.php.net/manual/en/function.chr.php - * @param int $codepoint - * @return string A single-character string containing the specified byte. + * {@inheritdoc} + * @param int $codepoint */ function chr (int $codepoint): string {} /** - * Make a string's first character uppercase - * @link http://www.php.net/manual/en/function.ucfirst.php - * @param string $string - * @return string Returns the resulting string. + * {@inheritdoc} + * @param string $string */ function ucfirst (string $string): string {} /** - * Make a string's first character lowercase - * @link http://www.php.net/manual/en/function.lcfirst.php - * @param string $string - * @return string Returns the resulting string. + * {@inheritdoc} + * @param string $string */ function lcfirst (string $string): string {} /** - * Uppercase the first character of each word in a string - * @link http://www.php.net/manual/en/function.ucwords.php - * @param string $string - * @param string $separators [optional] - * @return string Returns the modified string. + * {@inheritdoc} + * @param string $string + * @param string $separators [optional] */ -function ucwords (string $string, string $separators = '" \\t\\r\\n\\f\\v"'): string {} +function ucwords (string $string, string $separators = ' +'): string {} /** - * Translate characters or replace substrings - * @link http://www.php.net/manual/en/function.strtr.php - * @param string $string - * @param string $from - * @param string $to - * @return string Returns the translated string. + * {@inheritdoc} + * @param string $string + * @param array|string $from + * @param string|null $to [optional] */ -function strtr (string $string, string $from, string $to): string {} +function strtr (string $string, array|string $from, ?string $to = NULL): string {} /** - * Reverse a string - * @link http://www.php.net/manual/en/function.strrev.php - * @param string $string - * @return string Returns the reversed string. + * {@inheritdoc} + * @param string $string */ function strrev (string $string): string {} /** - * Calculate the similarity between two strings - * @link http://www.php.net/manual/en/function.similar-text.php - * @param string $string1 - * @param string $string2 - * @param float $percent [optional] - * @return int Returns the number of matching chars in both strings. - *The number of matching characters is calculated by finding the longest first - * common substring, and then doing this for the prefixes and the suffixes, - * recursively. The lengths of all found common substrings are added.
+ * {@inheritdoc} + * @param string $string1 + * @param string $string2 + * @param mixed $percent [optional] */ -function similar_text (string $string1, string $string2, float &$percent = null): int {} +function similar_text (string $string1, string $string2, &$percent = NULL): int {} /** - * Quote string with slashes in a C style - * @link http://www.php.net/manual/en/function.addcslashes.php - * @param string $string - * @param string $characters - * @return string Returns the escaped string. + * {@inheritdoc} + * @param string $string + * @param string $characters */ function addcslashes (string $string, string $characters): string {} /** - * Quote string with slashes - * @link http://www.php.net/manual/en/function.addslashes.php - * @param string $string - * @return string Returns the escaped string. + * {@inheritdoc} + * @param string $string */ function addslashes (string $string): string {} /** - * Un-quote string quoted with addcslashes - * @link http://www.php.net/manual/en/function.stripcslashes.php - * @param string $string - * @return string Returns the unescaped string. + * {@inheritdoc} + * @param string $string */ function stripcslashes (string $string): string {} /** - * Un-quotes a quoted string - * @link http://www.php.net/manual/en/function.stripslashes.php - * @param string $string - * @return string Returns a string with backslashes stripped off. - * (\' becomes ' and so on.) - * Double backslashes (\\) are made into a single - * backslash (\). + * {@inheritdoc} + * @param string $string */ function stripslashes (string $string): string {} /** - * Replace all occurrences of the search string with the replacement string - * @link http://www.php.net/manual/en/function.str-replace.php - * @param array|string $search - * @param array|string $replace - * @param string|array $subject - * @param int $count [optional] - * @return string|array This function returns a string or an array with the replaced values. + * {@inheritdoc} + * @param array|string $search + * @param array|string $replace + * @param array|string $subject + * @param mixed $count [optional] */ -function str_replace (array|string $search, array|string $replace, string|array $subject, int &$count = null): string|array {} +function str_replace (array|string $search, array|string $replace, array|string $subject, &$count = NULL): array|string {} /** - * Case-insensitive version of str_replace - * @link http://www.php.net/manual/en/function.str-ireplace.php - * @param array|string $search - * @param array|string $replace - * @param string|array $subject - * @param int $count [optional] - * @return string|array Returns a string or an array of replacements. + * {@inheritdoc} + * @param array|string $search + * @param array|string $replace + * @param array|string $subject + * @param mixed $count [optional] */ -function str_ireplace (array|string $search, array|string $replace, string|array $subject, int &$count = null): string|array {} +function str_ireplace (array|string $search, array|string $replace, array|string $subject, &$count = NULL): array|string {} /** - * Convert logical Hebrew text to visual text - * @link http://www.php.net/manual/en/function.hebrev.php - * @param string $string - * @param int $max_chars_per_line [optional] - * @return string Returns the visual string. + * {@inheritdoc} + * @param string $string + * @param int $max_chars_per_line [optional] */ -function hebrev (string $string, int $max_chars_per_line = null): string {} +function hebrev (string $string, int $max_chars_per_line = 0): string {} /** - * Inserts HTML line breaks before all newlines in a string - * @link http://www.php.net/manual/en/function.nl2br.php - * @param string $string - * @param bool $use_xhtml [optional] - * @return string Returns the altered string. + * {@inheritdoc} + * @param string $string + * @param bool $use_xhtml [optional] */ function nl2br (string $string, bool $use_xhtml = true): string {} /** - * Strip HTML and PHP tags from a string - * @link http://www.php.net/manual/en/function.strip-tags.php - * @param string $string - * @param array|string|null $allowed_tags [optional] - * @return string Returns the stripped string. + * {@inheritdoc} + * @param string $string + * @param array|string|null $allowed_tags [optional] */ -function strip_tags (string $string, array|string|null $allowed_tags = null): string {} +function strip_tags (string $string, array|string|null $allowed_tags = NULL): string {} /** - * Set locale information - * @link http://www.php.net/manual/en/function.setlocale.php - * @param int $category - * @param string $locales - * @param string $rest - * @return string|false Returns the new current locale, or false if the locale functionality is - * not implemented on your platform, the specified locale does not exist or - * the category name is invalid. - *An invalid category name also causes a warning message. Category/locale - * names can be found in RFC 1766 - * and ISO 639. - * Different systems have different naming schemes for locales.
- *The return value of setlocale depends - * on the system that PHP is running. It returns exactly - * what the system setlocale function returns.
+ * {@inheritdoc} + * @param int $category + * @param mixed $locales + * @param mixed $rest [optional] */ -function setlocale (int $category, string $locales, string ...$rest): string|false {} +function setlocale (int $category, $locales = null, ...$rest): string|false {} /** - * Parses the string into variables - * @link http://www.php.net/manual/en/function.parse-str.php - * @param string $string - * @param array $result - * @return void No value is returned. + * {@inheritdoc} + * @param string $string + * @param mixed $result */ -function parse_str (string $string, array &$result): void {} +function parse_str (string $string, &$result = null): void {} /** - * Parse a CSV string into an array - * @link http://www.php.net/manual/en/function.str-getcsv.php - * @param string $string - * @param string $separator [optional] - * @param string $enclosure [optional] - * @param string $escape [optional] - * @return array Returns an indexed array containing the fields read. + * {@inheritdoc} + * @param string $string + * @param string $separator [optional] + * @param string $enclosure [optional] + * @param string $escape [optional] */ -function str_getcsv (string $string, string $separator = '","', string $enclosure = '"\\""', string $escape = '"\\\\"'): array {} +function str_getcsv (string $string, string $separator = ',', string $enclosure = '"', string $escape = '\\'): array {} /** - * Repeat a string - * @link http://www.php.net/manual/en/function.str-repeat.php - * @param string $string - * @param int $times - * @return string Returns the repeated string. + * {@inheritdoc} + * @param string $string + * @param int $times */ function str_repeat (string $string, int $times): string {} /** - * Return information about characters used in a string - * @link http://www.php.net/manual/en/function.count-chars.php - * @param string $string - * @param int $mode [optional] - * @return array|string Depending on mode - * count_chars returns one of the following: - *
- *
- * 0 - an array with the byte-value as key and the frequency of
- * every byte as value.
- *
- * 1 - same as 0 but only byte-values with a frequency greater
- * than zero are listed.
- *
- * 2 - same as 0 but only byte-values with a frequency equal to
- * zero are listed.
- *
- * 3 - a string containing all unique characters is returned.
- *
- * 4 - a string containing all not used characters is returned.
- *
Array element | - *Description | - *
decimal_point | - *Decimal point character | - *
thousands_sep | - *Thousands separator | - *
grouping | - *Array containing numeric groupings | - *
int_curr_symbol | - *International currency symbol (i.e. USD) | - *
currency_symbol | - *Local currency symbol (i.e. $) | - *
mon_decimal_point | - *Monetary decimal point character | - *
mon_thousands_sep | - *Monetary thousands separator | - *
mon_grouping | - *Array containing monetary groupings | - *
positive_sign | - *Sign for positive values | - *
negative_sign | - *Sign for negative values | - *
int_frac_digits | - *International fractional digits | - *
frac_digits | - *Local fractional digits | - *
p_cs_precedes | - *- * true if currency_symbol precedes a positive value, false - * if it succeeds one - * | - *
p_sep_by_space | - *- * true if a space separates currency_symbol from a positive - * value, false otherwise - * | - *
n_cs_precedes | - *- * true if currency_symbol precedes a negative value, false - * if it succeeds one - * | - *
n_sep_by_space | - *- * true if a space separates currency_symbol from a negative - * value, false otherwise - * | - *
p_sign_posn | - *
- * - * 0 - Parentheses surround the quantity and currency_symbol - * 1 - The sign string precedes the quantity and currency_symbol - * 2 - The sign string succeeds the quantity and currency_symbol - * 3 - The sign string immediately precedes the currency_symbol - * 4 - The sign string immediately succeeds the currency_symbol - * - * |
- *
n_sign_posn | - *
- * - * 0 - Parentheses surround the quantity and currency_symbol - * 1 - The sign string precedes the quantity and currency_symbol - * 2 - The sign string succeeds the quantity and currency_symbol - * 3 - The sign string immediately precedes the currency_symbol - * 4 - The sign string immediately succeeds the currency_symbol - * - * |
- *
The p_sign_posn, and n_sign_posn contain a string - * of formatting options. Each number representing one of the above listed conditions.
- *The grouping fields contain arrays that define the way numbers should be - * grouped. For example, the monetary grouping field for the nl_NL locale (in - * UTF-8 mode with the euro sign), would contain a 2 item array with the - * values 3 and 3. The higher the index in the array, the farther left the - * grouping is. If an array element is equal to CHAR_MAX, - * no further grouping is done. If an array element is equal to 0, the previous - * element should be used.
+ * {@inheritdoc} */ function localeconv (): array {} /** - * Case insensitive string comparisons using a "natural order" algorithm - * @link http://www.php.net/manual/en/function.strnatcasecmp.php - * @param string $string1 - * @param string $string2 - * @return int Similar to other string comparison functions, this one returns -1 if - * string1 is less than string2 - * 1 if string1 is greater than - * string2, and 0 if they are equal. + * {@inheritdoc} + * @param string $string1 + * @param string $string2 */ function strnatcasecmp (string $string1, string $string2): int {} /** - * Count the number of substring occurrences - * @link http://www.php.net/manual/en/function.substr-count.php - * @param string $haystack - * @param string $needle - * @param int $offset [optional] - * @param int|null $length [optional] - * @return int This function returns an int. + * {@inheritdoc} + * @param string $haystack + * @param string $needle + * @param int $offset [optional] + * @param int|null $length [optional] */ -function substr_count (string $haystack, string $needle, int $offset = null, ?int $length = null): int {} +function substr_count (string $haystack, string $needle, int $offset = 0, ?int $length = NULL): int {} /** - * Pad a string to a certain length with another string - * @link http://www.php.net/manual/en/function.str-pad.php - * @param string $string - * @param int $length - * @param string $pad_string [optional] - * @param int $pad_type [optional] - * @return string Returns the padded string. + * {@inheritdoc} + * @param string $string + * @param int $length + * @param string $pad_string [optional] + * @param int $pad_type [optional] */ -function str_pad (string $string, int $length, string $pad_string = '" "', int $pad_type = STR_PAD_RIGHT): string {} +function str_pad (string $string, int $length, string $pad_string = ' ', int $pad_type = 1): string {} /** - * Parses input from a string according to a format - * @link http://www.php.net/manual/en/function.sscanf.php - * @param string $string - * @param string $format - * @param mixed $vars - * @return array|int|null If only two parameters were passed to this function, the values parsed will - * be returned as an array. Otherwise, if optional parameters are passed, the - * function will return the number of assigned values. The optional parameters - * must be passed by reference. - *If there are more substrings expected in the format - * than there are available within string, - * null will be returned.
+ * {@inheritdoc} + * @param string $string + * @param string $format + * @param mixed $vars [optional] */ function sscanf (string $string, string $format, mixed &...$vars): array|int|null {} /** - * Perform the rot13 transform on a string - * @link http://www.php.net/manual/en/function.str-rot13.php - * @param string $string - * @return string Returns the ROT13 version of the given string. + * {@inheritdoc} + * @param string $string */ function str_rot13 (string $string): string {} /** - * Randomly shuffles a string - * @link http://www.php.net/manual/en/function.str-shuffle.php - * @param string $string - * @return string Returns the shuffled string. + * {@inheritdoc} + * @param string $string */ function str_shuffle (string $string): string {} /** - * Return information about words used in a string - * @link http://www.php.net/manual/en/function.str-word-count.php - * @param string $string - * @param int $format [optional] - * @param string|null $characters [optional] - * @return array|int Returns an array or an integer, depending on the - * format chosen. + * {@inheritdoc} + * @param string $string + * @param int $format [optional] + * @param string|null $characters [optional] */ -function str_word_count (string $string, int $format = null, ?string $characters = null): array|int {} +function str_word_count (string $string, int $format = 0, ?string $characters = NULL): array|int {} /** - * Convert a string to an array - * @link http://www.php.net/manual/en/function.str-split.php - * @param string $string - * @param int $length [optional] - * @return array If the optional length parameter is - * specified, the returned array will be broken down into chunks with each - * being length in length, except the final chunk - * which may be shorter if the string does not divide evenly. The default - * length is 1, meaning every chunk will be one byte in size. + * {@inheritdoc} + * @param string $string + * @param int $length [optional] */ function str_split (string $string, int $length = 1): array {} /** - * Search a string for any of a set of characters - * @link http://www.php.net/manual/en/function.strpbrk.php - * @param string $string - * @param string $characters - * @return string|false Returns a string starting from the character found, or false if it is - * not found. + * {@inheritdoc} + * @param string $string + * @param string $characters */ function strpbrk (string $string, string $characters): string|false {} /** - * Binary safe comparison of two strings from an offset, up to length characters - * @link http://www.php.net/manual/en/function.substr-compare.php - * @param string $haystack - * @param string $needle - * @param int $offset - * @param int|null $length [optional] - * @param bool $case_insensitive [optional] - * @return int Returns -1 if haystack from position - * offset is less than needle, 1 - * if it is greater than needle, and 0 if they are equal. - * If offset is equal to (prior to PHP 7.2.18, 7.3.5) or - * greater than the length of haystack, or the - * length is set and is less than 0, - * substr_compare prints a warning and returns - * false. + * {@inheritdoc} + * @param string $haystack + * @param string $needle + * @param int $offset + * @param int|null $length [optional] + * @param bool $case_insensitive [optional] */ -function substr_compare (string $haystack, string $needle, int $offset, ?int $length = null, bool $case_insensitive = false): int {} +function substr_compare (string $haystack, string $needle, int $offset, ?int $length = NULL, bool $case_insensitive = false): int {} /** - * Converts a string from ISO-8859-1 to UTF-8 - * @link http://www.php.net/manual/en/function.utf8-encode.php - * @param string $string - * @return string Returns the UTF-8 translation of string. - * @deprecated 1 + * {@inheritdoc} + * @param string $string + * @deprecated */ function utf8_encode (string $string): string {} /** - * Converts a string from UTF-8 to ISO-8859-1, replacing invalid or unrepresentable - * characters - * @link http://www.php.net/manual/en/function.utf8-decode.php - * @param string $string - * @return string Returns the ISO-8859-1 translation of string. - * @deprecated 1 + * {@inheritdoc} + * @param string $string + * @deprecated */ function utf8_decode (string $string): string {} /** - * Open directory handle - * @link http://www.php.net/manual/en/function.opendir.php - * @param string $directory - * @param resource|null $context [optional] - * @return resource|false Returns a directory handle resource on success, - * or false on failure + * {@inheritdoc} + * @param string $directory + * @param mixed $context [optional] */ -function opendir (string $directory, $context = null) {} +function opendir (string $directory, $context = NULL) {} /** - * Return an instance of the Directory class - * @link http://www.php.net/manual/en/function.dir.php - * @param string $directory Directory to open - * @param resource|null $context [optional] >A context stream - * resource. - * @return Directory|false Returns an instance of Directory, or false in case of error. + * {@inheritdoc} + * @param string $directory + * @param mixed $context [optional] */ -function dir (string $directory, $context = null): Directory|false {} +function dir (string $directory, $context = NULL): Directory|false {} /** - * Close directory handle - * @link http://www.php.net/manual/en/function.closedir.php - * @param resource|null $dir_handle [optional] - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $dir_handle [optional] */ -function closedir ($dir_handle = null): void {} +function closedir ($dir_handle = NULL): void {} /** - * Change directory - * @link http://www.php.net/manual/en/function.chdir.php - * @param string $directory - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $directory */ function chdir (string $directory): bool {} /** - * Gets the current working directory - * @link http://www.php.net/manual/en/function.getcwd.php - * @return string|false Returns the current working directory on success, or false on - * failure. - *On some Unix variants, getcwd will return - * false if any one of the parent directories does not have the - * readable or search mode set, even if the current directory - * does. See chmod for more information on - * modes and permissions.
+ * {@inheritdoc} */ function getcwd (): string|false {} /** - * Rewind directory handle - * @link http://www.php.net/manual/en/function.rewinddir.php - * @param resource|null $dir_handle [optional] - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $dir_handle [optional] */ -function rewinddir ($dir_handle = null): void {} +function rewinddir ($dir_handle = NULL): void {} /** - * Read entry from directory handle - * @link http://www.php.net/manual/en/function.readdir.php - * @param resource|null $dir_handle [optional] - * @return string|false Returns the entry name on success or false on failure. + * {@inheritdoc} + * @param mixed $dir_handle [optional] */ -function readdir ($dir_handle = null): string|false {} +function readdir ($dir_handle = NULL): string|false {} /** - * List files and directories inside the specified path - * @link http://www.php.net/manual/en/function.scandir.php - * @param string $directory - * @param int $sorting_order [optional] - * @param resource|null $context [optional] - * @return array|false Returns an array of filenames on success, or false on - * failure. If directory is not a directory, then - * boolean false is returned, and an error of level - * E_WARNING is generated. + * {@inheritdoc} + * @param string $directory + * @param int $sorting_order [optional] + * @param mixed $context [optional] */ -function scandir (string $directory, int $sorting_order = SCANDIR_SORT_ASCENDING, $context = null): array|false {} +function scandir (string $directory, int $sorting_order = 0, $context = NULL): array|false {} /** - * Find pathnames matching a pattern - * @link http://www.php.net/manual/en/function.glob.php - * @param string $pattern - * @param int $flags [optional] - * @return array|false Returns an array containing the matched files/directories, an empty array - * if no file matched or false on error. - *On some systems it is impossible to distinguish between empty match and an - * error.
+ * {@inheritdoc} + * @param string $pattern + * @param int $flags [optional] */ -function glob (string $pattern, int $flags = null): array|false {} +function glob (string $pattern, int $flags = 0): array|false {} /** - * Execute an external program - * @link http://www.php.net/manual/en/function.exec.php - * @param string $command - * @param array $output [optional] - * @param int $result_code [optional] - * @return string|false The last line from the result of the command. If you need to execute a - * command and have all the data from the command passed directly back without - * any interference, use the passthru function. - *Returns false on failure.
- *To get the output of the executed command, be sure to set and use the - * output parameter.
+ * {@inheritdoc} + * @param string $command + * @param mixed $output [optional] + * @param mixed $result_code [optional] */ -function exec (string $command, array &$output = null, int &$result_code = null): string|false {} +function exec (string $command, &$output = NULL, &$result_code = NULL): string|false {} /** - * Execute an external program and display the output - * @link http://www.php.net/manual/en/function.system.php - * @param string $command - * @param int $result_code [optional] - * @return string|false Returns the last line of the command output on success, and false - * on failure. + * {@inheritdoc} + * @param string $command + * @param mixed $result_code [optional] */ -function system (string $command, int &$result_code = null): string|false {} +function system (string $command, &$result_code = NULL): string|false {} /** - * Execute an external program and display raw output - * @link http://www.php.net/manual/en/function.passthru.php - * @param string $command - * @param int $result_code [optional] - * @return false|null Returns null on success or false on failure. + * {@inheritdoc} + * @param string $command + * @param mixed $result_code [optional] */ -function passthru (string $command, int &$result_code = null): ?false {} +function passthru (string $command, &$result_code = NULL): ?false {} /** - * Escape shell metacharacters - * @link http://www.php.net/manual/en/function.escapeshellcmd.php - * @param string $command - * @return string The escaped string. + * {@inheritdoc} + * @param string $command */ function escapeshellcmd (string $command): string {} /** - * Escape a string to be used as a shell argument - * @link http://www.php.net/manual/en/function.escapeshellarg.php - * @param string $arg - * @return string The escaped string. + * {@inheritdoc} + * @param string $arg */ function escapeshellarg (string $arg): string {} /** - * Execute command via shell and return the complete output as a string - * @link http://www.php.net/manual/en/function.shell-exec.php - * @param string $command - * @return string|false|null A string containing the output from the executed command, false if the pipe - * cannot be established or null if an error occurs or the command produces no output. - *This function can return null both when an error occurs or the program - * produces no output. It is not possible to detect execution failures using - * this function. exec should be used when access to the - * program exit code is required.
+ * {@inheritdoc} + * @param string $command */ function shell_exec (string $command): string|false|null {} /** - * Change the priority of the current process - * @link http://www.php.net/manual/en/function.proc-nice.php - * @param int $priority - * @return bool Returns true on success or false on failure. - * If an error occurs, like the user lacks permission to change the priority, - * an error of level E_WARNING is also generated. + * {@inheritdoc} + * @param int $priority */ function proc_nice (int $priority): bool {} /** - * Portable advisory file locking - * @link http://www.php.net/manual/en/function.flock.php - * @param resource $stream - * @param int $operation - * @param int $would_block [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mixed $stream + * @param int $operation + * @param mixed $would_block [optional] */ -function flock ($stream, int $operation, int &$would_block = null): bool {} +function flock ($stream = null, int $operation, &$would_block = NULL): bool {} /** - * Extracts all meta tag content attributes from a file and returns an array - * @link http://www.php.net/manual/en/function.get-meta-tags.php - * @param string $filename - * @param bool $use_include_path [optional] - * @return array|false Returns an array with all the parsed meta tags. - *The value of the name property becomes the key, the value of the content - * property becomes the value of the returned array, so you can easily use - * standard array functions to traverse it or access single values. - * Special characters in the value of the name property are substituted with - * '_', the rest is converted to lower case. If two meta tags have the same - * name, only the last one is returned.
- *Returns false on failure.
+ * {@inheritdoc} + * @param string $filename + * @param bool $use_include_path [optional] */ function get_meta_tags (string $filename, bool $use_include_path = false): array|false {} /** - * Closes process file pointer - * @link http://www.php.net/manual/en/function.pclose.php - * @param resource $handle - * @return int Returns the termination status of the process that was run. In case of - * an error then -1 is returned. - *If PHP has been compiled with --enable-sigchild, the return value of this function is undefined.
+ * {@inheritdoc} + * @param mixed $handle */ -function pclose ($handle): int {} +function pclose ($handle = null): int {} /** - * Opens process file pointer - * @link http://www.php.net/manual/en/function.popen.php - * @param string $command - * @param string $mode - * @return resource|false Returns a file pointer identical to that returned by - * fopen, except that it is unidirectional (may - * only be used for reading or writing) and must be closed with - * pclose. This pointer may be used with - * fgets, fgetss, and - * fwrite. When the mode is 'r', the returned - * file pointer equals to the STDOUT of the command, when the mode - * is 'w', the returned file pointer equals to the STDIN of the - * command. - *If an error occurs, returns false.
+ * {@inheritdoc} + * @param string $command + * @param string $mode */ function popen (string $command, string $mode) {} /** - * Outputs a file - * @link http://www.php.net/manual/en/function.readfile.php - * @param string $filename - * @param bool $use_include_path [optional] - * @param resource|null $context [optional] - * @return int|false Returns the number of bytes read from the file on success, - * or false on failure + * {@inheritdoc} + * @param string $filename + * @param bool $use_include_path [optional] + * @param mixed $context [optional] */ -function readfile (string $filename, bool $use_include_path = false, $context = null): int|false {} +function readfile (string $filename, bool $use_include_path = false, $context = NULL): int|false {} /** - * Rewind the position of a file pointer - * @link http://www.php.net/manual/en/function.rewind.php - * @param resource $stream - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mixed $stream */ -function rewind ($stream): bool {} +function rewind ($stream = null): bool {} /** - * Removes directory - * @link http://www.php.net/manual/en/function.rmdir.php - * @param string $directory - * @param resource|null $context [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $directory + * @param mixed $context [optional] */ -function rmdir (string $directory, $context = null): bool {} +function rmdir (string $directory, $context = NULL): bool {} /** - * Changes the current umask - * @link http://www.php.net/manual/en/function.umask.php - * @param int|null $mask [optional] - * @return int If mask is null, umask - * simply returns the current umask otherwise the old umask is returned. + * {@inheritdoc} + * @param int|null $mask [optional] */ -function umask (?int $mask = null): int {} +function umask (?int $mask = NULL): int {} /** - * Closes an open file pointer - * @link http://www.php.net/manual/en/function.fclose.php - * @param resource $stream - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mixed $stream */ -function fclose ($stream): bool {} +function fclose ($stream = null): bool {} /** - * Tests for end-of-file on a file pointer - * @link http://www.php.net/manual/en/function.feof.php - * @param resource $stream - * @return bool Returns true if the file pointer is at EOF or an error occurs - * (including socket timeout); otherwise returns false. + * {@inheritdoc} + * @param mixed $stream */ -function feof ($stream): bool {} +function feof ($stream = null): bool {} /** - * Gets character from file pointer - * @link http://www.php.net/manual/en/function.fgetc.php - * @param resource $stream - * @return string|false Returns a string containing a single character read from the file pointed - * to by stream. Returns false on EOF. + * {@inheritdoc} + * @param mixed $stream */ -function fgetc ($stream): string|false {} +function fgetc ($stream = null): string|false {} /** - * Gets line from file pointer - * @link http://www.php.net/manual/en/function.fgets.php - * @param resource $stream - * @param int|null $length [optional] - * @return string|false Returns a string of up to length - 1 bytes read from - * the file pointed to by stream. If there is no more data - * to read in the file pointer, then false is returned. - *If an error occurs, false is returned.
+ * {@inheritdoc} + * @param mixed $stream + * @param int|null $length [optional] */ -function fgets ($stream, ?int $length = null): string|false {} +function fgets ($stream = null, ?int $length = NULL): string|false {} /** - * Binary-safe file read - * @link http://www.php.net/manual/en/function.fread.php - * @param resource $stream - * @param int $length - * @return string|false Returns the read string or false on failure. + * {@inheritdoc} + * @param mixed $stream + * @param int $length */ -function fread ($stream, int $length): string|false {} +function fread ($stream = null, int $length): string|false {} /** - * Opens file or URL - * @link http://www.php.net/manual/en/function.fopen.php - * @param string $filename - * @param string $mode - * @param bool $use_include_path [optional] - * @param resource|null $context [optional] - * @return resource|false Returns a file pointer resource on success, - * or false on failure + * {@inheritdoc} + * @param string $filename + * @param string $mode + * @param bool $use_include_path [optional] + * @param mixed $context [optional] */ -function fopen (string $filename, string $mode, bool $use_include_path = false, $context = null) {} +function fopen (string $filename, string $mode, bool $use_include_path = false, $context = NULL) {} /** - * Parses input from a file according to a format - * @link http://www.php.net/manual/en/function.fscanf.php - * @param resource $stream - * @param string $format - * @param mixed $vars - * @return array|int|false|null If only two parameters were passed to this function, the values parsed will be - * returned as an array. Otherwise, if optional parameters are passed, the - * function will return the number of assigned values. The optional - * parameters must be passed by reference. - *If there are more substrings expected in the format - * than there are available within string, - * null will be returned. On other errors, false will be returned.
+ * {@inheritdoc} + * @param mixed $stream + * @param string $format + * @param mixed $vars [optional] */ -function fscanf ($stream, string $format, mixed &...$vars): array|int|false|null {} +function fscanf ($stream = null, string $format, mixed &...$vars): array|int|false|null {} /** - * Output all remaining data on a file pointer - * @link http://www.php.net/manual/en/function.fpassthru.php - * @param resource $stream - * @return int Returns the number of characters read from stream - * and passed through to the output. + * {@inheritdoc} + * @param mixed $stream */ -function fpassthru ($stream): int {} +function fpassthru ($stream = null): int {} /** - * Truncates a file to a given length - * @link http://www.php.net/manual/en/function.ftruncate.php - * @param resource $stream - * @param int $size - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mixed $stream + * @param int $size */ -function ftruncate ($stream, int $size): bool {} +function ftruncate ($stream = null, int $size): bool {} /** - * Gets information about a file using an open file pointer - * @link http://www.php.net/manual/en/function.fstat.php - * @param resource $stream - * @return array|false Returns an array with the statistics of the file; the format of the array - * is described in detail on the stat manual page. - * Returns false on failure. + * {@inheritdoc} + * @param mixed $stream */ -function fstat ($stream): array|false {} +function fstat ($stream = null): array|false {} /** - * Seeks on a file pointer - * @link http://www.php.net/manual/en/function.fseek.php - * @param resource $stream - * @param int $offset - * @param int $whence [optional] - * @return int Upon success, returns 0; otherwise, returns -1. + * {@inheritdoc} + * @param mixed $stream + * @param int $offset + * @param int $whence [optional] */ -function fseek ($stream, int $offset, int $whence = SEEK_SET): int {} +function fseek ($stream = null, int $offset, int $whence = 0): int {} /** - * Returns the current position of the file read/write pointer - * @link http://www.php.net/manual/en/function.ftell.php - * @param resource $stream - * @return int|false Returns the position of the file pointer referenced by - * stream as an integer; i.e., its offset into the file stream. - *If an error occurs, returns false.
+ * {@inheritdoc} + * @param mixed $stream */ -function ftell ($stream): int|false {} +function ftell ($stream = null): int|false {} /** - * Flushes the output to a file - * @link http://www.php.net/manual/en/function.fflush.php - * @param resource $stream - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mixed $stream */ -function fflush ($stream): bool {} +function fflush ($stream = null): bool {} /** - * Synchronizes changes to the file (including meta-data) - * @link http://www.php.net/manual/en/function.fsync.php - * @param resource $stream - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mixed $stream */ -function fsync ($stream): bool {} +function fsync ($stream = null): bool {} /** - * Synchronizes data (but not meta-data) to the file - * @link http://www.php.net/manual/en/function.fdatasync.php - * @param resource $stream - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mixed $stream */ -function fdatasync ($stream): bool {} +function fdatasync ($stream = null): bool {} /** - * Binary-safe file write - * @link http://www.php.net/manual/en/function.fwrite.php - * @param resource $stream - * @param string $data - * @param int|null $length [optional] - * @return int|false fwrite returns the number of bytes - * written, or false on failure. + * {@inheritdoc} + * @param mixed $stream + * @param string $data + * @param int|null $length [optional] */ -function fwrite ($stream, string $data, ?int $length = null): int|false {} +function fwrite ($stream = null, string $data, ?int $length = NULL): int|false {} /** - * Alias of fwrite - * @link http://www.php.net/manual/en/function.fputs.php - * @param resource $stream - * @param string $data - * @param int|null $length [optional] - * @return int|false fwrite returns the number of bytes - * written, or false on failure. + * {@inheritdoc} + * @param mixed $stream + * @param string $data + * @param int|null $length [optional] */ -function fputs ($stream, string $data, ?int $length = null): int|false {} +function fputs ($stream = null, string $data, ?int $length = NULL): int|false {} /** - * Makes directory - * @link http://www.php.net/manual/en/function.mkdir.php - * @param string $directory - * @param int $permissions [optional] - * @param bool $recursive [optional] - * @param resource|null $context [optional] - * @return bool Returns true on success or false on failure. - *If the directory to be created already exists, that is considered an error - * and false will still be returned. Use is_dir or - * file_exists to check if the directory already exists - * before trying to create it.
+ * {@inheritdoc} + * @param string $directory + * @param int $permissions [optional] + * @param bool $recursive [optional] + * @param mixed $context [optional] */ -function mkdir (string $directory, int $permissions = 0777, bool $recursive = false, $context = null): bool {} +function mkdir (string $directory, int $permissions = 511, bool $recursive = false, $context = NULL): bool {} /** - * Renames a file or directory - * @link http://www.php.net/manual/en/function.rename.php - * @param string $from - * @param string $to - * @param resource|null $context [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $from + * @param string $to + * @param mixed $context [optional] */ -function rename (string $from, string $to, $context = null): bool {} +function rename (string $from, string $to, $context = NULL): bool {} /** - * Copies file - * @link http://www.php.net/manual/en/function.copy.php - * @param string $from - * @param string $to - * @param resource|null $context [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $from + * @param string $to + * @param mixed $context [optional] */ -function copy (string $from, string $to, $context = null): bool {} +function copy (string $from, string $to, $context = NULL): bool {} /** - * Create file with unique file name - * @link http://www.php.net/manual/en/function.tempnam.php - * @param string $directory - * @param string $prefix - * @return string|false Returns the new temporary filename (with path), or false on - * failure. + * {@inheritdoc} + * @param string $directory + * @param string $prefix */ function tempnam (string $directory, string $prefix): string|false {} /** - * Creates a temporary file - * @link http://www.php.net/manual/en/function.tmpfile.php - * @return resource|false Returns a file handle, similar to the one returned by - * fopen, for the new file or false on failure. + * {@inheritdoc} */ function tmpfile () {} /** - * Reads entire file into an array - * @link http://www.php.net/manual/en/function.file.php - * @param string $filename - * @param int $flags [optional] - * @param resource|null $context [optional] - * @return array|false Returns the file in an array. Each element of the array corresponds to a - * line in the file, with the newline still attached. Upon failure, - * file returns false. - *Each line in the resulting array will include the line ending, unless - * FILE_IGNORE_NEW_LINES is used.
- */ -function file (string $filename, int $flags = null, $context = null): array|false {} - -/** - * Reads entire file into a string - * @link http://www.php.net/manual/en/function.file-get-contents.php - * @param string $filename - * @param bool $use_include_path [optional] - * @param resource|null $context [optional] - * @param int $offset [optional] - * @param int|null $length [optional] - * @return string|false The function returns the read data or false on failure. - */ -function file_get_contents (string $filename, bool $use_include_path = false, $context = null, int $offset = null, ?int $length = null): string|false {} - -/** - * Deletes a file - * @link http://www.php.net/manual/en/function.unlink.php - * @param string $filename - * @param resource|null $context [optional] - * @return bool Returns true on success or false on failure. - */ -function unlink (string $filename, $context = null): bool {} - -/** - * Write data to a file - * @link http://www.php.net/manual/en/function.file-put-contents.php - * @param string $filename - * @param mixed $data - * @param int $flags [optional] - * @param resource|null $context [optional] - * @return int|false This function returns the number of bytes that were written to the file, or - * false on failure. - */ -function file_put_contents (string $filename, mixed $data, int $flags = null, $context = null): int|false {} - -/** - * Format line as CSV and write to file pointer - * @link http://www.php.net/manual/en/function.fputcsv.php - * @param resource $stream - * @param array $fields - * @param string $separator [optional] - * @param string $enclosure [optional] - * @param string $escape [optional] - * @param string $eol [optional] - * @return int|false Returns the length of the written string or false on failure. - */ -function fputcsv ($stream, array $fields, string $separator = '","', string $enclosure = '"\\""', string $escape = '"\\\\"', string $eol = '"\\n"'): int|false {} - -/** - * Gets line from file pointer and parse for CSV fields - * @link http://www.php.net/manual/en/function.fgetcsv.php - * @param resource $stream - * @param int|null $length [optional] - * @param string $separator [optional] - * @param string $enclosure [optional] - * @param string $escape [optional] - * @return array|false Returns an indexed array containing the fields read on success, or false on failure. - *A blank line in a CSV file will be returned as an array - * comprising a single null field, and will not be treated - * as an error.
- */ -function fgetcsv ($stream, ?int $length = null, string $separator = '","', string $enclosure = '"\\""', string $escape = '"\\\\"'): array|false {} - -/** - * Returns canonicalized absolute pathname - * @link http://www.php.net/manual/en/function.realpath.php - * @param string $path - * @return string|false Returns the canonicalized absolute pathname on success. The resulting path - * will have no symbolic link, /./ or /../ components. Trailing delimiters, - * such as \ and /, are also removed. - *realpath returns false on failure, e.g. if - * the file does not exist.
- *The running script must have executable permissions on all directories in - * the hierarchy, otherwise realpath will return - * false.
- *For case-insensitive filesystems realpath may or may - * not normalize the character case.
- *The function realpath will not work for a file which - * is inside a Phar as such path would be a virtual path, not a real one.
- *On Windows, junctions and symbolic links to directories are only expanded by - * one level.
+ * {@inheritdoc} + * @param string $filename + * @param int $flags [optional] + * @param mixed $context [optional] + */ +function file (string $filename, int $flags = 0, $context = NULL): array|false {} + +/** + * {@inheritdoc} + * @param string $filename + * @param bool $use_include_path [optional] + * @param mixed $context [optional] + * @param int $offset [optional] + * @param int|null $length [optional] + */ +function file_get_contents (string $filename, bool $use_include_path = false, $context = NULL, int $offset = 0, ?int $length = NULL): string|false {} + +/** + * {@inheritdoc} + * @param string $filename + * @param mixed $context [optional] + */ +function unlink (string $filename, $context = NULL): bool {} + +/** + * {@inheritdoc} + * @param string $filename + * @param mixed $data + * @param int $flags [optional] + * @param mixed $context [optional] + */ +function file_put_contents (string $filename, mixed $data = null, int $flags = 0, $context = NULL): int|false {} + +/** + * {@inheritdoc} + * @param mixed $stream + * @param array $fields + * @param string $separator [optional] + * @param string $enclosure [optional] + * @param string $escape [optional] + * @param string $eol [optional] + */ +function fputcsv ($stream = null, array $fields, string $separator = ',', string $enclosure = '"', string $escape = '\\', string $eol = ' +'): int|false {} + +/** + * {@inheritdoc} + * @param mixed $stream + * @param int|null $length [optional] + * @param string $separator [optional] + * @param string $enclosure [optional] + * @param string $escape [optional] + */ +function fgetcsv ($stream = null, ?int $length = NULL, string $separator = ',', string $enclosure = '"', string $escape = '\\'): array|false {} + +/** + * {@inheritdoc} + * @param string $path */ function realpath (string $path): string|false {} /** - * Match filename against a pattern - * @link http://www.php.net/manual/en/function.fnmatch.php - * @param string $pattern - * @param string $filename - * @param int $flags [optional] - * @return bool Returns true if there is a match, false otherwise. + * {@inheritdoc} + * @param string $pattern + * @param string $filename + * @param int $flags [optional] */ -function fnmatch (string $pattern, string $filename, int $flags = null): bool {} +function fnmatch (string $pattern, string $filename, int $flags = 0): bool {} /** - * Returns directory path used for temporary files - * @link http://www.php.net/manual/en/function.sys-get-temp-dir.php - * @return string Returns the path of the temporary directory. + * {@inheritdoc} */ function sys_get_temp_dir (): string {} /** - * Gets last access time of file - * @link http://www.php.net/manual/en/function.fileatime.php - * @param string $filename - * @return int|false Returns the time the file was last accessed, or false on failure. - * The time is returned as a Unix timestamp. + * {@inheritdoc} + * @param string $filename */ function fileatime (string $filename): int|false {} /** - * Gets inode change time of file - * @link http://www.php.net/manual/en/function.filectime.php - * @param string $filename - * @return int|false Returns the time the file was last changed, or false on failure. - * The time is returned as a Unix timestamp. + * {@inheritdoc} + * @param string $filename */ function filectime (string $filename): int|false {} /** - * Gets file group - * @link http://www.php.net/manual/en/function.filegroup.php - * @param string $filename - * @return int|false Returns the group ID of the file, or false if - * an error occurs. The group ID is returned in numerical format, use - * posix_getgrgid to resolve it to a group name. - * Upon failure, false is returned. + * {@inheritdoc} + * @param string $filename */ function filegroup (string $filename): int|false {} /** - * Gets file inode - * @link http://www.php.net/manual/en/function.fileinode.php - * @param string $filename - * @return int|false Returns the inode number of the file, or false on failure. + * {@inheritdoc} + * @param string $filename */ function fileinode (string $filename): int|false {} /** - * Gets file modification time - * @link http://www.php.net/manual/en/function.filemtime.php - * @param string $filename - * @return int|false Returns the time the file was last modified, or false on failure. - * The time is returned as a Unix timestamp, which is - * suitable for the date function. + * {@inheritdoc} + * @param string $filename */ function filemtime (string $filename): int|false {} /** - * Gets file owner - * @link http://www.php.net/manual/en/function.fileowner.php - * @param string $filename - * @return int|false Returns the user ID of the owner of the file, or false on failure. - * The user ID is returned in numerical format, use - * posix_getpwuid to resolve it to a username. + * {@inheritdoc} + * @param string $filename */ function fileowner (string $filename): int|false {} /** - * Gets file permissions - * @link http://www.php.net/manual/en/function.fileperms.php - * @param string $filename - * @return int|false Returns the file's permissions as a numeric mode. Lower bits of this mode - * are the same as the permissions expected by chmod, - * however on most platforms the return value will also include information on - * the type of file given as filename. The examples - * below demonstrate how to test the return value for specific permissions and - * file types on POSIX systems, including Linux and macOS. - *For local files, the specific return value is that of the - * st_mode member of the structure returned by the C - * library's stat function. Exactly which bits are set - * can vary from platform to platform, and looking up your specific platform's - * documentation is recommended if parsing the non-permission bits of the - * return value is required.
- *Returns false on failure.
+ * {@inheritdoc} + * @param string $filename */ function fileperms (string $filename): int|false {} /** - * Gets file size - * @link http://www.php.net/manual/en/function.filesize.php - * @param string $filename - * @return int|false Returns the size of the file in bytes, or false (and generates an error - * of level E_WARNING) in case of an error. + * {@inheritdoc} + * @param string $filename */ function filesize (string $filename): int|false {} /** - * Gets file type - * @link http://www.php.net/manual/en/function.filetype.php - * @param string $filename - * @return string|false Returns the type of the file. Possible values are fifo, char, - * dir, block, link, file, socket and unknown. - *Returns false if an error occurs. filetype will also - * produce an E_NOTICE message if the stat call fails - * or if the file type is unknown.
+ * {@inheritdoc} + * @param string $filename */ function filetype (string $filename): string|false {} /** - * Checks whether a file or directory exists - * @link http://www.php.net/manual/en/function.file-exists.php - * @param string $filename - * @return bool Returns true if the file or directory specified by - * filename exists; false otherwise. - *This function will return false for symlinks pointing to non-existing - * files.
- *The check is done using the real UID/GID instead of the effective one.
+ * {@inheritdoc} + * @param string $filename */ function file_exists (string $filename): bool {} /** - * Tells whether the filename is writable - * @link http://www.php.net/manual/en/function.is-writable.php - * @param string $filename - * @return bool Returns true if the filename exists and is - * writable. + * {@inheritdoc} + * @param string $filename */ function is_writable (string $filename): bool {} /** - * Alias of is_writable - * @link http://www.php.net/manual/en/function.is-writeable.php - * @param string $filename - * @return bool Returns true if the filename exists and is - * writable. + * {@inheritdoc} + * @param string $filename */ function is_writeable (string $filename): bool {} /** - * Tells whether a file exists and is readable - * @link http://www.php.net/manual/en/function.is-readable.php - * @param string $filename - * @return bool Returns true if the file or directory specified by - * filename exists and is readable, false otherwise. + * {@inheritdoc} + * @param string $filename */ function is_readable (string $filename): bool {} /** - * Tells whether the filename is executable - * @link http://www.php.net/manual/en/function.is-executable.php - * @param string $filename - * @return bool Returns true if the filename exists and is executable, or false on - * error. On POSIX systems, a file is executable if the executable bit of the - * file permissions is set. For Windows, see the note below. + * {@inheritdoc} + * @param string $filename */ function is_executable (string $filename): bool {} /** - * Tells whether the filename is a regular file - * @link http://www.php.net/manual/en/function.is-file.php - * @param string $filename - * @return bool Returns true if the filename exists and is a regular file, false - * otherwise. + * {@inheritdoc} + * @param string $filename */ function is_file (string $filename): bool {} /** - * Tells whether the filename is a directory - * @link http://www.php.net/manual/en/function.is-dir.php - * @param string $filename - * @return bool Returns true if the filename exists and is a directory, false - * otherwise. + * {@inheritdoc} + * @param string $filename */ function is_dir (string $filename): bool {} /** - * Tells whether the filename is a symbolic link - * @link http://www.php.net/manual/en/function.is-link.php - * @param string $filename - * @return bool Returns true if the filename exists and is a symbolic link, false - * otherwise. + * {@inheritdoc} + * @param string $filename */ function is_link (string $filename): bool {} /** - * Gives information about a file - * @link http://www.php.net/manual/en/function.stat.php - * @param string $filename - * @return array|falseNumeric | - *Associative | - *Description | - *
0 | - *dev | - *device number *** | - *
1 | - *ino | - *inode number **** | - *
2 | - *mode | - *inode protection mode ***** | - *
3 | - *nlink | - *number of links | - *
4 | - *uid | - *userid of owner * | - *
5 | - *gid | - *groupid of owner * | - *
6 | - *rdev | - *device type, if inode device | - *
7 | - *size | - *size in bytes | - *
8 | - *atime | - *time of last access (Unix timestamp) | - *
9 | - *mtime | - *time of last modification (Unix timestamp) | - *
10 | - *ctime | - *time of last inode change (Unix timestamp) | - *
11 | - *blksize | - *blocksize of filesystem IO ** | - *
12 | - *blocks | - *number of 512-byte blocks allocated ** | - *
* On Windows this will always be 0.
- *** Only valid on systems supporting the st_blksize type - other - * systems (e.g. Windows) return -1.
- **** On Windows, as of PHP 7.4.0, this is the serial number of the volume that contains the file, - * which is a 64-bit unsigned integer, so may overflow. - * Previously, it was the numeric representation of the drive letter (e.g. 2 - * for C:) for stat, and 0 for - * lstat.
- ***** On Windows, as of PHP 7.4.0, this is the identifier associated with the file, - * which is a 64-bit unsigned integer, so may overflow. - * Previously, it was always 0.
- ****** On Windows, the writable permission bit is set according to the read-only - * file attribute, and the same value is reported for all users, group and owner. - * The ACL is not taken into account, contrary to is_writable.
- *The value of mode contains information read by several functions. - * When written in octal, starting from the right, the first three digits are returned by - * chmod. The next digit is ignored by PHP. The next two digits indicate - * the file type: - *
mode in octal | - *Meaning | - *
0140000 | - *socket | - *
0120000 | - *link | - *
0100000 | - *regular file | - *
0060000 | - *block device | - *
0040000 | - *directory | - *
0020000 | - *character device | - *
0010000 | - *fifo | - *
In case of error, stat returns false.
+ * {@inheritdoc} + * @param string $filename */ function stat (string $filename): array|false {} /** - * Gives information about a file or symbolic link - * @link http://www.php.net/manual/en/function.lstat.php - * @param string $filename - * @return array|false See the manual page for stat for information on - * the structure of the array that lstat returns. - * This function is identical to the stat function - * except that if the filename parameter is a symbolic - * link, the status of the symbolic link is returned, not the status of the - * file pointed to by the symbolic link. - *On failure, false is returned.
+ * {@inheritdoc} + * @param string $filename */ function lstat (string $filename): array|false {} /** - * Changes file owner - * @link http://www.php.net/manual/en/function.chown.php - * @param string $filename - * @param string|int $user - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $filename + * @param string|int $user */ function chown (string $filename, string|int $user): bool {} /** - * Changes file group - * @link http://www.php.net/manual/en/function.chgrp.php - * @param string $filename - * @param string|int $group - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $filename + * @param string|int $group */ function chgrp (string $filename, string|int $group): bool {} /** - * Changes user ownership of symlink - * @link http://www.php.net/manual/en/function.lchown.php - * @param string $filename - * @param string|int $user - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $filename + * @param string|int $user */ function lchown (string $filename, string|int $user): bool {} /** - * Changes group ownership of symlink - * @link http://www.php.net/manual/en/function.lchgrp.php - * @param string $filename - * @param string|int $group - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $filename + * @param string|int $group */ function lchgrp (string $filename, string|int $group): bool {} /** - * Changes file mode - * @link http://www.php.net/manual/en/function.chmod.php - * @param string $filename - * @param int $permissions - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $filename + * @param int $permissions */ function chmod (string $filename, int $permissions): bool {} /** - * Sets access and modification time of file - * @link http://www.php.net/manual/en/function.touch.php - * @param string $filename - * @param int|null $mtime [optional] - * @param int|null $atime [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $filename + * @param int|null $mtime [optional] + * @param int|null $atime [optional] */ -function touch (string $filename, ?int $mtime = null, ?int $atime = null): bool {} +function touch (string $filename, ?int $mtime = NULL, ?int $atime = NULL): bool {} /** - * Clears file status cache - * @link http://www.php.net/manual/en/function.clearstatcache.php - * @param bool $clear_realpath_cache [optional] - * @param string $filename [optional] - * @return void No value is returned. + * {@inheritdoc} + * @param bool $clear_realpath_cache [optional] + * @param string $filename [optional] */ -function clearstatcache (bool $clear_realpath_cache = false, string $filename = '""'): void {} +function clearstatcache (bool $clear_realpath_cache = false, string $filename = ''): void {} /** - * Returns the total size of a filesystem or disk partition - * @link http://www.php.net/manual/en/function.disk-total-space.php - * @param string $directory - * @return float|false Returns the total number of bytes as a float - * or false on failure. + * {@inheritdoc} + * @param string $directory */ function disk_total_space (string $directory): float|false {} /** - * Returns available space on filesystem or disk partition - * @link http://www.php.net/manual/en/function.disk-free-space.php - * @param string $directory - * @return float|false Returns the number of available bytes as a float - * or false on failure. + * {@inheritdoc} + * @param string $directory */ function disk_free_space (string $directory): float|false {} /** - * Alias of disk_free_space - * @link http://www.php.net/manual/en/function.diskfreespace.php - * @param string $directory - * @return float|false Returns the number of available bytes as a float - * or false on failure. + * {@inheritdoc} + * @param string $directory */ function diskfreespace (string $directory): float|false {} /** - * Get realpath cache entries - * @link http://www.php.net/manual/en/function.realpath-cache-get.php - * @return array Returns an array of realpath cache entries. The keys are original path - * entries, and the values are arrays of data items, containing the resolved - * path, expiration date, and other options kept in the cache. + * {@inheritdoc} */ function realpath_cache_get (): array {} /** - * Get realpath cache size - * @link http://www.php.net/manual/en/function.realpath-cache-size.php - * @return int Returns how much memory realpath cache is using. + * {@inheritdoc} */ function realpath_cache_size (): int {} /** - * Return a formatted string - * @link http://www.php.net/manual/en/function.sprintf.php - * @param string $format - * @param mixed $values - * @return string Returns a string produced according to the formatting string - * format. + * {@inheritdoc} + * @param string $format + * @param mixed $values [optional] */ function sprintf (string $format, mixed ...$values): string {} /** - * Output a formatted string - * @link http://www.php.net/manual/en/function.printf.php - * @param string $format - * @param mixed $values - * @return int Returns the length of the outputted string. + * {@inheritdoc} + * @param string $format + * @param mixed $values [optional] */ function printf (string $format, mixed ...$values): int {} /** - * Output a formatted string - * @link http://www.php.net/manual/en/function.vprintf.php - * @param string $format - * @param array $values - * @return int Returns the length of the outputted string. + * {@inheritdoc} + * @param string $format + * @param array $values */ function vprintf (string $format, array $values): int {} /** - * Return a formatted string - * @link http://www.php.net/manual/en/function.vsprintf.php - * @param string $format - * @param array $values - * @return string Return array values as a formatted string according to - * format. + * {@inheritdoc} + * @param string $format + * @param array $values */ function vsprintf (string $format, array $values): string {} /** - * Write a formatted string to a stream - * @link http://www.php.net/manual/en/function.fprintf.php - * @param resource $stream - * @param string $format - * @param mixed $values - * @return int Returns the length of the string written. - */ -function fprintf ($stream, string $format, mixed ...$values): int {} - -/** - * Write a formatted string to a stream - * @link http://www.php.net/manual/en/function.vfprintf.php - * @param resource $stream - * @param string $format - * @param array $values - * @return int Returns the length of the outputted string. - */ -function vfprintf ($stream, string $format, array $values): int {} - -/** - * Open Internet or Unix domain socket connection - * @link http://www.php.net/manual/en/function.fsockopen.php - * @param string $hostname - * @param int $port [optional] - * @param int $error_code [optional] - * @param string $error_message [optional] - * @param float|null $timeout [optional] - * @return resource|false fsockopen returns a file pointer which may be used - * together with the other file functions (such as - * fgets, fgetss, - * fwrite, fclose, and - * feof). If the call fails, it will return false - */ -function fsockopen (string $hostname, int $port = -1, int &$error_code = null, string &$error_message = null, ?float $timeout = null) {} - -/** - * Open persistent Internet or Unix domain socket connection - * @link http://www.php.net/manual/en/function.pfsockopen.php - * @param string $hostname - * @param int $port [optional] - * @param int $error_code [optional] - * @param string $error_message [optional] - * @param float|null $timeout [optional] - * @return resource|false pfsockopen returns a file pointer which may be used - * together with the other file functions (such as - * fgets, fgetss, - * fwrite, fclose, and - * feof), or false on failure. - */ -function pfsockopen (string $hostname, int $port = -1, int &$error_code = null, string &$error_message = null, ?float $timeout = null) {} - -/** - * Generate URL-encoded query string - * @link http://www.php.net/manual/en/function.http-build-query.php - * @param array|object $data - * @param string $numeric_prefix [optional] - * @param string|null $arg_separator [optional] - * @param int $encoding_type [optional] - * @return string Returns a URL-encoded string. - */ -function http_build_query (array|object $data, string $numeric_prefix = '""', ?string $arg_separator = null, int $encoding_type = PHP_QUERY_RFC1738): string {} - -/** - * Get Mime-Type for image-type returned by getimagesize, - * exif_read_data, exif_thumbnail, exif_imagetype - * @link http://www.php.net/manual/en/function.image-type-to-mime-type.php - * @param int $image_type - * @return string The returned values are as follows - *image_type | - *Returned value | - *
IMAGETYPE_GIF | - *image/gif | - *
IMAGETYPE_JPEG | - *image/jpeg | - *
IMAGETYPE_PNG | - *image/png | - *
IMAGETYPE_SWF | - *application/x-shockwave-flash | - *
IMAGETYPE_PSD | - *image/psd | - *
IMAGETYPE_BMP | - *image/bmp | - *
IMAGETYPE_TIFF_II (intel byte order) | - *image/tiff | - *
- * IMAGETYPE_TIFF_MM (motorola byte order) - * | - *image/tiff | - *
IMAGETYPE_JPC | - *application/octet-stream | - *
IMAGETYPE_JP2 | - *image/jp2 | - *
IMAGETYPE_JPX | - *application/octet-stream | - *
IMAGETYPE_JB2 | - *application/octet-stream | - *
IMAGETYPE_SWC | - *application/x-shockwave-flash | - *
IMAGETYPE_IFF | - *image/iff | - *
IMAGETYPE_WBMP | - *image/vnd.wap.wbmp | - *
IMAGETYPE_XBM | - *image/xbm | - *
IMAGETYPE_ICO | - *image/vnd.microsoft.icon | - *
IMAGETYPE_WEBP | - *image/webp | - *
Index 0 and 1 contains respectively the width and the height of the image.
- *Some formats may contain no image or may contain multiple images. In these - * cases, getimagesize might not be able to properly - * determine the image size. getimagesize will return - * zero for width and height in these cases.
- *Index 2 is one of the IMAGETYPE_XXX constants indicating - * the type of the image.
- *Index 3 is a text string with the correct - * height="yyy" width="xxx" string that can be used - * directly in an IMG tag.
- *mime is the correspondant MIME type of the image. - * This information can be used to deliver images with the correct HTTP - * Content-type header: - * getimagesize and MIME types - *
- * <?php
- * $size = getimagesize($filename);
- * $fp = fopen($filename, "rb");
- * if ($size && $fp) {
- * header("Content-type: {$size['mime']}");
- * fpassthru($fp);
- * exit;
- * } else {
- * // error
- * }
- * ?>
- *
- * channels will be 3 for RGB pictures and 4 for CMYK - * pictures.
- *bits is the number of bits for each color.
- *For some image types, the presence of channels and - * bits values can be a bit - * confusing. As an example, GIF always uses 3 channels - * per pixel, but the number of bits per pixel cannot be calculated for an - * animated GIF with a global color table.
- *On failure, false is returned.
- */ -function getimagesize (string $filename, array &$image_info = null): array|false {} - -/** - * Get the size of an image from a string - * @link http://www.php.net/manual/en/function.getimagesizefromstring.php - * @param string $string The image data, as a string. - * @param array $image_info [optional] See getimagesize. - * @return array|false See getimagesize. - */ -function getimagesizefromstring (string $string, array &$image_info = null): array|false {} - -/** - * Outputs information about PHP's configuration - * @link http://www.php.net/manual/en/function.phpinfo.php - * @param int $flags [optional] - * @return true Always returns true. - */ -function phpinfo (int $flags = INFO_ALL): true {} - -/** - * Gets the current PHP version - * @link http://www.php.net/manual/en/function.phpversion.php - * @param string|null $extension [optional] - * @return string|false Returns the current PHP version as a string. - * If a string argument is provided for - * extension parameter, phpversion - * returns the version of that extension, or false if there is no version - * information associated or the extension isn't enabled. - */ -function phpversion (?string $extension = null): string|false {} - -/** - * Prints out the credits for PHP - * @link http://www.php.net/manual/en/function.phpcredits.php - * @param int $flags [optional] - * @return true Always returns true. - */ -function phpcredits (int $flags = CREDITS_ALL): true {} - -/** - * Returns the type of interface between web server and PHP - * @link http://www.php.net/manual/en/function.php-sapi-name.php - * @return string|false Returns the interface type, as a lowercase string, or false on failure. - *Although not exhaustive, the possible return values include - * apache, - * apache2handler, - * cgi (until PHP 5.3), - * cgi-fcgi, cli, cli-server, - * embed, fpm-fcgi, - * litespeed, - * phpdbg.
+ * {@inheritdoc} + * @param string $hostname + * @param int $port [optional] + * @param mixed $error_code [optional] + * @param mixed $error_message [optional] + * @param float|null $timeout [optional] */ -function php_sapi_name (): string|false {} +function fsockopen (string $hostname, int $port = -1, &$error_code = NULL, &$error_message = NULL, ?float $timeout = NULL) {} /** - * Returns information about the operating system PHP is running on - * @link http://www.php.net/manual/en/function.php-uname.php - * @param string $mode [optional] - * @return string Returns the description, as a string. + * {@inheritdoc} + * @param string $hostname + * @param int $port [optional] + * @param mixed $error_code [optional] + * @param mixed $error_message [optional] + * @param float|null $timeout [optional] */ -function php_uname (string $mode = '"a"'): string {} +function pfsockopen (string $hostname, int $port = -1, &$error_code = NULL, &$error_message = NULL, ?float $timeout = NULL) {} /** - * Return a list of .ini files parsed from the additional ini dir - * @link http://www.php.net/manual/en/function.php-ini-scanned-files.php - * @return string|false Returns a comma-separated string of .ini files on success. Each comma is - * followed by a newline. If the configure directive --with-config-file-scan-dir wasn't set and the - * PHP_INI_SCAN_DIR environment variable isn't set, false - * is returned. If it was set and the directory was empty, an empty string is - * returned. If a file is unrecognizable, the file will still make it into - * the returned string but a PHP error will also result. This PHP error will - * be seen both at compile time and while using - * php_ini_scanned_files. + * {@inheritdoc} + * @param object|array $data + * @param string $numeric_prefix [optional] + * @param string|null $arg_separator [optional] + * @param int $encoding_type [optional] */ -function php_ini_scanned_files (): string|false {} +function http_build_query (object|array $data, string $numeric_prefix = '', ?string $arg_separator = NULL, int $encoding_type = 1): string {} /** - * Retrieve a path to the loaded php.ini file - * @link http://www.php.net/manual/en/function.php-ini-loaded-file.php - * @return string|false The loaded php.ini path, or false if one is not loaded. + * {@inheritdoc} + * @param int $image_type + */ +function image_type_to_mime_type (int $image_type): string {} + +/** + * {@inheritdoc} + * @param int $image_type + * @param bool $include_dot [optional] + */ +function image_type_to_extension (int $image_type, bool $include_dot = true): string|false {} + +/** + * {@inheritdoc} + * @param string $filename + * @param mixed $image_info [optional] + */ +function getimagesize (string $filename, &$image_info = NULL): array|false {} + +/** + * {@inheritdoc} + * @param string $string + * @param mixed $image_info [optional] + */ +function getimagesizefromstring (string $string, &$image_info = NULL): array|false {} + +/** + * {@inheritdoc} + * @param int $flags [optional] + */ +function phpinfo (int $flags = 4294967295): true {} + +/** + * {@inheritdoc} + * @param string|null $extension [optional] + */ +function phpversion (?string $extension = NULL): string|false {} + +/** + * {@inheritdoc} + * @param int $flags [optional] + */ +function phpcredits (int $flags = 4294967295): true {} + +/** + * {@inheritdoc} + */ +function php_sapi_name (): string|false {} + +/** + * {@inheritdoc} + * @param string $mode [optional] + */ +function php_uname (string $mode = 'a'): string {} + +/** + * {@inheritdoc} + */ +function php_ini_scanned_files (): string|false {} + +/** + * {@inheritdoc} */ function php_ini_loaded_file (): string|false {} /** - * Embeds binary IPTC data into a JPEG image - * @link http://www.php.net/manual/en/function.iptcembed.php - * @param string $iptc_data - * @param string $filename - * @param int $spool [optional] - * @return string|bool If spool is less than 2, the JPEG will be returned, - * or false on failure. Otherwise returns true on success - * or false on failure. + * {@inheritdoc} + * @param string $iptc_data + * @param string $filename + * @param int $spool [optional] */ -function iptcembed (string $iptc_data, string $filename, int $spool = null): string|bool {} +function iptcembed (string $iptc_data, string $filename, int $spool = 0): string|bool {} /** - * Parse a binary IPTC block into single tags - * @link http://www.php.net/manual/en/function.iptcparse.php - * @param string $iptc_block - * @return array|false Returns an array using the tagmarker as an index and the value as the - * value. It returns false on error or if no IPTC data was found. + * {@inheritdoc} + * @param string $iptc_block */ function iptcparse (string $iptc_block): array|false {} /** - * Calculate Levenshtein distance between two strings - * @link http://www.php.net/manual/en/function.levenshtein.php - * @param string $string1 - * @param string $string2 - * @param int $insertion_cost [optional] - * @param int $replacement_cost [optional] - * @param int $deletion_cost [optional] - * @return int This function returns the Levenshtein-Distance between the - * two argument strings. + * {@inheritdoc} + * @param string $string1 + * @param string $string2 + * @param int $insertion_cost [optional] + * @param int $replacement_cost [optional] + * @param int $deletion_cost [optional] */ function levenshtein (string $string1, string $string2, int $insertion_cost = 1, int $replacement_cost = 1, int $deletion_cost = 1): int {} /** - * Returns the target of a symbolic link - * @link http://www.php.net/manual/en/function.readlink.php - * @param string $path - * @return string|false Returns the contents of the symbolic link path or false on error. + * {@inheritdoc} + * @param string $path */ function readlink (string $path): string|false {} /** - * Gets information about a link - * @link http://www.php.net/manual/en/function.linkinfo.php - * @param string $path - * @return int|false linkinfo returns the st_dev field - * of the Unix C stat structure returned by the lstat - * system call. Returns a non-negative integer on success, -1 in case the link was not found, - * or false if an open.base_dir violation occurs. + * {@inheritdoc} + * @param string $path */ function linkinfo (string $path): int|false {} /** - * Creates a symbolic link - * @link http://www.php.net/manual/en/function.symlink.php - * @param string $target - * @param string $link - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $target + * @param string $link */ function symlink (string $target, string $link): bool {} /** - * Create a hard link - * @link http://www.php.net/manual/en/function.link.php - * @param string $target - * @param string $link - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $target + * @param string $link */ function link (string $target, string $link): bool {} /** - * Send mail - * @link http://www.php.net/manual/en/function.mail.php - * @param string $to - * @param string $subject - * @param string $message - * @param array|string $additional_headers [optional] - * @param string $additional_params [optional] - * @return bool Returns true if the mail was successfully accepted for delivery, false otherwise. - *It is important to note that just because the mail was accepted for delivery, - * it does NOT mean the mail will actually reach the intended destination.
+ * {@inheritdoc} + * @param string $to + * @param string $subject + * @param string $message + * @param array|string $additional_headers [optional] + * @param string $additional_params [optional] */ -function mail (string $to, string $subject, string $message, array|string $additional_headers = '[]', string $additional_params = '""'): bool {} +function mail (string $to, string $subject, string $message, array|string $additional_headers = array ( +), string $additional_params = ''): bool {} /** - * Absolute value - * @link http://www.php.net/manual/en/function.abs.php - * @param int|float $num - * @return int|float The absolute value of num. If the - * argument num is - * of type float, the return type is also float, - * otherwise it is int (as float usually has a - * bigger value range than int). + * {@inheritdoc} + * @param int|float $num */ function abs (int|float $num): int|float {} /** - * Round fractions up - * @link http://www.php.net/manual/en/function.ceil.php - * @param int|float $num - * @return float num rounded up to the next highest - * integer. - * The return value of ceil is still of type - * float as the value range of float is - * usually bigger than that of int. + * {@inheritdoc} + * @param int|float $num */ function ceil (int|float $num): float {} /** - * Round fractions down - * @link http://www.php.net/manual/en/function.floor.php - * @param int|float $num - * @return float num rounded to the next lowest integer. - * The return value of floor is still of type - * float. - * This function returns false in case of an error (e.g. passing an array). + * {@inheritdoc} + * @param int|float $num */ function floor (int|float $num): float {} /** - * Rounds a float - * @link http://www.php.net/manual/en/function.round.php - * @param int|float $num - * @param int $precision [optional] - * @param int $mode [optional] - * @return float The value rounded to the given precision as a float. + * {@inheritdoc} + * @param int|float $num + * @param int $precision [optional] + * @param int $mode [optional] */ -function round (int|float $num, int $precision = null, int $mode = PHP_ROUND_HALF_UP): float {} +function round (int|float $num, int $precision = 0, int $mode = 1): float {} /** - * Sine - * @link http://www.php.net/manual/en/function.sin.php - * @param float $num - * @return float The sine of num + * {@inheritdoc} + * @param float $num */ function sin (float $num): float {} /** - * Cosine - * @link http://www.php.net/manual/en/function.cos.php - * @param float $num - * @return float The cosine of num + * {@inheritdoc} + * @param float $num */ function cos (float $num): float {} /** - * Tangent - * @link http://www.php.net/manual/en/function.tan.php - * @param float $num - * @return float The tangent of num + * {@inheritdoc} + * @param float $num */ function tan (float $num): float {} /** - * Arc sine - * @link http://www.php.net/manual/en/function.asin.php - * @param float $num - * @return float The arc sine of num in radians + * {@inheritdoc} + * @param float $num */ function asin (float $num): float {} /** - * Arc cosine - * @link http://www.php.net/manual/en/function.acos.php - * @param float $num - * @return float The arc cosine of num in radians. + * {@inheritdoc} + * @param float $num */ function acos (float $num): float {} /** - * Arc tangent - * @link http://www.php.net/manual/en/function.atan.php - * @param float $num - * @return float The arc tangent of num in radians. + * {@inheritdoc} + * @param float $num */ function atan (float $num): float {} /** - * Inverse hyperbolic tangent - * @link http://www.php.net/manual/en/function.atanh.php - * @param float $num - * @return float Inverse hyperbolic tangent of num + * {@inheritdoc} + * @param float $num */ function atanh (float $num): float {} /** - * Arc tangent of two variables - * @link http://www.php.net/manual/en/function.atan2.php - * @param float $y - * @param float $x - * @return float The arc tangent of y/x - * in radians. + * {@inheritdoc} + * @param float $y + * @param float $x */ function atan2 (float $y, float $x): float {} /** - * Hyperbolic sine - * @link http://www.php.net/manual/en/function.sinh.php - * @param float $num - * @return float The hyperbolic sine of num + * {@inheritdoc} + * @param float $num */ function sinh (float $num): float {} /** - * Hyperbolic cosine - * @link http://www.php.net/manual/en/function.cosh.php - * @param float $num - * @return float The hyperbolic cosine of num + * {@inheritdoc} + * @param float $num */ function cosh (float $num): float {} /** - * Hyperbolic tangent - * @link http://www.php.net/manual/en/function.tanh.php - * @param float $num - * @return float The hyperbolic tangent of num + * {@inheritdoc} + * @param float $num */ function tanh (float $num): float {} /** - * Inverse hyperbolic sine - * @link http://www.php.net/manual/en/function.asinh.php - * @param float $num - * @return float The inverse hyperbolic sine of num + * {@inheritdoc} + * @param float $num */ function asinh (float $num): float {} /** - * Inverse hyperbolic cosine - * @link http://www.php.net/manual/en/function.acosh.php - * @param float $num - * @return float The inverse hyperbolic cosine of num + * {@inheritdoc} + * @param float $num */ function acosh (float $num): float {} /** - * Returns exp(number) - 1, computed in a way that is accurate even - * when the value of number is close to zero - * @link http://www.php.net/manual/en/function.expm1.php - * @param float $num - * @return float 'e' to the power of num minus one + * {@inheritdoc} + * @param float $num */ function expm1 (float $num): float {} /** - * Returns log(1 + number), computed in a way that is accurate even when - * the value of number is close to zero - * @link http://www.php.net/manual/en/function.log1p.php - * @param float $num - * @return float log(1 + num) + * {@inheritdoc} + * @param float $num */ function log1p (float $num): float {} /** - * Get value of pi - * @link http://www.php.net/manual/en/function.pi.php - * @return float The value of pi as float. + * {@inheritdoc} */ function pi (): float {} /** - * Finds whether a value is a legal finite number - * @link http://www.php.net/manual/en/function.is-finite.php - * @param float $num - * @return bool true if num is a legal finite - * number within the allowed range for a PHP float on this platform, - * else false. + * {@inheritdoc} + * @param float $num */ function is_finite (float $num): bool {} /** - * Finds whether a value is not a number - * @link http://www.php.net/manual/en/function.is-nan.php - * @param float $num - * @return bool Returns true if num is 'not a number', - * else false. + * {@inheritdoc} + * @param float $num */ function is_nan (float $num): bool {} /** - * Integer division - * @link http://www.php.net/manual/en/function.intdiv.php - * @param int $num1 Number to be divided. - * @param int $num2 Number which divides the num1. - * @return int The integer quotient of the division of num1 by num2. + * {@inheritdoc} + * @param int $num1 + * @param int $num2 */ function intdiv (int $num1, int $num2): int {} /** - * Finds whether a value is infinite - * @link http://www.php.net/manual/en/function.is-infinite.php - * @param float $num - * @return bool true if num is infinite, else false. + * {@inheritdoc} + * @param float $num */ function is_infinite (float $num): bool {} /** - * Exponential expression - * @link http://www.php.net/manual/en/function.pow.php - * @param mixed $num - * @param mixed $exponent - * @return int|float|object num raised to the power of exponent. - * If both arguments are non-negative integers and the result can be represented - * as an integer, the result will be returned with int type, - * otherwise it will be returned as a float. + * {@inheritdoc} + * @param mixed $num + * @param mixed $exponent */ -function pow (mixed $num, mixed $exponent): int|float|object {} +function pow (mixed $num = null, mixed $exponent = null): object|int|float {} /** - * Calculates the exponent of e - * @link http://www.php.net/manual/en/function.exp.php - * @param float $num - * @return float 'e' raised to the power of num + * {@inheritdoc} + * @param float $num */ function exp (float $num): float {} /** - * Natural logarithm - * @link http://www.php.net/manual/en/function.log.php - * @param float $num - * @param float $base [optional] - * @return float The logarithm of num to - * base, if given, or the - * natural logarithm. + * {@inheritdoc} + * @param float $num + * @param float $base [optional] */ -function log (float $num, float $base = M_E): float {} +function log (float $num, float $base = 2.718281828459045): float {} /** - * Base-10 logarithm - * @link http://www.php.net/manual/en/function.log10.php - * @param float $num - * @return float The base-10 logarithm of num + * {@inheritdoc} + * @param float $num */ function log10 (float $num): float {} /** - * Square root - * @link http://www.php.net/manual/en/function.sqrt.php - * @param float $num - * @return float The square root of num - * or the special value NAN for negative numbers. + * {@inheritdoc} + * @param float $num */ function sqrt (float $num): float {} /** - * Calculate the length of the hypotenuse of a right-angle triangle - * @link http://www.php.net/manual/en/function.hypot.php - * @param float $x - * @param float $y - * @return float Calculated length of the hypotenuse + * {@inheritdoc} + * @param float $x + * @param float $y */ function hypot (float $x, float $y): float {} /** - * Converts the number in degrees to the radian equivalent - * @link http://www.php.net/manual/en/function.deg2rad.php - * @param float $num - * @return float The radian equivalent of num + * {@inheritdoc} + * @param float $num */ function deg2rad (float $num): float {} /** - * Converts the radian number to the equivalent number in degrees - * @link http://www.php.net/manual/en/function.rad2deg.php - * @param float $num - * @return float The equivalent of num in degrees + * {@inheritdoc} + * @param float $num */ function rad2deg (float $num): float {} /** - * Binary to decimal - * @link http://www.php.net/manual/en/function.bindec.php - * @param string $binary_string - * @return int|float The decimal value of binary_string + * {@inheritdoc} + * @param string $binary_string */ function bindec (string $binary_string): int|float {} /** - * Hexadecimal to decimal - * @link http://www.php.net/manual/en/function.hexdec.php - * @param string $hex_string - * @return int|float The decimal representation of hex_string + * {@inheritdoc} + * @param string $hex_string */ function hexdec (string $hex_string): int|float {} /** - * Octal to decimal - * @link http://www.php.net/manual/en/function.octdec.php - * @param string $octal_string - * @return int|float The decimal representation of octal_string + * {@inheritdoc} + * @param string $octal_string */ function octdec (string $octal_string): int|float {} /** - * Decimal to binary - * @link http://www.php.net/manual/en/function.decbin.php - * @param int $num - * @return string Binary string representation of num + * {@inheritdoc} + * @param int $num */ function decbin (int $num): string {} /** - * Decimal to octal - * @link http://www.php.net/manual/en/function.decoct.php - * @param int $num - * @return string Octal string representation of num + * {@inheritdoc} + * @param int $num */ function decoct (int $num): string {} /** - * Decimal to hexadecimal - * @link http://www.php.net/manual/en/function.dechex.php - * @param int $num - * @return string Hexadecimal string representation of num. + * {@inheritdoc} + * @param int $num */ function dechex (int $num): string {} /** - * Convert a number between arbitrary bases - * @link http://www.php.net/manual/en/function.base-convert.php - * @param string $num - * @param int $from_base - * @param int $to_base - * @return string num converted to base to_base + * {@inheritdoc} + * @param string $num + * @param int $from_base + * @param int $to_base */ function base_convert (string $num, int $from_base, int $to_base): string {} /** - * Format a number with grouped thousands - * @link http://www.php.net/manual/en/function.number-format.php - * @param float $num - * @param int $decimals [optional] - * @param string|null $decimal_separator [optional] - * @param string|null $thousands_separator [optional] - * @return string A formatted version of num. + * {@inheritdoc} + * @param float $num + * @param int $decimals [optional] + * @param string|null $decimal_separator [optional] + * @param string|null $thousands_separator [optional] */ -function number_format (float $num, int $decimals = null, ?string $decimal_separator = '"."', ?string $thousands_separator = '","'): string {} +function number_format (float $num, int $decimals = 0, ?string $decimal_separator = '.', ?string $thousands_separator = ','): string {} /** - * Returns the floating point remainder (modulo) of the division - * of the arguments - * @link http://www.php.net/manual/en/function.fmod.php - * @param float $num1 - * @param float $num2 - * @return float The floating point remainder of - * num1/num2 + * {@inheritdoc} + * @param float $num1 + * @param float $num2 */ function fmod (float $num1, float $num2): float {} /** - * Divides two numbers, according to IEEE 754 - * @link http://www.php.net/manual/en/function.fdiv.php - * @param float $num1 - * @param float $num2 - * @return float The floating point result of - * num1/num2 + * {@inheritdoc} + * @param float $num1 + * @param float $num2 */ function fdiv (float $num1, float $num2): float {} /** - * Return current Unix timestamp with microseconds - * @link http://www.php.net/manual/en/function.microtime.php - * @param bool $as_float [optional] - * @return string|float By default, microtime returns a string in - * the form "msec sec", where sec is the number of seconds - * since the Unix epoch (0:00:00 January 1,1970 GMT), and msec - * measures microseconds that have elapsed since sec - * and is also expressed in seconds as a decimal fraction. - *If as_float is set to true, then - * microtime returns a float, which - * represents the current time in seconds since the Unix epoch accurate to the - * nearest microsecond.
+ * {@inheritdoc} + * @param bool $as_float [optional] */ function microtime (bool $as_float = false): string|float {} /** - * Get current time - * @link http://www.php.net/manual/en/function.gettimeofday.php - * @param bool $as_float [optional] - * @return array|float By default an array is returned. If as_float - * is set, then a float is returned. - *Array keys: - *
- *
- * "sec" - seconds since the Unix Epoch
- *
- * "usec" - microseconds
- *
- * "minuteswest" - minutes west of Greenwich
- *
- * "dsttime" - type of dst correction
- *
- *
- * algo, which will match a
- * password algorithm constant
- *
- * algoName, which has the human readable name of the
- * algorithm
- *
- * options, which includes the options
- * provided when calling password_hash
- *
Using the PASSWORD_BCRYPT as the - * algorithm, will result - * in the password parameter being truncated to a - * maximum length of 72 bytes.
- * @param string|int|null $algo A password algorithm constant denoting the algorithm to use when hashing the password. - * @param array $options [optional] An associative array containing options. See the password algorithm constants for documentation on the supported options for each algorithm. - *If omitted, a random salt will be created and the default cost will be - * used.
- * @return string Returns the hashed password. - *The used algorithm, cost and salt are returned as part of the hash. Therefore, - * all information that's needed to verify the hash is included in it. This allows - * the password_verify function to verify the hash without - * needing separate storage for the salt or algorithm information.
- */ -function password_hash (string $password, string|int|null $algo, array $options = '[]'): string {} - -/** - * Checks if the given hash matches the given options - * @link http://www.php.net/manual/en/function.password-needs-rehash.php - * @param string $hash A hash created by password_hash. - * @param string|int|null $algo A password algorithm constant denoting the algorithm to use when hashing the password. - * @param array $options [optional] An associative array containing options. See the password algorithm constants for documentation on the supported options for each algorithm. - * @return bool Returns true if the hash should be rehashed to match the given - * algo and options, or false - * otherwise. - */ -function password_needs_rehash (string $hash, string|int|null $algo, array $options = '[]'): bool {} - -/** - * Verifies that a password matches a hash - * @link http://www.php.net/manual/en/function.password-verify.php - * @param string $password The user's password. - * @param string $hash A hash created by password_hash. - * @return bool Returns true if the password and hash match, or false otherwise. + * {@inheritdoc} + * @param string $hash */ -function password_verify (string $password, string $hash): bool {} +function password_get_info (string $hash): array {} /** - * Get available password hashing algorithm IDs - * @link http://www.php.net/manual/en/function.password-algos.php - * @return array Returns the available password hashing algorithm IDs. + * {@inheritdoc} + * @param string $password + * @param string|int|null $algo + * @param array $options [optional] */ -function password_algos (): array {} +function password_hash (string $password, string|int|null $algo = null, array $options = array ( +)): string {} /** - * Execute a command and open file pointers for input/output - * @link http://www.php.net/manual/en/function.proc-open.php - * @param array|string $command - * @param array $descriptor_spec - * @param array $pipes - * @param string|null $cwd [optional] - * @param array|null $env_vars [optional] - * @param array|null $options [optional] - * @return resource|false Returns a resource representing the process, which should be freed using - * proc_close when you are finished with it. On failure - * returns false. - */ -function proc_open (array|string $command, array $descriptor_spec, array &$pipes, ?string $cwd = null, ?array $env_vars = null, ?array $options = null) {} - -/** - * Close a process opened by proc_open and return the exit code of that process - * @link http://www.php.net/manual/en/function.proc-close.php - * @param resource $process - * @return int Returns the termination status of the process that was run. In case of - * an error then -1 is returned. - *If PHP has been compiled with --enable-sigchild, the return value of this function is undefined.
- */ -function proc_close ($process): int {} - -/** - * Kills a process opened by proc_open - * @link http://www.php.net/manual/en/function.proc-terminate.php - * @param resource $process - * @param int $signal [optional] - * @return bool Returns the termination status of the process that was run. - */ -function proc_terminate ($process, int $signal = 15): bool {} - -/** - * Get information about a process opened by proc_open - * @link http://www.php.net/manual/en/function.proc-get-status.php - * @param resource $process - * @return array An array of collected information. - * The returned array contains the following elements: - *element | type | description |
command | - *string | - *- * The command string that was passed to proc_open. - * | - *
pid | - *int | - *process id | - *
running | - *bool | - *- * true if the process is still running, false if it has - * terminated. - * | - *
signaled | - *bool | - *- * true if the child process has been terminated by - * an uncaught signal. Always set to false on Windows. - * | - *
stopped | - *bool | - *- * true if the child process has been stopped by a - * signal. Always set to false on Windows. - * | - *
exitcode | - *int | - *- * The exit code returned by the process (which is only - * meaningful if running is false). - * Only first call of this function return real value, next calls return - * -1. - * | - *
termsig | - *int | - *- * The number of the signal that caused the child process to terminate - * its execution (only meaningful if signaled is true). - * | - *
stopsig | - *int | - *- * The number of the signal that caused the child process to stop its - * execution (only meaningful if stopped is true). - * | - *
false is returned if stream is not a resource or - * if filtername cannot be located.
+ * {@inheritdoc} + * @param array|null $options [optional] + * @param array|null $params [optional] */ -function stream_filter_prepend ($stream, string $filtername, int $read_write = null, mixed $params = null) {} +function stream_context_create (?array $options = NULL, ?array $params = NULL) {} /** - * Attach a filter to a stream - * @link http://www.php.net/manual/en/function.stream-filter-append.php - * @param resource $stream - * @param string $filtername - * @param int $read_write [optional] - * @param mixed $params [optional] - * @return resource Returns a resource on success or false on failure. The resource can be - * used to refer to this filter instance during a call to - * stream_filter_remove. - *false is returned if stream is not a resource or - * if filtername cannot be located.
+ * {@inheritdoc} + * @param mixed $context + * @param array $params */ -function stream_filter_append ($stream, string $filtername, int $read_write = null, mixed $params = null) {} +function stream_context_set_params ($context = null, array $params): bool {} /** - * Remove a filter from a stream - * @link http://www.php.net/manual/en/function.stream-filter-remove.php - * @param resource $stream_filter - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mixed $context */ -function stream_filter_remove ($stream_filter): bool {} +function stream_context_get_params ($context = null): array {} /** - * Open Internet or Unix domain socket connection - * @link http://www.php.net/manual/en/function.stream-socket-client.php - * @param string $address - * @param int $error_code [optional] - * @param string $error_message [optional] - * @param float|null $timeout [optional] - * @param int $flags [optional] - * @param resource|null $context [optional] - * @return resource|false On success a stream resource is returned which may - * be used together with the other file functions (such as - * fgets, fgetss, - * fwrite, fclose, and - * feof), false on failure. + * {@inheritdoc} + * @param mixed $context + * @param array|string $wrapper_or_options + * @param string|null $option_name [optional] + * @param mixed $value [optional] */ -function stream_socket_client (string $address, int &$error_code = null, string &$error_message = null, ?float $timeout = null, int $flags = STREAM_CLIENT_CONNECT, $context = null) {} +function stream_context_set_option ($context = null, array|string $wrapper_or_options, ?string $option_name = NULL, mixed $value = NULL): bool {} /** - * Create an Internet or Unix domain server socket - * @link http://www.php.net/manual/en/function.stream-socket-server.php - * @param string $address - * @param int $error_code [optional] - * @param string $error_message [optional] - * @param int $flags [optional] - * @param resource|null $context [optional] - * @return resource|false Returns the created stream, or false on error. + * {@inheritdoc} + * @param mixed $context + * @param array $options */ -function stream_socket_server (string $address, int &$error_code = null, string &$error_message = null, int $flags = 'STREAM_SERVER_BIND | STREAM_SERVER_LISTEN', $context = null) {} +function stream_context_set_options ($context = null, array $options): bool {} /** - * Accept a connection on a socket created by stream_socket_server - * @link http://www.php.net/manual/en/function.stream-socket-accept.php - * @param resource $socket - * @param float|null $timeout [optional] - * @param string $peer_name [optional] - * @return resource|false Returns a stream to the accepted socket connection or false on failure. + * {@inheritdoc} + * @param mixed $stream_or_context */ -function stream_socket_accept ($socket, ?float $timeout = null, string &$peer_name = null) {} +function stream_context_get_options ($stream_or_context = null): array {} /** - * Retrieve the name of the local or remote sockets - * @link http://www.php.net/manual/en/function.stream-socket-get-name.php - * @param resource $socket - * @param bool $remote - * @return string|false The name of the socket, or false on failure. + * {@inheritdoc} + * @param array|null $options [optional] */ -function stream_socket_get_name ($socket, bool $remote): string|false {} +function stream_context_get_default (?array $options = NULL) {} /** - * Receives data from a socket, connected or not - * @link http://www.php.net/manual/en/function.stream-socket-recvfrom.php - * @param resource $socket - * @param int $length - * @param int $flags [optional] - * @param string|null $address [optional] - * @return string|false Returns the read data, as a string, or false on failure. + * {@inheritdoc} + * @param array $options */ -function stream_socket_recvfrom ($socket, int $length, int $flags = null, ?string &$address = null): string|false {} +function stream_context_set_default (array $options) {} /** - * Sends a message to a socket, whether it is connected or not - * @link http://www.php.net/manual/en/function.stream-socket-sendto.php - * @param resource $socket - * @param string $data - * @param int $flags [optional] - * @param string $address [optional] - * @return int|false Returns a result code, as an integer, or false on failure. + * {@inheritdoc} + * @param mixed $stream + * @param string $filter_name + * @param int $mode [optional] + * @param mixed $params [optional] */ -function stream_socket_sendto ($socket, string $data, int $flags = null, string $address = '""'): int|false {} +function stream_filter_prepend ($stream = null, string $filter_name, int $mode = 0, mixed $params = NULL) {} /** - * Turns encryption on/off on an already connected socket - * @link http://www.php.net/manual/en/function.stream-socket-enable-crypto.php - * @param resource $stream - * @param bool $enable - * @param int|null $crypto_method [optional] - * @param resource|null $session_stream [optional] - * @return int|bool Returns true on success, false if negotiation has failed or - * 0 if there isn't enough data and you should try again - * (only for non-blocking sockets). + * {@inheritdoc} + * @param mixed $stream + * @param string $filter_name + * @param int $mode [optional] + * @param mixed $params [optional] */ -function stream_socket_enable_crypto ($stream, bool $enable, ?int $crypto_method = null, $session_stream = null): int|bool {} +function stream_filter_append ($stream = null, string $filter_name, int $mode = 0, mixed $params = NULL) {} /** - * Shutdown a full-duplex connection - * @link http://www.php.net/manual/en/function.stream-socket-shutdown.php - * @param resource $stream - * @param int $mode - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mixed $stream_filter */ -function stream_socket_shutdown ($stream, int $mode): bool {} +function stream_filter_remove ($stream_filter = null): bool {} /** - * Creates a pair of connected, indistinguishable socket streams - * @link http://www.php.net/manual/en/function.stream-socket-pair.php - * @param int $domain - * @param int $type - * @param int $protocol - * @return array|false Returns an array with the two socket resources on success, or - * false on failure. + * {@inheritdoc} + * @param string $address + * @param mixed $error_code [optional] + * @param mixed $error_message [optional] + * @param float|null $timeout [optional] + * @param int $flags [optional] + * @param mixed $context [optional] */ -function stream_socket_pair (int $domain, int $type, int $protocol): array|false {} +function stream_socket_client (string $address, &$error_code = NULL, &$error_message = NULL, ?float $timeout = NULL, int $flags = 4, $context = NULL) {} /** - * Copies data from one stream to another - * @link http://www.php.net/manual/en/function.stream-copy-to-stream.php - * @param resource $from - * @param resource $to - * @param int|null $length [optional] - * @param int $offset [optional] - * @return int|false Returns the total count of bytes copied, or false on failure. - */ -function stream_copy_to_stream ($from, $to, ?int $length = null, int $offset = null): int|false {} - -/** - * Reads remainder of a stream into a string - * @link http://www.php.net/manual/en/function.stream-get-contents.php - * @param resource $stream - * @param int|null $length [optional] - * @param int $offset [optional] - * @return string|false Returns a string or false on failure. - */ -function stream_get_contents ($stream, ?int $length = null, int $offset = -1): string|false {} - -/** - * Tells whether the stream supports locking - * @link http://www.php.net/manual/en/function.stream-supports-lock.php - * @param resource $stream - * @return bool Returns true on success or false on failure. - */ -function stream_supports_lock ($stream): bool {} - -/** - * Sets write file buffering on the given stream - * @link http://www.php.net/manual/en/function.stream-set-write-buffer.php - * @param resource $stream - * @param int $size - * @return int Returns 0 on success, or another value if the request cannot be honored. - */ -function stream_set_write_buffer ($stream, int $size): int {} - -/** - * Alias of stream_set_write_buffer - * @link http://www.php.net/manual/en/function.set-file-buffer.php - * @param resource $stream - * @param int $size - * @return int Returns 0 on success, or another value if the request cannot be honored. - */ -function set_file_buffer ($stream, int $size): int {} - -/** - * Set read file buffering on the given stream - * @link http://www.php.net/manual/en/function.stream-set-read-buffer.php - * @param resource $stream The file pointer. - * @param int $size The number of bytes to buffer. If size - * is 0 then read operations are unbuffered. This ensures that all reads - * with fread are completed before other processes are - * allowed to read from that input stream. - * @return int Returns 0 on success, or another value if the request - * cannot be honored. - */ -function stream_set_read_buffer ($stream, int $size): int {} - -/** - * Set blocking/non-blocking mode on a stream - * @link http://www.php.net/manual/en/function.stream-set-blocking.php - * @param resource $stream - * @param bool $enable - * @return bool Returns true on success or false on failure. - */ -function stream_set_blocking ($stream, bool $enable): bool {} - -/** - * Alias of stream_set_blocking - * @link http://www.php.net/manual/en/function.socket-set-blocking.php - * @param resource $stream - * @param bool $enable - * @return bool Returns true on success or false on failure. - */ -function socket_set_blocking ($stream, bool $enable): bool {} - -/** - * Retrieves header/meta data from streams/file pointers - * @link http://www.php.net/manual/en/function.stream-get-meta-data.php - * @param resource $stream - * @return array The result array contains the following items: - *timed_out (bool) - true if the stream - * timed out while waiting for data on the last call to - * fread or fgets.
- *blocked (bool) - true if the stream is - * in blocking IO mode. See stream_set_blocking.
- *eof (bool) - true if the stream has reached - * end-of-file. Note that for socket streams this member can be true - * even when unread_bytes is non-zero. To - * determine if there is more data to be read, use - * feof instead of reading this item.
- *unread_bytes (int) - the number of bytes - * currently contained in the PHP's own internal buffer.
- *stream_type (string) - a label describing - * the underlying implementation of the stream.
- *wrapper_type (string) - a label describing - * the protocol wrapper implementation layered over the stream. - * See for more information about wrappers.
- *wrapper_data (mixed) - wrapper specific - * data attached to this stream. See for - * more information about wrappers and their wrapper data.
- *mode (string) - the type of access required for - * this stream (see Table 1 of the fopen() reference)
- *seekable (bool) - whether the current stream can - * be seeked.
- *uri (string) - the URI/filename associated with this - * stream.
- *crypto (array) - the TLS connection metadata for this - * stream. (Note: Only provided when the resource's stream uses TLS.)
- */ -function stream_get_meta_data ($stream): array {} - -/** - * Alias of stream_get_meta_data - * @link http://www.php.net/manual/en/function.socket-get-status.php - * @param resource $stream - * @return array The result array contains the following items: - *timed_out (bool) - true if the stream - * timed out while waiting for data on the last call to - * fread or fgets.
- *blocked (bool) - true if the stream is - * in blocking IO mode. See stream_set_blocking.
- *eof (bool) - true if the stream has reached - * end-of-file. Note that for socket streams this member can be true - * even when unread_bytes is non-zero. To - * determine if there is more data to be read, use - * feof instead of reading this item.
- *unread_bytes (int) - the number of bytes - * currently contained in the PHP's own internal buffer.
- *stream_type (string) - a label describing - * the underlying implementation of the stream.
- *wrapper_type (string) - a label describing - * the protocol wrapper implementation layered over the stream. - * See for more information about wrappers.
- *wrapper_data (mixed) - wrapper specific - * data attached to this stream. See for - * more information about wrappers and their wrapper data.
- *mode (string) - the type of access required for - * this stream (see Table 1 of the fopen() reference)
- *seekable (bool) - whether the current stream can - * be seeked.
- *uri (string) - the URI/filename associated with this - * stream.
- *crypto (array) - the TLS connection metadata for this - * stream. (Note: Only provided when the resource's stream uses TLS.)
- */ -function socket_get_status ($stream): array {} - -/** - * Gets line from stream resource up to a given delimiter - * @link http://www.php.net/manual/en/function.stream-get-line.php - * @param resource $stream - * @param int $length - * @param string $ending [optional] - * @return string|false Returns a string of up to length bytes read from the file - * pointed to by stream, or false on failure. - */ -function stream_get_line ($stream, int $length, string $ending = '""'): string|false {} - -/** - * Resolve filename against the include path - * @link http://www.php.net/manual/en/function.stream-resolve-include-path.php - * @param string $filename - * @return string|false Returns a string containing the resolved absolute filename, or false on failure. + * {@inheritdoc} + * @param string $address + * @param mixed $error_code [optional] + * @param mixed $error_message [optional] + * @param int $flags [optional] + * @param mixed $context [optional] */ -function stream_resolve_include_path (string $filename): string|false {} +function stream_socket_server (string $address, &$error_code = NULL, &$error_message = NULL, int $flags = 12, $context = NULL) {} /** - * Retrieve list of registered streams - * @link http://www.php.net/manual/en/function.stream-get-wrappers.php - * @return array Returns an indexed array containing the name of all stream wrappers - * available on the running system. + * {@inheritdoc} + * @param mixed $socket + * @param float|null $timeout [optional] + * @param mixed $peer_name [optional] */ -function stream_get_wrappers (): array {} +function stream_socket_accept ($socket = null, ?float $timeout = NULL, &$peer_name = NULL) {} /** - * Retrieve list of registered socket transports - * @link http://www.php.net/manual/en/function.stream-get-transports.php - * @return array Returns an indexed array of socket transports names. + * {@inheritdoc} + * @param mixed $socket + * @param bool $remote */ -function stream_get_transports (): array {} +function stream_socket_get_name ($socket = null, bool $remote): string|false {} /** - * Checks if a stream is a local stream - * @link http://www.php.net/manual/en/function.stream-is-local.php - * @param resource|string $stream - * @return bool Returns true on success or false on failure. - */ -function stream_is_local ($stream): bool {} - -/** - * Check if a stream is a TTY - * @link http://www.php.net/manual/en/function.stream-isatty.php - * @param resource $stream - * @return bool Returns true on success or false on failure. - */ -function stream_isatty ($stream): bool {} - -/** - * Set the stream chunk size - * @link http://www.php.net/manual/en/function.stream-set-chunk-size.php - * @param resource $stream The target stream. - * @param int $size The desired new chunk size. - * @return int Returns the previous chunk size on success. - *Will return false if size is less than 1 or - * greater than PHP_INT_MAX.
- */ -function stream_set_chunk_size ($stream, int $size): int {} - -/** - * Set timeout period on a stream - * @link http://www.php.net/manual/en/function.stream-set-timeout.php - * @param resource $stream - * @param int $seconds - * @param int $microseconds [optional] - * @return bool Returns true on success or false on failure. - */ -function stream_set_timeout ($stream, int $seconds, int $microseconds = null): bool {} - -/** - * Alias of stream_set_timeout - * @link http://www.php.net/manual/en/function.socket-set-timeout.php - * @param resource $stream - * @param int $seconds - * @param int $microseconds [optional] - * @return bool Returns true on success or false on failure. - */ -function socket_set_timeout ($stream, int $seconds, int $microseconds = null): bool {} - -/** - * Get the type of a variable - * @link http://www.php.net/manual/en/function.gettype.php - * @param mixed $value - * @return string Possible values for the returned string are: - *- * "boolean" - * "integer" - * "double" (for historical reasons "double" is - * returned in case of a float, and not simply - * "float") - * "string" - * "array" - * "object" - * "resource" - * "resource (closed)" as of PHP 7.2.0 - * "NULL" - * "unknown type" - *
- */ -function gettype (mixed $value): string {} - -/** - * Gets the type name of a variable in a way that is suitable for debugging - * @link http://www.php.net/manual/en/function.get-debug-type.php - * @param mixed $value - * @return string Possible values for the returned string are: - *Type + State | - *Return Value | - *Notes | - *
null | - *- * "null" - * | - *- | - *
Booleans (true or false) | - *- * "bool" - * | - *- | - *
Integers | - *- * "int" - * | - *- | - *
Floats | - *- * "float" - * | - *- | - *
Strings | - *- * "string" - * | - *- | - *
Arrays | - *- * "array" - * | - *- | - *
Resources | - *- * "resource (resourcename)" - * | - *- | - *
Resources (Closed) | - *- * "resource (closed)" - * | - *Example: A file stream after being closed with fclose. | - *
Objects from Named Classes | - *- * The full name of the class including its namespace e.g. Foo\Bar - * | - *- | - *
Objects from Anonymous Classes | - *- * "class@anonymous" - * | - *- * Anonymous classes are those created through the $x = new class { ... } syntax - * | - *
The maximum value depends on the system. 32 bit systems have a - * maximum signed integer range of -2147483648 to 2147483647. So for example - * on such a system, intval('1000000000000') will return - * 2147483647. The maximum signed integer value for 64 bit systems is - * 9223372036854775807.
- *Strings will most likely return 0 although this depends on the - * leftmost characters of the string. The common rules of - * integer casting - * apply.
- */ -function intval (mixed $value, int $base = 10): int {} - -/** - * Get float value of a variable - * @link http://www.php.net/manual/en/function.floatval.php - * @param mixed $value - * @return float The float value of the given variable. Empty arrays return 0, non-empty - * arrays return 1. - *Strings will most likely return 0 although this depends on the - * leftmost characters of the string. The common rules of - * float casting - * apply.
- */ -function floatval (mixed $value): float {} - -/** - * Alias of floatval - * @link http://www.php.net/manual/en/function.doubleval.php - * @param mixed $value - * @return float The float value of the given variable. Empty arrays return 0, non-empty - * arrays return 1. - *Strings will most likely return 0 although this depends on the - * leftmost characters of the string. The common rules of - * float casting - * apply.
- */ -function doubleval (mixed $value): float {} - -/** - * Get the boolean value of a variable - * @link http://www.php.net/manual/en/function.boolval.php - * @param mixed $value The scalar value being converted to a bool. - * @return bool The bool value of value. - */ -function boolval (mixed $value): bool {} + * {@inheritdoc} + * @param mixed $socket + * @param int $length + * @param int $flags [optional] + * @param mixed $address [optional] + */ +function stream_socket_recvfrom ($socket = null, int $length, int $flags = 0, &$address = NULL): string|false {} /** - * Get string value of a variable - * @link http://www.php.net/manual/en/function.strval.php - * @param mixed $value - * @return string The string value of value. + * {@inheritdoc} + * @param mixed $socket + * @param string $data + * @param int $flags [optional] + * @param string $address [optional] */ -function strval (mixed $value): string {} +function stream_socket_sendto ($socket = null, string $data, int $flags = 0, string $address = ''): int|false {} /** - * Finds whether a variable is null - * @link http://www.php.net/manual/en/function.is-null.php - * @param mixed $value - * @return bool Returns true if value is null, false - * otherwise. + * {@inheritdoc} + * @param mixed $stream + * @param bool $enable + * @param int|null $crypto_method [optional] + * @param mixed $session_stream [optional] */ -function is_null (mixed $value): bool {} +function stream_socket_enable_crypto ($stream = null, bool $enable, ?int $crypto_method = NULL, $session_stream = NULL): int|bool {} /** - * Finds whether a variable is a resource - * @link http://www.php.net/manual/en/function.is-resource.php - * @param mixed $value - * @return bool Returns true if value is a resource, - * false otherwise. + * {@inheritdoc} + * @param mixed $stream + * @param int $mode */ -function is_resource (mixed $value): bool {} +function stream_socket_shutdown ($stream = null, int $mode): bool {} /** - * Finds out whether a variable is a boolean - * @link http://www.php.net/manual/en/function.is-bool.php - * @param mixed $value - * @return bool Returns true if value is a bool, - * false otherwise. + * {@inheritdoc} + * @param int $domain + * @param int $type + * @param int $protocol */ -function is_bool (mixed $value): bool {} +function stream_socket_pair (int $domain, int $type, int $protocol): array|false {} /** - * Find whether the type of a variable is integer - * @link http://www.php.net/manual/en/function.is-int.php - * @param mixed $value - * @return bool Returns true if value is an int, - * false otherwise. + * {@inheritdoc} + * @param mixed $from + * @param mixed $to + * @param int|null $length [optional] + * @param int $offset [optional] */ -function is_int (mixed $value): bool {} +function stream_copy_to_stream ($from = null, $to = null, ?int $length = NULL, int $offset = 0): int|false {} /** - * Alias of is_int - * @link http://www.php.net/manual/en/function.is-integer.php - * @param mixed $value - * @return bool Returns true if value is an int, - * false otherwise. + * {@inheritdoc} + * @param mixed $stream + * @param int|null $length [optional] + * @param int $offset [optional] */ -function is_integer (mixed $value): bool {} +function stream_get_contents ($stream = null, ?int $length = NULL, int $offset = -1): string|false {} /** - * Alias of is_int - * @link http://www.php.net/manual/en/function.is-long.php - * @param mixed $value - * @return bool Returns true if value is an int, - * false otherwise. + * {@inheritdoc} + * @param mixed $stream */ -function is_long (mixed $value): bool {} +function stream_supports_lock ($stream = null): bool {} /** - * Finds whether the type of a variable is float - * @link http://www.php.net/manual/en/function.is-float.php - * @param mixed $value - * @return bool Returns true if value is a float, - * false otherwise. + * {@inheritdoc} + * @param mixed $stream + * @param int $size */ -function is_float (mixed $value): bool {} +function stream_set_write_buffer ($stream = null, int $size): int {} /** - * Alias of is_float - * @link http://www.php.net/manual/en/function.is-double.php - * @param mixed $value - * @return bool Returns true if value is a float, - * false otherwise. + * {@inheritdoc} + * @param mixed $stream + * @param int $size */ -function is_double (mixed $value): bool {} +function set_file_buffer ($stream = null, int $size): int {} /** - * Finds whether a variable is a number or a numeric string - * @link http://www.php.net/manual/en/function.is-numeric.php - * @param mixed $value - * @return bool Returns true if value is a number or a - * numeric string, - * false otherwise. + * {@inheritdoc} + * @param mixed $stream + * @param int $size */ -function is_numeric (mixed $value): bool {} +function stream_set_read_buffer ($stream = null, int $size): int {} /** - * Find whether the type of a variable is string - * @link http://www.php.net/manual/en/function.is-string.php - * @param mixed $value - * @return bool Returns true if value is of type string, - * false otherwise. + * {@inheritdoc} + * @param mixed $stream + * @param bool $enable */ -function is_string (mixed $value): bool {} +function stream_set_blocking ($stream = null, bool $enable): bool {} /** - * Finds whether a variable is an array - * @link http://www.php.net/manual/en/function.is-array.php - * @param mixed $value - * @return bool Returns true if value is an array, - * false otherwise. + * {@inheritdoc} + * @param mixed $stream + * @param bool $enable */ -function is_array (mixed $value): bool {} +function socket_set_blocking ($stream = null, bool $enable): bool {} /** - * Finds whether a variable is an object - * @link http://www.php.net/manual/en/function.is-object.php - * @param mixed $value - * @return bool Returns true if value is an object, - * false otherwise. + * {@inheritdoc} + * @param mixed $stream */ -function is_object (mixed $value): bool {} +function stream_get_meta_data ($stream = null): array {} /** - * Finds whether a variable is a scalar - * @link http://www.php.net/manual/en/function.is-scalar.php - * @param mixed $value - * @return bool Returns true if value is a scalar, false - * otherwise. + * {@inheritdoc} + * @param mixed $stream */ -function is_scalar (mixed $value): bool {} +function socket_get_status ($stream = null): array {} /** - * Verify that a value can be called as a function from the current scope. - * @link http://www.php.net/manual/en/function.is-callable.php - * @param mixed $value - * @param bool $syntax_only [optional] - * @param string $callable_name [optional] - * @return bool Returns true if value is callable, false - * otherwise. - */ -function is_callable (mixed $value, bool $syntax_only = false, string &$callable_name = null): bool {} - -/** - * Verify that the contents of a variable is an iterable value - * @link http://www.php.net/manual/en/function.is-iterable.php - * @param mixed $value - * @return bool Returns true if value is iterable, false - * otherwise. - */ -function is_iterable (mixed $value): bool {} - -/** - * Verify that the contents of a variable is a countable value - * @link http://www.php.net/manual/en/function.is-countable.php - * @param mixed $value - * @return bool Returns true if value is countable, false - * otherwise. - */ -function is_countable (mixed $value): bool {} - -/** - * Generate a unique ID - * @link http://www.php.net/manual/en/function.uniqid.php - * @param string $prefix [optional] - * @param bool $more_entropy [optional] - * @return string Returns timestamp based unique identifier as a string. - *This function tries to create unique identifier, but it does not - * guarantee 100% uniqueness of return value.
- */ -function uniqid (string $prefix = '""', bool $more_entropy = false): string {} - -/** - * Parse a URL and return its components - * @link http://www.php.net/manual/en/function.parse-url.php - * @param string $url - * @param int $component [optional] - * @return int|string|array|null|false On seriously malformed URLs, parse_url may return - * false. - *If the component parameter is omitted, an - * associative array is returned. At least one element will be - * present within the array. Potential keys within this array are: - *
- *
- * scheme - e.g. http
- *
- * host
- *
- * port
- *
- * user
- *
- * pass
- *
- * path
- *
- * query - after the question mark ?
- *
- * fragment - after the hashmark #
- *
If the component parameter is specified, - * parse_url returns a string (or an - * int, in the case of PHP_URL_PORT) - * instead of an array. If the requested component doesn't exist - * within the given URL, null will be returned. - * As of PHP 8.0.0, parse_url distinguishes absent and empty - * queries and fragments:
- *- * http://example.com/foo → query = null, fragment = null - * http://example.com/foo? → query = "", fragment = null - * http://example.com/foo# → query = null, fragment = "" - * http://example.com/foo?# → query = "", fragment = "" - *- *
Previously all cases resulted in query and fragment being null.
- *Note that control characters (cf. ctype_cntrl) in the - * components are replaced with underscores (_).
- */ -function parse_url (string $url, int $component = -1): int|string|array|null|false {} - -/** - * URL-encodes string - * @link http://www.php.net/manual/en/function.urlencode.php - * @param string $string - * @return string Returns a string in which all non-alphanumeric characters except - * -_. have been replaced with a percent - * (%) sign followed by two hex digits and spaces encoded - * as plus (+) signs. It is encoded the same way that the - * posted data from a WWW form is encoded, that is the same way as in - * application/x-www-form-urlencoded media type. This - * differs from the RFC 3986 encoding (see - * rawurlencode) in that for historical reasons, spaces - * are encoded as plus (+) signs. + * {@inheritdoc} + * @param mixed $stream + * @param int $length + * @param string $ending [optional] */ -function urlencode (string $string): string {} +function stream_get_line ($stream = null, int $length, string $ending = ''): string|false {} /** - * Decodes URL-encoded string - * @link http://www.php.net/manual/en/function.urldecode.php - * @param string $string - * @return string Returns the decoded string. + * {@inheritdoc} + * @param string $filename */ -function urldecode (string $string): string {} +function stream_resolve_include_path (string $filename): string|false {} /** - * URL-encode according to RFC 3986 - * @link http://www.php.net/manual/en/function.rawurlencode.php - * @param string $string - * @return string Returns a string in which all non-alphanumeric characters except - * -_.~ have been replaced with a percent - * (%) sign followed by two hex digits. This is the - * encoding described in RFC 3986 for - * protecting literal characters from being interpreted as special URL - * delimiters, and for protecting URLs from being mangled by transmission - * media with character conversions (like some email systems). + * {@inheritdoc} */ -function rawurlencode (string $string): string {} +function stream_get_wrappers (): array {} /** - * Decode URL-encoded strings - * @link http://www.php.net/manual/en/function.rawurldecode.php - * @param string $string - * @return string Returns the decoded URL, as a string. + * {@inheritdoc} */ -function rawurldecode (string $string): string {} +function stream_get_transports (): array {} /** - * Fetches all the headers sent by the server in response to an HTTP request - * @link http://www.php.net/manual/en/function.get-headers.php - * @param string $url - * @param bool $associative [optional] - * @param resource|null $context [optional] - * @return array|false Returns an indexed or associative array with the headers, or false on - * failure. + * {@inheritdoc} + * @param mixed $stream */ -function get_headers (string $url, bool $associative = false, $context = null): array|false {} +function stream_is_local ($stream = null): bool {} /** - * Returns a bucket object from the brigade to operate on - * @link http://www.php.net/manual/en/function.stream-bucket-make-writeable.php - * @param resource $brigade - * @return object|null Returns a bucket object with the properties listed below or null. - *
- * data
- * (string)
- *
- *
- * data bucket The current string in the bucket. - *
- * datalen - * (integer) - *- * datalen bucket The length of the string in the bucket. - *
- * - *data bucket The current string in the bucket.
- *datalen bucket The length of the string in the bucket.
+ * {@inheritdoc} + * @param mixed $stream */ -function stream_bucket_make_writeable ($brigade): ?object {} +function stream_isatty ($stream = null): bool {} /** - * Prepend bucket to brigade - * @link http://www.php.net/manual/en/function.stream-bucket-prepend.php - * @param resource $brigade brigade is a resource pointing to a bucket brigade - * which contains one or more bucket objects. - * @param object $bucket A bucket object. - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $stream + * @param int $size */ -function stream_bucket_prepend ($brigade, object $bucket): void {} +function stream_set_chunk_size ($stream = null, int $size): int {} /** - * Append bucket to brigade - * @link http://www.php.net/manual/en/function.stream-bucket-append.php - * @param resource $brigade - * @param object $bucket - * @return void + * {@inheritdoc} + * @param mixed $stream + * @param int $seconds + * @param int $microseconds [optional] */ -function stream_bucket_append ($brigade, object $bucket): void {} +function stream_set_timeout ($stream = null, int $seconds, int $microseconds = 0): bool {} /** - * Create a new bucket for use on the current stream - * @link http://www.php.net/manual/en/function.stream-bucket-new.php - * @param resource $stream - * @param string $buffer - * @return object + * {@inheritdoc} + * @param mixed $stream + * @param int $seconds + * @param int $microseconds [optional] */ -function stream_bucket_new ($stream, string $buffer): object {} +function socket_set_timeout ($stream = null, int $seconds, int $microseconds = 0): bool {} /** - * Retrieve list of registered filters - * @link http://www.php.net/manual/en/function.stream-get-filters.php - * @return array Returns an indexed array containing the name of all stream filters - * available. + * {@inheritdoc} + * @param mixed $value */ -function stream_get_filters (): array {} +function gettype (mixed $value = null): string {} /** - * Register a user defined stream filter - * @link http://www.php.net/manual/en/function.stream-filter-register.php - * @param string $filter_name - * @param string $class - * @return bool Returns true on success or false on failure. - *stream_filter_register will return false if the - * filter_name is already defined.
+ * {@inheritdoc} + * @param mixed $value */ -function stream_filter_register (string $filter_name, string $class): bool {} +function get_debug_type (mixed $value = null): string {} /** - * Uuencode a string - * @link http://www.php.net/manual/en/function.convert-uuencode.php - * @param string $string - * @return string Returns the uuencoded data. + * {@inheritdoc} + * @param mixed $var + * @param string $type */ -function convert_uuencode (string $string): string {} +function settype (mixed &$var = null, string $type): bool {} /** - * Decode a uuencoded string - * @link http://www.php.net/manual/en/function.convert-uudecode.php - * @param string $string - * @return string|false Returns the decoded data as a string or false on failure. + * {@inheritdoc} + * @param mixed $value + * @param int $base [optional] */ -function convert_uudecode (string $string): string|false {} +function intval (mixed $value = null, int $base = 10): int {} /** - * Dumps information about a variable - * @link http://www.php.net/manual/en/function.var-dump.php - * @param mixed $value - * @param mixed $values - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $value */ -function var_dump (mixed $value, mixed ...$values): void {} +function floatval (mixed $value = null): float {} /** - * Outputs or returns a parsable string representation of a variable - * @link http://www.php.net/manual/en/function.var-export.php - * @param mixed $value - * @param bool $return [optional] - * @return string|null Returns the variable representation when the return - * parameter is used and evaluates to true. Otherwise, this function will - * return null. + * {@inheritdoc} + * @param mixed $value */ -function var_export (mixed $value, bool $return = false): ?string {} +function doubleval (mixed $value = null): float {} /** - * Dumps a string representation of an internal zval structure to output - * @link http://www.php.net/manual/en/function.debug-zval-dump.php - * @param mixed $value - * @param mixed $values - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $value */ -function debug_zval_dump (mixed $value, mixed ...$values): void {} +function boolval (mixed $value = null): bool {} /** - * Generates a storable representation of a value - * @link http://www.php.net/manual/en/function.serialize.php - * @param mixed $value - * @return string Returns a string containing a byte-stream representation of - * value that can be stored anywhere. - *Note that this is a binary string which may include null bytes, and needs - * to be stored and handled as such. For example, - * serialize output should generally be stored in a BLOB - * field in a database, rather than a CHAR or TEXT field.
+ * {@inheritdoc} + * @param mixed $value */ -function serialize (mixed $value): string {} +function strval (mixed $value = null): string {} /** - * Creates a PHP value from a stored representation - * @link http://www.php.net/manual/en/function.unserialize.php - * @param string $data - * @param array $options [optional] - * @return mixed The converted value is returned, and can be a bool, - * int, float, string, - * array or object. - *In case the passed string is not unserializeable, false is returned and - * E_NOTICE is issued.
+ * {@inheritdoc} + * @param mixed $value */ -function unserialize (string $data, array $options = '[]'): mixed {} +function is_null (mixed $value = null): bool {} /** - * Returns the amount of memory allocated to PHP - * @link http://www.php.net/manual/en/function.memory-get-usage.php - * @param bool $real_usage [optional] - * @return int Returns the memory amount in bytes. + * {@inheritdoc} + * @param mixed $value */ -function memory_get_usage (bool $real_usage = false): int {} +function is_resource (mixed $value = null): bool {} /** - * Returns the peak of memory allocated by PHP - * @link http://www.php.net/manual/en/function.memory-get-peak-usage.php - * @param bool $real_usage [optional] - * @return int Returns the memory peak in bytes. + * {@inheritdoc} + * @param mixed $value */ -function memory_get_peak_usage (bool $real_usage = false): int {} +function is_bool (mixed $value = null): bool {} /** - * Reset the peak memory usage - * @link http://www.php.net/manual/en/function.memory-reset-peak-usage.php - * @return void No value is returned. + * {@inheritdoc} + * @param mixed $value */ -function memory_reset_peak_usage (): void {} +function is_int (mixed $value = null): bool {} /** - * Compares two "PHP-standardized" version number strings - * @link http://www.php.net/manual/en/function.version-compare.php - * @param string $version1 - * @param string $version2 - * @param string|null $operator [optional] - * @return int|bool By default, version_compare returns - * -1 if the first version is lower than the second, - * 0 if they are equal, and - * 1 if the second is lower. - *When using the optional operator argument, the - * function will return true if the relationship is the one specified - * by the operator, false otherwise.
- */ -function version_compare (string $version1, string $version2, ?string $operator = null): int|bool {} - -/** - * Loads a PHP extension at runtime - * @link http://www.php.net/manual/en/function.dl.php - * @param string $extension_filename - * @return bool Returns true on success or false on failure. If the functionality of loading modules is not available - * or has been disabled (by setting - * enable_dl off - * in php.ini) an E_ERROR is emitted - * and execution is stopped. If dl fails because the - * specified library couldn't be loaded, in addition to false an - * E_WARNING message is emitted. + * {@inheritdoc} + * @param mixed $value */ -function dl (string $extension_filename): bool {} +function is_integer (mixed $value = null): bool {} /** - * Sets the process title - * @link http://www.php.net/manual/en/function.cli-set-process-title.php - * @param string $title The new title. - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mixed $value */ -function cli_set_process_title (string $title): bool {} +function is_long (mixed $value = null): bool {} /** - * Returns the current process title - * @link http://www.php.net/manual/en/function.cli-get-process-title.php - * @return string|null Return a string with the current process title or null on error. + * {@inheritdoc} + * @param mixed $value */ -function cli_get_process_title (): ?string {} - +function is_float (mixed $value = null): bool {} /** - * - * @link http://www.php.net/manual/en/array.constants.php - * @var int + * {@inheritdoc} + * @param mixed $value */ -define ('EXTR_OVERWRITE', 0); +function is_double (mixed $value = null): bool {} /** - * - * @link http://www.php.net/manual/en/array.constants.php - * @var int + * {@inheritdoc} + * @param mixed $value */ -define ('EXTR_SKIP', 1); +function is_numeric (mixed $value = null): bool {} /** - * - * @link http://www.php.net/manual/en/array.constants.php - * @var int + * {@inheritdoc} + * @param mixed $value */ -define ('EXTR_PREFIX_SAME', 2); +function is_string (mixed $value = null): bool {} /** - * - * @link http://www.php.net/manual/en/array.constants.php - * @var int + * {@inheritdoc} + * @param mixed $value */ -define ('EXTR_PREFIX_ALL', 3); +function is_array (mixed $value = null): bool {} /** - * - * @link http://www.php.net/manual/en/array.constants.php - * @var int + * {@inheritdoc} + * @param mixed $value */ -define ('EXTR_PREFIX_INVALID', 4); +function is_object (mixed $value = null): bool {} /** - * - * @link http://www.php.net/manual/en/array.constants.php - * @var int + * {@inheritdoc} + * @param mixed $value */ -define ('EXTR_PREFIX_IF_EXISTS', 5); +function is_scalar (mixed $value = null): bool {} /** - * - * @link http://www.php.net/manual/en/array.constants.php - * @var int + * {@inheritdoc} + * @param mixed $value + * @param bool $syntax_only [optional] + * @param mixed $callable_name [optional] */ -define ('EXTR_IF_EXISTS', 6); +function is_callable (mixed $value = null, bool $syntax_only = false, &$callable_name = NULL): bool {} /** - * - * @link http://www.php.net/manual/en/array.constants.php - * @var int + * {@inheritdoc} + * @param mixed $value */ -define ('EXTR_REFS', 256); +function is_iterable (mixed $value = null): bool {} /** - * SORT_ASC is used with - * array_multisort to sort in ascending order. - * @link http://www.php.net/manual/en/array.constants.php - * @var int + * {@inheritdoc} + * @param mixed $value */ -define ('SORT_ASC', 4); +function is_countable (mixed $value = null): bool {} /** - * SORT_DESC is used with - * array_multisort to sort in descending order. - * @link http://www.php.net/manual/en/array.constants.php - * @var int + * {@inheritdoc} + * @param string $prefix [optional] + * @param bool $more_entropy [optional] */ -define ('SORT_DESC', 3); +function uniqid (string $prefix = '', bool $more_entropy = false): string {} /** - * SORT_REGULAR is used to compare items normally. - * @link http://www.php.net/manual/en/array.constants.php - * @var int + * {@inheritdoc} + * @param string $url + * @param int $component [optional] */ -define ('SORT_REGULAR', 0); +function parse_url (string $url, int $component = -1): array|string|int|false|null {} /** - * SORT_NUMERIC is used to compare items numerically. - * @link http://www.php.net/manual/en/array.constants.php - * @var int + * {@inheritdoc} + * @param string $string */ -define ('SORT_NUMERIC', 1); +function urlencode (string $string): string {} /** - * SORT_STRING is used to compare items as strings. - * @link http://www.php.net/manual/en/array.constants.php - * @var int + * {@inheritdoc} + * @param string $string */ -define ('SORT_STRING', 2); +function urldecode (string $string): string {} /** - * SORT_LOCALE_STRING is used to compare items as - * strings, based on the current locale. - * @link http://www.php.net/manual/en/array.constants.php - * @var int + * {@inheritdoc} + * @param string $string */ -define ('SORT_LOCALE_STRING', 5); +function rawurlencode (string $string): string {} /** - * SORT_NATURAL is used to compare items as - * strings using "natural ordering" like natsort. - * @link http://www.php.net/manual/en/array.constants.php - * @var int + * {@inheritdoc} + * @param string $string */ -define ('SORT_NATURAL', 6); +function rawurldecode (string $string): string {} /** - * SORT_FLAG_CASE can be combined (bitwise OR) with - * SORT_STRING or SORT_NATURAL to - * sort strings case-insensitively. As of PHP 8.2.0, only ASCII case folding - * will be done. - * @link http://www.php.net/manual/en/array.constants.php - * @var int + * {@inheritdoc} + * @param string $url + * @param bool $associative [optional] + * @param mixed $context [optional] */ -define ('SORT_FLAG_CASE', 8); +function get_headers (string $url, bool $associative = false, $context = NULL): array|false {} /** - * CASE_LOWER is used with - * array_change_key_case and is used to convert array - * keys to lower case. This is also the default case for - * array_change_key_case. As of PHP 8.2.0, only ASCII - * characters will be converted. - * @link http://www.php.net/manual/en/array.constants.php - * @var int + * {@inheritdoc} + * @param mixed $brigade */ -define ('CASE_LOWER', 0); +function stream_bucket_make_writeable ($brigade = null): ?object {} /** - * CASE_UPPER is used with - * array_change_key_case and is used to convert array - * keys to upper case. As of PHP 8.2.0, only ASCII characters will be - * converted. - * @link http://www.php.net/manual/en/array.constants.php - * @var int + * {@inheritdoc} + * @param mixed $brigade + * @param object $bucket */ -define ('CASE_UPPER', 1); +function stream_bucket_prepend ($brigade = null, object $bucket): void {} /** - * - * @link http://www.php.net/manual/en/array.constants.php - * @var int + * {@inheritdoc} + * @param mixed $brigade + * @param object $bucket */ -define ('COUNT_NORMAL', 0); +function stream_bucket_append ($brigade = null, object $bucket): void {} /** - * - * @link http://www.php.net/manual/en/array.constants.php - * @var int + * {@inheritdoc} + * @param mixed $stream + * @param string $buffer */ -define ('COUNT_RECURSIVE', 1); +function stream_bucket_new ($stream = null, string $buffer): object {} /** - * ARRAY_FILTER_USE_BOTH is used with - * array_filter to pass both value and key to the given callback function. - * @link http://www.php.net/manual/en/array.constants.php - * @var int + * {@inheritdoc} */ -define ('ARRAY_FILTER_USE_BOTH', 1); +function stream_get_filters (): array {} /** - * ARRAY_FILTER_USE_KEY is used with - * array_filter to pass each key as the first argument to the given callback function. - * @link http://www.php.net/manual/en/array.constants.php - * @var int + * {@inheritdoc} + * @param string $filter_name + * @param string $class */ -define ('ARRAY_FILTER_USE_KEY', 2); +function stream_filter_register (string $filter_name, string $class): bool {} /** - * - * @link http://www.php.net/manual/en/misc.constants.php - * @var int + * {@inheritdoc} + * @param string $string */ -define ('CONNECTION_ABORTED', 1); +function convert_uuencode (string $string): string {} /** - * - * @link http://www.php.net/manual/en/misc.constants.php - * @var int + * {@inheritdoc} + * @param string $string */ -define ('CONNECTION_NORMAL', 0); +function convert_uudecode (string $string): string|false {} /** - * - * @link http://www.php.net/manual/en/misc.constants.php - * @var int + * {@inheritdoc} + * @param mixed $value + * @param mixed $values [optional] */ -define ('CONNECTION_TIMEOUT', 2); -define ('INI_USER', 1); -define ('INI_PERDIR', 2); -define ('INI_SYSTEM', 4); -define ('INI_ALL', 7); +function var_dump (mixed $value = null, mixed ...$values): void {} /** - * Normal INI scanner mode. - * @link http://www.php.net/manual/en/filesystem.constants.php - * @var int + * {@inheritdoc} + * @param mixed $value + * @param bool $return [optional] */ -define ('INI_SCANNER_NORMAL', 0); +function var_export (mixed $value = null, bool $return = false): ?string {} /** - * Raw INI scanner mode. - * @link http://www.php.net/manual/en/filesystem.constants.php - * @var int + * {@inheritdoc} + * @param mixed $value + * @param mixed $values [optional] */ -define ('INI_SCANNER_RAW', 1); +function debug_zval_dump (mixed $value = null, mixed ...$values): void {} /** - * Typed INI scanner mode. - * @link http://www.php.net/manual/en/filesystem.constants.php - * @var int + * {@inheritdoc} + * @param mixed $value */ -define ('INI_SCANNER_TYPED', 2); +function serialize (mixed $value = null): string {} /** - * - * @link http://www.php.net/manual/en/url.constants.php - * @var int + * {@inheritdoc} + * @param string $data + * @param array $options [optional] */ -define ('PHP_URL_SCHEME', 0); +function unserialize (string $data, array $options = array ( +)): mixed {} /** - * Outputs the hostname of the URL parsed. - * @link http://www.php.net/manual/en/url.constants.php - * @var int + * {@inheritdoc} + * @param bool $real_usage [optional] */ -define ('PHP_URL_HOST', 1); +function memory_get_usage (bool $real_usage = false): int {} /** - * Outputs the port of the URL parsed. - * @link http://www.php.net/manual/en/url.constants.php - * @var int + * {@inheritdoc} + * @param bool $real_usage [optional] */ -define ('PHP_URL_PORT', 2); +function memory_get_peak_usage (bool $real_usage = false): int {} /** - * Outputs the user of the URL parsed. - * @link http://www.php.net/manual/en/url.constants.php - * @var int + * {@inheritdoc} */ -define ('PHP_URL_USER', 3); +function memory_reset_peak_usage (): void {} /** - * Outputs the password of the URL parsed. - * @link http://www.php.net/manual/en/url.constants.php - * @var int + * {@inheritdoc} + * @param string $version1 + * @param string $version2 + * @param string|null $operator [optional] */ -define ('PHP_URL_PASS', 4); +function version_compare (string $version1, string $version2, ?string $operator = NULL): int|bool {} /** - * Outputs the path of the URL parsed. - * @link http://www.php.net/manual/en/url.constants.php - * @var int + * {@inheritdoc} + * @param string $extension_filename */ -define ('PHP_URL_PATH', 5); +function dl (string $extension_filename): bool {} /** - * Outputs the query string of the URL parsed. - * @link http://www.php.net/manual/en/url.constants.php - * @var int + * {@inheritdoc} + * @param string $title */ -define ('PHP_URL_QUERY', 6); +function cli_set_process_title (string $title): bool {} /** - * Outputs the fragment (string after the hashmark #) of the URL parsed. - * @link http://www.php.net/manual/en/url.constants.php - * @var int + * {@inheritdoc} */ -define ('PHP_URL_FRAGMENT', 7); +function cli_get_process_title (): ?string {} -/** - * Encoding is performed per - * RFC 1738 and the - * application/x-www-form-urlencoded media type, which - * implies that spaces are encoded as plus (+) signs. - * @link http://www.php.net/manual/en/url.constants.php - * @var int - */ +define ('EXTR_OVERWRITE', 0); +define ('EXTR_SKIP', 1); +define ('EXTR_PREFIX_SAME', 2); +define ('EXTR_PREFIX_ALL', 3); +define ('EXTR_PREFIX_INVALID', 4); +define ('EXTR_PREFIX_IF_EXISTS', 5); +define ('EXTR_IF_EXISTS', 6); +define ('EXTR_REFS', 256); +define ('SORT_ASC', 4); +define ('SORT_DESC', 3); +define ('SORT_REGULAR', 0); +define ('SORT_NUMERIC', 1); +define ('SORT_STRING', 2); +define ('SORT_LOCALE_STRING', 5); +define ('SORT_NATURAL', 6); +define ('SORT_FLAG_CASE', 8); +define ('CASE_LOWER', 0); +define ('CASE_UPPER', 1); +define ('COUNT_NORMAL', 0); +define ('COUNT_RECURSIVE', 1); +define ('ARRAY_FILTER_USE_BOTH', 1); +define ('ARRAY_FILTER_USE_KEY', 2); +define ('ASSERT_ACTIVE', 1); +define ('ASSERT_CALLBACK', 2); +define ('ASSERT_BAIL', 3); +define ('ASSERT_WARNING', 4); +define ('ASSERT_EXCEPTION', 5); +define ('CONNECTION_ABORTED', 1); +define ('CONNECTION_NORMAL', 0); +define ('CONNECTION_TIMEOUT', 2); +define ('INI_USER', 1); +define ('INI_PERDIR', 2); +define ('INI_SYSTEM', 4); +define ('INI_ALL', 7); +define ('INI_SCANNER_NORMAL', 0); +define ('INI_SCANNER_RAW', 1); +define ('INI_SCANNER_TYPED', 2); +define ('PHP_URL_SCHEME', 0); +define ('PHP_URL_HOST', 1); +define ('PHP_URL_PORT', 2); +define ('PHP_URL_USER', 3); +define ('PHP_URL_PASS', 4); +define ('PHP_URL_PATH', 5); +define ('PHP_URL_QUERY', 6); +define ('PHP_URL_FRAGMENT', 7); define ('PHP_QUERY_RFC1738', 1); - -/** - * Encoding is performed according to RFC 3986, - * and spaces will be percent encoded (%20). - * @link http://www.php.net/manual/en/url.constants.php - * @var int - */ define ('PHP_QUERY_RFC3986', 2); define ('M_E', 2.718281828459); define ('M_LOG2E', 1.442695040889); @@ -6967,6 +3818,13 @@ function cli_get_process_title (): ?string {} define ('PHP_ROUND_HALF_DOWN', 2); define ('PHP_ROUND_HALF_EVEN', 3); define ('PHP_ROUND_HALF_ODD', 4); +define ('CRYPT_SALT_LENGTH', 123); +define ('CRYPT_STD_DES', 1); +define ('CRYPT_EXT_DES', 1); +define ('CRYPT_MD5', 1); +define ('CRYPT_BLOWFISH', 1); +define ('CRYPT_SHA256', 1); +define ('CRYPT_SHA512', 1); define ('DNS_A', 1); define ('DNS_NS', 2); define ('DNS_CNAME', 16); @@ -6982,181 +3840,56 @@ function cli_get_process_title (): ?string {} define ('DNS_A6', 16777216); define ('DNS_ANY', 268435456); define ('DNS_ALL', 251721779); - -/** - * > - * Image type constant used by the image_type_to_mime_type - * and image_type_to_extension functions. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ +define ('HTML_SPECIALCHARS', 0); +define ('HTML_ENTITIES', 1); +define ('ENT_COMPAT', 2); +define ('ENT_QUOTES', 3); +define ('ENT_NOQUOTES', 0); +define ('ENT_IGNORE', 4); +define ('ENT_SUBSTITUTE', 8); +define ('ENT_DISALLOWED', 128); +define ('ENT_HTML401', 0); +define ('ENT_XML1', 16); +define ('ENT_XHTML', 32); +define ('ENT_HTML5', 48); define ('IMAGETYPE_GIF', 1); - -/** - * > - * Image type constant used by the image_type_to_mime_type - * and image_type_to_extension functions. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMAGETYPE_JPEG', 2); - -/** - * > - * Image type constant used by the image_type_to_mime_type - * and image_type_to_extension functions. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMAGETYPE_PNG', 3); - -/** - * > - * Image type constant used by the image_type_to_mime_type - * and image_type_to_extension functions. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMAGETYPE_SWF', 4); - -/** - * > - * Image type constant used by the image_type_to_mime_type - * and image_type_to_extension functions. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMAGETYPE_PSD', 5); - -/** - * > - * Image type constant used by the image_type_to_mime_type - * and image_type_to_extension functions. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMAGETYPE_BMP', 6); - -/** - * > - * Image type constant used by the image_type_to_mime_type - * and image_type_to_extension functions. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMAGETYPE_TIFF_II', 7); - -/** - * > - * Image type constant used by the image_type_to_mime_type - * and image_type_to_extension functions. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMAGETYPE_TIFF_MM', 8); - -/** - * > - * Image type constant used by the image_type_to_mime_type - * and image_type_to_extension functions. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMAGETYPE_JPC', 9); - -/** - * > - * Image type constant used by the image_type_to_mime_type - * and image_type_to_extension functions. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMAGETYPE_JP2', 10); - -/** - * > - * Image type constant used by the image_type_to_mime_type - * and image_type_to_extension functions. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMAGETYPE_JPX', 11); - -/** - * > - * Image type constant used by the image_type_to_mime_type - * and image_type_to_extension functions. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMAGETYPE_JB2', 12); - -/** - * > - * Image type constant used by the image_type_to_mime_type - * and image_type_to_extension functions. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMAGETYPE_SWC', 13); - -/** - * > - * Image type constant used by the image_type_to_mime_type - * and image_type_to_extension functions. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMAGETYPE_IFF', 14); - -/** - * > - * Image type constant used by the image_type_to_mime_type - * and image_type_to_extension functions. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMAGETYPE_WBMP', 15); - -/** - * > - * Image type constant used by the image_type_to_mime_type - * and image_type_to_extension functions. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMAGETYPE_JPEG2000', 9); - -/** - * > - * Image type constant used by the image_type_to_mime_type - * and image_type_to_extension functions. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMAGETYPE_XBM', 16); - -/** - * > - * Image type constant used by the image_type_to_mime_type - * and image_type_to_extension functions. - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMAGETYPE_ICO', 17); - -/** - * > - * Image type constant used by the image_type_to_mime_type - * and image_type_to_extension functions. - * (Available as of PHP 7.1.0) - * @link http://www.php.net/manual/en/image.constants.php - * @var int - */ define ('IMAGETYPE_WEBP', 18); define ('IMAGETYPE_AVIF', 19); define ('IMAGETYPE_UNKNOWN', 0); define ('IMAGETYPE_COUNT', 20); +define ('INFO_GENERAL', 1); +define ('INFO_CREDITS', 2); +define ('INFO_CONFIGURATION', 4); +define ('INFO_MODULES', 8); +define ('INFO_ENVIRONMENT', 16); +define ('INFO_VARIABLES', 32); +define ('INFO_LICENSE', 64); +define ('INFO_ALL', 4294967295); +define ('CREDITS_GROUP', 1); +define ('CREDITS_GENERAL', 2); +define ('CREDITS_SAPI', 4); +define ('CREDITS_MODULES', 8); +define ('CREDITS_DOCS', 16); +define ('CREDITS_FULLPAGE', 32); +define ('CREDITS_QA', 64); +define ('CREDITS_ALL', 4294967295); define ('LOG_EMERG', 0); define ('LOG_ALERT', 1); define ('LOG_CRIT', 2); @@ -7190,260 +3923,85 @@ function cli_get_process_title (): ?string {} define ('LOG_NDELAY', 8); define ('LOG_NOWAIT', 16); define ('LOG_PERROR', 32); - -/** - * - * @link http://www.php.net/manual/en/string.constants.php - * @var int - */ define ('STR_PAD_LEFT', 0); - -/** - * - * @link http://www.php.net/manual/en/string.constants.php - * @var int - */ define ('STR_PAD_RIGHT', 1); - -/** - * - * @link http://www.php.net/manual/en/string.constants.php - * @var int - */ define ('STR_PAD_BOTH', 2); - -/** - * - * @link http://www.php.net/manual/en/filesystem.constants.php - * @var int - */ define ('PATHINFO_DIRNAME', 1); - -/** - * - * @link http://www.php.net/manual/en/filesystem.constants.php - * @var int - */ define ('PATHINFO_BASENAME', 2); - -/** - * - * @link http://www.php.net/manual/en/filesystem.constants.php - * @var int - */ define ('PATHINFO_EXTENSION', 4); - -/** - * - * @link http://www.php.net/manual/en/filesystem.constants.php - * @var int - */ define ('PATHINFO_FILENAME', 8); define ('PATHINFO_ALL', 15); - -/** - * - * @link http://www.php.net/manual/en/string.constants.php - * @var int - */ define ('CHAR_MAX', 127); - -/** - * - * @link http://www.php.net/manual/en/string.constants.php - * @var int - */ define ('LC_CTYPE', 2); - -/** - * - * @link http://www.php.net/manual/en/string.constants.php - * @var int - */ define ('LC_NUMERIC', 4); - -/** - * - * @link http://www.php.net/manual/en/string.constants.php - * @var int - */ define ('LC_TIME', 5); - -/** - * - * @link http://www.php.net/manual/en/string.constants.php - * @var int - */ define ('LC_COLLATE', 1); - -/** - * - * @link http://www.php.net/manual/en/string.constants.php - * @var int - */ define ('LC_MONETARY', 3); - -/** - * - * @link http://www.php.net/manual/en/string.constants.php - * @var int - */ define ('LC_ALL', 0); - -/** - * - * @link http://www.php.net/manual/en/string.constants.php - * @var int - */ define ('LC_MESSAGES', 6); -define ('INFO_GENERAL', 1); -define ('INFO_CREDITS', 2); -define ('INFO_CONFIGURATION', 4); -define ('INFO_MODULES', 8); -define ('INFO_ENVIRONMENT', 16); -define ('INFO_VARIABLES', 32); -define ('INFO_LICENSE', 64); -define ('INFO_ALL', 4294967295); -define ('CREDITS_GROUP', 1); -define ('CREDITS_GENERAL', 2); -define ('CREDITS_SAPI', 4); -define ('CREDITS_MODULES', 8); -define ('CREDITS_DOCS', 16); -define ('CREDITS_FULLPAGE', 32); -define ('CREDITS_QA', 64); -define ('CREDITS_ALL', 4294967295); - -/** - * - * @link http://www.php.net/manual/en/string.constants.php - * @var int - */ -define ('HTML_SPECIALCHARS', 0); - -/** - * - * @link http://www.php.net/manual/en/string.constants.php - * @var int - */ -define ('HTML_ENTITIES', 1); - -/** - * - * @link http://www.php.net/manual/en/string.constants.php - * @var int - */ -define ('ENT_COMPAT', 2); - -/** - * - * @link http://www.php.net/manual/en/string.constants.php - * @var int - */ -define ('ENT_QUOTES', 3); - -/** - * - * @link http://www.php.net/manual/en/string.constants.php - * @var int - */ -define ('ENT_NOQUOTES', 0); - -/** - * - * @link http://www.php.net/manual/en/string.constants.php - * @var int - */ -define ('ENT_IGNORE', 4); - -/** - * - * @link http://www.php.net/manual/en/string.constants.php - * @var int - */ -define ('ENT_SUBSTITUTE', 8); - -/** - * - * @link http://www.php.net/manual/en/string.constants.php - * @var int - */ -define ('ENT_DISALLOWED', 128); - -/** - * - * @link http://www.php.net/manual/en/string.constants.php - * @var int - */ -define ('ENT_HTML401', 0); - -/** - * - * @link http://www.php.net/manual/en/string.constants.php - * @var int - */ -define ('ENT_XML1', 16); - -/** - * - * @link http://www.php.net/manual/en/string.constants.php - * @var int - */ -define ('ENT_XHTML', 32); - -/** - * - * @link http://www.php.net/manual/en/string.constants.php - * @var int - */ -define ('ENT_HTML5', 48); - -/** - * - * @link http://www.php.net/manual/en/filesystem.constants.php - * @var int - */ +define ('ABDAY_1', 14); +define ('ABDAY_2', 15); +define ('ABDAY_3', 16); +define ('ABDAY_4', 17); +define ('ABDAY_5', 18); +define ('ABDAY_6', 19); +define ('ABDAY_7', 20); +define ('DAY_1', 7); +define ('DAY_2', 8); +define ('DAY_3', 9); +define ('DAY_4', 10); +define ('DAY_5', 11); +define ('DAY_6', 12); +define ('DAY_7', 13); +define ('ABMON_1', 33); +define ('ABMON_2', 34); +define ('ABMON_3', 35); +define ('ABMON_4', 36); +define ('ABMON_5', 37); +define ('ABMON_6', 38); +define ('ABMON_7', 39); +define ('ABMON_8', 40); +define ('ABMON_9', 41); +define ('ABMON_10', 42); +define ('ABMON_11', 43); +define ('ABMON_12', 44); +define ('MON_1', 21); +define ('MON_2', 22); +define ('MON_3', 23); +define ('MON_4', 24); +define ('MON_5', 25); +define ('MON_6', 26); +define ('MON_7', 27); +define ('MON_8', 28); +define ('MON_9', 29); +define ('MON_10', 30); +define ('MON_11', 31); +define ('MON_12', 32); +define ('AM_STR', 5); +define ('PM_STR', 6); +define ('D_T_FMT', 1); +define ('D_FMT', 2); +define ('T_FMT', 3); +define ('T_FMT_AMPM', 4); +define ('ERA', 45); +define ('ERA_D_T_FMT', 47); +define ('ERA_D_FMT', 46); +define ('ERA_T_FMT', 48); +define ('ALT_DIGITS', 49); +define ('CRNCYSTR', 56); +define ('RADIXCHAR', 50); +define ('THOUSEP', 51); +define ('YESEXPR', 52); +define ('NOEXPR', 53); +define ('YESSTR', 54); +define ('NOSTR', 55); +define ('CODESET', 0); define ('SEEK_SET', 0); - -/** - * - * @link http://www.php.net/manual/en/filesystem.constants.php - * @var int - */ define ('SEEK_CUR', 1); - -/** - * - * @link http://www.php.net/manual/en/filesystem.constants.php - * @var int - */ define ('SEEK_END', 2); - -/** - * - * @link http://www.php.net/manual/en/filesystem.constants.php - * @var int - */ define ('LOCK_SH', 1); - -/** - * - * @link http://www.php.net/manual/en/filesystem.constants.php - * @var int - */ define ('LOCK_EX', 2); - -/** - * - * @link http://www.php.net/manual/en/filesystem.constants.php - * @var int - */ define ('LOCK_UN', 3); - -/** - * - * @link http://www.php.net/manual/en/filesystem.constants.php - * @var int - */ define ('LOCK_NB', 4); define ('STREAM_NOTIFY_CONNECT', 2); define ('STREAM_NOTIFY_AUTH_REQUIRED', 3); @@ -7507,95 +4065,16 @@ function cli_get_process_title (): ?string {} define ('STREAM_OOB', 1); define ('STREAM_SERVER_BIND', 4); define ('STREAM_SERVER_LISTEN', 8); - -/** - * Search for filename in - * include_path. - * @link http://www.php.net/manual/en/ini.include-path.php - * @var int - */ define ('FILE_USE_INCLUDE_PATH', 1); - -/** - * Strip EOL characters. - * @link http://www.php.net/manual/en/filesystem.constants.php - * @var int - */ define ('FILE_IGNORE_NEW_LINES', 2); - -/** - * Skip empty lines. - * @link http://www.php.net/manual/en/filesystem.constants.php - * @var int - */ define ('FILE_SKIP_EMPTY_LINES', 4); - -/** - * Append content to existing file. - * @link http://www.php.net/manual/en/filesystem.constants.php - * @var int - */ define ('FILE_APPEND', 8); - -/** - * - * @link http://www.php.net/manual/en/filesystem.constants.php - * @var int - */ define ('FILE_NO_DEFAULT_CONTEXT', 16); - -/** - * Text mode. - *- * This constant has no effect, and is only available for - * forward compatibility. - *
- *This constant has no effect, and is only available for - * forward compatibility.
- * @link http://www.php.net/manual/en/filesystem.constants.php - * @var int - */ define ('FILE_TEXT', 0); - -/** - * Binary mode. - *- * This constant has no effect, and is only available for - * forward compatibility. - *
- *This constant has no effect, and is only available for - * forward compatibility.
- * @link http://www.php.net/manual/en/filesystem.constants.php - * @var int - */ define ('FILE_BINARY', 0); - -/** - * Disable backslash escaping. - * @link http://www.php.net/manual/en/filesystem.constants.php - * @var int - */ define ('FNM_NOESCAPE', 1); - -/** - * Slash in string only matches slash in the given pattern. - * @link http://www.php.net/manual/en/filesystem.constants.php - * @var int - */ define ('FNM_PATHNAME', 2); - -/** - * Leading period in string must be exactly matched by period in the given pattern. - * @link http://www.php.net/manual/en/filesystem.constants.php - * @var int - */ define ('FNM_PERIOD', 4); - -/** - * Caseless match. Part of the GNU extension. - * @link http://www.php.net/manual/en/filesystem.constants.php - * @var int - */ define ('FNM_CASEFOLD', 16); define ('PSFS_PASS_ON', 2); define ('PSFS_FEED_ME', 1); @@ -7603,293 +4082,28 @@ function cli_get_process_title (): ?string {} define ('PSFS_FLAG_NORMAL', 0); define ('PSFS_FLAG_FLUSH_INC', 1); define ('PSFS_FLAG_FLUSH_CLOSE', 2); - -/** - * The default algorithm to use for hashing if no algorithm is provided. - * This may change in newer PHP releases when newer, stronger hashing - * algorithms are supported. - *It is worth noting that over time this constant can (and likely will) - * change. Therefore you should be aware that the length of the resulting - * hash can change. Therefore, if you use PASSWORD_DEFAULT - * you should store the resulting hash in a way that can store more than 60 - * characters (255 is the recommended width).
- *Values for this constant:
- * @link http://www.php.net/manual/en/password.constants.php - * @var mixed - */ define ('PASSWORD_DEFAULT', "2y"); - -/** - * PASSWORD_BCRYPT is used to create new password - * hashes using the CRYPT_BLOWFISH algorithm. - *This will always result in a hash using the "$2y$" crypt format, - * which is always 60 characters wide.
- *Supported Options:
- *salt (string) - to manually provide a salt to use when hashing the password. - * Note that this will override and prevent a salt from being automatically generated.
- *If omitted, a random salt will be generated by password_hash for - * each password hashed. This is the intended mode of operation - * and as of PHP 7.0.0 the salt option has been deprecated.
- *cost (int) - which denotes the algorithmic cost that - * should be used. Examples of these values can be found on the crypt - * page.
- *If omitted, a default value of 10 will be used. This is a good - * baseline cost, but you may want to consider increasing it depending on your hardware.
- * @link http://www.php.net/manual/en/password.constants.php - * @var string - */ define ('PASSWORD_BCRYPT', "2y"); - -/** - * PASSWORD_ARGON2I is used to create new password - * hashes using the Argon2i algorithm. - *Supported Options:
- *memory_cost (int) - Maximum memory (in kibibytes) that may - * be used to compute the Argon2 hash. Defaults to PASSWORD_ARGON2_DEFAULT_MEMORY_COST.
- *time_cost (int) - Maximum amount of time it may - * take to compute the Argon2 hash. Defaults to PASSWORD_ARGON2_DEFAULT_TIME_COST.
- *threads (int) - Number of threads to use for computing - * the Argon2 hash. Defaults to PASSWORD_ARGON2_DEFAULT_THREADS. - * Only available with libargon2, not with libsodium implementation.
- *Available as of PHP 7.2.0.
- * @link http://www.php.net/manual/en/password.constants.php - * @var string - */ define ('PASSWORD_ARGON2I', "argon2i"); - -/** - * PASSWORD_ARGON2ID is used to create new password - * hashes using the Argon2id algorithm. It supports the same options as - * PASSWORD_ARGON2I. - *Available as of PHP 7.3.0.
- * @link http://www.php.net/manual/en/constant.password-argon2i.php - * @var string - */ define ('PASSWORD_ARGON2ID', "argon2id"); define ('PASSWORD_BCRYPT_DEFAULT_COST', 10); - -/** - * Default amount of memory in bytes that will be used while trying to - * compute a hash. - *Available as of PHP 7.2.0.
- * @link http://www.php.net/manual/en/password.constants.php - * @var int - */ define ('PASSWORD_ARGON2_DEFAULT_MEMORY_COST', 65536); - -/** - * Default amount of time that will be spent trying to compute a hash. - *Available as of PHP 7.2.0.
- * @link http://www.php.net/manual/en/password.constants.php - * @var int - */ define ('PASSWORD_ARGON2_DEFAULT_TIME_COST', 4); - -/** - * Default number of threads that Argon2lib will use. - * Not available with libsodium implementation. - *Available as of PHP 7.2.0.
- * @link http://www.php.net/manual/en/password.constants.php - * @var int - */ define ('PASSWORD_ARGON2_DEFAULT_THREADS', 1); define ('PASSWORD_ARGON2_PROVIDER', "standard"); -define ('ABDAY_1', 14); -define ('ABDAY_2', 15); -define ('ABDAY_3', 16); -define ('ABDAY_4', 17); -define ('ABDAY_5', 18); -define ('ABDAY_6', 19); -define ('ABDAY_7', 20); -define ('DAY_1', 7); -define ('DAY_2', 8); -define ('DAY_3', 9); -define ('DAY_4', 10); -define ('DAY_5', 11); -define ('DAY_6', 12); -define ('DAY_7', 13); -define ('ABMON_1', 33); -define ('ABMON_2', 34); -define ('ABMON_3', 35); -define ('ABMON_4', 36); -define ('ABMON_5', 37); -define ('ABMON_6', 38); -define ('ABMON_7', 39); -define ('ABMON_8', 40); -define ('ABMON_9', 41); -define ('ABMON_10', 42); -define ('ABMON_11', 43); -define ('ABMON_12', 44); -define ('MON_1', 21); -define ('MON_2', 22); -define ('MON_3', 23); -define ('MON_4', 24); -define ('MON_5', 25); -define ('MON_6', 26); -define ('MON_7', 27); -define ('MON_8', 28); -define ('MON_9', 29); -define ('MON_10', 30); -define ('MON_11', 31); -define ('MON_12', 32); -define ('AM_STR', 5); -define ('PM_STR', 6); -define ('D_T_FMT', 1); -define ('D_FMT', 2); -define ('T_FMT', 3); -define ('T_FMT_AMPM', 4); -define ('ERA', 45); -define ('ERA_D_T_FMT', 47); -define ('ERA_D_FMT', 46); -define ('ERA_T_FMT', 48); -define ('ALT_DIGITS', 49); -define ('CRNCYSTR', 56); -define ('RADIXCHAR', 50); -define ('THOUSEP', 51); -define ('YESEXPR', 52); -define ('NOEXPR', 53); -define ('YESSTR', 54); -define ('NOSTR', 55); -define ('CODESET', 0); - -/** - * - * @link http://www.php.net/manual/en/string.constants.php - * @var int - */ -define ('CRYPT_SALT_LENGTH', 123); - -/** - * Indicates whether standard DES-based hashes are supported in crypt. Always 1. - * @link http://www.php.net/manual/en/string.constants.php - * @var int - */ -define ('CRYPT_STD_DES', 1); - -/** - * Indicates whether extended DES-based hashes are supported in crypt. Always 1. - * @link http://www.php.net/manual/en/string.constants.php - * @var int - */ -define ('CRYPT_EXT_DES', 1); - -/** - * Indicates whether MD5 hashes are supported in crypt. Always 1. - * @link http://www.php.net/manual/en/string.constants.php - * @var int - */ -define ('CRYPT_MD5', 1); - -/** - * Indicates whether Blowfish hashes are supported in crypt. Always 1. - * @link http://www.php.net/manual/en/string.constants.php - * @var int - */ -define ('CRYPT_BLOWFISH', 1); - -/** - * Indicates whether SHA-256 hashes are supported in crypt. Always 1. - * @link http://www.php.net/manual/en/string.constants.php - * @var int - */ -define ('CRYPT_SHA256', 1); - -/** - * Indicates whether SHA-512 hashes are supported in crypt. Always 1. - * @link http://www.php.net/manual/en/string.constants.php - * @var int - */ -define ('CRYPT_SHA512', 1); - -/** - * - * @link http://www.php.net/manual/en/dir.constants.php - * @var string - */ define ('DIRECTORY_SEPARATOR', "/"); - -/** - * Semicolon on Windows, colon otherwise. - * @link http://www.php.net/manual/en/dir.constants.php - * @var string - */ define ('PATH_SEPARATOR', ":"); - -/** - * - * @link http://www.php.net/manual/en/dir.constants.php - * @var int - */ define ('SCANDIR_SORT_ASCENDING', 0); - -/** - * - * @link http://www.php.net/manual/en/dir.constants.php - * @var int - */ define ('SCANDIR_SORT_DESCENDING', 1); - -/** - * - * @link http://www.php.net/manual/en/dir.constants.php - * @var int - */ define ('SCANDIR_SORT_NONE', 2); - -/** - * - * @link http://www.php.net/manual/en/filesystem.constants.php - * @var int - */ define ('GLOB_BRACE', 128); - -/** - * - * @link http://www.php.net/manual/en/filesystem.constants.php - * @var int - */ define ('GLOB_MARK', 8); - -/** - * - * @link http://www.php.net/manual/en/filesystem.constants.php - * @var int - */ define ('GLOB_NOSORT', 32); - -/** - * - * @link http://www.php.net/manual/en/filesystem.constants.php - * @var int - */ define ('GLOB_NOCHECK', 16); - -/** - * - * @link http://www.php.net/manual/en/filesystem.constants.php - * @var int - */ define ('GLOB_NOESCAPE', 8192); define ('GLOB_ERR', 4); - -/** - * - * @link http://www.php.net/manual/en/filesystem.constants.php - * @var int - */ define ('GLOB_ONLYDIR', 1073741824); - -/** - * - * @link http://www.php.net/manual/en/filesystem.constants.php - * @var int - */ define ('GLOB_AVAILABLE_FLAGS', 1073750204); -define ('ASSERT_ACTIVE', 1); -define ('ASSERT_CALLBACK', 2); -define ('ASSERT_BAIL', 3); -define ('ASSERT_WARNING', 4); -define ('ASSERT_EXCEPTION', 5); define ('STREAM_USE_PATH', 1); define ('STREAM_IGNORE_URL', 2); define ('STREAM_REPORT_ERRORS', 8); @@ -7914,4 +4128,4 @@ function cli_get_process_title (): ?string {} define ('STREAM_META_GROUP_NAME', 4); define ('STREAM_META_ACCESS', 6); -// End of standard v.8.2.6 +// End of standard v.8.3.0 diff --git a/plugins/org.eclipse.php.core/Resources/language/php8.3/sysvmsg.php b/plugins/org.eclipse.php.core/Resources/language/php8.3/sysvmsg.php index 9f01a131cd..cff9810c0a 100644 --- a/plugins/org.eclipse.php.core/Resources/language/php8.3/sysvmsg.php +++ b/plugins/org.eclipse.php.core/Resources/language/php8.3/sysvmsg.php @@ -1,196 +1,70 @@ Upon successful completion the message queue data structure is updated as - * follows: msg_lspid is set to the process-ID of the - * calling process, msg_qnum is incremented by 1 and - * msg_stime is set to the current time. + * {@inheritdoc} + * @param SysvMessageQueue $queue + * @param int $message_type + * @param mixed $message + * @param bool $serialize [optional] + * @param bool $blocking [optional] + * @param mixed $error_code [optional] */ -function msg_send (SysvMessageQueue $queue, int $message_type, string|int|float|bool $message, bool $serialize = true, bool $blocking = true, int &$error_code = null): bool {} +function msg_send (SysvMessageQueue $queue, int $message_type, $message = null, bool $serialize = true, bool $blocking = true, &$error_code = NULL): bool {} /** - * Receive a message from a message queue - * @link http://www.php.net/manual/en/function.msg-receive.php - * @param SysvMessageQueue $queue - * @param int $desired_message_type - * @param int $received_message_type - * @param int $max_message_size - * @param mixed $message - * @param bool $unserialize [optional] - * @param int $flags [optional] - * @param int $error_code [optional] - * @return bool Returns true on success or false on failure. - *Upon successful completion the message queue data structure is updated as - * follows: msg_lrpid is set to the process-ID of the - * calling process, msg_qnum is decremented by 1 and - * msg_rtime is set to the current time.
+ * {@inheritdoc} + * @param SysvMessageQueue $queue + * @param int $desired_message_type + * @param mixed $received_message_type + * @param int $max_message_size + * @param mixed $message + * @param bool $unserialize [optional] + * @param int $flags [optional] + * @param mixed $error_code [optional] */ -function msg_receive (SysvMessageQueue $queue, int $desired_message_type, int &$received_message_type, int $max_message_size, mixed &$message, bool $unserialize = true, int $flags = null, int &$error_code = null): bool {} +function msg_receive (SysvMessageQueue $queue, int $desired_message_type, &$received_message_type = null, int $max_message_size, mixed &$message = null, bool $unserialize = true, int $flags = 0, &$error_code = NULL): bool {} /** - * Destroy a message queue - * @link http://www.php.net/manual/en/function.msg-remove-queue.php - * @param SysvMessageQueue $queue - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param SysvMessageQueue $queue */ function msg_remove_queue (SysvMessageQueue $queue): bool {} /** - * Returns information from the message queue data structure - * @link http://www.php.net/manual/en/function.msg-stat-queue.php - * @param SysvMessageQueue $queue - * @return array|false On success, the return value is an array whose keys and values have the following - * meanings: - *msg_perm.uid | - *- * The uid of the owner of the queue. - * | - *
msg_perm.gid | - *- * The gid of the owner of the queue. - * | - *
msg_perm.mode | - *- * The file access mode of the queue. - * | - *
msg_stime | - *- * The time that the last message was sent to the queue. - * | - *
msg_rtime | - *- * The time that the last message was received from the queue. - * | - *
msg_ctime | - *- * The time that the queue was last changed. - * | - *
msg_qnum | - *- * The number of messages waiting to be read from the queue. - * | - *
msg_qbytes | - *- * The maximum number of bytes allowed in one message queue. On - * Linux, this value may be read and modified via - * /proc/sys/kernel/msgmnb. - * | - *
msg_lspid | - *- * The pid of the process that sent the last message to the queue. - * | - *
msg_lrpid | - *- * The pid of the process that received the last message from the queue. - * | - *
Returns false on failure.
+ * {@inheritdoc} + * @param SysvMessageQueue $queue */ function msg_stat_queue (SysvMessageQueue $queue): array|false {} /** - * Set information in the message queue data structure - * @link http://www.php.net/manual/en/function.msg-set-queue.php - * @param SysvMessageQueue $queue - * @param array $data - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param SysvMessageQueue $queue + * @param array $data */ function msg_set_queue (SysvMessageQueue $queue, array $data): bool {} /** - * Check whether a message queue exists - * @link http://www.php.net/manual/en/function.msg-queue-exists.php - * @param int $key - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $key */ function msg_queue_exists (int $key): bool {} - -/** - * - * @link http://www.php.net/manual/en/sem.constants.php - * @var int - */ define ('MSG_IPC_NOWAIT', 1); - -/** - * - * @link http://www.php.net/manual/en/sem.constants.php - * @var int - */ define ('MSG_EAGAIN', 35); - -/** - * - * @link http://www.php.net/manual/en/sem.constants.php - * @var int - */ define ('MSG_ENOMSG', 91); - -/** - * - * @link http://www.php.net/manual/en/sem.constants.php - * @var int - */ define ('MSG_NOERROR', 2); - -/** - * - * @link http://www.php.net/manual/en/sem.constants.php - * @var int - */ define ('MSG_EXCEPT', 4); -// End of sysvmsg v.8.2.6 +// End of sysvmsg v.8.3.0 diff --git a/plugins/org.eclipse.php.core/Resources/language/php8.3/sysvsem.php b/plugins/org.eclipse.php.core/Resources/language/php8.3/sysvsem.php index 17548dce03..e18437af2c 100644 --- a/plugins/org.eclipse.php.core/Resources/language/php8.3/sysvsem.php +++ b/plugins/org.eclipse.php.core/Resources/language/php8.3/sysvsem.php @@ -1,49 +1,36 @@ For an explanation about each option, visit http://api.html-tidy.org/#quick-reference. + * {@inheritdoc} */ - public function getConfig (): array {} + public function getConfig () {} /** - * Get status of specified document - * @link http://www.php.net/manual/en/tidy.getstatus.php - * @return int Returns 0 if no error/warning was raised, 1 for warnings or accessibility - * errors, or 2 for errors. + * {@inheritdoc} */ - public function getStatus (): int {} + public function getStatus () {} /** - * Get the Detected HTML version for the specified document - * @link http://www.php.net/manual/en/tidy.gethtmlver.php - * @return int Returns the detected HTML version. - *This function is not yet implemented in the Tidylib itself, so it always - * return 0.
+ * {@inheritdoc} */ - public function getHtmlVer (): int {} + public function getHtmlVer () {} /** - * Returns the documentation for the given option name - * @link http://www.php.net/manual/en/tidy.getoptdoc.php - * @param string $option - * @return string|false Returns a string if the option exists and has documentation available, or - * false otherwise. + * {@inheritdoc} + * @param string $option */ - public function getOptDoc (string $option): string|false {} + public function getOptDoc (string $option) {} /** - * Indicates if the document is a XHTML document - * @link http://www.php.net/manual/en/tidy.isxhtml.php - * @return bool This function returns true if the specified tidy - * tidy is a XHTML document, or false otherwise. - *This function is not yet implemented in the Tidylib itself, so it always - * return false.
+ * {@inheritdoc} */ - public function isXhtml (): bool {} + public function isXhtml () {} /** - * Indicates if the document is a generic (non HTML/XHTML) XML document - * @link http://www.php.net/manual/en/tidy.isxml.php - * @return bool This function returns true if the specified tidy - * tidy is a generic XML document (non HTML/XHTML), - * or false otherwise. - *This function is not yet implemented in the Tidylib itself, so it always - * return false.
+ * {@inheritdoc} */ - public function isXml (): bool {} + public function isXml () {} /** - * Returns a tidyNode object representing the root of the tidy parse tree - * @link http://www.php.net/manual/en/tidy.root.php - * @return tidyNode|null Returns the tidyNode object. + * {@inheritdoc} */ - public function root (): ?tidyNode {} + public function root () {} /** - * Returns a tidyNode object starting from the tag of the tidy parse tree - * @link http://www.php.net/manual/en/tidy.head.php - * @return tidyNode|null Returns the tidyNode object. + * {@inheritdoc} */ - public function head (): ?tidyNode {} + public function head () {} /** - * Returns a tidyNode object starting from the tag of the tidy parse tree - * @link http://www.php.net/manual/en/tidy.html.php - * @return tidyNode|null Returns the tidyNode object. + * {@inheritdoc} */ - public function html (): ?tidyNode {} + public function html () {} /** - * Returns a tidyNode object starting from the tag of the tidy parse tree - * @link http://www.php.net/manual/en/tidy.body.php - * @return tidyNode|null Returns a tidyNode object starting from the - * <body> tag of the tidy parse tree. + * {@inheritdoc} */ - public function body (): ?tidyNode {} + public function body () {} } -/** - * An HTML node in an HTML file, as detected by tidy. - * @link http://www.php.net/manual/en/class.tidynode.php - */ final class tidyNode { - /** - * The HTML representation of the node, including the surrounding tags. - * @var string - * @link http://www.php.net/manual/en/class.tidynode.php#tidynode.props.value - */ public readonly string $value; - /** - * The name of the HTML node - * @var string - * @link http://www.php.net/manual/en/class.tidynode.php#tidynode.props.name - */ public readonly string $name; - /** - * The type of the node (one of the nodetype constants, e.g. TIDY_NODETYPE_PHP) - * @var int - * @link http://www.php.net/manual/en/class.tidynode.php#tidynode.props.type - */ public readonly int $type; - /** - * The line number at which the tags is located in the file - * @var int - * @link http://www.php.net/manual/en/class.tidynode.php#tidynode.props.line - */ public readonly int $line; - /** - * The column number at which the tags is located in the file - * @var int - * @link http://www.php.net/manual/en/class.tidynode.php#tidynode.props.column - */ public readonly int $column; - /** - * Indicates if the node is a proprietary tag - * @var bool - * @link http://www.php.net/manual/en/class.tidynode.php#tidynode.props.proprietary - */ public readonly bool $proprietary; - /** - * The ID of the node (one of the tag constants, e.g. TIDY_TAG_FRAME) - * @var int|null - * @link http://www.php.net/manual/en/class.tidynode.php#tidynode.props.id - */ public readonly ?int $id; - /** - * An array of string, representing - * the attributes names (as keys) of the current node. - * @var array|null - * @link http://www.php.net/manual/en/class.tidynode.php#tidynode.props.attribute - */ public readonly ?array $attribute; - /** - * An array of tidyNode, representing - * the children of the current node. - * @var array|null - * @link http://www.php.net/manual/en/class.tidynode.php#tidynode.props.child - */ public readonly ?array $child; /** - * Private constructor to disallow direct instantiation - * @link http://www.php.net/manual/en/tidynode.construct.php + * {@inheritdoc} */ private function __construct () {} /** - * Checks if a node has children - * @link http://www.php.net/manual/en/tidynode.haschildren.php - * @return bool Returns true if the node has children, false otherwise. + * {@inheritdoc} */ public function hasChildren (): bool {} /** - * Checks if a node has siblings - * @link http://www.php.net/manual/en/tidynode.hassiblings.php - * @return bool Returns true if the node has siblings, false otherwise. + * {@inheritdoc} */ public function hasSiblings (): bool {} /** - * Checks if a node represents a comment - * @link http://www.php.net/manual/en/tidynode.iscomment.php - * @return bool Returns true if the node is a comment, false otherwise. + * {@inheritdoc} */ public function isComment (): bool {} /** - * Checks if a node is an element node - * @link http://www.php.net/manual/en/tidynode.ishtml.php - * @return bool Returns true if the node is an element node, but not the root node of the document, false otherwise. + * {@inheritdoc} */ public function isHtml (): bool {} /** - * Checks if a node represents text (no markup) - * @link http://www.php.net/manual/en/tidynode.istext.php - * @return bool Returns true if the node represent a text, false otherwise. + * {@inheritdoc} */ public function isText (): bool {} /** - * Checks if this node is JSTE - * @link http://www.php.net/manual/en/tidynode.isjste.php - * @return bool Returns true if the node is JSTE, false otherwise. + * {@inheritdoc} */ public function isJste (): bool {} /** - * Checks if this node is ASP - * @link http://www.php.net/manual/en/tidynode.isasp.php - * @return bool Returns true if the node is ASP, false otherwise. + * {@inheritdoc} */ public function isAsp (): bool {} /** - * Checks if a node is PHP - * @link http://www.php.net/manual/en/tidynode.isphp.php - * @return bool Returns true if the current node is PHP code, false otherwise. + * {@inheritdoc} */ public function isPhp (): bool {} /** - * Returns the parent node of the current node - * @link http://www.php.net/manual/en/tidynode.getparent.php - * @return tidyNode|null Returns a tidyNode if the node has a parent, or null - * otherwise. + * {@inheritdoc} */ public function getParent (): ?tidyNode {} } /** - * Parse a document stored in a string - * @link http://www.php.net/manual/en/tidy.parsestring.php - * @param string $string - * @param array|string|null $config [optional] - * @param string|null $encoding [optional] - * @return tidy|false tidy::parseString returns true on success. - * tidy_parse_string returns a new tidy - * instance on success. - * Both, the method and the function return false on failure. + * {@inheritdoc} + * @param string $string + * @param array|string|null $config [optional] + * @param string|null $encoding [optional] */ -function tidy_parse_string (string $string, array|string|null $config = null, ?string $encoding = null): tidy|false {} +function tidy_parse_string (string $string, array|string|null $config = NULL, ?string $encoding = NULL): tidy|false {} /** - * Return warnings and errors which occurred parsing the specified document - * @link http://www.php.net/manual/en/tidy.props.errorbuffer.php - * @param tidy $tidy - * @return string|false Returns the error buffer as a string, or false if the buffer is empty. + * {@inheritdoc} + * @param tidy $tidy */ function tidy_get_error_buffer (tidy $tidy): string|false {} /** - * Return a string representing the parsed tidy markup - * @link http://www.php.net/manual/en/function.tidy-get-output.php - * @param tidy $tidy - * @return string Returns the parsed tidy markup. + * {@inheritdoc} + * @param tidy $tidy */ function tidy_get_output (tidy $tidy): string {} /** - * Parse markup in file or URI - * @link http://www.php.net/manual/en/tidy.parsefile.php - * @param string $filename - * @param array|string|null $config [optional] - * @param string|null $encoding [optional] - * @param bool $useIncludePath [optional] - * @return tidy|false tidy::parseFile returns true on success. - * tidy_parse_file returns a new tidy - * instance on success. - * Both, the method and the function return false on failure. + * {@inheritdoc} + * @param string $filename + * @param array|string|null $config [optional] + * @param string|null $encoding [optional] + * @param bool $useIncludePath [optional] */ -function tidy_parse_file (string $filename, array|string|null $config = null, ?string $encoding = null, bool $useIncludePath = false): tidy|false {} +function tidy_parse_file (string $filename, array|string|null $config = NULL, ?string $encoding = NULL, bool $useIncludePath = false): tidy|false {} /** - * Execute configured cleanup and repair operations on parsed markup - * @link http://www.php.net/manual/en/tidy.cleanrepair.php - * @param tidy $tidy - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param tidy $tidy */ function tidy_clean_repair (tidy $tidy): bool {} /** - * Repair a string using an optionally provided configuration file - * @link http://www.php.net/manual/en/tidy.repairstring.php - * @param string $string - * @param array|string|null $config [optional] - * @param string|null $encoding [optional] - * @return string|false Returns the repaired string, or false on failure. + * {@inheritdoc} + * @param string $string + * @param array|string|null $config [optional] + * @param string|null $encoding [optional] */ -function tidy_repair_string (string $string, array|string|null $config = null, ?string $encoding = null): string|false {} +function tidy_repair_string (string $string, array|string|null $config = NULL, ?string $encoding = NULL): string|false {} /** - * Repair a file and return it as a string - * @link http://www.php.net/manual/en/tidy.repairfile.php - * @param string $filename - * @param array|string|null $config [optional] - * @param string|null $encoding [optional] - * @param bool $useIncludePath [optional] - * @return string|false Returns the repaired contents as a string, or false on failure. + * {@inheritdoc} + * @param string $filename + * @param array|string|null $config [optional] + * @param string|null $encoding [optional] + * @param bool $useIncludePath [optional] */ -function tidy_repair_file (string $filename, array|string|null $config = null, ?string $encoding = null, bool $useIncludePath = false): string|false {} +function tidy_repair_file (string $filename, array|string|null $config = NULL, ?string $encoding = NULL, bool $useIncludePath = false): string|false {} /** - * Run configured diagnostics on parsed and repaired markup - * @link http://www.php.net/manual/en/tidy.diagnose.php - * @param tidy $tidy - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param tidy $tidy */ function tidy_diagnose (tidy $tidy): bool {} /** - * Get release date (version) for Tidy library - * @link http://www.php.net/manual/en/tidy.getrelease.php - * @return string Returns a string with the release date of the Tidy library, - * which may be 'unknown'. + * {@inheritdoc} */ function tidy_get_release (): string {} /** - * Returns the documentation for the given option name - * @link http://www.php.net/manual/en/tidy.getoptdoc.php - * @param tidy $tidy - * @param string $option - * @return string|false Returns a string if the option exists and has documentation available, or - * false otherwise. + * {@inheritdoc} + * @param tidy $tidy + * @param string $option */ function tidy_get_opt_doc (tidy $tidy, string $option): string|false {} /** - * Get current Tidy configuration - * @link http://www.php.net/manual/en/tidy.getconfig.php - * @param tidy $tidy - * @return array Returns an array of configuration options. - *For an explanation about each option, visit http://api.html-tidy.org/#quick-reference.
+ * {@inheritdoc} + * @param tidy $tidy */ function tidy_get_config (tidy $tidy): array {} /** - * Get status of specified document - * @link http://www.php.net/manual/en/tidy.getstatus.php - * @param tidy $tidy - * @return int Returns 0 if no error/warning was raised, 1 for warnings or accessibility - * errors, or 2 for errors. + * {@inheritdoc} + * @param tidy $tidy */ function tidy_get_status (tidy $tidy): int {} /** - * Get the Detected HTML version for the specified document - * @link http://www.php.net/manual/en/tidy.gethtmlver.php - * @param tidy $tidy - * @return int Returns the detected HTML version. - *This function is not yet implemented in the Tidylib itself, so it always - * return 0.
+ * {@inheritdoc} + * @param tidy $tidy */ function tidy_get_html_ver (tidy $tidy): int {} /** - * Indicates if the document is a XHTML document - * @link http://www.php.net/manual/en/tidy.isxhtml.php - * @param tidy $tidy - * @return bool This function returns true if the specified tidy - * tidy is a XHTML document, or false otherwise. - *This function is not yet implemented in the Tidylib itself, so it always - * return false.
+ * {@inheritdoc} + * @param tidy $tidy */ function tidy_is_xhtml (tidy $tidy): bool {} /** - * Indicates if the document is a generic (non HTML/XHTML) XML document - * @link http://www.php.net/manual/en/tidy.isxml.php - * @param tidy $tidy - * @return bool This function returns true if the specified tidy - * tidy is a generic XML document (non HTML/XHTML), - * or false otherwise. - *This function is not yet implemented in the Tidylib itself, so it always - * return false.
+ * {@inheritdoc} + * @param tidy $tidy */ function tidy_is_xml (tidy $tidy): bool {} /** - * Returns the Number of Tidy errors encountered for specified document - * @link http://www.php.net/manual/en/function.tidy-error-count.php - * @param tidy $tidy - * @return int Returns the number of errors. + * {@inheritdoc} + * @param tidy $tidy */ function tidy_error_count (tidy $tidy): int {} /** - * Returns the Number of Tidy warnings encountered for specified document - * @link http://www.php.net/manual/en/function.tidy-warning-count.php - * @param tidy $tidy - * @return int Returns the number of warnings. + * {@inheritdoc} + * @param tidy $tidy */ function tidy_warning_count (tidy $tidy): int {} /** - * Returns the Number of Tidy accessibility warnings encountered for specified document - * @link http://www.php.net/manual/en/function.tidy-access-count.php - * @param tidy $tidy - * @return int Returns the number of warnings. + * {@inheritdoc} + * @param tidy $tidy */ function tidy_access_count (tidy $tidy): int {} /** - * Returns the Number of Tidy configuration errors encountered for specified document - * @link http://www.php.net/manual/en/function.tidy-config-count.php - * @param tidy $tidy - * @return int Returns the number of errors. + * {@inheritdoc} + * @param tidy $tidy */ function tidy_config_count (tidy $tidy): int {} /** - * Returns the value of the specified configuration option for the tidy document - * @link http://www.php.net/manual/en/tidy.getopt.php - * @param tidy $tidy - * @param string $option - * @return string|int|bool Returns the value of the specified option. - * The return type depends on the type of the specified one. + * {@inheritdoc} + * @param tidy $tidy + * @param string $option */ function tidy_getopt (tidy $tidy, string $option): string|int|bool {} /** - * Returns a tidyNode object representing the root of the tidy parse tree - * @link http://www.php.net/manual/en/tidy.root.php - * @param tidy $tidy - * @return tidyNode|null Returns the tidyNode object. + * {@inheritdoc} + * @param tidy $tidy */ function tidy_get_root (tidy $tidy): ?tidyNode {} /** - * Returns a tidyNode object starting from the tag of the tidy parse tree - * @link http://www.php.net/manual/en/tidy.html.php - * @param tidy $tidy - * @return tidyNode|null Returns the tidyNode object. + * {@inheritdoc} + * @param tidy $tidy */ function tidy_get_html (tidy $tidy): ?tidyNode {} /** - * Returns a tidyNode object starting from the tag of the tidy parse tree - * @link http://www.php.net/manual/en/tidy.head.php - * @param tidy $tidy - * @return tidyNode|null Returns the tidyNode object. + * {@inheritdoc} + * @param tidy $tidy */ function tidy_get_head (tidy $tidy): ?tidyNode {} /** - * Returns a tidyNode object starting from the tag of the tidy parse tree - * @link http://www.php.net/manual/en/tidy.body.php - * @param tidy $tidy - * @return tidyNode|null Returns a tidyNode object starting from the - * <body> tag of the tidy parse tree. + * {@inheritdoc} + * @param tidy $tidy */ function tidy_get_body (tidy $tidy): ?tidyNode {} @@ -727,4 +514,4 @@ function tidy_get_body (tidy $tidy): ?tidyNode {} define ('TIDY_TAG_TRACK', 150); define ('TIDY_TAG_VIDEO', 151); -// End of tidy v.8.2.6 +// End of tidy v.8.3.0 diff --git a/plugins/org.eclipse.php.core/Resources/language/php8.3/tokenizer.php b/plugins/org.eclipse.php.core/Resources/language/php8.3/tokenizer.php index 930561a1a3..4c54ae4ab9 100644 --- a/plugins/org.eclipse.php.core/Resources/language/php8.3/tokenizer.php +++ b/plugins/org.eclipse.php.core/Resources/language/php8.3/tokenizer.php @@ -1,271 +1,216 @@ - *Some errors (such as entity errors) are reported at the end of the data, thus only if - * is_final is set and true.
+ * {@inheritdoc} + * @param XMLParser $parser + * @param string $data + * @param bool $is_final [optional] */ function xml_parse (XMLParser $parser, string $data, bool $is_final = false): int {} /** - * Parse XML data into an array structure - * @link http://www.php.net/manual/en/function.xml-parse-into-struct.php - * @param XMLParser $parser - * @param string $data - * @param array $values - * @param array $index [optional] - * @return int xml_parse_into_struct returns 0 for failure and 1 for - * success. This is not the same as false and true, be careful with - * operators such as ===. + * {@inheritdoc} + * @param XMLParser $parser + * @param string $data + * @param mixed $values + * @param mixed $index [optional] */ -function xml_parse_into_struct (XMLParser $parser, string $data, array &$values, array &$index = null): int {} +function xml_parse_into_struct (XMLParser $parser, string $data, &$values = null, &$index = NULL): int|false {} /** - * Get XML parser error code - * @link http://www.php.net/manual/en/function.xml-get-error-code.php - * @param XMLParser $parser - * @return int Returns one of the error - * codes listed in the error codes - * section. + * {@inheritdoc} + * @param XMLParser $parser */ function xml_get_error_code (XMLParser $parser): int {} /** - * Get XML parser error string - * @link http://www.php.net/manual/en/function.xml-error-string.php - * @param int $error_code - * @return string|null Returns a string with a textual description of the error - * error_code, or null if no description was found. + * {@inheritdoc} + * @param int $error_code */ function xml_error_string (int $error_code): ?string {} /** - * Get current line number for an XML parser - * @link http://www.php.net/manual/en/function.xml-get-current-line-number.php - * @param XMLParser $parser - * @return int Returns which line the - * parser is currently at in its data buffer. + * {@inheritdoc} + * @param XMLParser $parser */ function xml_get_current_line_number (XMLParser $parser): int {} /** - * Get current column number for an XML parser - * @link http://www.php.net/manual/en/function.xml-get-current-column-number.php - * @param XMLParser $parser - * @return int Returns which column on - * the current line (as given by - * xml_get_current_line_number) the parser is - * currently at. + * {@inheritdoc} + * @param XMLParser $parser */ function xml_get_current_column_number (XMLParser $parser): int {} /** - * Get current byte index for an XML parser - * @link http://www.php.net/manual/en/function.xml-get-current-byte-index.php - * @param XMLParser $parser - * @return int Returns which byte index - * the parser is currently at in its data buffer (starting at 0). + * {@inheritdoc} + * @param XMLParser $parser */ function xml_get_current_byte_index (XMLParser $parser): int {} /** - * Free an XML parser - * @link http://www.php.net/manual/en/function.xml-parser-free.php - * @param XMLParser $parser - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param XMLParser $parser */ function xml_parser_free (XMLParser $parser): bool {} /** - * Set options in an XML parser - * @link http://www.php.net/manual/en/function.xml-parser-set-option.php - * @param XMLParser $parser - * @param int $option - * @param string|int $value - * @return bool This function returns false if parser does not - * refer to a valid parser, or if the option could not be set. Else the - * option is set and true is returned. + * {@inheritdoc} + * @param XMLParser $parser + * @param int $option + * @param mixed $value */ -function xml_parser_set_option (XMLParser $parser, int $option, string|int $value): bool {} +function xml_parser_set_option (XMLParser $parser, int $option, $value = null): bool {} /** - * Get options from an XML parser - * @link http://www.php.net/manual/en/function.xml-parser-get-option.php - * @param XMLParser $parser - * @param int $option - * @return string|int This function returns false if parser does - * not refer to a valid parser or if option isn't - * valid (generates also a E_WARNING). - * Else the option's value is returned. + * {@inheritdoc} + * @param XMLParser $parser + * @param int $option */ -function xml_parser_get_option (XMLParser $parser, int $option): string|int {} - +function xml_parser_get_option (XMLParser $parser, int $option): string|int|bool {} -/** - * - * @link http://www.php.net/manual/en/xml.constants.php - * @var int - */ define ('XML_ERROR_NONE', 0); - -/** - * - * @link http://www.php.net/manual/en/xml.constants.php - * @var int - */ define ('XML_ERROR_NO_MEMORY', 1); - -/** - * - * @link http://www.php.net/manual/en/xml.constants.php - * @var int - */ define ('XML_ERROR_SYNTAX', 2); - -/** - * - * @link http://www.php.net/manual/en/xml.constants.php - * @var int - */ define ('XML_ERROR_NO_ELEMENTS', 3); - -/** - * - * @link http://www.php.net/manual/en/xml.constants.php - * @var int - */ define ('XML_ERROR_INVALID_TOKEN', 4); - -/** - * - * @link http://www.php.net/manual/en/xml.constants.php - * @var int - */ define ('XML_ERROR_UNCLOSED_TOKEN', 5); - -/** - * - * @link http://www.php.net/manual/en/xml.constants.php - * @var int - */ define ('XML_ERROR_PARTIAL_CHAR', 6); - -/** - * - * @link http://www.php.net/manual/en/xml.constants.php - * @var int - */ define ('XML_ERROR_TAG_MISMATCH', 7); - -/** - * - * @link http://www.php.net/manual/en/xml.constants.php - * @var int - */ define ('XML_ERROR_DUPLICATE_ATTRIBUTE', 8); - -/** - * - * @link http://www.php.net/manual/en/xml.constants.php - * @var int - */ define ('XML_ERROR_JUNK_AFTER_DOC_ELEMENT', 9); - -/** - * - * @link http://www.php.net/manual/en/xml.constants.php - * @var int - */ define ('XML_ERROR_PARAM_ENTITY_REF', 10); - -/** - * - * @link http://www.php.net/manual/en/xml.constants.php - * @var int - */ define ('XML_ERROR_UNDEFINED_ENTITY', 11); - -/** - * - * @link http://www.php.net/manual/en/xml.constants.php - * @var int - */ define ('XML_ERROR_RECURSIVE_ENTITY_REF', 12); - -/** - * - * @link http://www.php.net/manual/en/xml.constants.php - * @var int - */ define ('XML_ERROR_ASYNC_ENTITY', 13); - -/** - * - * @link http://www.php.net/manual/en/xml.constants.php - * @var int - */ define ('XML_ERROR_BAD_CHAR_REF', 14); - -/** - * - * @link http://www.php.net/manual/en/xml.constants.php - * @var int - */ define ('XML_ERROR_BINARY_ENTITY_REF', 15); - -/** - * - * @link http://www.php.net/manual/en/xml.constants.php - * @var int - */ define ('XML_ERROR_ATTRIBUTE_EXTERNAL_ENTITY_REF', 16); - -/** - * - * @link http://www.php.net/manual/en/xml.constants.php - * @var int - */ define ('XML_ERROR_MISPLACED_XML_PI', 17); - -/** - * - * @link http://www.php.net/manual/en/xml.constants.php - * @var int - */ define ('XML_ERROR_UNKNOWN_ENCODING', 18); - -/** - * - * @link http://www.php.net/manual/en/xml.constants.php - * @var int - */ define ('XML_ERROR_INCORRECT_ENCODING', 19); - -/** - * - * @link http://www.php.net/manual/en/xml.constants.php - * @var int - */ define ('XML_ERROR_UNCLOSED_CDATA_SECTION', 20); - -/** - * - * @link http://www.php.net/manual/en/xml.constants.php - * @var int - */ define ('XML_ERROR_EXTERNAL_ENTITY_HANDLING', 21); - -/** - * - * @link http://www.php.net/manual/en/xml.constants.php - * @var int - */ define ('XML_OPTION_CASE_FOLDING', 1); - -/** - * - * @link http://www.php.net/manual/en/xml.constants.php - * @var int - */ define ('XML_OPTION_TARGET_ENCODING', 2); - -/** - * - * @link http://www.php.net/manual/en/xml.constants.php - * @var int - */ define ('XML_OPTION_SKIP_TAGSTART', 3); - -/** - * - * @link http://www.php.net/manual/en/xml.constants.php - * @var int - */ define ('XML_OPTION_SKIP_WHITE', 4); - -/** - * Holds the SAX implementation method. - * Can be libxml or expat. - * @link http://www.php.net/manual/en/xml.constants.php - * @var string - */ define ('XML_SAX_IMPL', "libxml"); -// End of xml v.8.2.6 +// End of xml v.8.3.0 diff --git a/plugins/org.eclipse.php.core/Resources/language/php8.3/xmlreader.php b/plugins/org.eclipse.php.core/Resources/language/php8.3/xmlreader.php index 84812f8cf4..df3bd1c899 100644 --- a/plugins/org.eclipse.php.core/Resources/language/php8.3/xmlreader.php +++ b/plugins/org.eclipse.php.core/Resources/language/php8.3/xmlreader.php @@ -1,385 +1,207 @@ Procedural style: Returns a new XMLWriter instance for later use with the - * xmlwriter functions on success, or false on failure. + * {@inheritdoc} + * @param string $uri */ - public function openUri (string $uri): bool {} + public function openUri (string $uri) {} /** - * Create new xmlwriter using memory for string output - * @link http://www.php.net/manual/en/xmlwriter.openmemory.php - * @return bool Object-oriented style: Returns true on success or false on failure. - *Procedural style: Returns a new XMLWriter for later use with the - * xmlwriter functions on success, or false on failure.
+ * {@inheritdoc} */ - public function openMemory (): bool {} + public function openMemory () {} /** - * Toggle indentation on/off - * @link http://www.php.net/manual/en/xmlwriter.setindent.php - * @param bool $enable - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param bool $enable */ - public function setIndent (bool $enable): bool {} + public function setIndent (bool $enable) {} /** - * Set string used for indenting - * @link http://www.php.net/manual/en/xmlwriter.setindentstring.php - * @param string $indentation - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $indentation */ - public function setIndentString (string $indentation): bool {} + public function setIndentString (string $indentation) {} /** - * Create start comment - * @link http://www.php.net/manual/en/xmlwriter.startcomment.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function startComment (): bool {} + public function startComment () {} /** - * Create end comment - * @link http://www.php.net/manual/en/xmlwriter.endcomment.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function endComment (): bool {} + public function endComment () {} /** - * Create start attribute - * @link http://www.php.net/manual/en/xmlwriter.startattribute.php - * @param string $name - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $name */ - public function startAttribute (string $name): bool {} + public function startAttribute (string $name) {} /** - * End attribute - * @link http://www.php.net/manual/en/xmlwriter.endattribute.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function endAttribute (): bool {} + public function endAttribute () {} /** - * Write full attribute - * @link http://www.php.net/manual/en/xmlwriter.writeattribute.php - * @param string $name - * @param string $value - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $name + * @param string $value */ - public function writeAttribute (string $name, string $value): bool {} + public function writeAttribute (string $name, string $value) {} /** - * Create start namespaced attribute - * @link http://www.php.net/manual/en/xmlwriter.startattributens.php - * @param string|null $prefix - * @param string $name - * @param string|null $namespace - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string|null $prefix + * @param string $name + * @param string|null $namespace */ - public function startAttributeNs (?string $prefix, string $name, ?string $namespace): bool {} + public function startAttributeNs (?string $prefix = null, string $name, ?string $namespace = null) {} /** - * Write full namespaced attribute - * @link http://www.php.net/manual/en/xmlwriter.writeattributens.php - * @param string|null $prefix - * @param string $name - * @param string|null $namespace - * @param string $value - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string|null $prefix + * @param string $name + * @param string|null $namespace + * @param string $value */ - public function writeAttributeNs (?string $prefix, string $name, ?string $namespace, string $value): bool {} + public function writeAttributeNs (?string $prefix = null, string $name, ?string $namespace = null, string $value) {} /** - * Create start element tag - * @link http://www.php.net/manual/en/xmlwriter.startelement.php - * @param string $name - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $name */ - public function startElement (string $name): bool {} + public function startElement (string $name) {} /** - * End current element - * @link http://www.php.net/manual/en/xmlwriter.endelement.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function endElement (): bool {} + public function endElement () {} /** - * End current element - * @link http://www.php.net/manual/en/xmlwriter.fullendelement.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function fullEndElement (): bool {} + public function fullEndElement () {} /** - * Create start namespaced element tag - * @link http://www.php.net/manual/en/xmlwriter.startelementns.php - * @param string|null $prefix - * @param string $name - * @param string|null $namespace - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string|null $prefix + * @param string $name + * @param string|null $namespace */ - public function startElementNs (?string $prefix, string $name, ?string $namespace): bool {} + public function startElementNs (?string $prefix = null, string $name, ?string $namespace = null) {} /** - * Write full element tag - * @link http://www.php.net/manual/en/xmlwriter.writeelement.php - * @param string $name - * @param string|null $content [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $name + * @param string|null $content [optional] */ - public function writeElement (string $name, ?string $content = null): bool {} + public function writeElement (string $name, ?string $content = NULL) {} /** - * Write full namespaced element tag - * @link http://www.php.net/manual/en/xmlwriter.writeelementns.php - * @param string|null $prefix - * @param string $name - * @param string|null $namespace - * @param string|null $content [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string|null $prefix + * @param string $name + * @param string|null $namespace + * @param string|null $content [optional] */ - public function writeElementNs (?string $prefix, string $name, ?string $namespace, ?string $content = null): bool {} + public function writeElementNs (?string $prefix = null, string $name, ?string $namespace = null, ?string $content = NULL) {} /** - * Create start PI tag - * @link http://www.php.net/manual/en/xmlwriter.startpi.php - * @param string $target - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $target */ - public function startPi (string $target): bool {} + public function startPi (string $target) {} /** - * End current PI - * @link http://www.php.net/manual/en/xmlwriter.endpi.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function endPi (): bool {} + public function endPi () {} /** - * Writes a PI - * @link http://www.php.net/manual/en/xmlwriter.writepi.php - * @param string $target - * @param string $content - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $target + * @param string $content */ - public function writePi (string $target, string $content): bool {} + public function writePi (string $target, string $content) {} /** - * Create start CDATA tag - * @link http://www.php.net/manual/en/xmlwriter.startcdata.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function startCdata (): bool {} + public function startCdata () {} /** - * End current CDATA - * @link http://www.php.net/manual/en/xmlwriter.endcdata.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function endCdata (): bool {} + public function endCdata () {} /** - * Write full CDATA tag - * @link http://www.php.net/manual/en/xmlwriter.writecdata.php - * @param string $content - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $content */ - public function writeCdata (string $content): bool {} + public function writeCdata (string $content) {} /** - * Write text - * @link http://www.php.net/manual/en/xmlwriter.text.php - * @param string $content - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $content */ - public function text (string $content): bool {} + public function text (string $content) {} /** - * Write a raw XML text - * @link http://www.php.net/manual/en/xmlwriter.writeraw.php - * @param string $content - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $content */ - public function writeRaw (string $content): bool {} + public function writeRaw (string $content) {} /** - * Create document tag - * @link http://www.php.net/manual/en/xmlwriter.startdocument.php - * @param string|null $version [optional] - * @param string|null $encoding [optional] - * @param string|null $standalone [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string|null $version [optional] + * @param string|null $encoding [optional] + * @param string|null $standalone [optional] */ - public function startDocument (?string $version = '"1.0"', ?string $encoding = null, ?string $standalone = null): bool {} + public function startDocument (?string $version = '1.0', ?string $encoding = NULL, ?string $standalone = NULL) {} /** - * End current document - * @link http://www.php.net/manual/en/xmlwriter.enddocument.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function endDocument (): bool {} + public function endDocument () {} /** - * Write full comment tag - * @link http://www.php.net/manual/en/xmlwriter.writecomment.php - * @param string $content - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $content */ - public function writeComment (string $content): bool {} + public function writeComment (string $content) {} /** - * Create start DTD tag - * @link http://www.php.net/manual/en/xmlwriter.startdtd.php - * @param string $qualifiedName - * @param string|null $publicId [optional] - * @param string|null $systemId [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $qualifiedName + * @param string|null $publicId [optional] + * @param string|null $systemId [optional] */ - public function startDtd (string $qualifiedName, ?string $publicId = null, ?string $systemId = null): bool {} + public function startDtd (string $qualifiedName, ?string $publicId = NULL, ?string $systemId = NULL) {} /** - * End current DTD - * @link http://www.php.net/manual/en/xmlwriter.enddtd.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function endDtd (): bool {} + public function endDtd () {} /** - * Write full DTD tag - * @link http://www.php.net/manual/en/xmlwriter.writedtd.php - * @param string $name - * @param string|null $publicId [optional] - * @param string|null $systemId [optional] - * @param string|null $content [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $name + * @param string|null $publicId [optional] + * @param string|null $systemId [optional] + * @param string|null $content [optional] */ - public function writeDtd (string $name, ?string $publicId = null, ?string $systemId = null, ?string $content = null): bool {} + public function writeDtd (string $name, ?string $publicId = NULL, ?string $systemId = NULL, ?string $content = NULL) {} /** - * Create start DTD element - * @link http://www.php.net/manual/en/xmlwriter.startdtdelement.php - * @param string $qualifiedName - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $qualifiedName */ - public function startDtdElement (string $qualifiedName): bool {} + public function startDtdElement (string $qualifiedName) {} /** - * End current DTD element - * @link http://www.php.net/manual/en/xmlwriter.enddtdelement.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function endDtdElement (): bool {} + public function endDtdElement () {} /** - * Write full DTD element tag - * @link http://www.php.net/manual/en/xmlwriter.writedtdelement.php - * @param string $name - * @param string $content - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $name + * @param string $content */ - public function writeDtdElement (string $name, string $content): bool {} + public function writeDtdElement (string $name, string $content) {} /** - * Create start DTD AttList - * @link http://www.php.net/manual/en/xmlwriter.startdtdattlist.php - * @param string $name - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $name */ - public function startDtdAttlist (string $name): bool {} + public function startDtdAttlist (string $name) {} /** - * End current DTD AttList - * @link http://www.php.net/manual/en/xmlwriter.enddtdattlist.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function endDtdAttlist (): bool {} + public function endDtdAttlist () {} /** - * Write full DTD AttList tag - * @link http://www.php.net/manual/en/xmlwriter.writedtdattlist.php - * @param string $name - * @param string $content - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $name + * @param string $content */ - public function writeDtdAttlist (string $name, string $content): bool {} + public function writeDtdAttlist (string $name, string $content) {} /** - * Create start DTD Entity - * @link http://www.php.net/manual/en/xmlwriter.startdtdentity.php - * @param string $name - * @param bool $isParam - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $name + * @param bool $isParam */ - public function startDtdEntity (string $name, bool $isParam): bool {} + public function startDtdEntity (string $name, bool $isParam) {} /** - * End current DTD Entity - * @link http://www.php.net/manual/en/xmlwriter.enddtdentity.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function endDtdEntity (): bool {} + public function endDtdEntity () {} /** - * Write full DTD Entity tag - * @link http://www.php.net/manual/en/xmlwriter.writedtdentity.php - * @param string $name - * @param string $content - * @param bool $isParam [optional] - * @param string|null $publicId [optional] - * @param string|null $systemId [optional] - * @param string|null $notationData [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $name + * @param string $content + * @param bool $isParam [optional] + * @param string|null $publicId [optional] + * @param string|null $systemId [optional] + * @param string|null $notationData [optional] */ - public function writeDtdEntity (string $name, string $content, bool $isParam = false, ?string $publicId = null, ?string $systemId = null, ?string $notationData = null): bool {} + public function writeDtdEntity (string $name, string $content, bool $isParam = false, ?string $publicId = NULL, ?string $systemId = NULL, ?string $notationData = NULL) {} /** - * Returns current buffer - * @link http://www.php.net/manual/en/xmlwriter.outputmemory.php - * @param bool $flush [optional] - * @return string Returns the current buffer as a string. + * {@inheritdoc} + * @param bool $flush [optional] */ - public function outputMemory (bool $flush = true): string {} + public function outputMemory (bool $flush = true) {} /** - * Flush current buffer - * @link http://www.php.net/manual/en/xmlwriter.flush.php - * @param bool $empty [optional] - * @return string|int If you opened the writer in memory, this function returns the generated XML buffer, - * Else, if using URI, this function will write the buffer and return the number of - * written bytes. + * {@inheritdoc} + * @param bool $empty [optional] */ - public function flush (bool $empty = true): string|int {} + public function flush (bool $empty = true) {} } /** - * Create new xmlwriter using source uri for output - * @link http://www.php.net/manual/en/xmlwriter.openuri.php - * @param string $uri - * @return XMLWriter|false Object-oriented style: Returns true on success or false on failure. - *Procedural style: Returns a new XMLWriter instance for later use with the - * xmlwriter functions on success, or false on failure.
+ * {@inheritdoc} + * @param string $uri */ function xmlwriter_open_uri (string $uri): XMLWriter|false {} /** - * Create new xmlwriter using memory for string output - * @link http://www.php.net/manual/en/xmlwriter.openmemory.php - * @return XMLWriter|false Object-oriented style: Returns true on success or false on failure. - *Procedural style: Returns a new XMLWriter for later use with the - * xmlwriter functions on success, or false on failure.
+ * {@inheritdoc} */ function xmlwriter_open_memory (): XMLWriter|false {} /** - * Toggle indentation on/off - * @link http://www.php.net/manual/en/xmlwriter.setindent.php - * @param XMLWriter $writer - * @param bool $enable - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param XMLWriter $writer + * @param bool $enable */ function xmlwriter_set_indent (XMLWriter $writer, bool $enable): bool {} /** - * Set string used for indenting - * @link http://www.php.net/manual/en/xmlwriter.setindentstring.php - * @param XMLWriter $writer - * @param string $indentation - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param XMLWriter $writer + * @param string $indentation */ function xmlwriter_set_indent_string (XMLWriter $writer, string $indentation): bool {} /** - * Create start comment - * @link http://www.php.net/manual/en/xmlwriter.startcomment.php - * @param XMLWriter $writer - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param XMLWriter $writer */ function xmlwriter_start_comment (XMLWriter $writer): bool {} /** - * Create end comment - * @link http://www.php.net/manual/en/xmlwriter.endcomment.php - * @param XMLWriter $writer - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param XMLWriter $writer */ function xmlwriter_end_comment (XMLWriter $writer): bool {} /** - * Create start attribute - * @link http://www.php.net/manual/en/xmlwriter.startattribute.php - * @param XMLWriter $writer - * @param string $name - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param XMLWriter $writer + * @param string $name */ function xmlwriter_start_attribute (XMLWriter $writer, string $name): bool {} /** - * End attribute - * @link http://www.php.net/manual/en/xmlwriter.endattribute.php - * @param XMLWriter $writer - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param XMLWriter $writer */ function xmlwriter_end_attribute (XMLWriter $writer): bool {} /** - * Write full attribute - * @link http://www.php.net/manual/en/xmlwriter.writeattribute.php - * @param XMLWriter $writer - * @param string $name - * @param string $value - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param XMLWriter $writer + * @param string $name + * @param string $value */ function xmlwriter_write_attribute (XMLWriter $writer, string $name, string $value): bool {} /** - * Create start namespaced attribute - * @link http://www.php.net/manual/en/xmlwriter.startattributens.php - * @param XMLWriter $writer - * @param string|null $prefix - * @param string $name - * @param string|null $namespace - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param XMLWriter $writer + * @param string|null $prefix + * @param string $name + * @param string|null $namespace */ -function xmlwriter_start_attribute_ns (XMLWriter $writer, ?string $prefix, string $name, ?string $namespace): bool {} +function xmlwriter_start_attribute_ns (XMLWriter $writer, ?string $prefix = null, string $name, ?string $namespace = null): bool {} /** - * Write full namespaced attribute - * @link http://www.php.net/manual/en/xmlwriter.writeattributens.php - * @param XMLWriter $writer - * @param string|null $prefix - * @param string $name - * @param string|null $namespace - * @param string $value - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param XMLWriter $writer + * @param string|null $prefix + * @param string $name + * @param string|null $namespace + * @param string $value */ -function xmlwriter_write_attribute_ns (XMLWriter $writer, ?string $prefix, string $name, ?string $namespace, string $value): bool {} +function xmlwriter_write_attribute_ns (XMLWriter $writer, ?string $prefix = null, string $name, ?string $namespace = null, string $value): bool {} /** - * Create start element tag - * @link http://www.php.net/manual/en/xmlwriter.startelement.php - * @param XMLWriter $writer - * @param string $name - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param XMLWriter $writer + * @param string $name */ function xmlwriter_start_element (XMLWriter $writer, string $name): bool {} /** - * End current element - * @link http://www.php.net/manual/en/xmlwriter.endelement.php - * @param XMLWriter $writer - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param XMLWriter $writer */ function xmlwriter_end_element (XMLWriter $writer): bool {} /** - * End current element - * @link http://www.php.net/manual/en/xmlwriter.fullendelement.php - * @param XMLWriter $writer - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param XMLWriter $writer */ function xmlwriter_full_end_element (XMLWriter $writer): bool {} /** - * Create start namespaced element tag - * @link http://www.php.net/manual/en/xmlwriter.startelementns.php - * @param XMLWriter $writer - * @param string|null $prefix - * @param string $name - * @param string|null $namespace - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param XMLWriter $writer + * @param string|null $prefix + * @param string $name + * @param string|null $namespace */ -function xmlwriter_start_element_ns (XMLWriter $writer, ?string $prefix, string $name, ?string $namespace): bool {} +function xmlwriter_start_element_ns (XMLWriter $writer, ?string $prefix = null, string $name, ?string $namespace = null): bool {} /** - * Write full element tag - * @link http://www.php.net/manual/en/xmlwriter.writeelement.php - * @param XMLWriter $writer - * @param string $name - * @param string|null $content [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param XMLWriter $writer + * @param string $name + * @param string|null $content [optional] */ -function xmlwriter_write_element (XMLWriter $writer, string $name, ?string $content = null): bool {} +function xmlwriter_write_element (XMLWriter $writer, string $name, ?string $content = NULL): bool {} /** - * Write full namespaced element tag - * @link http://www.php.net/manual/en/xmlwriter.writeelementns.php - * @param XMLWriter $writer - * @param string|null $prefix - * @param string $name - * @param string|null $namespace - * @param string|null $content [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param XMLWriter $writer + * @param string|null $prefix + * @param string $name + * @param string|null $namespace + * @param string|null $content [optional] */ -function xmlwriter_write_element_ns (XMLWriter $writer, ?string $prefix, string $name, ?string $namespace, ?string $content = null): bool {} +function xmlwriter_write_element_ns (XMLWriter $writer, ?string $prefix = null, string $name, ?string $namespace = null, ?string $content = NULL): bool {} /** - * Create start PI tag - * @link http://www.php.net/manual/en/xmlwriter.startpi.php - * @param XMLWriter $writer - * @param string $target - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param XMLWriter $writer + * @param string $target */ function xmlwriter_start_pi (XMLWriter $writer, string $target): bool {} /** - * End current PI - * @link http://www.php.net/manual/en/xmlwriter.endpi.php - * @param XMLWriter $writer - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param XMLWriter $writer */ function xmlwriter_end_pi (XMLWriter $writer): bool {} /** - * Writes a PI - * @link http://www.php.net/manual/en/xmlwriter.writepi.php - * @param XMLWriter $writer - * @param string $target - * @param string $content - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param XMLWriter $writer + * @param string $target + * @param string $content */ function xmlwriter_write_pi (XMLWriter $writer, string $target, string $content): bool {} /** - * Create start CDATA tag - * @link http://www.php.net/manual/en/xmlwriter.startcdata.php - * @param XMLWriter $writer - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param XMLWriter $writer */ function xmlwriter_start_cdata (XMLWriter $writer): bool {} /** - * End current CDATA - * @link http://www.php.net/manual/en/xmlwriter.endcdata.php - * @param XMLWriter $writer - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param XMLWriter $writer */ function xmlwriter_end_cdata (XMLWriter $writer): bool {} /** - * Write full CDATA tag - * @link http://www.php.net/manual/en/xmlwriter.writecdata.php - * @param XMLWriter $writer - * @param string $content - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param XMLWriter $writer + * @param string $content */ function xmlwriter_write_cdata (XMLWriter $writer, string $content): bool {} /** - * Write text - * @link http://www.php.net/manual/en/xmlwriter.text.php - * @param XMLWriter $writer - * @param string $content - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param XMLWriter $writer + * @param string $content */ function xmlwriter_text (XMLWriter $writer, string $content): bool {} /** - * Write a raw XML text - * @link http://www.php.net/manual/en/xmlwriter.writeraw.php - * @param XMLWriter $writer - * @param string $content - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param XMLWriter $writer + * @param string $content */ function xmlwriter_write_raw (XMLWriter $writer, string $content): bool {} /** - * Create document tag - * @link http://www.php.net/manual/en/xmlwriter.startdocument.php - * @param XMLWriter $writer - * @param string|null $version [optional] - * @param string|null $encoding [optional] - * @param string|null $standalone [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param XMLWriter $writer + * @param string|null $version [optional] + * @param string|null $encoding [optional] + * @param string|null $standalone [optional] */ -function xmlwriter_start_document (XMLWriter $writer, ?string $version = '"1.0"', ?string $encoding = null, ?string $standalone = null): bool {} +function xmlwriter_start_document (XMLWriter $writer, ?string $version = '1.0', ?string $encoding = NULL, ?string $standalone = NULL): bool {} /** - * End current document - * @link http://www.php.net/manual/en/xmlwriter.enddocument.php - * @param XMLWriter $writer - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param XMLWriter $writer */ function xmlwriter_end_document (XMLWriter $writer): bool {} /** - * Write full comment tag - * @link http://www.php.net/manual/en/xmlwriter.writecomment.php - * @param XMLWriter $writer - * @param string $content - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param XMLWriter $writer + * @param string $content */ function xmlwriter_write_comment (XMLWriter $writer, string $content): bool {} /** - * Create start DTD tag - * @link http://www.php.net/manual/en/xmlwriter.startdtd.php - * @param XMLWriter $writer - * @param string $qualifiedName - * @param string|null $publicId [optional] - * @param string|null $systemId [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param XMLWriter $writer + * @param string $qualifiedName + * @param string|null $publicId [optional] + * @param string|null $systemId [optional] */ -function xmlwriter_start_dtd (XMLWriter $writer, string $qualifiedName, ?string $publicId = null, ?string $systemId = null): bool {} +function xmlwriter_start_dtd (XMLWriter $writer, string $qualifiedName, ?string $publicId = NULL, ?string $systemId = NULL): bool {} /** - * End current DTD - * @link http://www.php.net/manual/en/xmlwriter.enddtd.php - * @param XMLWriter $writer - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param XMLWriter $writer */ function xmlwriter_end_dtd (XMLWriter $writer): bool {} /** - * Write full DTD tag - * @link http://www.php.net/manual/en/xmlwriter.writedtd.php - * @param XMLWriter $writer - * @param string $name - * @param string|null $publicId [optional] - * @param string|null $systemId [optional] - * @param string|null $content [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param XMLWriter $writer + * @param string $name + * @param string|null $publicId [optional] + * @param string|null $systemId [optional] + * @param string|null $content [optional] */ -function xmlwriter_write_dtd (XMLWriter $writer, string $name, ?string $publicId = null, ?string $systemId = null, ?string $content = null): bool {} +function xmlwriter_write_dtd (XMLWriter $writer, string $name, ?string $publicId = NULL, ?string $systemId = NULL, ?string $content = NULL): bool {} /** - * Create start DTD element - * @link http://www.php.net/manual/en/xmlwriter.startdtdelement.php - * @param XMLWriter $writer - * @param string $qualifiedName - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param XMLWriter $writer + * @param string $qualifiedName */ function xmlwriter_start_dtd_element (XMLWriter $writer, string $qualifiedName): bool {} /** - * End current DTD element - * @link http://www.php.net/manual/en/xmlwriter.enddtdelement.php - * @param XMLWriter $writer - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param XMLWriter $writer */ function xmlwriter_end_dtd_element (XMLWriter $writer): bool {} /** - * Write full DTD element tag - * @link http://www.php.net/manual/en/xmlwriter.writedtdelement.php - * @param XMLWriter $writer - * @param string $name - * @param string $content - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param XMLWriter $writer + * @param string $name + * @param string $content */ function xmlwriter_write_dtd_element (XMLWriter $writer, string $name, string $content): bool {} /** - * Create start DTD AttList - * @link http://www.php.net/manual/en/xmlwriter.startdtdattlist.php - * @param XMLWriter $writer - * @param string $name - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param XMLWriter $writer + * @param string $name */ function xmlwriter_start_dtd_attlist (XMLWriter $writer, string $name): bool {} /** - * End current DTD AttList - * @link http://www.php.net/manual/en/xmlwriter.enddtdattlist.php - * @param XMLWriter $writer - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param XMLWriter $writer */ function xmlwriter_end_dtd_attlist (XMLWriter $writer): bool {} /** - * Write full DTD AttList tag - * @link http://www.php.net/manual/en/xmlwriter.writedtdattlist.php - * @param XMLWriter $writer - * @param string $name - * @param string $content - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param XMLWriter $writer + * @param string $name + * @param string $content */ function xmlwriter_write_dtd_attlist (XMLWriter $writer, string $name, string $content): bool {} /** - * Create start DTD Entity - * @link http://www.php.net/manual/en/xmlwriter.startdtdentity.php - * @param XMLWriter $writer - * @param string $name - * @param bool $isParam - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param XMLWriter $writer + * @param string $name + * @param bool $isParam */ function xmlwriter_start_dtd_entity (XMLWriter $writer, string $name, bool $isParam): bool {} /** - * End current DTD Entity - * @link http://www.php.net/manual/en/xmlwriter.enddtdentity.php - * @param XMLWriter $writer - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param XMLWriter $writer */ function xmlwriter_end_dtd_entity (XMLWriter $writer): bool {} /** - * Write full DTD Entity tag - * @link http://www.php.net/manual/en/xmlwriter.writedtdentity.php - * @param XMLWriter $writer - * @param string $name - * @param string $content - * @param bool $isParam [optional] - * @param string|null $publicId [optional] - * @param string|null $systemId [optional] - * @param string|null $notationData [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param XMLWriter $writer + * @param string $name + * @param string $content + * @param bool $isParam [optional] + * @param string|null $publicId [optional] + * @param string|null $systemId [optional] + * @param string|null $notationData [optional] */ -function xmlwriter_write_dtd_entity (XMLWriter $writer, string $name, string $content, bool $isParam = false, ?string $publicId = null, ?string $systemId = null, ?string $notationData = null): bool {} +function xmlwriter_write_dtd_entity (XMLWriter $writer, string $name, string $content, bool $isParam = false, ?string $publicId = NULL, ?string $systemId = NULL, ?string $notationData = NULL): bool {} /** - * Returns current buffer - * @link http://www.php.net/manual/en/xmlwriter.outputmemory.php - * @param XMLWriter $writer - * @param bool $flush [optional] - * @return string Returns the current buffer as a string. + * {@inheritdoc} + * @param XMLWriter $writer + * @param bool $flush [optional] */ function xmlwriter_output_memory (XMLWriter $writer, bool $flush = true): string {} /** - * Flush current buffer - * @link http://www.php.net/manual/en/xmlwriter.flush.php - * @param XMLWriter $writer - * @param bool $empty [optional] - * @return string|int If you opened the writer in memory, this function returns the generated XML buffer, - * Else, if using URI, this function will write the buffer and return the number of - * written bytes. + * {@inheritdoc} + * @param XMLWriter $writer + * @param bool $empty [optional] */ function xmlwriter_flush (XMLWriter $writer, bool $empty = true): string|int {} -// End of xmlwriter v.8.2.6 +// End of xmlwriter v.8.3.0 diff --git a/plugins/org.eclipse.php.core/Resources/language/php8.3/xsl.php b/plugins/org.eclipse.php.core/Resources/language/php8.3/xsl.php index 7186ae85f6..69060da82a 100644 --- a/plugins/org.eclipse.php.core/Resources/language/php8.3/xsl.php +++ b/plugins/org.eclipse.php.core/Resources/language/php8.3/xsl.php @@ -1,217 +1,99 @@ - * ZipArchive::ER_EXISTS - *
- *
- *
- * "add_path" - *
- *- * Prefix to prepend when translating to the local path of the file within - * the archive. This is applied after any remove operations defined by the - * "remove_path" or "remove_all_path" - * options. - *
- *- * "remove_path" - *
- *- * Prefix to remove from matching file paths before adding to the archive. - *
- *- * "remove_all_path" - *
- *- * true to use the file name only and add to the root of the archive. - *
- *- * "flags" - *
- *- * Bitmask consisting of - * ZipArchive::FL_OVERWRITE, - * ZipArchive::FL_ENC_GUESS, - * ZipArchive::FL_ENC_UTF_8, - * ZipArchive::FL_ENC_CP437. - * The behaviour of these constants is described on the - * ZIP constants page. - *
- *- * "comp_method" - *
- *- * Compression method, one of the ZipArchive::CM_* - * constants, see ZIP constants page. - *
- *- * "comp_flags" - *
- *- * Compression level. - *
- *- * "enc_method" - *
- *- * Encryption method, one of the ZipArchive::EM_* - * constants, see ZIP constants page. - *
- *- * "enc_password" - *
- *- * Password used for encryption. - *
- * - *"add_path"
- *Prefix to prepend when translating to the local path of the file within - * the archive. This is applied after any remove operations defined by the - * "remove_path" or "remove_all_path" - * options.
- *"remove_path"
- *Prefix to remove from matching file paths before adding to the archive.
- *"remove_all_path"
- *true to use the file name only and add to the root of the archive.
- *"flags"
- *Bitmask consisting of - * ZipArchive::FL_OVERWRITE, - * ZipArchive::FL_ENC_GUESS, - * ZipArchive::FL_ENC_UTF_8, - * ZipArchive::FL_ENC_CP437. - * The behaviour of these constants is described on the - * ZIP constants page.
- *"comp_method"
- *Compression method, one of the ZipArchive::CM_* - * constants, see ZIP constants page.
- *"comp_flags"
- *Compression level.
- *"enc_method"
- *Encryption method, one of the ZipArchive::EM_* - * constants, see ZIP constants page.
- *"enc_password"
- *Password used for encryption.
- * @return array|false An array of added files on success or false on failure + * {@inheritdoc} + * @param int $index + * @param string $new_name */ - public function addGlob (string $pattern, int $flags = null, array $options = '[]'): array|false {} + public function renameIndex (int $index, string $new_name) {} /** - * Add files from a directory by PCRE pattern - * @link http://www.php.net/manual/en/ziparchive.addpattern.php - * @param string $pattern A PCRE pattern against which files will be matched. - * @param string $path [optional] The directory that will be scanned. Defaults to the current working directory. - * @param array $options [optional] An associative array of options accepted by ZipArchive::addGlob. - * @return array|false An array of added files on success or false on failure + * {@inheritdoc} + * @param string $name + * @param string $new_name */ - public function addPattern (string $pattern, string $path = '"."', array $options = '[]'): array|false {} + public function renameName (string $name, string $new_name) {} /** - * Renames an entry defined by its index - * @link http://www.php.net/manual/en/ziparchive.renameindex.php - * @param int $index - * @param string $new_name - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $comment */ - public function renameIndex (int $index, string $new_name): bool {} + public function setArchiveComment (string $comment) {} /** - * Renames an entry defined by its name - * @link http://www.php.net/manual/en/ziparchive.renamename.php - * @param string $name - * @param string $new_name - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $flags [optional] */ - public function renameName (string $name, string $new_name): bool {} + public function getArchiveComment (int $flags = 0) {} /** - * Set the comment of a ZIP archive - * @link http://www.php.net/manual/en/ziparchive.setarchivecomment.php - * @param string $comment - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $flag + * @param int $value */ - public function setArchiveComment (string $comment): bool {} + public function setArchiveFlag (int $flag, int $value): bool {} /** - * Returns the Zip archive comment - * @link http://www.php.net/manual/en/ziparchive.getarchivecomment.php - * @param int $flags [optional] - * @return string|false Returns the Zip archive comment or false on failure. + * {@inheritdoc} + * @param int $flag + * @param int $flags [optional] */ - public function getArchiveComment (int $flags = null): string|false {} + public function getArchiveFlag (int $flag, int $flags = 0): int {} /** - * Set the comment of an entry defined by its index - * @link http://www.php.net/manual/en/ziparchive.setcommentindex.php - * @param int $index - * @param string $comment - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $index + * @param string $comment */ - public function setCommentIndex (int $index, string $comment): bool {} + public function setCommentIndex (int $index, string $comment) {} /** - * Set the comment of an entry defined by its name - * @link http://www.php.net/manual/en/ziparchive.setcommentname.php - * @param string $name - * @param string $comment - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $name + * @param string $comment */ - public function setCommentName (string $name, string $comment): bool {} + public function setCommentName (string $name, string $comment) {} /** - * Set the modification time of an entry defined by its index - * @link http://www.php.net/manual/en/ziparchive.setmtimeindex.php - * @param int $index - * @param int $timestamp - * @param int $flags [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $index + * @param int $timestamp + * @param int $flags [optional] */ - public function setMtimeIndex (int $index, int $timestamp, int $flags = null): bool {} + public function setMtimeIndex (int $index, int $timestamp, int $flags = 0) {} /** - * Set the modification time of an entry defined by its name - * @link http://www.php.net/manual/en/ziparchive.setmtimename.php - * @param string $name - * @param int $timestamp - * @param int $flags [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $name + * @param int $timestamp + * @param int $flags [optional] */ - public function setMtimeName (string $name, int $timestamp, int $flags = null): bool {} + public function setMtimeName (string $name, int $timestamp, int $flags = 0) {} /** - * Returns the comment of an entry using the entry index - * @link http://www.php.net/manual/en/ziparchive.getcommentindex.php - * @param int $index - * @param int $flags [optional] - * @return string|false Returns the comment on success or false on failure. + * {@inheritdoc} + * @param int $index + * @param int $flags [optional] */ - public function getCommentIndex (int $index, int $flags = null): string|false {} + public function getCommentIndex (int $index, int $flags = 0) {} /** - * Returns the comment of an entry using the entry name - * @link http://www.php.net/manual/en/ziparchive.getcommentname.php - * @param string $name - * @param int $flags [optional] - * @return string|false Returns the comment on success or false on failure. + * {@inheritdoc} + * @param string $name + * @param int $flags [optional] */ - public function getCommentName (string $name, int $flags = null): string|false {} + public function getCommentName (string $name, int $flags = 0) {} /** - * Delete an entry in the archive using its index - * @link http://www.php.net/manual/en/ziparchive.deleteindex.php - * @param int $index - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $index */ - public function deleteIndex (int $index): bool {} + public function deleteIndex (int $index) {} /** - * Delete an entry in the archive using its name - * @link http://www.php.net/manual/en/ziparchive.deletename.php - * @param string $name - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $name */ - public function deleteName (string $name): bool {} + public function deleteName (string $name) {} /** - * Get the details of an entry defined by its name - * @link http://www.php.net/manual/en/ziparchive.statname.php - * @param string $name - * @param int $flags [optional] - * @return array|false Returns an array containing the entry details or false on failure. + * {@inheritdoc} + * @param string $name + * @param int $flags [optional] */ - public function statName (string $name, int $flags = null): array|false {} + public function statName (string $name, int $flags = 0) {} /** - * Get the details of an entry defined by its index - * @link http://www.php.net/manual/en/ziparchive.statindex.php - * @param int $index - * @param int $flags [optional] - * @return array|false Returns an array containing the entry details or false on failure. + * {@inheritdoc} + * @param int $index + * @param int $flags [optional] */ - public function statIndex (int $index, int $flags = null): array|false {} + public function statIndex (int $index, int $flags = 0) {} /** - * Returns the index of the entry in the archive - * @link http://www.php.net/manual/en/ziparchive.locatename.php - * @param string $name - * @param int $flags [optional] - * @return int|false Returns the index of the entry on success or false on failure. + * {@inheritdoc} + * @param string $name + * @param int $flags [optional] */ - public function locateName (string $name, int $flags = null): int|false {} + public function locateName (string $name, int $flags = 0) {} /** - * Returns the name of an entry using its index - * @link http://www.php.net/manual/en/ziparchive.getnameindex.php - * @param int $index - * @param int $flags [optional] - * @return string|false Returns the name on success or false on failure. + * {@inheritdoc} + * @param int $index + * @param int $flags [optional] */ - public function getNameIndex (int $index, int $flags = null): string|false {} + public function getNameIndex (int $index, int $flags = 0) {} /** - * Revert all global changes done in the archive - * @link http://www.php.net/manual/en/ziparchive.unchangearchive.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function unchangeArchive (): bool {} + public function unchangeArchive () {} /** - * Undo all changes done in the archive - * @link http://www.php.net/manual/en/ziparchive.unchangeall.php - * @return bool Returns true on success or false on failure. + * {@inheritdoc} */ - public function unchangeAll (): bool {} + public function unchangeAll () {} /** - * Revert all changes done to an entry at the given index - * @link http://www.php.net/manual/en/ziparchive.unchangeindex.php - * @param int $index - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $index */ - public function unchangeIndex (int $index): bool {} + public function unchangeIndex (int $index) {} /** - * Revert all changes done to an entry with the given name - * @link http://www.php.net/manual/en/ziparchive.unchangename.php - * @param string $name - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $name */ - public function unchangeName (string $name): bool {} + public function unchangeName (string $name) {} /** - * Extract the archive contents - * @link http://www.php.net/manual/en/ziparchive.extractto.php - * @param string $pathto - * @param array|string|null $files [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $pathto + * @param array|string|null $files [optional] */ - public function extractTo (string $pathto, array|string|null $files = null): bool {} + public function extractTo (string $pathto, array|string|null $files = NULL) {} /** - * Returns the entry contents using its name - * @link http://www.php.net/manual/en/ziparchive.getfromname.php - * @param string $name - * @param int $len [optional] - * @param int $flags [optional] - * @return string|false Returns the contents of the entry on success or false on failure. + * {@inheritdoc} + * @param string $name + * @param int $len [optional] + * @param int $flags [optional] */ - public function getFromName (string $name, int $len = null, int $flags = null): string|false {} + public function getFromName (string $name, int $len = 0, int $flags = 0) {} /** - * Returns the entry contents using its index - * @link http://www.php.net/manual/en/ziparchive.getfromindex.php - * @param int $index - * @param int $len [optional] - * @param int $flags [optional] - * @return string|false Returns the contents of the entry on success or false on failure. + * {@inheritdoc} + * @param int $index + * @param int $len [optional] + * @param int $flags [optional] */ - public function getFromIndex (int $index, int $len = null, int $flags = null): string|false {} + public function getFromIndex (int $index, int $len = 0, int $flags = 0) {} /** - * Get a file handler to the entry defined by its index (read only) - * @link http://www.php.net/manual/en/ziparchive.getstreamindex.php - * @param int $index - * @param int $flags [optional] - * @return resource|false Returns a file pointer (resource) on success or false on failure. + * {@inheritdoc} + * @param int $index + * @param int $flags [optional] */ - public function getStreamIndex (int $index, int $flags = null) {} + public function getStreamIndex (int $index, int $flags = 0) {} /** - * Get a file handler to the entry defined by its name (read only) - * @link http://www.php.net/manual/en/ziparchive.getstreamname.php - * @param string $name - * @param int $flags [optional] - * @return resource|false Returns a file pointer (resource) on success or false on failure. + * {@inheritdoc} + * @param string $name + * @param int $flags [optional] */ - public function getStreamName (string $name, int $flags = null) {} + public function getStreamName (string $name, int $flags = 0) {} /** - * Get a file handler to the entry defined by its name (read only) - * @link http://www.php.net/manual/en/ziparchive.getstream.php - * @param string $name - * @return resource|false Returns a file pointer (resource) on success or false on failure. + * {@inheritdoc} + * @param string $name */ public function getStream (string $name) {} /** - * Set the external attributes of an entry defined by its name - * @link http://www.php.net/manual/en/ziparchive.setexternalattributesname.php - * @param string $name - * @param int $opsys - * @param int $attr - * @param int $flags [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $name + * @param int $opsys + * @param int $attr + * @param int $flags [optional] */ - public function setExternalAttributesName (string $name, int $opsys, int $attr, int $flags = null): bool {} + public function setExternalAttributesName (string $name, int $opsys, int $attr, int $flags = 0) {} /** - * Set the external attributes of an entry defined by its index - * @link http://www.php.net/manual/en/ziparchive.setexternalattributesindex.php - * @param int $index - * @param int $opsys - * @param int $attr - * @param int $flags [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $index + * @param int $opsys + * @param int $attr + * @param int $flags [optional] */ - public function setExternalAttributesIndex (int $index, int $opsys, int $attr, int $flags = null): bool {} + public function setExternalAttributesIndex (int $index, int $opsys, int $attr, int $flags = 0) {} /** - * Retrieve the external attributes of an entry defined by its name - * @link http://www.php.net/manual/en/ziparchive.getexternalattributesname.php - * @param string $name - * @param int $opsys - * @param int $attr - * @param int $flags [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $name + * @param mixed $opsys + * @param mixed $attr + * @param int $flags [optional] */ - public function getExternalAttributesName (string $name, int &$opsys, int &$attr, int $flags = null): bool {} + public function getExternalAttributesName (string $name, &$opsys = null, &$attr = null, int $flags = 0) {} /** - * Retrieve the external attributes of an entry defined by its index - * @link http://www.php.net/manual/en/ziparchive.getexternalattributesindex.php - * @param int $index - * @param int $opsys - * @param int $attr - * @param int $flags [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $index + * @param mixed $opsys + * @param mixed $attr + * @param int $flags [optional] */ - public function getExternalAttributesIndex (int $index, int &$opsys, int &$attr, int $flags = null): bool {} + public function getExternalAttributesIndex (int $index, &$opsys = null, &$attr = null, int $flags = 0) {} /** - * Set the compression method of an entry defined by its name - * @link http://www.php.net/manual/en/ziparchive.setcompressionname.php - * @param string $name - * @param int $method - * @param int $compflags [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $name + * @param int $method + * @param int $compflags [optional] */ - public function setCompressionName (string $name, int $method, int $compflags = null): bool {} + public function setCompressionName (string $name, int $method, int $compflags = 0) {} /** - * Set the compression method of an entry defined by its index - * @link http://www.php.net/manual/en/ziparchive.setcompressionindex.php - * @param int $index - * @param int $method - * @param int $compflags [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $index + * @param int $method + * @param int $compflags [optional] */ - public function setCompressionIndex (int $index, int $method, int $compflags = null): bool {} + public function setCompressionIndex (int $index, int $method, int $compflags = 0) {} /** - * Set the encryption method of an entry defined by its name - * @link http://www.php.net/manual/en/ziparchive.setencryptionname.php - * @param string $name - * @param int $method - * @param string|null $password [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param string $name + * @param int $method + * @param string|null $password [optional] */ - public function setEncryptionName (string $name, int $method, ?string $password = null): bool {} + public function setEncryptionName (string $name, int $method, ?string $password = NULL) {} /** - * Set the encryption method of an entry defined by its index - * @link http://www.php.net/manual/en/ziparchive.setencryptionindex.php - * @param int $index - * @param int $method - * @param string|null $password [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $index + * @param int $method + * @param string|null $password [optional] */ - public function setEncryptionIndex (int $index, int $method, ?string $password = null): bool {} + public function setEncryptionIndex (int $index, int $method, ?string $password = NULL) {} /** - * Register a callback to provide updates during archive close. - * @link http://www.php.net/manual/en/ziparchive.registerprogresscallback.php - * @param float $rate - * @param callable $callback - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param float $rate + * @param callable $callback */ - public function registerProgressCallback (float $rate, callable $callback): bool {} + public function registerProgressCallback (float $rate, callable $callback) {} /** - * Register a callback to allow cancellation during archive close. - * @link http://www.php.net/manual/en/ziparchive.registercancelcallback.php - * @param callable $callback - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param callable $callback */ - public function registerCancelCallback (callable $callback): bool {} + public function registerCancelCallback (callable $callback) {} /** - * Check if a compression method is supported by libzip - * @link http://www.php.net/manual/en/ziparchive.iscompressionmethoddupported.php - * @param int $method - * @param bool $enc [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $method + * @param bool $enc [optional] */ public static function isCompressionMethodSupported (int $method, bool $enc = true): bool {} /** - * Check if a encryption method is supported by libzip - * @link http://www.php.net/manual/en/ziparchive.isencryptionmethoddupported.php - * @param int $method - * @param bool $enc [optional] - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param int $method + * @param bool $enc [optional] */ public static function isEncryptionMethodSupported (int $method, bool $enc = true): bool {} } /** - * Open a ZIP file archive - * @link http://www.php.net/manual/en/function.zip-open.php - * @param string $filename - * @return resource|int|false Returns a resource handle for later use with - * zip_read and zip_close - * or returns either false or the number of error if filename - * does not exist or in case of other error. - * @deprecated 1 + * {@inheritdoc} + * @param string $filename + * @deprecated */ function zip_open (string $filename) {} /** - * Close a ZIP file archive - * @link http://www.php.net/manual/en/function.zip-close.php - * @param resource $zip - * @return void No value is returned. - * @deprecated 1 + * {@inheritdoc} + * @param mixed $zip + * @deprecated */ -function zip_close ($zip): void {} +function zip_close ($zip = null): void {} /** - * Read next entry in a ZIP file archive - * @link http://www.php.net/manual/en/function.zip-read.php - * @param resource $zip - * @return resource|false Returns a directory entry resource for later use with the - * zip_entry_... functions, or false if - * there are no more entries to read, or an error code if an error - * occurred. - * @deprecated 1 + * {@inheritdoc} + * @param mixed $zip + * @deprecated */ -function zip_read ($zip) {} +function zip_read ($zip = null) {} /** - * Open a directory entry for reading - * @link http://www.php.net/manual/en/function.zip-entry-open.php - * @param resource $zip_dp - * @param resource $zip_entry - * @param string $mode [optional] - * @return bool Returns true on success or false on failure. - *Unlike fopen and other similar functions, - * the return value of zip_entry_open only - * indicates the result of the operation and is not needed for - * reading or closing the directory entry.
- * @deprecated 1 + * {@inheritdoc} + * @param mixed $zip_dp + * @param mixed $zip_entry + * @param string $mode [optional] + * @deprecated */ -function zip_entry_open ($zip_dp, $zip_entry, string $mode = '"rb"'): bool {} +function zip_entry_open ($zip_dp = null, $zip_entry = null, string $mode = 'rb'): bool {} /** - * Close a directory entry - * @link http://www.php.net/manual/en/function.zip-entry-close.php - * @param resource $zip_entry - * @return bool Returns true on success or false on failure. - * @deprecated 1 + * {@inheritdoc} + * @param mixed $zip_entry + * @deprecated */ -function zip_entry_close ($zip_entry): bool {} +function zip_entry_close ($zip_entry = null): bool {} /** - * Read from an open directory entry - * @link http://www.php.net/manual/en/function.zip-entry-read.php - * @param resource $zip_entry - * @param int $len [optional] - * @return string|false Returns the data read, empty string on end of a file, or false on error. - * @deprecated 1 + * {@inheritdoc} + * @param mixed $zip_entry + * @param int $len [optional] + * @deprecated */ -function zip_entry_read ($zip_entry, int $len = 1024): string|false {} +function zip_entry_read ($zip_entry = null, int $len = 1024): string|false {} /** - * Retrieve the name of a directory entry - * @link http://www.php.net/manual/en/function.zip-entry-name.php - * @param resource $zip_entry - * @return string|false The name of the directory entry, or false on failure. - * @deprecated 1 + * {@inheritdoc} + * @param mixed $zip_entry + * @deprecated */ -function zip_entry_name ($zip_entry): string|false {} +function zip_entry_name ($zip_entry = null): string|false {} /** - * Retrieve the compressed size of a directory entry - * @link http://www.php.net/manual/en/function.zip-entry-compressedsize.php - * @param resource $zip_entry - * @return int|false The compressed size, or false on failure. - * @deprecated 1 + * {@inheritdoc} + * @param mixed $zip_entry + * @deprecated */ -function zip_entry_compressedsize ($zip_entry): int|false {} +function zip_entry_compressedsize ($zip_entry = null): int|false {} /** - * Retrieve the actual file size of a directory entry - * @link http://www.php.net/manual/en/function.zip-entry-filesize.php - * @param resource $zip_entry - * @return int|false The size of the directory entry, or false on failure. - * @deprecated 1 + * {@inheritdoc} + * @param mixed $zip_entry + * @deprecated */ -function zip_entry_filesize ($zip_entry): int|false {} +function zip_entry_filesize ($zip_entry = null): int|false {} /** - * Retrieve the compression method of a directory entry - * @link http://www.php.net/manual/en/function.zip-entry-compressionmethod.php - * @param resource $zip_entry - * @return string|false The compression method, or false on failure. - * @deprecated 1 + * {@inheritdoc} + * @param mixed $zip_entry + * @deprecated */ -function zip_entry_compressionmethod ($zip_entry): string|false {} +function zip_entry_compressionmethod ($zip_entry = null): string|false {} -// End of zip v.1.21.1 +// End of zip v.1.22.3 diff --git a/plugins/org.eclipse.php.core/Resources/language/php8.3/zlib.php b/plugins/org.eclipse.php.core/Resources/language/php8.3/zlib.php index ec92753654..1b600beeca 100644 --- a/plugins/org.eclipse.php.core/Resources/language/php8.3/zlib.php +++ b/plugins/org.eclipse.php.core/Resources/language/php8.3/zlib.php @@ -1,530 +1,243 @@ If the open fails, the function returns false. + * {@inheritdoc} + * @param string $filename + * @param string $mode + * @param int $use_include_path [optional] */ -function gzopen (string $filename, string $mode, int $use_include_path = null) {} +function gzopen (string $filename, string $mode, int $use_include_path = 0) {} /** - * Output a gz-file - * @link http://www.php.net/manual/en/function.readgzfile.php - * @param string $filename - * @param int $use_include_path [optional] - * @return int|false Returns the number of (uncompressed) bytes read from the file on success, - * or false on failure + * {@inheritdoc} + * @param string $filename + * @param int $use_include_path [optional] */ -function readgzfile (string $filename, int $use_include_path = null): int|false {} +function readgzfile (string $filename, int $use_include_path = 0): int|false {} /** - * Compress data with the specified encoding - * @link http://www.php.net/manual/en/function.zlib-encode.php - * @param string $data The data to compress. - * @param int $encoding The compression algorithm. Either ZLIB_ENCODING_RAW, - * ZLIB_ENCODING_DEFLATE or - * ZLIB_ENCODING_GZIP. - * @param int $level [optional] - * @return string|false + * {@inheritdoc} + * @param string $data + * @param int $encoding + * @param int $level [optional] */ function zlib_encode (string $data, int $encoding, int $level = -1): string|false {} /** - * Uncompress any raw/gzip/zlib encoded data - * @link http://www.php.net/manual/en/function.zlib-decode.php - * @param string $data - * @param int $max_length [optional] - * @return string|false Returns the uncompressed data, or false on failure. + * {@inheritdoc} + * @param string $data + * @param int $max_length [optional] */ -function zlib_decode (string $data, int $max_length = null): string|false {} +function zlib_decode (string $data, int $max_length = 0): string|false {} /** - * Deflate a string - * @link http://www.php.net/manual/en/function.gzdeflate.php - * @param string $data - * @param int $level [optional] - * @param int $encoding [optional] - * @return string|false The deflated string or false if an error occurred. + * {@inheritdoc} + * @param string $data + * @param int $level [optional] + * @param int $encoding [optional] */ -function gzdeflate (string $data, int $level = -1, int $encoding = ZLIB_ENCODING_RAW): string|false {} +function gzdeflate (string $data, int $level = -1, int $encoding = -15): string|false {} /** - * Create a gzip compressed string - * @link http://www.php.net/manual/en/function.gzencode.php - * @param string $data - * @param int $level [optional] - * @param int $encoding [optional] - * @return string|false The encoded string, or false if an error occurred. + * {@inheritdoc} + * @param string $data + * @param int $level [optional] + * @param int $encoding [optional] */ -function gzencode (string $data, int $level = -1, int $encoding = ZLIB_ENCODING_GZIP): string|false {} +function gzencode (string $data, int $level = -1, int $encoding = 31): string|false {} /** - * Compress a string - * @link http://www.php.net/manual/en/function.gzcompress.php - * @param string $data - * @param int $level [optional] - * @param int $encoding [optional] - * @return string|false The compressed string or false if an error occurred. + * {@inheritdoc} + * @param string $data + * @param int $level [optional] + * @param int $encoding [optional] */ -function gzcompress (string $data, int $level = -1, int $encoding = ZLIB_ENCODING_DEFLATE): string|false {} +function gzcompress (string $data, int $level = -1, int $encoding = 15): string|false {} /** - * Inflate a deflated string - * @link http://www.php.net/manual/en/function.gzinflate.php - * @param string $data - * @param int $max_length [optional] - * @return string|false The original uncompressed data or false on error. - *The function will return an error if the uncompressed data is more than - * 32768 times the length of the compressed input data - * or, unless max_length is 0, more than the optional parameter max_length.
+ * {@inheritdoc} + * @param string $data + * @param int $max_length [optional] */ -function gzinflate (string $data, int $max_length = null): string|false {} +function gzinflate (string $data, int $max_length = 0): string|false {} /** - * Decodes a gzip compressed string - * @link http://www.php.net/manual/en/function.gzdecode.php - * @param string $data - * @param int $max_length [optional] - * @return string|false The decoded string, or or false on failure. + * {@inheritdoc} + * @param string $data + * @param int $max_length [optional] */ -function gzdecode (string $data, int $max_length = null): string|false {} +function gzdecode (string $data, int $max_length = 0): string|false {} /** - * Uncompress a compressed string - * @link http://www.php.net/manual/en/function.gzuncompress.php - * @param string $data - * @param int $max_length [optional] - * @return string|false The original uncompressed data or false on error. - *The function will return an error if the uncompressed data is more than - * 32768 times the length of the compressed input data - * or more than the optional parameter max_length.
+ * {@inheritdoc} + * @param string $data + * @param int $max_length [optional] */ -function gzuncompress (string $data, int $max_length = null): string|false {} +function gzuncompress (string $data, int $max_length = 0): string|false {} /** - * Binary-safe gz-file write - * @link http://www.php.net/manual/en/function.gzwrite.php - * @param resource $stream - * @param string $data - * @param int|null $length [optional] - * @return int|false Returns the number of (uncompressed) bytes written to the given gz-file - * stream, or false on failure. + * {@inheritdoc} + * @param mixed $stream + * @param string $data + * @param int|null $length [optional] */ -function gzwrite ($stream, string $data, ?int $length = null): int|false {} +function gzwrite ($stream = null, string $data, ?int $length = NULL): int|false {} /** - * Alias of gzwrite - * @link http://www.php.net/manual/en/function.gzputs.php - * @param resource $stream - * @param string $data - * @param int|null $length [optional] - * @return int|false Returns the number of (uncompressed) bytes written to the given gz-file - * stream, or false on failure. + * {@inheritdoc} + * @param mixed $stream + * @param string $data + * @param int|null $length [optional] */ -function gzputs ($stream, string $data, ?int $length = null): int|false {} +function gzputs ($stream = null, string $data, ?int $length = NULL): int|false {} /** - * Rewind the position of a gz-file pointer - * @link http://www.php.net/manual/en/function.gzrewind.php - * @param resource $stream - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mixed $stream */ -function gzrewind ($stream): bool {} +function gzrewind ($stream = null): bool {} /** - * Close an open gz-file pointer - * @link http://www.php.net/manual/en/function.gzclose.php - * @param resource $stream - * @return bool Returns true on success or false on failure. + * {@inheritdoc} + * @param mixed $stream */ -function gzclose ($stream): bool {} +function gzclose ($stream = null): bool {} /** - * Test for EOF on a gz-file pointer - * @link http://www.php.net/manual/en/function.gzeof.php - * @param resource $stream - * @return bool Returns true if the gz-file pointer is at EOF or an error occurs; - * otherwise returns false. + * {@inheritdoc} + * @param mixed $stream */ -function gzeof ($stream): bool {} +function gzeof ($stream = null): bool {} /** - * Get character from gz-file pointer - * @link http://www.php.net/manual/en/function.gzgetc.php - * @param resource $stream - * @return string|false The uncompressed character or false on EOF (unlike gzeof). + * {@inheritdoc} + * @param mixed $stream */ -function gzgetc ($stream): string|false {} +function gzgetc ($stream = null): string|false {} /** - * Output all remaining data on a gz-file pointer - * @link http://www.php.net/manual/en/function.gzpassthru.php - * @param resource $stream - * @return int The number of uncompressed characters read from gz - * and passed through to the input. + * {@inheritdoc} + * @param mixed $stream */ -function gzpassthru ($stream): int {} +function gzpassthru ($stream = null): int {} /** - * Seek on a gz-file pointer - * @link http://www.php.net/manual/en/function.gzseek.php - * @param resource $stream - * @param int $offset - * @param int $whence [optional] - * @return int Upon success, returns 0; otherwise, returns -1. Note that seeking - * past EOF is not considered an error. + * {@inheritdoc} + * @param mixed $stream + * @param int $offset + * @param int $whence [optional] */ -function gzseek ($stream, int $offset, int $whence = SEEK_SET): int {} +function gzseek ($stream = null, int $offset, int $whence = 0): int {} /** - * Tell gz-file pointer read/write position - * @link http://www.php.net/manual/en/function.gztell.php - * @param resource $stream - * @return int|false The position of the file pointer or false if an error occurs. + * {@inheritdoc} + * @param mixed $stream */ -function gztell ($stream): int|false {} +function gztell ($stream = null): int|false {} /** - * Binary-safe gz-file read - * @link http://www.php.net/manual/en/function.gzread.php - * @param resource $stream - * @param int $length - * @return string|false The data that have been read, or false on failure. + * {@inheritdoc} + * @param mixed $stream + * @param int $length */ -function gzread ($stream, int $length): string|false {} +function gzread ($stream = null, int $length): string|false {} /** - * Get line from file pointer - * @link http://www.php.net/manual/en/function.gzgets.php - * @param resource $stream - * @param int|null $length [optional] - * @return string|false The uncompressed string, or false on error. + * {@inheritdoc} + * @param mixed $stream + * @param int|null $length [optional] */ -function gzgets ($stream, ?int $length = null): string|false {} +function gzgets ($stream = null, ?int $length = NULL): string|false {} /** - * Initialize an incremental deflate context - * @link http://www.php.net/manual/en/function.deflate-init.php - * @param int $encoding One of the ZLIB_ENCODING_* constants. - * @param array $options [optional] An associative array which may contain the following elements: - *
- * level
- *
- *
- * The compression level in range -1..9; defaults to -1. - *
- * memory - *- * The compression memory level in range 1..9; defaults to 8. - *
- * window - *- * The zlib window size (logarithmic) in range 8..15; - * defaults to 15. - * zlib changes a window size of 8 to 9, - * and as of zlib 1.2.8 fails with a warning, if a window size of 8 - * is requested for ZLIB_ENCODING_RAW or ZLIB_ENCODING_GZIP. - *
- * strategy - *- * One of ZLIB_FILTERED, - * ZLIB_HUFFMAN_ONLY, ZLIB_RLE, - * ZLIB_FIXED or - * ZLIB_DEFAULT_STRATEGY (the default). - *
- * dictionary - *- * A string or an array of strings - * of the preset dictionary (default: no preset dictionary). - *
- * - *The compression level in range -1..9; defaults to -1.
- *The compression memory level in range 1..9; defaults to 8.
- *The zlib window size (logarithmic) in range 8..15; - * defaults to 15. - * zlib changes a window size of 8 to 9, - * and as of zlib 1.2.8 fails with a warning, if a window size of 8 - * is requested for ZLIB_ENCODING_RAW or ZLIB_ENCODING_GZIP.
- *One of ZLIB_FILTERED, - * ZLIB_HUFFMAN_ONLY, ZLIB_RLE, - * ZLIB_FIXED or - * ZLIB_DEFAULT_STRATEGY (the default).
- *A string or an array of strings - * of the preset dictionary (default: no preset dictionary).
- * @return DeflateContext|false Returns a deflate context resource (zlib.deflate) on - * success, or false on failure. + * {@inheritdoc} + * @param int $encoding + * @param array $options [optional] */ -function deflate_init (int $encoding, array $options = '[]'): DeflateContext|false {} +function deflate_init (int $encoding, array $options = array ( +)): DeflateContext|false {} /** - * Incrementally deflate data - * @link http://www.php.net/manual/en/function.deflate-add.php - * @param DeflateContext $context A context created with deflate_init. - * @param string $data A chunk of data to compress. - * @param int $flush_mode [optional] One of ZLIB_BLOCK, - * ZLIB_NO_FLUSH, - * ZLIB_PARTIAL_FLUSH, - * ZLIB_SYNC_FLUSH (default), - * ZLIB_FULL_FLUSH, ZLIB_FINISH. - * Normally you will want to set ZLIB_NO_FLUSH to - * maximize compression, and ZLIB_FINISH to terminate - * with the last chunk of data. See the zlib manual for a - * detailed description of these constants. - * @return string|false Returns a chunk of compressed data, or false on failure. + * {@inheritdoc} + * @param DeflateContext $context + * @param string $data + * @param int $flush_mode [optional] */ -function deflate_add (DeflateContext $context, string $data, int $flush_mode = ZLIB_SYNC_FLUSH): string|false {} +function deflate_add (DeflateContext $context, string $data, int $flush_mode = 2): string|false {} /** - * Initialize an incremental inflate context - * @link http://www.php.net/manual/en/function.inflate-init.php - * @param int $encoding One of the ZLIB_ENCODING_* constants. - * @param array $options [optional] An associative array which may contain the following elements: - *
- * level
- *
- *
- * The compression level in range -1..9; defaults to -1. - *
- * memory - *- * The compression memory level in range 1..9; defaults to 8. - *
- * window - *- * The zlib window size (logarithmic) in range 8..15; defaults to 15. - *
- * strategy - *- * One of ZLIB_FILTERED, - * ZLIB_HUFFMAN_ONLY, ZLIB_RLE, - * ZLIB_FIXED or - * ZLIB_DEFAULT_STRATEGY (the default). - *
- * dictionary - *- * A string or an array of strings - * of the preset dictionary (default: no preset dictionary). - *
- * - *The compression level in range -1..9; defaults to -1.
- *The compression memory level in range 1..9; defaults to 8.
- *The zlib window size (logarithmic) in range 8..15; defaults to 15.
- *One of ZLIB_FILTERED, - * ZLIB_HUFFMAN_ONLY, ZLIB_RLE, - * ZLIB_FIXED or - * ZLIB_DEFAULT_STRATEGY (the default).
- *A string or an array of strings - * of the preset dictionary (default: no preset dictionary).
- * @return InflateContext|false Returns an inflate context resource (zlib.inflate) on - * success, or false on failure. + * {@inheritdoc} + * @param int $encoding + * @param array $options [optional] */ -function inflate_init (int $encoding, array $options = '[]'): InflateContext|false {} +function inflate_init (int $encoding, array $options = array ( +)): InflateContext|false {} /** - * Incrementally inflate encoded data - * @link http://www.php.net/manual/en/function.inflate-add.php - * @param InflateContext $context A context created with inflate_init. - * @param string $data A chunk of compressed data. - * @param int $flush_mode [optional] One of ZLIB_BLOCK, - * ZLIB_NO_FLUSH, - * ZLIB_PARTIAL_FLUSH, - * ZLIB_SYNC_FLUSH (default), - * ZLIB_FULL_FLUSH, ZLIB_FINISH. - * Normally you will want to set ZLIB_NO_FLUSH to - * maximize compression, and ZLIB_FINISH to terminate - * with the last chunk of data. See the zlib manual for a - * detailed description of these constants. - * @return string|false Returns a chunk of uncompressed data, or false on failure. + * {@inheritdoc} + * @param InflateContext $context + * @param string $data + * @param int $flush_mode [optional] */ -function inflate_add (InflateContext $context, string $data, int $flush_mode = ZLIB_SYNC_FLUSH): string|false {} +function inflate_add (InflateContext $context, string $data, int $flush_mode = 2): string|false {} /** - * Get decompression status - * @link http://www.php.net/manual/en/function.inflate-get-status.php - * @param InflateContext $context - * @return int Returns decompression status. + * {@inheritdoc} + * @param InflateContext $context */ function inflate_get_status (InflateContext $context): int {} /** - * Get number of bytes read so far - * @link http://www.php.net/manual/en/function.inflate-get-read-len.php - * @param InflateContext $context - * @return int Returns number of bytes read so far or false on failure. + * {@inheritdoc} + * @param InflateContext $context */ function inflate_get_read_len (InflateContext $context): int {} - -/** - * - * @link http://www.php.net/manual/en/zlib.constants.php - * @var int - */ define ('FORCE_GZIP', 31); - -/** - * - * @link http://www.php.net/manual/en/zlib.constants.php - * @var int - */ define ('FORCE_DEFLATE', 15); - -/** - * DEFLATE algorithm as per RFC 1951. - * @link http://www.php.net/manual/en/zlib.constants.php - * @var int - */ define ('ZLIB_ENCODING_RAW', -15); - -/** - * GZIP algorithm as per RFC 1952. - * @link http://www.php.net/manual/en/zlib.constants.php - * @var int - */ define ('ZLIB_ENCODING_GZIP', 31); - -/** - * ZLIB compression algorithm as per RFC 1950. - * @link http://www.php.net/manual/en/zlib.constants.php - * @var int - */ define ('ZLIB_ENCODING_DEFLATE', 15); - -/** - * - * @link http://www.php.net/manual/en/zlib.constants.php - * @var int - */ define ('ZLIB_NO_FLUSH', 0); - -/** - * - * @link http://www.php.net/manual/en/zlib.constants.php - * @var int - */ define ('ZLIB_PARTIAL_FLUSH', 1); - -/** - * - * @link http://www.php.net/manual/en/zlib.constants.php - * @var int - */ define ('ZLIB_SYNC_FLUSH', 2); - -/** - * - * @link http://www.php.net/manual/en/zlib.constants.php - * @var int - */ define ('ZLIB_FULL_FLUSH', 3); - -/** - * - * @link http://www.php.net/manual/en/zlib.constants.php - * @var int - */ define ('ZLIB_BLOCK', 5); - -/** - * - * @link http://www.php.net/manual/en/zlib.constants.php - * @var int - */ define ('ZLIB_FINISH', 4); - -/** - * - * @link http://www.php.net/manual/en/zlib.constants.php - * @var int - */ define ('ZLIB_FILTERED', 1); - -/** - * - * @link http://www.php.net/manual/en/zlib.constants.php - * @var int - */ define ('ZLIB_HUFFMAN_ONLY', 2); - -/** - * - * @link http://www.php.net/manual/en/zlib.constants.php - * @var int - */ define ('ZLIB_RLE', 3); - -/** - * - * @link http://www.php.net/manual/en/zlib.constants.php - * @var int - */ define ('ZLIB_FIXED', 4); - -/** - * - * @link http://www.php.net/manual/en/zlib.constants.php - * @var int - */ define ('ZLIB_DEFAULT_STRATEGY', 0); -define ('ZLIB_VERSION', "1.2.11"); -define ('ZLIB_VERNUM', 4784); +define ('ZLIB_VERSION', "1.2.12"); +define ('ZLIB_VERNUM', 4800); define ('ZLIB_OK', 0); define ('ZLIB_STREAM_END', 1); define ('ZLIB_NEED_DICT', 2); @@ -535,4 +248,4 @@ function inflate_get_read_len (InflateContext $context): int {} define ('ZLIB_BUF_ERROR', -5); define ('ZLIB_VERSION_ERROR', -6); -// End of zlib v.8.2.6 +// End of zlib v.8.3.0