Returns the string representation of the thrown object.
* @since 7.0 */ - public function __toString(){} + public function __toString() {} /** * Clone the error @@ -458,9 +447,9 @@ public function __toString(){} * @return void * @link https://php.net/manual/en/error.clone.php */ - private final function __clone(){} + final private function __clone() {} - public function __wakeup(){} + public function __wakeup() {} } class ValueError extends Error {} @@ -473,18 +462,14 @@ class ValueError extends Error {} * @link https://php.net/manual/en/class.typeerror.php * @since 7.0 */ -class TypeError extends Error { - -} +class TypeError extends Error {} /** * ParseError is thrown when an error occurs while parsing PHP code, such as when {@see eval()} is called. * @link https://php.net/manual/en/class.parseerror.php * @since 7.0 */ -class ParseError extends CompileError { - -} +class ParseError extends CompileError {} /** * ArgumentCountError is thrown when too few arguments are passed to a user @@ -502,27 +487,21 @@ class ArgumentCountError extends TypeError {} * @link https://php.net/manual/en/class.arithmeticerror.php * @since 7.0 */ -class ArithmeticError extends Error { - -} +class ArithmeticError extends Error {} /** * Class CompileError * @link https://secure.php.net/manual/en/class.compileerror.php * @since 7.3 */ -class CompileError extends Error { - -} +class CompileError extends Error {} /** * DivisionByZeroError is thrown when an attempt is made to divide a number by zero. * @link https://php.net/manual/en/class.divisionbyzeroerror.php * @since 7.0 */ -class DivisionByZeroError extends ArithmeticError { - -} +class DivisionByZeroError extends ArithmeticError {} /** * @since 8.0 @@ -533,11 +512,10 @@ class UnhandledMatchError extends Error {} * An Error Exception. * @link https://php.net/manual/en/class.errorexception.php */ -class ErrorException extends Exception { - +class ErrorException extends Exception +{ protected $severity; - /** * Constructs the exception * @link https://php.net/manual/en/errorexception.construct.php @@ -549,14 +527,14 @@ class ErrorException extends Exception { * @param Exception $previous [optional] The previous exception used for the exception chaining. */ #[\JetBrains\PhpStorm\Pure] - public function __construct($message = "", $code = 0, $severity = 1, $filename = __FILE__, $line = __LINE__, $previous = null) { } + public function __construct($message = "", $code = 0, $severity = 1, $filename = __FILE__, $line = __LINE__, $previous = null) {} /** * Gets the exception severity * @link https://php.net/manual/en/errorexception.getseverity.php * @return int the severity level of the exception. */ - final public function getSeverity() { } + final public function getSeverity() {} } /** @@ -568,14 +546,14 @@ final public function getSeverity() { } * This is for consistency with other classes that implement calling magic, as this method is not used for calling the function. * @link https://secure.php.net/manual/en/class.closure.php */ -final class Closure { - +final class Closure +{ /** * This method exists only to disallow instantiation of the Closure class. * Objects of this class are created in the fashion described on the anonymous functions page. * @link https://secure.php.net/manual/en/closure.construct.php */ - private function __construct() { } + private function __construct() {} /** * This is for consistency with other classes that implement calling magic, @@ -584,7 +562,7 @@ private function __construct() { } * @return mixed * @link https://secure.php.net/manual/en/class.closure.php */ - public function __invoke(...$_) { } + public function __invoke(...$_) {} /** * Duplicates the closure with a new bound object and class scope @@ -595,7 +573,7 @@ public function __invoke(...$_) { } * This determines the visibility of protected and private methods of the bound object. * @return Closure|false Returns the newly created Closure object or FALSE on failure */ - function bindTo(?object $newThis, object|string|null $newScope = 'static') { } + public function bindTo(?object $newThis, object|string|null $newScope = 'static') {} /** * This method is a static version of Closure::bindTo(). @@ -608,7 +586,7 @@ function bindTo(?object $newThis, object|string|null $newScope = 'static') { } * This determines the visibility of protected and private methods of the bound object. * @return Closure|false Returns the newly created Closure object or FALSE on failure */ - static function bind(Closure $closure, ?object $newThis, object|string|null $newScope = 'static') { } + public static function bind(Closure $closure, ?object $newThis, object|string|null $newScope = 'static') {} /** * Temporarily binds the closure to newthis, and calls it with any given parameters. @@ -618,14 +596,14 @@ static function bind(Closure $closure, ?object $newThis, object|string|null $new * @return mixed * @since 7.0 */ - function call (object $newThis, mixed ...$args) {} + public function call(object $newThis, mixed ...$args) {} /** * @param callable $callback * @return Closure * @since 7.1 */ - public static function fromCallable (callable $callback) {} + public static function fromCallable(callable $callback) {} } /** @@ -633,8 +611,8 @@ public static function fromCallable (callable $callback) {} * count function. * @link https://php.net/manual/en/class.countable.php */ -interface Countable { - +interface Countable +{ /** * Count elements of an object * @link https://php.net/manual/en/countable.count.php @@ -652,7 +630,8 @@ public function count(); * They are useful for implementing cache like structures. * @link https://www.php.net/manual/en/class.weakreference.php */ -class WeakReference { +class WeakReference +{ /** * This method exists only to disallow instantiation of the WeakReference * class. Weak references are to be instantiated with the factory method @@ -687,7 +666,8 @@ public function get() {} * * @since 8.0 */ -final class WeakMap implements \ArrayAccess, \Countable, \IteratorAggregate { +final class WeakMap implements \ArrayAccess, \Countable, \IteratorAggregate +{ /** * Returns {@see true} if the value for the object is contained in * the {@see WeakMap} and {@see false} instead. @@ -703,9 +683,7 @@ public function offsetExists($object) {} * @param object $object Any object * @return mixed Value associated with the key object */ - public function offsetGet($object) - { - } + public function offsetGet($object) {} /** * Sets a new value for an object. @@ -714,9 +692,7 @@ public function offsetGet($object) * @param mixed $value Any value * @return void */ - public function offsetSet($object, mixed $value) - { - } + public function offsetSet($object, mixed $value) {} /** * Force removes an object value from the {@see WeakMap} instance. @@ -724,27 +700,21 @@ public function offsetSet($object, mixed $value) * @param object $object Any object * @return void */ - public function offsetUnset($object) - { - } + public function offsetUnset($object) {} /** * Returns an iterator in the "[object => mixed]" format. * * @return Traversable */ - public function getIterator() - { - } + public function getIterator() {} /** * Returns the number of items in the {@see WeakMap} instance. * * @return int */ - public function count() - { - } + public function count() {} } /** @@ -753,7 +723,8 @@ public function count() * * @since 8.0 */ -interface Stringable { +interface Stringable +{ /** * Magic method {@see https://www.php.net/manual/en/language.oop5.magic.php} * called during serialization to string. @@ -768,56 +739,55 @@ public function __toString(); * @since 8.0 */ #[Attribute(Attribute::TARGET_CLASS)] -final class Attribute { +final class Attribute +{ public int $flags; /** * Marks that attribute declaration is allowed only in classes. */ - const TARGET_CLASS = 1; + public const TARGET_CLASS = 1; /** * Marks that attribute declaration is allowed only in functions. */ - const TARGET_FUNCTION = 2; + public const TARGET_FUNCTION = 2; /** * Marks that attribute declaration is allowed only in class methods. */ - const TARGET_METHOD = 4; + public const TARGET_METHOD = 4; /** * Marks that attribute declaration is allowed only in class properties. */ - const TARGET_PROPERTY = 8; + public const TARGET_PROPERTY = 8; /** * Marks that attribute declaration is allowed only in class constants. */ - const TARGET_CLASS_CONSTANT = 16; + public const TARGET_CLASS_CONSTANT = 16; /** * Marks that attribute declaration is allowed only in function or method parameters. */ - const TARGET_PARAMETER = 32; + public const TARGET_PARAMETER = 32; /** * Marks that attribute declaration is allowed anywhere. */ - const TARGET_ALL = 63; + public const TARGET_ALL = 63; /** * Notes that an attribute declaration in the same place is * allowed multiple times. */ - const IS_REPEATABLE = 64; + public const IS_REPEATABLE = 64; /** * @param int $flags A value in the form of a bitmask indicating the places * where attributes can be defined. */ - public function __construct(#[ExpectedValues(flagsFromClass: Attribute::class)] int $flags = self::TARGET_ALL) - { - } + public function __construct(#[ExpectedValues(flagsFromClass: Attribute::class)] int $flags = self::TARGET_ALL) {} } /** @@ -826,7 +796,8 @@ public function __construct(#[ExpectedValues(flagsFromClass: Attribute::class)] * * @since 8.0 */ -class PhpToken implements Stringable { +class PhpToken implements Stringable +{ /** * One of the T_* constants, or an integer < 256 representing a * single-char token. @@ -854,18 +825,14 @@ class PhpToken implements Stringable { * @param int $line Strating line * @param int $pos Straring position (line offset) */ - final public function __construct(int $id, string $text, int $line = -1, int $pos = -1) - { - } + final public function __construct(int $id, string $text, int $line = -1, int $pos = -1) {} /** * Get the name of the token. * * @return string|null */ - public function getTokenName() - { - } + public function getTokenName() {} /** * Same as {@see token_get_all()}, but returning array of {@see PhpToken} @@ -884,39 +851,34 @@ public static function tokenize(string $code, int $flags = 0) {} * @param int|string|array $kind * @return bool */ - public function is($kind) - { - } + public function is($kind) {} /** * Whether this token would be ignored by the PHP parser. * * @return bool */ - public function isIgnorable() - { - } + public function isIgnorable() {} /** * {@inheritDoc} */ - public function __toString() - { - } + public function __toString() {} } /** * @since 8.0 */ -final class InternalIterator implements Iterator{ - private function __construct(){} - public function current(){} +final class InternalIterator implements Iterator +{ + private function __construct() {} + public function current() {} - public function next(){} + public function next() {} - public function key(){} + public function key() {} - public function valid(){} + public function valid() {} - public function rewind(){} + public function rewind() {} } diff --git a/Core/Core_d.php b/Core/Core_d.php index 06891194d..21c7b2132 100755 --- a/Core/Core_d.php +++ b/Core/Core_d.php @@ -2,14 +2,13 @@ // Start of Core v.5.3.6-13ubuntu3.2 - /** * Fatal run-time errors. These indicate errors that can not be * recovered from, such as a memory allocation problem. * Execution of the script is halted. * @link https://php.net/manual/en/errorfunc.constants.php */ -define ('E_ERROR', 1); +define('E_ERROR', 1); /** * Catchable fatal error. It indicates that a probably dangerous error @@ -19,21 +18,21 @@ * was an E_ERROR. * @link https://php.net/manual/en/errorfunc.constants.php */ -define ('E_RECOVERABLE_ERROR', 4096); +define('E_RECOVERABLE_ERROR', 4096); /** * Run-time warnings (non-fatal errors). Execution of the script is not * halted. * @link https://php.net/manual/en/errorfunc.constants.php */ -define ('E_WARNING', 2); +define('E_WARNING', 2); /** * Compile-time parse errors. Parse errors should only be generated by * the parser. * @link https://php.net/manual/en/errorfunc.constants.php */ -define ('E_PARSE', 4); +define('E_PARSE', 4); /** * Run-time notices. Indicate that the script encountered something that @@ -41,7 +40,7 @@ * running a script. * @link https://php.net/manual/en/errorfunc.constants.php */ -define ('E_NOTICE', 8); +define('E_NOTICE', 8); /** * Enable to have PHP suggest changes @@ -49,21 +48,21 @@ * and forward compatibility of your code. * @link https://php.net/manual/en/errorfunc.constants.php */ -define ('E_STRICT', 2048); +define('E_STRICT', 2048); /** * Run-time notices. Enable this to receive warnings about code * that will not work in future versions. * @link https://php.net/manual/en/errorfunc.constants.php */ -define ('E_DEPRECATED', 8192); +define('E_DEPRECATED', 8192); /** * Fatal errors that occur during PHP's initial startup. This is like an * E_ERROR, except it is generated by the core of PHP. * @link https://php.net/manual/en/errorfunc.constants.php */ -define ('E_CORE_ERROR', 16); +define('E_CORE_ERROR', 16); /** * Warnings (non-fatal errors) that occur during PHP's initial startup. @@ -71,14 +70,14 @@ * by the core of PHP. * @link https://php.net/manual/en/errorfunc.constants.php */ -define ('E_CORE_WARNING', 32); +define('E_CORE_WARNING', 32); /** * Fatal compile-time errors. This is like an E_ERROR, * except it is generated by the Zend Scripting Engine. * @link https://php.net/manual/en/errorfunc.constants.php */ -define ('E_COMPILE_ERROR', 64); +define('E_COMPILE_ERROR', 64); /** * Compile-time warnings (non-fatal errors). This is like an @@ -86,7 +85,7 @@ * Scripting Engine. * @link https://php.net/manual/en/errorfunc.constants.php */ -define ('E_COMPILE_WARNING', 128); +define('E_COMPILE_WARNING', 128); /** * User-generated error message. This is like an @@ -94,7 +93,7 @@ * using the PHP function trigger_error. * @link https://php.net/manual/en/errorfunc.constants.php */ -define ('E_USER_ERROR', 256); +define('E_USER_ERROR', 256); /** * User-generated warning message. This is like an @@ -102,7 +101,7 @@ * using the PHP function trigger_error. * @link https://php.net/manual/en/errorfunc.constants.php */ -define ('E_USER_WARNING', 512); +define('E_USER_WARNING', 512); /** * User-generated notice message. This is like an @@ -110,7 +109,7 @@ * using the PHP function trigger_error. * @link https://php.net/manual/en/errorfunc.constants.php */ -define ('E_USER_NOTICE', 1024); +define('E_USER_NOTICE', 1024); /** * User-generated warning message. This is like an @@ -118,7 +117,7 @@ * using the PHP function trigger_error. * @link https://php.net/manual/en/errorfunc.constants.php */ -define ('E_USER_DEPRECATED', 16384); +define('E_USER_DEPRECATED', 16384); /** * All errors and warnings, as supported, except of level @@ -127,89 +126,89 @@ * 30719 in PHP 5.3.x, 6143 in PHP 5.2.x, 2047 previously * @link https://php.net/manual/en/errorfunc.constants.php */ -define ('E_ALL', 32767); -define ('DEBUG_BACKTRACE_PROVIDE_OBJECT', 1); -define ('DEBUG_BACKTRACE_IGNORE_ARGS', 2); -define ('S_MEMORY', 1); -define ('S_VARS', 4); -define ('S_FILES', 8); -define ('S_INCLUDE', 16); -define ('S_SQL', 32); -define ('S_EXECUTOR', 64); -define ('S_MAIL', 128); -define ('S_SESSION', 256); -define ('S_MISC', 2); -define ('S_INTERNAL', 536870912); -define ('S_ALL', 511); +define('E_ALL', 32767); +define('DEBUG_BACKTRACE_PROVIDE_OBJECT', 1); +define('DEBUG_BACKTRACE_IGNORE_ARGS', 2); +define('S_MEMORY', 1); +define('S_VARS', 4); +define('S_FILES', 8); +define('S_INCLUDE', 16); +define('S_SQL', 32); +define('S_EXECUTOR', 64); +define('S_MAIL', 128); +define('S_SESSION', 256); +define('S_MISC', 2); +define('S_INTERNAL', 536870912); +define('S_ALL', 511); -define ('true', (bool)1, true); -define ('false', (bool)0, true); -define ('null', null, true); -define ('ZEND_THREAD_SAFE', false); -define ('ZEND_DEBUG_BUILD', false); -define ('PHP_WINDOWS_VERSION_BUILD', 0); -define ('PHP_WINDOWS_VERSION_MAJOR', 0); -define ('PHP_WINDOWS_VERSION_MINOR', 0); -define ('PHP_WINDOWS_VERSION_PLATFORM', 0); -define ('PHP_WINDOWS_VERSION_PRODUCTTYPE', 0); -define ('PHP_WINDOWS_VERSION_SP_MAJOR', 0); -define ('PHP_WINDOWS_VERSION_SP_MINOR', 0); -define ('PHP_WINDOWS_VERSION_SUITEMASK', 0); -define ('PHP_WINDOWS_NT_DOMAIN_CONTROLLER', 2); -define ('PHP_WINDOWS_NT_SERVER', 3); -define ('PHP_WINDOWS_NT_WORKSTATION', 1); +define('true', (bool)1, true); +define('false', (bool)0, true); +define('null', null, true); +define('ZEND_THREAD_SAFE', false); +define('ZEND_DEBUG_BUILD', false); +define('PHP_WINDOWS_VERSION_BUILD', 0); +define('PHP_WINDOWS_VERSION_MAJOR', 0); +define('PHP_WINDOWS_VERSION_MINOR', 0); +define('PHP_WINDOWS_VERSION_PLATFORM', 0); +define('PHP_WINDOWS_VERSION_PRODUCTTYPE', 0); +define('PHP_WINDOWS_VERSION_SP_MAJOR', 0); +define('PHP_WINDOWS_VERSION_SP_MINOR', 0); +define('PHP_WINDOWS_VERSION_SUITEMASK', 0); +define('PHP_WINDOWS_NT_DOMAIN_CONTROLLER', 2); +define('PHP_WINDOWS_NT_SERVER', 3); +define('PHP_WINDOWS_NT_WORKSTATION', 1); /** * @since 7.4 */ -define ('PHP_WINDOWS_EVENT_CTRL_C', 0); +define('PHP_WINDOWS_EVENT_CTRL_C', 0); /** * @since 7.4 */ -define ('PHP_WINDOWS_EVENT_CTRL_BREAK', 1); -define ('PHP_VERSION', "5.3.6-13ubuntu3.2"); -define ('PHP_MAJOR_VERSION', 5); -define ('PHP_MINOR_VERSION', 3); -define ('PHP_RELEASE_VERSION', 6); -define ('PHP_EXTRA_VERSION', "-13ubuntu3.2"); -define ('PHP_VERSION_ID', 50306); -define ('PHP_ZTS', 0); -define ('PHP_DEBUG', 0); -define ('PHP_OS', "Linux"); +define('PHP_WINDOWS_EVENT_CTRL_BREAK', 1); +define('PHP_VERSION', "5.3.6-13ubuntu3.2"); +define('PHP_MAJOR_VERSION', 5); +define('PHP_MINOR_VERSION', 3); +define('PHP_RELEASE_VERSION', 6); +define('PHP_EXTRA_VERSION', "-13ubuntu3.2"); +define('PHP_VERSION_ID', 50306); +define('PHP_ZTS', 0); +define('PHP_DEBUG', 0); +define('PHP_OS', "Linux"); /** * The operating system family PHP was built for. Either of 'Windows', 'BSD', 'Darwin', 'Solaris', 'Linux' or 'Unknown'. Available as of PHP 7.2.0. * @since 7.2 */ -define ('PHP_OS_FAMILY', "Linux"); -define ('PHP_SAPI', "cli"); +define('PHP_OS_FAMILY', "Linux"); +define('PHP_SAPI', "cli"); /** * @since 7.4 */ -define ('PHP_CLI_PROCESS_TITLE', 1); -define ('DEFAULT_INCLUDE_PATH', ".:/usr/share/php:/usr/share/pear"); -define ('PEAR_INSTALL_DIR', "/usr/share/php"); -define ('PEAR_EXTENSION_DIR', "/usr/lib/php5/20090626"); -define ('PHP_EXTENSION_DIR', "/usr/lib/php5/20090626"); +define('PHP_CLI_PROCESS_TITLE', 1); +define('DEFAULT_INCLUDE_PATH', ".:/usr/share/php:/usr/share/pear"); +define('PEAR_INSTALL_DIR', "/usr/share/php"); +define('PEAR_EXTENSION_DIR', "/usr/lib/php5/20090626"); +define('PHP_EXTENSION_DIR', "/usr/lib/php5/20090626"); /** * Specifies where the binaries were installed into. * @link https://php.net/manual/en/reserved.constants.php */ -define ('PHP_BINARY', '/usr/local/php/bin/php'); -define ('PHP_PREFIX', "/usr"); -define ('PHP_BINDIR', "/usr/bin"); -define ('PHP_LIBDIR', "/usr/lib/php5"); -define ('PHP_DATADIR', "/usr/share"); -define ('PHP_SYSCONFDIR', "/etc"); -define ('PHP_LOCALSTATEDIR', "/var"); -define ('PHP_CONFIG_FILE_PATH', "/etc/php5/cli"); -define ('PHP_CONFIG_FILE_SCAN_DIR', "/etc/php5/cli/conf.d"); -define ('PHP_SHLIB_SUFFIX', "so"); -define ('PHP_EOL', "\n"); -define ('SUHOSIN_PATCH', 1); -define ('SUHOSIN_PATCH_VERSION', "0.9.10"); -define ('PHP_MAXPATHLEN', 4096); -define ('PHP_INT_MAX', 9223372036854775807); -define ('PHP_INT_MIN', -9223372036854775808); -define ('PHP_INT_SIZE', 8); +define('PHP_BINARY', '/usr/local/php/bin/php'); +define('PHP_PREFIX', "/usr"); +define('PHP_BINDIR', "/usr/bin"); +define('PHP_LIBDIR', "/usr/lib/php5"); +define('PHP_DATADIR', "/usr/share"); +define('PHP_SYSCONFDIR', "/etc"); +define('PHP_LOCALSTATEDIR', "/var"); +define('PHP_CONFIG_FILE_PATH', "/etc/php5/cli"); +define('PHP_CONFIG_FILE_SCAN_DIR', "/etc/php5/cli/conf.d"); +define('PHP_SHLIB_SUFFIX', "so"); +define('PHP_EOL', "\n"); +define('SUHOSIN_PATCH', 1); +define('SUHOSIN_PATCH_VERSION', "0.9.10"); +define('PHP_MAXPATHLEN', 4096); +define('PHP_INT_MAX', 9223372036854775807); +define('PHP_INT_MIN', -9223372036854775808); +define('PHP_INT_SIZE', 8); /** * Number of decimal digits that can be rounded into a float and back without precision loss. Available as of PHP 7.2.0. * @since 7.2 @@ -231,18 +230,18 @@ * @since 7.2 */ define('PHP_FLOAT_MIN', 2.2250738585072e-308); -define ('ZEND_MULTIBYTE', 0); -define ('PHP_OUTPUT_HANDLER_START', 1); -define ('PHP_OUTPUT_HANDLER_CONT', 2); -define ('PHP_OUTPUT_HANDLER_END', 4); -define ('UPLOAD_ERR_OK', 0); -define ('UPLOAD_ERR_INI_SIZE', 1); -define ('UPLOAD_ERR_FORM_SIZE', 2); -define ('UPLOAD_ERR_PARTIAL', 3); -define ('UPLOAD_ERR_NO_FILE', 4); -define ('UPLOAD_ERR_NO_TMP_DIR', 6); -define ('UPLOAD_ERR_CANT_WRITE', 7); -define ('UPLOAD_ERR_EXTENSION', 8); +define('ZEND_MULTIBYTE', 0); +define('PHP_OUTPUT_HANDLER_START', 1); +define('PHP_OUTPUT_HANDLER_CONT', 2); +define('PHP_OUTPUT_HANDLER_END', 4); +define('UPLOAD_ERR_OK', 0); +define('UPLOAD_ERR_INI_SIZE', 1); +define('UPLOAD_ERR_FORM_SIZE', 2); +define('UPLOAD_ERR_PARTIAL', 3); +define('UPLOAD_ERR_NO_FILE', 4); +define('UPLOAD_ERR_NO_TMP_DIR', 6); +define('UPLOAD_ERR_CANT_WRITE', 7); +define('UPLOAD_ERR_EXTENSION', 8); define('STDIN', fopen('php://stdin', 'r')); define('STDOUT', fopen('php://stdout', 'w')); define('STDERR', fopen('php://stderr', 'w')); diff --git a/Ev/Ev.php b/Ev/Ev.php index 75b14b311..e2a740bb6 100644 --- a/Ev/Ev.php +++ b/Ev/Ev.php @@ -11,14 +11,14 @@ final class Ev /** * Flag passed to create a loop: The default flags value */ - const FLAG_AUTO = 0; + public const FLAG_AUTO = 0; /** * Flag passed to create a loop: If this flag used(or the program runs setuid or setgid), libev won't look at the * environment variable LIBEV_FLAGS. Otherwise(by default), LIBEV_FLAGS will override the flags completely if it is * found. Useful for performance tests and searching for bugs. */ - const FLAG_NOENV = 16777216; + public const FLAG_NOENV = 16777216; /** * Flag passed to create a loop: Makes libev check for a fork in each iteration, instead of calling EvLoop::fork() @@ -26,14 +26,14 @@ final class Ev * loop with lots of loop iterations, but usually is not noticeable. This flag setting cannot be overridden or * specified in the LIBEV_FLAGS environment variable. */ - const FLAG_FORKCHECK = 33554432; + public const FLAG_FORKCHECK = 33554432; /** * Flag passed to create a loop: When this flag is specified, libev won't attempt to use the inotify API for its * ev_stat watchers. The flag can be useful to conserve inotify file descriptors, as otherwise each loop using * ev_stat watchers consumes one inotify handle. */ - const FLAG_NOINOTIFY = 1048576; + public const FLAG_NOINOTIFY = 1048576; /** * Flag passed to create a loop: When this flag is specified, libev will attempt to use the signalfd API for its @@ -41,7 +41,7 @@ final class Ev * make it possible to get the queued signal data. It can also simplify signal handling with threads, as long as * signals are properly blocked in threads. Signalfd will not be used by default. */ - const FLAG_SIGNALFD = 2097152; + public const FLAG_SIGNALFD = 2097152; /** * Flag passed to create a loop: When this flag is specified, libev will avoid to modify the signal mask. @@ -49,8 +49,7 @@ final class Ev * * This behaviour is useful for custom signal handling, or handling signals only in specific threads. */ - const FLAG_NOSIGMASK = 4194304; - + public const FLAG_NOSIGMASK = 4194304; /** * Flag passed to Ev::run() or EvLoop::run(): Means that event loop will look for new events, will handle those @@ -58,7 +57,7 @@ final class Ev * will return after one iteration of the loop. This is sometimes useful to poll and handle new events while doing * lengthy calculations, to keep the program responsive. */ - const RUN_NOWAIT = 1; + public const RUN_NOWAIT = 1; /** * Flag passed to Ev::run() or EvLoop::run(): Means that event loop will look for new events (waiting if necessary) @@ -66,151 +65,147 @@ final class Ev * arrives (which could be an event internal to libev itself, so there is no guarantee that a user-registered * callback will be called), and will return after one iteration of the loop. */ - const RUN_ONCE = 2; + public const RUN_ONCE = 2; /** * Flag passed to Ev::stop() or EvLoop::stop(): Cancel the break operation. */ - const BREAK_CANCEL = 0; + public const BREAK_CANCEL = 0; /** * Flag passed to Ev::stop() or EvLoop::stop(): Makes the innermost Ev::run() or EvLoop::run() call return. */ - const BREAK_ONE = 1; + public const BREAK_ONE = 1; /** * Flag passed to Ev::stop() or EvLoop::stop(): Makes all nested Ev::run() or EvLoop::run() calls return. */ - const BREAK_ALL = 2; - + public const BREAK_ALL = 2; /** * Lowest allowed watcher priority. */ - const MINPRI = -2; + public const MINPRI = -2; /** * Highest allowed watcher priority. */ - const MAXPRI = 2; - + public const MAXPRI = 2; /** * Event bitmask: The file descriptor in the EvIo watcher has become readable. */ - const READ = 1; + public const READ = 1; /** * Event bitmask: The file descriptor in the EvIo watcher has become writable. */ - const WRITE = 2; + public const WRITE = 2; /** * Event bitmask: EvTimer watcher has been timed out. */ - const TIMER = 256; + public const TIMER = 256; /** * Event bitmask: EvPeriodic watcher has been timed out. */ - const PERIODIC = 512; + public const PERIODIC = 512; /** * Event bitmask: A signal specified in EvSignal::__construct() has been received. */ - const SIGNAL = 1024; + public const SIGNAL = 1024; /** * Event bitmask: The pid specified in EvChild::__construct() has received a status change. */ - const CHILD = 2048; + public const CHILD = 2048; /** * Event bitmask: The path specified in EvStat watcher changed its attributes. */ - const STAT = 4096; + public const STAT = 4096; /** * Event bitmask: EvIdle watcher works when there is nothing to do with other watchers. */ - const IDLE = 8192; + public const IDLE = 8192; /** * Event bitmask: All EvPrepare watchers are invoked just before Ev::run() starts. Thus, EvPrepare watchers are the * last watchers invoked before the event loop sleeps or polls for new events. */ - const PREPARE = 16384; + public const PREPARE = 16384; /** * Event bitmask: All EvCheck watchers are queued just after Ev::run() has gathered the new events, but before it * queues any callbacks for any received events. Thus, EvCheck watchers will be invoked before any other watchers * of the same or lower priority within an event loop iteration. */ - const CHECK = 32768; + public const CHECK = 32768; /** * Event bitmask: The embedded event loop specified in the EvEmbed watcher needs attention. */ - const EMBED = 65536; + public const EMBED = 65536; /** * Event bitmask: Not ever sent(or otherwise used) by libev itself, but can be freely used by libev users to signal * watchers (e.g. via EvWatcher::feed() ). */ - const CUSTOM = 16777216; + public const CUSTOM = 16777216; /** * Event bitmask: An unspecified error has occurred, the watcher has been stopped. This might happen because the * watcher could not be properly started because libev ran out of memory, a file descriptor was found to be closed * or any other problem. Libev considers these application bugs. */ - const ERROR = 2147483648; - + public const ERROR = 2147483648; /** * select(2) backend */ - const BACKEND_SELECT = 1; + public const BACKEND_SELECT = 1; /** * poll(2) backend */ - const BACKEND_POLL = 2; + public const BACKEND_POLL = 2; /** * Linux-specific epoll(7) backend for both pre- and post-2.6.9 kernels */ - const BACKEND_EPOLL = 4; + public const BACKEND_EPOLL = 4; /** * kqueue backend used on most BSD systems. EvEmbed watcher could be used to embed one loop(with kqueue backend) * into another. For instance, one can try to create an event loop with kqueue backend and use it for sockets only. */ - const BACKEND_KQUEUE = 8; + public const BACKEND_KQUEUE = 8; /** * Solaris 8 backend. This is not implemented yet. */ - const BACKEND_DEVPOLL = 16; + public const BACKEND_DEVPOLL = 16; /** * Solaris 10 event port mechanism with a good scaling. */ - const BACKEND_PORT = 32; + public const BACKEND_PORT = 32; /** * Try all backends(even currupted ones). It's not recommended to use it explicitly. Bitwise operators should be * applied here(e.g. Ev::BACKEND_ALL & ~ Ev::BACKEND_KQUEUE ) Use Ev::recommendedBackends() , or don't specify any * backends at all. */ - const BACKEND_ALL = 63; + public const BACKEND_ALL = 63; /** * Not a backend, but a mask to select all backend bits from flags value to mask out any backends(e.g. when * modifying the LIBEV_FLAGS environment variable). */ - const BACKEND_MASK = 65535; - + public const BACKEND_MASK = 65535; /* Methods */ @@ -410,7 +405,7 @@ abstract class EvWatcher /** * Abstract constructor of a watcher object */ - abstract function __construct(); + abstract public function __construct(); /** * @var mixed Custom user data associated with the watcher @@ -490,18 +485,14 @@ public function setCallback(callable $callback) {} * * Marks the watcher as active. Note that only active watchers will receive events. */ - public function start() - { - } + public function start() {} /** * Stops the watcher. * * Marks the watcher as inactive. Note that only active watchers will receive events. */ - public function stop() - { - } + public function stop() {} } /** @@ -794,7 +785,6 @@ final class EvPeriodic extends EvWatcher */ public $interval; - /** * Constructs EvPeriodic watcher object. * @@ -864,7 +854,7 @@ final public static function createStopped( * @param float $interval The same meaning as for {@see EvPeriodic::__construct} * @return void */ - public function set($offset , $interval ){} + public function set($offset, $interval) {} } /** @@ -1209,8 +1199,6 @@ final public static function createStopped(callable $callback, $data = null, $pr * EvLoop::fork()). The invocation is done before the event loop blocks next and before EvCheck watchers are being * called, and only in the child after the fork. Note that if someone calls EvLoop::fork() in the wrong process, the * fork handlers will be invoked, too. - * - * */ final class EvFork extends EvWatcher { @@ -1322,7 +1310,7 @@ public function backend() {} * @param int $priority * @return EvCheck */ - public final function check(callable $callback, $data = null, $priority = 0) {} + final public function check(callable $callback, $data = null, $priority = 0) {} /** * Creates EvChild object associated with the current event loop instance; @@ -1334,7 +1322,7 @@ public final function check(callable $callback, $data = null, $priority = 0) {} * @param int $priority * @return EvChild */ - public final function child($pid, $trace, callable $callback, $data = null, $priority = 0) {} + final public function child($pid, $trace, callable $callback, $data = null, $priority = 0) {} /** * Creates EvEmbed object associated with the current event loop instance. @@ -1345,7 +1333,7 @@ public final function child($pid, $trace, callable $callback, $data = null, $pri * @param int $priority * @return EvEmbed */ - public final function embed(EvLoop $other, callable $callback, $data = null, $priority = 0) {} + final public function embed(EvLoop $other, callable $callback, $data = null, $priority = 0) {} /** * Creates EvFork object associated with the current event loop instance. @@ -1355,7 +1343,7 @@ public final function embed(EvLoop $other, callable $callback, $data = null, $pr * @param int $priority * @return EvFork */ - public final function fork(callable $callback, $data = null, $priority = 0) {} + final public function fork(callable $callback, $data = null, $priority = 0) {} /** * Creates EvIdle object associated with the current event loop instance. @@ -1365,7 +1353,7 @@ public final function fork(callable $callback, $data = null, $priority = 0) {} * @param int $priority * @return EvIdle */ - public final function idle(callable $callback, $data = null, $priority = 0) {} + final public function idle(callable $callback, $data = null, $priority = 0) {} /** * Invoke all pending watchers while resetting their pending state. @@ -1425,7 +1413,7 @@ public function nowUpdate() {} * @param mixed $data * @param int $priority */ - public final function periodic($offset, $interval, callable $callback, $data = null, $priority = 0) {} + final public function periodic($offset, $interval, callable $callback, $data = null, $priority = 0) {} /** * Creates EvPrepare object associated with the current event loop instance. @@ -1434,7 +1422,7 @@ public final function periodic($offset, $interval, callable $callback, $data = n * @param mixed $data * @param int $priority */ - public final function prepare(callable $callback, $data = null, $priority = 0) {} + final public function prepare(callable $callback, $data = null, $priority = 0) {} /** * Resume previously suspended default event loop. @@ -1464,9 +1452,7 @@ public function run($flags = Ev::FLAG_AUTO) {} * @param int $priority * @return EvSignal */ - public final function signal($signal, callable $callback, $data = null, $priority = 0) - { - } + final public function signal($signal, callable $callback, $data = null, $priority = 0) {} /** * Creates EvStats object associated with the current event loop instance. @@ -1478,7 +1464,7 @@ public final function signal($signal, callable $callback, $data = null, $priorit * @param int $priority * @return EvStat */ - public final function stat($path, $interval, callable $callback, $data = null, $priority = 0) {} + final public function stat($path, $interval, callable $callback, $data = null, $priority = 0) {} /** * Stops the event loop. @@ -1504,7 +1490,7 @@ public function suspend() {} * @param int $priority * @return EvTimer */ - public final function timer($after, $repeat, callable $callback, $data = null, $priority = 0) {} + final public function timer($after, $repeat, callable $callback, $data = null, $priority = 0) {} /** * Performs internal consistency checks (for debugging). diff --git a/FFI/FFI.php b/FFI/FFI.php index aff33df04..c95c142aa 100644 --- a/FFI/FFI.php +++ b/FFI/FFI.php @@ -3,6 +3,7 @@ // Start of FFI v.0.1.0 namespace { + use FFI\CData; use FFI\CType; use FFI\ParserException; @@ -249,18 +250,14 @@ public static function isNull(CData $ptr): bool {} * * @since 7.4 */ - class Exception extends \Error - { - } + class Exception extends \Error {} /** * Class ParserException * * @since 7.4 */ - class ParserException extends Exception - { - } + class ParserException extends Exception {} /** * Class CData @@ -269,9 +266,7 @@ class ParserException extends Exception * * @since 7.4 */ - class CData - { - } + class CData {} /** * Class CType @@ -280,7 +275,5 @@ class CData * * @since 7.4 */ - class CType - { - } + class CType {} } diff --git a/LuaSandbox/LuaSandbox.php b/LuaSandbox/LuaSandbox.php index a4869b5fd..8e211b6a7 100644 --- a/LuaSandbox/LuaSandbox.php +++ b/LuaSandbox/LuaSandbox.php @@ -17,24 +17,25 @@ * @link https://www.php.net/manual/en/class.luasandbox.php * @since luasandbox >= 1.0.0 */ -class LuaSandbox { +class LuaSandbox +{ /** * Used withLuaSandbox::getProfilerFunctionReport()
* to return timings in samples.
*/
- const SAMPLES = 0;
+ public const SAMPLES = 0;
/**
* Used with LuaSandbox::getProfilerFunctionReport()
* to return timings in seconds.
*/
- const SECONDS = 1;
+ public const SECONDS = 1;
/**
* Used with LuaSandbox::getProfilerFunctionReport()
* to return timings in percentages of the total.
*/
- const PERCENT = 2;
+ public const PERCENT = 2;
/**
* Call a function in a Lua global variable.
@@ -56,7 +57,7 @@ class LuaSandbox {
* @see LuaSandboxFunction::call()
* @since luasandbox >= 1.0.0
*/
- public function callFunction ($name, array $arguments) {}
+ public function callFunction($name, array $arguments) {}
/**
* Disable the profiler.
@@ -66,7 +67,7 @@ public function callFunction ($name, array $arguments) {}
* @see LuaSandbox::enableProfiler()
* @see LuaSandbox::getProfilerFunctionReport()
*/
- public function disableProfiler () {}
+ public function disableProfiler() {}
/**
* Enable the profiler.
@@ -83,7 +84,7 @@ public function disableProfiler () {}
* @see LuaSandbox::disableProfiler()
* @see LuaSandbox::getProfilerFunctionReport()
*/
- public function enableProfiler ($period = 0.02) {}
+ public function enableProfiler($period = 0.02) {}
/**
* Fetch the current CPU time usage of the Lua environment.
@@ -102,7 +103,7 @@ public function enableProfiler ($period = 0.02) {}
* @see LuaSandbox::getPeakMemoryUsage()
* @see LuaSandbox::setCPULimit()
*/
- public function getCPUUsage () {}
+ public function getCPUUsage() {}
/**
* Fetch the current memory usage of the Lua environment.
@@ -114,7 +115,7 @@ public function getCPUUsage () {}
* @see LuaSandbox::getCPUUsage()
* @see LuaSandbox::setMemoryLimit()
*/
- public function getMemoryUsage () {}
+ public function getMemoryUsage() {}
/**
* Fetch the peak memory usage of the Lua environment.
@@ -126,7 +127,7 @@ public function getMemoryUsage () {}
* @see LuaSandbox::getCPUUsage()
* @see LuaSandbox::setMemoryLimit()
*/
- public function getPeakMemoryUsage () {}
+ public function getPeakMemoryUsage() {}
/**
* Fetch profiler data.
@@ -154,7 +155,7 @@ public function getPeakMemoryUsage () {}
* @see LuaSandbox::SECONDS
* @see LuaSandbox::PERCENT
*/
- public function getProfilerFunctionReport ($units = LuaSandbox::SECONDS) {}
+ public function getProfilerFunctionReport($units = LuaSandbox::SECONDS) {}
/**
* Return the versions of LuaSandbox and Lua.
@@ -165,7 +166,7 @@ public function getProfilerFunctionReport ($units = LuaSandbox::SECONDS) {}
* LuaSandbox::pauseUsageTimer().
@@ -285,7 +286,7 @@ public function setMemoryLimit ($limit) {}
* @see LuaSandbox::setCPULimit()
* @see LuaSandbox::unpauseUsageTimer()
*/
- public function unpauseUsageTimer () {}
+ public function unpauseUsageTimer() {}
/**
* Wrap a PHP callable in a LuaSandboxFunction.
@@ -309,7 +310,7 @@ public function unpauseUsageTimer () {}
* @see LuaSandbox::loadString()
* @see LuaSandbox::registerLibrary()
*/
- public function wrapPhpFunction ($function) {}
+ public function wrapPhpFunction($function) {}
}
/**
@@ -322,7 +323,8 @@ public function wrapPhpFunction ($function) {}
*
* @since luasandbox >= 1.0.0
*/
-class LuaSandboxFunction {
+class LuaSandboxFunction
+{
/**
* Call a Lua function.
*
@@ -369,7 +371,7 @@ class LuaSandboxFunction {
* which may be empty, or false on error.
* @since luasandbox >= 1.0.0
*/
- public function call ($arguments) {}
+ public function call($arguments) {}
/**
* Dump the function as a binary blob.
@@ -378,7 +380,7 @@ public function call ($arguments) {}
* @return string Returns a string that may be passed to LuaSandbox::loadBinary().
- * using PDO::ATTR_DRIVER_NAME
- *
- * if ($db->getAttribute(PDO::ATTR_DRIVER_NAME) == 'mysql') {
- * echo "Running on mysql; doing something mysql specific here\n";
- * }
- *
- *
- * Forcing queries to be buffered in mysql
- *
- * if ($db->getAttribute(PDO::ATTR_DRIVER_NAME) == 'mysql') {
- * $stmt = $db->prepare('select * from foo',
- * array(PDO::MYSQL_ATTR_USE_BUFFERED_QUERY => true));
- * } else {
- * die("my application only works with mysql; I should use \$stmt->fetchAll() instead");
- * }
- *
- *
- * Enable LOAD LOCAL INFILE. - *
- *- * Note, this constant can only be used in the driver_options - * array when constructing a new database handle. - *
- * @link https://php.net/manual/en/ref.pdo-mysql.php#pdo.constants.mysql-attr-local-infile - */ - 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. - *
- * @link https://php.net/manual/en/ref.pdo-mysql.php#pdo.constants.mysql-attr-init-command - */ - const MYSQL_ATTR_INIT_COMMAND = 1002; - - /** - *- * Maximum buffer size. Defaults to 1 MiB. This constant is not supported when - * compiled against mysqlnd. - *
- * @link https://php.net/manual/en/ref.pdo-mysql.php#pdo.constants.mysql-attr-max-buffer-size - */ - const MYSQL_ATTR_MAX_BUFFER_SIZE = 1005; - - /** - *- * Read options from the named option file instead of from - * my.cnf. This option is not available if - * mysqlnd is used, because mysqlnd does not read the mysql - * configuration files. - *
- * @link https://php.net/manual/en/ref.pdo-mysql.php#pdo.constants.mysql-attr-read-default-file - */ - const MYSQL_ATTR_READ_DEFAULT_FILE = 1003; - - /** - *- * Read options from the named group from my.cnf or the - * file specified with MYSQL_READ_DEFAULT_FILE. This option - * is not available if mysqlnd is used, because mysqlnd does not read the mysql - * configuration files. - *
- * @link https://php.net/manual/en/ref.pdo-mysql.php#pdo.constants.mysql-attr-read-default-group - */ - const MYSQL_ATTR_READ_DEFAULT_GROUP = 1004; - - /** - *- * Enable network communication compression. This is not supported when - * compiled against mysqlnd. - *
- * @link https://php.net/manual/en/ref.pdo-mysql.php#pdo.constants.mysql-attr-compress - */ - const MYSQL_ATTR_COMPRESS = 1003; - - /** - *- * Perform direct queries, don't use prepared statements. - *
- * @link https://php.net/manual/en/ref.pdo-mysql.php#pdo.constants.mysql-attr-direct-query - */ - const MYSQL_ATTR_DIRECT_QUERY = 1004; - - /** - *- * Return the number of found (matched) rows, not the - * number of changed rows. - *
- * @link https://php.net/manual/en/ref.pdo-mysql.php#pdo.constants.mysql-attr-found-rows - */ - const MYSQL_ATTR_FOUND_ROWS = 1005; - - /** - *- * Permit spaces after function names. Makes all functions - * names reserved words. - *
- * @link https://php.net/manual/en/ref.pdo-mysql.php#pdo.constants.mysql-attr-ignore-space - */ - const MYSQL_ATTR_IGNORE_SPACE = 1006; - - const MYSQL_ATTR_SERVER_PUBLIC_KEY = 1012; - - /** - *- * The file path to the SSL key. - *
- * @since 5.3.7 - * @link https://php.net/manual/en/ref.pdo-mysql.php#pdo.constants.mysql-attr-ssl-key - */ - const MYSQL_ATTR_SSL_KEY = 1007; - - /** - *- * The file path to the SSL certificate. - *
- * @since 5.3.7 - * @link https://php.net/manual/en/ref.pdo-mysql.php#pdo.constants.mysql-attr-ssl-cert - */ - const MYSQL_ATTR_SSL_CERT = 1008; - - /** - *- * The file path to the SSL certificate authority. - *
- * @since 5.3.7 - * @link https://php.net/manual/en/ref.pdo-mysql.php#pdo.constants.mysql-attr-ssl-ca - */ - 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. - *
- * @since 5.3.7 - * @link https://php.net/manual/en/ref.pdo-mysql.php#pdo.constants.mysql-attr-ssl-capath - */ - 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 - *
- * @since 5.3.7 - * @link https://php.net/manual/en/ref.pdo-mysql.php#pdo.constants.mysql-attr-cipher - */ - const MYSQL_ATTR_SSL_CIPHER = 1011; - - /** - *- * Disables multi query execution in both {@see PDO::prepare()} and {@see PDO::query()} when set to FALSE. - *
- *- * Note, this constant can only be used in the driver_options array when constructing a new database handle. - *
- * @since 5.5.21 - * @link https://php.net/manual/en/ref.pdo-mysql.php#pdo.constants.mysql-attr-multi-statements - */ - const MYSQL_ATTR_MULTI_STATEMENTS = 1013; - - /** - *- * Disables SSL peer verification when set to FALSE. - *
- * @since 7.0.18 - * @since 7.1.4 - * @link https://bugs.php.net/bug.php?id=71003 - */ - const MYSQL_ATTR_SSL_VERIFY_SERVER_CERT = 1014; - - #[Deprecated("Use PDO::ATTR_EMULATE_PREPARES instead")] - const PGSQL_ASSOC = 1; - const PGSQL_ATTR_DISABLE_NATIVE_PREPARED_STATEMENT = 1000; - - /** - * @since 5.6 - */ - const PGSQL_ATTR_DISABLE_PREPARES = 1000; - const PGSQL_BAD_RESPONSE = 5; - const PGSQL_BOTH = 3; - 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; - - const PGSQL_CONNECT_ASYNC = 4; - const PGSQL_CONNECT_FORCE_NEW = 2; - const PGSQL_CONNECTION_AUTH_OK = 5; - const PGSQL_CONNECTION_AWAITING_RESPONSE = 4; - const PGSQL_CONNECTION_BAD = 1; - const PGSQL_CONNECTION_OK = 0; - const PGSQL_CONNECTION_MADE = 3; - const PGSQL_CONNECTION_SETENV = 6; - const PGSQL_CONNECTION_SSL_STARTUP = 7; - const PGSQL_CONNECTION_STARTED = 2; - const PGSQL_COMMAND_OK = 1; - const PGSQL_CONV_FORCE_NULL = 4; - const PGSQL_CONV_IGNORE_DEFAULT = 2; - const PGSQL_CONV_IGNORE_NOT_NULL = 8; - const PGSQL_COPY_IN = 4; - const PGSQL_COPY_OUT = 3; - const PGSQL_DIAG_CONTEXT = 87; - const PGSQL_DIAG_INTERNAL_POSITION = 112; - const PGSQL_DIAG_INTERNAL_QUERY = 113; - const PGSQL_DIAG_MESSAGE_DETAIL = 68; - const PGSQL_DIAG_MESSAGE_HINT = 72; - const PGSQL_DIAG_MESSAGE_PRIMARY = 77; - const PGSQL_DIAG_SEVERITY = 83; - const PGSQL_DIAG_SOURCE_FILE = 70; - const PGSQL_DIAG_SOURCE_FUNCTION = 82; - const PGSQL_DIAG_SOURCE_LINE = 76; - const PGSQL_DIAG_SQLSTATE = 67; - const PGSQL_DIAG_STATEMENT_POSITION = 80; - const PGSQL_DML_ASYNC = 1024; - const PGSQL_DML_EXEC = 512; - const PGSQL_DML_NO_CONV = 256; - const PGSQL_DML_STRING = 2048; - const PGSQL_DML_ESCAPE = 4096; - const PGSQL_EMPTY_QUERY = 0; - const PGSQL_ERRORS_DEFAULT = 1; - const PGSQL_ERRORS_TERSE = 0; - const PGSQL_ERRORS_VERBOSE = 2; - const PGSQL_FATAL_ERROR = 7; - const PGSQL_NONFATAL_ERROR = 6; - const PGSQL_NOTICE_ALL = 2; - const PGSQL_NOTICE_CLEAR = 3; - const PGSQL_NOTICE_LAST = 1; - const PGSQL_NUM = 2; - const PGSQL_POLLING_ACTIVE = 4; - const PGSQL_POLLING_FAILED = 0; - const PGSQL_POLLING_OK = 3; - const PGSQL_POLLING_READING = 1; - const PGSQL_POLLING_WRITING = 2; - const PGSQL_SEEK_CUR = 1; - const PGSQL_SEEK_END = 2; - const PGSQL_SEEK_SET = 0; - const PGSQL_STATUS_LONG = 1; - const PGSQL_STATUS_STRING = 2; - const PGSQL_TUPLES_OK = 2; - const SQLSRV_TXN_READ_UNCOMMITTED = "READ_UNCOMMITTED"; - const SQLSRV_TXN_READ_COMMITTED = "READ_COMMITTED"; - const SQLSRV_TXN_REPEATABLE_READ = "REPEATABLE_READ"; - const SQLSRV_TXN_SNAPSHOT = "SNAPSHOT"; - const SQLSRV_TXN_SERIALIZABLE = "SERIALIZABLE"; - const SQLSRV_ENCODING_BINARY = 2; - const SQLSRV_ENCODING_SYSTEM = 3; - const SQLSRV_ENCODING_UTF8 = 65001; - const SQLSRV_ENCODING_DEFAULT = 1; - const SQLSRV_ATTR_ENCODING = 1000; - const SQLSRV_ATTR_QUERY_TIMEOUT = 1001; - const SQLSRV_ATTR_DIRECT_QUERY = 1002; - const SQLSRV_ATTR_CURSOR_SCROLL_TYPE = 1003; - const SQLSRV_ATTR_CLIENT_BUFFER_MAX_KB_SIZE = 1004; - const SQLSRV_ATTR_FETCHES_NUMERIC_TYPE = 1005; - const SQLSRV_PARAM_OUT_DEFAULT_SIZE = -1; - const SQLSRV_CURSOR_KEYSET = 1; - const SQLSRV_CURSOR_DYNAMIC = 2; - const SQLSRV_CURSOR_STATIC = 3; - const SQLSRV_CURSOR_BUFFERED = 42; - - /** - * @since 7.4 - */ - const SQLITE_ATTR_READONLY_STATEMENT = 1001; - /** - * @since 7.4 - */ - const SQLITE_ATTR_EXTENDED_RESULT_CODES = 1002; - - /** - * Provides a way to specify the action on the database session. - * @since 7.2.16 - * @since 7.3.3 - */ - const OCI_ATTR_ACTION = 1000; - - /** - * Provides a way to specify the client info on the database session. - * @since 7.2.16 - * @since 7.3.3 - */ - const OCI_ATTR_CLIENT_INFO = 1001; - - /** - * Provides a way to specify the client identifier on the database session. - * @since 7.2.16 - * @since 7.3.3 - */ - const OCI_ATTR_CLIENT_IDENTIFIER = 1002; - - /** - * Provides a way to specify the module on the database session. - * @since 7.2.16 - * @since 7.3.3 - */ - const OCI_ATTR_MODULE = 1003; - - /** - * The number of milliseconds to wait for individual round trips to the database to complete before timing out. - * @since 8.0 - */ - const OCI_ATTR_CALL_TIMEOUT = 1004; - - /** - * (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0)- * This must be a valid SQL statement for the target database server. - *
- * @param array $options [optional]- * This array holds one or more key=>value pairs to set - * attribute values for the PDOStatement object that this method - * returns. You would most commonly use this to set the - * PDO::ATTR_CURSOR value to - * PDO::CURSOR_SCROLL to request a scrollable cursor. - * Some drivers have driver specific options that may be set at - * prepare-time. - *
- * @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.
- */
- public function prepare ($query, array $options = array()) {}
-
- /**
- * (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0)
- * Initiates a transaction
- *
- * Turns off autocommit mode. While autocommit mode is turned off, - * changes made to the database via the PDO object instance are not committed - * until you end the transaction by calling {@link PDO::commit()}. - * Calling {@link PDO::rollBack()} will roll back all changes to the database and - * return the connection to autocommit mode. - *
- *- * Some databases, including MySQL, automatically issue an implicit COMMIT - * when a database definition language (DDL) statement - * such as DROP TABLE or CREATE TABLE is issued within a transaction. - * The implicit COMMIT will prevent you from rolling back any other changes - * within the transaction boundary. - *
- * @link https://php.net/manual/en/pdo.begintransaction.php - * @return bool TRUE on success or FALSE on failure. - * @throws PDOException If there is already a transaction started or - * the driver does not support transactions- * The SQL statement to prepare and execute. - *
- *- * Data inside the query should be properly escaped. - *
- * @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. - * - * This function may - * return Boolean FALSE, but may also return a non-Boolean value which - * evaluates to FALSE. Please read the section on Booleans for more - * information. Use the === - * operator for testing the return value of this - * function. - *
- * 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:
- *
- * $db->exec() or die(print_r($db->errorInfo(), true));
- *
- */
- public function exec ($statement) {}
-
- /**
- * (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.2.0)
- * Executes an SQL statement, returning a result set as a PDOStatement object
- * @link https://php.net/manual/en/pdo.query.php
- * @param string $statement
- * The SQL statement to prepare and execute. - *
- *- * Data inside the query should be properly escaped. - *
- * @param int $mode- * The fetch mode must be one of the PDO::FETCH_* constants. - *
- * @param mixed $arg3- * The second and following parameters are the same as the parameters for PDOStatement::setFetchMode. - *
- * @param array $ctorargs [optional]- * Arguments of custom class constructor when the mode - * parameter is set to PDO::FETCH_CLASS. - *
- * @return PDOStatement|false PDO::query returns a PDOStatement object, or FALSE - * on failure. - * @see PDOStatement::setFetchMode For a full description of the second and following parameters. - */ - #[PhpStormStubsElementAvailable(to: '7.4')] - public function query ($statement, $mode = PDO::ATTR_DEFAULT_FETCH_MODE, $arg3 = null, array $ctorargs = array()) {} - - /** - * (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.2.0)- * The SQL statement to prepare and execute. - *
- *- * Data inside the query should be properly escaped. - *
- * @param int $mode- * The fetch mode must be one of the PDO::FETCH_* constants. - *
- * @param mixed $fetch_mode_args- * Arguments of custom class constructor when the mode - * parameter is set to PDO::FETCH_CLASS. - *
- * @return PDOStatement|false PDO::query returns a PDOStatement object, or FALSE - * on failure. - * @see PDOStatement::setFetchMode For a full description of the second and following parameters. - */ - #[PhpStormStubsElementAvailable('8.0')] - public function query ($statement, $mode = PDO::ATTR_DEFAULT_FETCH_MODE, ...$fetch_mode_args) {} - - /** - * (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0)- * Name of the sequence object from which the ID should be returned. - *
- * @return string 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.
- */
- public function lastInsertId ($name = null) {}
-
- /**
- * (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0)
- * Fetch the SQLSTATE associated with the last operation on the database handle
- * @link https://php.net/manual/en/pdo.errorcode.php
- * @return mixed 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.
- */
- public function errorCode () {}
-
- /**
- * (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0)
- * Fetch extended error information associated with the last operation on the database handle
- * @link https://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 the following fields:
- *
- * 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.
- */
- #[ArrayShape([
- 0 => "string",
- 1 => "int",
- 2 => "string",
- ])]
- public function errorInfo () {}
-
- /**
- * (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.2.0)
- * Retrieve a database connection attribute
- * @link https://php.net/manual/en/pdo.getattribute.php
- * @param int $attribute
- * One of the PDO::ATTR_* constants. The constants that - * apply to database connections are as follows: - * PDO::ATTR_AUTOCOMMIT - * PDO::ATTR_CASE - * PDO::ATTR_CLIENT_VERSION - * PDO::ATTR_CONNECTION_STATUS - * PDO::ATTR_DRIVER_NAME - * PDO::ATTR_ERRMODE - * PDO::ATTR_ORACLE_NULLS - * PDO::ATTR_PERSISTENT - * PDO::ATTR_PREFETCH - * PDO::ATTR_SERVER_INFO - * PDO::ATTR_SERVER_VERSION - * PDO::ATTR_TIMEOUT - *
- * @return mixed A successful call returns the value of the requested PDO attribute. - * An unsuccessful call returns null. - */ - public function getAttribute ($attribute) {} - - /** - * (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.2.1)- * The string to be quoted. - *
- * @param int $type [optional]- * Provides a data type hint for drivers that have alternate quoting styles. - *
- * @return string|false 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. - */ - public function quote ($string, $type = PDO::PARAM_STR) {} - - final public function __wakeup () {} - - final public function __sleep () {} - - /** - * (PHP 5 >= 5.1.3, PHP 7, PECL pdo >= 1.0.3)
+ * using PDO::ATTR_DRIVER_NAME
+ *
+ * if ($db->getAttribute(PDO::ATTR_DRIVER_NAME) == 'mysql') {
+ * echo "Running on mysql; doing something mysql specific here\n";
+ * }
+ *
+ *
+ * Forcing queries to be buffered in mysql
+ *
+ * if ($db->getAttribute(PDO::ATTR_DRIVER_NAME) == 'mysql') {
+ * $stmt = $db->prepare('select * from foo',
+ * array(PDO::MYSQL_ATTR_USE_BUFFERED_QUERY => true));
+ * } else {
+ * die("my application only works with mysql; I should use \$stmt->fetchAll() instead");
+ * }
+ *
+ *
+ * Enable LOAD LOCAL INFILE. + *
+ *+ * Note, this constant can only be used in the driver_options + * array when constructing a new database handle. + *
+ * @link https://php.net/manual/en/ref.pdo-mysql.php#pdo.constants.mysql-attr-local-infile + */ + public 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. + *
+ * @link https://php.net/manual/en/ref.pdo-mysql.php#pdo.constants.mysql-attr-init-command + */ + public const MYSQL_ATTR_INIT_COMMAND = 1002; + + /** + *+ * Maximum buffer size. Defaults to 1 MiB. This constant is not supported when + * compiled against mysqlnd. + *
+ * @link https://php.net/manual/en/ref.pdo-mysql.php#pdo.constants.mysql-attr-max-buffer-size + */ + public const MYSQL_ATTR_MAX_BUFFER_SIZE = 1005; + + /** + *+ * Read options from the named option file instead of from + * my.cnf. This option is not available if + * mysqlnd is used, because mysqlnd does not read the mysql + * configuration files. + *
+ * @link https://php.net/manual/en/ref.pdo-mysql.php#pdo.constants.mysql-attr-read-default-file + */ + public const MYSQL_ATTR_READ_DEFAULT_FILE = 1003; + + /** + *+ * Read options from the named group from my.cnf or the + * file specified with MYSQL_READ_DEFAULT_FILE. This option + * is not available if mysqlnd is used, because mysqlnd does not read the mysql + * configuration files. + *
+ * @link https://php.net/manual/en/ref.pdo-mysql.php#pdo.constants.mysql-attr-read-default-group + */ + public const MYSQL_ATTR_READ_DEFAULT_GROUP = 1004; + + /** + *+ * Enable network communication compression. This is not supported when + * compiled against mysqlnd. + *
+ * @link https://php.net/manual/en/ref.pdo-mysql.php#pdo.constants.mysql-attr-compress + */ + public const MYSQL_ATTR_COMPRESS = 1003; + + /** + *+ * Perform direct queries, don't use prepared statements. + *
+ * @link https://php.net/manual/en/ref.pdo-mysql.php#pdo.constants.mysql-attr-direct-query + */ + public const MYSQL_ATTR_DIRECT_QUERY = 1004; + + /** + *+ * Return the number of found (matched) rows, not the + * number of changed rows. + *
+ * @link https://php.net/manual/en/ref.pdo-mysql.php#pdo.constants.mysql-attr-found-rows + */ + public const MYSQL_ATTR_FOUND_ROWS = 1005; + + /** + *+ * Permit spaces after function names. Makes all functions + * names reserved words. + *
+ * @link https://php.net/manual/en/ref.pdo-mysql.php#pdo.constants.mysql-attr-ignore-space + */ + public const MYSQL_ATTR_IGNORE_SPACE = 1006; + + public const MYSQL_ATTR_SERVER_PUBLIC_KEY = 1012; + + /** + *+ * The file path to the SSL key. + *
+ * @since 5.3.7 + * @link https://php.net/manual/en/ref.pdo-mysql.php#pdo.constants.mysql-attr-ssl-key + */ + public const MYSQL_ATTR_SSL_KEY = 1007; + + /** + *+ * The file path to the SSL certificate. + *
+ * @since 5.3.7 + * @link https://php.net/manual/en/ref.pdo-mysql.php#pdo.constants.mysql-attr-ssl-cert + */ + public const MYSQL_ATTR_SSL_CERT = 1008; + + /** + *+ * The file path to the SSL certificate authority. + *
+ * @since 5.3.7 + * @link https://php.net/manual/en/ref.pdo-mysql.php#pdo.constants.mysql-attr-ssl-ca + */ + public 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. + *
+ * @since 5.3.7 + * @link https://php.net/manual/en/ref.pdo-mysql.php#pdo.constants.mysql-attr-ssl-capath + */ + public 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 + *
+ * @since 5.3.7 + * @link https://php.net/manual/en/ref.pdo-mysql.php#pdo.constants.mysql-attr-cipher + */ + public const MYSQL_ATTR_SSL_CIPHER = 1011; + + /** + *+ * Disables multi query execution in both {@see PDO::prepare()} and {@see PDO::query()} when set to FALSE. + *
+ *+ * Note, this constant can only be used in the driver_options array when constructing a new database handle. + *
+ * @since 5.5.21 + * @link https://php.net/manual/en/ref.pdo-mysql.php#pdo.constants.mysql-attr-multi-statements + */ + public const MYSQL_ATTR_MULTI_STATEMENTS = 1013; + + /** + *+ * Disables SSL peer verification when set to FALSE. + *
+ * @since 7.0.18 + * @since 7.1.4 + * @link https://bugs.php.net/bug.php?id=71003 + */ + public const MYSQL_ATTR_SSL_VERIFY_SERVER_CERT = 1014; + + #[Deprecated("Use PDO::ATTR_EMULATE_PREPARES instead")] + public const PGSQL_ASSOC = 1; + public const PGSQL_ATTR_DISABLE_NATIVE_PREPARED_STATEMENT = 1000; + + /** + * @since 5.6 + */ + public const PGSQL_ATTR_DISABLE_PREPARES = 1000; + public const PGSQL_BAD_RESPONSE = 5; + public const PGSQL_BOTH = 3; + public const PGSQL_TRANSACTION_IDLE = 0; + public const PGSQL_TRANSACTION_ACTIVE = 1; + public const PGSQL_TRANSACTION_INTRANS = 2; + public const PGSQL_TRANSACTION_INERROR = 3; + public const PGSQL_TRANSACTION_UNKNOWN = 4; + + public const PGSQL_CONNECT_ASYNC = 4; + public const PGSQL_CONNECT_FORCE_NEW = 2; + public const PGSQL_CONNECTION_AUTH_OK = 5; + public const PGSQL_CONNECTION_AWAITING_RESPONSE = 4; + public const PGSQL_CONNECTION_BAD = 1; + public const PGSQL_CONNECTION_OK = 0; + public const PGSQL_CONNECTION_MADE = 3; + public const PGSQL_CONNECTION_SETENV = 6; + public const PGSQL_CONNECTION_SSL_STARTUP = 7; + public const PGSQL_CONNECTION_STARTED = 2; + public const PGSQL_COMMAND_OK = 1; + public const PGSQL_CONV_FORCE_NULL = 4; + public const PGSQL_CONV_IGNORE_DEFAULT = 2; + public const PGSQL_CONV_IGNORE_NOT_NULL = 8; + public const PGSQL_COPY_IN = 4; + public const PGSQL_COPY_OUT = 3; + public const PGSQL_DIAG_CONTEXT = 87; + public const PGSQL_DIAG_INTERNAL_POSITION = 112; + public const PGSQL_DIAG_INTERNAL_QUERY = 113; + public const PGSQL_DIAG_MESSAGE_DETAIL = 68; + public const PGSQL_DIAG_MESSAGE_HINT = 72; + public const PGSQL_DIAG_MESSAGE_PRIMARY = 77; + public const PGSQL_DIAG_SEVERITY = 83; + public const PGSQL_DIAG_SOURCE_FILE = 70; + public const PGSQL_DIAG_SOURCE_FUNCTION = 82; + public const PGSQL_DIAG_SOURCE_LINE = 76; + public const PGSQL_DIAG_SQLSTATE = 67; + public const PGSQL_DIAG_STATEMENT_POSITION = 80; + public const PGSQL_DML_ASYNC = 1024; + public const PGSQL_DML_EXEC = 512; + public const PGSQL_DML_NO_CONV = 256; + public const PGSQL_DML_STRING = 2048; + public const PGSQL_DML_ESCAPE = 4096; + public const PGSQL_EMPTY_QUERY = 0; + public const PGSQL_ERRORS_DEFAULT = 1; + public const PGSQL_ERRORS_TERSE = 0; + public const PGSQL_ERRORS_VERBOSE = 2; + public const PGSQL_FATAL_ERROR = 7; + public const PGSQL_NONFATAL_ERROR = 6; + public const PGSQL_NOTICE_ALL = 2; + public const PGSQL_NOTICE_CLEAR = 3; + public const PGSQL_NOTICE_LAST = 1; + public const PGSQL_NUM = 2; + public const PGSQL_POLLING_ACTIVE = 4; + public const PGSQL_POLLING_FAILED = 0; + public const PGSQL_POLLING_OK = 3; + public const PGSQL_POLLING_READING = 1; + public const PGSQL_POLLING_WRITING = 2; + public const PGSQL_SEEK_CUR = 1; + public const PGSQL_SEEK_END = 2; + public const PGSQL_SEEK_SET = 0; + public const PGSQL_STATUS_LONG = 1; + public const PGSQL_STATUS_STRING = 2; + public const PGSQL_TUPLES_OK = 2; + public const SQLSRV_TXN_READ_UNCOMMITTED = "READ_UNCOMMITTED"; + public const SQLSRV_TXN_READ_COMMITTED = "READ_COMMITTED"; + public const SQLSRV_TXN_REPEATABLE_READ = "REPEATABLE_READ"; + public const SQLSRV_TXN_SNAPSHOT = "SNAPSHOT"; + public const SQLSRV_TXN_SERIALIZABLE = "SERIALIZABLE"; + public const SQLSRV_ENCODING_BINARY = 2; + public const SQLSRV_ENCODING_SYSTEM = 3; + public const SQLSRV_ENCODING_UTF8 = 65001; + public const SQLSRV_ENCODING_DEFAULT = 1; + public const SQLSRV_ATTR_ENCODING = 1000; + public const SQLSRV_ATTR_QUERY_TIMEOUT = 1001; + public const SQLSRV_ATTR_DIRECT_QUERY = 1002; + public const SQLSRV_ATTR_CURSOR_SCROLL_TYPE = 1003; + public const SQLSRV_ATTR_CLIENT_BUFFER_MAX_KB_SIZE = 1004; + public const SQLSRV_ATTR_FETCHES_NUMERIC_TYPE = 1005; + public const SQLSRV_PARAM_OUT_DEFAULT_SIZE = -1; + public const SQLSRV_CURSOR_KEYSET = 1; + public const SQLSRV_CURSOR_DYNAMIC = 2; + public const SQLSRV_CURSOR_STATIC = 3; + public const SQLSRV_CURSOR_BUFFERED = 42; + + /** + * @since 7.4 + */ + public const SQLITE_ATTR_READONLY_STATEMENT = 1001; + /** + * @since 7.4 + */ + public const SQLITE_ATTR_EXTENDED_RESULT_CODES = 1002; + + /** + * Provides a way to specify the action on the database session. + * @since 7.2.16 + * @since 7.3.3 + */ + public const OCI_ATTR_ACTION = 1000; + + /** + * Provides a way to specify the client info on the database session. + * @since 7.2.16 + * @since 7.3.3 + */ + public const OCI_ATTR_CLIENT_INFO = 1001; + + /** + * Provides a way to specify the client identifier on the database session. + * @since 7.2.16 + * @since 7.3.3 + */ + public const OCI_ATTR_CLIENT_IDENTIFIER = 1002; + + /** + * Provides a way to specify the module on the database session. + * @since 7.2.16 + * @since 7.3.3 + */ + public const OCI_ATTR_MODULE = 1003; + + /** + * The number of milliseconds to wait for individual round trips to the database to complete before timing out. + * @since 8.0 + */ + public const OCI_ATTR_CALL_TIMEOUT = 1004; + + /** + * (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0)+ * This must be a valid SQL statement for the target database server. + *
+ * @param array $options [optional]+ * This array holds one or more key=>value pairs to set + * attribute values for the PDOStatement object that this method + * returns. You would most commonly use this to set the + * PDO::ATTR_CURSOR value to + * PDO::CURSOR_SCROLL to request a scrollable cursor. + * Some drivers have driver specific options that may be set at + * prepare-time. + *
+ * @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.
+ */
+ public function prepare($query, array $options = []) {}
+
+ /**
+ * (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0)
+ * Initiates a transaction
+ *
+ * Turns off autocommit mode. While autocommit mode is turned off, + * changes made to the database via the PDO object instance are not committed + * until you end the transaction by calling {@link PDO::commit()}. + * Calling {@link PDO::rollBack()} will roll back all changes to the database and + * return the connection to autocommit mode. + *
+ *+ * Some databases, including MySQL, automatically issue an implicit COMMIT + * when a database definition language (DDL) statement + * such as DROP TABLE or CREATE TABLE is issued within a transaction. + * The implicit COMMIT will prevent you from rolling back any other changes + * within the transaction boundary. + *
+ * @link https://php.net/manual/en/pdo.begintransaction.php + * @return bool TRUE on success or FALSE on failure. + * @throws PDOException If there is already a transaction started or + * the driver does not support transactions+ * The SQL statement to prepare and execute. + *
+ *+ * Data inside the query should be properly escaped. + *
+ * @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. + * + * This function may + * return Boolean FALSE, but may also return a non-Boolean value which + * evaluates to FALSE. Please read the section on Booleans for more + * information. Use the === + * operator for testing the return value of this + * function. + *
+ * 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:
+ *
+ * $db->exec() or die(print_r($db->errorInfo(), true));
+ *
+ */
+ public function exec($statement) {}
+
+ /**
+ * (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.2.0)
+ * Executes an SQL statement, returning a result set as a PDOStatement object
+ * @link https://php.net/manual/en/pdo.query.php
+ * @param string $statement
+ * The SQL statement to prepare and execute. + *
+ *+ * Data inside the query should be properly escaped. + *
+ * @param int $mode+ * The fetch mode must be one of the PDO::FETCH_* constants. + *
+ * @param mixed $arg3+ * The second and following parameters are the same as the parameters for PDOStatement::setFetchMode. + *
+ * @param array $ctorargs [optional]+ * Arguments of custom class constructor when the mode + * parameter is set to PDO::FETCH_CLASS. + *
+ * @return PDOStatement|false PDO::query returns a PDOStatement object, or FALSE + * on failure. + * @see PDOStatement::setFetchMode For a full description of the second and following parameters. + */ + #[PhpStormStubsElementAvailable(to: '7.4')] + public function query($statement, $mode = PDO::ATTR_DEFAULT_FETCH_MODE, $arg3 = null, array $ctorargs = []) {} + + /** + * (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.2.0)+ * The SQL statement to prepare and execute. + *
+ *+ * Data inside the query should be properly escaped. + *
+ * @param int $mode+ * The fetch mode must be one of the PDO::FETCH_* constants. + *
+ * @param mixed $fetch_mode_args+ * Arguments of custom class constructor when the mode + * parameter is set to PDO::FETCH_CLASS. + *
+ * @return PDOStatement|false PDO::query returns a PDOStatement object, or FALSE + * on failure. + * @see PDOStatement::setFetchMode For a full description of the second and following parameters. + */ + #[PhpStormStubsElementAvailable('8.0')] + public function query($statement, $mode = PDO::ATTR_DEFAULT_FETCH_MODE, ...$fetch_mode_args) {} + + /** + * (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0)+ * Name of the sequence object from which the ID should be returned. + *
+ * @return string 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.
+ */
+ public function lastInsertId($name = null) {}
+
+ /**
+ * (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0)
+ * Fetch the SQLSTATE associated with the last operation on the database handle
+ * @link https://php.net/manual/en/pdo.errorcode.php
+ * @return mixed 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.
+ */
+ public function errorCode() {}
+
+ /**
+ * (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0)
+ * Fetch extended error information associated with the last operation on the database handle
+ * @link https://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 the following fields:
+ *
+ * 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.
+ */
+ #[ArrayShape([
+ 0 => "string",
+ 1 => "int",
+ 2 => "string",
+ ])]
+ public function errorInfo() {}
+
+ /**
+ * (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.2.0)
+ * Retrieve a database connection attribute
+ * @link https://php.net/manual/en/pdo.getattribute.php
+ * @param int $attribute
+ * One of the PDO::ATTR_* constants. The constants that + * apply to database connections are as follows: + * PDO::ATTR_AUTOCOMMIT + * PDO::ATTR_CASE + * PDO::ATTR_CLIENT_VERSION + * PDO::ATTR_CONNECTION_STATUS + * PDO::ATTR_DRIVER_NAME + * PDO::ATTR_ERRMODE + * PDO::ATTR_ORACLE_NULLS + * PDO::ATTR_PERSISTENT + * PDO::ATTR_PREFETCH + * PDO::ATTR_SERVER_INFO + * PDO::ATTR_SERVER_VERSION + * PDO::ATTR_TIMEOUT + *
+ * @return mixed A successful call returns the value of the requested PDO attribute. + * An unsuccessful call returns null. + */ + public function getAttribute($attribute) {} + + /** + * (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.2.1)+ * The string to be quoted. + *
+ * @param int $type [optional]+ * Provides a data type hint for drivers that have alternate quoting styles. + *
+ * @return string|false 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. + */ + public function quote($string, $type = PDO::PARAM_STR) {} + + final public function __wakeup() {} + + final public function __sleep() {} + + /** + * (PHP 5 >= 5.1.3, PHP 7, PECL pdo >= 1.0.3)- * An array of values with as many elements as there are bound - * parameters in the SQL statement being executed. - * All values are treated as PDO::PARAM_STR. - *
- *- * You cannot bind multiple values to a single parameter; for example, - * you cannot bind two values to a single named parameter in an IN() - * clause. - *
- *- * You cannot bind more values than specified; if more keys exist in - * input_parameters than in the SQL specified - * in the PDO::prepare, then the statement will - * fail and an error is emitted. - *
- * @return bool TRUE on success or FALSE on failure. - * @throws \PDOException On error if PDO::ERRMODE_EXCEPTION option is true. - */ - public function execute ($params = null) {} - - /** - * (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0)- * Controls how the next row will be returned to the caller. This value - * must be one of the PDO::FETCH_* constants, - * defaulting to value of PDO::ATTR_DEFAULT_FETCH_MODE - * (which defaults to PDO::FETCH_BOTH). - *
- *- * PDO::FETCH_ASSOC: returns an array indexed by column - * name as returned in your result set - *
- * @param int $cursorOrientation [optional]- * For a PDOStatement object representing a scrollable cursor, this - * value determines which row will be returned to the caller. This value - * must be one of the PDO::FETCH_ORI_* constants, - * defaulting to PDO::FETCH_ORI_NEXT. To request a - * scrollable cursor for your PDOStatement object, you must set the - * PDO::ATTR_CURSOR attribute to - * PDO::CURSOR_SCROLL when you prepare the SQL - * statement with PDO::prepare. - *
- * @param int $cursorOffset [optional] - * @return mixed The return value of this function on success depends on the fetch type. In - * all cases, FALSE is returned on failure. - */ - public function fetch ($mode = PDO::FETCH_BOTH, $cursorOrientation = PDO::FETCH_ORI_NEXT, $cursorOffset = 0) {} - - /** - * (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0)- * Parameter identifier. For a prepared statement using named - * placeholders, this will be a parameter name of the form - * :name. For a prepared statement using - * question mark placeholders, this will be the 1-indexed position of - * the parameter. - *
- * @param mixed &$var- * Name of the PHP variable to bind to the SQL statement parameter. - *
- * @param int $type [optional]- * Explicit data type for the parameter using the PDO::PARAM_* - * constants. - * To return an INOUT parameter from a stored procedure, - * use the bitwise OR operator to set the PDO::PARAM_INPUT_OUTPUT bits - * for the data_type parameter. - *
- * @param int $maxLength [optional]- * Length of the data type. To indicate that a parameter is an OUT - * parameter from a stored procedure, you must explicitly set the - * length. - *
- * @param mixed $driverOptions [optional]- *
- * @return bool TRUE on success or FALSE on failure. - */ - public function bindParam ($param, &$var, $type = PDO::PARAM_STR, $maxLength = null, $driverOptions = null) {} - - /** - * (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0)- * Number of the column (1-indexed) or name of the column in the result set. - * If using the column name, be aware that the name should match the - * case of the column, as returned by the driver. - *
- * @param mixed &$var- * Name of the PHP variable to which the column will be bound. - *
- * @param int $type [optional]- * Data type of the parameter, specified by the PDO::PARAM_* constants. - *
- * @param int $maxLength [optional]- * A hint for pre-allocation. - *
- * @param mixed $driverOptions [optional]- * Optional parameter(s) for the driver. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function bindColumn ($column, &$var, $type = null, $maxLength = null, $driverOptions = null) {} - - /** - * (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 1.0.0)- * Parameter identifier. For a prepared statement using named - * placeholders, this will be a parameter name of the form - * :name. For a prepared statement using - * question mark placeholders, this will be the 1-indexed position of - * the parameter. - *
- * @param mixed $value- * The value to bind to the parameter. - *
- * @param int $type [optional]- * Explicit data type for the parameter using the PDO::PARAM_* - * constants. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function bindValue ($param, $value, $type = PDO::PARAM_STR) {} - - /** - * (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0)- * 0-indexed number of the column you wish to retrieve from the row. If - * no value is supplied, PDOStatement::fetchColumn - * fetches the first column. - *
- * @return mixed 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.
- */
- public function fetchColumn ($column = 0) {}
-
- /**
- * (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0)
- * Returns an array containing all of the result set rows
- * @link https://php.net/manual/en/pdostatement.fetchall.php
- * @param int $mode [optional]
- * Controls the contents of the returned array as documented in - * PDOStatement::fetch. - * Defaults to value of PDO::ATTR_DEFAULT_FETCH_MODE - * (which defaults to PDO::FETCH_BOTH) - *
- *- * To return an array consisting of all values of a single column from - * the result set, specify PDO::FETCH_COLUMN. You - * can specify which column you want with the - * column-index parameter. - *
- *- * To fetch only the unique values of a single column from the result set, - * bitwise-OR PDO::FETCH_COLUMN with - * PDO::FETCH_UNIQUE. - *
- *- * To return an associative array grouped by the values of a specified - * column, bitwise-OR PDO::FETCH_COLUMN with - * PDO::FETCH_GROUP. - *
- * @param mixed ...$args- * Arguments of custom class constructor when the fetch_style - * parameter is PDO::FETCH_CLASS. - *
- * @return array|false PDOStatement::fetchAll returns an array containing - * all of the remaining rows in the result set. The array represents each - * row as either an array of column values or an object with properties - * corresponding to each column name. - * An empty array is returned if there are zero results to fetch, or false on failure. - * - *
- * 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.
- */
- public function fetchAll ($mode = PDO::FETCH_BOTH, ...$args) {}
-
- /**
- * (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.2.4)
- * Fetches the next row and returns it as an object.
- * @link https://php.net/manual/en/pdostatement.fetchobject.php
- * @param string $class [optional]
- * Name of the created class. - *
- * @param array $ctorArgs [optional]- * Elements of this array are passed to the constructor. - *
- * @return mixed an instance of the required class with property names that - * correspond to the column names or FALSE on failure. - */ - public function fetchObject ($class = "stdClass", array $ctorArgs = array()) {} - - /** - * (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0)- * The 0-indexed column in the result set. - *
- * @return array|false an associative array containing the following values representing - * the metadata for a single column: - * - *| Name | - *Value | - *
| native_type | - *The PHP native type used to represent the column value. | - *
| driver:decl_type | - *The SQL type used to represent the column value in the database. - * If the column in the result set is the result of a function, this value - * is not returned by PDOStatement::getColumnMeta. - * | - *
| flags | - *Any flags set for this column. | - *
| name | - *The name of this column as returned by the database. | - *
| table | - *The name of this column's table as returned by the database. | - *
| len | - *The length of this column. Normally -1 for - * types other than floating point decimals. | - *
| precision | - *The numeric precision of this column. Normally - * 0 for types other than floating point - * decimals. | - *
| pdo_type | - *The type of this column as represented by the - * PDO::PARAM_* constants. | - *
- * Returns FALSE if the requested column does not exist in the result set,
- * or if no result set exists.
- */
- public function getColumnMeta ($column) {}
-
- /**
- * (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.2.0)
- * Set the default fetch mode for this statement
- * @link https://php.net/manual/en/pdostatement.setfetchmode.php
- * @param int $mode
- * The fetch mode must be one of the PDO::FETCH_* constants. - *
- * @param null|string|object $className [optional]- * Class name or object - *
- * @param array $params [optional]Constructor arguments.
- * @return bool TRUE on success or FALSE on failure. - */ - #[PhpStormStubsElementAvailable(to: '7.4')] - public function setFetchMode ($mode, $className = null, array $params = array()) {} - - /** - * (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.2.0)- * The fetch mode must be one of the PDO::FETCH_* constants. - *
- * @param string|object|null $className [optional]- * Class name or object - *
- * @param mixed ...$paramsConstructor arguments.
- * @return bool TRUE on success or FALSE on failure. - */ - #[PhpStormStubsElementAvailable('8.0')] - public function setFetchMode ($mode, $className = null, ...$params) {} - - /** - * (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.2.0)+ * An array of values with as many elements as there are bound + * parameters in the SQL statement being executed. + * All values are treated as PDO::PARAM_STR. + *
+ *+ * You cannot bind multiple values to a single parameter; for example, + * you cannot bind two values to a single named parameter in an IN() + * clause. + *
+ *+ * You cannot bind more values than specified; if more keys exist in + * input_parameters than in the SQL specified + * in the PDO::prepare, then the statement will + * fail and an error is emitted. + *
+ * @return bool TRUE on success or FALSE on failure. + * @throws \PDOException On error if PDO::ERRMODE_EXCEPTION option is true. + */ + public function execute($params = null) {} + + /** + * (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0)+ * Controls how the next row will be returned to the caller. This value + * must be one of the PDO::FETCH_* constants, + * defaulting to value of PDO::ATTR_DEFAULT_FETCH_MODE + * (which defaults to PDO::FETCH_BOTH). + *
+ *+ * PDO::FETCH_ASSOC: returns an array indexed by column + * name as returned in your result set + *
+ * @param int $cursorOrientation [optional]+ * For a PDOStatement object representing a scrollable cursor, this + * value determines which row will be returned to the caller. This value + * must be one of the PDO::FETCH_ORI_* constants, + * defaulting to PDO::FETCH_ORI_NEXT. To request a + * scrollable cursor for your PDOStatement object, you must set the + * PDO::ATTR_CURSOR attribute to + * PDO::CURSOR_SCROLL when you prepare the SQL + * statement with PDO::prepare. + *
+ * @param int $cursorOffset [optional] + * @return mixed The return value of this function on success depends on the fetch type. In + * all cases, FALSE is returned on failure. + */ + public function fetch($mode = PDO::FETCH_BOTH, $cursorOrientation = PDO::FETCH_ORI_NEXT, $cursorOffset = 0) {} + + /** + * (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0)+ * Parameter identifier. For a prepared statement using named + * placeholders, this will be a parameter name of the form + * :name. For a prepared statement using + * question mark placeholders, this will be the 1-indexed position of + * the parameter. + *
+ * @param mixed &$var+ * Name of the PHP variable to bind to the SQL statement parameter. + *
+ * @param int $type [optional]+ * Explicit data type for the parameter using the PDO::PARAM_* + * constants. + * To return an INOUT parameter from a stored procedure, + * use the bitwise OR operator to set the PDO::PARAM_INPUT_OUTPUT bits + * for the data_type parameter. + *
+ * @param int $maxLength [optional]+ * Length of the data type. To indicate that a parameter is an OUT + * parameter from a stored procedure, you must explicitly set the + * length. + *
+ * @param mixed $driverOptions [optional]+ *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function bindParam($param, &$var, $type = PDO::PARAM_STR, $maxLength = null, $driverOptions = null) {} + + /** + * (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0)+ * Number of the column (1-indexed) or name of the column in the result set. + * If using the column name, be aware that the name should match the + * case of the column, as returned by the driver. + *
+ * @param mixed &$var+ * Name of the PHP variable to which the column will be bound. + *
+ * @param int $type [optional]+ * Data type of the parameter, specified by the PDO::PARAM_* constants. + *
+ * @param int $maxLength [optional]+ * A hint for pre-allocation. + *
+ * @param mixed $driverOptions [optional]+ * Optional parameter(s) for the driver. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function bindColumn($column, &$var, $type = null, $maxLength = null, $driverOptions = null) {} + + /** + * (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 1.0.0)+ * Parameter identifier. For a prepared statement using named + * placeholders, this will be a parameter name of the form + * :name. For a prepared statement using + * question mark placeholders, this will be the 1-indexed position of + * the parameter. + *
+ * @param mixed $value+ * The value to bind to the parameter. + *
+ * @param int $type [optional]+ * Explicit data type for the parameter using the PDO::PARAM_* + * constants. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function bindValue($param, $value, $type = PDO::PARAM_STR) {} + + /** + * (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0)+ * 0-indexed number of the column you wish to retrieve from the row. If + * no value is supplied, PDOStatement::fetchColumn + * fetches the first column. + *
+ * @return mixed 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.
+ */
+ public function fetchColumn($column = 0) {}
+
+ /**
+ * (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0)
+ * Returns an array containing all of the result set rows
+ * @link https://php.net/manual/en/pdostatement.fetchall.php
+ * @param int $mode [optional]
+ * Controls the contents of the returned array as documented in + * PDOStatement::fetch. + * Defaults to value of PDO::ATTR_DEFAULT_FETCH_MODE + * (which defaults to PDO::FETCH_BOTH) + *
+ *+ * To return an array consisting of all values of a single column from + * the result set, specify PDO::FETCH_COLUMN. You + * can specify which column you want with the + * column-index parameter. + *
+ *+ * To fetch only the unique values of a single column from the result set, + * bitwise-OR PDO::FETCH_COLUMN with + * PDO::FETCH_UNIQUE. + *
+ *+ * To return an associative array grouped by the values of a specified + * column, bitwise-OR PDO::FETCH_COLUMN with + * PDO::FETCH_GROUP. + *
+ * @param mixed ...$args+ * Arguments of custom class constructor when the fetch_style + * parameter is PDO::FETCH_CLASS. + *
+ * @return array|false PDOStatement::fetchAll returns an array containing + * all of the remaining rows in the result set. The array represents each + * row as either an array of column values or an object with properties + * corresponding to each column name. + * An empty array is returned if there are zero results to fetch, or false on failure. + * + *
+ * 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.
+ */
+ public function fetchAll($mode = PDO::FETCH_BOTH, ...$args) {}
+
+ /**
+ * (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.2.4)
+ * Fetches the next row and returns it as an object.
+ * @link https://php.net/manual/en/pdostatement.fetchobject.php
+ * @param string $class [optional]
+ * Name of the created class. + *
+ * @param array $ctorArgs [optional]+ * Elements of this array are passed to the constructor. + *
+ * @return mixed an instance of the required class with property names that + * correspond to the column names or FALSE on failure. + */ + public function fetchObject($class = "stdClass", array $ctorArgs = []) {} + + /** + * (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.1.0)+ * The 0-indexed column in the result set. + *
+ * @return array|false an associative array containing the following values representing + * the metadata for a single column: + * + *| Name | + *Value | + *
| native_type | + *The PHP native type used to represent the column value. | + *
| driver:decl_type | + *The SQL type used to represent the column value in the database. + * If the column in the result set is the result of a function, this value + * is not returned by PDOStatement::getColumnMeta. + * | + *
| flags | + *Any flags set for this column. | + *
| name | + *The name of this column as returned by the database. | + *
| table | + *The name of this column's table as returned by the database. | + *
| len | + *The length of this column. Normally -1 for + * types other than floating point decimals. | + *
| precision | + *The numeric precision of this column. Normally + * 0 for types other than floating point + * decimals. | + *
| pdo_type | + *The type of this column as represented by the + * PDO::PARAM_* constants. | + *
+ * Returns FALSE if the requested column does not exist in the result set,
+ * or if no result set exists.
+ */
+ public function getColumnMeta($column) {}
+
+ /**
+ * (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.2.0)
+ * Set the default fetch mode for this statement
+ * @link https://php.net/manual/en/pdostatement.setfetchmode.php
+ * @param int $mode
+ * The fetch mode must be one of the PDO::FETCH_* constants. + *
+ * @param null|string|object $className [optional]+ * Class name or object + *
+ * @param array $params [optional]Constructor arguments.
+ * @return bool TRUE on success or FALSE on failure. + */ + #[PhpStormStubsElementAvailable(to: '7.4')] + public function setFetchMode($mode, $className = null, array $params = []) {} + + /** + * (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.2.0)+ * The fetch mode must be one of the PDO::FETCH_* constants. + *
+ * @param string|object|null $className [optional]+ * Class name or object + *
+ * @param mixed ...$paramsConstructor arguments.
+ * @return bool TRUE on success or FALSE on failure. + */ + #[PhpStormStubsElementAvailable('8.0')] + public function setFetchMode($mode, $className = null, ...$params) {} -final class PDORow { + /** + * (PHP 5 >= 5.1.0, PHP 7, PECL pdo >= 0.2.0)- * Path to an existing Phar archive or to-be-created archive. The file name's - * extension must contain .phar. - *
- * @param int $flags [optional]- * Flags to pass to parent class RecursiveDirectoryIterator. - *
- * @param string $alias [optional]- * Alias with which this Phar archive should be referred to in calls to stream - * functionality. - *
+class Phar extends RecursiveDirectoryIterator implements RecursiveIterator, SeekableIterator, Countable, ArrayAccess +{ + public const BZ2 = 8192; + public const GZ = 4096; + public const NONE = 0; + public const PHAR = 1; + public const TAR = 2; + public const ZIP = 3; + public const COMPRESSED = 61440; + public const PHP = 0; + public const PHPS = 1; + public const MD5 = 1; + public const OPENSSL = 16; + public const SHA1 = 2; + public const SHA256 = 3; + public const SHA512 = 4; + + /** + * (PHP >= 5.3.0, PECL phar >= 1.0.0)+ * Path to an existing Phar archive or to-be-created archive. The file name's + * extension must contain .phar. + *
+ * @param int $flags [optional]+ * Flags to pass to parent class RecursiveDirectoryIterator. + *
+ * @param string $alias [optional]+ * Alias with which this Phar archive should be referred to in calls to stream + * functionality. + *
* @throws BadMethodCallException If called twice. * @throws UnexpectedValueException If the phar archive can't be opened. - */ - public function __construct ($filename, $flags = FilesystemIterator::KEY_AS_PATHNAME|FilesystemIterator::CURRENT_AS_FILEINFO, $alias = null) {} - - public function __destruct () {} - - /** - * (Unknown)- * The name of the empty directory to create in the phar archive - *
- * @return void no return value, exception is thrown on failure. - */ - public function addEmptyDir ($directory) {} - - /** - * (Unknown)- * Full or relative path to a file on disk to be added - * to the phar archive. - *
- * @param string $localName [optional]- * Path that the file will be stored in the archive. - *
- * @return void no return value, exception is thrown on failure. - */ - public function addFile ($filename, $localName = null) {} - - /** - * (Unknown)- * Path that the file will be stored in the archive. - *
- * @param string $contents- * The file contents to store - *
- * @return void no return value, exception is thrown on failure. - */ - public function addFromString ($localName, $contents) {} - - /** - * (PHP >= 5.3.0, PECL phar >= 2.0.0)- * The full or relative path to the directory that contains all files - * to add to the archive. - *
- * @param $pattern $regex [optional]- * An optional pcre regular expression that is used to filter the - * list of files. Only file paths matching the regular expression - * will be included in the archive. - *
- * @return array Phar::buildFromDirectory returns an associative array - * mapping internal path of file to the full path of the file on the - * filesystem. - */ - public function buildFromDirectory ($directory, $pattern = null) {} - - /** - * (PHP >= 5.3.0, PECL phar >= 2.0.0)- * Any iterator that either associatively maps phar file to location or - * returns SplFileInfo objects - *
- * @param string $baseDirectory [optional]- * For iterators that return SplFileInfo objects, the portion of each - * file's full path to remove when adding to the phar archive - *
- * @return array Phar::buildFromIterator returns an associative array - * mapping internal path of file to the full path of the file on the - * filesystem. - */ - public function buildFromIterator (Iterator $iterator, $baseDirectory = null) {} - - /** - * (PHP >= 5.3.0, PECL phar >= 2.0.0)- * Compression must be one of Phar::GZ, - * Phar::BZ2 to add compression, or Phar::NONE - * to remove compression. - *
- * @return void No value is returned. - */ - public function compressFiles ($compression) {} - - /** - * (PHP >= 5.3.0, PECL phar >= 2.0.0)- * Compression must be one of Phar::GZ, - * Phar::BZ2 to add compression, or Phar::NONE - * to remove compression. - *
- * @param string $extension [optional]- * By default, the extension is .phar.gz - * or .phar.bz2 for compressing phar archives, and - * .phar.tar.gz or .phar.tar.bz2 for - * compressing tar archives. For decompressing, the default file extensions - * are .phar and .phar.tar. - *
- * @return static a Phar object. - */ - public function compress ($compression, $extension = null) {} - - /** - * (PHP >= 5.3.0, PECL phar >= 2.0.0)- * For decompressing, the default file extensions - * are .phar and .phar.tar. - * Use this parameter to specify another file extension. Be aware - * that all executable phar archives must contain .phar - * in their filename. - *
- * @return static A Phar object is returned. - */ - public function decompress ($extension = null) {} - - /** - * (PHP >= 5.3.0, PECL phar >= 2.0.0)- * This should be one of Phar::PHAR, Phar::TAR, - * or Phar::ZIP. If set to NULL, the existing file format - * will be preserved. - *
- * @param int $compression [optional]- * This should be one of Phar::NONE for no whole-archive - * compression, Phar::GZ for zlib-based compression, and - * Phar::BZ2 for bzip-based compression. - *
- * @param string $extension [optional]- * This parameter is used to override the default file extension for a - * converted archive. Note that all zip- and tar-based phar archives must contain - * .phar in their file extension in order to be processed as a - * phar archive. - *
- *- * If converting to a phar-based archive, the default extensions are - * .phar, .phar.gz, or .phar.bz2 - * depending on the specified compression. For tar-based phar archives, the - * default extensions are .phar.tar, .phar.tar.gz, - * and .phar.tar.bz2. For zip-based phar archives, the - * default extension is .phar.zip. - *
- * @return Phar The method returns a Phar object on success and throws an - * exception on failure. - */ - public function convertToExecutable ($format = 9021976, $compression = 9021976, $extension = null) {} - - /** - * (PHP >= 5.3.0, PECL phar >= 2.0.0)- * This should be one of Phar::TAR - * or Phar::ZIP. If set to NULL, the existing file format - * will be preserved. - *
- * @param int $compression [optional]- * This should be one of Phar::NONE for no whole-archive - * compression, Phar::GZ for zlib-based compression, and - * Phar::BZ2 for bzip-based compression. - *
- * @param string $extension [optional]- * This parameter is used to override the default file extension for a - * converted archive. Note that .phar cannot be used - * anywhere in the filename for a non-executable tar or zip archive. - *
- *- * If converting to a tar-based phar archive, the - * default extensions are .tar, .tar.gz, - * and .tar.bz2 depending on specified compression. - * For zip-based archives, the - * default extension is .zip. - *
- * @return PharData The method returns a PharData object on success and throws an - * exception on failure. - */ - public function convertToData ($format = 9021976, $compression = 9021976, $extension = null) {} - - /** - * (PHP >= 5.3.0, PECL phar >= 2.0.0)- * Path within an archive to the file to delete. - *
- * @return bool returns TRUE on success, but it is better to check for thrown exception, - * and assume success if none is thrown. - */ - public function delete ($localName) {} - - /** - * (PHP >= 5.3.0, PECL phar >= 1.2.0)- * Path within an archive to the file to delete. - *
- * @param string|array|null $files [optional]- * The name of a file or directory to extract, or an array of files/directories to extract - *
- * @param bool $overwrite [optional]- * Set to TRUE to enable overwriting existing files - *
- * @return bool returns TRUE on success, but it is better to check for thrown exception, - * and assume success if none is thrown. - */ - public function extractTo ($directory, $files = null, $overwrite = false) {} + */ + public function __construct($filename, $flags = FilesystemIterator::KEY_AS_PATHNAME|FilesystemIterator::CURRENT_AS_FILEINFO, $alias = null) {} + + public function __destruct() {} + + /** + * (Unknown)+ * The name of the empty directory to create in the phar archive + *
+ * @return void no return value, exception is thrown on failure. + */ + public function addEmptyDir($directory) {} + + /** + * (Unknown)+ * Full or relative path to a file on disk to be added + * to the phar archive. + *
+ * @param string $localName [optional]+ * Path that the file will be stored in the archive. + *
+ * @return void no return value, exception is thrown on failure. + */ + public function addFile($filename, $localName = null) {} + + /** + * (Unknown)+ * Path that the file will be stored in the archive. + *
+ * @param string $contents+ * The file contents to store + *
+ * @return void no return value, exception is thrown on failure. + */ + public function addFromString($localName, $contents) {} + + /** + * (PHP >= 5.3.0, PECL phar >= 2.0.0)+ * The full or relative path to the directory that contains all files + * to add to the archive. + *
+ * @param $pattern $regex [optional]+ * An optional pcre regular expression that is used to filter the + * list of files. Only file paths matching the regular expression + * will be included in the archive. + *
+ * @return array Phar::buildFromDirectory returns an associative array + * mapping internal path of file to the full path of the file on the + * filesystem. + */ + public function buildFromDirectory($directory, $pattern = null) {} + + /** + * (PHP >= 5.3.0, PECL phar >= 2.0.0)+ * Any iterator that either associatively maps phar file to location or + * returns SplFileInfo objects + *
+ * @param string $baseDirectory [optional]+ * For iterators that return SplFileInfo objects, the portion of each + * file's full path to remove when adding to the phar archive + *
+ * @return array Phar::buildFromIterator returns an associative array + * mapping internal path of file to the full path of the file on the + * filesystem. + */ + public function buildFromIterator(Iterator $iterator, $baseDirectory = null) {} + + /** + * (PHP >= 5.3.0, PECL phar >= 2.0.0)+ * Compression must be one of Phar::GZ, + * Phar::BZ2 to add compression, or Phar::NONE + * to remove compression. + *
+ * @return void No value is returned. + */ + public function compressFiles($compression) {} + + /** + * (PHP >= 5.3.0, PECL phar >= 2.0.0)+ * Compression must be one of Phar::GZ, + * Phar::BZ2 to add compression, or Phar::NONE + * to remove compression. + *
+ * @param string $extension [optional]+ * By default, the extension is .phar.gz + * or .phar.bz2 for compressing phar archives, and + * .phar.tar.gz or .phar.tar.bz2 for + * compressing tar archives. For decompressing, the default file extensions + * are .phar and .phar.tar. + *
+ * @return static a Phar object. + */ + public function compress($compression, $extension = null) {} + + /** + * (PHP >= 5.3.0, PECL phar >= 2.0.0)+ * For decompressing, the default file extensions + * are .phar and .phar.tar. + * Use this parameter to specify another file extension. Be aware + * that all executable phar archives must contain .phar + * in their filename. + *
+ * @return static A Phar object is returned. + */ + public function decompress($extension = null) {} + + /** + * (PHP >= 5.3.0, PECL phar >= 2.0.0)+ * This should be one of Phar::PHAR, Phar::TAR, + * or Phar::ZIP. If set to NULL, the existing file format + * will be preserved. + *
+ * @param int $compression [optional]+ * This should be one of Phar::NONE for no whole-archive + * compression, Phar::GZ for zlib-based compression, and + * Phar::BZ2 for bzip-based compression. + *
+ * @param string $extension [optional]+ * This parameter is used to override the default file extension for a + * converted archive. Note that all zip- and tar-based phar archives must contain + * .phar in their file extension in order to be processed as a + * phar archive. + *
+ *+ * If converting to a phar-based archive, the default extensions are + * .phar, .phar.gz, or .phar.bz2 + * depending on the specified compression. For tar-based phar archives, the + * default extensions are .phar.tar, .phar.tar.gz, + * and .phar.tar.bz2. For zip-based phar archives, the + * default extension is .phar.zip. + *
+ * @return Phar The method returns a Phar object on success and throws an + * exception on failure. + */ + public function convertToExecutable($format = 9021976, $compression = 9021976, $extension = null) {} + + /** + * (PHP >= 5.3.0, PECL phar >= 2.0.0)+ * This should be one of Phar::TAR + * or Phar::ZIP. If set to NULL, the existing file format + * will be preserved. + *
+ * @param int $compression [optional]+ * This should be one of Phar::NONE for no whole-archive + * compression, Phar::GZ for zlib-based compression, and + * Phar::BZ2 for bzip-based compression. + *
+ * @param string $extension [optional]+ * This parameter is used to override the default file extension for a + * converted archive. Note that .phar cannot be used + * anywhere in the filename for a non-executable tar or zip archive. + *
+ *+ * If converting to a tar-based phar archive, the + * default extensions are .tar, .tar.gz, + * and .tar.bz2 depending on specified compression. + * For zip-based archives, the + * default extension is .zip. + *
+ * @return PharData The method returns a PharData object on success and throws an + * exception on failure. + */ + public function convertToData($format = 9021976, $compression = 9021976, $extension = null) {} + + /** + * (PHP >= 5.3.0, PECL phar >= 2.0.0)+ * Path within an archive to the file to delete. + *
+ * @return bool returns TRUE on success, but it is better to check for thrown exception, + * and assume success if none is thrown. + */ + public function delete($localName) {} + + /** + * (PHP >= 5.3.0, PECL phar >= 1.2.0)+ * Path within an archive to the file to delete. + *
+ * @param string|array|null $files [optional]+ * The name of a file or directory to extract, or an array of files/directories to extract + *
+ * @param bool $overwrite [optional]+ * Set to TRUE to enable overwriting existing files + *
+ * @return bool returns TRUE on success, but it is better to check for thrown exception, + * and assume success if none is thrown. + */ + public function extractTo($directory, $files = null, $overwrite = false) {} /** * @see setAlias * @return string */ - public function getAlias () {} - - - /** - * (PHP >= 5.3.0, PECL phar >= 1.0.0)- * Either Phar::PHAR, Phar::TAR, or - * Phar::ZIP to test for the format of the archive. - *
- * @return bool TRUE if the phar archive matches the file format requested by the parameter - */ - public function isFileFormat ($format) {} - - /** - * (Unknown)- * The filename (relative path) to look for in a Phar. - *
- * @return bool TRUE if the file exists within the phar, or FALSE if not. - */ - public function offsetExists ($localName) {} - - /** - * (PHP >= 5.3.0, PECL phar >= 1.0.0)- * The filename (relative path) to look for in a Phar. - *
- * @return PharFileInfo A PharFileInfo object is returned that can be used to - * iterate over a file's contents or to retrieve information about the current file. - */ - public function offsetGet ($localName) {} - - /** - * (PHP >= 5.3.0, PECL phar >= 1.0.0)- * The filename (relative path) to modify in a Phar. - *
- * @param string $value- * Content of the file. - *
- * @return void No return values. - */ - public function offsetSet ($localName, $value) {} - - /** - * (PHP >= 5.3.0, PECL phar >= 1.0.0)- * The filename (relative path) to modify in a Phar. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function offsetUnset ($localName) {} - - /** - * (PHP >= 5.3.0, PECL phar >= 1.2.1)- * A shorthand string that this archive can be referred to in phar - * stream wrapper access. - *
- * @return bool - */ - public function setAlias ($alias) {} - - /** - * (Unknown)- * Relative path within the phar archive to run if accessed on the command-line - *
- * @param string $webIndex [optional]- * Relative path within the phar archive to run if accessed through a web browser - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function setDefaultStub ($index = null, $webIndex = null) {} - - /** - * (PHP >= 5.3.0, PECL phar >= 1.0.0)- * Any PHP variable containing information to store that describes the phar archive - *
- * @return void No value is returned. - */ - public function setMetadata ($metadata) {} - - /** - * (PHP >= 5.3.0, PECL phar >= 1.1.0)- * One of Phar::MD5, - * Phar::SHA1, Phar::SHA256, - * Phar::SHA512, or Phar::OPENSSL - *
- * @param string $privateKey [optional]
- * The contents of an OpenSSL private key, as extracted from a certificate or
- * OpenSSL key file:
- *
- * $private = openssl_get_privatekey(file_get_contents('private.pem'));
- * $pkey = '';
- * openssl_pkey_export($private, $pkey);
- * $p->setSignatureAlgorithm(Phar::OPENSSL, $pkey);
- *
- * See phar introduction for instructions on
- * naming and placement of the public key file.
- *
- * A string or an open stream handle to use as the executable stub for this - * phar archive. - *
- * @param int $length [optional]- *
- * @return bool TRUE on success or FALSE on failure. - */ - public function setStub ($stub, $length = -1) {} - - /** - * (PHP >= 5.3.0, PECL phar >= 1.0.0)- * Either Phar::GZ or Phar::BZ2 can be - * used to test whether compression is possible with a specific compression - * algorithm (zlib or bzip2). - *
- * @return bool TRUE if compression/decompression is available, FALSE if not. - */ - final public static function canCompress (int $compression = 0) {} - - /** - * (PHP >= 5.3.0, PECL phar >= 1.0.0)- * The name or full path to a phar archive not yet created - *
- * @param bool $executable [optional]- * This parameter determines whether the filename should be treated as - * a phar executable archive, or a data non-executable archive - *
- * @return bool TRUE if the filename is valid, FALSE if not. - */ - final public static function isValidPharFilename (string $filename, bool $executable = true) {} - - /** - * (PHP >= 5.3.0, PECL phar >= 1.0.0)- * the full or relative path to the phar archive to open - *
- * @param string|null $alias [optional]- * The alias that may be used to refer to the phar archive. Note - * that many phar archives specify an explicit alias inside the - * phar archive, and a PharException will be thrown if - * a new alias is specified in this case. - *
- * @return bool TRUE on success or FALSE on failure. - */ - final public static function loadPhar (string $filename, ?string $alias = null) {} - - /** - * (PHP >= 5.3.0, PECL phar >= 1.0.0)- * The alias that can be used in phar:// URLs to - * refer to this archive, rather than its full path. - *
- * @param int $offset [optional]- * Unused variable, here for compatibility with PEAR's PHP_Archive. - *
- * @return bool TRUE on success or FALSE on failure. - */ - final public static function mapPhar (?string $alias = null, int $offset = 0) {} - - /** - * (PHP >= 5.3.0, PECL phar >= 2.0.0)- * If FALSE, the full path on disk to the phar - * archive is returned. If TRUE, a full phar URL is returned. - *
- * @return string the filename if valid, empty string otherwise. - */ - final public static function running (bool $returnPhar = true) {} - - /** - * (PHP >= 5.3.0, PECL phar >= 2.0.0)- * The internal path within the phar archive to use as the mounted path location. - * This must be a relative path within the phar archive, and must not already exist. - *
- * @param string $externalPath- * A path or URL to an external file or directory to mount within the phar archive - *
- * @return void No return. PharException is thrown on failure. - */ - final public static function mount (string $pharPath, string $externalPath) {} - - /** - * (Unknown)- * an array containing as string indices any of - * REQUEST_URI, PHP_SELF, - * SCRIPT_NAME and SCRIPT_FILENAME. - * Other values trigger an exception, and Phar::mungServer - * is case-sensitive. - *
- * @return void No return. - */ - final public static function mungServer (array $variables) {} - - /** - * (PHP >= 5.3.0, PECL phar >= 2.0.0)- * The path on disk to the phar archive. - *
- * @return bool TRUE on success or FALSE on failure. - */ - final public static function unlinkArchive (string $filename) {} - - /** - * (PHP >= 5.3.0, PECL phar >= 2.0.0)- * The alias that can be used in phar:// URLs to - * refer to this archive, rather than its full path. - *
- * @param string|null $index [optional]- * The location within the phar of the directory index. - *
- * @param null|string $fileNotFoundScript [optional]- * The location of the script to run when a file is not found. This - * script should output the proper HTTP 404 headers. - *
- * @param null|array $mimeTypes [optional]
- * An array mapping additional file extensions to MIME type.
- * If the default mapping is sufficient, pass an empty array.
- * By default, these extensions are mapped to these MIME types:
- *
- * $mimes = array(
- * 'phps' => Phar::PHPS, // pass to highlight_file()
- * 'c' => 'text/plain',
- * 'cc' => 'text/plain',
- * 'cpp' => 'text/plain',
- * 'c++' => 'text/plain',
- * 'dtd' => 'text/plain',
- * 'h' => 'text/plain',
- * 'log' => 'text/plain',
- * 'rng' => 'text/plain',
- * 'txt' => 'text/plain',
- * 'xsd' => 'text/plain',
- * 'php' => Phar::PHP, // parse as PHP
- * 'inc' => Phar::PHP, // parse as PHP
- * 'avi' => 'video/avi',
- * 'bmp' => 'image/bmp',
- * 'css' => 'text/css',
- * 'gif' => 'image/gif',
- * 'htm' => 'text/html',
- * 'html' => 'text/html',
- * 'htmls' => 'text/html',
- * 'ico' => 'image/x-ico',
- * 'jpe' => 'image/jpeg',
- * 'jpg' => 'image/jpeg',
- * 'jpeg' => 'image/jpeg',
- * 'js' => 'application/x-javascript',
- * 'midi' => 'audio/midi',
- * 'mid' => 'audio/midi',
- * 'mod' => 'audio/mod',
- * 'mov' => 'movie/quicktime',
- * 'mp3' => 'audio/mp3',
- * 'mpg' => 'video/mpeg',
- * 'mpeg' => 'video/mpeg',
- * 'pdf' => 'application/pdf',
- * 'png' => 'image/png',
- * 'swf' => 'application/shockwave-flash',
- * 'tif' => 'image/tiff',
- * 'tiff' => 'image/tiff',
- * 'wav' => 'audio/wav',
- * 'xbm' => 'image/xbm',
- * 'xml' => 'text/xml',
- * );
- *
- *
- * The rewrites function is passed a string as its only parameter and must return a string or FALSE. - *
- *- * If you are using fast-cgi or cgi then the parameter passed to the function is the value of the - * $_SERVER['PATH_INFO'] variable. Otherwise, the parameter passed to the function is the value - * of the $_SERVER['REQUEST_URI'] variable. - *
- *- * If a string is returned it is used as the internal file path. If FALSE is returned then webPhar() will - * send a HTTP 403 Denied Code. - *
- * @return void No value is returned. - */ - final public static function webPhar (?string $alias = null, - ?string $index = "index.php", - #[LanguageLevelTypeAware(['8.0' => '?string'], default: 'string')] $fileNotFoundScript = null, - array $mimeTypes = null, - ?callable $rewrite = null) {} - - /** - * Returns whether current entry is a directory and not '.' or '..' - * @link https://php.net/manual/en/recursivedirectoryiterator.haschildren.php - * @param bool $allow_links [optional]- *
- * @return bool whether the current entry is a directory, but not '.' or '..' - */ - public function hasChildren ($allow_links = false) {} - - /** - * Returns an iterator for the current entry if it is a directory - * @link https://php.net/manual/en/recursivedirectoryiterator.getchildren.php - * @return mixed The filename, file information, or $this depending on the set flags. - * See the FilesystemIterator - * constants. - */ - public function getChildren () {} - - /** - * Rewinds back to the beginning - * @link https://php.net/manual/en/filesystemiterator.rewind.php - * @return void No value is returned. - */ - public function rewind () {} - - /** - * Move to the next file - * @link https://php.net/manual/en/filesystemiterator.next.php - * @return void No value is returned. - */ - public function next () {} - - /** - * Retrieve the key for the current file - * @link https://php.net/manual/en/filesystemiterator.key.php - * @return string the pathname or filename depending on the set flags. - * See the FilesystemIterator constants. - */ - public function key () {} - - /** - * The current file - * @link https://php.net/manual/en/filesystemiterator.current.php - * @return mixed The filename, file information, or $this depending on the set flags. - * See the FilesystemIterator constants. - */ - public function current () {} - - /** - * Check whether current DirectoryIterator position is a valid file - * @link https://php.net/manual/en/directoryiterator.valid.php - * @return bool TRUE if the position is valid, otherwise FALSE - */ - public function valid () {} - - /** - * Seek to a DirectoryIterator item - * @link https://php.net/manual/en/directoryiterator.seek.php - * @param int $position- * The zero-based numeric position to seek to. - *
- * @return void No value is returned. - */ - public function seek ($position) {} - - public function _bad_state_ex (){} - + public function getAlias() {} + + /** + * (PHP >= 5.3.0, PECL phar >= 1.0.0)+ * Either Phar::PHAR, Phar::TAR, or + * Phar::ZIP to test for the format of the archive. + *
+ * @return bool TRUE if the phar archive matches the file format requested by the parameter + */ + public function isFileFormat($format) {} + + /** + * (Unknown)+ * The filename (relative path) to look for in a Phar. + *
+ * @return bool TRUE if the file exists within the phar, or FALSE if not. + */ + public function offsetExists($localName) {} + + /** + * (PHP >= 5.3.0, PECL phar >= 1.0.0)+ * The filename (relative path) to look for in a Phar. + *
+ * @return PharFileInfo A PharFileInfo object is returned that can be used to + * iterate over a file's contents or to retrieve information about the current file. + */ + public function offsetGet($localName) {} + + /** + * (PHP >= 5.3.0, PECL phar >= 1.0.0)+ * The filename (relative path) to modify in a Phar. + *
+ * @param string $value+ * Content of the file. + *
+ * @return void No return values. + */ + public function offsetSet($localName, $value) {} + + /** + * (PHP >= 5.3.0, PECL phar >= 1.0.0)+ * The filename (relative path) to modify in a Phar. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function offsetUnset($localName) {} + + /** + * (PHP >= 5.3.0, PECL phar >= 1.2.1)+ * A shorthand string that this archive can be referred to in phar + * stream wrapper access. + *
+ * @return bool + */ + public function setAlias($alias) {} + + /** + * (Unknown)+ * Relative path within the phar archive to run if accessed on the command-line + *
+ * @param string $webIndex [optional]+ * Relative path within the phar archive to run if accessed through a web browser + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function setDefaultStub($index = null, $webIndex = null) {} + + /** + * (PHP >= 5.3.0, PECL phar >= 1.0.0)+ * Any PHP variable containing information to store that describes the phar archive + *
+ * @return void No value is returned. + */ + public function setMetadata($metadata) {} + + /** + * (PHP >= 5.3.0, PECL phar >= 1.1.0)+ * One of Phar::MD5, + * Phar::SHA1, Phar::SHA256, + * Phar::SHA512, or Phar::OPENSSL + *
+ * @param string $privateKey [optional]
+ * The contents of an OpenSSL private key, as extracted from a certificate or
+ * OpenSSL key file:
+ *
+ * $private = openssl_get_privatekey(file_get_contents('private.pem'));
+ * $pkey = '';
+ * openssl_pkey_export($private, $pkey);
+ * $p->setSignatureAlgorithm(Phar::OPENSSL, $pkey);
+ *
+ * See phar introduction for instructions on
+ * naming and placement of the public key file.
+ *
+ * A string or an open stream handle to use as the executable stub for this + * phar archive. + *
+ * @param int $length [optional]+ *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function setStub($stub, $length = -1) {} + + /** + * (PHP >= 5.3.0, PECL phar >= 1.0.0)+ * Either Phar::GZ or Phar::BZ2 can be + * used to test whether compression is possible with a specific compression + * algorithm (zlib or bzip2). + *
+ * @return bool TRUE if compression/decompression is available, FALSE if not. + */ + final public static function canCompress(int $compression = 0) {} + + /** + * (PHP >= 5.3.0, PECL phar >= 1.0.0)+ * The name or full path to a phar archive not yet created + *
+ * @param bool $executable [optional]+ * This parameter determines whether the filename should be treated as + * a phar executable archive, or a data non-executable archive + *
+ * @return bool TRUE if the filename is valid, FALSE if not. + */ + final public static function isValidPharFilename(string $filename, bool $executable = true) {} + + /** + * (PHP >= 5.3.0, PECL phar >= 1.0.0)+ * the full or relative path to the phar archive to open + *
+ * @param string|null $alias [optional]+ * The alias that may be used to refer to the phar archive. Note + * that many phar archives specify an explicit alias inside the + * phar archive, and a PharException will be thrown if + * a new alias is specified in this case. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + final public static function loadPhar(string $filename, ?string $alias = null) {} + + /** + * (PHP >= 5.3.0, PECL phar >= 1.0.0)+ * The alias that can be used in phar:// URLs to + * refer to this archive, rather than its full path. + *
+ * @param int $offset [optional]+ * Unused variable, here for compatibility with PEAR's PHP_Archive. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + final public static function mapPhar(?string $alias = null, int $offset = 0) {} + + /** + * (PHP >= 5.3.0, PECL phar >= 2.0.0)+ * If FALSE, the full path on disk to the phar + * archive is returned. If TRUE, a full phar URL is returned. + *
+ * @return string the filename if valid, empty string otherwise. + */ + final public static function running(bool $returnPhar = true) {} + + /** + * (PHP >= 5.3.0, PECL phar >= 2.0.0)+ * The internal path within the phar archive to use as the mounted path location. + * This must be a relative path within the phar archive, and must not already exist. + *
+ * @param string $externalPath+ * A path or URL to an external file or directory to mount within the phar archive + *
+ * @return void No return. PharException is thrown on failure. + */ + final public static function mount(string $pharPath, string $externalPath) {} + + /** + * (Unknown)+ * an array containing as string indices any of + * REQUEST_URI, PHP_SELF, + * SCRIPT_NAME and SCRIPT_FILENAME. + * Other values trigger an exception, and Phar::mungServer + * is case-sensitive. + *
+ * @return void No return. + */ + final public static function mungServer(array $variables) {} + + /** + * (PHP >= 5.3.0, PECL phar >= 2.0.0)+ * The path on disk to the phar archive. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + final public static function unlinkArchive(string $filename) {} + + /** + * (PHP >= 5.3.0, PECL phar >= 2.0.0)+ * The alias that can be used in phar:// URLs to + * refer to this archive, rather than its full path. + *
+ * @param string|null $index [optional]+ * The location within the phar of the directory index. + *
+ * @param null|string $fileNotFoundScript [optional]+ * The location of the script to run when a file is not found. This + * script should output the proper HTTP 404 headers. + *
+ * @param null|array $mimeTypes [optional]
+ * An array mapping additional file extensions to MIME type.
+ * If the default mapping is sufficient, pass an empty array.
+ * By default, these extensions are mapped to these MIME types:
+ *
+ * $mimes = array(
+ * 'phps' => Phar::PHPS, // pass to highlight_file()
+ * 'c' => 'text/plain',
+ * 'cc' => 'text/plain',
+ * 'cpp' => 'text/plain',
+ * 'c++' => 'text/plain',
+ * 'dtd' => 'text/plain',
+ * 'h' => 'text/plain',
+ * 'log' => 'text/plain',
+ * 'rng' => 'text/plain',
+ * 'txt' => 'text/plain',
+ * 'xsd' => 'text/plain',
+ * 'php' => Phar::PHP, // parse as PHP
+ * 'inc' => Phar::PHP, // parse as PHP
+ * 'avi' => 'video/avi',
+ * 'bmp' => 'image/bmp',
+ * 'css' => 'text/css',
+ * 'gif' => 'image/gif',
+ * 'htm' => 'text/html',
+ * 'html' => 'text/html',
+ * 'htmls' => 'text/html',
+ * 'ico' => 'image/x-ico',
+ * 'jpe' => 'image/jpeg',
+ * 'jpg' => 'image/jpeg',
+ * 'jpeg' => 'image/jpeg',
+ * 'js' => 'application/x-javascript',
+ * 'midi' => 'audio/midi',
+ * 'mid' => 'audio/midi',
+ * 'mod' => 'audio/mod',
+ * 'mov' => 'movie/quicktime',
+ * 'mp3' => 'audio/mp3',
+ * 'mpg' => 'video/mpeg',
+ * 'mpeg' => 'video/mpeg',
+ * 'pdf' => 'application/pdf',
+ * 'png' => 'image/png',
+ * 'swf' => 'application/shockwave-flash',
+ * 'tif' => 'image/tiff',
+ * 'tiff' => 'image/tiff',
+ * 'wav' => 'audio/wav',
+ * 'xbm' => 'image/xbm',
+ * 'xml' => 'text/xml',
+ * );
+ *
+ *
+ * The rewrites function is passed a string as its only parameter and must return a string or FALSE. + *
+ *+ * If you are using fast-cgi or cgi then the parameter passed to the function is the value of the + * $_SERVER['PATH_INFO'] variable. Otherwise, the parameter passed to the function is the value + * of the $_SERVER['REQUEST_URI'] variable. + *
+ *+ * If a string is returned it is used as the internal file path. If FALSE is returned then webPhar() will + * send a HTTP 403 Denied Code. + *
+ * @return void No value is returned. + */ + final public static function webPhar(?string $alias = null, + ?string $index = "index.php", + #[LanguageLevelTypeAware(['8.0' => '?string'], default: 'string')] $fileNotFoundScript = null, + array $mimeTypes = null, + ?callable $rewrite = null) {} + + /** + * Returns whether current entry is a directory and not '.' or '..' + * @link https://php.net/manual/en/recursivedirectoryiterator.haschildren.php + * @param bool $allow_links [optional]+ *
+ * @return bool whether the current entry is a directory, but not '.' or '..' + */ + public function hasChildren($allow_links = false) {} + + /** + * Returns an iterator for the current entry if it is a directory + * @link https://php.net/manual/en/recursivedirectoryiterator.getchildren.php + * @return mixed The filename, file information, or $this depending on the set flags. + * See the FilesystemIterator + * constants. + */ + public function getChildren() {} + + /** + * Rewinds back to the beginning + * @link https://php.net/manual/en/filesystemiterator.rewind.php + * @return void No value is returned. + */ + public function rewind() {} + + /** + * Move to the next file + * @link https://php.net/manual/en/filesystemiterator.next.php + * @return void No value is returned. + */ + public function next() {} + + /** + * Retrieve the key for the current file + * @link https://php.net/manual/en/filesystemiterator.key.php + * @return string the pathname or filename depending on the set flags. + * See the FilesystemIterator constants. + */ + public function key() {} + + /** + * The current file + * @link https://php.net/manual/en/filesystemiterator.current.php + * @return mixed The filename, file information, or $this depending on the set flags. + * See the FilesystemIterator constants. + */ + public function current() {} + + /** + * Check whether current DirectoryIterator position is a valid file + * @link https://php.net/manual/en/directoryiterator.valid.php + * @return bool TRUE if the position is valid, otherwise FALSE + */ + public function valid() {} + + /** + * Seek to a DirectoryIterator item + * @link https://php.net/manual/en/directoryiterator.seek.php + * @param int $position+ * The zero-based numeric position to seek to. + *
+ * @return void No value is returned. + */ + public function seek($position) {} + + public function _bad_state_ex() {} } /** @@ -893,138 +890,132 @@ public function _bad_state_ex (){} * phar.readonly php.ini setting is 1. * @link https://php.net/manual/en/class.phardata.php */ -class PharData extends Phar { - - /** - * (PHP >= 5.3.0, PECL phar >= 2.0.0)- * Path to an existing tar/zip archive or to-be-created archive - *
- * @param int $flags [optional]- * Flags to pass to Phar parent class - * RecursiveDirectoryIterator. - *
- * @param string $alias [optional]- * Alias with which this Phar archive should be referred to in calls to stream - * functionality. - *
- * @param int $format [optional]- * One of the - * file format constants - * available within the Phar class. - *
- */ - public function __construct ($filename, $flags = FilesystemIterator::KEY_AS_PATHNAME|FilesystemIterator::CURRENT_AS_FILEINFO, $alias = null, $format = Phar::TAR) {} - - /** - * @param string $localName - * @return bool - */ - public function offsetExists ($localName) {} - - /** - * @param string $localName - * @return string - */ - public function offsetGet ($localName) {} - - /** - * (PHP >= 5.3.0, PECL phar >= 2.0.0)- * The filename (relative path) to modify in a tar or zip archive. - *
- * @param string $value- * Content of the file. - *
- * @return void No return values. - */ - public function offsetSet ($localName, $value) {} - - /** - * (PHP >= 5.3.0, PECL phar >= 2.0.0)- * The filename (relative path) to modify in the tar/zip archive. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function offsetUnset ($localName) {} - - - /** - * Returns whether current entry is a directory and not '.' or '..' - * @link https://php.net/manual/en/recursivedirectoryiterator.haschildren.php - * @param bool $allow_links [optional]- *
- * @return bool whether the current entry is a directory, but not '.' or '..' - */ - public function hasChildren ($allow_links = false) {} - - /** - * Returns an iterator for the current entry if it is a directory - * @link https://php.net/manual/en/recursivedirectoryiterator.getchildren.php - * @return mixed The filename, file information, or $this depending on the set flags. - * See the FilesystemIterator - * constants. - */ - public function getChildren () {} - - - /** - * Rewinds back to the beginning - * @link https://php.net/manual/en/filesystemiterator.rewind.php - * @return void No value is returned. - */ - public function rewind () {} - - /** - * Move to the next file - * @link https://php.net/manual/en/filesystemiterator.next.php - * @return void No value is returned. - */ - public function next () {} - - /** - * Retrieve the key for the current file - * @link https://php.net/manual/en/filesystemiterator.key.php - * @return string the pathname or filename depending on the set flags. - * See the FilesystemIterator constants. - */ - public function key () {} - - /** - * The current file - * @link https://php.net/manual/en/filesystemiterator.current.php - * @return mixed The filename, file information, or $this depending on the set flags. - * See the FilesystemIterator constants. - */ - public function current () {} - - - - /** - * Check whether current DirectoryIterator position is a valid file - * @link https://php.net/manual/en/directoryiterator.valid.php - * @return bool TRUE if the position is valid, otherwise FALSE - */ - public function valid () {} - - /** - * Seek to a DirectoryIterator item - * @link https://php.net/manual/en/directoryiterator.seek.php - * @param int $position- * The zero-based numeric position to seek to. - *
- * @return void No value is returned. - */ - public function seek ($position) {} - - +class PharData extends Phar +{ + /** + * (PHP >= 5.3.0, PECL phar >= 2.0.0)+ * Path to an existing tar/zip archive or to-be-created archive + *
+ * @param int $flags [optional]+ * Flags to pass to Phar parent class + * RecursiveDirectoryIterator. + *
+ * @param string $alias [optional]+ * Alias with which this Phar archive should be referred to in calls to stream + * functionality. + *
+ * @param int $format [optional]+ * One of the + * file format constants + * available within the Phar class. + *
+ */ + public function __construct($filename, $flags = FilesystemIterator::KEY_AS_PATHNAME|FilesystemIterator::CURRENT_AS_FILEINFO, $alias = null, $format = Phar::TAR) {} + + /** + * @param string $localName + * @return bool + */ + public function offsetExists($localName) {} + + /** + * @param string $localName + * @return string + */ + public function offsetGet($localName) {} + + /** + * (PHP >= 5.3.0, PECL phar >= 2.0.0)+ * The filename (relative path) to modify in a tar or zip archive. + *
+ * @param string $value+ * Content of the file. + *
+ * @return void No return values. + */ + public function offsetSet($localName, $value) {} + + /** + * (PHP >= 5.3.0, PECL phar >= 2.0.0)+ * The filename (relative path) to modify in the tar/zip archive. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function offsetUnset($localName) {} + + /** + * Returns whether current entry is a directory and not '.' or '..' + * @link https://php.net/manual/en/recursivedirectoryiterator.haschildren.php + * @param bool $allow_links [optional]+ *
+ * @return bool whether the current entry is a directory, but not '.' or '..' + */ + public function hasChildren($allow_links = false) {} + + /** + * Returns an iterator for the current entry if it is a directory + * @link https://php.net/manual/en/recursivedirectoryiterator.getchildren.php + * @return mixed The filename, file information, or $this depending on the set flags. + * See the FilesystemIterator + * constants. + */ + public function getChildren() {} + + /** + * Rewinds back to the beginning + * @link https://php.net/manual/en/filesystemiterator.rewind.php + * @return void No value is returned. + */ + public function rewind() {} + + /** + * Move to the next file + * @link https://php.net/manual/en/filesystemiterator.next.php + * @return void No value is returned. + */ + public function next() {} + + /** + * Retrieve the key for the current file + * @link https://php.net/manual/en/filesystemiterator.key.php + * @return string the pathname or filename depending on the set flags. + * See the FilesystemIterator constants. + */ + public function key() {} + + /** + * The current file + * @link https://php.net/manual/en/filesystemiterator.current.php + * @return mixed The filename, file information, or $this depending on the set flags. + * See the FilesystemIterator constants. + */ + public function current() {} + + /** + * Check whether current DirectoryIterator position is a valid file + * @link https://php.net/manual/en/directoryiterator.valid.php + * @return bool TRUE if the position is valid, otherwise FALSE + */ + public function valid() {} + + /** + * Seek to a DirectoryIterator item + * @link https://php.net/manual/en/directoryiterator.seek.php + * @param int $position+ * The zero-based numeric position to seek to. + *
+ * @return void No value is returned. + */ + public function seek($position) {} } /** @@ -1032,139 +1023,137 @@ public function seek ($position) {} * and attributes of a single file within a phar archive. * @link https://php.net/manual/en/class.pharfileinfo.php */ -class PharFileInfo extends SplFileInfo { - - /** - * (PHP >= 5.3.0, PECL phar >= 1.0.0)- * The full url to retrieve a file. If you wish to retrieve the information - * for the file my/file.php from the phar boo.phar, - * the entry should be phar://boo.phar/my/file.php. - *
- */ - public function __construct ($filename) {} - - public function __destruct () {} - - /** - * (PHP >= 5.3.0, PECL phar >= 1.0.0)- * permissions (see chmod) - *
- * @return void No value is returned. - */ - public function chmod ($perms) {} - - /** - * (PHP >= 5.3.0, PECL phar >= 2.0.0)- * One of Phar::GZ or Phar::BZ2, - * defaults to any compression. - *
- * @return bool TRUE if the file is compressed within the Phar archive, FALSE if not. - */ - public function isCompressed ($compression = 9021976) {} - - /** - * (PHP >= 5.3.0, PECL phar >= 1.0.0)- * Any PHP variable containing information to store alongside a file - *
- * @return void No value is returned. - */ - public function setMetadata ($metadata) {} - +class PharFileInfo extends SplFileInfo +{ + /** + * (PHP >= 5.3.0, PECL phar >= 1.0.0)+ * The full url to retrieve a file. If you wish to retrieve the information + * for the file my/file.php from the phar boo.phar, + * the entry should be phar://boo.phar/my/file.php. + *
+ */ + public function __construct($filename) {} + + public function __destruct() {} + + /** + * (PHP >= 5.3.0, PECL phar >= 1.0.0)+ * permissions (see chmod) + *
+ * @return void No value is returned. + */ + public function chmod($perms) {} + + /** + * (PHP >= 5.3.0, PECL phar >= 2.0.0)+ * One of Phar::GZ or Phar::BZ2, + * defaults to any compression. + *
+ * @return bool TRUE if the file is compressed within the Phar archive, FALSE if not. + */ + public function isCompressed($compression = 9021976) {} + + /** + * (PHP >= 5.3.0, PECL phar >= 1.0.0)+ * Any PHP variable containing information to store alongside a file + *
+ * @return void No value is returned. + */ + public function setMetadata($metadata) {} } // End of Phar v.2.0.1 -?> diff --git a/Reflection/Reflection.php b/Reflection/Reflection.php index 26e1f1f62..b125de56e 100644 --- a/Reflection/Reflection.php +++ b/Reflection/Reflection.php @@ -16,9 +16,7 @@ class Reflection * @param int $modifiers Bitfield of the modifiers to get. * @return array An array of modifier names. */ - public static function getModifierNames($modifiers) - { - } + public static function getModifierNames($modifiers) {} /** * Exports @@ -32,7 +30,5 @@ public static function getModifierNames($modifiers) * @removed 8.0 */ #[Deprecated(since: '7.4')] - public static function export(Reflector $reflector, $return = false) - { - } + public static function export(Reflector $reflector, $return = false) {} } diff --git a/Reflection/ReflectionAttribute.php b/Reflection/ReflectionAttribute.php index 83d24e952..d06c93371 100644 --- a/Reflection/ReflectionAttribute.php +++ b/Reflection/ReflectionAttribute.php @@ -15,15 +15,13 @@ class ReflectionAttribute * * @since 8.0 */ - const IS_INSTANCEOF = 2; + public const IS_INSTANCEOF = 2; /** * ReflectionAttribute cannot be created explicitly. * @since 8.0 */ - private function __construct() - { - } + private function __construct() {} /** * Gets attribute name @@ -32,9 +30,7 @@ private function __construct() * @since 8.0 */ #[Pure] - public function getName() - { - } + public function getName() {} /** * Returns the target of the attribute as a bit mask format. @@ -43,9 +39,7 @@ public function getName() * @since 8.0 */ #[Pure] - public function getTarget() - { - } + public function getTarget() {} /** * Returns {@see true} if the attribute is repeated. @@ -54,9 +48,7 @@ public function getTarget() * @since 8.0 */ #[Pure] - public function isRepeated() - { - } + public function isRepeated() {} /** * Gets list of passed attribute's arguments. @@ -65,9 +57,7 @@ public function isRepeated() * @since 8.0 */ #[Pure] - public function getArguments() - { - } + public function getArguments() {} /** * Creates a new instance of the attribute with passed arguments @@ -75,9 +65,7 @@ public function getArguments() * @return object * @since 8.0 */ - public function newInstance() - { - } + public function newInstance() {} /** * ReflectionAttribute cannot be cloned @@ -85,7 +73,5 @@ public function newInstance() * @return void * @since 8.0 */ - private function __clone() - { - } + private function __clone() {} } diff --git a/Reflection/ReflectionClass.php b/Reflection/ReflectionClass.php index 37073f19c..50e8783fb 100644 --- a/Reflection/ReflectionClass.php +++ b/Reflection/ReflectionClass.php @@ -22,21 +22,21 @@ class ReflectionClass implements Reflector * * @link https://www.php.net/manual/en/class.reflectionclass.php#reflectionclass.constants.is-implicit-abstract */ - const IS_IMPLICIT_ABSTRACT = 16; + public const IS_IMPLICIT_ABSTRACT = 16; /** * Indicates class that is abstract because of its definition. * * @link https://www.php.net/manual/en/class.reflectionclass.php#reflectionclass.constants.is-explicit-abstract */ - const IS_EXPLICIT_ABSTRACT = 64; + public const IS_EXPLICIT_ABSTRACT = 64; /** * Indicates final class. * * @link https://www.php.net/manual/en/class.reflectionclass.php#reflectionclass.constants.is-final */ - const IS_FINAL = 32; + public const IS_FINAL = 32; /** * Constructs a ReflectionClass @@ -46,9 +46,7 @@ class ReflectionClass implements Reflector * the class to reflect, or an object. * @throws \ReflectionException if the class does not exist. */ - public function __construct($objectOrClass) - { - } + public function __construct($objectOrClass) {} /** * Exports a reflected class @@ -62,9 +60,7 @@ public function __construct($objectOrClass) * @removed 8.0 */ #[Deprecated(since: '7.4')] - public static function export($argument, $return = false) - { - } + public static function export($argument, $return = false) {} /** * Returns the string representation of the ReflectionClass object. @@ -72,9 +68,7 @@ public static function export($argument, $return = false) * @link https://php.net/manual/en/reflectionclass.tostring.php * @return string A string representation of this {@see ReflectionClass} instance. */ - public function __toString() - { - } + public function __toString() {} /** * Gets class name @@ -83,9 +77,7 @@ public function __toString() * @return string The class name. */ #[Pure] - public function getName() - { - } + public function getName() {} /** * Checks if class is defined internally by an extension, or the core @@ -94,9 +86,7 @@ public function getName() * @return bool Returns {@see true} on success or {@see false} on failure. */ #[Pure] - public function isInternal() - { - } + public function isInternal() {} /** * Checks if user defined @@ -105,9 +95,7 @@ public function isInternal() * @return bool Returns {@see true} on success or {@see false} on failure. */ #[Pure] - public function isUserDefined() - { - } + public function isUserDefined() {} /** * Checks if the class is instantiable @@ -116,9 +104,7 @@ public function isUserDefined() * @return bool Returns {@see true} on success or {@see false} on failure. */ #[Pure] - public function isInstantiable() - { - } + public function isInstantiable() {} /** * Returns whether this class is cloneable @@ -128,9 +114,7 @@ public function isInstantiable() * @since 5.4 */ #[Pure] - public function isCloneable() - { - } + public function isCloneable() {} /** * Gets the filename of the file in which the class has been defined @@ -141,9 +125,7 @@ public function isCloneable() * is returned. */ #[Pure] - public function getFileName() - { - } + public function getFileName() {} /** * Gets starting line number @@ -152,9 +134,7 @@ public function getFileName() * @return int The starting line number, as an integer. */ #[Pure] - public function getStartLine() - { - } + public function getStartLine() {} /** * Gets end line @@ -164,9 +144,7 @@ public function getStartLine() * {@see false} if unknown. */ #[Pure] - public function getEndLine() - { - } + public function getEndLine() {} /** * Gets doc comments @@ -175,9 +153,7 @@ public function getEndLine() * @return string|false The doc comment if it exists, otherwise {@see false} */ #[Pure] - public function getDocComment() - { - } + public function getDocComment() {} /** * Gets the constructor of the class @@ -187,9 +163,7 @@ public function getDocComment() * the class' constructor, or {@see null} if the class has no constructor. */ #[Pure] - public function getConstructor() - { - } + public function getConstructor() {} /** * Checks if method is defined @@ -198,9 +172,7 @@ public function getConstructor() * @param string $name Name of the method being checked for. * @return bool Returns {@see true} if it has the method, otherwise {@see false} */ - public function hasMethod($name) - { - } + public function hasMethod($name) {} /** * Gets a ReflectionMethod for a class method. @@ -211,9 +183,7 @@ public function hasMethod($name) * @throws \ReflectionException if the method does not exist. */ #[Pure] - public function getMethod($name) - { - } + public function getMethod($name) {} /** * Gets an array of methods for the class. @@ -225,9 +195,7 @@ public function getMethod($name) * reflecting each method. */ #[Pure] - public function getMethods($filter = null) - { - } + public function getMethods($filter = null) {} /** * Checks if property is defined @@ -236,9 +204,7 @@ public function getMethods($filter = null) * @param string $name Name of the property being checked for. * @return bool Returns {@see true} if it has the property, otherwise {@see false} */ - public function hasProperty($name) - { - } + public function hasProperty($name) {} /** * Gets a ReflectionProperty for a class's property @@ -249,9 +215,7 @@ public function hasProperty($name) * @throws ReflectionException If no property exists by that name. */ #[Pure] - public function getProperty($name) - { - } + public function getProperty($name) {} /** * Gets properties @@ -263,9 +227,7 @@ public function getProperty($name) * @return ReflectionProperty[] */ #[Pure] - public function getProperties($filter = null) - { - } + public function getProperties($filter = null) {} /** * Gets a ReflectionClassConstant for a class's property @@ -276,9 +238,7 @@ public function getProperties($filter = null) * @since 7.1 */ #[Pure] - public function getReflectionConstant(string $name) - { - } + public function getReflectionConstant(string $name) {} /** * Gets class constants @@ -289,9 +249,7 @@ public function getReflectionConstant(string $name) * @since 7.1 */ #[Pure] - public function getReflectionConstants(?int $filter = ReflectionClassConstant::IS_PUBLIC | ReflectionClassConstant::IS_PROTECTED | ReflectionClassConstant::IS_PRIVATE) - { - } + public function getReflectionConstants(?int $filter = ReflectionClassConstant::IS_PUBLIC|ReflectionClassConstant::IS_PROTECTED|ReflectionClassConstant::IS_PRIVATE) {} /** * Checks if constant is defined @@ -300,9 +258,7 @@ public function getReflectionConstants(?int $filter = ReflectionClassConstant::I * @param string $name The name of the constant being checked for. * @return bool Returns {@see true} if the constant is defined, otherwise {@see false} */ - public function hasConstant($name) - { - } + public function hasConstant($name) {} /** * Gets constants @@ -313,9 +269,7 @@ public function hasConstant($name) * the values the value of the constants. */ #[Pure] - public function getConstants($filter = ReflectionClassConstant::IS_PUBLIC | ReflectionClassConstant::IS_PROTECTED | ReflectionClassConstant::IS_PRIVATE) - { - } + public function getConstants($filter = ReflectionClassConstant::IS_PUBLIC|ReflectionClassConstant::IS_PROTECTED|ReflectionClassConstant::IS_PRIVATE) {} /** * Gets defined constant @@ -326,9 +280,7 @@ public function getConstants($filter = ReflectionClassConstant::IS_PUBLIC | Refl * Returns {@see false} if the constant was not found in the class. */ #[Pure] - public function getConstant($name) - { - } + public function getConstant($name) {} /** * Gets the interfaces @@ -338,9 +290,7 @@ public function getConstant($name) * names and the array values as {@see ReflectionClass} objects. */ #[Pure] - public function getInterfaces() - { - } + public function getInterfaces() {} /** * Gets the interface names @@ -349,9 +299,7 @@ public function getInterfaces() * @return string[] A numerical array with interface names as the values. */ #[Pure] - public function getInterfaceNames() - { - } + public function getInterfaceNames() {} /** * Checks if the class is anonymous @@ -361,9 +309,7 @@ public function getInterfaceNames() * @since 7.0 */ #[Pure] - public function isAnonymous() - { - } + public function isAnonymous() {} /** * Checks if the class is an interface @@ -372,9 +318,7 @@ public function isAnonymous() * @return bool Returns {@see true} on success or {@see false} on failure. */ #[Pure] - public function isInterface() - { - } + public function isInterface() {} /** * Returns an array of traits used by this class @@ -386,9 +330,7 @@ public function isInterface() * @since 5.4 */ #[Pure] - public function getTraits() - { - } + public function getTraits() {} /** * Returns an array of names of traits used by this class @@ -399,9 +341,7 @@ public function getTraits() * @since 5.4 */ #[Pure] - public function getTraitNames() - { - } + public function getTraitNames() {} /** * Returns an array of trait aliases @@ -413,9 +353,7 @@ public function getTraitNames() * @since 5.4 */ #[Pure] - public function getTraitAliases() - { - } + public function getTraitAliases() {} /** * Returns whether this is a trait @@ -426,9 +364,7 @@ public function getTraitAliases() * @since 5.4 */ #[Pure] - public function isTrait() - { - } + public function isTrait() {} /** * Checks if class is abstract @@ -437,9 +373,7 @@ public function isTrait() * @return bool Returns {@see true} on success or {@see false} on failure. */ #[Pure] - public function isAbstract() - { - } + public function isAbstract() {} /** * Checks if class is final @@ -448,9 +382,7 @@ public function isAbstract() * @return bool Returns {@see true} on success or {@see false} on failure. */ #[Pure] - public function isFinal() - { - } + public function isFinal() {} /** * Gets modifiers @@ -459,9 +391,7 @@ public function isFinal() * @return int bitmask of modifier constants. */ #[Pure] - public function getModifiers() - { - } + public function getModifiers() {} /** * Checks class for instance @@ -471,9 +401,7 @@ public function getModifiers() * @return bool Returns {@see true} on success or {@see false} on failure. */ #[Pure] - public function isInstance($object) - { - } + public function isInstance($object) {} /** * Creates a new class instance from given arguments. @@ -486,9 +414,7 @@ public function isInstance($object) * the class does not have a constructor and the $args parameter contains * one or more parameters. */ - public function newInstance(...$args) - { - } + public function newInstance(...$args) {} /** * Creates a new class instance without invoking the constructor. @@ -500,9 +426,7 @@ public function newInstance(...$args) * onwards, this exception is limited only to internal classes that are final. * @since 5.4 */ - public function newInstanceWithoutConstructor() - { - } + public function newInstanceWithoutConstructor() {} /** * Creates a new class instance from given arguments. @@ -515,9 +439,7 @@ public function newInstanceWithoutConstructor() * one or more parameters. * @since 5.1.3 */ - public function newInstanceArgs(array $args = []) - { - } + public function newInstanceArgs(array $args = []) {} /** * Gets parent class @@ -527,9 +449,7 @@ public function newInstanceArgs(array $args = []) * if there's no parent. */ #[Pure] - public function getParentClass() - { - } + public function getParentClass() {} /** * Checks if a subclass @@ -540,9 +460,7 @@ public function getParentClass() * @return bool {@see true} on success or {@see false} on failure. */ #[Pure] - public function isSubclassOf($class) - { - } + public function isSubclassOf($class) {} /** * Gets static properties @@ -552,9 +470,7 @@ public function isSubclassOf($class) * the name and the values the value of the properties. */ #[Pure] - public function getStaticProperties() - { - } + public function getStaticProperties() {} /** * Gets static property value @@ -567,9 +483,7 @@ public function getStaticProperties() * @return mixed The value of the static property. */ #[Pure] - public function getStaticPropertyValue($name, $default = null) - { - } + public function getStaticPropertyValue($name, $default = null) {} /** * Sets static property value @@ -579,9 +493,7 @@ public function getStaticPropertyValue($name, $default = null) * @param mixed $value New property value. * @return void No value is returned. */ - public function setStaticPropertyValue($name, $value) - { - } + public function setStaticPropertyValue($name, $value) {} /** * Gets default properties @@ -594,9 +506,7 @@ public function setStaticPropertyValue($name, $value) * not take visibility modifiers into account. */ #[Pure] - public function getDefaultProperties() - { - } + public function getDefaultProperties() {} /** * An alias of {@see ReflectionClass::isIterable} method. @@ -605,9 +515,7 @@ public function getDefaultProperties() * @return bool Returns {@see true} on success or {@see false} on failure. */ #[Pure] - public function isIterateable() - { - } + public function isIterateable() {} /** * Check whether this class is iterable @@ -617,9 +525,7 @@ public function isIterateable() * @since 7.2 */ #[Pure] - public function isIterable() - { - } + public function isIterable() {} /** * Checks whether it implements an interface. @@ -628,9 +534,7 @@ public function isIterable() * @param string $interface The interface name. * @return bool Returns {@see true} on success or {@see false} on failure. */ - public function implementsInterface($interface) - { - } + public function implementsInterface($interface) {} /** * Gets a ReflectionExtension object for the extension which defined the class @@ -640,9 +544,7 @@ public function implementsInterface($interface) * the extension which defined the class, or {@see null} for user-defined classes. */ #[Pure] - public function getExtension() - { - } + public function getExtension() {} /** * Gets the name of the extension which defined the class @@ -652,9 +554,7 @@ public function getExtension() * or {@see false} for user-defined classes. */ #[Pure] - public function getExtensionName() - { - } + public function getExtensionName() {} /** * Checks if in namespace @@ -662,9 +562,7 @@ public function getExtensionName() * @link https://php.net/manual/en/reflectionclass.innamespace.php * @return bool {@see true} on success or {@see false} on failure. */ - public function inNamespace() - { - } + public function inNamespace() {} /** * Gets namespace name @@ -673,9 +571,7 @@ public function inNamespace() * @return string The namespace name. */ #[Pure] - public function getNamespaceName() - { - } + public function getNamespaceName() {} /** * Gets short name @@ -684,9 +580,7 @@ public function getNamespaceName() * @return string The class short name. */ #[Pure] - public function getShortName() - { - } + public function getShortName() {} /** * Returns an array of function attributes. @@ -697,9 +591,7 @@ public function getShortName() * @since 8.0 */ #[Pure] - public function getAttributes(?string $name = null, int $flags = 0) - { - } + public function getAttributes(?string $name = null, int $flags = 0) {} /** * Clones object @@ -707,8 +599,5 @@ public function getAttributes(?string $name = null, int $flags = 0) * @link https://php.net/manual/en/reflectionclass.clone.php * @return void */ - final private function __clone() - { - } - + final private function __clone() {} } diff --git a/Reflection/ReflectionClassConstant.php b/Reflection/ReflectionClassConstant.php index bee136f9b..006a44fb4 100644 --- a/Reflection/ReflectionClassConstant.php +++ b/Reflection/ReflectionClassConstant.php @@ -29,21 +29,21 @@ class ReflectionClassConstant implements Reflector * * @since 8.0 */ - const IS_PUBLIC = 1; + public const IS_PUBLIC = 1; /** * Indicates that the constant is protected. * * @since 8.0 */ - const IS_PROTECTED = 2; + public const IS_PROTECTED = 2; /** * Indicates that the constant is private. * * @since 8.0 */ - const IS_PRIVATE = 4; + public const IS_PRIVATE = 4; /** * ReflectionClassConstant constructor. @@ -53,9 +53,7 @@ class ReflectionClassConstant implements Reflector * @since 7.1 * @link https://php.net/manual/en/reflectionclassconstant.construct.php */ - public function __construct($class, string $constant) - { - } + public function __construct($class, string $constant) {} /** * @link https://php.net/manual/en/reflectionclassconstant.export.php @@ -68,9 +66,7 @@ public function __construct($class, string $constant) * @removed 8.0 */ #[Deprecated(since: '7.4')] - public static function export($class, $name, $return = false) - { - } + public static function export($class, $name, $return = false) {} /** * Gets declaring class @@ -80,9 +76,7 @@ public static function export($class, $name, $return = false) * @since 7.1 */ #[Pure] - public function getDeclaringClass() - { - } + public function getDeclaringClass() {} /** * Gets doc comments @@ -92,9 +86,7 @@ public function getDeclaringClass() * @since 7.1 */ #[Pure] - public function getDocComment() - { - } + public function getDocComment() {} /** * Gets the class constant modifiers @@ -105,9 +97,7 @@ public function getDocComment() * @since 7.1 */ #[Pure] - public function getModifiers() - { - } + public function getModifiers() {} /** * Get name of the constant @@ -117,9 +107,7 @@ public function getModifiers() * @since 7.1 */ #[Pure] - public function getName() - { - } + public function getName() {} /** * Gets value @@ -129,9 +117,7 @@ public function getName() * @since 7.1 */ #[Pure] - public function getValue() - { - } + public function getValue() {} /** * Checks if class constant is private @@ -141,9 +127,7 @@ public function getValue() * @since 7.1 */ #[Pure] - public function isPrivate() - { - } + public function isPrivate() {} /** * Checks if class constant is protected @@ -153,9 +137,7 @@ public function isPrivate() * @since 7.1 */ #[Pure] - public function isProtected() - { - } + public function isProtected() {} /** * Checks if class constant is public @@ -165,9 +147,7 @@ public function isProtected() * @since 7.1 */ #[Pure] - public function isPublic() - { - } + public function isPublic() {} /** * Returns the string representation of the ReflectionClassConstant object. @@ -176,9 +156,7 @@ public function isPublic() * @return string * @since 7.1 */ - public function __toString() - { - } + public function __toString() {} /** * Returns an array of constant attributes. @@ -189,16 +167,12 @@ public function __toString() * @since 8.0 */ #[Pure] - public function getAttributes(?string $name = null, int $flags = 0) - { - } + public function getAttributes(?string $name = null, int $flags = 0) {} /** * ReflectionClassConstant cannot be cloned * * @return void */ - final private function __clone() - { - } + final private function __clone() {} } diff --git a/Reflection/ReflectionException.php b/Reflection/ReflectionException.php index fb64139ed..1e4bac921 100644 --- a/Reflection/ReflectionException.php +++ b/Reflection/ReflectionException.php @@ -5,6 +5,4 @@ * * @link https://php.net/manual/en/class.reflectionexception.php */ -class ReflectionException extends Exception -{ -} +class ReflectionException extends Exception {} diff --git a/Reflection/ReflectionExtension.php b/Reflection/ReflectionExtension.php index a37be4af7..e2255e5cb 100644 --- a/Reflection/ReflectionExtension.php +++ b/Reflection/ReflectionExtension.php @@ -11,7 +11,6 @@ */ class ReflectionExtension implements Reflector { - /** * @var string Name of the extension, same as calling the {@see ReflectionExtension::getName()} method */ @@ -25,9 +24,7 @@ class ReflectionExtension implements Reflector * @param string $name Name of the extension. * @throws \ReflectionException if the extension does not exist. */ - public function __construct($name) - { - } + public function __construct($name) {} /** * Exports a reflected extension. @@ -43,9 +40,7 @@ public function __construct($name) * @removed 8.0 */ #[Deprecated(since: '7.4')] - public static function export($name, $return = false) - { - } + public static function export($name, $return = false) {} /** * To string @@ -54,9 +49,7 @@ public static function export($name, $return = false) * @return string the exported extension as a string, in the same way as * the {@see ReflectionExtension::export()}. */ - public function __toString() - { - } + public function __toString() {} /** * Gets extension name @@ -65,9 +58,7 @@ public function __toString() * @return string The extensions name. */ #[Pure] - public function getName() - { - } + public function getName() {} /** * Gets extension version @@ -76,9 +67,7 @@ public function getName() * @return string The version of the extension. */ #[Pure] - public function getVersion() - { - } + public function getVersion() {} /** * Gets extension functions @@ -89,9 +78,7 @@ public function getVersion() * names. If no function are defined, an empty array is returned. */ #[Pure] - public function getFunctions() - { - } + public function getFunctions() {} /** * Gets constants @@ -100,9 +87,7 @@ public function getFunctions() * @return array An associative array with constant names as keys. */ #[Pure] - public function getConstants() - { - } + public function getConstants() {} /** * Gets extension ini entries @@ -112,9 +97,7 @@ public function getConstants() * with their defined values as values. */ #[Pure] - public function getINIEntries() - { - } + public function getINIEntries() {} /** * Gets classes @@ -125,9 +108,7 @@ public function getINIEntries() * an empty array is returned. */ #[Pure] - public function getClasses() - { - } + public function getClasses() {} /** * Gets class names @@ -137,9 +118,7 @@ public function getClasses() * If no classes are defined, an empty array is returned. */ #[Pure] - public function getClassNames() - { - } + public function getClassNames() {} /** * Gets dependencies @@ -149,9 +128,7 @@ public function getClassNames() * either Required, Optional or Conflicts as the values. */ #[Pure] - public function getDependencies() - { - } + public function getDependencies() {} /** * Print extension info @@ -159,9 +136,7 @@ public function getDependencies() * @link https://php.net/manual/en/reflectionextension.info.php * @return void Print extension info */ - public function info() - { - } + public function info() {} /** * Returns whether this extension is persistent @@ -171,9 +146,7 @@ public function info() * @since 5.4 */ #[Pure] - public function isPersistent() - { - } + public function isPersistent() {} /** * Returns whether this extension is temporary @@ -183,9 +156,7 @@ public function isPersistent() * @since 5.4 */ #[Pure] - public function isTemporary() - { - } + public function isTemporary() {} /** * Clones @@ -193,7 +164,5 @@ public function isTemporary() * @link https://php.net/manual/en/reflectionextension.clone.php * @return void No value is returned, if called a fatal error will occur. */ - final private function __clone() - { - } + final private function __clone() {} } diff --git a/Reflection/ReflectionFunction.php b/Reflection/ReflectionFunction.php index 57021a2b3..b845f76e0 100644 --- a/Reflection/ReflectionFunction.php +++ b/Reflection/ReflectionFunction.php @@ -23,7 +23,7 @@ class ReflectionFunction extends ReflectionFunctionAbstract * * @link https://www.php.net/manual/en/class.reflectionfunction.php#reflectionfunction.constants.is-deprecated */ - const IS_DEPRECATED = 2048; + public const IS_DEPRECATED = 2048; /** * Constructs a ReflectionFunction object @@ -32,18 +32,14 @@ class ReflectionFunction extends ReflectionFunctionAbstract * @param string|Closure $function The name of the function to reflect or a closure. * @throws ReflectionException if the function does not exist. */ - public function __construct($function) - { - } + public function __construct($function) {} /** * Returns the string representation of the ReflectionFunction object. * * @link https://php.net/manual/en/reflectionfunction.tostring.php */ - public function __toString() - { - } + public function __toString() {} /** * Exports function @@ -58,9 +54,7 @@ public function __toString() * @removed 8.0 */ #[Deprecated(since: '7.4')] - public static function export($name, $return = false) - { - } + public static function export($name, $return = false) {} /** * Checks if function is disabled @@ -70,9 +64,7 @@ public static function export($name, $return = false) */ #[Deprecated(since: '8.0')] #[Pure] - public function isDisabled() - { - } + public function isDisabled() {} /** * Invokes function @@ -83,9 +75,7 @@ public function isDisabled() * like {@see call_user_func} is. * @return mixed Returns the result of the invoked function call. */ - public function invoke(...$args) - { - } + public function invoke(...$args) {} /** * Invokes function args @@ -95,9 +85,7 @@ public function invoke(...$args) * like {@see call_user_func_array} works. * @return mixed the result of the invoked function */ - public function invokeArgs(array $args) - { - } + public function invokeArgs(array $args) {} /** * Returns a dynamically created closure for the function @@ -106,7 +94,5 @@ public function invokeArgs(array $args) * @return Closure Returns {@see Closure} or {@see null} in case of an error. */ #[Pure] - public function getClosure() - { - } + public function getClosure() {} } diff --git a/Reflection/ReflectionFunctionAbstract.php b/Reflection/ReflectionFunctionAbstract.php index 07d1a3057..2299b73e8 100644 --- a/Reflection/ReflectionFunctionAbstract.php +++ b/Reflection/ReflectionFunctionAbstract.php @@ -23,9 +23,7 @@ abstract class ReflectionFunctionAbstract implements Reflector * @link https://php.net/manual/en/reflectionfunctionabstract.clone.php * @return void */ - final private function __clone() - { - } + final private function __clone() {} /** * Checks if function in namespace @@ -33,9 +31,7 @@ final private function __clone() * @link https://php.net/manual/en/reflectionfunctionabstract.innamespace.php * @return bool {@see true} if it's in a namespace, otherwise {@see false} */ - public function inNamespace() - { - } + public function inNamespace() {} /** * Checks if closure @@ -44,9 +40,7 @@ public function inNamespace() * @return bool {@see true} if it's a closure, otherwise {@see false} */ #[Pure] - public function isClosure() - { - } + public function isClosure() {} /** * Checks if deprecated @@ -55,9 +49,7 @@ public function isClosure() * @return bool {@see true} if it's deprecated, otherwise {@see false} */ #[Pure] - public function isDeprecated() - { - } + public function isDeprecated() {} /** * Checks if is internal @@ -66,9 +58,7 @@ public function isDeprecated() * @return bool {@see true} if it's internal, otherwise {@see false} */ #[Pure] - public function isInternal() - { - } + public function isInternal() {} /** * Checks if user defined @@ -77,9 +67,7 @@ public function isInternal() * @return bool {@see true} if it's user-defined, otherwise {@see false} */ #[Pure] - public function isUserDefined() - { - } + public function isUserDefined() {} /** * Returns whether this function is a generator @@ -89,9 +77,7 @@ public function isUserDefined() * @since 5.5 */ #[Pure] - public function isGenerator() - { - } + public function isGenerator() {} /** * Returns whether this function is variadic @@ -101,9 +87,7 @@ public function isGenerator() * @since 5.6 */ #[Pure] - public function isVariadic() - { - } + public function isVariadic() {} /** * Returns this pointer bound to closure @@ -112,9 +96,7 @@ public function isVariadic() * @return object|null Returns $this pointer or {@see null} in case of an error. */ #[Pure] - public function getClosureThis() - { - } + public function getClosureThis() {} /** * Returns the scope associated to the closure @@ -125,9 +107,7 @@ public function getClosureThis() * @since 5.4 */ #[Pure] - public function getClosureScopeClass() - { - } + public function getClosureScopeClass() {} /** * Gets doc comment @@ -136,9 +116,7 @@ public function getClosureScopeClass() * @return string|false The doc comment if it exists, otherwise {@see false} */ #[Pure] - public function getDocComment() - { - } + public function getDocComment() {} /** * Gets end line number @@ -148,9 +126,7 @@ public function getDocComment() * or {@see false} if unknown. */ #[Pure] - public function getEndLine() - { - } + public function getEndLine() {} /** * Gets extension info @@ -160,9 +136,7 @@ public function getEndLine() * {@see ReflectionExtension} object or {@see null} instead. */ #[Pure] - public function getExtension() - { - } + public function getExtension() {} /** * Gets extension name @@ -171,9 +145,7 @@ public function getExtension() * @return string|null The extension's name or {@see null} instead. */ #[Pure] - public function getExtensionName() - { - } + public function getExtensionName() {} /** * Gets file name @@ -182,9 +154,7 @@ public function getExtensionName() * @return string|false The file name or {@see false} in case of error. */ #[Pure] - public function getFileName() - { - } + public function getFileName() {} /** * Gets function name @@ -193,9 +163,7 @@ public function getFileName() * @return string The name of the function. */ #[Pure] - public function getName() - { - } + public function getName() {} /** * Gets namespace name @@ -204,9 +172,7 @@ public function getName() * @return string The namespace name. */ #[Pure] - public function getNamespaceName() - { - } + public function getNamespaceName() {} /** * Gets number of parameters @@ -216,9 +182,7 @@ public function getNamespaceName() * @since 5.0.3 */ #[Pure] - public function getNumberOfParameters() - { - } + public function getNumberOfParameters() {} /** * Gets number of required parameters @@ -228,9 +192,7 @@ public function getNumberOfParameters() * @since 5.0.3 */ #[Pure] - public function getNumberOfRequiredParameters() - { - } + public function getNumberOfRequiredParameters() {} /** * Gets parameters @@ -239,9 +201,7 @@ public function getNumberOfRequiredParameters() * @return ReflectionParameter[] The parameters, as a ReflectionParameter objects. */ #[Pure] - public function getParameters() - { - } + public function getParameters() {} /** * Gets the specified return type of a function @@ -252,9 +212,7 @@ public function getParameters() * @since 7.0 */ #[Pure] - public function getReturnType() - { - } + public function getReturnType() {} /** * Gets function short name @@ -263,9 +221,7 @@ public function getReturnType() * @return string The short name of the function. */ #[Pure] - public function getShortName() - { - } + public function getShortName() {} /** * Gets starting line number @@ -274,9 +230,7 @@ public function getShortName() * @return int The starting line number. */ #[Pure] - public function getStartLine() - { - } + public function getStartLine() {} /** * Gets static variables @@ -285,9 +239,7 @@ public function getStartLine() * @return array An array of static variables. */ #[Pure] - public function getStaticVariables() - { - } + public function getStaticVariables() {} /** * Checks if returns reference @@ -295,9 +247,7 @@ public function getStaticVariables() * @link https://php.net/manual/en/reflectionfunctionabstract.returnsreference.php * @return bool {@see true} if it returns a reference, otherwise {@see false} */ - public function returnsReference() - { - } + public function returnsReference() {} /** * Checks if the function has a specified return type @@ -307,9 +257,7 @@ public function returnsReference() * type, otherwise {@see false}. * @since 7.0 */ - public function hasReturnType() - { - } + public function hasReturnType() {} /** * Returns an array of function attributes. @@ -320,7 +268,5 @@ public function hasReturnType() * @since 8.0 */ #[Pure] - public function getAttributes(?string $name = null, int $flags = 0) - { - } + public function getAttributes(?string $name = null, int $flags = 0) {} } diff --git a/Reflection/ReflectionGenerator.php b/Reflection/ReflectionGenerator.php index b94a2c829..4d28acd1a 100644 --- a/Reflection/ReflectionGenerator.php +++ b/Reflection/ReflectionGenerator.php @@ -16,9 +16,7 @@ class ReflectionGenerator * @param Generator $generator A generator object. * @since 7.0 */ - public function __construct(Generator $generator) - { - } + public function __construct(Generator $generator) {} /** * Gets the currently executing line of the generator @@ -29,9 +27,7 @@ public function __construct(Generator $generator) * @since 7.0 */ #[Pure] - public function getExecutingLine() - { - } + public function getExecutingLine() {} /** * Gets the file name of the currently executing generator @@ -42,9 +38,7 @@ public function getExecutingLine() * @since 7.0 */ #[Pure] - public function getExecutingFile() - { - } + public function getExecutingFile() {} /** * Gets the trace of the executing generator @@ -63,10 +57,7 @@ public function getExecutingFile() * @since 7.0 */ #[Pure] - public function getTrace($options = DEBUG_BACKTRACE_PROVIDE_OBJECT) - { - } - + public function getTrace($options = DEBUG_BACKTRACE_PROVIDE_OBJECT) {} /** * Gets the function name of the generator @@ -78,9 +69,7 @@ public function getTrace($options = DEBUG_BACKTRACE_PROVIDE_OBJECT) * @since 7.0 */ #[Pure] - public function getFunction() - { - } + public function getFunction() {} /** * Gets the function name of the generator @@ -91,9 +80,7 @@ public function getFunction() * @since 7.0 */ #[Pure] - public function getThis() - { - } + public function getThis() {} /** * Gets the executing Generator object @@ -101,10 +88,7 @@ public function getThis() * @link https://php.net/manual/en/reflectiongenerator.construct.php * @return Generator Returns the currently executing Generator object. * @since 7.0 - * */ #[Pure] - public function getExecutingGenerator() - { - } + public function getExecutingGenerator() {} } diff --git a/Reflection/ReflectionMethod.php b/Reflection/ReflectionMethod.php index aaf94eef6..1c4b0845d 100644 --- a/Reflection/ReflectionMethod.php +++ b/Reflection/ReflectionMethod.php @@ -27,32 +27,32 @@ class ReflectionMethod extends ReflectionFunctionAbstract /** * Indicates that the method is static. */ - const IS_STATIC = 16; + public const IS_STATIC = 16; /** * Indicates that the method is public. */ - const IS_PUBLIC = 1; + public const IS_PUBLIC = 1; /** * Indicates that the method is protected. */ - const IS_PROTECTED = 2; + public const IS_PROTECTED = 2; /** * Indicates that the method is private. */ - const IS_PRIVATE = 4; + public const IS_PRIVATE = 4; /** * Indicates that the method is abstract. */ - const IS_ABSTRACT = 64; + public const IS_ABSTRACT = 64; /** * Indicates that the method is final. */ - const IS_FINAL = 32; + public const IS_FINAL = 32; /** * Constructs a ReflectionMethod @@ -71,9 +71,7 @@ class ReflectionMethod extends ReflectionFunctionAbstract * classname or an object. * @throws \ReflectionException if the class or method does not exist. */ - public function __construct($objectOrMethod, $method = null) - { - } + public function __construct($objectOrMethod, $method = null) {} /** * Export a reflection method. @@ -89,9 +87,7 @@ public function __construct($objectOrMethod, $method = null) * @removed 8.0 */ #[Deprecated(since: '7.4')] - public static function export($class, $name, $return = false) - { - } + public static function export($class, $name, $return = false) {} /** * Returns the string representation of the ReflectionMethod object. @@ -99,9 +95,7 @@ public static function export($class, $name, $return = false) * @link https://php.net/manual/en/reflectionmethod.tostring.php * @return string A string representation of this {@see ReflectionMethod} instance. */ - public function __toString() - { - } + public function __toString() {} /** * Checks if method is public @@ -110,9 +104,7 @@ public function __toString() * @return bool Returns {@see true} if the method is public, otherwise {@see false} */ #[Pure] - public function isPublic() - { - } + public function isPublic() {} /** * Checks if method is private @@ -121,9 +113,7 @@ public function isPublic() * @return bool Returns {@see true} if the method is private, otherwise {@see false} */ #[Pure] - public function isPrivate() - { - } + public function isPrivate() {} /** * Checks if method is protected @@ -132,9 +122,7 @@ public function isPrivate() * @return bool Returns {@see true} if the method is protected, otherwise {@see false} */ #[Pure] - public function isProtected() - { - } + public function isProtected() {} /** * Checks if method is abstract @@ -143,9 +131,7 @@ public function isProtected() * @return bool Returns {@see true} if the method is abstract, otherwise {@see false} */ #[Pure] - public function isAbstract() - { - } + public function isAbstract() {} /** * Checks if method is final @@ -154,9 +140,7 @@ public function isAbstract() * @return bool Returns {@see true} if the method is final, otherwise {@see false} */ #[Pure] - public function isFinal() - { - } + public function isFinal() {} /** * Checks if method is static @@ -165,9 +149,7 @@ public function isFinal() * @return bool Returns {@see true} if the method is static, otherwise {@see false} */ #[Pure] - public function isStatic() - { - } + public function isStatic() {} /** * Checks if method is a constructor @@ -176,9 +158,7 @@ public function isStatic() * @return bool Returns {@see true} if the method is a constructor, otherwise {@see false} */ #[Pure] - public function isConstructor() - { - } + public function isConstructor() {} /** * Checks if method is a destructor @@ -187,9 +167,7 @@ public function isConstructor() * @return bool Returns {@see true} if the method is a destructor, otherwise {@see false} */ #[Pure] - public function isDestructor() - { - } + public function isDestructor() {} /** * Returns a dynamically created closure for the method @@ -200,9 +178,7 @@ public function isDestructor() * @since 5.4 */ #[Pure] - public function getClosure($object = null) - { - } + public function getClosure($object = null) {} /** * Gets the method modifiers @@ -222,9 +198,7 @@ public function getClosure($object = null) * - {@see ReflectionMethod::IS_FINAL} - Indicates that the method is final. */ #[Pure] - public function getModifiers() - { - } + public function getModifiers() {} /** * Invokes a reflected method. @@ -240,9 +214,7 @@ public function getModifiers() * instance of the class that this method was declared in or the method * invocation failed. */ - public function invoke($object, ...$args) - { - } + public function invoke($object, ...$args) {} /** * Invokes the reflected method and pass its arguments as array. @@ -256,9 +228,7 @@ public function invoke($object, ...$args) * instance of the class that this method was declared in or the method * invocation failed. */ - public function invokeArgs($object, array $args) - { - } + public function invokeArgs($object, array $args) {} /** * Gets declaring class for the reflected method. @@ -268,9 +238,7 @@ public function invokeArgs($object, array $args) * reflected method is part of. */ #[Pure] - public function getDeclaringClass() - { - } + public function getDeclaringClass() {} /** * Gets the method prototype (if there is one). @@ -280,9 +248,7 @@ public function getDeclaringClass() * @throws ReflectionException if the method does not have a prototype */ #[Pure] - public function getPrototype() - { - } + public function getPrototype() {} /** * Set method accessibility @@ -292,8 +258,5 @@ public function getPrototype() * @return void No value is returned. * @since 5.3.2 */ - public function setAccessible($accessible) - { - } - + public function setAccessible($accessible) {} } diff --git a/Reflection/ReflectionNamedType.php b/Reflection/ReflectionNamedType.php index 01c3536e5..e6003b30a 100644 --- a/Reflection/ReflectionNamedType.php +++ b/Reflection/ReflectionNamedType.php @@ -15,9 +15,7 @@ class ReflectionNamedType extends ReflectionType * @since 7.1 */ #[Pure] - public function getName() - { - } + public function getName() {} /** * Checks if it is a built-in type @@ -29,7 +27,5 @@ public function getName() * @since 8.0 method was removed from the parent {@see ReflectionType} class. */ #[Pure] - public function isBuiltin() - { - } + public function isBuiltin() {} } diff --git a/Reflection/ReflectionObject.php b/Reflection/ReflectionObject.php index f872ee813..4defba5f4 100644 --- a/Reflection/ReflectionObject.php +++ b/Reflection/ReflectionObject.php @@ -16,9 +16,7 @@ class ReflectionObject extends ReflectionClass * @link https://php.net/manual/en/reflectionobject.construct.php * @param object $object An object instance. */ - public function __construct($object) - { - } + public function __construct($object) {} /** * Export @@ -33,7 +31,5 @@ public function __construct($object) * @removed 8.0 */ #[Deprecated(since: '7.4')] - public static function export($argument, $return = false) - { - } + public static function export($argument, $return = false) {} } diff --git a/Reflection/ReflectionParameter.php b/Reflection/ReflectionParameter.php index ff25bd113..ce5832c0c 100644 --- a/Reflection/ReflectionParameter.php +++ b/Reflection/ReflectionParameter.php @@ -27,9 +27,7 @@ class ReflectionParameter implements Reflector * of the parameter (starting with zero), or a the parameter name as string. * @throws \ReflectionException if the function or parameter does not exist. */ - public function __construct(callable $function, $param) - { - } + public function __construct(callable $function, $param) {} /** * Exports @@ -44,9 +42,7 @@ public function __construct(callable $function, $param) * @removed 8.0 */ #[Deprecated(since: '7.4')] - public static function export($function, $parameter, $return = false) - { - } + public static function export($function, $parameter, $return = false) {} /** * Returns the string representation of the ReflectionParameter object. @@ -54,9 +50,7 @@ public static function export($function, $parameter, $return = false) * @link https://php.net/manual/en/reflectionparameter.tostring.php * @return string */ - public function __toString() - { - } + public function __toString() {} /** * Gets parameter name @@ -65,9 +59,7 @@ public function __toString() * @return string The name of the reflected parameter. */ #[Pure] - public function getName() - { - } + public function getName() {} /** * Checks if passed by reference @@ -76,9 +68,7 @@ public function getName() * @return bool {@see true} if the parameter is passed in by reference, otherwise {@see false} */ #[Pure] - public function isPassedByReference() - { - } + public function isPassedByReference() {} /** * Returns whether this parameter can be passed by value @@ -88,9 +78,7 @@ public function isPassedByReference() * Returns {@see null} in case of an error. * @since 5.4 */ - public function canBePassedByValue() - { - } + public function canBePassedByValue() {} /** * Gets declaring function @@ -100,9 +88,7 @@ public function canBePassedByValue() * @since 5.2.3 */ #[Pure] - public function getDeclaringFunction() - { - } + public function getDeclaringFunction() {} /** * Gets declaring class @@ -112,9 +98,7 @@ public function getDeclaringFunction() * called on function. */ #[Pure] - public function getDeclaringClass() - { - } + public function getDeclaringClass() {} /** * Gets the class type hinted for the parameter as a ReflectionClass object. @@ -125,9 +109,7 @@ public function getDeclaringClass() */ #[Deprecated(reason: "Use ReflectionParameter::getType() and the ReflectionType APIs should be used instead.", since: "8.0")] #[Pure] - public function getClass() - { - } + public function getClass() {} /** * Checks if the parameter has a type associated with it. @@ -136,9 +118,7 @@ public function getClass() * @return bool {@see true} if a type is specified, {@see false} otherwise. * @since 7.0 */ - public function hasType() - { - } + public function hasType() {} /** * Gets a parameter's type @@ -149,9 +129,7 @@ public function hasType() * @since 7.0 */ #[Pure] - public function getType() - { - } + public function getType() {} /** * Checks if parameter expects an array @@ -162,9 +140,7 @@ public function getType() */ #[Deprecated(reason: "Use ReflectionParameter::getType() and the ReflectionType APIs should be used instead.", since: "8.0")] #[Pure] - public function isArray() - { - } + public function isArray() {} /** * Returns whether parameter MUST be callable @@ -177,9 +153,7 @@ public function isArray() */ #[Deprecated(reason: "Use ReflectionParameter::getType() and the ReflectionType APIs should be used instead.", since: "8.0")] #[Pure] - public function isCallable() - { - } + public function isCallable() {} /** * Checks if null is allowed @@ -188,9 +162,7 @@ public function isCallable() * @return bool Returns {@see true} if {@see null} is allowed, * otherwise {@see false} */ - public function allowsNull() - { - } + public function allowsNull() {} /** * Gets parameter position @@ -200,9 +172,7 @@ public function allowsNull() * @since 5.2.3 */ #[Pure] - public function getPosition() - { - } + public function getPosition() {} /** * Checks if optional @@ -212,9 +182,7 @@ public function getPosition() * @since 5.0.3 */ #[Pure] - public function isOptional() - { - } + public function isOptional() {} /** * Checks if a default value is available @@ -224,9 +192,7 @@ public function isOptional() * @since 5.0.3 */ #[Pure] - public function isDefaultValueAvailable() - { - } + public function isDefaultValueAvailable() {} /** * Gets default parameter value @@ -237,9 +203,7 @@ public function isDefaultValueAvailable() * @since 5.0.3 */ #[Pure] - public function getDefaultValue() - { - } + public function getDefaultValue() {} /** * Returns whether the default value of this parameter is constant @@ -249,9 +213,7 @@ public function getDefaultValue() * @since 5.4.6 */ #[Pure] - public function isDefaultValueConstant() - { - } + public function isDefaultValueConstant() {} /** * Returns the default value's constant name if default value is constant or null @@ -262,9 +224,7 @@ public function isDefaultValueConstant() * @since 5.4.6 */ #[Pure] - public function getDefaultValueConstantName() - { - } + public function getDefaultValueConstantName() {} /** * Returns whether this function is variadic @@ -274,9 +234,7 @@ public function getDefaultValueConstantName() * @since 5.6 */ #[Pure] - public function isVariadic() - { - } + public function isVariadic() {} /** * Returns information about whether the parameter is a promoted. @@ -285,9 +243,7 @@ public function isVariadic() * @since 8.0 */ #[Pure] - public function isPromoted() - { - } + public function isPromoted() {} /** * Returns an array of parameter attributes. @@ -298,9 +254,7 @@ public function isPromoted() * @since 8.0 */ #[Pure] - public function getAttributes(?string $name = null, int $flags = 0) - { - } + public function getAttributes(?string $name = null, int $flags = 0) {} /** * Clone @@ -308,7 +262,5 @@ public function getAttributes(?string $name = null, int $flags = 0) * @link https://php.net/manual/en/reflectionparameter.clone.php * @return void */ - final private function __clone() - { - } + final private function __clone() {} } diff --git a/Reflection/ReflectionProperty.php b/Reflection/ReflectionProperty.php index 9d81017f5..862c360d3 100644 --- a/Reflection/ReflectionProperty.php +++ b/Reflection/ReflectionProperty.php @@ -12,7 +12,6 @@ */ class ReflectionProperty implements Reflector { - /** * @var string Name of the property, same as calling the {@see ReflectionProperty::getName()} method */ @@ -30,28 +29,28 @@ class ReflectionProperty implements Reflector * * @link https://www.php.net/manual/en/class.reflectionproperty.php#reflectionproperty.constants.is-static */ - const IS_STATIC = 16; + public const IS_STATIC = 16; /** * Indicates that the property is public. * * @link https://www.php.net/manual/en/class.reflectionproperty.php#reflectionproperty.constants.is-public */ - const IS_PUBLIC = 1; + public const IS_PUBLIC = 1; /** * Indicates that the property is protected. * * @link https://www.php.net/manual/en/class.reflectionproperty.php#reflectionproperty.constants.is-protected */ - const IS_PROTECTED = 2; + public const IS_PROTECTED = 2; /** * Indicates that the property is private. * * @link https://www.php.net/manual/en/class.reflectionproperty.php#reflectionproperty.constants.is-private */ - const IS_PRIVATE = 4; + public const IS_PRIVATE = 4; /** * Construct a ReflectionProperty object @@ -61,9 +60,7 @@ class ReflectionProperty implements Reflector * @param string $property The name of the property being reflected. * @throws \ReflectionException if the class or property does not exist. */ - public function __construct($class, $property) - { - } + public function __construct($class, $property) {} /** * Export @@ -78,9 +75,7 @@ public function __construct($class, $property) * @removed 8.0 */ #[Deprecated(since: '7.4')] - public static function export($class, $name, $return = false) - { - } + public static function export($class, $name, $return = false) {} /** * To string @@ -88,9 +83,7 @@ public static function export($class, $name, $return = false) * @link https://php.net/manual/en/reflectionproperty.tostring.php * @return string */ - public function __toString() - { - } + public function __toString() {} /** * Gets property name @@ -99,9 +92,7 @@ public function __toString() * @return string The name of the reflected property. */ #[Pure] - public function getName() - { - } + public function getName() {} /** * Gets value @@ -114,9 +105,7 @@ public function getName() * @return mixed The current value of the property. */ #[Pure] - public function getValue($object = null) - { - } + public function getValue($object = null) {} /** * Set property value @@ -128,9 +117,7 @@ public function getValue($object = null) * @param mixed $value The new value. * @return void No value is returned. */ - public function setValue($objectOrValue, $value = null) - { - } + public function setValue($objectOrValue, $value = null) {} /** * Checks if property is public @@ -139,9 +126,7 @@ public function setValue($objectOrValue, $value = null) * @return bool Return {@see true} if the property is public, {@see false} otherwise. */ #[Pure] - public function isPublic() - { - } + public function isPublic() {} /** * Checks if property is private @@ -150,9 +135,7 @@ public function isPublic() * @return bool Return {@see true} if the property is private, {@see false} otherwise. */ #[Pure] - public function isPrivate() - { - } + public function isPrivate() {} /** * Checks if property is protected @@ -161,9 +144,7 @@ public function isPrivate() * @return bool Returns {@see true} if the property is protected, {@see false} otherwise. */ #[Pure] - public function isProtected() - { - } + public function isProtected() {} /** * Checks if property is static @@ -172,9 +153,7 @@ public function isProtected() * @return bool Retruns {@see true} if the property is static, {@see false} otherwise. */ #[Pure] - public function isStatic() - { - } + public function isStatic() {} /** * Checks if default value @@ -184,9 +163,7 @@ public function isStatic() * compile-time, or {@see false} if it was created at run-time. */ #[Pure] - public function isDefault() - { - } + public function isDefault() {} /** * Gets modifiers @@ -195,9 +172,7 @@ public function isDefault() * @return int A numeric representation of the modifiers. */ #[Pure] - public function getModifiers() - { - } + public function getModifiers() {} /** * Gets declaring class @@ -206,9 +181,7 @@ public function getModifiers() * @return ReflectionClass A {@see ReflectionClass} object. */ #[Pure] - public function getDeclaringClass() - { - } + public function getDeclaringClass() {} /** * Gets doc comment @@ -217,9 +190,7 @@ public function getDeclaringClass() * @return string|false The doc comment if it exists, otherwise {@see false} */ #[Pure] - public function getDocComment() - { - } + public function getDocComment() {} /** * Set property accessibility @@ -228,9 +199,7 @@ public function getDocComment() * @param bool $accessible A boolean {@see true} to allow accessibility, or {@see false} * @return void No value is returned. */ - public function setAccessible($accessible) - { - } + public function setAccessible($accessible) {} /** * Gets property type @@ -241,9 +210,7 @@ public function setAccessible($accessible) * @since 7.4 */ #[Pure] - public function getType() - { - } + public function getType() {} /** * Checks if property has type @@ -252,9 +219,7 @@ public function getType() * @return bool Returns {@see true} if a type is specified, {@see false} otherwise. * @since 7.4 */ - public function hasType() - { - } + public function hasType() {} /** * Checks if property is initialized @@ -266,9 +231,7 @@ public function hasType() * @since 7.4 */ #[Pure] - public function isInitialized(?object $object = null) - { - } + public function isInitialized(?object $object = null) {} /** * Returns information about whether the property was promoted. @@ -277,9 +240,7 @@ public function isInitialized(?object $object = null) * @since 8.0 */ #[Pure] - public function isPromoted() - { - } + public function isPromoted() {} /** * Clone @@ -287,22 +248,20 @@ public function isPromoted() * @link https://php.net/manual/en/reflectionproperty.clone.php * @return void */ - final private function __clone() - { - } + final private function __clone() {} /** * @return bool * @since 8.0 */ - public function hasDefaultValue(){} + public function hasDefaultValue() {} /** * @return mixed * @since 8.0 */ #[Pure] - public function getDefaultValue(){} + public function getDefaultValue() {} /** * @param null|string $name @@ -311,5 +270,5 @@ public function getDefaultValue(){} * @since 8.0 */ #[Pure] - public function getAttributes(?string $name = null, int $flags = 0) {} + public function getAttributes(?string $name = null, int $flags = 0) {} } diff --git a/Reflection/ReflectionReference.php b/Reflection/ReflectionReference.php index 53d243232..51888d5e0 100644 --- a/Reflection/ReflectionReference.php +++ b/Reflection/ReflectionReference.php @@ -15,9 +15,7 @@ class ReflectionReference /** * ReflectionReference cannot be created explicitly. */ - private function __construct() - { - } + private function __construct() {} /** * Returns ReflectionReference if array element is a reference, {@see null} otherwise @@ -27,9 +25,7 @@ private function __construct() * @param int|string $key The key; either an integer or a string. * @return self|null */ - public static function fromArrayElement(array $array, $key) - { - } + public static function fromArrayElement(array $array, $key) {} /** * Returns unique identifier for the reference. The return value format is unspecified @@ -38,16 +34,12 @@ public static function fromArrayElement(array $array, $key) * @return int|string Returns an integer or string of unspecified format. */ #[Pure] - public function getId() - { - } + public function getId() {} /** * ReflectionReference cannot be cloned * * @return void */ - private function __clone() - { - } + private function __clone() {} } diff --git a/Reflection/ReflectionType.php b/Reflection/ReflectionType.php index 611ebbb80..13b2ee6ff 100644 --- a/Reflection/ReflectionType.php +++ b/Reflection/ReflectionType.php @@ -18,9 +18,7 @@ abstract class ReflectionType implements Stringable * @return bool Returns {@see true} if {@see null} is allowed, otherwise {@see false} * @since 7.0 */ - public function allowsNull() - { - } + public function allowsNull() {} /** * Checks if it is a built-in type @@ -32,9 +30,7 @@ public function allowsNull() * class and moved to the {@see ReflectionNamedType} child. */ #[Pure] - public function isBuiltin() - { - } + public function isBuiltin() {} /** * To string @@ -45,16 +41,12 @@ public function isBuiltin() * @see ReflectionNamedType::getName() */ #[Deprecated(since: "7.1")] - public function __toString() - { - } + public function __toString() {} /** * Cloning of this class is prohibited * * @return void */ - final private function __clone() - { - } + final private function __clone() {} } diff --git a/Reflection/ReflectionUnionType.php b/Reflection/ReflectionUnionType.php index bd0d21515..5ad6eb268 100644 --- a/Reflection/ReflectionUnionType.php +++ b/Reflection/ReflectionUnionType.php @@ -13,7 +13,5 @@ class ReflectionUnionType extends ReflectionType * @return ReflectionNamedType[] */ #[Pure] - public function getTypes() - { - } + public function getTypes() {} } diff --git a/Reflection/ReflectionZendExtension.php b/Reflection/ReflectionZendExtension.php index 91be914b9..6d6daaa7e 100644 --- a/Reflection/ReflectionZendExtension.php +++ b/Reflection/ReflectionZendExtension.php @@ -23,9 +23,7 @@ class ReflectionZendExtension implements Reflector * @throws \ReflectionException if the extension does not exist. * @since 5.4 */ - public function __construct($name) - { - } + public function __construct($name) {} /** * Exports a reflected zend extension. @@ -38,9 +36,7 @@ public function __construct($name) * @return string|null If the $return parameter is set to {@see true}, then * the export is returned as a string, otherwise {@see null} is returned. */ - public static function export($name, $return = false) - { - } + public static function export($name, $return = false) {} /** * To string handler @@ -49,9 +45,7 @@ public static function export($name, $return = false) * @return string * @since 5.4 */ - public function __toString() - { - } + public function __toString() {} /** * Gets name @@ -61,9 +55,7 @@ public function __toString() * @since 5.4 */ #[Pure] - public function getName() - { - } + public function getName() {} /** * Gets version @@ -73,9 +65,7 @@ public function getName() * @since 5.4 */ #[Pure] - public function getVersion() - { - } + public function getVersion() {} /** * Gets author @@ -85,9 +75,7 @@ public function getVersion() * @since 5.4 */ #[Pure] - public function getAuthor() - { - } + public function getAuthor() {} /** * Gets URL @@ -97,9 +85,7 @@ public function getAuthor() * @since 5.4 */ #[Pure] - public function getURL() - { - } + public function getURL() {} /** * Gets copyright @@ -109,9 +95,7 @@ public function getURL() * @since 5.4 */ #[Pure] - public function getCopyright() - { - } + public function getCopyright() {} /** * Clone handler @@ -120,8 +104,5 @@ public function getCopyright() * @return void * @since 5.4 */ - final private function __clone() - { - } - + final private function __clone() {} } diff --git a/SPL/SPL.php b/SPL/SPL.php index 65c917044..dd76dca45 100644 --- a/SPL/SPL.php +++ b/SPL/SPL.php @@ -7,75 +7,65 @@ * exceptions should directly lead to a fix in your code. * @link https://php.net/manual/en/class.logicexception.php */ -class LogicException extends Exception { -} +class LogicException extends Exception {} /** * Exception thrown if a callback refers to an undefined function or if some * arguments are missing. * @link https://php.net/manual/en/class.badfunctioncallexception.php */ -class BadFunctionCallException extends LogicException { -} +class BadFunctionCallException extends LogicException {} /** * Exception thrown if a callback refers to an undefined method or if some * arguments are missing. * @link https://php.net/manual/en/class.badmethodcallexception.php */ -class BadMethodCallException extends BadFunctionCallException { -} +class BadMethodCallException extends BadFunctionCallException {} /** * Exception thrown if a value does not adhere to a defined valid data domain. * @link https://php.net/manual/en/class.domainexception.php */ -class DomainException extends LogicException { -} +class DomainException extends LogicException {} /** * Exception thrown if an argument does not match with the expected value. * @link https://php.net/manual/en/class.invalidargumentexception.php */ -class InvalidArgumentException extends LogicException { -} +class InvalidArgumentException extends LogicException {} /** * Exception thrown if a length is invalid. * @link https://php.net/manual/en/class.lengthexception.php */ -class LengthException extends LogicException { -} +class LengthException extends LogicException {} /** * Exception thrown when an illegal index was requested. This represents * errors that should be detected at compile time. * @link https://php.net/manual/en/class.outofrangeexception.php */ -class OutOfRangeException extends LogicException { -} +class OutOfRangeException extends LogicException {} /** * Exception thrown if an error which can only be found on runtime occurs. * @link https://php.net/manual/en/class.runtimeexception.php */ -class RuntimeException extends Exception { -} +class RuntimeException extends Exception {} /** * Exception thrown if a value is not a valid key. This represents errors * that cannot be detected at compile time. * @link https://php.net/manual/en/class.outofboundsexception.php */ -class OutOfBoundsException extends RuntimeException { -} +class OutOfBoundsException extends RuntimeException {} /** * Exception thrown when you add an element into a full container. * @link https://php.net/manual/en/class.overflowexception.php */ -class OverflowException extends RuntimeException { -} +class OverflowException extends RuntimeException {} /** * Exception thrown to indicate range errors during program execution. @@ -84,15 +74,13 @@ class OverflowException extends RuntimeException { * DomainException. * @link https://php.net/manual/en/class.rangeexception.php */ -class RangeException extends RuntimeException { -} +class RangeException extends RuntimeException {} /** * Exception thrown when you try to remove an element of an empty container. * @link https://php.net/manual/en/class.underflowexception.php */ -class UnderflowException extends RuntimeException { -} +class UnderflowException extends RuntimeException {} /** * Exception thrown if a value does not match with a set of values. Typically @@ -101,35 +89,34 @@ class UnderflowException extends RuntimeException { * related errors. * @link https://php.net/manual/en/class.unexpectedvalueexception.php */ -class UnexpectedValueException extends RuntimeException { -} +class UnexpectedValueException extends RuntimeException {} /** * The EmptyIterator class for an empty iterator. * @link https://secure.php.net/manual/en/class.emptyiterator.php */ -class EmptyIterator implements Iterator { - +class EmptyIterator implements Iterator +{ /** * Return the current element * @link https://php.net/manual/en/iterator.current.php * @return mixed Can return any type. */ - public function current() { } + public function current() {} /** * Move forward to next element * @link https://php.net/manual/en/iterator.next.php * @return void Any returned value is ignored. */ - public function next() { } + public function next() {} /** * Return the key of the current element * @link https://php.net/manual/en/iterator.key.php * @return string|float|int|bool|null scalar on success, or null on failure. */ - public function key() { } + public function key() {} /** * Checks if current position is valid @@ -137,14 +124,14 @@ public function key() { } * @return bool The return value will be casted to boolean and then evaluated. * Returns true on success or false on failure. */ - public function valid() { } + public function valid() {} /** * Rewind the Iterator to the first element * @link https://php.net/manual/en/iterator.rewind.php * @return void Any returned value is ignored. */ - public function rewind() { } + public function rewind() {} } /** @@ -152,8 +139,8 @@ public function rewind() { } * @link https://secure.php.net/manual/en/class.callbackfilteriterator.php * @since 5.4 */ -class CallbackFilterIterator extends FilterIterator { - +class CallbackFilterIterator extends FilterIterator +{ /** * Creates a filtered iterator using the callback to determine which items are accepted or rejected. * @param Iterator $iterator The iterator to be filtered. @@ -163,7 +150,7 @@ class CallbackFilterIterator extends FilterIterator { * function my_callback($current, $key, $iterator)
* @link https://secure.php.net/manual/en/callbackfilteriterator.construct.php
*/
- function __construct(Iterator $iterator , callable $callback) { }
+ public function __construct(Iterator $iterator, callable $callback) {}
/**
* This method calls the callback with the current value, current key and the inner iterator.
@@ -171,7 +158,7 @@ function __construct(Iterator $iterator , callable $callback) { }
* @link https://secure.php.net/manual/en/callbackfilteriterator.accept.php
* @return bool true if the current element is acceptable, otherwise false.
*/
- public function accept() { }
+ public function accept() {}
}
/**
@@ -180,8 +167,8 @@ public function accept() { }
* @link https://secure.php.net/manual/en/class.recursivecallbackfilteriterator.php
* @since 5.4
*/
-class RecursiveCallbackFilterIterator extends CallbackFilterIterator implements RecursiveIterator {
-
+class RecursiveCallbackFilterIterator extends CallbackFilterIterator implements RecursiveIterator
+{
/**
* Create a RecursiveCallbackFilterIterator from a RecursiveIterator
* @param RecursiveIterator $iterator The recursive iterator to be filtered.
@@ -189,22 +176,21 @@ class RecursiveCallbackFilterIterator extends CallbackFilterIterator implements
* May be any valid callable value.
* @link https://secure.php.net/manual/en/recursivecallbackfilteriterator.getchildren.php
*/
- function __construct( RecursiveIterator $iterator, $callback ) { }
+ public function __construct(RecursiveIterator $iterator, $callback) {}
/**
* Check whether the inner iterator's current element has children
* @link https://php.net/manual/en/recursiveiterator.haschildren.php
* @return bool Returns TRUE if the current element has children, FALSE otherwise.
*/
- public function hasChildren() { }
+ public function hasChildren() {}
/**
* Returns an iterator for the current entry.
* @link https://secure.php.net/manual/en/recursivecallbackfilteriterator.haschildren.php
* @return RecursiveCallbackFilterIterator containing the children.
*/
- public function getChildren() { }
-
+ public function getChildren() {}
}
/**
@@ -212,8 +198,8 @@ public function getChildren() { }
* over iterators recursively.
* @link https://php.net/manual/en/class.recursiveiterator.php
*/
-interface RecursiveIterator extends Iterator {
-
+interface RecursiveIterator extends Iterator
+{
/**
* Returns if an iterator can be created for the current entry.
* @link https://php.net/manual/en/recursiveiterator.haschildren.php
@@ -233,27 +219,27 @@ public function getChildren();
* Can be used to iterate through recursive iterators.
* @link https://php.net/manual/en/class.recursiveiteratoriterator.php
*/
-class RecursiveIteratorIterator implements OuterIterator {
-
+class RecursiveIteratorIterator implements OuterIterator
+{
/**
* The default. Lists only leaves in iteration.
*/
- const LEAVES_ONLY = 0;
+ public const LEAVES_ONLY = 0;
/**
* Lists leaves and parents in iteration with parents coming first.
*/
- const SELF_FIRST = 1;
+ public const SELF_FIRST = 1;
/**
* Lists leaves and parents in iteration with leaves coming first.
*/
- const CHILD_FIRST = 2;
+ public const CHILD_FIRST = 2;
/**
* Special flag: Ignore exceptions thrown in accessing children.
*/
- const CATCH_GET_CHILD = 16;
+ public const CATCH_GET_CHILD = 16;
/**
* Construct a RecursiveIteratorIterator
@@ -263,49 +249,49 @@ class RecursiveIteratorIterator implements OuterIterator {
* @param int $flags [optional] A bitmask of special flags. See class constants for details.
* @since 5.1.3
*/
- public function __construct(Traversable $iterator, $mode = self::LEAVES_ONLY, $flags = 0) { }
+ public function __construct(Traversable $iterator, $mode = self::LEAVES_ONLY, $flags = 0) {}
/**
* Rewind the iterator to the first element of the top level inner iterator
* @link https://php.net/manual/en/recursiveiteratoriterator.rewind.php
* @return void
*/
- public function rewind() { }
+ public function rewind() {}
/**
* Check whether the current position is valid
* @link https://php.net/manual/en/recursiveiteratoriterator.valid.php
* @return bool true if the current position is valid, otherwise false
*/
- public function valid() { }
+ public function valid() {}
/**
* Access the current key
* @link https://php.net/manual/en/recursiveiteratoriterator.key.php
* @return string|float|int|bool|null The current key.
*/
- public function key() { }
+ public function key() {}
/**
* Access the current element value
* @link https://php.net/manual/en/recursiveiteratoriterator.current.php
* @return mixed The current elements value.
*/
- public function current() { }
+ public function current() {}
/**
* Move forward to the next element
* @link https://php.net/manual/en/recursiveiteratoriterator.next.php
* @return void
*/
- public function next() { }
+ public function next() {}
/**
* Get the current depth of the recursive iteration
* @link https://php.net/manual/en/recursiveiteratoriterator.getdepth.php
* @return int The current depth of the recursive iteration.
*/
- public function getDepth() { }
+ public function getDepth() {}
/**
* The current active sub iterator
@@ -313,63 +299,63 @@ public function getDepth() { }
* @param int $level [optional]
* @return RecursiveIterator The current active sub iterator.
*/
- public function getSubIterator($level) { }
+ public function getSubIterator($level) {}
/**
* Get inner iterator
* @link https://php.net/manual/en/recursiveiteratoriterator.getinneriterator.php
* @return Iterator The current active sub iterator.
*/
- public function getInnerIterator() { }
+ public function getInnerIterator() {}
/**
* Begin Iteration
* @link https://php.net/manual/en/recursiveiteratoriterator.beginiteration.php
* @return void
*/
- public function beginIteration() { }
+ public function beginIteration() {}
/**
* End Iteration
* @link https://php.net/manual/en/recursiveiteratoriterator.enditeration.php
* @return void
*/
- public function endIteration() { }
+ public function endIteration() {}
/**
* Has children
* @link https://php.net/manual/en/recursiveiteratoriterator.callhaschildren.php
* @return bool true if the element has children, otherwise false
*/
- public function callHasChildren() { }
+ public function callHasChildren() {}
/**
* Get children
* @link https://php.net/manual/en/recursiveiteratoriterator.callgetchildren.php
* @return RecursiveIterator A RecursiveIterator.
*/
- public function callGetChildren() { }
+ public function callGetChildren() {}
/**
* Begin children
* @link https://php.net/manual/en/recursiveiteratoriterator.beginchildren.php
* @return void
*/
- public function beginChildren() { }
+ public function beginChildren() {}
/**
* End children
* @link https://php.net/manual/en/recursiveiteratoriterator.endchildren.php
* @return void
*/
- public function endChildren() { }
+ public function endChildren() {}
/**
* Next element
* @link https://php.net/manual/en/recursiveiteratoriterator.nextelement.php
* @return void
*/
- public function nextElement() { }
+ public function nextElement() {}
/**
* Set max depth
@@ -380,14 +366,14 @@ public function nextElement() { }
*
* @return void
*/
- public function setMaxDepth($maxDepth = -1) { }
+ public function setMaxDepth($maxDepth = -1) {}
/**
* Get max depth
* @link https://php.net/manual/en/recursiveiteratoriterator.getmaxdepth.php
* @return int|false The maximum accepted depth, or false if any depth is allowed.
*/
- public function getMaxDepth() { }
+ public function getMaxDepth() {}
}
/**
@@ -395,8 +381,8 @@ public function getMaxDepth() { }
* over iterators.
* @link https://php.net/manual/en/class.outeriterator.php
*/
-interface OuterIterator extends Iterator {
-
+interface OuterIterator extends Iterator
+{
/**
* Returns the inner iterator for the current entry.
* @link https://php.net/manual/en/outeriterator.getinneriterator.php
@@ -405,7 +391,6 @@ interface OuterIterator extends Iterator {
public function getInnerIterator();
}
-
/**
* This iterator wrapper allows the conversion of anything that is
* Traversable into an Iterator.
@@ -415,57 +400,57 @@ public function getInnerIterator();
* misuse, otherwise expect exceptions or fatal errors.
* @link https://php.net/manual/en/class.iteratoriterator.php
*/
-class IteratorIterator implements OuterIterator {
-
+class IteratorIterator implements OuterIterator
+{
/**
* Create an iterator from anything that is traversable
* @link https://php.net/manual/en/iteratoriterator.construct.php
* @param Traversable $iterator
* @param string $class [optional]
*/
- public function __construct(Traversable $iterator, $class = '') { }
+ public function __construct(Traversable $iterator, $class = '') {}
/**
* Get the inner iterator
* @link https://php.net/manual/en/iteratoriterator.getinneriterator.php
* @return Iterator The inner iterator as passed to IteratorIterator::__construct.
*/
- public function getInnerIterator() { }
+ public function getInnerIterator() {}
/**
* Rewind to the first element
* @link https://php.net/manual/en/iteratoriterator.rewind.php
* @return void
*/
- public function rewind() { }
+ public function rewind() {}
/**
* Checks if the iterator is valid
* @link https://php.net/manual/en/iteratoriterator.valid.php
* @return bool true if the iterator is valid, otherwise false
*/
- public function valid() { }
+ public function valid() {}
/**
* Get the key of the current element
* @link https://php.net/manual/en/iteratoriterator.key.php
* @return string|float|int|bool|null The key of the current element.
*/
- public function key() { }
+ public function key() {}
/**
* Get the current value
* @link https://php.net/manual/en/iteratoriterator.current.php
* @return mixed The value of the current element.
*/
- public function current() { }
+ public function current() {}
/**
* Forward to the next element
* @link https://php.net/manual/en/iteratoriterator.next.php
* @return void
*/
- public function next() { }
+ public function next() {}
}
/**
@@ -474,8 +459,8 @@ public function next() { }
* must be implemented in the subclass.
* @link https://php.net/manual/en/class.filteriterator.php
*/
-abstract class FilterIterator extends IteratorIterator {
-
+abstract class FilterIterator extends IteratorIterator
+{
/**
* Check whether the current element of the iterator is acceptable
* @link https://php.net/manual/en/filteriterator.accept.php
@@ -488,49 +473,49 @@ abstract public function accept();
* @link https://php.net/manual/en/filteriterator.construct.php
* @param Iterator $iterator
*/
- public function __construct(Iterator $iterator) { }
+ public function __construct(Iterator $iterator) {}
/**
* Rewind the iterator
* @link https://php.net/manual/en/filteriterator.rewind.php
* @return void
*/
- public function rewind() { }
+ public function rewind() {}
/**
* Check whether the current element is valid
* @link https://php.net/manual/en/filteriterator.valid.php
* @return bool true if the current element is valid, otherwise false
*/
- public function valid() { }
+ public function valid() {}
/**
* Get the current key
* @link https://php.net/manual/en/filteriterator.key.php
* @return string|float|int|bool|null The current key.
*/
- public function key() { }
+ public function key() {}
/**
* Get the current element value
* @link https://php.net/manual/en/filteriterator.current.php
* @return mixed The current element value.
*/
- public function current() { }
+ public function current() {}
/**
* Move the iterator forward
* @link https://php.net/manual/en/filteriterator.next.php
* @return void
*/
- public function next() { }
+ public function next() {}
/**
* Get the inner iterator
* @link https://php.net/manual/en/filteriterator.getinneriterator.php
* @return Iterator The inner iterator.
*/
- public function getInnerIterator() { }
+ public function getInnerIterator() {}
}
/**
@@ -539,71 +524,71 @@ public function getInnerIterator() { }
* The RecursiveFilterIterator::accept must be implemented in the subclass.
* @link https://php.net/manual/en/class.recursivefilteriterator.php
*/
-abstract class RecursiveFilterIterator extends FilterIterator implements RecursiveIterator {
-
+abstract class RecursiveFilterIterator extends FilterIterator implements RecursiveIterator
+{
/**
* Create a RecursiveFilterIterator from a RecursiveIterator
* @link https://php.net/manual/en/recursivefilteriterator.construct.php
* @param RecursiveIterator $iterator
*/
- public function __construct(RecursiveIterator $iterator) { }
+ public function __construct(RecursiveIterator $iterator) {}
/**
* Check whether the inner iterator's current element has children
* @link https://php.net/manual/en/recursivefilteriterator.haschildren.php
* @return bool true if the inner iterator has children, otherwise false
*/
- public function hasChildren() { }
+ public function hasChildren() {}
/**
* Return the inner iterator's children contained in a RecursiveFilterIterator
* @link https://php.net/manual/en/recursivefilteriterator.getchildren.php
* @return RecursiveFilterIterator containing the inner iterator's children.
*/
- public function getChildren() { }
+ public function getChildren() {}
}
/**
* This extended FilterIterator allows a recursive iteration using RecursiveIteratorIterator that only shows those elements which have children.
* @link https://php.net/manual/en/class.parentiterator.php
*/
-class ParentIterator extends RecursiveFilterIterator {
-
+class ParentIterator extends RecursiveFilterIterator
+{
/**
* Determines acceptability
* @link https://php.net/manual/en/parentiterator.accept.php
* @return bool true if the current element is acceptable, otherwise false.
*/
- public function accept() { }
+ public function accept() {}
/**
* Constructs a ParentIterator
* @link https://php.net/manual/en/parentiterator.construct.php
* @param RecursiveIterator $iterator
*/
- public function __construct(RecursiveIterator $iterator) { }
+ public function __construct(RecursiveIterator $iterator) {}
/**
* Check whether the inner iterator's current element has children
* @link https://php.net/manual/en/recursivefilteriterator.haschildren.php
* @return bool true if the inner iterator has children, otherwise false
*/
- public function hasChildren() { }
+ public function hasChildren() {}
/**
* Return the inner iterator's children contained in a RecursiveFilterIterator
* @link https://php.net/manual/en/recursivefilteriterator.getchildren.php
* @return ParentIterator containing the inner iterator's children.
*/
- public function getChildren() { }
+ public function getChildren() {}
}
/**
* The Seekable iterator.
* @link https://php.net/manual/en/class.seekableiterator.php
*/
-interface SeekableIterator extends Iterator {
-
+interface SeekableIterator extends Iterator
+{
/**
* Seeks to a position
* @link https://php.net/manual/en/seekableiterator.seek.php
@@ -620,8 +605,8 @@ public function seek($offset);
* a limited subset of items in an Iterator.
* @link https://php.net/manual/en/class.limititerator.php
*/
-class LimitIterator extends IteratorIterator {
-
+class LimitIterator extends IteratorIterator
+{
/**
* Construct a LimitIterator
* @link https://php.net/manual/en/limititerator.construct.php
@@ -629,42 +614,42 @@ class LimitIterator extends IteratorIterator {
* @param int $offset [optional] The offset to start at. Must be zero or greater.
* @param int $limit [optional] The number of items to iterate. Must be -1 or greater. -1, the default, means no limit.
*/
- public function __construct(Iterator $iterator, $offset = 0, $limit = -1) { }
+ public function __construct(Iterator $iterator, $offset = 0, $limit = -1) {}
/**
* Rewind the iterator to the specified starting offset
* @link https://php.net/manual/en/limititerator.rewind.php
* @return void
*/
- public function rewind() { }
+ public function rewind() {}
/**
* Check whether the current element is valid
* @link https://php.net/manual/en/limititerator.valid.php
* @return bool true on success or false on failure.
*/
- public function valid() { }
+ public function valid() {}
/**
* Get current key
* @link https://php.net/manual/en/limititerator.key.php
* @return string|float|int|bool|null the key for the current item.
*/
- public function key() { }
+ public function key() {}
/**
* Get current element
* @link https://php.net/manual/en/limititerator.current.php
* @return mixed the current element or null if there is none.
*/
- public function current() { }
+ public function current() {}
/**
* Move the iterator forward
* @link https://php.net/manual/en/limititerator.next.php
* @return void
*/
- public function next() { }
+ public function next() {}
/**
* Seek to the given position
@@ -674,61 +659,61 @@ public function next() { }
*
* @return int the offset position after seeking.
*/
- public function seek($offset) { }
+ public function seek($offset) {}
/**
* Return the current position
* @link https://php.net/manual/en/limititerator.getposition.php
* @return int The current position.
*/
- public function getPosition() { }
+ public function getPosition() {}
/**
* Get inner iterator
* @link https://php.net/manual/en/limititerator.getinneriterator.php
* @return Iterator The inner iterator passed to LimitIterator::__construct.
*/
- public function getInnerIterator() { }
+ public function getInnerIterator() {}
}
/**
* This object supports cached iteration over another iterator.
* @link https://php.net/manual/en/class.cachingiterator.php
*/
-class CachingIterator extends IteratorIterator implements ArrayAccess, Countable, Stringable {
-
+class CachingIterator extends IteratorIterator implements ArrayAccess, Countable, Stringable
+{
/**
* String conversion flag (mutually exclusive): Uses the current element for the iterator's string conversion.
* This converts the current element to a string only once, regardless of whether it is needed or not.
*/
- const CALL_TOSTRING = 1;
+ public const CALL_TOSTRING = 1;
/**
* String conversion flag (mutually exclusive). Uses the current key for the iterator's string conversion.
*/
- const TOSTRING_USE_KEY = 2;
+ public const TOSTRING_USE_KEY = 2;
/**
* String conversion flag (mutually exclusive). Uses the current element for the iterator's string conversion.
* This converts the current element to a string only when (and every time) it is needed.
*/
- const TOSTRING_USE_CURRENT = 4;
+ public const TOSTRING_USE_CURRENT = 4;
/**
* String conversion flag (mutually exclusive). Forwards the string conversion to the inner iterator.
* This converts the inner iterator to a string only once, regardless of whether it is needed or not.
*/
- const TOSTRING_USE_INNER = 8;
+ public const TOSTRING_USE_INNER = 8;
/**
* Ignore exceptions thrown in accessing children. Only used with {@see RecursiveCachingIterator}.
*/
- const CATCH_GET_CHILD = 16;
+ public const CATCH_GET_CHILD = 16;
/**
* Cache all read data. This is needed to use {@see CachingIterator::getCache}, and ArrayAccess and Countable methods.
*/
- const FULL_CACHE = 256;
+ public const FULL_CACHE = 256;
/**
* Constructs a new CachingIterator.
@@ -736,70 +721,70 @@ class CachingIterator extends IteratorIterator implements ArrayAccess, Countable
* @param Iterator $iterator The iterator to cache.
* @param int $flags [optional] A bitmask of flags. See CachingIterator class constants for details.
*/
- public function __construct(Iterator $iterator, $flags = self::CALL_TOSTRING) { }
+ public function __construct(Iterator $iterator, $flags = self::CALL_TOSTRING) {}
/**
* Rewind the iterator
* @link https://php.net/manual/en/cachingiterator.rewind.php
* @return void
*/
- public function rewind() { }
+ public function rewind() {}
/**
* Check whether the current element is valid
* @link https://php.net/manual/en/cachingiterator.valid.php
* @return bool true on success or false on failure.
*/
- public function valid() { }
+ public function valid() {}
/**
* Return the key for the current element
* @link https://php.net/manual/en/cachingiterator.key.php
* @return string|float|int|bool|null
*/
- public function key() { }
+ public function key() {}
/**
* Return the current element
* @link https://php.net/manual/en/cachingiterator.current.php
* @return mixed
*/
- public function current() { }
+ public function current() {}
/**
* Move the iterator forward
* @link https://php.net/manual/en/cachingiterator.next.php
* @return void
*/
- public function next() { }
+ public function next() {}
/**
* Check whether the inner iterator has a valid next element
* @link https://php.net/manual/en/cachingiterator.hasnext.php
* @return bool true on success or false on failure.
*/
- public function hasNext() { }
+ public function hasNext() {}
/**
* Return the string representation of the current iteration based on the flag being used.
* @link https://php.net/manual/en/cachingiterator.tostring.php
* @return string The string representation of the current iteration based on the flag being used.
*/
- public function __toString() { }
+ public function __toString() {}
/**
* Returns the inner iterator
* @link https://php.net/manual/en/cachingiterator.getinneriterator.php
* @return Iterator an object implementing the Iterator interface.
*/
- public function getInnerIterator() { }
+ public function getInnerIterator() {}
/**
* Get flags used
* @link https://php.net/manual/en/cachingiterator.getflags.php
* @return int Bitmask of the flags
*/
- public function getFlags() { }
+ public function getFlags() {}
/**
* The setFlags purpose
@@ -807,7 +792,7 @@ public function getFlags() { }
* @param int $flags Bitmask of the flags to set.
* @return void
*/
- public function setFlags($flags) { }
+ public function setFlags($flags) {}
/**
* Internal cache array index to retrieve.
@@ -816,7 +801,7 @@ public function setFlags($flags) { }
* @return mixed
* @throws BadMethodCallException when the {@see CachingIterator::FULL_CACHE} flag is not being used.
*/
- public function offsetGet($key) { }
+ public function offsetGet($key) {}
/**
* Set an element on the internal cache array.
@@ -826,7 +811,7 @@ public function offsetGet($key) { }
* @return void
* @throws BadMethodCallException when the {@see CachingIterator::FULL_CACHE} flag is not being used.
*/
- public function offsetSet($key, $value) { }
+ public function offsetSet($key, $value) {}
/**
* Remove an element from the internal cache array.
@@ -835,7 +820,7 @@ public function offsetSet($key, $value) { }
* @return void
* @throws BadMethodCallException when the {@see CachingIterator::FULL_CACHE} flag is not being used.
*/
- public function offsetUnset($key) { }
+ public function offsetUnset($key) {}
/**
* Return whether an element at the index exists on the internal cache array.
@@ -844,7 +829,7 @@ public function offsetUnset($key) { }
* @return bool true if an entry referenced by the offset exists, false otherwise.
* @throws BadMethodCallException when the {@see CachingIterator::FULL_CACHE} flag is not being used.
*/
- public function offsetExists($key) { }
+ public function offsetExists($key) {}
/**
* Retrieve the contents of the cache
@@ -852,7 +837,7 @@ public function offsetExists($key) { }
* @return array An array containing the cache items.
* @throws BadMethodCallException when the {@see CachingIterator::FULL_CACHE} flag is not being used.
*/
- public function getCache() { }
+ public function getCache() {}
/**
* The number of elements in the iterator
@@ -861,106 +846,105 @@ public function getCache() { }
* @throws BadMethodCallException when the {@see CachingIterator::FULL_CACHE} flag is not being used.
* @since 5.2.2
*/
- public function count() { }
+ public function count() {}
}
/**
* ...
* @link https://php.net/manual/en/class.recursivecachingiterator.php
*/
-class RecursiveCachingIterator extends CachingIterator implements RecursiveIterator {
-
+class RecursiveCachingIterator extends CachingIterator implements RecursiveIterator
+{
/**
* Constructs a new RecursiveCachingIterator.
* @link https://php.net/manual/en/recursivecachingiterator.construct.php
* @param Iterator $iterator The iterator to cache.
* @param int $flags [optional] A bitmask of flags. See CachingIterator class constants for details.
*/
- public function __construct(Iterator $iterator, $flags = self::CALL_TOSTRING) { }
+ public function __construct(Iterator $iterator, $flags = self::CALL_TOSTRING) {}
/**
* Check whether the current element of the inner iterator has children
* @link https://php.net/manual/en/recursivecachingiterator.haschildren.php
* @return bool true if the inner iterator has children, otherwise false
*/
- public function hasChildren() { }
+ public function hasChildren() {}
/**
* Return the inner iterator's children as a RecursiveCachingIterator
* @link https://php.net/manual/en/recursivecachingiterator.getchildren.php
* @return RecursiveCachingIterator The inner iterator's children, as a RecursiveCachingIterator.
*/
- public function getChildren() { }
+ public function getChildren() {}
}
-
/**
* This iterator cannot be rewinded.
* @link https://php.net/manual/en/class.norewinditerator.php
*/
-class NoRewindIterator extends IteratorIterator {
-
+class NoRewindIterator extends IteratorIterator
+{
/**
* Construct a NoRewindIterator
* @link https://php.net/manual/en/norewinditerator.construct.php
* @param Iterator $iterator
*/
- public function __construct(Iterator $iterator) { }
+ public function __construct(Iterator $iterator) {}
/**
* Prevents the rewind operation on the inner iterator.
* @link https://php.net/manual/en/norewinditerator.rewind.php
* @return void
*/
- public function rewind() { }
+ public function rewind() {}
/**
* Validates the iterator
* @link https://php.net/manual/en/norewinditerator.valid.php
* @return bool true on success or false on failure.
*/
- public function valid() { }
+ public function valid() {}
/**
* Get the current key
* @link https://php.net/manual/en/norewinditerator.key.php
* @return string|float|int|bool|null The current key.
*/
- public function key() { }
+ public function key() {}
/**
* Get the current value
* @link https://php.net/manual/en/norewinditerator.current.php
* @return mixed The current value.
*/
- public function current() { }
+ public function current() {}
/**
* Forward to the next element
* @link https://php.net/manual/en/norewinditerator.next.php
* @return void
*/
- public function next() { }
+ public function next() {}
/**
* Get the inner iterator
* @link https://php.net/manual/en/norewinditerator.getinneriterator.php
* @return Iterator The inner iterator, as passed to NoRewindIterator::__construct.
*/
- public function getInnerIterator() { }
+ public function getInnerIterator() {}
}
/**
* An Iterator that iterates over several iterators one after the other.
* @link https://php.net/manual/en/class.appenditerator.php
*/
-class AppendIterator extends IteratorIterator {
-
+class AppendIterator extends IteratorIterator
+{
/**
* Constructs an AppendIterator
* @link https://php.net/manual/en/appenditerator.construct.php
*/
- public function __construct() { }
+ public function __construct() {}
/**
* Appends an iterator
@@ -970,63 +954,63 @@ public function __construct() { }
*
* @return void
*/
- public function append(Iterator $iterator) { }
+ public function append(Iterator $iterator) {}
/**
* Rewinds the Iterator
* @link https://php.net/manual/en/appenditerator.rewind.php
* @return void
*/
- public function rewind() { }
+ public function rewind() {}
/**
* Checks validity of the current element
* @link https://php.net/manual/en/appenditerator.valid.php
* @return bool true on success or false on failure.
*/
- public function valid() { }
+ public function valid() {}
/**
* Gets the current key
* @link https://php.net/manual/en/appenditerator.key.php
* @return string|float|int|bool|null The current key if it is valid or null otherwise.
*/
- public function key() { }
+ public function key() {}
/**
* Gets the current value
* @link https://php.net/manual/en/appenditerator.current.php
* @return mixed The current value if it is valid or null otherwise.
*/
- public function current() { }
+ public function current() {}
/**
* Moves to the next element
* @link https://php.net/manual/en/appenditerator.next.php
* @return void
*/
- public function next() { }
+ public function next() {}
/**
* Gets an inner iterator
* @link https://php.net/manual/en/appenditerator.getinneriterator.php
* @return Iterator the current inner Iterator.
*/
- public function getInnerIterator() { }
+ public function getInnerIterator() {}
/**
* Gets an index of iterators
* @link https://php.net/manual/en/appenditerator.getiteratorindex.php
* @return int The index of iterators.
*/
- public function getIteratorIndex() { }
+ public function getIteratorIndex() {}
/**
* The getArrayIterator method
* @link https://php.net/manual/en/appenditerator.getarrayiterator.php
* @return ArrayIterator containing the appended iterators.
*/
- public function getArrayIterator() { }
+ public function getArrayIterator() {}
}
/**
@@ -1035,64 +1019,63 @@ public function getArrayIterator() { }
* rewind the iterator upon reaching its end.
* @link https://php.net/manual/en/class.infiniteiterator.php
*/
-class InfiniteIterator extends IteratorIterator {
-
+class InfiniteIterator extends IteratorIterator
+{
/**
* Constructs an InfiniteIterator
* @link https://php.net/manual/en/infiniteiterator.construct.php
* @param Iterator $iterator
*/
- public function __construct(Iterator $iterator) { }
+ public function __construct(Iterator $iterator) {}
/**
* Moves the inner Iterator forward or rewinds it
* @link https://php.net/manual/en/infiniteiterator.next.php
* @return void
*/
- public function next() { }
+ public function next() {}
}
/**
* This iterator can be used to filter another iterator based on a regular expression.
* @link https://php.net/manual/en/class.regexiterator.php
*/
-class RegexIterator extends FilterIterator {
-
+class RegexIterator extends FilterIterator
+{
/**
* Return all matches for the current entry @see preg_match_all
*/
- const ALL_MATCHES = 2;
+ public const ALL_MATCHES = 2;
/**
* Return the first match for the current entry @see preg_match
*/
- const GET_MATCH = 1;
+ public const GET_MATCH = 1;
/**
* Only execute match (filter) for the current entry @see preg_match
*/
- const MATCH = 0;
+ public const MATCH = 0;
/**
* Replace the current entry (Not fully implemented yet) @see preg_replace
*/
- const REPLACE = 4;
+ public const REPLACE = 4;
/**
* Returns the split values for the current entry @see preg_split
*/
- const SPLIT = 3;
+ public const SPLIT = 3;
/**
* Special flag: Match the entry key instead of the entry value.
*/
- const USE_KEY = 1;
+ public const USE_KEY = 1;
- const INVERT_MATCH = 2;
+ public const INVERT_MATCH = 2;
public $replacement;
-
/**
* Create a new RegexIterator
* @link https://php.net/manual/en/regexiterator.construct.php
@@ -1102,21 +1085,21 @@ class RegexIterator extends FilterIterator {
* @param int $flags [optional] Special flags, see RegexIterator::setFlags() for a list of available flags.
* @param int $pregFlags [optional] The regular expression flags. These flags depend on the operation mode parameter
*/
- public function __construct(Iterator $iterator, $pattern, $mode = self::MATCH, $flags = 0, $pregFlags = 0) { }
+ public function __construct(Iterator $iterator, $pattern, $mode = self::MATCH, $flags = 0, $pregFlags = 0) {}
/**
* Get accept status
* @link https://php.net/manual/en/regexiterator.accept.php
* @return bool true if a match, false otherwise.
*/
- public function accept() { }
+ public function accept() {}
/**
* Returns operation mode.
* @link https://php.net/manual/en/regexiterator.getmode.php
* @return int the operation mode.
*/
- public function getMode() { }
+ public function getMode() {}
/**
* Sets the operation mode.
@@ -1168,14 +1151,14 @@ public function getMode() { }
*
* @return void
*/
- public function setMode($mode) { }
+ public function setMode($mode) {}
/**
* Get flags
* @link https://php.net/manual/en/regexiterator.getflags.php
* @return int the set flags.
*/
- public function getFlags() { }
+ public function getFlags() {}
/**
* Sets the flags.
@@ -1203,14 +1186,14 @@ public function getFlags() { }
*
* @return void
*/
- public function setFlags($flags) { }
+ public function setFlags($flags) {}
/**
- * Returns current regular expression
- * @link https://secure.php.net/manual/en/regexiterator.getregex.php
- * @return string
- * @since 5.4
- */
+ * Returns current regular expression
+ * @link https://secure.php.net/manual/en/regexiterator.getregex.php
+ * @return string
+ * @since 5.4
+ */
public function getRegex() {}
/**
@@ -1218,7 +1201,7 @@ public function getRegex() {}
* @link https://php.net/manual/en/regexiterator.getpregflags.php
* @return int a bitmask of the regular expression flags.
*/
- public function getPregFlags() { }
+ public function getPregFlags() {}
/**
* Sets the regular expression flags.
@@ -1229,14 +1212,15 @@ public function getPregFlags() { }
*
* @return void
*/
- public function setPregFlags($pregFlags) { }
+ public function setPregFlags($pregFlags) {}
}
/**
* This recursive iterator can filter another recursive iterator via a regular expression.
* @link https://php.net/manual/en/class.recursiveregexiterator.php
*/
-class RecursiveRegexIterator extends RegexIterator implements RecursiveIterator {
+class RecursiveRegexIterator extends RegexIterator implements RecursiveIterator
+{
/**
* Creates a new RecursiveRegexIterator.
* @link https://php.net/manual/en/recursiveregexiterator.construct.php
@@ -1246,39 +1230,38 @@ class RecursiveRegexIterator extends RegexIterator implements RecursiveIterator
* @param int $flags [optional] Special flags, see RegexIterator::setFlags() for a list of available flags.
* @param int $pregFlags [optional] The regular expression flags. These flags depend on the operation mode parameter
*/
- public function __construct(RecursiveIterator $iterator, $pattern, $mode = self::MATCH, $flags = 0, $pregFlags = 0) { }
+ public function __construct(RecursiveIterator $iterator, $pattern, $mode = self::MATCH, $flags = 0, $pregFlags = 0) {}
/**
* Returns whether an iterator can be obtained for the current entry.
* @link https://php.net/manual/en/recursiveregexiterator.haschildren.php
* @return bool true if an iterator can be obtained for the current entry, otherwise returns false.
*/
- public function hasChildren() { }
+ public function hasChildren() {}
/**
* Returns an iterator for the current entry.
* @link https://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.
*/
- public function getChildren() { }
+ public function getChildren() {}
}
/**
* Allows iterating over a RecursiveIterator to generate an ASCII graphic tree.
* @link https://php.net/manual/en/class.recursivetreeiterator.php
*/
-class RecursiveTreeIterator extends RecursiveIteratorIterator {
-
- const BYPASS_CURRENT = 4;
- const BYPASS_KEY = 8;
-
- const PREFIX_LEFT = 0;
- const PREFIX_MID_HAS_NEXT = 1;
- const PREFIX_MID_LAST = 2;
- const PREFIX_END_HAS_NEXT = 3;
- const PREFIX_END_LAST = 4;
- const PREFIX_RIGHT = 5;
+class RecursiveTreeIterator extends RecursiveIteratorIterator
+{
+ public const BYPASS_CURRENT = 4;
+ public const BYPASS_KEY = 8;
+ public const PREFIX_LEFT = 0;
+ public const PREFIX_MID_HAS_NEXT = 1;
+ public const PREFIX_MID_LAST = 2;
+ public const PREFIX_END_HAS_NEXT = 3;
+ public const PREFIX_END_LAST = 4;
+ public const PREFIX_RIGHT = 5;
/**
* Construct a RecursiveTreeIterator
@@ -1289,98 +1272,98 @@ class RecursiveTreeIterator extends RecursiveIteratorIterator {
* @param int $mode [optional] Flags to affect the behavior of the {@see RecursiveIteratorIterator} used internally.
*/
public function __construct($iterator, $flags = self::BYPASS_KEY, $cachingIteratorFlags = CachingIterator::CATCH_GET_CHILD,
- $mode = self::SELF_FIRST) { }
+ $mode = self::SELF_FIRST) {}
/**
* Rewind iterator
* @link https://php.net/manual/en/recursivetreeiterator.rewind.php
* @return void
*/
- public function rewind() { }
+ public function rewind() {}
/**
* Check validity
* @link https://php.net/manual/en/recursivetreeiterator.valid.php
* @return bool true if the current position is valid, otherwise false
*/
- public function valid() { }
+ public function valid() {}
/**
* Get the key of the current element
* @link https://php.net/manual/en/recursivetreeiterator.key.php
* @return string the current key prefixed and postfixed.
*/
- public function key() { }
+ public function key() {}
/**
* Get current element
* @link https://php.net/manual/en/recursivetreeiterator.current.php
* @return string the current element prefixed and postfixed.
*/
- public function current() { }
+ public function current() {}
/**
* Move to next element
* @link https://php.net/manual/en/recursivetreeiterator.next.php
* @return void
*/
- public function next() { }
+ public function next() {}
/**
* Begin iteration
* @link https://php.net/manual/en/recursivetreeiterator.beginiteration.php
* @return RecursiveIterator A RecursiveIterator.
*/
- public function beginIteration() { }
+ public function beginIteration() {}
/**
* End iteration
* @link https://php.net/manual/en/recursivetreeiterator.enditeration.php
* @return void
*/
- public function endIteration() { }
+ public function endIteration() {}
/**
* Has children
* @link https://php.net/manual/en/recursivetreeiterator.callhaschildren.php
* @return bool true if there are children, otherwise false
*/
- public function callHasChildren() { }
+ public function callHasChildren() {}
/**
* Get children
* @link https://php.net/manual/en/recursivetreeiterator.callgetchildren.php
* @return RecursiveIterator A RecursiveIterator.
*/
- public function callGetChildren() { }
+ public function callGetChildren() {}
/**
* Begin children
* @link https://php.net/manual/en/recursivetreeiterator.beginchildren.php
* @return void
*/
- public function beginChildren() { }
+ public function beginChildren() {}
/**
* End children
* @link https://php.net/manual/en/recursivetreeiterator.endchildren.php
* @return void
*/
- public function endChildren() { }
+ public function endChildren() {}
/**
* Next element
* @link https://php.net/manual/en/recursivetreeiterator.nextelement.php
* @return void
*/
- public function nextElement() { }
+ public function nextElement() {}
/**
* Get the prefix
* @link https://php.net/manual/en/recursivetreeiterator.getprefix.php
* @return string the string to place in front of current element
*/
- public function getPrefix() { }
+ public function getPrefix() {}
/**
* @param string $postfix
@@ -1398,38 +1381,38 @@ public function setPostfix($postfix) {}
*
* @return void
*/
- public function setPrefixPart($part, $value) { }
+ public function setPrefixPart($part, $value) {}
/**
* Get current entry
* @link https://php.net/manual/en/recursivetreeiterator.getentry.php
* @return string the part of the tree built for the current element.
*/
- public function getEntry() { }
+ public function getEntry() {}
/**
* Get the postfix
* @link https://php.net/manual/en/recursivetreeiterator.getpostfix.php
* @return string to place after the current element.
*/
- public function getPostfix() { }
+ public function getPostfix() {}
}
/**
* This class allows objects to work as arrays.
* @link https://php.net/manual/en/class.arrayobject.php
*/
-class ArrayObject implements IteratorAggregate, ArrayAccess, Serializable, Countable {
+class ArrayObject implements IteratorAggregate, ArrayAccess, Serializable, Countable
+{
/**
* Properties of the object have their normal functionality when accessed as list (var_dump, foreach, etc.).
*/
- const STD_PROP_LIST = 1;
+ public const STD_PROP_LIST = 1;
/**
* Entries can be accessed as properties (read and write).
*/
- const ARRAY_AS_PROPS = 2;
-
+ public const ARRAY_AS_PROPS = 2;
/**
* Construct a new array object
@@ -1437,9 +1420,8 @@ class ArrayObject implements IteratorAggregate, ArrayAccess, Serializable, Count
* @param array|object $array The input parameter accepts an array or an Object.
* @param int $flags Flags to control the behaviour of the ArrayObject object.
* @param string $iteratorClass Specify the class that will be used for iteration of the ArrayObject object. ArrayIterator is the default class used.
- *
*/
- public function __construct($array = array(), $flags = 0, $iteratorClass = "ArrayIterator") { }
+ public function __construct($array = [], $flags = 0, $iteratorClass = "ArrayIterator") {}
/**
* Returns whether the requested index exists
@@ -1449,7 +1431,7 @@ public function __construct($array = array(), $flags = 0, $iteratorClass = "Arra
*
* @return bool true if the requested index exists, otherwise false
*/
- public function offsetExists($key) { }
+ public function offsetExists($key) {}
/**
* Returns the value at the specified index
@@ -1459,7 +1441,7 @@ public function offsetExists($key) { }
*
* @return mixed|false The value at the specified index or false.
*/
- public function offsetGet($key) { }
+ public function offsetGet($key) {}
/**
* Sets the value at the specified index to newval
@@ -1472,7 +1454,7 @@ public function offsetGet($key) { }
*
* @return void
*/
- public function offsetSet($key, $value) { }
+ public function offsetSet($key, $value) {}
/**
* Unsets the value at the specified index
@@ -1482,7 +1464,7 @@ public function offsetSet($key, $value) { }
*
* @return void
*/
- public function offsetUnset($key) { }
+ public function offsetUnset($key) {}
/**
* Appends the value
@@ -1492,7 +1474,7 @@ public function offsetUnset($key) { }
*
* @return void
*/
- public function append($value) { }
+ public function append($value) {}
/**
* Creates a copy of the ArrayObject.
@@ -1500,7 +1482,7 @@ public function append($value) { }
* @return array a copy of the array. When the ArrayObject refers to an object
* an array of the public properties of that object will be returned.
*/
- public function getArrayCopy() { }
+ public function getArrayCopy() {}
/**
* Get the number of public properties in the ArrayObject
@@ -1508,14 +1490,14 @@ public function getArrayCopy() { }
* @link https://php.net/manual/en/arrayobject.count.php
* @return int The number of public properties in the ArrayObject.
*/
- public function count() { }
+ public function count() {}
/**
* Gets the behavior flags.
* @link https://php.net/manual/en/arrayobject.getflags.php
* @return int the behavior flags of the ArrayObject.
*/
- public function getFlags() { }
+ public function getFlags() {}
/**
* Sets the behavior flags.
@@ -1552,7 +1534,7 @@ public function getFlags() { }
*
* @return void
*/
- public function setFlags($flags) { }
+ public function setFlags($flags) {}
/**
* Sort the entries by value
@@ -1560,7 +1542,7 @@ public function setFlags($flags) { }
* @param int $flags [optional]
* @return void
*/
- public function asort($flags = SORT_REGULAR) { }
+ public function asort($flags = SORT_REGULAR) {}
/**
* Sort the entries by key
@@ -1568,7 +1550,7 @@ public function asort($flags = SORT_REGULAR) { }
* @param int $flags [optional]
* @return void
*/
- public function ksort($flags = SORT_REGULAR) { }
+ public function ksort($flags = SORT_REGULAR) {}
/**
* Sort the entries with a user-defined comparison function and maintain key association
@@ -1583,7 +1565,7 @@ public function ksort($flags = SORT_REGULAR) { }
*
* @return void
*/
- public function uasort($callback) { }
+ public function uasort($callback) {}
/**
* Sort the entries by keys using a user-defined comparison function
@@ -1601,21 +1583,21 @@ public function uasort($callback) { }
*
* @return void
*/
- public function uksort($callback) { }
+ public function uksort($callback) {}
/**
* Sort entries using a "natural order" algorithm
* @link https://php.net/manual/en/arrayobject.natsort.php
* @return void
*/
- public function natsort() { }
+ public function natsort() {}
/**
* Sort an array using a case insensitive "natural order" algorithm
* @link https://php.net/manual/en/arrayobject.natcasesort.php
* @return void
*/
- public function natcasesort() { }
+ public function natcasesort() {}
/**
* Unserialize an ArrayObject
@@ -1625,21 +1607,20 @@ public function natcasesort() { }
*
* @return void The unserialized ArrayObject.
*/
- public function unserialize($data) { }
+ public function unserialize($data) {}
/**
* Serialize an ArrayObject
* @link https://php.net/manual/en/arrayobject.serialize.php
* @return string The serialized representation of the ArrayObject.
*/
- public function serialize() { }
+ public function serialize() {}
/**
* @return array
* @since 7.4
*/
- public function __debugInfo(){}
-
+ public function __debugInfo() {}
/**
* @return array
@@ -1658,7 +1639,7 @@ public function __unserialize(array $data) {}
* @link https://php.net/manual/en/arrayobject.getiterator.php
* @return ArrayIterator An iterator from an ArrayObject.
*/
- public function getIterator() { }
+ public function getIterator() {}
/**
* Exchange the array for another one.
@@ -1668,7 +1649,7 @@ public function getIterator() { }
*
* @return array the old array.
*/
- public function exchangeArray($array) { }
+ public function exchangeArray($array) {}
/**
* Sets the iterator classname for the ArrayObject.
@@ -1678,14 +1659,14 @@ public function exchangeArray($array) { }
*
* @return void
*/
- public function setIteratorClass($iteratorClass) { }
+ public function setIteratorClass($iteratorClass) {}
/**
* Gets the iterator classname for the ArrayObject.
* @link https://php.net/manual/en/arrayobject.getiteratorclass.php
* @return string the iterator class name that is used to iterate over this object.
*/
- public function getIteratorClass() { }
+ public function getIteratorClass() {}
}
/**
@@ -1693,10 +1674,10 @@ public function getIteratorClass() { }
* over Arrays and Objects.
* @link https://php.net/manual/en/class.arrayiterator.php
*/
-class ArrayIterator implements SeekableIterator, ArrayAccess, Serializable, Countable {
- const STD_PROP_LIST = 1;
- const ARRAY_AS_PROPS = 2;
-
+class ArrayIterator implements SeekableIterator, ArrayAccess, Serializable, Countable
+{
+ public const STD_PROP_LIST = 1;
+ public const ARRAY_AS_PROPS = 2;
/**
* Construct an ArrayIterator
@@ -1705,7 +1686,7 @@ class ArrayIterator implements SeekableIterator, ArrayAccess, Serializable, Coun
* @param int $flags Flags to control the behaviour of the ArrayObject object.
* @see ArrayObject::setFlags()
*/
- public function __construct($array = array(), $flags = 0) { }
+ public function __construct($array = [], $flags = 0) {}
/**
* Check if offset exists
@@ -1715,7 +1696,7 @@ public function __construct($array = array(), $flags = 0) { }
*
* @return bool true if the offset exists, otherwise false
*/
- public function offsetExists($key) { }
+ public function offsetExists($key) {}
/**
* Get value for an offset
@@ -1725,7 +1706,7 @@ public function offsetExists($key) { }
*
* @return mixed The value at offset index.
*/
- public function offsetGet($key) { }
+ public function offsetGet($key) {}
/**
* Set value for an offset
@@ -1738,7 +1719,7 @@ public function offsetGet($key) { }
*
* @return void
*/
- public function offsetSet($key, $value) { }
+ public function offsetSet($key, $value) {}
/**
* Unset value for an offset
@@ -1748,7 +1729,7 @@ public function offsetSet($key, $value) { }
*
* @return void
*/
- public function offsetUnset($key) { }
+ public function offsetUnset($key) {}
/**
* Append an element
@@ -1758,7 +1739,7 @@ public function offsetUnset($key) { }
*
* @return void
*/
- public function append($value) { }
+ public function append($value) {}
/**
* Get array copy
@@ -1766,7 +1747,7 @@ public function append($value) { }
* @return array A copy of the array, or array of public properties
* if ArrayIterator refers to an object.
*/
- public function getArrayCopy() { }
+ public function getArrayCopy() {}
/**
* Count elements
@@ -1774,14 +1755,14 @@ public function getArrayCopy() { }
* @return int The number of elements or public properties in the associated
* array or object, respectively.
*/
- public function count() { }
+ public function count() {}
/**
* Get flags
* @link https://php.net/manual/en/arrayiterator.getflags.php
* @return string The current flags.
*/
- public function getFlags() { }
+ public function getFlags() {}
/**
* Set behaviour flags
@@ -1794,7 +1775,7 @@ public function getFlags() { }
*
* @return void
*/
- public function setFlags($flags) { }
+ public function setFlags($flags) {}
/**
* Sort array by values
@@ -1802,7 +1783,7 @@ public function setFlags($flags) { }
* @param int $flags [optional]
* @return void
*/
- public function asort($flags = SORT_REGULAR) { }
+ public function asort($flags = SORT_REGULAR) {}
/**
* Sort array by keys
@@ -1810,7 +1791,7 @@ public function asort($flags = SORT_REGULAR) { }
* @param int $flags [optional]
* @return void
*/
- public function ksort($flags = SORT_REGULAR) { }
+ public function ksort($flags = SORT_REGULAR) {}
/**
* User defined sort
@@ -1820,7 +1801,7 @@ public function ksort($flags = SORT_REGULAR) { }
*
* @return void
*/
- public function uasort($callback) { }
+ public function uasort($callback) {}
/**
* User defined sort
@@ -1830,21 +1811,21 @@ public function uasort($callback) { }
*
* @return void
*/
- public function uksort($callback) { }
+ public function uksort($callback) {}
/**
* Sort an array naturally
* @link https://php.net/manual/en/arrayiterator.natsort.php
* @return void
*/
- public function natsort() { }
+ public function natsort() {}
/**
* Sort an array naturally, case insensitive
* @link https://php.net/manual/en/arrayiterator.natcasesort.php
* @return void
*/
- public function natcasesort() { }
+ public function natcasesort() {}
/**
* Unserialize
@@ -1854,49 +1835,49 @@ public function natcasesort() { }
*
* @return string The ArrayIterator.
*/
- public function unserialize($data) { }
+ public function unserialize($data) {}
/**
* Serialize
* @link https://php.net/manual/en/arrayiterator.serialize.php
* @return string The serialized ArrayIterator.
*/
- public function serialize() { }
+ public function serialize() {}
/**
* Rewind array back to the start
* @link https://php.net/manual/en/arrayiterator.rewind.php
* @return void
*/
- public function rewind() { }
+ public function rewind() {}
/**
* Return current array entry
* @link https://php.net/manual/en/arrayiterator.current.php
* @return mixed The current array entry.
*/
- public function current() { }
+ public function current() {}
/**
* Return current array key
* @link https://php.net/manual/en/arrayiterator.key.php
* @return string|float|int|bool|null The current array key.
*/
- public function key() { }
+ public function key() {}
/**
* Move to next entry
* @link https://php.net/manual/en/arrayiterator.next.php
* @return void
*/
- public function next() { }
+ public function next() {}
/**
* Check whether array contains more entries
* @link https://php.net/manual/en/arrayiterator.valid.php
* @return bool
*/
- public function valid() { }
+ public function valid() {}
/**
* Seek to position
@@ -1906,14 +1887,13 @@ public function valid() { }
*
* @return void
*/
- public function seek($offset) { }
+ public function seek($offset) {}
/**
* @return array
* @since 7.4
*/
- public function __debugInfo(){}
-
+ public function __debugInfo() {}
/**
* @return array
@@ -1926,7 +1906,6 @@ public function __serialize() {}
* @since 7.4
*/
public function __unserialize(array $data) {}
-
}
/**
@@ -1935,9 +1914,9 @@ public function __unserialize(array $data) {}
* over the current iterator entry.
* @link https://php.net/manual/en/class.recursivearrayiterator.php
*/
-class RecursiveArrayIterator extends ArrayIterator implements RecursiveIterator {
- const CHILD_ARRAYS_ONLY = 4;
-
+class RecursiveArrayIterator extends ArrayIterator implements RecursiveIterator
+{
+ public const CHILD_ARRAYS_ONLY = 4;
/**
* Returns whether current entry is an array or an object.
@@ -1945,12 +1924,12 @@ class RecursiveArrayIterator extends ArrayIterator implements RecursiveIterator
* @return bool true if the current entry is an array or an object,
* otherwise false is returned.
*/
- public function hasChildren() { }
+ public function hasChildren() {}
/**
* Returns an iterator for the current entry if it is an array or an object.
* @link https://php.net/manual/en/recursivearrayiterator.getchildren.php
* @return RecursiveArrayIterator An iterator for the current entry, if it is an array or object.
*/
- public function getChildren() { }
+ public function getChildren() {}
}
diff --git a/SPL/SPL_c1.php b/SPL/SPL_c1.php
index 5d390ddb4..1a210b75a 100644
--- a/SPL/SPL_c1.php
+++ b/SPL/SPL_c1.php
@@ -8,15 +8,15 @@
* information for an individual file.
* @link https://php.net/manual/en/class.splfileinfo.php
*/
-class SplFileInfo implements Stringable {
-
+class SplFileInfo implements Stringable
+{
/**
* Construct a new SplFileInfo object
* @link https://php.net/manual/en/splfileinfo.construct.php
* @param string $filename
* @since 5.1.2
*/
- public function __construct ($filename) {}
+ public function __construct($filename) {}
/**
* Gets the path without filename
@@ -24,7 +24,7 @@ public function __construct ($filename) {}
* @return string the path to the file.
* @since 5.1.2
*/
- public function getPath () {}
+ public function getPath() {}
/**
* Gets the filename
@@ -32,7 +32,7 @@ public function getPath () {}
* @return string The filename.
* @since 5.1.2
*/
- public function getFilename () {}
+ public function getFilename() {}
/**
* Gets the file extension
@@ -41,7 +41,7 @@ public function getFilename () {}
* empty string if the file has no extension.
* @since 5.3.6
*/
- public function getExtension () {}
+ public function getExtension() {}
/**
* Gets the base name of the file
@@ -52,7 +52,7 @@ public function getExtension () {}
* @return string the base name without path information.
* @since 5.2.2
*/
- public function getBasename ($suffix = null) {}
+ public function getBasename($suffix = null) {}
/**
* Gets the path to the file
@@ -60,7 +60,7 @@ public function getBasename ($suffix = null) {}
* @return string The path to the file.
* @since 5.1.2
*/
- public function getPathname () {}
+ public function getPathname() {}
/**
* Gets file permissions
@@ -68,7 +68,7 @@ public function getPathname () {}
* @return int the file permissions.
* @since 5.1.2
*/
- public function getPerms () {}
+ public function getPerms() {}
/**
* Gets the inode for the file
@@ -76,7 +76,7 @@ public function getPerms () {}
* @return int the inode number for the filesystem object.
* @since 5.1.2
*/
- public function getInode () {}
+ public function getInode() {}
/**
* Gets file size
@@ -84,7 +84,7 @@ public function getInode () {}
* @return int The filesize in bytes.
* @since 5.1.2
*/
- public function getSize () {}
+ public function getSize() {}
/**
* Gets the owner of the file
@@ -92,7 +92,7 @@ public function getSize () {}
* @return int The owner id in numerical format.
* @since 5.1.2
*/
- public function getOwner () {}
+ public function getOwner() {}
/**
* Gets the file group
@@ -100,7 +100,7 @@ public function getOwner () {}
* @return int The group id in numerical format.
* @since 5.1.2
*/
- public function getGroup () {}
+ public function getGroup() {}
/**
* Gets last access time of the file
@@ -108,7 +108,7 @@ public function getGroup () {}
* @return int the time the file was last accessed.
* @since 5.1.2
*/
- public function getATime () {}
+ public function getATime() {}
/**
* Gets the last modified time
@@ -116,7 +116,7 @@ public function getATime () {}
* @return int the last modified time for the file, in a Unix timestamp.
* @since 5.1.2
*/
- public function getMTime () {}
+ public function getMTime() {}
/**
* Gets the inode change time
@@ -124,7 +124,7 @@ public function getMTime () {}
* @return int The last change time, in a Unix timestamp.
* @since 5.1.2
*/
- public function getCTime () {}
+ public function getCTime() {}
/**
* Gets file type
@@ -134,7 +134,7 @@ public function getCTime () {}
* or dir
* @since 5.1.2
*/
- public function getType () {}
+ public function getType() {}
/**
* Tells if the entry is writable
@@ -142,7 +142,7 @@ public function getType () {}
* @return bool true if writable, false otherwise;
* @since 5.1.2
*/
- public function isWritable () {}
+ public function isWritable() {}
/**
* Tells if file is readable
@@ -150,7 +150,7 @@ public function isWritable () {}
* @return bool true if readable, false otherwise.
* @since 5.1.2
*/
- public function isReadable () {}
+ public function isReadable() {}
/**
* Tells if the file is executable
@@ -158,7 +158,7 @@ public function isReadable () {}
* @return bool true if executable, false otherwise.
* @since 5.1.2
*/
- public function isExecutable () {}
+ public function isExecutable() {}
/**
* Tells if the object references a regular file
@@ -166,7 +166,7 @@ public function isExecutable () {}
* @return bool true if the file exists and is a regular file (not a link), false otherwise.
* @since 5.1.2
*/
- public function isFile () {}
+ public function isFile() {}
/**
* Tells if the file is a directory
@@ -174,7 +174,7 @@ public function isFile () {}
* @return bool true if a directory, false otherwise.
* @since 5.1.2
*/
- public function isDir () {}
+ public function isDir() {}
/**
* Tells if the file is a link
@@ -182,7 +182,7 @@ public function isDir () {}
* @return bool true if the file is a link, false otherwise.
* @since 5.1.2
*/
- public function isLink () {}
+ public function isLink() {}
/**
* Gets the target of a link
@@ -190,7 +190,7 @@ public function isLink () {}
* @return string the target of the filesystem link.
* @since 5.2.2
*/
- public function getLinkTarget () {}
+ public function getLinkTarget() {}
/**
* Gets absolute path to file
@@ -198,49 +198,49 @@ public function getLinkTarget () {}
* @return string|false the path to the file, or FALSE if the file does not exist.
* @since 5.2.2
*/
- public function getRealPath () {}
+ public function getRealPath() {}
/**
* Gets an SplFileInfo object for the file
* @link https://php.net/manual/en/splfileinfo.getfileinfo.php
* @param string $class [optional] - * Name of an SplFileInfo derived class to use. + * Name of an SplFileInfo derived class to use. *
- * @return SplFileInfo An SplFileInfo object created for the file. + * @return SplFileInfo An SplFileInfo object created for the file. * @since 5.1.2 */ - public function getFileInfo ($class = null) {} + public function getFileInfo($class = null) {} /** * Gets an SplFileInfo object for the path * @link https://php.net/manual/en/splfileinfo.getpathinfo.php * @param string $class [optional]- * Name of an SplFileInfo derived class to use. + * Name of an SplFileInfo derived class to use. *
- * @return SplFileInfo an SplFileInfo object for the parent path of the file. + * @return SplFileInfo an SplFileInfo object for the parent path of the file. * @since 5.1.2 */ - public function getPathInfo ($class = null) {} + public function getPathInfo($class = null) {} - /** - * Gets an SplFileObject object for the file - * @link https://php.net/manual/en/splfileinfo.openfile.php - * @param string $mode [optional]- * The mode for opening the file. See the fopen - * documentation for descriptions of possible modes. The default - * is read only. - *
- * @param bool $useIncludePath [optional]- *
- * @param resource $context [optional]- *
- * @return SplFileObject The opened file as an SplFileObject object. - * @since 5.1.2 - */ - public function openFile ($mode = 'r', $useIncludePath = false, $context = null) {} + /** + * Gets an SplFileObject object for the file + * @link https://php.net/manual/en/splfileinfo.openfile.php + * @param string $mode [optional]+ * The mode for opening the file. See the fopen + * documentation for descriptions of possible modes. The default + * is read only. + *
+ * @param bool $useIncludePath [optional]+ *
+ * @param resource $context [optional]+ *
+ * @return SplFileObject The opened file as an SplFileObject object. + * @since 5.1.2 + */ + public function openFile($mode = 'r', $useIncludePath = false, $context = null) {} /** - * Sets the class name used with SplFileInfo::openFile + * Sets the class name used with SplFileInfo::openFile * @link https://php.net/manual/en/splfileinfo.setfileclass.php * @param string $class [optional]* The class name to use when openFile() is called. @@ -248,7 +248,7 @@ public function openFile ($mode = 'r', $useIncludePath = false, $context = null) * @return void * @since 5.1.2 */ - public function setFileClass ($class = SplFileObject::class) {} + public function setFileClass($class = SplFileObject::class) {} /** * Sets the class used with getFileInfo and getPathInfo @@ -259,7 +259,7 @@ public function setFileClass ($class = SplFileObject::class) {} * @return void * @since 5.1.2 */ - public function setInfoClass ($class = SplFileInfo::class) {} + public function setInfoClass($class = SplFileInfo::class) {} /** * Returns the path to the file as a string @@ -267,19 +267,17 @@ public function setInfoClass ($class = SplFileInfo::class) {} * @return string the path to the file. * @since 5.1.2 */ - public function __toString () {} + public function __toString() {} - public final function _bad_state_ex (){} + final public function _bad_state_ex() {} - public function __wakeup() - { - } + public function __wakeup() {} /** * @return array * @since 7.4 */ - public function __debugInfo(){} + public function __debugInfo() {} } /** @@ -287,8 +285,8 @@ public function __debugInfo(){} * the contents of filesystem directories. * @link https://php.net/manual/en/class.directoryiterator.php */ -class DirectoryIterator extends SplFileInfo implements SeekableIterator { - +class DirectoryIterator extends SplFileInfo implements SeekableIterator +{ /** * Constructs a new directory iterator from a path * @link https://php.net/manual/en/directoryiterator.construct.php @@ -296,51 +294,50 @@ class DirectoryIterator extends SplFileInfo implements SeekableIterator { * @throws UnexpectedValueException if the path cannot be opened. * @throws RuntimeException if the path is an empty string. */ - public function __construct ($directory) {} - + public function __construct($directory) {} /** * Determine if current DirectoryIterator item is '.' or '..' * @link https://php.net/manual/en/directoryiterator.isdot.php * @return bool true if the entry is . or .., * otherwise false - */ - public function isDot () {} + */ + public function isDot() {} /** * Rewind the DirectoryIterator back to the start * @link https://php.net/manual/en/directoryiterator.rewind.php * @return void */ - public function rewind () {} + public function rewind() {} /** * Check whether current DirectoryIterator position is a valid file * @link https://php.net/manual/en/directoryiterator.valid.php * @return bool true if the position is valid, otherwise false */ - public function valid () {} + public function valid() {} /** * Return the key for the current DirectoryIterator item * @link https://php.net/manual/en/directoryiterator.key.php - * @return string The key for the current DirectoryIterator item. + * @return string The key for the current DirectoryIterator item. */ - public function key () {} + public function key() {} /** * Return the current DirectoryIterator item. * @link https://php.net/manual/en/directoryiterator.current.php - * @return DirectoryIterator The current DirectoryIterator item. + * @return DirectoryIterator The current DirectoryIterator item. */ - public function current () {} + public function current() {} /** * Move forward to next DirectoryIterator item * @link https://php.net/manual/en/directoryiterator.next.php * @return void */ - public function next () {} + public function next() {} /** * Seek to a DirectoryIterator item @@ -349,27 +346,28 @@ public function next () {} * The zero-based numeric position to seek to. *
* @return void - */ - public function seek ($offset) {} + */ + public function seek($offset) {} } /** * The Filesystem iterator * @link https://php.net/manual/en/class.filesystemiterator.php */ -class FilesystemIterator extends DirectoryIterator { - const CURRENT_MODE_MASK = 240; - const CURRENT_AS_PATHNAME = 32; - const CURRENT_AS_FILEINFO = 0; - const CURRENT_AS_SELF = 16; - const KEY_MODE_MASK = 3840; - const KEY_AS_PATHNAME = 0; - const FOLLOW_SYMLINKS = 512; - const KEY_AS_FILENAME = 256; - const NEW_CURRENT_AND_KEY = 256; - const SKIP_DOTS = 4096; - const UNIX_PATHS = 8192; - const OTHER_MODE_MASK = 12288; +class FilesystemIterator extends DirectoryIterator +{ + public const CURRENT_MODE_MASK = 240; + public const CURRENT_AS_PATHNAME = 32; + public const CURRENT_AS_FILEINFO = 0; + public const CURRENT_AS_SELF = 16; + public const KEY_MODE_MASK = 3840; + public const KEY_AS_PATHNAME = 0; + public const FOLLOW_SYMLINKS = 512; + public const KEY_AS_FILENAME = 256; + public const NEW_CURRENT_AND_KEY = 256; + public const SKIP_DOTS = 4096; + public const UNIX_PATHS = 8192; + public const OTHER_MODE_MASK = 12288; /** * Constructs a new filesystem iterator @@ -378,21 +376,21 @@ class FilesystemIterator extends DirectoryIterator { * @param int $flags [optional] * @throws UnexpectedValueException if the path cannot be found. */ - public function __construct ($directory, $flags = FilesystemIterator::KEY_AS_PATHNAME | FilesystemIterator::CURRENT_AS_FILEINFO | FilesystemIterator::SKIP_DOTS) {} + public function __construct($directory, $flags = FilesystemIterator::KEY_AS_PATHNAME|FilesystemIterator::CURRENT_AS_FILEINFO|FilesystemIterator::SKIP_DOTS) {} /** * Rewinds back to the beginning * @link https://php.net/manual/en/filesystemiterator.rewind.php * @return void */ - public function rewind () {} + public function rewind() {} /** * Move to the next file * @link https://php.net/manual/en/filesystemiterator.next.php * @return void */ - public function next () {} + public function next() {} /** * Retrieve the key for the current file @@ -400,7 +398,7 @@ public function next () {} * @return string the pathname or filename depending on the set flags. * See the FilesystemIterator constants. */ - public function key () {} + public function key() {} /** * The current file @@ -408,14 +406,14 @@ public function key () {} * @return string|SplFileInfo|self The filename, file information, or $this depending on the set flags. * See the FilesystemIterator constants. */ - public function current () {} + public function current() {} /** * Get the handling flags * @link https://php.net/manual/en/filesystemiterator.getflags.php * @return int The integer value of the set flags. */ - public function getFlags () {} + public function getFlags() {} /** * Sets handling flags @@ -426,7 +424,7 @@ public function getFlags () {} * * @return void */ - public function setFlags ($flags = null) {} + public function setFlags($flags = null) {} } /** @@ -434,9 +432,8 @@ public function setFlags ($flags = null) {} * an interface for iterating recursively over filesystem directories. * @link https://php.net/manual/en/class.recursivedirectoryiterator.php */ -class RecursiveDirectoryIterator extends FilesystemIterator implements RecursiveIterator { - - +class RecursiveDirectoryIterator extends FilesystemIterator implements RecursiveIterator +{ /** * Constructs a RecursiveDirectoryIterator * @link https://php.net/manual/en/recursivedirectoryiterator.construct.php @@ -445,7 +442,7 @@ class RecursiveDirectoryIterator extends FilesystemIterator implements Recursive * @throws UnexpectedValueException if the path cannot be found or is not a directory. * @since 5.1.2 */ - public function __construct ($directory, $flags = FilesystemIterator::KEY_AS_PATHNAME | FilesystemIterator::CURRENT_AS_FILEINFO) {} + public function __construct($directory, $flags = FilesystemIterator::KEY_AS_PATHNAME|FilesystemIterator::CURRENT_AS_FILEINFO) {} /** * Returns whether current entry is a directory and not '.' or '..' @@ -454,42 +451,42 @@ public function __construct ($directory, $flags = FilesystemIterator::KEY_AS_PAT * * @return bool whether the current entry is a directory, but not '.' or '..' */ - public function hasChildren ($allowLinks = false) {} + public function hasChildren($allowLinks = false) {} /** * Returns an iterator for the current entry if it is a directory * @link https://php.net/manual/en/recursivedirectoryiterator.getchildren.php * @return object An iterator for the current entry, if it is a directory. */ - public function getChildren () {} + public function getChildren() {} /** * Get sub path * @link https://php.net/manual/en/recursivedirectoryiterator.getsubpath.php * @return string The sub path (sub directory). */ - public function getSubPath () {} + public function getSubPath() {} /** * Get sub path and name * @link https://php.net/manual/en/recursivedirectoryiterator.getsubpathname.php * @return string The sub path (sub directory) and filename. */ - public function getSubPathname () {} + public function getSubPathname() {} /** * Rewinds back to the beginning * @link https://php.net/manual/en/filesystemiterator.rewind.php * @return void */ - public function rewind () {} + public function rewind() {} /** * Move to the next file * @link https://php.net/manual/en/filesystemiterator.next.php * @return void */ - public function next () {} + public function next() {} /** * Retrieve the key for the current file @@ -497,7 +494,7 @@ public function next () {} * @return string the pathname or filename depending on the set flags. * See the FilesystemIterator constants. */ - public function key () {} + public function key() {} /** * The current file @@ -505,8 +502,7 @@ public function key () {} * @return string|SplFileInfo|self The filename, file information, or $this depending on the set flags. * See the FilesystemIterator constants. */ - public function current () {} - + public function current() {} } /** @@ -514,47 +510,47 @@ public function current () {} * glob. * @link https://php.net/manual/en/class.globiterator.php */ -class GlobIterator extends FilesystemIterator implements Countable { - +class GlobIterator extends FilesystemIterator implements Countable +{ /** * Construct a directory using glob * @link https://php.net/manual/en/globiterator.construct.php * @param $pattern * @param int $flags [optional] */ - public function __construct ($pattern, $flags = FilesystemIterator::KEY_AS_PATHNAME | FilesystemIterator::CURRENT_AS_FILEINFO) {} + public function __construct($pattern, $flags = FilesystemIterator::KEY_AS_PATHNAME|FilesystemIterator::CURRENT_AS_FILEINFO) {} /** * Get the number of directories and files * @link https://php.net/manual/en/globiterator.count.php - * @return int The number of returned directories and files, as an + * @return int The number of returned directories and files, as an * integer. */ - public function count () {} + public function count() {} } /** * The SplFileObject class offers an object oriented interface for a file. * @link https://php.net/manual/en/class.splfileobject.php */ -class SplFileObject extends SplFileInfo implements RecursiveIterator, SeekableIterator { +class SplFileObject extends SplFileInfo implements RecursiveIterator, SeekableIterator +{ /** * Drop newlines at the end of a line. */ - const DROP_NEW_LINE = 1; + public const DROP_NEW_LINE = 1; /** * Read on rewind/next. */ - const READ_AHEAD = 2; + public const READ_AHEAD = 2; /** * Skip empty lines in the file. This requires the {@see READ_AHEAD} flag to work as expected. */ - const SKIP_EMPTY = 4; + public const SKIP_EMPTY = 4; /** * Read lines as CSV rows. */ - const READ_CSV = 8; - + public const READ_CSV = 8; /** * Construct a new file object. @@ -568,37 +564,36 @@ class SplFileObject extends SplFileInfo implements RecursiveIterator, SeekableIt * * @throws RuntimeException When the filename cannot be opened * @throws LogicException When the filename is a directory - * */ - public function __construct ($filename, $mode = 'r', $useIncludePath = false, $context = null) {} + public function __construct($filename, $mode = 'r', $useIncludePath = false, $context = null) {} /** * Rewind the file to the first line * @link https://php.net/manual/en/splfileobject.rewind.php * @return void */ - public function rewind () {} + public function rewind() {} /** * Reached end of file * @link https://php.net/manual/en/splfileobject.eof.php - * @return bool true if file is at EOF, false otherwise. + * @return bool true if file is at EOF, false otherwise. */ - public function eof () {} + public function eof() {} /** * Not at EOF * @link https://php.net/manual/en/splfileobject.valid.php * @return bool true if not reached EOF, false otherwise. */ - public function valid () {} + public function valid() {} /** * Gets line from file * @link https://php.net/manual/en/splfileobject.fgets.php * @return string|false a string containing the next line from the file, or false on error. */ - public function fgets () {} + public function fgets() {} /** * Read from file @@ -609,28 +604,28 @@ public function fgets () {} * @return string|false returns the string read from the file or FALSE on failure. * @since 5.5.11 */ - public function fread ($length) {} + public function fread($length) {} - /** - * Gets line from file and parse as CSV fields - * @link https://php.net/manual/en/splfileobject.fgetcsv.php - * @param string $separator [optional]- * The field delimiter (one character only). Defaults as a comma or the value set using SplFileObject::setCsvControl. - *
- * @param string $enclosure [optional]- * The field enclosure character (one character only). Defaults as a double quotation mark or the value set using SplFileObject::setCsvControl. - *
- * @param string $escape [optional]- * The escape character (one character only). Defaults as a backslash (\) or the value set using SplFileObject::setCsvControl. - *
- * @return array|false 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. - */ - public function fgetcsv ($separator = ",", $enclosure = "\"", $escape = "\\") {} + /** + * Gets line from file and parse as CSV fields + * @link https://php.net/manual/en/splfileobject.fgetcsv.php + * @param string $separator [optional]
+ * The field delimiter (one character only). Defaults as a comma or the value set using SplFileObject::setCsvControl. + *
+ * @param string $enclosure [optional]+ * The field enclosure character (one character only). Defaults as a double quotation mark or the value set using SplFileObject::setCsvControl. + *
+ * @param string $escape [optional]+ * The escape character (one character only). Defaults as a backslash (\) or the value set using SplFileObject::setCsvControl. + *
+ * @return array|false 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. + */ + public function fgetcsv($separator = ",", $enclosure = "\"", $escape = "\\") {} /** * Write a field array as a CSV line @@ -646,86 +641,86 @@ public function fgetcsv ($separator = ",", $enclosure = "\"", $escape = "\\") {} * @return int|false Returns the length of the written string or FALSE on failure. * @since 5.4 */ - public function fputcsv (array $fields, $separator = ',' , $enclosure = '"', $escape = "\\") {} + public function fputcsv(array $fields, $separator = ',', $enclosure = '"', $escape = "\\") {} - /** - * Set the delimiter and enclosure character for CSV - * @link https://php.net/manual/en/splfileobject.setcsvcontrol.php - * @param string $separator [optional]
- * The field delimiter (one character only). - *
- * @param string $enclosure [optional]- * The field enclosure character (one character only). - *
- * @param string $escape [optional]- * The field escape character (one character only). - *
- * @return void - */ - public function setCsvControl ($separator = ",", $enclosure = "\"", $escape = "\\") {} + /** + * Set the delimiter and enclosure character for CSV + * @link https://php.net/manual/en/splfileobject.setcsvcontrol.php + * @param string $separator [optional]+ * The field delimiter (one character only). + *
+ * @param string $enclosure [optional]+ * The field enclosure character (one character only). + *
+ * @param string $escape [optional]+ * The field escape character (one character only). + *
+ * @return void + */ + public function setCsvControl($separator = ",", $enclosure = "\"", $escape = "\\") {} /** * Get the delimiter and enclosure character for CSV * @link https://php.net/manual/en/splfileobject.getcsvcontrol.php * @return array an indexed array containing the delimiter and enclosure character. */ - public function getCsvControl () {} + public function getCsvControl() {} /** * Portable file locking * @link https://php.net/manual/en/splfileobject.flock.php * @param int $operation- * operation is one of the following: - * LOCK_SH to acquire a shared lock (reader). + * operation is one of the following: + * LOCK_SH to acquire a shared lock (reader). *
* @param int &$wouldBlock [optional]* Set to 1 if the lock would block (EWOULDBLOCK errno condition). *
- * @return bool true on success or false on failure. + * @return bool true on success or false on failure. */ - public function flock ($operation, &$wouldBlock = null) {} + public function flock($operation, &$wouldBlock = null) {} /** * Flushes the output to the file * @link https://php.net/manual/en/splfileobject.fflush.php - * @return bool true on success or false on failure. + * @return bool true on success or false on failure. */ - public function fflush () {} + public function fflush() {} /** * Return current file position * @link https://php.net/manual/en/splfileobject.ftell.php * @return int|false the position of the file pointer as an integer, or false on error. */ - public function ftell () {} + public function ftell() {} - /** - * Seek to a position - * @link https://php.net/manual/en/splfileobject.fseek.php - * @param int $offset- * The offset. A negative value can be used to move backwards through the file which - * is useful when SEEK_END is used as the whence value. - *
- * @param int $whence [optional]- * whence values are: - * SEEK_SET - Set position equal to offset bytes. - * SEEK_CUR - Set position to current location plus offset. - * SEEK_END - Set position to end-of-file plus offset. - *
- *- * If whence is not specified, it is assumed to be SEEK_SET. - *
- * @return int 0 if the seek was successful, -1 otherwise. Note that seeking - * past EOF is not considered an error. - */ - public function fseek ($offset, $whence = SEEK_SET) {} + /** + * Seek to a position + * @link https://php.net/manual/en/splfileobject.fseek.php + * @param int $offset+ * The offset. A negative value can be used to move backwards through the file which + * is useful when SEEK_END is used as the whence value. + *
+ * @param int $whence [optional]+ * whence values are: + * SEEK_SET - Set position equal to offset bytes. + * SEEK_CUR - Set position to current location plus offset. + * SEEK_END - Set position to end-of-file plus offset. + *
+ *+ * If whence is not specified, it is assumed to be SEEK_SET. + *
+ * @return int 0 if the seek was successful, -1 otherwise. Note that seeking + * past EOF is not considered an error. + */ + public function fseek($offset, $whence = SEEK_SET) {} /** * Gets character from file * @link https://php.net/manual/en/splfileobject.fgetc.php * @return string|false a string containing a single character read from the file or false on EOF. */ - public function fgetc () {} + public function fgetc() {} /** * Output all remaining data on a file pointer @@ -733,7 +728,7 @@ public function fgetc () {} * @return int|false the number of characters read from handle * and passed through to the output. */ - public function fpassthru () {} + public function fpassthru() {} /** * Gets line from file and strip HTML tags @@ -747,23 +742,23 @@ public function fpassthru () {} * @removed 8.0 */ #[Deprecated(since: '7.3')] - public function fgetss ($allowable_tags = null) {} + public function fgetss($allowable_tags = null) {} /** * Parses input from file according to a format * @link https://php.net/manual/en/splfileobject.fscanf.php * @param string $format- * The specified format as described in the sprintf documentation. + * The specified format as described in the sprintf documentation. *
- * @param mixed &...$vars [optional]- * The optional assigned values. - *
- * @return array|int If only one parameter is passed to this method, the values parsed will be + * @param mixed &...$vars [optional]+ * The optional assigned values. + *
+ * @return array|int 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. */ - public function fscanf ($format, &...$vars) {} + public function fscanf($format, &...$vars) {} /** * Write to file @@ -772,22 +767,22 @@ public function fscanf ($format, &...$vars) {} * The string to be written to the file. * * @param int $length [optional]- * If the length argument is given, writing will - * stop after length bytes have been written or - * the end of string is reached, whichever comes + * If the length argument is given, writing will + * stop after length bytes have been written or + * the end of string is reached, whichever comes * first. *
* @return int the number of bytes written, or 0 on error. */ - public function fwrite ($data, $length = null) {} + public function fwrite($data, $length = null) {} /** * Gets information about the file * @link https://php.net/manual/en/splfileobject.fstat.php * @return array an array with the statistics of the file; the format of the array - * is described in detail on the stat manual page. + * is described in detail on the stat manual page. */ - public function fstat () {} + public function fstat() {} /** * Truncates the file to a given length @@ -796,35 +791,35 @@ public function fstat () {} * The size to truncate to. * *- * If size is larger than the file it is extended with null bytes. + * If size is larger than the file it is extended with null bytes. *
*- * If size is smaller than the file, the extra data will be lost. + * If size is smaller than the file, the extra data will be lost. *
- * @return bool true on success or false on failure. + * @return bool true on success or false on failure. */ - public function ftruncate ($size) {} + public function ftruncate($size) {} /** * Retrieve current line of file * @link https://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. + * @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. */ - public function current () {} + public function current() {} /** * Get line number * @link https://php.net/manual/en/splfileobject.key.php * @return int the current line number. */ - public function key () {} + public function key() {} /** * Read next line * @link https://php.net/manual/en/splfileobject.next.php * @return void */ - public function next () {} + public function next() {} /** * Sets flags for the SplFileObject @@ -836,14 +831,14 @@ public function next () {} * * @return void */ - public function setFlags ($flags) {} + public function setFlags($flags) {} /** * Gets flags for the SplFileObject * @link https://php.net/manual/en/splfileobject.getflags.php * @return int an integer representing the flags. */ - public function getFlags () {} + public function getFlags() {} /** * Set maximum line length @@ -853,15 +848,15 @@ public function getFlags () {} * * @return void */ - public function setMaxLineLen ($maxLength) {} + public function setMaxLineLen($maxLength) {} /** * Get maximum line length * @link https://php.net/manual/en/splfileobject.getmaxlinelen.php * @return int the maximum line length if one has been set with - * SplFileObject::setMaxLineLen, default is 0. + * SplFileObject::setMaxLineLen, default is 0. */ - public function getMaxLineLen () {} + public function getMaxLineLen() {} /** * SplFileObject does not have children @@ -869,14 +864,14 @@ public function getMaxLineLen () {} * @return bool false * @since 5.1.2 */ - public function hasChildren () {} + public function hasChildren() {} /** * No purpose * @link https://php.net/manual/en/splfileobject.getchildren.php * @return null An SplFileObject does not have children so this method returns NULL. */ - public function getChildren () {} + public function getChildren() {} /** * Seek to specified line @@ -886,31 +881,29 @@ public function getChildren () {} * * @return void */ - public function seek ($line) {} + public function seek($line) {} /** - * Alias of SplFileObject::fgets + * Alias of SplFileObject::fgets * @link https://php.net/manual/en/splfileobject.getcurrentline.php * @return string|false Returns a string containing the next line from the file, or FALSE on error. * @since 5.1.2 */ - public function getCurrentLine () {} + public function getCurrentLine() {} /** - * Alias of SplFileObject::current + * Alias of SplFileObject::current * @link https://php.net/manual/en/splfileobject.tostring.php */ - public function __toString () {} - + public function __toString() {} } /** * The SplTempFileObject class offers an object oriented interface for a temporary file. * @link https://php.net/manual/en/class.spltempfileobject.php */ -class SplTempFileObject extends SplFileObject { - - +class SplTempFileObject extends SplFileObject +{ /** * Construct a new temporary file object * @link https://php.net/manual/en/spltempfileobject.construct.php @@ -918,7 +911,7 @@ class SplTempFileObject extends SplFileObject { * @throws RuntimeException if an error occurs. * @since 5.1.2 */ - public function __construct ($maxMemory = 2097152) {} + public function __construct($maxMemory = 2097152) {} } /** @@ -927,11 +920,10 @@ public function __construct ($maxMemory = 2097152) {} */ class SplDoublyLinkedList implements Iterator, Countable, ArrayAccess, Serializable { - const IT_MODE_LIFO = 2; - const IT_MODE_FIFO = 0; - const IT_MODE_DELETE = 1; - const IT_MODE_KEEP = 0; - + public const IT_MODE_LIFO = 2; + public const IT_MODE_FIFO = 0; + public const IT_MODE_DELETE = 1; + public const IT_MODE_KEEP = 0; /** * Add/insert a new value at the specified index @@ -948,14 +940,14 @@ public function add($index, $value) {} * @link https://php.net/manual/en/spldoublylinkedlist.pop.php * @return mixed The value of the popped node. */ - public function pop () {} + public function pop() {} /** * Shifts a node from the beginning of the doubly linked list * @link https://php.net/manual/en/spldoublylinkedlist.shift.php * @return mixed The value of the shifted node. */ - public function shift () {} + public function shift() {} /** * Pushes an element at the end of the doubly linked list @@ -965,7 +957,7 @@ public function shift () {} * * @return void */ - public function push ($value) {} + public function push($value) {} /** * Prepends the doubly linked list with an element @@ -975,35 +967,35 @@ public function push ($value) {} * * @return void */ - public function unshift ($value) {} + public function unshift($value) {} /** * Peeks at the node from the end of the doubly linked list * @link https://php.net/manual/en/spldoublylinkedlist.top.php * @return mixed The value of the last node. */ - public function top () {} + public function top() {} /** * Peeks at the node from the beginning of the doubly linked list * @link https://php.net/manual/en/spldoublylinkedlist.bottom.php * @return mixed The value of the first node. */ - public function bottom () {} + public function bottom() {} /** * Counts the number of elements in the doubly linked list. * @link https://php.net/manual/en/spldoublylinkedlist.count.php * @return int the number of elements in the doubly linked list. */ - public function count () {} + public function count() {} /** * Checks whether the doubly linked list is empty. * @link https://php.net/manual/en/spldoublylinkedlist.isempty.php * @return bool whether the doubly linked list is empty. */ - public function isEmpty () {} + public function isEmpty() {} /** * Sets the mode of iteration @@ -1012,17 +1004,17 @@ public function isEmpty () {} * There are two orthogonal sets of modes that can be set: * * The direction of the iteration (either one or the other): - * SplDoublyLinkedList::IT_MODE_LIFO (Stack style) + * SplDoublyLinkedList::IT_MODE_LIFO (Stack style) * @return void */ - public function setIteratorMode ($mode) {} + public function setIteratorMode($mode) {} /** * Returns the mode of iteration * @link https://php.net/manual/en/spldoublylinkedlist.getiteratormode.php * @return int the different modes and flags that affect the iteration. */ - public function getIteratorMode () {} + public function getIteratorMode() {} /** * Returns whether the requested $index exists @@ -1030,9 +1022,9 @@ public function getIteratorMode () {} * @param mixed $index* The index being checked. *
- * @return bool true if the requested index exists, otherwise false + * @return bool true if the requested index exists, otherwise false */ - public function offsetExists ($index) {} + public function offsetExists($index) {} /** * Returns the value at the specified $index @@ -1040,9 +1032,9 @@ public function offsetExists ($index) {} * @param mixed $index* The index with the value. *
- * @return mixed The value at the specified index. + * @return mixed The value at the specified index. */ - public function offsetGet ($index) {} + public function offsetGet($index) {} /** * Sets the value at the specified $index to $newval @@ -1051,11 +1043,11 @@ public function offsetGet ($index) {} * The index being set. * * @param mixed $value- * The new value for the index. + * The new value for the index. *
* @return void */ - public function offsetSet ($index, $value) {} + public function offsetSet($index, $value) {} /** * Unsets the value at the specified $index @@ -1065,73 +1057,72 @@ public function offsetSet ($index, $value) {} * * @return void */ - public function offsetUnset ($index) {} + public function offsetUnset($index) {} /** * Rewind iterator back to the start * @link https://php.net/manual/en/spldoublylinkedlist.rewind.php * @return void */ - public function rewind () {} + public function rewind() {} /** * Return current array entry * @link https://php.net/manual/en/spldoublylinkedlist.current.php * @return mixed The current node value. */ - public function current () {} + public function current() {} /** * Return current node index * @link https://php.net/manual/en/spldoublylinkedlist.key.php * @return string|float|int|bool|null The current node index. */ - public function key () {} + public function key() {} /** * Move to next entry * @link https://php.net/manual/en/spldoublylinkedlist.next.php * @return void */ - public function next () {} + public function next() {} /** * Move to previous entry * @link https://php.net/manual/en/spldoublylinkedlist.prev.php * @return void */ - public function prev () {} + public function prev() {} /** * Check whether the doubly linked list contains more nodes * @link https://php.net/manual/en/spldoublylinkedlist.valid.php * @return bool true if the doubly linked list contains any more nodes, false otherwise. */ - public function valid () {} + public function valid() {} - /** - * Unserializes the storage - * @link https://php.net/manual/en/spldoublylinkedlist.serialize.php - * @param string $data The serialized string. - * @return void - * @since 5.4 - */ + /** + * Unserializes the storage + * @link https://php.net/manual/en/spldoublylinkedlist.serialize.php + * @param string $data The serialized string. + * @return void + * @since 5.4 + */ public function unserialize($data) {} /** - * Serializes the storage - * @link https://php.net/manual/en/spldoublylinkedlist.unserialize.php - * @return string The serialized string. - * @since 5.4 - */ - public function serialize () {} - + * Serializes the storage + * @link https://php.net/manual/en/spldoublylinkedlist.unserialize.php + * @return string The serialized string. + * @since 5.4 + */ + public function serialize() {} /** * @return array * @since 7.4 */ - public function __debugInfo(){} + public function __debugInfo() {} /** * @return array @@ -1144,16 +1135,14 @@ public function __serialize() {} * @since 7.4 */ public function __unserialize(array $data) {} - } /** * The SplQueue class provides the main functionalities of a queue implemented using a doubly linked list. * @link https://php.net/manual/en/class.splqueue.php */ -class SplQueue extends SplDoublyLinkedList { - - +class SplQueue extends SplDoublyLinkedList +{ /** * Adds an element to the queue. * @link https://php.net/manual/en/splqueue.enqueue.php @@ -1162,14 +1151,14 @@ class SplQueue extends SplDoublyLinkedList { * * @return void */ - public function enqueue ($value) {} + public function enqueue($value) {} /** * Dequeues a node from the queue * @link https://php.net/manual/en/splqueue.dequeue.php * @return mixed The value of the dequeued node. */ - public function dequeue () {} + public function dequeue() {} /** * Sets the mode of iteration @@ -1181,15 +1170,14 @@ public function dequeue () {} * SplDoublyLinkedList::IT_MODE_LIFO (Stack style) * @return void */ - public function setIteratorMode ($mode) {} - + public function setIteratorMode($mode) {} } /** * The SplStack class provides the main functionalities of a stack implemented using a doubly linked list. * @link https://php.net/manual/en/class.splstack.php */ -class SplStack extends SplDoublyLinkedList { - +class SplStack extends SplDoublyLinkedList +{ /** * Sets the mode of iteration * @link https://php.net/manual/en/spldoublylinkedlist.setiteratormode.php @@ -1200,21 +1188,21 @@ class SplStack extends SplDoublyLinkedList { * SplDoublyLinkedList::IT_MODE_LIFO (Stack style) * @return void */ - public function setIteratorMode ($mode) {} + public function setIteratorMode($mode) {} } /** * The SplHeap class provides the main functionalities of an Heap. * @link https://php.net/manual/en/class.splheap.php */ -abstract class SplHeap implements Iterator, Countable { - +abstract class SplHeap implements Iterator, Countable +{ /** * Extracts a node from top of the heap and sift up. * @link https://php.net/manual/en/splheap.extract.php * @return mixed The value of the extracted node. */ - public function extract () {} + public function extract() {} /** * Inserts an element in the heap by sifting it up. @@ -1224,70 +1212,70 @@ public function extract () {} * * @return void */ - public function insert ($value) {} + public function insert($value) {} /** - * Peeks at the node from the top of the heap + * Peeks at the node from the top of the heap * @link https://php.net/manual/en/splheap.top.php * @return mixed The value of the node on the top. */ - public function top () {} + public function top() {} /** * Counts the number of elements in the heap. * @link https://php.net/manual/en/splheap.count.php * @return int the number of elements in the heap. */ - public function count () {} + public function count() {} /** * Checks whether the heap is empty. * @link https://php.net/manual/en/splheap.isempty.php * @return bool whether the heap is empty. */ - public function isEmpty () {} + public function isEmpty() {} /** * Rewind iterator back to the start (no-op) * @link https://php.net/manual/en/splheap.rewind.php * @return void */ - public function rewind () {} + public function rewind() {} /** * Return current node pointed by the iterator * @link https://php.net/manual/en/splheap.current.php * @return mixed The current node value. */ - public function current () {} + public function current() {} /** * Return current node index * @link https://php.net/manual/en/splheap.key.php * @return int The current node index. */ - public function key () {} + public function key() {} /** * Move to the next node * @link https://php.net/manual/en/splheap.next.php * @return void */ - public function next () {} + public function next() {} /** * Check whether the heap contains more nodes * @link https://php.net/manual/en/splheap.valid.php * @return bool true if the heap contains any more nodes, false otherwise. */ - public function valid () {} + public function valid() {} /** * Recover from the corrupted state and allow further actions on the heap. * @link https://php.net/manual/en/splheap.recoverfromcorruption.php * @return void */ - public function recoverFromCorruption () {} + public function recoverFromCorruption() {} /** * Compare elements in order to place them correctly in the heap while sifting up. @@ -1298,33 +1286,31 @@ public function recoverFromCorruption () {} * @param mixed $value2* The value of the second node being compared. *
- * @return int Result of the comparison, positive integer if value1 is greater than value2, 0 if they are equal, negative integer otherwise. + * @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. */ - abstract protected function compare ($value1, $value2); - - /** - * @return bool - */ - public function isCorrupted(){} + abstract protected function compare($value1, $value2); + /** + * @return bool + */ + public function isCorrupted() {} /** * @return array * @since 7.4 */ - public function __debugInfo(){} - + public function __debugInfo() {} } /** * The SplMinHeap class provides the main functionalities of a heap, keeping the minimum on the top. * @link https://php.net/manual/en/class.splminheap.php */ -class SplMinHeap extends SplHeap { - +class SplMinHeap extends SplHeap +{ /** * Compare elements in order to place them correctly in the heap while sifting up. * @link https://php.net/manual/en/splminheap.compare.php @@ -1334,19 +1320,19 @@ class SplMinHeap extends SplHeap { * @param mixed $value2
* The value of the second node being compared. *
- * @return void Result of the comparison, positive integer if value1 is lower than value2, 0 if they are equal, negative integer otherwise. + * @return void 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. */ - protected function compare ($value1, $value2) {} + protected function compare($value1, $value2) {} /** * Extracts a node from top of the heap and sift up. * @link https://php.net/manual/en/splheap.extract.php * @return mixed The value of the extracted node. */ - public function extract () {} + public function extract() {} /** * Inserts an element in the heap by sifting it up. @@ -1356,79 +1342,78 @@ public function extract () {} *
* @return void */ - public function insert ($value) {} + public function insert($value) {} /** - * Peeks at the node from the top of the heap + * Peeks at the node from the top of the heap * @link https://php.net/manual/en/splheap.top.php * @return mixed The value of the node on the top. */ - public function top () {} + public function top() {} /** * Counts the number of elements in the heap. * @link https://php.net/manual/en/splheap.count.php * @return int the number of elements in the heap. */ - public function count () {} + public function count() {} /** * Checks whether the heap is empty. * @link https://php.net/manual/en/splheap.isempty.php * @return bool whether the heap is empty. */ - public function isEmpty () {} + public function isEmpty() {} /** * Rewind iterator back to the start (no-op) * @link https://php.net/manual/en/splheap.rewind.php * @return void */ - public function rewind () {} + public function rewind() {} /** * Return current node pointed by the iterator * @link https://php.net/manual/en/splheap.current.php * @return mixed The current node value. */ - public function current () {} + public function current() {} /** * Return current node index * @link https://php.net/manual/en/splheap.key.php * @return int The current node index. */ - public function key () {} + public function key() {} /** * Move to the next node * @link https://php.net/manual/en/splheap.next.php * @return void */ - public function next () {} + public function next() {} /** * Check whether the heap contains more nodes * @link https://php.net/manual/en/splheap.valid.php * @return bool true if the heap contains any more nodes, false otherwise. */ - public function valid () {} + public function valid() {} /** * Recover from the corrupted state and allow further actions on the heap. * @link https://php.net/manual/en/splheap.recoverfromcorruption.php * @return void */ - public function recoverFromCorruption () {} - + public function recoverFromCorruption() {} } /** * The SplMaxHeap class provides the main functionalities of a heap, keeping the maximum on the top. * @link https://php.net/manual/en/class.splmaxheap.php */ -class SplMaxHeap extends SplHeap { - +class SplMaxHeap extends SplHeap +{ /** * Compare elements in order to place them correctly in the heap while sifting up. * @link https://php.net/manual/en/splmaxheap.compare.php @@ -1443,24 +1428,24 @@ class SplMaxHeap extends SplHeap { ** Having multiple elements with the same value in a Heap is not recommended. They will end up in an arbitrary relative position. */ - protected function compare ($value1, $value2) {} - + protected function compare($value1, $value2) {} } /** * The SplPriorityQueue class provides the main functionalities of an * prioritized queue, implemented using a heap. * @link https://php.net/manual/en/class.splpriorityqueue.php */ -class SplPriorityQueue implements Iterator, Countable { - const EXTR_BOTH = 3; - const EXTR_PRIORITY = 2; - const EXTR_DATA = 1; +class SplPriorityQueue implements Iterator, Countable +{ + public const EXTR_BOTH = 3; + public const EXTR_PRIORITY = 2; + public const EXTR_DATA = 1; /** * Construct a new SplPriorityQueue object * @link https://www.php.net/manual/en/splpriorityqueue.construct.php */ - public function __construct () {} + public function __construct() {} /** * Compare priorities in order to place elements correctly in the heap while sifting up. @@ -1476,7 +1461,7 @@ public function __construct () {} *
* Multiple elements with the same priority will get dequeued in no particular order. */ - public function compare ($priority1, $priority2) {} + public function compare($priority1, $priority2) {} /** * Inserts an element in the queue by sifting it up. @@ -1489,90 +1474,90 @@ public function compare ($priority1, $priority2) {} *
* @return true */ - public function insert ($value, $priority) {} + public function insert($value, $priority) {} /** * Sets the mode of extraction * @link https://php.net/manual/en/splpriorityqueue.setextractflags.php * @param int $flags- * Defines what is extracted by SplPriorityQueue::current, - * SplPriorityQueue::top and - * SplPriorityQueue::extract. - *
- * SplPriorityQueue::EXTR_DATA (0x00000001): Extract the data + * Defines what is extracted by SplPriorityQueue::current, + * SplPriorityQueue::top and + * SplPriorityQueue::extract. + * + * SplPriorityQueue::EXTR_DATA (0x00000001): Extract the data * @return void */ - public function setExtractFlags ($flags) {} + public function setExtractFlags($flags) {} /** - * Peeks at the node from the top of the queue + * Peeks at the node from the top of the queue * @link https://php.net/manual/en/splpriorityqueue.top.php * @return mixed The value or priority (or both) of the top node, depending on the extract flag. */ - public function top () {} + public function top() {} /** * Extracts a node from top of the heap and sift up. * @link https://php.net/manual/en/splpriorityqueue.extract.php * @return mixed The value or priority (or both) of the extracted node, depending on the extract flag. */ - public function extract () {} + public function extract() {} /** * Counts the number of elements in the queue. * @link https://php.net/manual/en/splpriorityqueue.count.php * @return int the number of elements in the queue. */ - public function count () {} + public function count() {} /** * Checks whether the queue is empty. * @link https://php.net/manual/en/splpriorityqueue.isempty.php * @return bool whether the queue is empty. */ - public function isEmpty () {} + public function isEmpty() {} /** * Rewind iterator back to the start (no-op) * @link https://php.net/manual/en/splpriorityqueue.rewind.php * @return void */ - public function rewind () {} + public function rewind() {} /** * Return current node pointed by the iterator * @link https://php.net/manual/en/splpriorityqueue.current.php * @return mixed The value or priority (or both) of the current node, depending on the extract flag. */ - public function current () {} + public function current() {} /** * Return current node index * @link https://php.net/manual/en/splpriorityqueue.key.php * @return int The current node index. */ - public function key () {} + public function key() {} /** * Move to the next node * @link https://php.net/manual/en/splpriorityqueue.next.php * @return void */ - public function next () {} + public function next() {} /** * Check whether the queue contains more nodes * @link https://php.net/manual/en/splpriorityqueue.valid.php * @return bool true if the queue contains any more nodes, false otherwise. */ - public function valid () {} + public function valid() {} /** * Recover from the corrupted state and allow further actions on the queue. * @link https://php.net/manual/en/splpriorityqueue.recoverfromcorruption.php * @return void */ - public function recoverFromCorruption () {} + public function recoverFromCorruption() {} /** * @return bool @@ -1584,13 +1569,11 @@ public function isCorrupted() {} */ public function getExtractFlags() {} - /** * @return array * @since 7.4 */ - public function __debugInfo(){} - + public function __debugInfo() {} } /** @@ -1601,28 +1584,28 @@ public function __debugInfo(){} * implementation. * @link https://php.net/manual/en/class.splfixedarray.php */ -class SplFixedArray implements Iterator, ArrayAccess, Countable, IteratorAggregate { - +class SplFixedArray implements Iterator, ArrayAccess, Countable, IteratorAggregate +{ /** * Constructs a new fixed array * @link https://php.net/manual/en/splfixedarray.construct.php * @param int $size [optional] */ - public function __construct ($size = 0) {} + public function __construct($size = 0) {} /** * Returns the size of the array * @link https://php.net/manual/en/splfixedarray.count.php * @return int the size of the array. */ - public function count () {} + public function count() {} /** * Returns a PHP array from the fixed array * @link https://php.net/manual/en/splfixedarray.toarray.php * @return array a PHP array, similar to the fixed array. */ - public function toArray () {} + public function toArray() {} /** * Import a PHP array in a SplFixedArray instance @@ -1636,14 +1619,14 @@ public function toArray () {} * @return SplFixedArray an instance of SplFixedArray * containing the array content. */ - public static function fromArray ($array, $preserveKeys = true) {} + public static function fromArray($array, $preserveKeys = true) {} /** * Gets the size of the array * @link https://php.net/manual/en/splfixedarray.getsize.php * @return int the size of the array, as an integer. */ - public function getSize () {} + public function getSize() {} /** * Change the size of an array @@ -1653,7 +1636,7 @@ public function getSize () {} * * @return bool */ - public function setSize ($size) {} + public function setSize($size) {} /** * Returns whether the requested index exists @@ -1661,9 +1644,9 @@ public function setSize ($size) {} * @param int $index* The index being checked. *
- * @return bool true if the requested index exists, otherwise false + * @return bool true if the requested index exists, otherwise false */ - public function offsetExists ($index) {} + public function offsetExists($index) {} /** * Returns the value at the specified index @@ -1671,9 +1654,9 @@ public function offsetExists ($index) {} * @param int $index* The index with the value. *
- * @return mixed The value at the specified index. + * @return mixed The value at the specified index. */ - public function offsetGet ($index) {} + public function offsetGet($index) {} /** * Sets a new value at a specified index @@ -1682,11 +1665,11 @@ public function offsetGet ($index) {} * The index being set. * * @param mixed $value- * The new value for the index. + * The new value for the index. *
* @return void */ - public function offsetSet ($index, $value) {} + public function offsetSet($index, $value) {} /** * Unsets the value at the specified $index @@ -1696,46 +1679,44 @@ public function offsetSet ($index, $value) {} * * @return void */ - public function offsetUnset ($index) {} + public function offsetUnset($index) {} /** * Rewind iterator back to the start * @link https://php.net/manual/en/splfixedarray.rewind.php * @return void */ - public function rewind () {} + public function rewind() {} /** * Return current array entry * @link https://php.net/manual/en/splfixedarray.current.php * @return mixed The current element value. */ - public function current () {} + public function current() {} /** * Return current array index * @link https://php.net/manual/en/splfixedarray.key.php * @return int The current array index. */ - public function key () {} + public function key() {} /** * Move to next entry * @link https://php.net/manual/en/splfixedarray.next.php * @return void */ - public function next () {} + public function next() {} /** * Check whether the array contains more elements * @link https://php.net/manual/en/splfixedarray.valid.php * @return bool true if the array contains any more elements, false otherwise. */ - public function valid () {} + public function valid() {} - public function __wakeup() - { - } + public function __wakeup() {} /** * @return Traversable @@ -1748,18 +1729,17 @@ public function getIterator() {} * SplSubject to implement the Observer Design Pattern. * @link https://php.net/manual/en/class.splobserver.php */ -interface SplObserver { - +interface SplObserver +{ /** * Receive update from subject * @link https://php.net/manual/en/splobserver.update.php * @param SplSubject $subject- * The SplSubject notifying the observer of an update. + * The SplSubject notifying the observer of an update. *
* @return void */ - public function update (SplSubject $subject); - + public function update(SplSubject $subject); } /** @@ -1767,35 +1747,34 @@ public function update (SplSubject $subject); * SplObserver to implement the Observer Design Pattern. * @link https://php.net/manual/en/class.splsubject.php */ -interface SplSubject { - +interface SplSubject +{ /** * Attach an SplObserver * @link https://php.net/manual/en/splsubject.attach.php * @param SplObserver $observer- * The SplObserver to attach. + * The SplObserver to attach. *
* @return void */ - public function attach (SplObserver $observer); + public function attach(SplObserver $observer); /** * Detach an observer * @link https://php.net/manual/en/splsubject.detach.php * @param SplObserver $observer- * The SplObserver to detach. + * The SplObserver to detach. *
* @return void */ - public function detach (SplObserver $observer); + public function detach(SplObserver $observer); /** * Notify an observer * @link https://php.net/manual/en/splsubject.notify.php * @return void */ - public function notify (); - + public function notify(); } /** @@ -1804,8 +1783,8 @@ public function notify (); * cases involving the need to uniquely identify objects. * @link https://php.net/manual/en/class.splobjectstorage.php */ -class SplObjectStorage implements Countable, Iterator, Serializable, ArrayAccess { - +class SplObjectStorage implements Countable, Iterator, Serializable, ArrayAccess +{ /** * Adds an object in the storage * @link https://php.net/manual/en/splobjectstorage.attach.php @@ -1817,17 +1796,17 @@ class SplObjectStorage implements Countable, Iterator, Serializable, ArrayAccess * * @return void */ - public function attach ($object, $info = null) {} + public function attach($object, $info = null) {} /** - * Removes an object from the storage + * Removes an object from the storage * @link https://php.net/manual/en/splobjectstorage.detach.php * @param object $object* The object to remove. *
* @return void */ - public function detach ($object) {} + public function detach($object) {} /** * Checks if the storage contains a specific object @@ -1835,47 +1814,47 @@ public function detach ($object) {} * @param object $object* The object to look for. *
- * @return bool true if the object is in the storage, false otherwise. + * @return bool true if the object is in the storage, false otherwise. */ - public function contains ($object) {} + public function contains($object) {} - /** - * Adds all objects from another storage - * @link https://php.net/manual/en/splobjectstorage.addall.php - * @param SplObjectStorage $storage- * The storage you want to import. - *
- * @return void - */ - public function addAll ($storage) {} + /** + * Adds all objects from another storage + * @link https://php.net/manual/en/splobjectstorage.addall.php + * @param SplObjectStorage $storage+ * The storage you want to import. + *
+ * @return void + */ + public function addAll($storage) {} - /** - * Removes objects contained in another storage from the current storage - * @link https://php.net/manual/en/splobjectstorage.removeall.php - * @param SplObjectStorage $storage- * The storage containing the elements to remove. - *
- * @return void - */ - public function removeAll ($storage) {} + /** + * Removes objects contained in another storage from the current storage + * @link https://php.net/manual/en/splobjectstorage.removeall.php + * @param SplObjectStorage $storage+ * The storage containing the elements to remove. + *
+ * @return void + */ + public function removeAll($storage) {} - /** - * Removes all objects except for those contained in another storage from the current storage - * @link https://php.net/manual/en/splobjectstorage.removeallexcept.php - * @param SplObjectStorage $storage- * The storage containing the elements to retain in the current storage. - *
- * @return void - * @since 5.3.6 - */ - public function removeAllExcept ($storage) {} + /** + * Removes all objects except for those contained in another storage from the current storage + * @link https://php.net/manual/en/splobjectstorage.removeallexcept.php + * @param SplObjectStorage $storage+ * The storage containing the elements to retain in the current storage. + *
+ * @return void + * @since 5.3.6 + */ + public function removeAllExcept($storage) {} - /** + /** * Returns the data associated with the current iterator entry * @link https://php.net/manual/en/splobjectstorage.getinfo.php * @return mixed The data associated with the current iterator position. */ - public function getInfo () {} + public function getInfo() {} /** * Sets the data associated with the current iterator entry @@ -1885,7 +1864,7 @@ public function getInfo () {} * * @return void */ - public function setInfo ($info) {} + public function setInfo($info) {} /** * Returns the number of objects in the storage @@ -1893,42 +1872,42 @@ public function setInfo ($info) {} * @param int $mode [optional] * @return int The number of objects in the storage. */ - public function count ($mode = COUNT_NORMAL) {} + public function count($mode = COUNT_NORMAL) {} /** * Rewind the iterator to the first storage element * @link https://php.net/manual/en/splobjectstorage.rewind.php * @return void */ - public function rewind () {} + public function rewind() {} /** * Returns if the current iterator entry is valid * @link https://php.net/manual/en/splobjectstorage.valid.php - * @return bool true if the iterator entry is valid, false otherwise. + * @return bool true if the iterator entry is valid, false otherwise. */ - public function valid () {} + public function valid() {} /** * Returns the index at which the iterator currently is * @link https://php.net/manual/en/splobjectstorage.key.php * @return int The index corresponding to the position of the iterator. */ - public function key () {} + public function key() {} /** * Returns the current storage entry * @link https://php.net/manual/en/splobjectstorage.current.php * @return object The object at the current iterator position. */ - public function current () {} + public function current() {} /** * Move to the next entry * @link https://php.net/manual/en/splobjectstorage.next.php * @return void */ - public function next () {} + public function next() {} /** * Unserializes a storage from its string representation @@ -1939,7 +1918,7 @@ public function next () {} * @return void * @since 5.2.2 */ - public function unserialize ($data) {} + public function unserialize($data) {} /** * Serializes the storage @@ -1947,7 +1926,7 @@ public function unserialize ($data) {} * @return string A string representing the storage. * @since 5.2.2 */ - public function serialize () {} + public function serialize() {} /** * Checks whether an object exists in the storage @@ -1955,23 +1934,23 @@ public function serialize () {} * @param object $object* The object to look for. *
- * @return bool true if the object exists in the storage, + * @return bool true if the object exists in the storage, * and false otherwise. */ - public function offsetExists ($object) {} + public function offsetExists($object) {} - /** - * Associates data to an object in the storage - * @link https://php.net/manual/en/splobjectstorage.offsetset.php - * @param object $object- * The object to associate data with. - *
- * @param mixed $info [optional]- * The data to associate with the object. - *
- * @return void - */ - public function offsetSet ($object, $info = null) {} + /** + * Associates data to an object in the storage + * @link https://php.net/manual/en/splobjectstorage.offsetset.php + * @param object $object+ * The object to associate data with. + *
+ * @param mixed $info [optional]+ * The data to associate with the object. + *
+ * @return void + */ + public function offsetSet($object, $info = null) {} /** * Removes an object from the storage @@ -1981,7 +1960,7 @@ public function offsetSet ($object, $info = null) {} * * @return void */ - public function offsetUnset ($object) {} + public function offsetUnset($object) {} /** * Returns the data associated with an+ * @param int $flags
* The flags to set, according to the * Flag Constants *
* @return void */ - public function setFlags ($flags) {} + public function setFlags($flags) {} - /** - * Attaches iterator information - * @link https://php.net/manual/en/multipleiterator.attachiterator.php - * @param Iterator $iterator- * The new iterator to attach. - *
- * @param int|string|null $info [optional]- * The associative information for the Iterator, which must be an - * integer, a string, or null. - *
- * @return void Description... - */ - public function attachIterator (Iterator $iterator, $info = null) {} + /** + * Attaches iterator information + * @link https://php.net/manual/en/multipleiterator.attachiterator.php + * @param Iterator $iterator+ * The new iterator to attach. + *
+ * @param int|string|null $info [optional]+ * The associative information for the Iterator, which must be an + * integer, a string, or null. + *
+ * @return void Description... + */ + public function attachIterator(Iterator $iterator, $info = null) {} - /** - * Detaches an iterator - * @link https://php.net/manual/en/multipleiterator.detachiterator.php - * @param Iterator $iterator- * The iterator to detach. - *
- * @return void - */ - public function detachIterator (Iterator $iterator) {} + /** + * Detaches an iterator + * @link https://php.net/manual/en/multipleiterator.detachiterator.php + * @param Iterator $iterator+ * The iterator to detach. + *
+ * @return void + */ + public function detachIterator(Iterator $iterator) {} - /** - * Checks if an iterator is attached - * @link https://php.net/manual/en/multipleiterator.containsiterator.php - * @param Iterator $iterator- * The iterator to check. - *
- * @return bool true on success or false on failure. - */ - public function containsIterator (Iterator $iterator) {} + /** + * Checks if an iterator is attached + * @link https://php.net/manual/en/multipleiterator.containsiterator.php + * @param Iterator $iterator+ * The iterator to check. + *
+ * @return bool true on success or false on failure. + */ + public function containsIterator(Iterator $iterator) {} /** * Gets the number of attached iterator instances * @link https://php.net/manual/en/multipleiterator.countiterators.php * @return int The number of attached iterator instances (as an integer). */ - public function countIterators () {} + public function countIterators() {} /** * Rewinds all attached iterator instances * @link https://php.net/manual/en/multipleiterator.rewind.php * @return void */ - public function rewind () {} + public function rewind() {} /** * Checks the validity of sub iterators @@ -2114,7 +2092,7 @@ public function rewind () {} * @return bool true if one or all sub iterators are valid depending on flags, * otherwise false */ - public function valid () {} + public function valid() {} /** * Gets the registered iterator instances @@ -2122,7 +2100,7 @@ public function valid () {} * @return array An array of all registered iterator instances, * or false if no sub iterator is attached. */ - public function key () {} + public function key() {} /** * Gets the registered iterator instances @@ -2132,18 +2110,18 @@ public function key () {} * @throws \RuntimeException if mode MIT_NEED_ALL is set and at least one attached iterator is not valid. * @throws \InvalidArgumentException if a key is NULL and MIT_KEYS_ASSOC is set. */ - public function current () {} + public function current() {} /** * Moves all attached iterator instances forward * @link https://php.net/manual/en/multipleiterator.next.php * @return void */ - public function next () {} + public function next() {} /** * @return array * @since 7.4 */ - public function __debugInfo(){} + public function __debugInfo() {} } diff --git a/SPL/SPL_f.php b/SPL/SPL_f.php index b8cad42fa..edf1192b7 100644 --- a/SPL/SPL_f.php +++ b/SPL/SPL_f.php @@ -4,15 +4,13 @@ use JetBrains\PhpStorm\Internal\LanguageLevelTypeAware; use JetBrains\PhpStorm\Pure; - /** * Return available SPL classes * @link https://php.net/manual/en/function.spl-classes.php * @return array */ #[Pure] -function spl_classes (): array -{} +function spl_classes(): array {} /** * Default implementation for __autoload() @@ -27,8 +25,7 @@ function spl_classes (): array * @return void * @since 5.1.2 */ -function spl_autoload (string $class, ?string $file_extensions): void -{} +function spl_autoload(string $class, ?string $file_extensions): void {} /** * Register and return default file extensions for spl_autoload @@ -44,8 +41,7 @@ function spl_autoload (string $class, ?string $file_extensions): void * spl_autoload. * @since 5.1.2 */ -function spl_autoload_extensions (?string $file_extensions): string -{} +function spl_autoload_extensions(?string $file_extensions): string {} /** * Register given function as __autoload() implementation @@ -63,8 +59,7 @@ function spl_autoload_extensions (?string $file_extensions): string * @throws TypeError Since 8.0. * @since 5.1.2 */ -function spl_autoload_register (?callable $callback, bool $throw = true, bool $prepend = false): bool -{} +function spl_autoload_register(?callable $callback, bool $throw = true, bool $prepend = false): bool {} /** * Unregister given function as __autoload() implementation @@ -75,8 +70,7 @@ function spl_autoload_register (?callable $callback, bool $throw = true, bool $p * @return bool true on success or false on failure. * @since 5.1.2 */ -function spl_autoload_unregister (callable $callback): bool -{} +function spl_autoload_unregister(callable $callback): bool {} /** * Return all registered __autoload() functions @@ -87,8 +81,7 @@ function spl_autoload_unregister (callable $callback): bool * @since 5.1.2 */ #[LanguageLevelTypeAware(["8.0" => "array"], default: "array|false")] -function spl_autoload_functions () -{} +function spl_autoload_functions() {} /** * Try all registered __autoload() functions to load the requested class @@ -99,7 +92,7 @@ function spl_autoload_functions () * @return void * @since 5.1.2 */ -function spl_autoload_call (string $class): void {} +function spl_autoload_call(string $class): void {} /** * Return the parent classes of the given class @@ -115,8 +108,7 @@ function spl_autoload_call (string $class): void {} * @return string[]|false An array on success, or false on error. */ #[Pure] -function class_parents ($object_or_class, bool $autoload = true): array|false -{} +function class_parents($object_or_class, bool $autoload = true): array|false {} /** * Return the interfaces which are implemented by the given class @@ -132,8 +124,7 @@ function class_parents ($object_or_class, bool $autoload = true): array|false * @return string[]|false An array on success, or false on error. */ #[Pure] -function class_implements ($object_or_class, bool $autoload = true): array|false -{} +function class_implements($object_or_class, bool $autoload = true): array|false {} /** * Return hash id for given object @@ -143,8 +134,7 @@ function class_implements ($object_or_class, bool $autoload = true): array|false * the same object. */ #[Pure] -function spl_object_hash (object $object): string -{} +function spl_object_hash(object $object): string {} /** * Copy the iterator into an array @@ -157,8 +147,7 @@ function spl_object_hash (object $object): string * * @return array An array containing the elements of the iterator. */ -function iterator_to_array (Traversable $iterator, bool $preserve_keys = true): array -{} +function iterator_to_array(Traversable $iterator, bool $preserve_keys = true): array {} /** * Count the elements in an iterator @@ -169,8 +158,7 @@ function iterator_to_array (Traversable $iterator, bool $preserve_keys = true): * @return int The number of elements in iterator. */ #[Pure] -function iterator_count (Traversable $iterator): int -{} +function iterator_count(Traversable $iterator): int {} /** * Call a function for every element in an iterator @@ -188,8 +176,7 @@ function iterator_count (Traversable $iterator): int * * @return int the iteration count. */ -function iterator_apply (Traversable $iterator, callable $callback, ?array $args): int -{} +function iterator_apply(Traversable $iterator, callable $callback, ?array $args): int {} // End of SPL v.0.2 @@ -203,8 +190,7 @@ function iterator_apply (Traversable $iterator, callable $callback, ?array $args * @see get_declared_traits() * @since 5.4 */ -function class_uses($object_or_class, bool $autoload = true): array|false -{} +function class_uses($object_or_class, bool $autoload = true): array|false {} /** * return the integer object handle for given object @@ -212,7 +198,4 @@ function class_uses($object_or_class, bool $autoload = true): array|false * @return int * @since 7.2 */ -function spl_object_id(object $object): int -{} - -?> +function spl_object_id(object $object): int {} diff --git a/SQLite/SQLite.php b/SQLite/SQLite.php index ee2274e3c..8278e13c5 100644 --- a/SQLite/SQLite.php +++ b/SQLite/SQLite.php @@ -6,551 +6,546 @@ /** * @link https://php.net/manual/en/ref.sqlite.php */ -class SQLiteDatabase { - - /** - * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) - * @link https://php.net/manual/en/function.sqlite-open.php - * @param string $filenameThe filename of the SQLite database. If the file does not exist, SQLite will attempt to create it. PHP must have write permissions to the file if data is inserted, the database schema is modified or to create the database if it does not exist.
- * @param int $mode [optional]The mode of the file. Intended to be used to open the database in read-only mode. Presently, this parameter is ignored by the sqlite library. The default value for mode is the octal value 0666 and this is the recommended value.
- * @param string &$error_message [optional]Passed by reference and is set to hold a descriptive error message explaining why the database could not be opened if there was an error.
- */ - final public function __construct ($filename, $mode = 0666, &$error_message) {} - - /** - * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) - * @link https://php.net/manual/en/function.sqlite-query.php - * @param string $query- * The query to be executed. - *
- *- * Data inside the query should be {@link https://php.net/manual/en/function.sqlite-escape-string.php properly escaped}. - *
- * @param int $result_type [optional] - *The optional result_type parameter accepts a constant and determines how the returned array will be indexed. Using SQLITE_ASSOC will return only associative indices (named fields) while SQLITE_NUM will return only numerical indices (ordinal field numbers). SQLITE_BOTH will return both associative and numerical indices. SQLITE_BOTH is the default for this function.
- * @param string &$error_message [optional]The specified variable will be filled if an error occurs. This is specially important because SQL syntax errors can't be fetched using the {@see sqlite_last_error()} function.
- * @return resource|false- * This function will return a result handle or FALSE on failure. - * For queries that return rows, the result handle can then be used with - * functions such as {@see sqlite_fetch_array()} and - * {@see sqlite_seek()}. - *
- *- * Regardless of the query type, this function will return FALSE if the - * query failed. - *
- *- * {@see sqlite_query()} returns a buffered, seekable result - * handle. This is useful for reasonably small queries where you need to - * be able to randomly access the rows. Buffered result handles will - * allocate memory to hold the entire result and will not return until it - * has been fetched. If you only need sequential access to the data, it is - * recommended that you use the much higher performance - * {@see sqlite_unbuffered_query()} instead. - *
- */ - public function query ($query, $result_type, &$error_message) {} - - /** - * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) - * @link https://php.net/manual/en/function.sqlite-exec.php - * @param string $query- * The query to be executed. - *
- *- * Data inside the query should be {@link https://php.net/manual/en/function.sqlite-escape-string.php properly escaped}. - *
- * @param string &$error_message [optional]The specified variable will be filled if an error occurs. This is specially important because SQL syntax errors can't be fetched using the - * {@see sqlite_last_error()} function.
- * @return bool- * This function will return a boolean result; TRUE for success or FALSE for failure. - * If you need to run a query that returns rows, see {@see sqlite_query()}. - *
- *The column names returned by - * SQLITE_ASSOC and SQLITE_BOTH will be - * case-folded according to the value of the - * {@link https://php.net/manual/en/sqlite.configuration.php#ini.sqlite.assoc-case sqlite.assoc_case} configuration - * option.
- */ - public function queryExec ($query, &$error_message) {} - - /** - * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) - * Execute a query against a given database and returns an array - * @link https://php.net/manual/en/function.sqlite-array-query.php - * @param string $query- * The query to be executed. - *
- *- * Data inside the query should be {@link https://php.net/manual/en/function.sqlite-escape-string.php properly escaped}. - *
- * @param int $result_type [optional]The optional result_type - * parameter accepts a constant and determines how the returned array will be - * indexed. Using SQLITE_ASSOC will return only associative - * indices (named fields) while SQLITE_NUM will return - * only numerical indices (ordinal field numbers). SQLITE_BOTH - * will return both associative and numerical indices. - * SQLITE_BOTH is the default for this function.
- * @param bool $decode_binary [optional]When the decode_binary - * parameter is set to TRUE (the default), PHP will decode the binary encoding - * it applied to the data if it was encoded using the - * {@see sqlite_escape_string()}. You should normally leave this - * value at its default, unless you are interoperating with databases created by - * other sqlite capable applications.
- *+class SQLiteDatabase +{ + /** + * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) + * @link https://php.net/manual/en/function.sqlite-open.php + * @param string $filename
The filename of the SQLite database. If the file does not exist, SQLite will attempt to create it. PHP must have write permissions to the file if data is inserted, the database schema is modified or to create the database if it does not exist.
+ * @param int $mode [optional]The mode of the file. Intended to be used to open the database in read-only mode. Presently, this parameter is ignored by the sqlite library. The default value for mode is the octal value 0666 and this is the recommended value.
+ * @param string &$error_message [optional]Passed by reference and is set to hold a descriptive error message explaining why the database could not be opened if there was an error.
+ */ + final public function __construct($filename, $mode = 0666, &$error_message) {} + + /** + * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) + * @link https://php.net/manual/en/function.sqlite-query.php + * @param string $query+ * The query to be executed. + *
+ *+ * Data inside the query should be {@link https://php.net/manual/en/function.sqlite-escape-string.php properly escaped}. + *
+ * @param int $result_type [optional] + *The optional result_type parameter accepts a constant and determines how the returned array will be indexed. Using SQLITE_ASSOC will return only associative indices (named fields) while SQLITE_NUM will return only numerical indices (ordinal field numbers). SQLITE_BOTH will return both associative and numerical indices. SQLITE_BOTH is the default for this function.
+ * @param string &$error_message [optional]The specified variable will be filled if an error occurs. This is specially important because SQL syntax errors can't be fetched using the {@see sqlite_last_error()} function.
+ * @return resource|false+ * This function will return a result handle or FALSE on failure. + * For queries that return rows, the result handle can then be used with + * functions such as {@see sqlite_fetch_array()} and + * {@see sqlite_seek()}. + *
+ *+ * Regardless of the query type, this function will return FALSE if the + * query failed. + *
+ *+ * {@see sqlite_query()} returns a buffered, seekable result + * handle. This is useful for reasonably small queries where you need to + * be able to randomly access the rows. Buffered result handles will + * allocate memory to hold the entire result and will not return until it + * has been fetched. If you only need sequential access to the data, it is + * recommended that you use the much higher performance + * {@see sqlite_unbuffered_query()} instead. + *
+ */ + public function query($query, $result_type, &$error_message) {} + + /** + * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) + * @link https://php.net/manual/en/function.sqlite-exec.php + * @param string $query+ * The query to be executed. + *
+ *+ * Data inside the query should be {@link https://php.net/manual/en/function.sqlite-escape-string.php properly escaped}. + *
+ * @param string &$error_message [optional]The specified variable will be filled if an error occurs. This is specially important because SQL syntax errors can't be fetched using the + * {@see sqlite_last_error()} function.
+ * @return bool+ * This function will return a boolean result; TRUE for success or FALSE for failure. + * If you need to run a query that returns rows, see {@see sqlite_query()}. + *
+ *The column names returned by + * SQLITE_ASSOC and SQLITE_BOTH will be + * case-folded according to the value of the + * {@link https://php.net/manual/en/sqlite.configuration.php#ini.sqlite.assoc-case sqlite.assoc_case} configuration + * option.
+ */ + public function queryExec($query, &$error_message) {} + + /** + * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) + * Execute a query against a given database and returns an array + * @link https://php.net/manual/en/function.sqlite-array-query.php + * @param string $query+ * The query to be executed. + *
+ *+ * Data inside the query should be {@link https://php.net/manual/en/function.sqlite-escape-string.php properly escaped}. + *
+ * @param int $result_type [optional]The optional result_type + * parameter accepts a constant and determines how the returned array will be + * indexed. Using SQLITE_ASSOC will return only associative + * indices (named fields) while SQLITE_NUM will return + * only numerical indices (ordinal field numbers). SQLITE_BOTH + * will return both associative and numerical indices. + * SQLITE_BOTH is the default for this function.
+ * @param bool $decode_binary [optional]When the decode_binary + * parameter is set to TRUE (the default), PHP will decode the binary encoding + * it applied to the data if it was encoded using the + * {@see sqlite_escape_string()}. You should normally leave this + * value at its default, unless you are interoperating with databases created by + * other sqlite capable applications.
+ ** @return array|false - * Returns an array of the entire result set; FALSE otherwise. - *
- *The column names returned by - * SQLITE_ASSOC and SQLITE_BOTH will be - * case-folded according to the value of the - * {@link https://php.net/manual/en/sqlite.configuration.php#ini.sqlite.assoc-case sqlite.assoc_case} configuration - * option.
- */ - public function arrayQuery ($query, $result_type, $decode_binary) {} - - /** - * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.1) - * Executes a query and returns either an array for one single column or the value of the first row - * @link https://php.net/manual/en/function.sqlite-single-query.php - * @param string $query - * @param bool $first_row_only [optional] - * @param bool $decode_binary [optional] - * @return array - */ - public function singleQuery ($query, $first_row_only, $decode_binary) {} - - /** - * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) - * Execute a query that does not prefetch and buffer all data - * @link https://php.net/manual/en/function.sqlite-unbuffered-query.php - * @param string $query- * The query to be executed. - *
- *- * Data inside the query should be {@link https://php.net/manual/en/function.sqlite-escape-string.php properly escaped}. - *
- * @param int $result_type [optional]The optional result_type parameter accepts a constant and determines how the returned array will be indexed. - * Using SQLITE_ASSOC will return only associative indices (named fields) while SQLITE_NUM will return only numerical indices (ordinal field numbers). - * SQLITE_BOTH will return both associative and numerical indices. SQLITE_BOTH is the default for this function. + * Returns an array of the entire result set; FALSE otherwise. *
- * @param string &$error_message [optional] - * @return resource Returns a result handle or FALSE on failure. - * {@see sqlite_unbuffered_query()} returns a sequential forward-only result set that can only be used to read each row, one after the other. - */ - public function unbufferedQuery ($query, $result_type = SQLITE_BOTH, &$error_message = null) {} - - /** - * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) - * Returns the rowid of the most recently inserted row - * @link https://php.net/manual/en/function.sqlite-last-insert-rowid.php - * @return int Returns the row id, as an integer. - */ - public function lastInsertRowid () {} - - /** - * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) - * Returns the number of rows that were changed by the most recent SQL statement - * @link https://php.net/manual/en/function.sqlite-changes.php - * @return int Returns the number of changed rows. - */ - public function changes () {} - - /** - * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) - * Register an aggregating UDF for use in SQL statements - * @link https://php.net/manual/en/function.sqlite-create-aggregate.php - * @param string $function_nameThe name of the function used in SQL statements.
- * @param callable $step_funcCallback function called for each row of the result set. Function parameters are &$context, $value, ....
- * @param callable $finalize_funcCallback function to aggregate the "stepped" data from each row. Function parameter is &$context and the function should return the final result of aggregation.
- * @param int $num_args [optional]Hint to the SQLite parser if the callback function accepts a predetermined number of arguments.
- */ - public function createAggregate ($function_name, $step_func, $finalize_func, $num_args = -1) {} - - /** - * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) - * Registers a "regular" User Defined Function for use in SQL statements - * @link https://php.net/manual/en/function.sqlite-create-function.php - * @param string $function_nameThe name of the function used in SQL statements.
- * @param callable $callback- * Callback function to handle the defined SQL function. - *
- *- * @param int $num_args [optional]Note: - * Callback functions should return a type understood by SQLite (i.e. - * {@link https://php.net/manual/en/language.types.intro.php scalar type}). - *
- */ - public function createFunction ($function_name, $callback, $num_args = -1) {} - - /** - * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) - * Set busy timeout duration, or disable busy handlers - * @link https://php.net/manual/en/function.sqlite-busy-timeout.php - * @param int $millisecondsNote: Two alternative syntaxes are - * supported for compatibility with other database extensions (such as MySQL). - * The preferred form is the first, where the dbhandle - * parameter is the first parameter to the function.
The number of milliseconds. When set to 0, busy handlers will be disabled and SQLite will return immediately with a SQLITE_BUSY status code if another process/thread has the database locked for an update. - * PHP sets the default busy timeout to be 60 seconds when the database is opened.
- * @return intReturns an error code, or 0 if no error occurred.
- */ - public function busyTimeout ($milliseconds) {} - - /** - * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) - * Returns the error code of the last error for a database - * @link https://php.net/manual/en/function.sqlite-last-error.php - * @return int Returns an error code, or 0 if no error occurred. - */ - public function lastError () {} - - /** - * (PHP 5 < 5.4.0) - * Return an array of column types from a particular table - * @link https://php.net/manual/en/function.sqlite-fetch-column-types.php - * @param string $table_nameThe table name to query.
- * @param int $result_type [optional]- * The optional result_type parameter accepts a - * constant and determines how the returned array will be indexed. Using - * SQLITE_ASSOC will return only associative indices - * (named fields) while SQLITE_NUM will return only - * numerical indices (ordinal field numbers). - * SQLITE_ASSOC is the default for - * this function. - *
- * @return array- * Returns an array of column data types; FALSE on error. - *
- *The column names returned by - * SQLITE_ASSOC and SQLITE_BOTH will be - * case-folded according to the value of the - * {@link https://php.net/manual/en/sqlite.configuration.php#ini.sqlite.assoc-case sqlite.assoc_case} configuration - * option.
- */ - public function fetchColumnTypes ($table_name, $result_type = SQLITE_ASSOC) {} - + *The column names returned by + * SQLITE_ASSOC and SQLITE_BOTH will be + * case-folded according to the value of the + * {@link https://php.net/manual/en/sqlite.configuration.php#ini.sqlite.assoc-case sqlite.assoc_case} configuration + * option.
+ */ + public function arrayQuery($query, $result_type, $decode_binary) {} + + /** + * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.1) + * Executes a query and returns either an array for one single column or the value of the first row + * @link https://php.net/manual/en/function.sqlite-single-query.php + * @param string $query + * @param bool $first_row_only [optional] + * @param bool $decode_binary [optional] + * @return array + */ + public function singleQuery($query, $first_row_only, $decode_binary) {} + + /** + * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) + * Execute a query that does not prefetch and buffer all data + * @link https://php.net/manual/en/function.sqlite-unbuffered-query.php + * @param string $query+ * The query to be executed. + *
+ *+ * Data inside the query should be {@link https://php.net/manual/en/function.sqlite-escape-string.php properly escaped}. + *
+ * @param int $result_type [optional]The optional result_type parameter accepts a constant and determines how the returned array will be indexed. + * Using SQLITE_ASSOC will return only associative indices (named fields) while SQLITE_NUM will return only numerical indices (ordinal field numbers). + * SQLITE_BOTH will return both associative and numerical indices. SQLITE_BOTH is the default for this function. + *
+ * @param string &$error_message [optional] + * @return resource Returns a result handle or FALSE on failure. + * {@see sqlite_unbuffered_query()} returns a sequential forward-only result set that can only be used to read each row, one after the other. + */ + public function unbufferedQuery($query, $result_type = SQLITE_BOTH, &$error_message = null) {} + + /** + * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) + * Returns the rowid of the most recently inserted row + * @link https://php.net/manual/en/function.sqlite-last-insert-rowid.php + * @return int Returns the row id, as an integer. + */ + public function lastInsertRowid() {} + + /** + * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) + * Returns the number of rows that were changed by the most recent SQL statement + * @link https://php.net/manual/en/function.sqlite-changes.php + * @return int Returns the number of changed rows. + */ + public function changes() {} + + /** + * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) + * Register an aggregating UDF for use in SQL statements + * @link https://php.net/manual/en/function.sqlite-create-aggregate.php + * @param string $function_nameThe name of the function used in SQL statements.
+ * @param callable $step_funcCallback function called for each row of the result set. Function parameters are &$context, $value, ....
+ * @param callable $finalize_funcCallback function to aggregate the "stepped" data from each row. Function parameter is &$context and the function should return the final result of aggregation.
+ * @param int $num_args [optional]Hint to the SQLite parser if the callback function accepts a predetermined number of arguments.
+ */ + public function createAggregate($function_name, $step_func, $finalize_func, $num_args = -1) {} + + /** + * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) + * Registers a "regular" User Defined Function for use in SQL statements + * @link https://php.net/manual/en/function.sqlite-create-function.php + * @param string $function_nameThe name of the function used in SQL statements.
+ * @param callable $callback+ * Callback function to handle the defined SQL function. + *
+ *+ * @param int $num_args [optional]Note: + * Callback functions should return a type understood by SQLite (i.e. + * {@link https://php.net/manual/en/language.types.intro.php scalar type}). + *
+ */ + public function createFunction($function_name, $callback, $num_args = -1) {} + + /** + * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) + * Set busy timeout duration, or disable busy handlers + * @link https://php.net/manual/en/function.sqlite-busy-timeout.php + * @param int $millisecondsNote: Two alternative syntaxes are + * supported for compatibility with other database extensions (such as MySQL). + * The preferred form is the first, where the dbhandle + * parameter is the first parameter to the function.
The number of milliseconds. When set to 0, busy handlers will be disabled and SQLite will return immediately with a SQLITE_BUSY status code if another process/thread has the database locked for an update. + * PHP sets the default busy timeout to be 60 seconds when the database is opened.
+ * @return intReturns an error code, or 0 if no error occurred.
+ */ + public function busyTimeout($milliseconds) {} + + /** + * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) + * Returns the error code of the last error for a database + * @link https://php.net/manual/en/function.sqlite-last-error.php + * @return int Returns an error code, or 0 if no error occurred. + */ + public function lastError() {} + + /** + * (PHP 5 < 5.4.0) + * Return an array of column types from a particular table + * @link https://php.net/manual/en/function.sqlite-fetch-column-types.php + * @param string $table_nameThe table name to query.
+ * @param int $result_type [optional]+ * The optional result_type parameter accepts a + * constant and determines how the returned array will be indexed. Using + * SQLITE_ASSOC will return only associative indices + * (named fields) while SQLITE_NUM will return only + * numerical indices (ordinal field numbers). + * SQLITE_ASSOC is the default for + * this function. + *
+ * @return array+ * Returns an array of column data types; FALSE on error. + *
+ *The column names returned by + * SQLITE_ASSOC and SQLITE_BOTH will be + * case-folded according to the value of the + * {@link https://php.net/manual/en/sqlite.configuration.php#ini.sqlite.assoc-case sqlite.assoc_case} configuration + * option.
+ */ + public function fetchColumnTypes($table_name, $result_type = SQLITE_ASSOC) {} } /** * @link https://php.net/manual/en/ref.sqlite.php */ -final class SQLiteResult implements Iterator, Countable { - - /** - * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) - * Fetches the next row from a result set as an array - * @link https://php.net/manual/en/function.sqlite-fetch-array.php - * @param int $result_type [optional] - *- * The optional result_type - * parameter accepts a constant and determines how the returned array will be - * indexed. Using SQLITE_ASSOC will return only associative - * indices (named fields) while SQLITE_NUM will return - * only numerical indices (ordinal field numbers). SQLITE_BOTH - * will return both associative and numerical indices. - * SQLITE_BOTH is the default for this function. +final class SQLiteResult implements Iterator, Countable +{ + /** + * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) + * Fetches the next row from a result set as an array + * @link https://php.net/manual/en/function.sqlite-fetch-array.php + * @param int $result_type [optional] + *
+ * The optional result_type + * parameter accepts a constant and determines how the returned array will be + * indexed. Using SQLITE_ASSOC will return only associative + * indices (named fields) while SQLITE_NUM will return + * only numerical indices (ordinal field numbers). SQLITE_BOTH + * will return both associative and numerical indices. + * SQLITE_BOTH is the default for this function. *
- * @param bool $decode_binary [optional]When the decode_binary - * parameter is set to TRUE (the default), PHP will decode the binary encoding - * it applied to the data if it was encoded using the - * {@link https://php.net/manual/en/sqlite.configuration.php#ini.sqlite.assoc-case sqlite.assoc_case}. You should normally leave this - * value at its default, unless you are interoperating with databases created by - * other sqlite capable applications.
+ * @param bool $decode_binary [optional]When the decode_binary + * parameter is set to TRUE (the default), PHP will decode the binary encoding + * it applied to the data if it was encoded using the + * {@link https://php.net/manual/en/sqlite.configuration.php#ini.sqlite.assoc-case sqlite.assoc_case}. You should normally leave this + * value at its default, unless you are interoperating with databases created by + * other sqlite capable applications.
* @return array *- * Returns an array of the next row from a result set; FALSE if the - * next position is beyond the final row. - *
- *The column names returned by - * SQLITE_ASSOC and SQLITE_BOTH will be - * case-folded according to the value of the - * {@link https://php.net/manual/en/sqlite.configuration.php#ini.sqlite.assoc-case sqlite.assoc_case} configuration - * option.
- */ - public function fetch ($result_type = SQLITE_BOTH, $decode_binary = true) {} - - /** - * (PHP 5 < 5.4.0) - * Fetches the next row from a result set as an object - * @link https://php.net/manual/en/function.sqlite-fetch-object.php - * @param string $class_name [optional] - * @param array $ctor_params [optional] - * @param bool $decode_binary [optional] - * @return object - */ - public function fetchObject ($class_name, $ctor_params, $decode_binary = true) {} - - /** - * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.1) - * Fetches the first column of a result set as a string - * @link https://php.net/manual/en/function.sqlite-fetch-single.php - * @param bool $decode_binary [optional] - * @return stringReturns the first column value, as a string.
- */ - public function fetchSingle ($decode_binary = true) {} - - /** - * (PHP 5 < 5.4.0) - * Fetches the next row from a result set as an object - * @link https://www.php.net/manual/en/function.sqlite-fetch-all.php + * Returns an array of the next row from a result set; FALSE if the + * next position is beyond the final row. + * + *The column names returned by + * SQLITE_ASSOC and SQLITE_BOTH will be + * case-folded according to the value of the + * {@link https://php.net/manual/en/sqlite.configuration.php#ini.sqlite.assoc-case sqlite.assoc_case} configuration + * option.
+ */ + public function fetch($result_type = SQLITE_BOTH, $decode_binary = true) {} + + /** + * (PHP 5 < 5.4.0) + * Fetches the next row from a result set as an object + * @link https://php.net/manual/en/function.sqlite-fetch-object.php + * @param string $class_name [optional] + * @param array $ctor_params [optional] + * @param bool $decode_binary [optional] + * @return object + */ + public function fetchObject($class_name, $ctor_params, $decode_binary = true) {} + + /** + * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.1) + * Fetches the first column of a result set as a string + * @link https://php.net/manual/en/function.sqlite-fetch-single.php + * @param bool $decode_binary [optional] + * @return stringReturns the first column value, as a string.
+ */ + public function fetchSingle($decode_binary = true) {} + + /** + * (PHP 5 < 5.4.0) + * Fetches the next row from a result set as an object + * @link https://www.php.net/manual/en/function.sqlite-fetch-all.php * @param int $result_type [optional]* The optional result_type parameter accepts a constant and determines how the returned array will be indexed. * Using SQLITE_ASSOC will return only associative indices (named fields) while SQLITE_NUM will return only numerical indices (ordinal field numbers). * {@see SQLITE_BOTH} will return both associative and numerical indices. {@see SQLITE_BOTH} is the default for this function.
- * @param bool $decode_binary [optional]When the decode_binary parameter is set to TRUE (the default), + * @param bool $decode_binary [optional]
When the decode_binary parameter is set to TRUE (the default), * PHP will decode the binary encoding it applied to the data if it was encoded using the {@see sqlite_escape_string()}. * You should normally leave this value at its default, unless you are interoperating with databases created by other sqlite capable applications.
* @return object - */ - public function fetchAll ($result_type, $decode_binary = true) {} - - /** - * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) - * Fetches a column from the current row of a result set - * @link https://php.net/manual/en/function.sqlite-column.php - * @param $index_or_name - * @param $decode_binary [optional]When the decode_binary - * parameter is set to TRUE (the default), PHP will decode the binary encoding - * it applied to the data if it was encoded using the - * {@see sqlite_escape_string()}. You should normally leave this - * value at its default, unless you are interoperating with databases created by - * other sqlite capable applications.
- * @return mixedReturns the column value
- */ - public function column ($index_or_name, $decode_binary = true) {} - - /** - * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) - * Returns the number of fields in a result set - * @link https://php.net/manual/en/function.sqlite-num-fields.php - * @return intReturns the number of fields, as an integer.
- */ - public function numFields () {} - - /** - * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) - * Returns the name of a particular field - * @link https://php.net/manual/en/function.sqlite-field-name.php - * @param int $field_indexThe ordinal column number in the result set.
- * @return string- * Returns the name of a field in an SQLite result set, given the ordinal - * column number; FALSE on error. - *
- *The column names returned by - * SQLITE_ASSOC and SQLITE_BOTH will be - * case-folded according to the value of the - * {@link https://php.net/manual/en/sqlite.configuration.php#ini.sqlite.assoc-case sqlite.assoc_case}configuration - * option.
- * - */ - public function fieldName ($field_index) {} - - /** - * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) - * Fetches the current row from a result set as an array - * @link https://php.net/manual/en/function.sqlite-current.php - * @param int $result_type [optional]The optional result_type - * parameter accepts a constant and determines how the returned array will be - * indexed. Using {@see SQLITE_ASSOC} will return only associative - * indices (named fields) while {@see SQLITE_NUM} will return - * only numerical indices (ordinal field numbers). SQLITE_BOTH - * will return both associative and numerical indices. - * {@see SQLITE_BOTH} is the default for this function.
- * @param bool $decode_binary [optional]When the decode_binary - * parameter is set to TRUE (the default), PHP will decode the binary encoding - * it applied to the data if it was encoded using the - * {@see sqlite_escape_string()}. You should normally leave this - * value at its default, unless you are interoperating with databases created by - * other sqlite capable applications.
- * @return array- * Returns an array of the current row from a result set; FALSE if the - * current position is beyond the final row. - *
- *The column names returned by - * SQLITE_ASSOC and SQLITE_BOTH will be - * case-folded according to the value of the - * {@link https://php.net/manual/en/sqlite.configuration.php#ini.sqlite.assoc-case sqlite.assoc_case} configuration - * option.
- */ - public function current ($result_type = SQLITE_BOTH , $decode_binary = true) {} - /** - * Return the key of the current element - * @link https://php.net/manual/en/iterator.key.php - * @return mixed scalar on success, or null on failure. - * @since 5.0.0 - */ - public function key () {} - /** - * Seek to the next row number - * @link https://php.net/manual/en/function.sqlite-next.php - * @return bool Returns TRUE on success, or FALSE if there are no more rows. - * @since 5.0.0 - */ - public function next () {} - /** - * Checks if current position is valid - * @link https://php.net/manual/en/iterator.valid.php - * @return bool- * Returns TRUE if there are more rows available from the - * result handle, or FALSE otherwise. - *
- * @since 5.0.0 - */ - public function valid () {} - /** - * Rewind the Iterator to the first element - * @link https://php.net/manual/en/iterator.rewind.php - * @return void Any returned value is ignored. - * @since 5.0.0 - */ - public function rewind () {} - - /** - * Count elements of an object - * @link https://php.net/manual/en/countable.count.php - * @return intThe custom count as an integer. - *
- *- * The return value is cast to an integer. - *
- * @since 5.1.0 - */ - public function count () {} - - /** - * Seek to the previous row number of a result set - * @link https://php.net/manual/en/function.sqlite-prev.php - * @return boolReturns TRUE on success, or FALSE if there are no more previous rows. - *
- * @since 5.4.0 - */ - public function prev () {} - - /** - *@since 5.4.0 - * Returns whether or not a previous row is available - * @link https://php.net/manual/en/function.sqlite-has-prev.php - * @return bool- * Returns TRUE if there are more previous rows available from the - * result handle, or FALSE otherwise. - *
- */ - public function hasPrev () {} - - /** - * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) - * Returns the number of rows in a buffered result set - * @link https://php.net/manual/en/function.sqlite-num-rows.php - * @return int Returns the number of rows, as an integer. - */ - public function numRows () {} - - /** - * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) - * Seek to a particular row number of a buffered result set - * @link https://php.net/manual/en/function.sqlite-seek.php - * @param $row - *- * The ordinal row number to seek to. The row number is zero-based (0 is - * the first row). - *
- *- */ - public function seek ($row) {} - + */ + public function fetchAll($result_type, $decode_binary = true) {} + + /** + * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) + * Fetches a column from the current row of a result set + * @link https://php.net/manual/en/function.sqlite-column.php + * @param $index_or_name + * @param $decode_binary [optional]Note:
This function cannot be used with - * unbuffered result handles.
When the decode_binary + * parameter is set to TRUE (the default), PHP will decode the binary encoding + * it applied to the data if it was encoded using the + * {@see sqlite_escape_string()}. You should normally leave this + * value at its default, unless you are interoperating with databases created by + * other sqlite capable applications.
+ * @return mixedReturns the column value
+ */ + public function column($index_or_name, $decode_binary = true) {} + + /** + * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) + * Returns the number of fields in a result set + * @link https://php.net/manual/en/function.sqlite-num-fields.php + * @return intReturns the number of fields, as an integer.
+ */ + public function numFields() {} + + /** + * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) + * Returns the name of a particular field + * @link https://php.net/manual/en/function.sqlite-field-name.php + * @param int $field_indexThe ordinal column number in the result set.
+ * @return string+ * Returns the name of a field in an SQLite result set, given the ordinal + * column number; FALSE on error. + *
+ *The column names returned by + * SQLITE_ASSOC and SQLITE_BOTH will be + * case-folded according to the value of the + * {@link https://php.net/manual/en/sqlite.configuration.php#ini.sqlite.assoc-case sqlite.assoc_case}configuration + * option.
+ */ + public function fieldName($field_index) {} + + /** + * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) + * Fetches the current row from a result set as an array + * @link https://php.net/manual/en/function.sqlite-current.php + * @param int $result_type [optional]The optional result_type + * parameter accepts a constant and determines how the returned array will be + * indexed. Using {@see SQLITE_ASSOC} will return only associative + * indices (named fields) while {@see SQLITE_NUM} will return + * only numerical indices (ordinal field numbers). SQLITE_BOTH + * will return both associative and numerical indices. + * {@see SQLITE_BOTH} is the default for this function.
+ * @param bool $decode_binary [optional]When the decode_binary + * parameter is set to TRUE (the default), PHP will decode the binary encoding + * it applied to the data if it was encoded using the + * {@see sqlite_escape_string()}. You should normally leave this + * value at its default, unless you are interoperating with databases created by + * other sqlite capable applications.
+ * @return array+ * Returns an array of the current row from a result set; FALSE if the + * current position is beyond the final row. + *
+ *The column names returned by + * SQLITE_ASSOC and SQLITE_BOTH will be + * case-folded according to the value of the + * {@link https://php.net/manual/en/sqlite.configuration.php#ini.sqlite.assoc-case sqlite.assoc_case} configuration + * option.
+ */ + public function current($result_type = SQLITE_BOTH, $decode_binary = true) {} + /** + * Return the key of the current element + * @link https://php.net/manual/en/iterator.key.php + * @return mixed scalar on success, or null on failure. + * @since 5.0.0 + */ + public function key() {} + /** + * Seek to the next row number + * @link https://php.net/manual/en/function.sqlite-next.php + * @return bool Returns TRUE on success, or FALSE if there are no more rows. + * @since 5.0.0 + */ + public function next() {} + /** + * Checks if current position is valid + * @link https://php.net/manual/en/iterator.valid.php + * @return bool+ * Returns TRUE if there are more rows available from the + * result handle, or FALSE otherwise. + *
+ * @since 5.0.0 + */ + public function valid() {} + /** + * Rewind the Iterator to the first element + * @link https://php.net/manual/en/iterator.rewind.php + * @return void Any returned value is ignored. + * @since 5.0.0 + */ + public function rewind() {} + + /** + * Count elements of an object + * @link https://php.net/manual/en/countable.count.php + * @return intThe custom count as an integer. + *
+ *+ * The return value is cast to an integer. + *
+ * @since 5.1.0 + */ + public function count() {} + + /** + * Seek to the previous row number of a result set + * @link https://php.net/manual/en/function.sqlite-prev.php + * @return boolReturns TRUE on success, or FALSE if there are no more previous rows. + *
+ * @since 5.4.0 + */ + public function prev() {} + + /** + *@since 5.4.0 + * Returns whether or not a previous row is available + * @link https://php.net/manual/en/function.sqlite-has-prev.php + * @return bool+ * Returns TRUE if there are more previous rows available from the + * result handle, or FALSE otherwise. + *
+ */ + public function hasPrev() {} + + /** + * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) + * Returns the number of rows in a buffered result set + * @link https://php.net/manual/en/function.sqlite-num-rows.php + * @return int Returns the number of rows, as an integer. + */ + public function numRows() {} + + /** + * (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0) + * Seek to a particular row number of a buffered result set + * @link https://php.net/manual/en/function.sqlite-seek.php + * @param $row + *+ * The ordinal row number to seek to. The row number is zero-based (0 is + * the first row). + *
+ *+ */ + public function seek($row) {} } /** * Represents an unbuffered SQLite result set. Unbuffered results sets are sequential, forward-seeking only. * @link https://php.net/manual/en/ref.sqlite.php */ -final class SQLiteUnbuffered { - - /** - * @param int $result_type [optional] - * @param bool $decode_binary [optional] - */ - public function fetch ($result_type, $decode_binary) {} +final class SQLiteUnbuffered +{ + /** + * @param int $result_type [optional] + * @param bool $decode_binary [optional] + */ + public function fetch($result_type, $decode_binary) {} - /** + /** * @link https://www.php.net/manual/en/function.sqlite-fetch-object.php - * @param string $class_name [optional] - * @param array $ctor_params [optional] - * @param bool $decode_binary [optional] - */ - public function fetchObject ($class_name, $ctor_params, $decode_binary) {} - - /** - * @param bool $decode_binary [optional] - */ - public function fetchSingle ($decode_binary) {} - - /** - * @param int $result_type [optional] - * @param bool $decode_binary [optional] - */ - public function fetchAll ($result_type, $decode_binary) {} - - /** - * @param $index_or_name - * @param $decode_binary [optional] - */ - public function column ($index_or_name, $decode_binary) {} - - public function numFields () {} - - /** - * @param int $field_index - */ - public function fieldName ($field_index) {} - - /** - * @param int $result_type [optional] - * @param bool $decode_binary [optional] - */ - public function current ($result_type, $decode_binary) {} - - public function next () {} - - public function valid () {} - + * @param string $class_name [optional] + * @param array $ctor_params [optional] + * @param bool $decode_binary [optional] + */ + public function fetchObject($class_name, $ctor_params, $decode_binary) {} + + /** + * @param bool $decode_binary [optional] + */ + public function fetchSingle($decode_binary) {} + + /** + * @param int $result_type [optional] + * @param bool $decode_binary [optional] + */ + public function fetchAll($result_type, $decode_binary) {} + + /** + * @param $index_or_name + * @param $decode_binary [optional] + */ + public function column($index_or_name, $decode_binary) {} + + public function numFields() {} + + /** + * @param int $field_index + */ + public function fieldName($field_index) {} + + /** + * @param int $result_type [optional] + * @param bool $decode_binary [optional] + */ + public function current($result_type, $decode_binary) {} + + public function next() {} + + public function valid() {} } -final class SQLiteException extends RuntimeException { - protected $message; - protected $code; - protected $file; - protected $line; - - - /** - * Clone the exception - * @link https://php.net/manual/en/exception.clone.php - * @return void - * @since 5.1.0 - */ - final private function __clone () {} - - /** - * Construct the exception - * @link https://php.net/manual/en/exception.construct.php - * @param $message [optional] - * @param $code [optional] - * @param $previous [optional] - * @since 5.1.0 - */ - #[Pure] - public function __construct ($message, $code, $previous) {} - - /** - * String representation of the exception - * @link https://php.net/manual/en/exception.tostring.php - * @return string the string representation of the exception. - * @since 5.1.0 - */ - public function __toString () {} - +final class SQLiteException extends RuntimeException +{ + protected $message; + protected $code; + protected $file; + protected $line; + + /** + * Clone the exception + * @link https://php.net/manual/en/exception.clone.php + * @return void + * @since 5.1.0 + */ + final private function __clone() {} + + /** + * Construct the exception + * @link https://php.net/manual/en/exception.construct.php + * @param $message [optional] + * @param $code [optional] + * @param $previous [optional] + * @since 5.1.0 + */ + #[Pure] + public function __construct($message, $code, $previous) {} + + /** + * String representation of the exception + * @link https://php.net/manual/en/exception.tostring.php + * @return string the string representation of the exception. + * @since 5.1.0 + */ + public function __toString() {} } /** @@ -575,7 +570,7 @@ public function __toString () {} * * @return resource|false a resource (database handle) on success, false on error. */ -function sqlite_open ($filename, $mode = null, &$error_message = null) {} +function sqlite_open($filename, $mode = null, &$error_message = null) {} /** * (PHP 5, PECL sqlite >= 1.0.0)Note:
This function cannot be used with + * unbuffered result handles.
a resource (database handle) on success, false on error.
*/ -function sqlite_popen ($filename, $mode = null, &$error_message = null) {} +function sqlite_popen($filename, $mode = null, &$error_message = null) {} /** * (PHP 5, PECL sqlite >= 1.0.0)This function will return a boolean result; true for success or false for failure. * If you need to run a query that returns rows, see sqlite_query.
*/ -function sqlite_exec ($dbhandle, $query, &$error_msg = null) {} +function sqlite_exec($dbhandle, $query, &$error_msg = null) {} /** * (PHP 5, PECL sqlite >= 1.0.0)an array of the next row from a result set; false if the * next position is beyond the final row.
*/ -function sqlite_fetch_array ($result, $result_type = SQLITE_BOTH, $decode_binary = null) {} +function sqlite_fetch_array($result, $result_type = SQLITE_BOTH, $decode_binary = null) {} /** * Fetches the next row from a result set as an object @@ -756,7 +751,7 @@ function sqlite_fetch_array ($result, $result_type = SQLITE_BOTH, $decode_binary * @param bool $decode_binary [optional] * @return object */ -function sqlite_fetch_object ($result, $class_name = null, ?array $ctor_params = null, $decode_binary = null) {} +function sqlite_fetch_object($result, $class_name = null, ?array $ctor_params = null, $decode_binary = null) {} /** * (PHP 5, PECL sqlite >= 1.0.1)the first column value, as a string.
*/ -function sqlite_fetch_single ($result, $decode_binary = null) {} +function sqlite_fetch_single($result, $decode_binary = null) {} /** * (PHP 5, PECL sqlite >= 1.0.0)the first column value, as a string.
*/ -function sqlite_fetch_string ($result, $decode_binary) {} +function sqlite_fetch_string($result, $decode_binary) {} /** * (PHP 5, PECL sqlite >= 1.0.0)The column names returned by SQLITE_ASSOC and SQLITE_BOTH will be case-folded according to the value of the * {@link https://php.net/manual/en/sqlite.configuration.php#ini.sqlite.assoc-case sqlite.assoc_case} configuration option.
*/ -function sqlite_fetch_all ($result_type = null, $decode_binary = null) {} +function sqlite_fetch_all($result_type = null, $decode_binary = null) {} /** * (PHP 5, PECL sqlite >= 1.0.0)The SQLite result resource. This parameter is not required when using the object-oriented method.
* @return int the number of fields, as an integer. */ -function sqlite_num_fields ($result) {} +function sqlite_num_fields($result) {} /** * (PHP 5, PECL sqlite >= 1.0.0)+ * If specified, the function writes the data to the file rather than + * returning it. + *
+ * @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. + * @since 5.0.1 + */ + public function asXML($filename = null) {} + + /** + * Alias of SimpleXMLElement::asXML * Return a well-formed XML string based on SimpleXML element - * @link https://php.net/manual/en/simplexmlelement.savexml.php + * @link https://php.net/manual/en/simplexmlelement.savexml.php * @param string $filename [optional]- * If specified, the function writes the data to the file rather than - * returning it. - *
+ * If specified, the function writes the data to the file rather than + * returning it. + * * @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. - */ - public function saveXML ($filename = null) {} - - /** - * Runs XPath query on XML data - * @link https://php.net/manual/en/simplexmlelement.xpath.php - * @param string $expression- * An XPath path - *
- * @return static[]|false an array of SimpleXMLElement objects or FALSE in - * case of an error. - */ - public function xpath ($expression) {} - - /** - * Creates a prefix/ns context for the next XPath query - * @link https://php.net/manual/en/simplexmlelement.registerxpathnamespace.php - * @param string $prefix- * The namespace prefix to use in the XPath query for the namespace given in - * ns. - *
- * @param string $namespace- * The namespace to use for the XPath query. This must match a namespace in - * use by the XML document or the XPath query using - * prefix will not return any results. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function registerXPathNamespace ($prefix, $namespace) {} - - /** - * Identifies an element's attributes - * @link https://php.net/manual/en/simplexmlelement.attributes.php - * @param string $namespaceOrPrefix [optional]- * An optional namespace for the retrieved attributes - *
- * @param bool $isPrefix [optional]- * Default to FALSE - *
- * @return static|null 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. - * @since 5.0.1 - */ - public function attributes ($namespaceOrPrefix = null, $isPrefix = false) {} - - /** - * Finds children of given node - * @link https://php.net/manual/en/simplexmlelement.children.php - * @param string $namespaceOrPrefix [optional]
- * An XML namespace. - *
- * @param bool $isPrefix [optional]- * If is_prefix is TRUE, - * ns will be regarded as a prefix. If FALSE, - * ns will be regarded as a namespace - * URL. - *
- * @return static a SimpleXMLElement element, whether the node - * has children or not. - * @since 5.0.1 - */ + * 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. + */ + public function saveXML($filename = null) {} + + /** + * Runs XPath query on XML data + * @link https://php.net/manual/en/simplexmlelement.xpath.php + * @param string $expression+ * An XPath path + *
+ * @return static[]|false an array of SimpleXMLElement objects or FALSE in + * case of an error. + */ + public function xpath($expression) {} + + /** + * Creates a prefix/ns context for the next XPath query + * @link https://php.net/manual/en/simplexmlelement.registerxpathnamespace.php + * @param string $prefix+ * The namespace prefix to use in the XPath query for the namespace given in + * ns. + *
+ * @param string $namespace+ * The namespace to use for the XPath query. This must match a namespace in + * use by the XML document or the XPath query using + * prefix will not return any results. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function registerXPathNamespace($prefix, $namespace) {} + + /** + * Identifies an element's attributes + * @link https://php.net/manual/en/simplexmlelement.attributes.php + * @param string $namespaceOrPrefix [optional]+ * An optional namespace for the retrieved attributes + *
+ * @param bool $isPrefix [optional]+ * Default to FALSE + *
+ * @return static|null 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. + * @since 5.0.1 + */ + public function attributes($namespaceOrPrefix = null, $isPrefix = false) {} + + /** + * Finds children of given node + * @link https://php.net/manual/en/simplexmlelement.children.php + * @param string $namespaceOrPrefix [optional]
+ * An XML namespace. + *
+ * @param bool $isPrefix [optional]+ * If is_prefix is TRUE, + * ns will be regarded as a prefix. If FALSE, + * ns will be regarded as a namespace + * URL. + *
+ * @return static a SimpleXMLElement element, whether the node + * has children or not. + * @since 5.0.1 + */ #[Pure] - public function children ($namespaceOrPrefix = null, $isPrefix = false) {} - - /** - * Returns namespaces used in document - * @link https://php.net/manual/en/simplexmlelement.getnamespaces.php - * @param bool $recursive [optional]- * If specified, returns all namespaces used in parent and child nodes. - * Otherwise, returns only namespaces used in root node. - *
- * @return array The getNamespaces method returns an array of - * namespace names with their associated URIs. - * @since 5.1.2 - */ + public function children($namespaceOrPrefix = null, $isPrefix = false) {} + + /** + * Returns namespaces used in document + * @link https://php.net/manual/en/simplexmlelement.getnamespaces.php + * @param bool $recursive [optional]+ * If specified, returns all namespaces used in parent and child nodes. + * Otherwise, returns only namespaces used in root node. + *
+ * @return array The getNamespaces method returns an array of + * namespace names with their associated URIs. + * @since 5.1.2 + */ #[Pure] - public function getNamespaces ($recursive = false) {} - - /** - * Returns namespaces declared in document - * @link https://php.net/manual/en/simplexmlelement.getdocnamespaces.php - * @param bool $recursive [optional]- * If specified, returns all namespaces declared in parent and child nodes. - * Otherwise, returns only namespaces declared in root node. - *
- * @param bool $fromRoot [optional]- * Allows you to recursively check namespaces under a child node instead of - * from the root of the XML doc. - *
- * @return array The getDocNamespaces method returns an array - * of namespace names with their associated URIs. - * @since 5.1.2 - */ + public function getNamespaces($recursive = false) {} + + /** + * Returns namespaces declared in document + * @link https://php.net/manual/en/simplexmlelement.getdocnamespaces.php + * @param bool $recursive [optional]+ * If specified, returns all namespaces declared in parent and child nodes. + * Otherwise, returns only namespaces declared in root node. + *
+ * @param bool $fromRoot [optional]+ * Allows you to recursively check namespaces under a child node instead of + * from the root of the XML doc. + *
+ * @return array The getDocNamespaces method returns an array + * of namespace names with their associated URIs. + * @since 5.1.2 + */ #[Pure] - public function getDocNamespaces ($recursive = false, $fromRoot = true) {} - - /** - * Gets the name of the XML element - * @link https://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. - * @since 5.1.3 - */ + public function getDocNamespaces($recursive = false, $fromRoot = true) {} + + /** + * Gets the name of the XML element + * @link https://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. + * @since 5.1.3 + */ #[Pure] - public function getName () {} - - /** - * Adds a child element to the XML node - * @link https://php.net/manual/en/simplexmlelement.addchild.php - * @param string $qualifiedName- * The name of the child element to add. - *
- * @param string $value [optional]- * If specified, the value of the child element. - *
- * @param string $namespace [optional]- * If specified, the namespace to which the child element belongs. - *
- * @return static The addChild method returns a SimpleXMLElement - * object representing the child added to the XML node. - * @since 5.1.3 - */ - public function addChild ($qualifiedName, $value = null, $namespace = null) {} - - /** - * Adds an attribute to the SimpleXML element - * @link https://php.net/manual/en/simplexmlelement.addattribute.php - * @param string $qualifiedName- * The name of the attribute to add. - *
- * @param string $value [optional]- * The value of the attribute. - *
- * @param string $namespace [optional]- * If specified, the namespace to which the attribute belongs. - *
- * @return void No value is returned. - * @since 5.1.3 - */ - public function addAttribute ($qualifiedName, $value = null, $namespace = null) {} - - /** - * (No version information available, might only be in SVN)+ * The name of the child element to add. + *
+ * @param string $value [optional]+ * If specified, the value of the child element. + *
+ * @param string $namespace [optional]+ * If specified, the namespace to which the child element belongs. + *
+ * @return static The addChild method returns a SimpleXMLElement + * object representing the child added to the XML node. + * @since 5.1.3 + */ + public function addChild($qualifiedName, $value = null, $namespace = null) {} + + /** + * Adds an attribute to the SimpleXML element + * @link https://php.net/manual/en/simplexmlelement.addattribute.php + * @param string $qualifiedName+ * The name of the attribute to add. + *
+ * @param string $value [optional]+ * The value of the attribute. + *
+ * @param string $namespace [optional]+ * If specified, the namespace to which the attribute belongs. + *
+ * @return void No value is returned. + * @since 5.1.3 + */ + public function addAttribute($qualifiedName, $value = null, $namespace = null) {} + + /** + * (No version information available, might only be in SVN)Returns an array of information, optionally containing script specific state information
* @since 5.5 */ -function opcache_get_status (bool $include_scripts = true): array|false -{} +function opcache_get_status(bool $include_scripts = true): array|false {} /** * (PHP 5 >= 5.5.5, PECL ZendOpcache >= 7.0.2 )Returns an array of information, including ini, blacklist and version
* @since 5.5 */ -function opcache_get_configuration(): array|false -{} +function opcache_get_configuration(): array|false {} /** * (PHP 5 >= 5.6, PECL ZendOpcache >= 7.0.4 )Name of the file.
* @since 5.5 */ - function __construct($filename, $mime_type = '', $posted_filename = '') { - } + public function __construct($filename, $mime_type = '', $posted_filename = '') {} /** * Get file name @@ -27,8 +27,7 @@ function __construct($filename, $mime_type = '', $posted_filename = '') { * @since 5.5 */ #[Pure] - public function getFilename() { - } + public function getFilename() {} /** * Get MIME type @@ -37,8 +36,7 @@ public function getFilename() { * @since 5.5 */ #[Pure] - public function getMimeType() { - } + public function getMimeType() {} /** * Get file name for POST @@ -47,8 +45,7 @@ public function getMimeType() { * @since 5.5 */ #[Pure] - public function getPostFilename() { - } + public function getPostFilename() {} /** * Set MIME type @@ -56,8 +53,7 @@ public function getPostFilename() { * @param string $mime_type * @since 5.5 */ - public function setMimeType($mime_type) { - } + public function setMimeType($mime_type) {} /** * Set file name for POST @@ -65,16 +61,14 @@ public function setMimeType($mime_type) { * @param string $posted_filename * @since 5.5 */ - public function setPostFilename($posted_filename) { - } + public function setPostFilename($posted_filename) {} /** * @link https://secure.php.net/manual/en/curlfile.wakeup.php * Unserialization handler * @since 5.5 */ - public function __wakeup() { - } + public function __wakeup() {} } /** * Initialize a cURL session @@ -87,7 +81,7 @@ public function __wakeup() { * @return resource|false|CurlHandle a cURL handle on success, false on errors. */ #[LanguageLevelTypeAware(["8.0" => "CurlHandle|false"], default: "resource|false")] -function curl_init (?string $url) {} +function curl_init(?string $url) {} /** * Copy a cURL handle along with all of its preferences @@ -97,7 +91,7 @@ function curl_init (?string $url) {} */ #[Pure] #[LanguageLevelTypeAware(["8.0" => "CurlHandle|false"], default: "resource|false")] -function curl_copy_handle (#[LanguageLevelTypeAware(["8.0" => "CurlHandle"], default: "resource")] $handle) {} +function curl_copy_handle(#[LanguageLevelTypeAware(["8.0" => "CurlHandle"], default: "resource")] $handle) {} /** * Gets cURL version information @@ -157,8 +151,7 @@ function curl_copy_handle (#[LanguageLevelTypeAware(["8.0" => "CurlHandle"], def "protocols" => "array", ])] #[Pure] -function curl_version ($age = null): array|false -{} +function curl_version($age = null): array|false {} /** * Set an option for a cURL transfer @@ -2116,8 +2109,7 @@ function curl_version ($age = null): array|false * * @return bool true on success or false on failure. */ -function curl_setopt (#[LanguageLevelTypeAware(["8.0" => "CurlHandle"], default: "resource")] $handle, int $option, mixed $value): bool -{} +function curl_setopt(#[LanguageLevelTypeAware(["8.0" => "CurlHandle"], default: "resource")] $handle, int $option, mixed $value): bool {} /** * Set multiple options for a cURL transfer @@ -2133,8 +2125,7 @@ function curl_setopt (#[LanguageLevelTypeAware(["8.0" => "CurlHandle"], default: * future options in the options array. * @since 5.1.3 */ -function curl_setopt_array (#[LanguageLevelTypeAware(["8.0" => "CurlHandle"], default: "resource")] $handle, array $options): bool -{} +function curl_setopt_array(#[LanguageLevelTypeAware(["8.0" => "CurlHandle"], default: "resource")] $handle, array $options): bool {} /** * (PHP 5 >=5.5.0)Returns the current time measured in the number of seconds since the Unix Epoch (January 1 1970 00:00:00 GMT).
*/ -function time (): int -{} +function time(): int {} /** * Get the local time @@ -816,8 +806,7 @@ function time (): int * @return array */ #[Pure] -function localtime (?int $timestamp, bool $associative = false): array -{} +function localtime(?int $timestamp, bool $associative = false): array {} /** * Get date/time information @@ -899,8 +888,7 @@ function localtime (?int $timestamp, bool $associative = false): array * */ #[Pure] -function getdate (?int $timestamp): array -{} +function getdate(?int $timestamp): array {} /** * Returns new DateTime object @@ -914,8 +902,7 @@ function getdate (?int $timestamp): array * @return DateTime|false DateTime object on success or false on failure. */ #[Pure] -function date_create (string $datetime = 'now', ?DateTimeZone $timezone ): DateTime|false -{} +function date_create(string $datetime = 'now', ?DateTimeZone $timezone): DateTime|false {} /** * (PHP 5.5)Returns the * {@see DateTime} object for method chaining or FALSE on failure.
*/ -function date_time_set (DateTime $object, int $hour, int $minute, int $second = 0, int $microsecond = 0): DateTime {} +function date_time_set(DateTime $object, int $hour, int $minute, int $second = 0, int $microsecond = 0): DateTime {} /** * Alias: @@ -1165,8 +1138,7 @@ function date_time_set (DateTime $object, int $hour, int $minute, int $second = * */ #[LanguageLevelTypeAware(["8.0" => "DateTime"], default: "DateTime|false")] -function date_date_set (DateTime $object, int $year, int $month, int $day): DateTime|false -{} +function date_date_set(DateTime $object, int $year, int $month, int $day): DateTime|false {} /** * Alias: @@ -1181,8 +1153,7 @@ function date_date_set (DateTime $object, int $year, int $month, int $day): Date * */ #[LanguageLevelTypeAware(["8.0" => "DateTime"], default: "DateTime|false")] -function date_isodate_set (DateTime $object, int $year, int $week, int $dayOfWeek = 1) -{} +function date_isodate_set(DateTime $object, int $year, int $week, int $dayOfWeek = 1) {} /** * Sets the date and time based on an unix timestamp @@ -1197,8 +1168,7 @@ function date_isodate_set (DateTime $object, int $year, int $week, int $dayOfWee * {@see DateTime} object for call chaining or FALSE on failure */ #[LanguageLevelTypeAware(["8.0" => "DateTime"], default: "DateTime|false")] -function date_timestamp_set (DateTime $object, int $timestamp): DateTime|false -{} +function date_timestamp_set(DateTime $object, int $timestamp): DateTime|false {} /** * Gets the unix timestamp @@ -1209,8 +1179,7 @@ function date_timestamp_set (DateTime $object, int $timestamp): DateTime|false * @return intReturns the Unix timestamp representing the date.
*/ #[Pure] -function date_timestamp_get (DateTimeInterface $object): int -{} +function date_timestamp_get(DateTimeInterface $object): int {} /** * Returns new DateTimeZone object @@ -1222,8 +1191,7 @@ function date_timestamp_get (DateTimeInterface $object): int * @return DateTimeZone|false DateTimeZone object on success or false on failure. */ #[Pure] -function timezone_open (string $timezone): DateTimeZone|false -{} +function timezone_open(string $timezone): DateTimeZone|false {} /** * Alias: @@ -1234,8 +1202,7 @@ function timezone_open (string $timezone): DateTimeZone|false * @return string One of the timezone names in the list of timezones. */ #[Pure] -function timezone_name_get (DateTimeZone $object): string -{} +function timezone_name_get(DateTimeZone $object): string {} /** * Returns the timezone name from abbreviation @@ -1258,8 +1225,7 @@ function timezone_name_get (DateTimeZone $object): string * @since 5.1.3 */ #[Pure] -function timezone_name_from_abbr (string $abbr, int $utcOffset = -1, int $isDST = -1): string|false -{} +function timezone_name_from_abbr(string $abbr, int $utcOffset = -1, int $isDST = -1): string|false {} /** * Alias: @@ -1274,8 +1240,7 @@ function timezone_name_from_abbr (string $abbr, int $utcOffset = -1, int $isDST */ #[Pure] #[LanguageLevelTypeAware(["8.0" => "int"], default: "int|false")] -function timezone_offset_get (DateTimeZone $object, DateTimeInterface $datetime) -{} +function timezone_offset_get(DateTimeZone $object, DateTimeInterface $datetime) {} /** * Returns all transitions for the timezone @@ -1290,8 +1255,7 @@ function timezone_offset_get (DateTimeZone $object, DateTimeInterface $datetime) * @return array|falseReturns numerically indexed array containing associative array with all transitions on success or FALSE on failure.
*/ #[Pure] -function timezone_transitions_get (DateTimeZone $object, int $timestampBegin, int $timestampEnd): array|false -{} +function timezone_transitions_get(DateTimeZone $object, int $timestampBegin, int $timestampEnd): array|false {} /** * Alias: @@ -1301,8 +1265,7 @@ function timezone_transitions_get (DateTimeZone $object, int $timestampBegin, in * @return array|falseArray containing location information about timezone.
*/ #[Pure] -function timezone_location_get (DateTimeZone $object): array|false -{} +function timezone_location_get(DateTimeZone $object): array|false {} /** * Returns a numerically indexed array containing all defined timezone identifiers @@ -1316,8 +1279,7 @@ function timezone_location_get (DateTimeZone $object): array|false */ #[Pure] #[LanguageLevelTypeAware(["8.0" => "array"], default: "array|false")] -function timezone_identifiers_list (int $timezoneGroup = DateTimeZone::ALL, ?string $countryCode) -{} +function timezone_identifiers_list(int $timezoneGroup = DateTimeZone::ALL, ?string $countryCode) {} /** * Returns associative array containing dst, offset and the timezone name @@ -1328,8 +1290,7 @@ function timezone_identifiers_list (int $timezoneGroup = DateTimeZone::ALL, ?str */ #[Pure] #[LanguageLevelTypeAware(["8.0" => "array"], default: "array|false")] -function timezone_abbreviations_list () -{} +function timezone_abbreviations_list() {} /** * Gets the version of the timezonedb @@ -1337,8 +1298,7 @@ function timezone_abbreviations_list () * @return string a string. */ #[Pure] -function timezone_version_get (): string -{} +function timezone_version_get(): string {} /** * Alias: @@ -1352,8 +1312,7 @@ function timezone_version_get (): string *Returns a new DateInterval instance.
*/ #[Pure] -function date_interval_create_from_date_string (string $datetime): DateInterval|false -{} +function date_interval_create_from_date_string(string $datetime): DateInterval|false {} /** * Alias: @@ -1364,8 +1323,7 @@ function date_interval_create_from_date_string (string $datetime): DateInterval| * @return string */ #[Pure] -function date_interval_format (DateInterval $object, string $format): string -{} +function date_interval_format(DateInterval $object, string $format): string {} /** * Sets the default timezone used by all date/time functions in a script @@ -1379,8 +1337,7 @@ function date_interval_format (DateInterval $object, string $format): string * timezone_identifier isn't valid, or true * otherwise. */ -function date_default_timezone_set (string $timezoneId): bool -{} +function date_default_timezone_set(string $timezoneId): bool {} /** * Gets the default timezone used by all date/time functions in a script @@ -1388,8 +1345,7 @@ function date_default_timezone_set (string $timezoneId): bool * @return string a string. */ #[Pure] -function date_default_timezone_get (): string -{} +function date_default_timezone_get(): string {} /** * Returns time of sunrise for a given day and location @@ -1439,8 +1395,7 @@ function date_default_timezone_get (): string * success or false on failure. */ #[Pure] -function date_sunrise (int $timestamp, int $returnFormat = SUNFUNCS_RET_STRING, ?float $latitude, ?float $longitude, ?float $zenith, ?float $utcOffset): string|int|float|false -{} +function date_sunrise(int $timestamp, int $returnFormat = SUNFUNCS_RET_STRING, ?float $latitude, ?float $longitude, ?float $zenith, ?float $utcOffset): string|int|float|false {} /** * Returns time of sunset for a given day and location @@ -1490,8 +1445,7 @@ function date_sunrise (int $timestamp, int $returnFormat = SUNFUNCS_RET_STRING, * success or false on failure. */ #[Pure] -function date_sunset (int $timestamp, int $returnFormat = SUNFUNCS_RET_STRING, ?float $latitude, ?float $longitude, ?float $zenith, ?float $utcOffset): string|int|float|false -{} +function date_sunset(int $timestamp, int $returnFormat = SUNFUNCS_RET_STRING, ?float $latitude, ?float $longitude, ?float $zenith, ?float $utcOffset): string|int|float|false {} /** * Returns an array with information about sunset/sunrise and twilight begin/end @@ -1510,7 +1464,6 @@ function date_sunset (int $timestamp, int $returnFormat = SUNFUNCS_RET_STRING, ? */ #[Pure] #[LanguageLevelTypeAware(["8.0" => "array"], default: "array|false")] -function date_sun_info (int $timestamp, float $latitude, float $longitude) -{} +function date_sun_info(int $timestamp, float $latitude, float $longitude) {} // End of date v.5.3.2-0.dotdeb.1 diff --git a/date/date_c.php b/date/date_c.php index 4b2625db3..421989c6a 100644 --- a/date/date_c.php +++ b/date/date_c.php @@ -5,71 +5,72 @@ /** * @since 5.5 */ -interface DateTimeInterface { +interface DateTimeInterface +{ /** * @since 7.2 */ - const ATOM = 'Y-m-d\TH:i:sP'; + public const ATOM = 'Y-m-d\TH:i:sP'; /** * @since 7.2 */ - const COOKIE = 'l, d-M-Y H:i:s T'; + public const COOKIE = 'l, d-M-Y H:i:s T'; /** * @since 7.2 */ - const ISO8601 = 'Y-m-d\TH:i:sO'; + public const ISO8601 = 'Y-m-d\TH:i:sO'; /** * @since 7.2 */ - const RFC822 = 'D, d M y H:i:s O'; + public const RFC822 = 'D, d M y H:i:s O'; /** * @since 7.2 */ - const RFC850 = 'l, d-M-y H:i:s T'; + public const RFC850 = 'l, d-M-y H:i:s T'; /** * @since 7.2 */ - const RFC1036 = 'D, d M y H:i:s O'; + public const RFC1036 = 'D, d M y H:i:s O'; /** * @since 7.2 */ - const RFC1123 = 'D, d M Y H:i:s O'; + public const RFC1123 = 'D, d M Y H:i:s O'; /** * @since 7.2 */ - const RFC2822 = 'D, d M Y H:i:s O'; + public const RFC2822 = 'D, d M Y H:i:s O'; /** * @since 7.2 */ - const RFC3339 = 'Y-m-d\TH:i:sP'; + public const RFC3339 = 'Y-m-d\TH:i:sP'; /** * @since 7.2 */ - const RFC3339_EXTENDED = 'Y-m-d\TH:i:s.vP'; + public const RFC3339_EXTENDED = 'Y-m-d\TH:i:s.vP'; /** * @since 7.2 */ - const RFC7231 = 'D, d M Y H:i:s \G\M\T'; + public const RFC7231 = 'D, d M Y H:i:s \G\M\T'; /** * @since 7.2 */ - const RSS = 'D, d M Y H:i:s O'; + public const RSS = 'D, d M Y H:i:s O'; /** * @since 7.2 */ - const W3C = 'Y-m-d\TH:i:sP'; + public const W3C = 'Y-m-d\TH:i:sP'; /* Methods */ /** @@ -81,7 +82,6 @@ interface DateTimeInterface { * @return DateInterval * The https://secure.php.net/manual/en/class.dateinterval.php DateInterval} object representing the * difference between the two dates or FALSE on failure. - * */ public function diff($targetObject, $absolute = false); @@ -94,7 +94,6 @@ public function diff($targetObject, $absolute = false); * * @return string * Returns the formatted date string on success or FALSE on failure. - * */ public function format($format); @@ -104,7 +103,6 @@ public function format($format); * @return int * Returns the timezone offset in seconds from UTC on success * or FALSE on failure. - * */ public function getOffset(); @@ -138,7 +136,8 @@ public function __wakeup(); /** * @since 5.5 */ -class DateTimeImmutable implements DateTimeInterface { +class DateTimeImmutable implements DateTimeInterface +{ /* Methods */ /** * (PHP 5 >=5.5.0)Day of the date.
* @return static|false * Returns the {@link https://secure.php.net/manual/en/class.datetimeimmutable.php DateTimeImmutable} object for method chaining or FALSE on failure. - * */ - public function setDate($year, $month, $day) { } + public function setDate($year, $month, $day) {} /** * (PHP 5 >=5.5.0)Initialization array.
* @return DateTimeReturns a new instance of a DateTime object.
*/ - public static function __set_state ($array) {} + public static function __set_state($array) {} /** * @param DateTimeInterface $object * @return DateTime * @since 8.0 */ - public static function createFromInterface(DateTimeInterface $object){} + public static function createFromInterface(DateTimeInterface $object) {} } /** * Representation of time zone * @link https://php.net/manual/en/class.datetimezone.php */ -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; - +class DateTimeZone +{ + public const AFRICA = 1; + public const AMERICA = 2; + public const ANTARCTICA = 4; + public const ARCTIC = 8; + public const ASIA = 16; + public const ATLANTIC = 32; + public const AUSTRALIA = 64; + public const EUROPE = 128; + public const INDIAN = 256; + public const PACIFIC = 512; + public const UTC = 1024; + public const ALL = 2047; + public const ALL_WITH_BC = 4095; + public const PER_COUNTRY = 4096; /** * @param string $timezone * @link https://php.net/manual/en/datetimezone.construct.php */ - public function __construct ($timezone) {} + public function __construct($timezone) {} /** * Returns the name of the timezone * @return string * @link https://php.net/manual/en/datetimezone.getname.php */ - public function getName () {} + public function getName() {} /** * Returns location information for a timezone * @return array|false * @link https://php.net/manual/en/datetimezone.getlocation.php */ - public function getLocation () {} + public function getLocation() {} /** * Returns the timezone offset from GMT @@ -688,7 +681,7 @@ public function getLocation () {} * @return int|false * @link https://php.net/manual/en/datetimezone.getoffset.php */ - public function getOffset (DateTimeInterface $datetime) {} + public function getOffset(DateTimeInterface $datetime) {} /** * Returns all transitions for the timezone @@ -697,15 +690,14 @@ public function getOffset (DateTimeInterface $datetime) {} * @return array|false * @link https://php.net/manual/en/datetimezone.gettransitions.php */ - public function getTransitions ($timestampBegin=null, $timestampEnd=null) {} - + public function getTransitions($timestampBegin = null, $timestampEnd = null) {} /** * Returns associative array containing dst, offset and the timezone name * @return array|false * @link https://php.net/manual/en/datetimezone.listabbreviations.php */ - public static function listAbbreviations () {} + public static function listAbbreviations() {} /** * Returns a numerically indexed array with all timezone identifiers @@ -714,13 +706,12 @@ public static function listAbbreviations () {} * @return array|false * @link https://php.net/manual/en/datetimezone.listidentifiers.php */ - public static function listIdentifiers ($timezoneGroup = DateTimeZone::ALL, $countryCode = null) {} + public static function listIdentifiers($timezoneGroup = DateTimeZone::ALL, $countryCode = null) {} /** * @link https://php.net/manual/en/datetime.wakeup.php */ - public function __wakeup(){} - + public function __wakeup() {} public static function __set_state($an_array) {} } @@ -731,7 +722,8 @@ public static function __set_state($an_array) {} * that DateTime's constructor supports. * @link https://php.net/manual/en/class.dateinterval.php */ -class DateInterval { +class DateInterval +{ /** * Number of years * @var int @@ -787,13 +779,12 @@ class DateInterval { */ public $days; - /** * @param string $duration * @link https://php.net/manual/en/dateinterval.construct.php * @throws \Exception when the $duration cannot be parsed as an interval. */ - public function __construct ($duration) {} + public function __construct($duration) {} /** * Formats the interval @@ -801,7 +792,7 @@ public function __construct ($duration) {} * @return string * @link https://php.net/manual/en/dateinterval.format.php */ - public function format ($format) {} + public function format($format) {} /** * Sets up a DateInterval from the relative parts of the string @@ -809,7 +800,7 @@ public function format ($format) {} * @return DateInterval * @link https://php.net/manual/en/dateinterval.createfromdatestring.php */ - public static function createFromDateString ($datetime) {} + public static function createFromDateString($datetime) {} public function __wakeup() {} @@ -820,8 +811,9 @@ public static function __set_state($an_array) {} * Representation of date period. * @link https://php.net/manual/en/class.dateperiod.php */ -class DatePeriod implements IteratorAggregate { - const EXCLUDE_START_DATE = 1; +class DatePeriod implements IteratorAggregate +{ + public const EXCLUDE_START_DATE = 1; /** * Start date @@ -866,7 +858,7 @@ class DatePeriod implements IteratorAggregate { * @param int $options Can be set to DatePeriod::EXCLUDE_START_DATE. * @link https://php.net/manual/en/dateperiod.construct.php */ - public function __construct (DateTimeInterface $start, DateInterval $interval, DateTimeInterface $end, $options = 0) {} + public function __construct(DateTimeInterface $start, DateInterval $interval, DateTimeInterface $end, $options = 0) {} /** * @param DateTimeInterface $start @@ -875,14 +867,14 @@ public function __construct (DateTimeInterface $start, DateInterval $interval, D * @param int $options Can be set to DatePeriod::EXCLUDE_START_DATE. * @link https://php.net/manual/en/dateperiod.construct.php */ - public function __construct (DateTimeInterface $start, DateInterval $interval, $recurrences, $options = 0) {} + public function __construct(DateTimeInterface $start, DateInterval $interval, $recurrences, $options = 0) {} /** * @param string $isostr String containing the ISO interval. * @param int $options Can be set to DatePeriod::EXCLUDE_START_DATE. * @link https://php.net/manual/en/dateperiod.construct.php */ - public function __construct ($isostr, $options = 0) {} + public function __construct($isostr, $options = 0) {} /** * Gets the interval @@ -890,7 +882,7 @@ public function __construct ($isostr, $options = 0) {} * @link https://php.net/manual/en/dateperiod.getdateinterval.php * @since 5.6.5 */ - public function getDateInterval () {} + public function getDateInterval() {} /** * Gets the end date @@ -898,7 +890,7 @@ public function getDateInterval () {} * @link https://php.net/manual/en/dateperiod.getenddate.php * @since 5.6.5 */ - public function getEndDate () {} + public function getEndDate() {} /** * Gets the start date @@ -906,9 +898,9 @@ public function getEndDate () {} * @link https://php.net/manual/en/dateperiod.getstartdate.php * @since 5.6.5 */ - public function getStartDate () {} + public function getStartDate() {} - public static function __set_state ($array){} + public static function __set_state($array) {} public function __wakeup() {} @@ -919,11 +911,11 @@ public function __wakeup() {} * @since 7.2.17 * @since 7.3.4 */ - public function getRecurrences () {} + public function getRecurrences() {} /** * @return DateTimeInterface[] * @since 8.0 */ - public function getIterator(){} + public function getIterator() {} } diff --git a/date/date_d.php b/date/date_d.php index d5289cc37..0d7a0780e 100644 --- a/date/date_d.php +++ b/date/date_d.php @@ -2,36 +2,36 @@ // Start of date v.5.3.2-0.dotdeb.1 -define ('DATE_ATOM', "Y-m-d\TH:i:sP"); -define ('DATE_COOKIE', "l, d-M-Y H:i:s T"); -define ('DATE_ISO8601', "Y-m-d\TH:i:sO"); -define ('DATE_RFC822', "D, d M y H:i:s O"); -define ('DATE_RFC850', "l, d-M-y H:i:s T"); -define ('DATE_RFC1036', "D, d M y H:i:s O"); -define ('DATE_RFC1123', "D, d M Y H:i:s O"); -define ('DATE_RFC2822', "D, d M Y H:i:s O"); -define ('DATE_RFC3339', "Y-m-d\TH:i:sP"); -define ('DATE_RFC3339_EXTENDED', "Y-m-d\TH:i:s.vP"); -define ('DATE_RFC7231', "D, d M Y H:i:s \G\M\T"); -define ('DATE_RSS', "D, d M Y H:i:s O"); -define ('DATE_W3C', "Y-m-d\TH:i:sP"); +define('DATE_ATOM', "Y-m-d\TH:i:sP"); +define('DATE_COOKIE', "l, d-M-Y H:i:s T"); +define('DATE_ISO8601', "Y-m-d\TH:i:sO"); +define('DATE_RFC822', "D, d M y H:i:s O"); +define('DATE_RFC850', "l, d-M-y H:i:s T"); +define('DATE_RFC1036', "D, d M y H:i:s O"); +define('DATE_RFC1123', "D, d M Y H:i:s O"); +define('DATE_RFC2822', "D, d M Y H:i:s O"); +define('DATE_RFC3339', "Y-m-d\TH:i:sP"); +define('DATE_RFC3339_EXTENDED', "Y-m-d\TH:i:s.vP"); +define('DATE_RFC7231', "D, d M Y H:i:s \G\M\T"); +define('DATE_RSS', "D, d M Y H:i:s O"); +define('DATE_W3C', "Y-m-d\TH:i:sP"); /** * Timestamp * @link https://php.net/manual/en/datetime.constants.php */ -define ('SUNFUNCS_RET_TIMESTAMP', 0); +define('SUNFUNCS_RET_TIMESTAMP', 0); /** * Hours:minutes (example: 08:02) * @link https://php.net/manual/en/datetime.constants.php */ -define ('SUNFUNCS_RET_STRING', 1); +define('SUNFUNCS_RET_STRING', 1); /** * Hours as floating point number (example 8.75) * @link https://php.net/manual/en/datetime.constants.php */ -define ('SUNFUNCS_RET_DOUBLE', 2); +define('SUNFUNCS_RET_DOUBLE', 2); // End of date v.5.3.2-0.dotdeb.1 diff --git a/dba/dba.php b/dba/dba.php index 6424c40dd..4b67472d1 100644 --- a/dba/dba.php +++ b/dba/dba.php @@ -119,8 +119,7 @@ * @param mixed ...$handler_params [optional] * @return resource|false a positive handle on success or FALSE on failure. */ -function dba_open ($path, $mode, $handler, ...$handler_params) -{} +function dba_open($path, $mode, $handler, ...$handler_params) {} /** * Open database persistently @@ -143,8 +142,7 @@ function dba_open ($path, $mode, $handler, ...$handler_params) * @param mixed ...$handler_params [optional] * @return resource|false a positive handle on success or FALSE on failure. */ -function dba_popen ($path, $mode, $handler, ...$handler_params) -{} +function dba_popen($path, $mode, $handler, ...$handler_params) {} /** * Close a DBA database @@ -155,7 +153,7 @@ function dba_popen ($path, $mode, $handler, ...$handler_params) * * @return void No value is returned. */ -function dba_close ($dba): void {} +function dba_close($dba): void {} /** * Delete DBA entry specified by key @@ -169,8 +167,7 @@ function dba_close ($dba): void {} * * @return bool TRUE on success or FALSE on failure. */ -function dba_delete ($key, $dba): bool -{} +function dba_delete($key, $dba): bool {} /** * Check whether key exists @@ -184,8 +181,7 @@ function dba_delete ($key, $dba): bool * * @return bool TRUE if the key exists, FALSE otherwise. */ -function dba_exists ($key, $dba): bool -{} +function dba_exists($key, $dba): bool {} /** * Fetch data specified by key @@ -205,8 +201,7 @@ function dba_exists ($key, $dba): bool * @return string|false the associated string if the key/data pair is found, FALSE * otherwise. */ -function dba_fetch ($key, $handle): string|false -{} +function dba_fetch($key, $handle): string|false {} /** * Fetch data specified by key @@ -227,8 +222,7 @@ function dba_fetch ($key, $handle): string|false * @return string|false the associated string if the key/data pair is found, FALSE * otherwise. */ -function dba_fetch ($key, $skip, $dba): string|false -{} +function dba_fetch($key, $skip, $dba): string|false {} /** * Insert entry @@ -247,8 +241,7 @@ function dba_fetch ($key, $skip, $dba): string|false * * @return bool TRUE on success or FALSE on failure. */ -function dba_insert ($key, string $value, $dba): bool -{} +function dba_insert($key, string $value, $dba): bool {} /** * Replace or insert entry @@ -265,8 +258,7 @@ function dba_insert ($key, string $value, $dba): bool * * @return bool TRUE on success or FALSE on failure. */ -function dba_replace ($key, string $value, $dba): bool -{} +function dba_replace($key, string $value, $dba): bool {} /** * Fetch first key @@ -277,8 +269,7 @@ function dba_replace ($key, string $value, $dba): bool * * @return string|false the key on success or FALSE on failure. */ -function dba_firstkey ($dba): string|false -{} +function dba_firstkey($dba): string|false {} /** * Fetch next key @@ -289,8 +280,7 @@ function dba_firstkey ($dba): string|false * * @return string|false the key on success or FALSE on failure. */ -function dba_nextkey ($dba): string|false -{} +function dba_nextkey($dba): string|false {} /** * Optimize database @@ -301,8 +291,7 @@ function dba_nextkey ($dba): string|false * * @return bool TRUE on success or FALSE on failure. */ -function dba_optimize ($dba): bool -{} +function dba_optimize($dba): bool {} /** * Synchronize database @@ -313,8 +302,7 @@ function dba_optimize ($dba): bool * * @return bool TRUE on success or FALSE on failure. */ -function dba_sync ($dba): bool -{} +function dba_sync($dba): bool {} /** * List all the handlers available @@ -331,16 +319,14 @@ function dba_sync ($dba): bool * When the internal cdb library is used you will see * cdb and cdb_make. */ -function dba_handlers (bool $full_info = false): array -{} +function dba_handlers(bool $full_info = false): array {} /** * List all open database files * @link https://php.net/manual/en/function.dba-list.php * @return array An associative array, in the form resourceid => filename. */ -function dba_list (): array -{} +function dba_list(): array {} /** * Splits a key in string representation into array representation @@ -352,7 +338,6 @@ function dba_list (): array * value_name). This function will return FALSE if * key is NULL or FALSE. */ -function dba_key_split (string|false|null $key): array|false -{} +function dba_key_split(string|false|null $key): array|false {} // End of dba v. diff --git a/decimal/decimal.php b/decimal/decimal.php index 267d5be35..d3e48374e 100644 --- a/decimal/decimal.php +++ b/decimal/decimal.php @@ -1,4 +1,5 @@ DOMElement object from a SimpleXMLElement object * @link https://php.net/manual/en/function.dom-import-simplexml.php @@ -11,194 +10,193 @@ * * @return DOMElement|null The DOMElement node added or NULL if any errors occur. */ -function dom_import_simplexml (object $node): ?DOMElement {} - +function dom_import_simplexml(object $node): ?DOMElement {} /** * Node is a DOMElement * @link https://php.net/manual/en/dom.constants.php */ -define ('XML_ELEMENT_NODE', 1); +define('XML_ELEMENT_NODE', 1); /** * Node is a DOMAttr * @link https://php.net/manual/en/dom.constants.php */ -define ('XML_ATTRIBUTE_NODE', 2); +define('XML_ATTRIBUTE_NODE', 2); /** * Node is a DOMText * @link https://php.net/manual/en/dom.constants.php */ -define ('XML_TEXT_NODE', 3); +define('XML_TEXT_NODE', 3); /** * Node is a DOMCharacterData * @link https://php.net/manual/en/dom.constants.php */ -define ('XML_CDATA_SECTION_NODE', 4); +define('XML_CDATA_SECTION_NODE', 4); /** * Node is a DOMEntityReference * @link https://php.net/manual/en/dom.constants.php */ -define ('XML_ENTITY_REF_NODE', 5); +define('XML_ENTITY_REF_NODE', 5); /** * Node is a DOMEntity * @link https://php.net/manual/en/dom.constants.php */ -define ('XML_ENTITY_NODE', 6); +define('XML_ENTITY_NODE', 6); /** * Node is a DOMProcessingInstruction * @link https://php.net/manual/en/dom.constants.php */ -define ('XML_PI_NODE', 7); +define('XML_PI_NODE', 7); /** * Node is a DOMComment * @link https://php.net/manual/en/dom.constants.php */ -define ('XML_COMMENT_NODE', 8); +define('XML_COMMENT_NODE', 8); /** * Node is a DOMDocument * @link https://php.net/manual/en/dom.constants.php */ -define ('XML_DOCUMENT_NODE', 9); +define('XML_DOCUMENT_NODE', 9); /** * Node is a DOMDocumentType * @link https://php.net/manual/en/dom.constants.php */ -define ('XML_DOCUMENT_TYPE_NODE', 10); +define('XML_DOCUMENT_TYPE_NODE', 10); /** * Node is a DOMDocumentFragment * @link https://php.net/manual/en/dom.constants.php */ -define ('XML_DOCUMENT_FRAG_NODE', 11); +define('XML_DOCUMENT_FRAG_NODE', 11); /** * Node is a DOMNotation * @link https://php.net/manual/en/dom.constants.php */ -define ('XML_NOTATION_NODE', 12); -define ('XML_HTML_DOCUMENT_NODE', 13); -define ('XML_DTD_NODE', 14); -define ('XML_ELEMENT_DECL_NODE', 15); -define ('XML_ATTRIBUTE_DECL_NODE', 16); -define ('XML_ENTITY_DECL_NODE', 17); -define ('XML_NAMESPACE_DECL_NODE', 18); -define ('XML_LOCAL_NAMESPACE', 18); -define ('XML_ATTRIBUTE_CDATA', 1); -define ('XML_ATTRIBUTE_ID', 2); -define ('XML_ATTRIBUTE_IDREF', 3); -define ('XML_ATTRIBUTE_IDREFS', 4); -define ('XML_ATTRIBUTE_ENTITY', 6); -define ('XML_ATTRIBUTE_NMTOKEN', 7); -define ('XML_ATTRIBUTE_NMTOKENS', 8); -define ('XML_ATTRIBUTE_ENUMERATION', 9); -define ('XML_ATTRIBUTE_NOTATION', 10); +define('XML_NOTATION_NODE', 12); +define('XML_HTML_DOCUMENT_NODE', 13); +define('XML_DTD_NODE', 14); +define('XML_ELEMENT_DECL_NODE', 15); +define('XML_ATTRIBUTE_DECL_NODE', 16); +define('XML_ENTITY_DECL_NODE', 17); +define('XML_NAMESPACE_DECL_NODE', 18); +define('XML_LOCAL_NAMESPACE', 18); +define('XML_ATTRIBUTE_CDATA', 1); +define('XML_ATTRIBUTE_ID', 2); +define('XML_ATTRIBUTE_IDREF', 3); +define('XML_ATTRIBUTE_IDREFS', 4); +define('XML_ATTRIBUTE_ENTITY', 6); +define('XML_ATTRIBUTE_NMTOKEN', 7); +define('XML_ATTRIBUTE_NMTOKENS', 8); +define('XML_ATTRIBUTE_ENUMERATION', 9); +define('XML_ATTRIBUTE_NOTATION', 10); /** * Error code not part of the DOM specification. Meant for PHP errors. * @link https://php.net/manual/en/dom.constants.php */ -define ('DOM_PHP_ERR', 0); +define('DOM_PHP_ERR', 0); /** * If index or size is negative, or greater than the allowed value. * @link https://php.net/manual/en/dom.constants.php */ -define ('DOM_INDEX_SIZE_ERR', 1); +define('DOM_INDEX_SIZE_ERR', 1); /** * If the specified range of text does not fit into a * DOMString. * @link https://php.net/manual/en/dom.constants.php */ -define ('DOMSTRING_SIZE_ERR', 2); +define('DOMSTRING_SIZE_ERR', 2); /** * If any node is inserted somewhere it doesn't belong * @link https://php.net/manual/en/dom.constants.php */ -define ('DOM_HIERARCHY_REQUEST_ERR', 3); +define('DOM_HIERARCHY_REQUEST_ERR', 3); /** * If a node is used in a different document than the one that created it. * @link https://php.net/manual/en/dom.constants.php */ -define ('DOM_WRONG_DOCUMENT_ERR', 4); +define('DOM_WRONG_DOCUMENT_ERR', 4); /** * If an invalid or illegal character is specified, such as in a name. * @link https://php.net/manual/en/dom.constants.php */ -define ('DOM_INVALID_CHARACTER_ERR', 5); +define('DOM_INVALID_CHARACTER_ERR', 5); /** * If data is specified for a node which does not support data. * @link https://php.net/manual/en/dom.constants.php */ -define ('DOM_NO_DATA_ALLOWED_ERR', 6); +define('DOM_NO_DATA_ALLOWED_ERR', 6); /** * If an attempt is made to modify an object where modifications are not allowed. * @link https://php.net/manual/en/dom.constants.php */ -define ('DOM_NO_MODIFICATION_ALLOWED_ERR', 7); +define('DOM_NO_MODIFICATION_ALLOWED_ERR', 7); /** * If an attempt is made to reference a node in a context where it does not exist. * @link https://php.net/manual/en/dom.constants.php */ -define ('DOM_NOT_FOUND_ERR', 8); +define('DOM_NOT_FOUND_ERR', 8); /** * If the implementation does not support the requested type of object or operation. * @link https://php.net/manual/en/dom.constants.php */ -define ('DOM_NOT_SUPPORTED_ERR', 9); +define('DOM_NOT_SUPPORTED_ERR', 9); /** * If an attempt is made to add an attribute that is already in use elsewhere. * @link https://php.net/manual/en/dom.constants.php */ -define ('DOM_INUSE_ATTRIBUTE_ERR', 10); +define('DOM_INUSE_ATTRIBUTE_ERR', 10); /** * If an attempt is made to use an object that is not, or is no longer, usable. * @link https://php.net/manual/en/dom.constants.php */ -define ('DOM_INVALID_STATE_ERR', 11); +define('DOM_INVALID_STATE_ERR', 11); /** * If an invalid or illegal string is specified. * @link https://php.net/manual/en/dom.constants.php */ -define ('DOM_SYNTAX_ERR', 12); +define('DOM_SYNTAX_ERR', 12); /** * If an attempt is made to modify the type of the underlying object. * @link https://php.net/manual/en/dom.constants.php */ -define ('DOM_INVALID_MODIFICATION_ERR', 13); +define('DOM_INVALID_MODIFICATION_ERR', 13); /** * If an attempt is made to create or change an object in a way which is * incorrect with regard to namespaces. * @link https://php.net/manual/en/dom.constants.php */ -define ('DOM_NAMESPACE_ERR', 14); +define('DOM_NAMESPACE_ERR', 14); /** * If a parameter or an operation is not supported by the underlying object. * @link https://php.net/manual/en/dom.constants.php */ -define ('DOM_INVALID_ACCESS_ERR', 15); +define('DOM_INVALID_ACCESS_ERR', 15); /** * If a call to a method such as insertBefore or removeChild would make the Node @@ -206,7 +204,6 @@ function dom_import_simplexml (object $node): ?DOMElement {} * the operation would not be done. * @link https://php.net/manual/en/dom.constants.php */ -define ('DOM_VALIDATION_ERR', 16); +define('DOM_VALIDATION_ERR', 16); // End of dom v.20031129 -?> diff --git a/dom/dom_c.php b/dom/dom_c.php index 325f363a7..65e972c94 100644 --- a/dom/dom_c.php +++ b/dom/dom_c.php @@ -7,8 +7,8 @@ * The DOMNode class * @link https://php.net/manual/en/class.domnode.php */ -class DOMNode { - +class DOMNode +{ /** * @var string * Returns the most accurate name for the current node type @@ -134,7 +134,7 @@ class DOMNode { * * @return DOMNode The inserted node. */ - public function insertBefore (DOMNode $node, DOMNode $child = null) {} + public function insertBefore(DOMNode $node, DOMNode $child = null) {} /** * Replaces a child @@ -149,7 +149,7 @@ public function insertBefore (DOMNode $node, DOMNode $child = null) {} * * @return DOMNode|false The old node or false if an error occur. */ - public function replaceChild (DOMNode $node , DOMNode $child ) {} + public function replaceChild(DOMNode $node, DOMNode $child) {} /** * Removes child from list of children @@ -159,7 +159,7 @@ public function replaceChild (DOMNode $node , DOMNode $child ) {} * * @return DOMNode If the child could be removed the functions returns the old child. */ - public function removeChild (DOMNode $child ) {} + public function removeChild(DOMNode $child) {} /** * Adds new child at the end of the children @@ -169,14 +169,14 @@ public function removeChild (DOMNode $child ) {} * * @return DOMNode The node added. */ - public function appendChild (DOMNode $node) {} + public function appendChild(DOMNode $node) {} /** * Checks if node has children * @link https://php.net/manual/en/domnode.haschildnodes.php * @return bool true on success or false on failure. */ - public function hasChildNodes () {} + public function hasChildNodes() {} /** * Clones a node @@ -187,14 +187,14 @@ public function hasChildNodes () {} * * @return static The cloned node. */ - public function cloneNode ($deep = false) {} + public function cloneNode($deep = false) {} /** * Normalizes the node * @link https://php.net/manual/en/domnode.normalize.php * @return void */ - public function normalize () {} + public function normalize() {} /** * Checks if feature is supported for specified version @@ -209,19 +209,19 @@ public function normalize () {} * * @return bool true on success or false on failure. */ - public function isSupported ($feature, $version) {} + public function isSupported($feature, $version) {} /** * Checks if node has attributes * @link https://php.net/manual/en/domnode.hasattributes.php * @return bool true on success or false on failure. */ - public function hasAttributes () {} + public function hasAttributes() {} /** * @param DOMNode $other */ - public function compareDocumentPosition (DOMNode $other) {} + public function compareDocumentPosition(DOMNode $other) {} /** * Indicates if two nodes are the same node @@ -231,7 +231,7 @@ public function compareDocumentPosition (DOMNode $other) {} * * @return bool true on success or false on failure. */ - public function isSameNode (DOMNode $otherNode ) {} + public function isSameNode(DOMNode $otherNode) {} /** * Gets the namespace prefix of the node based on the namespace URI @@ -241,7 +241,7 @@ public function isSameNode (DOMNode $otherNode ) {} * * @return string The prefix of the namespace. */ - public function lookupPrefix ($namespace) {} + public function lookupPrefix($namespace) {} /** * Checks if the specified namespaceURI is the default namespace or not @@ -252,7 +252,7 @@ public function lookupPrefix ($namespace) {} * @return bool Return true if namespaceURI is the default * namespace, false otherwise. */ - public function isDefaultNamespace ($namespace) {} + public function isDefaultNamespace($namespace) {} /** * Gets the namespace URI of the node based on the prefix @@ -262,48 +262,47 @@ public function isDefaultNamespace ($namespace) {} * * @return string The namespace URI of the node. */ - public function lookupNamespaceURI ($prefix) {} + public function lookupNamespaceURI($prefix) {} /** * @param DOMNode $arg * @return bool */ - public function isEqualNode (DOMNode $arg) {} + public function isEqualNode(DOMNode $arg) {} /** * @param $feature * @param $version * @return mixed */ - public function getFeature ($feature, $version) {} + public function getFeature($feature, $version) {} /** * @param $key * @param $data * @param $handler */ - public function setUserData ($key, $data, $handler) {} + public function setUserData($key, $data, $handler) {} /** * @param $key * @return mixed */ - public function getUserData ($key) {} + public function getUserData($key) {} /** * Gets an XPath location path for the node * @return string|null the XPath, or NULL in case of an error. * @link https://secure.php.net/manual/en/domnode.getnodepath.php */ - public function getNodePath () {} + public function getNodePath() {} - - /** - * Get line number for a node - * @link https://php.net/manual/en/domnode.getlineno.php - * @return int Always returns the line number where the node was defined in. - */ - public function getLineNo () {} + /** + * Get line number for a node + * @link https://php.net/manual/en/domnode.getlineno.php + * @return int Always returns the line number where the node was defined in. + */ + public function getLineNo() {} /** * Canonicalize nodes to a string @@ -313,7 +312,7 @@ public function getLineNo () {} * @param null|array $nsPrefixes [optional] An array of namespace prefixes to filter the nodes by. * @return string|false Canonicalized nodes as a string or FALSE on failure */ - public function C14N ($exclusive = false, $withComments = false, array $xpath = null, array $nsPrefixes = null) {} + public function C14N($exclusive = false, $withComments = false, array $xpath = null, array $nsPrefixes = null) {} /** * Canonicalize nodes to a file. @@ -325,9 +324,7 @@ public function C14N ($exclusive = false, $withComments = false, array $xpath = * @param null|array $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 ($uri, $exclusive = false, $withComments = false, array $xpath = null, array $nsPrefixes = null) {} - - + public function C14NFile($uri, $exclusive = false, $withComments = false, array $xpath = null, array $nsPrefixes = null) {} } /** @@ -335,8 +332,8 @@ public function C14NFile ($uri, $exclusive = false, $withComments = false, array * when an operation is impossible to perform for logical reasons. * @link https://php.net/manual/en/class.domexception.php */ -class DOMException extends Exception { - +class DOMException extends Exception +{ /** * An integer indicating the type of error generated * @link https://php.net/manual/en/class.domexception.php#domexception.props.code @@ -344,66 +341,62 @@ class DOMException extends Exception { public $code; } -class DOMStringList { - +class DOMStringList +{ /** - * @param $index + * @param $index * @return mixed */ - public function item ($index) {} - + public function item($index) {} } /** * @link https://php.net/manual/en/ref.dom.php * @removed 8.0 */ -class DOMNameList { - +class DOMNameList +{ /** - * @param $index + * @param $index * @return mixed */ - public function getName ($index) {} + public function getName($index) {} /** - * @param $index + * @param $index * @return mixed */ - public function getNamespaceURI ($index) {} - + public function getNamespaceURI($index) {} } /** * @removed 8.0 */ -class DOMImplementationList { - +class DOMImplementationList +{ /** - * @param $index + * @param $index * @return mixed */ - public function item ($index) {} - + public function item($index) {} } /** * @removed 8.0 */ -class DOMImplementationSource { - +class DOMImplementationSource +{ /** - * @param $features + * @param $features * @return mixed */ - public function getDomimplementation ($features) {} + public function getDomimplementation($features) {} /** - * @param $features + * @param $features * @return mixed */ - public function getDomimplementations ($features) {} - + public function getDomimplementations($features) {} } /** @@ -412,35 +405,35 @@ public function getDomimplementations ($features) {} * particular instance of the document object model. * @link https://php.net/manual/en/class.domimplementation.php */ -class DOMImplementation { - +class DOMImplementation +{ /** * Creates a new DOMImplementation object * @link https://php.net/manual/en/domimplementation.construct.php */ - public function __construct(){} + public function __construct() {} /** * @param $feature * @param $version * @return mixed */ - public function getFeature ($feature, $version) {} + public function getFeature($feature, $version) {} - /** - * Test if the DOM implementation implements a specific feature - * @link https://php.net/manual/en/domimplementation.hasfeature.php - * @param string $feature- * The feature to test. - *
- * @param string $version- * The version number of the feature to test. In - * level 2, this can be either 2.0 or - * 1.0. - *
- * @return bool true on success or false on failure. - */ - public function hasFeature ($feature, $version) {} + /** + * Test if the DOM implementation implements a specific feature + * @link https://php.net/manual/en/domimplementation.hasfeature.php + * @param string $feature+ * The feature to test. + *
+ * @param string $version+ * The version number of the feature to test. In + * level 2, this can be either 2.0 or + * 1.0. + *
+ * @return bool true on success or false on failure. + */ + public function hasFeature($feature, $version) {} /** * Creates an empty DOMDocumentType object @@ -457,7 +450,7 @@ public function hasFeature ($feature, $version) {} * @return DOMDocumentType A new DOMDocumentType node with its * ownerDocument set to null. */ - public function createDocumentType ($qualifiedName = null, $publicId = null, $systemId = null) {} + public function createDocumentType($qualifiedName = null, $publicId = null, $systemId = null) {} /** * Creates a DOMDocument object of the specified type with its document element @@ -476,21 +469,18 @@ public function createDocumentType ($qualifiedName = null, $publicId = null, $sy * and doctype are null, the returned * DOMDocument is empty with no document element */ - public function createDocument ($namespace = null, $qualifiedName = null, DOMDocumentType $doctype = null) {} - + public function createDocument($namespace = null, $qualifiedName = null, DOMDocumentType $doctype = null) {} } - -class DOMNameSpaceNode { -} +class DOMNameSpaceNode {} /** * The DOMDocumentFragment class * @link https://php.net/manual/en/class.domdocumentfragment.php */ -class DOMDocumentFragment extends DOMNode implements DOMParentNode { - - public function __construct () {} +class DOMDocumentFragment extends DOMNode implements DOMParentNode +{ + public function __construct() {} /** * Append raw XML data @@ -500,7 +490,7 @@ public function __construct () {} * * @return bool true on success or false on failure. */ - public function appendXML ($data) {} + public function appendXML($data) {} /** * {@inheritDoc} @@ -518,8 +508,8 @@ public function prepend(...$nodes) {} * document; serves as the root of the document tree. * @link https://php.net/manual/en/class.domdocument.php */ -class DOMDocument extends DOMNode implements DOMParentNode { - +class DOMDocument extends DOMNode implements DOMParentNode +{ /** * @var string * @link https://php.net/manual/en/class.domdocument.php#domdocument.props.actualencoding @@ -564,28 +554,28 @@ class DOMDocument extends DOMNode implements DOMParentNode { * encoding in this implementation. * @link https://php.net/manual/en/class.domdocument.php#domdocument.props.encoding */ - public $encoding ; + public $encoding; /** * @var bool * Nicely formats output with indentation and extra space. * @link https://php.net/manual/en/class.domdocument.php#domdocument.props.formatoutput */ - public $formatOutput ; + public $formatOutput; /** * @var DOMImplementation * The* The path to the schema. *
- * @param int $options [optional]- * Bitwise OR - * of the libxml option constants. - *
+ * @param int $options [optional]+ * Bitwise OR + * of the libxml option constants. + *
* @return bool true on success or false on failure. */ - public function schemaValidate ($filename, $options = null) {} + public function schemaValidate($filename, $options = null) {} /** * Validates a document based on a schema @@ -1026,7 +1016,7 @@ public function schemaValidate ($filename, $options = null) {} * Available since PHP 5.5.2 and Libxml 2.6.14. * @return bool true on success or false on failure. */ - public function schemaValidateSource ($source, $flags) {} + public function schemaValidateSource($source, $flags) {} /** * Performs relaxNG validation on the document @@ -1036,7 +1026,7 @@ public function schemaValidateSource ($source, $flags) {} * * @return bool true on success or false on failure. */ - public function relaxNGValidate ($filename) {} + public function relaxNGValidate($filename) {} /** * Performs relaxNG validation on the document @@ -1046,7 +1036,7 @@ public function relaxNGValidate ($filename) {} * * @return bool true on success or false on failure. */ - public function relaxNGValidateSource ($source) {} + public function relaxNGValidateSource($source) {} /** * Register extended class used to create base node type @@ -1062,16 +1052,15 @@ public function relaxNGValidateSource ($source) {} * * @return bool true on success or false on failure. */ - public function registerNodeClass ($baseClass, $extendedClass) {} - + public function registerNodeClass($baseClass, $extendedClass) {} } /** * The DOMNodeList class * @link https://php.net/manual/en/class.domnodelist.php */ -class DOMNodeList implements IteratorAggregate, Countable { - +class DOMNodeList implements IteratorAggregate, Countable +{ /** * @var int * The number of nodes in the list. The range of valid child node indices is 0 to length - 1 inclusive. @@ -1079,18 +1068,18 @@ class DOMNodeList implements IteratorAggregate, Countable { */ public $length; - /** - * Retrieves a node specified by index - * @link https://php.net/manual/en/domnodelist.item.php - * @param int $index- * Index of the node into the collection. - * The range of valid child node indices is 0 to length - 1 inclusive. - *
- * @return DOMNode|null The node at the indexth position in the - * DOMNodeList, or null if that is not a valid - * index. - */ - public function item ($index) {} + /** + * Retrieves a node specified by index + * @link https://php.net/manual/en/domnodelist.item.php + * @param int $index+ * Index of the node into the collection. + * The range of valid child node indices is 0 to length - 1 inclusive. + *
+ * @return DOMNode|null The node at the indexth position in the + * DOMNodeList, or null if that is not a valid + * index. + */ + public function item($index) {} /** * @since 7.2 @@ -1101,7 +1090,7 @@ public function count() {} * @since 8.0 * @return Traversable */ - public function getIterator(){} + public function getIterator() {} } /** @@ -1109,8 +1098,8 @@ public function getIterator(){} * @link https://php.net/manual/en/class.domnamednodemap.php * @property-read int $length The number of nodes in the map. The range of valid child node indices is 0 to length - 1 inclusive. */ -class DOMNamedNodeMap implements IteratorAggregate, Countable { - +class DOMNamedNodeMap implements IteratorAggregate, Countable +{ /** * Retrieves a node specified by name * @link https://php.net/manual/en/domnamednodemap.getnameditem.php @@ -1120,17 +1109,17 @@ class DOMNamedNodeMap implements IteratorAggregate, Countable { * @return DOMNode|null A node (of any type) with the specified nodeName, or * null if no node is found. */ - public function getNamedItem ($qualifiedName) {} + public function getNamedItem($qualifiedName) {} /** * @param DOMNode $arg */ - public function setNamedItem (DOMNode $arg) {} + public function setNamedItem(DOMNode $arg) {} /** * @param $name [optional] */ - public function removeNamedItem ($name) {} + public function removeNamedItem($name) {} /** * Retrieves a node specified by index @@ -1142,7 +1131,7 @@ public function removeNamedItem ($name) {} * if that is not a valid index (greater than or equal to the number of nodes * in this map). */ - public function item ($index) {} + public function item($index) {} /** * Retrieves a node specified by local name and namespace URI @@ -1156,18 +1145,18 @@ public function item ($index) {} * @return DOMNode|null A node (of any type) with the specified local name and namespace URI, or * null if no node is found. */ - public function getNamedItemNS ($namespace, $localName) {} + public function getNamedItemNS($namespace, $localName) {} /** * @param DOMNode $arg [optional] */ - public function setNamedItemNS (DOMNode $arg) {} + public function setNamedItemNS(DOMNode $arg) {} /** * @param $namespace [optional] * @param $localName [optional] */ - public function removeNamedItemNS ($namespace, $localName) {} + public function removeNamedItemNS($namespace, $localName) {} /** * @since 7.2 @@ -1179,7 +1168,7 @@ public function count() {} * @since 8.0 * @return Traversable */ - public function getIterator(){} + public function getIterator() {} } /** @@ -1187,9 +1176,8 @@ public function getIterator(){} * No nodes directly correspond to this class, but other nodes do inherit from it. * @link https://php.net/manual/en/class.domcharacterdata.php */ -class DOMCharacterData extends DOMNode implements DOMChildNode { - - +class DOMCharacterData extends DOMNode implements DOMChildNode +{ /** * @var string * The contents of the node. @@ -1217,7 +1205,7 @@ class DOMCharacterData extends DOMNode implements DOMChildNode { * and count exceeds the length, then all 16-bit units * to the end of the data are returned. */ - public function substringData ($offset, $count) {} + public function substringData($offset, $count) {} /** * Append the string to the end of the character data of the node @@ -1227,7 +1215,7 @@ public function substringData ($offset, $count) {} * * @return void */ - public function appendData ($data) {} + public function appendData($data) {} /** * Insert a string at the specified 16-bit unit offset @@ -1240,7 +1228,7 @@ public function appendData ($data) {} * * @return void */ - public function insertData ($offset, $data) {} + public function insertData($offset, $data) {} /** * Remove a range of characters from the node @@ -1255,7 +1243,7 @@ public function insertData ($offset, $data) {} * * @return void */ - public function deleteData ($offset, $count) {} + public function deleteData($offset, $count) {} /** * Replace a substring within the DOMCharacterData node @@ -1273,7 +1261,7 @@ public function deleteData ($offset, $count) {} * * @return void */ - public function replaceData ($offset, $count, $data) {} + public function replaceData($offset, $count, $data) {} /** * {@inheritDoc} @@ -1302,7 +1290,6 @@ public function replaceWith(...$nodes) {} */ class DOMAttr extends DOMNode { - /** * @var string * (PHP5)Note: Values will be compared by value and by type.
* @link https://www.php.net/manual/en/ds-vector.find.php */ - public function find($value) - { - } + public function find($value) {} /** * Returns the first value in the vector. @@ -561,9 +540,7 @@ public function find($value) * @throws UnderflowException if empty. * @link https://www.php.net/manual/en/ds-vector.first.php */ - public function first() - { - } + public function first() {} /** * Returns the value at a given index. @@ -571,9 +548,7 @@ public function first() * @return mixed * @link https://www.php.net/manual/en/ds-vector.get.php */ - public function get(int $index) - { - } + public function get(int $index) {} /** * Inserts values into the sequence at a given index. @@ -584,9 +559,7 @@ public function get(int $index) * @param array $values The value or values to insert. * @link https://www.php.net/manual/en/ds-vector.insert.php */ - public function insert(int $index, ...$values): void - { - } + public function insert(int $index, ...$values): void {} /** * Joins all values together as a string using an optional separator between each value. @@ -595,9 +568,7 @@ public function insert(int $index, ...$values): void * @return string All values of the sequence joined together as a string. * @link https://www.php.net/manual/en/ds-vector.join.php */ - public function join(?string $glue = null): string - { - } + public function join(?string $glue = null): string {} /** * Returns the last value in the sequence. @@ -605,9 +576,7 @@ public function join(?string $glue = null): string * @return mixed The last value in the sequence. * @link https://www.php.net/manual/en/ds-vector.last.php */ - public function last() - { - } + public function last() {} /** * Returns the result of applying a callback function to each value in the sequence. @@ -618,9 +587,7 @@ public function last() * @return Vector * @link https://www.php.net/manual/en/ds-vector.map.php */ - public function map(callable $callback): Vector - { - } + public function map(callable $callback): Vector {} /** * Returns the result of adding all given values to the sequence. @@ -632,9 +599,7 @@ public function map(callable $callback): Vector * The current instance won't be affected. * @link https://www.php.net/manual/en/ds-vector.merge.php */ - public function merge($values): Vector - { - } + public function merge($values): Vector {} /** * Removes and returns the last value. @@ -642,18 +607,14 @@ public function merge($values): Vector * @return mixed * @link https://www.php.net/manual/en/ds-vector.pop.php */ - public function pop() - { - } + public function pop() {} /** * Adds values to the end of the sequence. * @param array $values * @link https://www.php.net/manual/en/ds-vector.push.php */ - public function push(...$values): void - { - } + public function push(...$values): void {} /** * Reduces the sequence to a single value using a callback function. @@ -667,9 +628,7 @@ public function push(...$values): void * * @link https://www.php.net/manual/en/ds-vector.reduce.php */ - public function reduce(callable $callback, $initial = null) - { - } + public function reduce(callable $callback, $initial = null) {} /** * Removes and returns a value by index. @@ -677,17 +636,13 @@ public function reduce(callable $callback, $initial = null) * @return mixed The value that was removed. * @link https://www.php.net/manual/en/ds-vector.remove.php */ - public function remove(int $index) - { - } + public function remove(int $index) {} /** * Reverses the sequence in-place. * @link https://www.php.net/manual/en/ds-vector.reverse.php */ - public function reverse(): void - { - } + public function reverse(): void {} /** * Returns a reversed copy of the sequence. @@ -695,9 +650,7 @@ public function reverse(): void * Note: The current instance is not affected. * @link https://www.php.net/manual/en/ds-vector.reversed.php */ - public function reversed(): Vector - { - } + public function reversed(): Vector {} /** * Rotates the sequence by a given number of rotations, which is @@ -709,9 +662,7 @@ public function reversed(): Vector * * @param int $rotations The number of times the sequence should be rotated. */ - public function rotate(int $rotations): void - { - } + public function rotate(int $rotations): void {} /** * Updates a value at a given index. @@ -723,9 +674,7 @@ public function rotate(int $rotations): void * * @throws OutOfRangeException if the index is not valid. */ - public function set(int $index, $value): void - { - } + public function set(int $index, $value): void {} /** * Removes and returns the first value. @@ -735,9 +684,7 @@ public function set(int $index, $value): void * @return mixed The first value, which was removed. * @throws UnderflowException if empty. */ - public function shift() - { - } + public function shift() {} /** * Creates a sub-sequence of a given range. @@ -755,9 +702,7 @@ public function shift() * between the index and the end of the sequence. * @return Vector */ - public function slice(int $index, int $length = null): Vector - { - } + public function slice(int $index, int $length = null): Vector {} /** * Sorts the sequence in-place, using an optional comparator function. @@ -774,9 +719,7 @@ public function slice(int $index, int $length = null): Vector * such as 0.99 and 0.1 will both be cast to an integer value of 0, * which will compare such values as equal. */ - public function sort(?callable $comparator = null): void - { - } + public function sort(?callable $comparator = null): void {} /** * Returns a sorted copy, using an optional comparator function. @@ -791,9 +734,7 @@ public function sort(?callable $comparator = null): void * an integer value of 0, which will compare such values as equal. * @return Vector Returns a sorted copy of the sequence. */ - public function sorted(?callable $comparator = null): Vector - { - } + public function sorted(?callable $comparator = null): Vector {} /** * Returns the sum of all values in the sequence.Note: Capacity will always be rounded up to the nearest power of 2.
* @link https://www.php.net/manual/en/ds-deque.allocate.php */ - public function allocate(int $capacity): void - { - } + public function allocate(int $capacity): void {} /** * Updates all values by applying a callback function to each value in @@ -949,18 +864,14 @@ public function allocate(int $capacity): void * * @link https://www.php.net/manual/en/ds-deque.apply.php */ - public function apply(callable $callback): void - { - } + public function apply(callable $callback): void {} /** * Returns the current capacity. * @return int The current capacity. * @link https://www.php.net/manual/en/ds-deque.capacity.php */ - public function capacity(): int - { - } + public function capacity(): int {} /** * Determines if the deque contains all values. @@ -969,9 +880,7 @@ public function capacity(): int * deque, TRUE otherwise. * @link https://www.php.net/manual/en/ds-deque.contains.php */ - public function contains(...$values): bool - { - } + public function contains(...$values): bool {} /** * Creates a new deque using a callable to determine which values @@ -987,9 +896,7 @@ public function contains(...$values): bool * TRUE if a callback was not provided. * @link https://www.php.net/manual/en/ds-deque.filter.php */ - public function filter(?callable $callback = null): Deque - { - } + public function filter(?callable $callback = null): Deque {} /** * Returns the index of the value, or FALSE if not found. @@ -997,9 +904,7 @@ public function filter(?callable $callback = null): Deque * @return int|false The index of the value, or FALSE if not found. * @link https://www.php.net/manual/en/ds-deque.find.php */ - public function find($value) - { - } + public function find($value) {} /** * Returns the first value in the deque. @@ -1007,9 +912,7 @@ public function find($value) * @throws UnderflowException if empty. * @link https://www.php.net/manual/en/ds-deque.first.php */ - public function first() - { - } + public function first() {} /** * Returns the value at a given index. @@ -1018,9 +921,7 @@ public function first() * @throws OutOfRangeException if the index is not valid. * @link https://www.php.net/manual/en/ds-deque.get.php */ - public function get(int $index) - { - } + public function get(int $index) {} /** * Inserts values into the deque at a given index. @@ -1031,9 +932,7 @@ public function get(int $index) * @throws OutOfRangeException if the index is not valid. * @link https://www.php.net/manual/en/ds-deque.insert.php */ - public function insert(int $index, ...$values): void - { - } + public function insert(int $index, ...$values): void {} /** * Joins all values together as a string using an optional separator @@ -1043,9 +942,7 @@ public function insert(int $index, ...$values): void * string. * @link https://www.php.net/manual/en/ds-deque.join.php */ - public function join(string $glue = ''): string - { - } + public function join(string $glue = ''): string {} /** * Returns the last value in the deque. @@ -1053,9 +950,7 @@ public function join(string $glue = ''): string * @throws UnderflowException if empty. * @link https://www.php.net/manual/en/ds-deque.last.php */ - public function last() - { - } + public function last() {} /** * Returns the result of applying a callback function to each value in @@ -1073,9 +968,7 @@ public function last() * affected. * @link https://www.php.net/manual/en/ds-deque.map.php */ - public function map(callable $callback): Deque - { - } + public function map(callable $callback): Deque {} /** * Returns the result of adding all given values to the deque. @@ -1085,9 +978,7 @@ public function map(callable $callback): Deque * then returning that copy. * @link https://www.php.net/manual/en/ds-deque.merge.php */ - public function merge($values): Deque - { - } + public function merge($values): Deque {} /** * Removes and returns the last value. @@ -1095,17 +986,13 @@ public function merge($values): Deque * @throws UnderflowException if empty. * @link https://www.php.net/manual/en/ds-deque.pop.php */ - public function pop() - { - } + public function pop() {} /** * Adds values to the end of the deque. * @param mixed ...$values The values to add. */ - public function push(...$values): void - { - } + public function push(...$values): void {} /** * Reduces the deque to a single value using a callback function. @@ -1119,9 +1006,7 @@ public function push(...$values): void * @return mixed The return value of the final callback. * @link https://www.php.net/manual/en/ds-deque.reduce.php */ - public function reduce(callable $callback, $initial = null) - { - } + public function reduce(callable $callback, $initial = null) {} /** * Removes and returns a value by index. @@ -1129,26 +1014,20 @@ public function reduce(callable $callback, $initial = null) * @return mixed The value that was removed. * @link https://www.php.net/manual/en/ds-deque.remove.php */ - public function remove(int $index) - { - } + public function remove(int $index) {} /** * Reverses the deque in-place. * @link https://www.php.net/manual/en/ds-deque.reverse.php */ - public function reverse(): void - { - } + public function reverse(): void {} /** * Returns a reversed copy of the deque. * @return Deque A reversed copy of the deque. *Note: The current instance is not affected.
*/ - public function reversed(): Deque - { - } + public function reversed(): Deque {} /** * Rotates the deque by a given number of rotations, which is @@ -1159,9 +1038,7 @@ public function reversed(): Deque * rotated. * @link https://www.php.net/manual/en/ds-deque.rotate.php */ - public function rotate(int $rotations): void - { - } + public function rotate(int $rotations): void {} /** * Updates a value at a given index. @@ -1170,9 +1047,7 @@ public function rotate(int $rotations): void * @throws OutOfRangeException if the index is not valid. * @link https://www.php.net/manual/en/ds-deque.set.php */ - public function set(int $index, $value): void - { - } + public function set(int $index, $value): void {} /** * Removes and returns the first value. @@ -1180,9 +1055,7 @@ public function set(int $index, $value): void * @throws UnderflowException if empty. * @link https://www.php.net/manual/en/ds-deque.shift.php */ - public function shift() - { - } + public function shift() {} /** * Creates a sub-deque of a given range. @@ -1199,9 +1072,7 @@ public function shift() * @return Deque A sub-deque of the given range. * @link https://www.php.net/manual/en/ds-deque.slice.php */ - public function slice(int $index, int $length = null): Deque - { - } + public function slice(int $index, int $length = null): Deque {} /** * Sorts the deque in-place, using an optional comparator function. @@ -1218,9 +1089,7 @@ public function slice(int $index, int $length = null): Deque * values as equal. * @link https://www.php.net/manual/en/ds-deque.sort.php */ - public function sort(?callable $comparator = null): void - { - } + public function sort(?callable $comparator = null): void {} /** * Returns a sorted copy, using an optional comparator function. @@ -1238,9 +1107,7 @@ public function sort(?callable $comparator = null): void * @return Deque Returns a sorted copy of the deque. * @link https://www.php.net/manual/en/ds-deque.sort.php */ - public function sorted(?callable $comparator = null): Deque - { - } + public function sorted(?callable $comparator = null): Deque {} /** * Returns the sum of all values in the deque. @@ -1249,9 +1116,7 @@ public function sorted(?callable $comparator = null): Deque * @return float|int The sum of all the values in the deque as * either a float or int depending on the values in the deque. */ - public function sum(): float|int - { - } + public function sum(): float|int {} /** * Adds values to the front of the deque, moving all the current @@ -1260,9 +1125,7 @@ public function sum(): float|int *Note: Multiple values will be added in the same order that they * are passed.
*/ - public function unshift($values): void - { - } + public function unshift($values): void {} /** * Specify data which should be serialized to JSON @@ -1271,11 +1134,7 @@ public function unshift($values): void * which is a value of any type other than a resource. * @since 5.4 */ - public function jsonSerialize() - { - } - - + public function jsonSerialize() {} } class Map implements Collection @@ -1286,9 +1145,7 @@ class Map implements Collection * * @link https://www.php.net/manual/en/ds-map.construct.php */ - public function __construct(...$values) - { - } + public function __construct(...$values) {} /** * Allocates enough memory for a required capacity. @@ -1299,9 +1156,7 @@ public function __construct(...$values) * * @link https://www.php.net/manual/en/ds-map.allocate.php */ - public function allocate(int $capacity) - { - } + public function allocate(int $capacity) {} /** * Updates all values by applying a callback function to each value in the map. @@ -1311,9 +1166,7 @@ public function allocate(int $capacity) * * @link https://www.php.net/manual/en/ds-map.apply.php */ - public function apply(callable $callback) - { - } + public function apply(callable $callback) {} /** * Returns the current capacity. @@ -1322,9 +1175,7 @@ public function apply(callable $callback) * * @link https://www.php.net/manual/en/ds-map.capacity.php */ - public function capacity(): int - { - } + public function capacity(): int {} /** * Count elements of an object @@ -1335,26 +1186,20 @@ public function capacity(): int * The return value is cast to an integer. * @since 5.1 */ - public function count(): int - { - } + public function count(): int {} /** * Removes all values from the collection. * @link https://www.php.net/manual/en/ds-collection.clear.php */ - public function clear(): void - { - } + public function clear(): void {} /** * Returns a shallow copy of the collection. * @link https://www.php.net/manual/en/ds-collection.copy.php * @return Collection */ - public function copy(): Collection - { - } + public function copy(): Collection {} /** * Returns the result of removing all keys from the current instance that are present in a given map. @@ -1367,9 +1212,7 @@ public function copy(): Collection * * @link https://www.php.net/manual/en/ds-map.diff.php */ - public function diff(Map $map): Map - { - } + public function diff(Map $map): Map {} /** * Creates a new map using a callable to determine which pairs to include @@ -1381,9 +1224,7 @@ public function diff(Map $map): Map * * @link https://www.php.net/manual/en/ds-map.filter.php */ - public function filter(?callable $callback = null): Map - { - } + public function filter(?callable $callback = null): Map {} /** * Returns the first pair in the map @@ -1394,9 +1235,7 @@ public function filter(?callable $callback = null): Map * * @link https://www.php.net/manual/en/ds-map.first.php */ - public function first(): Pair - { - } + public function first(): Pair {} /** * Returns the value for a given key, or an optional default value if the key could not be found. @@ -1421,9 +1260,7 @@ public function first(): Pair * * @link https://www.php.net/manual/en/ds-map.get.php */ - public function get($key, $default = null) - { - } + public function get($key, $default = null) {} /** * Determines whether the map contains a given key @@ -1434,9 +1271,7 @@ public function get($key, $default = null) * * @link https://www.php.net/manual/en/ds-map.hasKey.php */ - public function hasKey($key): bool - { - } + public function hasKey($key): bool {} /** * Determines whether the map contains a given value @@ -1447,9 +1282,7 @@ public function hasKey($key): bool * * @link https://www.php.net/manual/en/ds-map.hasValue.php */ - public function hasValue($value): bool - { - } + public function hasValue($value): bool {} /** * Creates a new map containing the pairs of the current instance whose @@ -1467,9 +1300,7 @@ public function hasValue($value): bool * * @link https://www.php.net/manual/en/ds-map.intersect.php */ - public function intersect(Map $map): Map - { - } + public function intersect(Map $map): Map {} /** * Returns whether the collection is empty. @@ -1480,9 +1311,7 @@ public function intersect(Map $map): Map * * @link https://www.php.net/manual/en/ds-map.isempty.php */ - public function isEmpty(): bool - { - } + public function isEmpty(): bool {} /** * Converts the map to an array. @@ -1499,9 +1328,7 @@ public function isEmpty(): bool * @return array An array containing all the values in the same order as * the map. */ - public function toArray(): array - { - } + public function toArray(): array {} /** * Specify data which should be serialized to JSON @@ -1510,18 +1337,14 @@ public function toArray(): array * which is a value of any type other than a resource. * @since 5.4 */ - public function jsonSerialize() - { - } + public function jsonSerialize() {} /** * Returns a set containing all the keys of the map, in the same order. * @link https://www.php.net/manual/en/ds-map.keys.php * @return Set A Ds\Set containing all the keys of the map. */ - public function keys(): Set - { - } + public function keys(): Set {} /** * Sorts the map in-place by key, using an optional comparator function. @@ -1538,9 +1361,7 @@ public function keys(): Set * equal. * @link https://www.php.net/manual/en/ds-map.ksort.php */ - public function ksort(?callable $comparator = null) - { - } + public function ksort(?callable $comparator = null) {} /** * Returns a copy sorted by key, using an optional comparator function. @@ -1558,9 +1379,7 @@ public function ksort(?callable $comparator = null) * @return Map Returns a copy of the map, sorted by key. * @link https://www.php.net/manual/en/ds-map.ksorted.php */ - public function ksorted(?callable $comparator = null): Map - { - } + public function ksorted(?callable $comparator = null): Map {} /** * Returns the last pair of the map. @@ -1568,9 +1387,7 @@ public function ksorted(?callable $comparator = null): Map * @throws UnderflowException if empty * @link https://www.php.net/manual/en/ds-map.last.php */ - public function last(): Pair - { - } + public function last(): Pair {} /** * Returns the result of applying a callback function to each value of @@ -1586,9 +1403,7 @@ public function last(): Pair * * @link https://www.php.net/manual/en/ds-map.map.php */ - public function map(callable $callback): Map - { - } + public function map(callable $callback): Map {} /** * Returns the result of associating all keys of a given traversable @@ -1603,9 +1418,7 @@ public function map(callable $callback): Map * * @link https://www.php.net/manual/en/ds-map.merge.php */ - public function merge($values): Map - { - } + public function merge($values): Map {} /** * Returns a Ds\Sequence containing all the pairs of the map. @@ -1614,9 +1427,7 @@ public function merge($values): Map * * @link https://www.php.net/manual/en/ds-map.pairs.php */ - public function pairs(): Sequence - { - } + public function pairs(): Sequence {} /** * Associates a key with a value, overwriting a previous association if @@ -1639,9 +1450,7 @@ public function pairs(): Sequence * * @link https://www.php.net/manual/en/ds-map.put.php */ - public function put($key, $value) - { - } + public function put($key, $value) {} /** * Associates all key-value pairs of a traversable object or array. @@ -1656,9 +1465,7 @@ public function put($key, $value) * * @link https://www.php.net/manual/en/ds-map.putall.php */ - public function putAll($pairs) - { - } + public function putAll($pairs) {} /** * Reduces the map to a single value using a callback function. @@ -1675,9 +1482,7 @@ public function putAll($pairs) * * @link https://www.php.net/manual/en/ds-map.reduce.php */ - public function reduce(callable $callback, $initial) - { - } + public function reduce(callable $callback, $initial) {} /** * Removes and returns a value by key, or return an optional default @@ -1709,18 +1514,14 @@ public function reduce(callable $callback, $initial) * * @link https://www.php.net/manual/en/ds-map.remove.php */ - public function remove($key, $default = null) - { - } + public function remove($key, $default = null) {} /** * Reverses the map in-place. * * @link https://www.php.net/manual/en/ds-map.reverse.php */ - public function reverse() - { - } + public function reverse() {} /** * Returns a reversed copy of the map. @@ -1731,9 +1532,7 @@ public function reverse() * * @link https://www.php.net/manual/en/ds-map.reversed.php */ - public function reversed(): Map - { - } + public function reversed(): Map {} /** * Returns the pair at a given zero-based position. @@ -1746,9 +1545,7 @@ public function reversed(): Map * * @link https://www.php.net/manual/en/ds-map.skip.php */ - public function skip(int $position): Pair - { - } + public function skip(int $position): Pair {} /** * Returns a subset of the map defined by a starting index and length. @@ -1770,9 +1567,7 @@ public function skip(int $position): Pair * * @link https://www.php.net/manual/en/ds-map.slice.php */ - public function slice(int $index, ?int $length = null): Map - { - } + public function slice(int $index, ?int $length = null): Map {} /** * Sorts the map in-place by value, using an optional comparator @@ -1794,9 +1589,7 @@ public function slice(int $index, ?int $length = null): Map * * @link https://www.php.net/manual/en/ds-map.sort.php */ - public function sort(?callable $comparator = null) - { - } + public function sort(?callable $comparator = null) {} /** * Returns a copy, sorted by value using an optional comparator function. @@ -1819,9 +1612,7 @@ public function sort(?callable $comparator = null) * * @link https://www.php.net/manual/en/ds-map.sorted.php */ - public function sorted(?callable $comparator = null): Map - { - } + public function sorted(?callable $comparator = null): Map {} /** * Returns the sum of all values in the map. @@ -1834,9 +1625,7 @@ public function sorted(?callable $comparator = null): Map * * @link https://www.php.net/manual/en/ds-map.sum.php */ - public function sum(): float|int - { - } + public function sum(): float|int {} /** * Creates a new map using values from the current instance and another @@ -1854,9 +1643,7 @@ public function sum(): float|int * * @link https://www.php.net/manual/en/ds-map.union.php */ - public function union(Map $map): Map - { - } + public function union(Map $map): Map {} /** * Returns a sequence containing all the values of the map, in the same @@ -1866,9 +1653,7 @@ public function union(Map $map): Map * * @link https://www.php.net/manual/en/ds-map.values.php */ - public function values(): Sequence - { - } + public function values(): Sequence {} /** * Creates a new map containing keys of the current instance as well as @@ -1883,9 +1668,7 @@ public function values(): Sequence * * @link https://www.php.net/manual/en/ds-map.xor.php */ - public function xor(Map $map): Map - { - } + public function xor(Map $map): Map {} } /** @@ -1912,18 +1695,14 @@ class Pair implements JsonSerializable * * @link https://php.net/manual/en/ds-pair.construct.php */ - public function __construct($key = null, $value = null) - { - } + public function __construct($key = null, $value = null) {} /** * Removes all values from the pair. * * @link https://php.net/manual/en/ds-pair.clear.php */ - public function clear() - { - } + public function clear() {} /** * Returns a shallow copy of the pair. @@ -1932,9 +1711,7 @@ public function clear() * * @link https://php.net/manual/en/ds-pair.copy.php */ - public function copy(): Pair - { - } + public function copy(): Pair {} /** * Returns whether the pair is empty. @@ -1943,9 +1720,7 @@ public function copy(): Pair * * @link https://php.net/manual/en/ds-pair.isempty.php */ - public function isEmpty(): bool - { - } + public function isEmpty(): bool {} /** * Converts the pair to an array. @@ -1957,9 +1732,7 @@ public function isEmpty(): bool * * @link https://php.net/manual/en/ds-pair.toarray.php */ - public function toArray(): array - { - } + public function toArray(): array {} /** * Specify data which should be serialized to JSON @@ -1967,10 +1740,7 @@ public function toArray(): array * @return mixed data which can be serialized by json_encode, * which is a value of any type other than a resource. */ - public function jsonSerialize() - { - } - + public function jsonSerialize() {} } /** @@ -1993,9 +1763,7 @@ class Set implements Collection * * @link https://php.net/manual/en/ds-set.construct.php */ - public function __construct(...$values) - { - } + public function __construct(...$values) {} /** * Adds all given values to the set that haven't already been added. @@ -2011,9 +1779,7 @@ public function __construct(...$values) * * @link https://php.net/manual/en/ds-set.add.php */ - public function add(...$values) - { - } + public function add(...$values) {} /** * Allocates enough memory for a required capacity. @@ -2028,9 +1794,7 @@ public function add(...$values) * * @link https://php.net/manual/en/ds-set.allocate.php */ - public function allocate(int $capacity) - { - } + public function allocate(int $capacity) {} /** * Determines if the set contains all values. @@ -2048,10 +1812,7 @@ public function allocate(int $capacity) * * @link https://php.net/manual/en/ds-set.contains.php */ - public function contains(...$values): bool - { - } - + public function contains(...$values): bool {} /** * Returns the current capacity. @@ -2059,17 +1820,13 @@ public function contains(...$values): bool * * @return int */ - public function capacity(): int - { - } + public function capacity(): int {} /** * Removes all values from the set. * @link https://www.php.net/manual/en/ds-set.clear.php */ - public function clear(): void - { - } + public function clear(): void {} /** * Count elements of an object @@ -2080,18 +1837,14 @@ public function clear(): void * The return value is cast to an integer. * @since 5.1 */ - public function count(): int - { - } + public function count(): int {} /** * Returns a shallow copy of the set. * @link https://www.php.net/manual/en/ds-set.copy.php * @return Set */ - public function copy(): Set - { - } + public function copy(): Set {} /** * Creates a new set using values that aren't in another set. @@ -2105,9 +1858,7 @@ public function copy(): Set * @return Set A new set containing all values that were not in the * other set. */ - public function diff(Set $set): Set - { - } + public function diff(Set $set): Set {} /** * Creates a new set using a callable to determine which values to @@ -2124,9 +1875,7 @@ public function diff(Set $set): Set * callback returned TRUE, or all values that convert to TRUE if a * callback was not provided. */ - public function filter(?callable $callback = null): Set - { - } + public function filter(?callable $callback = null): Set {} /** * Returns the first value in the set. @@ -2135,9 +1884,7 @@ public function filter(?callable $callback = null): Set * * @return mixed The first value in the set. */ - public function first() - { - } + public function first() {} /** * Returns the value at a given index. @@ -2148,9 +1895,7 @@ public function first() * * @return mixed The value at the requested index. */ - public function get(int $index) - { - } + public function get(int $index) {} /** * Creates a new set using values common to both the current instance @@ -2165,9 +1910,7 @@ public function get(int $index) * * @return Set The intersection of the current instance and another set. */ - public function intersect(Set $set): Set - { - } + public function intersect(Set $set): Set {} /** * Returns whether the set is empty. @@ -2175,9 +1918,7 @@ public function intersect(Set $set): Set * * @return bool */ - public function isEmpty(): bool - { - } + public function isEmpty(): bool {} /** * Joins all values together as a string using an optional separator @@ -2189,9 +1930,7 @@ public function isEmpty(): bool * * @return string */ - public function join(?string $glue = null): string - { - } + public function join(?string $glue = null): string {} /** * Returns the result of adding all given values to the set. @@ -2206,9 +1945,7 @@ public function join(?string $glue = null): string * effectively the same as adding the values to a copy, then returning * that copy. */ - public function merge($values): Set - { - } + public function merge($values): Set {} /** * Reduces the set to a single value using a callback function. @@ -2226,9 +1963,7 @@ public function merge($values): Set * * @return mixed The return value of the final callback. */ - public function reduce(callable $callback, $initial = null) - { - } + public function reduce(callable $callback, $initial = null) {} /** * Removes all given values from the set, ignoring any that are not in @@ -2238,18 +1973,14 @@ public function reduce(callable $callback, $initial = null) * * @param mixed ...$values The values to remove. */ - public function remove(...$values) - { - } + public function remove(...$values) {} /** * Reverses the set in-place. * * @link https://www.php.net/manual/en/ds-set.reverse.php */ - public function reverse() - { - } + public function reverse() {} /** * Returns a reversed copy of the set. @@ -2260,9 +1991,7 @@ public function reverse() * * @return Set A reversed copy of the set. */ - public function reversed(): Set - { - } + public function reversed(): Set {} /** * Returns a sub-set of a given range @@ -2281,9 +2010,7 @@ public function reversed(): Set * * @return Set A sub-set of the given range. */ - public function slice(int $index, ?int $length = null): Set - { - } + public function slice(int $index, ?int $length = null): Set {} /** * Returns the last value in the set. @@ -2294,9 +2021,7 @@ public function slice(int $index, ?int $length = null): Set * * @throws UnderflowException if empty. */ - public function last() - { - } + public function last() {} /** * Sorts the set in-place, using an optional comparator function. @@ -2315,9 +2040,7 @@ public function last() * * @link https://www.php.net/manual/en/ds-set.sort.php */ - public function sort(?callable $comparator = null) - { - } + public function sort(?callable $comparator = null) {} /** * Returns a sorted copy, using an optional comparator function. @@ -2340,9 +2063,7 @@ public function sort(?callable $comparator = null) * * @return Set Returns a sorted copy of the set. */ - public function sorted(?callable $comparator = null): Set - { - } + public function sorted(?callable $comparator = null): Set {} /** * Returns the sum of all values in the set. @@ -2355,9 +2076,7 @@ public function sorted(?callable $comparator = null): Set * @return float|int The sum of all the values in the set as either a * float or int depending on the values in the set. */ - public function sum(): float|int - { - } + public function sum(): float|int {} /** * Creates a new set that contains the values of the current instance as @@ -2372,9 +2091,7 @@ public function sum(): float|int * @return Set A new set containing all the values of the current * instance as well as another set. */ - public function union(Set $set): Set - { - } + public function union(Set $set): Set {} /** * Creates a new set using values in either the current instance or in @@ -2389,9 +2106,7 @@ public function union(Set $set): Set * @return Set A new set containing values in the current instance as * well as another set, but not in both. */ - public function xor(Set $set): Set - { - } + public function xor(Set $set): Set {} /** * Converts the set to an array. @@ -2400,9 +2115,7 @@ public function xor(Set $set): Set * @return array An array containing all the values in the same order as * the collection. */ - public function toArray(): array - { - } + public function toArray(): array {} /** * Specify data which should be serialized to JSON @@ -2411,11 +2124,7 @@ public function toArray(): array * which is a value of any type other than a resource. * @since 5.4 */ - public function jsonSerialize() - { - } - - + public function jsonSerialize() {} } /** @@ -2438,9 +2147,7 @@ class Stack implements Collection * @param array|Traversable|null $values A traversable object or an * array to use for the initial values. */ - public function __construct($values = null) - { - } + public function __construct($values = null) {} /** * Ensures that enough memory is allocated for a required capacity. This @@ -2454,9 +2161,7 @@ public function __construct($values = null) *Note: Capacity will stay the same if this value is less than or * equal to the current capacity.
*/ - public function allocate(int $capacity) - { - } + public function allocate(int $capacity) {} /** * Returns the current capacity. @@ -2465,17 +2170,13 @@ public function allocate(int $capacity) * * @return int The current capacity. */ - public function capacity(): int - { - } + public function capacity(): int {} /** * Removes all values from the stack. * @link https://www.php.net/manual/en/ds-stack.clear.php */ - public function clear(): void - { - } + public function clear(): void {} /** * Count elements of an object @@ -2486,27 +2187,21 @@ public function clear(): void * The return value is cast to an integer. * @since 5.1 */ - public function count(): int - { - } + public function count(): int {} /** * Returns a shallow copy of the collection. * @link https://www.php.net/manual/en/ds-stack.copy.php * @return Stack */ - public function copy(): Stack - { - } + public function copy(): Stack {} /** * Returns whether the collection is empty. * @link https://www.php.net/manual/en/ds-stack.isempty.php * @return bool */ - public function isEmpty(): bool - { - } + public function isEmpty(): bool {} /** * Converts the collection to an array. @@ -2515,9 +2210,7 @@ public function isEmpty(): bool * @return array An array containing all the values in the same order as * the collection. */ - public function toArray(): array - { - } + public function toArray(): array {} /** * Specify data which should be serialized to JSON @@ -2526,9 +2219,7 @@ public function toArray(): array * which is a value of any type other than a resource. * @since 5.4 */ - public function jsonSerialize() - { - } + public function jsonSerialize() {} /** * Returns the value at the top of the stack, but does not remove it. @@ -2539,9 +2230,7 @@ public function jsonSerialize() * * @throws UnderflowException */ - public function peek() - { - } + public function peek() {} /** * Removes and returns the value at the top of the stack. @@ -2552,9 +2241,7 @@ public function peek() * * @throws UnderflowException */ - public function pop() - { - } + public function pop() {} /** * Pushes values onto the stack. @@ -2563,9 +2250,7 @@ public function pop() * * @param array $values The values to push onto the stack. */ - public function push(...$values) - { - } + public function push(...$values) {} } /** @@ -2588,9 +2273,7 @@ class Queue implements Collection * @param array|Traversable|null $values A traversable object or an * array to use for the initial values. */ - public function __construct($values = null) - { - } + public function __construct($values = null) {} /** * Ensures that enough memory is allocated for a required capacity. This @@ -2604,9 +2287,7 @@ public function __construct($values = null) *Note: Capacity will stay the same if this value is less than or * equal to the current capacity.
*/ - public function allocate(int $capacity) - { - } + public function allocate(int $capacity) {} /** * Returns the current capacity. @@ -2615,17 +2296,13 @@ public function allocate(int $capacity) * * @return int The current capacity. */ - public function capacity(): int - { - } + public function capacity(): int {} /** * Removes all values from the queue. * @link https://www.php.net/manual/en/ds-queue.clear.php */ - public function clear(): void - { - } + public function clear(): void {} /** * Count elements of an object @@ -2636,27 +2313,21 @@ public function clear(): void * The return value is cast to an integer. * @since 5.1 */ - public function count(): int - { - } + public function count(): int {} /** * Returns a shallow copy of the collection. * @link https://www.php.net/manual/en/ds-queue.copy.php * @return Stack */ - public function copy(): Stack - { - } + public function copy(): Stack {} /** * Returns whether the collection is empty. * @link https://www.php.net/manual/en/ds-queue.isempty.php * @return bool */ - public function isEmpty(): bool - { - } + public function isEmpty(): bool {} /** * Converts the collection to an array. @@ -2665,9 +2336,7 @@ public function isEmpty(): bool * @return array An array containing all the values in the same order as * the collection. */ - public function toArray(): array - { - } + public function toArray(): array {} /** * Specify data which should be serialized to JSON @@ -2676,9 +2345,7 @@ public function toArray(): array * which is a value of any type other than a resource. * @since 5.4 */ - public function jsonSerialize() - { - } + public function jsonSerialize() {} /** * Returns the value at the top of the queue, but does not remove it. @@ -2689,9 +2356,7 @@ public function jsonSerialize() * * @throws UnderflowException */ - public function peek() - { - } + public function peek() {} /** * Removes and returns the value at the top of the queue. @@ -2702,9 +2367,7 @@ public function peek() * * @throws UnderflowException */ - public function pop() - { - } + public function pop() {} /** * Pushes values onto the queue. @@ -2713,9 +2376,7 @@ public function pop() * * @param array $values The values to push onto the queue. */ - public function push(...$values) - { - } + public function push(...$values) {} } /** @@ -2731,7 +2392,7 @@ public function push(...$values) */ class PriorityQueue implements Collection { - const MIN_CAPACITY = 8; + public const MIN_CAPACITY = 8; /** * Count elements of an object @@ -2742,35 +2403,27 @@ class PriorityQueue implements Collection * The return value is cast to an integer. * @since 5.1 */ - public function count(): int - { - } + public function count(): int {} /** * Removes all values from the collection. * @link https://www.php.net/manual/en/ds-collection.clear.php */ - public function clear(): void - { - } + public function clear(): void {} /** * Returns a shallow copy of the collection. * @link https://www.php.net/manual/en/ds-collection.copy.php * @return Collection */ - public function copy() - { - } + public function copy() {} /** * Returns whether the collection is empty. * @link https://www.php.net/manual/en/ds-collection.isempty.php * @return bool */ - public function isEmpty(): bool - { - } + public function isEmpty(): bool {} /** * Pushes a value with a given priority into the queue. @@ -2778,9 +2431,7 @@ public function isEmpty(): bool * @param mixed $value * @param int $priority */ - public function push($value, int $priority) - { - } + public function push($value, int $priority) {} /** * Converts the collection to an array. @@ -2789,9 +2440,7 @@ public function push($value, int $priority) * @return array An array containing all the values in the same order as * the collection. */ - public function toArray(): array - { - } + public function toArray(): array {} /** * Specify data which should be serialized to JSON @@ -2800,10 +2449,5 @@ public function toArray(): array * which is a value of any type other than a resource. * @since 5.4 */ - public function jsonSerialize() - { - } - - + public function jsonSerialize() {} } -} diff --git a/enchant/enchant.php b/enchant/enchant.php index 516d5ed89..e181b4aaa 100644 --- a/enchant/enchant.php +++ b/enchant/enchant.php @@ -9,7 +9,7 @@ * @link https://php.net/manual/en/function.enchant-broker-init.php * @return resource|false|EnchantBroker a broker resource on success or FALSE. */ -function enchant_broker_init () {} +function enchant_broker_init() {} /** * Free the broker resource and its dictionaries @@ -21,7 +21,7 @@ function enchant_broker_init () {} * @since 5.3 */ #[Deprecated(reason: "Unset the object instead", since: '8.0')] -function enchant_broker_free ($broker) {} +function enchant_broker_free($broker) {} /** * (PHP 5 >= 5.3.0, PECL enchant >= 0.1.0 )- * One or disjunction of more Fileinfo - * constants. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function set_flags ($flags) {} - - /** - * (PHP >= 5.3.0, PECL fileinfo >= 0.1.0)- * Name of a file to be checked. - *
- * @param int $flags [optional]- * One or disjunction of more Fileinfo - * constants. - *
- * @param resource $context [optional]- * For a description of contexts, refer to . - *
- * @return string a textual description of the contents of the - * filename argument, or FALSE if an error occurred. - */ - #[Pure] - public function file ($filename = null, $flags = FILEINFO_NONE, $context = null) {} - - /** - * (PHP 5 >= 5.3.0, PECL fileinfo >= 0.1.0)- * Content of a file to be checked. - *
- * @param int $flags [optional]- * One or disjunction of more Fileinfo - * constants. - *
- * @param resource $context [optional] - * @return string a textual description of the string - * argument, or FALSE if an error occurred. - */ - #[Pure] - public function buffer ($string = null, $flags = FILEINFO_NONE, $context = null) {} - +class finfo +{ + /** + * @param int $flags [optional] + * @param string $magic_database [optional] + */ + public function __construct($flags, $magic_database) {} + + /** + * (PHP >= 5.3.0, PECL fileinfo >= 0.1.0)+ * One or disjunction of more Fileinfo + * constants. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function set_flags($flags) {} + + /** + * (PHP >= 5.3.0, PECL fileinfo >= 0.1.0)+ * Name of a file to be checked. + *
+ * @param int $flags [optional]+ * One or disjunction of more Fileinfo + * constants. + *
+ * @param resource $context [optional]+ * For a description of contexts, refer to . + *
+ * @return string a textual description of the contents of the + * filename argument, or FALSE if an error occurred. + */ + #[Pure] + public function file($filename = null, $flags = FILEINFO_NONE, $context = null) {} + + /** + * (PHP 5 >= 5.3.0, PECL fileinfo >= 0.1.0)+ * Content of a file to be checked. + *
+ * @param int $flags [optional]+ * One or disjunction of more Fileinfo + * constants. + *
+ * @param resource $context [optional] + * @return string a textual description of the string + * argument, or FALSE if an error occurred. + */ + #[Pure] + public function buffer($string = null, $flags = FILEINFO_NONE, $context = null) {} } /** @@ -82,8 +81,7 @@ public function buffer ($string = null, $flags = FILEINFO_NONE, $context = null) * * @return resource|false a magic database resource on success or FALSE on failure. */ -function finfo_open (int $flags, ?string $magic_database = null) -{} +function finfo_open(int $flags, ?string $magic_database = null) {} /** * (PHP >= 5.3.0, PECL fileinfo >= 0.1.0)The position in the remote file to start uploading to.
* @return bool TRUE on success or FALSE on failure. */ -function ftp_put ($ftp, string $remote_filename, string $local_filename, #[EV([FTP_ASCII, FTP_BINARY])] int $mode = FTP_BINARY, int $offset = 0): bool -{} +function ftp_put($ftp, string $remote_filename, string $local_filename, #[EV([FTP_ASCII, FTP_BINARY])] int $mode = FTP_BINARY, int $offset = 0): bool {} /** * Uploads from an open file to the FTP server @@ -374,8 +353,7 @@ function ftp_put ($ftp, string $remote_filename, string $local_filename, #[EV([F * @param int $offset [optional]The position in the remote file to start uploading to.
* @return bool TRUE on success or FALSE on failure. */ -function ftp_fput ($ftp, string $remote_filename, $stream, #[EV([FTP_ASCII, FTP_BINARY])] int $mode = FTP_BINARY, int $offset = 0): bool -{} +function ftp_fput($ftp, string $remote_filename, $stream, #[EV([FTP_ASCII, FTP_BINARY])] int $mode = FTP_BINARY, int $offset = 0): bool {} /** * Returns the size of the given file @@ -388,8 +366,7 @@ function ftp_fput ($ftp, string $remote_filename, $stream, #[EV([FTP_ASCII, FTP_ * * @return int the file size on success, or -1 on error. */ -function ftp_size ($ftp, string $filename): int -{} +function ftp_size($ftp, string $filename): int {} /** * Returns the last modified time of the given file @@ -403,8 +380,7 @@ function ftp_size ($ftp, string $filename): int * @return int the last modified time as a Unix timestamp on success, or -1 on * error. */ -function ftp_mdtm ($ftp, string $filename): int -{} +function ftp_mdtm($ftp, string $filename): int {} /** * Renames a file or a directory on the FTP server @@ -420,8 +396,7 @@ function ftp_mdtm ($ftp, string $filename): int * * @return bool TRUE on success or FALSE on failure. */ -function ftp_rename ($ftp, string $from, string $to): bool -{} +function ftp_rename($ftp, string $from, string $to): bool {} /** * Deletes a file on the FTP server @@ -434,8 +409,7 @@ function ftp_rename ($ftp, string $from, string $to): bool * * @return bool TRUE on success or FALSE on failure. */ -function ftp_delete ($ftp, string $filename): bool -{} +function ftp_delete($ftp, string $filename): bool {} /** * Sends a SITE command to the server @@ -449,8 +423,7 @@ function ftp_delete ($ftp, string $filename): bool * * @return bool TRUE on success or FALSE on failure. */ -function ftp_site ($ftp, string $command): bool -{} +function ftp_site($ftp, string $command): bool {} /** * Closes an FTP connection @@ -460,8 +433,7 @@ function ftp_site ($ftp, string $command): bool * * @return bool TRUE on success or FALSE on failure. */ -function ftp_close ($ftp): bool -{} +function ftp_close($ftp): bool {} /** * Set miscellaneous runtime FTP options @@ -501,8 +473,7 @@ function ftp_close ($ftp): bool * supported or the passed value doesn't match the * expected value for the given option. */ -function ftp_set_option ($ftp, #[EV(flags: [FTP_TIMEOUT_SEC, FTP_AUTOSEEK, FTP_USEPASVADDRESS])] int $option, $value): bool -{} +function ftp_set_option($ftp, #[EV(flags: [FTP_TIMEOUT_SEC, FTP_AUTOSEEK, FTP_USEPASVADDRESS])] int $option, $value): bool {} /** * Retrieves various runtime behaviours of the current FTP stream @@ -532,8 +503,7 @@ function ftp_set_option ($ftp, #[EV(flags: [FTP_TIMEOUT_SEC, FTP_AUTOSEEK, FTP_U * option is not supported. In the latter case, a * warning message is also thrown. */ -function ftp_get_option ($ftp, #[EV(flags: [FTP_TIMEOUT_SEC, FTP_AUTOSEEK])] int $option): int|bool -{} +function ftp_get_option($ftp, #[EV(flags: [FTP_TIMEOUT_SEC, FTP_AUTOSEEK])] int $option): int|bool {} /** * Retrieves a file from the FTP server and writes it to an open file (non-blocking) @@ -555,8 +525,7 @@ function ftp_get_option ($ftp, #[EV(flags: [FTP_TIMEOUT_SEC, FTP_AUTOSEEK])] int * @return int FTP_FAILED or FTP_FINISHED * or FTP_MOREDATA. */ -#[EV([FTP_FAILED, FTP_FINISHED, FTP_MOREDATA])] function ftp_nb_fget ($ftp, $stream, string $remote_filename, #[EV([FTP_ASCII, FTP_BINARY])] int $mode = FTP_BINARY, int $offset = 0): int -{} +#[EV([FTP_FAILED, FTP_FINISHED, FTP_MOREDATA])] function ftp_nb_fget($ftp, $stream, string $remote_filename, #[EV([FTP_ASCII, FTP_BINARY])] int $mode = FTP_BINARY, int $offset = 0): int {} /** * Retrieves a file from the FTP server and writes it to a local file (non-blocking) @@ -578,8 +547,7 @@ function ftp_get_option ($ftp, #[EV(flags: [FTP_TIMEOUT_SEC, FTP_AUTOSEEK])] int * @return int FTP_FAILED or FTP_FINISHED * or FTP_MOREDATA. */ -#[EV([FTP_FAILED, FTP_FINISHED, FTP_MOREDATA])] function ftp_nb_get ($ftp, string $local_filename, string $remote_filename, int $mode = FTP_BINARY, int $offset = 0): int -{} +#[EV([FTP_FAILED, FTP_FINISHED, FTP_MOREDATA])] function ftp_nb_get($ftp, string $local_filename, string $remote_filename, int $mode = FTP_BINARY, int $offset = 0): int {} /** * Continues retrieving/sending a file (non-blocking) @@ -590,8 +558,7 @@ function ftp_get_option ($ftp, #[EV(flags: [FTP_TIMEOUT_SEC, FTP_AUTOSEEK])] int * @return int FTP_FAILED or FTP_FINISHED * or FTP_MOREDATA. */ -#[EV([FTP_FAILED, FTP_FINISHED, FTP_MOREDATA])] function ftp_nb_continue ($ftp): int -{} +#[EV([FTP_FAILED, FTP_FINISHED, FTP_MOREDATA])] function ftp_nb_continue($ftp): int {} /** * Stores a file on the FTP server (non-blocking) @@ -613,8 +580,7 @@ function ftp_get_option ($ftp, #[EV(flags: [FTP_TIMEOUT_SEC, FTP_AUTOSEEK])] int * @return int|false FTP_FAILED or FTP_FINISHED * or FTP_MOREDATA. */ -#[EV([FTP_FAILED, FTP_FINISHED, FTP_MOREDATA])] function ftp_nb_put ($ftp, string $remote_filename, string $local_filename, #[EV([FTP_ASCII, FTP_BINARY])] int $mode = FTP_BINARY, int $offset = 0): int|false -{} +#[EV([FTP_FAILED, FTP_FINISHED, FTP_MOREDATA])] function ftp_nb_put($ftp, string $remote_filename, string $local_filename, #[EV([FTP_ASCII, FTP_BINARY])] int $mode = FTP_BINARY, int $offset = 0): int|false {} /** * Stores a file from an open file to the FTP server (non-blocking) @@ -636,8 +602,7 @@ function ftp_get_option ($ftp, #[EV(flags: [FTP_TIMEOUT_SEC, FTP_AUTOSEEK])] int * @return int FTP_FAILED or FTP_FINISHED * or FTP_MOREDATA. */ -#[EV([FTP_FAILED, FTP_FINISHED, FTP_MOREDATA])] function ftp_nb_fput ($ftp, string $remote_filename, $stream, #[EV([FTP_ASCII, FTP_BINARY])] int $mode = FTP_BINARY, int $offset = 0): int -{} +#[EV([FTP_FAILED, FTP_FINISHED, FTP_MOREDATA])] function ftp_nb_fput($ftp, string $remote_filename, $stream, #[EV([FTP_ASCII, FTP_BINARY])] int $mode = FTP_BINARY, int $offset = 0): int {} /** * Alias of ftp_close @@ -645,33 +610,31 @@ function ftp_get_option ($ftp, #[EV(flags: [FTP_TIMEOUT_SEC, FTP_AUTOSEEK])] int * @param resource $ftp * @return bool TRUE on success or FALSE on failure. */ -function ftp_quit ($ftp): bool -{} - +function ftp_quit($ftp): bool {} /** * * @link https://php.net/manual/en/ftp.constants.php */ -define ('FTP_ASCII', 1); +define('FTP_ASCII', 1); /** * * @link https://php.net/manual/en/ftp.constants.php */ -define ('FTP_TEXT', 1); +define('FTP_TEXT', 1); /** * * @link https://php.net/manual/en/ftp.constants.php */ -define ('FTP_BINARY', 2); +define('FTP_BINARY', 2); /** * * @link https://php.net/manual/en/ftp.constants.php */ -define ('FTP_IMAGE', 2); +define('FTP_IMAGE', 2); /** *@@ -680,7 +643,7 @@ function ftp_quit ($ftp): bool *
* @link https://php.net/manual/en/ftp.constants.php */ -define ('FTP_AUTORESUME', -1); +define('FTP_AUTORESUME', -1); /** *@@ -688,7 +651,7 @@ function ftp_quit ($ftp): bool *
* @link https://php.net/manual/en/ftp.constants.php */ -define ('FTP_TIMEOUT_SEC', 0); +define('FTP_TIMEOUT_SEC', 0); /** *@@ -696,8 +659,7 @@ function ftp_quit ($ftp): bool *
* @link https://php.net/manual/en/ftp.constants.php */ -define ('FTP_AUTOSEEK', 1); - +define('FTP_AUTOSEEK', 1); define('FTP_USEPASVADDRESS', 2); @@ -707,7 +669,7 @@ function ftp_quit ($ftp): bool * * @link https://php.net/manual/en/ftp.constants.php */ -define ('FTP_FAILED', 0); +define('FTP_FAILED', 0); /** *@@ -715,7 +677,7 @@ function ftp_quit ($ftp): bool *
* @link https://php.net/manual/en/ftp.constants.php */ -define ('FTP_FINISHED', 1); +define('FTP_FINISHED', 1); /** *@@ -723,7 +685,6 @@ function ftp_quit ($ftp): bool *
* @link https://php.net/manual/en/ftp.constants.php */ -define ('FTP_MOREDATA', 2); +define('FTP_MOREDATA', 2); // End of ftp v. -?> diff --git a/gd/gd.php b/gd/gd.php index 61e210220..cf25f5824 100644 --- a/gd/gd.php +++ b/gd/gd.php @@ -82,7 +82,7 @@ * */ #[Pure] -function gd_info (): array {} +function gd_info(): array {} /** * Draws an arc @@ -114,7 +114,7 @@ function gd_info (): array {} * * @return bool TRUE on success or FALSE on failure. */ -function imagearc (GdImage $image, int $center_x, int $center_y, int $width, int $height, int $start_angle, int $end_angle, int $color): bool {} +function imagearc(GdImage $image, int $center_x, int $center_y, int $width, int $height, int $start_angle, int $end_angle, int $color): bool {} /** * Draw an ellipse @@ -138,7 +138,7 @@ function imagearc (GdImage $image, int $center_x, int $center_y, int $width, int * * @return bool TRUE on success or FALSE on failure. */ -function imageellipse (GdImage $image, int $center_x, int $center_y, int $width, int $height, int $color): bool {} +function imageellipse(GdImage $image, int $center_x, int $center_y, int $width, int $height, int $color): bool {} /** * Draw a character horizontally @@ -160,7 +160,7 @@ function imageellipse (GdImage $image, int $center_x, int $center_y, int $width, * * @return bool TRUE on success or FALSE on failure. */ -function imagechar (GdImage $image, int $font, int $x, int $y, string $char, int $color): bool {} +function imagechar(GdImage $image, int $font, int $x, int $y, string $char, int $color): bool {} /** * Draw a character vertically @@ -182,7 +182,7 @@ function imagechar (GdImage $image, int $font, int $x, int $y, string $char, int * * @return bool TRUE on success or FALSE on failure. */ -function imagecharup (GdImage $image, int $font, int $x, int $y, string $char, int $color): bool {} +function imagecharup(GdImage $image, int $font, int $x, int $y, string $char, int $color): bool {} /** * Get the index of the color of a pixel @@ -197,7 +197,7 @@ function imagecharup (GdImage $image, int $font, int $x, int $y, string $char, i * @return int|false the index of the color or FALSE on failure */ #[Pure] -function imagecolorat (GdImage $image, int $x, int $y): int|false {} +function imagecolorat(GdImage $image, int $x, int $y): int|false {} /** * Allocate a color for an image @@ -208,7 +208,7 @@ function imagecolorat (GdImage $image, int $x, int $y): int|false {} * @param int $blueValue of blue component.
* @return int|false A color identifier or FALSE if the allocation failed. */ -function imagecolorallocate (GdImage $image, int $red, int $green, int $blue): int|false {} +function imagecolorallocate(GdImage $image, int $red, int $green, int $blue): int|false {} /** * Copy the palette from one image to another @@ -221,7 +221,7 @@ function imagecolorallocate (GdImage $image, int $red, int $green, int $blue): i * * @return void No value is returned. */ -function imagepalettecopy (GdImage $dst, GdImage $src): void {} +function imagepalettecopy(GdImage $dst, GdImage $src): void {} /** * Create a new image from the image stream in the string @@ -234,7 +234,7 @@ function imagepalettecopy (GdImage $dst, GdImage $src): void {} * or the image is corrupt and cannot be loaded. */ #[Pure] -function imagecreatefromstring (string $data): GdImage|false {} +function imagecreatefromstring(string $data): GdImage|false {} /** * Get the index of the closest color to the specified color @@ -247,7 +247,7 @@ function imagecreatefromstring (string $data): GdImage|false {} * the specified one or FALSE on failure */ #[Pure] -function imagecolorclosest (GdImage $image, int $red, int $green, int $blue): int|false {} +function imagecolorclosest(GdImage $image, int $red, int $green, int $blue): int|false {} /** * Get the index of the color which has the hue, white and blackness @@ -260,7 +260,7 @@ function imagecolorclosest (GdImage $image, int $red, int $green, int $blue): in * the hue, white and blackness nearest the given color or FALSE on failure */ #[Pure] -function imagecolorclosesthwb (GdImage $image, int $red, int $green, int $blue): int|false {} +function imagecolorclosesthwb(GdImage $image, int $red, int $green, int $blue): int|false {} /** * De-allocate a color for an image @@ -271,7 +271,7 @@ function imagecolorclosesthwb (GdImage $image, int $red, int $green, int $blue): * * @return bool TRUE on success or FALSE on failure. */ -function imagecolordeallocate (GdImage $image, int $color): bool {} +function imagecolordeallocate(GdImage $image, int $color): bool {} /** * Get the index of the specified color or its closest possible alternative @@ -283,7 +283,7 @@ function imagecolordeallocate (GdImage $image, int $color): bool {} * @return int|false a color index or FALSE on failure */ #[Pure] -function imagecolorresolve (GdImage $image, int $red, int $green, int $blue): int|false {} +function imagecolorresolve(GdImage $image, int $red, int $green, int $blue): int|false {} /** * Get the index of the specified color @@ -296,7 +296,7 @@ function imagecolorresolve (GdImage $image, int $red, int $green, int $blue): in * color does not exist, or FALSE on failure */ #[Pure] -function imagecolorexact (GdImage $image, int $red, int $green, int $blue): int|false {} +function imagecolorexact(GdImage $image, int $red, int $green, int $blue): int|false {} /** * Set the color for the specified palette index @@ -313,7 +313,7 @@ function imagecolorexact (GdImage $image, int $red, int $green, int $blue): int| * * @return bool|null */ -function imagecolorset (GdImage $image, int $color, int $red, int $green, int $blue, int $alpha = 0): ?bool {} +function imagecolorset(GdImage $image, int $color, int $red, int $green, int $blue, int $alpha = 0): ?bool {} /** * Define a color as transparent @@ -328,7 +328,7 @@ function imagecolorset (GdImage $image, int $color, int $red, int $green, int $b * is not specified, and the image has no transparent color, the * returned identifier will be -1. */ -function imagecolortransparent (GdImage $image, ?int $color = null): ?int {} +function imagecolortransparent(GdImage $image, ?int $color = null): ?int {} /** * Find out the number of colors in an image's palette @@ -341,7 +341,7 @@ function imagecolortransparent (GdImage $image, ?int $color = null): ?int {} * truecolor images, or FALSE on failure */ #[Pure] -function imagecolorstotal (GdImage $image): int {} +function imagecolorstotal(GdImage $image): int {} /** * Get the colors for an index @@ -354,7 +354,7 @@ function imagecolorstotal (GdImage $image): int {} * contain the appropriate values for the specified color index or FALSE on failure */ #[Pure] -function imagecolorsforindex (GdImage $image, int $color): array|false {} +function imagecolorsforindex(GdImage $image, int $color): array|false {} /** * Copy part of an image @@ -385,7 +385,7 @@ function imagecolorsforindex (GdImage $image, int $color): array|false {} * * @return bool true on success or false on failure. */ -function imagecopy (GdImage $dst_image, GdImage $src_image, int $dst_x, int $dst_y, int $src_x, int $src_y, int $src_width, int $src_height): bool {} +function imagecopy(GdImage $dst_image, GdImage $src_image, int $dst_x, int $dst_y, int $src_x, int $src_y, int $src_width, int $src_height): bool {} /** * Copy and merge part of an image @@ -423,7 +423,7 @@ function imagecopy (GdImage $dst_image, GdImage $src_image, int $dst_x, int $dst * * @return bool true on success or false on failure. */ -function imagecopymerge (GdImage $dst_image, GdImage $src_image, int $dst_x, int $dst_y, int $src_x, int $src_y, int $src_width, int $src_height, int $pct): bool {} +function imagecopymerge(GdImage $dst_image, GdImage $src_image, int $dst_x, int $dst_y, int $src_x, int $src_y, int $src_width, int $src_height, int $pct): bool {} /** * Copy and merge part of an image with gray scale @@ -461,7 +461,7 @@ function imagecopymerge (GdImage $dst_image, GdImage $src_image, int $dst_x, int * * @return bool true on success or false on failure. */ -function imagecopymergegray (GdImage $dst_image, GdImage $src_image, int $dst_x, int $dst_y, int $src_x, int $src_y, int $src_width, int $src_height, int $pct): bool {} +function imagecopymergegray(GdImage $dst_image, GdImage $src_image, int $dst_x, int $dst_y, int $src_x, int $src_y, int $src_width, int $src_height, int $pct): bool {} /** * Copy and resize part of an image @@ -494,7 +494,7 @@ function imagecopymergegray (GdImage $dst_image, GdImage $src_image, int $dst_x, * * @return bool true on success or false on failure. */ -function imagecopyresized (GdImage $dst_image, GdImage $src_image, int $dst_x, int $dst_y, int $src_x, int $src_y, int $dst_width, int $dst_height, int $src_width, int $src_height): bool {} +function imagecopyresized(GdImage $dst_image, GdImage $src_image, int $dst_x, int $dst_y, int $src_x, int $src_y, int $dst_width, int $dst_height, int $src_width, int $src_height): bool {} /** * Create a new palette based image @@ -508,7 +508,7 @@ function imagecopyresized (GdImage $dst_image, GdImage $src_image, int $dst_x, i * @return resource|GdImage|false an image resource identifier on success, false on errors. */ #[Pure] -function imagecreate (int $width, int $height): GdImage|false {} +function imagecreate(int $width, int $height): GdImage|false {} /** * Create a new true color image @@ -522,7 +522,7 @@ function imagecreate (int $width, int $height): GdImage|false {} * @return resource|GdImage|false an image resource identifier on success, false on errors. */ #[Pure] -function imagecreatetruecolor (int $width, int $height): GdImage|false {} +function imagecreatetruecolor(int $width, int $height): GdImage|false {} /** * Finds whether an image is a truecolor image @@ -532,7 +532,7 @@ function imagecreatetruecolor (int $width, int $height): GdImage|false {} * otherwise. */ #[Pure] -function imageistruecolor (GdImage $image): bool {} +function imageistruecolor(GdImage $image): bool {} /** * Convert a true color image to a palette image @@ -548,7 +548,7 @@ function imageistruecolor (GdImage $image): bool {} * * @return bool true on success or false on failure. */ -function imagetruecolortopalette (GdImage $image, bool $dither, int $num_colors): bool {} +function imagetruecolortopalette(GdImage $image, bool $dither, int $num_colors): bool {} /** * Set the thickness for line drawing @@ -559,7 +559,7 @@ function imagetruecolortopalette (GdImage $image, bool $dither, int $num_colors) * * @return bool true on success or false on failure. */ -function imagesetthickness (GdImage $image, int $thickness): bool {} +function imagesetthickness(GdImage $image, int $thickness): bool {} /** * Draw a partial arc and fill it @@ -594,7 +594,7 @@ function imagesetthickness (GdImage $image, int $thickness): bool {} * IMG_ARC_PIE * @return bool true on success or false on failure. */ -function imagefilledarc (GdImage $image, int $center_x, int $center_y, int $width, int $height, int $start_angle, int $end_angle, int $color, int $style): bool {} +function imagefilledarc(GdImage $image, int $center_x, int $center_y, int $width, int $height, int $start_angle, int $end_angle, int $color, int $style): bool {} /** * Draw a filled ellipse @@ -618,7 +618,7 @@ function imagefilledarc (GdImage $image, int $center_x, int $center_y, int $widt * * @return bool true on success or false on failure. */ -function imagefilledellipse (GdImage $image, int $center_x, int $center_y, int $width, int $height, int $color): bool {} +function imagefilledellipse(GdImage $image, int $center_x, int $center_y, int $width, int $height, int $color): bool {} /** * Set the blending mode for an image @@ -630,7 +630,7 @@ function imagefilledellipse (GdImage $image, int $center_x, int $center_y, int $ * * @return bool true on success or false on failure. */ -function imagealphablending (GdImage $image, bool $enable): bool {} +function imagealphablending(GdImage $image, bool $enable): bool {} /** * Set the flag to save full alpha channel information (as opposed to single-color transparency) when saving PNG images @@ -641,7 +641,7 @@ function imagealphablending (GdImage $image, bool $enable): bool {} * * @return bool true on success or false on failure. */ -function imagesavealpha (GdImage $image, bool $enable): bool {} +function imagesavealpha(GdImage $image, bool $enable): bool {} /** * Allocate a color for an image @@ -663,7 +663,7 @@ function imagesavealpha (GdImage $image, bool $enable): bool {} * * @return int|false A color identifier or false if the allocation failed. */ -function imagecolorallocatealpha (GdImage $image, int $red, int $green, int $blue, int $alpha): int|false {} +function imagecolorallocatealpha(GdImage $image, int $red, int $green, int $blue, int $alpha): int|false {} /** * Get the index of the specified color + alpha or its closest possible alternative @@ -686,7 +686,7 @@ function imagecolorallocatealpha (GdImage $image, int $red, int $green, int $blu * @return int|false a color index or FALSE on failure */ #[Pure] -function imagecolorresolvealpha (GdImage $image, int $red, int $green, int $blue, int $alpha): int|false {} +function imagecolorresolvealpha(GdImage $image, int $red, int $green, int $blue, int $alpha): int|false {} /** * Get the index of the closest color to the specified color + alpha @@ -710,7 +710,7 @@ function imagecolorresolvealpha (GdImage $image, int $red, int $green, int $blue * FALSE on failure */ #[Pure] -function imagecolorclosestalpha (GdImage $image, int $red, int $green, int $blue, int $alpha): int|false {} +function imagecolorclosestalpha(GdImage $image, int $red, int $green, int $blue, int $alpha): int|false {} /** * Get the index of the specified color + alpha @@ -735,7 +735,7 @@ function imagecolorclosestalpha (GdImage $image, int $red, int $green, int $blue * on failure */ #[Pure] -function imagecolorexactalpha (GdImage $image, int $red, int $green, int $blue, int $alpha): int|false {} +function imagecolorexactalpha(GdImage $image, int $red, int $green, int $blue, int $alpha): int|false {} /** * Copy and resize part of an image with resampling @@ -768,7 +768,7 @@ function imagecolorexactalpha (GdImage $image, int $red, int $green, int $blue, * * @return bool true on success or false on failure. */ -function imagecopyresampled (GdImage $dst_image, GdImage $src_image, int $dst_x, int $dst_y, int $src_x, int $src_y, int $dst_width, int $dst_height, int $src_width, int $src_height): bool {} +function imagecopyresampled(GdImage $dst_image, GdImage $src_image, int $dst_x, int $dst_y, int $src_x, int $src_y, int $dst_width, int $dst_height, int $src_width, int $src_height): bool {} /** * Rotate an image with a given angle @@ -785,7 +785,7 @@ function imagecopyresampled (GdImage $dst_image, GdImage $src_image, int $dst_x, * * @return resource|GdImage|false the rotated image or FALSE on failure */ -function imagerotate (GdImage $image, float $angle, int $background_color, bool $ignore_transparent = false): GdImage|false {} +function imagerotate(GdImage $image, float $angle, int $background_color, bool $ignore_transparent = false): GdImage|false {} /** * Should antialias functions be used or not.
@@ -2967,7 +2965,7 @@ function imagepalettetotruecolor (GdImage $image): bool {}
* @since 5.5
* Scale an image using the given new width and height
*/
-function imagescale (GdImage $image, int $width, int $height = -1, int $mode = IMG_BILINEAR_FIXED): GdImage|false {}
+function imagescale(GdImage $image, int $width, int $height = -1, int $mode = IMG_BILINEAR_FIXED): GdImage|false {}
/**
* Set the interpolation method
@@ -3046,15 +3044,16 @@ function imagescale (GdImage $image, int $width, int $height = -1, int $mode = I
* @return bool Returns TRUE on success or FALSE on failure.
* @since 5.5
*/
-function imagesetinterpolation (GdImage $image, int $method = IMG_BILINEAR_FIXED): bool {}
+function imagesetinterpolation(GdImage $image, int $method = IMG_BILINEAR_FIXED): bool {}
/**
* @since 8.0
*/
-final class GdImage{
+final class GdImage
+{
/**
* You cannot initialize a GdImage object except through helper functions.
*/
- private function __construct(){}
- private function __clone(){}
+ private function __construct() {}
+ private function __clone() {}
}
diff --git a/gearman/gearman.php b/gearman/gearman.php
index 8ec8fa621..b4b860059 100644
--- a/gearman/gearman.php
+++ b/gearman/gearman.php
@@ -804,13 +804,8 @@
*/
define('GEARMAN_WORKER_STATE_PRE_SLEEP', 5);
-
-/**
- */
function gearman_version() {}
-/**
- */
function gearman_bugreport() {}
/**
@@ -1170,8 +1165,6 @@ function gearman_task_recv_data($task_object, $data_len) {}
*/
function gearman_worker_return_code($worker_object) {}
-/**
- */
function gearman_worker_create() {}
/**
@@ -1351,13 +1344,11 @@ function gearman_job_workload($job_object) {}
*/
function gearman_job_workload_size($job_object) {}
-
-
/**
* Class: GearmanClient
- *
*/
-class GearmanClient {
+class GearmanClient
+{
/**
* Creates a GearmanClient instance representing a client that connects to the job
* server and submits tasks to complete.
@@ -1390,8 +1381,6 @@ public function error() {}
*/
public function getErrno() {}
- /**
- */
public function options() {}
/**
@@ -1479,8 +1468,6 @@ public function addServer($host = '127.0.0.1', $port = 4730) {}
*/
public function addServers($servers = '127.0.0.1:4730') {}
- /**
- */
public function wait() {}
/**
@@ -1809,12 +1796,11 @@ public function runTasks() {}
public function ping($workload) {}
}
-
/**
* Class: GearmanTask
- *
*/
-class GearmanTask {
+class GearmanTask
+{
/**
* Returns the last Gearman return code for this task.
*
@@ -1921,12 +1907,11 @@ public function dataSize() {}
public function recvData($data_len) {}
}
-
/**
* Class: GearmanWorker
- *
*/
-class GearmanWorker {
+class GearmanWorker
+{
/**
* Creates a GearmanWorker instance representing a worker that connects to the job
* server and accepts tasks to run.
@@ -2088,8 +2073,6 @@ public function unregister($function_name) {}
*/
public function unregisterAll() {}
- /**
- */
public function grabJob() {}
/**
@@ -2118,15 +2101,13 @@ public function addFunction($function_name, $function, $context = null, $timeout
* @return bool
*/
public function work() {}
-
}
-
/**
* Class: GearmanJob
- *
*/
-class GearmanJob {
+class GearmanJob
+{
/**
* Returns the last return code issued by the job server.
*
@@ -2247,12 +2228,7 @@ public function workload() {}
public function workloadSize() {}
}
-
/**
* Class: GearmanException
*/
-class GearmanException extends Exception {
-}
-
-
-?>
+class GearmanException extends Exception {}
diff --git a/geoip/geoip.php b/geoip/geoip.php
index e608f69fa..b9a851365 100644
--- a/geoip/geoip.php
+++ b/geoip/geoip.php
@@ -15,7 +15,7 @@
* @return string|null the corresponding database version, or NULL on error.
*/
#[Pure]
-function geoip_database_info ($database = GEOIP_COUNTRY_EDITION) {}
+function geoip_database_info($database = GEOIP_COUNTRY_EDITION) {}
/**
* (PECL geoip >= 0.2.0)
@@ -28,7 +28,7 @@ function geoip_database_info ($database = GEOIP_COUNTRY_EDITION) {}
* if the address cannot be found in the database.
*/
#[Pure]
-function geoip_country_code_by_name ($hostname) {}
+function geoip_country_code_by_name($hostname) {}
/**
* (PECL geoip >= 0.2.0)
@@ -41,7 +41,7 @@ function geoip_country_code_by_name ($hostname) {}
* if the address cannot be found in the database.
*/
#[Pure]
-function geoip_country_code3_by_name ($hostname) {}
+function geoip_country_code3_by_name($hostname) {}
/**
* (PECL geoip >= 0.2.0)
@@ -54,7 +54,7 @@ function geoip_country_code3_by_name ($hostname) {}
* be found in the database.
*/
#[Pure]
-function geoip_country_name_by_name ($hostname) {}
+function geoip_country_name_by_name($hostname) {}
/**
* (PECL geoip >= 1.0.3)
@@ -67,7 +67,7 @@ function geoip_country_name_by_name ($hostname) {}
* address cannot be found in the database.
*/
#[Pure]
-function geoip_continent_code_by_name ($hostname) {}
+function geoip_continent_code_by_name($hostname) {}
/**
* (PECL geoip >= 0.2.0)
@@ -80,7 +80,7 @@ function geoip_continent_code_by_name ($hostname) {}
* cannot be found in the database.
*/
#[Pure]
-function geoip_org_by_name ($hostname) {}
+function geoip_org_by_name($hostname) {}
/**
* (PECL geoip >= 0.2.0)
@@ -93,7 +93,7 @@ function geoip_org_by_name ($hostname) {}
* cannot be found in the database.
*/
#[Pure]
-function geoip_record_by_name ($hostname) {}
+function geoip_record_by_name($hostname) {}
/**
* (PECL geoip >= 0.2.0)
@@ -105,7 +105,7 @@ function geoip_record_by_name ($hostname) {}
* @return int the connection type.
*/
#[Pure]
-function geoip_id_by_name ($hostname) {}
+function geoip_id_by_name($hostname) {}
/**
* (PECL geoip >= 0.2.0)
@@ -118,7 +118,7 @@ function geoip_id_by_name ($hostname) {}
* cannot be found in the database.
*/
#[Pure]
-function geoip_region_by_name ($hostname) {}
+function geoip_region_by_name($hostname) {}
/**
* (PECL geoip >= 1.0.2)
@@ -131,7 +131,7 @@ function geoip_region_by_name ($hostname) {}
* cannot be found in the database.
*/
#[Pure]
-function geoip_isp_by_name ($hostname) {}
+function geoip_isp_by_name($hostname) {}
/**
* (PECL geoip >= 1.0.1)
@@ -145,7 +145,7 @@ function geoip_isp_by_name ($hostname) {}
* @return bool|null TRUE is database exists, FALSE if not found, or NULL on error.
*/
#[Pure]
-function geoip_db_avail ($database) {}
+function geoip_db_avail($database) {}
/**
* (PECL geoip >= 1.0.1)
@@ -154,7 +154,7 @@ function geoip_db_avail ($database) {}
* @return array the associative array.
*/
#[Pure]
-function geoip_db_get_all_info () {}
+function geoip_db_get_all_info() {}
/**
* (PECL geoip >= 1.0.1)
@@ -168,7 +168,7 @@ function geoip_db_get_all_info () {}
* @return string|null the filename of the corresponding database, or NULL on error.
*/
#[Pure]
-function geoip_db_filename ($database) {}
+function geoip_db_filename($database) {}
/**
* (PECL geoip >= 1.0.4)
@@ -186,7 +186,7 @@ function geoip_db_filename ($database) {}
* combo cannot be found.
*/
#[Pure]
-function geoip_region_name_by_code ($country_code, $region_code) {}
+function geoip_region_name_by_code($country_code, $region_code) {}
/**
* (PECL geoip >= 1.0.4)
@@ -204,23 +204,23 @@ function geoip_region_name_by_code ($country_code, $region_code) {}
* combo cannot be found.
*/
#[Pure]
-function geoip_time_zone_by_country_and_region ($country_code, $region_code = null) {}
+function geoip_time_zone_by_country_and_region($country_code, $region_code = null) {}
-define ('GEOIP_COUNTRY_EDITION', 1);
-define ('GEOIP_REGION_EDITION_REV0', 7);
-define ('GEOIP_CITY_EDITION_REV0', 6);
-define ('GEOIP_ORG_EDITION', 5);
-define ('GEOIP_ISP_EDITION', 4);
-define ('GEOIP_CITY_EDITION_REV1', 2);
-define ('GEOIP_REGION_EDITION_REV1', 3);
-define ('GEOIP_PROXY_EDITION', 8);
-define ('GEOIP_ASNUM_EDITION', 9);
-define ('GEOIP_NETSPEED_EDITION', 10);
-define ('GEOIP_DOMAIN_EDITION', 11);
-define ('GEOIP_UNKNOWN_SPEED', 0);
-define ('GEOIP_DIALUP_SPEED', 1);
-define ('GEOIP_CABLEDSL_SPEED', 2);
-define ('GEOIP_CORPORATE_SPEED', 3);
+define('GEOIP_COUNTRY_EDITION', 1);
+define('GEOIP_REGION_EDITION_REV0', 7);
+define('GEOIP_CITY_EDITION_REV0', 6);
+define('GEOIP_ORG_EDITION', 5);
+define('GEOIP_ISP_EDITION', 4);
+define('GEOIP_CITY_EDITION_REV1', 2);
+define('GEOIP_REGION_EDITION_REV1', 3);
+define('GEOIP_PROXY_EDITION', 8);
+define('GEOIP_ASNUM_EDITION', 9);
+define('GEOIP_NETSPEED_EDITION', 10);
+define('GEOIP_DOMAIN_EDITION', 11);
+define('GEOIP_UNKNOWN_SPEED', 0);
+define('GEOIP_DIALUP_SPEED', 1);
+define('GEOIP_CABLEDSL_SPEED', 2);
+define('GEOIP_CORPORATE_SPEED', 3);
/**
* (PECL geoip >= 1.1.0)
@@ -233,7 +233,7 @@ function geoip_time_zone_by_country_and_region ($country_code, $region_code = nu
* @return string|false Returns the ASN on success, or FALSE if the address cannot be found in the database.
* @since 1.1.0
*/
-function geoip_asnum_by_name ($hostname) {}
+function geoip_asnum_by_name($hostname) {}
/**
* (PECL geoip >= 1.1.0)
@@ -256,7 +256,7 @@ function geoip_asnum_by_name ($hostname) {}
* @return string|false Returns the connection speed on success, or FALSE if the address cannot be found in the database.
* @since 1.1.0
*/
-function geoip_netspeedcell_by_name ($hostname) {}
+function geoip_netspeedcell_by_name($hostname) {}
/**
* (PECL geoip >= 1.1.0)
@@ -269,6 +269,6 @@ function geoip_netspeedcell_by_name ($hostname) {}
* @return void
* @since 1.1.0
*/
-function geoip_setup_custom_directory ($path) {}
+function geoip_setup_custom_directory($path) {}
// End of geoip v.1.1.0
diff --git a/geos/geos.php b/geos/geos.php
index 657bd8f4b..8050ed89f 100644
--- a/geos/geos.php
+++ b/geos/geos.php
@@ -3,7 +3,6 @@
/**
* @see https://github.com/libgeos/php-geos/blob/master/tests/000_General.phpt
*/
-
define('GEOSBUF_CAP_ROUND', 1);
define('GEOSBUF_CAP_FLAT', 2);
@@ -101,7 +100,6 @@ function GEOSPolygonize(GEOSGeometry $geom): array {}
*/
class GEOSWKTReader
{
-
/**
* GEOSWKTReader constructor.
*/
@@ -113,7 +111,6 @@ public function __construct() {}
* @throws Exception
*/
public function read(string $wkt): GEOSGeometry {}
-
}
/**
@@ -122,7 +119,6 @@ public function read(string $wkt): GEOSGeometry {}
*/
class GEOSWKTWriter
{
-
/**
* GEOSWKTWriter constructor.
*/
@@ -160,7 +156,6 @@ public function getOutputDimension(): int {}
* @param bool $old3d
*/
public function setOld3D(bool $old3d): void {}
-
}
/**
@@ -169,7 +164,6 @@ public function setOld3D(bool $old3d): void {}
*/
class GEOSGeometry
{
-
/**
* GEOSGeometry constructor.
*/
@@ -652,7 +646,6 @@ public function voronoiDiagram(float $tolerance = 0.0, bool $onlyEdges = false,
* @throws Exception
*/
public function clipByRect(float $xmin, float $ymin, float $xmax, float $ymax): GEOSGeometry {}
-
}
/**
@@ -661,7 +654,6 @@ public function clipByRect(float $xmin, float $ymin, float $xmax, float $ymax):
*/
class GEOSWKBWriter
{
-
/**
* GEOSWKBWriter constructor.
*/
@@ -713,7 +705,6 @@ public function write(GEOSGeometry $geom): string {}
* @throws Exception
*/
public function writeHEX(GEOSGeometry $geom): string {}
-
}
/**
@@ -722,7 +713,6 @@ public function writeHEX(GEOSGeometry $geom): string {}
*/
class GEOSWKBReader
{
-
/**
* GEOSWKBReader constructor.
*/
@@ -741,5 +731,4 @@ public function read(string $wkb): GEOSGeometry {}
* @throws Exception
*/
public function readHEX(string $wkb): GEOSGeometry {}
-
}
diff --git a/gettext/gettext.php b/gettext/gettext.php
index 8dcb3236f..351766f8a 100644
--- a/gettext/gettext.php
+++ b/gettext/gettext.php
@@ -14,8 +14,7 @@
* @return string If successful, this function returns the current message
* domain, after possibly changing it.
*/
-function textdomain (?string $domain): string
-{}
+function textdomain(?string $domain): string {}
/**
* Lookup a message in the current domain
@@ -27,8 +26,7 @@ function textdomain (?string $domain): string
* translation table, or the submitted message if not found.
*/
#[Pure]
-function _ (string $message): string
-{}
+function _(string $message): string {}
/**
* Lookup a message in the current domain
@@ -40,8 +38,7 @@ function _ (string $message): string
* translation table, or the submitted message if not found.
*/
#[Pure]
-function gettext (string $message): string
-{}
+function gettext(string $message): string {}
/**
* Override the current domain
@@ -54,8 +51,7 @@ function gettext (string $message): string
*
Default value is 1. The number of bytes in each chunk of binary + * @param int $word_size
Default value is 1. The number of bytes in each chunk of binary * data. This is mainly used in conjunction with the options parameter.
- * @param integer $options Default value is GMP_MSW_FIRST | GMP_NATIVE_ENDIAN. + * @param int $options Default value is GMP_MSW_FIRST | GMP_NATIVE_ENDIAN. * @return GMP|false Returns a GMP number or FALSE on failure. * @since 5.6.1 */ #[Pure] -function gmp_import ($data, $word_size = 1, $options = GMP_MSW_FIRST | GMP_NATIVE_ENDIAN) {} +function gmp_import($data, $word_size = 1, $options = GMP_MSW_FIRST|GMP_NATIVE_ENDIAN) {} /** * Export to a binary string * @link https://php.net/manual/en/function.gmp-export.php * @param GMP $gmpnumber The GMP number being exported - * @param integer $word_sizeDefault value is 1. The number of bytes in each chunk of binary + * @param int $word_size
Default value is 1. The number of bytes in each chunk of binary * data. This is mainly used in conjunction with the options parameter.
- * @param integer $options Default value is GMP_MSW_FIRST | GMP_NATIVE_ENDIAN. + * @param int $options Default value is GMP_MSW_FIRST | GMP_NATIVE_ENDIAN. * @return string|false Returns a string or FALSE on failure. * @since 5.6.1 */ #[Pure] -function gmp_export (GMP $gmpnumber, $word_size = 1, $options = GMP_MSW_FIRST | GMP_NATIVE_ENDIAN) {} +function gmp_export(GMP $gmpnumber, $word_size = 1, $options = GMP_MSW_FIRST|GMP_NATIVE_ENDIAN) {} /** * Takes the nth root of a and returns the integer component of the result. * @link https://php.net/manual/en/function.gmp-root.php * @param GMP $aEither a GMP number resource in PHP 5.5 and earlier, a GMP object in PHP 5.6 * and later, or a numeric string provided that it is possible to convert the latter to a number.
- * @param integer $nth The positive root to take of a. + * @param int $nth The positive root to take of a. * @return GMP The integer component of the resultant root, as a GMP number. * @since 5.6 */ #[Pure] -function gmp_root (GMP $a, $nth) {} +function gmp_root(GMP $a, $nth) {} /** * Takes the nth root of a and returns the integer component and remainder of the result. * @link https://php.net/manual/en/function.gmp-rootrem.php * @param GMP $aEither a GMP number resource in PHP 5.5 and earlier, a GMP object in PHP 5.6 * and later, or a numeric string provided that it is possible to convert the latter to a number.
- * @param integer $nth The positive root to take of a. + * @param int $nth The positive root to take of a. * @return array|GMP[]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.
* @since 5.6 */ #[Pure] -function gmp_rootrem (GMP $a, $nth) {} +function gmp_rootrem(GMP $a, $nth) {} /** * Find next prime number @@ -725,7 +725,7 @@ function gmp_rootrem (GMP $a, $nth) {} * as a GMP number. */ #[Pure] -function gmp_nextprime ($a) {} +function gmp_nextprime($a) {} /** * Calculates binomial coefficient @@ -782,25 +782,25 @@ function gmp_lcm($a, $b) {} #[Pure] function gmp_perfect_power($a) {} -define ('GMP_ROUND_ZERO', 0); -define ('GMP_ROUND_PLUSINF', 1); -define ('GMP_ROUND_MINUSINF', 2); -define ('GMP_MSW_FIRST', 1); -define ('GMP_LSW_FIRST', 2); -define ('GMP_LITTLE_ENDIAN', 4); -define ('GMP_BIG_ENDIAN', 8); -define ('GMP_NATIVE_ENDIAN', 16); +define('GMP_ROUND_ZERO', 0); +define('GMP_ROUND_PLUSINF', 1); +define('GMP_ROUND_MINUSINF', 2); +define('GMP_MSW_FIRST', 1); +define('GMP_LSW_FIRST', 2); +define('GMP_LITTLE_ENDIAN', 4); +define('GMP_BIG_ENDIAN', 8); +define('GMP_NATIVE_ENDIAN', 16); /** * The GMP library version * @link https://php.net/manual/en/gmp.constants.php */ -define ('GMP_VERSION', ""); +define('GMP_VERSION', ""); -define ('GMP_MPIR_VERSION', '3.0.0'); - -class GMP implements Serializable { +define('GMP_MPIR_VERSION', '3.0.0'); +class GMP implements Serializable +{ /** * String representation of object * @link https://php.net/manual/en/serializable.serialize.php @@ -819,4 +819,3 @@ public function serialize() {} public function unserialize($serialized) {} } // End of gmp v. -?> diff --git a/gnupg/gnupg.php b/gnupg/gnupg.php index 9e013aeba..9858716ee 100644 --- a/gnupg/gnupg.php +++ b/gnupg/gnupg.php @@ -33,263 +33,220 @@ * @link https://php.net/manual/en/book.gnupg.php * Class gnupg */ - -class gnupg { - /** - * Add a key for decryption - * @link https://php.net/manual/en/function.gnupg-adddecryptkey.php - * - * @param string $fingerprint - * @param string $passphrase - * - * @return bool - */ - function adddecryptkey($fingerprint, $passphrase) - { - } - - /** - * Verifies a signed text - * @link https://php.net/manual/en/function.gnupg-verify.php - * - * * @param string $signed_text - * @param string $signature - * @param string &$plaintext - * - * @return array|false On success, this function returns information about the signature. - * On failure, this function returns false. - */ - function verify($signed_text, $signature, &$plaintext = null) - { - } - - /** - * Add a key for encryption - * @link https://php.net/manual/en/function.gnupg-addencryptkey.php - * - * @param string $fingerprint - * - * @return bool - */ - function addencryptkey($fingerprint) - { - } - - /** - * Add a key for signing - * @link https://php.net/manual/en/function.gnupg-addsignkey.php - * - * @param string $fingerprint - * @param string $passphrase - * - * @return bool - */ - function addsignkey($fingerprint, $passphrase = null) - { - } - - /** - * Removes all keys which were set for decryption before - * @link https://php.net/manual/en/function.gnupg-cleardecryptkeys.php - * - * @return bool - */ - function cleardecryptkeys() - { - } - - /** - * Removes all keys which were set for encryption before - * @link https://php.net/manual/en/function.gnupg-clearencryptkeys.php - * - * @return bool - */ - function clearencryptkeys() - { - } - - /** - * Removes all keys which were set for signing before - * @link https://php.net/manual/en/function.gnupg-clearsignkeys.php - * - * @return bool - */ - function clearsignkeys() - { - } - - /** - * Decrypts a given text - * @link https://php.net/manual/en/function.gnupg-decrypt.php - * - * @param string $text - * - * @return string|false On success, this function returns the decrypted text. - * On failure, this function returns false. - */ - function decrypt($text) - { - } - - /** - * Decrypts and verifies a given text - * @link https://php.net/manual/en/function.gnupg-decryptverify.php - * - * @param string $text - * @param string &$plaintext - * - * @return array|false On success, this function returns information about the signature and - * fills the parameter with the decrypted text. - * On failure, this function returns false. - */ - function decryptverify($text, &$plaintext) - { - } - - /** - * Encrypts a given text - * @link https://php.net/manual/en/function.gnupg-encrypt.php - * - * @param string $plaintext - * - * @return string|false On success, this function returns the encrypted text. - * On failure, this function returns false. - */ - function encrypt($plaintext) - { - } - - /** - * Encrypts and signs a given text - * @link https://php.net/manual/en/function.gnupg-encryptsign.php - * - * @param string $plaintext - * - * @return string|false On success, this function returns the encrypted and signed text. - * On failure, this function returns false. - */ - function encryptsign($plaintext) - { - } - - /** - * Exports a key - * @link https://php.net/manual/en/function.gnupg-export.php - * - * @param string $fingerprint - * - * @return string|false On success, this function returns the keydata. - * On failure, this function returns false. - */ - function export($fingerprint) - { - } - - /** - * Returns the errortext, if a function fails - * @link https://php.net/manual/en/function.gnupg-geterror.php - * - * @return string|false Returns an errortext, if an error has occurred, otherwise false. - */ - function geterror() - { - } - - /** - * Returns the currently active protocol for all operations - * @link https://php.net/manual/en/function.gnupg-getprotocol.php - * - * @return int Returns the currently active protocol, which can be one of - * or - * . - */ - function getprotocol() - { - } - - /** - * Imports a key - * @link https://php.net/manual/en/function.gnupg-import.php - * - * @param string $keydata - * - * @return array|false On success, this function returns and info-array about the importprocess. - * On failure, this function returns false. - */ - function import($keydata) - { - } - - /** - * Initialize a connection - * @link https://php.net/manual/en/function.gnupg-init.php - * - * @return resource A GnuPG ``resource`` connection used by other GnuPG functions. - */ - function init() - { - } - - /** - * Returns an array with information about all keys that matches the given pattern - * @link https://php.net/manual/en/function.gnupg-keyinfo.php - * - * @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. - */ - function keyinfo($pattern) - { - } - - /** - * Toggle armored output - * @link https://php.net/manual/en/function.gnupg-setarmor.php - * - * @param int $armor - * - * @return bool - */ - function setarmor($armor) - { - } - - /** - * Sets the mode for error_reporting - * @link https://php.net/manual/en/function.gnupg-seterrormode.php - * - * @param int $errormode - * - * @return void - */ - function seterrormode($errormode) - { - } - - /** - * Sets the mode for signing - * @link https://php.net/manual/en/function.gnupg-setsignmode.php - * - * @param int $signmode - * - * @return bool - */ - function setsignmode($signmode) - { - } - - /** - * Signs a given text - * @link https://php.net/manual/en/function.gnupg-sign.php - * - * @param string $plaintext - * - * @return string|false On success, this function returns the signed text or the signature. - * On failure, this function returns false. - */ - function sign($plaintext) - { - } - +class gnupg +{ + /** + * Add a key for decryption + * @link https://php.net/manual/en/function.gnupg-adddecryptkey.php + * + * @param string $fingerprint + * @param string $passphrase + * + * @return bool + */ + public function adddecryptkey($fingerprint, $passphrase) {} + + /** + * Verifies a signed text + * @link https://php.net/manual/en/function.gnupg-verify.php + * + * * @param string $signed_text + * @param string $signature + * @param string &$plaintext + * + * @return array|false On success, this function returns information about the signature. + * On failure, this function returns false. + */ + public function verify($signed_text, $signature, &$plaintext = null) {} + + /** + * Add a key for encryption + * @link https://php.net/manual/en/function.gnupg-addencryptkey.php + * + * @param string $fingerprint + * + * @return bool + */ + public function addencryptkey($fingerprint) {} + + /** + * Add a key for signing + * @link https://php.net/manual/en/function.gnupg-addsignkey.php + * + * @param string $fingerprint + * @param string $passphrase + * + * @return bool + */ + public function addsignkey($fingerprint, $passphrase = null) {} + + /** + * Removes all keys which were set for decryption before + * @link https://php.net/manual/en/function.gnupg-cleardecryptkeys.php + * + * @return bool + */ + public function cleardecryptkeys() {} + + /** + * Removes all keys which were set for encryption before + * @link https://php.net/manual/en/function.gnupg-clearencryptkeys.php + * + * @return bool + */ + public function clearencryptkeys() {} + + /** + * Removes all keys which were set for signing before + * @link https://php.net/manual/en/function.gnupg-clearsignkeys.php + * + * @return bool + */ + public function clearsignkeys() {} + + /** + * Decrypts a given text + * @link https://php.net/manual/en/function.gnupg-decrypt.php + * + * @param string $text + * + * @return string|false On success, this function returns the decrypted text. + * On failure, this function returns false. + */ + public function decrypt($text) {} + + /** + * Decrypts and verifies a given text + * @link https://php.net/manual/en/function.gnupg-decryptverify.php + * + * @param string $text + * @param string &$plaintext + * + * @return array|false On success, this function returns information about the signature and + * fills the parameter with the decrypted text. + * On failure, this function returns false. + */ + public function decryptverify($text, &$plaintext) {} + + /** + * Encrypts a given text + * @link https://php.net/manual/en/function.gnupg-encrypt.php + * + * @param string $plaintext + * + * @return string|false On success, this function returns the encrypted text. + * On failure, this function returns false. + */ + public function encrypt($plaintext) {} + + /** + * Encrypts and signs a given text + * @link https://php.net/manual/en/function.gnupg-encryptsign.php + * + * @param string $plaintext + * + * @return string|false On success, this function returns the encrypted and signed text. + * On failure, this function returns false. + */ + public function encryptsign($plaintext) {} + + /** + * Exports a key + * @link https://php.net/manual/en/function.gnupg-export.php + * + * @param string $fingerprint + * + * @return string|false On success, this function returns the keydata. + * On failure, this function returns false. + */ + public function export($fingerprint) {} + + /** + * Returns the errortext, if a function fails + * @link https://php.net/manual/en/function.gnupg-geterror.php + * + * @return string|false Returns an errortext, if an error has occurred, otherwise false. + */ + public function geterror() {} + + /** + * Returns the currently active protocol for all operations + * @link https://php.net/manual/en/function.gnupg-getprotocol.php + * + * @return int Returns the currently active protocol, which can be one of + * or + * . + */ + public function getprotocol() {} + + /** + * Imports a key + * @link https://php.net/manual/en/function.gnupg-import.php + * + * @param string $keydata + * + * @return array|false On success, this function returns and info-array about the importprocess. + * On failure, this function returns false. + */ + public function import($keydata) {} + + /** + * Initialize a connection + * @link https://php.net/manual/en/function.gnupg-init.php + * + * @return resource A GnuPG ``resource`` connection used by other GnuPG functions. + */ + public function init() {} + + /** + * Returns an array with information about all keys that matches the given pattern + * @link https://php.net/manual/en/function.gnupg-keyinfo.php + * + * @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. + */ + public function keyinfo($pattern) {} + + /** + * Toggle armored output + * @link https://php.net/manual/en/function.gnupg-setarmor.php + * + * @param int $armor + * + * @return bool + */ + public function setarmor($armor) {} + + /** + * Sets the mode for error_reporting + * @link https://php.net/manual/en/function.gnupg-seterrormode.php + * + * @param int $errormode + * + * @return void + */ + public function seterrormode($errormode) {} + + /** + * Sets the mode for signing + * @link https://php.net/manual/en/function.gnupg-setsignmode.php + * + * @param int $signmode + * + * @return bool + */ + public function setsignmode($signmode) {} + + /** + * Signs a given text + * @link https://php.net/manual/en/function.gnupg-sign.php + * + * @param string $plaintext + * + * @return string|false On success, this function returns the signed text or the signature. + * On failure, this function returns false. + */ + public function sign($plaintext) {} } diff --git a/grpc/grpc.php b/grpc/grpc.php index 046f6a31d..ac85cd9ed 100644 --- a/grpc/grpc.php +++ b/grpc/grpc.php @@ -9,8 +9,10 @@ * @see https://grpc.io * @see https://github.com/grpc/grpc/tree/master/src/php/ext/grpc */ + namespace Grpc -{ +; + /** * Register call error constants */ @@ -443,7 +445,7 @@ class Channel * * @throws \InvalidArgumentException */ - public function __construct($target, $args = array()) {} + public function __construct($target, $args = []) {} /** * Get the endpoint this call/stream is connected to @@ -723,4 +725,3 @@ public function subtract(Timeval $other) {} */ public static function zero() {} } -} diff --git a/hash/hash.php b/hash/hash.php index 1f16ee7b0..a2105d4f3 100644 --- a/hash/hash.php +++ b/hash/hash.php @@ -23,8 +23,7 @@ * binary representation of the message digest is returned. */ #[Pure] -function hash (string $algo, string $data, bool $binary = false): string|false -{} +function hash(string $algo, string $data, bool $binary = false): string|false {} /** * Timing attack safe string comparison @@ -35,8 +34,7 @@ function hash (string $algo, string $data, bool $binary = false): string|false * @since 5.6 */ #[Pure] -function hash_equals(string $known_string, string $user_string): bool -{} +function hash_equals(string $known_string, string $user_string): bool {} /** * (PHP 5 >= 5.1.2, PECL hash >= 1.1)- * initialization flags - *
- */ - public function __construct ($flags = null) {} - - /** - * (PECL pecl_http >= 0.21.0)- * data to deflate - *
- * @return string|false deflated data on success or false on failure. - */ - public function update ($data) {} - - /** - * (PECL pecl_http >= 0.21.0)- * more data to deflate - *
- * @return string|false some deflated data as string on success or false on failure. - */ - public function flush ($data = null) {} - - /** - * (PECL pecl_http >= 0.21.0)- * data to deflate - *
- * @return string the final part of deflated data. - */ - public function finish ($data = null) {} - - /** - * (PECL pecl_http >= 1.4.0)- * initialization flags - *
- * @param string $class_name [optional]- * name of a subclass of HttpDeflateStream - *
- * @return HttpDeflateStream - */ - public static function factory ($flags = null, $class_name = null) {} - +class HttpDeflateStream +{ + public const TYPE_GZIP = 16; + public const TYPE_ZLIB = 0; + public const TYPE_RAW = 32; + public const LEVEL_DEF = 0; + public const LEVEL_MIN = 1; + public const LEVEL_MAX = 9; + public const STRATEGY_DEF = 0; + public const STRATEGY_FILT = 256; + public const STRATEGY_HUFF = 512; + public const STRATEGY_RLE = 768; + public const STRATEGY_FIXED = 1024; + public const FLUSH_NONE = 0; + public const FLUSH_SYNC = 1048576; + public const FLUSH_FULL = 2097152; + + /** + * (PECL pecl_http >= 0.21.0)+ * initialization flags + *
+ */ + public function __construct($flags = null) {} + + /** + * (PECL pecl_http >= 0.21.0)+ * data to deflate + *
+ * @return string|false deflated data on success or false on failure. + */ + public function update($data) {} + + /** + * (PECL pecl_http >= 0.21.0)+ * more data to deflate + *
+ * @return string|false some deflated data as string on success or false on failure. + */ + public function flush($data = null) {} + + /** + * (PECL pecl_http >= 0.21.0)+ * data to deflate + *
+ * @return string the final part of deflated data. + */ + public function finish($data = null) {} + + /** + * (PECL pecl_http >= 1.4.0)+ * initialization flags + *
+ * @param string $class_name [optional]+ * name of a subclass of HttpDeflateStream + *
+ * @return HttpDeflateStream + */ + public static function factory($flags = null, $class_name = null) {} } /** * @link https://php.net/manual/en/class.httpinflatestream.php */ -class HttpInflateStream { - const FLUSH_NONE = 0; - const FLUSH_SYNC = 1048576; - const FLUSH_FULL = 2097152; - - - /** - * (PECL pecl_http >= 1.0.0)- * initialization flags - *
- */ - public function __construct ($flags = null) {} - - /** - * (PECL pecl_http >= 0.21.0)- * data to inflate - *
- * @return string|false inflated data on success or false on failure. - */ - public function update ($data) {} - - /** - * (PECL pecl_http >= 0.21.0)- * more data to inflate - *
- * @return string|false some inflated data as string on success or false on failure. - */ - public function flush ($data = null) {} - - /** - * (PECL pecl_http >= 0.21.0)- * data to inflate - *
- * @return string the final part of inflated data. - */ - public function finish ($data = null) {} - - /** - * (PECL pecl_http >= 1.4.0)- * initialization flags - *
- * @param string $class_name [optional]- * name of a subclass of HttpInflateStream - *
- * @return HttpInflateStream - */ - public static function factory ($flags = null, $class_name = null) {} - +class HttpInflateStream +{ + public const FLUSH_NONE = 0; + public const FLUSH_SYNC = 1048576; + public const FLUSH_FULL = 2097152; + + /** + * (PECL pecl_http >= 1.0.0)+ * initialization flags + *
+ */ + public function __construct($flags = null) {} + + /** + * (PECL pecl_http >= 0.21.0)+ * data to inflate + *
+ * @return string|false inflated data on success or false on failure. + */ + public function update($data) {} + + /** + * (PECL pecl_http >= 0.21.0)+ * more data to inflate + *
+ * @return string|false some inflated data as string on success or false on failure. + */ + public function flush($data = null) {} + + /** + * (PECL pecl_http >= 0.21.0)+ * data to inflate + *
+ * @return string the final part of inflated data. + */ + public function finish($data = null) {} + + /** + * (PECL pecl_http >= 1.4.0)+ * initialization flags + *
+ * @param string $class_name [optional]+ * name of a subclass of HttpInflateStream + *
+ * @return HttpInflateStream + */ + public static function factory($flags = null, $class_name = null) {} } /** * @link https://php.net/manual/en/class.httpmessage.php */ -class HttpMessage implements Countable, Serializable, Iterator { - const TYPE_NONE = 0; - const TYPE_REQUEST = 1; - const TYPE_RESPONSE = 2; - - protected $type; - protected $body; - protected $requestMethod; - protected $requestUrl; - protected $responseStatus; - protected $responseCode; - protected $httpVersion; - protected $headers; - protected $parentMessage; - - - /** - * (PECL pecl_http >= 0.10.0)- * a single or several consecutive HTTP messages - *
- */ - public function __construct ($message = null) {} - - /** - * (PECL pecl_http >= 0.10.0)+ * a single or several consecutive HTTP messages + *
+ */ + public function __construct($message = null) {} + + /** + * (PECL pecl_http >= 0.10.0)- * the new body of the message - *
- * @return void - */ - public function setBody ($body) {} - - /** - * (PECL pecl_http >= 1.1.0)- * header name - *
- * @return string|null the header value on success or NULL if the header does not exist. - */ + public function getBody() {} + + /** + * (PECL pecl_http >= 0.14.0)+ * the new body of the message + *
+ * @return void + */ + public function setBody($body) {} + + /** + * (PECL pecl_http >= 1.1.0)+ * header name + *
+ * @return string|null the header value on success or NULL if the header does not exist. + */ #[Pure] - public function getHeader ($header) {} - - /** - * (PECL pecl_http >= 0.10.0)- * associative array containing the new HTTP headers, which will replace all previous HTTP headers of the message - *
- * @return void - */ - public function setHeaders (array $header) {} - - /** - * (PECL pecl_http >= 0.10.0)- * associative array containing the additional HTTP headers to add to the messages existing headers - *
- * @param bool $append [optional]- * if true, and a header with the same name of one to add exists already, this respective - * header will be converted to an array containing both header values, otherwise - * it will be overwritten with the new header value - *
- * @return void - */ - public function addHeaders (array $headers, $append = null) {} - - /** - * (PECL pecl_http >= 0.10.0)+ * associative array containing the new HTTP headers, which will replace all previous HTTP headers of the message + *
+ * @return void + */ + public function setHeaders(array $header) {} + + /** + * (PECL pecl_http >= 0.10.0)+ * associative array containing the additional HTTP headers to add to the messages existing headers + *
+ * @param bool $append [optional]+ * if true, and a header with the same name of one to add exists already, this respective + * header will be converted to an array containing both header values, otherwise + * it will be overwritten with the new header value + *
+ * @return void + */ + public function addHeaders(array $headers, $append = null) {} + + /** + * (PECL pecl_http >= 0.10.0)- * the HttpMessage::TYPE - *
- * @return void - */ - public function setType ($type) {} + public function getType() {} + + /** + * (PECL pecl_http >= 0.10.0)+ * the HttpMessage::TYPE + *
+ * @return void + */ + public function setType($type) {} #[Pure] - public function getInfo () {} - - /** - * @param $http_info - */ - public function setInfo ($http_info) {} - - /** - * (PECL pecl_http >= 0.10.0)- * HTTP response code - *
- * @return bool TRUE on success, or FALSE if the message is not of type - * HttpMessage::TYPE_RESPONSE or the response code is out of range (100-510). - */ - public function setResponseCode ($code) {} - - /** - * (PECL pecl_http >= 0.23.0)+ * HTTP response code + *
+ * @return bool TRUE on success, or FALSE if the message is not of type + * HttpMessage::TYPE_RESPONSE or the response code is out of range (100-510). + */ + public function setResponseCode($code) {} + + /** + * (PECL pecl_http >= 0.23.0)- * the response status text - *
- * @return bool TRUE on success or FALSE if the message is not of type - * HttpMessage::TYPE_RESPONSE. - */ - public function setResponseStatus ($status) {} - - /** - * (PECL pecl_http >= 0.10.0)+ * the response status text + *
+ * @return bool TRUE on success or FALSE if the message is not of type + * HttpMessage::TYPE_RESPONSE. + */ + public function setResponseStatus($status) {} + + /** + * (PECL pecl_http >= 0.10.0)- * the request method name - *
- * @return bool TRUE on success, or FALSE if the message is not of type - * HttpMessage::TYPE_REQUEST or an invalid request method was supplied. - */ - public function setRequestMethod ($method) {} - - /** - * (PECL pecl_http >= 0.21.0)+ * the request method name + *
+ * @return bool TRUE on success, or FALSE if the message is not of type + * HttpMessage::TYPE_REQUEST or an invalid request method was supplied. + */ + public function setRequestMethod($method) {} + + /** + * (PECL pecl_http >= 0.21.0)- * the request URL - *
- * @return bool TRUE on success, or FALSE if the message is not of type - * HttpMessage::TYPE_REQUEST or supplied URL was empty. - */ - public function setRequestUrl ($url) {} - - /** - * (PECL pecl_http >= 0.10.0)+ * the request URL + *
+ * @return bool TRUE on success, or FALSE if the message is not of type + * HttpMessage::TYPE_REQUEST or supplied URL was empty. + */ + public function setRequestUrl($url) {} + + /** + * (PECL pecl_http >= 0.10.0)- * the HTTP protocol version - *
- * @return bool TRUE on success, or FALSE if supplied version is out of range (1.0/1.1). - */ - public function setHttpVersion ($version) {} - - /** - * (PECL pecl_http >= 1.0.0)- * the magic.mime database to use - *
- * @param int $magic_mode [optional]- * flags for libmagic - *
- * @return string|false the guessed content type on success or false on failure. - */ - public function guessContentType ($magic_file, $magic_mode = null) {} - - /** - * (PECL pecl_http >= 0.10.0)+ * the HTTP protocol version + *
+ * @return bool TRUE on success, or FALSE if supplied version is out of range (1.0/1.1). + */ + public function setHttpVersion($version) {} + + /** + * (PECL pecl_http >= 1.0.0)+ * the magic.mime database to use + *
+ * @param int $magic_mode [optional]+ * flags for libmagic + *
+ * @return string|false the guessed content type on success or false on failure. + */ + public function guessContentType($magic_file, $magic_mode = null) {} + + /** + * (PECL pecl_http >= 0.10.0)- * specifies whether the returned string should also contain any parent messages - *
- * @return string the message as string. - */ - public function toString ($include_parent = null) {} - - /** - * (PECL pecl_http >= 0.22.0)- * a single or several consecutive HTTP messages - *
- * @param string $class_name [optional]- * a class extending HttpMessage - *
- * @return HttpMessage|null an HttpMessage object on success or NULL on failure. - */ - public static function factory ($raw_message = null, $class_name = null) {} - - /** - * (PECL pecl_http 0.10.0-1.3.3)- * a single or several consecutive HTTP messages - *
- * @param string $class_name [optional]- * a class extending HttpMessage - *
- * @return HttpMessage|null an HttpMessage object on success or NULL on failure. - */ - public static function fromString ($raw_message = null, $class_name = null) {} - - /** - * (PECL pecl_http >= 1.5.0)- * The message type. See HttpMessage type constants. - *
- * @param string $class_name [optional]- * a class extending HttpMessage - *
- * @return HttpMessage|null an HttpMessage object on success or NULL on failure. - */ - public static function fromEnv ($message_type, $class_name = null) {} - - /** - * (PECL pecl_http >= 0.22.0)- * HttpMessage object to prepend - *
- * @param bool $top [optional]- * whether to prepend to the top most or right this message - *
- * @return void - */ - public function prepend (HttpMessage $message, $top = null) {} - - /** - * (PECL pecl_http >= 0.23.0)+ * specifies whether the returned string should also contain any parent messages + *
+ * @return string the message as string. + */ + public function toString($include_parent = null) {} + + /** + * (PECL pecl_http >= 0.22.0)+ * a single or several consecutive HTTP messages + *
+ * @param string $class_name [optional]+ * a class extending HttpMessage + *
+ * @return HttpMessage|null an HttpMessage object on success or NULL on failure. + */ + public static function factory($raw_message = null, $class_name = null) {} + + /** + * (PECL pecl_http 0.10.0-1.3.3)+ * a single or several consecutive HTTP messages + *
+ * @param string $class_name [optional]+ * a class extending HttpMessage + *
+ * @return HttpMessage|null an HttpMessage object on success or NULL on failure. + */ + public static function fromString($raw_message = null, $class_name = null) {} + + /** + * (PECL pecl_http >= 1.5.0)+ * The message type. See HttpMessage type constants. + *
+ * @param string $class_name [optional]+ * a class extending HttpMessage + *
+ * @return HttpMessage|null an HttpMessage object on success or NULL on failure. + */ + public static function fromEnv($message_type, $class_name = null) {} + + /** + * (PECL pecl_http >= 0.22.0)+ * HttpMessage object to prepend + *
+ * @param bool $top [optional]+ * whether to prepend to the top most or right this message + *
+ * @return void + */ + public function prepend(HttpMessage $message, $top = null) {} + + /** + * (PECL pecl_http >= 0.23.0)- * whether to operate on $_GET and - * $_SERVER['QUERY_STRING'] - *
- * @param mixed $add [optional]- * additional/initial query string parameters - *
- */ - final public function __construct ($global = null, $add = null) {} - - /** - * (PECL pecl_http >= 0.22.0)- * key of the query string param to retrieve - *
- * @param mixed $type [optional]- * which variable type to enforce - *
- * @param mixed $defval [optional]- * default value if key does not exist - *
- * @param bool $delete [optional]- * whether to remove the key/value pair from the query string - *
- * @return mixed the value of the query string param or the whole query string if no key was specified on success or defval if key does not exist. - */ +class HttpQueryString implements Serializable, ArrayAccess +{ + public const TYPE_BOOL = 3; + public const TYPE_INT = 1; + public const TYPE_FLOAT = 2; + public const TYPE_STRING = 6; + public const TYPE_ARRAY = 4; + public const TYPE_OBJECT = 5; + + private static $instance; + private $queryArray; + private $queryString; + + /** + * (PECL pecl_http >= 0.22.0)+ * whether to operate on $_GET and + * $_SERVER['QUERY_STRING'] + *
+ * @param mixed $add [optional]+ * additional/initial query string parameters + *
+ */ + final public function __construct($global = null, $add = null) {} + + /** + * (PECL pecl_http >= 0.22.0)+ * key of the query string param to retrieve + *
+ * @param mixed $type [optional]+ * which variable type to enforce + *
+ * @param mixed $defval [optional]+ * default value if key does not exist + *
+ * @param bool $delete [optional]+ * whether to remove the key/value pair from the query string + *
+ * @return mixed the value of the query string param or the whole query string if no key was specified on success or defval if key does not exist. + */ #[Pure] - public function get ($key = null, $type = null, $defval = null, $delete = null) {} - - /** - * (PECL pecl_http >= 0.22.0)- * query string params to add - *
- * @return string the current query string. - */ - public function set ($params) {} - - /** - * (PECL pecl_http >= 1.1.0)- * query string params to add - *
- * @return HttpQueryString a new HttpQueryString object - */ - public function mod ($params) {} - - /** - * @param $name - * @param $defval [optional] - * @param $delete [optional] - */ + public function get($key = null, $type = null, $defval = null, $delete = null) {} + + /** + * (PECL pecl_http >= 0.22.0)+ * query string params to add + *
+ * @return string the current query string. + */ + public function set($params) {} + + /** + * (PECL pecl_http >= 1.1.0)+ * query string params to add + *
+ * @return HttpQueryString a new HttpQueryString object + */ + public function mod($params) {} + + /** + * @param $name + * @param $defval [optional] + * @param $delete [optional] + */ #[Pure] - public function getBool ($name, $defval, $delete) {} + public function getBool($name, $defval, $delete) {} - /** - * @param $name - * @param $defval [optional] - * @param $delete [optional] - */ + /** + * @param $name + * @param $defval [optional] + * @param $delete [optional] + */ #[Pure] - public function getInt ($name, $defval, $delete) {} + public function getInt($name, $defval, $delete) {} - /** - * @param $name - * @param $defval [optional] - * @param $delete [optional] - */ + /** + * @param $name + * @param $defval [optional] + * @param $delete [optional] + */ #[Pure] - public function getFloat ($name, $defval, $delete) {} + public function getFloat($name, $defval, $delete) {} - /** - * @param $name - * @param $defval [optional] - * @param $delete [optional] - */ + /** + * @param $name + * @param $defval [optional] + * @param $delete [optional] + */ #[Pure] - public function getString ($name, $defval, $delete) {} + public function getString($name, $defval, $delete) {} - /** - * @param $name - * @param $defval [optional] - * @param $delete [optional] - */ + /** + * @param $name + * @param $defval [optional] + * @param $delete [optional] + */ #[Pure] - public function getArray ($name, $defval, $delete) {} + public function getArray($name, $defval, $delete) {} - /** - * @param $name - * @param $defval [optional] - * @param $delete [optional] - */ + /** + * @param $name + * @param $defval [optional] + * @param $delete [optional] + */ #[Pure] - public function getObject ($name, $defval, $delete) {} - - /** - * @param $global [optional] - * @param $params [optional] - * @param $class_name [optional] - */ - public static function factory ($global, $params, $class_name) {} - - /** - * (PECL pecl_http >= 0.25.0)- * whether to operate on $_GET and - * $_SERVER['QUERY_STRING'] - *
- * @return HttpQueryString always the same HttpQueryString instance regarding the global setting. - */ - public static function singleton ($global = null) {} - - /** - * (PECL pecl_http >= 0.25.0)- * input encoding - *
- * @param string $oe- * output encoding - *
- * @return bool true on success or false on failure. - */ - public function xlate ($ie, $oe) {} - - /** - * String representation of object - * @link https://php.net/manual/en/serializable.serialize.php - * @return string the string representation of the object or null - * @since 5.1.0 - */ - public function serialize() - {} - - /** - * Offset to retrieve - * @link https://php.net/manual/en/arrayaccess.offsetget.php - * @param mixed $offset- * The offset to retrieve. - *
- * @return mixed Can return all value types. - * @since 5.0.0 - */ - public function offsetGet($offset) - {} - - /** - * Constructs the object - * @link https://php.net/manual/en/serializable.unserialize.php - * @param string $serialized- * The string representation of the object. - *
- * @return void - * @since 5.1.0 - */ - public function unserialize($serialized) - {} - - /** - * Whether a offset exists - * @link https://php.net/manual/en/arrayaccess.offsetexists.php - * @param mixed $offset- * An offset to check for. - *
- * @return bool true on success or false on failure. - * - *- * The return value will be casted to boolean if non-boolean was returned. - * @since 5.0.0 - */ - public function offsetExists($offset) - {} - - /** - * Offset to set - * @link https://php.net/manual/en/arrayaccess.offsetset.php - * @param mixed $offset
- * The offset to assign the value to. - *
- * @param mixed $value- * The value to set. - *
- * @return void - * @since 5.0.0 - */ - public function offsetSet($offset, $value) - {} - - /** - * Offset to unset - * @link https://php.net/manual/en/arrayaccess.offsetunset.php - * @param mixed $offset- * The offset to unset. - *
- * @return void - * @since 5.0.0 - */ - public function offsetUnset($offset) - {} + public function getObject($name, $defval, $delete) {} + + /** + * @param $global [optional] + * @param $params [optional] + * @param $class_name [optional] + */ + public static function factory($global, $params, $class_name) {} + + /** + * (PECL pecl_http >= 0.25.0)+ * whether to operate on $_GET and + * $_SERVER['QUERY_STRING'] + *
+ * @return HttpQueryString always the same HttpQueryString instance regarding the global setting. + */ + public static function singleton($global = null) {} + + /** + * (PECL pecl_http >= 0.25.0)+ * input encoding + *
+ * @param string $oe+ * output encoding + *
+ * @return bool true on success or false on failure. + */ + public function xlate($ie, $oe) {} + + /** + * String representation of object + * @link https://php.net/manual/en/serializable.serialize.php + * @return string the string representation of the object or null + * @since 5.1.0 + */ + public function serialize() {} + + /** + * Offset to retrieve + * @link https://php.net/manual/en/arrayaccess.offsetget.php + * @param mixed $offset+ * The offset to retrieve. + *
+ * @return mixed Can return all value types. + * @since 5.0.0 + */ + public function offsetGet($offset) {} + + /** + * Constructs the object + * @link https://php.net/manual/en/serializable.unserialize.php + * @param string $serialized+ * The string representation of the object. + *
+ * @return void + * @since 5.1.0 + */ + public function unserialize($serialized) {} + + /** + * Whether a offset exists + * @link https://php.net/manual/en/arrayaccess.offsetexists.php + * @param mixed $offset+ * An offset to check for. + *
+ * @return bool true on success or false on failure. + * + *+ * The return value will be casted to boolean if non-boolean was returned. + * @since 5.0.0 + */ + public function offsetExists($offset) {} + + /** + * Offset to set + * @link https://php.net/manual/en/arrayaccess.offsetset.php + * @param mixed $offset
+ * The offset to assign the value to. + *
+ * @param mixed $value+ * The value to set. + *
+ * @return void + * @since 5.0.0 + */ + public function offsetSet($offset, $value) {} + + /** + * Offset to unset + * @link https://php.net/manual/en/arrayaccess.offsetunset.php + * @param mixed $offset+ * The offset to unset. + *
+ * @return void + * @since 5.0.0 + */ + public function offsetUnset($offset) {} } /** * @link https://php.net/manual/en/class.httprequest.php */ -class HttpRequest { - const METH_GET = 1; - const METH_HEAD = 2; - const METH_POST = 3; - const METH_PUT = 4; - const METH_DELETE = 5; - const METH_OPTIONS = 6; - const METH_TRACE = 7; - const METH_CONNECT = 8; - const METH_PROPFIND = 9; - const METH_PROPPATCH = 10; - const METH_MKCOL = 11; - const METH_COPY = 12; - const METH_MOVE = 13; - const METH_LOCK = 14; - const METH_UNLOCK = 15; - const METH_VERSION_CONTROL = 16; - const METH_REPORT = 17; - const METH_CHECKOUT = 18; - const METH_CHECKIN = 19; - const METH_UNCHECKOUT = 20; - const METH_MKWORKSPACE = 21; - const METH_UPDATE = 22; - const METH_LABEL = 23; - const METH_MERGE = 24; - const METH_BASELINE_CONTROL = 25; - const METH_MKACTIVITY = 26; - const METH_ACL = 27; - const VERSION_1_0 = 1; - const VERSION_1_1 = 2; - const VERSION_NONE = 0; - const VERSION_ANY = 0; - const SSL_VERSION_TLSv1 = 1; - const SSL_VERSION_SSLv2 = 2; - const SSL_VERSION_SSLv3 = 3; - const SSL_VERSION_ANY = 0; - const IPRESOLVE_V4 = 1; - const IPRESOLVE_V6 = 2; - const IPRESOLVE_ANY = 0; - const AUTH_BASIC = 1; - const AUTH_DIGEST = 2; - const AUTH_NTLM = 8; - const AUTH_GSSNEG = 4; - const AUTH_ANY = -1; - const PROXY_SOCKS4 = 4; - const PROXY_SOCKS5 = 5; - const PROXY_HTTP = 0; - - private $options; - private $postFields; - private $postFiles; - private $responseInfo; - private $responseMessage; - private $responseCode; - private $responseStatus; - private $method; - private $url; - private $contentType; - private $requestBody; - private $queryData; - private $putFile; - private $putData; - private $history; - public $recordHistory; - - - /** - * (PECL pecl_http >= 0.10.0)- * the target request url - *
- * @param int $request_method [optional]- * the request method to use - *
- * @param null|array $options [optional]- * an associative array with request options - *
- */ - public function __construct ($url = null, $request_method = null, ?array $options = null ) {} - - /** - * (PECL pecl_http >= 0.10.0)- * an associative array, which values will overwrite the - * currently set request options; - * if empty or omitted, the options of the HttpRequest object will be reset - *
- * @return bool true on success or false on failure. - */ - public function setOptions (?array $options = null ) {} - - /** - * (PECL pecl_http >= 0.10.0)+ * the target request url + *
+ * @param int $request_method [optional]+ * the request method to use + *
+ * @param null|array $options [optional]+ * an associative array with request options + *
+ */ + public function __construct($url = null, $request_method = null, ?array $options = null) {} + + /** + * (PECL pecl_http >= 0.10.0)+ * an associative array, which values will overwrite the + * currently set request options; + * if empty or omitted, the options of the HttpRequest object will be reset + *
+ * @return bool true on success or false on failure. + */ + public function setOptions(?array $options = null) {} + + /** + * (PECL pecl_http >= 0.10.0)- * an associative array containing any SSL specific options; - * if empty or omitted, the SSL options will be reset - *
- * @return bool true on success or false on failure. - */ - public function setSslOptions (?array $options = null ) {} - - /** - * (PECL pecl_http >= 0.10.0)+ * an associative array containing any SSL specific options; + * if empty or omitted, the SSL options will be reset + *
+ * @return bool true on success or false on failure. + */ + public function setSslOptions(?array $options = null) {} + + /** + * (PECL pecl_http >= 0.10.0)- * an associative array as parameter containing additional SSL specific options - *
- * @return bool true on success or false on failure. - */ - public function addSslOptions (array $option) {} - - /** - * (PECL pecl_http >= 0.10.0)- * an associative array as parameter containing additional header name/value pairs - *
- * @return bool true on success or false on failure. - */ - public function addHeaders (array $headers) {} - - /** - * (PECL pecl_http >= 0.10.0)+ * an associative array as parameter containing additional SSL specific options + *
+ * @return bool true on success or false on failure. + */ + public function addSslOptions(array $option) {} + + /** + * (PECL pecl_http >= 0.10.0)+ * an associative array as parameter containing additional header name/value pairs + *
+ * @return bool true on success or false on failure. + */ + public function addHeaders(array $headers) {} + + /** + * (PECL pecl_http >= 0.10.0)- * an associative array as parameter containing header name/value pairs; - * if empty or omitted, all previously set headers will be unset - *
- * @return bool true on success or false on failure. - */ - public function setHeaders ( ?array $headers = null ) {} - - /** - * (PECL pecl_http >= 0.10.0)- * an associative array containing any cookie name/value pairs to add - *
- * @return bool true on success or false on failure. - */ - public function addCookies (array $cookies) {} - - /** - * (PECL pecl_http >= 0.10.0)+ * an associative array as parameter containing header name/value pairs; + * if empty or omitted, all previously set headers will be unset + *
+ * @return bool true on success or false on failure. + */ + public function setHeaders(?array $headers = null) {} + + /** + * (PECL pecl_http >= 0.10.0)+ * an associative array containing any cookie name/value pairs to add + *
+ * @return bool true on success or false on failure. + */ + public function addCookies(array $cookies) {} + + /** + * (PECL pecl_http >= 0.10.0)- * an associative array as parameter containing cookie name/value pairs; - * if empty or omitted, all previously set cookies will be unset - *
- * @return bool true on success or false on failure. - */ - public function setCookies ( ?array $cookies = null ) {} - - /** - * (PECL pecl_http >= 1.0.0)- * whether only session cookies should be reset (needs libcurl >= v7.15.4, else libcurl >= v7.14.1) - *
- * @return bool true on success or false on failure. - */ - public function resetCookies ($session_only = null) {} - - public function flushCookies () {} - - /** - * (PECL pecl_http >= 0.10.0)- * the request method to use - *
- * @return bool true on success or false on failure. - */ - public function setMethod ($request_method) {} - - /** - * (PECL pecl_http >= 0.10.0)+ * an associative array as parameter containing cookie name/value pairs; + * if empty or omitted, all previously set cookies will be unset + *
+ * @return bool true on success or false on failure. + */ + public function setCookies(?array $cookies = null) {} + + /** + * (PECL pecl_http >= 1.0.0)+ * whether only session cookies should be reset (needs libcurl >= v7.15.4, else libcurl >= v7.14.1) + *
+ * @return bool true on success or false on failure. + */ + public function resetCookies($session_only = null) {} + + public function flushCookies() {} + + /** + * (PECL pecl_http >= 0.10.0)+ * the request method to use + *
+ * @return bool true on success or false on failure. + */ + public function setMethod($request_method) {} + + /** + * (PECL pecl_http >= 0.10.0)- * the request url - *
- * @return bool true on success or false on failure. - */ - public function setUrl ($url) {} - - /** - * (PECL pecl_http >= 0.10.0)+ * the request url + *
+ * @return bool true on success or false on failure. + */ + public function setUrl($url) {} + + /** + * (PECL pecl_http >= 0.10.0)- * the content type of the request (primary/secondary) - *
- * @return bool TRUE on success, or FALSE if the content type does not seem to - * contain a primary and a secondary part. - */ - public function setContentType ($content_type) {} - - /** - * (PECL pecl_http >= 0.10.0)+ * the content type of the request (primary/secondary) + *
+ * @return bool TRUE on success, or FALSE if the content type does not seem to + * contain a primary and a secondary part. + */ + public function setContentType($content_type) {} + + /** + * (PECL pecl_http >= 0.10.0)- * a string or associative array parameter containing the pre-encoded - * query string or to be encoded query fields; - * if empty, the query data will be unset - *
- * @return bool true on success or false on failure. - */ - public function setQueryData ($query_data) {} - - /** - * (PECL pecl_http >= 0.10.0)+ * a string or associative array parameter containing the pre-encoded + * query string or to be encoded query fields; + * if empty, the query data will be unset + *
+ * @return bool true on success or false on failure. + */ + public function setQueryData($query_data) {} + + /** + * (PECL pecl_http >= 0.10.0)- * an associative array as parameter containing the query fields to add - *
- * @return bool true on success or false on failure. - */ - public function addQueryData (array $query_params) {} - - /** - * (PECL pecl_http >= 0.10.0)- * an associative array containing the post fields; - * if empty, the post data will be unset - *
- * @return bool true on success or false on failure. - */ - public function setPostFields (array $post_data) {} - - /** - * (PECL pecl_http >= 0.10.0)+ * an associative array as parameter containing the query fields to add + *
+ * @return bool true on success or false on failure. + */ + public function addQueryData(array $query_params) {} + + /** + * (PECL pecl_http >= 0.10.0)+ * an associative array containing the post fields; + * if empty, the post data will be unset + *
+ * @return bool true on success or false on failure. + */ + public function setPostFields(array $post_data) {} + + /** + * (PECL pecl_http >= 0.10.0)- * an associative array as parameter containing the post fields - *
- * @return bool true on success or false on failure. - */ - public function addPostFields (array $post_data) {} - - /** - * @param $request_body_data [optional] - */ - public function setBody ($request_body_data) {} + public function getPostFields() {} + + /** + * (PECL pecl_http >= 0.10.0)+ * an associative array as parameter containing the post fields + *
+ * @return bool true on success or false on failure. + */ + public function addPostFields(array $post_data) {} + + /** + * @param $request_body_data [optional] + */ + public function setBody($request_body_data) {} #[Pure] - public function getBody () {} - - /** - * @param $request_body_data - */ - public function addBody ($request_body_data) {} - - /** - * (PECL pecl_http 0.14.0-1.4.1)- * raw post data - *
- * @return bool true on success or false on failure. - */ - public function setRawPostData ($raw_post_data = null) {} - - /** - * (PECL pecl_http 0.14.0-1.4.1)+ * raw post data + *
+ * @return bool true on success or false on failure. + */ + public function setRawPostData($raw_post_data = null) {} + + /** + * (PECL pecl_http 0.14.0-1.4.1)- * the raw post data to concatenate - *
- * @return bool true on success or false on failure. - */ - public function addRawPostData ($raw_post_data) {} - - /** - * (PECL pecl_http >= 0.10.0)- * an array containing the files to post; - * if empty, the post files will be unset - *
- * @return bool true on success or false on failure. - */ - public function setPostFiles (array $post_files) {} - - /** - * (PECL pecl_http >= 0.10.0)- * the form element name - *
- * @param string $file- * the path to the file - *
- * @param string $content_type [optional]- * the content type of the file - *
- * @return bool TRUE on success, or FALSE if the content type seems not to contain a - * primary and a secondary content type part. - */ - public function addPostFile ($name, $file, $content_type = null) {} - - /** - * (PECL pecl_http >= 0.10.0)+ * the raw post data to concatenate + *
+ * @return bool true on success or false on failure. + */ + public function addRawPostData($raw_post_data) {} + + /** + * (PECL pecl_http >= 0.10.0)+ * an array containing the files to post; + * if empty, the post files will be unset + *
+ * @return bool true on success or false on failure. + */ + public function setPostFiles(array $post_files) {} + + /** + * (PECL pecl_http >= 0.10.0)+ * the form element name + *
+ * @param string $file+ * the path to the file + *
+ * @param string $content_type [optional]+ * the content type of the file + *
+ * @return bool TRUE on success, or FALSE if the content type seems not to contain a + * primary and a secondary content type part. + */ + public function addPostFile($name, $file, $content_type = null) {} + + /** + * (PECL pecl_http >= 0.10.0)- * the path to the file to send; - * if empty or omitted the put file will be unset - *
- * @return bool true on success or false on failure. - */ - public function setPutFile ($file = null) {} - - /** - * (PECL pecl_http >= 0.10.0)+ * the path to the file to send; + * if empty or omitted the put file will be unset + *
+ * @return bool true on success or false on failure. + */ + public function setPutFile($file = null) {} + + /** + * (PECL pecl_http >= 0.10.0)- * the data to upload - *
- * @return bool true on success or false on failure. - */ - public function setPutData ($put_data = null) {} - - /** - * (PECL pecl_http >= 0.25.0)+ * the data to upload + *
+ * @return bool true on success or false on failure. + */ + public function setPutData($put_data = null) {} + + /** + * (PECL pecl_http >= 0.25.0)- * the data to concatenate - *
- * @return bool true on success or false on failure. - */ - public function addPutData ($put_data) {} - - /** - * (PECL pecl_http >= 0.10.0)+ * the data to concatenate + *
+ * @return bool true on success or false on failure. + */ + public function addPutData($put_data) {} + + /** + * (PECL pecl_http >= 0.10.0)- * header to read; if empty, all response headers will be returned - *
- * @return mixed either a string with the value of the header matching name if requested, - * FALSE on failure, or an associative array containing all response headers. - */ + public function getResponseData() {} + + /** + * (PECL pecl_http >= 0.10.0)+ * header to read; if empty, all response headers will be returned + *
+ * @return mixed either a string with the value of the header matching name if requested, + * FALSE on failure, or an associative array containing all response headers. + */ #[Pure] - public function getResponseHeader ($name = null) {} - - /** - * (PECL pecl_http >= 0.23.0)- * http_parse_cookie flags - *
- * @param null|array $allowed_extras [optional]- * allowed keys treated as extra information instead of cookie names - *
- * @return stdClass[] an array of stdClass objects like http_parse_cookie would return. - */ + public function getResponseHeader($name = null) {} + + /** + * (PECL pecl_http >= 0.23.0)+ * http_parse_cookie flags + *
+ * @param null|array $allowed_extras [optional]+ * allowed keys treated as extra information instead of cookie names + *
+ * @return stdClass[] an array of stdClass objects like http_parse_cookie would return. + */ #[Pure] - public function getResponseCookies ($flags = null, ?array $allowed_extras = null ) {} - - /** - * (PECL pecl_http >= 0.10.0)- * the info to read; if empty or omitted, an associative array containing - * all available info will be returned - *
- * @return mixed either a scalar containing the value of the info matching name if - * requested, FALSE on failure, or an associative array containing all - * available info. - */ + public function getResponseBody() {} + + /** + * (PECL pecl_http >= 0.10.0)+ * the info to read; if empty or omitted, an associative array containing + * all available info will be returned + *
+ * @return mixed either a scalar containing the value of the info matching name if + * requested, FALSE on failure, or an associative array containing all + * available info. + */ #[Pure] - public function getResponseInfo ($name = null) {} - - /** - * (PECL pecl_http >= 0.10.0)- * HttpRequest object to attach - *
- */ - public function __construct ( ?HttpRequest $request = null) {} - - /** - * (PECL pecl_http >= 0.10.0)- * an HttpRequest object not already attached to any HttpRequestPool object - *
- * @return bool true on success or false on failure. - */ - public function attach ( HttpRequest $request) {} - - /** - * (PECL pecl_http >= 0.10.0)- * an HttpRequest object attached to this HttpRequestPool object - *
- * @return bool true on success or false on failure. - */ - public function detach ( HttpRequest $request ) {} - - /** - * (PECL pecl_http >= 0.10.0)+ * HttpRequest object to attach + *
+ */ + public function __construct(?HttpRequest $request = null) {} + + /** + * (PECL pecl_http >= 0.10.0)+ * an HttpRequest object not already attached to any HttpRequestPool object + *
+ * @return bool true on success or false on failure. + */ + public function attach(HttpRequest $request) {} + + /** + * (PECL pecl_http >= 0.10.0)+ * an HttpRequest object attached to this HttpRequestPool object + *
+ * @return bool true on success or false on failure. + */ + public function detach(HttpRequest $request) {} + + /** + * (PECL pecl_http >= 0.10.0)- * the name of the header - *
- * @param mixed $value [optional]- * the value of the header; - * if not set, no header with this name will be sent - *
- * @param bool $replace [optional]- * whether an existing header should be replaced - *
- * @return bool true on success or false on failure. - */ - public static function setHeader ($name, $value = null, $replace = null) {} - - /** - * (PECL pecl_http >= 0.12.0)- * specifies the name of the header to read; - * if empty or omitted, an associative array with all headers will be returned - *
- * @return mixed either a string containing the value of the header matching name, - * false on failure, or an associative array with all headers. - */ - public static function getHeader ($name = null) {} - - /** - * (PECL pecl_http >= 0.10.0)- * unquoted string as parameter containing the ETag - *
- * @return bool true on success or false on failure. - */ - public static function setETag ($etag) {} - - /** - * (PECL pecl_http >= 0.10.0)- * Unix timestamp representing the last modification time of the sent entity - *
- * @return bool true on success or false on failure. - */ - public static function setLastModified ($timestamp) {} - - /** - * (PECL pecl_http >= 0.12.0)- * the file name the "Save as..." dialog should display - *
- * @param bool $inline [optional]- * if set to true and the user agent knows how to handle the content type, - * it will probably not cause the popup window to be shown - *
- * @return bool true on success or false on failure. - */ - public static function setContentDisposition ($filename, $inline = null) {} - - /** - * (PECL pecl_http >= 0.10.0)- * the content type of the sent entity (primary/secondary) - *
- * @return bool true on success, or false if the content type does not seem to - * contain a primary and secondary content type part. - */ - public static function setContentType ($content_type) {} - - /** - * (PECL pecl_http >= 0.10.0)- * specifies the magic.mime database to use - *
- * @param int $magic_mode [optional]- * flags for libmagic - *
- * @return string|false the guessed content type on success or false on failure. - */ - public static function guessContentType ($magic_file, $magic_mode = null) {} - - /** - * (PECL pecl_http >= 0.10.0)- * whether caching should be attempted - *
- * @return bool true on success or false on failure. - */ - public static function setCache ($cache) {} - - /** - * (PECL pecl_http >= 0.10.0)- * the primary cache control setting - *
- * @param int $max_age [optional]- * the max-age in seconds, suggesting how long the cache entry is valid on the client side - *
- * @param bool $must_revalidate [optional]- * whether the cached entity should be revalidated by the client for every request - *
- * @return bool true on success, or false if control does not match one of public, private or no-cache. - */ - public static function setCacheControl ($control, $max_age = null, $must_revalidate = null) {} - - /** - * (PECL pecl_http >= 0.10.0)- * whether GZip compression should be enabled - *
- * @return bool true on success or false on failure. - */ - public static function setGzip ($gzip) {} - - /** - * (PECL pecl_http >= 0.10.0)- * seconds to sleep after each chunk sent - *
- * @return bool true on success or false on failure. - */ - public static function setThrottleDelay ($seconds) {} - - /** - * (PECL pecl_http >= 0.10.0)- * the chunk size in bytes - *
- * @return bool true on success or false on failure. - */ - public static function setBufferSize ($bytes) {} - - /** - * (PECL pecl_http >= 0.10.0)- * data to send - *
- * @return bool true on success or false on failure. - */ - public static function setData ($data) {} - - /** - * (PECL pecl_http >= 0.10.0)- * the path to the file to send - *
- * @return bool true on success or false on failure. - */ - public static function setFile ($file) {} - - /** - * (PECL pecl_http >= 0.10.0)- * already opened stream from which the data to send will be read - *
- * @return bool true on success or false on failure. - */ - public static function setStream ($stream) {} - - /** - * (PECL pecl_http >= 0.10.0)- * whether to destroy all previously started output handlers and their buffers - *
- * @return bool true on success or false on failure. - */ - public static function send ($clean_ob = null) {} - - /** - * (PECL pecl_http >= 0.10.0)+ * the name of the header + *
+ * @param mixed $value [optional]+ * the value of the header; + * if not set, no header with this name will be sent + *
+ * @param bool $replace [optional]+ * whether an existing header should be replaced + *
+ * @return bool true on success or false on failure. + */ + public static function setHeader($name, $value = null, $replace = null) {} + + /** + * (PECL pecl_http >= 0.12.0)+ * specifies the name of the header to read; + * if empty or omitted, an associative array with all headers will be returned + *
+ * @return mixed either a string containing the value of the header matching name, + * false on failure, or an associative array with all headers. + */ + public static function getHeader($name = null) {} + + /** + * (PECL pecl_http >= 0.10.0)+ * unquoted string as parameter containing the ETag + *
+ * @return bool true on success or false on failure. + */ + public static function setETag($etag) {} + + /** + * (PECL pecl_http >= 0.10.0)+ * Unix timestamp representing the last modification time of the sent entity + *
+ * @return bool true on success or false on failure. + */ + public static function setLastModified($timestamp) {} + + /** + * (PECL pecl_http >= 0.12.0)+ * the file name the "Save as..." dialog should display + *
+ * @param bool $inline [optional]+ * if set to true and the user agent knows how to handle the content type, + * it will probably not cause the popup window to be shown + *
+ * @return bool true on success or false on failure. + */ + public static function setContentDisposition($filename, $inline = null) {} + + /** + * (PECL pecl_http >= 0.10.0)+ * the content type of the sent entity (primary/secondary) + *
+ * @return bool true on success, or false if the content type does not seem to + * contain a primary and secondary content type part. + */ + public static function setContentType($content_type) {} + + /** + * (PECL pecl_http >= 0.10.0)+ * specifies the magic.mime database to use + *
+ * @param int $magic_mode [optional]+ * flags for libmagic + *
+ * @return string|false the guessed content type on success or false on failure. + */ + public static function guessContentType($magic_file, $magic_mode = null) {} + + /** + * (PECL pecl_http >= 0.10.0)+ * whether caching should be attempted + *
+ * @return bool true on success or false on failure. + */ + public static function setCache($cache) {} + + /** + * (PECL pecl_http >= 0.10.0)+ * the primary cache control setting + *
+ * @param int $max_age [optional]+ * the max-age in seconds, suggesting how long the cache entry is valid on the client side + *
+ * @param bool $must_revalidate [optional]+ * whether the cached entity should be revalidated by the client for every request + *
+ * @return bool true on success, or false if control does not match one of public, private or no-cache. + */ + public static function setCacheControl($control, $max_age = null, $must_revalidate = null) {} + + /** + * (PECL pecl_http >= 0.10.0)+ * whether GZip compression should be enabled + *
+ * @return bool true on success or false on failure. + */ + public static function setGzip($gzip) {} + + /** + * (PECL pecl_http >= 0.10.0)+ * seconds to sleep after each chunk sent + *
+ * @return bool true on success or false on failure. + */ + public static function setThrottleDelay($seconds) {} + + /** + * (PECL pecl_http >= 0.10.0)+ * the chunk size in bytes + *
+ * @return bool true on success or false on failure. + */ + public static function setBufferSize($bytes) {} + + /** + * (PECL pecl_http >= 0.10.0)+ * data to send + *
+ * @return bool true on success or false on failure. + */ + public static function setData($data) {} + + /** + * (PECL pecl_http >= 0.10.0)+ * the path to the file to send + *
+ * @return bool true on success or false on failure. + */ + public static function setFile($file) {} + + /** + * (PECL pecl_http >= 0.10.0)+ * already opened stream from which the data to send will be read + *
+ * @return bool true on success or false on failure. + */ + public static function setStream($stream) {} + + /** + * (PECL pecl_http >= 0.10.0)+ * whether to destroy all previously started output handlers and their buffers + *
+ * @return bool true on success or false on failure. + */ + public static function send($clean_ob = null) {} + + /** + * (PECL pecl_http >= 0.10.0)* Returns false if no row was retrieved. */ -function db2_fetch_object ($stmt, $row_number = null) {} +function db2_fetch_object($stmt, $row_number = null) {} /** * Returns an object with properties that describe the DB2 database server @@ -1638,7 +1638,7 @@ function db2_fetch_object ($stmt, $row_number = null) {} *
* @return object|false An object on a successful call. Returns false on failure. */ -function db2_server_info ($connection) {} +function db2_server_info($connection) {} /** * Returns an object with properties that describe the DB2 database client @@ -1648,7 +1648,7 @@ function db2_server_info ($connection) {} * * @return object|false An object on a successful call. Returns false on failure. */ -function db2_client_info ($connection) {} +function db2_client_info($connection) {} /** * Used to escape certain characters @@ -1662,7 +1662,7 @@ function db2_client_info ($connection) {} * @return string string_literal with the special characters * noted above prepended with backslashes. */ -function db2_escape_string ($string_literal) {} +function db2_escape_string($string_literal) {} /** * Gets a user defined size of LOB files with each invocation @@ -1679,7 +1679,7 @@ function db2_escape_string ($string_literal) {} * @return string|false The amount of data the user specifies. Returns * false if the data cannot be retrieved. */ -function db2_lob_read ($stmt, $colnum, $length) {} +function db2_lob_read($stmt, $colnum, $length) {} /** * Retrieves an option value for a statement resource or a connection resource @@ -1720,7 +1720,7 @@ function db2_lob_read ($stmt, $colnum, $length) {} * @return string|false The current setting of the connection attribute provided on success * or false on failure. */ -function db2_get_option ($resource, $option) {} +function db2_get_option($resource, $option) {} /** * Returns the auto generated ID of the last insert query that successfully executed on this connection. @@ -1735,28 +1735,27 @@ function db2_get_option ($resource, $option) {} * The value of this parameter cannot be a statement resource or result set resource. * @return string Returns the auto generated ID of last insert query that successfully executed on this connection. */ -function db2_last_insert_id ($resource) {} - +function db2_last_insert_id($resource) {} /** * Specifies that binary data shall be returned as is. This is the default * mode. * @link https://php.net/manual/en/ibm-db2.constants.php */ -define ('DB2_BINARY', 1); +define('DB2_BINARY', 1); /** * Specifies that binary data shall be converted to a hexadecimal encoding * and returned as an ASCII string. * @link https://php.net/manual/en/ibm-db2.constants.php */ -define ('DB2_CONVERT', 2); +define('DB2_CONVERT', 2); /** * Specifies that binary data shall be converted to a null value. * @link https://php.net/manual/en/ibm-db2.constants.php */ -define ('DB2_PASSTHRU', 3); +define('DB2_PASSTHRU', 3); /** * Specifies a scrollable cursor for a statement resource. This mode enables @@ -1764,103 +1763,103 @@ function db2_last_insert_id ($resource) {} * IBM DB2 Universal Database. * @link https://php.net/manual/en/ibm-db2.constants.php */ -define ('DB2_SCROLLABLE', 1); +define('DB2_SCROLLABLE', 1); /** * Specifies a forward-only cursor for a statement resource. This is the * default cursor type and is supported on all database servers. * @link https://php.net/manual/en/ibm-db2.constants.php */ -define ('DB2_FORWARD_ONLY', 0); +define('DB2_FORWARD_ONLY', 0); /** * Specifies the PHP variable should be bound as an IN parameter for a * stored procedure. * @link https://php.net/manual/en/ibm-db2.constants.php */ -define ('DB2_PARAM_IN', 1); +define('DB2_PARAM_IN', 1); /** * Specifies the PHP variable should be bound as an OUT parameter for a * stored procedure. * @link https://php.net/manual/en/ibm-db2.constants.php */ -define ('DB2_PARAM_OUT', 4); +define('DB2_PARAM_OUT', 4); /** * Specifies the PHP variable should be bound as an INOUT parameter for a * stored procedure. * @link https://php.net/manual/en/ibm-db2.constants.php */ -define ('DB2_PARAM_INOUT', 2); +define('DB2_PARAM_INOUT', 2); /** * Specifies that the column should be bound directly to a file for input. * @link https://php.net/manual/en/ibm-db2.constants.php */ -define ('DB2_PARAM_FILE', 11); +define('DB2_PARAM_FILE', 11); /** * Specifies that autocommit should be turned on. * @link https://php.net/manual/en/ibm-db2.constants.php */ -define ('DB2_AUTOCOMMIT_ON', 1); +define('DB2_AUTOCOMMIT_ON', 1); /** * Specifies that autocommit should be turned off. * @link https://php.net/manual/en/ibm-db2.constants.php */ -define ('DB2_AUTOCOMMIT_OFF', 0); +define('DB2_AUTOCOMMIT_OFF', 0); /** * Specifies that deferred prepare should be turned on for the specified statement resource. * @link https://php.net/manual/en/ibm-db2.constants.php */ -define ('DB2_DEFERRED_PREPARE_ON', 1); +define('DB2_DEFERRED_PREPARE_ON', 1); /** * Specifies that deferred prepare should be turned off for the specified statement resource. * @link https://php.net/manual/en/ibm-db2.constants.php */ -define ('DB2_DEFERRED_PREPARE_OFF', 0); +define('DB2_DEFERRED_PREPARE_OFF', 0); /** * Specifies that the variable should be bound as a DOUBLE, FLOAT, or REAL * data type. * @link https://php.net/manual/en/ibm-db2.constants.php */ -define ('DB2_DOUBLE', 8); +define('DB2_DOUBLE', 8); /** * Specifies that the variable should be bound as a SMALLINT, INTEGER, or * BIGINT data type. * @link https://php.net/manual/en/ibm-db2.constants.php */ -define ('DB2_LONG', 4); +define('DB2_LONG', 4); /** * Specifies that the variable should be bound as a CHAR or VARCHAR data type. * @link https://php.net/manual/en/ibm-db2.constants.php */ -define ('DB2_CHAR', 1); -define ('DB2_XML', -370); +define('DB2_CHAR', 1); +define('DB2_XML', -370); /** * Specifies that column names will be returned in their natural case. * @link https://php.net/manual/en/ibm-db2.constants.php */ -define ('DB2_CASE_NATURAL', 0); +define('DB2_CASE_NATURAL', 0); /** * Specifies that column names will be returned in lower case. * @link https://php.net/manual/en/ibm-db2.constants.php */ -define ('DB2_CASE_LOWER', 1); +define('DB2_CASE_LOWER', 1); /** * Specifies that column names will be returned in upper case. * @link https://php.net/manual/en/ibm-db2.constants.php */ -define ('DB2_CASE_UPPER', 2); +define('DB2_CASE_UPPER', 2); // End of ibm_db2 v.1.6.0 diff --git a/iconv/iconv.php b/iconv/iconv.php index f3e8dc235..3f59cd1fa 100644 --- a/iconv/iconv.php +++ b/iconv/iconv.php @@ -28,8 +28,7 @@ * @return string|false the converted string or FALSE on failure. */ #[Pure] -function iconv (string $from_encoding, string $to_encoding, string $string): string|false -{} +function iconv(string $from_encoding, string $to_encoding, string $string): string|false {} /** * Convert character encoding as output buffer handler @@ -40,8 +39,7 @@ function iconv (string $from_encoding, string $to_encoding, string $string): str * return values. */ #[Pure] -function ob_iconv_handler (string $contents, int $status): string -{} +function ob_iconv_handler(string $contents, int $status): string {} /** * Retrieve internal configuration variables of iconv extension @@ -62,8 +60,7 @@ function ob_iconv_handler (string $contents, int $status): string * */ #[Pure] -function iconv_get_encoding (string $type = "all"): array|string|false -{} +function iconv_get_encoding(string $type = "all"): array|string|false {} /** * Set current setting for character encoding conversion @@ -79,8 +76,7 @@ function iconv_get_encoding (string $type = "all"): array|string|false * * @return bool TRUE on success or FALSE on failure. */ -function iconv_set_encoding (string $type, string $encoding): bool -{} +function iconv_set_encoding(string $type, string $encoding): bool {} /** * Returns the character count of string @@ -96,8 +92,7 @@ function iconv_set_encoding (string $type, string $encoding): bool * @return int|false the character count of str, as an integer. False on error. */ #[Pure] -function iconv_strlen (string $string, ?string $encoding = 'ini_get("iconv.internal_encoding")'): int|false -{} +function iconv_strlen(string $string, ?string $encoding = 'ini_get("iconv.internal_encoding")'): int|false {} /** * Cut out part of a string @@ -152,8 +147,7 @@ function iconv_strlen (string $string, ?string $encoding = 'ini_get("iconv.inter * */ #[Pure] -function iconv_substr (string $string, int $offset, ?int $length, ?string $encoding = 'ini_get("iconv.internal_encoding")'): string|false -{} +function iconv_substr(string $string, int $offset, ?int $length, ?string $encoding = 'ini_get("iconv.internal_encoding")'): string|false {} /** * Finds position of first occurrence of a needle within a haystack @@ -181,8 +175,7 @@ function iconv_substr (string $string, int $offset, ?int $length, ?string $encod * */ #[Pure] -function iconv_strpos (string $haystack, string $needle, int $offset = 0, ?string $encoding = 'ini_get("iconv.internal_encoding")'): int|false -{} +function iconv_strpos(string $haystack, string $needle, int $offset = 0, ?string $encoding = 'ini_get("iconv.internal_encoding")'): int|false {} /** * Finds the last occurrence of a needle within a haystack @@ -206,8 +199,7 @@ function iconv_strpos (string $haystack, string $needle, int $offset = 0, ?strin * */ #[Pure] -function iconv_strrpos (string $haystack, string $needle, ?string $encoding = 'ini_get("iconv.internal_encoding")'): int|false -{} +function iconv_strrpos(string $haystack, string $needle, ?string $encoding = 'ini_get("iconv.internal_encoding")'): int|false {} /** * Composes a MIME header field @@ -308,8 +300,7 @@ function iconv_strrpos (string $haystack, string $needle, ?string $encoding = 'i * or FALSE if an error occurs during the encoding. */ #[Pure] -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): string|false {} /** * Decodes a MIME header field @@ -361,8 +352,7 @@ function iconv_mime_encode (string $field_name, string $field_value, array $opti * or FALSE if an error occurs during the decoding. */ #[Pure] -function iconv_mime_decode (string $string, int $mode = 0, ?string $encoding = 'ini_get("iconv.internal_encoding")'): string|false -{} +function iconv_mime_decode(string $string, int $mode = 0, ?string $encoding = 'ini_get("iconv.internal_encoding")'): string|false {} /** * Decodes multiple MIME header fields at once @@ -423,33 +413,30 @@ function iconv_mime_decode (string $string, int $mode = 0, ?string $encoding = ' * */ #[Pure] -function iconv_mime_decode_headers (string $headers, int $mode = 0, ?string $encoding = 'ini_get("iconv.internal_encoding")'): array|false -{} - +function iconv_mime_decode_headers(string $headers, int $mode = 0, ?string $encoding = 'ini_get("iconv.internal_encoding")'): array|false {} /** * string * @link https://php.net/manual/en/iconv.constants.php */ -define ('ICONV_IMPL', "unknown"); +define('ICONV_IMPL', "unknown"); /** * string * @link https://php.net/manual/en/iconv.constants.php */ -define ('ICONV_VERSION', 2.17); +define('ICONV_VERSION', 2.17); /** * integer * @link https://php.net/manual/en/iconv.constants.php */ -define ('ICONV_MIME_DECODE_STRICT', 1); +define('ICONV_MIME_DECODE_STRICT', 1); /** * integer * @link https://php.net/manual/en/iconv.constants.php */ -define ('ICONV_MIME_DECODE_CONTINUE_ON_ERROR', 2); +define('ICONV_MIME_DECODE_CONTINUE_ON_ERROR', 2); // End of iconv v. -?> diff --git a/igbinary/igbinary.php b/igbinary/igbinary.php index bf9c84905..c0c39c43b 100644 --- a/igbinary/igbinary.php +++ b/igbinary/igbinary.php @@ -38,4 +38,3 @@ function igbinary_serialize($value) {} function igbinary_unserialize($str) {} // End of igbinary v.1.0.0 -?> diff --git a/imagick/imagick.php b/imagick/imagick.php index 14374f122..f3110ca95 100644 --- a/imagick/imagick.php +++ b/imagick/imagick.php @@ -6,6773 +6,6769 @@ use JetBrains\PhpStorm\Deprecated; use JetBrains\PhpStorm\Pure; -class ImagickException extends Exception { -} +class ImagickException extends Exception {} -class ImagickDrawException extends Exception { -} +class ImagickDrawException extends Exception {} -class ImagickPixelIteratorException extends Exception { -} +class ImagickPixelIteratorException extends Exception {} -class ImagickPixelException extends Exception { -} +class ImagickPixelException extends Exception {} -class ImagickKernelException extends Exception { -} +class ImagickKernelException extends Exception {} /** * @method Imagick clone() (PECL imagick 2.0.0)- * One of the layer method constants. - *
- * @return Imagick TRUE on success. - * @throws ImagickException on error. - */ - public function compareImageLayers ($method) {} - - /** - * (PECL imagick 2.0.0)- * A string containing the image. - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function pingImageBlob ($image) {} - - /** - * (PECL imagick 2.0.0)- * An open filehandle to the image. - *
- * @param string $fileName [optional]- * Optional filename for this image. - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function pingImageFile ($filehandle, $fileName = null) {} - - /** - * (PECL imagick 2.0.0)- * By default target must match a particular pixel color exactly. - * However, in many cases two colors may differ by a small amount. - * The fuzz member of image defines how much tolerance is acceptable - * to consider two colors as the same. This parameter represents the variation - * on the quantum range. - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function trimImage ($fuzz) {} - - /** - * (PECL imagick 2.0.0)- * The amplitude of the wave. - *
- * @param float $length- * The length of the wave. - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function waveImage ($amplitude, $length) {} - - /** - * (PECL imagick 2.0.0)- * The black point. - *
- * @param float $whitePoint- * The white point - *
- * @param int $x- * X offset of the ellipse - *
- * @param int $y- * Y offset of the ellipse - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function vignetteImage ($blackPoint, $whitePoint, $x, $y) {} - - /** - * (PECL imagick 2.0.0)- * True activates the matte channel and false disables it. - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function setImageMatte ($matte) {} - - /** - * Adaptively resize image with data dependent triangulation - * - * If legacy is true, the calculations are done with the small rounding bug that existed in Imagick before 3.4.0.- * The radius of the Gaussian, in pixels, not counting the center pixel - *
- * @param float $sigma- * The standard deviation of the Gaussian, in pixels. - *
- * @param float $angle- * Apply the effect along this angle. - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function sketchImage ($radius, $sigma, $angle) {} - - /** - * (PECL imagick 2.0.0)- * A value other than zero shades the intensity of each pixel. - *
- * @param float $azimuth- * Defines the light source direction. - *
- * @param float $elevation- * Defines the light source direction. - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function shadeImage ($gray, $azimuth, $elevation) {} - - /** - * (PECL imagick 2.0.0)- * The width in pixels. - *
- * @param int $rows- * The height in pixels. - *
- * @param int $offset- * The image offset. - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function setSizeOffset ($columns, $rows, $offset) {} - - /** - * (PECL imagick 2.0.0)- * The radius of the Gaussian, in pixels, not counting the center pixel. - * Provide a value of 0 and the radius will be chosen automagically. - *
- * @param float $sigma- * The standard deviation of the Gaussian, in pixels. - *
- * @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 using bitwise operators. Defaults to Imagick::CHANNEL_DEFAULT. Refer to this list of channel constants - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function adaptiveBlurImage ($radius, $sigma, $channel = Imagick::CHANNEL_DEFAULT) {} - - /** - * (PECL imagick 2.0.0)- * The black point. - *
- * @param float $white_point- * The white point. - *
- * @param int $channel [optional]- * Provide any channel constant that is valid for your channel mode. To - * apply to more than one channel, combine channeltype constants using - * bitwise operators. Imagick::CHANNEL_ALL. Refer to this - * list of channel constants. - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function contrastStretchImage ($black_point, $white_point, $channel = Imagick::CHANNEL_ALL) {} - - /** - * (PECL imagick 2.0.0)- * The radius of the Gaussian, in pixels, not counting the center pixel. Use 0 for auto-select. - *
- * @param float $sigma- * The standard deviation of the Gaussian, in pixels. - *
- * @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 using bitwise operators. Defaults to Imagick::CHANNEL_DEFAULT. Refer to this list of channel constants - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function adaptiveSharpenImage ($radius, $sigma, $channel = Imagick::CHANNEL_DEFAULT) {} - - /** - * (PECL imagick 2.0.0)- * The low point - *
- * @param float $high- * The high point - *
- * @param int $channel [optional]- * Provide any channel constant that is valid for your channel mode. To - * apply to more than one channel, combine channeltype constants using - * bitwise operators. Refer to this - * list of channel constants. - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function randomThresholdImage ($low, $high, $channel = Imagick::CHANNEL_ALL) {} - - /** - * @param $xRounding - * @param $yRounding - * @param $strokeWidth [optional] - * @param $displace [optional] - * @param $sizeCorrection [optional] - * @throws ImagickException on error. - */ - public function roundCornersImage ($xRounding, $yRounding, $strokeWidth, $displace, $sizeCorrection) {} - - /** - * (PECL imagick 2.0.0)- * x rounding - *
- * @param float $y_rounding- * y rounding - *
- * @param float $stroke_width [optional]- * stroke width - *
- * @param float $displace [optional]- * image displace - *
- * @param float $size_correction [optional]- * size correction - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - #[Deprecated(replacement: "%class%->roundCornersImage(%parametersList%)")] - public function roundCorners ($x_rounding, $y_rounding, $stroke_width = 10.0, $displace = 5.0, $size_correction = -6.0) {} - - /** - * (PECL imagick 2.0.0)- * The position to set the iterator to - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function setIteratorIndex ($index) {} - - /** - * (PECL imagick 2.0.0)- * A crop geometry string. This geometry defines a subregion of the image to crop. - *
- * @param string $geometry- * An image geometry string. This geometry defines the final size of the image. - *
- * @return Imagick TRUE on success. - * @throws ImagickException on error. - */ - public function transformImage ($crop, $geometry) {} - - /** - * (PECL imagick 2.0.0)- * The level of transparency: 1.0 is fully opaque and 0.0 is fully - * transparent. - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function setImageOpacity ($opacity) {} - - /** - * (PECL imagick 2.2.2)- * A string containing the name of the threshold dither map to use - *
- * @param int $channel [optional]- * Provide any channel constant that is valid for your channel mode. To - * apply to more than one channel, combine channeltype constants using - * bitwise operators. Refer to this - * list of channel constants. - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function orderedPosterizeImage ($threshold_map, $channel = Imagick::CHANNEL_ALL) {} - - /** - * (PECL imagick 2.0.0)- * The polaroid properties - *
- * @param float $angle- * The polaroid angle - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function polaroidImage (ImagickDraw $properties, $angle) {} - - /** - * (PECL imagick 2.0.0)- * name of the property (for example Exif:DateTime) - *
- * @return string|false a string containing the image property, false if a - * property with the given name does not exist. - * @throws ImagickException on error. - */ - #[Pure] - public function getImageProperty ($name) {} - - /** - * (PECL imagick 2.0.0)- * The method is one of the Imagick::INTERPOLATE_* constants - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function setImageInterpolateMethod ($method) {} - - /** - * (PECL imagick 2.0.0)- * The image black point - *
- * @param float $whitePoint- * The image white point - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function linearStretchImage ($blackPoint, $whitePoint) {} - - /** - * (PECL imagick 2.0.0)- * The new width - *
- * @param int $height- * The new height - *
- * @param int $x- * X position for the new size - *
- * @param int $y- * Y position for the new size - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function extentImage ($width, $height, $x, $y) {} - - /** - * (PECL imagick 2.0.0)- * One of the orientation constants - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function setImageOrientation ($orientation) {} - - /** - * (PECL imagick 2.1.0)- * ImagickPixel object or a string containing the fill color - *
- * @param float $fuzz- * The amount of fuzz. For example, set fuzz to 10 and the color red at - * intensities of 100 and 102 respectively are now interpreted as the - * same color for the purposes of the floodfill. - *
- * @param mixed $bordercolor- * ImagickPixel object or a string containing the border color - *
- * @param int $x- * X start position of the floodfill - *
- * @param int $y- * Y start position of the floodfill - *
- * @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 using bitwise operators. Defaults to Imagick::CHANNEL_DEFAULT. Refer to this list of channel constants - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - #[Deprecated] - public function paintFloodfillImage ($fill, $fuzz, $bordercolor, $x, $y, $channel = Imagick::CHANNEL_ALL) {} - - /** - * (PECL imagick 2.0.0)- * Imagick object containing the color lookup table - *
- * @param int $channel [optional]- * The Channeltype - * constant. When not supplied, default channels are replaced. - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - * @since 2.0.0 - */ - public function clutImage (Imagick $lookup_table, $channel = Imagick::CHANNEL_DEFAULT) {} - - /** - * (PECL imagick 2.0.0)- * The pattern for property names. - *
- * @param bool $only_names [optional]- * Whether to return only property names. If FALSE then also the values are returned - *
- * @return array an array containing the image properties or property names. - * @throws ImagickException on error. - */ - #[Pure] - public function getImageProperties ($pattern = "*", $only_names = true) {} - - /** - * (PECL imagick 2.2.0)- * The pattern for profile names. - *
- * @param bool $include_values [optional]- * Whether to return only profile names. If FALSE then only profile names will be returned. - *
- * @return array an array containing the image profiles or profile names. - * @throws ImagickException on error. - */ - #[Pure] - public function getImageProfiles ($pattern = "*", $include_values = true) {} - - /** - * (PECL imagick 2.0.1)- * The method of image distortion. See distortion constants - *
- * @param array $arguments- * The arguments for this distortion method - *
- * @param bool $bestfit- * Attempt to resize destination to fit distorted source - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function distortImage ($method, array $arguments, $bestfit) {} - - /** - * (No version information available, might only be in SVN)- * Filehandle where to write the image - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function writeImageFile ($filehandle) {} - - /** - * (No version information available, might only be in SVN)- * Filehandle where to write the images - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function writeImagesFile ($filehandle) {} - - /** - * (No version information available, might only be in SVN)- * The page definition. For example 7168x5147+0+0 - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function resetImagePage ($page) {} - - /** - * (No version information available, might only be in SVN)- * The Imagick object containing the clip mask - *
- * @return bool TRUE on success. - */ - public function setImageClipMask (Imagick $clip_mask) {} - - /** - * (No version information available, might only be in SVN)- * X server address - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function animateImages ($x_server) {} - - /** - * (No version information available, might only be in SVN)- * The matrix containing the color values - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - #[Deprecated] - public function recolorImage (array $matrix) {} - - /** - * (PECL imagick 2.1.0)- * Font name or a filename - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function setFont ($font) {} - - /** - * (PECL imagick 2.1.0)- * Point size - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function setPointSize ($point_size) {} - - /** - * (No version information available, might only be in SVN)- * One of the Imagick::LAYERMETHOD_* constants - *
- * @return Imagick Returns an Imagick object containing the merged image. - * @throws ImagickException - */ - public function mergeImageLayers ($layer_method) {} - - /** - * (No version information available, might only be in SVN)- * One of the Imagick::ALPHACHANNEL_* constants - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function setImageAlphaChannel ($mode) {} - - /** - * (No version information available, might only be in SVN)- * ImagickPixel object or a string containing the fill color - *
- * @param float $fuzz- * The amount of fuzz. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color. - *
- * @param mixed $target- * ImagickPixel object or a string containing the target color to paint - *
- * @param int $x- * X start position of the floodfill - *
- * @param int $y- * Y start position of the floodfill - *
- * @param bool $invert- * If TRUE paints any pixel that does not match the target color. - *
- * @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 using bitwise operators. Defaults to Imagick::CHANNEL_DEFAULT. Refer to this list of channel constants - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function floodFillPaintImage ($fill, $fuzz, $target, $x, $y, $invert, $channel = Imagick::CHANNEL_DEFAULT) {} - - /** - * (No version information available, might only be in SVN)- * ImagickPixel object or a string containing the color to change - *
- * @param mixed $fill- * The replacement color - *
- * @param float $fuzz- * The amount of fuzz. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color. - *
- * @param bool $invert- * If TRUE paints any pixel that does not match the target color. - *
- * @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 using bitwise operators. Defaults to Imagick::CHANNEL_DEFAULT. Refer to this list of channel constants - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function opaquePaintImage ($target, $fill, $fuzz, $invert, $channel = Imagick::CHANNEL_DEFAULT) {} - - /** - * (No version information available, might only be in SVN)- * The target color to paint - *
- * @param float $alpha- * The level of transparency: 1.0 is fully opaque and 0.0 is fully transparent. - *
- * @param float $fuzz- * The amount of fuzz. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color. - *
- * @param bool $invert- * If TRUE paints any pixel that does not match the target color. - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function transparentPaintImage ($target, $alpha, $fuzz, $invert) {} - - /** - * (No version information available, might only be in SVN)- * The width of the target size - *
- * @param int $height- * The height of the target size - *
- * @param float $delta_x- * How much the seam can traverse on x-axis. - * Passing 0 causes the seams to be straight. - *
- * @param float $rigidity- * Introduces a bias for non-straight seams. This parameter is - * typically 0. - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function liquidRescaleImage ($width, $height, $delta_x, $rigidity) {} - - /** - * (No version information available, might only be in SVN)- * The passphrase - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function encipherImage ($passphrase) {} - - /** - * (No version information available, might only be in SVN)- * The passphrase - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function decipherImage ($passphrase) {} - - /** - * (No version information available, might only be in SVN)- * The gravity property. Refer to the list of - * gravity constants. - *
- * @return bool No value is returned. - * @throws ImagickException on error. - */ - public function setGravity ($gravity) {} - - /** - * (No version information available, might only be in SVN)- * Provide any channel constant that is valid for your channel mode. To apply to more than one channel, combine channel constants using bitwise operators. Defaults to Imagick::CHANNEL_DEFAULT. Refer to this list of channel constants - *
- * @return float[] an array containing minima and maxima values of the channel(s). - * @throws ImagickException on error. - */ +class Imagick implements Iterator, Countable +{ + public const COLOR_BLACK = 11; + public const COLOR_BLUE = 12; + public const COLOR_CYAN = 13; + public const COLOR_GREEN = 14; + public const COLOR_RED = 15; + public const COLOR_YELLOW = 16; + public const COLOR_MAGENTA = 17; + public const COLOR_OPACITY = 18; + public const COLOR_ALPHA = 19; + public const COLOR_FUZZ = 20; + public const IMAGICK_EXTNUM = 30403; + public const IMAGICK_EXTVER = "3.4.3"; + public const QUANTUM_RANGE = 65535; + public const USE_ZEND_MM = 0; + public const COMPOSITE_DEFAULT = 40; + public const COMPOSITE_UNDEFINED = 0; + public const COMPOSITE_NO = 1; + public const COMPOSITE_ADD = 2; + public const COMPOSITE_ATOP = 3; + public const COMPOSITE_BLEND = 4; + public const COMPOSITE_BUMPMAP = 5; + public const COMPOSITE_CLEAR = 7; + public const COMPOSITE_COLORBURN = 8; + public const COMPOSITE_COLORDODGE = 9; + public const COMPOSITE_COLORIZE = 10; + public const COMPOSITE_COPYBLACK = 11; + public const COMPOSITE_COPYBLUE = 12; + public const COMPOSITE_COPY = 13; + public const COMPOSITE_COPYCYAN = 14; + public const COMPOSITE_COPYGREEN = 15; + public const COMPOSITE_COPYMAGENTA = 16; + public const COMPOSITE_COPYOPACITY = 17; + public const COMPOSITE_COPYRED = 18; + public const COMPOSITE_COPYYELLOW = 19; + public const COMPOSITE_DARKEN = 20; + public const COMPOSITE_DSTATOP = 21; + public const COMPOSITE_DST = 22; + public const COMPOSITE_DSTIN = 23; + public const COMPOSITE_DSTOUT = 24; + public const COMPOSITE_DSTOVER = 25; + public const COMPOSITE_DIFFERENCE = 26; + public const COMPOSITE_DISPLACE = 27; + public const COMPOSITE_DISSOLVE = 28; + public const COMPOSITE_EXCLUSION = 29; + public const COMPOSITE_HARDLIGHT = 30; + public const COMPOSITE_HUE = 31; + public const COMPOSITE_IN = 32; + public const COMPOSITE_LIGHTEN = 33; + public const COMPOSITE_LUMINIZE = 35; + public const COMPOSITE_MINUS = 36; + public const COMPOSITE_MODULATE = 37; + public const COMPOSITE_MULTIPLY = 38; + public const COMPOSITE_OUT = 39; + public const COMPOSITE_OVER = 40; + public const COMPOSITE_OVERLAY = 41; + public const COMPOSITE_PLUS = 42; + public const COMPOSITE_REPLACE = 43; + public const COMPOSITE_SATURATE = 44; + public const COMPOSITE_SCREEN = 45; + public const COMPOSITE_SOFTLIGHT = 46; + public const COMPOSITE_SRCATOP = 47; + public const COMPOSITE_SRC = 48; + public const COMPOSITE_SRCIN = 49; + public const COMPOSITE_SRCOUT = 50; + public const COMPOSITE_SRCOVER = 51; + public const COMPOSITE_SUBTRACT = 52; + public const COMPOSITE_THRESHOLD = 53; + public const COMPOSITE_XOR = 54; + public const COMPOSITE_CHANGEMASK = 6; + public const COMPOSITE_LINEARLIGHT = 34; + public const COMPOSITE_DIVIDE = 55; + public const COMPOSITE_DISTORT = 56; + public const COMPOSITE_BLUR = 57; + public const COMPOSITE_PEGTOPLIGHT = 58; + public const COMPOSITE_VIVIDLIGHT = 59; + public const COMPOSITE_PINLIGHT = 60; + public const COMPOSITE_LINEARDODGE = 61; + public const COMPOSITE_LINEARBURN = 62; + public const COMPOSITE_MATHEMATICS = 63; + public const COMPOSITE_MODULUSADD = 2; + public const COMPOSITE_MODULUSSUBTRACT = 52; + public const COMPOSITE_MINUSDST = 36; + public const COMPOSITE_DIVIDEDST = 55; + public const COMPOSITE_DIVIDESRC = 64; + public const COMPOSITE_MINUSSRC = 65; + public const COMPOSITE_DARKENINTENSITY = 66; + public const COMPOSITE_LIGHTENINTENSITY = 67; + public const MONTAGEMODE_FRAME = 1; + public const MONTAGEMODE_UNFRAME = 2; + public const MONTAGEMODE_CONCATENATE = 3; + public const STYLE_NORMAL = 1; + public const STYLE_ITALIC = 2; + public const STYLE_OBLIQUE = 3; + public const STYLE_ANY = 4; + public const FILTER_UNDEFINED = 0; + public const FILTER_POINT = 1; + public const FILTER_BOX = 2; + public const FILTER_TRIANGLE = 3; + public const FILTER_HERMITE = 4; + public const FILTER_HANNING = 5; + public const FILTER_HAMMING = 6; + public const FILTER_BLACKMAN = 7; + public const FILTER_GAUSSIAN = 8; + public const FILTER_QUADRATIC = 9; + public const FILTER_CUBIC = 10; + public const FILTER_CATROM = 11; + public const FILTER_MITCHELL = 12; + public const FILTER_LANCZOS = 22; + public const FILTER_BESSEL = 13; + public const FILTER_SINC = 14; + public const FILTER_KAISER = 16; + public const FILTER_WELSH = 17; + public const FILTER_PARZEN = 18; + public const FILTER_LAGRANGE = 21; + public const FILTER_SENTINEL = 31; + public const FILTER_BOHMAN = 19; + public const FILTER_BARTLETT = 20; + public const FILTER_JINC = 13; + public const FILTER_SINCFAST = 15; + public const FILTER_ROBIDOUX = 26; + public const FILTER_LANCZOSSHARP = 23; + public const FILTER_LANCZOS2 = 24; + public const FILTER_LANCZOS2SHARP = 25; + public const FILTER_ROBIDOUXSHARP = 27; + public const FILTER_COSINE = 28; + public const FILTER_SPLINE = 29; + public const FILTER_LANCZOSRADIUS = 30; + public const IMGTYPE_UNDEFINED = 0; + public const IMGTYPE_BILEVEL = 1; + public const IMGTYPE_GRAYSCALE = 2; + public const IMGTYPE_GRAYSCALEMATTE = 3; + public const IMGTYPE_PALETTE = 4; + public const IMGTYPE_PALETTEMATTE = 5; + public const IMGTYPE_TRUECOLOR = 6; + public const IMGTYPE_TRUECOLORMATTE = 7; + public const IMGTYPE_COLORSEPARATION = 8; + public const IMGTYPE_COLORSEPARATIONMATTE = 9; + public const IMGTYPE_OPTIMIZE = 10; + public const IMGTYPE_PALETTEBILEVELMATTE = 11; + public const RESOLUTION_UNDEFINED = 0; + public const RESOLUTION_PIXELSPERINCH = 1; + public const RESOLUTION_PIXELSPERCENTIMETER = 2; + public const COMPRESSION_UNDEFINED = 0; + public const COMPRESSION_NO = 1; + public const COMPRESSION_BZIP = 2; + public const COMPRESSION_FAX = 6; + public const COMPRESSION_GROUP4 = 7; + public const COMPRESSION_JPEG = 8; + public const COMPRESSION_JPEG2000 = 9; + public const COMPRESSION_LOSSLESSJPEG = 10; + public const COMPRESSION_LZW = 11; + public const COMPRESSION_RLE = 12; + public const COMPRESSION_ZIP = 13; + public const COMPRESSION_DXT1 = 3; + public const COMPRESSION_DXT3 = 4; + public const COMPRESSION_DXT5 = 5; + public const COMPRESSION_ZIPS = 14; + public const COMPRESSION_PIZ = 15; + public const COMPRESSION_PXR24 = 16; + public const COMPRESSION_B44 = 17; + public const COMPRESSION_B44A = 18; + public const COMPRESSION_LZMA = 19; + public const COMPRESSION_JBIG1 = 20; + public const COMPRESSION_JBIG2 = 21; + public const PAINT_POINT = 1; + public const PAINT_REPLACE = 2; + public const PAINT_FLOODFILL = 3; + public const PAINT_FILLTOBORDER = 4; + public const PAINT_RESET = 5; + public const GRAVITY_NORTHWEST = 1; + public const GRAVITY_NORTH = 2; + public const GRAVITY_NORTHEAST = 3; + public const GRAVITY_WEST = 4; + public const GRAVITY_CENTER = 5; + public const GRAVITY_EAST = 6; + public const GRAVITY_SOUTHWEST = 7; + public const GRAVITY_SOUTH = 8; + public const GRAVITY_SOUTHEAST = 9; + public const GRAVITY_FORGET = 0; + public const GRAVITY_STATIC = 10; + public const STRETCH_NORMAL = 1; + public const STRETCH_ULTRACONDENSED = 2; + public const STRETCH_EXTRACONDENSED = 3; + public const STRETCH_CONDENSED = 4; + public const STRETCH_SEMICONDENSED = 5; + public const STRETCH_SEMIEXPANDED = 6; + public const STRETCH_EXPANDED = 7; + public const STRETCH_EXTRAEXPANDED = 8; + public const STRETCH_ULTRAEXPANDED = 9; + public const STRETCH_ANY = 10; + public const ALIGN_UNDEFINED = 0; + public const ALIGN_LEFT = 1; + public const ALIGN_CENTER = 2; + public const ALIGN_RIGHT = 3; + public const DECORATION_NO = 1; + public const DECORATION_UNDERLINE = 2; + public const DECORATION_OVERLINE = 3; + public const DECORATION_LINETROUGH = 4; + public const DECORATION_LINETHROUGH = 4; + public const NOISE_UNIFORM = 1; + public const NOISE_GAUSSIAN = 2; + public const NOISE_MULTIPLICATIVEGAUSSIAN = 3; + public const NOISE_IMPULSE = 4; + public const NOISE_LAPLACIAN = 5; + public const NOISE_POISSON = 6; + public const NOISE_RANDOM = 7; + public const CHANNEL_UNDEFINED = 0; + public const CHANNEL_RED = 1; + public const CHANNEL_GRAY = 1; + public const CHANNEL_CYAN = 1; + public const CHANNEL_GREEN = 2; + public const CHANNEL_MAGENTA = 2; + public const CHANNEL_BLUE = 4; + public const CHANNEL_YELLOW = 4; + public const CHANNEL_ALPHA = 8; + public const CHANNEL_OPACITY = 8; + public const CHANNEL_MATTE = 8; + public const CHANNEL_BLACK = 32; + public const CHANNEL_INDEX = 32; + public const CHANNEL_ALL = 134217727; + public const CHANNEL_DEFAULT = 134217719; + public const CHANNEL_RGBA = 15; + public const CHANNEL_TRUEALPHA = 64; + public const CHANNEL_RGBS = 128; + public const CHANNEL_GRAY_CHANNELS = 128; + public const CHANNEL_SYNC = 256; + public const CHANNEL_COMPOSITES = 47; + public const METRIC_UNDEFINED = 0; + public const METRIC_ABSOLUTEERRORMETRIC = 1; + public const METRIC_MEANABSOLUTEERROR = 2; + public const METRIC_MEANERRORPERPIXELMETRIC = 3; + public const METRIC_MEANSQUAREERROR = 4; + public const METRIC_PEAKABSOLUTEERROR = 5; + public const METRIC_PEAKSIGNALTONOISERATIO = 6; + public const METRIC_ROOTMEANSQUAREDERROR = 7; + public const METRIC_NORMALIZEDCROSSCORRELATIONERRORMETRIC = 8; + public const METRIC_FUZZERROR = 9; + public const PIXEL_CHAR = 1; + public const PIXEL_DOUBLE = 2; + public const PIXEL_FLOAT = 3; + public const PIXEL_INTEGER = 4; + public const PIXEL_LONG = 5; + public const PIXEL_QUANTUM = 6; + public const PIXEL_SHORT = 7; + public const EVALUATE_UNDEFINED = 0; + public const EVALUATE_ADD = 1; + public const EVALUATE_AND = 2; + public const EVALUATE_DIVIDE = 3; + public const EVALUATE_LEFTSHIFT = 4; + public const EVALUATE_MAX = 5; + public const EVALUATE_MIN = 6; + public const EVALUATE_MULTIPLY = 7; + public const EVALUATE_OR = 8; + public const EVALUATE_RIGHTSHIFT = 9; + public const EVALUATE_SET = 10; + public const EVALUATE_SUBTRACT = 11; + public const EVALUATE_XOR = 12; + public const EVALUATE_POW = 13; + public const EVALUATE_LOG = 14; + public const EVALUATE_THRESHOLD = 15; + public const EVALUATE_THRESHOLDBLACK = 16; + public const EVALUATE_THRESHOLDWHITE = 17; + public const EVALUATE_GAUSSIANNOISE = 18; + public const EVALUATE_IMPULSENOISE = 19; + public const EVALUATE_LAPLACIANNOISE = 20; + public const EVALUATE_MULTIPLICATIVENOISE = 21; + public const EVALUATE_POISSONNOISE = 22; + public const EVALUATE_UNIFORMNOISE = 23; + public const EVALUATE_COSINE = 24; + public const EVALUATE_SINE = 25; + public const EVALUATE_ADDMODULUS = 26; + public const EVALUATE_MEAN = 27; + public const EVALUATE_ABS = 28; + public const EVALUATE_EXPONENTIAL = 29; + public const EVALUATE_MEDIAN = 30; + public const EVALUATE_SUM = 31; + public const COLORSPACE_UNDEFINED = 0; + public const COLORSPACE_RGB = 1; + public const COLORSPACE_GRAY = 2; + public const COLORSPACE_TRANSPARENT = 3; + public const COLORSPACE_OHTA = 4; + public const COLORSPACE_LAB = 5; + public const COLORSPACE_XYZ = 6; + public const COLORSPACE_YCBCR = 7; + public const COLORSPACE_YCC = 8; + public const COLORSPACE_YIQ = 9; + public const COLORSPACE_YPBPR = 10; + public const COLORSPACE_YUV = 11; + public const COLORSPACE_CMYK = 12; + public const COLORSPACE_SRGB = 13; + public const COLORSPACE_HSB = 14; + public const COLORSPACE_HSL = 15; + public const COLORSPACE_HWB = 16; + public const COLORSPACE_REC601LUMA = 17; + public const COLORSPACE_REC709LUMA = 19; + public const COLORSPACE_LOG = 21; + public const COLORSPACE_CMY = 22; + public const COLORSPACE_LUV = 23; + public const COLORSPACE_HCL = 24; + public const COLORSPACE_LCH = 25; + public const COLORSPACE_LMS = 26; + public const COLORSPACE_LCHAB = 27; + public const COLORSPACE_LCHUV = 28; + public const COLORSPACE_SCRGB = 29; + public const COLORSPACE_HSI = 30; + public const COLORSPACE_HSV = 31; + public const COLORSPACE_HCLP = 32; + public const COLORSPACE_YDBDR = 33; + public const COLORSPACE_REC601YCBCR = 18; + public const COLORSPACE_REC709YCBCR = 20; + public const VIRTUALPIXELMETHOD_UNDEFINED = 0; + public const VIRTUALPIXELMETHOD_BACKGROUND = 1; + public const VIRTUALPIXELMETHOD_CONSTANT = 2; + public const VIRTUALPIXELMETHOD_EDGE = 4; + public const VIRTUALPIXELMETHOD_MIRROR = 5; + public const VIRTUALPIXELMETHOD_TILE = 7; + public const VIRTUALPIXELMETHOD_TRANSPARENT = 8; + public const VIRTUALPIXELMETHOD_MASK = 9; + public const VIRTUALPIXELMETHOD_BLACK = 10; + public const VIRTUALPIXELMETHOD_GRAY = 11; + public const VIRTUALPIXELMETHOD_WHITE = 12; + public const VIRTUALPIXELMETHOD_HORIZONTALTILE = 13; + public const VIRTUALPIXELMETHOD_VERTICALTILE = 14; + public const VIRTUALPIXELMETHOD_HORIZONTALTILEEDGE = 15; + public const VIRTUALPIXELMETHOD_VERTICALTILEEDGE = 16; + public const VIRTUALPIXELMETHOD_CHECKERTILE = 17; + public const PREVIEW_UNDEFINED = 0; + public const PREVIEW_ROTATE = 1; + public const PREVIEW_SHEAR = 2; + public const PREVIEW_ROLL = 3; + public const PREVIEW_HUE = 4; + public const PREVIEW_SATURATION = 5; + public const PREVIEW_BRIGHTNESS = 6; + public const PREVIEW_GAMMA = 7; + public const PREVIEW_SPIFF = 8; + public const PREVIEW_DULL = 9; + public const PREVIEW_GRAYSCALE = 10; + public const PREVIEW_QUANTIZE = 11; + public const PREVIEW_DESPECKLE = 12; + public const PREVIEW_REDUCENOISE = 13; + public const PREVIEW_ADDNOISE = 14; + public const PREVIEW_SHARPEN = 15; + public const PREVIEW_BLUR = 16; + public const PREVIEW_THRESHOLD = 17; + public const PREVIEW_EDGEDETECT = 18; + public const PREVIEW_SPREAD = 19; + public const PREVIEW_SOLARIZE = 20; + public const PREVIEW_SHADE = 21; + public const PREVIEW_RAISE = 22; + public const PREVIEW_SEGMENT = 23; + public const PREVIEW_SWIRL = 24; + public const PREVIEW_IMPLODE = 25; + public const PREVIEW_WAVE = 26; + public const PREVIEW_OILPAINT = 27; + public const PREVIEW_CHARCOALDRAWING = 28; + public const PREVIEW_JPEG = 29; + public const RENDERINGINTENT_UNDEFINED = 0; + public const RENDERINGINTENT_SATURATION = 1; + public const RENDERINGINTENT_PERCEPTUAL = 2; + public const RENDERINGINTENT_ABSOLUTE = 3; + public const RENDERINGINTENT_RELATIVE = 4; + public const INTERLACE_UNDEFINED = 0; + public const INTERLACE_NO = 1; + public const INTERLACE_LINE = 2; + public const INTERLACE_PLANE = 3; + public const INTERLACE_PARTITION = 4; + public const INTERLACE_GIF = 5; + public const INTERLACE_JPEG = 6; + public const INTERLACE_PNG = 7; + public const FILLRULE_UNDEFINED = 0; + public const FILLRULE_EVENODD = 1; + public const FILLRULE_NONZERO = 2; + public const PATHUNITS_UNDEFINED = 0; + public const PATHUNITS_USERSPACE = 1; + public const PATHUNITS_USERSPACEONUSE = 2; + public const PATHUNITS_OBJECTBOUNDINGBOX = 3; + public const LINECAP_UNDEFINED = 0; + public const LINECAP_BUTT = 1; + public const LINECAP_ROUND = 2; + public const LINECAP_SQUARE = 3; + public const LINEJOIN_UNDEFINED = 0; + public const LINEJOIN_MITER = 1; + public const LINEJOIN_ROUND = 2; + public const LINEJOIN_BEVEL = 3; + public const RESOURCETYPE_UNDEFINED = 0; + public const RESOURCETYPE_AREA = 1; + public const RESOURCETYPE_DISK = 2; + public const RESOURCETYPE_FILE = 3; + public const RESOURCETYPE_MAP = 4; + public const RESOURCETYPE_MEMORY = 5; + public const RESOURCETYPE_TIME = 7; + public const RESOURCETYPE_THROTTLE = 8; + public const RESOURCETYPE_THREAD = 6; + public const DISPOSE_UNRECOGNIZED = 0; + public const DISPOSE_UNDEFINED = 0; + public const DISPOSE_NONE = 1; + public const DISPOSE_BACKGROUND = 2; + public const DISPOSE_PREVIOUS = 3; + public const INTERPOLATE_UNDEFINED = 0; + public const INTERPOLATE_AVERAGE = 1; + public const INTERPOLATE_BICUBIC = 2; + public const INTERPOLATE_BILINEAR = 3; + public const INTERPOLATE_FILTER = 4; + public const INTERPOLATE_INTEGER = 5; + public const INTERPOLATE_MESH = 6; + public const INTERPOLATE_NEARESTNEIGHBOR = 7; + public const INTERPOLATE_SPLINE = 8; + public const LAYERMETHOD_UNDEFINED = 0; + public const LAYERMETHOD_COALESCE = 1; + public const LAYERMETHOD_COMPAREANY = 2; + public const LAYERMETHOD_COMPARECLEAR = 3; + public const LAYERMETHOD_COMPAREOVERLAY = 4; + public const LAYERMETHOD_DISPOSE = 5; + public const LAYERMETHOD_OPTIMIZE = 6; + public const LAYERMETHOD_OPTIMIZEPLUS = 8; + public const LAYERMETHOD_OPTIMIZETRANS = 9; + public const LAYERMETHOD_COMPOSITE = 12; + public const LAYERMETHOD_OPTIMIZEIMAGE = 7; + public const LAYERMETHOD_REMOVEDUPS = 10; + public const LAYERMETHOD_REMOVEZERO = 11; + public const LAYERMETHOD_TRIMBOUNDS = 16; + public const ORIENTATION_UNDEFINED = 0; + public const ORIENTATION_TOPLEFT = 1; + public const ORIENTATION_TOPRIGHT = 2; + public const ORIENTATION_BOTTOMRIGHT = 3; + public const ORIENTATION_BOTTOMLEFT = 4; + public const ORIENTATION_LEFTTOP = 5; + public const ORIENTATION_RIGHTTOP = 6; + public const ORIENTATION_RIGHTBOTTOM = 7; + public const ORIENTATION_LEFTBOTTOM = 8; + public const DISTORTION_UNDEFINED = 0; + public const DISTORTION_AFFINE = 1; + public const DISTORTION_AFFINEPROJECTION = 2; + public const DISTORTION_ARC = 9; + public const DISTORTION_BILINEAR = 6; + public const DISTORTION_PERSPECTIVE = 4; + public const DISTORTION_PERSPECTIVEPROJECTION = 5; + public const DISTORTION_SCALEROTATETRANSLATE = 3; + public const DISTORTION_POLYNOMIAL = 8; + public const DISTORTION_POLAR = 10; + public const DISTORTION_DEPOLAR = 11; + public const DISTORTION_BARREL = 14; + public const DISTORTION_SHEPARDS = 16; + public const DISTORTION_SENTINEL = 18; + public const DISTORTION_BARRELINVERSE = 15; + public const DISTORTION_BILINEARFORWARD = 6; + public const DISTORTION_BILINEARREVERSE = 7; + public const DISTORTION_RESIZE = 17; + public const DISTORTION_CYLINDER2PLANE = 12; + public const DISTORTION_PLANE2CYLINDER = 13; + public const LAYERMETHOD_MERGE = 13; + public const LAYERMETHOD_FLATTEN = 14; + public const LAYERMETHOD_MOSAIC = 15; + public const ALPHACHANNEL_ACTIVATE = 1; + public const ALPHACHANNEL_RESET = 7; + public const ALPHACHANNEL_SET = 8; + public const ALPHACHANNEL_UNDEFINED = 0; + public const ALPHACHANNEL_COPY = 3; + public const ALPHACHANNEL_DEACTIVATE = 4; + public const ALPHACHANNEL_EXTRACT = 5; + public const ALPHACHANNEL_OPAQUE = 6; + public const ALPHACHANNEL_SHAPE = 9; + public const ALPHACHANNEL_TRANSPARENT = 10; + public const SPARSECOLORMETHOD_UNDEFINED = 0; + public const SPARSECOLORMETHOD_BARYCENTRIC = 1; + public const SPARSECOLORMETHOD_BILINEAR = 7; + public const SPARSECOLORMETHOD_POLYNOMIAL = 8; + public const SPARSECOLORMETHOD_SPEPARDS = 16; + public const SPARSECOLORMETHOD_VORONOI = 18; + public const SPARSECOLORMETHOD_INVERSE = 19; + public const DITHERMETHOD_UNDEFINED = 0; + public const DITHERMETHOD_NO = 1; + public const DITHERMETHOD_RIEMERSMA = 2; + public const DITHERMETHOD_FLOYDSTEINBERG = 3; + public const FUNCTION_UNDEFINED = 0; + public const FUNCTION_POLYNOMIAL = 1; + public const FUNCTION_SINUSOID = 2; + public const ALPHACHANNEL_BACKGROUND = 2; + public const FUNCTION_ARCSIN = 3; + public const FUNCTION_ARCTAN = 4; + public const ALPHACHANNEL_FLATTEN = 11; + public const ALPHACHANNEL_REMOVE = 12; + public const STATISTIC_GRADIENT = 1; + public const STATISTIC_MAXIMUM = 2; + public const STATISTIC_MEAN = 3; + public const STATISTIC_MEDIAN = 4; + public const STATISTIC_MINIMUM = 5; + public const STATISTIC_MODE = 6; + public const STATISTIC_NONPEAK = 7; + public const STATISTIC_STANDARD_DEVIATION = 8; + public const MORPHOLOGY_CONVOLVE = 1; + public const MORPHOLOGY_CORRELATE = 2; + public const MORPHOLOGY_ERODE = 3; + public const MORPHOLOGY_DILATE = 4; + public const MORPHOLOGY_ERODE_INTENSITY = 5; + public const MORPHOLOGY_DILATE_INTENSITY = 6; + public const MORPHOLOGY_DISTANCE = 7; + public const MORPHOLOGY_OPEN = 8; + public const MORPHOLOGY_CLOSE = 9; + public const MORPHOLOGY_OPEN_INTENSITY = 10; + public const MORPHOLOGY_CLOSE_INTENSITY = 11; + public const MORPHOLOGY_SMOOTH = 12; + public const MORPHOLOGY_EDGE_IN = 13; + public const MORPHOLOGY_EDGE_OUT = 14; + public const MORPHOLOGY_EDGE = 15; + public const MORPHOLOGY_TOP_HAT = 16; + public const MORPHOLOGY_BOTTOM_HAT = 17; + public const MORPHOLOGY_HIT_AND_MISS = 18; + public const MORPHOLOGY_THINNING = 19; + public const MORPHOLOGY_THICKEN = 20; + public const MORPHOLOGY_VORONOI = 21; + public const MORPHOLOGY_ITERATIVE = 22; + public const KERNEL_UNITY = 1; + public const KERNEL_GAUSSIAN = 2; + public const KERNEL_DIFFERENCE_OF_GAUSSIANS = 3; + public const KERNEL_LAPLACIAN_OF_GAUSSIANS = 4; + public const KERNEL_BLUR = 5; + public const KERNEL_COMET = 6; + public const KERNEL_LAPLACIAN = 7; + public const KERNEL_SOBEL = 8; + public const KERNEL_FREI_CHEN = 9; + public const KERNEL_ROBERTS = 10; + public const KERNEL_PREWITT = 11; + public const KERNEL_COMPASS = 12; + public const KERNEL_KIRSCH = 13; + public const KERNEL_DIAMOND = 14; + public const KERNEL_SQUARE = 15; + public const KERNEL_RECTANGLE = 16; + public const KERNEL_OCTAGON = 17; + public const KERNEL_DISK = 18; + public const KERNEL_PLUS = 19; + public const KERNEL_CROSS = 20; + public const KERNEL_RING = 21; + public const KERNEL_PEAKS = 22; + public const KERNEL_EDGES = 23; + public const KERNEL_CORNERS = 24; + public const KERNEL_DIAGONALS = 25; + public const KERNEL_LINE_ENDS = 26; + public const KERNEL_LINE_JUNCTIONS = 27; + public const KERNEL_RIDGES = 28; + public const KERNEL_CONVEX_HULL = 29; + public const KERNEL_THIN_SE = 30; + public const KERNEL_SKELETON = 31; + public const KERNEL_CHEBYSHEV = 32; + public const KERNEL_MANHATTAN = 33; + public const KERNEL_OCTAGONAL = 34; + public const KERNEL_EUCLIDEAN = 35; + public const KERNEL_USER_DEFINED = 36; + public const KERNEL_BINOMIAL = 37; + public const DIRECTION_LEFT_TO_RIGHT = 2; + public const DIRECTION_RIGHT_TO_LEFT = 1; + public const NORMALIZE_KERNEL_NONE = 0; + public const NORMALIZE_KERNEL_VALUE = 8192; + public const NORMALIZE_KERNEL_CORRELATE = 65536; + public const NORMALIZE_KERNEL_PERCENT = 4096; + + /** + * (PECL imagick 2.0.0)+ * One of the layer method constants. + *
+ * @return Imagick TRUE on success. + * @throws ImagickException on error. + */ + public function compareImageLayers($method) {} + + /** + * (PECL imagick 2.0.0)+ * A string containing the image. + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function pingImageBlob($image) {} + + /** + * (PECL imagick 2.0.0)+ * An open filehandle to the image. + *
+ * @param string $fileName [optional]+ * Optional filename for this image. + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function pingImageFile($filehandle, $fileName = null) {} + + /** + * (PECL imagick 2.0.0)+ * By default target must match a particular pixel color exactly. + * However, in many cases two colors may differ by a small amount. + * The fuzz member of image defines how much tolerance is acceptable + * to consider two colors as the same. This parameter represents the variation + * on the quantum range. + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function trimImage($fuzz) {} + + /** + * (PECL imagick 2.0.0)+ * The amplitude of the wave. + *
+ * @param float $length+ * The length of the wave. + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function waveImage($amplitude, $length) {} + + /** + * (PECL imagick 2.0.0)+ * The black point. + *
+ * @param float $whitePoint+ * The white point + *
+ * @param int $x+ * X offset of the ellipse + *
+ * @param int $y+ * Y offset of the ellipse + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function vignetteImage($blackPoint, $whitePoint, $x, $y) {} + + /** + * (PECL imagick 2.0.0)+ * True activates the matte channel and false disables it. + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function setImageMatte($matte) {} + + /** + * Adaptively resize image with data dependent triangulation + * + * If legacy is true, the calculations are done with the small rounding bug that existed in Imagick before 3.4.0.+ * The radius of the Gaussian, in pixels, not counting the center pixel + *
+ * @param float $sigma+ * The standard deviation of the Gaussian, in pixels. + *
+ * @param float $angle+ * Apply the effect along this angle. + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function sketchImage($radius, $sigma, $angle) {} + + /** + * (PECL imagick 2.0.0)+ * A value other than zero shades the intensity of each pixel. + *
+ * @param float $azimuth+ * Defines the light source direction. + *
+ * @param float $elevation+ * Defines the light source direction. + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function shadeImage($gray, $azimuth, $elevation) {} + + /** + * (PECL imagick 2.0.0)+ * The width in pixels. + *
+ * @param int $rows+ * The height in pixels. + *
+ * @param int $offset+ * The image offset. + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function setSizeOffset($columns, $rows, $offset) {} + + /** + * (PECL imagick 2.0.0)+ * The radius of the Gaussian, in pixels, not counting the center pixel. + * Provide a value of 0 and the radius will be chosen automagically. + *
+ * @param float $sigma+ * The standard deviation of the Gaussian, in pixels. + *
+ * @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 using bitwise operators. Defaults to Imagick::CHANNEL_DEFAULT. Refer to this list of channel constants + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function adaptiveBlurImage($radius, $sigma, $channel = Imagick::CHANNEL_DEFAULT) {} + + /** + * (PECL imagick 2.0.0)+ * The black point. + *
+ * @param float $white_point+ * The white point. + *
+ * @param int $channel [optional]+ * Provide any channel constant that is valid for your channel mode. To + * apply to more than one channel, combine channeltype constants using + * bitwise operators. Imagick::CHANNEL_ALL. Refer to this + * list of channel constants. + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function contrastStretchImage($black_point, $white_point, $channel = Imagick::CHANNEL_ALL) {} + + /** + * (PECL imagick 2.0.0)+ * The radius of the Gaussian, in pixels, not counting the center pixel. Use 0 for auto-select. + *
+ * @param float $sigma+ * The standard deviation of the Gaussian, in pixels. + *
+ * @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 using bitwise operators. Defaults to Imagick::CHANNEL_DEFAULT. Refer to this list of channel constants + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function adaptiveSharpenImage($radius, $sigma, $channel = Imagick::CHANNEL_DEFAULT) {} + + /** + * (PECL imagick 2.0.0)+ * The low point + *
+ * @param float $high+ * The high point + *
+ * @param int $channel [optional]+ * Provide any channel constant that is valid for your channel mode. To + * apply to more than one channel, combine channeltype constants using + * bitwise operators. Refer to this + * list of channel constants. + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function randomThresholdImage($low, $high, $channel = Imagick::CHANNEL_ALL) {} + + /** + * @param $xRounding + * @param $yRounding + * @param $strokeWidth [optional] + * @param $displace [optional] + * @param $sizeCorrection [optional] + * @throws ImagickException on error. + */ + public function roundCornersImage($xRounding, $yRounding, $strokeWidth, $displace, $sizeCorrection) {} + + /** + * (PECL imagick 2.0.0)+ * x rounding + *
+ * @param float $y_rounding+ * y rounding + *
+ * @param float $stroke_width [optional]+ * stroke width + *
+ * @param float $displace [optional]+ * image displace + *
+ * @param float $size_correction [optional]+ * size correction + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + #[Deprecated(replacement: "%class%->roundCornersImage(%parametersList%)")] + public function roundCorners($x_rounding, $y_rounding, $stroke_width = 10.0, $displace = 5.0, $size_correction = -6.0) {} + + /** + * (PECL imagick 2.0.0)+ * The position to set the iterator to + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function setIteratorIndex($index) {} + + /** + * (PECL imagick 2.0.0)+ * A crop geometry string. This geometry defines a subregion of the image to crop. + *
+ * @param string $geometry+ * An image geometry string. This geometry defines the final size of the image. + *
+ * @return Imagick TRUE on success. + * @throws ImagickException on error. + */ + public function transformImage($crop, $geometry) {} + + /** + * (PECL imagick 2.0.0)+ * The level of transparency: 1.0 is fully opaque and 0.0 is fully + * transparent. + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function setImageOpacity($opacity) {} + + /** + * (PECL imagick 2.2.2)+ * A string containing the name of the threshold dither map to use + *
+ * @param int $channel [optional]+ * Provide any channel constant that is valid for your channel mode. To + * apply to more than one channel, combine channeltype constants using + * bitwise operators. Refer to this + * list of channel constants. + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function orderedPosterizeImage($threshold_map, $channel = Imagick::CHANNEL_ALL) {} + + /** + * (PECL imagick 2.0.0)+ * The polaroid properties + *
+ * @param float $angle+ * The polaroid angle + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function polaroidImage(ImagickDraw $properties, $angle) {} + + /** + * (PECL imagick 2.0.0)+ * name of the property (for example Exif:DateTime) + *
+ * @return string|false a string containing the image property, false if a + * property with the given name does not exist. + * @throws ImagickException on error. + */ + #[Pure] + public function getImageProperty($name) {} + + /** + * (PECL imagick 2.0.0)+ * The method is one of the Imagick::INTERPOLATE_* constants + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function setImageInterpolateMethod($method) {} + + /** + * (PECL imagick 2.0.0)+ * The image black point + *
+ * @param float $whitePoint+ * The image white point + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function linearStretchImage($blackPoint, $whitePoint) {} + + /** + * (PECL imagick 2.0.0)+ * The new width + *
+ * @param int $height+ * The new height + *
+ * @param int $x+ * X position for the new size + *
+ * @param int $y+ * Y position for the new size + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function extentImage($width, $height, $x, $y) {} + + /** + * (PECL imagick 2.0.0)+ * One of the orientation constants + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function setImageOrientation($orientation) {} + + /** + * (PECL imagick 2.1.0)+ * ImagickPixel object or a string containing the fill color + *
+ * @param float $fuzz+ * The amount of fuzz. For example, set fuzz to 10 and the color red at + * intensities of 100 and 102 respectively are now interpreted as the + * same color for the purposes of the floodfill. + *
+ * @param mixed $bordercolor+ * ImagickPixel object or a string containing the border color + *
+ * @param int $x+ * X start position of the floodfill + *
+ * @param int $y+ * Y start position of the floodfill + *
+ * @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 using bitwise operators. Defaults to Imagick::CHANNEL_DEFAULT. Refer to this list of channel constants + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + #[Deprecated] + public function paintFloodfillImage($fill, $fuzz, $bordercolor, $x, $y, $channel = Imagick::CHANNEL_ALL) {} + + /** + * (PECL imagick 2.0.0)+ * Imagick object containing the color lookup table + *
+ * @param int $channel [optional]+ * The Channeltype + * constant. When not supplied, default channels are replaced. + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + * @since 2.0.0 + */ + public function clutImage(Imagick $lookup_table, $channel = Imagick::CHANNEL_DEFAULT) {} + + /** + * (PECL imagick 2.0.0)+ * The pattern for property names. + *
+ * @param bool $only_names [optional]+ * Whether to return only property names. If FALSE then also the values are returned + *
+ * @return array an array containing the image properties or property names. + * @throws ImagickException on error. + */ + #[Pure] + public function getImageProperties($pattern = "*", $only_names = true) {} + + /** + * (PECL imagick 2.2.0)+ * The pattern for profile names. + *
+ * @param bool $include_values [optional]+ * Whether to return only profile names. If FALSE then only profile names will be returned. + *
+ * @return array an array containing the image profiles or profile names. + * @throws ImagickException on error. + */ + #[Pure] + public function getImageProfiles($pattern = "*", $include_values = true) {} + + /** + * (PECL imagick 2.0.1)+ * The method of image distortion. See distortion constants + *
+ * @param array $arguments+ * The arguments for this distortion method + *
+ * @param bool $bestfit+ * Attempt to resize destination to fit distorted source + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function distortImage($method, array $arguments, $bestfit) {} + + /** + * (No version information available, might only be in SVN)+ * Filehandle where to write the image + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function writeImageFile($filehandle) {} + + /** + * (No version information available, might only be in SVN)+ * Filehandle where to write the images + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function writeImagesFile($filehandle) {} + + /** + * (No version information available, might only be in SVN)+ * The page definition. For example 7168x5147+0+0 + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function resetImagePage($page) {} + + /** + * (No version information available, might only be in SVN)+ * The Imagick object containing the clip mask + *
+ * @return bool TRUE on success. + */ + public function setImageClipMask(Imagick $clip_mask) {} + + /** + * (No version information available, might only be in SVN)+ * X server address + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function animateImages($x_server) {} + + /** + * (No version information available, might only be in SVN)+ * The matrix containing the color values + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + #[Deprecated] + public function recolorImage(array $matrix) {} + + /** + * (PECL imagick 2.1.0)+ * Font name or a filename + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function setFont($font) {} + + /** + * (PECL imagick 2.1.0)+ * Point size + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function setPointSize($point_size) {} + + /** + * (No version information available, might only be in SVN)+ * One of the Imagick::LAYERMETHOD_* constants + *
+ * @return Imagick Returns an Imagick object containing the merged image. + * @throws ImagickException + */ + public function mergeImageLayers($layer_method) {} + + /** + * (No version information available, might only be in SVN)+ * One of the Imagick::ALPHACHANNEL_* constants + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function setImageAlphaChannel($mode) {} + + /** + * (No version information available, might only be in SVN)+ * ImagickPixel object or a string containing the fill color + *
+ * @param float $fuzz+ * The amount of fuzz. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color. + *
+ * @param mixed $target+ * ImagickPixel object or a string containing the target color to paint + *
+ * @param int $x+ * X start position of the floodfill + *
+ * @param int $y+ * Y start position of the floodfill + *
+ * @param bool $invert+ * If TRUE paints any pixel that does not match the target color. + *
+ * @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 using bitwise operators. Defaults to Imagick::CHANNEL_DEFAULT. Refer to this list of channel constants + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function floodFillPaintImage($fill, $fuzz, $target, $x, $y, $invert, $channel = Imagick::CHANNEL_DEFAULT) {} + + /** + * (No version information available, might only be in SVN)+ * ImagickPixel object or a string containing the color to change + *
+ * @param mixed $fill+ * The replacement color + *
+ * @param float $fuzz+ * The amount of fuzz. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color. + *
+ * @param bool $invert+ * If TRUE paints any pixel that does not match the target color. + *
+ * @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 using bitwise operators. Defaults to Imagick::CHANNEL_DEFAULT. Refer to this list of channel constants + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function opaquePaintImage($target, $fill, $fuzz, $invert, $channel = Imagick::CHANNEL_DEFAULT) {} + + /** + * (No version information available, might only be in SVN)+ * The target color to paint + *
+ * @param float $alpha+ * The level of transparency: 1.0 is fully opaque and 0.0 is fully transparent. + *
+ * @param float $fuzz+ * The amount of fuzz. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color. + *
+ * @param bool $invert+ * If TRUE paints any pixel that does not match the target color. + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function transparentPaintImage($target, $alpha, $fuzz, $invert) {} + + /** + * (No version information available, might only be in SVN)+ * The width of the target size + *
+ * @param int $height+ * The height of the target size + *
+ * @param float $delta_x+ * How much the seam can traverse on x-axis. + * Passing 0 causes the seams to be straight. + *
+ * @param float $rigidity+ * Introduces a bias for non-straight seams. This parameter is + * typically 0. + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function liquidRescaleImage($width, $height, $delta_x, $rigidity) {} + + /** + * (No version information available, might only be in SVN)+ * The passphrase + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function encipherImage($passphrase) {} + + /** + * (No version information available, might only be in SVN)+ * The passphrase + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function decipherImage($passphrase) {} + + /** + * (No version information available, might only be in SVN)+ * The gravity property. Refer to the list of + * gravity constants. + *
+ * @return bool No value is returned. + * @throws ImagickException on error. + */ + public function setGravity($gravity) {} + + /** + * (No version information available, might only be in SVN)+ * Provide any channel constant that is valid for your channel mode. To apply to more than one channel, combine channel constants using bitwise operators. Defaults to Imagick::CHANNEL_DEFAULT. Refer to this list of channel constants + *
+ * @return float[] an array containing minima and maxima values of the channel(s). + * @throws ImagickException on error. + */ #[ArrayShape([ "minima" => "float", "maxima" => "float" ])] - #[Pure] - public function getImageChannelRange ($channel) {} - - /** - * (No version information available, might only be in SVN)- * Imagick object containing the reference image - *
- * @param int $metric- * Refer to this list of metric type constants. - *
- * @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 using bitwise operators. Defaults to Imagick::CHANNEL_DEFAULT. Refer to this list of channel constants - *
- * @return float a float describing the channel distortion. - * @throws ImagickException on error. - */ - #[Pure] - public function getImageChannelDistortions (Imagick $reference, $metric, $channel = Imagick::CHANNEL_DEFAULT) {} - - /** - * (No version information available, might only be in SVN)- * The gravity property. Refer to the list of - * gravity constants. - *
- * @return bool No value is returned. - * @throws ImagickException on error. - */ - public function setImageGravity ($gravity) {} - - /** - * (No version information available, might only be in SVN)- * The image x position - *
- * @param int $y- * The image y position - *
- * @param int $width- * The image width - *
- * @param int $height- * The image height - *
- * @param string $map- * Map of pixel ordering as a string. This can be for example RGB. - * The value can be any combination or order of R = red, G = green, B = blue, A = alpha (0 is transparent), - * O = opacity (0 is opaque), C = cyan, Y = yellow, M = magenta, K = black, I = intensity (for grayscale), P = pad. - *
- * @param int $storage- * The pixel storage method. - * Refer to this list of pixel constants. - *
- * @param array $pixels- * The array of pixels - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function importImagePixels ($x, $y, $width, $height, $map, $storage, array $pixels) {} - - /** - * (No version information available, might only be in SVN)- * Deskew threshold - *
- * @return bool - * @throws ImagickException on error. - */ - public function deskewImage ($threshold) {} - - /** - * (No version information available, might only be in SVN)- * One of the COLORSPACE constants. - *
- * @param float $cluster_threshold- * A percentage describing minimum number of pixels - * contained in hexedra before it is considered valid. - *
- * @param float $smooth_threshold- * Eliminates noise from the histogram. - *
- * @param bool $verbose [optional]- * Whether to output detailed information about recognised classes. - *
- * @return bool - * @throws ImagickException on error. - */ - public function segmentImage ($COLORSPACE, $cluster_threshold, $smooth_threshold, $verbose = false) {} - - /** - * (No version information available, might only be in SVN)- * Refer to this list of sparse method constants - *
- * @param array $arguments- * An array containing the coordinates. - * The array is in format array(1,1, 2,45) - *
- * @param int $channel [optional] - * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function sparseColorImage ($SPARSE_METHOD, array $arguments, $channel = Imagick::CHANNEL_DEFAULT) {} - - /** - * (No version information available, might only be in SVN)- * An Imagick object containing the replacement colors - *
- * @param int $DITHER- * Refer to this list of dither method constants - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function remapImage (Imagick $replacement, $DITHER) {} - - /** - * (No version information available, might only be in SVN)- * X-coordinate of the exported area - *
- * @param int $y- * Y-coordinate of the exported area - *
- * @param int $width- * Width of the exported aread - *
- * @param int $height- * Height of the exported area - *
- * @param string $map- * Ordering of the exported pixels. For example "RGB". - * Valid characters for the map are R, G, B, A, O, C, Y, M, K, I and P. - *
- * @param int $STORAGE- * Refer to this list of pixel type constants - *
- * @return int[] an array containing the pixels values. - * @throws ImagickException on error. - */ - public function exportImagePixels ($x, $y, $width, $height, $map, $STORAGE) {} - - /** - * (No version information available, might only be in SVN)- * Provide any channel constant that is valid for your channel mode. To apply to more than one channel, combine channel constants using bitwise operators. Defaults to Imagick::CHANNEL_DEFAULT. Refer to this list of channel constants - *
- * @return float[] an array with kurtosis and skewness - * members. - * @throws ImagickException on error. - */ + #[Pure] + public function getImageChannelRange($channel) {} + + /** + * (No version information available, might only be in SVN)+ * Imagick object containing the reference image + *
+ * @param int $metric+ * Refer to this list of metric type constants. + *
+ * @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 using bitwise operators. Defaults to Imagick::CHANNEL_DEFAULT. Refer to this list of channel constants + *
+ * @return float a float describing the channel distortion. + * @throws ImagickException on error. + */ + #[Pure] + public function getImageChannelDistortions(Imagick $reference, $metric, $channel = Imagick::CHANNEL_DEFAULT) {} + + /** + * (No version information available, might only be in SVN)+ * The gravity property. Refer to the list of + * gravity constants. + *
+ * @return bool No value is returned. + * @throws ImagickException on error. + */ + public function setImageGravity($gravity) {} + + /** + * (No version information available, might only be in SVN)+ * The image x position + *
+ * @param int $y+ * The image y position + *
+ * @param int $width+ * The image width + *
+ * @param int $height+ * The image height + *
+ * @param string $map+ * Map of pixel ordering as a string. This can be for example RGB. + * The value can be any combination or order of R = red, G = green, B = blue, A = alpha (0 is transparent), + * O = opacity (0 is opaque), C = cyan, Y = yellow, M = magenta, K = black, I = intensity (for grayscale), P = pad. + *
+ * @param int $storage+ * The pixel storage method. + * Refer to this list of pixel constants. + *
+ * @param array $pixels+ * The array of pixels + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function importImagePixels($x, $y, $width, $height, $map, $storage, array $pixels) {} + + /** + * (No version information available, might only be in SVN)+ * Deskew threshold + *
+ * @return bool + * @throws ImagickException on error. + */ + public function deskewImage($threshold) {} + + /** + * (No version information available, might only be in SVN)+ * One of the COLORSPACE constants. + *
+ * @param float $cluster_threshold+ * A percentage describing minimum number of pixels + * contained in hexedra before it is considered valid. + *
+ * @param float $smooth_threshold+ * Eliminates noise from the histogram. + *
+ * @param bool $verbose [optional]+ * Whether to output detailed information about recognised classes. + *
+ * @return bool + * @throws ImagickException on error. + */ + public function segmentImage($COLORSPACE, $cluster_threshold, $smooth_threshold, $verbose = false) {} + + /** + * (No version information available, might only be in SVN)+ * Refer to this list of sparse method constants + *
+ * @param array $arguments+ * An array containing the coordinates. + * The array is in format array(1,1, 2,45) + *
+ * @param int $channel [optional] + * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function sparseColorImage($SPARSE_METHOD, array $arguments, $channel = Imagick::CHANNEL_DEFAULT) {} + + /** + * (No version information available, might only be in SVN)+ * An Imagick object containing the replacement colors + *
+ * @param int $DITHER+ * Refer to this list of dither method constants + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function remapImage(Imagick $replacement, $DITHER) {} + + /** + * (No version information available, might only be in SVN)+ * X-coordinate of the exported area + *
+ * @param int $y+ * Y-coordinate of the exported area + *
+ * @param int $width+ * Width of the exported aread + *
+ * @param int $height+ * Height of the exported area + *
+ * @param string $map+ * Ordering of the exported pixels. For example "RGB". + * Valid characters for the map are R, G, B, A, O, C, Y, M, K, I and P. + *
+ * @param int $STORAGE+ * Refer to this list of pixel type constants + *
+ * @return int[] an array containing the pixels values. + * @throws ImagickException on error. + */ + public function exportImagePixels($x, $y, $width, $height, $map, $STORAGE) {} + + /** + * (No version information available, might only be in SVN)+ * Provide any channel constant that is valid for your channel mode. To apply to more than one channel, combine channel constants using bitwise operators. Defaults to Imagick::CHANNEL_DEFAULT. Refer to this list of channel constants + *
+ * @return float[] an array with kurtosis and skewness + * members. + * @throws ImagickException on error. + */ #[ArrayShape([ "kurtosis" => "float", "skewness" => "float" ])] - #[Pure] - public function getImageChannelKurtosis ($channel = Imagick::CHANNEL_DEFAULT) {} - - /** - * (No version information available, might only be in SVN)- * Refer to this list of function constants - *
- * @param array $arguments- * Array of arguments to pass to this function. - *
- * @param int $channel [optional] - * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function functionImage ($function, array $arguments, $channel = Imagick::CHANNEL_DEFAULT) {} - - /** - * Transform image colorspace - * @param $COLORSPACE - * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function transformImageColorspace ($COLORSPACE) {} - - /** - * (No version information available, might only be in SVN)- * Imagick object containing the Hald lookup image. - *
- * @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 using bitwise operators. Defaults to Imagick::CHANNEL_DEFAULT. Refer to this list of channel constants - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function haldClutImage (Imagick $clut, $channel = Imagick::CHANNEL_DEFAULT) {} - - /** - * Adjusts the levels of a particular image channel by scaling the minimum and maximum values to the full quantum range. - * @param $CHANNEL [optional] - * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function autoLevelImage ($CHANNEL) {} - - /** - * @link https://www.php.net/manual/en/imagick.blueshiftimage.php - * @param float $factor [optional] - * @return bool - * @throws ImagickException on error. - */ - public function blueShiftImage ($factor) {} - - /** - * (No version information available, might only be in SVN)- * The name of the artifact - *
- * @return string the artifact value on success. - * @throws ImagickException on error. - */ - #[Pure] - public function getImageArtifact ($artifact) {} - - /** - * (No version information available, might only be in SVN)- * The name of the artifact - *
- * @param string $value- * The value of the artifact - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function setImageArtifact ($artifact, $value) {} - - /** - * (No version information available, might only be in SVN)- * The name of the artifact to delete - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function deleteImageArtifact ($artifact) {} - - /** - * (PECL imagick 0.9.10-0.9.9)- * One of the COLORSPACE constants - *
- * @return bool TRUE on success. - */ - public function setColorspace ($COLORSPACE) {} - - /** - * @param $CHANNEL [optional] - * @throws ImagickException on error. - */ - public function clampImage ($CHANNEL) {} - - /** - * @param bool $stack - * @param int $offset - * @return Imagick - * @throws ImagickException on error. - */ - public function smushImages ($stack, $offset) {} - - /** - * (PECL imagick 2.0.0)- * The path to an image to load or an array of paths. Paths can include - * wildcards for file names, or can be URLs. - *
- * @throws ImagickException Throws ImagickException on error. - */ - public function __construct ($files = null) {} - - /** - * @return string - */ - public function __toString () {} - - public function count () {} - - /** - * (PECL imagick 2.0.0)- * The x-coordinate of the region. - *
- * @param int $y- * The y-coordinate of the region. - *
- * @param int $columns- * The width of the region. - *
- * @param int $rows- * The height of the region. - *
- * @return ImagickPixelIterator an ImagickPixelIterator for an image section. - * @throws ImagickException on error. - * @throws ImagickPixelIteratorException on error. - */ - #[Pure] - public function getPixelRegionIterator ($x, $y, $columns, $rows) {} - - /** - * (PECL imagick 0.9.0-0.9.9)- * String presentation of the image format. Format support - * depends on the ImageMagick installation. - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function setImageFormat ($format) {} - - /** - * Scales the size of an image to the given dimensions. Passing zero as either of the arguments will preserve dimension while scaling.- * Filename where to write the image. The extension of the filename - * defines the type of the file. - * Format can be forced regardless of file extension using format: prefix, - * for example "jpg:test.png". - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function writeImage ($filename = null) {} - - /** - * (PECL imagick 0.9.0-0.9.9)- * Blur radius - *
- * @param float $sigma- * Standard deviation - *
- * @param int $channel [optional]- * The Channeltype - * constant. When not supplied, all channels are blurred. - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function blurImage ($radius, $sigma, $channel = null) {} - - /** - * Changes the size of an image to the given dimensions and removes any associated profiles.- * Image width - *
- * @param int $rows- * Image height - *
- * @param bool $bestfit [optional]- * Whether to force maximum values - *
- * The behavior of the parameter bestfit changed in Imagick 3.0.0. Before this version given dimensions 400x400 an image of dimensions 200x150 would be left untouched. In Imagick 3.0.0 and later the image would be scaled up to size 400x300 as this is the "best fit" for the given dimensions. If bestfit parameter is used both width and height must be given. - * @param bool $fill [optional] - * @param bool $legacy [optional] Added since 3.4.0. Default value FALSE - * @return bool TRUE on success. - * @throws ImagickException on error. - * @since 2.0.0 - */ - public function thumbnailImage ($columns, $rows, $bestfit = false, $fill = false, $legacy = false) {} - - /** - * Creates a cropped thumbnail at the requested size. - * If legacy is true, uses the incorrect behaviour that was present until Imagick 3.4.0. - * If false it uses the correct behaviour. - * @link https://php.net/manual/en/imagick.cropthumbnailimage.php - * @param int $width The width of the thumbnail - * @param int $height The Height of the thumbnail - * @param bool $legacy [optional] Added since 3.4.0. Default value FALSE - * @return bool TRUE on succes - * @throws ImagickException Throws ImagickException on error - * @since 2.0.0 - */ - public function cropThumbnailImage ($width, $height, $legacy = false) {} - - /** - * (PECL imagick 2.0.0)- * The position to set the iterator to - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - #[Deprecated] - public function setImageIndex ($index) {} - - /** - * (PECL imagick 2.0.0)- * The comment to add - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function commentImage ($comment) {} - - /** - * (PECL imagick 2.0.0)- * The width of the crop - *
- * @param int $height- * The height of the crop - *
- * @param int $x- * The X coordinate of the cropped region's top left corner - *
- * @param int $y- * The Y coordinate of the cropped region's top left corner - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function cropImage ($width, $height, $x, $y) {} - - /** - * (PECL imagick 2.0.0)- * The label to add - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function labelImage ($label) {} - - /** - * (PECL imagick 2.0.0)- * The drawing operations to render on the image. - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function drawImage (ImagickDraw $draw) {} - - /** - * (No version information available, might only be in SVN)- * The image compression quality as an integer - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function setImageCompressionQuality ($quality) {} - - /** - * (PECL imagick 2.2.2)- * The ImagickDraw object that contains settings for drawing the text - *
- * @param float $x- * Horizontal offset in pixels to the left of text - *
- * @param float $y- * Vertical offset in pixels to the baseline of text - *
- * @param float $angle- * The angle at which to write the text - *
- * @param string $text- * The string to draw - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function annotateImage (ImagickDraw $draw_settings, $x, $y, $angle, $text) {} - - /** - * (PECL imagick 2.0.0)- * Imagick object which holds the composite image - *
- * @param int $composite Composite operator - * @param int $x- * The column offset of the composited image - *
- * @param int $y- * The row offset of the composited image - *
- * @param int $channel [optional]- * Provide any channel constant that is valid for your channel mode. To - * apply to more than one channel, combine channeltype constants using - * bitwise operators. Refer to this list of channel constants. - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function compositeImage (Imagick $composite_object, $composite, $x, $y, $channel = Imagick::CHANNEL_ALL) {} - - /** - * (PECL imagick 2.0.0)- * The font name, size, and color are obtained from this object. - *
- * @param string $tile_geometry- * The number of tiles per row and page (e.g. 6x4+0+0). - *
- * @param string $thumbnail_geometry- * Preferred image size and border size of each thumbnail - * (e.g. 120x120+4+3>). - *
- * @param int $mode- * Thumbnail framing mode, see Montage Mode constants. - *
- * @param string $frame- * Surround the image with an ornamental border (e.g. 15x15+3+3). The - * frame color is that of the thumbnail's matte color. - *
- * @return Imagick TRUE on success. - * @throws ImagickException on error. - */ - public function montageImage (ImagickDraw $draw, $tile_geometry, $thumbnail_geometry, $mode, $frame) {} - - /** - * (PECL imagick 2.0.0)- * Width of the local neighborhood. - *
- * @param int $height- * Height of the local neighborhood. - *
- * @param int $offset- * The mean offset - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function adaptiveThresholdImage ($width, $height, $offset) {} - - /** - * (PECL imagick 2.0.0)- * The threshold below which everything turns black - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function blackThresholdImage ($threshold) {} - - /** - * (PECL imagick 2.0.0)- * Whether to stack the images vertically. - * By default (or if FALSE is specified) images are stacked left-to-right. - * If stack is TRUE, images are stacked top-to-bottom. - *
- * @return Imagick Imagick instance on success. - * @throws ImagickException on error. - */ - public function appendImages ($stack = false) {} - - /** - * (PECL imagick 2.0.0)- * The radius of the Gaussian, in pixels, not counting the center pixel - *
- * @param float $sigma- * The standard deviation of the Gaussian, in pixels - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function charcoalImage ($radius, $sigma) {} - - /** - * (PECL imagick 2.0.0)- * Provide any channel constant that is valid for your channel mode. To - * apply to more than one channel, combine channeltype constants using - * bitwise operators. Refer to this - * list of channel constants. - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function normalizeImage ($channel = Imagick::CHANNEL_ALL) {} - - /** - * (PECL imagick 2.0.0)- * The radius of the circular neighborhood. - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function oilPaintImage ($radius) {} - - /** - * (PECL imagick 2.0.0)- * The X offset. - *
- * @param int $y- * The Y offset. - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function rollImage ($x, $y) {} - - /** - * (PECL imagick 2.0.0)- * The background color - *
- * @param float $degrees- * The number of degrees to rotate the image - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function rotateImage ($background, $degrees) {} - - /** - * (PECL imagick 2.0.0)- * One of the COMPRESSION constants - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function setImageCompression ($compression) {} - - /** - * (PECL imagick 2.0.0)- * The amount of time expressed in 'ticks' that the image should be - * displayed for. For animated GIFs there are 100 ticks per second, so a - * value of 20 would be 20/100 of a second aka 1/5th of a second. - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function setImageDelay ($delay) {} - - /** - * (PECL imagick 2.0.0)- * The number of iterations the image should loop over. Set to '0' to loop - * continuously. - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function setImageIterations ($iterations) {} - - /** - * (PECL imagick 2.0.0)- * The duration for which an image should be displayed expressed in ticks - * per second. - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function setImageTicksPerSecond ($ticks_per_second) {} - - /** - * (PECL imagick 2.0.0)- * The background color - *
- * @param float $x_shear- * The number of degrees to shear on the x axis - *
- * @param float $y_shear- * The number of degrees to shear on the y axis - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function shearImage ($background, $x_shear, $y_shear) {} - - /** - * (PECL imagick 2.0.0)- * The filename to read the information from. - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function pingImage ($filename) {} - - /** - * (PECL imagick 2.0.0)- * The X server name - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function displayImage ($servername) {} - - /** - * (PECL imagick 2.0.0)- * The X server name - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function displayImages ($servername) {} - - /** - * (PECL imagick 2.0.0)- * The query pattern - *
- * @return array an array containing the configured fonts. - */ - public static function queryFonts ($pattern = "*") {} - - /** - * (PECL imagick 2.0.0)- * ImagickDraw object containing font properties - *
- * @param string $text- * The text - *
- * @param bool $multiline [optional]- * Multiline parameter. If left empty it is autodetected - *
- * @return array a multi-dimensional array representing the font metrics. - * @throws ImagickException on error. - */ - public function queryFontMetrics (ImagickDraw $properties, $text, $multiline = null) {} - - /** - * (PECL imagick 2.0.0)- * The type of the noise. Refer to this list of - * noise constants. - *
- * @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 using bitwise operators. Defaults to Imagick::CHANNEL_DEFAULT. Refer to this list of channel constants - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function addNoiseImage ($noise_type, $channel = Imagick::CHANNEL_DEFAULT) {} - - /** - * (PECL imagick 2.0.0)- * The radius of the Gaussian, in pixels, not counting the center pixel. - *
- * @param float $sigma- * The standard deviation of the Gaussian, in pixels. - *
- * @param float $angle- * Apply the effect along this angle. - *
- * @param int $channel [optional]- * Provide any channel constant that is valid for your channel mode. To - * apply to more than one channel, combine channeltype constants using - * bitwise operators. Refer to this - * list of channel constants. - * The channel argument affects only if Imagick is compiled against ImageMagick version - * 6.4.4 or greater. - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function motionBlurImage ($radius, $sigma, $angle, $channel = Imagick::CHANNEL_DEFAULT) {} - - /** - * (PECL imagick 2.0.0)- * The number of in-between images to generate. - *
- * @return Imagick This method returns a new Imagick object on success. - * Throw an ImagickException on error. - * @throws ImagickException on error - * @throws ImagickException on error. - */ - public function morphImages ($number_frames) {} - - /** - * (PECL imagick 2.0.0)- * The affine matrix - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function affineTransformImage (ImagickDraw $matrix) {} - - /** - * (PECL imagick 2.0.0)- * ImagickPixel object or a string containing the border color - *
- * @param int $width- * Border width - *
- * @param int $height- * Border height - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function borderImage ($bordercolor, $width, $height) {} - - /** - * (PECL imagick 2.0.0)- * Width of the chopped area - *
- * @param int $height- * Height of the chopped area - *
- * @param int $x- * X origo of the chopped area - *
- * @param int $y- * Y origo of the chopped area - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function chopImage ($width, $height, $x, $y) {} - - /** - * (PECL imagick 2.0.0)- * The name of the path - *
- * @param bool $inside- * If TRUE later operations take effect inside clipping path. - * Otherwise later operations take effect outside clipping path. - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function clipPathImage ($pathname, $inside) {} - - /** - * Alias to {@see Imagick::clipPathImage} - * @param string $pathname - * @param string $inside - * @throws ImagickException on error. - */ - public function clipImagePath ($pathname, $inside) {} - - /** - * (PECL imagick 2.0.0)- * ImagickPixel object containing the fill color - *
- * @param float $fuzz- * The amount of fuzz. For example, set fuzz to 10 and the color red at - * intensities of 100 and 102 respectively are now interpreted as the - * same color for the purposes of the floodfill. - *
- * @param mixed $bordercolor- * ImagickPixel object containing the border color - *
- * @param int $x- * X start position of the floodfill - *
- * @param int $y- * Y start position of the floodfill - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - #[Deprecated] - public function colorFloodfillImage ($fill, $fuzz, $bordercolor, $x, $y) {} - - /** - * Blends the fill color with each pixel in the image. The 'opacity' color is a per channel strength factor for how strongly the color should be applied.- * ImagickPixel object or a string containing the colorize color - *
- * @param mixed $opacity- * ImagickPixel object or an float containing the opacity value. - * 1.0 is fully opaque and 0.0 is fully transparent. - *
- * @param bool $legacy [optional] Added since 3.4.0. Default value FALSE - * @return bool TRUE on success. - * @throws ImagickException Throws ImagickException on error - * @since 2.0.0 - */ - public function colorizeImage ($colorize, $opacity, $legacy = false) {} - - /** - * (PECL imagick 2.0.0)- * Imagick object containing the image to compare. - *
- * @param int $channelType- * Provide any channel constant that is valid for your channel mode. To - * apply to more than one channel, combine channeltype constants using - * bitwise operators. Refer to this - * list of channel constants. - *
- * @param int $metricType- * One of the metric type constants. - *
- * @return array Array consisting of new_wand and - * distortion. - * @throws ImagickException on error. - */ - public function compareImageChannels (Imagick $image, $channelType, $metricType) {} - - /** - * (PECL imagick 2.0.0)- * An image to compare to. - *
- * @param int $metric- * Provide a valid metric type constant. Refer to this - * list of metric constants. - *
- * @return array Array consisting of an Imagick object of the - * reconstructed image and a float representing the difference. - * @throws ImagickException Throws ImagickException on error. - */ - public function compareImages (Imagick $compare, $metric) {} - - /** - * (PECL imagick 2.0.0)- * The sharpen value - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function contrastImage ($sharpen) {} - - /** - * (PECL imagick 2.0.0)- * Provide any channel constant that is valid for your channel mode. To - * apply to more than one channel, combine channeltype constants using - * bitwise operators. Refer to this - * list of channel constants. - *
- * @return Imagick TRUE on success. - * @throws ImagickException on error. - */ - public function combineImages ($channelType) {} - - /** - * (PECL imagick 2.0.0)- * The convolution kernel - *
- * @param int $channel [optional]- * Provide any channel constant that is valid for your channel mode. To - * apply to more than one channel, combine channeltype constants using - * bitwise operators. Refer to this - * list of channel constants. - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function convolveImage (array $kernel, $channel = Imagick::CHANNEL_ALL) {} - - /** - * (PECL imagick 2.0.0)- * The amount to displace the colormap. - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function cycleColormapImage ($displace) {} - - /** - * (PECL imagick 2.0.0)- * The radius of the operation. - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function edgeImage ($radius) {} - - /** - * (PECL imagick 2.0.0)- * The radius of the effect - *
- * @param float $sigma- * The sigma of the effect - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function embossImage ($radius, $sigma) {} - - /** - * (PECL imagick 2.0.0)- * The evaluation operator - *
- * @param float $constant- * The value of the operator - *
- * @param int $channel [optional]- * Provide any channel constant that is valid for your channel mode. To - * apply to more than one channel, combine channeltype constants using - * bitwise operators. Refer to this - * list of channel constants. - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function evaluateImage ($op, $constant, $channel = Imagick::CHANNEL_ALL) {} - - /** - * Merges a sequence of images. This is useful for combining Photoshop layers into a single image. - * This is replaced by: - *- * $im = $im->mergeImageLayers(\Imagick::LAYERMETHOD_FLATTEN) - *- * @link https://php.net/manual/en/imagick.flattenimages.php - * @return Imagick Returns an Imagick object containing the merged image. - * @throws ImagickException Throws ImagickException on error. - * @since 2.0.0 - */ - #[Deprecated] - public function flattenImages () {} - - /** - * (PECL imagick 2.0.0)
- * ImagickPixel object or a string representing the matte color - *
- * @param int $width- * The width of the border - *
- * @param int $height- * The height of the border - *
- * @param int $inner_bevel- * The inner bevel width - *
- * @param int $outer_bevel- * The outer bevel width - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function frameImage ($matte_color, $width, $height, $inner_bevel, $outer_bevel) {} - - /** - * (PECL imagick 2.0.0)- * The expression. - *
- * @param int $channel [optional]- * Provide any channel constant that is valid for your channel mode. To - * apply to more than one channel, combine channeltype constants using - * bitwise operators. Refer to this - * list of channel constants. - *
- * @return Imagick TRUE on success. - * @throws ImagickException on error. - */ - public function fxImage ($expression, $channel = Imagick::CHANNEL_ALL) {} - - /** - * (PECL imagick 2.0.0)- * The amount of gamma-correction. - *
- * @param int $channel [optional]- * Provide any channel constant that is valid for your channel mode. To - * apply to more than one channel, combine channeltype constants using - * bitwise operators. Refer to this - * list of channel constants. - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function gammaImage ($gamma, $channel = Imagick::CHANNEL_ALL) {} - - /** - * (PECL imagick 2.0.0)- * The radius of the Gaussian, in pixels, not counting the center pixel. - *
- * @param float $sigma- * The standard deviation of the Gaussian, in pixels. - *
- * @param int $channel [optional]- * Provide any channel constant that is valid for your channel mode. To - * apply to more than one channel, combine channeltype constants using - * bitwise operators. Refer to this - * list of channel constants. - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function gaussianBlurImage ($radius, $sigma, $channel = Imagick::CHANNEL_ALL) {} - - /** - * @link https://www.php.net/manual/en/imagick.getimageattribute.php - * @param string $keyThe key of the attribute to get.
- * @return string - */ - #[Deprecated] - #[Pure] - public function getImageAttribute ($key) {} - - /** - * (PECL imagick 2.0.0)- * Provide any channel constant that is valid for your channel mode. To apply to more than one channel, combine channel constants using bitwise operators. Defaults to Imagick::CHANNEL_DEFAULT. Refer to this list of channel constants - *
- * @return int TRUE on success. - * @throws ImagickException on error. - */ - #[Pure] - public function getImageChannelDepth ($channel) {} - - /** - * (PECL imagick 2.0.0)- * Imagick object to compare to. - *
- * @param int $channel- * Provide any channel constant that is valid for your channel mode. To - * apply to more than one channel, combine channeltype constants using - * bitwise operators. Refer to this - * list of channel constants. - *
- * @param int $metric- * One of the metric type constants. - *
- * @return float TRUE on success. - * @throws ImagickException on error. - */ - #[Pure] - public function getImageChannelDistortion (Imagick $reference, $channel, $metric) {} - - /** - * (PECL imagick 2.0.0)- * Provide any channel constant that is valid for your channel mode. To - * apply to more than one channel, combine channeltype constants using - * bitwise operators. Refer to this - * list of channel constants. - *
- * @return int[] - * @throws ImagickException on error. - */ - #[ArrayShape([ - "minima" => "int", - "maxima" => "int" - ])] - #[Deprecated] - #[Pure] - public function getImageChannelExtrema ($channel) {} - - /** - * (PECL imagick 2.0.0)- * Provide any channel constant that is valid for your channel mode. To - * apply to more than one channel, combine channeltype constants using - * bitwise operators. Refer to this - * list of channel constants. - *
- * @return float[] - * @throws ImagickException on error. - */ - #[ArrayShape([ - "mean" => "float", - "standardDeviation" => "float" - ])] - #[Pure] - public function getImageChannelMean ($channel) {} - - /** - * (PECL imagick 2.0.0)- * The offset into the image colormap. - *
- * @return ImagickPixel TRUE on success. - * @throws ImagickException on error. - */ - #[Pure] - public function getImageColormapColor ($index) {} - - /** - * (PECL imagick 2.0.0)- * Imagick object to compare to. - *
- * @param int $metric- * One of the metric type constants. - *
- * @return float the distortion metric used on the image (or the best guess - * thereof). - * @throws ImagickException on error. - */ - #[Pure] - public function getImageDistortion (Imagick $reference, $metric) {} - - /** - * (PECL imagick 2.0.0)- * The x-coordinate of the pixel - *
- * @param int $y- * The y-coordinate of the pixel - *
- * @return ImagickPixel an ImagickPixel instance for the color at the coordinates given. - * @throws ImagickException on error. - */ - #[Pure] - public function getImagePixelColor ($x, $y) {} - - /** - * (PECL imagick 2.0.0)- * The name of the profile to return. - *
- * @return string a string containing the image profile. - * @throws ImagickException on error. - */ - #[Pure] - public function getImageProfile ($name) {} - - /** - * (PECL imagick 2.0.0)- * The width of the extracted region. - *
- * @param int $height- * The height of the extracted region. - *
- * @param int $x- * X-coordinate of the top-left corner of the extracted region. - *
- * @param int $y- * Y-coordinate of the top-left corner of the extracted region. - *
- * @return Imagick Extracts a region of the image and returns it as a new wand. - * @throws ImagickException on error. - */ - #[Pure] - public function getImageRegion ($width, $height, $x, $y) {} - - /** - * (PECL imagick 2.0.0)- * The radius of the implode - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function implodeImage ($radius) {} - - /** - * (PECL imagick 2.0.0)- * The image black point - *
- * @param float $gamma- * The gamma value - *
- * @param float $whitePoint- * The image white point - *
- * @param int $channel [optional]- * Provide any channel constant that is valid for your channel mode. To - * apply to more than one channel, combine channeltype constants using - * bitwise operators. Refer to this - * list of channel constants. - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function levelImage ($blackPoint, $gamma, $whitePoint, $channel = Imagick::CHANNEL_ALL) {} - - /** - * (PECL imagick 2.0.0)- * The level of transparency: 1.0 is fully opaque and 0.0 is fully - * transparent. - *
- * @param float $fuzz- * The fuzz member of image defines how much tolerance is acceptable to - * consider two colors as the same. - *
- * @param mixed $bordercolor- * An ImagickPixel object or string representing the border color. - *
- * @param int $x- * The starting x coordinate of the operation. - *
- * @param int $y- * The starting y coordinate of the operation. - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - #[Deprecated] - public function matteFloodfillImage ($alpha, $fuzz, $bordercolor, $x, $y) {} - - /** - * (PECL imagick 2.0.0)- * The radius of the pixel neighborhood. - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - #[Deprecated] - public function medianFilterImage ($radius) {} - - /** - * (PECL imagick 2.0.0)- * Whether to only negate grayscale pixels within the image. - *
- * @param int $channel [optional]- * Provide any channel constant that is valid for your channel mode. To - * apply to more than one channel, combine channeltype constants using - * bitwise operators. Refer to this - * list of channel constants. - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function negateImage ($gray, $channel = Imagick::CHANNEL_ALL) {} - - /** - * (PECL imagick 2.0.0)- * Change this target color to the fill color within the image. An - * ImagickPixel object or a string representing the target color. - *
- * @param mixed $fill- * An ImagickPixel object or a string representing the fill color. - *
- * @param float $fuzz- * The fuzz member of image defines how much tolerance is acceptable to - * consider two colors as the same. - *
- * @param int $channel [optional]- * Provide any channel constant that is valid for your channel mode. To - * apply to more than one channel, combine channeltype constants using - * bitwise operators. Refer to this - * list of channel constants. - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - #[Deprecated] - public function paintOpaqueImage ($target, $fill, $fuzz, $channel = Imagick::CHANNEL_ALL) {} - - /** - * (PECL imagick 2.0.0)- * Change this target color to specified opacity value within the image. - *
- * @param float $alpha- * The level of transparency: 1.0 is fully opaque and 0.0 is fully - * transparent. - *
- * @param float $fuzz- * The fuzz member of image defines how much tolerance is acceptable to - * consider two colors as the same. - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - #[Deprecated] - public function paintTransparentImage ($target, $alpha, $fuzz) {} - - /** - * (PECL imagick 2.0.0)- * Preview type. See Preview type constants - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function previewImages ($preview) {} - - /** - * (PECL imagick 2.0.0)- * The border color - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function setImageBorderColor ($border) {} - - /** - * (PECL imagick 2.0.0)- * One of the COLORSPACE constants - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function setImageColorspace ($colorspace) {} - - /** - * (PECL imagick 2.0.0)- * The source Imagick object - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function addImage (Imagick $source) {} - - /** - * (PECL imagick 2.0.0)- * The replace Imagick object - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function setImage (Imagick $replace) {} - - /** - * (PECL imagick 2.0.0)- * Columns in the new image - *
- * @param int $rows- * Rows in the new image - *
- * @param mixed $background- * The background color used for this image - *
- * @param string $format [optional]- * Image format. This parameter was added in Imagick version 2.0.1. - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function newImage ($cols, $rows, $background, $format = null) {} - - /** - * (PECL imagick 2.0.0)- * columns in the new image - *
- * @param int $rows- * rows in the new image - *
- * @param string $pseudoString- * string containing pseudo image definition. - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function newPseudoImage ($columns, $rows, $pseudoString) {} - - /** - * (PECL imagick 2.0.0)- * The name of the option - *
- * @return string a value associated with a wand and the specified key. - */ - #[Pure] - public function getOption ($key) {} - - /** - * (PECL imagick 2.0.0)+ * Refer to this list of function constants + *
+ * @param array $arguments+ * Array of arguments to pass to this function. + *
+ * @param int $channel [optional] + * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function functionImage($function, array $arguments, $channel = Imagick::CHANNEL_DEFAULT) {} + + /** + * Transform image colorspace + * @param $COLORSPACE + * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function transformImageColorspace($COLORSPACE) {} + + /** + * (No version information available, might only be in SVN)+ * Imagick object containing the Hald lookup image. + *
+ * @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 using bitwise operators. Defaults to Imagick::CHANNEL_DEFAULT. Refer to this list of channel constants + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function haldClutImage(Imagick $clut, $channel = Imagick::CHANNEL_DEFAULT) {} + + /** + * Adjusts the levels of a particular image channel by scaling the minimum and maximum values to the full quantum range. + * @param $CHANNEL [optional] + * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function autoLevelImage($CHANNEL) {} + + /** + * @link https://www.php.net/manual/en/imagick.blueshiftimage.php + * @param float $factor [optional] + * @return bool + * @throws ImagickException on error. + */ + public function blueShiftImage($factor) {} + + /** + * (No version information available, might only be in SVN)+ * The name of the artifact + *
+ * @return string the artifact value on success. + * @throws ImagickException on error. + */ + #[Pure] + public function getImageArtifact($artifact) {} + + /** + * (No version information available, might only be in SVN)+ * The name of the artifact + *
+ * @param string $value+ * The value of the artifact + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function setImageArtifact($artifact, $value) {} + + /** + * (No version information available, might only be in SVN)+ * The name of the artifact to delete + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function deleteImageArtifact($artifact) {} + + /** + * (PECL imagick 0.9.10-0.9.9)+ * One of the COLORSPACE constants + *
+ * @return bool TRUE on success. + */ + public function setColorspace($COLORSPACE) {} + + /** + * @param $CHANNEL [optional] + * @throws ImagickException on error. + */ + public function clampImage($CHANNEL) {} + + /** + * @param bool $stack + * @param int $offset + * @return Imagick + * @throws ImagickException on error. + */ + public function smushImages($stack, $offset) {} + + /** + * (PECL imagick 2.0.0)+ * The path to an image to load or an array of paths. Paths can include + * wildcards for file names, or can be URLs. + *
+ * @throws ImagickException Throws ImagickException on error. + */ + public function __construct($files = null) {} + + /** + * @return string + */ + public function __toString() {} + + public function count() {} + + /** + * (PECL imagick 2.0.0)+ * The x-coordinate of the region. + *
+ * @param int $y+ * The y-coordinate of the region. + *
+ * @param int $columns+ * The width of the region. + *
+ * @param int $rows+ * The height of the region. + *
+ * @return ImagickPixelIterator an ImagickPixelIterator for an image section. + * @throws ImagickException on error. + * @throws ImagickPixelIteratorException on error. + */ + #[Pure] + public function getPixelRegionIterator($x, $y, $columns, $rows) {} + + /** + * (PECL imagick 0.9.0-0.9.9)+ * String presentation of the image format. Format support + * depends on the ImageMagick installation. + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function setImageFormat($format) {} + + /** + * Scales the size of an image to the given dimensions. Passing zero as either of the arguments will preserve dimension while scaling.+ * Filename where to write the image. The extension of the filename + * defines the type of the file. + * Format can be forced regardless of file extension using format: prefix, + * for example "jpg:test.png". + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function writeImage($filename = null) {} + + /** + * (PECL imagick 0.9.0-0.9.9)+ * Blur radius + *
+ * @param float $sigma+ * Standard deviation + *
+ * @param int $channel [optional]+ * The Channeltype + * constant. When not supplied, all channels are blurred. + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function blurImage($radius, $sigma, $channel = null) {} + + /** + * Changes the size of an image to the given dimensions and removes any associated profiles.+ * Image width + *
+ * @param int $rows+ * Image height + *
+ * @param bool $bestfit [optional]+ * Whether to force maximum values + *
+ * The behavior of the parameter bestfit changed in Imagick 3.0.0. Before this version given dimensions 400x400 an image of dimensions 200x150 would be left untouched. In Imagick 3.0.0 and later the image would be scaled up to size 400x300 as this is the "best fit" for the given dimensions. If bestfit parameter is used both width and height must be given. + * @param bool $fill [optional] + * @param bool $legacy [optional] Added since 3.4.0. Default value FALSE + * @return bool TRUE on success. + * @throws ImagickException on error. + * @since 2.0.0 + */ + public function thumbnailImage($columns, $rows, $bestfit = false, $fill = false, $legacy = false) {} + + /** + * Creates a cropped thumbnail at the requested size. + * If legacy is true, uses the incorrect behaviour that was present until Imagick 3.4.0. + * If false it uses the correct behaviour. + * @link https://php.net/manual/en/imagick.cropthumbnailimage.php + * @param int $width The width of the thumbnail + * @param int $height The Height of the thumbnail + * @param bool $legacy [optional] Added since 3.4.0. Default value FALSE + * @return bool TRUE on succes + * @throws ImagickException Throws ImagickException on error + * @since 2.0.0 + */ + public function cropThumbnailImage($width, $height, $legacy = false) {} + + /** + * (PECL imagick 2.0.0)+ * The position to set the iterator to + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + #[Deprecated] + public function setImageIndex($index) {} + + /** + * (PECL imagick 2.0.0)+ * The comment to add + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function commentImage($comment) {} + + /** + * (PECL imagick 2.0.0)+ * The width of the crop + *
+ * @param int $height+ * The height of the crop + *
+ * @param int $x+ * The X coordinate of the cropped region's top left corner + *
+ * @param int $y+ * The Y coordinate of the cropped region's top left corner + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function cropImage($width, $height, $x, $y) {} + + /** + * (PECL imagick 2.0.0)+ * The label to add + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function labelImage($label) {} + + /** + * (PECL imagick 2.0.0)- * Refer to the list of resourcetype constants. - *
- * @return int the specified resource's memory usage in megabytes. - */ - public static function getResource ($type) {} - - /** - * (PECL imagick 2.0.0)- * Refer to the list of resourcetype constants. - *
- * @return int the specified resource limit in megabytes. - */ - public static function getResourceLimit ($type) {} - - /** - * (PECL imagick 2.0.0)- * Refer to the list of resourcetype constants. - *
- * @param int $limit- * The resource limit. The unit depends on the type of the resource being limited. - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public static function setResourceLimit ($type, $limit) {} - - /** - * (PECL imagick 2.0.0)- * The horizontal resolution. - *
- * @param float $y_resolution- * The vertical resolution. - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function setResolution ($x_resolution, $y_resolution) {} - - /** - * (PECL imagick 2.0.0)bool callback ( mixed $offset , mixed $span )- * Caution - * 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 void - * @throws ImagickException on error. - * @since 3.3.0 - */ - public function setProgressMonitor ($callback) { } - - /** - * Sets the ImageMagick registry entry named key to value. This is most useful for setting "temporary-path" which controls where ImageMagick creates temporary images e.g. while processing PDFs. - * @link https://php.net/manual/en/imagick.setregistry.php - * @param string $key - * @param string $value - * @return void - * @since 3.3.0 - */ - public static function setRegistry ($key, $value) { } - - /** - * Replace each pixel with corresponding statistic from the neighborhood of the specified width and height. - * @link https://php.net/manual/en/imagick.statisticimage.php - * @param int $type - * @param int $width - * @param int $height - * @param int $channel [optional] - * @return void - * @throws ImagickException on error. - * @since 3.3.0 - */ - public function statisticImage ($type, $width, $height, $channel = Imagick::CHANNEL_DEFAULT ) { } - - /** - * Searches for a subimage in the current image and returns a similarity image such that an exact match location is - * completely white and if none of the pixels match, black, otherwise some gray level in-between. - * You can also pass in the optional parameters bestMatch and similarity. After calling the function similarity will - * be set to the 'score' of the similarity between the subimage and the matching position in the larger image, - * bestMatch will contain an associative array with elements x, y, width, height that describe the matching region. - * - * @link https://php.net/manual/en/imagick.subimagematch.php - * @param Imagick $imagick - * @param array &$bestMatch [optional] - * @param float &$similarity [optional] A new image that displays the amount of similarity at each pixel. - * @param float $similarity_threshold [optional] Only used if compiled with ImageMagick (library) > 7 - * @param int $metric [optional] Only used if compiled with ImageMagick (library) > 7 - * @return Imagick - * @throws ImagickException on error. - * @since 3.3.0 - */ - public function subImageMatch (Imagick $imagick, array &$bestMatch, &$similarity, $similarity_threshold, $metric) { } - - /** - * Is an alias of Imagick::subImageMatch - * - * @param Imagick $imagick - * @param array &$bestMatch [optional] - * @param float &$similarity [optional] A new image that displays the amount of similarity at each pixel. - * @param float $similarity_threshold [optional] - * @param int $metric [optional] - * @return Imagick - * @throws ImagickException on error. - * @see Imagick::subImageMatch() This function is an alias of subImageMatch() - * @since 3.4.0 - */ - public function similarityImage (Imagick $imagick, array &$bestMatch, &$similarity, $similarity_threshold, $metric) { } - - /** - * Returns any ImageMagick configure options that match the specified pattern (e.g. "*" for all). Options include NAME, VERSION, LIB_VERSION, etc. - * @return string - * @since 3.4.0 - */ - #[Pure] - public function getConfigureOptions () { } - - /** - * GetFeatures() returns the ImageMagick features that have been compiled into the runtime. - * @return string - * @since 3.4.0 - */ - #[Pure] - public function getFeatures () { } - - /** - * @return int - * @since 3.4.0 - */ - #[Pure] - public function getHDRIEnabled () { } - - /** - * Sets the image channel mask. Returns the previous set channel mask. - * Only works with Imagick >= 7 - * @param int $channel - * @throws ImagickException on error. - * @since 3.4.0 - */ - public function setImageChannelMask ($channel) {} - - /** - * Merge multiple images of the same size together with the selected operator. https://www.imagemagick.org/Usage/layers/#evaluate-sequence - * @param int $EVALUATE_CONSTANT - * @return bool - * @see https://www.imagemagick.org/Usage/layers/#evaluate-sequence - * @throws ImagickException on error. - * @since 3.4.0 - */ - public function evaluateImages ($EVALUATE_CONSTANT) { } - - /** - * Extracts the 'mean' from the image and adjust the image to try make set its gamma appropriately. - * @param int $channel [optional] Default value Imagick::CHANNEL_ALL - * @return bool - * @throws ImagickException on error. - * @since 3.4.1 - */ - public function autoGammaImage ($channel = Imagick::CHANNEL_ALL) { } - - /** - * Adjusts an image so that its orientation is suitable $ for viewing (i.e. top-left orientation). - * @return bool - * @throws ImagickException on error. - * @since 3.4.1 - */ - public function autoOrient () { } - - /** - * Composite one image onto another using the specified gravity. - * - * @param Imagick $imagick - * @param int $COMPOSITE_CONSTANT - * @param int $GRAVITY_CONSTANT - * @return bool - * @throws ImagickException on error. - * @since 3.4.1 - */ - public function compositeImageGravity(Imagick $imagick, $COMPOSITE_CONSTANT, $GRAVITY_CONSTANT) { } - - /** - * Attempts to increase the appearance of large-scale light-dark transitions. - * - * @param float $radius - * @param float $strength - * @return bool - * @throws ImagickException on error. - * @since 3.4.1 - */ - public function localContrastImage($radius, $strength) { } - - /** - * Identifies the potential image type, returns one of the Imagick::IMGTYPE_* constants - * @return int - * @throws ImagickException on error. - * @since 3.4.3 - */ - public function identifyImageType() { } - - /** - * Sets the image to the specified alpha level. Will replace ImagickDraw::setOpacity() - * - * @param float $alpha - * @return bool - * @throws ImagickException on error. - * @since 3.4.3 - */ - public function setImageAlpha($alpha) { } -} + #[Pure] + public function getImageGeometry() {} + + /** + * (PECL imagick 2.0.0)
+ * The drawing operations to render on the image. + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function drawImage(ImagickDraw $draw) {} + + /** + * (No version information available, might only be in SVN)+ * The image compression quality as an integer + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function setImageCompressionQuality($quality) {} + + /** + * (PECL imagick 2.2.2)+ * The ImagickDraw object that contains settings for drawing the text + *
+ * @param float $x+ * Horizontal offset in pixels to the left of text + *
+ * @param float $y+ * Vertical offset in pixels to the baseline of text + *
+ * @param float $angle+ * The angle at which to write the text + *
+ * @param string $text+ * The string to draw + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function annotateImage(ImagickDraw $draw_settings, $x, $y, $angle, $text) {} + + /** + * (PECL imagick 2.0.0)+ * Imagick object which holds the composite image + *
+ * @param int $composite Composite operator + * @param int $x+ * The column offset of the composited image + *
+ * @param int $y+ * The row offset of the composited image + *
+ * @param int $channel [optional]+ * Provide any channel constant that is valid for your channel mode. To + * apply to more than one channel, combine channeltype constants using + * bitwise operators. Refer to this list of channel constants. + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function compositeImage(Imagick $composite_object, $composite, $x, $y, $channel = Imagick::CHANNEL_ALL) {} + + /** + * (PECL imagick 2.0.0)+ * The font name, size, and color are obtained from this object. + *
+ * @param string $tile_geometry+ * The number of tiles per row and page (e.g. 6x4+0+0). + *
+ * @param string $thumbnail_geometry+ * Preferred image size and border size of each thumbnail + * (e.g. 120x120+4+3>). + *
+ * @param int $mode+ * Thumbnail framing mode, see Montage Mode constants. + *
+ * @param string $frame+ * Surround the image with an ornamental border (e.g. 15x15+3+3). The + * frame color is that of the thumbnail's matte color. + *
+ * @return Imagick TRUE on success. + * @throws ImagickException on error. + */ + public function montageImage(ImagickDraw $draw, $tile_geometry, $thumbnail_geometry, $mode, $frame) {} + + /** + * (PECL imagick 2.0.0)+ * Width of the local neighborhood. + *
+ * @param int $height+ * Height of the local neighborhood. + *
+ * @param int $offset+ * The mean offset + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function adaptiveThresholdImage($width, $height, $offset) {} + + /** + * (PECL imagick 2.0.0)+ * The threshold below which everything turns black + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function blackThresholdImage($threshold) {} + + /** + * (PECL imagick 2.0.0)+ * Whether to stack the images vertically. + * By default (or if FALSE is specified) images are stacked left-to-right. + * If stack is TRUE, images are stacked top-to-bottom. + *
+ * @return Imagick Imagick instance on success. + * @throws ImagickException on error. + */ + public function appendImages($stack = false) {} + + /** + * (PECL imagick 2.0.0)+ * The radius of the Gaussian, in pixels, not counting the center pixel + *
+ * @param float $sigma+ * The standard deviation of the Gaussian, in pixels + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function charcoalImage($radius, $sigma) {} + + /** + * (PECL imagick 2.0.0)+ * Provide any channel constant that is valid for your channel mode. To + * apply to more than one channel, combine channeltype constants using + * bitwise operators. Refer to this + * list of channel constants. + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function normalizeImage($channel = Imagick::CHANNEL_ALL) {} + + /** + * (PECL imagick 2.0.0)+ * The radius of the circular neighborhood. + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function oilPaintImage($radius) {} + + /** + * (PECL imagick 2.0.0)+ * The X offset. + *
+ * @param int $y+ * The Y offset. + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function rollImage($x, $y) {} + + /** + * (PECL imagick 2.0.0)+ * The background color + *
+ * @param float $degrees+ * The number of degrees to rotate the image + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function rotateImage($background, $degrees) {} + + /** + * (PECL imagick 2.0.0)+ * One of the COMPRESSION constants + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function setImageCompression($compression) {} + + /** + * (PECL imagick 2.0.0)+ * The amount of time expressed in 'ticks' that the image should be + * displayed for. For animated GIFs there are 100 ticks per second, so a + * value of 20 would be 20/100 of a second aka 1/5th of a second. + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function setImageDelay($delay) {} + + /** + * (PECL imagick 2.0.0)+ * The number of iterations the image should loop over. Set to '0' to loop + * continuously. + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function setImageIterations($iterations) {} + + /** + * (PECL imagick 2.0.0)+ * The duration for which an image should be displayed expressed in ticks + * per second. + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function setImageTicksPerSecond($ticks_per_second) {} + + /** + * (PECL imagick 2.0.0)+ * The background color + *
+ * @param float $x_shear+ * The number of degrees to shear on the x axis + *
+ * @param float $y_shear+ * The number of degrees to shear on the y axis + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function shearImage($background, $x_shear, $y_shear) {} + + /** + * (PECL imagick 2.0.0)+ * The filename to read the information from. + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function pingImage($filename) {} + + /** + * (PECL imagick 2.0.0)+ * The X server name + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function displayImage($servername) {} + + /** + * (PECL imagick 2.0.0)+ * The X server name + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function displayImages($servername) {} + + /** + * (PECL imagick 2.0.0)+ * The query pattern + *
+ * @return array an array containing the configured fonts. + */ + public static function queryFonts($pattern = "*") {} + + /** + * (PECL imagick 2.0.0)+ * ImagickDraw object containing font properties + *
+ * @param string $text+ * The text + *
+ * @param bool $multiline [optional]+ * Multiline parameter. If left empty it is autodetected + *
+ * @return array a multi-dimensional array representing the font metrics. + * @throws ImagickException on error. + */ + public function queryFontMetrics(ImagickDraw $properties, $text, $multiline = null) {} + + /** + * (PECL imagick 2.0.0)+ * The type of the noise. Refer to this list of + * noise constants. + *
+ * @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 using bitwise operators. Defaults to Imagick::CHANNEL_DEFAULT. Refer to this list of channel constants + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function addNoiseImage($noise_type, $channel = Imagick::CHANNEL_DEFAULT) {} + + /** + * (PECL imagick 2.0.0)+ * The radius of the Gaussian, in pixels, not counting the center pixel. + *
+ * @param float $sigma+ * The standard deviation of the Gaussian, in pixels. + *
+ * @param float $angle+ * Apply the effect along this angle. + *
+ * @param int $channel [optional]+ * Provide any channel constant that is valid for your channel mode. To + * apply to more than one channel, combine channeltype constants using + * bitwise operators. Refer to this + * list of channel constants. + * The channel argument affects only if Imagick is compiled against ImageMagick version + * 6.4.4 or greater. + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function motionBlurImage($radius, $sigma, $angle, $channel = Imagick::CHANNEL_DEFAULT) {} + + /** + * (PECL imagick 2.0.0)+ * The number of in-between images to generate. + *
+ * @return Imagick This method returns a new Imagick object on success. + * Throw an ImagickException on error. + * @throws ImagickException on error + * @throws ImagickException on error. + */ + public function morphImages($number_frames) {} + + /** + * (PECL imagick 2.0.0)+ * The affine matrix + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function affineTransformImage(ImagickDraw $matrix) {} + + /** + * (PECL imagick 2.0.0)+ * ImagickPixel object or a string containing the border color + *
+ * @param int $width+ * Border width + *
+ * @param int $height+ * Border height + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function borderImage($bordercolor, $width, $height) {} + + /** + * (PECL imagick 2.0.0)+ * Width of the chopped area + *
+ * @param int $height+ * Height of the chopped area + *
+ * @param int $x+ * X origo of the chopped area + *
+ * @param int $y+ * Y origo of the chopped area + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function chopImage($width, $height, $x, $y) {} + + /** + * (PECL imagick 2.0.0)+ * The name of the path + *
+ * @param bool $inside+ * If TRUE later operations take effect inside clipping path. + * Otherwise later operations take effect outside clipping path. + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function clipPathImage($pathname, $inside) {} + + /** + * Alias to {@see Imagick::clipPathImage} + * @param string $pathname + * @param string $inside + * @throws ImagickException on error. + */ + public function clipImagePath($pathname, $inside) {} + + /** + * (PECL imagick 2.0.0)+ * ImagickPixel object containing the fill color + *
+ * @param float $fuzz+ * The amount of fuzz. For example, set fuzz to 10 and the color red at + * intensities of 100 and 102 respectively are now interpreted as the + * same color for the purposes of the floodfill. + *
+ * @param mixed $bordercolor+ * ImagickPixel object containing the border color + *
+ * @param int $x+ * X start position of the floodfill + *
+ * @param int $y+ * Y start position of the floodfill + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + #[Deprecated] + public function colorFloodfillImage($fill, $fuzz, $bordercolor, $x, $y) {} + + /** + * Blends the fill color with each pixel in the image. The 'opacity' color is a per channel strength factor for how strongly the color should be applied.+ * ImagickPixel object or a string containing the colorize color + *
+ * @param mixed $opacity+ * ImagickPixel object or an float containing the opacity value. + * 1.0 is fully opaque and 0.0 is fully transparent. + *
+ * @param bool $legacy [optional] Added since 3.4.0. Default value FALSE + * @return bool TRUE on success. + * @throws ImagickException Throws ImagickException on error + * @since 2.0.0 + */ + public function colorizeImage($colorize, $opacity, $legacy = false) {} + + /** + * (PECL imagick 2.0.0)+ * Imagick object containing the image to compare. + *
+ * @param int $channelType+ * Provide any channel constant that is valid for your channel mode. To + * apply to more than one channel, combine channeltype constants using + * bitwise operators. Refer to this + * list of channel constants. + *
+ * @param int $metricType+ * One of the metric type constants. + *
+ * @return array Array consisting of new_wand and + * distortion. + * @throws ImagickException on error. + */ + public function compareImageChannels(Imagick $image, $channelType, $metricType) {} + + /** + * (PECL imagick 2.0.0)+ * An image to compare to. + *
+ * @param int $metric+ * Provide a valid metric type constant. Refer to this + * list of metric constants. + *
+ * @return array Array consisting of an Imagick object of the + * reconstructed image and a float representing the difference. + * @throws ImagickException Throws ImagickException on error. + */ + public function compareImages(Imagick $compare, $metric) {} + + /** + * (PECL imagick 2.0.0)+ * The sharpen value + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function contrastImage($sharpen) {} + + /** + * (PECL imagick 2.0.0)+ * Provide any channel constant that is valid for your channel mode. To + * apply to more than one channel, combine channeltype constants using + * bitwise operators. Refer to this + * list of channel constants. + *
+ * @return Imagick TRUE on success. + * @throws ImagickException on error. + */ + public function combineImages($channelType) {} + + /** + * (PECL imagick 2.0.0)+ * The convolution kernel + *
+ * @param int $channel [optional]+ * Provide any channel constant that is valid for your channel mode. To + * apply to more than one channel, combine channeltype constants using + * bitwise operators. Refer to this + * list of channel constants. + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function convolveImage(array $kernel, $channel = Imagick::CHANNEL_ALL) {} + + /** + * (PECL imagick 2.0.0)+ * The amount to displace the colormap. + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function cycleColormapImage($displace) {} + + /** + * (PECL imagick 2.0.0)+ * The radius of the operation. + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function edgeImage($radius) {} + + /** + * (PECL imagick 2.0.0)+ * The radius of the effect + *
+ * @param float $sigma+ * The sigma of the effect + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function embossImage($radius, $sigma) {} + + /** + * (PECL imagick 2.0.0)+ * The evaluation operator + *
+ * @param float $constant+ * The value of the operator + *
+ * @param int $channel [optional]+ * Provide any channel constant that is valid for your channel mode. To + * apply to more than one channel, combine channeltype constants using + * bitwise operators. Refer to this + * list of channel constants. + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function evaluateImage($op, $constant, $channel = Imagick::CHANNEL_ALL) {} + + /** + * Merges a sequence of images. This is useful for combining Photoshop layers into a single image. + * This is replaced by: + *+ * $im = $im->mergeImageLayers(\Imagick::LAYERMETHOD_FLATTEN) + *+ * @link https://php.net/manual/en/imagick.flattenimages.php + * @return Imagick Returns an Imagick object containing the merged image. + * @throws ImagickException Throws ImagickException on error. + * @since 2.0.0 + */ + #[Deprecated] + public function flattenImages() {} + + /** + * (PECL imagick 2.0.0)
+ * ImagickPixel object or a string representing the matte color + *
+ * @param int $width+ * The width of the border + *
+ * @param int $height+ * The height of the border + *
+ * @param int $inner_bevel+ * The inner bevel width + *
+ * @param int $outer_bevel+ * The outer bevel width + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function frameImage($matte_color, $width, $height, $inner_bevel, $outer_bevel) {} + + /** + * (PECL imagick 2.0.0)+ * The expression. + *
+ * @param int $channel [optional]+ * Provide any channel constant that is valid for your channel mode. To + * apply to more than one channel, combine channeltype constants using + * bitwise operators. Refer to this + * list of channel constants. + *
+ * @return Imagick TRUE on success. + * @throws ImagickException on error. + */ + public function fxImage($expression, $channel = Imagick::CHANNEL_ALL) {} + + /** + * (PECL imagick 2.0.0)+ * The amount of gamma-correction. + *
+ * @param int $channel [optional]+ * Provide any channel constant that is valid for your channel mode. To + * apply to more than one channel, combine channeltype constants using + * bitwise operators. Refer to this + * list of channel constants. + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function gammaImage($gamma, $channel = Imagick::CHANNEL_ALL) {} + + /** + * (PECL imagick 2.0.0)+ * The radius of the Gaussian, in pixels, not counting the center pixel. + *
+ * @param float $sigma+ * The standard deviation of the Gaussian, in pixels. + *
+ * @param int $channel [optional]+ * Provide any channel constant that is valid for your channel mode. To + * apply to more than one channel, combine channeltype constants using + * bitwise operators. Refer to this + * list of channel constants. + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function gaussianBlurImage($radius, $sigma, $channel = Imagick::CHANNEL_ALL) {} + + /** + * @link https://www.php.net/manual/en/imagick.getimageattribute.php + * @param string $keyThe key of the attribute to get.
+ * @return string + */ + #[Deprecated] + #[Pure] + public function getImageAttribute($key) {} + + /** + * (PECL imagick 2.0.0)+ * Provide any channel constant that is valid for your channel mode. To apply to more than one channel, combine channel constants using bitwise operators. Defaults to Imagick::CHANNEL_DEFAULT. Refer to this list of channel constants + *
+ * @return int TRUE on success. + * @throws ImagickException on error. + */ + #[Pure] + public function getImageChannelDepth($channel) {} + + /** + * (PECL imagick 2.0.0)+ * Imagick object to compare to. + *
+ * @param int $channel+ * Provide any channel constant that is valid for your channel mode. To + * apply to more than one channel, combine channeltype constants using + * bitwise operators. Refer to this + * list of channel constants. + *
+ * @param int $metric+ * One of the metric type constants. + *
+ * @return float TRUE on success. + * @throws ImagickException on error. + */ + #[Pure] + public function getImageChannelDistortion(Imagick $reference, $channel, $metric) {} + + /** + * (PECL imagick 2.0.0)+ * Provide any channel constant that is valid for your channel mode. To + * apply to more than one channel, combine channeltype constants using + * bitwise operators. Refer to this + * list of channel constants. + *
+ * @return int[] + * @throws ImagickException on error. + */ + #[ArrayShape([ + "minima" => "int", + "maxima" => "int" + ])] + #[Deprecated] + #[Pure] + public function getImageChannelExtrema($channel) {} + + /** + * (PECL imagick 2.0.0)+ * Provide any channel constant that is valid for your channel mode. To + * apply to more than one channel, combine channeltype constants using + * bitwise operators. Refer to this + * list of channel constants. + *
+ * @return float[] + * @throws ImagickException on error. + */ + #[ArrayShape([ + "mean" => "float", + "standardDeviation" => "float" + ])] + #[Pure] + public function getImageChannelMean($channel) {} + + /** + * (PECL imagick 2.0.0)+ * The offset into the image colormap. + *
+ * @return ImagickPixel TRUE on success. + * @throws ImagickException on error. + */ + #[Pure] + public function getImageColormapColor($index) {} + + /** + * (PECL imagick 2.0.0)+ * Imagick object to compare to. + *
+ * @param int $metric+ * One of the metric type constants. + *
+ * @return float the distortion metric used on the image (or the best guess + * thereof). + * @throws ImagickException on error. + */ + #[Pure] + public function getImageDistortion(Imagick $reference, $metric) {} + + /** + * (PECL imagick 2.0.0)+ * The x-coordinate of the pixel + *
+ * @param int $y+ * The y-coordinate of the pixel + *
+ * @return ImagickPixel an ImagickPixel instance for the color at the coordinates given. + * @throws ImagickException on error. + */ + #[Pure] + public function getImagePixelColor($x, $y) {} + + /** + * (PECL imagick 2.0.0)+ * The name of the profile to return. + *
+ * @return string a string containing the image profile. + * @throws ImagickException on error. + */ + #[Pure] + public function getImageProfile($name) {} + + /** + * (PECL imagick 2.0.0)+ * The width of the extracted region. + *
+ * @param int $height+ * The height of the extracted region. + *
+ * @param int $x+ * X-coordinate of the top-left corner of the extracted region. + *
+ * @param int $y+ * Y-coordinate of the top-left corner of the extracted region. + *
+ * @return Imagick Extracts a region of the image and returns it as a new wand. + * @throws ImagickException on error. + */ + #[Pure] + public function getImageRegion($width, $height, $x, $y) {} + + /** + * (PECL imagick 2.0.0)+ * The radius of the implode + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function implodeImage($radius) {} + + /** + * (PECL imagick 2.0.0)+ * The image black point + *
+ * @param float $gamma+ * The gamma value + *
+ * @param float $whitePoint+ * The image white point + *
+ * @param int $channel [optional]+ * Provide any channel constant that is valid for your channel mode. To + * apply to more than one channel, combine channeltype constants using + * bitwise operators. Refer to this + * list of channel constants. + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function levelImage($blackPoint, $gamma, $whitePoint, $channel = Imagick::CHANNEL_ALL) {} + + /** + * (PECL imagick 2.0.0)+ * The level of transparency: 1.0 is fully opaque and 0.0 is fully + * transparent. + *
+ * @param float $fuzz+ * The fuzz member of image defines how much tolerance is acceptable to + * consider two colors as the same. + *
+ * @param mixed $bordercolor+ * An ImagickPixel object or string representing the border color. + *
+ * @param int $x+ * The starting x coordinate of the operation. + *
+ * @param int $y+ * The starting y coordinate of the operation. + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + #[Deprecated] + public function matteFloodfillImage($alpha, $fuzz, $bordercolor, $x, $y) {} + + /** + * (PECL imagick 2.0.0)+ * The radius of the pixel neighborhood. + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + #[Deprecated] + public function medianFilterImage($radius) {} + + /** + * (PECL imagick 2.0.0)+ * Whether to only negate grayscale pixels within the image. + *
+ * @param int $channel [optional]+ * Provide any channel constant that is valid for your channel mode. To + * apply to more than one channel, combine channeltype constants using + * bitwise operators. Refer to this + * list of channel constants. + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function negateImage($gray, $channel = Imagick::CHANNEL_ALL) {} + + /** + * (PECL imagick 2.0.0)+ * Change this target color to the fill color within the image. An + * ImagickPixel object or a string representing the target color. + *
+ * @param mixed $fill+ * An ImagickPixel object or a string representing the fill color. + *
+ * @param float $fuzz+ * The fuzz member of image defines how much tolerance is acceptable to + * consider two colors as the same. + *
+ * @param int $channel [optional]+ * Provide any channel constant that is valid for your channel mode. To + * apply to more than one channel, combine channeltype constants using + * bitwise operators. Refer to this + * list of channel constants. + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + #[Deprecated] + public function paintOpaqueImage($target, $fill, $fuzz, $channel = Imagick::CHANNEL_ALL) {} + + /** + * (PECL imagick 2.0.0)+ * Change this target color to specified opacity value within the image. + *
+ * @param float $alpha+ * The level of transparency: 1.0 is fully opaque and 0.0 is fully + * transparent. + *
+ * @param float $fuzz+ * The fuzz member of image defines how much tolerance is acceptable to + * consider two colors as the same. + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + #[Deprecated] + public function paintTransparentImage($target, $alpha, $fuzz) {} + + /** + * (PECL imagick 2.0.0)+ * Preview type. See Preview type constants + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function previewImages($preview) {} + + /** + * (PECL imagick 2.0.0)+ * The border color + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function setImageBorderColor($border) {} + + /** + * (PECL imagick 2.0.0)+ * One of the COLORSPACE constants + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function setImageColorspace($colorspace) {} + + /** + * (PECL imagick 2.0.0)+ * The source Imagick object + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function addImage(Imagick $source) {} + + /** + * (PECL imagick 2.0.0)+ * The replace Imagick object + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function setImage(Imagick $replace) {} + + /** + * (PECL imagick 2.0.0)+ * Columns in the new image + *
+ * @param int $rows+ * Rows in the new image + *
+ * @param mixed $background+ * The background color used for this image + *
+ * @param string $format [optional]+ * Image format. This parameter was added in Imagick version 2.0.1. + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function newImage($cols, $rows, $background, $format = null) {} + + /** + * (PECL imagick 2.0.0)+ * columns in the new image + *
+ * @param int $rows+ * rows in the new image + *
+ * @param string $pseudoString+ * string containing pseudo image definition. + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function newPseudoImage($columns, $rows, $pseudoString) {} + + /** + * (PECL imagick 2.0.0)+ * The name of the option + *
+ * @return string a value associated with a wand and the specified key. + */ + #[Pure] + public function getOption($key) {} + + /** + * (PECL imagick 2.0.0)+ * Refer to the list of resourcetype constants. + *
+ * @return int the specified resource's memory usage in megabytes. + */ + public static function getResource($type) {} + + /** + * (PECL imagick 2.0.0)+ * Refer to the list of resourcetype constants. + *
+ * @return int the specified resource limit in megabytes. + */ + public static function getResourceLimit($type) {} + + /** + * (PECL imagick 2.0.0)+ * Refer to the list of resourcetype constants. + *
+ * @param int $limit+ * The resource limit. The unit depends on the type of the resource being limited. + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public static function setResourceLimit($type, $limit) {} + + /** + * (PECL imagick 2.0.0)+ * The horizontal resolution. + *
+ * @param float $y_resolution+ * The vertical resolution. + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function setResolution($x_resolution, $y_resolution) {} + + /** + * (PECL imagick 2.0.0)bool callback ( mixed $offset , mixed $span )+ * Caution + * 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 void + * @throws ImagickException on error. + * @since 3.3.0 + */ + public function setProgressMonitor($callback) {} + + /** + * Sets the ImageMagick registry entry named key to value. This is most useful for setting "temporary-path" which controls where ImageMagick creates temporary images e.g. while processing PDFs. + * @link https://php.net/manual/en/imagick.setregistry.php + * @param string $key + * @param string $value + * @return void + * @since 3.3.0 + */ + public static function setRegistry($key, $value) {} + + /** + * Replace each pixel with corresponding statistic from the neighborhood of the specified width and height. + * @link https://php.net/manual/en/imagick.statisticimage.php + * @param int $type + * @param int $width + * @param int $height + * @param int $channel [optional] + * @return void + * @throws ImagickException on error. + * @since 3.3.0 + */ + public function statisticImage($type, $width, $height, $channel = Imagick::CHANNEL_DEFAULT) {} + + /** + * Searches for a subimage in the current image and returns a similarity image such that an exact match location is + * completely white and if none of the pixels match, black, otherwise some gray level in-between. + * You can also pass in the optional parameters bestMatch and similarity. After calling the function similarity will + * be set to the 'score' of the similarity between the subimage and the matching position in the larger image, + * bestMatch will contain an associative array with elements x, y, width, height that describe the matching region. + * + * @link https://php.net/manual/en/imagick.subimagematch.php + * @param Imagick $imagick + * @param array &$bestMatch [optional] + * @param float &$similarity [optional] A new image that displays the amount of similarity at each pixel. + * @param float $similarity_threshold [optional] Only used if compiled with ImageMagick (library) > 7 + * @param int $metric [optional] Only used if compiled with ImageMagick (library) > 7 + * @return Imagick + * @throws ImagickException on error. + * @since 3.3.0 + */ + public function subImageMatch(Imagick $imagick, array &$bestMatch, &$similarity, $similarity_threshold, $metric) {} + + /** + * Is an alias of Imagick::subImageMatch + * + * @param Imagick $imagick + * @param array &$bestMatch [optional] + * @param float &$similarity [optional] A new image that displays the amount of similarity at each pixel. + * @param float $similarity_threshold [optional] + * @param int $metric [optional] + * @return Imagick + * @throws ImagickException on error. + * @see Imagick::subImageMatch() This function is an alias of subImageMatch() + * @since 3.4.0 + */ + public function similarityImage(Imagick $imagick, array &$bestMatch, &$similarity, $similarity_threshold, $metric) {} + + /** + * Returns any ImageMagick configure options that match the specified pattern (e.g. "*" for all). Options include NAME, VERSION, LIB_VERSION, etc. + * @return string + * @since 3.4.0 + */ + #[Pure] + public function getConfigureOptions() {} + + /** + * GetFeatures() returns the ImageMagick features that have been compiled into the runtime. + * @return string + * @since 3.4.0 + */ + #[Pure] + public function getFeatures() {} + + /** + * @return int + * @since 3.4.0 + */ + #[Pure] + public function getHDRIEnabled() {} + + /** + * Sets the image channel mask. Returns the previous set channel mask. + * Only works with Imagick >= 7 + * @param int $channel + * @throws ImagickException on error. + * @since 3.4.0 + */ + public function setImageChannelMask($channel) {} + + /** + * Merge multiple images of the same size together with the selected operator. https://www.imagemagick.org/Usage/layers/#evaluate-sequence + * @param int $EVALUATE_CONSTANT + * @return bool + * @see https://www.imagemagick.org/Usage/layers/#evaluate-sequence + * @throws ImagickException on error. + * @since 3.4.0 + */ + public function evaluateImages($EVALUATE_CONSTANT) {} + + /** + * Extracts the 'mean' from the image and adjust the image to try make set its gamma appropriately. + * @param int $channel [optional] Default value Imagick::CHANNEL_ALL + * @return bool + * @throws ImagickException on error. + * @since 3.4.1 + */ + public function autoGammaImage($channel = Imagick::CHANNEL_ALL) {} + + /** + * Adjusts an image so that its orientation is suitable $ for viewing (i.e. top-left orientation). + * @return bool + * @throws ImagickException on error. + * @since 3.4.1 + */ + public function autoOrient() {} + + /** + * Composite one image onto another using the specified gravity. + * + * @param Imagick $imagick + * @param int $COMPOSITE_CONSTANT + * @param int $GRAVITY_CONSTANT + * @return bool + * @throws ImagickException on error. + * @since 3.4.1 + */ + public function compositeImageGravity(Imagick $imagick, $COMPOSITE_CONSTANT, $GRAVITY_CONSTANT) {} + + /** + * Attempts to increase the appearance of large-scale light-dark transitions. + * + * @param float $radius + * @param float $strength + * @return bool + * @throws ImagickException on error. + * @since 3.4.1 + */ + public function localContrastImage($radius, $strength) {} + + /** + * Identifies the potential image type, returns one of the Imagick::IMGTYPE_* constants + * @return int + * @throws ImagickException on error. + * @since 3.4.3 + */ + public function identifyImageType() {} + + /** + * Sets the image to the specified alpha level. Will replace ImagickDraw::setOpacity() + * + * @param float $alpha + * @return bool + * @throws ImagickException on error. + * @since 3.4.3 + */ + public function setImageAlpha($alpha) {} +} + +/** + * @method ImagickDraw clone() (PECL imagick 2.0.0)
+ * ImagickPixel to use to set the color + *
+ * @return bool No value is returned. + * @throws ImagickDrawException on error. + */ + public function setFillColor(ImagickPixel $fill_pixel) {} + + /** + * (PECL imagick 2.0.0)+ * fill alpha + *
+ * @return bool No value is returned. + */ + #[Deprecated] + public function setFillAlpha($opacity) {} + + /** + * Sets the image resolution + * @param float $x_resolutionThe horizontal resolution.
+ * @param float $y_resolutionThe vertical resolution.
+ * @return bool + * @throws ImagickDrawException on error. + */ + public function setResolution($x_resolution, $y_resolution) {} + + /** + * (PECL imagick 2.0.0)+ * the stroke color + *
+ * @return bool No value is returned. + * @throws ImagickDrawException on error. + */ + public function setStrokeColor(ImagickPixel $stroke_pixel) {} + + /** + * (PECL imagick 2.0.0)+ * opacity + *
+ * @return bool No value is returned. + */ + #[Deprecated] + public function setStrokeAlpha($opacity) {} + + /** + * (PECL imagick 2.0.0)+ * stroke width + *
+ * @return bool No value is returned. + */ + public function setStrokeWidth($stroke_width) {} + + /** + * (PECL imagick 2.0.0)+ * origin x coordinate + *
+ * @param float $oy+ * origin y coordinate + *
+ * @param float $px+ * perimeter x coordinate + *
+ * @param float $py+ * perimeter y coordinate + *
+ * @return bool No value is returned. + */ + public function circle($ox, $oy, $px, $py) {} + + /** + * (PECL imagick 2.0.0)+ * The x coordinate where text is drawn + *
+ * @param float $y+ * The y coordinate where text is drawn + *
+ * @param string $text+ * The text to draw on the image + *
+ * @return bool No value is returned. + * @throws ImagickDrawException on error. + */ + public function annotation($x, $y, $text) {} + + /** + * (PECL imagick 2.0.0)+ * the encoding name + *
+ * @return bool No value is returned. + */ + public function setTextEncoding($encoding) {} + + /** + * (PECL imagick 2.0.0)+ * the font family + *
+ * @return bool TRUE on success. + * @throws ImagickDrawException on error. + * @throws ImagickException on error. + */ + public function setFontFamily($font_family) {} + + /** + * (PECL imagick 2.0.0)+ * the point size + *
+ * @return bool No value is returned. + */ + public function setFontSize($pointsize) {} + + /** + * (PECL imagick 2.0.0)+ * STYLETYPE_ constant + *
+ * @return bool No value is returned. + */ + public function setFontStyle($style) {} + + /** + * (PECL imagick 2.0.0)+ * x coordinate of the top left corner + *
+ * @param float $y1+ * y coordinate of the top left corner + *
+ * @param float $x2+ * x coordinate of the bottom right corner + *
+ * @param float $y2+ * y coordinate of the bottom right corner + *
+ * @return bool No value is returned. + */ + public function rectangle($x1, $y1, $x2, $y2) {} + + /** + * (PECL imagick 2.0.0)+ * x coordinate of the top left corner + *
+ * @param float $y1+ * y coordinate of the top left corner + *
+ * @param float $x2+ * x coordinate of the bottom right + *
+ * @param float $y2+ * y coordinate of the bottom right + *
+ * @param float $rx+ * x rounding + *
+ * @param float $ry+ * y rounding + *
+ * @return bool No value is returned. + */ + public function roundRectangle($x1, $y1, $x2, $y2, $rx, $ry) {} + + /** + * (PECL imagick 2.0.0)+ * degrees to skew + *
+ * @return bool No value is returned. + */ + public function skewX($degrees) {} + + /** + * (PECL imagick 2.0.0)+ * degrees to skew + *
+ * @return bool No value is returned. + */ + public function skewY($degrees) {} + + /** + * (PECL imagick 2.0.0)+ * horizontal translation + *
+ * @param float $y+ * vertical translation + *
+ * @return bool No value is returned. + */ + public function translate($x, $y) {} + + /** + * (PECL imagick 2.0.0)+ * starting x coordinate + *
+ * @param float $sy+ * starting y coordinate + *
+ * @param float $ex+ * ending x coordinate + *
+ * @param float $ey+ * ending y coordinate + *
+ * @return bool No value is returned. + */ + public function line($sx, $sy, $ex, $ey) {} + + /** + * (PECL imagick 2.0.0)+ * Starting x ordinate of bounding rectangle + *
+ * @param float $sy+ * starting y ordinate of bounding rectangle + *
+ * @param float $ex+ * ending x ordinate of bounding rectangle + *
+ * @param float $ey+ * ending y ordinate of bounding rectangle + *
+ * @param float $sd+ * starting degrees of rotation + *
+ * @param float $ed+ * ending degrees of rotation + *
+ * @return bool No value is returned. + */ + public function arc($sx, $sy, $ex, $ey, $sd, $ed) {} + + /** + * (PECL imagick 2.0.0)+ * x coordinate of the matte + *
+ * @param float $y+ * y coordinate of the matte + *
+ * @param int $paintMethod+ * PAINT_ constant + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function matte($x, $y, $paintMethod) {} + + /** + * (PECL imagick 2.0.0)+ * multidimensional array like array( array( 'x' => 3, 'y' => 4 ), array( 'x' => 2, 'y' => 6 ) ); + *
+ * @return bool TRUE on success. + * @throws ImagickDrawException on error. + */ + public function polygon(array $coordinates) {} + + /** + * (PECL imagick 2.0.0)+ * point's x coordinate + *
+ * @param float $y+ * point's y coordinate + *
+ * @return bool No value is returned. + */ + public function point($x, $y) {} + + /** + * (PECL imagick 2.0.0)+ * STRETCH_ constant + *
+ * @return bool No value is returned. + */ + public function setFontStretch($fontStretch) {} + + /** + * (PECL imagick 2.0.0)+ * the antialias setting + *
+ * @return bool No value is returned. + */ + public function setStrokeAntialias($stroke_antialias) {} + + /** + * (PECL imagick 2.0.0)+ * ALIGN_ constant + *
+ * @return bool No value is returned. + */ + public function setTextAlignment($alignment) {} + + /** + * (PECL imagick 2.0.0)+ * DECORATION_ constant + *
+ * @return bool No value is returned. + */ + public function setTextDecoration($decoration) {} + + /** + * (PECL imagick 2.0.0)+ * the under color + *
+ * @return bool No value is returned. + * @throws ImagickDrawException on error. + */ + public function setTextUnderColor(ImagickPixel $under_color) {} + + /** + * (PECL imagick 2.0.0)+ * left x coordinate + *
+ * @param int $y1+ * left y coordinate + *
+ * @param int $x2+ * right x coordinate + *
+ * @param int $y2+ * right y coordinate + *
+ * @return bool No value is returned. + */ + public function setViewbox($x1, $y1, $x2, $y2) {} + + /** + * (PECL imagick 2.0.0)+ * Affine matrix parameters + *
+ * @return bool No value is returned. + * @throws ImagickDrawException on error. + */ + public function affine(array $affine) {} + + /** + * (PECL imagick 2.0.0)+ * Multidimensional array like array( array( 'x' => 1, 'y' => 2 ), + * array( 'x' => 3, 'y' => 4 ) ) + *
+ * @return bool No value is returned. + * @throws ImagickDrawException on error. + */ + public function bezier(array $coordinates) {} + + /** + * (PECL imagick 2.0.0)+ * composition operator. One of COMPOSITE_ constants + *
+ * @param float $x+ * x coordinate of the top left corner + *
+ * @param float $y+ * y coordinate of the top left corner + *
+ * @param float $width+ * width of the composition image + *
+ * @param float $height+ * height of the composition image + *
+ * @param Imagick $compositeWand+ * the Imagick object where composition image is taken from + *
+ * @return bool TRUE on success. + * @throws ImagickException on error. + */ + public function composite($compose, $x, $y, $width, $height, Imagick $compositeWand) {} + + /** + * (PECL imagick 2.0.0)+ * x coordinate of the paint + *
+ * @param float $y+ * y coordinate of the paint + *
+ * @param int $paintMethod+ * one of the PAINT_ constants + *
+ * @return bool No value is returned. + */ + public function color($x, $y, $paintMethod) {} + + /** + * (PECL imagick 2.0.0)+ * The comment string to add to vector output stream + *
+ * @return bool No value is returned. + */ + public function comment($comment) {} + + /** + * (PECL imagick 2.0.0)+ * x coordinate of the first control point + *
+ * @param float $y1+ * y coordinate of the first control point + *
+ * @param float $x2+ * x coordinate of the second control point + *
+ * @param float $y2+ * y coordinate of the first control point + *
+ * @param float $x+ * x coordinate of the curve end + *
+ * @param float $y+ * y coordinate of the curve end + *
+ * @return bool No value is returned. + */ + public function pathCurveToAbsolute($x1, $y1, $x2, $y2, $x, $y) {} + + /** + * (PECL imagick 2.0.0)+ * x coordinate of starting control point + *
+ * @param float $y1+ * y coordinate of starting control point + *
+ * @param float $x2+ * x coordinate of ending control point + *
+ * @param float $y2+ * y coordinate of ending control point + *
+ * @param float $x+ * ending x coordinate + *
+ * @param float $y+ * ending y coordinate + *
+ * @return bool No value is returned. + */ + public function pathCurveToRelative($x1, $y1, $x2, $y2, $x, $y) {} + + /** + * (PECL imagick 2.0.0)+ * x coordinate of the control point + *
+ * @param float $y1+ * y coordinate of the control point + *
+ * @param float $x+ * x coordinate of the end point + *
+ * @param float $y+ * y coordinate of the end point + *
+ * @return bool No value is returned. + */ + public function pathCurveToQuadraticBezierAbsolute($x1, $y1, $x, $y) {} + + /** + * (PECL imagick 2.0.0)+ * starting x coordinate + *
+ * @param float $y1+ * starting y coordinate + *
+ * @param float $x+ * ending x coordinate + *
+ * @param float $y+ * ending y coordinate + *
+ * @return bool No value is returned. + */ + public function pathCurveToQuadraticBezierRelative($x1, $y1, $x, $y) {} + + /** + * (PECL imagick 2.0.0)+ * ending x coordinate + *
+ * @param float $y+ * ending y coordinate + *
+ * @return bool No value is returned. + */ + public function pathCurveToQuadraticBezierSmoothAbsolute($x, $y) {} + + /** + * (PECL imagick 2.0.0)+ * ending x coordinate + *
+ * @param float $y+ * ending y coordinate + *
+ * @return bool No value is returned. + */ + public function pathCurveToQuadraticBezierSmoothRelative($x, $y) {} + + /** + * (PECL imagick 2.0.0)+ * x coordinate of the second control point + *
+ * @param float $y2+ * y coordinate of the second control point + *
+ * @param float $x+ * x coordinate of the ending point + *
+ * @param float $y+ * y coordinate of the ending point + *
+ * @return bool No value is returned. + */ + public function pathCurveToSmoothAbsolute($x2, $y2, $x, $y) {} + + /** + * (PECL imagick 2.0.0)+ * x coordinate of the second control point + *
+ * @param float $y2+ * y coordinate of the second control point + *
+ * @param float $x+ * x coordinate of the ending point + *
+ * @param float $y+ * y coordinate of the ending point + *
+ * @return bool No value is returned. + */ + public function pathCurveToSmoothRelative($x2, $y2, $x, $y) {} + + /** + * (PECL imagick 2.0.0)+ * x radius + *
+ * @param float $ry+ * y radius + *
+ * @param float $x_axis_rotation+ * x axis rotation + *
+ * @param bool $large_arc_flag+ * large arc flag + *
+ * @param bool $sweep_flag+ * sweep flag + *
+ * @param float $x+ * x coordinate + *
+ * @param float $y+ * y coordinate + *
+ * @return bool No value is returned. + */ + public function pathEllipticArcAbsolute($rx, $ry, $x_axis_rotation, $large_arc_flag, $sweep_flag, $x, $y) {} + + /** + * (PECL imagick 2.0.0)+ * x radius + *
+ * @param float $ry+ * y radius + *
+ * @param float $x_axis_rotation+ * x axis rotation + *
+ * @param bool $large_arc_flag+ * large arc flag + *
+ * @param bool $sweep_flag+ * sweep flag + *
+ * @param float $x+ * x coordinate + *
+ * @param float $y+ * y coordinate + *
+ * @return bool No value is returned. + */ + public function pathEllipticArcRelative($rx, $ry, $x_axis_rotation, $large_arc_flag, $sweep_flag, $x, $y) {} + + /** + * (PECL imagick 2.0.0)+ * starting x coordinate + *
+ * @param float $y+ * ending x coordinate + *
+ * @return bool No value is returned. + */ + public function pathLineToAbsolute($x, $y) {} + + /** + * (PECL imagick 2.0.0)+ * starting x coordinate + *
+ * @param float $y+ * starting y coordinate + *
+ * @return bool No value is returned. + */ + public function pathLineToRelative($x, $y) {} + + /** + * (PECL imagick 2.0.0)+ * x coordinate + *
+ * @return bool No value is returned. + */ + public function pathLineToHorizontalAbsolute($x) {} + + /** + * (PECL imagick 2.0.0)+ * x coordinate + *
+ * @return bool No value is returned. + */ + public function pathLineToHorizontalRelative($x) {} + + /** + * (PECL imagick 2.0.0)+ * y coordinate + *
+ * @return bool No value is returned. + */ + public function pathLineToVerticalAbsolute($y) {} + + /** + * (PECL imagick 2.0.0)+ * y coordinate + *
+ * @return bool No value is returned. + */ + public function pathLineToVerticalRelative($y) {} + + /** + * (PECL imagick 2.0.0)+ * x coordinate of the starting point + *
+ * @param float $y+ * y coordinate of the starting point + *
+ * @return bool No value is returned. + */ + public function pathMoveToAbsolute($x, $y) {} + + /** + * (PECL imagick 2.0.0)+ * target x coordinate + *
+ * @param float $y+ * target y coordinate + *
+ * @return bool No value is returned. + */ + public function pathMoveToRelative($x, $y) {} + + /** + * (PECL imagick 2.0.0)+ * array of x and y coordinates: array( array( 'x' => 4, 'y' => 6 ), array( 'x' => 8, 'y' => 10 ) ) + *
+ * @return bool TRUE on success. + * @throws ImagickDrawException on error. + */ + public function polyline(array $coordinates) {} + + /** + * (PECL imagick 2.0.0)+ * Clip mask Id + *
+ * @return bool No value is returned. + */ + public function pushClipPath($clip_mask_id) {} + + /** + * (PECL imagick 2.0.0)+ * the pattern Id + *
+ * @param float $x+ * x coordinate of the top-left corner + *
+ * @param float $y+ * y coordinate of the top-left corner + *
+ * @param float $width+ * width of the pattern + *
+ * @param float $height+ * height of the pattern + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function pushPattern($pattern_id, $x, $y, $width, $height) {} -/** - * @method ImagickDraw clone() (PECL imagick 2.0.0)- * ImagickPixel to use to set the color - *
- * @return bool No value is returned. - * @throws ImagickDrawException on error. - */ - public function setFillColor (ImagickPixel $fill_pixel) {} - - /** - * (PECL imagick 2.0.0)- * fill alpha - *
- * @return bool No value is returned. - */ - #[Deprecated] - public function setFillAlpha ($opacity) {} - - /** - * Sets the image resolution - * @param float $x_resolutionThe horizontal resolution.
- * @param float $y_resolutionThe vertical resolution.
- * @return bool - * @throws ImagickDrawException on error. - */ - public function setResolution ($x_resolution, $y_resolution) {} - - /** - * (PECL imagick 2.0.0)- * the stroke color - *
- * @return bool No value is returned. - * @throws ImagickDrawException on error. - */ - public function setStrokeColor (ImagickPixel $stroke_pixel) {} - - /** - * (PECL imagick 2.0.0)- * opacity - *
- * @return bool No value is returned. - */ - #[Deprecated] - public function setStrokeAlpha ($opacity) {} - - /** - * (PECL imagick 2.0.0)- * stroke width - *
- * @return bool No value is returned. - */ - public function setStrokeWidth ($stroke_width) {} - - /** - * (PECL imagick 2.0.0)- * origin x coordinate - *
- * @param float $oy- * origin y coordinate - *
- * @param float $px- * perimeter x coordinate - *
- * @param float $py- * perimeter y coordinate - *
- * @return bool No value is returned. - */ - public function circle ($ox, $oy, $px, $py) {} - - /** - * (PECL imagick 2.0.0)- * The x coordinate where text is drawn - *
- * @param float $y- * The y coordinate where text is drawn - *
- * @param string $text- * The text to draw on the image - *
- * @return bool No value is returned. - * @throws ImagickDrawException on error. - */ - public function annotation ($x, $y, $text) {} - - /** - * (PECL imagick 2.0.0)- * the encoding name - *
- * @return bool No value is returned. - */ - public function setTextEncoding ($encoding) {} - - /** - * (PECL imagick 2.0.0)- * the font family - *
- * @return bool TRUE on success. - * @throws ImagickDrawException on error. - * @throws ImagickException on error. - */ - public function setFontFamily ($font_family) {} - - /** - * (PECL imagick 2.0.0)- * the point size - *
- * @return bool No value is returned. - */ - public function setFontSize ($pointsize) {} - - /** - * (PECL imagick 2.0.0)- * STYLETYPE_ constant - *
- * @return bool No value is returned. - */ - public function setFontStyle ($style) {} - - /** - * (PECL imagick 2.0.0)- * x coordinate of the top left corner - *
- * @param float $y1- * y coordinate of the top left corner - *
- * @param float $x2- * x coordinate of the bottom right corner - *
- * @param float $y2- * y coordinate of the bottom right corner - *
- * @return bool No value is returned. - */ - public function rectangle ($x1, $y1, $x2, $y2) {} - - /** - * (PECL imagick 2.0.0)- * x coordinate of the top left corner - *
- * @param float $y1- * y coordinate of the top left corner - *
- * @param float $x2- * x coordinate of the bottom right - *
- * @param float $y2- * y coordinate of the bottom right - *
- * @param float $rx- * x rounding - *
- * @param float $ry- * y rounding - *
- * @return bool No value is returned. - */ - public function roundRectangle ($x1, $y1, $x2, $y2, $rx, $ry) {} - - /** - * (PECL imagick 2.0.0)- * degrees to skew - *
- * @return bool No value is returned. - */ - public function skewX ($degrees) {} - - /** - * (PECL imagick 2.0.0)- * degrees to skew - *
- * @return bool No value is returned. - */ - public function skewY ($degrees) {} - - /** - * (PECL imagick 2.0.0)- * horizontal translation - *
- * @param float $y- * vertical translation - *
- * @return bool No value is returned. - */ - public function translate ($x, $y) {} - - /** - * (PECL imagick 2.0.0)- * starting x coordinate - *
- * @param float $sy- * starting y coordinate - *
- * @param float $ex- * ending x coordinate - *
- * @param float $ey- * ending y coordinate - *
- * @return bool No value is returned. - */ - public function line ($sx, $sy, $ex, $ey) {} - - /** - * (PECL imagick 2.0.0)- * Starting x ordinate of bounding rectangle - *
- * @param float $sy- * starting y ordinate of bounding rectangle - *
- * @param float $ex- * ending x ordinate of bounding rectangle - *
- * @param float $ey- * ending y ordinate of bounding rectangle - *
- * @param float $sd- * starting degrees of rotation - *
- * @param float $ed- * ending degrees of rotation - *
- * @return bool No value is returned. - */ - public function arc ($sx, $sy, $ex, $ey, $sd, $ed) {} - - /** - * (PECL imagick 2.0.0)- * x coordinate of the matte - *
- * @param float $y- * y coordinate of the matte - *
- * @param int $paintMethod- * PAINT_ constant - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function matte ($x, $y, $paintMethod) {} - - /** - * (PECL imagick 2.0.0)- * multidimensional array like array( array( 'x' => 3, 'y' => 4 ), array( 'x' => 2, 'y' => 6 ) ); - *
- * @return bool TRUE on success. - * @throws ImagickDrawException on error. - */ - public function polygon (array $coordinates) {} - - /** - * (PECL imagick 2.0.0)- * point's x coordinate - *
- * @param float $y- * point's y coordinate - *
- * @return bool No value is returned. - */ - public function point ($x, $y) {} - - /** - * (PECL imagick 2.0.0)- * STRETCH_ constant - *
- * @return bool No value is returned. - */ - public function setFontStretch ($fontStretch) {} - - /** - * (PECL imagick 2.0.0)- * the antialias setting - *
- * @return bool No value is returned. - */ - public function setStrokeAntialias ($stroke_antialias) {} - - /** - * (PECL imagick 2.0.0)- * ALIGN_ constant - *
- * @return bool No value is returned. - */ - public function setTextAlignment ($alignment) {} - - /** - * (PECL imagick 2.0.0)- * DECORATION_ constant - *
- * @return bool No value is returned. - */ - public function setTextDecoration ($decoration) {} - - /** - * (PECL imagick 2.0.0)- * the under color - *
- * @return bool No value is returned. - * @throws ImagickDrawException on error. - */ - public function setTextUnderColor (ImagickPixel $under_color) {} - - /** - * (PECL imagick 2.0.0)- * left x coordinate - *
- * @param int $y1- * left y coordinate - *
- * @param int $x2- * right x coordinate - *
- * @param int $y2- * right y coordinate - *
- * @return bool No value is returned. - */ - public function setViewbox ($x1, $y1, $x2, $y2) {} - - /** - * (PECL imagick 2.0.0)- * Affine matrix parameters - *
- * @return bool No value is returned. - * @throws ImagickDrawException on error. - */ - public function affine (array $affine) {} - - /** - * (PECL imagick 2.0.0)- * Multidimensional array like array( array( 'x' => 1, 'y' => 2 ), - * array( 'x' => 3, 'y' => 4 ) ) - *
- * @return bool No value is returned. - * @throws ImagickDrawException on error. - */ - public function bezier (array $coordinates) {} - - /** - * (PECL imagick 2.0.0)- * composition operator. One of COMPOSITE_ constants - *
- * @param float $x- * x coordinate of the top left corner - *
- * @param float $y- * y coordinate of the top left corner - *
- * @param float $width- * width of the composition image - *
- * @param float $height- * height of the composition image - *
- * @param Imagick $compositeWand- * the Imagick object where composition image is taken from - *
- * @return bool TRUE on success. - * @throws ImagickException on error. - */ - public function composite ($compose, $x, $y, $width, $height, Imagick $compositeWand) {} - - /** - * (PECL imagick 2.0.0)- * x coordinate of the paint - *
- * @param float $y- * y coordinate of the paint - *
- * @param int $paintMethod- * one of the PAINT_ constants - *
- * @return bool No value is returned. - */ - public function color ($x, $y, $paintMethod) {} - - /** - * (PECL imagick 2.0.0)- * The comment string to add to vector output stream - *
- * @return bool No value is returned. - */ - public function comment ($comment) {} - - /** - * (PECL imagick 2.0.0)- * x coordinate of the first control point - *
- * @param float $y1- * y coordinate of the first control point - *
- * @param float $x2- * x coordinate of the second control point - *
- * @param float $y2- * y coordinate of the first control point - *
- * @param float $x- * x coordinate of the curve end - *
- * @param float $y- * y coordinate of the curve end - *
- * @return bool No value is returned. - */ - public function pathCurveToAbsolute ($x1, $y1, $x2, $y2, $x, $y) {} - - /** - * (PECL imagick 2.0.0)- * x coordinate of starting control point - *
- * @param float $y1- * y coordinate of starting control point - *
- * @param float $x2- * x coordinate of ending control point - *
- * @param float $y2- * y coordinate of ending control point - *
- * @param float $x- * ending x coordinate - *
- * @param float $y- * ending y coordinate - *
- * @return bool No value is returned. - */ - public function pathCurveToRelative ($x1, $y1, $x2, $y2, $x, $y) {} - - /** - * (PECL imagick 2.0.0)- * x coordinate of the control point - *
- * @param float $y1- * y coordinate of the control point - *
- * @param float $x- * x coordinate of the end point - *
- * @param float $y- * y coordinate of the end point - *
- * @return bool No value is returned. - */ - public function pathCurveToQuadraticBezierAbsolute ($x1, $y1, $x, $y) {} - - /** - * (PECL imagick 2.0.0)- * starting x coordinate - *
- * @param float $y1- * starting y coordinate - *
- * @param float $x- * ending x coordinate - *
- * @param float $y- * ending y coordinate - *
- * @return bool No value is returned. - */ - public function pathCurveToQuadraticBezierRelative ($x1, $y1, $x, $y) {} - - /** - * (PECL imagick 2.0.0)- * ending x coordinate - *
- * @param float $y- * ending y coordinate - *
- * @return bool No value is returned. - */ - public function pathCurveToQuadraticBezierSmoothAbsolute ($x, $y) {} - - /** - * (PECL imagick 2.0.0)- * ending x coordinate - *
- * @param float $y- * ending y coordinate - *
- * @return bool No value is returned. - */ - public function pathCurveToQuadraticBezierSmoothRelative ($x, $y) {} - - /** - * (PECL imagick 2.0.0)- * x coordinate of the second control point - *
- * @param float $y2- * y coordinate of the second control point - *
- * @param float $x- * x coordinate of the ending point - *
- * @param float $y- * y coordinate of the ending point - *
- * @return bool No value is returned. - */ - public function pathCurveToSmoothAbsolute ($x2, $y2, $x, $y) {} - - /** - * (PECL imagick 2.0.0)- * x coordinate of the second control point - *
- * @param float $y2- * y coordinate of the second control point - *
- * @param float $x- * x coordinate of the ending point - *
- * @param float $y- * y coordinate of the ending point - *
- * @return bool No value is returned. - */ - public function pathCurveToSmoothRelative ($x2, $y2, $x, $y) {} - - /** - * (PECL imagick 2.0.0)- * x radius - *
- * @param float $ry- * y radius - *
- * @param float $x_axis_rotation- * x axis rotation - *
- * @param bool $large_arc_flag- * large arc flag - *
- * @param bool $sweep_flag- * sweep flag - *
- * @param float $x- * x coordinate - *
- * @param float $y- * y coordinate - *
- * @return bool No value is returned. - */ - public function pathEllipticArcAbsolute ($rx, $ry, $x_axis_rotation, $large_arc_flag, $sweep_flag, $x, $y) {} - - /** - * (PECL imagick 2.0.0)- * x radius - *
- * @param float $ry- * y radius - *
- * @param float $x_axis_rotation- * x axis rotation - *
- * @param bool $large_arc_flag- * large arc flag - *
- * @param bool $sweep_flag- * sweep flag - *
- * @param float $x- * x coordinate - *
- * @param float $y- * y coordinate - *
- * @return bool No value is returned. - */ - public function pathEllipticArcRelative ($rx, $ry, $x_axis_rotation, $large_arc_flag, $sweep_flag, $x, $y) {} - - /** - * (PECL imagick 2.0.0)- * starting x coordinate - *
- * @param float $y- * ending x coordinate - *
- * @return bool No value is returned. - */ - public function pathLineToAbsolute ($x, $y) {} - - /** - * (PECL imagick 2.0.0)- * starting x coordinate - *
- * @param float $y- * starting y coordinate - *
- * @return bool No value is returned. - */ - public function pathLineToRelative ($x, $y) {} - - /** - * (PECL imagick 2.0.0)- * x coordinate - *
- * @return bool No value is returned. - */ - public function pathLineToHorizontalAbsolute ($x) {} - - /** - * (PECL imagick 2.0.0)- * x coordinate - *
- * @return bool No value is returned. - */ - public function pathLineToHorizontalRelative ($x) {} - - /** - * (PECL imagick 2.0.0)- * y coordinate - *
- * @return bool No value is returned. - */ - public function pathLineToVerticalAbsolute ($y) {} - - /** - * (PECL imagick 2.0.0)- * y coordinate - *
- * @return bool No value is returned. - */ - public function pathLineToVerticalRelative ($y) {} - - /** - * (PECL imagick 2.0.0)- * x coordinate of the starting point - *
- * @param float $y- * y coordinate of the starting point - *
- * @return bool No value is returned. - */ - public function pathMoveToAbsolute ($x, $y) {} - - /** - * (PECL imagick 2.0.0)- * target x coordinate - *
- * @param float $y- * target y coordinate - *
- * @return bool No value is returned. - */ - public function pathMoveToRelative ($x, $y) {} - - /** - * (PECL imagick 2.0.0)- * array of x and y coordinates: array( array( 'x' => 4, 'y' => 6 ), array( 'x' => 8, 'y' => 10 ) ) - *
- * @return bool TRUE on success. - * @throws ImagickDrawException on error. - */ - public function polyline (array $coordinates) {} - - /** - * (PECL imagick 2.0.0)- * Clip mask Id - *
- * @return bool No value is returned. - */ - public function pushClipPath ($clip_mask_id) {} - - /** - * (PECL imagick 2.0.0)- * the pattern Id - *
- * @param float $x- * x coordinate of the top-left corner - *
- * @param float $y- * y coordinate of the top-left corner - *
- * @param float $width- * width of the pattern - *
- * @param float $height- * height of the pattern - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function pushPattern ($pattern_id, $x, $y, $width, $height) {} - - /** - * (PECL imagick 2.0.0)- * degrees to rotate - *
- * @return bool No value is returned. - */ - public function rotate ($degrees) {} - - /** - * (PECL imagick 2.0.0)- * horizontal factor - *
- * @param float $y- * vertical factor - *
- * @return bool No value is returned. - */ - public function scale ($x, $y) {} - - /** - * (PECL imagick 2.0.0)- * the clipping path name - *
- * @return bool No value is returned. - * @throws ImagickException on error. - */ - public function setClipPath ($clip_mask) {} - - /** - * (PECL imagick 2.0.0)- * FILLRULE_ constant - *
- * @return bool No value is returned. - */ - public function setClipRule ($fill_rule) {} - - /** - * (PECL imagick 2.0.0)- * the number of clip units - *
- * @return bool No value is returned. - */ - public function setClipUnits ($clip_units) {} - - /** - * (PECL imagick 2.0.0)- * the fill opacity - *
- * @return bool No value is returned. - */ - public function setFillOpacity ($fillOpacity) {} - - /** - * (PECL imagick 2.0.0)- * URL to use to obtain fill pattern. - *
- * @return bool TRUE on success or FALSE on failure. - * @throws ImagickException on error. - */ - public function setFillPatternURL ($fill_url) {} - - /** - * (PECL imagick 2.0.0)- * FILLRULE_ constant - *
- * @return bool No value is returned. - */ - public function setFillRule ($fill_rule) {} - - /** - * (PECL imagick 2.0.0)- * GRAVITY_ constant - *
- * @return bool No value is returned. - */ - public function setGravity ($gravity) {} - - /** - * (PECL imagick 2.0.0)- * stroke URL - *
- * @return bool imagick.imagickdraw.return.success; - * @throws ImagickException on error. - */ - public function setStrokePatternURL ($stroke_url) {} - - /** - * (PECL imagick 2.0.0)- * dash offset - *
- * @return bool No value is returned. - */ - public function setStrokeDashOffset ($dash_offset) {} - - /** - * (PECL imagick 2.0.0)- * LINECAP_ constant - *
- * @return bool No value is returned. - */ - public function setStrokeLineCap ($linecap) {} - - /** - * (PECL imagick 2.0.0)- * LINEJOIN_ constant - *
- * @return bool No value is returned. - */ - public function setStrokeLineJoin ($linejoin) {} - - /** - * (PECL imagick 2.0.0)- * the miter limit - *
- * @return bool No value is returned. - */ - public function setStrokeMiterLimit ($miterlimit) {} - - /** - * (PECL imagick 2.0.0)- * stroke opacity. 1.0 is fully opaque - *
- * @return bool No value is returned. - */ - public function setStrokeOpacity ($stroke_opacity) {} - - /** - * (PECL imagick 2.0.0)- * xml containing the vector graphics - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function setVectorGraphics ($xml) {} - - /** - * (PECL imagick 2.0.0)- * array of floats - *
- * @return bool TRUE on success. - */ - public function setStrokeDashArray (array $dashArray) {} + /** + * (PECL imagick 2.0.0)+ * degrees to rotate + *
+ * @return bool No value is returned. + */ + public function rotate($degrees) {} + + /** + * (PECL imagick 2.0.0)+ * horizontal factor + *
+ * @param float $y+ * vertical factor + *
+ * @return bool No value is returned. + */ + public function scale($x, $y) {} + + /** + * (PECL imagick 2.0.0)+ * the clipping path name + *
+ * @return bool No value is returned. + * @throws ImagickException on error. + */ + public function setClipPath($clip_mask) {} + + /** + * (PECL imagick 2.0.0)+ * FILLRULE_ constant + *
+ * @return bool No value is returned. + */ + public function setClipRule($fill_rule) {} + + /** + * (PECL imagick 2.0.0)+ * the number of clip units + *
+ * @return bool No value is returned. + */ + public function setClipUnits($clip_units) {} + + /** + * (PECL imagick 2.0.0)+ * the fill opacity + *
+ * @return bool No value is returned. + */ + public function setFillOpacity($fillOpacity) {} + + /** + * (PECL imagick 2.0.0)+ * URL to use to obtain fill pattern. + *
+ * @return bool TRUE on success or FALSE on failure. + * @throws ImagickException on error. + */ + public function setFillPatternURL($fill_url) {} + + /** + * (PECL imagick 2.0.0)+ * FILLRULE_ constant + *
+ * @return bool No value is returned. + */ + public function setFillRule($fill_rule) {} + + /** + * (PECL imagick 2.0.0)+ * GRAVITY_ constant + *
+ * @return bool No value is returned. + */ + public function setGravity($gravity) {} + + /** + * (PECL imagick 2.0.0)+ * stroke URL + *
+ * @return bool imagick.imagickdraw.return.success; + * @throws ImagickException on error. + */ + public function setStrokePatternURL($stroke_url) {} + + /** + * (PECL imagick 2.0.0)+ * dash offset + *
+ * @return bool No value is returned. + */ + public function setStrokeDashOffset($dash_offset) {} + + /** + * (PECL imagick 2.0.0)+ * LINECAP_ constant + *
+ * @return bool No value is returned. + */ + public function setStrokeLineCap($linecap) {} + + /** + * (PECL imagick 2.0.0)+ * LINEJOIN_ constant + *
+ * @return bool No value is returned. + */ + public function setStrokeLineJoin($linejoin) {} + + /** + * (PECL imagick 2.0.0)+ * the miter limit + *
+ * @return bool No value is returned. + */ + public function setStrokeMiterLimit($miterlimit) {} + + /** + * (PECL imagick 2.0.0)+ * stroke opacity. 1.0 is fully opaque + *
+ * @return bool No value is returned. + */ + public function setStrokeOpacity($stroke_opacity) {} + + /** + * (PECL imagick 2.0.0)+ * xml containing the vector graphics + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function setVectorGraphics($xml) {} + + /** + * (PECL imagick 2.0.0)+ * array of floats + *
+ * @return bool TRUE on success. + */ + public function setStrokeDashArray(array $dashArray) {} /** * Sets the opacity to use when drawing using the fill or stroke color or texture. Fully opaque is 1.0. @@ -6781,540 +6777,538 @@ public function setStrokeDashArray (array $dashArray) {} * @return void * @since 3.4.1 */ - public function setOpacity($opacity) { } - - /** - * Returns the opacity used when drawing with the fill or stroke color or texture. Fully opaque is 1.0. - * - * @return float - * @since 3.4.1 - */ - #[Pure] - public function getOpacity() { } - - /** - * Sets the image font resolution. - * - * @param float $x - * @param float $y - * @return bool - * @throws ImagickException on error. - * @since 3.4.1 - */ - public function setFontResolution($x, $y) { } - - /** - * Gets the image X and Y resolution. - * - * @return array - * @throws ImagickException on error. - * @since 3.4.1 - */ - #[Pure] - public function getFontResolution() { } - - /** - * Returns the direction that will be used when annotating with text. - * @return bool - * @since 3.4.1 - */ - #[Pure] - public function getTextDirection() { } - - /** - * Sets the font style to use when annotating with text. The AnyStyle enumeration acts as a wild-card "don't care" option. - * - * @param int $direction - * @return bool - * @since 3.4.1 - */ - public function setTextDirection($direction) { } - - /** - * Returns the border color used for drawing bordered objects. - * - * @return ImagickPixel - * @since 3.4.1 - */ - #[Pure] - public function getBorderColor() { } - - /** - * Sets the border color to be used for drawing bordered objects. - * @param ImagickPixel $color - * @return bool - * @throws ImagickDrawException on error. - * @since 3.4.1 - */ - public function setBorderColor(ImagickPixel $color) { } - - /** - * Obtains the vertical and horizontal resolution. - * - * @return string|null - * @since 3.4.1 - */ - #[Pure] - public function getDensity() { } - - /** - * Sets the vertical and horizontal resolution. - * @param string $density_string - * @return bool - * @throws ImagickException on error. - * @since 3.4.1 - */ - public function setDensity($density_string) { } + public function setOpacity($opacity) {} + + /** + * Returns the opacity used when drawing with the fill or stroke color or texture. Fully opaque is 1.0. + * + * @return float + * @since 3.4.1 + */ + #[Pure] + public function getOpacity() {} + + /** + * Sets the image font resolution. + * + * @param float $x + * @param float $y + * @return bool + * @throws ImagickException on error. + * @since 3.4.1 + */ + public function setFontResolution($x, $y) {} + + /** + * Gets the image X and Y resolution. + * + * @return array + * @throws ImagickException on error. + * @since 3.4.1 + */ + #[Pure] + public function getFontResolution() {} + + /** + * Returns the direction that will be used when annotating with text. + * @return bool + * @since 3.4.1 + */ + #[Pure] + public function getTextDirection() {} + + /** + * Sets the font style to use when annotating with text. The AnyStyle enumeration acts as a wild-card "don't care" option. + * + * @param int $direction + * @return bool + * @since 3.4.1 + */ + public function setTextDirection($direction) {} + + /** + * Returns the border color used for drawing bordered objects. + * + * @return ImagickPixel + * @since 3.4.1 + */ + #[Pure] + public function getBorderColor() {} + + /** + * Sets the border color to be used for drawing bordered objects. + * @param ImagickPixel $color + * @return bool + * @throws ImagickDrawException on error. + * @since 3.4.1 + */ + public function setBorderColor(ImagickPixel $color) {} + + /** + * Obtains the vertical and horizontal resolution. + * + * @return string|null + * @since 3.4.1 + */ + #[Pure] + public function getDensity() {} + + /** + * Sets the vertical and horizontal resolution. + * @param string $density_string + * @return bool + * @throws ImagickException on error. + * @since 3.4.1 + */ + public function setDensity($density_string) {} } /** * @link https://php.net/manual/en/class.imagickpixeliterator.php */ -class ImagickPixelIterator implements Iterator { - - /** - * (PECL imagick 2.0.0)- * The normalized value for hue, described as a fractional arc - * (between 0 and 1) of the hue circle, where the zero value is - * red. - *
- * @param float $saturation- * The normalized value for saturation, with 1 as full saturation. - *
- * @param float $luminosity- * The normalized value for luminosity, on a scale from black at - * 0 to white at 1, with the full HS value at 0.5 luminosity. - *
- * @return bool TRUE on success. - * @throws ImagickPixelException on failure - */ - public function setHSL ($hue, $saturation, $luminosity) {} - - /** - * @throws ImagickPixelException on failure - */ - #[Pure] - public function getColorValueQuantum () {} - - /** - * @param $color_value - * @throws ImagickPixelException on failure - */ - public function setColorValueQuantum ($color_value) {} + #[Pure] + public function getHSL() {} + + /** + * (PECL imagick 2.0.0)+ * The normalized value for hue, described as a fractional arc + * (between 0 and 1) of the hue circle, where the zero value is + * red. + *
+ * @param float $saturation+ * The normalized value for saturation, with 1 as full saturation. + *
+ * @param float $luminosity+ * The normalized value for luminosity, on a scale from black at + * 0 to white at 1, with the full HS value at 0.5 luminosity. + *
+ * @return bool TRUE on success. + * @throws ImagickPixelException on failure + */ + public function setHSL($hue, $saturation, $luminosity) {} + + /** + * @throws ImagickPixelException on failure + */ + #[Pure] + public function getColorValueQuantum() {} + + /** + * @param $color_value + * @throws ImagickPixelException on failure + */ + public function setColorValueQuantum($color_value) {} /** * Gets the colormap index of the pixel wand. - * @throws ImagickPixelException on failure - */ - #[Pure] - public function getIndex () {} - - /** - * @param int $index - * @throws ImagickPixelException on failure - */ - public function setIndex ($index) {} - - /** - * (PECL imagick 2.0.0)- * The optional color string to use as the initial value of this object. - *
- * @throws ImagickPixelException on failure - */ - public function __construct ($color = null) {} - - /** - * (PECL imagick 2.0.0)- * The color definition to use in order to initialise the - * ImagickPixel object. - *
- * @return bool TRUE if the specified color was set, FALSE otherwise. - * @throws ImagickPixelException on failure - */ - public function setColor ($color) {} - - /** - * (PECL imagick 2.0.0)- * One of the Imagick color constants e.g. \Imagick::COLOR_GREEN or \Imagick::COLOR_ALPHA. - *
- * @param float $value- * The value to set this channel to, ranging from 0 to 1. - *
- * @return bool TRUE on success. - * @throws ImagickPixelException on failure - */ - public function setColorValue ($color, $value) {} - - /** - * (PECL imagick 2.0.0)- * The color to get the value of, specified as one of the Imagick color - * constants. This can be one of the RGB colors, CMYK colors, alpha and - * opacity e.g (Imagick::COLOR_BLUE, Imagick::COLOR_MAGENTA). - *
- * @return float The value of the channel, as a normalized floating-point number, throwing - * ImagickPixelException on error. - * @throws ImagickPixelException on error - */ - #[Pure] - public function getColorValue ($color) {} - - /** - * (PECL imagick 2.0.0)- * The ImagickPixel object to compare this object against. - *
- * @param float $fuzz- * The maximum distance within which to consider these colors as similar. - * The theoretical maximum for this value is the square root of three - * (1.732). - *
- * @return bool TRUE on success. - * @throws ImagickPixelException on failure - */ - public function isSimilar (ImagickPixel $color, $fuzz) {} - - /** - * (No version information available, might only be in SVN)- * The ImagickPixel object to compare this object against. - *
- * @param float $fuzz- * The maximum distance within which to consider these colors as similar. - * The theoretical maximum for this value is the square root of three - * (1.732). - *
- * @return bool TRUE on success. - * @throws ImagickPixelException on failure - */ - public function isPixelSimilar (ImagickPixel $color, $fuzz) {} - - /** - * (PECL imagick 2.0.0)- * Normalize the color values - *
- * @return array An array of channel values, each normalized if TRUE is given as param. Throws - * ImagickPixelException on error. - * @throws ImagickPixelException on error. - */ + * @throws ImagickPixelException on failure + */ + #[Pure] + public function getIndex() {} + + /** + * @param int $index + * @throws ImagickPixelException on failure + */ + public function setIndex($index) {} + + /** + * (PECL imagick 2.0.0)+ * The optional color string to use as the initial value of this object. + *
+ * @throws ImagickPixelException on failure + */ + public function __construct($color = null) {} + + /** + * (PECL imagick 2.0.0)+ * The color definition to use in order to initialise the + * ImagickPixel object. + *
+ * @return bool TRUE if the specified color was set, FALSE otherwise. + * @throws ImagickPixelException on failure + */ + public function setColor($color) {} + + /** + * (PECL imagick 2.0.0)+ * One of the Imagick color constants e.g. \Imagick::COLOR_GREEN or \Imagick::COLOR_ALPHA. + *
+ * @param float $value+ * The value to set this channel to, ranging from 0 to 1. + *
+ * @return bool TRUE on success. + * @throws ImagickPixelException on failure + */ + public function setColorValue($color, $value) {} + + /** + * (PECL imagick 2.0.0)+ * The color to get the value of, specified as one of the Imagick color + * constants. This can be one of the RGB colors, CMYK colors, alpha and + * opacity e.g (Imagick::COLOR_BLUE, Imagick::COLOR_MAGENTA). + *
+ * @return float The value of the channel, as a normalized floating-point number, throwing + * ImagickPixelException on error. + * @throws ImagickPixelException on error + */ + #[Pure] + public function getColorValue($color) {} + + /** + * (PECL imagick 2.0.0)+ * The ImagickPixel object to compare this object against. + *
+ * @param float $fuzz+ * The maximum distance within which to consider these colors as similar. + * The theoretical maximum for this value is the square root of three + * (1.732). + *
+ * @return bool TRUE on success. + * @throws ImagickPixelException on failure + */ + public function isSimilar(ImagickPixel $color, $fuzz) {} + + /** + * (No version information available, might only be in SVN)+ * The ImagickPixel object to compare this object against. + *
+ * @param float $fuzz+ * The maximum distance within which to consider these colors as similar. + * The theoretical maximum for this value is the square root of three + * (1.732). + *
+ * @return bool TRUE on success. + * @throws ImagickPixelException on failure + */ + public function isPixelSimilar(ImagickPixel $color, $fuzz) {} + + /** + * (PECL imagick 2.0.0)+ * Normalize the color values + *
+ * @return array An array of channel values, each normalized if TRUE is given as param. Throws + * ImagickPixelException on error. + * @throws ImagickPixelException on error. + */ #[ArrayShape([ "r" => "int|float", "g" => "int|float", "b" => "int|float", "a" => "int|float" ])] - #[Pure] - public function getColor ($normalized = 0) {} - - /** - * (PECL imagick 2.1.0)* Returns FALSE on failure. */ -function imap_check ($imap_stream) {} +function imap_check($imap_stream) {} /** * Returns the list of mailboxes that matches the given text @@ -586,7 +586,7 @@ function imap_check ($imap_stream) {} * @return array|false an array containing the names of the mailboxes that have * content in the text of the mailbox. */ -function imap_listscan ($imap_stream, $ref, $pattern, $content) {} +function imap_listscan($imap_stream, $ref, $pattern, $content) {} /** * Copy specified messages to a mailbox @@ -605,7 +605,7 @@ function imap_listscan ($imap_stream, $ref, $pattern, $content) {} * CP_UID - the sequence numbers contain UIDS
* @return bool TRUE on success or FALSE on failure. */ -function imap_mail_copy ($imap_stream, $msglist, $mailbox, $options = 0) {} +function imap_mail_copy($imap_stream, $msglist, $mailbox, $options = 0) {} /** * Move specified messages to a mailbox @@ -624,7 +624,7 @@ function imap_mail_copy ($imap_stream, $msglist, $mailbox, $options = 0) {} * CP_UID - the sequence numbers contain UIDS * @return bool TRUE on success or FALSE on failure. */ -function imap_mail_move ($imap_stream, $msglist, $mailbox, $options = 0) {} +function imap_mail_move($imap_stream, $msglist, $mailbox, $options = 0) {} /** * Create a MIME message based on given envelope and body sections @@ -646,7 +646,7 @@ function imap_mail_move ($imap_stream, $msglist, $mailbox, $options = 0) {} * * @return string the MIME message. */ -function imap_mail_compose (array $envelope, array $body) {} +function imap_mail_compose(array $envelope, array $body) {} /** * Create a new mailbox @@ -659,7 +659,7 @@ function imap_mail_compose (array $envelope, array $body) {} * * @return bool TRUE on success or FALSE on failure. */ -function imap_createmailbox ($imap_stream, $mailbox) {} +function imap_createmailbox($imap_stream, $mailbox) {} /** * Rename an old mailbox to new mailbox @@ -675,7 +675,7 @@ function imap_createmailbox ($imap_stream, $mailbox) {} * * @return bool TRUE on success or FALSE on failure. */ -function imap_renamemailbox ($imap_stream, $old_mbox, $new_mbox) {} +function imap_renamemailbox($imap_stream, $old_mbox, $new_mbox) {} /** * Delete a mailbox @@ -687,7 +687,7 @@ function imap_renamemailbox ($imap_stream, $old_mbox, $new_mbox) {} * * @return bool TRUE on success or FALSE on failure. */ -function imap_deletemailbox ($imap_stream, $mailbox) {} +function imap_deletemailbox($imap_stream, $mailbox) {} /** * Subscribe to a mailbox @@ -699,7 +699,7 @@ function imap_deletemailbox ($imap_stream, $mailbox) {} * * @return bool TRUE on success or FALSE on failure. */ -function imap_subscribe ($imap_stream, $mailbox) {} +function imap_subscribe($imap_stream, $mailbox) {} /** * Unsubscribe from a mailbox @@ -711,7 +711,7 @@ function imap_subscribe ($imap_stream, $mailbox) {} * * @return bool TRUE on success or FALSE on failure. */ -function imap_unsubscribe ($imap_stream, $mailbox) {} +function imap_unsubscribe($imap_stream, $mailbox) {} /** * Append a string message to a specified mailbox @@ -738,7 +738,7 @@ function imap_unsubscribe ($imap_stream, $mailbox) {} * * @return bool TRUE on success or FALSE on failure. */ -function imap_append ($imap_stream, $mailbox, $message, $options = null, $internal_date = null) {} +function imap_append($imap_stream, $mailbox, $message, $options = null, $internal_date = null) {} /** * Check if the IMAP stream is still active @@ -746,7 +746,7 @@ function imap_append ($imap_stream, $mailbox, $message, $options = null, $intern * @param resource $imap_stream * @return bool TRUE if the stream is still alive, FALSE otherwise. */ -function imap_ping ($imap_stream) {} +function imap_ping($imap_stream) {} /** * Decode BASE64 encoded text @@ -756,7 +756,7 @@ function imap_ping ($imap_stream) {} * * @return string the decoded message as a string. */ -function imap_base64 ($text) {} +function imap_base64($text) {} /** * Convert a quoted-printable string to an 8 bit string @@ -766,7 +766,7 @@ function imap_base64 ($text) {} * * @return string an 8 bits string. */ -function imap_qprint ($string) {} +function imap_qprint($string) {} /** * Convert an 8bit string to a quoted-printable string @@ -776,7 +776,7 @@ function imap_qprint ($string) {} * * @return string a quoted-printable string. */ -function imap_8bit ($string) {} +function imap_8bit($string) {} /** * Convert an 8bit string to a base64 string @@ -786,7 +786,7 @@ function imap_8bit ($string) {} * * @return string a base64 encoded string. */ -function imap_binary ($string) {} +function imap_binary($string) {} /** * Converts MIME-encoded text to UTF-8 @@ -797,7 +797,7 @@ function imap_binary ($string) {} * * @return string an UTF-8 encoded string. */ -function imap_utf8 ($mime_encoded_text) {} +function imap_utf8($mime_encoded_text) {} /** * Returns status information on a mailbox @@ -820,13 +820,13 @@ function imap_utf8 ($mime_encoded_text) {} * flags is also set, which contains a bitmask which can * be checked against any of the above constants. */ -function imap_status ($imap_stream, $mailbox, $options) {} +function imap_status($imap_stream, $mailbox, $options) {} /** * @param $stream_id * @param $options */ -function imap_status_current ($stream_id, $options) {} +function imap_status_current($stream_id, $options) {} /** * Get information about the current mailbox @@ -872,7 +872,7 @@ function imap_status_current ($stream_id, $options) {} ** Returns FALSE on failure. */ -function imap_mailboxmsginfo ($imap_stream) {} +function imap_mailboxmsginfo($imap_stream) {} /** * Sets flags on messages @@ -895,7 +895,7 @@ function imap_mailboxmsginfo ($imap_stream) {} * instead of sequence numbers
* @return bool TRUE on success or FALSE on failure. */ -function imap_setflag_full ($imap_stream, $sequence, $flag, $options = NIL) {} +function imap_setflag_full($imap_stream, $sequence, $flag, $options = NIL) {} /** * Clears flags on messages @@ -917,7 +917,7 @@ function imap_setflag_full ($imap_stream, $sequence, $flag, $options = NIL) {} * instead of sequence numbers * @return bool TRUE on success or FALSE on failure. */ -function imap_clearflag_full ($imap_stream, $sequence, $flag, $options = 0) {} +function imap_clearflag_full($imap_stream, $sequence, $flag, $options = 0) {} /** * Gets and sort messages @@ -938,7 +938,7 @@ function imap_clearflag_full ($imap_stream, $sequence, $flag, $options = 0) {} * @return array an array of message numbers sorted by the given * parameters. */ -function imap_sort ($imap_stream, $criteria, $reverse, $options = 0, $search_criteria = null, $charset = 'NIL') {} +function imap_sort($imap_stream, $criteria, $reverse, $options = 0, $search_criteria = null, $charset = 'NIL') {} /** * This function returns the UID for the given message sequence number @@ -949,7 +949,7 @@ function imap_sort ($imap_stream, $criteria, $reverse, $options = 0, $search_cri * * @return int The UID of the given message. */ -function imap_uid ($imap_stream, $msg_number) {} +function imap_uid($imap_stream, $msg_number) {} /** * Gets the message sequence number for the given UID @@ -961,7 +961,7 @@ function imap_uid ($imap_stream, $msg_number) {} * @return int the message sequence number for the given * uid. */ -function imap_msgno ($imap_stream, $uid) {} +function imap_msgno($imap_stream, $uid) {} /** * Read the list of mailboxes @@ -985,7 +985,7 @@ function imap_msgno ($imap_stream, $uid) {} * mailboxes; '~/mail/%' on UW_IMAPD will return every mailbox in the ~/mail directory, but none in subfolders of that directory. * @return array|false an array containing the names of the mailboxes. */ -function imap_list ($imap_stream, $ref, $pattern) {} +function imap_list($imap_stream, $ref, $pattern) {} /** * List all the subscribed mailboxes @@ -1009,7 +1009,7 @@ function imap_list ($imap_stream, $ref, $pattern) {} * mailboxes; '~/mail/%' on UW_IMAPD will return every mailbox in the ~/mail directory, but none in subfolders of that directory. * @return array an array of all the subscribed mailboxes. */ -function imap_lsub ($imap_stream, $ref, $pattern) {} +function imap_lsub($imap_stream, $ref, $pattern) {} /** * Read an overview of the information in the headers of the given message @@ -1045,7 +1045,7 @@ function imap_lsub ($imap_stream, $ref, $pattern) {} * seen - this message is flagged as already read * draft - this message is flagged as being a draft */ -function imap_fetch_overview ($imap_stream, $sequence, $options = 0) {} +function imap_fetch_overview($imap_stream, $sequence, $options = 0) {} /** * Returns all IMAP alert messages that have occurred @@ -1053,7 +1053,7 @@ function imap_fetch_overview ($imap_stream, $sequence, $options = 0) {} * @return array|false an array of all of the IMAP alert messages generated or FALSE if * no alert messages are available. */ -function imap_alerts () {} +function imap_alerts() {} /** * Returns all of the IMAP errors that have occurred @@ -1063,7 +1063,7 @@ function imap_alerts () {} * or the beginning of the page. Returns FALSE if no error messages are * available. */ -function imap_errors () {} +function imap_errors() {} /** * Gets the last IMAP error that occurred during this page request @@ -1071,7 +1071,7 @@ function imap_errors () {} * @return string|false the full text of the last IMAP error message that occurred on the * current page. Returns FALSE if no error messages are available. */ -function imap_last_error () {} +function imap_last_error() {} /** * This function returns an array of messages matching the given search criteria @@ -1095,7 +1095,7 @@ function imap_last_error () {} * criteria or no messages have been found. * */ -function imap_search ($imap_stream, $criteria, $options = SE_FREE, $charset = NIL) {} +function imap_search($imap_stream, $criteria, $options = SE_FREE, $charset = NIL) {} /** * Decodes a modified UTF-7 encoded string @@ -1110,7 +1110,7 @@ function imap_search ($imap_stream, $criteria, $options = SE_FREE, $charset = NI * or text contains a character that is not part of * ISO-8859-1 character set. */ -function imap_utf7_decode ($text) {} +function imap_utf7_decode($text) {} /** * Converts ISO-8859-1 string to modified UTF-7 text @@ -1122,7 +1122,7 @@ function imap_utf7_decode ($text) {} * encoding as defined in RFC 2060, * section 5.1.3 (original UTF-7 was defined in RFC1642). */ -function imap_utf7_encode ($data) {} +function imap_utf7_encode($data) {} /** * Decode MIME header elements @@ -1139,7 +1139,7 @@ function imap_utf7_encode ($data) {} * plain US-ASCII, the charset property of that element is * set to default. */ -function imap_mime_header_decode ($text) {} +function imap_mime_header_decode($text) {} /** * Returns a tree of threaded message @@ -1163,7 +1163,7 @@ function imap_mime_header_decode ($text) {} * $thread["XX.branch"] * */ -function imap_thread ($imap_stream, $options = SE_FREE) {} +function imap_thread($imap_stream, $options = SE_FREE) {} /** * Set or fetch imap timeout @@ -1186,7 +1186,7 @@ function imap_thread ($imap_stream, $options = SE_FREE) {} * the current timeout value of timeout_type is * returned as an integer. */ -function imap_timeout ($timeout_type, $timeout = -1) {} +function imap_timeout($timeout_type, $timeout = -1) {} /** * Retrieve the quota level settings, and usage statics per mailbox @@ -1214,7 +1214,7 @@ function imap_timeout ($timeout_type, $timeout = -1) {} * For backwards compatibility reasons, the original access methods are * still available for use, although it is suggested to update. */ -function imap_get_quota ($imap_stream, $quota_root) {} +function imap_get_quota($imap_stream, $quota_root) {} /** * Retrieve the quota settings per user @@ -1233,7 +1233,7 @@ function imap_get_quota ($imap_stream, $quota_root) {} * array of information about the connection upon an un-parsable response * from the server. */ -function imap_get_quotaroot ($imap_stream, $quota_root) {} +function imap_get_quotaroot($imap_stream, $quota_root) {} /** * Sets a quota for a given mailbox @@ -1248,7 +1248,7 @@ function imap_get_quotaroot ($imap_stream, $quota_root) {} * * @return bool TRUE on success or FALSE on failure. */ -function imap_set_quota ($imap_stream, $quota_root, $quota_limit) {} +function imap_set_quota($imap_stream, $quota_root, $quota_limit) {} /** * Sets the ACL for a given mailbox @@ -1267,7 +1267,7 @@ function imap_set_quota ($imap_stream, $quota_root, $quota_limit) {} * * @return bool TRUE on success or FALSE on failure. */ -function imap_setacl ($imap_stream, $mailbox, $id, $rights) {} +function imap_setacl($imap_stream, $mailbox, $id, $rights) {} /** * Gets the ACL for a given mailbox @@ -1279,13 +1279,13 @@ function imap_setacl ($imap_stream, $mailbox, $id, $rights) {} * * @return array an associative array of "folder" => "acl" pairs. */ -function imap_getacl ($imap_stream, $mailbox) {} +function imap_getacl($imap_stream, $mailbox) {} /** * @param $stream_id * @param $mailbox */ -function imap_myrights ($stream_id, $mailbox) {} +function imap_myrights($stream_id, $mailbox) {} /** * @param $stream_id @@ -1294,7 +1294,7 @@ function imap_myrights ($stream_id, $mailbox) {} * @param $attr * @param $value */ -function imap_setannotation ($stream_id, $mailbox, $entry, $attr, $value) {} +function imap_setannotation($stream_id, $mailbox, $entry, $attr, $value) {} /** * @param $stream_id @@ -1302,7 +1302,7 @@ function imap_setannotation ($stream_id, $mailbox, $entry, $attr, $value) {} * @param $entry * @param $attr */ -function imap_getannotation ($stream_id, $mailbox, $entry, $attr) {} +function imap_getannotation($stream_id, $mailbox, $entry, $attr) {} /** * Send an email message @@ -1330,7 +1330,7 @@ function imap_getannotation ($stream_id, $mailbox, $entry, $attr) {} * * @return bool TRUE on success or FALSE on failure. */ -function imap_mail ($to, $subject, $message, $additional_headers = null, $cc = null, $bcc = null, $rpath = null) {} +function imap_mail($to, $subject, $message, $additional_headers = null, $cc = null, $bcc = null, $rpath = null) {} /** * Alias of imap_headerinfo @@ -1380,7 +1380,7 @@ function imap_mail ($to, $subject, $message, $additional_headers = null, $cc = n *
* @return string body of the specified message
*/
-function imap_fetchtext ($stream, $msg_no, $options = 0) {}
+function imap_fetchtext($stream, $msg_no, $options = 0) {}
/**
* Alias of imap_listscan
@@ -1520,7 +1520,7 @@ function imap_fetchtext ($stream, $msg_no, $options = 0) {}
* @param $pattern
* @param $content
*/
-function imap_scan ($stream_id, $ref, $pattern, $content) {}
+function imap_scan($stream_id, $ref, $pattern, $content) {}
/**
* Alias of imap_createmailbox
@@ -1528,7 +1528,7 @@ function imap_scan ($stream_id, $ref, $pattern, $content) {}
* @param $stream_id
* @param $mailbox
*/
-function imap_create ($stream_id, $mailbox) {}
+function imap_create($stream_id, $mailbox) {}
/**
* Alias of imap_renamemailbox
@@ -1537,7 +1537,7 @@ function imap_create ($stream_id, $mailbox) {}
* @param $old_name
* @param $new_name
*/
-function imap_rename ($stream_id, $old_name, $new_name) {}
+function imap_rename($stream_id, $old_name, $new_name) {}
/**
* Decode a modified UTF-7 string to UTF-8
@@ -1559,215 +1559,215 @@ function imap_mutf7_to_utf8($in) {}
*/
function imap_utf8_to_mutf7($in) {}
-define ('NIL', 0);
-define ('IMAP_OPENTIMEOUT', 1);
-define ('IMAP_READTIMEOUT', 2);
-define ('IMAP_WRITETIMEOUT', 3);
-define ('IMAP_CLOSETIMEOUT', 4);
-define ('OP_DEBUG', 1);
+define('NIL', 0);
+define('IMAP_OPENTIMEOUT', 1);
+define('IMAP_READTIMEOUT', 2);
+define('IMAP_WRITETIMEOUT', 3);
+define('IMAP_CLOSETIMEOUT', 4);
+define('OP_DEBUG', 1);
/**
* Open mailbox read-only
* @link https://php.net/manual/en/imap.constants.php
*/
-define ('OP_READONLY', 2);
+define('OP_READONLY', 2);
/**
* Don't use or update a .newsrc for news
* (NNTP only)
* @link https://php.net/manual/en/imap.constants.php
*/
-define ('OP_ANONYMOUS', 4);
-define ('OP_SHORTCACHE', 8);
-define ('OP_SILENT', 16);
-define ('OP_PROTOTYPE', 32);
+define('OP_ANONYMOUS', 4);
+define('OP_SHORTCACHE', 8);
+define('OP_SILENT', 16);
+define('OP_PROTOTYPE', 32);
/**
* For IMAP and NNTP
* names, open a connection but don't open a mailbox.
* @link https://php.net/manual/en/imap.constants.php
*/
-define ('OP_HALFOPEN', 64);
-define ('OP_EXPUNGE', 128);
-define ('OP_SECURE', 256);
+define('OP_HALFOPEN', 64);
+define('OP_EXPUNGE', 128);
+define('OP_SECURE', 256);
/**
* silently expunge the mailbox before closing when
* calling imap_close
* @link https://php.net/manual/en/imap.constants.php
*/
-define ('CL_EXPUNGE', 32768);
+define('CL_EXPUNGE', 32768);
/**
* The parameter is a UID
* @link https://php.net/manual/en/imap.constants.php
*/
-define ('FT_UID', 1);
+define('FT_UID', 1);
/**
* Do not set the \Seen flag if not already set
* @link https://php.net/manual/en/imap.constants.php
*/
-define ('FT_PEEK', 2);
-define ('FT_NOT', 4);
+define('FT_PEEK', 2);
+define('FT_NOT', 4);
/**
* The return string is in internal format, will not canonicalize to CRLF.
* @link https://php.net/manual/en/imap.constants.php
*/
-define ('FT_INTERNAL', 8);
-define ('FT_PREFETCHTEXT', 32);
+define('FT_INTERNAL', 8);
+define('FT_PREFETCHTEXT', 32);
/**
* The sequence argument contains UIDs instead of sequence numbers
* @link https://php.net/manual/en/imap.constants.php
*/
-define ('ST_UID', 1);
-define ('ST_SILENT', 2);
-define ('ST_SET', 4);
+define('ST_UID', 1);
+define('ST_SILENT', 2);
+define('ST_SET', 4);
/**
* the sequence numbers contain UIDS
* @link https://php.net/manual/en/imap.constants.php
*/
-define ('CP_UID', 1);
+define('CP_UID', 1);
/**
* Delete the messages from the current mailbox after copying
* with imap_mail_copy
* @link https://php.net/manual/en/imap.constants.php
*/
-define ('CP_MOVE', 2);
+define('CP_MOVE', 2);
/**
* Return UIDs instead of sequence numbers
* @link https://php.net/manual/en/imap.constants.php
*/
-define ('SE_UID', 1);
-define ('SE_FREE', 2);
+define('SE_UID', 1);
+define('SE_FREE', 2);
/**
* Don't prefetch searched messages
* @link https://php.net/manual/en/imap.constants.php
*/
-define ('SE_NOPREFETCH', 4);
-define ('SO_FREE', 8);
-define ('SO_NOSERVER', 16);
-define ('SA_MESSAGES', 1);
-define ('SA_RECENT', 2);
-define ('SA_UNSEEN', 4);
-define ('SA_UIDNEXT', 8);
-define ('SA_UIDVALIDITY', 16);
-define ('SA_ALL', 31);
+define('SE_NOPREFETCH', 4);
+define('SO_FREE', 8);
+define('SO_NOSERVER', 16);
+define('SA_MESSAGES', 1);
+define('SA_RECENT', 2);
+define('SA_UNSEEN', 4);
+define('SA_UIDNEXT', 8);
+define('SA_UIDVALIDITY', 16);
+define('SA_ALL', 31);
/**
* This mailbox has no "children" (there are no
* mailboxes below this one).
* @link https://php.net/manual/en/imap.constants.php
*/
-define ('LATT_NOINFERIORS', 1);
+define('LATT_NOINFERIORS', 1);
/**
* This is only a container, not a mailbox - you
* cannot open it.
* @link https://php.net/manual/en/imap.constants.php
*/
-define ('LATT_NOSELECT', 2);
+define('LATT_NOSELECT', 2);
/**
* This mailbox is marked. Only used by UW-IMAPD.
* @link https://php.net/manual/en/imap.constants.php
*/
-define ('LATT_MARKED', 4);
+define('LATT_MARKED', 4);
/**
* This mailbox is not marked. Only used by
* UW-IMAPD.
* @link https://php.net/manual/en/imap.constants.php
*/
-define ('LATT_UNMARKED', 8);
-define ('LATT_REFERRAL', 16);
-define ('LATT_HASCHILDREN', 32);
-define ('LATT_HASNOCHILDREN', 64);
+define('LATT_UNMARKED', 8);
+define('LATT_REFERRAL', 16);
+define('LATT_HASCHILDREN', 32);
+define('LATT_HASNOCHILDREN', 64);
/**
* Sort criteria for imap_sort:
* message Date
* @link https://php.net/manual/en/imap.constants.php
*/
-define ('SORTDATE', 0);
+define('SORTDATE', 0);
/**
* Sort criteria for imap_sort:
* arrival date
* @link https://php.net/manual/en/imap.constants.php
*/
-define ('SORTARRIVAL', 1);
+define('SORTARRIVAL', 1);
/**
* Sort criteria for imap_sort:
* mailbox in first From address
* @link https://php.net/manual/en/imap.constants.php
*/
-define ('SORTFROM', 2);
+define('SORTFROM', 2);
/**
* Sort criteria for imap_sort:
* message subject
* @link https://php.net/manual/en/imap.constants.php
*/
-define ('SORTSUBJECT', 3);
+define('SORTSUBJECT', 3);
/**
* Sort criteria for imap_sort:
* mailbox in first To address
* @link https://php.net/manual/en/imap.constants.php
*/
-define ('SORTTO', 4);
+define('SORTTO', 4);
/**
* Sort criteria for imap_sort:
* mailbox in first cc address
* @link https://php.net/manual/en/imap.constants.php
*/
-define ('SORTCC', 5);
+define('SORTCC', 5);
/**
* Sort criteria for imap_sort:
* size of message in octets
* @link https://php.net/manual/en/imap.constants.php
*/
-define ('SORTSIZE', 6);
-define ('TYPETEXT', 0);
-define ('TYPEMULTIPART', 1);
-define ('TYPEMESSAGE', 2);
-define ('TYPEAPPLICATION', 3);
-define ('TYPEAUDIO', 4);
-define ('TYPEIMAGE', 5);
-define ('TYPEVIDEO', 6);
-define ('TYPEMODEL', 7);
-define ('TYPEOTHER', 8);
-define ('ENC7BIT', 0);
-define ('ENC8BIT', 1);
-define ('ENCBINARY', 2);
-define ('ENCBASE64', 3);
-define ('ENCQUOTEDPRINTABLE', 4);
-define ('ENCOTHER', 5);
+define('SORTSIZE', 6);
+define('TYPETEXT', 0);
+define('TYPEMULTIPART', 1);
+define('TYPEMESSAGE', 2);
+define('TYPEAPPLICATION', 3);
+define('TYPEAUDIO', 4);
+define('TYPEIMAGE', 5);
+define('TYPEVIDEO', 6);
+define('TYPEMODEL', 7);
+define('TYPEOTHER', 8);
+define('ENC7BIT', 0);
+define('ENC8BIT', 1);
+define('ENCBINARY', 2);
+define('ENCBASE64', 3);
+define('ENCQUOTEDPRINTABLE', 4);
+define('ENCOTHER', 5);
/**
* Garbage collector, clear message cache elements.
* @link https://php.net/manual/en/imap.constants.php
*/
-define ('IMAP_GC_ELT', 1);
+define('IMAP_GC_ELT', 1);
/**
* Garbage collector, clear envelopes and bodies.
* @link https://php.net/manual/en/imap.constants.php
*/
-define ('IMAP_GC_ENV', 2);
+define('IMAP_GC_ENV', 2);
/**
* Garbage collector, clear texts.
* @link https://php.net/manual/en/imap.constants.php
*/
-define ('IMAP_GC_TEXTS', 4);
+define('IMAP_GC_TEXTS', 4);
diff --git a/inotify/inotify.php b/inotify/inotify.php
index 829ec4b7e..dfcfbd2e3 100644
--- a/inotify/inotify.php
+++ b/inotify/inotify.php
@@ -14,9 +14,7 @@
*
* @return int a unique (inotify instance-wide) watch descriptor.
*/
-function inotify_add_watch( $inotify_instance, $pathname, $mask )
-{
-}
+function inotify_add_watch($inotify_instance, $pathname, $mask) {}
/**
* (PHP >= 5.2.0, PECL inotify >= 0.1.2)
@@ -25,9 +23,7 @@ function inotify_add_watch( $inotify_instance, $pathname, $mask )
* @link https://php.net/manual/en/function.inotify-init.php
* @return resource|false a stream resource or FALSE on error.
*/
-function inotify_init()
-{
-}
+function inotify_init() {}
/**
* (PHP >= 5.2.0, PECL inotify >= 0.1.2)
@@ -41,9 +37,7 @@ function inotify_init()
*
* @return int a number greater than zero if events are pending, otherwise zero.
*/
-function inotify_queue_len( $inotify_instance )
-{
-}
+function inotify_queue_len($inotify_instance) {}
/**
* (PHP >= 5.2.0, PECL inotify >= 0.1.2)
@@ -64,9 +58,7 @@ function inotify_queue_len( $inotify_instance )
*
The methods and constants adhere closely to the names and behavior used by the underlying ICU library.
* @since 7.0 */ -class IntlChar { - const UNICODE_VERSION = 13.0; - const CODEPOINT_MIN = 0; - const CODEPOINT_MAX = 1114111; - const FOLD_CASE_DEFAULT = 0; - const FOLD_CASE_EXCLUDE_SPECIAL_I = 1; - const PROPERTY_ALPHABETIC = 0; - const PROPERTY_BINARY_START = 0; - const PROPERTY_ASCII_HEX_DIGIT = 1; - const PROPERTY_BIDI_CONTROL = 2; - const PROPERTY_BIDI_MIRRORED = 3; - const PROPERTY_DASH = 4; - const PROPERTY_DEFAULT_IGNORABLE_CODE_POINT = 5; - const PROPERTY_DEPRECATED = 6; - const PROPERTY_DIACRITIC = 7; - const PROPERTY_EXTENDER = 8; - const PROPERTY_FULL_COMPOSITION_EXCLUSION = 9; - const PROPERTY_GRAPHEME_BASE = 10; - const PROPERTY_GRAPHEME_EXTEND = 11; - const PROPERTY_GRAPHEME_LINK = 12; - const PROPERTY_HEX_DIGIT = 13; - const PROPERTY_HYPHEN = 14; - const PROPERTY_ID_CONTINUE = 15; - const PROPERTY_ID_START = 16; - const PROPERTY_IDEOGRAPHIC = 17; - const PROPERTY_IDS_BINARY_OPERATOR = 18; - const PROPERTY_IDS_TRINARY_OPERATOR = 19; - const PROPERTY_JOIN_CONTROL = 20; - const PROPERTY_LOGICAL_ORDER_EXCEPTION = 21; - const PROPERTY_LOWERCASE = 22; - const PROPERTY_MATH = 23; - const PROPERTY_NONCHARACTER_CODE_POINT = 24; - const PROPERTY_QUOTATION_MARK = 25; - const PROPERTY_RADICAL = 26; - const PROPERTY_SOFT_DOTTED = 27; - const PROPERTY_TERMINAL_PUNCTUATION = 28; - const PROPERTY_UNIFIED_IDEOGRAPH = 29; - const PROPERTY_UPPERCASE = 30; - const PROPERTY_WHITE_SPACE = 31; - const PROPERTY_XID_CONTINUE = 32; - const PROPERTY_XID_START = 33; - const PROPERTY_CASE_SENSITIVE = 34; - const PROPERTY_S_TERM = 35; - const PROPERTY_VARIATION_SELECTOR = 36; - const PROPERTY_NFD_INERT = 37; - const PROPERTY_NFKD_INERT = 38; - const PROPERTY_NFC_INERT = 39; - const PROPERTY_NFKC_INERT = 40; - const PROPERTY_SEGMENT_STARTER = 41; - const PROPERTY_PATTERN_SYNTAX = 42; - const PROPERTY_PATTERN_WHITE_SPACE = 43; - const PROPERTY_POSIX_ALNUM = 44; - const PROPERTY_POSIX_BLANK = 45; - const PROPERTY_POSIX_GRAPH = 46; - const PROPERTY_POSIX_PRINT = 47; - const PROPERTY_POSIX_XDIGIT = 48; - const PROPERTY_CASED = 49; - const PROPERTY_CASE_IGNORABLE = 50; - const PROPERTY_CHANGES_WHEN_LOWERCASED = 51; - const PROPERTY_CHANGES_WHEN_UPPERCASED = 52; - const PROPERTY_CHANGES_WHEN_TITLECASED = 53; - const PROPERTY_CHANGES_WHEN_CASEFOLDED = 54; - const PROPERTY_CHANGES_WHEN_CASEMAPPED = 55; - const PROPERTY_CHANGES_WHEN_NFKC_CASEFOLDED = 56; - const PROPERTY_BINARY_LIMIT = 65; - const PROPERTY_BIDI_CLASS = 4096; - const PROPERTY_INT_START = 4096; - const PROPERTY_BLOCK = 4097; - const PROPERTY_CANONICAL_COMBINING_CLASS = 4098; - const PROPERTY_DECOMPOSITION_TYPE = 4099; - const PROPERTY_EAST_ASIAN_WIDTH = 4100; - const PROPERTY_GENERAL_CATEGORY = 4101; - const PROPERTY_JOINING_GROUP = 4102; - const PROPERTY_JOINING_TYPE = 4103; - const PROPERTY_LINE_BREAK = 4104; - const PROPERTY_NUMERIC_TYPE = 4105; - const PROPERTY_SCRIPT = 4106; - const PROPERTY_HANGUL_SYLLABLE_TYPE = 4107; - const PROPERTY_NFD_QUICK_CHECK = 4108; - const PROPERTY_NFKD_QUICK_CHECK = 4109; - const PROPERTY_NFC_QUICK_CHECK = 4110; - const PROPERTY_NFKC_QUICK_CHECK = 4111; - const PROPERTY_LEAD_CANONICAL_COMBINING_CLASS = 4112; - const PROPERTY_TRAIL_CANONICAL_COMBINING_CLASS = 4113; - const PROPERTY_GRAPHEME_CLUSTER_BREAK = 4114; - const PROPERTY_SENTENCE_BREAK = 4115; - const PROPERTY_WORD_BREAK = 4116; - const PROPERTY_BIDI_PAIRED_BRACKET_TYPE = 4117; - const PROPERTY_INT_LIMIT = 4121; - const PROPERTY_GENERAL_CATEGORY_MASK = 8192; - const PROPERTY_MASK_START = 8192; - const PROPERTY_MASK_LIMIT = 8193; - const PROPERTY_NUMERIC_VALUE = 12288; - const PROPERTY_DOUBLE_START = 12288; - const PROPERTY_DOUBLE_LIMIT = 12289; - const PROPERTY_AGE = 16384; - const PROPERTY_STRING_START = 16384; - const PROPERTY_BIDI_MIRRORING_GLYPH = 16385; - const PROPERTY_CASE_FOLDING = 16386; - const PROPERTY_ISO_COMMENT = 16387; - const PROPERTY_LOWERCASE_MAPPING = 16388; - const PROPERTY_NAME = 16389; - const PROPERTY_SIMPLE_CASE_FOLDING = 16390; - const PROPERTY_SIMPLE_LOWERCASE_MAPPING = 16391; - const PROPERTY_SIMPLE_TITLECASE_MAPPING = 16392; - const PROPERTY_SIMPLE_UPPERCASE_MAPPING = 16393; - const PROPERTY_TITLECASE_MAPPING = 16394; - const PROPERTY_UNICODE_1_NAME = 16395; - const PROPERTY_UPPERCASE_MAPPING = 16396; - const PROPERTY_BIDI_PAIRED_BRACKET = 16397; - const PROPERTY_STRING_LIMIT = 16398; - const PROPERTY_SCRIPT_EXTENSIONS = 28672; - const PROPERTY_OTHER_PROPERTY_START = 28672; - const PROPERTY_OTHER_PROPERTY_LIMIT = 28673; - const PROPERTY_INVALID_CODE = -1; - const CHAR_CATEGORY_UNASSIGNED = 0; - const CHAR_CATEGORY_GENERAL_OTHER_TYPES = 0; - const CHAR_CATEGORY_UPPERCASE_LETTER = 1; - const CHAR_CATEGORY_LOWERCASE_LETTER = 2; - const CHAR_CATEGORY_TITLECASE_LETTER = 3; - const CHAR_CATEGORY_MODIFIER_LETTER = 4; - const CHAR_CATEGORY_OTHER_LETTER = 5; - const CHAR_CATEGORY_NON_SPACING_MARK = 6; - const CHAR_CATEGORY_ENCLOSING_MARK = 7; - const CHAR_CATEGORY_COMBINING_SPACING_MARK = 8; - const CHAR_CATEGORY_DECIMAL_DIGIT_NUMBER = 9; - const CHAR_CATEGORY_LETTER_NUMBER = 10; - const CHAR_CATEGORY_OTHER_NUMBER = 11; - const CHAR_CATEGORY_SPACE_SEPARATOR = 12; - const CHAR_CATEGORY_LINE_SEPARATOR = 13; - const CHAR_CATEGORY_PARAGRAPH_SEPARATOR = 14; - const CHAR_CATEGORY_CONTROL_CHAR = 15; - const CHAR_CATEGORY_FORMAT_CHAR = 16; - const CHAR_CATEGORY_PRIVATE_USE_CHAR = 17; - const CHAR_CATEGORY_SURROGATE = 18; - const CHAR_CATEGORY_DASH_PUNCTUATION = 19; - const CHAR_CATEGORY_START_PUNCTUATION = 20; - const CHAR_CATEGORY_END_PUNCTUATION = 21; - const CHAR_CATEGORY_CONNECTOR_PUNCTUATION = 22; - const CHAR_CATEGORY_OTHER_PUNCTUATION = 23; - const CHAR_CATEGORY_MATH_SYMBOL = 24; - const CHAR_CATEGORY_CURRENCY_SYMBOL = 25; - const CHAR_CATEGORY_MODIFIER_SYMBOL = 26; - const CHAR_CATEGORY_OTHER_SYMBOL = 27; - const CHAR_CATEGORY_INITIAL_PUNCTUATION = 28; - const CHAR_CATEGORY_FINAL_PUNCTUATION = 29; - const CHAR_CATEGORY_CHAR_CATEGORY_COUNT = 30; - const CHAR_DIRECTION_LEFT_TO_RIGHT = 0; - const CHAR_DIRECTION_RIGHT_TO_LEFT = 1; - const CHAR_DIRECTION_EUROPEAN_NUMBER = 2; - const CHAR_DIRECTION_EUROPEAN_NUMBER_SEPARATOR = 3; - const CHAR_DIRECTION_EUROPEAN_NUMBER_TERMINATOR = 4; - const CHAR_DIRECTION_ARABIC_NUMBER = 5; - const CHAR_DIRECTION_COMMON_NUMBER_SEPARATOR = 6; - const CHAR_DIRECTION_BLOCK_SEPARATOR = 7; - const CHAR_DIRECTION_SEGMENT_SEPARATOR = 8; - const CHAR_DIRECTION_WHITE_SPACE_NEUTRAL = 9; - const CHAR_DIRECTION_OTHER_NEUTRAL = 10; - const CHAR_DIRECTION_LEFT_TO_RIGHT_EMBEDDING = 11; - const CHAR_DIRECTION_LEFT_TO_RIGHT_OVERRIDE = 12; - const CHAR_DIRECTION_RIGHT_TO_LEFT_ARABIC = 13; - const CHAR_DIRECTION_RIGHT_TO_LEFT_EMBEDDING = 14; - const CHAR_DIRECTION_RIGHT_TO_LEFT_OVERRIDE = 15; - const CHAR_DIRECTION_POP_DIRECTIONAL_FORMAT = 16; - const CHAR_DIRECTION_DIR_NON_SPACING_MARK = 17; - const CHAR_DIRECTION_BOUNDARY_NEUTRAL = 18; - const CHAR_DIRECTION_FIRST_STRONG_ISOLATE = 19; - const CHAR_DIRECTION_LEFT_TO_RIGHT_ISOLATE = 20; - const CHAR_DIRECTION_RIGHT_TO_LEFT_ISOLATE = 21; - const CHAR_DIRECTION_POP_DIRECTIONAL_ISOLATE = 22; - const CHAR_DIRECTION_CHAR_DIRECTION_COUNT = 23; - const BLOCK_CODE_NO_BLOCK = 0; - const BLOCK_CODE_BASIC_LATIN = 1; - const BLOCK_CODE_LATIN_1_SUPPLEMENT = 2; - const BLOCK_CODE_LATIN_EXTENDED_A = 3; - const BLOCK_CODE_LATIN_EXTENDED_B = 4; - const BLOCK_CODE_IPA_EXTENSIONS = 5; - const BLOCK_CODE_SPACING_MODIFIER_LETTERS = 6; - const BLOCK_CODE_COMBINING_DIACRITICAL_MARKS = 7; - const BLOCK_CODE_GREEK = 8; - const BLOCK_CODE_CYRILLIC = 9; - const BLOCK_CODE_ARMENIAN = 10; - const BLOCK_CODE_HEBREW = 11; - const BLOCK_CODE_ARABIC = 12; - const BLOCK_CODE_SYRIAC = 13; - const BLOCK_CODE_THAANA = 14; - const BLOCK_CODE_DEVANAGARI = 15; - const BLOCK_CODE_BENGALI = 16; - const BLOCK_CODE_GURMUKHI = 17; - const BLOCK_CODE_GUJARATI = 18; - const BLOCK_CODE_ORIYA = 19; - const BLOCK_CODE_TAMIL = 20; - const BLOCK_CODE_TELUGU = 21; - const BLOCK_CODE_KANNADA = 22; - const BLOCK_CODE_MALAYALAM = 23; - const BLOCK_CODE_SINHALA = 24; - const BLOCK_CODE_THAI = 25; - const BLOCK_CODE_LAO = 26; - const BLOCK_CODE_TIBETAN = 27; - const BLOCK_CODE_MYANMAR = 28; - const BLOCK_CODE_GEORGIAN = 29; - const BLOCK_CODE_HANGUL_JAMO = 30; - const BLOCK_CODE_ETHIOPIC = 31; - const BLOCK_CODE_CHEROKEE = 32; - const BLOCK_CODE_UNIFIED_CANADIAN_ABORIGINAL_SYLLABICS = 33; - const BLOCK_CODE_OGHAM = 34; - const BLOCK_CODE_RUNIC = 35; - const BLOCK_CODE_KHMER = 36; - const BLOCK_CODE_MONGOLIAN = 37; - const BLOCK_CODE_LATIN_EXTENDED_ADDITIONAL = 38; - const BLOCK_CODE_GREEK_EXTENDED = 39; - const BLOCK_CODE_GENERAL_PUNCTUATION = 40; - const BLOCK_CODE_SUPERSCRIPTS_AND_SUBSCRIPTS = 41; - const BLOCK_CODE_CURRENCY_SYMBOLS = 42; - const BLOCK_CODE_COMBINING_MARKS_FOR_SYMBOLS = 43; - const BLOCK_CODE_LETTERLIKE_SYMBOLS = 44; - const BLOCK_CODE_NUMBER_FORMS = 45; - const BLOCK_CODE_ARROWS = 46; - const BLOCK_CODE_MATHEMATICAL_OPERATORS = 47; - const BLOCK_CODE_MISCELLANEOUS_TECHNICAL = 48; - const BLOCK_CODE_CONTROL_PICTURES = 49; - const BLOCK_CODE_OPTICAL_CHARACTER_RECOGNITION = 50; - const BLOCK_CODE_ENCLOSED_ALPHANUMERICS = 51; - const BLOCK_CODE_BOX_DRAWING = 52; - const BLOCK_CODE_BLOCK_ELEMENTS = 53; - const BLOCK_CODE_GEOMETRIC_SHAPES = 54; - const BLOCK_CODE_MISCELLANEOUS_SYMBOLS = 55; - const BLOCK_CODE_DINGBATS = 56; - const BLOCK_CODE_BRAILLE_PATTERNS = 57; - const BLOCK_CODE_CJK_RADICALS_SUPPLEMENT = 58; - const BLOCK_CODE_KANGXI_RADICALS = 59; - const BLOCK_CODE_IDEOGRAPHIC_DESCRIPTION_CHARACTERS = 60; - const BLOCK_CODE_CJK_SYMBOLS_AND_PUNCTUATION = 61; - const BLOCK_CODE_HIRAGANA = 62; - const BLOCK_CODE_KATAKANA = 63; - const BLOCK_CODE_BOPOMOFO = 64; - const BLOCK_CODE_HANGUL_COMPATIBILITY_JAMO = 65; - const BLOCK_CODE_KANBUN = 66; - const BLOCK_CODE_BOPOMOFO_EXTENDED = 67; - const BLOCK_CODE_ENCLOSED_CJK_LETTERS_AND_MONTHS = 68; - const BLOCK_CODE_CJK_COMPATIBILITY = 69; - const BLOCK_CODE_CJK_UNIFIED_IDEOGRAPHS_EXTENSION_A = 70; - const BLOCK_CODE_CJK_UNIFIED_IDEOGRAPHS = 71; - const BLOCK_CODE_YI_SYLLABLES = 72; - const BLOCK_CODE_YI_RADICALS = 73; - const BLOCK_CODE_HANGUL_SYLLABLES = 74; - const BLOCK_CODE_HIGH_SURROGATES = 75; - const BLOCK_CODE_HIGH_PRIVATE_USE_SURROGATES = 76; - const BLOCK_CODE_LOW_SURROGATES = 77; - const BLOCK_CODE_PRIVATE_USE_AREA = 78; - const BLOCK_CODE_PRIVATE_USE = 78; - const BLOCK_CODE_CJK_COMPATIBILITY_IDEOGRAPHS = 79; - const BLOCK_CODE_ALPHABETIC_PRESENTATION_FORMS = 80; - const BLOCK_CODE_ARABIC_PRESENTATION_FORMS_A = 81; - const BLOCK_CODE_COMBINING_HALF_MARKS = 82; - const BLOCK_CODE_CJK_COMPATIBILITY_FORMS = 83; - const BLOCK_CODE_SMALL_FORM_VARIANTS = 84; - const BLOCK_CODE_ARABIC_PRESENTATION_FORMS_B = 85; - const BLOCK_CODE_SPECIALS = 86; - const BLOCK_CODE_HALFWIDTH_AND_FULLWIDTH_FORMS = 87; - const BLOCK_CODE_OLD_ITALIC = 88; - const BLOCK_CODE_GOTHIC = 89; - const BLOCK_CODE_DESERET = 90; - const BLOCK_CODE_BYZANTINE_MUSICAL_SYMBOLS = 91; - const BLOCK_CODE_MUSICAL_SYMBOLS = 92; - const BLOCK_CODE_MATHEMATICAL_ALPHANUMERIC_SYMBOLS = 93; - const BLOCK_CODE_CJK_UNIFIED_IDEOGRAPHS_EXTENSION_B = 94; - const BLOCK_CODE_CJK_COMPATIBILITY_IDEOGRAPHS_SUPPLEMENT = 95; - const BLOCK_CODE_TAGS = 96; - const BLOCK_CODE_CYRILLIC_SUPPLEMENT = 97; - const BLOCK_CODE_CYRILLIC_SUPPLEMENTARY = 97; - const BLOCK_CODE_TAGALOG = 98; - const BLOCK_CODE_HANUNOO = 99; - const BLOCK_CODE_BUHID = 100; - const BLOCK_CODE_TAGBANWA = 101; - const BLOCK_CODE_MISCELLANEOUS_MATHEMATICAL_SYMBOLS_A = 102; - const BLOCK_CODE_SUPPLEMENTAL_ARROWS_A = 103; - const BLOCK_CODE_SUPPLEMENTAL_ARROWS_B = 104; - const BLOCK_CODE_MISCELLANEOUS_MATHEMATICAL_SYMBOLS_B = 105; - const BLOCK_CODE_SUPPLEMENTAL_MATHEMATICAL_OPERATORS = 106; - const BLOCK_CODE_KATAKANA_PHONETIC_EXTENSIONS = 107; - const BLOCK_CODE_VARIATION_SELECTORS = 108; - const BLOCK_CODE_SUPPLEMENTARY_PRIVATE_USE_AREA_A = 109; - const BLOCK_CODE_SUPPLEMENTARY_PRIVATE_USE_AREA_B = 110; - const BLOCK_CODE_LIMBU = 111; - const BLOCK_CODE_TAI_LE = 112; - const BLOCK_CODE_KHMER_SYMBOLS = 113; - const BLOCK_CODE_PHONETIC_EXTENSIONS = 114; - const BLOCK_CODE_MISCELLANEOUS_SYMBOLS_AND_ARROWS = 115; - const BLOCK_CODE_YIJING_HEXAGRAM_SYMBOLS = 116; - const BLOCK_CODE_LINEAR_B_SYLLABARY = 117; - const BLOCK_CODE_LINEAR_B_IDEOGRAMS = 118; - const BLOCK_CODE_AEGEAN_NUMBERS = 119; - const BLOCK_CODE_UGARITIC = 120; - const BLOCK_CODE_SHAVIAN = 121; - const BLOCK_CODE_OSMANYA = 122; - const BLOCK_CODE_CYPRIOT_SYLLABARY = 123; - const BLOCK_CODE_TAI_XUAN_JING_SYMBOLS = 124; - const BLOCK_CODE_VARIATION_SELECTORS_SUPPLEMENT = 125; - const BLOCK_CODE_ANCIENT_GREEK_MUSICAL_NOTATION = 126; - const BLOCK_CODE_ANCIENT_GREEK_NUMBERS = 127; - const BLOCK_CODE_ARABIC_SUPPLEMENT = 128; - const BLOCK_CODE_BUGINESE = 129; - const BLOCK_CODE_CJK_STROKES = 130; - const BLOCK_CODE_COMBINING_DIACRITICAL_MARKS_SUPPLEMENT = 131; - const BLOCK_CODE_COPTIC = 132; - const BLOCK_CODE_ETHIOPIC_EXTENDED = 133; - const BLOCK_CODE_ETHIOPIC_SUPPLEMENT = 134; - const BLOCK_CODE_GEORGIAN_SUPPLEMENT = 135; - const BLOCK_CODE_GLAGOLITIC = 136; - const BLOCK_CODE_KHAROSHTHI = 137; - const BLOCK_CODE_MODIFIER_TONE_LETTERS = 138; - const BLOCK_CODE_NEW_TAI_LUE = 139; - const BLOCK_CODE_OLD_PERSIAN = 140; - const BLOCK_CODE_PHONETIC_EXTENSIONS_SUPPLEMENT = 141; - const BLOCK_CODE_SUPPLEMENTAL_PUNCTUATION = 142; - const BLOCK_CODE_SYLOTI_NAGRI = 143; - const BLOCK_CODE_TIFINAGH = 144; - const BLOCK_CODE_VERTICAL_FORMS = 145; - const BLOCK_CODE_NKO = 146; - const BLOCK_CODE_BALINESE = 147; - const BLOCK_CODE_LATIN_EXTENDED_C = 148; - const BLOCK_CODE_LATIN_EXTENDED_D = 149; - const BLOCK_CODE_PHAGS_PA = 150; - const BLOCK_CODE_PHOENICIAN = 151; - const BLOCK_CODE_CUNEIFORM = 152; - const BLOCK_CODE_CUNEIFORM_NUMBERS_AND_PUNCTUATION = 153; - const BLOCK_CODE_COUNTING_ROD_NUMERALS = 154; - const BLOCK_CODE_SUNDANESE = 155; - const BLOCK_CODE_LEPCHA = 156; - const BLOCK_CODE_OL_CHIKI = 157; - const BLOCK_CODE_CYRILLIC_EXTENDED_A = 158; - const BLOCK_CODE_VAI = 159; - const BLOCK_CODE_CYRILLIC_EXTENDED_B = 160; - const BLOCK_CODE_SAURASHTRA = 161; - const BLOCK_CODE_KAYAH_LI = 162; - const BLOCK_CODE_REJANG = 163; - const BLOCK_CODE_CHAM = 164; - const BLOCK_CODE_ANCIENT_SYMBOLS = 165; - const BLOCK_CODE_PHAISTOS_DISC = 166; - const BLOCK_CODE_LYCIAN = 167; - const BLOCK_CODE_CARIAN = 168; - const BLOCK_CODE_LYDIAN = 169; - const BLOCK_CODE_MAHJONG_TILES = 170; - const BLOCK_CODE_DOMINO_TILES = 171; - const BLOCK_CODE_SAMARITAN = 172; - const BLOCK_CODE_UNIFIED_CANADIAN_ABORIGINAL_SYLLABICS_EXTENDED = 173; - const BLOCK_CODE_TAI_THAM = 174; - const BLOCK_CODE_VEDIC_EXTENSIONS = 175; - const BLOCK_CODE_LISU = 176; - const BLOCK_CODE_BAMUM = 177; - const BLOCK_CODE_COMMON_INDIC_NUMBER_FORMS = 178; - const BLOCK_CODE_DEVANAGARI_EXTENDED = 179; - const BLOCK_CODE_HANGUL_JAMO_EXTENDED_A = 180; - const BLOCK_CODE_JAVANESE = 181; - const BLOCK_CODE_MYANMAR_EXTENDED_A = 182; - const BLOCK_CODE_TAI_VIET = 183; - const BLOCK_CODE_MEETEI_MAYEK = 184; - const BLOCK_CODE_HANGUL_JAMO_EXTENDED_B = 185; - const BLOCK_CODE_IMPERIAL_ARAMAIC = 186; - const BLOCK_CODE_OLD_SOUTH_ARABIAN = 187; - const BLOCK_CODE_AVESTAN = 188; - const BLOCK_CODE_INSCRIPTIONAL_PARTHIAN = 189; - const BLOCK_CODE_INSCRIPTIONAL_PAHLAVI = 190; - const BLOCK_CODE_OLD_TURKIC = 191; - const BLOCK_CODE_RUMI_NUMERAL_SYMBOLS = 192; - const BLOCK_CODE_KAITHI = 193; - const BLOCK_CODE_EGYPTIAN_HIEROGLYPHS = 194; - const BLOCK_CODE_ENCLOSED_ALPHANUMERIC_SUPPLEMENT = 195; - const BLOCK_CODE_ENCLOSED_IDEOGRAPHIC_SUPPLEMENT = 196; - const BLOCK_CODE_CJK_UNIFIED_IDEOGRAPHS_EXTENSION_C = 197; - const BLOCK_CODE_MANDAIC = 198; - const BLOCK_CODE_BATAK = 199; - const BLOCK_CODE_ETHIOPIC_EXTENDED_A = 200; - const BLOCK_CODE_BRAHMI = 201; - const BLOCK_CODE_BAMUM_SUPPLEMENT = 202; - const BLOCK_CODE_KANA_SUPPLEMENT = 203; - const BLOCK_CODE_PLAYING_CARDS = 204; - const BLOCK_CODE_MISCELLANEOUS_SYMBOLS_AND_PICTOGRAPHS = 205; - const BLOCK_CODE_EMOTICONS = 206; - const BLOCK_CODE_TRANSPORT_AND_MAP_SYMBOLS = 207; - const BLOCK_CODE_ALCHEMICAL_SYMBOLS = 208; - const BLOCK_CODE_CJK_UNIFIED_IDEOGRAPHS_EXTENSION_D = 209; - const BLOCK_CODE_ARABIC_EXTENDED_A = 210; - const BLOCK_CODE_ARABIC_MATHEMATICAL_ALPHABETIC_SYMBOLS = 211; - const BLOCK_CODE_CHAKMA = 212; - const BLOCK_CODE_MEETEI_MAYEK_EXTENSIONS = 213; - const BLOCK_CODE_MEROITIC_CURSIVE = 214; - const BLOCK_CODE_MEROITIC_HIEROGLYPHS = 215; - const BLOCK_CODE_MIAO = 216; - const BLOCK_CODE_SHARADA = 217; - const BLOCK_CODE_SORA_SOMPENG = 218; - const BLOCK_CODE_SUNDANESE_SUPPLEMENT = 219; - const BLOCK_CODE_TAKRI = 220; - const BLOCK_CODE_BASSA_VAH = 221; - const BLOCK_CODE_CAUCASIAN_ALBANIAN = 222; - const BLOCK_CODE_COPTIC_EPACT_NUMBERS = 223; - const BLOCK_CODE_COMBINING_DIACRITICAL_MARKS_EXTENDED = 224; - const BLOCK_CODE_DUPLOYAN = 225; - const BLOCK_CODE_ELBASAN = 226; - const BLOCK_CODE_GEOMETRIC_SHAPES_EXTENDED = 227; - const BLOCK_CODE_GRANTHA = 228; - const BLOCK_CODE_KHOJKI = 229; - const BLOCK_CODE_KHUDAWADI = 230; - const BLOCK_CODE_LATIN_EXTENDED_E = 231; - const BLOCK_CODE_LINEAR_A = 232; - const BLOCK_CODE_MAHAJANI = 233; - const BLOCK_CODE_MANICHAEAN = 234; - const BLOCK_CODE_MENDE_KIKAKUI = 235; - const BLOCK_CODE_MODI = 236; - const BLOCK_CODE_MRO = 237; - const BLOCK_CODE_MYANMAR_EXTENDED_B = 238; - const BLOCK_CODE_NABATAEAN = 239; - const BLOCK_CODE_OLD_NORTH_ARABIAN = 240; - const BLOCK_CODE_OLD_PERMIC = 241; - const BLOCK_CODE_ORNAMENTAL_DINGBATS = 242; - const BLOCK_CODE_PAHAWH_HMONG = 243; - const BLOCK_CODE_PALMYRENE = 244; - const BLOCK_CODE_PAU_CIN_HAU = 245; - const BLOCK_CODE_PSALTER_PAHLAVI = 246; - const BLOCK_CODE_SHORTHAND_FORMAT_CONTROLS = 247; - const BLOCK_CODE_SIDDHAM = 248; - const BLOCK_CODE_SINHALA_ARCHAIC_NUMBERS = 249; - const BLOCK_CODE_SUPPLEMENTAL_ARROWS_C = 250; - const BLOCK_CODE_TIRHUTA = 251; - const BLOCK_CODE_WARANG_CITI = 252; - const BLOCK_CODE_COUNT = 309; - const BLOCK_CODE_INVALID_CODE = -1; - const BPT_NONE = 0; - const BPT_OPEN = 1; - const BPT_CLOSE = 2; - const BPT_COUNT = 3; - const EA_NEUTRAL = 0; - const EA_AMBIGUOUS = 1; - const EA_HALFWIDTH = 2; - const EA_FULLWIDTH = 3; - const EA_NARROW = 4; - const EA_WIDE = 5; - const EA_COUNT = 6; - const UNICODE_CHAR_NAME = 0; - const UNICODE_10_CHAR_NAME = 1; - const EXTENDED_CHAR_NAME = 2; - const CHAR_NAME_ALIAS = 3; - const CHAR_NAME_CHOICE_COUNT = 4; - const SHORT_PROPERTY_NAME = 0; - const LONG_PROPERTY_NAME = 1; - const PROPERTY_NAME_CHOICE_COUNT = 2; - const DT_NONE = 0; - const DT_CANONICAL = 1; - const DT_COMPAT = 2; - const DT_CIRCLE = 3; - const DT_FINAL = 4; - const DT_FONT = 5; - const DT_FRACTION = 6; - const DT_INITIAL = 7; - const DT_ISOLATED = 8; - const DT_MEDIAL = 9; - const DT_NARROW = 10; - const DT_NOBREAK = 11; - const DT_SMALL = 12; - const DT_SQUARE = 13; - const DT_SUB = 14; - const DT_SUPER = 15; - const DT_VERTICAL = 16; - const DT_WIDE = 17; - const DT_COUNT = 18; - const JT_NON_JOINING = 0; - const JT_JOIN_CAUSING = 1; - const JT_DUAL_JOINING = 2; - const JT_LEFT_JOINING = 3; - const JT_RIGHT_JOINING = 4; - const JT_TRANSPARENT = 5; - const JT_COUNT = 6; - const JG_NO_JOINING_GROUP = 0; - const JG_AIN = 1; - const JG_ALAPH = 2; - const JG_ALEF = 3; - const JG_BEH = 4; - const JG_BETH = 5; - const JG_DAL = 6; - const JG_DALATH_RISH = 7; - const JG_E = 8; - const JG_FEH = 9; - const JG_FINAL_SEMKATH = 10; - const JG_GAF = 11; - const JG_GAMAL = 12; - const JG_HAH = 13; - const JG_TEH_MARBUTA_GOAL = 14; - const JG_HAMZA_ON_HEH_GOAL = 14; - const JG_HE = 15; - const JG_HEH = 16; - const JG_HEH_GOAL = 17; - const JG_HETH = 18; - const JG_KAF = 19; - const JG_KAPH = 20; - const JG_KNOTTED_HEH = 21; - const JG_LAM = 22; - const JG_LAMADH = 23; - const JG_MEEM = 24; - const JG_MIM = 25; - const JG_NOON = 26; - const JG_NUN = 27; - const JG_PE = 28; - const JG_QAF = 29; - const JG_QAPH = 30; - const JG_REH = 31; - const JG_REVERSED_PE = 32; - const JG_SAD = 33; - const JG_SADHE = 34; - const JG_SEEN = 35; - const JG_SEMKATH = 36; - const JG_SHIN = 37; - const JG_SWASH_KAF = 38; - const JG_SYRIAC_WAW = 39; - const JG_TAH = 40; - const JG_TAW = 41; - const JG_TEH_MARBUTA = 42; - const JG_TETH = 43; - const JG_WAW = 44; - const JG_YEH = 45; - const JG_YEH_BARREE = 46; - const JG_YEH_WITH_TAIL = 47; - const JG_YUDH = 48; - const JG_YUDH_HE = 49; - const JG_ZAIN = 50; - const JG_FE = 51; - const JG_KHAPH = 52; - const JG_ZHAIN = 53; - const JG_BURUSHASKI_YEH_BARREE = 54; - const JG_FARSI_YEH = 55; - const JG_NYA = 56; - const JG_ROHINGYA_YEH = 57; - const JG_MANICHAEAN_ALEPH = 58; - const JG_MANICHAEAN_AYIN = 59; - const JG_MANICHAEAN_BETH = 60; - const JG_MANICHAEAN_DALETH = 61; - const JG_MANICHAEAN_DHAMEDH = 62; - const JG_MANICHAEAN_FIVE = 63; - const JG_MANICHAEAN_GIMEL = 64; - const JG_MANICHAEAN_HETH = 65; - const JG_MANICHAEAN_HUNDRED = 66; - const JG_MANICHAEAN_KAPH = 67; - const JG_MANICHAEAN_LAMEDH = 68; - const JG_MANICHAEAN_MEM = 69; - const JG_MANICHAEAN_NUN = 70; - const JG_MANICHAEAN_ONE = 71; - const JG_MANICHAEAN_PE = 72; - const JG_MANICHAEAN_QOPH = 73; - const JG_MANICHAEAN_RESH = 74; - const JG_MANICHAEAN_SADHE = 75; - const JG_MANICHAEAN_SAMEKH = 76; - const JG_MANICHAEAN_TAW = 77; - const JG_MANICHAEAN_TEN = 78; - const JG_MANICHAEAN_TETH = 79; - const JG_MANICHAEAN_THAMEDH = 80; - const JG_MANICHAEAN_TWENTY = 81; - const JG_MANICHAEAN_WAW = 82; - const JG_MANICHAEAN_YODH = 83; - const JG_MANICHAEAN_ZAYIN = 84; - const JG_STRAIGHT_WAW = 85; - const JG_COUNT = 102; - const GCB_OTHER = 0; - const GCB_CONTROL = 1; - const GCB_CR = 2; - const GCB_EXTEND = 3; - const GCB_L = 4; - const GCB_LF = 5; - const GCB_LV = 6; - const GCB_LVT = 7; - const GCB_T = 8; - const GCB_V = 9; - const GCB_SPACING_MARK = 10; - const GCB_PREPEND = 11; - const GCB_REGIONAL_INDICATOR = 12; - const GCB_COUNT = 18; - const WB_OTHER = 0; - const WB_ALETTER = 1; - const WB_FORMAT = 2; - const WB_KATAKANA = 3; - const WB_MIDLETTER = 4; - const WB_MIDNUM = 5; - const WB_NUMERIC = 6; - const WB_EXTENDNUMLET = 7; - const WB_CR = 8; - const WB_EXTEND = 9; - const WB_LF = 10; - const WB_MIDNUMLET = 11; - const WB_NEWLINE = 12; - const WB_REGIONAL_INDICATOR = 13; - const WB_HEBREW_LETTER = 14; - const WB_SINGLE_QUOTE = 15; - const WB_DOUBLE_QUOTE = 16; - const WB_COUNT = 23; - const SB_OTHER = 0; - const SB_ATERM = 1; - const SB_CLOSE = 2; - const SB_FORMAT = 3; - const SB_LOWER = 4; - const SB_NUMERIC = 5; - const SB_OLETTER = 6; - const SB_SEP = 7; - const SB_SP = 8; - const SB_STERM = 9; - const SB_UPPER = 10; - const SB_CR = 11; - const SB_EXTEND = 12; - const SB_LF = 13; - const SB_SCONTINUE = 14; - const SB_COUNT = 15; - const LB_UNKNOWN = 0; - const LB_AMBIGUOUS = 1; - const LB_ALPHABETIC = 2; - const LB_BREAK_BOTH = 3; - const LB_BREAK_AFTER = 4; - const LB_BREAK_BEFORE = 5; - const LB_MANDATORY_BREAK = 6; - const LB_CONTINGENT_BREAK = 7; - const LB_CLOSE_PUNCTUATION = 8; - const LB_COMBINING_MARK = 9; - const LB_CARRIAGE_RETURN = 10; - const LB_EXCLAMATION = 11; - const LB_GLUE = 12; - const LB_HYPHEN = 13; - const LB_IDEOGRAPHIC = 14; - const LB_INSEPARABLE = 15; - const LB_INSEPERABLE = 15; - const LB_INFIX_NUMERIC = 16; - const LB_LINE_FEED = 17; - const LB_NONSTARTER = 18; - const LB_NUMERIC = 19; - const LB_OPEN_PUNCTUATION = 20; - const LB_POSTFIX_NUMERIC = 21; - const LB_PREFIX_NUMERIC = 22; - const LB_QUOTATION = 23; - const LB_COMPLEX_CONTEXT = 24; - const LB_SURROGATE = 25; - const LB_SPACE = 26; - const LB_BREAK_SYMBOLS = 27; - const LB_ZWSPACE = 28; - const LB_NEXT_LINE = 29; - const LB_WORD_JOINER = 30; - const LB_H2 = 31; - const LB_H3 = 32; - const LB_JL = 33; - const LB_JT = 34; - const LB_JV = 35; - const LB_CLOSE_PARENTHESIS = 36; - const LB_CONDITIONAL_JAPANESE_STARTER = 37; - const LB_HEBREW_LETTER = 38; - const LB_REGIONAL_INDICATOR = 39; - const LB_COUNT = 43; - const NT_NONE = 0; - const NT_DECIMAL = 1; - const NT_DIGIT = 2; - const NT_NUMERIC = 3; - const NT_COUNT = 4; - const HST_NOT_APPLICABLE = 0; - const HST_LEADING_JAMO = 1; - const HST_VOWEL_JAMO = 2; - const HST_TRAILING_JAMO = 3; - const HST_LV_SYLLABLE = 4; - const HST_LVT_SYLLABLE = 5; - const HST_COUNT = 6; - const NO_NUMERIC_VALUE = -123456789; +class IntlChar +{ + public const UNICODE_VERSION = 13.0; + public const CODEPOINT_MIN = 0; + public const CODEPOINT_MAX = 1114111; + public const FOLD_CASE_DEFAULT = 0; + public const FOLD_CASE_EXCLUDE_SPECIAL_I = 1; + public const PROPERTY_ALPHABETIC = 0; + public const PROPERTY_BINARY_START = 0; + public const PROPERTY_ASCII_HEX_DIGIT = 1; + public const PROPERTY_BIDI_CONTROL = 2; + public const PROPERTY_BIDI_MIRRORED = 3; + public const PROPERTY_DASH = 4; + public const PROPERTY_DEFAULT_IGNORABLE_CODE_POINT = 5; + public const PROPERTY_DEPRECATED = 6; + public const PROPERTY_DIACRITIC = 7; + public const PROPERTY_EXTENDER = 8; + public const PROPERTY_FULL_COMPOSITION_EXCLUSION = 9; + public const PROPERTY_GRAPHEME_BASE = 10; + public const PROPERTY_GRAPHEME_EXTEND = 11; + public const PROPERTY_GRAPHEME_LINK = 12; + public const PROPERTY_HEX_DIGIT = 13; + public const PROPERTY_HYPHEN = 14; + public const PROPERTY_ID_CONTINUE = 15; + public const PROPERTY_ID_START = 16; + public const PROPERTY_IDEOGRAPHIC = 17; + public const PROPERTY_IDS_BINARY_OPERATOR = 18; + public const PROPERTY_IDS_TRINARY_OPERATOR = 19; + public const PROPERTY_JOIN_CONTROL = 20; + public const PROPERTY_LOGICAL_ORDER_EXCEPTION = 21; + public const PROPERTY_LOWERCASE = 22; + public const PROPERTY_MATH = 23; + public const PROPERTY_NONCHARACTER_CODE_POINT = 24; + public const PROPERTY_QUOTATION_MARK = 25; + public const PROPERTY_RADICAL = 26; + public const PROPERTY_SOFT_DOTTED = 27; + public const PROPERTY_TERMINAL_PUNCTUATION = 28; + public const PROPERTY_UNIFIED_IDEOGRAPH = 29; + public const PROPERTY_UPPERCASE = 30; + public const PROPERTY_WHITE_SPACE = 31; + public const PROPERTY_XID_CONTINUE = 32; + public const PROPERTY_XID_START = 33; + public const PROPERTY_CASE_SENSITIVE = 34; + public const PROPERTY_S_TERM = 35; + public const PROPERTY_VARIATION_SELECTOR = 36; + public const PROPERTY_NFD_INERT = 37; + public const PROPERTY_NFKD_INERT = 38; + public const PROPERTY_NFC_INERT = 39; + public const PROPERTY_NFKC_INERT = 40; + public const PROPERTY_SEGMENT_STARTER = 41; + public const PROPERTY_PATTERN_SYNTAX = 42; + public const PROPERTY_PATTERN_WHITE_SPACE = 43; + public const PROPERTY_POSIX_ALNUM = 44; + public const PROPERTY_POSIX_BLANK = 45; + public const PROPERTY_POSIX_GRAPH = 46; + public const PROPERTY_POSIX_PRINT = 47; + public const PROPERTY_POSIX_XDIGIT = 48; + public const PROPERTY_CASED = 49; + public const PROPERTY_CASE_IGNORABLE = 50; + public const PROPERTY_CHANGES_WHEN_LOWERCASED = 51; + public const PROPERTY_CHANGES_WHEN_UPPERCASED = 52; + public const PROPERTY_CHANGES_WHEN_TITLECASED = 53; + public const PROPERTY_CHANGES_WHEN_CASEFOLDED = 54; + public const PROPERTY_CHANGES_WHEN_CASEMAPPED = 55; + public const PROPERTY_CHANGES_WHEN_NFKC_CASEFOLDED = 56; + public const PROPERTY_BINARY_LIMIT = 65; + public const PROPERTY_BIDI_CLASS = 4096; + public const PROPERTY_INT_START = 4096; + public const PROPERTY_BLOCK = 4097; + public const PROPERTY_CANONICAL_COMBINING_CLASS = 4098; + public const PROPERTY_DECOMPOSITION_TYPE = 4099; + public const PROPERTY_EAST_ASIAN_WIDTH = 4100; + public const PROPERTY_GENERAL_CATEGORY = 4101; + public const PROPERTY_JOINING_GROUP = 4102; + public const PROPERTY_JOINING_TYPE = 4103; + public const PROPERTY_LINE_BREAK = 4104; + public const PROPERTY_NUMERIC_TYPE = 4105; + public const PROPERTY_SCRIPT = 4106; + public const PROPERTY_HANGUL_SYLLABLE_TYPE = 4107; + public const PROPERTY_NFD_QUICK_CHECK = 4108; + public const PROPERTY_NFKD_QUICK_CHECK = 4109; + public const PROPERTY_NFC_QUICK_CHECK = 4110; + public const PROPERTY_NFKC_QUICK_CHECK = 4111; + public const PROPERTY_LEAD_CANONICAL_COMBINING_CLASS = 4112; + public const PROPERTY_TRAIL_CANONICAL_COMBINING_CLASS = 4113; + public const PROPERTY_GRAPHEME_CLUSTER_BREAK = 4114; + public const PROPERTY_SENTENCE_BREAK = 4115; + public const PROPERTY_WORD_BREAK = 4116; + public const PROPERTY_BIDI_PAIRED_BRACKET_TYPE = 4117; + public const PROPERTY_INT_LIMIT = 4121; + public const PROPERTY_GENERAL_CATEGORY_MASK = 8192; + public const PROPERTY_MASK_START = 8192; + public const PROPERTY_MASK_LIMIT = 8193; + public const PROPERTY_NUMERIC_VALUE = 12288; + public const PROPERTY_DOUBLE_START = 12288; + public const PROPERTY_DOUBLE_LIMIT = 12289; + public const PROPERTY_AGE = 16384; + public const PROPERTY_STRING_START = 16384; + public const PROPERTY_BIDI_MIRRORING_GLYPH = 16385; + public const PROPERTY_CASE_FOLDING = 16386; + public const PROPERTY_ISO_COMMENT = 16387; + public const PROPERTY_LOWERCASE_MAPPING = 16388; + public const PROPERTY_NAME = 16389; + public const PROPERTY_SIMPLE_CASE_FOLDING = 16390; + public const PROPERTY_SIMPLE_LOWERCASE_MAPPING = 16391; + public const PROPERTY_SIMPLE_TITLECASE_MAPPING = 16392; + public const PROPERTY_SIMPLE_UPPERCASE_MAPPING = 16393; + public const PROPERTY_TITLECASE_MAPPING = 16394; + public const PROPERTY_UNICODE_1_NAME = 16395; + public const PROPERTY_UPPERCASE_MAPPING = 16396; + public const PROPERTY_BIDI_PAIRED_BRACKET = 16397; + public const PROPERTY_STRING_LIMIT = 16398; + public const PROPERTY_SCRIPT_EXTENSIONS = 28672; + public const PROPERTY_OTHER_PROPERTY_START = 28672; + public const PROPERTY_OTHER_PROPERTY_LIMIT = 28673; + public const PROPERTY_INVALID_CODE = -1; + public const CHAR_CATEGORY_UNASSIGNED = 0; + public const CHAR_CATEGORY_GENERAL_OTHER_TYPES = 0; + public const CHAR_CATEGORY_UPPERCASE_LETTER = 1; + public const CHAR_CATEGORY_LOWERCASE_LETTER = 2; + public const CHAR_CATEGORY_TITLECASE_LETTER = 3; + public const CHAR_CATEGORY_MODIFIER_LETTER = 4; + public const CHAR_CATEGORY_OTHER_LETTER = 5; + public const CHAR_CATEGORY_NON_SPACING_MARK = 6; + public const CHAR_CATEGORY_ENCLOSING_MARK = 7; + public const CHAR_CATEGORY_COMBINING_SPACING_MARK = 8; + public const CHAR_CATEGORY_DECIMAL_DIGIT_NUMBER = 9; + public const CHAR_CATEGORY_LETTER_NUMBER = 10; + public const CHAR_CATEGORY_OTHER_NUMBER = 11; + public const CHAR_CATEGORY_SPACE_SEPARATOR = 12; + public const CHAR_CATEGORY_LINE_SEPARATOR = 13; + public const CHAR_CATEGORY_PARAGRAPH_SEPARATOR = 14; + public const CHAR_CATEGORY_CONTROL_CHAR = 15; + public const CHAR_CATEGORY_FORMAT_CHAR = 16; + public const CHAR_CATEGORY_PRIVATE_USE_CHAR = 17; + public const CHAR_CATEGORY_SURROGATE = 18; + public const CHAR_CATEGORY_DASH_PUNCTUATION = 19; + public const CHAR_CATEGORY_START_PUNCTUATION = 20; + public const CHAR_CATEGORY_END_PUNCTUATION = 21; + public const CHAR_CATEGORY_CONNECTOR_PUNCTUATION = 22; + public const CHAR_CATEGORY_OTHER_PUNCTUATION = 23; + public const CHAR_CATEGORY_MATH_SYMBOL = 24; + public const CHAR_CATEGORY_CURRENCY_SYMBOL = 25; + public const CHAR_CATEGORY_MODIFIER_SYMBOL = 26; + public const CHAR_CATEGORY_OTHER_SYMBOL = 27; + public const CHAR_CATEGORY_INITIAL_PUNCTUATION = 28; + public const CHAR_CATEGORY_FINAL_PUNCTUATION = 29; + public const CHAR_CATEGORY_CHAR_CATEGORY_COUNT = 30; + public const CHAR_DIRECTION_LEFT_TO_RIGHT = 0; + public const CHAR_DIRECTION_RIGHT_TO_LEFT = 1; + public const CHAR_DIRECTION_EUROPEAN_NUMBER = 2; + public const CHAR_DIRECTION_EUROPEAN_NUMBER_SEPARATOR = 3; + public const CHAR_DIRECTION_EUROPEAN_NUMBER_TERMINATOR = 4; + public const CHAR_DIRECTION_ARABIC_NUMBER = 5; + public const CHAR_DIRECTION_COMMON_NUMBER_SEPARATOR = 6; + public const CHAR_DIRECTION_BLOCK_SEPARATOR = 7; + public const CHAR_DIRECTION_SEGMENT_SEPARATOR = 8; + public const CHAR_DIRECTION_WHITE_SPACE_NEUTRAL = 9; + public const CHAR_DIRECTION_OTHER_NEUTRAL = 10; + public const CHAR_DIRECTION_LEFT_TO_RIGHT_EMBEDDING = 11; + public const CHAR_DIRECTION_LEFT_TO_RIGHT_OVERRIDE = 12; + public const CHAR_DIRECTION_RIGHT_TO_LEFT_ARABIC = 13; + public const CHAR_DIRECTION_RIGHT_TO_LEFT_EMBEDDING = 14; + public const CHAR_DIRECTION_RIGHT_TO_LEFT_OVERRIDE = 15; + public const CHAR_DIRECTION_POP_DIRECTIONAL_FORMAT = 16; + public const CHAR_DIRECTION_DIR_NON_SPACING_MARK = 17; + public const CHAR_DIRECTION_BOUNDARY_NEUTRAL = 18; + public const CHAR_DIRECTION_FIRST_STRONG_ISOLATE = 19; + public const CHAR_DIRECTION_LEFT_TO_RIGHT_ISOLATE = 20; + public const CHAR_DIRECTION_RIGHT_TO_LEFT_ISOLATE = 21; + public const CHAR_DIRECTION_POP_DIRECTIONAL_ISOLATE = 22; + public const CHAR_DIRECTION_CHAR_DIRECTION_COUNT = 23; + public const BLOCK_CODE_NO_BLOCK = 0; + public const BLOCK_CODE_BASIC_LATIN = 1; + public const BLOCK_CODE_LATIN_1_SUPPLEMENT = 2; + public const BLOCK_CODE_LATIN_EXTENDED_A = 3; + public const BLOCK_CODE_LATIN_EXTENDED_B = 4; + public const BLOCK_CODE_IPA_EXTENSIONS = 5; + public const BLOCK_CODE_SPACING_MODIFIER_LETTERS = 6; + public const BLOCK_CODE_COMBINING_DIACRITICAL_MARKS = 7; + public const BLOCK_CODE_GREEK = 8; + public const BLOCK_CODE_CYRILLIC = 9; + public const BLOCK_CODE_ARMENIAN = 10; + public const BLOCK_CODE_HEBREW = 11; + public const BLOCK_CODE_ARABIC = 12; + public const BLOCK_CODE_SYRIAC = 13; + public const BLOCK_CODE_THAANA = 14; + public const BLOCK_CODE_DEVANAGARI = 15; + public const BLOCK_CODE_BENGALI = 16; + public const BLOCK_CODE_GURMUKHI = 17; + public const BLOCK_CODE_GUJARATI = 18; + public const BLOCK_CODE_ORIYA = 19; + public const BLOCK_CODE_TAMIL = 20; + public const BLOCK_CODE_TELUGU = 21; + public const BLOCK_CODE_KANNADA = 22; + public const BLOCK_CODE_MALAYALAM = 23; + public const BLOCK_CODE_SINHALA = 24; + public const BLOCK_CODE_THAI = 25; + public const BLOCK_CODE_LAO = 26; + public const BLOCK_CODE_TIBETAN = 27; + public const BLOCK_CODE_MYANMAR = 28; + public const BLOCK_CODE_GEORGIAN = 29; + public const BLOCK_CODE_HANGUL_JAMO = 30; + public const BLOCK_CODE_ETHIOPIC = 31; + public const BLOCK_CODE_CHEROKEE = 32; + public const BLOCK_CODE_UNIFIED_CANADIAN_ABORIGINAL_SYLLABICS = 33; + public const BLOCK_CODE_OGHAM = 34; + public const BLOCK_CODE_RUNIC = 35; + public const BLOCK_CODE_KHMER = 36; + public const BLOCK_CODE_MONGOLIAN = 37; + public const BLOCK_CODE_LATIN_EXTENDED_ADDITIONAL = 38; + public const BLOCK_CODE_GREEK_EXTENDED = 39; + public const BLOCK_CODE_GENERAL_PUNCTUATION = 40; + public const BLOCK_CODE_SUPERSCRIPTS_AND_SUBSCRIPTS = 41; + public const BLOCK_CODE_CURRENCY_SYMBOLS = 42; + public const BLOCK_CODE_COMBINING_MARKS_FOR_SYMBOLS = 43; + public const BLOCK_CODE_LETTERLIKE_SYMBOLS = 44; + public const BLOCK_CODE_NUMBER_FORMS = 45; + public const BLOCK_CODE_ARROWS = 46; + public const BLOCK_CODE_MATHEMATICAL_OPERATORS = 47; + public const BLOCK_CODE_MISCELLANEOUS_TECHNICAL = 48; + public const BLOCK_CODE_CONTROL_PICTURES = 49; + public const BLOCK_CODE_OPTICAL_CHARACTER_RECOGNITION = 50; + public const BLOCK_CODE_ENCLOSED_ALPHANUMERICS = 51; + public const BLOCK_CODE_BOX_DRAWING = 52; + public const BLOCK_CODE_BLOCK_ELEMENTS = 53; + public const BLOCK_CODE_GEOMETRIC_SHAPES = 54; + public const BLOCK_CODE_MISCELLANEOUS_SYMBOLS = 55; + public const BLOCK_CODE_DINGBATS = 56; + public const BLOCK_CODE_BRAILLE_PATTERNS = 57; + public const BLOCK_CODE_CJK_RADICALS_SUPPLEMENT = 58; + public const BLOCK_CODE_KANGXI_RADICALS = 59; + public const BLOCK_CODE_IDEOGRAPHIC_DESCRIPTION_CHARACTERS = 60; + public const BLOCK_CODE_CJK_SYMBOLS_AND_PUNCTUATION = 61; + public const BLOCK_CODE_HIRAGANA = 62; + public const BLOCK_CODE_KATAKANA = 63; + public const BLOCK_CODE_BOPOMOFO = 64; + public const BLOCK_CODE_HANGUL_COMPATIBILITY_JAMO = 65; + public const BLOCK_CODE_KANBUN = 66; + public const BLOCK_CODE_BOPOMOFO_EXTENDED = 67; + public const BLOCK_CODE_ENCLOSED_CJK_LETTERS_AND_MONTHS = 68; + public const BLOCK_CODE_CJK_COMPATIBILITY = 69; + public const BLOCK_CODE_CJK_UNIFIED_IDEOGRAPHS_EXTENSION_A = 70; + public const BLOCK_CODE_CJK_UNIFIED_IDEOGRAPHS = 71; + public const BLOCK_CODE_YI_SYLLABLES = 72; + public const BLOCK_CODE_YI_RADICALS = 73; + public const BLOCK_CODE_HANGUL_SYLLABLES = 74; + public const BLOCK_CODE_HIGH_SURROGATES = 75; + public const BLOCK_CODE_HIGH_PRIVATE_USE_SURROGATES = 76; + public const BLOCK_CODE_LOW_SURROGATES = 77; + public const BLOCK_CODE_PRIVATE_USE_AREA = 78; + public const BLOCK_CODE_PRIVATE_USE = 78; + public const BLOCK_CODE_CJK_COMPATIBILITY_IDEOGRAPHS = 79; + public const BLOCK_CODE_ALPHABETIC_PRESENTATION_FORMS = 80; + public const BLOCK_CODE_ARABIC_PRESENTATION_FORMS_A = 81; + public const BLOCK_CODE_COMBINING_HALF_MARKS = 82; + public const BLOCK_CODE_CJK_COMPATIBILITY_FORMS = 83; + public const BLOCK_CODE_SMALL_FORM_VARIANTS = 84; + public const BLOCK_CODE_ARABIC_PRESENTATION_FORMS_B = 85; + public const BLOCK_CODE_SPECIALS = 86; + public const BLOCK_CODE_HALFWIDTH_AND_FULLWIDTH_FORMS = 87; + public const BLOCK_CODE_OLD_ITALIC = 88; + public const BLOCK_CODE_GOTHIC = 89; + public const BLOCK_CODE_DESERET = 90; + public const BLOCK_CODE_BYZANTINE_MUSICAL_SYMBOLS = 91; + public const BLOCK_CODE_MUSICAL_SYMBOLS = 92; + public const BLOCK_CODE_MATHEMATICAL_ALPHANUMERIC_SYMBOLS = 93; + public const BLOCK_CODE_CJK_UNIFIED_IDEOGRAPHS_EXTENSION_B = 94; + public const BLOCK_CODE_CJK_COMPATIBILITY_IDEOGRAPHS_SUPPLEMENT = 95; + public const BLOCK_CODE_TAGS = 96; + public const BLOCK_CODE_CYRILLIC_SUPPLEMENT = 97; + public const BLOCK_CODE_CYRILLIC_SUPPLEMENTARY = 97; + public const BLOCK_CODE_TAGALOG = 98; + public const BLOCK_CODE_HANUNOO = 99; + public const BLOCK_CODE_BUHID = 100; + public const BLOCK_CODE_TAGBANWA = 101; + public const BLOCK_CODE_MISCELLANEOUS_MATHEMATICAL_SYMBOLS_A = 102; + public const BLOCK_CODE_SUPPLEMENTAL_ARROWS_A = 103; + public const BLOCK_CODE_SUPPLEMENTAL_ARROWS_B = 104; + public const BLOCK_CODE_MISCELLANEOUS_MATHEMATICAL_SYMBOLS_B = 105; + public const BLOCK_CODE_SUPPLEMENTAL_MATHEMATICAL_OPERATORS = 106; + public const BLOCK_CODE_KATAKANA_PHONETIC_EXTENSIONS = 107; + public const BLOCK_CODE_VARIATION_SELECTORS = 108; + public const BLOCK_CODE_SUPPLEMENTARY_PRIVATE_USE_AREA_A = 109; + public const BLOCK_CODE_SUPPLEMENTARY_PRIVATE_USE_AREA_B = 110; + public const BLOCK_CODE_LIMBU = 111; + public const BLOCK_CODE_TAI_LE = 112; + public const BLOCK_CODE_KHMER_SYMBOLS = 113; + public const BLOCK_CODE_PHONETIC_EXTENSIONS = 114; + public const BLOCK_CODE_MISCELLANEOUS_SYMBOLS_AND_ARROWS = 115; + public const BLOCK_CODE_YIJING_HEXAGRAM_SYMBOLS = 116; + public const BLOCK_CODE_LINEAR_B_SYLLABARY = 117; + public const BLOCK_CODE_LINEAR_B_IDEOGRAMS = 118; + public const BLOCK_CODE_AEGEAN_NUMBERS = 119; + public const BLOCK_CODE_UGARITIC = 120; + public const BLOCK_CODE_SHAVIAN = 121; + public const BLOCK_CODE_OSMANYA = 122; + public const BLOCK_CODE_CYPRIOT_SYLLABARY = 123; + public const BLOCK_CODE_TAI_XUAN_JING_SYMBOLS = 124; + public const BLOCK_CODE_VARIATION_SELECTORS_SUPPLEMENT = 125; + public const BLOCK_CODE_ANCIENT_GREEK_MUSICAL_NOTATION = 126; + public const BLOCK_CODE_ANCIENT_GREEK_NUMBERS = 127; + public const BLOCK_CODE_ARABIC_SUPPLEMENT = 128; + public const BLOCK_CODE_BUGINESE = 129; + public const BLOCK_CODE_CJK_STROKES = 130; + public const BLOCK_CODE_COMBINING_DIACRITICAL_MARKS_SUPPLEMENT = 131; + public const BLOCK_CODE_COPTIC = 132; + public const BLOCK_CODE_ETHIOPIC_EXTENDED = 133; + public const BLOCK_CODE_ETHIOPIC_SUPPLEMENT = 134; + public const BLOCK_CODE_GEORGIAN_SUPPLEMENT = 135; + public const BLOCK_CODE_GLAGOLITIC = 136; + public const BLOCK_CODE_KHAROSHTHI = 137; + public const BLOCK_CODE_MODIFIER_TONE_LETTERS = 138; + public const BLOCK_CODE_NEW_TAI_LUE = 139; + public const BLOCK_CODE_OLD_PERSIAN = 140; + public const BLOCK_CODE_PHONETIC_EXTENSIONS_SUPPLEMENT = 141; + public const BLOCK_CODE_SUPPLEMENTAL_PUNCTUATION = 142; + public const BLOCK_CODE_SYLOTI_NAGRI = 143; + public const BLOCK_CODE_TIFINAGH = 144; + public const BLOCK_CODE_VERTICAL_FORMS = 145; + public const BLOCK_CODE_NKO = 146; + public const BLOCK_CODE_BALINESE = 147; + public const BLOCK_CODE_LATIN_EXTENDED_C = 148; + public const BLOCK_CODE_LATIN_EXTENDED_D = 149; + public const BLOCK_CODE_PHAGS_PA = 150; + public const BLOCK_CODE_PHOENICIAN = 151; + public const BLOCK_CODE_CUNEIFORM = 152; + public const BLOCK_CODE_CUNEIFORM_NUMBERS_AND_PUNCTUATION = 153; + public const BLOCK_CODE_COUNTING_ROD_NUMERALS = 154; + public const BLOCK_CODE_SUNDANESE = 155; + public const BLOCK_CODE_LEPCHA = 156; + public const BLOCK_CODE_OL_CHIKI = 157; + public const BLOCK_CODE_CYRILLIC_EXTENDED_A = 158; + public const BLOCK_CODE_VAI = 159; + public const BLOCK_CODE_CYRILLIC_EXTENDED_B = 160; + public const BLOCK_CODE_SAURASHTRA = 161; + public const BLOCK_CODE_KAYAH_LI = 162; + public const BLOCK_CODE_REJANG = 163; + public const BLOCK_CODE_CHAM = 164; + public const BLOCK_CODE_ANCIENT_SYMBOLS = 165; + public const BLOCK_CODE_PHAISTOS_DISC = 166; + public const BLOCK_CODE_LYCIAN = 167; + public const BLOCK_CODE_CARIAN = 168; + public const BLOCK_CODE_LYDIAN = 169; + public const BLOCK_CODE_MAHJONG_TILES = 170; + public const BLOCK_CODE_DOMINO_TILES = 171; + public const BLOCK_CODE_SAMARITAN = 172; + public const BLOCK_CODE_UNIFIED_CANADIAN_ABORIGINAL_SYLLABICS_EXTENDED = 173; + public const BLOCK_CODE_TAI_THAM = 174; + public const BLOCK_CODE_VEDIC_EXTENSIONS = 175; + public const BLOCK_CODE_LISU = 176; + public const BLOCK_CODE_BAMUM = 177; + public const BLOCK_CODE_COMMON_INDIC_NUMBER_FORMS = 178; + public const BLOCK_CODE_DEVANAGARI_EXTENDED = 179; + public const BLOCK_CODE_HANGUL_JAMO_EXTENDED_A = 180; + public const BLOCK_CODE_JAVANESE = 181; + public const BLOCK_CODE_MYANMAR_EXTENDED_A = 182; + public const BLOCK_CODE_TAI_VIET = 183; + public const BLOCK_CODE_MEETEI_MAYEK = 184; + public const BLOCK_CODE_HANGUL_JAMO_EXTENDED_B = 185; + public const BLOCK_CODE_IMPERIAL_ARAMAIC = 186; + public const BLOCK_CODE_OLD_SOUTH_ARABIAN = 187; + public const BLOCK_CODE_AVESTAN = 188; + public const BLOCK_CODE_INSCRIPTIONAL_PARTHIAN = 189; + public const BLOCK_CODE_INSCRIPTIONAL_PAHLAVI = 190; + public const BLOCK_CODE_OLD_TURKIC = 191; + public const BLOCK_CODE_RUMI_NUMERAL_SYMBOLS = 192; + public const BLOCK_CODE_KAITHI = 193; + public const BLOCK_CODE_EGYPTIAN_HIEROGLYPHS = 194; + public const BLOCK_CODE_ENCLOSED_ALPHANUMERIC_SUPPLEMENT = 195; + public const BLOCK_CODE_ENCLOSED_IDEOGRAPHIC_SUPPLEMENT = 196; + public const BLOCK_CODE_CJK_UNIFIED_IDEOGRAPHS_EXTENSION_C = 197; + public const BLOCK_CODE_MANDAIC = 198; + public const BLOCK_CODE_BATAK = 199; + public const BLOCK_CODE_ETHIOPIC_EXTENDED_A = 200; + public const BLOCK_CODE_BRAHMI = 201; + public const BLOCK_CODE_BAMUM_SUPPLEMENT = 202; + public const BLOCK_CODE_KANA_SUPPLEMENT = 203; + public const BLOCK_CODE_PLAYING_CARDS = 204; + public const BLOCK_CODE_MISCELLANEOUS_SYMBOLS_AND_PICTOGRAPHS = 205; + public const BLOCK_CODE_EMOTICONS = 206; + public const BLOCK_CODE_TRANSPORT_AND_MAP_SYMBOLS = 207; + public const BLOCK_CODE_ALCHEMICAL_SYMBOLS = 208; + public const BLOCK_CODE_CJK_UNIFIED_IDEOGRAPHS_EXTENSION_D = 209; + public const BLOCK_CODE_ARABIC_EXTENDED_A = 210; + public const BLOCK_CODE_ARABIC_MATHEMATICAL_ALPHABETIC_SYMBOLS = 211; + public const BLOCK_CODE_CHAKMA = 212; + public const BLOCK_CODE_MEETEI_MAYEK_EXTENSIONS = 213; + public const BLOCK_CODE_MEROITIC_CURSIVE = 214; + public const BLOCK_CODE_MEROITIC_HIEROGLYPHS = 215; + public const BLOCK_CODE_MIAO = 216; + public const BLOCK_CODE_SHARADA = 217; + public const BLOCK_CODE_SORA_SOMPENG = 218; + public const BLOCK_CODE_SUNDANESE_SUPPLEMENT = 219; + public const BLOCK_CODE_TAKRI = 220; + public const BLOCK_CODE_BASSA_VAH = 221; + public const BLOCK_CODE_CAUCASIAN_ALBANIAN = 222; + public const BLOCK_CODE_COPTIC_EPACT_NUMBERS = 223; + public const BLOCK_CODE_COMBINING_DIACRITICAL_MARKS_EXTENDED = 224; + public const BLOCK_CODE_DUPLOYAN = 225; + public const BLOCK_CODE_ELBASAN = 226; + public const BLOCK_CODE_GEOMETRIC_SHAPES_EXTENDED = 227; + public const BLOCK_CODE_GRANTHA = 228; + public const BLOCK_CODE_KHOJKI = 229; + public const BLOCK_CODE_KHUDAWADI = 230; + public const BLOCK_CODE_LATIN_EXTENDED_E = 231; + public const BLOCK_CODE_LINEAR_A = 232; + public const BLOCK_CODE_MAHAJANI = 233; + public const BLOCK_CODE_MANICHAEAN = 234; + public const BLOCK_CODE_MENDE_KIKAKUI = 235; + public const BLOCK_CODE_MODI = 236; + public const BLOCK_CODE_MRO = 237; + public const BLOCK_CODE_MYANMAR_EXTENDED_B = 238; + public const BLOCK_CODE_NABATAEAN = 239; + public const BLOCK_CODE_OLD_NORTH_ARABIAN = 240; + public const BLOCK_CODE_OLD_PERMIC = 241; + public const BLOCK_CODE_ORNAMENTAL_DINGBATS = 242; + public const BLOCK_CODE_PAHAWH_HMONG = 243; + public const BLOCK_CODE_PALMYRENE = 244; + public const BLOCK_CODE_PAU_CIN_HAU = 245; + public const BLOCK_CODE_PSALTER_PAHLAVI = 246; + public const BLOCK_CODE_SHORTHAND_FORMAT_CONTROLS = 247; + public const BLOCK_CODE_SIDDHAM = 248; + public const BLOCK_CODE_SINHALA_ARCHAIC_NUMBERS = 249; + public const BLOCK_CODE_SUPPLEMENTAL_ARROWS_C = 250; + public const BLOCK_CODE_TIRHUTA = 251; + public const BLOCK_CODE_WARANG_CITI = 252; + public const BLOCK_CODE_COUNT = 309; + public const BLOCK_CODE_INVALID_CODE = -1; + public const BPT_NONE = 0; + public const BPT_OPEN = 1; + public const BPT_CLOSE = 2; + public const BPT_COUNT = 3; + public const EA_NEUTRAL = 0; + public const EA_AMBIGUOUS = 1; + public const EA_HALFWIDTH = 2; + public const EA_FULLWIDTH = 3; + public const EA_NARROW = 4; + public const EA_WIDE = 5; + public const EA_COUNT = 6; + public const UNICODE_CHAR_NAME = 0; + public const UNICODE_10_CHAR_NAME = 1; + public const EXTENDED_CHAR_NAME = 2; + public const CHAR_NAME_ALIAS = 3; + public const CHAR_NAME_CHOICE_COUNT = 4; + public const SHORT_PROPERTY_NAME = 0; + public const LONG_PROPERTY_NAME = 1; + public const PROPERTY_NAME_CHOICE_COUNT = 2; + public const DT_NONE = 0; + public const DT_CANONICAL = 1; + public const DT_COMPAT = 2; + public const DT_CIRCLE = 3; + public const DT_FINAL = 4; + public const DT_FONT = 5; + public const DT_FRACTION = 6; + public const DT_INITIAL = 7; + public const DT_ISOLATED = 8; + public const DT_MEDIAL = 9; + public const DT_NARROW = 10; + public const DT_NOBREAK = 11; + public const DT_SMALL = 12; + public const DT_SQUARE = 13; + public const DT_SUB = 14; + public const DT_SUPER = 15; + public const DT_VERTICAL = 16; + public const DT_WIDE = 17; + public const DT_COUNT = 18; + public const JT_NON_JOINING = 0; + public const JT_JOIN_CAUSING = 1; + public const JT_DUAL_JOINING = 2; + public const JT_LEFT_JOINING = 3; + public const JT_RIGHT_JOINING = 4; + public const JT_TRANSPARENT = 5; + public const JT_COUNT = 6; + public const JG_NO_JOINING_GROUP = 0; + public const JG_AIN = 1; + public const JG_ALAPH = 2; + public const JG_ALEF = 3; + public const JG_BEH = 4; + public const JG_BETH = 5; + public const JG_DAL = 6; + public const JG_DALATH_RISH = 7; + public const JG_E = 8; + public const JG_FEH = 9; + public const JG_FINAL_SEMKATH = 10; + public const JG_GAF = 11; + public const JG_GAMAL = 12; + public const JG_HAH = 13; + public const JG_TEH_MARBUTA_GOAL = 14; + public const JG_HAMZA_ON_HEH_GOAL = 14; + public const JG_HE = 15; + public const JG_HEH = 16; + public const JG_HEH_GOAL = 17; + public const JG_HETH = 18; + public const JG_KAF = 19; + public const JG_KAPH = 20; + public const JG_KNOTTED_HEH = 21; + public const JG_LAM = 22; + public const JG_LAMADH = 23; + public const JG_MEEM = 24; + public const JG_MIM = 25; + public const JG_NOON = 26; + public const JG_NUN = 27; + public const JG_PE = 28; + public const JG_QAF = 29; + public const JG_QAPH = 30; + public const JG_REH = 31; + public const JG_REVERSED_PE = 32; + public const JG_SAD = 33; + public const JG_SADHE = 34; + public const JG_SEEN = 35; + public const JG_SEMKATH = 36; + public const JG_SHIN = 37; + public const JG_SWASH_KAF = 38; + public const JG_SYRIAC_WAW = 39; + public const JG_TAH = 40; + public const JG_TAW = 41; + public const JG_TEH_MARBUTA = 42; + public const JG_TETH = 43; + public const JG_WAW = 44; + public const JG_YEH = 45; + public const JG_YEH_BARREE = 46; + public const JG_YEH_WITH_TAIL = 47; + public const JG_YUDH = 48; + public const JG_YUDH_HE = 49; + public const JG_ZAIN = 50; + public const JG_FE = 51; + public const JG_KHAPH = 52; + public const JG_ZHAIN = 53; + public const JG_BURUSHASKI_YEH_BARREE = 54; + public const JG_FARSI_YEH = 55; + public const JG_NYA = 56; + public const JG_ROHINGYA_YEH = 57; + public const JG_MANICHAEAN_ALEPH = 58; + public const JG_MANICHAEAN_AYIN = 59; + public const JG_MANICHAEAN_BETH = 60; + public const JG_MANICHAEAN_DALETH = 61; + public const JG_MANICHAEAN_DHAMEDH = 62; + public const JG_MANICHAEAN_FIVE = 63; + public const JG_MANICHAEAN_GIMEL = 64; + public const JG_MANICHAEAN_HETH = 65; + public const JG_MANICHAEAN_HUNDRED = 66; + public const JG_MANICHAEAN_KAPH = 67; + public const JG_MANICHAEAN_LAMEDH = 68; + public const JG_MANICHAEAN_MEM = 69; + public const JG_MANICHAEAN_NUN = 70; + public const JG_MANICHAEAN_ONE = 71; + public const JG_MANICHAEAN_PE = 72; + public const JG_MANICHAEAN_QOPH = 73; + public const JG_MANICHAEAN_RESH = 74; + public const JG_MANICHAEAN_SADHE = 75; + public const JG_MANICHAEAN_SAMEKH = 76; + public const JG_MANICHAEAN_TAW = 77; + public const JG_MANICHAEAN_TEN = 78; + public const JG_MANICHAEAN_TETH = 79; + public const JG_MANICHAEAN_THAMEDH = 80; + public const JG_MANICHAEAN_TWENTY = 81; + public const JG_MANICHAEAN_WAW = 82; + public const JG_MANICHAEAN_YODH = 83; + public const JG_MANICHAEAN_ZAYIN = 84; + public const JG_STRAIGHT_WAW = 85; + public const JG_COUNT = 102; + public const GCB_OTHER = 0; + public const GCB_CONTROL = 1; + public const GCB_CR = 2; + public const GCB_EXTEND = 3; + public const GCB_L = 4; + public const GCB_LF = 5; + public const GCB_LV = 6; + public const GCB_LVT = 7; + public const GCB_T = 8; + public const GCB_V = 9; + public const GCB_SPACING_MARK = 10; + public const GCB_PREPEND = 11; + public const GCB_REGIONAL_INDICATOR = 12; + public const GCB_COUNT = 18; + public const WB_OTHER = 0; + public const WB_ALETTER = 1; + public const WB_FORMAT = 2; + public const WB_KATAKANA = 3; + public const WB_MIDLETTER = 4; + public const WB_MIDNUM = 5; + public const WB_NUMERIC = 6; + public const WB_EXTENDNUMLET = 7; + public const WB_CR = 8; + public const WB_EXTEND = 9; + public const WB_LF = 10; + public const WB_MIDNUMLET = 11; + public const WB_NEWLINE = 12; + public const WB_REGIONAL_INDICATOR = 13; + public const WB_HEBREW_LETTER = 14; + public const WB_SINGLE_QUOTE = 15; + public const WB_DOUBLE_QUOTE = 16; + public const WB_COUNT = 23; + public const SB_OTHER = 0; + public const SB_ATERM = 1; + public const SB_CLOSE = 2; + public const SB_FORMAT = 3; + public const SB_LOWER = 4; + public const SB_NUMERIC = 5; + public const SB_OLETTER = 6; + public const SB_SEP = 7; + public const SB_SP = 8; + public const SB_STERM = 9; + public const SB_UPPER = 10; + public const SB_CR = 11; + public const SB_EXTEND = 12; + public const SB_LF = 13; + public const SB_SCONTINUE = 14; + public const SB_COUNT = 15; + public const LB_UNKNOWN = 0; + public const LB_AMBIGUOUS = 1; + public const LB_ALPHABETIC = 2; + public const LB_BREAK_BOTH = 3; + public const LB_BREAK_AFTER = 4; + public const LB_BREAK_BEFORE = 5; + public const LB_MANDATORY_BREAK = 6; + public const LB_CONTINGENT_BREAK = 7; + public const LB_CLOSE_PUNCTUATION = 8; + public const LB_COMBINING_MARK = 9; + public const LB_CARRIAGE_RETURN = 10; + public const LB_EXCLAMATION = 11; + public const LB_GLUE = 12; + public const LB_HYPHEN = 13; + public const LB_IDEOGRAPHIC = 14; + public const LB_INSEPARABLE = 15; + public const LB_INSEPERABLE = 15; + public const LB_INFIX_NUMERIC = 16; + public const LB_LINE_FEED = 17; + public const LB_NONSTARTER = 18; + public const LB_NUMERIC = 19; + public const LB_OPEN_PUNCTUATION = 20; + public const LB_POSTFIX_NUMERIC = 21; + public const LB_PREFIX_NUMERIC = 22; + public const LB_QUOTATION = 23; + public const LB_COMPLEX_CONTEXT = 24; + public const LB_SURROGATE = 25; + public const LB_SPACE = 26; + public const LB_BREAK_SYMBOLS = 27; + public const LB_ZWSPACE = 28; + public const LB_NEXT_LINE = 29; + public const LB_WORD_JOINER = 30; + public const LB_H2 = 31; + public const LB_H3 = 32; + public const LB_JL = 33; + public const LB_JT = 34; + public const LB_JV = 35; + public const LB_CLOSE_PARENTHESIS = 36; + public const LB_CONDITIONAL_JAPANESE_STARTER = 37; + public const LB_HEBREW_LETTER = 38; + public const LB_REGIONAL_INDICATOR = 39; + public const LB_COUNT = 43; + public const NT_NONE = 0; + public const NT_DECIMAL = 1; + public const NT_DIGIT = 2; + public const NT_NUMERIC = 3; + public const NT_COUNT = 4; + public const HST_NOT_APPLICABLE = 0; + public const HST_LEADING_JAMO = 1; + public const HST_VOWEL_JAMO = 2; + public const HST_TRAILING_JAMO = 3; + public const HST_LV_SYLLABLE = 4; + public const HST_LVT_SYLLABLE = 5; + public const HST_COUNT = 6; + public const NO_NUMERIC_VALUE = -123456789; /** * Check a binary Unicode property for a code point @@ -683,7 +684,7 @@ class IntlChar { * @since 7.0 */ #[Pure] - static public function hasBinaryProperty($codepoint, $property){} + public static function hasBinaryProperty($codepoint, $property) {} /** * @link https://php.net/manual/en/intlchar.charage.php @@ -703,7 +704,7 @@ public static function charAge($codepoint) {} * Or NULL if codepoint is out of bounds. * @since 7.0 */ - public static function charDigitValue($codepoint){} + public static function charDigitValue($codepoint) {} /** * Get bidirectional category value for a code point @@ -828,9 +829,7 @@ public static function charName($codepoint, $type = IntlChar::UNICODE_CHAR_NAME) *Or NULL if codepoint is out of bound.
codepoint is out of bound. * @since 7.0 */ - public static function chr ($codepoint) - { - - } + public static function chr($codepoint) {} /** * Get the decimal digit value of a code point for a given radix @@ -855,7 +851,7 @@ public static function chr ($codepoint) * or NULL if codepoint is out of bound. * @since 7.0 */ - public static function digit ($codepoint, $base = 10 ) {} + public static function digit($codepoint, $base = 10) {} /** * Enumerate all assigned Unicode characters within a range @@ -880,7 +876,7 @@ public static function digit ($codepoint, $base = 10 ) {} * * @since 7.0 */ - public static function enumCharNames ($start, $end, $callback, $type = IntlChar::UNICODE_CHAR_NAME) {} + public static function enumCharNames($start, $end, $callback, $type = IntlChar::UNICODE_CHAR_NAME) {} /** * Enumerate all code points with their Unicode general categories @@ -895,7 +891,7 @@ public static function enumCharNames ($start, $end, $callback, $type = IntlChar: * * @since 7.0 */ - public static function enumCharTypes ($callback) {} + public static function enumCharTypes($callback) {} /** * Perform case folding on a code point @@ -906,7 +902,7 @@ public static function enumCharTypes ($callback) {} * Returns NULL if codepoint is out of bound. * @since 7.0 */ - public static function foldCase ($codepoint, $options = IntlChar::FOLD_CASE_DEFAULT ) {} + public static function foldCase($codepoint, $options = IntlChar::FOLD_CASE_DEFAULT) {} /** * Get character representation for a given digit and radix @@ -916,7 +912,7 @@ public static function foldCase ($codepoint, $options = IntlChar::FOLD_CASE_DEFA * @return int The character representation (as a string) of the specified digit in the specified radix. * @since 7.0 */ - public static function forDigit ($digit, $base = 10) {} + public static function forDigit($digit, $base = 10) {} /** * Get the paired bracket character for a code point @@ -947,7 +943,7 @@ public static function getBlockCode($codepoint) {} * Or NULL if codepoint is out of bound. * @since 7.0 */ - public static function getCombiningClass ($codepoint) {} + public static function getCombiningClass($codepoint) {} /** * Get the FC_NFKC_Closure property for a code point @@ -958,7 +954,7 @@ public static function getCombiningClass ($codepoint) {} * or FALSE if there was an error. * @since 7.0 */ - public static function getFC_NFKC_Closure ($codepoint) {} + public static function getFC_NFKC_Closure($codepoint) {} /** * Get the max value for a Unicode property @@ -967,7 +963,7 @@ public static function getFC_NFKC_Closure ($codepoint) {} * @return int The maximum value returned by {@see IntlChar::getIntPropertyValue()} for a Unicode property. <=0 if the property selector is out of range. * @since 7.0 */ - public static function getIntPropertyMaxValue ($property) {} + public static function getIntPropertyMaxValue($property) {} /** * Get the min value for a Unicode property @@ -976,7 +972,7 @@ public static function getIntPropertyMaxValue ($property) {} * @return int The minimum value returned by {@see IntlChar::getIntPropertyValue()} for a Unicode property. 0 if the property selector is out of range. * @since 7.0 */ - public static function getIntPropertyMinValue ($property) {} + public static function getIntPropertyMinValue($property) {} /** * Get the value for a Unicode property for a code point @@ -1002,7 +998,7 @@ public static function getIntPropertyMinValue ($property) {} * * @since 7.0 */ - public static function getIntPropertyValue ($codepoint, $property ) {} + public static function getIntPropertyValue($codepoint, $property) {} /** * Get the numeric value for a Unicode code point @@ -1011,7 +1007,7 @@ public static function getIntPropertyValue ($codepoint, $property ) {} * @return float|null Numeric value of codepoint, or float(-123456789) if none is defined, or NULL if codepoint is out of bound. * @since 7.0 */ - public static function getNumericValue ($codepoint) {} + public static function getNumericValue($codepoint) {} /** * Get the property constant value for a given property name @@ -1020,7 +1016,7 @@ public static function getNumericValue ($codepoint) {} * @return int Returns an IntlChar::PROPERTY_ constant value, or IntlChar::PROPERTY_INVALID_CODE if the given name does not match any property. * @since 7.0 */ - public static function getPropertyEnum ($alias ) {} + public static function getPropertyEnum($alias) {} /** * Get the Unicode name for a property @@ -1041,7 +1037,7 @@ public static function getPropertyEnum ($alias ) {} * * @since 7.0 */ - public static function getPropertyName ($property, $type = IntlChar::LONG_PROPERTY_NAME) {} + public static function getPropertyName($property, $type = IntlChar::LONG_PROPERTY_NAME) {} /** * Get the property value for a given value name @@ -1052,7 +1048,7 @@ public static function getPropertyName ($property, $type = IntlChar::LONG_PROPER * @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. * @since 7.0 */ - public static function getPropertyValueEnum ($property, $name) {} + public static function getPropertyValueEnum($property, $name) {} /** * Get the Unicode name for a property value @@ -1082,7 +1078,7 @@ public static function getPropertyValueEnum ($property, $name) {} * If a given nameChoice returns FALSE, then all larger values of nameChoice 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. * @since 7.0 */ - public static function getPropertyValueName ($property, $value, $type = IntlChar::LONG_PROPERTY_NAME) {} + public static function getPropertyValueName($property, $value, $type = IntlChar::LONG_PROPERTY_NAME) {} /** * Get the Unicode version @@ -1099,7 +1095,7 @@ public static function getUnicodeVersion() {} * @return bool|null Returns TRUE if codepoint is an alphanumeric character, FALSE if not, NULL if codepoint is out of bound. * @since 7.0 */ - public static function isalnum ($codepoint) {} + public static function isalnum($codepoint) {} /** * Check if code point is a letter character @@ -1108,7 +1104,7 @@ public static function isalnum ($codepoint) {} * @return bool|null Returns TRUE if codepoint is a letter character, FALSE if not, NULL if codepoint is out of bound. * @since 7.0 */ - public static function isalpha ($codepoint) {} + public static function isalpha($codepoint) {} /** * Check if code point is a base character * @link https://php.net/manual/en/intlchar.isbase.php @@ -1116,7 +1112,7 @@ public static function isalpha ($codepoint) {} * @return bool|null Returns TRUE if codepoint is a base character, FALSE if not, NULL if codepoint is out of bound. * @since 7.0 */ - public static function isbase ($codepoint ){} + public static function isbase($codepoint) {} /** * Check if code point is a "blank" or "horizontal space" character * @link https://php.net/manual/en/intlchar.isblank.php @@ -1124,7 +1120,7 @@ public static function isbase ($codepoint ){} * @return bool|null Returns TRUE if codepoint is either a "blank" or "horizontal space" character, FALSE if not, NULL if codepoint is out of bound. * @since 7.0 */ - public static function isblank ($codepoint){} + public static function isblank($codepoint) {} /** * Check if code point is a control character @@ -1133,7 +1129,7 @@ public static function isblank ($codepoint){} * @return bool|null Returns TRUE if codepoint is a control character, FALSE if not, NULL if codepoint is out of bound. * @since 7.0 */ - public static function iscntrl ($codepoint ) {} + public static function iscntrl($codepoint) {} /** * Check whether the code point is defined @@ -1142,7 +1138,7 @@ public static function iscntrl ($codepoint ) {} * @return bool|null Returns TRUE if codepoint is a defined character, FALSE if not, NULL if codepoint is out of bound. * @since 7.0 */ - public static function isdefined ($codepoint ) {} + public static function isdefined($codepoint) {} /** * Check if code point is a digit character @@ -1151,7 +1147,7 @@ public static function isdefined ($codepoint ) {} * @return bool|null Returns TRUE if codepoint is a digit character, FALSE if not, NULL if codepoint is out of bound. * @since 7.0 */ - public static function isdigit ($codepoint) {} + public static function isdigit($codepoint) {} /** * Check if code point is a graphic character * @link https://php.net/manual/en/intlchar.isgraph.php @@ -1159,7 +1155,7 @@ public static function isdigit ($codepoint) {} * @return bool|null Returns TRUE if codepoint is a "graphic" character, FALSE if not, NULL if codepoint is out of bound. * @since 7.0 */ - public static function isgraph ($codepoint ) {} + public static function isgraph($codepoint) {} /** * Check if code point is an ignorable character * @link https://php.net/manual/en/intlchar.isidignorable.php @@ -1167,7 +1163,7 @@ public static function isgraph ($codepoint ) {} * @return bool|null Returns TRUE if codepoint is ignorable in identifiers, FALSE if not, NULL if codepoint is out of bound. * @since 7.0 */ - public static function isIDIgnorable ($codepoint ) {} + public static function isIDIgnorable($codepoint) {} /** * Check if code point is permissible in an identifier * @link https://php.net/manual/en/intlchar.isidpart.php @@ -1175,7 +1171,7 @@ public static function isIDIgnorable ($codepoint ) {} * @return bool|null Returns TRUE if codepoint is the code point may occur in an identifier, FALSE if not, NULL if codepoint is out of bound. * @since 7.0 */ - public static function isIDPart ($codepoint ) {} + public static function isIDPart($codepoint) {} /** * Check if code point is permissible as the first character in an identifier @@ -1184,7 +1180,7 @@ public static function isIDPart ($codepoint ) {} * @return bool|null Returns TRUE if codepoint may start an identifier, FALSE if not, NULL if codepoint is out of bound. * @since 7.0 */ - public static function isIDStart ($codepoint ) {} + public static function isIDStart($codepoint) {} /** * Check if code point is an ISO control code * @link https://php.net/manual/en/intlchar.isisocontrol.php @@ -1192,7 +1188,7 @@ public static function isIDStart ($codepoint ) {} * @return bool|null Returns TRUE if codepoint is an ISO control code, FALSE if not, NULL if codepoint is out of bound. * @since 7.0 */ - public static function isISOControl ($codepoint ) {} + public static function isISOControl($codepoint) {} /** * Check if code point is permissible in a Java identifier * @link https://php.net/manual/en/intlchar.isjavaidpart.php @@ -1200,7 +1196,7 @@ public static function isISOControl ($codepoint ) {} * @return bool|null Returns TRUE if codepoint may occur in a Java identifier, FALSE if not, NULL if codepoint is out of bound. * @since 7.0 */ - public static function isJavaIDPart ($codepoint ) {} + public static function isJavaIDPart($codepoint) {} /** * Check if code point is permissible as the first character in a Java identifier * @link https://php.net/manual/en/intlchar.isjavaidstart.php @@ -1208,7 +1204,7 @@ public static function isJavaIDPart ($codepoint ) {} * @return bool|null Returns TRUE if codepoint may start a Java identifier, FALSE if not, NULL if codepoint is out of bound. * @since 7.0 */ - public static function isJavaIDStart ($codepoint ) {} + public static function isJavaIDStart($codepoint) {} /** * Check if code point is a space character according to Java * @link https://php.net/manual/en/intlchar.isjavaspacechar.php @@ -1216,7 +1212,7 @@ public static function isJavaIDStart ($codepoint ) {} * @return bool|null Returns TRUE if codepoint is a space character according to Java, FALSE if not, NULL if codepoint is out of bound. * @since 7.0 */ - public static function isJavaSpaceChar ($codepoint ) {} + public static function isJavaSpaceChar($codepoint) {} /** * Check if code point is a lowercase letter @@ -1226,7 +1222,7 @@ public static function isJavaSpaceChar ($codepoint ) {} * @return bool|null Returns TRUE if codepoint is an Ll lowercase letter, FALSE if not, NULL if codepoint is out of bound. * @since 7.0 */ - public static function islower ($codepoint ) {} + public static function islower($codepoint) {} /** * Check if code point has the Bidi_Mirrored property * @link https://php.net/manual/en/intlchar.ismirrored.php @@ -1234,7 +1230,7 @@ public static function islower ($codepoint ) {} * @return bool|null Returns TRUE if codepoint has the Bidi_Mirrored property, FALSE if not, NULL if codepoint is out of bound. * @since 7.0 */ - public static function isMirrored ($codepoint ) {} + public static function isMirrored($codepoint) {} /** * Check if code point is a printable character @@ -1243,7 +1239,7 @@ public static function isMirrored ($codepoint ) {} * @return bool|null Returns TRUE if codepoint is a printable character, FALSE if not, NULL if codepoint is out of bound. * @since 7.0 */ - public static function isprint ($codepoint ) {} + public static function isprint($codepoint) {} /** * Check if code point is punctuation character @@ -1253,7 +1249,7 @@ public static function isprint ($codepoint ) {} * @return bool|null Returns TRUE if codepoint is a punctuation character, FALSE if not, NULL if codepoint is out of bound. * @since 7.0 */ - public static function ispunct ($codepoint ) {} + public static function ispunct($codepoint) {} /** * Check if code point is a space character * @link https://php.net/manual/en/intlchar.isspace.php @@ -1261,7 +1257,7 @@ public static function ispunct ($codepoint ) {} * @return bool|null Returns TRUE if codepoint is a space character, FALSE if not, NULL if codepoint is out of bound. * @since 7.0 */ - public static function isspace ($codepoint ) {} + public static function isspace($codepoint) {} /** * Check if code point is a titlecase letter * @link https://php.net/manual/en/intlchar.istitle.php @@ -1269,7 +1265,7 @@ public static function isspace ($codepoint ) {} * @return bool|null Returns TRUE if codepoint is a titlecase letter, FALSE if not, NULL if codepoint is out of bound. * @since 7.0 */ - public static function istitle ($codepoint ){} + public static function istitle($codepoint) {} /** * Check if code point has the Alphabetic Unicode property @@ -1278,7 +1274,7 @@ public static function istitle ($codepoint ){} * @return bool|null Returns TRUE if codepoint has the Alphabetic Unicode property, FALSE if not, NULL if codepoint is out of bound. * @since 7.0 */ - public static function isUAlphabetic ($codepoint ) {} + public static function isUAlphabetic($codepoint) {} /** * Check if code point has the Lowercase Unicode property * @link https://php.net/manual/en/intlchar.isulowercase.php @@ -1286,7 +1282,7 @@ public static function isUAlphabetic ($codepoint ) {} * @return bool|null Returns TRUE if codepoint has the Lowercase Unicode property, FALSE if not, NULL if codepoint is out of bound. * @since 7.0 */ - public static function isULowercase ($codepoint ) {} + public static function isULowercase($codepoint) {} /** * Check if code point has the general category "Lu" (uppercase letter) * @link https://php.net/manual/en/intlchar.isupper.php @@ -1295,7 +1291,7 @@ public static function isULowercase ($codepoint ) {} * @return bool|null Returns TRUE if codepoint is an Lu uppercase letter, FALSE if not, NULL if codepoint is out of bound. * @since 7.0 */ - public static function isupper ($codepoint) {} + public static function isupper($codepoint) {} /** * Check if code point has the Uppercase Unicode property * @link https://php.net/manual/en/intlchar.isuuppercase.php @@ -1303,7 +1299,7 @@ public static function isupper ($codepoint) {} * @return bool|null Returns TRUE if codepoint has the Uppercase Unicode property, FALSE if not, NULL if codepoint is out of bound. * @since 7.0 */ - public static function isUUppercase ($codepoint) {} + public static function isUUppercase($codepoint) {} /** * Check if code point has the White_Space Unicode property * @link https://php.net/manual/en/intlchar.isuwhitespace.php @@ -1311,7 +1307,7 @@ public static function isUUppercase ($codepoint) {} * @return bool|null Returns TRUE if codepoint has the White_Space Unicode property, FALSE if not, NULL if codepoint is out of bound. * @since 7.0 */ - public static function isUWhiteSpace ($codepoint ) {} + public static function isUWhiteSpace($codepoint) {} /** * Check if code point is a whitespace character according to ICU * @link https://php.net/manual/en/intlchar.iswhitespace.php @@ -1327,7 +1323,7 @@ public static function isWhitespace($codepoint) {} * @return bool|null Returns TRUE if codepoint is a hexadecimal character, FALSE if not, NULL if codepoint is out of bound. * @since 7.0 */ - public static function isxdigit ($codepoint){} + public static function isxdigit($codepoint) {} /** * Return Unicode code point value of character @@ -1336,7 +1332,7 @@ public static function isxdigit ($codepoint){} * @return int|null Returns the Unicode code point value as an integer, NULL if codepoint is out of bound. * @since 7.0 */ - public static function ord ($character) {} + public static function ord($character) {} /** * Make Unicode character lowercase @@ -1357,7 +1353,7 @@ public static function tolower($codepoint) {} * Or NULL if codepoint is out of bound. * @since 7.0 */ - public static function totitle ($codepoint ) {} + public static function totitle($codepoint) {} /** * Make Unicode character uppercase @@ -1368,5 +1364,5 @@ public static function totitle ($codepoint ) {} * Or NULL if codepoint is out of bound. * @since 7.0 */ - public static function toupper ($codepoint ) {} + public static function toupper($codepoint) {} } diff --git a/intl/intl.php b/intl/intl.php index 88ad87902..953b346e7 100644 --- a/intl/intl.php +++ b/intl/intl.php @@ -6,20 +6,21 @@ use JetBrains\PhpStorm\Internal\LanguageLevelTypeAware; use JetBrains\PhpStorm\Pure; -class Collator { - const DEFAULT_VALUE = -1; - const PRIMARY = 0; - const SECONDARY = 1; - const TERTIARY = 2; - const DEFAULT_STRENGTH = 2; - const QUATERNARY = 3; - const IDENTICAL = 15; - const OFF = 16; - const ON = 17; - const SHIFTED = 20; - const NON_IGNORABLE = 21; - const LOWER_FIRST = 24; - const UPPER_FIRST = 25; +class Collator +{ + public const DEFAULT_VALUE = -1; + public const PRIMARY = 0; + public const SECONDARY = 1; + public const TERTIARY = 2; + public const DEFAULT_STRENGTH = 2; + public const QUATERNARY = 3; + public const IDENTICAL = 15; + public const OFF = 16; + public const ON = 17; + public const SHIFTED = 20; + public const NON_IGNORABLE = 21; + public const LOWER_FIRST = 24; + public const UPPER_FIRST = 25; /** *@@ -43,7 +44,7 @@ class Collator { *
* @link https://php.net/manual/en/class.collator.php#intl.collator-constants */ - const FRENCH_COLLATION = 0; + public const FRENCH_COLLATION = 0; /** *@@ -88,7 +89,7 @@ class Collator { *
* @link https://php.net/manual/en/class.collator.php#intl.collator-constants */ - const ALTERNATE_HANDLING = 1; + public const ALTERNATE_HANDLING = 1; /** *@@ -122,7 +123,7 @@ class Collator { *
* @link https://php.net/manual/en/class.collator.php#intl.collator-constants */ - const CASE_FIRST = 2; + public const CASE_FIRST = 2; /** *@@ -148,7 +149,7 @@ class Collator { *
* @link https://php.net/manual/en/class.collator.php#intl.collator-constants */ - const CASE_LEVEL = 3; + public const CASE_LEVEL = 3; /** *@@ -174,7 +175,7 @@ class Collator { *
* @link https://php.net/manual/en/class.collator.php#intl.collator-constants */ - const NORMALIZATION_MODE = 4; + public const NORMALIZATION_MODE = 4; /** *@@ -197,7 +198,7 @@ class Collator { *
* @link https://php.net/manual/en/class.collator.php#intl.collator-constants */ - const STRENGTH = 5; + public const STRENGTH = 5; /** *@@ -216,7 +217,7 @@ class Collator { *
* @link https://php.net/manual/en/class.collator.php#intl.collator-constants */ - const HIRAGANA_QUATERNARY_MODE = 6; + public const HIRAGANA_QUATERNARY_MODE = 6; /** *@@ -232,11 +233,10 @@ class Collator { *
* @link https://php.net/manual/en/class.collator.php#intl.collator-constants */ - const NUMERIC_COLLATION = 7; - const SORT_REGULAR = 0; - const SORT_STRING = 1; - const SORT_NUMERIC = 2; - + public const NUMERIC_COLLATION = 7; + public const SORT_REGULAR = 0; + public const SORT_STRING = 1; + public const SORT_NUMERIC = 2; /** * (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)Array of strings to sort
* @return bool TRUE on success or FALSE on failure. */ - public function sortWithSortKeys(array &$array) { } + public function sortWithSortKeys(array &$array) {} /** * (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)One of the normalization forms.
* @return string|false The normalized string or FALSE if an error occurred. */ - public static function normalize($string, $form = Normalizer::FORM_C) { } + public static function normalize($string, $form = Normalizer::FORM_C) {} /** * (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)optional format locale
* @return string Display name of the locale in the format appropriate for $in_locale. */ - public static function getDisplayName($locale, $displayLocale = null) { } + public static function getDisplayName($locale, $displayLocale = null) {} /** * (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)Locale for which the resources should be loaded (locale name, e.g. en_CA).
@@ -2043,7 +2039,7 @@ class ResourceBundle implements IteratorAggregate, Countable { * @param bool $fallback [optional]Whether locale should match exactly or fallback to parent locale is allowed.
*/ #[Pure] - public function __construct($locale, $bundle, $fallback = true) { } + public function __construct($locale, $bundle, $fallback = true) {} /** * (PHP >= 5.3.2, PECL intl >= 2.0.0)Array of strings to sort
* @return bool TRUE on success or FALSE on failure. */ -function collator_sort_with_sort_keys(Collator $object, array &$array): bool { } +function collator_sort_with_sort_keys(Collator $object, array &$array): bool {} /** * (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)The input string to normalize
* @param int $form [optional]
@@ -3871,7 +3857,7 @@ function normalizer_normalize(string $string, int $form = Normalizer::FORM_C): s
* @return bool TRUE if normalized, FALSE otherwise or if there an error
*/
#[Pure]
-function normalizer_is_normalized(string $string, int $form = Normalizer::FORM_C): bool { }
+function normalizer_is_normalized(string $string, int $form = Normalizer::FORM_C): bool {}
/**
* Gets the default locale value from the intl global 'default_locale'
@@ -3879,7 +3865,7 @@ function normalizer_is_normalized(string $string, int $form = Normalizer::FORM_C
* @return string a string with the current Locale.
*/
#[Pure]
-function locale_get_default(): string { }
+function locale_get_default(): string {}
/**
* (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)
@@ -3891,7 +3877,7 @@ function locale_get_default(): string { }
*
the extracted part of $string,
- * or FALSE if $length is negative and $start denotes a position beyond truncation $length,
- * or also FALSE if $start denotes a position beyond $string length
@@ -328,7 +325,7 @@ function json_last_error_msg (): string {} *
* @link https://php.net/manual/en/json.constants.php */ -define ('JSON_ERROR_RECURSION', 6); +define('JSON_ERROR_RECURSION', 6); /** *@@ -344,7 +341,7 @@ function json_last_error_msg (): string {} *
* @link https://php.net/manual/en/json.constants.php */ -define ('JSON_ERROR_INF_OR_NAN', 7); +define('JSON_ERROR_INF_OR_NAN', 7); /** *@@ -358,47 +355,47 @@ function json_last_error_msg (): string {} *
* @link https://php.net/manual/en/json.constants.php */ -define ('JSON_ERROR_UNSUPPORTED_TYPE', 8); +define('JSON_ERROR_UNSUPPORTED_TYPE', 8); /** * No error has occurred. * @link https://php.net/manual/en/json.constants.php */ -define ('JSON_ERROR_NONE', 0); +define('JSON_ERROR_NONE', 0); /** * The maximum stack depth has been exceeded. * @link https://php.net/manual/en/json.constants.php */ -define ('JSON_ERROR_DEPTH', 1); +define('JSON_ERROR_DEPTH', 1); /** * Syntax error. * @link https://php.net/manual/en/json.constants.php */ -define ('JSON_ERROR_SYNTAX', 4); +define('JSON_ERROR_SYNTAX', 4); /** * Decodes JSON objects as PHP array. * @since 5.4 * @link https://php.net/manual/en/json.constants.php */ -define ('JSON_OBJECT_AS_ARRAY', 1); -define ('JSON_PARSER_NOTSTRICT', 4); +define('JSON_OBJECT_AS_ARRAY', 1); +define('JSON_PARSER_NOTSTRICT', 4); /** * Decodes large integers as their original string value. * @since 5.4 * @link https://php.net/manual/en/json.constants.php */ -define ('JSON_BIGINT_AS_STRING', 2); +define('JSON_BIGINT_AS_STRING', 2); /** * Ensures that float values are always encoded as a float value. * @since 5.6.6 * @link https://php.net/manual/en/json.constants.php */ -define ('JSON_PRESERVE_ZERO_FRACTION', 1024); +define('JSON_PRESERVE_ZERO_FRACTION', 1024); /** * The line terminators are kept unescaped when JSON_UNESCAPED_UNICODE is supplied. @@ -426,7 +423,7 @@ function json_last_error_msg (): string {} * @link https://php.net/manual/en/json.constants.php * @since 7.0 */ -define('JSON_ERROR_INVALID_PROPERTY_NAME',9); +define('JSON_ERROR_INVALID_PROPERTY_NAME', 9); /** * Single unpaired UTF-16 surrogate in unicode escape contained in the JSON string passed to json_encode(). @@ -434,7 +431,7 @@ function json_last_error_msg (): string {} * @link https://php.net/manual/en/json.constants.php * @since 7.0 */ -define('JSON_ERROR_UTF16',10); +define('JSON_ERROR_UTF16', 10); /** * Throws JsonException if an error occurs instead of setting the global error state @@ -458,8 +455,6 @@ function json_last_error_msg (): string {} * @since 7.3 * @link https://wiki.php.net/rfc/json_throw_on_error */ -class JsonException extends \Exception { -} +class JsonException extends \Exception {} // End of json v.1.3.1 -?> diff --git a/judy/judy.php b/judy/judy.php index 091c2fdbd..766fb3af7 100644 --- a/judy/judy.php +++ b/judy/judy.php @@ -6,32 +6,33 @@ * Class Judy. * @link https://php.net/manual/en/class.judy.php */ -class Judy implements ArrayAccess { +class Judy implements ArrayAccess +{ /** * Define the Judy Array as a Bitset with keys as Integer and Values as a Boolean. * @link https://php.net/manual/en/class.judy.php#judy.constants.bitset */ - const BITSET = 1; + public const BITSET = 1; /** * Define the Judy Array with key/values as Integer, and Integer only. * @link https://php.net/manual/en/class.judy.php#judy.constants.int-to-int */ - const INT_TO_INT = 2; + public const INT_TO_INT = 2; /** * Define the Judy Array with keys as Integer and Values of any type. * @link https://php.net/manual/en/class.judy.php#judy.constants.int-to-mixed */ - const INT_TO_MIXED = 3; + public const INT_TO_MIXED = 3; /** * Define the Judy Array with keys as a String and Values as Integer, and Integer only. * @link https://php.net/manual/en/class.judy.php#judy.constants.string-to-int */ - const STRING_TO_INT = 4; + public const STRING_TO_INT = 4; /** * Define the Judy Array with keys as a String and Values of any type. * @link https://php.net/manual/en/class.judy.php#judy.constants.string-to-mixed */ - const STRING_TO_MIXED = 5; + public const STRING_TO_MIXED = 5; /** * (PECL judy >= 0.1.1)@@ -1337,7 +1279,7 @@ function ldap_count_references($ldap, $result): int * The lesser of these two settings is the actual size limit. * @link https://php.net/manual/en/ldap.constants.php */ -define ('LDAP_OPT_SIZELIMIT', 3); +define('LDAP_OPT_SIZELIMIT', 3); /** * Specifies the number of seconds to wait for search results. @@ -1346,54 +1288,54 @@ function ldap_count_references($ldap, $result): int * The lesser of these two settings is the actual time limit. * @link https://php.net/manual/en/ldap.constants.php */ -define ('LDAP_OPT_TIMELIMIT', 4); +define('LDAP_OPT_TIMELIMIT', 4); /** * Option for ldap_set_option to allow setting network timeout. * (Available as of PHP 5.3.0) * @link https://php.net/manual/en/ldap.constants.php */ -define ('LDAP_OPT_NETWORK_TIMEOUT', 20485); +define('LDAP_OPT_NETWORK_TIMEOUT', 20485); /** * Specifies the LDAP protocol to be used (V2 or V3). * @link https://php.net/manual/en/ldap.constants.php */ -define ('LDAP_OPT_PROTOCOL_VERSION', 17); -define ('LDAP_OPT_ERROR_NUMBER', 49); +define('LDAP_OPT_PROTOCOL_VERSION', 17); +define('LDAP_OPT_ERROR_NUMBER', 49); /** * Specifies whether to automatically follow referrals returned * by the LDAP server. * @link https://php.net/manual/en/ldap.constants.php */ -define ('LDAP_OPT_REFERRALS', 8); -define ('LDAP_OPT_RESTART', 9); -define ('LDAP_OPT_HOST_NAME', 48); -define ('LDAP_OPT_ERROR_STRING', 50); -define ('LDAP_OPT_MATCHED_DN', 51); +define('LDAP_OPT_REFERRALS', 8); +define('LDAP_OPT_RESTART', 9); +define('LDAP_OPT_HOST_NAME', 48); +define('LDAP_OPT_ERROR_STRING', 50); +define('LDAP_OPT_MATCHED_DN', 51); /** * Specifies a default list of server controls to be sent with each request. * @link https://php.net/manual/en/ldap.constants.php */ -define ('LDAP_OPT_SERVER_CONTROLS', 18); +define('LDAP_OPT_SERVER_CONTROLS', 18); /** * Specifies a default list of client controls to be processed with each request. * @link https://php.net/manual/en/ldap.constants.php */ -define ('LDAP_OPT_CLIENT_CONTROLS', 19); +define('LDAP_OPT_CLIENT_CONTROLS', 19); /** * Specifies a bitwise level for debug traces. * @link https://php.net/manual/en/ldap.constants.php */ -define ('LDAP_OPT_DEBUG_LEVEL', 20481); -define ('LDAP_OPT_X_SASL_MECH', 24832); -define ('LDAP_OPT_X_SASL_REALM', 24833); -define ('LDAP_OPT_X_SASL_AUTHCID', 24834); -define ('LDAP_OPT_X_SASL_AUTHZID', 24835); +define('LDAP_OPT_DEBUG_LEVEL', 20481); +define('LDAP_OPT_X_SASL_MECH', 24832); +define('LDAP_OPT_X_SASL_REALM', 24833); +define('LDAP_OPT_X_SASL_AUTHCID', 24834); +define('LDAP_OPT_X_SASL_AUTHZID', 24835); /** * Specifies the path of the directory containing CA certificates. @@ -1415,16 +1357,13 @@ function ldap_count_references($ldap, $result): int define('LDAP_OPT_TIMEOUT', 20482); define('LDAP_OPT_DIAGNOSTIC_MESSAGE', 50); - /** * Control Constant - Manage DSA IT (» RFC 3296) * @link https://php.net/manual/en/ldap.constants.php * @since 7.3 */ define("LDAP_CONTROL_MANAGEDSAIT", "2.16.840.1.113730.3.4.2"); -echo - -/** +echo /** * Control Constant - Proxied Authorization (» RFC 4370) * @link https://php.net/manual/en/ldap.constants.php * @since 7.3 @@ -1585,7 +1524,6 @@ function ldap_count_references($ldap, $result): int */ define("LDAP_CONTROL_VLVRESPONSE", "2.16.840.1.113730.3.4.10"); - /** * Extended Operation constant - Modify password */ @@ -1612,4 +1550,3 @@ function ldap_count_references($ldap, $result): int define("LDAP_EXOP_WHO_AM_I", "1.3.6.1.4.1.4203.1.11.3"); // End of ldap v. -?> diff --git a/leveldb/LevelDB.php b/leveldb/LevelDB.php index e8e034a7d..063fbd253 100644 --- a/leveldb/LevelDB.php +++ b/leveldb/LevelDB.php @@ -1,158 +1,154 @@ true, // if the specified database does not exist will create a new one - 'error_if_exists' => false, // if the opened database exists will throw exception - 'paranoid_checks' => false, - 'block_cache_size' => 8 * (2 << 20), - 'write_buffer_size' => 4<<20, - 'block_size' => 4096, - 'max_open_files' => 1000, - 'block_restart_interval' => 16, - 'compression' => LEVELDB_SNAPPY_COMPRESSION, - 'comparator' => null, // any callable parameter return 0, -1, 1 - ], array $read_options = [ - 'verify_check_sum' => false, //may be set to true to force checksum verification of all data that is read from the file system on behalf of a particular read. By default, no such verification is done. - 'fill_cache' => true, //When performing a bulk read, the application may set this to false to disable the caching so that the data processed by the bulk read does not end up displacing most of the cached contents. - ], array $write_options = [ - //Only one element named sync in the write option array. By default, each write to leveldb is asynchronous. - 'sync' => false - ]){} - - /** - * @param string $key - * @param array $read_options - * - * @return string|false - */ - public function get($key, array $read_options = []){} - - /** - * Alias of LevelDB::put() - * - * @param string $key - * @param string $value - * @param array $write_options - */ - public function set($key, $value, array $write_options = []){} - - /** - * @param string $key - * @param string $value - * @param array $write_options - */ - public function put($key, $value, array $write_options = []){} - - /** - * @param string $key - * @param array $write_options - * - * @return bool - */ - public function delete($key, array $write_options = []){} - - /** - * Executes all of the operations added in the write batch. - * - * @param LevelDBWriteBatch $batch - * @param array $write_options - */ - public function write(LevelDBWriteBatch $batch, array $write_options = []){} - - /** - * Valid properties: - * - leveldb.stats: returns the status of the entire db - * - leveldb.num-files-at-level: returns the number of files for each level. For example, you can use leveldb.num-files-at-level0 the number of files for zero level. - * - leveldb.sstables: returns current status of sstables - * - * @param string $name - * - * @return mixed - */ - public function getProperty($name){} - - public function getApproximateSizes($start, $limit){} - - public function compactRange($start, $limit){} - - public function close(){} - - /** - * @param array $options - * - * @return LevelDBIterator - */ - public function getIterator(array $options = []){} - - /** - * @return LevelDBSnapshot - */ - public function getSnapshot(){} - - static public function destroy($name, array $options = []){} - - static public function repair($name, array $options = []){} +class LevelDB +{ + /** + * @param string $name Path to database + * @param array $options + * @param array $read_options + * @param array $write_options + */ + public function __construct($name, array $options = [ + 'create_if_missing' => true, // if the specified database does not exist will create a new one + 'error_if_exists' => false, // if the opened database exists will throw exception + 'paranoid_checks' => false, + 'block_cache_size' => 8 * (2 << 20), + 'write_buffer_size' => 4 << 20, + 'block_size' => 4096, + 'max_open_files' => 1000, + 'block_restart_interval' => 16, + 'compression' => LEVELDB_SNAPPY_COMPRESSION, + 'comparator' => null, // any callable parameter return 0, -1, 1 + ], array $read_options = [ + 'verify_check_sum' => false, //may be set to true to force checksum verification of all data that is read from the file system on behalf of a particular read. By default, no such verification is done. + 'fill_cache' => true, //When performing a bulk read, the application may set this to false to disable the caching so that the data processed by the bulk read does not end up displacing most of the cached contents. + ], array $write_options = [ + //Only one element named sync in the write option array. By default, each write to leveldb is asynchronous. + 'sync' => false + ]) {} + + /** + * @param string $key + * @param array $read_options + * + * @return string|false + */ + public function get($key, array $read_options = []) {} + + /** + * Alias of LevelDB::put() + * + * @param string $key + * @param string $value + * @param array $write_options + */ + public function set($key, $value, array $write_options = []) {} + + /** + * @param string $key + * @param string $value + * @param array $write_options + */ + public function put($key, $value, array $write_options = []) {} + + /** + * @param string $key + * @param array $write_options + * + * @return bool + */ + public function delete($key, array $write_options = []) {} + + /** + * Executes all of the operations added in the write batch. + * + * @param LevelDBWriteBatch $batch + * @param array $write_options + */ + public function write(LevelDBWriteBatch $batch, array $write_options = []) {} + + /** + * Valid properties: + * - leveldb.stats: returns the status of the entire db + * - leveldb.num-files-at-level: returns the number of files for each level. For example, you can use leveldb.num-files-at-level0 the number of files for zero level. + * - leveldb.sstables: returns current status of sstables + * + * @param string $name + * + * @return mixed + */ + public function getProperty($name) {} + + public function getApproximateSizes($start, $limit) {} + + public function compactRange($start, $limit) {} + + public function close() {} + + /** + * @param array $options + * + * @return LevelDBIterator + */ + public function getIterator(array $options = []) {} + + /** + * @return LevelDBSnapshot + */ + public function getSnapshot() {} + + public static function destroy($name, array $options = []) {} + + public static function repair($name, array $options = []) {} } -class LevelDBIterator implements Iterator{ - - public function __construct(LevelDB $db, array $read_options = []){} - - public function valid(){} +class LevelDBIterator implements Iterator +{ + public function __construct(LevelDB $db, array $read_options = []) {} - public function rewind(){} + public function valid() {} - public function last(){} + public function rewind() {} - public function seek($key){} + public function last() {} - public function next(){} + public function seek($key) {} - public function prev(){} + public function next() {} - public function key(){} + public function prev() {} - public function current(){} + public function key() {} - public function getError(){} + public function current() {} - public function destroy(){} + public function getError() {} + public function destroy() {} } -class LevelDBWriteBatch{ - public function __construct(){} +class LevelDBWriteBatch +{ + public function __construct() {} - public function set($key, $value, array $write_options = []){} + public function set($key, $value, array $write_options = []) {} - public function put($key, $value, array $write_options = []){} + public function put($key, $value, array $write_options = []) {} - public function delete($key, array $write_options = []){} + public function delete($key, array $write_options = []) {} - public function clear(){} + public function clear() {} } -class LevelDBSnapshot{ - public function __construct(LevelDB $db){} - - public function release(){} +class LevelDBSnapshot +{ + public function __construct(LevelDB $db) {} + public function release() {} } -class LevelDBException extends Exception{ - -} +class LevelDBException extends Exception {} diff --git a/libevent/libevent.php b/libevent/libevent.php index 2d8687859..06792ef79 100644 --- a/libevent/libevent.php +++ b/libevent/libevent.php @@ -8,7 +8,6 @@ // PHP Libevent extension documentation: // https://php.net/libevent - // Event flags /** @@ -62,7 +61,6 @@ */ define('EV_PERSIST', 16); - // Event loop modes /** @@ -82,7 +80,6 @@ */ define('EVLOOP_NONBLOCK', 2); - // Buffered event error codes (second argument in buffer's error-callback) /** @@ -113,9 +110,6 @@ */ define('EVBUFFER_TIMEOUT', 64); - - - /** *
Create and initialize new event base
* @@ -125,7 +119,7 @@ * * @return resource|false returns valid event base resource on success or FALSE on error. */ -function event_base_new(){} +function event_base_new() {} /** *Destroy event base
@@ -250,7 +244,6 @@ function event_base_set($event, $base) {} */ function event_base_priority_init($event_base, $npriorities) {} - /** *Creates and returns a new event resource.
*(PECL libevent >= 0.0.1)
@@ -370,7 +363,6 @@ function event_set($event, $fd, $events, $callback, $arg = null) {} */ function event_del($event) {} - /** *Create new buffered event
*(PECL libevent >= 0.0.1)
@@ -609,7 +601,6 @@ function event_buffer_fd_set($bevent, $fd) {} */ function event_buffer_set_callback($bevent, $readcb, $writecb, $errorcb, $arg = null) {} - /** *Alias of {@link event_new}().
* @@ -693,5 +684,4 @@ function event_timer_add($event, $timeout = -1) {} */ function event_timer_del($event) {} - // End of PECL libevent v.0.0.4 diff --git a/libsodium/libsodium.php b/libsodium/libsodium.php index 01c0abff9..b8866f61a 100644 --- a/libsodium/libsodium.php +++ b/libsodium/libsodium.php @@ -1,11 +1,11 @@ - * the severity of the error (one of the following constants: - *LIBXML_ERR_WARNING,
- * LIBXML_ERR_ERROR or
- * LIBXML_ERR_FATAL)
- *
- * @var int
- */
- public int $level;
- /**
- * - * The error's code. - *
- * @var int - */ - public int $code; - /** - *- * The column where the error occurred. - *
- *Note: - *
- * This property isn't entirely implemented in libxml and therefore - * 0 is often returned. - *
- * @var int - */ - public int $column; - /** - *- * The error message, if any. - *
- * @var string - */ - public string $message; - /** - *The filename, or empty if the XML was loaded from a string.
- * @var string - */ - public string $file; - /** - *- * The line where the error occurred. - *
- * @var int - */ - public int $line; - +class LibXMLError +{ + /** + *
+ * the severity of the error (one of the following constants:
+ * LIBXML_ERR_WARNING,
+ * LIBXML_ERR_ERROR or
+ * LIBXML_ERR_FATAL)
+ *
+ * The error's code. + *
+ * @var int + */ + public int $code; + /** + *+ * The column where the error occurred. + *
+ *Note: + *
+ * This property isn't entirely implemented in libxml and therefore + * 0 is often returned. + *
+ * @var int + */ + public int $column; + /** + *+ * The error message, if any. + *
+ * @var string + */ + public string $message; + /** + *The filename, or empty if the XML was loaded from a string.
+ * @var string + */ + public string $file; + /** + *+ * The line where the error occurred. + *
+ * @var int + */ + public int $line; } /** @@ -71,7 +71,7 @@ class LibXMLError { * * @return void No value is returned. */ -function libxml_set_streams_context ($context):void {} +function libxml_set_streams_context($context): void {} /** * Disable libxml errors and allow user to fetch error information as needed @@ -82,7 +82,7 @@ function libxml_set_streams_context ($context):void {} * @return bool This function returns the previous value of * use_errors. */ -function libxml_use_internal_errors (?bool $use_errors = false): bool {} +function libxml_use_internal_errors(?bool $use_errors = false): bool {} /** * Retrieve last error from libxml @@ -91,15 +91,14 @@ function libxml_use_internal_errors (?bool $use_errors = false): bool {} * buffer, FALSE otherwise. */ #[Pure] -function libxml_get_last_error (): LibXMLError|false -{} +function libxml_get_last_error(): LibXMLError|false {} /** * Clear libxml error buffer * @link https://php.net/manual/en/function.libxml-clear-errors.php * @return void No value is returned. */ -function libxml_clear_errors (): void {} +function libxml_clear_errors(): void {} /** * Retrieve array of errors @@ -108,8 +107,7 @@ function libxml_clear_errors (): void {} * errors in the buffer, or an empty array otherwise. */ #[Pure] -function libxml_get_errors (): array -{} +function libxml_get_errors(): array {} /** * Disable the ability to load external entities @@ -123,8 +121,7 @@ function libxml_get_errors (): array * @since 5.2.11 */ #[Deprecated(since: "8.0")] -function libxml_disable_entity_loader (bool $disable = true): bool -{} +function libxml_disable_entity_loader(bool $disable = true): bool {} /** * Changes the default external entity loader @@ -138,94 +135,93 @@ function libxml_disable_entity_loader (bool $disable = true): bool * @return bool * @since 5.4 */ -function libxml_set_external_entity_loader (?callable $resolver_function): bool {} - +function libxml_set_external_entity_loader(?callable $resolver_function): bool {} /** * libxml version like 20605 or 20617 * @link https://php.net/manual/en/libxml.constants.php */ -define ('LIBXML_VERSION', 20901); +define('LIBXML_VERSION', 20901); /** * libxml version like 2.6.5 or 2.6.17 * @link https://php.net/manual/en/libxml.constants.php */ -define ('LIBXML_DOTTED_VERSION', "2.9.1"); -define ('LIBXML_LOADED_VERSION', 20901); +define('LIBXML_DOTTED_VERSION', "2.9.1"); +define('LIBXML_LOADED_VERSION', 20901); /** * Substitute entities * @link https://php.net/manual/en/libxml.constants.php */ -define ('LIBXML_NOENT', 2); +define('LIBXML_NOENT', 2); /** * Load the external subset * @link https://php.net/manual/en/libxml.constants.php */ -define ('LIBXML_DTDLOAD', 4); +define('LIBXML_DTDLOAD', 4); /** * Default DTD attributes * @link https://php.net/manual/en/libxml.constants.php */ -define ('LIBXML_DTDATTR', 8); +define('LIBXML_DTDATTR', 8); /** * Validate with the DTD * @link https://php.net/manual/en/libxml.constants.php */ -define ('LIBXML_DTDVALID', 16); +define('LIBXML_DTDVALID', 16); /** * Suppress error reports * @link https://php.net/manual/en/libxml.constants.php */ -define ('LIBXML_NOERROR', 32); +define('LIBXML_NOERROR', 32); /** * Suppress warning reports * @link https://php.net/manual/en/libxml.constants.php */ -define ('LIBXML_NOWARNING', 64); +define('LIBXML_NOWARNING', 64); /** * Remove blank nodes * @link https://php.net/manual/en/libxml.constants.php */ -define ('LIBXML_NOBLANKS', 256); +define('LIBXML_NOBLANKS', 256); /** * Implement XInclude substitution * @link https://php.net/manual/en/libxml.constants.php */ -define ('LIBXML_XINCLUDE', 1024); +define('LIBXML_XINCLUDE', 1024); /** * Remove redundant namespaces declarations * @link https://php.net/manual/en/libxml.constants.php */ -define ('LIBXML_NSCLEAN', 8192); +define('LIBXML_NSCLEAN', 8192); /** * Merge CDATA as text nodes * @link https://php.net/manual/en/libxml.constants.php */ -define ('LIBXML_NOCDATA', 16384); +define('LIBXML_NOCDATA', 16384); /** * Disable network access when loading documents * @link https://php.net/manual/en/libxml.constants.php */ -define ('LIBXML_NONET', 2048); +define('LIBXML_NONET', 2048); /** * Sets XML_PARSE_PEDANTIC flag, which enables pedentic error reporting. * @link https://php.net/manual/en/libxml.constants.php * @since 5.4 */ -define ('LIBXML_PEDANTIC', 128); +define('LIBXML_PEDANTIC', 128); /** * Activate small nodes allocation optimization. This may speed up your @@ -235,7 +231,7 @@ function libxml_set_external_entity_loader (?callable $resolver_function): bool * * @link https://php.net/manual/en/libxml.constants.php */ -define ('LIBXML_COMPACT', 65536); +define('LIBXML_COMPACT', 65536); /** * Allows line numbers greater than 65535 to be reported correctly. @@ -244,8 +240,7 @@ function libxml_set_external_entity_loader (?callable $resolver_function): bool * * @link https://php.net/manual/en/libxml.constants.php */ -define ('LIBXML_BIGLINES', 65535); - +define('LIBXML_BIGLINES', 65535); /** * Drop the XML declaration when saving a document @@ -254,7 +249,7 @@ function libxml_set_external_entity_loader (?callable $resolver_function): bool * * @link https://php.net/manual/en/libxml.constants.php */ -define ('LIBXML_NOXMLDECL', 2); +define('LIBXML_NOXMLDECL', 2); /** * Sets XML_PARSE_HUGE flag, which relaxes any hardcoded limit from the parser. This affects @@ -265,7 +260,7 @@ function libxml_set_external_entity_loader (?callable $resolver_function): bool * * @link https://php.net/manual/en/libxml.constants.php */ -define ('LIBXML_PARSEHUGE', 524288); +define('LIBXML_PARSEHUGE', 524288); /** * Expand empty tags (e.g. <br/> to @@ -277,7 +272,7 @@ function libxml_set_external_entity_loader (?callable $resolver_function): bool * * @link https://php.net/manual/en/libxml.constants.php */ -define ('LIBXML_NOEMPTYTAG', 4); +define('LIBXML_NOEMPTYTAG', 4); /** * Create default/fixed value nodes during XSD schema validation @@ -286,7 +281,7 @@ function libxml_set_external_entity_loader (?callable $resolver_function): bool * * @link https://php.net/manual/en/libxml.constants.php */ -define ('LIBXML_SCHEMA_CREATE', 1); +define('LIBXML_SCHEMA_CREATE', 1); /** * Sets HTML_PARSE_NOIMPLIED flag, which turns off the @@ -296,7 +291,7 @@ function libxml_set_external_entity_loader (?callable $resolver_function): bool * * @link https://php.net/manual/en/libxml.constants.php */ -define ('LIBXML_HTML_NOIMPLIED', 8192); +define('LIBXML_HTML_NOIMPLIED', 8192); /** * Sets HTML_PARSE_NODEFDTD flag, which prevents a default doctype @@ -306,30 +301,30 @@ function libxml_set_external_entity_loader (?callable $resolver_function): bool * * @link https://php.net/manual/en/libxml.constants.php */ -define ('LIBXML_HTML_NODEFDTD', 4); +define('LIBXML_HTML_NODEFDTD', 4); /** * No errors * @link https://php.net/manual/en/libxml.constants.php */ -define ('LIBXML_ERR_NONE', 0); +define('LIBXML_ERR_NONE', 0); /** * A simple warning * @link https://php.net/manual/en/libxml.constants.php */ -define ('LIBXML_ERR_WARNING', 1); +define('LIBXML_ERR_WARNING', 1); /** * A recoverable error * @link https://php.net/manual/en/libxml.constants.php */ -define ('LIBXML_ERR_ERROR', 2); +define('LIBXML_ERR_ERROR', 2); /** * A fatal error * @link https://php.net/manual/en/libxml.constants.php */ -define ('LIBXML_ERR_FATAL', 3); +define('LIBXML_ERR_FATAL', 3); // End of libxml v. diff --git a/lua/lua.php b/lua/lua.php index 9d22ab6ca..f6bbb377e 100644 --- a/lua/lua.php +++ b/lua/lua.php @@ -6,13 +6,14 @@ /** * @link https://secure.php.net/manual/en/class.lua.php */ -class Lua { +class Lua +{ /** * @var string * * @link https://secure.php.net/manual/en/class.lua.php#lua.constants.lua-version */ - const LUA_VERSION = '5.1.4'; + public const LUA_VERSION = '5.1.4'; /** * @param null|string $lua_script_file @@ -76,5 +77,3 @@ public function getVersion(): string {} */ public function registerCallback(string $name, callable $function) {} } - -?> diff --git a/lzf/lzf.php b/lzf/lzf.php index 4dfcb2857..566960a5b 100644 --- a/lzf/lzf.php +++ b/lzf/lzf.php @@ -11,7 +11,7 @@ * * @since 0.1.0 */ -function lzf_compress($data) { } +function lzf_compress($data) {} /** * Decompresses the given data string containing lzf encoded data. @@ -24,7 +24,7 @@ function lzf_compress($data) { } * * @since 0.1.0 */ -function lzf_decompress($data) { } +function lzf_decompress($data) {} /** * Determines what was LZF extension optimized for during compilation. @@ -35,4 +35,4 @@ function lzf_decompress($data) { } * * @since 1.0.0 */ -function lzf_optimized_for() { } +function lzf_optimized_for() {} diff --git a/mailparse/mailparse.php b/mailparse/mailparse.php index 709ef8069..ff643a98f 100644 --- a/mailparse/mailparse.php +++ b/mailparse/mailparse.php @@ -12,7 +12,7 @@ * @return string Returns one of the character encodings supported by the * {@link https://php.net/manual/en/ref.mbstring.php mbstring} module. */ -function mailparse_determine_best_xfer_encoding ($fp) {} +function mailparse_determine_best_xfer_encoding($fp) {} /** * (PECL mailparse >= 0.9.0)Value in seconds which will be used for connecting to the daemon. Think twice before changing the default value of 1 second - you can lose all the advantages of caching if your connection is too slow.
* @return boolReturns TRUE on success or FALSE on failure.
*/ - public function connect ($host, $port, $timeout = 1) {} + public function connect($host, $port, $timeout = 1) {} /** * (PECL memcache >= 2.0.0)Returns TRUE on success or FALSE on failure.
*/ - public function setServerParams ($host, $port = 11211, $timeout = 1, $retry_interval = 15, $status = true, callable $failure_callback = null) {} + public function setServerParams($host, $port = 11211, $timeout = 1, $retry_interval = 15, $status = true, callable $failure_callback = null) {} - /** - * - */ - public function setFailureCallback () {} + public function setFailureCallback() {} /** * (PECL memcache >= 2.1.0)Expiration time of the item. If it's equal to zero, the item will never expire. You can also use Unix timestamp or a number of seconds starting from current time, but in the latter case the number of seconds may not exceed 2592000 (30 days).
* @return bool Returns TRUE on success or FALSE on failure. */ - public function replace ($key, $var, $flag = null, $expire = null) {} + public function replace($key, $var, $flag = null, $expire = null) {} - public function cas () {} + public function cas() {} - public function append () {} + public function append() {} /** * @return string */ - public function prepend () {} + public function prepend() {} /** * (PECL memcache >= 0.2.0)Specifies the minimum amount of savings to actually store the value compressed. The supplied value must be between 0 and 1. Default value is 0.2 giving a minimum 20% compression savings.
* @return bool Returns TRUE on success or FALSE on failure. */ - public function setCompressThreshold ($thresold, $min_saving = 0.2) {} + public function setCompressThreshold($thresold, $min_saving = 0.2) {} /** * (PECL memcache >= 0.2.0)- * Point to the host where memcached is listening for connections. This parameter - * may also specify other transports like unix:///path/to/memcached.sock - * to use UNIX domain sockets, in this case port must also - * be set to 0. - *
- * @param int $port [optional]- * Point to the port where memcached is listening for connections. Set this - * parameter to 0 when using UNIX domain sockets. - *
- * @param int $timeout [optional]- * Value in seconds which will be used for connecting to the daemon. Think - * twice before changing the default value of 1 second - you can lose all - * the advantages of caching if your connection is too slow. - *
- * @return mixed a Memcache object or FALSE on failure. - */ - public function pconnect ($host, $port, $timeout = 1) {} +class Memcache extends MemcachePool +{ + /** + * (PECL memcache >= 0.4.0)+ * Point to the host where memcached is listening for connections. This parameter + * may also specify other transports like unix:///path/to/memcached.sock + * to use UNIX domain sockets, in this case port must also + * be set to 0. + *
+ * @param int $port [optional]+ * Point to the port where memcached is listening for connections. Set this + * parameter to 0 when using UNIX domain sockets. + *
+ * @param int $timeout [optional]+ * Value in seconds which will be used for connecting to the daemon. Think + * twice before changing the default value of 1 second - you can lose all + * the advantages of caching if your connection is too slow. + *
+ * @return mixed a Memcache object or FALSE on failure. + */ + public function pconnect($host, $port, $timeout = 1) {} } // string $host [, int $port [, int $timeout ]] @@ -382,7 +374,7 @@ public function pconnect ($host, $port, $timeout = 1) {} * * @return bool Returns TRUE on success or FALSE on failure. */ -function memcache_connect ($host, $port, $timeout = 1) {} +function memcache_connect($host, $port, $timeout = 1) {} /** * (PECL memcache >= 0.4.0) @@ -394,33 +386,33 @@ function memcache_connect ($host, $port, $timeout = 1) {} * @param int $timeout * @return Memcache */ -function memcache_pconnect ($host, $port = null, $timeout = 1) {} +function memcache_pconnect($host, $port = null, $timeout = 1) {} -function memcache_add_server () {} +function memcache_add_server() {} -function memcache_set_server_params () {} +function memcache_set_server_params() {} -function memcache_set_failure_callback () {} +function memcache_set_failure_callback() {} -function memcache_get_server_status () {} +function memcache_get_server_status() {} -function memcache_get_version () {} +function memcache_get_version() {} -function memcache_add () {} +function memcache_add() {} -function memcache_set () {} +function memcache_set() {} -function memcache_replace () {} +function memcache_replace() {} -function memcache_cas () {} +function memcache_cas() {} -function memcache_append () {} +function memcache_append() {} -function memcache_prepend () {} +function memcache_prepend() {} -function memcache_get () {} +function memcache_get() {} -function memcache_delete () {} +function memcache_delete() {} /** * (PECL memcache >= 0.2.0)Enables or disables payload compression. When enabled, - * item values longer than a certain threshold (currently 100 bytes) will be - * compressed during storage and decompressed during retrieval - * transparently.
- *Type: boolean, default: TRUE.
- * @link https://php.net/manual/en/memcached.constants.php - */ - 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: "".
- * @link https://php.net/manual/en/memcached.constants.php - */ - 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: integer, default: Memcached::SERIALIZER_PHP.
- * @link https://php.net/manual/en/memcached.constants.php - */ - const OPT_SERIALIZER = -1003; - - /** - *Indicates whether igbinary serializer support is available.
- *Type: boolean.
- * @link https://php.net/manual/en/memcached.constants.php - */ - const HAVE_IGBINARY = 0; - - /** - *Indicates whether JSON serializer support is available.
- *Type: boolean.
- * @link https://php.net/manual/en/memcached.constants.php - */ - const HAVE_JSON = 0; - - /** - *Indicates whether msgpack serializer support is available.
- *Type: boolean.
- * Available as of Memcached 3.0.0. - * @since 3.0.0 - * @link https://php.net/manual/en/memcached.constants.php - */ - const HAVE_MSGPACK = 0; - - /** - *Indicate whether set_encoding_key is available
- *Type: boolean.
- * @link https://github.com/php-memcached-dev/php-memcached/blob/v3.1.5/memcached-api.php, https://github.com/php-memcached-dev/php-memcached/blob/v3.1.5/php_memcached.c#L4387 - */ - const HAVE_ENCODING = 0; - - /** - * Feature support - */ - const HAVE_SESSION = 1; - const HAVE_SASL = 0; - - /** - *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: integer, default: Memcached::HASH_DEFAULT
- * @link https://php.net/manual/en/memcached.constants.php - */ - const OPT_HASH = 2; - - /** - *The default (Jenkins one-at-a-time) item key hashing algorithm.
- * @link https://php.net/manual/en/memcached.constants.php - */ - const HASH_DEFAULT = 0; - - /** - *MD5 item key hashing algorithm.
- * @link https://php.net/manual/en/memcached.constants.php - */ - const HASH_MD5 = 1; - - /** - *CRC item key hashing algorithm.
- * @link https://php.net/manual/en/memcached.constants.php - */ - const HASH_CRC = 2; - - /** - *FNV1_64 item key hashing algorithm.
- * @link https://php.net/manual/en/memcached.constants.php - */ - const HASH_FNV1_64 = 3; - - /** - *FNV1_64A item key hashing algorithm.
- * @link https://php.net/manual/en/memcached.constants.php - */ - const HASH_FNV1A_64 = 4; - - /** - *FNV1_32 item key hashing algorithm.
- * @link https://php.net/manual/en/memcached.constants.php - */ - const HASH_FNV1_32 = 5; - - /** - *FNV1_32A item key hashing algorithm.
- * @link https://php.net/manual/en/memcached.constants.php - */ - const HASH_FNV1A_32 = 6; - - /** - *Hsieh item key hashing algorithm.
- * @link https://php.net/manual/en/memcached.constants.php - */ - const HASH_HSIEH = 7; - - /** - *Murmur item key hashing algorithm.
- * @link https://php.net/manual/en/memcached.constants.php - */ - 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: integer, default: Memcached::DISTRIBUTION_MODULA.
- * @link https://php.net/manual/en/memcached.constants.php - */ - const OPT_DISTRIBUTION = 9; - - /** - *Modulo-based key distribution algorithm.
- * @link https://php.net/manual/en/memcached.constants.php - */ - const DISTRIBUTION_MODULA = 0; - - /** - *Consistent hashing key distribution algorithm (based on libketama).
- * @link https://php.net/manual/en/memcached.constants.php - */ - 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: boolean, default: FALSE.
- * @link https://php.net/manual/en/memcached.constants.php - */ - 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: boolean, default: FALSE.
- * @link https://php.net/manual/en/memcached.constants.php - */ - 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: boolean, default: FALSE.
- * @link https://php.net/manual/en/memcached.constants.php - */ - const OPT_BINARY_PROTOCOL = 18; - - /** - *Enables or disables asynchronous I/O. This is the fastest transport - * available for storage functions.
- *Type: boolean, default: FALSE.
- * @link https://php.net/manual/en/memcached.constants.php - */ - const OPT_NO_BLOCK = 0; - - /** - *Enables or disables the no-delay feature for connecting sockets (may - * be faster in some environments).
- *Type: boolean, default: FALSE.
- * @link https://php.net/manual/en/memcached.constants.php - */ - const OPT_TCP_NODELAY = 1; - - /** - *The maximum socket send buffer in bytes.
- *Type: integer, default: varies by platform/kernel - * configuration.
- * @link https://php.net/manual/en/memcached.constants.php - */ - const OPT_SOCKET_SEND_SIZE = 4; - - /** - *The maximum socket receive buffer in bytes.
- *Type: integer, default: varies by platform/kernel - * configuration.
- * @link https://php.net/manual/en/memcached.constants.php - */ - const OPT_SOCKET_RECV_SIZE = 5; - - /** - *In non-blocking mode this set the value of the timeout during socket - * connection, in milliseconds.
- *Type: integer, default: 1000.
- * @link https://php.net/manual/en/memcached.constants.php - */ - const OPT_CONNECT_TIMEOUT = 14; - - /** - *The amount of time, in seconds, to wait until retrying a failed - * connection attempt.
- *Type: integer, default: 0.
- * @link https://php.net/manual/en/memcached.constants.php - */ - const OPT_RETRY_TIMEOUT = 15; - - /** - *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: integer, default: 0.
- * @link https://php.net/manual/en/memcached.constants.php - */ - 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: integer, default: 0.
- * @link https://php.net/manual/en/memcached.constants.php - */ - const OPT_RECV_TIMEOUT = 20; - - /** - *Timeout for connection polling, in milliseconds.
- *Type: integer, default: 1000.
- * @link https://php.net/manual/en/memcached.constants.php - */ - const OPT_POLL_TIMEOUT = 8; - - /** - *Enables or disables caching of DNS lookups.
- *Type: boolean, default: FALSE.
- * @link https://php.net/manual/en/memcached.constants.php - */ - 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: integer, default: 0.
- * @link https://php.net/manual/en/memcached.constants.php - */ - const OPT_SERVER_FAILURE_LIMIT = 21; - const OPT_AUTO_EJECT_HOSTS = 28; - const OPT_HASH_WITH_PREFIX_KEY = 25; - const OPT_NOREPLY = 26; - const OPT_SORT_HOSTS = 12; - const OPT_VERIFY_KEY = 13; - const OPT_USE_UDP = 27; - const OPT_NUMBER_OF_REPLICAS = 29; - const OPT_RANDOMIZE_REPLICA_READ = 30; - const OPT_CORK = 31; - const OPT_REMOVE_FAILED_SERVERS = 35; - const OPT_DEAD_TIMEOUT = 36; - const OPT_SERVER_TIMEOUT_LIMIT = 37; - const OPT_MAX = 38; - const OPT_IO_BYTES_WATERMARK = 23; - const OPT_IO_KEY_PREFETCH = 24; - const OPT_IO_MSG_WATERMARK = 22; - const OPT_LOAD_FROM_FILE = 34; - const OPT_SUPPORT_CAS = 7; - const OPT_TCP_KEEPIDLE = 33; - const OPT_USER_DATA = 11; - - - /** - * libmemcached result codes - */ - /** - *The operation was successful.
- * @link https://php.net/manual/en/memcached.constants.php - */ - const RES_SUCCESS = 0; - - /** - *The operation failed in some fashion.
- * @link https://php.net/manual/en/memcached.constants.php - */ - const RES_FAILURE = 1; - - /** - *DNS lookup failed.
- * @link https://php.net/manual/en/memcached.constants.php - */ - const RES_HOST_LOOKUP_FAILURE = 2; - - /** - *Failed to read network data.
- * @link https://php.net/manual/en/memcached.constants.php - */ - const RES_UNKNOWN_READ_FAILURE = 7; - - /** - *Bad command in memcached protocol.
- * @link https://php.net/manual/en/memcached.constants.php - */ - const RES_PROTOCOL_ERROR = 8; - - /** - *Error on the client side.
- * @link https://php.net/manual/en/memcached.constants.php - */ - const RES_CLIENT_ERROR = 9; - - /** - *Error on the server side.
- * @link https://php.net/manual/en/memcached.constants.php - */ - const RES_SERVER_ERROR = 10; - - /** - *Failed to write network data.
- * @link https://php.net/manual/en/memcached.constants.php - */ - const RES_WRITE_FAILURE = 5; - - /** - *Failed to do compare-and-swap: item you are trying to store has been - * modified since you last fetched it.
- * @link https://php.net/manual/en/memcached.constants.php - */ - const RES_DATA_EXISTS = 12; - - /** - *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.
- * @link https://php.net/manual/en/memcached.constants.php - */ - const RES_NOTSTORED = 14; - - /** - *Item with this key was not found (with "get" operation or "cas" - * operations).
- * @link https://php.net/manual/en/memcached.constants.php - */ - const RES_NOTFOUND = 16; - - /** - *Partial network data read error.
- * @link https://php.net/manual/en/memcached.constants.php - */ - const RES_PARTIAL_READ = 18; - - /** - *Some errors occurred during multi-get.
- * @link https://php.net/manual/en/memcached.constants.php - */ - const RES_SOME_ERRORS = 19; - - /** - *Server list is empty.
- * @link https://php.net/manual/en/memcached.constants.php - */ - const RES_NO_SERVERS = 20; - - /** - *End of result set.
- * @link https://php.net/manual/en/memcached.constants.php - */ - const RES_END = 21; - - /** - *System error.
- * @link https://php.net/manual/en/memcached.constants.php - */ - const RES_ERRNO = 26; - - /** - *The operation was buffered.
- * @link https://php.net/manual/en/memcached.constants.php - */ - const RES_BUFFERED = 32; - - /** - *The operation timed out.
- * @link https://php.net/manual/en/memcached.constants.php - */ - const RES_TIMEOUT = 31; - - /** - *Bad key.
- * @link https://php.net/manual/en/memcached.constants.php, http://docs.libmemcached.org/index.html - */ - /** - *MEMCACHED_BAD_KEY_PROVIDED: The key provided is not a valid key.
- */ - const RES_BAD_KEY_PROVIDED = 33; - /** - *MEMCACHED_STORED: The requested object has been successfully stored on the server.
- */ - const RES_STORED = 15; - /** - *MEMCACHED_DELETED: The object requested by the key has been deleted.
- */ - const RES_DELETED = 22; - /** - *MEMCACHED_STAT: A “stat” command has been returned in the protocol.
- */ - const RES_STAT = 24; - /** - *MEMCACHED_ITEM: An item has been fetched (this is an internal error only).
- */ - const RES_ITEM = 25; - /** - *MEMCACHED_NOT_SUPPORTED: The given method is not supported in the server.
- */ - const RES_NOT_SUPPORTED = 28; - /** - *MEMCACHED_FETCH_NOTFINISHED: A request has been made, but the server has not finished the fetch of the last request.
- */ - const RES_FETCH_NOTFINISHED = 30; - /** - *MEMCACHED_SERVER_MARKED_DEAD: The requested server has been marked dead.
- */ - const RES_SERVER_MARKED_DEAD = 35; - /** - *MEMCACHED_UNKNOWN_STAT_KEY: The server you are communicating with has a stat key which has not be defined in the protocol.
- */ - const RES_UNKNOWN_STAT_KEY = 36; - /** - *MEMCACHED_INVALID_HOST_PROTOCOL: The server you are connecting too has an invalid protocol. Most likely you are connecting to an older server that does not speak the binary protocol.
- */ - const RES_INVALID_HOST_PROTOCOL = 34; - /** - *MEMCACHED_MEMORY_ALLOCATION_FAILURE: An error has occurred while trying to allocate memory.
- */ - const RES_MEMORY_ALLOCATION_FAILURE = 17; - /** - *MEMCACHED_E2BIG: Item is too large for the server to store.
- */ - const RES_E2BIG = 37; - /** - *MEMCACHED_KEY_TOO_BIG: The key that has been provided is too large for the given server.
- */ - const RES_KEY_TOO_BIG = 39; - /** - *MEMCACHED_SERVER_TEMPORARILY_DISABLED
- */ - const RES_SERVER_TEMPORARILY_DISABLED = 47; - /** - *MEMORY_ALLOCATION_FAILURE: An error has occurred while trying to allocate memory. - * - * #if defined(LIBMEMCACHED_VERSION_HEX) && LIBMEMCACHED_VERSION_HEX >= 0x01000008
- */ - const RES_SERVER_MEMORY_ALLOCATION_FAILURE = 48; - /** - *MEMCACHED_AUTH_PROBLEM: An unknown issue has occured during authentication.
- */ - const RES_AUTH_PROBLEM = 40; - /** - *MEMCACHED_AUTH_FAILURE: The credentials provided are not valid for this server.
- */ - const RES_AUTH_FAILURE = 41; - /** - *MEMCACHED_AUTH_CONTINUE: Authentication has been paused.
- */ - const RES_AUTH_CONTINUE = 42; - /** - *MEMCACHED_CONNECTION_FAILURE: A unknown error has occured while trying to connect to a server.
- */ - const RES_CONNECTION_FAILURE = 3; - /** - * MEMCACHED_CONNECTION_BIND_FAILURE: We were not able to bind() to the socket. - */ - #[Deprecated('Deprecated since version 0.30(libmemcached)')] - const RES_CONNECTION_BIND_FAILURE = 4; - /** - *MEMCACHED_READ_FAILURE: A read failure has occurred.
- */ - const RES_READ_FAILURE = 6; - /** - *MEMCACHED_DATA_DOES_NOT_EXIST: The data requested with the key given was not found.
- */ - const RES_DATA_DOES_NOT_EXIST = 13; - /** - *MEMCACHED_VALUE: A value has been returned from the server (this is an internal condition only).
- */ - const RES_VALUE = 23; - /** - *MEMCACHED_FAIL_UNIX_SOCKET: A connection was not established with the server via a unix domain socket.
- */ - const RES_FAIL_UNIX_SOCKET = 27; - /** - * No key was provided. - */ - #[Deprecated('Deprecated since version 0.30 (libmemcached). Use MEMCACHED_BAD_KEY_PROVIDED instead.')] - const RES_NO_KEY_PROVIDED = 29; - /** - *MEMCACHED_INVALID_ARGUMENTS: The arguments supplied to the given function were not valid.
- */ - const RES_INVALID_ARGUMENTS = 38; - /** - *MEMCACHED_PARSE_ERROR: An error has occurred while trying to parse the configuration string. You should use memparse to determine what the error was.
- */ - const RES_PARSE_ERROR = 43; - /** - *MEMCACHED_PARSE_USER_ERROR: An error has occurred in parsing the configuration string.
- */ - const RES_PARSE_USER_ERROR = 44; - /** - *MEMCACHED_DEPRECATED: The method that was requested has been deprecated.
- */ - const RES_DEPRECATED = 45; - //unknow - const RES_IN_PROGRESS = 46; - /** - *MEMCACHED_MAXIMUM_RETURN: This in an internal only state.
- */ - const RES_MAXIMUM_RETURN = 49; - - /** - * Server callbacks, if compiled with --memcached-protocol - * @link https://github.com/php-memcached-dev/php-memcached/blob/v3.1.5/memcached-api.php - */ - const ON_CONNECT = 0; - const ON_ADD = 1; - const ON_APPEND = 2; - const ON_DECREMENT = 3; - const ON_DELETE = 4; - const ON_FLUSH = 5; - const ON_GET = 6; - const ON_INCREMENT = 7; - const ON_NOOP = 8; - const ON_PREPEND = 9; - const ON_QUIT = 10; - const ON_REPLACE = 11; - const ON_SET = 12; - const ON_STAT = 13; - const ON_VERSION = 14; - /** - * Constants used when compiled with --memcached-protocol - * @link https://github.com/php-memcached-dev/php-memcached/blob/v3.1.5/memcached-api.php - */ - const RESPONSE_SUCCESS = 0; - const RESPONSE_KEY_ENOENT = 1; - const RESPONSE_KEY_EEXISTS = 2; - const RESPONSE_E2BIG = 3; - const RESPONSE_EINVAL = 4; - const RESPONSE_NOT_STORED = 5; - const RESPONSE_DELTA_BADVAL = 6; - const RESPONSE_NOT_MY_VBUCKET = 7; - const RESPONSE_AUTH_ERROR = 32; - const RESPONSE_AUTH_CONTINUE = 33; - const RESPONSE_UNKNOWN_COMMAND = 129; - const RESPONSE_ENOMEM = 130; - const RESPONSE_NOT_SUPPORTED = 131; - const RESPONSE_EINTERNAL = 132; - const RESPONSE_EBUSY = 133; - const RESPONSE_ETMPFAIL = 134; - - - /** - *Failed to create network socket.
- * @link https://php.net/manual/en/memcached.constants.php - */ - const RES_CONNECTION_SOCKET_CREATE_FAILURE = 11; - - /** - *Payload failure: could not compress/decompress or serialize/unserialize the value.
- * @link https://php.net/manual/en/memcached.constants.php - */ - const RES_PAYLOAD_FAILURE = -1001; - - /** - *The default PHP serializer.
- * @link https://php.net/manual/en/memcached.constants.php - */ - 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.
- * @link https://php.net/manual/en/memcached.constants.php - */ - const SERIALIZER_IGBINARY = 2; - - /** - *The JSON serializer. Requires PHP 5.2.10+.
- * @link https://php.net/manual/en/memcached.constants.php - */ - const SERIALIZER_JSON = 3; - const SERIALIZER_JSON_ARRAY = 4; - /** - *The msgpack serializer.
- * @link https://github.com/php-memcached-dev/php-memcached/blob/v3.1.5/memcached-api.php - */ - 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.
- * @link https://php.net/manual/en/memcached.constants.php - */ - 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. - * @link https://php.net/manual/en/memcached.constants.php - */ - const GET_EXTENDED = 2; - - const GET_ERROR_RETURN_VALUE = false; - - /** - * (PECL memcached >= 0.1.0)- * The key of the item to retrieve. - *
- * @param callable $cache_cb [optional]- * Read-through caching callback or NULL. - *
- * @param int $flags [optional]- * The flags for the get operation. - *
- * @return mixed the value stored in the cache or FALSE otherwise. - * The Memcached::getResultCode will return - * Memcached::RES_NOTFOUND if the key does not exist. - */ - public function get ($key, callable $cache_cb = null, $flags = 0) {} - - /** - * (PECL memcached >= 0.1.0)- * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations. - *
- * @param string $key- * The key of the item to fetch. - *
- * @param callable $cache_cb [optional]- * Read-through caching callback or NULL - *
- * @param int $flags [optional]- * The flags for the get operation. - *
- * @return mixed the value stored in the cache or FALSE otherwise. - * The Memcached::getResultCode will return - * Memcached::RES_NOTFOUND if the key does not exist. - */ - public function getByKey ($server_key, $key, callable $cache_cb = null, $flags = 0) {} - - /** - * (PECL memcached >= 0.1.0)- * Array of keys to retrieve. - *
- * @param int $flags [optional]- * The flags for the get operation. - *
- * @return mixed the array of found items or FALSE on failure. - * Use Memcached::getResultCode if necessary. - */ - public function getMulti (array $keys, $flags = 0) {} - - /** - * (PECL memcached >= 0.1.0)- * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations. - *
- * @param array $keys- * Array of keys to retrieve. - *
- * @param int $flags [optional]- * The flags for the get operation. - *
- * @return array|false the array of found items or FALSE on failure. - * Use Memcached::getResultCode if necessary. - */ - public function getMultiByKey ($server_key, array $keys, $flags = 0) {} - - /** - * (PECL memcached >= 0.1.0)- * Array of keys to request. - *
- * @param bool $with_cas [optional]- * Whether to request CAS token values also. - *
- * @param callable $value_cb [optional]- * The result callback or NULL. - *
- * @return bool TRUE on success or FALSE on failure. - * Use Memcached::getResultCode if necessary. - */ - public function getDelayed (array $keys, $with_cas = null, callable $value_cb = null) {} - - /** - * (PECL memcached >= 0.1.0)- * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations. - *
- * @param array $keys- * Array of keys to request. - *
- * @param bool $with_cas [optional]- * Whether to request CAS token values also. - *
- * @param callable $value_cb [optional]- * The result callback or NULL. - *
- * @return bool TRUE on success or FALSE on failure. - * Use Memcached::getResultCode if necessary. - */ - public function getDelayedByKey ($server_key, array $keys, $with_cas = null, callable $value_cb = null) {} - - /** - * (PECL memcached >= 0.1.0)- * The key under which to store the value. - *
- * @param mixed $value- * The value to store. - *
- * @param int $expiration [optional]- * The expiration time, defaults to 0. See Expiration Times for more info. - *
- * @param int $udf_flags [optional] - * @return bool TRUE on success or FALSE on failure. - * Use Memcached::getResultCode if necessary. - */ - public function set ($key, $value, $expiration = 0, $udf_flags = 0) {} - - /** - * (PECL memcached >= 0.1.0)- * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations. - *
- * @param string $key- * The key under which to store the value. - *
- * @param mixed $value- * The value to store. - *
- * @param int $expiration [optional]- * The expiration time, defaults to 0. See Expiration Times for more info. - *
- * @param int $udf_flags [optional] - * @return bool TRUE on success or FALSE on failure. - * Use Memcached::getResultCode if necessary. - */ - public function setByKey ($server_key, $key, $value, $expiration = 0, $udf_flags = 0) {} - - /** - * (PECL memcached >= 2.0.0)- * The key under which to store the value. - *
- * @param int $expiration- * The expiration time, defaults to 0. See Expiration Times for more info. - *
- * @return bool TRUE on success or FALSE on failure. - * Use Memcached::getResultCode if necessary. - */ - public function touch ($key, $expiration = 0) {} - - /** - * (PECL memcached >= 2.0.0)- * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations. - *
- * @param string $key- * The key under which to store the value. - *
- * @param int $expiration- * The expiration time, defaults to 0. See Expiration Times for more info. - *
- * @return bool TRUE on success or FALSE on failure. - * Use Memcached::getResultCode if necessary. - */ - public function touchByKey ($server_key, $key, $expiration) {} - - /** - * (PECL memcached >= 0.1.0)- * An array of key/value pairs to store on the server. - *
- * @param int $expiration [optional]- * The expiration time, defaults to 0. See Expiration Times for more info. - *
- * @param int $udf_flags [optional] - * @return bool TRUE on success or FALSE on failure. - * Use Memcached::getResultCode if necessary. - */ - public function setMulti (array $items, $expiration = 0, $udf_flags = 0) {} - - /** - * (PECL memcached >= 0.1.0)- * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations. - *
- * @param array $items- * An array of key/value pairs to store on the server. - *
- * @param int $expiration [optional]- * The expiration time, defaults to 0. See Expiration Times for more info. - *
- * @param int $udf_flags [optional] - * @return bool TRUE on success or FALSE on failure. - * Use Memcached::getResultCode if necessary. - */ - public function setMultiByKey ($server_key, array $items, $expiration = 0, $udf_flags = 0) {} - - /** - * (PECL memcached >= 0.1.0)- * Unique value associated with the existing item. Generated by memcache. - *
- * @param string $key- * The key under which to store the value. - *
- * @param mixed $value- * The value to store. - *
- * @param int $expiration [optional]- * The expiration time, defaults to 0. See Expiration Times for more info. - *
- * @param int $udf_flags [optional] - * @return bool 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. - */ - public function cas ($cas_token, $key, $value, $expiration = 0, $udf_flags = 0) {} - - /** - * (PECL memcached >= 0.1.0)- * Unique value associated with the existing item. Generated by memcache. - *
- * @param string $server_key- * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations. - *
- * @param string $key- * The key under which to store the value. - *
- * @param mixed $value- * The value to store. - *
- * @param int $expiration [optional]- * The expiration time, defaults to 0. See Expiration Times for more info. - *
- * @param int $udf_flags [optional] - * @return bool 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. - */ - public function casByKey ($cas_token, $server_key, $key, $value, $expiration = 0, $udf_flags = 0) {} - - /** - * (PECL memcached >= 0.1.0)- * The key under which to store the value. - *
- * @param mixed $value- * The value to store. - *
- * @param int $expiration [optional]- * The expiration time, defaults to 0. See Expiration Times for more info. - *
- * @param int $udf_flags [optional] - * @return bool TRUE on success or FALSE on failure. - * The Memcached::getResultCode will return - * Memcached::RES_NOTSTORED if the key already exists. - */ - public function add ($key, $value, $expiration = 0, $udf_flags = 0) {} - - /** - * (PECL memcached >= 0.1.0)- * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations. - *
- * @param string $key- * The key under which to store the value. - *
- * @param mixed $value- * The value to store. - *
- * @param int $expiration [optional]- * The expiration time, defaults to 0. See Expiration Times for more info. - *
- * @param int $udf_flags [optional] - * @return bool TRUE on success or FALSE on failure. - * The Memcached::getResultCode will return - * Memcached::RES_NOTSTORED if the key already exists. - */ - public function addByKey ($server_key, $key, $value, $expiration = 0, $udf_flags = 0) {} - - /** - * (PECL memcached >= 0.1.0)- * The key under which to store the value. - *
- * @param string $value- * The string to append. - *
- * @return bool TRUE on success or FALSE on failure. - * The Memcached::getResultCode will return - * Memcached::RES_NOTSTORED if the key does not exist. - */ - public function append ($key, $value) {} - - /** - * (PECL memcached >= 0.1.0)- * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations. - *
- * @param string $key- * The key under which to store the value. - *
- * @param string $value- * The string to append. - *
- * @return bool TRUE on success or FALSE on failure. - * The Memcached::getResultCode will return - * Memcached::RES_NOTSTORED if the key does not exist. - */ - public function appendByKey ($server_key, $key, $value) {} - - /** - * (PECL memcached >= 0.1.0)- * The key of the item to prepend the data to. - *
- * @param string $value- * The string to prepend. - *
- * @return bool TRUE on success or FALSE on failure. - * The Memcached::getResultCode will return - * Memcached::RES_NOTSTORED if the key does not exist. - */ - public function prepend ($key, $value) {} - - /** - * (PECL memcached >= 0.1.0)- * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations. - *
- * @param string $key- * The key of the item to prepend the data to. - *
- * @param string $value- * The string to prepend. - *
- * @return bool TRUE on success or FALSE on failure. - * The Memcached::getResultCode will return - * Memcached::RES_NOTSTORED if the key does not exist. - */ - public function prependByKey ($server_key, $key, $value) {} - - /** - * (PECL memcached >= 0.1.0)- * The key under which to store the value. - *
- * @param mixed $value- * The value to store. - *
- * @param int $expiration [optional]- * The expiration time, defaults to 0. See Expiration Times for more info. - *
- * @param int $udf_flags [optional] - * @return bool TRUE on success or FALSE on failure. - * The Memcached::getResultCode will return - * Memcached::RES_NOTSTORED if the key does not exist. - */ - public function replace ($key, $value, $expiration = null, $udf_flags = 0) {} - - /** - * (PECL memcached >= 0.1.0)- * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations. - *
- * @param string $key- * The key under which to store the value. - *
- * @param mixed $value- * The value to store. - *
- * @param int $expiration [optional]- * The expiration time, defaults to 0. See Expiration Times for more info. - *
- * @param int $udf_flags [optional] - * @return bool TRUE on success or FALSE on failure. - * The Memcached::getResultCode will return - * Memcached::RES_NOTSTORED if the key does not exist. - */ - public function replaceByKey ($server_key, $key, $value, $expiration = null, $udf_flags = 0) {} - - /** - * (PECL memcached >= 0.1.0)- * The key to be deleted. - *
- * @param int $time [optional]- * The amount of time the server will wait to delete the item. - *
- * @return bool TRUE on success or FALSE on failure. - * The Memcached::getResultCode will return - * Memcached::RES_NOTFOUND if the key does not exist. - */ - public function delete ($key, $time = 0) {} - - /** - * (PECL memcached >= 2.0.0)- * The keys to be deleted. - *
- * @param int $time [optional]- * The amount of time the server will wait to delete the items. - *
- * @return array Returns array indexed by keys and where values are indicating whether operation succeeded or not. - * The Memcached::getResultCode will return - * Memcached::RES_NOTFOUND if the key does not exist. - */ - public function deleteMulti (array $keys, $time = 0) {} - - /** - * (PECL memcached >= 0.1.0)- * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations. - *
- * @param string $key- * The key to be deleted. - *
- * @param int $time [optional]- * The amount of time the server will wait to delete the item. - *
- * @return bool TRUE on success or FALSE on failure. - * The Memcached::getResultCode will return - * Memcached::RES_NOTFOUND if the key does not exist. - */ - public function deleteByKey ($server_key, $key, $time = 0) {} - - /** - * (PECL memcached >= 2.0.0)- * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations. - *
- * @param array $keys- * The keys to be deleted. - *
- * @param int $time [optional]- * The amount of time the server will wait to delete the items. - *
- * @return bool TRUE on success or FALSE on failure. - * The Memcached::getResultCode will return - * Memcached::RES_NOTFOUND if the key does not exist. - */ - public function deleteMultiByKey ($server_key, array $keys, $time = 0) {} - - /** - * (PECL memcached >= 0.1.0)- * The key of the item to increment. - *
- * @param int $offset [optional]- * The amount by which to increment the item's value. - *
- * @param int $initial_value [optional]- * The value to set the item to if it doesn't currently exist. - *
- * @param int $expiry [optional]- * The expiry time to set on the item. - *
- * @return int|false new item's value on success or FALSE on failure. - */ - public function increment ($key, $offset = 1, $initial_value = 0, $expiry = 0) {} - - /** - * (PECL memcached >= 0.1.0)- * The key of the item to decrement. - *
- * @param int $offset [optional]- * The amount by which to decrement the item's value. - *
- * @param int $initial_value [optional]- * The value to set the item to if it doesn't currently exist. - *
- * @param int $expiry [optional]- * The expiry time to set on the item. - *
- * @return int|false item's new value on success or FALSE on failure. - */ - public function decrement ($key, $offset = 1, $initial_value = 0, $expiry = 0) {} - - /** - * (PECL memcached >= 2.0.0)- * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations. - *
- * @param string $key- * The key of the item to increment. - *
- * @param int $offset [optional]- * The amount by which to increment the item's value. - *
- * @param int $initial_value [optional]- * The value to set the item to if it doesn't currently exist. - *
- * @param int $expiry [optional]- * The expiry time to set on the item. - *
- * @return int|false new item's value on success or FALSE on failure. - */ - public function incrementByKey ($server_key, $key, $offset = 1, $initial_value = 0, $expiry = 0) {} - - /** - * (PECL memcached >= 2.0.0)- * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations. - *
- * @param string $key- * The key of the item to decrement. - *
- * @param int $offset [optional]- * The amount by which to decrement the item's value. - *
- * @param int $initial_value [optional]- * The value to set the item to if it doesn't currently exist. - *
- * @param int $expiry [optional]- * The expiry time to set on the item. - *
- * @return int|false item's new value on success or FALSE on failure. - */ - public function decrementByKey ($server_key, $key, $offset = 1, $initial_value = 0, $expiry = 0) {} - - /** - * (PECL memcached >= 0.1.0)- * The hostname of the memcache server. If the hostname is invalid, data-related - * operations will set - * Memcached::RES_HOST_LOOKUP_FAILURE result code. - *
- * @param int $port- * The port on which memcache is running. Usually, this is - * 11211. - *
- * @param int $weight [optional]- * The weight of the server relative to the total weight of all the - * servers in the pool. This controls the probability of the server being - * selected for operations. This is used only with consistent distribution - * option and usually corresponds to the amount of memory available to - * memcache on that server. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function addServer ($host, $port, $weight = 0) {} - - /** - * (PECL memcached >= 0.1.1)- * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations. - *
- * @return array an array containing three keys of host, - * port, and weight on success or FALSE - * on failure. - * Use Memcached::getResultCode if necessary. - */ - public function getServerByKey ($server_key) {} - - /** - * (PECL memcached >= 2.0.0)items, slabs, sizes ...
- * @return array|false Array of server statistics, one entry per server. - */ - public function getStats ($type = null) {} - - /** - * (PECL memcached >= 0.1.5)- * Numer of seconds to wait before invalidating the items. - *
- * @return bool TRUE on success or FALSE on failure. - * Use Memcached::getResultCode if necessary. - */ - public function flush ($delay = 0) {} - - /** - * (PECL memcached >= 0.1.0)- * One of the Memcached::OPT_* constants. - *
- * @return mixed the value of the requested option, or FALSE on - * error. - */ - public function getOption ($option) {} - - /** - * (PECL memcached >= 0.1.0)- * 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 TRUE on success or FALSE on failure. - */ - public function setOptions (array $options) {} - - /** - * (PECL memcached >= 2.0.0)- * The username to use for authentication. - *
- * @param string $password- * The password to use for authentication. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function setSaslAuthData (string $username , string $password) {} - - /** - * (PECL memcached >= 2.0.0)Enables or disables payload compression. When enabled, + * item values longer than a certain threshold (currently 100 bytes) will be + * compressed during storage and decompressed during retrieval + * transparently.
+ *Type: boolean, default: TRUE.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const OPT_COMPRESSION = -1001; + public 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: "".
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public 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: integer, default: Memcached::SERIALIZER_PHP.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const OPT_SERIALIZER = -1003; + + /** + *Indicates whether igbinary serializer support is available.
+ *Type: boolean.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const HAVE_IGBINARY = 0; + + /** + *Indicates whether JSON serializer support is available.
+ *Type: boolean.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const HAVE_JSON = 0; + + /** + *Indicates whether msgpack serializer support is available.
+ *Type: boolean.
+ * Available as of Memcached 3.0.0. + * @since 3.0.0 + * @link https://php.net/manual/en/memcached.constants.php + */ + public const HAVE_MSGPACK = 0; + + /** + *Indicate whether set_encoding_key is available
+ *Type: boolean.
+ * @link https://github.com/php-memcached-dev/php-memcached/blob/v3.1.5/memcached-api.php, https://github.com/php-memcached-dev/php-memcached/blob/v3.1.5/php_memcached.c#L4387 + */ + public const HAVE_ENCODING = 0; + + /** + * Feature support + */ + public const HAVE_SESSION = 1; + public const HAVE_SASL = 0; + + /** + *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: integer, default: Memcached::HASH_DEFAULT
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const OPT_HASH = 2; + + /** + *The default (Jenkins one-at-a-time) item key hashing algorithm.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const HASH_DEFAULT = 0; + + /** + *MD5 item key hashing algorithm.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const HASH_MD5 = 1; + + /** + *CRC item key hashing algorithm.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const HASH_CRC = 2; + + /** + *FNV1_64 item key hashing algorithm.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const HASH_FNV1_64 = 3; + + /** + *FNV1_64A item key hashing algorithm.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const HASH_FNV1A_64 = 4; + + /** + *FNV1_32 item key hashing algorithm.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const HASH_FNV1_32 = 5; + + /** + *FNV1_32A item key hashing algorithm.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const HASH_FNV1A_32 = 6; + + /** + *Hsieh item key hashing algorithm.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const HASH_HSIEH = 7; + + /** + *Murmur item key hashing algorithm.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public 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: integer, default: Memcached::DISTRIBUTION_MODULA.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const OPT_DISTRIBUTION = 9; + + /** + *Modulo-based key distribution algorithm.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const DISTRIBUTION_MODULA = 0; + + /** + *Consistent hashing key distribution algorithm (based on libketama).
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const DISTRIBUTION_CONSISTENT = 1; + public 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: boolean, default: FALSE.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const OPT_LIBKETAMA_COMPATIBLE = 16; + public const OPT_LIBKETAMA_HASH = 17; + public 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: boolean, default: FALSE.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public 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: boolean, default: FALSE.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const OPT_BINARY_PROTOCOL = 18; + + /** + *Enables or disables asynchronous I/O. This is the fastest transport + * available for storage functions.
+ *Type: boolean, default: FALSE.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const OPT_NO_BLOCK = 0; + + /** + *Enables or disables the no-delay feature for connecting sockets (may + * be faster in some environments).
+ *Type: boolean, default: FALSE.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const OPT_TCP_NODELAY = 1; + + /** + *The maximum socket send buffer in bytes.
+ *Type: integer, default: varies by platform/kernel + * configuration.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const OPT_SOCKET_SEND_SIZE = 4; + + /** + *The maximum socket receive buffer in bytes.
+ *Type: integer, default: varies by platform/kernel + * configuration.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const OPT_SOCKET_RECV_SIZE = 5; + + /** + *In non-blocking mode this set the value of the timeout during socket + * connection, in milliseconds.
+ *Type: integer, default: 1000.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const OPT_CONNECT_TIMEOUT = 14; + + /** + *The amount of time, in seconds, to wait until retrying a failed + * connection attempt.
+ *Type: integer, default: 0.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const OPT_RETRY_TIMEOUT = 15; + + /** + *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: integer, default: 0.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public 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: integer, default: 0.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const OPT_RECV_TIMEOUT = 20; + + /** + *Timeout for connection polling, in milliseconds.
+ *Type: integer, default: 1000.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const OPT_POLL_TIMEOUT = 8; + + /** + *Enables or disables caching of DNS lookups.
+ *Type: boolean, default: FALSE.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public 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: integer, default: 0.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const OPT_SERVER_FAILURE_LIMIT = 21; + public const OPT_AUTO_EJECT_HOSTS = 28; + public const OPT_HASH_WITH_PREFIX_KEY = 25; + public const OPT_NOREPLY = 26; + public const OPT_SORT_HOSTS = 12; + public const OPT_VERIFY_KEY = 13; + public const OPT_USE_UDP = 27; + public const OPT_NUMBER_OF_REPLICAS = 29; + public const OPT_RANDOMIZE_REPLICA_READ = 30; + public const OPT_CORK = 31; + public const OPT_REMOVE_FAILED_SERVERS = 35; + public const OPT_DEAD_TIMEOUT = 36; + public const OPT_SERVER_TIMEOUT_LIMIT = 37; + public const OPT_MAX = 38; + public const OPT_IO_BYTES_WATERMARK = 23; + public const OPT_IO_KEY_PREFETCH = 24; + public const OPT_IO_MSG_WATERMARK = 22; + public const OPT_LOAD_FROM_FILE = 34; + public const OPT_SUPPORT_CAS = 7; + public const OPT_TCP_KEEPIDLE = 33; + public const OPT_USER_DATA = 11; + + /** + * libmemcached result codes + */ + /** + *The operation was successful.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const RES_SUCCESS = 0; + + /** + *The operation failed in some fashion.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const RES_FAILURE = 1; + + /** + *DNS lookup failed.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const RES_HOST_LOOKUP_FAILURE = 2; + + /** + *Failed to read network data.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const RES_UNKNOWN_READ_FAILURE = 7; + + /** + *Bad command in memcached protocol.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const RES_PROTOCOL_ERROR = 8; + + /** + *Error on the client side.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const RES_CLIENT_ERROR = 9; + + /** + *Error on the server side.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const RES_SERVER_ERROR = 10; + + /** + *Failed to write network data.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const RES_WRITE_FAILURE = 5; + + /** + *Failed to do compare-and-swap: item you are trying to store has been + * modified since you last fetched it.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const RES_DATA_EXISTS = 12; + + /** + *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.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const RES_NOTSTORED = 14; + + /** + *Item with this key was not found (with "get" operation or "cas" + * operations).
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const RES_NOTFOUND = 16; + + /** + *Partial network data read error.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const RES_PARTIAL_READ = 18; + + /** + *Some errors occurred during multi-get.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const RES_SOME_ERRORS = 19; + + /** + *Server list is empty.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const RES_NO_SERVERS = 20; + + /** + *End of result set.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const RES_END = 21; + + /** + *System error.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const RES_ERRNO = 26; + + /** + *The operation was buffered.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const RES_BUFFERED = 32; + + /** + *The operation timed out.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const RES_TIMEOUT = 31; + + /** + *Bad key.
+ * @link https://php.net/manual/en/memcached.constants.php, http://docs.libmemcached.org/index.html + */ + /** + *MEMCACHED_BAD_KEY_PROVIDED: The key provided is not a valid key.
+ */ + public const RES_BAD_KEY_PROVIDED = 33; + /** + *MEMCACHED_STORED: The requested object has been successfully stored on the server.
+ */ + public const RES_STORED = 15; + /** + *MEMCACHED_DELETED: The object requested by the key has been deleted.
+ */ + public const RES_DELETED = 22; + /** + *MEMCACHED_STAT: A “stat” command has been returned in the protocol.
+ */ + public const RES_STAT = 24; + /** + *MEMCACHED_ITEM: An item has been fetched (this is an internal error only).
+ */ + public const RES_ITEM = 25; + /** + *MEMCACHED_NOT_SUPPORTED: The given method is not supported in the server.
+ */ + public const RES_NOT_SUPPORTED = 28; + /** + *MEMCACHED_FETCH_NOTFINISHED: A request has been made, but the server has not finished the fetch of the last request.
+ */ + public const RES_FETCH_NOTFINISHED = 30; + /** + *MEMCACHED_SERVER_MARKED_DEAD: The requested server has been marked dead.
+ */ + public const RES_SERVER_MARKED_DEAD = 35; + /** + *MEMCACHED_UNKNOWN_STAT_KEY: The server you are communicating with has a stat key which has not be defined in the protocol.
+ */ + public const RES_UNKNOWN_STAT_KEY = 36; + /** + *MEMCACHED_INVALID_HOST_PROTOCOL: The server you are connecting too has an invalid protocol. Most likely you are connecting to an older server that does not speak the binary protocol.
+ */ + public const RES_INVALID_HOST_PROTOCOL = 34; + /** + *MEMCACHED_MEMORY_ALLOCATION_FAILURE: An error has occurred while trying to allocate memory.
+ */ + public const RES_MEMORY_ALLOCATION_FAILURE = 17; + /** + *MEMCACHED_E2BIG: Item is too large for the server to store.
+ */ + public const RES_E2BIG = 37; + /** + *MEMCACHED_KEY_TOO_BIG: The key that has been provided is too large for the given server.
+ */ + public const RES_KEY_TOO_BIG = 39; + /** + *MEMCACHED_SERVER_TEMPORARILY_DISABLED
+ */ + public const RES_SERVER_TEMPORARILY_DISABLED = 47; + /** + *MEMORY_ALLOCATION_FAILURE: An error has occurred while trying to allocate memory. + * + * #if defined(LIBMEMCACHED_VERSION_HEX) && LIBMEMCACHED_VERSION_HEX >= 0x01000008
+ */ + public const RES_SERVER_MEMORY_ALLOCATION_FAILURE = 48; + /** + *MEMCACHED_AUTH_PROBLEM: An unknown issue has occured during authentication.
+ */ + public const RES_AUTH_PROBLEM = 40; + /** + *MEMCACHED_AUTH_FAILURE: The credentials provided are not valid for this server.
+ */ + public const RES_AUTH_FAILURE = 41; + /** + *MEMCACHED_AUTH_CONTINUE: Authentication has been paused.
+ */ + public const RES_AUTH_CONTINUE = 42; + /** + *MEMCACHED_CONNECTION_FAILURE: A unknown error has occured while trying to connect to a server.
+ */ + public const RES_CONNECTION_FAILURE = 3; + /** + * MEMCACHED_CONNECTION_BIND_FAILURE: We were not able to bind() to the socket. + */ + #[Deprecated('Deprecated since version 0.30(libmemcached)')] + public const RES_CONNECTION_BIND_FAILURE = 4; + /** + *MEMCACHED_READ_FAILURE: A read failure has occurred.
+ */ + public const RES_READ_FAILURE = 6; + /** + *MEMCACHED_DATA_DOES_NOT_EXIST: The data requested with the key given was not found.
+ */ + public const RES_DATA_DOES_NOT_EXIST = 13; + /** + *MEMCACHED_VALUE: A value has been returned from the server (this is an internal condition only).
+ */ + public const RES_VALUE = 23; + /** + *MEMCACHED_FAIL_UNIX_SOCKET: A connection was not established with the server via a unix domain socket.
+ */ + public const RES_FAIL_UNIX_SOCKET = 27; + /** + * No key was provided. + */ + #[Deprecated('Deprecated since version 0.30 (libmemcached). Use MEMCACHED_BAD_KEY_PROVIDED instead.')] + public const RES_NO_KEY_PROVIDED = 29; + /** + *MEMCACHED_INVALID_ARGUMENTS: The arguments supplied to the given function were not valid.
+ */ + public const RES_INVALID_ARGUMENTS = 38; + /** + *MEMCACHED_PARSE_ERROR: An error has occurred while trying to parse the configuration string. You should use memparse to determine what the error was.
+ */ + public const RES_PARSE_ERROR = 43; + /** + *MEMCACHED_PARSE_USER_ERROR: An error has occurred in parsing the configuration string.
+ */ + public const RES_PARSE_USER_ERROR = 44; + /** + *MEMCACHED_DEPRECATED: The method that was requested has been deprecated.
+ */ + public const RES_DEPRECATED = 45; + //unknow + public const RES_IN_PROGRESS = 46; + /** + *MEMCACHED_MAXIMUM_RETURN: This in an internal only state.
+ */ + public const RES_MAXIMUM_RETURN = 49; + + /** + * Server callbacks, if compiled with --memcached-protocol + * @link https://github.com/php-memcached-dev/php-memcached/blob/v3.1.5/memcached-api.php + */ + public const ON_CONNECT = 0; + public const ON_ADD = 1; + public const ON_APPEND = 2; + public const ON_DECREMENT = 3; + public const ON_DELETE = 4; + public const ON_FLUSH = 5; + public const ON_GET = 6; + public const ON_INCREMENT = 7; + public const ON_NOOP = 8; + public const ON_PREPEND = 9; + public const ON_QUIT = 10; + public const ON_REPLACE = 11; + public const ON_SET = 12; + public const ON_STAT = 13; + public const ON_VERSION = 14; + /** + * Constants used when compiled with --memcached-protocol + * @link https://github.com/php-memcached-dev/php-memcached/blob/v3.1.5/memcached-api.php + */ + public const RESPONSE_SUCCESS = 0; + public const RESPONSE_KEY_ENOENT = 1; + public const RESPONSE_KEY_EEXISTS = 2; + public const RESPONSE_E2BIG = 3; + public const RESPONSE_EINVAL = 4; + public const RESPONSE_NOT_STORED = 5; + public const RESPONSE_DELTA_BADVAL = 6; + public const RESPONSE_NOT_MY_VBUCKET = 7; + public const RESPONSE_AUTH_ERROR = 32; + public const RESPONSE_AUTH_CONTINUE = 33; + public const RESPONSE_UNKNOWN_COMMAND = 129; + public const RESPONSE_ENOMEM = 130; + public const RESPONSE_NOT_SUPPORTED = 131; + public const RESPONSE_EINTERNAL = 132; + public const RESPONSE_EBUSY = 133; + public const RESPONSE_ETMPFAIL = 134; + + /** + *Failed to create network socket.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const RES_CONNECTION_SOCKET_CREATE_FAILURE = 11; + + /** + *Payload failure: could not compress/decompress or serialize/unserialize the value.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const RES_PAYLOAD_FAILURE = -1001; + + /** + *The default PHP serializer.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public 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.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const SERIALIZER_IGBINARY = 2; + + /** + *The JSON serializer. Requires PHP 5.2.10+.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public const SERIALIZER_JSON = 3; + public const SERIALIZER_JSON_ARRAY = 4; + /** + *The msgpack serializer.
+ * @link https://github.com/php-memcached-dev/php-memcached/blob/v3.1.5/memcached-api.php + */ + public const SERIALIZER_MSGPACK = 5; + + public const COMPRESSION_FASTLZ = 2; + public 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.
+ * @link https://php.net/manual/en/memcached.constants.php + */ + public 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. + * @link https://php.net/manual/en/memcached.constants.php + */ + public const GET_EXTENDED = 2; + + public const GET_ERROR_RETURN_VALUE = false; + + /** + * (PECL memcached >= 0.1.0)+ * The key of the item to retrieve. + *
+ * @param callable $cache_cb [optional]+ * Read-through caching callback or NULL. + *
+ * @param int $flags [optional]+ * The flags for the get operation. + *
+ * @return mixed the value stored in the cache or FALSE otherwise. + * The Memcached::getResultCode will return + * Memcached::RES_NOTFOUND if the key does not exist. + */ + public function get($key, callable $cache_cb = null, $flags = 0) {} + + /** + * (PECL memcached >= 0.1.0)+ * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations. + *
+ * @param string $key+ * The key of the item to fetch. + *
+ * @param callable $cache_cb [optional]+ * Read-through caching callback or NULL + *
+ * @param int $flags [optional]+ * The flags for the get operation. + *
+ * @return mixed the value stored in the cache or FALSE otherwise. + * The Memcached::getResultCode will return + * Memcached::RES_NOTFOUND if the key does not exist. + */ + public function getByKey($server_key, $key, callable $cache_cb = null, $flags = 0) {} + + /** + * (PECL memcached >= 0.1.0)+ * Array of keys to retrieve. + *
+ * @param int $flags [optional]+ * The flags for the get operation. + *
+ * @return mixed the array of found items or FALSE on failure. + * Use Memcached::getResultCode if necessary. + */ + public function getMulti(array $keys, $flags = 0) {} + + /** + * (PECL memcached >= 0.1.0)+ * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations. + *
+ * @param array $keys+ * Array of keys to retrieve. + *
+ * @param int $flags [optional]+ * The flags for the get operation. + *
+ * @return array|false the array of found items or FALSE on failure. + * Use Memcached::getResultCode if necessary. + */ + public function getMultiByKey($server_key, array $keys, $flags = 0) {} + + /** + * (PECL memcached >= 0.1.0)+ * Array of keys to request. + *
+ * @param bool $with_cas [optional]+ * Whether to request CAS token values also. + *
+ * @param callable $value_cb [optional]+ * The result callback or NULL. + *
+ * @return bool TRUE on success or FALSE on failure. + * Use Memcached::getResultCode if necessary. + */ + public function getDelayed(array $keys, $with_cas = null, callable $value_cb = null) {} + + /** + * (PECL memcached >= 0.1.0)+ * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations. + *
+ * @param array $keys+ * Array of keys to request. + *
+ * @param bool $with_cas [optional]+ * Whether to request CAS token values also. + *
+ * @param callable $value_cb [optional]+ * The result callback or NULL. + *
+ * @return bool TRUE on success or FALSE on failure. + * Use Memcached::getResultCode if necessary. + */ + public function getDelayedByKey($server_key, array $keys, $with_cas = null, callable $value_cb = null) {} + + /** + * (PECL memcached >= 0.1.0)+ * The key under which to store the value. + *
+ * @param mixed $value+ * The value to store. + *
+ * @param int $expiration [optional]+ * The expiration time, defaults to 0. See Expiration Times for more info. + *
+ * @param int $udf_flags [optional] + * @return bool TRUE on success or FALSE on failure. + * Use Memcached::getResultCode if necessary. + */ + public function set($key, $value, $expiration = 0, $udf_flags = 0) {} + + /** + * (PECL memcached >= 0.1.0)+ * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations. + *
+ * @param string $key+ * The key under which to store the value. + *
+ * @param mixed $value+ * The value to store. + *
+ * @param int $expiration [optional]+ * The expiration time, defaults to 0. See Expiration Times for more info. + *
+ * @param int $udf_flags [optional] + * @return bool TRUE on success or FALSE on failure. + * Use Memcached::getResultCode if necessary. + */ + public function setByKey($server_key, $key, $value, $expiration = 0, $udf_flags = 0) {} + + /** + * (PECL memcached >= 2.0.0)+ * The key under which to store the value. + *
+ * @param int $expiration+ * The expiration time, defaults to 0. See Expiration Times for more info. + *
+ * @return bool TRUE on success or FALSE on failure. + * Use Memcached::getResultCode if necessary. + */ + public function touch($key, $expiration = 0) {} + + /** + * (PECL memcached >= 2.0.0)+ * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations. + *
+ * @param string $key+ * The key under which to store the value. + *
+ * @param int $expiration+ * The expiration time, defaults to 0. See Expiration Times for more info. + *
+ * @return bool TRUE on success or FALSE on failure. + * Use Memcached::getResultCode if necessary. + */ + public function touchByKey($server_key, $key, $expiration) {} + + /** + * (PECL memcached >= 0.1.0)+ * An array of key/value pairs to store on the server. + *
+ * @param int $expiration [optional]+ * The expiration time, defaults to 0. See Expiration Times for more info. + *
+ * @param int $udf_flags [optional] + * @return bool TRUE on success or FALSE on failure. + * Use Memcached::getResultCode if necessary. + */ + public function setMulti(array $items, $expiration = 0, $udf_flags = 0) {} + + /** + * (PECL memcached >= 0.1.0)+ * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations. + *
+ * @param array $items+ * An array of key/value pairs to store on the server. + *
+ * @param int $expiration [optional]+ * The expiration time, defaults to 0. See Expiration Times for more info. + *
+ * @param int $udf_flags [optional] + * @return bool TRUE on success or FALSE on failure. + * Use Memcached::getResultCode if necessary. + */ + public function setMultiByKey($server_key, array $items, $expiration = 0, $udf_flags = 0) {} + + /** + * (PECL memcached >= 0.1.0)+ * Unique value associated with the existing item. Generated by memcache. + *
+ * @param string $key+ * The key under which to store the value. + *
+ * @param mixed $value+ * The value to store. + *
+ * @param int $expiration [optional]+ * The expiration time, defaults to 0. See Expiration Times for more info. + *
+ * @param int $udf_flags [optional] + * @return bool 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. + */ + public function cas($cas_token, $key, $value, $expiration = 0, $udf_flags = 0) {} + + /** + * (PECL memcached >= 0.1.0)+ * Unique value associated with the existing item. Generated by memcache. + *
+ * @param string $server_key+ * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations. + *
+ * @param string $key+ * The key under which to store the value. + *
+ * @param mixed $value+ * The value to store. + *
+ * @param int $expiration [optional]+ * The expiration time, defaults to 0. See Expiration Times for more info. + *
+ * @param int $udf_flags [optional] + * @return bool 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. + */ + public function casByKey($cas_token, $server_key, $key, $value, $expiration = 0, $udf_flags = 0) {} + + /** + * (PECL memcached >= 0.1.0)+ * The key under which to store the value. + *
+ * @param mixed $value+ * The value to store. + *
+ * @param int $expiration [optional]+ * The expiration time, defaults to 0. See Expiration Times for more info. + *
+ * @param int $udf_flags [optional] + * @return bool TRUE on success or FALSE on failure. + * The Memcached::getResultCode will return + * Memcached::RES_NOTSTORED if the key already exists. + */ + public function add($key, $value, $expiration = 0, $udf_flags = 0) {} + + /** + * (PECL memcached >= 0.1.0)+ * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations. + *
+ * @param string $key+ * The key under which to store the value. + *
+ * @param mixed $value+ * The value to store. + *
+ * @param int $expiration [optional]+ * The expiration time, defaults to 0. See Expiration Times for more info. + *
+ * @param int $udf_flags [optional] + * @return bool TRUE on success or FALSE on failure. + * The Memcached::getResultCode will return + * Memcached::RES_NOTSTORED if the key already exists. + */ + public function addByKey($server_key, $key, $value, $expiration = 0, $udf_flags = 0) {} + + /** + * (PECL memcached >= 0.1.0)+ * The key under which to store the value. + *
+ * @param string $value+ * The string to append. + *
+ * @return bool TRUE on success or FALSE on failure. + * The Memcached::getResultCode will return + * Memcached::RES_NOTSTORED if the key does not exist. + */ + public function append($key, $value) {} + + /** + * (PECL memcached >= 0.1.0)+ * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations. + *
+ * @param string $key+ * The key under which to store the value. + *
+ * @param string $value+ * The string to append. + *
+ * @return bool TRUE on success or FALSE on failure. + * The Memcached::getResultCode will return + * Memcached::RES_NOTSTORED if the key does not exist. + */ + public function appendByKey($server_key, $key, $value) {} + + /** + * (PECL memcached >= 0.1.0)+ * The key of the item to prepend the data to. + *
+ * @param string $value+ * The string to prepend. + *
+ * @return bool TRUE on success or FALSE on failure. + * The Memcached::getResultCode will return + * Memcached::RES_NOTSTORED if the key does not exist. + */ + public function prepend($key, $value) {} + + /** + * (PECL memcached >= 0.1.0)+ * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations. + *
+ * @param string $key+ * The key of the item to prepend the data to. + *
+ * @param string $value+ * The string to prepend. + *
+ * @return bool TRUE on success or FALSE on failure. + * The Memcached::getResultCode will return + * Memcached::RES_NOTSTORED if the key does not exist. + */ + public function prependByKey($server_key, $key, $value) {} + + /** + * (PECL memcached >= 0.1.0)+ * The key under which to store the value. + *
+ * @param mixed $value+ * The value to store. + *
+ * @param int $expiration [optional]+ * The expiration time, defaults to 0. See Expiration Times for more info. + *
+ * @param int $udf_flags [optional] + * @return bool TRUE on success or FALSE on failure. + * The Memcached::getResultCode will return + * Memcached::RES_NOTSTORED if the key does not exist. + */ + public function replace($key, $value, $expiration = null, $udf_flags = 0) {} + + /** + * (PECL memcached >= 0.1.0)+ * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations. + *
+ * @param string $key+ * The key under which to store the value. + *
+ * @param mixed $value+ * The value to store. + *
+ * @param int $expiration [optional]+ * The expiration time, defaults to 0. See Expiration Times for more info. + *
+ * @param int $udf_flags [optional] + * @return bool TRUE on success or FALSE on failure. + * The Memcached::getResultCode will return + * Memcached::RES_NOTSTORED if the key does not exist. + */ + public function replaceByKey($server_key, $key, $value, $expiration = null, $udf_flags = 0) {} + + /** + * (PECL memcached >= 0.1.0)+ * The key to be deleted. + *
+ * @param int $time [optional]+ * The amount of time the server will wait to delete the item. + *
+ * @return bool TRUE on success or FALSE on failure. + * The Memcached::getResultCode will return + * Memcached::RES_NOTFOUND if the key does not exist. + */ + public function delete($key, $time = 0) {} + + /** + * (PECL memcached >= 2.0.0)+ * The keys to be deleted. + *
+ * @param int $time [optional]+ * The amount of time the server will wait to delete the items. + *
+ * @return array Returns array indexed by keys and where values are indicating whether operation succeeded or not. + * The Memcached::getResultCode will return + * Memcached::RES_NOTFOUND if the key does not exist. + */ + public function deleteMulti(array $keys, $time = 0) {} + + /** + * (PECL memcached >= 0.1.0)+ * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations. + *
+ * @param string $key+ * The key to be deleted. + *
+ * @param int $time [optional]+ * The amount of time the server will wait to delete the item. + *
+ * @return bool TRUE on success or FALSE on failure. + * The Memcached::getResultCode will return + * Memcached::RES_NOTFOUND if the key does not exist. + */ + public function deleteByKey($server_key, $key, $time = 0) {} + + /** + * (PECL memcached >= 2.0.0)+ * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations. + *
+ * @param array $keys+ * The keys to be deleted. + *
+ * @param int $time [optional]+ * The amount of time the server will wait to delete the items. + *
+ * @return bool TRUE on success or FALSE on failure. + * The Memcached::getResultCode will return + * Memcached::RES_NOTFOUND if the key does not exist. + */ + public function deleteMultiByKey($server_key, array $keys, $time = 0) {} + + /** + * (PECL memcached >= 0.1.0)+ * The key of the item to increment. + *
+ * @param int $offset [optional]+ * The amount by which to increment the item's value. + *
+ * @param int $initial_value [optional]+ * The value to set the item to if it doesn't currently exist. + *
+ * @param int $expiry [optional]+ * The expiry time to set on the item. + *
+ * @return int|false new item's value on success or FALSE on failure. + */ + public function increment($key, $offset = 1, $initial_value = 0, $expiry = 0) {} + + /** + * (PECL memcached >= 0.1.0)+ * The key of the item to decrement. + *
+ * @param int $offset [optional]+ * The amount by which to decrement the item's value. + *
+ * @param int $initial_value [optional]+ * The value to set the item to if it doesn't currently exist. + *
+ * @param int $expiry [optional]+ * The expiry time to set on the item. + *
+ * @return int|false item's new value on success or FALSE on failure. + */ + public function decrement($key, $offset = 1, $initial_value = 0, $expiry = 0) {} + + /** + * (PECL memcached >= 2.0.0)+ * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations. + *
+ * @param string $key+ * The key of the item to increment. + *
+ * @param int $offset [optional]+ * The amount by which to increment the item's value. + *
+ * @param int $initial_value [optional]+ * The value to set the item to if it doesn't currently exist. + *
+ * @param int $expiry [optional]+ * The expiry time to set on the item. + *
+ * @return int|false new item's value on success or FALSE on failure. + */ + public function incrementByKey($server_key, $key, $offset = 1, $initial_value = 0, $expiry = 0) {} + + /** + * (PECL memcached >= 2.0.0)+ * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations. + *
+ * @param string $key+ * The key of the item to decrement. + *
+ * @param int $offset [optional]+ * The amount by which to decrement the item's value. + *
+ * @param int $initial_value [optional]+ * The value to set the item to if it doesn't currently exist. + *
+ * @param int $expiry [optional]+ * The expiry time to set on the item. + *
+ * @return int|false item's new value on success or FALSE on failure. + */ + public function decrementByKey($server_key, $key, $offset = 1, $initial_value = 0, $expiry = 0) {} + + /** + * (PECL memcached >= 0.1.0)+ * The hostname of the memcache server. If the hostname is invalid, data-related + * operations will set + * Memcached::RES_HOST_LOOKUP_FAILURE result code. + *
+ * @param int $port+ * The port on which memcache is running. Usually, this is + * 11211. + *
+ * @param int $weight [optional]+ * The weight of the server relative to the total weight of all the + * servers in the pool. This controls the probability of the server being + * selected for operations. This is used only with consistent distribution + * option and usually corresponds to the amount of memory available to + * memcache on that server. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function addServer($host, $port, $weight = 0) {} + + /** + * (PECL memcached >= 0.1.1)+ * The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations. + *
+ * @return array an array containing three keys of host, + * port, and weight on success or FALSE + * on failure. + * Use Memcached::getResultCode if necessary. + */ + public function getServerByKey($server_key) {} + + /** + * (PECL memcached >= 2.0.0)items, slabs, sizes ...
+ * @return array|false Array of server statistics, one entry per server. + */ + public function getStats($type = null) {} + + /** + * (PECL memcached >= 0.1.5)+ * Numer of seconds to wait before invalidating the items. + *
+ * @return bool TRUE on success or FALSE on failure. + * Use Memcached::getResultCode if necessary. + */ + public function flush($delay = 0) {} + + /** + * (PECL memcached >= 0.1.0)+ * One of the Memcached::OPT_* constants. + *
+ * @return mixed the value of the requested option, or FALSE on + * error. + */ + public function getOption($option) {} + + /** + * (PECL memcached >= 0.1.0)+ * 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 TRUE on success or FALSE on failure. + */ + public function setOptions(array $options) {} + + /** + * (PECL memcached >= 2.0.0)+ * The username to use for authentication. + *
+ * @param string $password+ * The password to use for authentication. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function setSaslAuthData(string $username, string $password) {} + + /** + * (PECL memcached >= 2.0.0)+ * @param bool|string $connection [optional]
* If connection is not given, or FALSE then connection that would be selected for writes would be closed. In a single-node configuration, that is then the whole connection, but if you are connected to a replica set, close() will only close the connection to the primary server.
* If connection is TRUE then all connections as known by the connection manager will be closed. This can include connections that are not referenced in the connection string used to create the object that you are calling close on.
* If connection is a string argument, then it will only close the connection identified by this hash. Hashes are identifiers for a connection and can be obtained by calling {@see MongoClient::getConnections()}.
@@ -145,16 +145,14 @@ public function dropDB($db) {}
* @param string $dbname The database name.
* @return MongoDB The database name.
*/
- public function __get ($dbname)
- {}
+ public function __get($dbname) {}
/**
* Get connections
* Returns an array of all open connections, and information about each of the servers
* @return array
*/
- static public function getConnections ()
- {}
+ public static function getConnections() {}
/**
* Get hosts
@@ -163,16 +161,14 @@ static public function getConnections ()
* connected to.
* @return array
*/
- public function getHosts ()
- {}
+ public function getHosts() {}
/**
* Get read preference
* Get the read preference for this connection
* @return array
*/
- public function getReadPreference ()
- {}
+ public function getReadPreference() {}
/**
* (PECL mongo >= 1.5.0)
@@ -181,8 +177,7 @@ public function getReadPreference ()
* The array contains the values w for an integer acknowledgement level or string mode,
* and wtimeout denoting the maximum number of milliseconds to wait for the server to satisfy the write concern.
If cloned files should be kept if the repair fails.
- * @param bool $backup_original_files [optional]If original files should be backed up.
- * @return arrayReturns db response.
- */ + * Repairs and compacts this database + * @link https://secure.php.net/manual/en/mongodb.repair.php + * @param bool $preserve_cloned_files [optional]If cloned files should be kept if the repair fails.
+ * @param bool $backup_original_files [optional]If original files should be backed up.
+ * @return arrayReturns db response.
+ */ public function repair($preserve_cloned_files = false, $backup_original_files = false) {} /** * (PECL mongo >= 0.9.0)* Returns a new collection object. *
- */ + */ public function selectCollection($name) {} /** @@ -603,12 +597,12 @@ public function selectCollection($name) {} * * @return bool Returns the former value of slaveOkay for this instance. */ - public function setSlaveOkay ($ok = true) {} + public function setSlaveOkay($ok = true) {} - /** - * Creates a collection - * @link https://secure.php.net/manual/en/mongodb.createcollection.php - * @param string $name The name of the collection. + /** + * Creates a collection + * @link https://secure.php.net/manual/en/mongodb.createcollection.php + * @param string $name The name of the collection. * @param array $options [optional]*
* An array containing options for the collections. Each option is its own @@ -637,56 +631,55 @@ public function setSlaveOkay ($ok = true) {} * autoIndexId was FALSE. *
* - * @return MongoCollectionReturns a collection object representing the new collection.
+ * @return MongoCollectionReturns a collection object representing the new collection.
*/ public function createCollection($name, $options) {} /** * (PECL mongo >= 0.9.0)Include system collections.
- * @return array Returns a list of MongoCollections. - */ + /** + * (PECL mongo >= 0.9.0)Include system collections.
+ * @return array Returns a list of MongoCollections. + */ public function listCollections($includeSystemCollections = false) {} /** * (PECL mongo >= 0.9.0)+ * @link https://secure.php.net/manual/en/mongodb.createdbref.php + * @param string $collection The collection to which the database reference will point. + * @param mixed $document_or_id
* If an array or object is given, its _id field will be * used as the reference ID. If a {@see MongoId} or scalar * is given, it will be used as the reference ID. *
- * @return arrayReturns a database reference array.
+ * @return arrayReturns a database reference array.
** If an array without an _id field was provided as the * document_or_id parameter, NULL will be returned. *
- */ + */ public function createDBRef($collection, $document_or_id) {} - - /** + /** * (PECL mongo >= 0.9.0)* This parameter is an associative array of the form * array("optionname" => <boolean>, ...). Currently @@ -719,7 +712,7 @@ public function execute($code, array $args = array()) {} *
"timeout"
Deprecated alias for "socketTimeoutMS".
Returns database response. If the login was successful, it will return 1.
+ * Log in to this database + * + * @link https://secure.php.net/manual/en/mongodb.authenticate.php + * + * @param string $username The username. + * @param string $password The password (in plaintext). + * + * @return arrayReturns database response. If the login was successful, it will return 1.
*
* <?php
* array(
@@ -794,7 +787,7 @@ public function forceError() {}
*
("auth fails" could be another message, depending on database version and * what went wrong)
- */ + */ public function authenticate($username, $password) {} /** @@ -803,7 +796,7 @@ public function authenticate($username, $password) {} * @link https://secure.php.net/manual/en/mongodb.getreadpreference.php * @return array This function returns an array describing the read preference. The array contains the values type for the string read preference mode (corresponding to the MongoClient constants), and tagsets containing a list of all tag set criteria. If no tag sets were specified, tagsets will not be present in the array. */ - public function getReadPreference () {} + public function getReadPreference() {} /** * (PECL mongo >= 1.3.0)An array of zero or more tag sets, where each tag set is itself an array of criteria used to match tags on replica set members.
* @return bool Returns TRUE on success, or FALSE otherwise. */ - public function setReadPreference ($read_preference, array $tags) {} + public function setReadPreference($read_preference, array $tags) {} /** * (PECL mongo >= 1.5.0)@@ -867,27 +861,27 @@ class MongoCollection { public $wtimeout; /** - * Creates a new collection - * @link https://secure.php.net/manual/en/mongocollection.construct.php - * @param MongoDB $db Parent database. - * @param string $name Name for this collection. - * @throws Exception - */ + * Creates a new collection + * @link https://secure.php.net/manual/en/mongocollection.construct.php + * @param MongoDB $db Parent database. + * @param string $name Name for this collection. + * @throws Exception + */ public function __construct(MongoDB $db, $name) {} - /** - * String representation of this collection - * @link https://secure.php.net/manual/en/mongocollection.--tostring.php - * @return string Returns the full name of this collection. - */ + /** + * String representation of this collection + * @link https://secure.php.net/manual/en/mongocollection.--tostring.php + * @return string Returns the full name of this collection. + */ public function __toString() {} - /** - * Gets a collection - * @link https://secure.php.net/manual/en/mongocollection.get.php - * @param string $name The next string in the collection name. - * @return MongoCollection - */ + /** + * Gets a collection + * @link https://secure.php.net/manual/en/mongocollection.get.php + * @param string $name The next string in the collection name. + * @return MongoCollection + */ public function __get($name) {} /** @@ -910,7 +904,7 @@ public function __get($name) {} * @param array $pipelineOperators [optional]
Additional pipeline operators.
* @return array The result of the aggregation as an array. The ok will be set to 1 on success, 0 on failure. */ - public function aggregate ( array $pipeline, array $op, array $pipelineOperators ) {} + public function aggregate(array $pipeline, array $op, array $pipelineOperators) {} /** * (PECL mongo >= 1.5.0)An array of zero or more tag sets, where each tag set is itself an array of criteria used to match tags on replica set members.
* @return bool Returns TRUE on success, or FALSE otherwise. */ - public function setReadPreference($read_preference, array $tags) { } + public function setReadPreference($read_preference, array $tags) {} - /** - * Drops this collection - * @link https://secure.php.net/manual/en/mongocollection.drop.php - * @return array Returns the database response. - */ + /** + * Drops this collection + * @link https://secure.php.net/manual/en/mongocollection.drop.php + * @return array Returns the database response. + */ public function drop() {} /** - * Validates this collection - * @link https://secure.php.net/manual/en/mongocollection.validate.php - * @param bool $scan_data Only validate indices, not the base collection. - * @return array Returns the database's evaluation of this object. - */ + * Validates this collection + * @link https://secure.php.net/manual/en/mongocollection.validate.php + * @param bool $scan_data Only validate indices, not the base collection. + * @return array Returns the database's evaluation of this object. + */ public function validate($scan_data = false) {} /** - * Inserts an array into the collection - * @link https://secure.php.net/manual/en/mongocollection.insert.php - * @param array|object $a An array or object. If an object is used, it may not have protected or private properties. + * Inserts an array into the collection + * @link https://secure.php.net/manual/en/mongocollection.insert.php + * @param array|object $a An array or object. If an object is used, it may not have protected or private properties. * Note: If the parameter does not have an _id key or property, a new MongoId instance will be created and assigned to it. * This special behavior does not mean that the parameter is passed by reference. - * @param array $options Options for the insert. + * @param array $options Options for the insert. *
Query criteria for the documents to delete.
+ * Remove records from this collection + * @link https://secure.php.net/manual/en/mongocollection.remove.php + * @param array $criteria [optional]Query criteria for the documents to delete.
* @param array $options [optional]An array of options for the remove operation. Currently available options * include: *
"fsync"
Boolean, defaults to FALSE. If journaling is enabled, it works exactly like "j". If journaling is not enabled, the write operation blocks until it is synced to database files on disk. If TRUE, an acknowledged insert is implied and this option will override setting "w" to 0.
Note: If journaling is enabled, users are strongly encouraged to use the "j" option instead of "fsync". Do not use "fsync" and "j" simultaneously, as that will result in an error.
"j"
Boolean, defaults to FALSE. Forces the write operation to block until it is synced to the journal on disk. If TRUE, an acknowledged write is implied and this option will override setting "w" to 0.
Note: If this option is used and journaling is disabled, MongoDB 2.6+ will raise an error and the write will fail; older server versions will simply ignore the option.
"socketTimeoutMS"
This option specifies the time limit, in milliseconds, for socket communication. If the server does not respond within the timeout period, a MongoCursorTimeoutException will be thrown and there will be no way to determine if the server actually handled the write or not. A value of -1 may be specified to block indefinitely. The default value for MongoClient is 30000 (30 seconds).
"w"
See {@link https://secure.php.net/manual/en/mongo.writeconcerns.php Write Concerns }. The default value for MongoClient is 1.
"w"
See {@link https://secure.php.net/manual/en/mongo.writeconcerns.php Write Concerns}. The default value for MongoClient is 1.
"wTimeoutMS"
This option specifies the time limit, in milliseconds, for {@link https://secure.php.net/manual/en/mongo.writeconcerns.php write concern} acknowledgement. It is only applicable when "w" is greater than 1, as the timeout pertains to replication. If the write concern is not satisfied within the time limit, a MongoCursorException will be thrown. A value of 0 may be specified to block indefinitely. The default value for {@link https://secure.php.net/manual/en/class.mongoclient.php MongoClient} is 10000 (ten seconds).
"safe"
Deprecated. Please use the {@link https://secure.php.net/manual/en/mongo.writeconcerns.php write concern} "w" option.
"timeout"
Deprecated alias for "socketTimeoutMS".
"wtimeout"
Deprecated alias for "wTimeoutMS".
Returns an array containing the status of the removal if the + * @return bool|array
Returns an array containing the status of the removal if the * "w" option is set. Otherwise, returns TRUE. *
** Fields in the status array are described in the documentation for * MongoCollection::insert(). *
- */ - public function remove(array $criteria = array(), array $options = array()) {} + */ + public function remove(array $criteria = [], array $options = []) {} /** - * Querys this collection - * @link https://secure.php.net/manual/en/mongocollection.find.php - * @param array $query The fields for which to search. - * @param array $fields Fields of the results to return. - * @return MongoCursor - */ - public function find(array $query = array(), array $fields = array()) {} + * Querys this collection + * @link https://secure.php.net/manual/en/mongocollection.find.php + * @param array $query The fields for which to search. + * @param array $fields Fields of the results to return. + * @return MongoCursor + */ + public function find(array $query = [], array $fields = []) {} /** * Retrieve a list of distinct values for the given key across a collection @@ -1147,7 +1141,7 @@ public function find(array $query = array(), array $fields = array()) {} * @param array $query An optional query parameters * @return array|false Returns an array of distinct values, or FALSE on failure */ - public function distinct ($key, array $query = null) {} + public function distinct($key, array $query = null) {} /** * Update a document and return it @@ -1158,17 +1152,17 @@ public function distinct ($key, array $query = null) {} * @param array $options An array of options to apply, such as remove the match document from the DB and return it. * @return array Returns the original document, or the modified document when new is set. */ - public function findAndModify (array $query, array $update = null, array $fields = null, array $options = null) {} + public function findAndModify(array $query, array $update = null, array $fields = null, array $options = null) {} /** - * Querys this collection, returning a single element - * @link https://secure.php.net/manual/en/mongocollection.findone.php - * @param array $query The fields for which to search. - * @param array $fields Fields of the results to return. - * @param array $options This parameter is an associative array of the form array("name" => `If the cursor should wait for more data to become available.
* @return MongoCursor Returns this cursor. */ - public function awaitData ($wait = true) {} + public function awaitData($wait = true) {} /** - * Checks if there are any more elements in this cursor - * @link https://secure.php.net/manual/en/mongocursor.hasnext.php - * @throws MongoConnectionException - * @throws MongoCursorTimeoutException + * Checks if there are any more elements in this cursor + * @link https://secure.php.net/manual/en/mongocursor.hasnext.php + * @throws MongoConnectionException + * @throws MongoCursorTimeoutException * @return bool Returns true if there is another element - */ + */ public function hasNext() {} /** - * Return the next object to which this cursor points, and advance the cursor - * @link https://secure.php.net/manual/en/mongocursor.getnext.php - * @throws MongoConnectionException - * @throws MongoCursorTimeoutException + * Return the next object to which this cursor points, and advance the cursor + * @link https://secure.php.net/manual/en/mongocursor.getnext.php + * @throws MongoConnectionException + * @throws MongoCursorTimeoutException * @return array Returns the next object - */ + */ public function getNext() {} /** @@ -1342,15 +1337,15 @@ public function getNext() {} * @return array This function returns an array describing the read preference. The array contains the values type for the string * read preference mode (corresponding to the {@link https://secure.php.net/manual/en/class.mongoclient.php MongoClient} constants), and tagsets containing a list of all tag set criteria. If no tag sets were specified, tagsets will not be present in the array. */ - public function getReadPreference () { } + public function getReadPreference() {} /** - * Limits the number of results returned - * @link https://secure.php.net/manual/en/mongocursor.limit.php - * @param int $num The number of results to return. - * @throws MongoCursorException + * Limits the number of results returned + * @link https://secure.php.net/manual/en/mongocursor.limit.php + * @param int $num The number of results to return. + * @throws MongoCursorException * @return MongoCursor Returns this cursor - */ + */ public function limit($num) {} /** @@ -1359,7 +1354,7 @@ public function limit($num) {} * @param bool $okay [optional]If receiving partial results is okay.
* @return MongoCursor Returns this cursor. */ - public function partial ($okay = true) {} + public function partial($okay = true) {} /** * (PECL mongo >= 1.2.1)Whether the flag should be set (TRUE) or unset (FALSE).
* @return MongoCursor */ - public function setFlag ($flag, $set = true ) {} + public function setFlag($flag, $set = true) {} /** * (PECL mongo >= 1.3.3)The read preference mode: MongoClient::RP_PRIMARY, MongoClient::RP_PRIMARY_PREFERRED, MongoClient::RP_SECONDARY, MongoClient::RP_SECONDARY_PREFERRED, or MongoClient::RP_NEAREST.
* @return MongoCursor Returns this cursor. */ - public function setReadPreference ($read_preference, array $tags) {} + public function setReadPreference($read_preference, array $tags) {} /** - * Skips a number of results - * @link https://secure.php.net/manual/en/mongocursor.skip.php - * @param int $num The number of results to skip. - * @throws MongoCursorException + * Skips a number of results + * @link https://secure.php.net/manual/en/mongocursor.skip.php + * @param int $num The number of results to skip. + * @throws MongoCursorException * @return MongoCursor Returns this cursor - */ + */ public function skip($num) {} /** - * Sets whether this query can be done on a slave - * This method will override the static class variable slaveOkay. - * @link https://secure.php.net/manual/en/mongocursor.slaveOkay.php - * @param bool $okay If it is okay to query the slave. - * @throws MongoCursorException + * Sets whether this query can be done on a slave + * This method will override the static class variable slaveOkay. + * @link https://secure.php.net/manual/en/mongocursor.slaveOkay.php + * @param bool $okay If it is okay to query the slave. + * @throws MongoCursorException * @return MongoCursor Returns this cursor - */ + */ public function slaveOkay($okay = true) {} /** - * Sets whether this cursor will be left open after fetching the last results - * @link https://secure.php.net/manual/en/mongocursor.tailable.php - * @param bool $tail If the cursor should be tailable. + * Sets whether this cursor will be left open after fetching the last results + * @link https://secure.php.net/manual/en/mongocursor.tailable.php + * @param bool $tail If the cursor should be tailable. * @return MongoCursor Returns this cursor - */ + */ public function tailable($tail = true) {} /** - * Sets whether this cursor will timeout - * @link https://secure.php.net/manual/en/mongocursor.immortal.php - * @param bool $liveForever If the cursor should be immortal. - * @throws MongoCursorException + * Sets whether this cursor will timeout + * @link https://secure.php.net/manual/en/mongocursor.immortal.php + * @param bool $liveForever If the cursor should be immortal. + * @throws MongoCursorException * @return MongoCursor Returns this cursor - */ + */ public function immortal($liveForever = true) {} /** - * Sets a client-side timeout for this query - * @link https://secure.php.net/manual/en/mongocursor.timeout.php - * @param int $ms The number of milliseconds for the cursor to wait for a response. By default, the cursor will wait forever. - * @throws MongoCursorTimeoutException + * Sets a client-side timeout for this query + * @link https://secure.php.net/manual/en/mongocursor.timeout.php + * @param int $ms The number of milliseconds for the cursor to wait for a response. By default, the cursor will wait forever. + * @throws MongoCursorTimeoutException * @return MongoCursor Returns this cursor - */ + */ public function timeout($ms) {} - /** - * Checks if there are documents that have not been sent yet from the database for this cursor - * @link https://secure.php.net/manual/en/mongocursor.dead.php - * @return bool Returns if there are more results that have not been sent to the client, yet. - */ + /** + * Checks if there are documents that have not been sent yet from the database for this cursor + * @link https://secure.php.net/manual/en/mongocursor.dead.php + * @return bool Returns if there are more results that have not been sent to the client, yet. + */ public function dead() {} - /** - * Use snapshot mode for the query - * @link https://secure.php.net/manual/en/mongocursor.snapshot.php - * @throws MongoCursorException - * @return MongoCursor Returns this cursor - */ + /** + * Use snapshot mode for the query + * @link https://secure.php.net/manual/en/mongocursor.snapshot.php + * @throws MongoCursorException + * @return MongoCursor Returns this cursor + */ public function snapshot() {} /** - * Sorts the results by given fields - * @link https://secure.php.net/manual/en/mongocursor.sort.php + * Sorts the results by given fields + * @link https://secure.php.net/manual/en/mongocursor.sort.php * @param array $fields An array of fields by which to sort. Each element in the array has as key the field name, and as value either 1 for ascending sort, or -1 for descending sort - * @throws MongoCursorException + * @throws MongoCursorException * @return MongoCursor Returns the same cursor that this method was called on - */ + */ public function sort(array $fields) {} - /** - * Gives the database a hint about the query - * @link https://secure.php.net/manual/en/mongocursor.hint.php - * @param mixed $key_pattern Indexes to use for the query. - * @throws MongoCursorException - * @return MongoCursor Returns this cursor - */ + /** + * Gives the database a hint about the query + * @link https://secure.php.net/manual/en/mongocursor.hint.php + * @param mixed $key_pattern Indexes to use for the query. + * @throws MongoCursorException + * @return MongoCursor Returns this cursor + */ public function hint($key_pattern) {} - - /** - * Adds a top-level key/value pair to a query - * @link https://secure.php.net/manual/en/mongocursor.addoption.php - * @param string $key Fieldname to add. - * @param mixed $value Value to add. - * @throws MongoCursorException + /** + * Adds a top-level key/value pair to a query + * @link https://secure.php.net/manual/en/mongocursor.addoption.php + * @param string $key Fieldname to add. + * @param mixed $value Value to add. + * @throws MongoCursorException * @return MongoCursor Returns this cursor - */ + */ public function addOption($key, $value) {} - /** - * Execute the query - * @link https://secure.php.net/manual/en/mongocursor.doquery.php - * @throws MongoConnectionException if it cannot reach the database. - * @return void - */ + /** + * Execute the query + * @link https://secure.php.net/manual/en/mongocursor.doquery.php + * @throws MongoConnectionException if it cannot reach the database. + * @return void + */ protected function doQuery() {} - /** - * Returns the current element - * @link https://secure.php.net/manual/en/mongocursor.current.php - * @return array - */ + /** + * Returns the current element + * @link https://secure.php.net/manual/en/mongocursor.current.php + * @return array + */ public function current() {} - /** - * Returns the current result's _id - * @link https://secure.php.net/manual/en/mongocursor.key.php - * @return string The current result's _id as a string. - */ + /** + * Returns the current result's _id + * @link https://secure.php.net/manual/en/mongocursor.key.php + * @return string The current result's _id as a string. + */ public function key() {} /** - * Advances the cursor to the next result - * @link https://secure.php.net/manual/en/mongocursor.next.php - * @throws MongoConnectionException - * @throws MongoCursorTimeoutException - * @return void - */ + * Advances the cursor to the next result + * @link https://secure.php.net/manual/en/mongocursor.next.php + * @throws MongoConnectionException + * @throws MongoCursorTimeoutException + * @return void + */ public function next() {} - /** - * Returns the cursor to the beginning of the result set - * @throws MongoConnectionException - * @throws MongoCursorTimeoutException - * @return void - */ + /** + * Returns the cursor to the beginning of the result set + * @throws MongoConnectionException + * @throws MongoCursorTimeoutException + * @return void + */ public function rewind() {} /** - * Checks if the cursor is reading a valid result. - * @link https://secure.php.net/manual/en/mongocursor.valid.php - * @return bool If the current result is not null. - */ + * Checks if the cursor is reading a valid result. + * @link https://secure.php.net/manual/en/mongocursor.valid.php + * @return bool If the current result is not null. + */ public function valid() {} - /** - * Clears the cursor - * @link https://secure.php.net/manual/en/mongocursor.reset.php - * @return void - */ + /** + * Clears the cursor + * @link https://secure.php.net/manual/en/mongocursor.reset.php + * @return void + */ public function reset() {} - /** - * Return an explanation of the query, often useful for optimization and debugging - * @link https://secure.php.net/manual/en/mongocursor.explain.php - * @return array Returns an explanation of the query. - */ + /** + * Return an explanation of the query, often useful for optimization and debugging + * @link https://secure.php.net/manual/en/mongocursor.explain.php + * @return array Returns an explanation of the query. + */ public function explain() {} /** - * Counts the number of results for this query - * @link https://secure.php.net/manual/en/mongocursor.count.php - * @param bool $all Send cursor limit and skip information to the count function, if applicable. - * @return int The number of documents returned by this cursor's query. - */ + * Counts the number of results for this query + * @link https://secure.php.net/manual/en/mongocursor.count.php + * @param bool $all Send cursor limit and skip information to the count function, if applicable. + * @return int The number of documents returned by this cursor's query. + */ public function count($all = false) {} - /** - * Sets the fields for a query - * @link https://secure.php.net/manual/en/mongocursor.fields.php - * @param array $f Fields to return (or not return). - * @throws MongoCursorException - * @return MongoCursor - */ - public function fields(array $f){} + /** + * Sets the fields for a query + * @link https://secure.php.net/manual/en/mongocursor.fields.php + * @param array $f Fields to return (or not return). + * @throws MongoCursorException + * @return MongoCursor + */ + public function fields(array $f) {} - /** - * Gets the query, fields, limit, and skip for this cursor - * @link https://secure.php.net/manual/en/mongocursor.info.php - * @return array The query, fields, limit, and skip for this cursor as an associative array. - */ - public function info(){} + /** + * Gets the query, fields, limit, and skip for this cursor + * @link https://secure.php.net/manual/en/mongocursor.info.php + * @return array The query, fields, limit, and skip for this cursor as an associative array. + */ + public function info() {} /** * PECL mongo >= 1.0.11 @@ -1593,29 +1587,30 @@ public function info(){} * @return MongoCursor Returns this cursor. * @link https://secure.php.net/manual/en/mongocursor.batchsize.php */ - public function batchSize($batchSize){} - - /** - * (PECL mongo >= 1.5.0) - * Sets a server-side timeout for this query - * @link https://php.net/manual/en/mongocursor.maxtimems.php - * @param int $ms- * Specifies a cumulative time limit in milliseconds to be allowed by the - * server for processing operations on the cursor. - *
- * @return MongoCursor This cursor. - */ - public function maxTimeMS ($ms) {} + public function batchSize($batchSize) {} + + /** + * (PECL mongo >= 1.5.0) + * Sets a server-side timeout for this query + * @link https://php.net/manual/en/mongocursor.maxtimems.php + * @param int $ms+ * Specifies a cumulative time limit in milliseconds to be allowed by the + * server for processing operations on the cursor. + *
+ * @return MongoCursor This cursor. + */ + public function maxTimeMS($ms) {} } -class MongoCommandCursor implements MongoCursorInterface { +class MongoCommandCursor implements MongoCursorInterface +{ /** * Return the current element * @link https://php.net/manual/en/iterator.current.php * @return mixed Can return any type. * @since 5.0.0 */ - public function current(){} + public function current() {} /** * Move forward to next element @@ -1623,7 +1618,7 @@ public function current(){} * @return void Any returned value is ignored. * @since 5.0.0 */ - public function next(){} + public function next() {} /** * Return the key of the current element @@ -1631,7 +1626,7 @@ public function next(){} * @return mixed scalar on success, or null on failure. * @since 5.0.0 */ - public function key(){} + public function key() {} /** * Checks if current position is valid @@ -1640,7 +1635,7 @@ public function key(){} * Returns true on success or false on failure. * @since 5.0.0 */ - public function valid(){} + public function valid() {} /** * Rewind the Iterator to the first element @@ -1648,42 +1643,40 @@ public function valid(){} * @return void Any returned value is ignored. * @since 5.0.0 */ - public function rewind(){} + public function rewind() {} - function batchSize(int $batchSize):MongoCursorInterface{} + public function batchSize(int $batchSize): MongoCursorInterface {} - function dead():bool{} + public function dead(): bool {} - function info():array{} + public function info(): array {} - function getReadPreference():array{} + public function getReadPreference(): array {} - function setReadPreference(string $read_preference, array $tags = null):MongoCursorInterface{} + public function setReadPreference(string $read_preference, array $tags = null): MongoCursorInterface {} - function timeout(int $ms):MongoCursorInterface{} + public function timeout(int $ms): MongoCursorInterface {} } interface MongoCursorInterface extends Iterator { - function batchSize(int $batchSize):MongoCursorInterface; + public function batchSize(int $batchSize): MongoCursorInterface; - function dead():bool; + public function dead(): bool; - function info():array; + public function info(): array; - function getReadPreference():array; + public function getReadPreference(): array; - function setReadPreference(string $read_preference, array $tags = null):MongoCursorInterface; + public function setReadPreference(string $read_preference, array $tags = null): MongoCursorInterface; - function timeout(int $ms):MongoCursorInterface; + public function timeout(int $ms): MongoCursorInterface; } -/** - * - */ -class MongoGridFS extends MongoCollection { - const ASCENDING = 1; - const DESCENDING = -1; +class MongoGridFS extends MongoCollection +{ + public const ASCENDING = 1; + public const DESCENDING = -1; /** * @link https://php.net/manual/en/class.mongogridfs.php#mongogridfs.props.chunks @@ -1703,8 +1696,6 @@ class MongoGridFS extends MongoCollection { */ protected $chunksName; - - /** * Files as stored across two collections, the first containing file meta * information, the second containing chunks of the actual file. By default, @@ -1730,7 +1721,7 @@ public function drop() {} * @param array $fields Fields to return * @return MongoGridFSCursor A MongoGridFSCursor */ - public function find(array $query = array(), array $fields = array()) {} + public function find(array $query = [], array $fields = []) {} /** * Stores a file in the database @@ -1740,7 +1731,7 @@ public function find(array $query = array(), array $fields = array()) {} * @param array $options Options for the store. "safe": Check that this store succeeded * @return mixed Returns the _id of the saved object */ - public function storeFile($filename, $extra = array(), $options = array()) {} + public function storeFile($filename, $extra = [], $options = []) {} /** * Chunkifies and stores bytes in the database @@ -1750,26 +1741,26 @@ public function storeFile($filename, $extra = array(), $options = array()) {} * @param array $options Options for the store. "safe": Check that this store succeeded * @return mixed The _id of the object saved */ - public function storeBytes($bytes, $extra = array(), $options = array()) {} + public function storeBytes($bytes, $extra = [], $options = []) {} /** - * Returns a single file matching the criteria - * @link https://secure.php.net/manual/en/mongogridfs.findone.php - * @param array $query The fields for which to search. - * @param array $fields Fields of the results to return. - * @return MongoGridFSFile|null - */ - public function findOne(array $query = array(), array $fields = array()) {} + * Returns a single file matching the criteria + * @link https://secure.php.net/manual/en/mongogridfs.findone.php + * @param array $query The fields for which to search. + * @param array $fields Fields of the results to return. + * @return MongoGridFSFile|null + */ + public function findOne(array $query = [], array $fields = []) {} /** - * Removes files from the collections - * @link https://secure.php.net/manual/en/mongogridfs.remove.php - * @param array $criteria Description of records to remove. - * @param array $options Options for remove. Valid options are: "safe"- Check that the remove succeeded. - * @throws MongoCursorException - * @return bool - */ - public function remove(array $criteria = array(), array $options = array()) {} + * Removes files from the collections + * @link https://secure.php.net/manual/en/mongogridfs.remove.php + * @param array $criteria Description of records to remove. + * @param array $options Options for remove. Valid options are: "safe"- Check that the remove succeeded. + * @throws MongoCursorException + * @return bool + */ + public function remove(array $criteria = [], array $options = []) {} /** * Delete a file from the database @@ -1780,45 +1771,44 @@ public function remove(array $criteria = array(), array $options = array()) {} public function delete($id) {} /** - * Saves an uploaded file directly from a POST to the database - * @link https://secure.php.net/manual/en/mongogridfs.storeupload.php - * @param string $name The name attribute of the uploaded file, from<input type="file" name="something"/>
- * @param array $metadata An array of extra fields for the uploaded file.
- * @return mixed Returns the _id of the uploaded file.
- */
- public function storeUpload($name, array $metadata = array()) {}
-
+ * Saves an uploaded file directly from a POST to the database
+ * @link https://secure.php.net/manual/en/mongogridfs.storeupload.php
+ * @param string $name The name attribute of the uploaded file, from <input type="file" name="something"/>
+ * @param array $metadata An array of extra fields for the uploaded file.
+ * @return mixed Returns the _id of the uploaded file.
+ */
+ public function storeUpload($name, array $metadata = []) {}
/**
- * Retrieve a file from the database
- * @link https://secure.php.net/manual/en/mongogridfs.get.php
- * @param mixed $id _id of the file to find.
- * @return MongoGridFSFile|null Returns the file, if found, or NULL.
- */
+ * Retrieve a file from the database
+ * @link https://secure.php.net/manual/en/mongogridfs.get.php
+ * @param mixed $id _id of the file to find.
+ * @return MongoGridFSFile|null Returns the file, if found, or NULL.
+ */
public function get($id) {}
- /**
+ /**
* Stores a file in the database
* @link https://php.net/manual/en/mongogridfs.put.php
* @param string $filename The name of the file
* @param array $extra Other metadata to add to the file saved
* @return mixed Returns the _id of the saved object
*/
- public function put($filename, array $extra = array()) {}
-
+ public function put($filename, array $extra = []) {}
}
-class MongoGridFSFile {
+class MongoGridFSFile
+{
/**
- * @link https://php.net/manual/en/class.mongogridfsfile.php#mongogridfsfile.props.file
- * @var array|null
- */
+ * @link https://php.net/manual/en/class.mongogridfsfile.php#mongogridfsfile.props.file
+ * @var array|null
+ */
public $file;
/**
- * @link https://php.net/manual/en/class.mongogridfsfile.php#mongogridfsfile.props.gridfs
- * @var MongoGridFS|null
- */
+ * @link https://php.net/manual/en/class.mongogridfsfile.php#mongogridfsfile.props.gridfs
+ * @var MongoGridFS|null
+ */
protected $gridfs;
/**
@@ -1832,14 +1822,14 @@ public function __construct($gridfs, array $file) {}
* Returns this file's filename
* @link https://php.net/manual/en/mongogridfsfile.getfilename.php
* @return string Returns the filename
- */
+ */
public function getFilename() {}
/**
* Returns this file's size
* @link https://php.net/manual/en/mongogridfsfile.getsize.php
* @return int Returns this file's size
- */
+ */
public function getSize() {}
/**
@@ -1857,7 +1847,7 @@ public function write($filename = null) {}
*/
public function getBytes() {}
- /**
+ /**
* This method returns a stream resource that can be used to read the stored file with all file functions in PHP.
* The contents of the file are pulled out of MongoDB on the fly, so that the whole file does not have to be loaded into memory first.
* At most two GridFSFile chunks will be loaded in memory.
@@ -1868,16 +1858,17 @@ public function getBytes() {}
public function getResource() {}
}
-class MongoGridFSCursor extends MongoCursor implements Traversable, Iterator {
+class MongoGridFSCursor extends MongoCursor implements Traversable, Iterator
+{
/**
- * @var bool
- */
+ * @var bool
+ */
public static $slaveOkay;
/**
- * @link https://php.net/manual/en/class.mongogridfscursor.php#mongogridfscursor.props.gridfs
- * @var MongoGridFS|null
- */
+ * @link https://php.net/manual/en/class.mongogridfscursor.php#mongogridfscursor.props.gridfs
+ * @var MongoGridFS|null
+ */
protected $gridfs;
/**
@@ -1892,44 +1883,44 @@ class MongoGridFSCursor extends MongoCursor implements Traversable, Iterator {
public function __construct($gridfs, $connection, $ns, $query, $fields) {}
/**
- * Return the next file to which this cursor points, and advance the cursor
- * @link https://php.net/manual/en/mongogridfscursor.getnext.php
- * @return MongoGridFSFile Returns the next file
- */
+ * Return the next file to which this cursor points, and advance the cursor
+ * @link https://php.net/manual/en/mongogridfscursor.getnext.php
+ * @return MongoGridFSFile Returns the next file
+ */
public function getNext() {}
/**
- * Returns the current file
- * @link https://php.net/manual/en/mongogridfscursor.current.php
- * @return MongoGridFSFile The current file
- */
+ * Returns the current file
+ * @link https://php.net/manual/en/mongogridfscursor.current.php
+ * @return MongoGridFSFile The current file
+ */
public function current() {}
/**
- * Returns the current result's filename
- * @link https://php.net/manual/en/mongogridfscursor.key.php
- * @return string The current results filename
- */
+ * Returns the current result's filename
+ * @link https://php.net/manual/en/mongogridfscursor.key.php
+ * @return string The current results filename
+ */
public function key() {}
-
}
/**
* A unique identifier created for database objects.
* @link https://secure.php.net/manual/en/class.mongoid.php
*/
-class MongoId {
- /**
- * @var string $id Note: The property name begins with a $ character. It may be accessed using - * {@link https://php.net/manual/en/language.types.string.php#language.types.string.parsing.complex complex variable parsed syntax} (e.g. $mongoId->{'$id'}).
- */ +class MongoId +{ + /** + * @var stringNote: The property name begins with a $ character. It may be accessed using + * {@link https://php.net/manual/en/language.types.string.php#language.types.string.parsing.complex complex variable parsed syntax} (e.g. $mongoId->{'$id'}).
+ */ public $id = null; /** * (PECL mongo >= 0.8.0) - * Creates a new id - * @link https://secure.php.net/manual/en/mongoid.construct.php - * @param MongoId|string $id [optional] A string to use as the id. Must be 24 hexadecimal characters. If an invalid string is passed to this constructor, the constructor will ignore it and create a new id value. + * Creates a new id + * @link https://secure.php.net/manual/en/mongoid.construct.php + * @param MongoId|string $id [optional] A string to use as the id. Must be 24 hexadecimal characters. If an invalid string is passed to this constructor, the constructor will ignore it and create a new id value. */ public function __construct($id = null) {} @@ -1945,12 +1936,12 @@ public function __construct($id = null) {} * */ public static function isValid($value) {} - /** - * (PECL mongo >= 0.8.0) - * Returns a hexadecimal representation of this id - * @link https://secure.php.net/manual/en/mongoid.tostring.php - * @return string This id. - */ + /** + * (PECL mongo >= 0.8.0) + * Returns a hexadecimal representation of this id + * @link https://secure.php.net/manual/en/mongoid.tostring.php + * @return string This id. + */ public function __toString() {} /** @@ -1969,12 +1960,12 @@ public function getInc() {} */ public function getPID() {} - /** - * (PECL mongo >= 1.0.1) - * Gets the number of seconds since the epoch that this id was created - * @link https://secure.php.net/manual/en/mongoid.gettimestamp.php - * @return int - */ + /** + * (PECL mongo >= 1.0.1) + * Gets the number of seconds since the epoch that this id was created + * @link https://secure.php.net/manual/en/mongoid.gettimestamp.php + * @return int + */ public function getTimestamp() {} /** @@ -1995,15 +1986,16 @@ public static function getHostname() {} public static function __set_state(array $props) {} } -class MongoCode { +class MongoCode +{ /** - * @var string - */ + * @var string + */ public $code; /** - * @var array - */ + * @var array + */ public $scope; /** @@ -2013,16 +2005,17 @@ class MongoCode { * @param string $code A string of code * @param array $scope The scope to use for the code */ - public function __construct($code, array $scope = array()) {} + public function __construct($code, array $scope = []) {} /** - * Returns this code as a string - * @return string - */ + * Returns this code as a string + * @return string + */ public function __toString() {} } -class MongoRegex { +class MongoRegex +{ /** * @link https://php.net/manual/en/class.mongoregex.php#mongoregex.props.regex * @var string @@ -2044,22 +2037,23 @@ class MongoRegex { public function __construct($regex) {} /** - * Returns a string representation of this regular expression. - * @return string This regular expression in the form "/expr/flags". - */ + * Returns a string representation of this regular expression. + * @return string This regular expression in the form "/expr/flags". + */ public function __toString() {} } -class MongoDate { +class MongoDate +{ /** * @link https://php.net/manual/en/class.mongodate.php#mongodate.props.sec - * @var int $sec + * @var int */ public $sec; /** * @link https://php.net/manual/en/class.mongodate.php#mongodate.props.usec - * @var int $usec + * @var int */ public $usec; @@ -2080,56 +2074,55 @@ public function __construct($sec = 0, $usec = 0) {} public function toDateTime() {} /** - * Returns a string representation of this date - * @return string - */ + * Returns a string representation of this date + * @return string + */ public function __toString() {} } -class MongoBinData { - /** - * Generic binary data. - * @link https://php.net/manual/en/class.mongobindata.php#mongobindata.constants.custom - */ - const GENERIC = 0x0; +class MongoBinData +{ + /** + * Generic binary data. + * @link https://php.net/manual/en/class.mongobindata.php#mongobindata.constants.custom + */ + public const GENERIC = 0x0; - /** - * Function + /** + * Function * @link https://php.net/manual/en/class.mongobindata.php#mongobindata.constants.func */ - const FUNC = 0x1; + public const FUNC = 0x1; - /** - * Generic binary data (deprecated in favor of MongoBinData::GENERIC) + /** + * Generic binary data (deprecated in favor of MongoBinData::GENERIC) * @link https://php.net/manual/en/class.mongobindata.php#mongobindata.constants.byte-array */ - const BYTE_ARRAY = 0x2; + public const BYTE_ARRAY = 0x2; - /** - * Universally unique identifier (deprecated in favor of MongoBinData::UUID_RFC4122) + /** + * Universally unique identifier (deprecated in favor of MongoBinData::UUID_RFC4122) * @link https://php.net/manual/en/class.mongobindata.php#mongobindata.constants.uuid */ - const UUID = 0x3; - - /** - * Universally unique identifier (according to » RFC 4122) - * @link https://php.net/manual/en/class.mongobindata.php#mongobindata.constants.custom - */ - const UUID_RFC4122 = 0x4; + public const UUID = 0x3; + /** + * Universally unique identifier (according to » RFC 4122) + * @link https://php.net/manual/en/class.mongobindata.php#mongobindata.constants.custom + */ + public const UUID_RFC4122 = 0x4; - /** - * MD5 + /** + * MD5 * @link https://php.net/manual/en/class.mongobindata.php#mongobindata.constants.md5 */ - const MD5 = 0x5; + public const MD5 = 0x5; - /** - * User-defined type + /** + * User-defined type * @link https://php.net/manual/en/class.mongobindata.php#mongobindata.constants.custom */ - const CUSTOM = 0x80; - + public const CUSTOM = 0x80; /** * @link https://php.net/manual/en/class.mongobindata.php#mongobindata.props.bin @@ -2143,7 +2136,6 @@ class MongoBinData { */ public $type; - /** * Creates a new binary data object. * @@ -2154,21 +2146,22 @@ class MongoBinData { public function __construct($data, $type = 2) {} /** - * Returns the string representation of this binary data object. - * @return string - */ + * Returns the string representation of this binary data object. + * @return string + */ public function __toString() {} } -class MongoDBRef { +class MongoDBRef +{ /** - * @var string - */ + * @var string + */ protected static $refKey = '$ref'; /** - * @var string - */ + * @var string + */ protected static $idKey = '$id'; /** @@ -2204,158 +2197,137 @@ public static function get($db, $ref) {} class MongoWriteBatch { - - const COMMAND_INSERT = 1; - const COMMAND_UPDATE = 2; - const COMMAND_DELETE = 3; - - - /** - *(PECL mongo >= 1.5.0)
- * MongoWriteBatch constructor. - * @link https://php.net/manual/en/mongowritebatch.construct.php - * @param MongoCollection $collection The {@see MongoCollection} to execute the batch on. - * Its {@link https://php.net/manual/en/mongo.writeconcerns.php write concern} - * will be copied and used as the default write concern if none is given as$write_options or during
- * {@see MongoWriteBatch::execute()}.
- * @param string $batch_type [optional] - * One of: - *
An array of Write Options.
| key | value meaning |
|---|---|
| w (int|string) | {@link https://php.net/manual/en/mongo.writeconcerns.php Write concern} value |
| wtimeout (int) | {@link https://php.net/manual/en/mongo.writeconcerns.php Maximum time to wait for replication} |
| ordered | Determins if MongoDB must apply this batch in order (sequentally, one item at a time) or can rearrange it.
- * Defaults to TRUE |
| j (bool) | Wait for journaling on the primary. This value is discouraged, use WriteConcern instead |
| fsync (bool) | Wait for fsync on the primary. This value is discouraged, use WriteConcern instead |
(PECL mongo >= 1.5.0)
- * Adds a write operation to a batch - * @link https://php.net/manual/en/mongowritebatch.add.php - * @param array $item- * An array that describes a write operation. The structure of this value - * depends on the batch's operation type. - *
| Batch type | - *Argument expectation | - *
|---|---|
MongoWriteBatch::COMMAND_INSERT |
- * - * The document to add. - * | - *
MongoWriteBatch::COMMAND_UPDATE |
- *
- * Raw update operation. - *Required keys are "q" and "u", which correspond to the
- * Optional keys are "multi" and "upsert", which correspond to the
- * "multiple" and "upsert" options for {@see MongoCollection::update()}, respectively.
- * If unspecified, both options default to |
- *
MongoWriteBatch::COMMAND_DELETE |
- *
- * Raw delete operation. - *Required keys are: "q" and "limit", which correspond to the The "limit" option is an integer; however, MongoDB only supports 0 (i.e. remove all matching - * ocuments) and 1 (i.e. remove at most one matching document) at this time. - * |
- *
(PECL mongo >= 1.5.0)
- * Executes a batch of write operations - * @link https://php.net/manual/en/mongowritebatch.execute.php - * @param array $write_options See {@see MongoWriteBatch::__construct} - * @return array Returns an array containing statistical information for the full batch. - * If the batch had to be split into multiple batches, the return value will aggregate the values from individual batches and return only the totals. - * If the batch was empty, an array containing only the 'ok' field is returned (as TRUE) although nothing will be shipped over the wire (NOOP). - */ - final public function execute(array $write_options) - { - } + public const COMMAND_INSERT = 1; + public const COMMAND_UPDATE = 2; + public const COMMAND_DELETE = 3; + + /** + *(PECL mongo >= 1.5.0)
+ * MongoWriteBatch constructor. + * @link https://php.net/manual/en/mongowritebatch.construct.php + * @param MongoCollection $collection The {@see MongoCollection} to execute the batch on. + * Its {@link https://php.net/manual/en/mongo.writeconcerns.php write concern} + * will be copied and used as the default write concern if none is given as$write_options or during
+ * {@see MongoWriteBatch::execute()}.
+ * @param string $batch_type [optional] + * One of: + *
An array of Write Options.
| key | value meaning |
|---|---|
| w (int|string) | {@link https://php.net/manual/en/mongo.writeconcerns.php Write concern} value |
| wtimeout (int) | {@link https://php.net/manual/en/mongo.writeconcerns.php Maximum time to wait for replication} |
| ordered | Determins if MongoDB must apply this batch in order (sequentally, one item at a time) or can rearrange it.
+ * Defaults to TRUE |
| j (bool) | Wait for journaling on the primary. This value is discouraged, use WriteConcern instead |
| fsync (bool) | Wait for fsync on the primary. This value is discouraged, use WriteConcern instead |
(PECL mongo >= 1.5.0)
+ * Adds a write operation to a batch + * @link https://php.net/manual/en/mongowritebatch.add.php + * @param array $item+ * An array that describes a write operation. The structure of this value + * depends on the batch's operation type. + *
| Batch type | + *Argument expectation | + *
|---|---|
MongoWriteBatch::COMMAND_INSERT |
+ * + * The document to add. + * | + *
MongoWriteBatch::COMMAND_UPDATE |
+ *
+ * Raw update operation. + *Required keys are "q" and "u", which correspond to the
+ * Optional keys are "multi" and "upsert", which correspond to the
+ * "multiple" and "upsert" options for {@see MongoCollection::update()}, respectively.
+ * If unspecified, both options default to |
+ *
MongoWriteBatch::COMMAND_DELETE |
+ *
+ * Raw delete operation. + *Required keys are: "q" and "limit", which correspond to the The "limit" option is an integer; however, MongoDB only supports 0 (i.e. remove all matching + * ocuments) and 1 (i.e. remove at most one matching document) at this time. + * |
+ *
(PECL mongo >= 1.5.0)
+ * Executes a batch of write operations + * @link https://php.net/manual/en/mongowritebatch.execute.php + * @param array $write_options See {@see MongoWriteBatch::__construct} + * @return array Returns an array containing statistical information for the full batch. + * If the batch had to be split into multiple batches, the return value will aggregate the values from individual batches and return only the totals. + * If the batch was empty, an array containing only the 'ok' field is returned (as TRUE) although nothing will be shipped over the wire (NOOP). + */ + final public function execute(array $write_options) {} } class MongoUpdateBatch extends MongoWriteBatch { - - /** - *(PECL mongo >= 1.5.0)
- * MongoUpdateBatch constructor. - * @link https://php.net/manual/en/mongoupdatebatch.construct.php - * @param MongoCollection $collectionThe MongoCollection to execute the batch on. - * Its write concern will be copied and used as the default write concern - * if none is given as $write_options or during {@see MongoWriteBatch::execute()}.
- * @param array $write_optionsAn array of Write Options.
| key | value meaning |
|---|---|
| w (int|string) | {@link https://php.net/manual/en/mongo.writeconcerns.php Write concern} value |
| wtimeout (int) | {@link https://php.net/manual/en/mongo.writeconcerns.php Maximum time to wait for replication} |
| ordered | Determins if MongoDB must apply this batch in order (sequentally, one item at a time) or can rearrange it. Defaults to TRUE |
| j (bool) | Wait for journaling on the primary. This value is discouraged, use WriteConcern instead |
| fsync (bool) | Wait for fsync on the primary. This value is discouraged, use WriteConcern instead |
(PECL mongo >= 1.5.0)
+ * MongoUpdateBatch constructor. + * @link https://php.net/manual/en/mongoupdatebatch.construct.php + * @param MongoCollection $collectionThe MongoCollection to execute the batch on. + * Its write concern will be copied and used as the default write concern + * if none is given as $write_options or during {@see MongoWriteBatch::execute()}.
+ * @param array $write_optionsAn array of Write Options.
| key | value meaning |
|---|---|
| w (int|string) | {@link https://php.net/manual/en/mongo.writeconcerns.php Write concern} value |
| wtimeout (int) | {@link https://php.net/manual/en/mongo.writeconcerns.php Maximum time to wait for replication} |
| ordered | Determins if MongoDB must apply this batch in order (sequentally, one item at a time) or can rearrange it. Defaults to TRUE |
| j (bool) | Wait for journaling on the primary. This value is discouraged, use WriteConcern instead |
| fsync (bool) | Wait for fsync on the primary. This value is discouraged, use WriteConcern instead |
(PECL mongo >= 1.5.0)
* @link https://php.net/manual/en/class.mongowriteconcernexception.php#class.mongowriteconcernexception */ -class MongoWriteConcernException extends MongoCursorException { +class MongoWriteConcernException extends MongoCursorException +{ /** * Get the error document * @link https://php.net/manual/en/mongowriteconcernexception.getdocument.php @@ -2379,30 +2351,27 @@ class MongoProtocolException extends MongoException {} *(PECL mongo >= 1.5.0)
* @link https://php.net/manual/en/class.mongoduplicatekeyexception.php */ -class MongoDuplicateKeyException extends MongoWriteConcernException { - -} +class MongoDuplicateKeyException extends MongoWriteConcernException {} /** *(PECL mongo >= 1.3.0)
* @link https://php.net/manual/en/class.mongoresultexception.php#mongoresultexception.props.document - * */ -class MongoResultException extends MongoException { +class MongoResultException extends MongoException +{ /** *(PECL mongo >= 1.3.0)
* Retrieve the full result document * https://secure.php.net/manual/en/mongoresultexception.getdocument.php * @return arrayThe full result document as an array, including partial data if available and additional keys.
*/ - public function getDocument () {} + public function getDocument() {} public $document; - - } -class MongoTimestamp { +class MongoTimestamp +{ /** * @link https://php.net/manual/en/class.mongotimestamp.php#mongotimestamp.props.sec * @var int @@ -2415,7 +2384,7 @@ class MongoTimestamp { */ public $inc; - /** + /** * Creates a new timestamp. If no parameters are given, the current time is used * and the increment is automatically provided. The increment is set to 0 when the * module is loaded and is incremented every time this constructor is called @@ -2428,19 +2397,19 @@ class MongoTimestamp { public function __construct($sec = 0, $inc) {} /** - * @return string - */ + * @return string + */ public function __toString() {} } -class MongoInt32 { +class MongoInt32 +{ /** * @link https://php.net/manual/en/class.mongoint32.php#mongoint32.props.value * @var string */ public $value; - /** * Creates a new 32-bit number with the given value. * @@ -2450,19 +2419,19 @@ class MongoInt32 { public function __construct($value) {} /** - * @return string - */ + * @return string + */ public function __toString() {} } -class MongoInt64 { +class MongoInt64 +{ /** * @link https://php.net/manual/en/class.mongoint64.php#mongoint64.props.value * @var string */ public $value; - /** * Creates a new 64-bit number with the given value. * @@ -2472,63 +2441,64 @@ class MongoInt64 { public function __construct($value) {} /** - * @return string - */ + * @return string + */ public function __toString() {} } -class MongoLog { - /** +class MongoLog +{ + /** * @link https://php.net/manual/en/class.mongolog.php#mongolog.constants.none */ - const NONE = 0; + public const NONE = 0; - /** + /** * @link https://php.net/manual/en/class.mongolog.php#mongolog.constants.all */ - const ALL = 0; + public const ALL = 0; - /** + /** * @link https://php.net/manual/en/class.mongolog.php#mongolog.constants.warning */ - const WARNING = 0; + public const WARNING = 0; - /** + /** * @link https://php.net/manual/en/class.mongolog.php#mongolog.constants.info */ - const INFO = 0; + public const INFO = 0; - /** + /** * @link https://php.net/manual/en/class.mongolog.php#mongolog.constants.fine */ - const FINE = 0; + public const FINE = 0; - /** + /** * @link https://php.net/manual/en/class.mongolog.php#mongolog.constants.rs */ - const RS = 0; + public const RS = 0; - /** + /** * @link https://php.net/manual/en/class.mongolog.php#mongolog.constants.pool */ - const POOL = 0; + public const POOL = 0; - /** + /** * @link https://php.net/manual/en/class.mongolog.php#mongolog.constants.io */ - const IO = 0; + public const IO = 0; - /** + /** * @link https://php.net/manual/en/class.mongolog.php#mongolog.constants.server */ - const SERVER = 0; + public const SERVER = 0; - /** + /** * @link https://php.net/manual/en/class.mongolog.php#mongolog.constants.parse */ - const PARSE = 0; + public const PARSE = 0; - const CON = 2; + public const CON = 2; /** * (PECL mongo >= 1.3.0)
* @return mixed
*/
-function msgpack_unpack($str, $object = null)
-{
-}
+function msgpack_unpack($str, $object = null) {}
class MessagePack
{
- const OPT_PHPONLY = -1001;
+ public const OPT_PHPONLY = -1001;
/**
* @param $opt [optional]
*/
- public function __construct($opt)
- {
- }
+ public function __construct($opt) {}
- public function setOption($option, $value)
- {
- }
+ public function setOption($option, $value) {}
- public function pack($value)
- {
- }
+ public function pack($value) {}
/**
* @param $str
* @param $object [optional]
*/
- public function unpack($str, $object)
- {
- }
-
- public function unpacker()
- {
+ public function unpack($str, $object) {}
- }
+ public function unpacker() {}
}
class MessagePackUnpacker
@@ -78,40 +65,24 @@ class MessagePackUnpacker
/**
* @param $opt [optional]
*/
- public function __construct($opt)
- {
- }
+ public function __construct($opt) {}
- public function __destruct()
- {
- }
+ public function __destruct() {}
- public function setOption($option, $value)
- {
- }
+ public function setOption($option, $value) {}
- public function feed($str)
- {
- }
+ public function feed($str) {}
/**
* @param $str [optional]
* @param $offset [optional]
*/
- public function execute($str, &$offset)
- {
- }
+ public function execute($str, &$offset) {}
/**
* @param $object [optional]
*/
- public function data($object)
- {
-
- }
-
- public function reset()
- {
+ public function data($object) {}
- }
+ public function reset() {}
}
diff --git a/mssql/mssql.php b/mssql/mssql.php
index b407158b1..8d950c6d9 100644
--- a/mssql/mssql.php
+++ b/mssql/mssql.php
@@ -28,7 +28,7 @@
* @return resource|false a MS SQL link identifier on success, or false on error.
* @removed 7.0
*/
-function mssql_connect ($servername = null, $username = null, $password = null, $new_link = false) {}
+function mssql_connect($servername = null, $username = null, $password = null, $new_link = false) {}
/**
* (PHP 4, PHP 5, PECL odbtp >= 1.1.1)
@@ -57,7 +57,7 @@ function mssql_connect ($servername = null, $username = null, $password = null,
* false on error.
* @removed 7.0
*/
-function mssql_pconnect ($servername = null, $username = null, $password = null, $new_link = false) {}
+function mssql_pconnect($servername = null, $username = null, $password = null, $new_link = false) {}
/**
* (PHP 4, PHP 5, PECL odbtp >= 1.1.1)
@@ -74,7 +74,7 @@ function mssql_pconnect ($servername = null, $username = null, $password = null,
* @return bool true on success or false on failure.
* @removed 7.0
*/
-function mssql_close ($link_identifier = null) {}
+function mssql_close($link_identifier = null) {}
/**
* (PHP 4, PHP 5, PECL odbtp >= 1.1.1)
@@ -103,7 +103,7 @@ function mssql_close ($link_identifier = null) {}
* @return bool true on success or false on failure.
* @removed 7.0
*/
-function mssql_select_db ($database_name, $link_identifier = null) {}
+function mssql_select_db($database_name, $link_identifier = null) {}
/**
* (PHP 4, PHP 5, PECL odbtp >= 1.1.1)
@@ -129,7 +129,7 @@ function mssql_select_db ($database_name, $link_identifier = null) {}
* returned, or false on error.
* @removed 7.0
*/
-function mssql_query ($query, $link_identifier = null, $batch_size = 0) {}
+function mssql_query($query, $link_identifier = null, $batch_size = 0) {}
/**
* (PHP 4 >= 4.0.4, PHP 5, PECL odbtp >= 1.1.1)
@@ -142,7 +142,7 @@ function mssql_query ($query, $link_identifier = null, $batch_size = 0) {}
* @return int the batch number as an integer.
* @removed 7.0
*/
-function mssql_fetch_batch ($result) {}
+function mssql_fetch_batch($result) {}
/**
* (PHP 4 >= 4.0.4, PHP 5, PECL odbtp >= 1.1.1)
@@ -156,7 +156,7 @@ function mssql_fetch_batch ($result) {}
* @return int the number of records affected by last operation.
* @removed 7.0
*/
-function mssql_rows_affected ($link_identifier) {}
+function mssql_rows_affected($link_identifier) {}
/**
* (PHP 4, PHP 5, PECL odbtp >= 1.1.1)
@@ -169,7 +169,7 @@ function mssql_rows_affected ($link_identifier) {}
* @return bool true on success or false on failure.
* @removed 7.0
*/
-function mssql_free_result ($result) {}
+function mssql_free_result($result) {}
/**
* (PHP 4, PHP 5, PECL odbtp >= 1.1.1)
@@ -179,7 +179,7 @@ function mssql_free_result ($result) {}
* no error messages are returned from MSSQL.
* @removed 7.0
*/
-function mssql_get_last_message () {}
+function mssql_get_last_message() {}
/**
* (PHP 4, PHP 5, PECL odbtp >= 1.1.1)
@@ -192,7 +192,7 @@ function mssql_get_last_message () {}
* @return int the number of rows, as an integer.
* @removed 7.0
*/
-function mssql_num_rows ($result) {}
+function mssql_num_rows($result) {}
/**
* (PHP 4, PHP 5, PECL odbtp >= 1.1.1)
@@ -205,7 +205,7 @@ function mssql_num_rows ($result) {}
* @return int the number of fields, as an integer.
* @removed 7.0
*/
-function mssql_num_fields ($result) {}
+function mssql_num_fields($result) {}
/**
* (PHP 4, PHP 5, PECL odbtp >= 1.1.1)
@@ -223,7 +223,7 @@ function mssql_num_fields ($result) {}
* @return object an object containing field information.
* @removed 7.0
*/
-function mssql_fetch_field ($result, $field_offset = -1) {}
+function mssql_fetch_field($result, $field_offset = -1) {}
/**
* (PHP 4, PHP 5, PECL odbtp >= 1.1.1)
@@ -237,7 +237,7 @@ function mssql_fetch_field ($result, $field_offset = -1) {}
* are no more rows.
* @removed 7.0
*/
-function mssql_fetch_row ($result) {}
+function mssql_fetch_row($result) {}
/**
* (PHP 4, PHP 5, PECL odbtp >= 1.1.1)
@@ -257,7 +257,7 @@ function mssql_fetch_row ($result) {}
* are no more rows.
* @removed 7.0
*/
-function mssql_fetch_array ($result, $result_type = MSSQL_BOTH) {}
+function mssql_fetch_array($result, $result_type = MSSQL_BOTH) {}
/**
* (PHP 4 >= 4.2.0, PHP 5, PECL odbtp >= 1.1.1)
@@ -271,7 +271,7 @@ function mssql_fetch_array ($result, $result_type = MSSQL_BOTH) {}
* false if there are no more rows.
* @removed 7.0
*/
-function mssql_fetch_assoc ($result_id) {}
+function mssql_fetch_assoc($result_id) {}
/**
* (PHP 4, PHP 5, PECL odbtp >= 1.1.1)
@@ -285,7 +285,7 @@ function mssql_fetch_assoc ($result_id) {}
* false if there are no more rows.
* @removed 7.0
*/
-function mssql_fetch_object ($result) {}
+function mssql_fetch_object($result) {}
/**
* (PHP 4, PHP 5, PECL odbtp >= 1.1.1)
@@ -301,7 +301,7 @@ function mssql_fetch_object ($result) {}
* @return int|false The length of the specified field index on success or false on failure.
* @removed 7.0
*/
-function mssql_field_length ($result, $offset = null) {}
+function mssql_field_length($result, $offset = null) {}
/**
* (PHP 4, PHP 5, PECL odbtp >= 1.1.1)
@@ -317,7 +317,7 @@ function mssql_field_length ($result, $offset = null) {}
* @return string|false The name of the specified field index on success or false on failure.
* @removed 7.0
*/
-function mssql_field_name ($result, $offset = -1) {}
+function mssql_field_name($result, $offset = -1) {}
/**
* (PHP 4, PHP 5, PECL odbtp >= 1.1.1)
@@ -333,7 +333,7 @@ function mssql_field_name ($result, $offset = -1) {}
* @return string|false The type of the specified field index on success or false on failure.
* @removed 7.0
*/
-function mssql_field_type ($result, $offset = -1) {}
+function mssql_field_type($result, $offset = -1) {}
/**
* (PHP 4, PHP 5, PECL odbtp >= 1.1.1)
@@ -348,7 +348,7 @@ function mssql_field_type ($result, $offset = -1) {}
* @return bool true on success or false on failure.
* @removed 7.0
*/
-function mssql_data_seek ($result_identifier, $row_number) {}
+function mssql_data_seek($result_identifier, $row_number) {}
/**
* (PHP 4, PHP 5, PECL odbtp >= 1.1.1)
@@ -364,7 +364,7 @@ function mssql_data_seek ($result_identifier, $row_number) {}
* @return bool true on success or false on failure.
* @removed 7.0
*/
-function mssql_field_seek ($result, $field_offset) {}
+function mssql_field_seek($result, $field_offset) {}
/**
* (PHP 4, PHP 5, PECL odbtp >= 1.1.1)
@@ -392,7 +392,7 @@ function mssql_field_seek ($result, $field_offset) {}
* @return string the contents of the specified cell.
* @removed 7.0
*/
-function mssql_result ($result, $row, $field) {}
+function mssql_result($result, $row, $field) {}
/**
* (PHP 4 >= 4.0.5, PHP 5, PECL odbtp >= 1.1.1)
@@ -406,7 +406,7 @@ function mssql_result ($result, $row, $field) {}
* otherwise.
* @removed 7.0
*/
-function mssql_next_result ($result_id) {}
+function mssql_next_result($result_id) {}
/**
* (PHP 4, PHP 5, PECL odbtp >= 1.1.1)
@@ -418,7 +418,7 @@ function mssql_next_result ($result_id) {}
* @return void
* @removed 7.0
*/
-function mssql_min_error_severity ($severity) {}
+function mssql_min_error_severity($severity) {}
/**
* (PHP 4, PHP 5, PECL odbtp >= 1.1.1)
@@ -430,7 +430,7 @@ function mssql_min_error_severity ($severity) {}
* @return void
* @removed 7.0
*/
-function mssql_min_message_severity ($severity) {}
+function mssql_min_message_severity($severity) {}
/**
* (PHP 4 >= 4.0.7, PHP 5, PECL odbtp >= 1.1.1)
@@ -449,7 +449,7 @@ function mssql_min_message_severity ($severity) {}
* or false on errors.
* @removed 7.0
*/
-function mssql_init ($sp_name, $link_identifier = null) {}
+function mssql_init($sp_name, $link_identifier = null) {}
/**
* (PHP 4 >= 4.0.7, PHP 5, PECL odbtp >= 1.1.1)
@@ -496,7 +496,7 @@ function mssql_init ($sp_name, $link_identifier = null) {}
* @return bool true on success or false on failure.
* @removed 7.0
*/
-function mssql_bind ($stmt, $param_name, &$var, $type, $is_output = false, $is_null = false, $maxlen = -1) {}
+function mssql_bind($stmt, $param_name, &$var, $type, $is_output = false, $is_null = false, $maxlen = -1) {}
/**
* (PHP 4 >= 4.0.7, PHP 5, PECL odbtp >= 1.1.1)
@@ -511,7 +511,7 @@ function mssql_bind ($stmt, $param_name, &$var, $type, $is_output = false, $is_n
* @return mixed
* @removed 7.0
*/
-function mssql_execute ($stmt, $skip_results = false) {}
+function mssql_execute($stmt, $skip_results = false) {}
/**
* (PHP 4 >= 4.3.2, PHP 5, PECL odbtp >= 1.1.1)
@@ -523,7 +523,7 @@ function mssql_execute ($stmt, $skip_results = false) {}
* @return bool true on success or false on failure.
* @removed 7.0
*/
-function mssql_free_statement ($stmt) {}
+function mssql_free_statement($stmt) {}
/**
* (PHP 4 >= 4.0.7, PHP 5, PECL odbtp >= 1.1.1)
@@ -538,8 +538,7 @@ function mssql_free_statement ($stmt) {}
* @return string the converted string on success.
* @removed 7.0
*/
-function mssql_guid_string ($binary, $short_format = null) {}
-
+function mssql_guid_string($binary, $short_format = null) {}
/**
* Return an associative array. Used on
@@ -547,7 +546,7 @@ function mssql_guid_string ($binary, $short_format = null) {}
* result_type parameter.
* @link https://php.net/manual/en/mssql.constants.php
*/
-define ('MSSQL_ASSOC', 1);
+define('MSSQL_ASSOC', 1);
/**
* Return an array with numeric keys. Used on
@@ -555,7 +554,7 @@ function mssql_guid_string ($binary, $short_format = null) {}
* result_type parameter.
* @link https://php.net/manual/en/mssql.constants.php
*/
-define ('MSSQL_NUM', 2);
+define('MSSQL_NUM', 2);
/**
* Return an array with both numeric keys and
@@ -564,7 +563,7 @@ function mssql_guid_string ($binary, $short_format = null) {}
* result_type parameter.
* @link https://php.net/manual/en/mssql.constants.php
*/
-define ('MSSQL_BOTH', 3);
+define('MSSQL_BOTH', 3);
/**
* Indicates the 'TEXT' type in MSSQL, used by
@@ -572,7 +571,7 @@ function mssql_guid_string ($binary, $short_format = null) {}
* parameter.
* @link https://php.net/manual/en/mssql.constants.php
*/
-define ('SQLTEXT', 35);
+define('SQLTEXT', 35);
/**
* Indicates the 'VARCHAR' type in MSSQL, used by
@@ -580,7 +579,7 @@ function mssql_guid_string ($binary, $short_format = null) {}
* parameter.
* @link https://php.net/manual/en/mssql.constants.php
*/
-define ('SQLVARCHAR', 39);
+define('SQLVARCHAR', 39);
/**
* Indicates the 'CHAR' type in MSSQL, used by
@@ -588,27 +587,27 @@ function mssql_guid_string ($binary, $short_format = null) {}
* parameter.
* @link https://php.net/manual/en/mssql.constants.php
*/
-define ('SQLCHAR', 47);
+define('SQLCHAR', 47);
/**
* Represents one byte, with a range of -128 to 127.
* @link https://php.net/manual/en/mssql.constants.php
*/
-define ('SQLINT1', 48);
+define('SQLINT1', 48);
/**
* Represents two bytes, with a range of -32768
* to 32767.
* @link https://php.net/manual/en/mssql.constants.php
*/
-define ('SQLINT2', 52);
+define('SQLINT2', 52);
/**
* Represents four bytes, with a range of -2147483648
* to 2147483647.
* @link https://php.net/manual/en/mssql.constants.php
*/
-define ('SQLINT4', 56);
+define('SQLINT4', 56);
/**
* Indicates the 'BIT' type in MSSQL, used by
@@ -616,20 +615,19 @@ function mssql_guid_string ($binary, $short_format = null) {}
* parameter.
* @link https://php.net/manual/en/mssql.constants.php
*/
-define ('SQLBIT', 50);
+define('SQLBIT', 50);
/**
* Represents an four byte float.
* @link https://php.net/manual/en/mssql.constants.php
*/
-define ('SQLFLT4', 59);
+define('SQLFLT4', 59);
/**
* Represents an eight byte float.
* @link https://php.net/manual/en/mssql.constants.php
*/
-define ('SQLFLT8', 62);
-define ('SQLFLTN', 109);
+define('SQLFLT8', 62);
+define('SQLFLTN', 109);
// End of mssql v.
-?>
diff --git a/mysql/mysql.php b/mysql/mysql.php
index bc71cf6e7..d40359845 100644
--- a/mysql/mysql.php
+++ b/mysql/mysql.php
@@ -52,7 +52,7 @@
* @removed 7.0
*/
#[Deprecated(since: '5.5')]
-function mysql_connect ($server = 'ini_get("mysql.default_host")', $username = 'ini_get("mysql.default_user")', $password = 'ini_get("mysql.default_password")', $new_link = false, $client_flags = 0) {}
+function mysql_connect($server = 'ini_get("mysql.default_host")', $username = 'ini_get("mysql.default_user")', $password = 'ini_get("mysql.default_password")', $new_link = false, $client_flags = 0) {}
/**
* Open a persistent connection to a MySQL server
@@ -88,7 +88,7 @@ function mysql_connect ($server = 'ini_get("mysql.default_host")', $username = '
* @removed 7.0
*/
#[Deprecated(since: '5.5')]
-function mysql_pconnect ($server = 'ini_get("mysql.default_host")', $username = 'ini_get("mysql.default_user")', $password = 'ini_get("mysql.default_password")', $client_flags = null) {}
+function mysql_pconnect($server = 'ini_get("mysql.default_host")', $username = 'ini_get("mysql.default_user")', $password = 'ini_get("mysql.default_password")', $client_flags = null) {}
/**
* Close MySQL connection
@@ -98,7 +98,7 @@ function mysql_pconnect ($server = 'ini_get("mysql.default_host")', $username =
* @removed 7.0
*/
#[Deprecated(since: '5.5')]
-function mysql_close ($link_identifier = null) {}
+function mysql_close($link_identifier = null) {}
/**
* Select a MySQL database
@@ -111,7 +111,7 @@ function mysql_close ($link_identifier = null) {}
* @removed 7.0
*/
#[Deprecated(since: '5.5')]
-function mysql_select_db ($database_name, $link_identifier = null) {}
+function mysql_select_db($database_name, $link_identifier = null) {}
/**
* Send a MySQL query
@@ -153,7 +153,7 @@ function mysql_select_db ($database_name, $link_identifier = null) {}
* @removed 7.0
*/
#[Deprecated(since: '5.5')]
-function mysql_query ($query, $link_identifier = null) {}
+function mysql_query($query, $link_identifier = null) {}
/**
* @deprecated 5.5
@@ -178,7 +178,7 @@ function mysql_query ($query, $link_identifier = null) {}
* @removed 7.0
*/
#[Deprecated(since: '5.5')]
-function mysql_unbuffered_query ($query, $link_identifier = null) {}
+function mysql_unbuffered_query($query, $link_identifier = null) {}
/**
* Selects a database and executes a query on it
@@ -202,7 +202,7 @@ function mysql_unbuffered_query ($query, $link_identifier = null) {}
* @see mysql_query()
*/
#[Deprecated('Use mysql_select_db() and mysql_query() instead', since: '5.3')]
-function mysql_db_query ($database, $query, $link_identifier = null) {}
+function mysql_db_query($database, $query, $link_identifier = null) {}
/**
* List databases available on a MySQL server
@@ -215,7 +215,7 @@ function mysql_db_query ($database, $query, $link_identifier = null) {}
* @removed 7.0
*/
#[Deprecated(since: '5.4')]
-function mysql_list_dbs ($link_identifier = null) {}
+function mysql_list_dbs($link_identifier = null) {}
/**
* List tables in a MySQL database
@@ -233,7 +233,7 @@ function mysql_list_dbs ($link_identifier = null) {}
* @removed 7.0
*/
#[Deprecated(since: '5.3')]
-function mysql_list_tables ($database, $link_identifier = null) {}
+function mysql_list_tables($database, $link_identifier = null) {}
/**
* List MySQL table fields
@@ -256,7 +256,7 @@ function mysql_list_tables ($database, $link_identifier = null) {}
* @removed 7.0
*/
#[Deprecated(since: '5.5')]
-function mysql_list_fields ($database_name, $table_name, $link_identifier = null) {}
+function mysql_list_fields($database_name, $table_name, $link_identifier = null) {}
/**
* List MySQL processes
@@ -266,7 +266,7 @@ function mysql_list_fields ($database_name, $table_name, $link_identifier = null
* @removed 7.0
*/
#[Deprecated(since: '5.5')]
-function mysql_list_processes ($link_identifier = null) {}
+function mysql_list_processes($link_identifier = null) {}
/**
* Returns the text of the error message from previous MySQL operation
@@ -277,7 +277,7 @@ function mysql_list_processes ($link_identifier = null) {}
* @removed 7.0
*/
#[Deprecated(since: '5.5')]
-function mysql_error ($link_identifier = null) {}
+function mysql_error($link_identifier = null) {}
/**
* Returns the numerical value of the error message from previous MySQL operation
@@ -288,7 +288,7 @@ function mysql_error ($link_identifier = null) {}
* @removed 7.0
*/
#[Deprecated(since: '5.5')]
-function mysql_errno ($link_identifier = null) {}
+function mysql_errno($link_identifier = null) {}
/**
* Get number of affected rows in previous MySQL operation
@@ -316,7 +316,7 @@ function mysql_errno ($link_identifier = null) {}
* @removed 7.0
*/
#[Deprecated(since: '5.5')]
-function mysql_affected_rows ($link_identifier = null) {}
+function mysql_affected_rows($link_identifier = null) {}
/**
* Get the ID generated in the last query
@@ -329,7 +329,7 @@ function mysql_affected_rows ($link_identifier = null) {}
* @removed 7.0
*/
#[Deprecated(since: '5.5')]
-function mysql_insert_id ($link_identifier = null) {}
+function mysql_insert_id($link_identifier = null) {}
/**
* Get result data
@@ -353,7 +353,7 @@ function mysql_insert_id ($link_identifier = null) {}
* @removed 7.0
*/
#[Deprecated(since: '5.5')]
-function mysql_result ($result, $row, $field = 0) {}
+function mysql_result($result, $row, $field = 0) {}
/**
* Get number of rows in result
@@ -363,7 +363,7 @@ function mysql_result ($result, $row, $field = 0) {}
* @removed 7.0
*/
#[Deprecated(since: '5.5')]
-function mysql_num_rows ($result) {}
+function mysql_num_rows($result) {}
/**
* Get number of fields in result
@@ -374,7 +374,7 @@ function mysql_num_rows ($result) {}
* @removed 7.0
*/
#[Deprecated(since: '5.5')]
-function mysql_num_fields ($result) {}
+function mysql_num_fields($result) {}
/**
* Get a result row as an enumerated array
@@ -391,7 +391,7 @@ function mysql_num_fields ($result) {}
* @removed 7.0
*/
#[Deprecated(since: '5.5')]
-function mysql_fetch_row ($result) {}
+function mysql_fetch_row($result) {}
/**
* Fetch a result row as an associative array, a numeric array, or both
@@ -421,7 +421,7 @@ function mysql_fetch_row ($result) {}
* @removed 7.0
*/
#[Deprecated(since: '5.5')]
-function mysql_fetch_array ($result, $result_type = MYSQL_BOTH) {}
+function mysql_fetch_array($result, $result_type = MYSQL_BOTH) {}
/**
* Fetch a result row as an associative array
@@ -441,7 +441,7 @@ function mysql_fetch_array ($result, $result_type = MYSQL_BOTH) {}
* @removed 7.0
*/
#[Deprecated(since: '5.5')]
-function mysql_fetch_assoc ($result) {}
+function mysql_fetch_assoc($result) {}
/**
* Fetch a result row as an object
@@ -466,7 +466,7 @@ function mysql_fetch_assoc ($result) {}
* @removed 7.0
*/
#[Deprecated(since: '5.5')]
-function mysql_fetch_object ($result, $class_name = 'stdClass', array $params = null ) {}
+function mysql_fetch_object($result, $class_name = 'stdClass', array $params = null) {}
/**
* Move internal result pointer
@@ -479,7 +479,7 @@ function mysql_fetch_object ($result, $class_name = 'stdClass', array $params =
* @removed 7.0
*/
#[Deprecated(since: '5.5')]
-function mysql_data_seek ($result, $row_number) {}
+function mysql_data_seek($result, $row_number) {}
/**
* Get the length of each output in a result
@@ -489,7 +489,7 @@ function mysql_data_seek ($result, $row_number) {}
* @removed 7.0
*/
#[Deprecated(since: '5.5')]
-function mysql_fetch_lengths ($result) {}
+function mysql_fetch_lengths($result) {}
/**
* Get column information from a result and return as an object
@@ -520,7 +520,7 @@ function mysql_fetch_lengths ($result) {}
* @removed 7.0
*/
#[Deprecated(since: '5.5')]
-function mysql_fetch_field ($result, $field_offset = 0) {}
+function mysql_fetch_field($result, $field_offset = 0) {}
/**
* Set result pointer to a specified field offset
@@ -531,7 +531,7 @@ function mysql_fetch_field ($result, $field_offset = 0) {}
* @removed 7.0
*/
#[Deprecated(since: '5.5')]
-function mysql_field_seek ($result, $field_offset) {}
+function mysql_field_seek($result, $field_offset) {}
/**
* Free result memory
@@ -547,7 +547,7 @@ function mysql_field_seek ($result, $field_offset) {}
* @removed 7.0
*/
#[Deprecated(since: '5.5')]
-function mysql_free_result ($result) {}
+function mysql_free_result($result) {}
/**
* Get the name of the specified field in a result
@@ -558,7 +558,7 @@ function mysql_free_result ($result) {}
* @removed 7.0
*/
#[Deprecated(since: '5.5')]
-function mysql_field_name ($result, $field_offset) {}
+function mysql_field_name($result, $field_offset) {}
/**
* Get name of the table the specified field is in
@@ -569,7 +569,7 @@ function mysql_field_name ($result, $field_offset) {}
* @removed 7.0
*/
#[Deprecated(since: '5.5')]
-function mysql_field_table ($result, $field_offset) {}
+function mysql_field_table($result, $field_offset) {}
/**
* Returns the length of the specified field
@@ -580,7 +580,7 @@ function mysql_field_table ($result, $field_offset) {}
* @removed 7.0
*/
#[Deprecated(since: '5.5')]
-function mysql_field_len ($result, $field_offset) {}
+function mysql_field_len($result, $field_offset) {}
/**
* Get the type of the specified field in a result
@@ -595,7 +595,7 @@ function mysql_field_len ($result, $field_offset) {}
* @removed 7.0
*/
#[Deprecated(since: '5.5')]
-function mysql_field_type ($result, $field_offset) {}
+function mysql_field_type($result, $field_offset) {}
/**
* Get the flags associated with the specified field in a result
@@ -615,7 +615,7 @@ function mysql_field_type ($result, $field_offset) {}
* @removed 7.0
*/
#[Deprecated(since: '5.5')]
-function mysql_field_flags ($result, $field_offset) {}
+function mysql_field_flags($result, $field_offset) {}
/**
* Escapes a string for use in a mysql_query
@@ -626,8 +626,8 @@ function mysql_field_flags ($result, $field_offset) {}
* @return string the escaped string.
* @removed 7.0
*/
-#[Deprecated(replacement: 'mysql_real_escape_string(%parameter0%)',since: '5.3')]
-function mysql_escape_string ($unescaped_string) {}
+#[Deprecated(replacement: 'mysql_real_escape_string(%parameter0%)', since: '5.3')]
+function mysql_escape_string($unescaped_string) {}
/**
* Escapes special characters in a string for use in an SQL statement
@@ -640,7 +640,7 @@ function mysql_escape_string ($unescaped_string) {}
* @removed 7.0
*/
#[Deprecated(since: '5.5')]
-function mysql_real_escape_string ($unescaped_string, $link_identifier = null) {}
+function mysql_real_escape_string($unescaped_string, $link_identifier = null) {}
/**
* Get current system status
@@ -653,7 +653,7 @@ function mysql_real_escape_string ($unescaped_string, $link_identifier = null) {
* @removed 7.0
*/
#[Deprecated(since: '5.5')]
-function mysql_stat ($link_identifier = null) {}
+function mysql_stat($link_identifier = null) {}
/**
* Return the current thread ID
@@ -663,7 +663,7 @@ function mysql_stat ($link_identifier = null) {}
* @removed 7.0
*/
#[Deprecated(since: '5.5')]
-function mysql_thread_id ($link_identifier = null) {}
+function mysql_thread_id($link_identifier = null) {}
/**
* Returns the name of the character set
@@ -673,7 +673,7 @@ function mysql_thread_id ($link_identifier = null) {}
* @removed 7.0
*/
#[Deprecated(since: '5.5')]
-function mysql_client_encoding ($link_identifier = null) {}
+function mysql_client_encoding($link_identifier = null) {}
/**
* Ping a server connection or reconnect if there is no connection
@@ -684,7 +684,7 @@ function mysql_client_encoding ($link_identifier = null) {}
* @removed 7.0
*/
#[Deprecated(since: '5.5')]
-function mysql_ping ($link_identifier = null) {}
+function mysql_ping($link_identifier = null) {}
/**
* Get MySQL client info
@@ -693,7 +693,7 @@ function mysql_ping ($link_identifier = null) {}
* @removed 7.0
*/
#[Deprecated(since: '5.5')]
-function mysql_get_client_info () {}
+function mysql_get_client_info() {}
/**
* Get MySQL host info
@@ -704,7 +704,7 @@ function mysql_get_client_info () {}
* @removed 7.0
*/
#[Deprecated(since: '5.5')]
-function mysql_get_host_info ($link_identifier = null) {}
+function mysql_get_host_info($link_identifier = null) {}
/**
* Get MySQL protocol info
@@ -714,7 +714,7 @@ function mysql_get_host_info ($link_identifier = null) {}
* @removed 7.0
*/
#[Deprecated(since: '5.5')]
-function mysql_get_proto_info ($link_identifier = null) {}
+function mysql_get_proto_info($link_identifier = null) {}
/**
* Get MySQL server info
@@ -724,7 +724,7 @@ function mysql_get_proto_info ($link_identifier = null) {}
* @removed 7.0
*/
#[Deprecated(since: '5.5')]
-function mysql_get_server_info ($link_identifier = null) {}
+function mysql_get_server_info($link_identifier = null) {}
/**
* Get information about the most recent query
@@ -737,7 +737,7 @@ function mysql_get_server_info ($link_identifier = null) {}
* @removed 7.0
*/
#[Deprecated(since: '5.5')]
-function mysql_info ($link_identifier = null) {}
+function mysql_info($link_identifier = null) {}
/**
* Sets the client character set
@@ -751,8 +751,8 @@ function mysql_info ($link_identifier = null) {}
* @removed 7.0
* @see mysqli_set_charset()
*/
-#[Deprecated(replacement: 'Use mysqli_set_charset instead',since: '5.5')]
-function mysql_set_charset ($charset, $link_identifier = null) {}
+#[Deprecated(replacement: 'Use mysqli_set_charset instead', since: '5.5')]
+function mysql_set_charset($charset, $link_identifier = null) {}
/**
* @param $database_name
@@ -761,7 +761,7 @@ function mysql_set_charset ($charset, $link_identifier = null) {}
* @removed 7.0
*/
#[Deprecated(replacement: "mysql_db_query(%parametersList%)", since: '5.3')]
-function mysql ($database_name, $query, $link_identifier) {}
+function mysql($database_name, $query, $link_identifier) {}
/**
* @param $result
@@ -769,7 +769,7 @@ function mysql ($database_name, $query, $link_identifier) {}
* @removed 7.0
*/
#[Deprecated(replacement: 'mysql_field_name(%parametersList%)', since: '5.5')]
-function mysql_fieldname ($result, $field_index) {}
+function mysql_fieldname($result, $field_index) {}
/**
* @param $result
@@ -777,7 +777,7 @@ function mysql_fieldname ($result, $field_index) {}
* @removed 7.0
*/
#[Deprecated(replacement: 'mysql_field_table(%parametersList%)', since: '5.5')]
-function mysql_fieldtable ($result, $field_offset) {}
+function mysql_fieldtable($result, $field_offset) {}
/**
* @param $result
@@ -785,7 +785,7 @@ function mysql_fieldtable ($result, $field_offset) {}
* @removed 7.0
*/
#[Deprecated(replacement: 'mysql_field_len(%parametersList%)', since: '5.5')]
-function mysql_fieldlen ($result, $field_offset) {}
+function mysql_fieldlen($result, $field_offset) {}
/**
* @param $result
@@ -793,7 +793,7 @@ function mysql_fieldlen ($result, $field_offset) {}
* @removed 7.0
*/
#[Deprecated(replacement: 'mysql_field_type(%parametersList%)', since: '5.5')]
-function mysql_fieldtype ($result, $field_offset) {}
+function mysql_fieldtype($result, $field_offset) {}
/**
* @param $result
@@ -801,7 +801,7 @@ function mysql_fieldtype ($result, $field_offset) {}
* @removed 7.0
*/
#[Deprecated(replacement: 'mysql_field_flags(%parametersList%)', since: '5.5')]
-function mysql_fieldflags ($result, $field_offset) {}
+function mysql_fieldflags($result, $field_offset) {}
/**
* @param $database_name
@@ -809,21 +809,21 @@ function mysql_fieldflags ($result, $field_offset) {}
* @removed 7.0
*/
#[Deprecated(replacement: 'mysql_select_db(%parametersList%)', since: '5.5')]
-function mysql_selectdb ($database_name, $link_identifier) {}
+function mysql_selectdb($database_name, $link_identifier) {}
/**
* @param $result
* @removed 7.0
*/
#[Deprecated(replacement: 'mysql_free_result(%parametersList%)', since: '5.5')]
-function mysql_freeresult ($result) {}
+function mysql_freeresult($result) {}
/**
* @param $result
* @removed 7.0
*/
#[Deprecated(replacement: 'mysql_num_fields(%parametersList%)', since: '5.5')]
-function mysql_numfields ($result) {}
+function mysql_numfields($result) {}
/**
* (PHP 4, PHP 5)
@@ -834,14 +834,14 @@ function mysql_numfields ($result) {}
* @removed 7.0
*/
#[Deprecated(replacement: 'mysql_num_rows(%parametersList%)', since: '5.5')]
-function mysql_numrows ($result) {}
+function mysql_numrows($result) {}
/**
* @param $link_identifier [optional]
* @removed 7.0
*/
#[Deprecated(replacement: 'mysql_list_dbs(%parametersList%)', since: '5.5')]
-function mysql_listdbs ($link_identifier) {}
+function mysql_listdbs($link_identifier) {}
/**
* @param $database_name
@@ -849,7 +849,7 @@ function mysql_listdbs ($link_identifier) {}
* @removed 7.0
*/
#[Deprecated(replacement: 'mysql_list_tables(%parametersList%)', since: '5.5')]
-function mysql_listtables ($database_name, $link_identifier) {}
+function mysql_listtables($database_name, $link_identifier) {}
/**
* @param $database_name
@@ -858,7 +858,7 @@ function mysql_listtables ($database_name, $link_identifier) {}
* @removed 7.0
*/
#[Deprecated(replacement: 'mysql_list_fields(%parametersList%)', since: '5.5')]
-function mysql_listfields ($database_name, $table_name, $link_identifier) {}
+function mysql_listfields($database_name, $table_name, $link_identifier) {}
/**
* Retrieves database name from the call to {@see mysql_list_dbs}
@@ -878,7 +878,7 @@ function mysql_listfields ($database_name, $table_name, $link_identifier) {}
* @removed 7.0
*/
#[Deprecated(since: '5.5')]
-function mysql_db_name ($result, $row, $field = null) {}
+function mysql_db_name($result, $row, $field = null) {}
/**
* @param $result
@@ -887,7 +887,7 @@ function mysql_db_name ($result, $row, $field = null) {}
* @removed 7.0
*/
#[Deprecated(replacement: 'mysql_db_name(%parametersList%)', since: '5.5')]
-function mysql_dbname ($result, $row, $field) {}
+function mysql_dbname($result, $row, $field) {}
/**
* Get table name of field
@@ -908,7 +908,7 @@ function mysql_dbname ($result, $row, $field) {}
* @removed 7.0
*/
#[Deprecated(since: '5.5')]
-function mysql_tablename ($result, $i) {}
+function mysql_tablename($result, $i) {}
/**
* @param $result
@@ -917,8 +917,7 @@ function mysql_tablename ($result, $i) {}
* @removed 7.0
*/
#[Deprecated(since: '5.5')]
-function mysql_table_name ($result, $row, $field) {}
-
+function mysql_table_name($result, $row, $field) {}
/**
* Columns are returned into the array having the fieldname as the array
@@ -927,7 +926,7 @@ function mysql_table_name ($result, $row, $field) {}
* @deprecated 5.5
* @removed 7.0
*/
-define ('MYSQL_ASSOC', 1);
+define('MYSQL_ASSOC', 1);
/**
* Columns are returned into the array having a numerical index to the
@@ -936,7 +935,7 @@ function mysql_table_name ($result, $row, $field) {}
* @deprecated 5.5
* @removed 7.0
*/
-define ('MYSQL_NUM', 2);
+define('MYSQL_NUM', 2);
/**
* Columns are returned into the array having both a numerical index
@@ -945,7 +944,7 @@ function mysql_table_name ($result, $row, $field) {}
* @deprecated 5.5
* @removed 7.0
*/
-define ('MYSQL_BOTH', 3);
+define('MYSQL_BOTH', 3);
/**
* Use compression protocol
@@ -953,7 +952,7 @@ function mysql_table_name ($result, $row, $field) {}
* @deprecated 5.5
* @removed 7.0
*/
-define ('MYSQL_CLIENT_COMPRESS', 32);
+define('MYSQL_CLIENT_COMPRESS', 32);
/**
* Use SSL encryption. This flag is only available with version 4.x
@@ -963,7 +962,7 @@ function mysql_table_name ($result, $row, $field) {}
* @deprecated 5.5
* @removed 7.0
*/
-define ('MYSQL_CLIENT_SSL', 2048);
+define('MYSQL_CLIENT_SSL', 2048);
/**
* Allow interactive_timeout seconds (instead of wait_timeout) of
@@ -972,7 +971,7 @@ function mysql_table_name ($result, $row, $field) {}
* @deprecated 5.5
* @removed 7.0
*/
-define ('MYSQL_CLIENT_INTERACTIVE', 1024);
+define('MYSQL_CLIENT_INTERACTIVE', 1024);
/**
* Allow space after function names
@@ -980,7 +979,6 @@ function mysql_table_name ($result, $row, $field) {}
* @deprecated 5.5
* @removed 7.0
*/
-define ('MYSQL_CLIENT_IGNORE_SPACE', 256);
+define('MYSQL_CLIENT_IGNORE_SPACE', 256);
// End of mysql v.1.0
-?>
diff --git a/mysql_xdevapi/mysql_xdevapi.php b/mysql_xdevapi/mysql_xdevapi.php
index e765c017e..7ab0b89f4 100644
--- a/mysql_xdevapi/mysql_xdevapi.php
+++ b/mysql_xdevapi/mysql_xdevapi.php
@@ -6,46 +6,46 @@
* @author Mathijs Giesbers
* @package mysql_xdevapi
*/
+
namespace mysql_xdevapi;
define('MYSQLX_LOCK_DEFAULT', 0);
-define('MYSQLX_TYPE_DECIMAL',0);
-define('MYSQLX_TYPE_TINY',1);
-define('MYSQLX_TYPE_SHORT',2);
-define('MYSQLX_TYPE_SMALLINT',17);
-define('MYSQLX_TYPE_MEDIUMINT',18);
-define('MYSQLX_TYPE_INT',19);
-define('MYSQLX_TYPE_BIGINT',20);
-define('MYSQLX_TYPE_LONG',3);
-define('MYSQLX_TYPE_FLOAT',4);
-define('MYSQLX_TYPE_DOUBLE',5);
-define('MYSQLX_TYPE_NULL',6);
-define('MYSQLX_TYPE_TIMESTAMP',7);
-define('MYSQLX_TYPE_LONGLONG',8);
-define('MYSQLX_TYPE_INT24',9);
-define('MYSQLX_TYPE_DATE',10);
-define('MYSQLX_TYPE_TIME',11);
-define('MYSQLX_TYPE_DATETIME',12);
-define('MYSQLX_TYPE_YEAR',13);
-define('MYSQLX_TYPE_NEWDATE',14);
-define('MYSQLX_TYPE_ENUM',247);
-define('MYSQLX_TYPE_SET',248);
-define('MYSQLX_TYPE_TINY_BLOB',249);
-define('MYSQLX_TYPE_MEDIUM_BLOB',250);
-define('MYSQLX_TYPE_LONG_BLOB',251);
-define('MYSQLX_TYPE_BLOB',252);
-define('MYSQLX_TYPE_VAR_STRING',253);
-define('MYSQLX_TYPE_STRING',254);
-define('MYSQLX_TYPE_CHAR',1);
-define('MYSQLX_TYPE_BYTES',21);
-define('MYSQLX_TYPE_INTERVAL',247);
-define('MYSQLX_TYPE_GEOMETRY',255);
-define('MYSQLX_TYPE_JSON',245);
-define('MYSQLX_TYPE_NEWDECIMAL',246);
-define('MYSQLX_TYPE_BIT',16);
-define('MYSQLX_LOCK_NOWAIT',1);
-define('MYSQLX_LOCK_SKIP_LOCKED',2);
-
+define('MYSQLX_TYPE_DECIMAL', 0);
+define('MYSQLX_TYPE_TINY', 1);
+define('MYSQLX_TYPE_SHORT', 2);
+define('MYSQLX_TYPE_SMALLINT', 17);
+define('MYSQLX_TYPE_MEDIUMINT', 18);
+define('MYSQLX_TYPE_INT', 19);
+define('MYSQLX_TYPE_BIGINT', 20);
+define('MYSQLX_TYPE_LONG', 3);
+define('MYSQLX_TYPE_FLOAT', 4);
+define('MYSQLX_TYPE_DOUBLE', 5);
+define('MYSQLX_TYPE_NULL', 6);
+define('MYSQLX_TYPE_TIMESTAMP', 7);
+define('MYSQLX_TYPE_LONGLONG', 8);
+define('MYSQLX_TYPE_INT24', 9);
+define('MYSQLX_TYPE_DATE', 10);
+define('MYSQLX_TYPE_TIME', 11);
+define('MYSQLX_TYPE_DATETIME', 12);
+define('MYSQLX_TYPE_YEAR', 13);
+define('MYSQLX_TYPE_NEWDATE', 14);
+define('MYSQLX_TYPE_ENUM', 247);
+define('MYSQLX_TYPE_SET', 248);
+define('MYSQLX_TYPE_TINY_BLOB', 249);
+define('MYSQLX_TYPE_MEDIUM_BLOB', 250);
+define('MYSQLX_TYPE_LONG_BLOB', 251);
+define('MYSQLX_TYPE_BLOB', 252);
+define('MYSQLX_TYPE_VAR_STRING', 253);
+define('MYSQLX_TYPE_STRING', 254);
+define('MYSQLX_TYPE_CHAR', 1);
+define('MYSQLX_TYPE_BYTES', 21);
+define('MYSQLX_TYPE_INTERVAL', 247);
+define('MYSQLX_TYPE_GEOMETRY', 255);
+define('MYSQLX_TYPE_JSON', 245);
+define('MYSQLX_TYPE_NEWDECIMAL', 246);
+define('MYSQLX_TYPE_BIT', 16);
+define('MYSQLX_LOCK_NOWAIT', 1);
+define('MYSQLX_LOCK_SKIP_LOCKED', 2);
/**
* @link https://secure.php.net/manual/en/function.mysql-xdevapi-getsession.php
@@ -61,26 +61,25 @@ function getSession($uri) {}
*/
function expression($expression) {}
-
/**
* Interface BaseResult
* @package mysql_xdevapi
*/
-interface BaseResult {
-
+interface BaseResult
+{
/**
* Fetch warnings from last operation
* @link https://www.php.net/manual/en/mysql-xdevapi-baseresult.getwarnings.php
* @return array
*/
- public function getWarnings () : array;
+ public function getWarnings(): array;
/**
* Fetch warning count from last operation
* @link https://www.php.net/manual/en/mysql-xdevapi-baseresult.getwarningscount.php
* @return int
*/
- public function getWarningsCount () : int;
+ public function getWarningsCount(): int;
}
/**
@@ -88,8 +87,8 @@ public function getWarningsCount () : int;
* @link https://www.php.net/manual/en/class.mysql-xdevapi-collection.php
* @package mysql_xdevapi
*/
-class Collection {
-
+class Collection
+{
/**
* Collection constructor
* @link https://www.php.net/manual/en/mysql-xdevapi-collection.construct.php
@@ -102,7 +101,7 @@ public function __construct() {}
* @param mixed $document
* @return \mysql_xdevapi\CollectionAdd
*/
- public function add($document) : \mysql_xdevapi\CollectionAdd {}
+ public function add($document): CollectionAdd {}
/**
* Add or replace collection document
@@ -111,14 +110,14 @@ public function add($document) : \mysql_xdevapi\CollectionAdd {}
* @param mixed $document
* @return \mysql_xdevapi\Result
*/
- public function addOrReplaceOne($id, $document) : \mysql_xdevapi\Result {}
+ public function addOrReplaceOne($id, $document): Result {}
/**
* Get document count
* @link https://www.php.net/manual/en/mysql-xdevapi-collection.count.php
- * @return integer The number of documents in the collection.
+ * @return int The number of documents in the collection.
*/
- public function count() : int {}
+ public function count(): int {}
/**
* Create collection index
@@ -134,28 +133,28 @@ public function createIndex($index_name, $index_desc_json) {}
* @param string $index_name
* @return bool
*/
- public function dropIndex($index_name) : bool {}
+ public function dropIndex($index_name): bool {}
/**
* Check if collection exists in database
* @link https://www.php.net/manual/en/mysql-xdevapi-collection.existsindatabase.php
* @return bool
*/
- public function existsInDatabase() : bool {}
+ public function existsInDatabase(): bool {}
/**
* @link https://secure.php.net/manual/en/mysql-xdevapi-collection.find.php
* @param string $search_condition
* @return \mysql_xdevapi\CollectionFind
*/
- public function find($search_condition) : \mysql_xdevapi\CollectionFind {}
+ public function find($search_condition): CollectionFind {}
/**
* Get collection name
* @link https://www.php.net/manual/en/mysql-xdevapi-collection.getname.php
* @return string
*/
- public function getName() : string {}
+ public function getName(): string {}
/**
* Get one document
@@ -171,14 +170,14 @@ public function getOne($id) {}
* @link https://www.php.net/manual/en/mysql-xdevapi-collection.getschema.php
* @return \mysql_xdevapi\Schema
*/
- public function getSchema() : \mysql_xdevapi\Schema {}
+ public function getSchema(): Schema {}
/**
* Get a new Session object from the Collection object.
* @link https://www.php.net/manual/en/mysql-xdevapi-collection.getsession.php
* @return \mysql_xdevapi\Session
*/
- public function getSession() : \mysql_xdevapi\Session {}
+ public function getSession(): Session {}
/**
* Modify collections that meet specific search conditions. Multiple operations are allowed, and parameter binding is supported.
@@ -186,7 +185,7 @@ public function getSession() : \mysql_xdevapi\Session {}
* @param string $search_condition
* @return \mysql_xdevapi\CollectionModify
*/
- public function modify($search_condition) : \mysql_xdevapi\CollectionModify {}
+ public function modify($search_condition): CollectionModify {}
/**
* Remove collections that meet specific search conditions. Multiple operations are allowed, and parameter binding is supported.
@@ -194,7 +193,7 @@ public function modify($search_condition) : \mysql_xdevapi\CollectionModify {}
* @param string $search_condition
* @return \mysql_xdevapi\CollectionRemove
*/
- public function remove($search_condition) : \mysql_xdevapi\CollectionRemove {}
+ public function remove($search_condition): CollectionRemove {}
/**
* Remove one collection document
@@ -203,7 +202,7 @@ public function remove($search_condition) : \mysql_xdevapi\CollectionRemove {}
* @param string $id
* @return \mysql_xdevapi\Result
*/
- public function removeOne($id) : \mysql_xdevapi\Result {}
+ public function removeOne($id): Result {}
/**
* Updates (or replaces) the document identified by ID, if it exists.
@@ -212,30 +211,28 @@ public function removeOne($id) : \mysql_xdevapi\Result {}
* @param string $doc
* @return \mysql_xdevapi\Result
*/
- public function replaceOne($id, $doc) : \mysql_xdevapi\Result {}
+ public function replaceOne($id, $doc): Result {}
}
-
/**
* Class CollectionAdd
* @package mysql_xdevapi
*/
-class CollectionAdd implements \mysql_xdevapi\Executable {
-
+class CollectionAdd implements \mysql_xdevapi\Executable
+{
/**
* @return \mysql_xdevapi\Result
*/
- public function execute () : \mysql_xdevapi\Result {}
+ public function execute(): Result {}
}
-
/**
* Class CollectionFind
* @link https://www.php.net/manual/en/class.mysql-xdevapi-collectionfind.php
* @package mysql_xdevapi
*/
-class CollectionFind implements \mysql_xdevapi\Executable, \mysql_xdevapi\CrudOperationBindable, \mysql_xdevapi\CrudOperationLimitable, \mysql_xdevapi\CrudOperationSortable {
-
+class CollectionFind implements \mysql_xdevapi\Executable, \mysql_xdevapi\CrudOperationBindable, \mysql_xdevapi\CrudOperationLimitable, \mysql_xdevapi\CrudOperationSortable
+{
/**
* Bind value to query placeholder
* It allows the user to bind a parameter to the placeholder in the search condition of the find operation. The placeholder has the form of :NAME where ':' is a common prefix that must always exists before any NAME, NAME is the actual name of the placeholder. The bind function accepts a list of placeholders if multiple entities have to be substituted in the search condition.
@@ -243,14 +240,14 @@ class CollectionFind implements \mysql_xdevapi\Executable, \mysql_xdevapi\CrudOp
* @param array $placeholder_values
* @return \mysql_xdevapi\CollectionFind
*/
- public function bind ( array $placeholder_values ) : \mysql_xdevapi\CollectionFind {}
+ public function bind(array $placeholder_values): CollectionFind {}
/**
* Execute the find operation; this functionality allows for method chaining.
* @link https://www.php.net/manual/en/mysql-xdevapi-collectionfind.execute.php
* @return \mysql_xdevapi\DocResult
*/
- public function execute () : \mysql_xdevapi\DocResult {}
+ public function execute(): DocResult {}
/**
* Defined the columns for the query to return. If not defined then all columns are used.
@@ -258,7 +255,7 @@ public function execute () : \mysql_xdevapi\DocResult {}
* @param string $projection
* @return \mysql_xdevapi\CollectionFind
*/
- public function fields ( string $projection ) : \mysql_xdevapi\CollectionFind {}
+ public function fields(string $projection): CollectionFind {}
/**
* This function can be used to group the result-set by one more columns, frequently this is used with aggregate functions like COUNT,MAX,MIN,SUM etc.
@@ -266,7 +263,7 @@ public function fields ( string $projection ) : \mysql_xdevapi\CollectionFind {}
* @param string $sort_expr
* @return \mysql_xdevapi\CollectionFind
*/
- public function groupBy ( string $sort_expr ) : \mysql_xdevapi\CollectionFind {}
+ public function groupBy(string $sort_expr): CollectionFind {}
/**
* This function can be used after the 'field' operation in order to make a selection on the documents to extract.
@@ -274,7 +271,7 @@ public function groupBy ( string $sort_expr ) : \mysql_xdevapi\CollectionFind {}
* @param string $sort_expr
* @return \mysql_xdevapi\CollectionFind
*/
- public function having ( string $sort_expr ) : \mysql_xdevapi\CollectionFind {}
+ public function having(string $sort_expr): CollectionFind {}
/**
* Set the maximum number of documents to return.
@@ -282,7 +279,7 @@ public function having ( string $sort_expr ) : \mysql_xdevapi\CollectionFind {}
* @param int $rows
* @return \mysql_xdevapi\CollectionFind
*/
- public function limit ( int $rows ) : \mysql_xdevapi\CollectionFind {}
+ public function limit(int $rows): CollectionFind {}
/**
* Execute operation with EXCLUSIVE LOCK
@@ -295,7 +292,7 @@ public function limit ( int $rows ) : \mysql_xdevapi\CollectionFind {}
* @param int $lock_waiting_option
* @return \mysql_xdevapi\CollectionFind
*/
- public function lockExclusive (int $lock_waiting_option) : \mysql_xdevapi\CollectionFind {}
+ public function lockExclusive(int $lock_waiting_option): CollectionFind {}
/**
* Execute operation with SHARED LOCK
@@ -310,7 +307,7 @@ public function lockExclusive (int $lock_waiting_option) : \mysql_xdevapi\Collec
* @param int $lock_waiting_option
* @return \mysql_xdevapi\CollectionFind
*/
- public function lockShared ( int $lock_waiting_option ) : \mysql_xdevapi\CollectionFind {}
+ public function lockShared(int $lock_waiting_option): CollectionFind {}
/**
* Skip given number of elements to be returned
@@ -323,7 +320,7 @@ public function lockShared ( int $lock_waiting_option ) : \mysql_xdevapi\Collect
* @param int $position
* @return \mysql_xdevapi\CollectionFind
*/
- public function offset ( int $position ) : \mysql_xdevapi\CollectionFind {}
+ public function offset(int $position): CollectionFind {}
/**
* Set the sorting criteria
@@ -335,15 +332,15 @@ public function offset ( int $position ) : \mysql_xdevapi\CollectionFind {}
* @param string $sort_expr
* @return CollectionFind
*/
- public function sort ( string $sort_expr ) : \mysql_xdevapi\CollectionFind {}
+ public function sort(string $sort_expr): CollectionFind {}
}
-
/**
* Class CollectionModify
* @package mysql_xdevapi
*/
-class CollectionModify implements \mysql_xdevapi\Executable, \mysql_xdevapi\CrudOperationBindable, \mysql_xdevapi\CrudOperationLimitable, \mysql_xdevapi\CrudOperationSkippable, \mysql_xdevapi\CrudOperationSortable {
+class CollectionModify implements \mysql_xdevapi\Executable, \mysql_xdevapi\CrudOperationBindable, \mysql_xdevapi\CrudOperationLimitable, \mysql_xdevapi\CrudOperationSkippable, \mysql_xdevapi\CrudOperationSortable
+{
/**
* Add an element to a document's field, as multiple elements of a field are represented as an array. Unlike arrayInsert(), arrayAppend() always appends the new element at the end of the array, whereas arrayInsert() can define the location.
* @link https://www.php.net/manual/en/mysql-xdevapi-collectionmodify.arrayappend.php
@@ -351,7 +348,7 @@ class CollectionModify implements \mysql_xdevapi\Executable, \mysql_xdevapi\Cru
* @param string $expression_or_literal
* @return \mysql_xdevapi\CollectionModify
*/
- public function arrayAppend ( string $collection_field , string $expression_or_literal ) : \mysql_xdevapi\CollectionModify {}
+ public function arrayAppend(string $collection_field, string $expression_or_literal): CollectionModify {}
/**
* Add an element to a document's field, as multiple elements of a field are represented as an array. Unlike arrayAppend(), arrayInsert() allows you to specify where the new element is inserted by defining which item it is after, whereas arrayAppend() always appends the new element at the end of the array.
@@ -360,7 +357,7 @@ public function arrayAppend ( string $collection_field , string $expression_or_l
* @param string $expression_or_literal
* @return \mysql_xdevapi\CollectionModify
*/
- public function arrayInsert ( string $collection_field , string $expression_or_literal ) : \mysql_xdevapi\CollectionModify {}
+ public function arrayInsert(string $collection_field, string $expression_or_literal): CollectionModify {}
/**
* Bind a parameter to the placeholder in the search condition of the modify operation.
@@ -369,14 +366,14 @@ public function arrayInsert ( string $collection_field , string $expression_or_l
* @param array $placeholder_values
* @return \mysql_xdevapi\CollectionModify
*/
- public function bind ( array $placeholder_values ) : \mysql_xdevapi\CollectionModify {}
+ public function bind(array $placeholder_values): CollectionModify {}
/**
* The execute method is required to send the CRUD operation request to the MySQL server.
* @link https://www.php.net/manual/en/mysql-xdevapi-collectionmodify.execute.php
* @return \mysql_xdevapi\Result
*/
- public function execute () : \mysql_xdevapi\Result {}
+ public function execute(): Result {}
/**
* Limit the number of documents modified by this operation. Optionally combine with skip() to define an offset value.
@@ -384,7 +381,7 @@ public function execute () : \mysql_xdevapi\Result {}
* @param int $rows
* @return \mysql_xdevapi\CollectionModify
*/
- public function limit ( int $rows ) : \mysql_xdevapi\CollectionModify {}
+ public function limit(int $rows): CollectionModify {}
/**
* Takes a patch object and applies it on one or more documents, and can update multiple document properties.
@@ -392,7 +389,7 @@ public function limit ( int $rows ) : \mysql_xdevapi\CollectionModify {}
* @param string $document
* @return \mysql_xdevapi\CollectionModify
*/
- public function patch ( string $document ) : \mysql_xdevapi\CollectionModify {}
+ public function patch(string $document): CollectionModify {}
/**
* Replace (update) a given field value with a new one.
@@ -401,7 +398,7 @@ public function patch ( string $document ) : \mysql_xdevapi\CollectionModify {}
* @param string $expression_or_literal
* @return \mysql_xdevapi\CollectionModify
*/
- public function replace ( string $collection_field , string $expression_or_literal ) : \mysql_xdevapi\CollectionModify {}
+ public function replace(string $collection_field, string $expression_or_literal): CollectionModify {}
/**
* Sets or updates attributes on documents in a collection.
@@ -410,7 +407,7 @@ public function replace ( string $collection_field , string $expression_or_liter
* @param string $expression_or_literal
* @return \mysql_xdevapi\CollectionModify
*/
- public function set ( string $collection_field , string $expression_or_literal ) : \mysql_xdevapi\CollectionModify {}
+ public function set(string $collection_field, string $expression_or_literal): CollectionModify {}
/**
* Skip the first N elements that would otherwise be returned by a find operation. If the number of elements skipped is larger than the size of the result set, then the find operation returns an empty set.
@@ -418,7 +415,7 @@ public function set ( string $collection_field , string $expression_or_literal )
* @param int $position
* @return \mysql_xdevapi\CollectionModify
*/
- public function skip ( int $position ) : \mysql_xdevapi\CollectionModify {}
+ public function skip(int $position): CollectionModify {}
/**
* Sort the result set by the field selected in the sort_expr argument. The allowed orders are ASC (Ascending) or DESC (Descending). This operation is equivalent to the 'ORDER BY' SQL operation and it follows the same set of rules.
@@ -426,7 +423,7 @@ public function skip ( int $position ) : \mysql_xdevapi\CollectionModify {}
* @param string $sort_expr
* @return \mysql_xdevapi\CollectionModify
*/
- public function sort ( string $sort_expr ) : \mysql_xdevapi\CollectionModify {}
+ public function sort(string $sort_expr): CollectionModify {}
/**
* Removes attributes from documents in a collection.
@@ -434,14 +431,11 @@ public function sort ( string $sort_expr ) : \mysql_xdevapi\CollectionModify {}
* @param array $fields
* @return \mysql_xdevapi\CollectionModify
*/
- public function unset ( array $fields ) : \mysql_xdevapi\CollectionModify {}
+ public function unset(array $fields): CollectionModify {}
}
-
-
-
-class CollectionRemove implements \mysql_xdevapi\Executable, \mysql_xdevapi\CrudOperationBindable, \mysql_xdevapi\CrudOperationLimitable, \mysql_xdevapi\CrudOperationSortable {
-
+class CollectionRemove implements \mysql_xdevapi\Executable, \mysql_xdevapi\CrudOperationBindable, \mysql_xdevapi\CrudOperationLimitable, \mysql_xdevapi\CrudOperationSortable
+{
/**
* Bind a parameter to the placeholder in the search condition of the remove operation.
* The placeholder has the form of :NAME where ':' is a common prefix that must always exists before any NAME where NAME is the name of the placeholder. The bind method accepts a list of placeholders if multiple entities have to be substituted in the search condition of the remove operation.
@@ -449,14 +443,14 @@ class CollectionRemove implements \mysql_xdevapi\Executable, \mysql_xdevapi\Crud
* @param array $placeholder_values
* @return \mysql_xdevapi\CollectionRemove
*/
- public function bind ( array $placeholder_values ) : \mysql_xdevapi\CollectionRemove {}
+ public function bind(array $placeholder_values): CollectionRemove {}
/**
* The execute function needs to be invoked in order to trigger the client to send the CRUD operation request to the server.
* @link https://www.php.net/manual/en/mysql-xdevapi-collectionremove.execute.php
* @return \mysql_xdevapi\Result
*/
- public function execute () : \mysql_xdevapi\Result {}
+ public function execute(): Result {}
/**
* Sets the maximum number of documents to remove.
@@ -464,7 +458,7 @@ public function execute () : \mysql_xdevapi\Result {}
* @param int $rows
* @return \mysql_xdevapi\CollectionRemove
*/
- public function limit ( int $rows ) : \mysql_xdevapi\CollectionRemove {}
+ public function limit(int $rows): CollectionRemove {}
/**
* Sort the result set by the field selected in the sort_expr argument. The allowed orders are ASC (Ascending) or DESC (Descending). This operation is equivalent to the 'ORDER BY' SQL operation and it follows the same set of rules.
@@ -472,228 +466,227 @@ public function limit ( int $rows ) : \mysql_xdevapi\CollectionRemove {}
* @param string $sort_expr
* @return \mysql_xdevapi\CollectionRemove
*/
- public function sort ( string $sort_expr ) : \mysql_xdevapi\CollectionRemove {}
+ public function sort(string $sort_expr): CollectionRemove {}
}
-
/**
* Class ColumnResult
* @package mysql_xdevapi
*/
-class ColumnResult {
+class ColumnResult
+{
/**
* Get character set
* @link https://www.php.net/manual/en/mysql-xdevapi-columnresult.getcharactersetname.php
* @return string
*/
- public function getCharacterSetName () : string {}
+ public function getCharacterSetName(): string {}
/**
* Get collation name
* @link https://www.php.net/manual/en/mysql-xdevapi-columnresult.getcollationname.php
* @return string
*/
- public function getCollationName () : string {}
+ public function getCollationName(): string {}
/**
* Get column label
* @link https://www.php.net/manual/en/mysql-xdevapi-columnresult.getcolumnlabel.php
* @return string
*/
- public function getColumnLabel () : string {}
+ public function getColumnLabel(): string {}
/**
* Get column name
* @link https://www.php.net/manual/en/mysql-xdevapi-columnresult.getcolumnname.php
* @return string
*/
- public function getColumnName () : string {}
+ public function getColumnName(): string {}
/**
* Get fractional digit length
* @link https://www.php.net/manual/en/mysql-xdevapi-columnresult.getfractionaldigits.php
* @return int
*/
- public function getFractionalDigits () : int {}
+ public function getFractionalDigits(): int {}
/**
* Get column field length
* @link https://www.php.net/manual/en/mysql-xdevapi-columnresult.getlength.php
* @return int
*/
- public function getLength () : int {}
+ public function getLength(): int {}
/**
* Get schema name
* @link https://www.php.net/manual/en/mysql-xdevapi-columnresult.getschemaname.php
* @return string
*/
- public function getSchemaName () : string {}
+ public function getSchemaName(): string {}
/**
* Get table label
* @link https://www.php.net/manual/en/mysql-xdevapi-columnresult.gettablelabel.php
* @return string
*/
- public function getTableLabel () : string {}
+ public function getTableLabel(): string {}
/**
* Get table name
* @link https://www.php.net/manual/en/mysql-xdevapi-columnresult.gettablename.php
* @return string
*/
- public function getTableName () : string {}
+ public function getTableName(): string {}
/**
* Get column type
* @link https://www.php.net/manual/en/mysql-xdevapi-columnresult.gettype.php
* @return int
*/
- public function getType () : int {}
+ public function getType(): int {}
/**
* Check if signed type
* @link https://www.php.net/manual/en/mysql-xdevapi-columnresult.isnumbersigned.php
* @return int
*/
- public function isNumberSigned () : int {}
+ public function isNumberSigned(): int {}
/**
* Check if padded
* @link https://www.php.net/manual/en/mysql-xdevapi-columnresult.ispadded.php
* @return int
*/
- public function isPadded () : int {}
+ public function isPadded(): int {}
}
-
/**
* Interface CrudOperationBindable
* @link https://www.php.net/manual/en/class.mysql-xdevapi-crudoperationbindable.php
* @package mysql_xdevapi
*/
-interface CrudOperationBindable {
+interface CrudOperationBindable
+{
/**
* Binds a value to a specific placeholder.
* @link https://www.php.net/manual/en/mysql-xdevapi-crudoperationbindable.bind.php
* @param array $placeholder_values
* @return CrudOperationBindable
*/
- public function bind ( array $placeholder_values ) : \mysql_xdevapi\CrudOperationBindable;
+ public function bind(array $placeholder_values): CrudOperationBindable;
}
-
/**
* Interface CrudOperationLimitable
* @link https://www.php.net/manual/en/class.mysql-xdevapi-crudoperationlimitable.php
* @package mysql_xdevapi
*/
-interface CrudOperationLimitable {
+interface CrudOperationLimitable
+{
/**
* Set result limit
* @link https://www.php.net/manual/en/mysql-xdevapi-crudoperationlimitable.limit.php
* @param int $rows
* @return CrudOperationLimitable
*/
- public function limit ( int $rows ) : \mysql_xdevapi\CrudOperationLimitable;
+ public function limit(int $rows): CrudOperationLimitable;
}
-
/**
* Interface CrudOperationSkippable
* @link https://www.php.net/manual/en/class.mysql-xdevapi-crudoperationskippable.php
* @package mysql_xdevapi
*/
-interface CrudOperationSkippable {
+interface CrudOperationSkippable
+{
/**
* Number of operations to skip
* @link https://www.php.net/manual/en/mysql-xdevapi-crudoperationskippable.skip.php
* @param int $skip
* @return CrudOperationSkippable
*/
- public function skip ( int $skip ) : \mysql_xdevapi\CrudOperationSkippable;
+ public function skip(int $skip): CrudOperationSkippable;
}
-
-
/**
* Interface CrudOperationSortable
* @link https://www.php.net/manual/en/class.mysql-xdevapi-crudoperationsortable.php
* @package mysql_xdevapi
*/
-interface CrudOperationSortable {
+interface CrudOperationSortable
+{
/**
* Sort results
* @link https://www.php.net/manual/en/mysql-xdevapi-crudoperationsortable.sort.php
* @param string $sort_expr
* @return CrudOperationSortable
*/
- public function sort ( string $sort_expr ) : \mysql_xdevapi\CrudOperationSortable;
+ public function sort(string $sort_expr): CrudOperationSortable;
}
-
/**
* Interface DatabaseObject
* @link https://www.php.net/manual/en/class.mysql-xdevapi-databaseobject.php
* @package mysql_xdevapi
*/
-interface DatabaseObject {
+interface DatabaseObject
+{
/**
* Check if object exists in database
* @link https://www.php.net/manual/en/mysql-xdevapi-databaseobject.existsindatabase.php
* @return bool
*/
- public function existsInDatabase () : bool;
+ public function existsInDatabase(): bool;
/**
* Get object name
* @link https://www.php.net/manual/en/mysql-xdevapi-databaseobject.getname.php
* @return string
*/
- public function getName () : string;
+ public function getName(): string;
/**
* Get session name
* @link https://www.php.net/manual/en/mysql-xdevapi-databaseobject.getsession.php
* @return \mysql_xdevapi\Session
*/
- public function getSession () : \mysql_xdevapi\Session;
+ public function getSession(): Session;
}
-
/**
* Class DocResult
* @link https://www.php.net/manual/en/class.mysql-xdevapi-docresult.php
* @package mysql_xdevapi
*/
-class DocResult implements \mysql_xdevapi\BaseResult, \Traversable {
+class DocResult implements \mysql_xdevapi\BaseResult, \Traversable
+{
/**
* Get all rows
* @link https://www.php.net/manual/en/mysql-xdevapi-docresult.fetchall.php
* @return array
*/
- public function fetchAll () : array {}
+ public function fetchAll(): array {}
/**
* Fetch one result from a result set.
* @link https://www.php.net/manual/en/mysql-xdevapi-docresult.fetchone.php
* @return array
*/
- public function fetchOne () : array {}
+ public function fetchOne(): array {}
/**
* Fetches warnings generated by MySQL server's last operation.
* @link https://www.php.net/manual/en/mysql-xdevapi-docresult.getwarnings.php
* @return \mysql_xdevapi\Warning[]
*/
- public function getWarnings () : array {}
+ public function getWarnings(): array {}
/**
* Returns the number of warnings raised by the last operation. Specifically, these warnings are raised by the MySQL server.
* @link https://www.php.net/manual/en/mysql-xdevapi-docresult.getwarningscount.php
* @return int
*/
- public function getWarningsCount () : int {}
+ public function getWarningsCount(): int {}
}
/**
@@ -702,153 +695,151 @@ public function getWarningsCount () : int {}
*/
class Exception extends \RuntimeException implements \Throwable {}
-
/**
* Interface Executable
* @link https://www.php.net/manual/en/class.mysql-xdevapi-exception.php
* @package mysql_xdevapi
*/
-interface Executable {
+interface Executable
+{
/**
* Execute statement
* @link https://www.php.net/manual/en/class.mysql-xdevapi-executable.php
* @return Result
*/
- public function execute () : \mysql_xdevapi\Result;
+ public function execute(): Result;
}
-
/**
* Class ExecutionStatus
* @link https://www.php.net/manual/en/class.mysql-xdevapi-executionstatus.php
* @package mysql_xdevapi
*/
-class ExecutionStatus {
- public $affectedItems ;
- public $matchedItems ;
- public $foundItems ;
- public $lastInsertId ;
- public $lastDocumentId ;
+class ExecutionStatus
+{
+ public $affectedItems;
+ public $matchedItems;
+ public $foundItems;
+ public $lastInsertId;
+ public $lastDocumentId;
}
-
/**
* Class Expression
* @link https://www.php.net/manual/en/class.mysql-xdevapi-expression.php
* @package mysql_xdevapi
*/
-class Expression {
+class Expression
+{
/* Properties */
- public $name ;
+ public $name;
/* Constructor */
- public function __construct ( string $expression ) {}
+ public function __construct(string $expression) {}
}
-
/**
* Class Result
* @link https://www.php.net/manual/en/class.mysql-xdevapi-result.php
* @package mysql_xdevapi
*/
-class Result implements \mysql_xdevapi\BaseResult , \Traversable {
+class Result implements \mysql_xdevapi\BaseResult, \Traversable
+{
/**
* Get the last AUTO_INCREMENT value (last insert id).
* @link https://www.php.net/manual/en/mysql-xdevapi-result.getautoincrementvalue.php
* @return int
*/
- public function getAutoIncrementValue () : int {}
+ public function getAutoIncrementValue(): int {}
/**
* Fetch the generated _id values from the last operation. The unique _id field is generated by the MySQL server.
* @link https://www.php.net/manual/en/mysql-xdevapi-result.getgeneratedids.php
* @return string[]
*/
- public function getGeneratedIds () : array {}
-
+ public function getGeneratedIds(): array {}
/**
* Retrieve warnings from the last Result operation.
* @link https://www.php.net/manual/en/mysql-xdevapi-result.getwarnings.php
* @return \mysql_xdevapi\Warning[]
*/
- public function getWarnings () : array {}
+ public function getWarnings(): array {}
/**
* Retrieve the number of warnings from the last Result operation.
* @link https://www.php.net/manual/en/mysql-xdevapi-result.getwarningscount.php
* @return int
*/
- public function getWarningsCount () : int {}
+ public function getWarningsCount(): int {}
}
-
/**
* Class RowResult
* @link https://www.php.net/manual/en/class.mysql-xdevapi-rowresult.php
* @package mysql_xdevapi
*/
-class RowResult implements \mysql_xdevapi\BaseResult , \Traversable {
-
+class RowResult implements \mysql_xdevapi\BaseResult, \Traversable
+{
/**
* Fetch all the rows from the result set.
* @link https://www.php.net/manual/en/mysql-xdevapi-rowresult.fetchall.php
* @return array A numerical array with all results from the query; each result is an associative array. An empty array is returned if no rows are present.
*/
- public function fetchAll () : array {}
+ public function fetchAll(): array {}
/**
* Fetch one result from the result set.
* @link https://www.php.net/manual/en/mysql-xdevapi-rowresult.fetchone.php
* @return array The result, as an associative array or NULL if no results are present.
*/
- public function fetchOne () : array {}
+ public function fetchOne(): array {}
/**
* Retrieve the column count for columns present in the result set.
* @link https://www.php.net/manual/en/mysql-xdevapi-rowresult.getcolumncount.php
* @return int
*/
- public function getColumnsCount () : int {}
+ public function getColumnsCount(): int {}
/**
* Retrieve column names for columns present in the result set.
* @link https://www.php.net/manual/en/mysql-xdevapi-rowresult.getcolumnnames.php
* @return array
*/
- public function getColumnNames () : array {}
+ public function getColumnNames(): array {}
/**
* Retrieve column metadata for columns present in the result set.
* @link https://www.php.net/manual/en/mysql-xdevapi-rowresult.getcolumns.php
* @return \mysql_xdevapi\FieldMetadata[]
*/
- public function getColumns () : array {}
+ public function getColumns(): array {}
/**
* Retrieve warnings from the last RowResult operation.
* @link https://www.php.net/manual/en/mysql-xdevapi-rowresult.getwarnings.php
* @return \mysql_xdevapi\Warning[]
*/
- public function getWarnings () : array {}
+ public function getWarnings(): array {}
/**
* Retrieve the number of warnings from the last RowResult operation.
* @link https://www.php.net/manual/en/mysql-xdevapi-rowresult.getwarningscount.php
* @return int
*/
- public function getWarningsCount () : int {}
+ public function getWarningsCount(): int {}
}
-
/**
* Class Schema
* @link https://www.php.net/manual/en/class.mysql-xdevapi-schema.php
* @package mysql_xdevapi
*/
-class Schema implements \mysql_xdevapi\DatabaseObject {
+class Schema implements \mysql_xdevapi\DatabaseObject
+{
/* Properties */
- public $name ;
+ public $name;
/* Methods */
/**
@@ -857,7 +848,7 @@ class Schema implements \mysql_xdevapi\DatabaseObject {
* @param string $name
* @return \mysql_xdevapi\Collection
*/
- public function createCollection ( string $name ) : \mysql_xdevapi\Collection {}
+ public function createCollection(string $name): Collection {}
/**
* Drop collection from schema
@@ -865,7 +856,7 @@ public function createCollection ( string $name ) : \mysql_xdevapi\Collection {}
* @param string $collection_name
* @return bool
*/
- public function dropCollection ( string $collection_name ) : bool {}
+ public function dropCollection(string $collection_name): bool {}
/**
* Check if exists in database
@@ -873,7 +864,7 @@ public function dropCollection ( string $collection_name ) : bool {}
* @link https://www.php.net/manual/en/mysql-xdevapi-schema.existsindatabase.php
* @return bool
*/
- public function existsInDatabase () : bool {}
+ public function existsInDatabase(): bool {}
/**
* Get a collection from the schema.
@@ -881,7 +872,7 @@ public function existsInDatabase () : bool {}
* @param string $name
* @return \mysql_xdevapi\Collection
*/
- public function getCollection ( string $name ) : \mysql_xdevapi\Collection {}
+ public function getCollection(string $name): Collection {}
/**
* Get a collection, but as a Table object instead of a Collection object.
@@ -889,28 +880,28 @@ public function getCollection ( string $name ) : \mysql_xdevapi\Collection {}
* @param string $name
* @return \mysql_xdevapi\Table
*/
- public function getCollectionAsTable ( string $name ) : \mysql_xdevapi\Table {}
+ public function getCollectionAsTable(string $name): Table {}
/**
* Fetch a list of collections for this schema.
* @link https://www.php.net/manual/en/mysql-xdevapi-schema.getcollections.php
* @return \mysql_xdevapi\Collection[] Array of all collections in this schema, where each array element value is a Collection object with the collection name as the key.
*/
- public function getCollections () : array {}
+ public function getCollections(): array {}
/**
* Get the name of the schema.
* @link https://www.php.net/manual/en/mysql-xdevapi-schema.getname.php
* @return string
*/
- public function getName () : string {}
+ public function getName(): string {}
/**
* Get a new Session object from the Schema object.
* @link https://www.php.net/manual/en/mysql-xdevapi-schema.getsession.php
* @return \mysql_xdevapi\Session
*/
- public function getSession () : \mysql_xdevapi\Session {}
+ public function getSession(): Session {}
/**
* Fetch a Table object for the provided table in the schema.
@@ -918,49 +909,47 @@ public function getSession () : \mysql_xdevapi\Session {}
* @param string $name
* @return \mysql_xdevapi\Table
*/
- public function getTable ( string $name ) : \mysql_xdevapi\Table {}
+ public function getTable(string $name): Table {}
/**
* Get schema tables
* @link https://www.php.net/manual/en/mysql-xdevapi-schema.gettables.php
* @return \mysql_xdevapi\Table[] Array of all tables in this schema, where each array element value is a Table object with the table name as the key.
*/
- public function getTables () : array {}
+ public function getTables(): array {}
}
-
/**
* Interface SchemaObject
* @link https://www.php.net/manual/en/class.mysql-xdevapi-schemaobject.php
* @package mysql_xdevapi
*/
-interface SchemaObject extends \mysql_xdevapi\DatabaseObject {
+interface SchemaObject extends \mysql_xdevapi\DatabaseObject
+{
/* Methods */
- function getSchema () : \mysql_xdevapi\Schema;
+ public function getSchema(): Schema;
}
-
-
/**
* Class Session
* @link https://www.php.net/manual/en/class.mysql-xdevapi-session.php
* @package mysql_xdevapi
*/
-class Session {
-
+class Session
+{
/**
* Close the session with the server.
* @link https://www.php.net/manual/en/mysql-xdevapi-session.close.php
* @return bool
*/
- public function close () : bool {}
+ public function close(): bool {}
/**
* Commit the transaction.
* @link https://www.php.net/manual/en/mysql-xdevapi-session.commit.php
- * @return Object
+ * @return object
*/
- public function commit () : Object {}
+ public function commit(): object {}
/**
* Creates a new schema.
@@ -968,7 +957,7 @@ public function commit () : Object {}
* @param string $schema_name
* @return \mysql_xdevapi\Schema
*/
- public function createSchema ( string $schema_name ) : \mysql_xdevapi\Schema {}
+ public function createSchema(string $schema_name): Schema {}
/**
* Drop a schema (database).
@@ -976,14 +965,14 @@ public function createSchema ( string $schema_name ) : \mysql_xdevapi\Schema {}
* @param string $schema_name
* @return bool
*/
- public function dropSchema ( string $schema_name ) : bool {}
+ public function dropSchema(string $schema_name): bool {}
/**
* Generate a Universal Unique IDentifier (UUID) generated according to » RFC 4122.
* @link https://www.php.net/manual/en/mysql-xdevapi-session.generateuuid.php
* @return string
*/
- public function generateUUID () : string {}
+ public function generateUUID(): string {}
/**
* Get a new schema object
@@ -991,28 +980,28 @@ public function generateUUID () : string {}
* @param string $schema_name
* @return \mysql_xdevapi\Schema
*/
- public function getSchema ( string $schema_name ) : \mysql_xdevapi\Schema {}
+ public function getSchema(string $schema_name): Schema {}
/**
* Get schema objects for all schemas available to the session.
* @link https://www.php.net/manual/en/mysql-xdevapi-session.getschemas.php
* @return \mysql_xdevapi\Schema[]
*/
- public function getSchemas () : array {}
+ public function getSchemas(): array {}
/**
* Retrieve the MySQL server version for the session.
* @link https://www.php.net/manual/en/mysql-xdevapi-session.getserverversion.php
* @return int
*/
- public function getServerVersion () : int {}
+ public function getServerVersion(): int {}
/**
* Get a list of client connections to the session's MySQL server.
* @link https://www.php.net/manual/en/mysql-xdevapi-session.listclients.php
* @return array
*/
- public function listClients () : array {}
+ public function listClients(): array {}
/**
* Add quotes
@@ -1021,27 +1010,27 @@ public function listClients () : array {}
* @param string $name
* @return string
*/
- public function quoteName ( string $name ) : string {}
+ public function quoteName(string $name): string {}
/**
* Release a previously set savepoint.
* @link https://www.php.net/manual/en/mysql-xdevapi-session.releasesavepoint.php
* @param string $name
*/
- public function releaseSavepoint ( string $name ) : void {}
+ public function releaseSavepoint(string $name): void {}
/**
* Rollback the transaction.
* @link https://www.php.net/manual/en/mysql-xdevapi-session.rollback.php
*/
- public function rollback () : void {}
+ public function rollback(): void {}
/**
* Rollback transaction to savepoint
* @link https://www.php.net/manual/en/mysql-xdevapi-session.rollbackto.php
* @param string $name
*/
- public function rollbackTo ( string $name ) : void {}
+ public function rollbackTo(string $name): void {}
/**
* Create a new savepoint for the transaction.
@@ -1049,7 +1038,7 @@ public function rollbackTo ( string $name ) : void {}
* @param string $name
* @return string
*/
- public function setSavepoint (string $name ) : string {}
+ public function setSavepoint(string $name): string {}
/**
* Create a native SQL statement. Placeholders are supported using the native "?" syntax. Use the execute method to execute the SQL statement.
@@ -1057,28 +1046,28 @@ public function setSavepoint (string $name ) : string {}
* @param string $query
* @return SqlStatement
*/
- public function sql ( string $query ) : \mysql_xdevapi\SqlStatement {}
+ public function sql(string $query): SqlStatement {}
/**
* Start a new transaction.
* @link https://www.php.net/manual/en/mysql-xdevapi-session.starttransaction.php
*/
- public function startTransaction () : void {}
+ public function startTransaction(): void {}
}
-
/**
* Class SqlStatement
* @link https://www.php.net/manual/en/class.mysql-xdevapi-sqlstatement.php
* @package mysql_xdevapi
*/
-class SqlStatement {
+class SqlStatement
+{
/* Constants */
- const EXECUTE_ASYNC = 1 ;
- const BUFFERED = 2 ;
+ public const EXECUTE_ASYNC = 1;
+ public const BUFFERED = 2;
/* Properties */
- public $statement ;
+ public $statement;
/* Methods */
/**
@@ -1087,140 +1076,140 @@ class SqlStatement {
* @param string $param
* @return \mysql_xdevapi\SqlStatement
*/
- public function bind ( string $param ) : \mysql_xdevapi\SqlStatement {}
+ public function bind(string $param): SqlStatement {}
/**
* Execute the operation
* @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatement.execute.php
* @return \mysql_xdevapi\Result
*/
- public function execute () : \mysql_xdevapi\Result {}
+ public function execute(): Result {}
/**
* Get next result
* @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatement.getnextresult.php
* @return \mysql_xdevapi\Result
*/
- public function getNextResult () : \mysql_xdevapi\Result {}
+ public function getNextResult(): Result {}
/**
* Get result
* @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatement.getresult.php
* @return \mysql_xdevapi\Result
*/
- public function getResult () : \mysql_xdevapi\Result {}
+ public function getResult(): Result {}
/**
* Check for more results
* @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatement.hasmoreresults.php
* @return bool
*/
- public function hasMoreResults () : bool {}
+ public function hasMoreResults(): bool {}
}
-
/**
* Class SqlStatementResult
* @link https://www.php.net/manual/en/class.mysql-xdevapi-sqlstatementresult.php
* @package mysql_xdevapi
*/
-class SqlStatementResult implements \mysql_xdevapi\BaseResult , \Traversable {
+class SqlStatementResult implements \mysql_xdevapi\BaseResult, \Traversable
+{
/* Methods */
/**
* Fetch all the rows from the result set.
* @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatementresult.fetchall.php
* @return array
*/
- public function fetchAll () : array {}
+ public function fetchAll(): array {}
/**
* Fetch one row from the result set.
* @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatementresult.fetchone.php
* @return array
*/
- public function fetchOne () : array {}
+ public function fetchOne(): array {}
/**
* Get affected row count
* @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatementresult.getaffecteditemscount.php
* @return int
*/
- public function getAffectedItemsCount () : int {}
+ public function getAffectedItemsCount(): int {}
/**
* Get column count
* @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatementresult.getcolumncount.php
* @return int
*/
- public function getColumnsCount () : int {}
+ public function getColumnsCount(): int {}
/**
* Get column names
* @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatementresult.getcolumnnames.php
* @return array
*/
- public function getColumnNames () : array {}
+ public function getColumnNames(): array {}
/**
* Get columns
* @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatementresult.getcolumns.php
* @return array
*/
- public function getColumns () : array {}
+ public function getColumns(): array {}
/**
* Get generated ids
* @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatementresult.getgeneratedids.php
* @return array
*/
- public function getGeneratedIds () : array {}
+ public function getGeneratedIds(): array {}
/**
* Get last insert id
* @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatementresult.getlastinsertid.php
* @return string
*/
- public function getLastInsertId () : string {}
+ public function getLastInsertId(): string {}
/**
* Get warnings from last operation
* @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatementresult.getwarnings.php
* @return \mysql_xdevapi\Warning[]
*/
- public function getWarnings () : array {}
+ public function getWarnings(): array {}
/**
* Get warning count from last operation
* @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatementresult.getwarningcount.php
* @return int
*/
- public function getWarningCounts () : int {}
+ public function getWarningCounts(): int {}
/**
* Check if result has data
* @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatementresult.hasdata.php
* @return bool
*/
- public function hasData () : bool {}
+ public function hasData(): bool {}
/**
* Get next result
* @link https://www.php.net/manual/en/mysql-xdevapi-sqlstatementresult.nextresult.php
* @return \mysql_xdevapi\Result
*/
- public function nextResult () : \mysql_xdevapi\Result {}
+ public function nextResult(): Result {}
}
-
/**
* Class Statement
* @link https://www.php.net/manual/en/class.mysql-xdevapi-statement.php
* @package mysql_xdevapi
*/
-class Statement {
+class Statement
+{
/* Constants */
- const EXECUTE_ASYNC = 1 ;
- const BUFFERED = 2 ;
+ public const EXECUTE_ASYNC = 1;
+ public const BUFFERED = 2;
/* Methods */
/**
@@ -1228,33 +1217,32 @@ class Statement {
* @link https://www.php.net/manual/en/mysql-xdevapi-statement.getnextresult.php
* @return \mysql_xdevapi\Result
*/
- public function getNextResult () : \mysql_xdevapi\Result {}
+ public function getNextResult(): Result {}
/**
* Get result
* @link https://www.php.net/manual/en/mysql-xdevapi-statement.getresult.php
* @return Result
*/
- public function getResult () : \mysql_xdevapi\Result {}
+ public function getResult(): Result {}
/**
* Check if more results
* @link https://www.php.net/manual/en/mysql-xdevapi-statement.hasmoreresults.php
* @return bool
*/
- public function hasMoreResults () : bool {}
+ public function hasMoreResults(): bool {}
}
-
/**
* Class Table
* @link https://www.php.net/manual/en/class.mysql-xdevapi-table.php
* @package mysql_xdevapi
*/
-class Table implements \mysql_xdevapi\SchemaObject {
+class Table implements \mysql_xdevapi\SchemaObject
+{
/* Properties */
- public $name ;
-
+ public $name;
/* Methods */
/**
@@ -1262,42 +1250,42 @@ class Table implements \mysql_xdevapi\SchemaObject {
* @link https://www.php.net/manual/en/mysql-xdevapi-table.count.php
* @return int
*/
- public function count () : int {}
+ public function count(): int {}
/**
* Deletes rows from a table.
* @link https://www.php.net/manual/en/mysql-xdevapi-table.delete.php
* @return \mysql_xdevapi\TableDelete
*/
- public function delete () : \mysql_xdevapi\TableDelete {}
+ public function delete(): TableDelete {}
/**
* Verifies if this table exists in the database.
* @link https://www.php.net/manual/en/mysql-xdevapi-table.existsindatabase.php
* @return bool
*/
- public function existsInDatabase () : bool {}
+ public function existsInDatabase(): bool {}
/**
* Returns the name of this database object.
* @link https://www.php.net/manual/en/mysql-xdevapi-table.getname.php
* @return string
*/
- public function getName () : string {}
+ public function getName(): string {}
/**
* Fetch the schema associated with the table.
* @link https://www.php.net/manual/en/mysql-xdevapi-table.getschema.php
* @return \mysql_xdevapi\Schema
*/
- public function getSchema () : \mysql_xdevapi\Schema {}
+ public function getSchema(): Schema {}
/**
* Get session associated with the table.
* @link https://www.php.net/manual/en/mysql-xdevapi-table.getsession.php
* @return \mysql_xdevapi\Session
*/
- public function getSession () : \mysql_xdevapi\Session {}
+ public function getSession(): Session {}
/**
* Inserts rows into a table.
@@ -1306,14 +1294,14 @@ public function getSession () : \mysql_xdevapi\Session {}
* @param string|string[] ...$additionalColumns Additional columns definitions.
* @return \mysql_xdevapi\TableInsert
*/
- public function insert ( $columns, ...$additionalColumns ) : \mysql_xdevapi\TableInsert {}
+ public function insert($columns, ...$additionalColumns): TableInsert {}
/**
* Determine if the underlying object is a view or not.
* @link https://www.php.net/manual/en/mysql-xdevapi-table.isview.php
* @return bool
*/
- public function isView () : bool {}
+ public function isView(): bool {}
/**
* Fetches data from a table.
@@ -1322,23 +1310,23 @@ public function isView () : bool {}
* @param string|string[] ...$additionalColumns Additional columns parameter definitions.
* @return \mysql_xdevapi\TableSelect
*/
- public function select ( $columns, ...$additionalColumns ) : \mysql_xdevapi\TableSelect {}
+ public function select($columns, ...$additionalColumns): TableSelect {}
/**
* Updates columns in a table.
* @link https://www.php.net/manual/en/mysql-xdevapi-table.update.php
* @return \mysql_xdevapi\TableUpdate
*/
- public function update () : \mysql_xdevapi\TableUpdate {}
+ public function update(): TableUpdate {}
}
-
/**
* Class TableDelete
* @link https://www.php.net/manual/en/class.mysql-xdevapi-tabledelete.php
* @package mysql_xdevapi
*/
-class TableDelete implements \mysql_xdevapi\Executable {
+class TableDelete implements \mysql_xdevapi\Executable
+{
/* Methods */
/**
* Binds a value to a specific placeholder.
@@ -1346,14 +1334,14 @@ class TableDelete implements \mysql_xdevapi\Executable {
* @param array $placeholder_values
* @return \mysql_xdevapi\TableDelete
*/
- public function bind ( array $placeholder_values ) : \mysql_xdevapi\TableDelete {}
+ public function bind(array $placeholder_values): TableDelete {}
/**
* Execute the delete query.
* @link https://www.php.net/manual/en/mysql-xdevapi-tabledelete.execute.php
* @return \mysql_xdevapi\Result
*/
- public function execute () : \mysql_xdevapi\Result {}
+ public function execute(): Result {}
/**
* Sets the maximum number of records or documents to delete.
@@ -1361,7 +1349,7 @@ public function execute () : \mysql_xdevapi\Result {}
* @param int $rows
* @return \mysql_xdevapi\TableDelete
*/
- public function limit ( int $rows ) : \mysql_xdevapi\TableDelete {}
+ public function limit(int $rows): TableDelete {}
/**
* Set the order options for a result set.
@@ -1369,7 +1357,7 @@ public function limit ( int $rows ) : \mysql_xdevapi\TableDelete {}
* @param string $orderby_expr
* @return \mysql_xdevapi\TableDelete
*/
- public function orderby ( string $orderby_expr ) : \mysql_xdevapi\TableDelete {}
+ public function orderby(string $orderby_expr): TableDelete {}
/**
* Sets the search condition to filter.
@@ -1377,22 +1365,22 @@ public function orderby ( string $orderby_expr ) : \mysql_xdevapi\TableDelete {}
* @param string $where_expr
* @return \mysql_xdevapi\TableDelete
*/
- public function where ( string $where_expr ) : \mysql_xdevapi\TableDelete {}
+ public function where(string $where_expr): TableDelete {}
}
-
/**
* Class TableInsert
* @link https://www.php.net/manual/en/class.mysql-xdevapi-tableinsert.php
* @package mysql_xdevapi
*/
-class TableInsert implements \mysql_xdevapi\Executable {
+class TableInsert implements \mysql_xdevapi\Executable
+{
/**
* Execute the statement.
* @link https://www.php.net/manual/en/mysql-xdevapi-tableinsert.execute.php
* @return \mysql_xdevapi\Result
*/
- public function execute () : \mysql_xdevapi\Result {}
+ public function execute(): Result {}
/**
* Set the values to be inserted.
@@ -1400,30 +1388,30 @@ public function execute () : \mysql_xdevapi\Result {}
* @param array $row_values
* @return \mysql_xdevapi\TableInsert
*/
- public function values ( array $row_values ) : \mysql_xdevapi\TableInsert {}
+ public function values(array $row_values): TableInsert {}
}
-
/**
* Class TableSelect
* @link https://www.php.net/manual/en/class.mysql-xdevapi-tableselect.php
* @package mysql_xdevapi
*/
-class TableSelect implements \mysql_xdevapi\Executable {
+class TableSelect implements \mysql_xdevapi\Executable
+{
/**
* Binds a value to a specific placeholder.
* @link https://www.php.net/manual/en/mysql-xdevapi-tableselect.bind.php
* @param array $placeholder_values
* @return \mysql_xdevapi\TableSelect
*/
- public function bind ( array $placeholder_values ) : \mysql_xdevapi\TableSelect {}
+ public function bind(array $placeholder_values): TableSelect {}
/**
* Execute the select statement by chaining it with the execute() method.
* @link https://www.php.net/manual/en/mysql-xdevapi-tableselect.execute.php
* @return \mysql_xdevapi\RowResult
*/
- public function execute () : \mysql_xdevapi\RowResult {}
+ public function execute(): RowResult {}
/**
* Sets a grouping criteria for the result set.
@@ -1431,7 +1419,7 @@ public function execute () : \mysql_xdevapi\RowResult {}
* @param mixed $sort_expr
* @return \mysql_xdevapi\TableSelect
*/
- public function groupBy ($sort_expr ) : \mysql_xdevapi\TableSelect {}
+ public function groupBy($sort_expr): TableSelect {}
/**
* Sets a condition for records to consider in aggregate function operations.
@@ -1439,7 +1427,7 @@ public function groupBy ($sort_expr ) : \mysql_xdevapi\TableSelect {}
* @param string $sort_expr
* @return \mysql_xdevapi\TableSelect
*/
- public function having ( string $sort_expr ) : \mysql_xdevapi\TableSelect {}
+ public function having(string $sort_expr): TableSelect {}
/**
* Sets the maximum number of records or documents to return.
@@ -1447,7 +1435,7 @@ public function having ( string $sort_expr ) : \mysql_xdevapi\TableSelect {}
* @param int $rows
* @return \mysql_xdevapi\TableSelect
*/
- public function limit ( int $rows ) : \mysql_xdevapi\TableSelect {}
+ public function limit(int $rows): TableSelect {}
/**
* Execute a read operation with EXCLUSIVE LOCK. Only one lock can be active at a time.
@@ -1455,7 +1443,7 @@ public function limit ( int $rows ) : \mysql_xdevapi\TableSelect {}
* @param int|null $lock_waiting_option
* @return \mysql_xdevapi\TableSelect
*/
- public function lockExclusive (?int $lock_waiting_option ) : \mysql_xdevapi\TableSelect {}
+ public function lockExclusive(?int $lock_waiting_option): TableSelect {}
/**
* Execute a read operation with SHARED LOCK. Only one lock can be active at a time.
@@ -1463,7 +1451,7 @@ public function lockExclusive (?int $lock_waiting_option ) : \mysql_xdevapi\Tabl
* @param int|null $lock_waiting_option
* @return \mysql_xdevapi\TableSelect
*/
- public function lockShared (?int $lock_waiting_option ) : \mysql_xdevapi\TableSelect {}
+ public function lockShared(?int $lock_waiting_option): TableSelect {}
/**
* Skip given number of rows in result.
@@ -1471,7 +1459,7 @@ public function lockShared (?int $lock_waiting_option ) : \mysql_xdevapi\TableSe
* @param int $position
* @return \mysql_xdevapi\TableSelect
*/
- public function offset ( int $position ) : \mysql_xdevapi\TableSelect {}
+ public function offset(int $position): TableSelect {}
/**
* Sets the order by criteria.
@@ -1479,7 +1467,7 @@ public function offset ( int $position ) : \mysql_xdevapi\TableSelect {}
* @param string|string[] ...$sort_expr
* @return \mysql_xdevapi\TableSelect
*/
- public function orderby ( ...$sort_expr ) : \mysql_xdevapi\TableSelect {}
+ public function orderby(...$sort_expr): TableSelect {}
/**
* Sets the search condition to filter.
@@ -1487,30 +1475,30 @@ public function orderby ( ...$sort_expr ) : \mysql_xdevapi\TableSelect {}
* @param string $where_expr
* @return \mysql_xdevapi\TableSelect
*/
- public function where ( string $where_expr ) : \mysql_xdevapi\TableSelect {}
+ public function where(string $where_expr): TableSelect {}
}
-
/**
* Class TableUpdate
* @link https://www.php.net/manual/en/class.mysql-xdevapi-tableupdate.php
* @package mysql_xdevapi
*/
-class TableUpdate implements \mysql_xdevapi\Executable {
+class TableUpdate implements \mysql_xdevapi\Executable
+{
/**
* Bind update query parameters
* @link https://www.php.net/manual/en/mysql-xdevapi-tableupdate.bind.php
* @param array $placeholder_values The name of the placeholder, and the value to bind, defined as a JSON array.
* @return \mysql_xdevapi\TableUpdate
*/
- public function bind ( array $placeholder_values ) : \mysql_xdevapi\TableUpdate {}
+ public function bind(array $placeholder_values): TableUpdate {}
/**
* Executes the update statement.
* @link https://www.php.net/manual/en/mysql-xdevapi-tableupdate.execute.php
* @return \mysql_xdevapi\TableUpdate
*/
- public function execute () : \mysql_xdevapi\TableUpdate {}
+ public function execute(): TableUpdate {}
/**
* Set the maximum number of records or documents update.
@@ -1518,7 +1506,7 @@ public function execute () : \mysql_xdevapi\TableUpdate {}
* @param int $rows
* @return \mysql_xdevapi\TableUpdate
*/
- public function limit ( int $rows ) : \mysql_xdevapi\TableUpdate {}
+ public function limit(int $rows): TableUpdate {}
/**
* Sets the sorting criteria.
@@ -1526,7 +1514,7 @@ public function limit ( int $rows ) : \mysql_xdevapi\TableUpdate {}
* @param ?string|?string[] ...$orderby_expr The expressions that define the order by criteria. Can be an array with one or more expressions, or a string.
* @return \mysql_xdevapi\TableUpdate
*/
- public function orderby ( ...$orderby_expr) : \mysql_xdevapi\TableUpdate {}
+ public function orderby(...$orderby_expr): TableUpdate {}
/**
* Updates the column value on records in a table.
@@ -1535,7 +1523,7 @@ public function orderby ( ...$orderby_expr) : \mysql_xdevapi\TableUpdate {}
* @param string $expression_or_literal
* @return \mysql_xdevapi\TableUpdate
*/
- public function set ( string $table_field , string $expression_or_literal ) : \mysql_xdevapi\TableUpdate {}
+ public function set(string $table_field, string $expression_or_literal): TableUpdate {}
/**
* Set the search condition to filter.
@@ -1543,26 +1531,25 @@ public function set ( string $table_field , string $expression_or_literal ) : \m
* @param string $where_expr
* @return \mysql_xdevapi\TableUpdate
*/
- public function where ( string $where_expr ) : \mysql_xdevapi\TableUpdate {}
+ public function where(string $where_expr): TableUpdate {}
}
-
/**
* Class Warning
* @link https://www.php.net/manual/en/class.mysql-xdevapi-warning.php
* @package mysql_xdevapi
*/
-class Warning {
+class Warning
+{
/* Properties */
- public $message ;
- public $level ;
- public $code ;
+ public $message;
+ public $level;
+ public $code;
/* Constructor */
- private function __construct () {}
+ private function __construct() {}
}
-
/**
* Class XSession
* @link https://www.php.net/manual/en/class.mysql-xdevapi-xsession.php
diff --git a/mysqli/mysqli.php b/mysqli/mysqli.php
index bddd22286..0817113fc 100644
--- a/mysqli/mysqli.php
+++ b/mysqli/mysqli.php
@@ -10,1468 +10,1466 @@
/**
* mysqli_sql_exception
*/
-class mysqli_sql_exception extends RuntimeException {
- /**
- * The sql state with the error.
+class mysqli_sql_exception extends RuntimeException
+{
+ /**
+ * The sql state with the error.
+ *
+ * @var string
+ */
+ protected $sqlstate;
+
+ /**
+ * The error code
*
+ * @var int
+ */
+ protected $code;
+}
+
+/**
+ * MySQLi Driver.
+ * @link https://php.net/manual/en/class.mysqli-driver.php
+ */
+final class mysqli_driver
+{
+ /**
+ * @var string
+ */
+ public $client_info;
+ /**
+ * @var string
+ */
+ public $client_version;
+ /**
+ * @var string
+ */
+ public $driver_version;
+ /**
+ * @var string
+ */
+ public $embedded;
+ /**
+ * @var bool
+ */
+ public $reconnect;
+ /**
+ * @var int
+ */
+ public $report_mode;
+}
+
+/**
+ * Represents a connection between PHP and a MySQL database.
+ * @link https://php.net/manual/en/class.mysqli.php
+ */
+class mysqli
+{
+ /**
+ * @var int
+ */
+ public $affected_rows;
+ /**
+ * @var string
+ */
+ public $client_info;
+ /**
+ * @var int
+ */
+ public $client_version;
+ /**
+ * @var int
+ */
+ public $connect_errno;
+ /**
+ * @var string
+ */
+ public $connect_error;
+ /**
+ * @var int
+ */
+ public $errno;
+ /**
+ * @var string
+ */
+ public $error;
+ /**
+ * @var int
+ */
+ public $field_count;
+ /**
+ * @var string
+ */
+ public $host_info;
+ /**
+ * @var string
+ */
+ public $info;
+ /**
+ * @var int|string
+ */
+ public $insert_id;
+ /**
+ * @var string
+ */
+ public $server_info;
+ /**
+ * @var int
+ */
+ public $server_version;
+ /**
+ * @var string
+ */
+ public $sqlstate;
+ /**
+ * @var string
+ */
+ public $protocol_version;
+ /**
+ * @var int
+ */
+ public $thread_id;
+ /**
+ * @var int
+ */
+ public $warning_count;
+
+ /**
+ * @var array A list of errors, each as an associative array containing the errno, error, and sqlstate.
+ * @link https://secure.php.net/manual/en/mysqli.error-list.php
+ */
+ public $error_list;
+
+ /**
+ * Open a new connection to the MySQL server
+ * @link https://php.net/manual/en/mysqli.construct.php
+ * @param string $hostname [optional] Can be either a host name or an IP address. Passing the NULL value or the string "localhost" to this parameter, the local host is assumed. When possible, pipes will be used instead of the TCP/IP protocol. Prepending host by p: opens a persistent connection. mysqli_change_user() is automatically called on connections opened from the connection pool. Defaults to ini_get("mysqli.default_host")
+ * @param string $username [optional] The MySQL user name. Defaults to ini_get("mysqli.default_user")
+ * @param string $password [optional] If not provided or NULL, the MySQL server will attempt to authenticate the user against those user records which have no password only. This allows one username to be used with different permissions (depending on if a password as provided or not). Defaults to ini_get("mysqli.default_pw")
+ * @param string $database [optional] If provided will specify the default database to be used when performing queries. Defaults to ""
+ * @param int $port [optional] Specifies the port number to attempt to connect to the MySQL server. Defaults to ini_get("mysqli.default_port")
+ * @param string $socket [optional] Specifies the socket or named pipe that should be used. Defaults to ini_get("mysqli.default_socket")
+ */
+ public function __construct(
+ $hostname = null,
+ $username = null,
+ $password = null,
+ $database = null,
+ $port = null,
+ $socket = null
+ ) {}
+
+ /**
+ * Turns on or off auto-committing database modifications
+ * @link https://php.net/manual/en/mysqli.autocommit.php
+ * @param bool $enable
+ * Whether to turn on auto-commit or not. + *
+ * @return bool true on success or false on failure. + */ + public function autocommit($enable) {} + + /** + * Starts a transaction + * @link https://secure.php.net/manual/en/mysqli.begin-transaction.php + * @param int $flags [optional] + * @param string $name [optional] + * @return bool true on success or false on failure. + * @since 5.5 + */ + public function begin_transaction($flags = 0, $name = null) {} + + /** + * Changes the user of the specified database connection + * @link https://php.net/manual/en/mysqli.change-user.php + * @param string $username+ * The MySQL user name. + *
+ * @param string $password+ * The MySQL password. + *
+ * @param string $database+ * The database to change to. + *
+ *+ * If desired, the null value may be passed resulting in only changing + * the user and not selecting a database. To select a database in this + * case use the mysqli_select_db function. + *
+ * @return bool true on success or false on failure. + */ + public function change_user($username, $password, $database) {} + + /** + * Returns the default character set for the database connection + * @link https://php.net/manual/en/mysqli.character-set-name.php + * @return string The default character set for the current connection + */ + public function character_set_name() {} + + /** + * @removed 5.4 + */ + #[Deprecated(since: '5.3')] + public function client_encoding() {} + + /** + * Closes a previously opened database connection + * @link https://php.net/manual/en/mysqli.close.php + * @return bool true on success or false on failure. + */ + public function close() {} + + /** + * Commits the current transaction + * @link https://php.net/manual/en/mysqli.commit.php + * @param int $flags A bitmask of MYSQLI_TRANS_COR_* constants. + * @param string $name If provided then COMMIT $name is executed. + * @return bool true on success or false on failure. + */ + public function commit($flags = -1, $name = null) {} + + /** + * @link https://php.net/manual/en/function.mysqli-connect.php + * @param string $hostname [optional] + * @param string $username [optional] + * @param string $password [optional] + * @param string $database [optional] + * @param int $port [optional] + * @param string $socket [optional] + */ + public function connect($hostname = null, $username = null, $password = null, $database = null, $port = null, $socket = null) {} + + /** + * Dump debugging information into the log + * @link https://php.net/manual/en/mysqli.dump-debug-info.php + * @return bool true on success or false on failure. + */ + public function dump_debug_info() {} + + /** + * Performs debugging operations + * @link https://php.net/manual/en/mysqli.debug.php + * @param string $options+ * A string representing the debugging operation to perform + *
+ * @return bool true. + */ + public function debug($options) {} + + /** + * Returns a character set object + * @link https://php.net/manual/en/mysqli.get-charset.php + * @return object 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 (?)
+ */ + public function get_charset() {} + + /** + * Returns the MySQL client version as a string + * @link https://php.net/manual/en/mysqli.get-client-info.php + * @return string A string that represents the MySQL client library version + */ + public function get_client_info() {} + + /** + * Returns statistics about the client connection + * @link https://php.net/manual/en/mysqli.get-connection-stats.php + * @return array|false an array with connection stats if success, false otherwise. + */ + public function get_connection_stats() {} + + /** + * An undocumented function equivalent to the $server_info property + * @link https://php.net/manual/en/mysqli.get-server-info.php + * @return string A character string representing the server version. + */ + public function get_server_info() {} + + /** + * Get result of SHOW WARNINGS + * @link https://php.net/manual/en/mysqli.get-warnings.php + * @return mysqli_warning + */ + public function get_warnings() {} + + /** + * Initializes MySQLi and returns a resource for use with mysqli_real_connect() + * @link https://php.net/manual/en/mysqli.init.php + * @return mysqli an object. + */ + public function init() {} + + /** + * Asks the server to kill a MySQL thread + * @link https://php.net/manual/en/mysqli.kill.php + * @param int $process_id + * @return bool true on success or false on failure. + */ + public function kill($process_id) {} + + /** + * Performs a query on the database + * @link https://php.net/manual/en/mysqli.multi-query.php + * @param string $query+ * The query, as a string. + *
+ *+ * Data inside the query should be properly escaped. + *
+ * @return bool false if the first statement failed. + * To retrieve subsequent errors from other statements you have to call + * mysqli_next_result first. + */ + public function multi_query($query) {} + + /** + * @link https://php.net/manual/en/mysqli.construct.php + * @param string $host [optional] + * @param string $username [optional] + * @param string $password [optional] + * @param string $database [optional] + * @param int $port [optional] + * @param string $socket [optional] + * + * @removed 8.0 + */ + public function mysqli($host = null, $username = null, $password = null, $database = null, $port = null, $socket = null) {} + + /** + * Check if there are any more query results from a multi query + * @link https://php.net/manual/en/mysqli.more-results.php + * @return bool true on success or false on failure. + */ + public function more_results() {} + + /** + * Prepare next result from multi_query + * @link https://php.net/manual/en/mysqli.next-result.php + * @return bool true on success or false on failure. + */ + public function next_result() {} + + /** + * Set options + * @link https://php.net/manual/en/mysqli.options.php + * @param int $option+ * The option that you want to set. It can be one of the following values: + *
| Name | + *Description | + *
| MYSQLI_OPT_CONNECT_TIMEOUT | + *connection timeout in seconds (supported on Windows with TCP/IP since PHP 5.3.1) | + *
| MYSQLI_OPT_LOCAL_INFILE | + *enable/disable use of LOAD LOCAL INFILE | + *
| MYSQLI_INIT_COMMAND | + *command to execute after when connecting to MySQL server | + *
| MYSQLI_READ_DEFAULT_FILE | + *+ * Read options from named option file instead of my.cnf + * | + *
| MYSQLI_READ_DEFAULT_GROUP | + *+ * Read options from the named group from my.cnf + * or the file specified with MYSQL_READ_DEFAULT_FILE + * | + *
| MYSQLI_SERVER_PUBLIC_KEY | + *+ * RSA public key file used with the SHA-256 based authentication. + * | + *
+ * The value for the option. + *
+ * @return bool true on success or false on failure. + */ + public function options($option, $value) {} + + /** + * Pings a server connection, or tries to reconnect if the connection has gone down + * @link https://php.net/manual/en/mysqli.ping.php + * @return bool true on success or false on failure. + */ + public function ping() {} + + /** + * Prepare an SQL statement for execution + * @link https://php.net/manual/en/mysqli.prepare.php + * @param string $query+ * The query, as a string. + *
+ *+ * You should not add a terminating semicolon or \g + * to the statement. + *
+ *+ * This parameter can include one or more parameter markers in the SQL + * statement by embedding question mark (?) characters + * at the appropriate positions. + *
+ *+ * The markers are legal only in certain places in SQL statements. + * For example, they are allowed in the VALUES() + * list of an INSERT statement (to specify column + * values for a row), or in a comparison with a column in a + * WHERE clause to specify a comparison value. + *
+ *+ * However, they are not allowed for identifiers (such as table or + * column names), in the select list that names the columns to be + * returned by a SELECT statement, or to specify both + * operands of a binary operator such as the = equal + * sign. The latter restriction is necessary because it would be + * impossible to determine the parameter type. It's not allowed to + * compare marker with NULL by + * ? IS NULL too. In general, parameters are legal + * only in Data Manipulation Language (DML) statements, and not in Data + * Definition Language (DDL) statements. + *
+ * @return mysqli_stmt|false mysqli_prepare returns a statement object or false if an error occurred. + */ + public function prepare($query) {} + + /** + * Performs a query on the database + * @link https://php.net/manual/en/mysqli.query.php + * @param string $query+ * The query string. + *
+ *+ * Data inside the query should be properly escaped. + *
+ * @param int $result_mode [optional]+ * Either the constant MYSQLI_USE_RESULT or + * MYSQLI_STORE_RESULT depending on the desired + * behavior. By default, MYSQLI_STORE_RESULT is used. + *
+ *+ * If you use MYSQLI_USE_RESULT all subsequent calls + * will return error Commands out of sync unless you + * call mysqli_free_result + *
+ *+ * With MYSQLI_ASYNC (available with mysqlnd), it is + * possible to perform query asynchronously. + * mysqli_poll is then used to get results from such + * queries. + *
+ * @return mysqli_result|bool For successful SELECT, SHOW, DESCRIBE or + * EXPLAIN queries mysqli_query will return + * a mysqli_result object. For other successful queries mysqli_query will + * return true and false on failure. + */ + public function query($query, $result_mode = MYSQLI_STORE_RESULT) {} + + /** + * Opens a connection to a mysql server + * @link https://php.net/manual/en/mysqli.real-connect.php + * @param string $hostname [optional]+ * Can be either a host name or an IP address. Passing the null value + * or the string "localhost" to this parameter, the local host is + * assumed. When possible, pipes will be used instead of the TCP/IP + * protocol. + *
+ * @param string $username [optional]+ * The MySQL user name. + *
+ * @param string $password [optional]+ * If provided or null, the MySQL server will attempt to authenticate + * the user against those user records which have no password only. This + * allows one username to be used with different permissions (depending + * on if a password as provided or not). + *
+ * @param string $database [optional]+ * If provided will specify the default database to be used when + * performing queries. + *
+ * @param int $port [optional]+ * Specifies the port number to attempt to connect to the MySQL server. + *
+ * @param string $socket [optional]+ * Specifies the socket or named pipe that should be used. + *
+ *+ * Specifying the socket parameter will not + * explicitly determine the type of connection to be used when + * connecting to the MySQL server. How the connection is made to the + * MySQL database is determined by the host + * parameter. + *
+ * @param int $flags [optional]+ * With the parameter flags you can set different + * connection options: + *
+ *| Name | + *Description | + *
| MYSQLI_CLIENT_COMPRESS | + *Use compression protocol | + *
| MYSQLI_CLIENT_FOUND_ROWS | + *return number of matched rows, not the number of affected rows | + *
| MYSQLI_CLIENT_IGNORE_SPACE | + *Allow spaces after function names. Makes all function names reserved words. | + *
| MYSQLI_CLIENT_INTERACTIVE | + *+ * Allow interactive_timeout seconds (instead of + * wait_timeout seconds) of inactivity before closing the connection + * | + *
| MYSQLI_CLIENT_SSL | + *Use SSL (encryption) | + *
+ * For security reasons the MULTI_STATEMENT flag is + * not supported in PHP. If you want to execute multiple queries use the + * mysqli_multi_query function. + *
+ * @return bool true on success or false on failure. + */ + public function real_connect($hostname = null, $username = null, $password = null, $database = null, $port = null, $socket = null, $flags = null) {} + + /** + * Escapes special characters in a string for use in an SQL statement, taking into account the current charset of the connection + * @link https://php.net/manual/en/mysqli.real-escape-string.php + * @param string $string+ * The string to be escaped. + *
+ *+ * Characters encoded are NUL (ASCII 0), \n, \r, \, ', ", and + * Control-Z. + *
+ * @return string an escaped string. + */ + public function real_escape_string($string) {} + + /** + * Poll connections + * @link https://php.net/manual/en/mysqli.poll.php + * @param array &$read+ *
+ * @param array &$error+ *
+ * @param array &$reject+ *
+ * @param int $seconds+ * Number of seconds to wait, must be non-negative. + *
+ * @param int $microseconds [optional]+ * Number of microseconds to wait, must be non-negative. + *
+ * @return int|false number of ready connections in success, false otherwise. + */ + public static function poll(array &$read, array &$error, array &$reject, $seconds, $microseconds = 0) {} + + /** + * Get result from async query + * @link https://php.net/manual/en/mysqli.reap-async-query.php + * @return mysqli_result|false mysqli_result in success, false otherwise. + */ + public function reap_async_query() {} + + /** + * Escapes special characters in a string for use in an SQL statement, taking into account the current charset of the connection + * @param string $string The string to be escaped. + * Characters encoded are NUL (ASCII 0), \n, \r, \, ', ", and Control-Z. + * @return string + * @link https://secure.php.net/manual/en/mysqli.real-escape-string.php + */ + public function escape_string($string) {} + + /** + * Execute an SQL query + * @link https://php.net/manual/en/mysqli.real-query.php + * @param string $query+ * The query, as a string. + *
+ *+ * Data inside the query should be properly escaped. + *
+ * @return bool true on success or false on failure. + */ + public function real_query($query) {} + + /** + * Execute an SQL query + * @link https://php.net/manual/en/mysqli.release-savepoint.php + * @param string $name + * @return bool Returns TRUE on success or FALSE on failure. + * @since 5.5 + */ + public function release_savepoint($name) {} + + /** + * Rolls back current transaction + * @link https://php.net/manual/en/mysqli.rollback.php + * @param int $flags [optional] A bitmask of MYSQLI_TRANS_COR_* constants. + * @param string $name [optional] If provided then ROLLBACK $name is executed. + * @return bool true on success or false on failure. + * @since 5.5 Added flags and name parameters. + */ + public function rollback($flags = 0, $name = null) {} + + /** + * Set a named transaction savepoint + * @link https://secure.php.net/manual/en/mysqli.savepoint.php + * @param string $name + * @return bool Returns TRUE on success or FALSE on failure. + * @since 5.5 + */ + public function savepoint($name) {} + + /** + * Selects the default database for database queries + * @link https://php.net/manual/en/mysqli.select-db.php + * @param string $database+ * The database name. + *
+ * @return bool true on success or false on failure. + */ + public function select_db($database) {} + + /** + * Sets the default client character set + * @link https://php.net/manual/en/mysqli.set-charset.php + * @param string $charset+ * The charset to be set as default. + *
+ * @return bool true on success or false on failure..5 + */ + public function set_charset($charset) {} + + /** + * @link https://php.net/manual/en/function.mysqli-set-opt + * @param int $option + * @param mixed $value + */ + public function set_opt($option, $value) {} + + /** + * Used for establishing secure connections using SSL + * @link https://secure.php.net/manual/en/mysqli.ssl-set.php + * @param string $key+ * The path name to the key file. + *
+ * @param string $certificate+ * The path name to the certificate file. + *
+ * @param string $ca_certificate+ * The path name to the certificate authority file. + *
+ * @param string $ca_path+ * The pathname to a directory that contains trusted SSL CA certificates in PEM format. + *
+ * @param string $cipher_algos+ * A list of allowable ciphers to use for SSL encryption. + *
+ * @return bool This function always returns TRUE value. + */ + public function ssl_set($key, $certificate, $ca_certificate, $ca_path, $cipher_algos) {} + + /** + * Gets the current system status + * @link https://php.net/manual/en/mysqli.stat.php + * @return string|false A string describing the server status. false if an error occurred. + */ + public function stat() {} + + /** + * Initializes a statement and returns an object for use with mysqli_stmt_prepare + * @link https://php.net/manual/en/mysqli.stmt-init.php + * @return mysqli_stmt an object. + */ + public function stmt_init() {} + + /** + * Transfers a result set from the last query + * @link https://php.net/manual/en/mysqli.store-result.php + * @param int $mode [optional] The option that you want to set + * @return mysqli_result|false 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. + */ + public function store_result($mode = null) {} + + /** + * Returns whether thread safety is given or not + * @link https://php.net/manual/en/mysqli.thread-safe.php + * @return bool true if the client library is thread-safe, otherwise false. + */ + public function thread_safe() {} + + /** + * Initiate a result set retrieval + * @link https://php.net/manual/en/mysqli.use-result.php + * @return mysqli_result|false an unbuffered result object or false if an error occurred. + */ + public function use_result() {} + + /** + * @link https://php.net/manual/en/mysqli.refresh + * @param int $flags MYSQLI_REFRESH_* + * @return bool TRUE if the refresh was a success, otherwise FALSE + * @since 5.3 + */ + public function refresh($flags) {} +} + +/** + * Represents one or more MySQL warnings. + * @link https://php.net/manual/en/class.mysqli-warning.php + */ +final class mysqli_warning +{ + /** * @var string - */ - protected $sqlstate; + */ + public $message; + /** + * @var string + */ + public $sqlstate; + /** + * @var int + */ + public $errno; + + /** + * The __construct purpose + * @link https://php.net/manual/en/mysqli-warning.construct.php + */ + private function __construct() {} + + /** + * Move to the next warning + * @link https://php.net/manual/en/mysqli-warning.next.php + * @return bool True if it successfully moved to the next warning + */ + public function next() {} +} + +/** + * Represents the result set obtained from a query against the database. + * Implements Traversable since 5.4 + * @link https://php.net/manual/en/class.mysqli-result.php + */ +class mysqli_result implements IteratorAggregate +{ + /** + * @var int + */ + public $current_field; + /** + * @var int + */ + public $field_count; + /** + * @var array + */ + public $lengths; + /** + * @var int + */ + public $num_rows; + /** + * @var mixed + */ + public $type; + + /** + * Constructor (no docs available) + * @param object $mysql [optional] + * @param int $result_mode [optional] + */ + public function __construct($mysql = null, $result_mode = 0) {} + + /** + * Frees the memory associated with a result + * @return void + * @link https://php.net/manual/en/mysqli-result.free.php + */ + public function close() {} + + /** + * Frees the memory associated with a result + * @link https://php.net/manual/en/mysqli-result.free.php + * @return void + */ + public function free() {} + + /** + * Adjusts the result pointer to an arbitrary row in the result + * @link https://php.net/manual/en/mysqli-result.data-seek.php + * @param int $offset
+ * The field offset. Must be between zero and the total number of rows + * minus one (0..mysqli_num_rows - 1). + *
+ * @return bool true on success or false on failure. + */ + public function data_seek($offset) {} + + /** + * Returns the next field in the result set + * @link https://php.net/manual/en/mysqli-result.fetch-field.php + * @return object|false 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 | + *Database (since PHP 5.3.6) | + *
| catalog | + *The catalog name, always "def" (since PHP 5.3.6) | + *
| 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 | + *
| def | + *The default value for this field, represented as a string | + *
| 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) | + *
+ * The field number. This value must be in the range from + * 0 to number of fields - 1. + *
+ * @return object|false an object which contains field definition information or false + * if no field information for specified fieldnr is + * available. + * + *+ *
| 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. | + *
| 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) | + *
+ * This optional parameter is a constant indicating what type of array + * should be produced from the current row data. The possible values for + * this parameter are the constants MYSQLI_ASSOC, + * MYSQLI_NUM, or MYSQLI_BOTH. + *
+ * @return mixed an array of associative or numeric arrays holding result rows. + */ + public function fetch_all($mode = MYSQLI_NUM) {} + + /** + * Fetch a result row as an associative, a numeric array, or both + * @link https://php.net/manual/en/mysqli-result.fetch-array.php + * @param int $mode [optional]+ * This optional parameter is a constant indicating what type of array + * should be produced from the current row data. The possible values for + * this parameter are the constants MYSQLI_ASSOC, + * MYSQLI_NUM, or MYSQLI_BOTH. + *
+ *+ * By using the MYSQLI_ASSOC constant this function + * will behave identically to the mysqli_fetch_assoc, + * while MYSQLI_NUM will behave identically to the + * mysqli_fetch_row function. The final option + * MYSQLI_BOTH will create a single array with the + * attributes of both. + *
+ * @return mixed an array of strings that corresponds to the fetched row or null if there + * are no more rows in resultset. + */ + public function fetch_array($mode = MYSQLI_BOTH) {} + + /** + * Fetch a result row as an associative array + * @link https://php.net/manual/en/mysqli-result.fetch-assoc.php + * @return array|null an associative array of strings representing the fetched row in the result + * set, where each key in the array represents the name of one of the result + * set's columns or null if there are no more rows in resultset. + * + *+ * If two or more columns of the result have the same field names, the last + * column will take precedence. To access the other column(s) of the same + * name, you either need to access the result with numeric indices by using + * mysqli_fetch_row or add alias names. + */ + public function fetch_assoc() {} + + /** + * Returns the current row of a result set as an object + * @link https://php.net/manual/en/mysqli-result.fetch-object.php + * @param string $class [optional]
+ * The name of the class to instantiate, set the properties of and return. + * If not specified, a stdClass object is returned. + *
+ * @param null|array $constructor_args [optional]+ * An optional array of parameters to pass to the constructor + * for class_name objects. + *
+ * @return stdClass|object an object with string properties that corresponds to the fetched + * row or null if there are no more rows in resultset. + */ + public function fetch_object($class = 'stdClass', array $constructor_args = null) {} + + /** + * Get a result row as an enumerated array + * @link https://php.net/manual/en/mysqli-result.fetch-row.php + * @return array|null mysqli_fetch_row returns an array of strings that corresponds to the fetched row + * or null if there are no more rows in result set. + */ + public function fetch_row() {} + + /** + * Set result pointer to a specified field offset + * @link https://php.net/manual/en/mysqli-result.field-seek.php + * @param int $index+ * The field number. This value must be in the range from + * 0 to number of fields - 1. + *
+ * @return bool true on success or false on failure. + */ + public function field_seek($index) {} + + /** + * Frees the memory associated with a result + * @return void + * @link https://php.net/manual/en/mysqli-result.free.php + */ + public function free_result() {} + /** + * @since 8.0 + * @return Traversable + */ + public function getIterator() {} } /** - * Represents a connection between PHP and a MySQL database. - * @link https://php.net/manual/en/class.mysqli.php + * Represents a prepared statement. + * @link https://php.net/manual/en/class.mysqli-stmt.php */ -class mysqli { - /** - * @var int - */ - public $affected_rows; - /** - * @var string - */ - public $client_info; - /** - * @var int - */ - public $client_version; - /** - * @var int - */ - public $connect_errno; - /** - * @var string - */ - public $connect_error; - /** - * @var int - */ - public $errno; - /** - * @var string - */ - public $error; - /** - * @var int - */ - public $field_count; - /** - * @var string - */ - public $host_info; - /** - * @var string - */ - public $info; - /** - * @var int|string - */ - public $insert_id; - /** - * @var string - */ - public $server_info; - /** - * @var int - */ - public $server_version; - /** - * @var string - */ - public $sqlstate; - /** - * @var string - */ - public $protocol_version; - /** - * @var int - */ - public $thread_id; - /** - * @var int - */ - public $warning_count; - +class mysqli_stmt +{ /** - * @var array A list of errors, each as an associative array containing the errno, error, and sqlstate. - * @link https://secure.php.net/manual/en/mysqli.error-list.php + * @var int + */ + public $affected_rows; + /** + * @var int + */ + public $insert_id; + /** + * @var int + */ + public $num_rows; + /** + * @var int + */ + public $param_count; + /** + * @var int + */ + public $field_count; + /** + * @var int + */ + public $errno; + /** + * @var string + */ + public $error; + /** + * @var array */ public $error_list; + /** + * @var string + */ + public $sqlstate; + /** + * @var string + */ + public $id; - - /** - * Open a new connection to the MySQL server - * @link https://php.net/manual/en/mysqli.construct.php - * @param string $hostname [optional] Can be either a host name or an IP address. Passing the NULL value or the string "localhost" to this parameter, the local host is assumed. When possible, pipes will be used instead of the TCP/IP protocol. Prepending host by p: opens a persistent connection. mysqli_change_user() is automatically called on connections opened from the connection pool. Defaults to ini_get("mysqli.default_host") - * @param string $username [optional] The MySQL user name. Defaults to ini_get("mysqli.default_user") - * @param string $password [optional] If not provided or NULL, the MySQL server will attempt to authenticate the user against those user records which have no password only. This allows one username to be used with different permissions (depending on if a password as provided or not). Defaults to ini_get("mysqli.default_pw") - * @param string $database [optional] If provided will specify the default database to be used when performing queries. Defaults to "" - * @param int $port [optional] Specifies the port number to attempt to connect to the MySQL server. Defaults to ini_get("mysqli.default_port") - * @param string $socket [optional] Specifies the socket or named pipe that should be used. Defaults to ini_get("mysqli.default_socket") - */ - public function __construct ( - $hostname = null, - $username = null, - $password = null, - $database = null, - $port = null, - $socket = null - ) {} - - /** - * Turns on or off auto-committing database modifications - * @link https://php.net/manual/en/mysqli.autocommit.php - * @param bool $enable- * Whether to turn on auto-commit or not. - *
- * @return bool true on success or false on failure. - */ - public function autocommit ($enable) {} + /** + * mysqli_stmt constructor + * @param mysqli $mysql + * @param string $query [optional] + */ + public function __construct($mysql, $query) {} /** - * Starts a transaction - * @link https://secure.php.net/manual/en/mysqli.begin-transaction.php - * @param int $flags [optional] - * @param string $name [optional] - * @return bool true on success or false on failure. - * @since 5.5 + * Used to get the current value of a statement attribute + * @link https://php.net/manual/en/mysqli-stmt.attr-get.php + * @param int $attribute+ * The attribute that you want to get. + *
+ * @return int|false false if the attribute is not found, otherwise returns the value of the attribute. */ - public function begin_transaction ($flags = 0, $name = null) {} - - /** - * Changes the user of the specified database connection - * @link https://php.net/manual/en/mysqli.change-user.php - * @param string $username- * The MySQL user name. - *
- * @param string $password- * The MySQL password. - *
- * @param string $database- * The database to change to. - *
- *- * If desired, the null value may be passed resulting in only changing - * the user and not selecting a database. To select a database in this - * case use the mysqli_select_db function. - *
- * @return bool true on success or false on failure. - */ - public function change_user ($username, $password, $database) {} - - /** - * Returns the default character set for the database connection - * @link https://php.net/manual/en/mysqli.character-set-name.php - * @return string The default character set for the current connection - */ - public function character_set_name () {} - - /** - * @removed 5.4 - */ - #[Deprecated(since: '5.3')] - public function client_encoding () {} - - /** - * Closes a previously opened database connection - * @link https://php.net/manual/en/mysqli.close.php - * @return bool true on success or false on failure. - */ - public function close () {} - - /** - * Commits the current transaction - * @link https://php.net/manual/en/mysqli.commit.php - * @param int $flags A bitmask of MYSQLI_TRANS_COR_* constants. - * @param string $name If provided then COMMIT $name is executed. - * @return bool true on success or false on failure. - */ - public function commit ($flags = -1, $name = null) {} - - /** - * @link https://php.net/manual/en/function.mysqli-connect.php - * @param string $hostname [optional] - * @param string $username [optional] - * @param string $password [optional] - * @param string $database [optional] - * @param int $port [optional] - * @param string $socket [optional] - */ - public function connect ($hostname = null, $username = null, $password = null, $database = null, $port = null, $socket = null) {} - - /** - * Dump debugging information into the log - * @link https://php.net/manual/en/mysqli.dump-debug-info.php - * @return bool true on success or false on failure. - */ - public function dump_debug_info () {} - - /** - * Performs debugging operations - * @link https://php.net/manual/en/mysqli.debug.php - * @param string $options- * A string representing the debugging operation to perform - *
- * @return bool true. - */ - public function debug ($options) {} - - /** - * Returns a character set object - * @link https://php.net/manual/en/mysqli.get-charset.php - * @return object 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 (?)
- */ - public function get_charset () {} - - /** - * Returns the MySQL client version as a string - * @link https://php.net/manual/en/mysqli.get-client-info.php - * @return string A string that represents the MySQL client library version - */ - public function get_client_info () {} - - /** - * Returns statistics about the client connection - * @link https://php.net/manual/en/mysqli.get-connection-stats.php - * @return array|false an array with connection stats if success, false otherwise. - */ - public function get_connection_stats () {} - - /** - * An undocumented function equivalent to the $server_info property - * @link https://php.net/manual/en/mysqli.get-server-info.php - * @return string A character string representing the server version. - */ - public function get_server_info () {} - - /** - * Get result of SHOW WARNINGS - * @link https://php.net/manual/en/mysqli.get-warnings.php - * @return mysqli_warning - */ - public function get_warnings () {} - - /** - * Initializes MySQLi and returns a resource for use with mysqli_real_connect() - * @link https://php.net/manual/en/mysqli.init.php - * @return mysqli an object. - */ - public function init () {} - - /** - * Asks the server to kill a MySQL thread - * @link https://php.net/manual/en/mysqli.kill.php - * @param int $process_id - * @return bool true on success or false on failure. - */ - public function kill ($process_id) {} - - /** - * Performs a query on the database - * @link https://php.net/manual/en/mysqli.multi-query.php - * @param string $query- * The query, as a string. - *
- *- * Data inside the query should be properly escaped. - *
- * @return bool false if the first statement failed. - * To retrieve subsequent errors from other statements you have to call - * mysqli_next_result first. - */ - public function multi_query ($query) {} - - /** - * @link https://php.net/manual/en/mysqli.construct.php - * @param string $host [optional] - * @param string $username [optional] - * @param string $password [optional] - * @param string $database [optional] - * @param int $port [optional] - * @param string $socket [optional] - * - * @removed 8.0 - */ - public function mysqli ($host = null, $username = null, $password = null, $database = null, $port = null, $socket = null) {} - - /** - * Check if there are any more query results from a multi query - * @link https://php.net/manual/en/mysqli.more-results.php - * @return bool true on success or false on failure. - */ - public function more_results () {} - - /** - * Prepare next result from multi_query - * @link https://php.net/manual/en/mysqli.next-result.php - * @return bool true on success or false on failure. - */ - public function next_result () {} - - /** - * Set options - * @link https://php.net/manual/en/mysqli.options.php - * @param int $option- * The option that you want to set. It can be one of the following values: - *
| Name | - *Description | - *|
| MYSQLI_OPT_CONNECT_TIMEOUT | - *connection timeout in seconds (supported on Windows with TCP/IP since PHP 5.3.1) | - *|
| MYSQLI_OPT_LOCAL_INFILE | - *enable/disable use of LOAD LOCAL INFILE | - *|
| MYSQLI_INIT_COMMAND | - *command to execute after when connecting to MySQL server | - *|
| MYSQLI_READ_DEFAULT_FILE | - *- * Read options from named option file instead of my.cnf - * | - *|
| MYSQLI_READ_DEFAULT_GROUP | - *- * Read options from the named group from my.cnf - * or the file specified with MYSQL_READ_DEFAULT_FILE - * | - *
| MYSQLI_SERVER_PUBLIC_KEY | + *Character | + *Description | + *
| MYSQLI_STMT_ATTR_UPDATE_MAX_LENGTH | *- * RSA public key file used with the SHA-256 based authentication. + * If set to 1, causes mysqli_stmt_store_result to + * update the metadata MYSQL_FIELD->max_length value. + * | + *|
| MYSQLI_STMT_ATTR_CURSOR_TYPE | + *+ * Type of cursor to open for statement when mysqli_stmt_execute + * is invoked. mode can be MYSQLI_CURSOR_TYPE_NO_CURSOR + * (the default) or MYSQLI_CURSOR_TYPE_READ_ONLY. + * | + *|
| MYSQLI_STMT_ATTR_PREFETCH_ROWS | + *+ * Number of rows to fetch from server at a time when using a cursor. + * mode can be in the range from 1 to the maximum + * value of unsigned long. The default is 1. * | *
- * The value for the option. - *
- * @return bool true on success or false on failure. - */ - public function options ($option, $value) {} - - /** - * Pings a server connection, or tries to reconnect if the connection has gone down - * @link https://php.net/manual/en/mysqli.ping.php - * @return bool true on success or false on failure. - */ - public function ping () {} - - /** - * Prepare an SQL statement for execution - * @link https://php.net/manual/en/mysqli.prepare.php - * @param string $query- * The query, as a string. - *
- *- * You should not add a terminating semicolon or \g - * to the statement. - *
- *- * This parameter can include one or more parameter markers in the SQL - * statement by embedding question mark (?) characters - * at the appropriate positions. - *
- *- * The markers are legal only in certain places in SQL statements. - * For example, they are allowed in the VALUES() - * list of an INSERT statement (to specify column - * values for a row), or in a comparison with a column in a - * WHERE clause to specify a comparison value. - *
- *- * However, they are not allowed for identifiers (such as table or - * column names), in the select list that names the columns to be - * returned by a SELECT statement, or to specify both - * operands of a binary operator such as the = equal - * sign. The latter restriction is necessary because it would be - * impossible to determine the parameter type. It's not allowed to - * compare marker with NULL by - * ? IS NULL too. In general, parameters are legal - * only in Data Manipulation Language (DML) statements, and not in Data - * Definition Language (DDL) statements. - *
- * @return mysqli_stmt|false mysqli_prepare returns a statement object or false if an error occurred. - */ - public function prepare ($query) {} - - /** - * Performs a query on the database - * @link https://php.net/manual/en/mysqli.query.php - * @param string $query- * The query string. - *
- *- * Data inside the query should be properly escaped. - *
- * @param int $result_mode [optional]- * Either the constant MYSQLI_USE_RESULT or - * MYSQLI_STORE_RESULT depending on the desired - * behavior. By default, MYSQLI_STORE_RESULT is used. - *
- *- * If you use MYSQLI_USE_RESULT all subsequent calls - * will return error Commands out of sync unless you - * call mysqli_free_result - *
- *- * With MYSQLI_ASYNC (available with mysqlnd), it is - * possible to perform query asynchronously. - * mysqli_poll is then used to get results from such - * queries. - *
- * @return mysqli_result|bool For successful SELECT, SHOW, DESCRIBE or - * EXPLAIN queries mysqli_query will return - * a mysqli_result object. For other successful queries mysqli_query will - * return true and false on failure. - */ - public function query ($query, $result_mode = MYSQLI_STORE_RESULT) {} - - /** - * Opens a connection to a mysql server - * @link https://php.net/manual/en/mysqli.real-connect.php - * @param string $hostname [optional]- * Can be either a host name or an IP address. Passing the null value - * or the string "localhost" to this parameter, the local host is - * assumed. When possible, pipes will be used instead of the TCP/IP - * protocol. - *
- * @param string $username [optional]- * The MySQL user name. - *
- * @param string $password [optional]- * If provided or null, the MySQL server will attempt to authenticate - * the user against those user records which have no password only. This - * allows one username to be used with different permissions (depending - * on if a password as provided or not). - *
- * @param string $database [optional]- * If provided will specify the default database to be used when - * performing queries. - *
- * @param int $port [optional]- * Specifies the port number to attempt to connect to the MySQL server. - *
- * @param string $socket [optional]- * Specifies the socket or named pipe that should be used. - *
- *- * Specifying the socket parameter will not - * explicitly determine the type of connection to be used when - * connecting to the MySQL server. How the connection is made to the - * MySQL database is determined by the host - * parameter. - *
- * @param int $flags [optional]- * With the parameter flags you can set different - * connection options: - *
- *| Name | - *Description | - *
| MYSQLI_CLIENT_COMPRESS | - *Use compression protocol | - *
| MYSQLI_CLIENT_FOUND_ROWS | - *return number of matched rows, not the number of affected rows | - *
| MYSQLI_CLIENT_IGNORE_SPACE | - *Allow spaces after function names. Makes all function names reserved words. | - *
| MYSQLI_CLIENT_INTERACTIVE | - *- * Allow interactive_timeout seconds (instead of - * wait_timeout seconds) of inactivity before closing the connection - * | - *
| MYSQLI_CLIENT_SSL | - *Use SSL (encryption) | - *
- * For security reasons the MULTI_STATEMENT flag is - * not supported in PHP. If you want to execute multiple queries use the - * mysqli_multi_query function. - *
- * @return bool true on success or false on failure. - */ - public function real_connect ($hostname = null, $username = null, $password = null, $database = null, $port = null, $socket = null, $flags = null) {} - - /** - * Escapes special characters in a string for use in an SQL statement, taking into account the current charset of the connection - * @link https://php.net/manual/en/mysqli.real-escape-string.php - * @param string $string- * The string to be escaped. - *
- *- * Characters encoded are NUL (ASCII 0), \n, \r, \, ', ", and - * Control-Z. - *
- * @return string an escaped string. - */ - public function real_escape_string ($string) {} - - /** - * Poll connections - * @link https://php.net/manual/en/mysqli.poll.php - * @param array &$read- *
- * @param array &$error- *
- * @param array &$reject- *
- * @param int $seconds- * Number of seconds to wait, must be non-negative. - *
- * @param int $microseconds [optional]- * Number of microseconds to wait, must be non-negative. - *
- * @return int|false number of ready connections in success, false otherwise. - */ - public static function poll (array &$read , array &$error , array &$reject , $seconds, $microseconds = 0) {} - - /** - * Get result from async query - * @link https://php.net/manual/en/mysqli.reap-async-query.php - * @return mysqli_result|false mysqli_result in success, false otherwise. - */ - public function reap_async_query () {} - - /** - * Escapes special characters in a string for use in an SQL statement, taking into account the current charset of the connection - * @param string $string The string to be escaped. - * Characters encoded are NUL (ASCII 0), \n, \r, \, ', ", and Control-Z. - * @return string - * @link https://secure.php.net/manual/en/mysqli.real-escape-string.php - */ - public function escape_string ($string) {} - - /** - * Execute an SQL query - * @link https://php.net/manual/en/mysqli.real-query.php - * @param string $query- * The query, as a string. - *
- *- * Data inside the query should be properly escaped. - *
- * @return bool true on success or false on failure. - */ - public function real_query ($query) {} + *+ * If you use the MYSQLI_STMT_ATTR_CURSOR_TYPE option with + * MYSQLI_CURSOR_TYPE_READ_ONLY, a cursor is opened for the + * statement when you invoke mysqli_stmt_execute. If there + * is already an open cursor from a previous mysqli_stmt_execute call, + * it closes the cursor before opening a new one. mysqli_stmt_reset + * also closes any open cursor before preparing the statement for re-execution. + * mysqli_stmt_free_result closes any open cursor. + *
+ *+ * If you open a cursor for a prepared statement, mysqli_stmt_store_result + * is unnecessary. + *
+ * @param int $valueThe value to assign to the attribute.
+ * @return bool + */ + public function attr_set($attribute, $value) {} /** - * Execute an SQL query - * @link https://php.net/manual/en/mysqli.release-savepoint.php - * @param string $name - * @return bool Returns TRUE on success or FALSE on failure. - * @since 5.5 + * Binds variables to a prepared statement as parameters + * @link https://php.net/manual/en/mysqli-stmt.bind-param.php + * @param string $types+ * A string that contains one or more characters which specify the types + * for the corresponding bind variables: + *
| Character | + *Description | + *
| i | + *corresponding variable has type integer | + *
| d | + *corresponding variable has type double | + *
| s | + *corresponding variable has type string | + *
| b | + *corresponding variable is a blob and will be sent in packets | + *
+ * The number of variables and length of string + * types must match the parameters in the statement. + *
+ * @param mixed &...$_ [optional] + * @return bool true on success or false on failure. */ - public function release_savepoint ($name) {} + public function bind_param($types, &$var1, &...$_) {} - /** - * Rolls back current transaction - * @link https://php.net/manual/en/mysqli.rollback.php - * @param int $flags [optional] A bitmask of MYSQLI_TRANS_COR_* constants. - * @param string $name [optional] If provided then ROLLBACK $name is executed. - * @return bool true on success or false on failure. - * @since 5.5 Added flags and name parameters. - */ - public function rollback ($flags = 0, $name = null) {} + /** + * Binds variables to a prepared statement for result storage + * @link https://php.net/manual/en/mysqli-stmt.bind-result.php + * @param mixed &$var1 The variable to be bound. + * @param mixed &...$_ The variables to be bound. + * @return bool true on success or false on failure. + */ + public function bind_result(&$var1, &...$_) {} /** - * Set a named transaction savepoint - * @link https://secure.php.net/manual/en/mysqli.savepoint.php - * @param string $name - * @return bool Returns TRUE on success or FALSE on failure. - * @since 5.5 + * Closes a prepared statement + * @link https://php.net/manual/en/mysqli-stmt.close.php + * @return bool true on success or false on failure. */ - public function savepoint ($name) {} - - /** - * Selects the default database for database queries - * @link https://php.net/manual/en/mysqli.select-db.php - * @param string $database- * The database name. - *
- * @return bool true on success or false on failure. - */ - public function select_db ($database) {} - - /** - * Sets the default client character set - * @link https://php.net/manual/en/mysqli.set-charset.php - * @param string $charset- * The charset to be set as default. - *
- * @return bool true on success or false on failure..5 - */ - public function set_charset ($charset) {} - - /** - * @link https://php.net/manual/en/function.mysqli-set-opt - * @param int $option - * @param mixed $value - */ - public function set_opt ($option, $value) {} - - - /** - * Used for establishing secure connections using SSL - * @link https://secure.php.net/manual/en/mysqli.ssl-set.php - * @param string $key- * The path name to the key file. - *
- * @param string $certificate- * The path name to the certificate file. - *
- * @param string $ca_certificate- * The path name to the certificate authority file. - *
- * @param string $ca_path- * The pathname to a directory that contains trusted SSL CA certificates in PEM format. - *
- * @param string $cipher_algos- * A list of allowable ciphers to use for SSL encryption. - *
- * @return bool This function always returns TRUE value. - */ - public function ssl_set($key , $certificate , $ca_certificate , $ca_path , $cipher_algos) {} - - /** - * Gets the current system status - * @link https://php.net/manual/en/mysqli.stat.php - * @return string|false A string describing the server status. false if an error occurred. - */ - public function stat () {} - - /** - * Initializes a statement and returns an object for use with mysqli_stmt_prepare - * @link https://php.net/manual/en/mysqli.stmt-init.php - * @return mysqli_stmt an object. - */ - public function stmt_init () {} - - /** - * Transfers a result set from the last query - * @link https://php.net/manual/en/mysqli.store-result.php - * @param int $mode [optional] The option that you want to set - * @return mysqli_result|false 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. - */ - public function store_result ($mode = null) {} - - /** - * Returns whether thread safety is given or not - * @link https://php.net/manual/en/mysqli.thread-safe.php - * @return bool true if the client library is thread-safe, otherwise false. - */ - public function thread_safe () {} - - /** - * Initiate a result set retrieval - * @link https://php.net/manual/en/mysqli.use-result.php - * @return mysqli_result|false an unbuffered result object or false if an error occurred. - */ - public function use_result () {} - - /** - * @link https://php.net/manual/en/mysqli.refresh - * @param int $flags MYSQLI_REFRESH_* - * @return bool TRUE if the refresh was a success, otherwise FALSE - * @since 5.3 - */ - public function refresh ($flags) {} + public function close() {} -} + /** + * Seeks to an arbitrary row in statement result set + * @link https://php.net/manual/en/mysqli-stmt.data-seek.php + * @param int $offset
+ * Must be between zero and the total number of rows minus one (0.. + * mysqli_stmt_num_rows - 1). + *
+ * @return void + */ + public function data_seek($offset) {} -/** - * Represents one or more MySQL warnings. - * @link https://php.net/manual/en/class.mysqli-warning.php - */ -final class mysqli_warning { - /** - * @var string - */ - public $message; - /** - * @var string - */ - public $sqlstate; - /** - * @var int - */ - public $errno; - - - /** - * The __construct purpose - * @link https://php.net/manual/en/mysqli-warning.construct.php - */ - private function __construct () {} - - /** - * Move to the next warning - * @link https://php.net/manual/en/mysqli-warning.next.php - * @return bool True if it successfully moved to the next warning - */ - public function next () {} + /** + * Executes a prepared Query + * @link https://php.net/manual/en/mysqli-stmt.execute.php + * @return bool true on success or false on failure. + */ + public function execute() {} -} + /** + * Fetch results from a prepared statement into the bound variables + * @link https://php.net/manual/en/mysqli-stmt.fetch.php + * @return bool|null + */ + public function fetch() {} -/** - * Represents the result set obtained from a query against the database. - * Implements Traversable since 5.4 - * @link https://php.net/manual/en/class.mysqli-result.php - */ -class mysqli_result implements IteratorAggregate -{ - /** - * @var int - */ - public $current_field; - /** - * @var int - */ - public $field_count; - /** - * @var array - */ - public $lengths; - /** - * @var int - */ - public $num_rows; - /** - * @var mixed - */ - public $type; - - /** - * Constructor (no docs available) - * @param object $mysql [optional] - * @param int $result_mode [optional] - */ - public function __construct ($mysql = null, $result_mode = 0) {} - - /** - * Frees the memory associated with a result - * @return void - * @link https://php.net/manual/en/mysqli-result.free.php - */ - public function close () {} - - /** - * Frees the memory associated with a result - * @link https://php.net/manual/en/mysqli-result.free.php - * @return void - */ - public function free () {} - - /** - * Adjusts the result pointer to an arbitrary row in the result - * @link https://php.net/manual/en/mysqli-result.data-seek.php - * @param int $offset- * The field offset. Must be between zero and the total number of rows - * minus one (0..mysqli_num_rows - 1). - *
- * @return bool true on success or false on failure. - */ - public function data_seek ($offset) {} - - /** - * Returns the next field in the result set - * @link https://php.net/manual/en/mysqli-result.fetch-field.php - * @return object|false 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 | - *Database (since PHP 5.3.6) | - *
| catalog | - *The catalog name, always "def" (since PHP 5.3.6) | - *
| 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 | - *
| def | - *The default value for this field, represented as a string | - *
| 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) | - *
- * The field number. This value must be in the range from - * 0 to number of fields - 1. - *
- * @return object|false an object which contains field definition information or false - * if no field information for specified fieldnr is - * available. - * - *- *
| 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. | - *
| 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) | - *
- * This optional parameter is a constant indicating what type of array - * should be produced from the current row data. The possible values for - * this parameter are the constants MYSQLI_ASSOC, - * MYSQLI_NUM, or MYSQLI_BOTH. - *
- * @return mixed an array of associative or numeric arrays holding result rows. - */ - public function fetch_all ($mode = MYSQLI_NUM) {} - - /** - * Fetch a result row as an associative, a numeric array, or both - * @link https://php.net/manual/en/mysqli-result.fetch-array.php - * @param int $mode [optional]- * This optional parameter is a constant indicating what type of array - * should be produced from the current row data. The possible values for - * this parameter are the constants MYSQLI_ASSOC, - * MYSQLI_NUM, or MYSQLI_BOTH. - *
- *- * By using the MYSQLI_ASSOC constant this function - * will behave identically to the mysqli_fetch_assoc, - * while MYSQLI_NUM will behave identically to the - * mysqli_fetch_row function. The final option - * MYSQLI_BOTH will create a single array with the - * attributes of both. - *
- * @return mixed an array of strings that corresponds to the fetched row or null if there - * are no more rows in resultset. - */ - public function fetch_array ($mode = MYSQLI_BOTH) {} - - /** - * Fetch a result row as an associative array - * @link https://php.net/manual/en/mysqli-result.fetch-assoc.php - * @return array|null an associative array of strings representing the fetched row in the result - * set, where each key in the array represents the name of one of the result - * set's columns or null if there are no more rows in resultset. - * - *- * If two or more columns of the result have the same field names, the last - * column will take precedence. To access the other column(s) of the same - * name, you either need to access the result with numeric indices by using - * mysqli_fetch_row or add alias names. - */ - public function fetch_assoc () {} - - /** - * Returns the current row of a result set as an object - * @link https://php.net/manual/en/mysqli-result.fetch-object.php - * @param string $class [optional]
- * The name of the class to instantiate, set the properties of and return. - * If not specified, a stdClass object is returned. - *
- * @param null|array $constructor_args [optional]- * An optional array of parameters to pass to the constructor - * for class_name objects. - *
- * @return stdClass|object an object with string properties that corresponds to the fetched - * row or null if there are no more rows in resultset. - */ - public function fetch_object ($class = 'stdClass', array $constructor_args = null) {} - - /** - * Get a result row as an enumerated array - * @link https://php.net/manual/en/mysqli-result.fetch-row.php - * @return array|null mysqli_fetch_row returns an array of strings that corresponds to the fetched row - * or null if there are no more rows in result set. - */ - public function fetch_row () {} - - /** - * Set result pointer to a specified field offset - * @link https://php.net/manual/en/mysqli-result.field-seek.php - * @param int $index- * The field number. This value must be in the range from - * 0 to number of fields - 1. - *
- * @return bool true on success or false on failure. - */ - public function field_seek ($index) {} - - /** - * Frees the memory associated with a result - * @return void - * @link https://php.net/manual/en/mysqli-result.free.php - */ - public function free_result () {} + /** + * Get result of SHOW WARNINGS + * @link https://php.net/manual/en/mysqli-stmt.get-warnings.php + * @return object + */ + public function get_warnings() {} /** - * @since 8.0 - * @return Traversable + * Returns result set metadata from a prepared statement + * @link https://php.net/manual/en/mysqli-stmt.result-metadata.php + * @return mysqli_result|false a result object or false if an error occurred. */ - public function getIterator(){} -} + public function result_metadata() {} -/** - * Represents a prepared statement. - * @link https://php.net/manual/en/class.mysqli-stmt.php - */ -class mysqli_stmt { - /** - * @var int - */ - public $affected_rows; - /** - * @var int - */ - public $insert_id; - /** - * @var int - */ - public $num_rows; - /** - * @var int - */ - public $param_count; - /** - * @var int - */ - public $field_count; - /** - * @var int - */ - public $errno; - /** - * @var string - */ - public $error; - /** - * @var array - */ - public $error_list; - /** - * @var string - */ - public $sqlstate; - /** - * @var string - */ - public $id; - - /** - * mysqli_stmt constructor - * @param mysqli $mysql - * @param string $query [optional] - */ - public function __construct ($mysql, $query) {} - - /** - * Used to get the current value of a statement attribute - * @link https://php.net/manual/en/mysqli-stmt.attr-get.php - * @param int $attribute- * The attribute that you want to get. - *
- * @return int|false false if the attribute is not found, otherwise returns the value of the attribute. - */ - public function attr_get ($attribute) {} - - /** - * Used to modify the behavior of a prepared statement - * @link https://php.net/manual/en/mysqli-stmt.attr-set.php - * @param int $attribute- * The attribute that you want to set. It can have one of the following values: - *
| Character | - *Description | - *
| MYSQLI_STMT_ATTR_UPDATE_MAX_LENGTH | - *- * If set to 1, causes mysqli_stmt_store_result to - * update the metadata MYSQL_FIELD->max_length value. - * | - *
| MYSQLI_STMT_ATTR_CURSOR_TYPE | - *- * Type of cursor to open for statement when mysqli_stmt_execute - * is invoked. mode can be MYSQLI_CURSOR_TYPE_NO_CURSOR - * (the default) or MYSQLI_CURSOR_TYPE_READ_ONLY. - * | - *
| MYSQLI_STMT_ATTR_PREFETCH_ROWS | - *- * Number of rows to fetch from server at a time when using a cursor. - * mode can be in the range from 1 to the maximum - * value of unsigned long. The default is 1. - * | - *
- * If you use the MYSQLI_STMT_ATTR_CURSOR_TYPE option with - * MYSQLI_CURSOR_TYPE_READ_ONLY, a cursor is opened for the - * statement when you invoke mysqli_stmt_execute. If there - * is already an open cursor from a previous mysqli_stmt_execute call, - * it closes the cursor before opening a new one. mysqli_stmt_reset - * also closes any open cursor before preparing the statement for re-execution. - * mysqli_stmt_free_result closes any open cursor. - *
- *- * If you open a cursor for a prepared statement, mysqli_stmt_store_result - * is unnecessary. - *
- * @param int $valueThe value to assign to the attribute.
- * @return bool - */ - public function attr_set ($attribute, $value) {} - - /** - * Binds variables to a prepared statement as parameters - * @link https://php.net/manual/en/mysqli-stmt.bind-param.php - * @param string $types- * A string that contains one or more characters which specify the types - * for the corresponding bind variables: - *
| Character | - *Description | - *
| i | - *corresponding variable has type integer | - *
| d | - *corresponding variable has type double | - *
| s | - *corresponding variable has type string | - *
| b | - *corresponding variable is a blob and will be sent in packets | - *
- * The number of variables and length of string - * types must match the parameters in the statement. - *
- * @param mixed &...$_ [optional] - * @return bool true on success or false on failure. - */ - public function bind_param ($types, &$var1, &...$_) {} - - /** - * Binds variables to a prepared statement for result storage - * @link https://php.net/manual/en/mysqli-stmt.bind-result.php - * @param mixed &$var1 The variable to be bound. - * @param mixed &...$_ The variables to be bound. - * @return bool true on success or false on failure. - */ - public function bind_result (&$var1, &...$_) {} - - /** - * Closes a prepared statement - * @link https://php.net/manual/en/mysqli-stmt.close.php - * @return bool true on success or false on failure. - */ - public function close () {} - - /** - * Seeks to an arbitrary row in statement result set - * @link https://php.net/manual/en/mysqli-stmt.data-seek.php - * @param int $offset- * Must be between zero and the total number of rows minus one (0.. - * mysqli_stmt_num_rows - 1). - *
- * @return void - */ - public function data_seek ($offset) {} - - /** - * Executes a prepared Query - * @link https://php.net/manual/en/mysqli-stmt.execute.php - * @return bool true on success or false on failure. - */ - public function execute () {} - - /** - * Fetch results from a prepared statement into the bound variables - * @link https://php.net/manual/en/mysqli-stmt.fetch.php - * @return bool|null - */ - public function fetch () {} - - /** - * Get result of SHOW WARNINGS - * @link https://php.net/manual/en/mysqli-stmt.get-warnings.php - * @return object - */ - public function get_warnings () {} - - /** - * Returns result set metadata from a prepared statement - * @link https://php.net/manual/en/mysqli-stmt.result-metadata.php - * @return mysqli_result|false a result object or false if an error occurred. - */ - public function result_metadata () {} - - /** - * Check if there are more query results from a multiple query - * @link https://php.net/manual/en/mysqli-stmt.more-results.php - * @return bool - */ - public function more_results () {} - - /** - * Reads the next result from a multiple query - * @link https://php.net/manual/en/mysqli-stmt.next-result.php - * @return bool - */ - public function next_result () {} - - /** - * Return the number of rows in statements result set - * @link https://php.net/manual/en/mysqli-stmt.num-rows.php - * @return int An integer representing the number of rows in result set. - */ - public function num_rows () {} - - /** - * Send data in blocks - * @link https://php.net/manual/en/mysqli-stmt.send-long-data.php - * @param int $param_num- * Indicates which parameter to associate the data with. Parameters are - * numbered beginning with 0. - *
- * @param string $data- * A string containing data to be sent. - *
- * @return bool true on success or false on failure. - */ - public function send_long_data ($param_num, $data) {} - - /** - * No documentation available + /** + * Check if there are more query results from a multiple query + * @link https://php.net/manual/en/mysqli-stmt.more-results.php + * @return bool + */ + public function more_results() {} + + /** + * Reads the next result from a multiple query + * @link https://php.net/manual/en/mysqli-stmt.next-result.php + * @return bool + */ + public function next_result() {} + + /** + * Return the number of rows in statements result set + * @link https://php.net/manual/en/mysqli-stmt.num-rows.php + * @return int An integer representing the number of rows in result set. + */ + public function num_rows() {} + + /** + * Send data in blocks + * @link https://php.net/manual/en/mysqli-stmt.send-long-data.php + * @param int $param_num+ * Indicates which parameter to associate the data with. Parameters are + * numbered beginning with 0. + *
+ * @param string $data+ * A string containing data to be sent. + *
+ * @return bool true on success or false on failure. + */ + public function send_long_data($param_num, $data) {} + + /** + * No documentation available * @removed 5.4 - */ + */ #[Deprecated(since: '5.3')] - public function stmt () {} - - /** - * Frees stored result memory for the given statement handle - * @link https://php.net/manual/en/mysqli-stmt.free-result.php - * @return void - */ - public function free_result () {} - - /** - * Resets a prepared statement - * @link https://php.net/manual/en/mysqli-stmt.reset.php - * @return bool true on success or false on failure. - */ - public function reset () {} - - /** - * Prepare an SQL statement for execution - * @link https://php.net/manual/en/mysqli-stmt.prepare.php - * @param string $query- * The query, as a string. It must consist of a single SQL statement. - *
- *- * You can include one or more parameter markers in the SQL statement by - * embedding question mark (?) characters at the - * appropriate positions. - *
- *- * You should not add a terminating semicolon or \g - * to the statement. - *
- *- * The markers are legal only in certain places in SQL statements. - * For example, they are allowed in the VALUES() list of an INSERT statement - * (to specify column values for a row), or in a comparison with a column in - * a WHERE clause to specify a comparison value. - *
- *- * However, they are not allowed for identifiers (such as table or column names), - * in the select list that names the columns to be returned by a SELECT statement), - * or to specify both operands of a binary operator such as the = - * equal sign. The latter restriction is necessary because it would be impossible - * to determine the parameter type. In general, parameters are legal only in Data - * Manipulation Language (DML) statements, and not in Data Definition Language - * (DDL) statements. - *
- * @return bool true on success or false on failure. - */ - public function prepare ($query) {} - - /** - * Transfers a result set from a prepared statement - * @link https://php.net/manual/en/mysqli-stmt.store-result.php - * @return bool true on success or false on failure. - */ - public function store_result () {} - - /** - * Gets a result set from a prepared statement - * @link https://php.net/manual/en/mysqli-stmt.get-result.php - * @return mysqli_result|false Returns a resultset or FALSE on failure - */ - public function get_result () {} + public function stmt() {} + + /** + * Frees stored result memory for the given statement handle + * @link https://php.net/manual/en/mysqli-stmt.free-result.php + * @return void + */ + public function free_result() {} + + /** + * Resets a prepared statement + * @link https://php.net/manual/en/mysqli-stmt.reset.php + * @return bool true on success or false on failure. + */ + public function reset() {} + + /** + * Prepare an SQL statement for execution + * @link https://php.net/manual/en/mysqli-stmt.prepare.php + * @param string $query+ * The query, as a string. It must consist of a single SQL statement. + *
+ *+ * You can include one or more parameter markers in the SQL statement by + * embedding question mark (?) characters at the + * appropriate positions. + *
+ *+ * You should not add a terminating semicolon or \g + * to the statement. + *
+ *+ * The markers are legal only in certain places in SQL statements. + * For example, they are allowed in the VALUES() list of an INSERT statement + * (to specify column values for a row), or in a comparison with a column in + * a WHERE clause to specify a comparison value. + *
+ *+ * However, they are not allowed for identifiers (such as table or column names), + * in the select list that names the columns to be returned by a SELECT statement), + * or to specify both operands of a binary operator such as the = + * equal sign. The latter restriction is necessary because it would be impossible + * to determine the parameter type. In general, parameters are legal only in Data + * Manipulation Language (DML) statements, and not in Data Definition Language + * (DDL) statements. + *
+ * @return bool true on success or false on failure. + */ + public function prepare($query) {} + + /** + * Transfers a result set from a prepared statement + * @link https://php.net/manual/en/mysqli-stmt.store-result.php + * @return bool true on success or false on failure. + */ + public function store_result() {} + /** + * Gets a result set from a prepared statement + * @link https://php.net/manual/en/mysqli-stmt.get-result.php + * @return mysqli_result|false Returns a resultset or FALSE on failure + */ + public function get_result() {} } /** @@ -1482,8 +1480,7 @@ public function get_result () {} * Zero indicates that no records where 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. */ -function mysqli_affected_rows (mysqli $mysql): string|int -{} +function mysqli_affected_rows(mysqli $mysql): string|int {} /** * Turns on or off auto-committing database modifications @@ -1492,8 +1489,7 @@ function mysqli_affected_rows (mysqli $mysql): string|int * @param bool $enable Whether to turn on auto-commit or not. * @return bool */ -function mysqli_autocommit (mysqli $mysql, bool $enable): bool -{} +function mysqli_autocommit(mysqli $mysql, bool $enable): bool {} /** * Starts a transaction @@ -1504,8 +1500,7 @@ function mysqli_autocommit (mysqli $mysql, bool $enable): bool * @return bool true on success or false on failure. * @since 5.5 */ -function mysqli_begin_transaction (mysqli $mysql, int $flags = 0, ?string $name): bool -{} +function mysqli_begin_transaction(mysqli $mysql, int $flags = 0, ?string $name): bool {} /** * Changes the user of the specified database connection @@ -1516,8 +1511,7 @@ function mysqli_begin_transaction (mysqli $mysql, int $flags = 0, ?string $name) * @param string|null $database The database to change to. If desired, the NULL value may be passed resulting in only changing the user and not selecting a database. * @return bool */ -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): bool {} /** * Returns the default character set for the database connection @@ -1525,8 +1519,7 @@ function mysqli_change_user (mysqli $mysql, string $username, string $password, * @param mysqli $mysql A link identifier returned by mysqli_connect() or mysqli_init() * @return string The default character set for the current connection */ -function mysqli_character_set_name (mysqli $mysql): string -{} +function mysqli_character_set_name(mysqli $mysql): string {} /** * Closes a previously opened database connection @@ -1534,8 +1527,7 @@ function mysqli_character_set_name (mysqli $mysql): string * @param mysqli $mysql A link identifier returned by mysqli_connect() or mysqli_init() * @return bool */ -function mysqli_close (mysqli $mysql): bool -{} +function mysqli_close(mysqli $mysql): bool {} /** * Commits the current transaction @@ -1545,8 +1537,7 @@ function mysqli_close (mysqli $mysql): bool * @param string|null $name [optional] If provided then COMMITname is executed * @return bool */ -function mysqli_commit (mysqli $mysql, int $flags = -1, ?string $name): bool -{} +function mysqli_commit(mysqli $mysql, int $flags = -1, ?string $name): bool {} /** * Open a new connection to the MySQL server @@ -1560,24 +1551,21 @@ function mysqli_commit (mysqli $mysql, int $flags = -1, ?string $name): bool * @param string|null $socket Specifies the socket or named pipe that should be used. * @return mysqli|false|null object which represents the connection to a MySQL Server or false if an error occurred. */ -function mysqli_connect (?string $hostname = null, ?string $username = null, ?string $password = null, ?string $database = null, ?int $port = null, ?string $socket = null): mysqli|false|null -{} +function mysqli_connect(?string $hostname = null, ?string $username = null, ?string $password = null, ?string $database = null, ?int $port = null, ?string $socket = null): mysqli|false|null {} /** * Returns the error code from last connect call * @link https://php.net/manual/en/mysqli.connect-errno.php * @return int Last error code number from the last call to mysqli_connect(). Zero means no error occurred. */ -function mysqli_connect_errno (): int -{} +function mysqli_connect_errno(): int {} /** * Returns a string description of the last connect error * @link https://php.net/manual/en/mysqli.connect-error.php * @return string|null Last error message string from the last call to mysqli_connect(). */ -function mysqli_connect_error (): ?string -{} +function mysqli_connect_error(): ?string {} /** * Adjusts the result pointer to an arbitrary row in the result @@ -1587,8 +1575,7 @@ function mysqli_connect_error (): ?string * @param int $offset * @return bool Returns TRUE on success or FALSE on failure. */ -function mysqli_data_seek (mysqli_result $result, int $offset): bool -{} +function mysqli_data_seek(mysqli_result $result, int $offset): bool {} /** * Dump debugging information into the log @@ -1596,8 +1583,7 @@ function mysqli_data_seek (mysqli_result $result, int $offset): bool * @param mysqli $mysql A link identifier returned by mysqli_connect() or mysqli_init() * @return bool */ -function mysqli_dump_debug_info (mysqli $mysql): bool -{} +function mysqli_dump_debug_info(mysqli $mysql): bool {} /** * Performs debugging operations using the Fred Fish debugging library. @@ -1605,8 +1591,7 @@ function mysqli_dump_debug_info (mysqli $mysql): bool * @param string $options * @return bool */ -function mysqli_debug (string $options): bool -{} +function mysqli_debug(string $options): bool {} /** * Returns the error code for the most recent function call @@ -1614,8 +1599,7 @@ function mysqli_debug (string $options): bool * @param mysqli $mysql A link identifier returned by mysqli_connect() or mysqli_init() * @return int An error code value for the last call, if it failed. zero means no error occurred. */ -function mysqli_errno (mysqli $mysql): int -{} +function mysqli_errno(mysqli $mysql): int {} /** * Returns a list of errors from the last command executed @@ -1624,7 +1608,7 @@ function mysqli_errno (mysqli $mysql): int * @return array A list of errors, each as an associative array containing the errno, error, and sqlstate. * @since 5.4 */ -function mysqli_error_list (mysqli $mysql): array {} +function mysqli_error_list(mysqli $mysql): array {} /** * Returns a list of errors from the last statement executed @@ -1633,7 +1617,7 @@ function mysqli_error_list (mysqli $mysql): array {} * @return array A list of errors, each as an associative array containing the errno, error, and sqlstate. * @since 5.4 */ -function mysqli_stmt_error_list (mysqli_stmt $statement): array {} +function mysqli_stmt_error_list(mysqli_stmt $statement): array {} /** * Returns a string description of the last error @@ -1641,7 +1625,7 @@ function mysqli_stmt_error_list (mysqli_stmt $statement): array {} * @param mysqli $mysql A link identifier returned by mysqli_connect() or mysqli_init() * @return string */ -function mysqli_error (mysqli $mysql): string {} +function mysqli_error(mysqli $mysql): string {} /** * Executes a prepared Query @@ -1649,7 +1633,7 @@ function mysqli_error (mysqli $mysql): string {} * @param mysqli_stmt $statement * @return bool */ -function mysqli_stmt_execute (mysqli_stmt $statement): bool {} +function mysqli_stmt_execute(mysqli_stmt $statement): bool {} /** * Executes a prepared Query @@ -1659,7 +1643,7 @@ function mysqli_stmt_execute (mysqli_stmt $statement): bool {} * @return bool */ #[Deprecated(since: '5.3')] -function mysqli_execute (mysqli_stmt $statement): bool {} +function mysqli_execute(mysqli_stmt $statement): bool {} /** * Returns the next field in the result set @@ -1668,7 +1652,7 @@ function mysqli_execute (mysqli_stmt $statement): bool {} * mysqli_store_result() or mysqli_use_result(). * @return object|false Returns an object which contains field definition information or FALSE if no field information is available. */ -function mysqli_fetch_field (mysqli_result $result): object|false {} +function mysqli_fetch_field(mysqli_result $result): object|false {} /** * Returns an array of objects representing the fields in a result set @@ -1678,7 +1662,7 @@ function mysqli_fetch_field (mysqli_result $result): object|false {} * @return array|false Returns an array of objects which contains field definition information or FALSE if no field information is available. */ #[LanguageLevelTypeAware(["8.0" => "array"], default: "array|false")] -function mysqli_fetch_fields (mysqli_result $result) {} +function mysqli_fetch_fields(mysqli_result $result) {} /** * Fetch meta-data for a single field @@ -1688,7 +1672,7 @@ function mysqli_fetch_fields (mysqli_result $result) {} * @param int $index The field number. This value must be in the range from 0 to number of fields - 1. * @return object|false Returns an object which contains field definition information or FALSE if no field information for specified fieldnr is available. */ -function mysqli_fetch_field_direct (mysqli_result $result, int $index): object|false {} +function mysqli_fetch_field_direct(mysqli_result $result, int $index): object|false {} /** * Returns the lengths of the columns of the current row in the result set @@ -1697,7 +1681,7 @@ function mysqli_fetch_field_direct (mysqli_result $result, int $index): object|f * mysqli_store_result() or mysqli_use_result(). * @return int[]|false An array of integers representing the size of each column (not including any terminating null characters). FALSE if an error occurred. */ -function mysqli_fetch_lengths (mysqli_result $result): array|false {} +function mysqli_fetch_lengths(mysqli_result $result): array|false {} /** * Fetches all result rows as an associative array, a numeric array, or both. @@ -1708,7 +1692,7 @@ function mysqli_fetch_lengths (mysqli_result $result): array|false {} * @param int $mode * @return array Returns an array of associative or numeric arrays holding result rows. */ -function mysqli_fetch_all (mysqli_result $result, int $mode = MYSQLI_NUM): array {} +function mysqli_fetch_all(mysqli_result $result, int $mode = MYSQLI_NUM): array {} /** * Fetch a result row as an associative, a numeric array, or both. @@ -1718,7 +1702,7 @@ function mysqli_fetch_all (mysqli_result $result, int $mode = MYSQLI_NUM): array * @param int $mode * @return array|false|null */ -function mysqli_fetch_array (mysqli_result $result, int $mode = MYSQLI_BOTH): array|false|null {} +function mysqli_fetch_array(mysqli_result $result, int $mode = MYSQLI_BOTH): array|false|null {} /** * Fetch a result row as an associative array @@ -1731,7 +1715,7 @@ function mysqli_fetch_array (mysqli_result $result, int $mode = MYSQLI_BOTH): ar * To access the other column(s) of the same name, * you either need to access the result with numeric indices by using mysqli_fetch_row() or add alias names. */ -function mysqli_fetch_assoc (mysqli_result $result): array|null|false {} +function mysqli_fetch_assoc(mysqli_result $result): array|null|false {} /** * Returns the current row of a result set as an object. @@ -1745,7 +1729,7 @@ function mysqli_fetch_assoc (mysqli_result $result): array|null|false {} * To access the other column(s) of the same name, * you either need to access the result with numeric indices by using mysqli_fetch_row() or add alias names. */ -function mysqli_fetch_object (mysqli_result $result, string $class = 'stdClass', array $constructor_args = array()): object|null|false {} +function mysqli_fetch_object(mysqli_result $result, string $class = 'stdClass', array $constructor_args = []): object|null|false {} /** * Get a result row as an enumerated array @@ -1756,7 +1740,7 @@ function mysqli_fetch_object (mysqli_result $result, string $class = 'stdClass', * or null if there are no more rows in result set. * @link https://php.net/manual/en/mysqli-result.fetch-row.php */ -function mysqli_fetch_row (mysqli_result $result): array|false|null {} +function mysqli_fetch_row(mysqli_result $result): array|false|null {} /** * Returns the number of columns for the most recent query @@ -1764,7 +1748,7 @@ function mysqli_fetch_row (mysqli_result $result): array|false|null {} * @param mysqli $mysql A link identifier returned by mysqli_connect() or mysqli_init() * @return int An integer representing the number of fields in a result set. */ -function mysqli_field_count (mysqli $mysql): int {} +function mysqli_field_count(mysqli $mysql): int {} /** * Set result pointer to a specified field offset @@ -1774,7 +1758,7 @@ function mysqli_field_count (mysqli $mysql): int {} * @param int $index The field number. This value must be in the range from 0 to number of fields - 1. * @return bool */ -function mysqli_field_seek (mysqli_result $result, int $index): bool {} +function mysqli_field_seek(mysqli_result $result, int $index): bool {} /** * Get current field offset of a result pointer @@ -1783,7 +1767,7 @@ function mysqli_field_seek (mysqli_result $result, int $index): bool {} * mysqli_store_result() or mysqli_use_result(). * @return int */ -function mysqli_field_tell (mysqli_result $result): int {} +function mysqli_field_tell(mysqli_result $result): int {} /** * Frees the memory associated with a result @@ -1792,7 +1776,7 @@ function mysqli_field_tell (mysqli_result $result): int {} * mysqli_store_result() or mysqli_use_result(). * @return void */ -function mysqli_free_result (mysqli_result $result): void {} +function mysqli_free_result(mysqli_result $result): void {} /** * Returns client Zval cache statistics @@ -1802,7 +1786,7 @@ function mysqli_free_result (mysqli_result $result): void {} * @return array|false an array with client Zval cache stats if success, false otherwise. * @removed 5.4 */ -function mysqli_get_cache_stats (mysqli $mysql) {} +function mysqli_get_cache_stats(mysqli $mysql) {} /** * Returns statistics about the client connection @@ -1811,7 +1795,7 @@ function mysqli_get_cache_stats (mysqli $mysql) {} * @return array|false an array with connection stats if successful, FALSE otherwise. */ #[LanguageLevelTypeAware(["8.0" => "array"], default: "array|false")] -function mysqli_get_connection_stats (mysqli $mysql) {} +function mysqli_get_connection_stats(mysqli $mysql) {} /** * Returns client per-process statistics @@ -1819,7 +1803,7 @@ function mysqli_get_connection_stats (mysqli $mysql) {} * @return array|false an array with client stats if success, false otherwise. */ #[LanguageLevelTypeAware(["8.0" => "array"], default: "array|false")] -function mysqli_get_client_stats () {} +function mysqli_get_client_stats() {} /** * Returns a character set object @@ -1827,7 +1811,7 @@ function mysqli_get_client_stats () {} * @param mysqli $mysql A link identifier returned by mysqli_connect() or mysqli_init() * @return object|null */ -function mysqli_get_charset (mysqli $mysql): ?object {} +function mysqli_get_charset(mysqli $mysql): ?object {} /** * Get MySQL client info @@ -1835,14 +1819,14 @@ function mysqli_get_charset (mysqli $mysql): ?object {} * @param mysqli|null $mysql [optional] A link identifier returned by mysqli_connect() or mysqli_init() * @return string|null A string that represents the MySQL client library version */ -function mysqli_get_client_info (?mysqli $mysql): ?string {} +function mysqli_get_client_info(?mysqli $mysql): ?string {} /** * Returns the MySQL client version as an integer * @link https://php.net/manual/en/mysqli.get-client-version.php * @return int */ -function mysqli_get_client_version (): int {} +function mysqli_get_client_version(): int {} /** * Returns a string representing the type of connection used @@ -1850,7 +1834,7 @@ function mysqli_get_client_version (): int {} * @param mysqli $mysql A link identifier returned by mysqli_connect() or mysqli_init() * @return string A character string representing the server hostname and the connection type. */ -function mysqli_get_host_info (mysqli $mysql): string {} +function mysqli_get_host_info(mysqli $mysql): string {} /** * Return information about open and cached links @@ -1895,7 +1879,7 @@ function mysqli_get_links_stats(): array {} * @param mysqli $mysql A link identifier returned by mysqli_connect() or mysqli_init() * @return int Returns an integer representing the protocol version */ -function mysqli_get_proto_info (mysqli $mysql): int {} +function mysqli_get_proto_info(mysqli $mysql): int {} /** * Returns the version of the MySQL server @@ -1903,7 +1887,7 @@ function mysqli_get_proto_info (mysqli $mysql): int {} * @param mysqli $mysql A link identifier returned by mysqli_connect() or mysqli_init() * @return string A character string representing the server version. */ -function mysqli_get_server_info (mysqli $mysql): string {} +function mysqli_get_server_info(mysqli $mysql): string {} /** * Returns the version of the MySQL server as an integer @@ -1912,7 +1896,7 @@ function mysqli_get_server_info (mysqli $mysql): string {} * @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). */ -function mysqli_get_server_version (mysqli $mysql): int {} +function mysqli_get_server_version(mysqli $mysql): int {} /** * Get result of SHOW WARNINGS @@ -1920,7 +1904,7 @@ function mysqli_get_server_version (mysqli $mysql): int {} * @param mysqli $mysql A link identifier returned by mysqli_connect() or mysqli_init() * @return mysqli_warning|false */ -function mysqli_get_warnings (mysqli $mysql): mysqli_warning|false {} +function mysqli_get_warnings(mysqli $mysql): mysqli_warning|false {} /** * Initializes MySQLi and returns a resource for use with mysqli_real_connect() @@ -1928,7 +1912,7 @@ function mysqli_get_warnings (mysqli $mysql): mysqli_warning|false {} * @return mysqli|false * @see mysqli_real_connect() */ -function mysqli_init (): mysqli|false {} +function mysqli_init(): mysqli|false {} /** * Retrieves information about the most recently executed query @@ -1936,7 +1920,7 @@ function mysqli_init (): mysqli|false {} * @param mysqli $mysql A link identifier returned by mysqli_connect() or mysqli_init() * @return string|null A character string representing additional information about the most recently executed query. */ -function mysqli_info (mysqli $mysql): ?string {} +function mysqli_info(mysqli $mysql): ?string {} /** * Returns the auto generated id used in the last query @@ -1945,8 +1929,7 @@ function mysqli_info (mysqli $mysql): ?string {} * @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. * If the number is greater than maximal int value, mysqli_insert_id() will return a string. */ -function mysqli_insert_id (mysqli $mysql): string|int -{} +function mysqli_insert_id(mysqli $mysql): string|int {} /** * Asks the server to kill a MySQL thread @@ -1956,8 +1939,7 @@ function mysqli_insert_id (mysqli $mysql): string|int * @param int $process_id * @return bool */ -function mysqli_kill (mysqli $mysql, int $process_id): bool -{} +function mysqli_kill(mysqli $mysql, int $process_id): bool {} /** * Unsets user defined handler for load local infile command @@ -1965,7 +1947,7 @@ function mysqli_kill (mysqli $mysql, int $process_id): bool * @param mysqli $mysql A link identifier returned by mysqli_connect() or mysqli_init() * @return void */ -function mysqli_set_local_infile_default (mysqli $mysql) {} +function mysqli_set_local_infile_default(mysqli $mysql) {} /** * Set callback function for LOAD DATA LOCAL INFILE command @@ -1974,8 +1956,7 @@ function mysqli_set_local_infile_default (mysqli $mysql) {} * @param callable $read_func * @return bool */ -function mysqli_set_local_infile_handler (mysqli $mysql, callable $read_func): bool -{} +function mysqli_set_local_infile_handler(mysqli $mysql, callable $read_func): bool {} /** * Check if there are any more query results from a multi query @@ -1984,8 +1965,7 @@ function mysqli_set_local_infile_handler (mysqli $mysql, callable $read_func): b * @param mysqli $mysql A link identifier returned by mysqli_connect() or mysqli_init() * @return bool */ -function mysqli_more_results (mysqli $mysql): bool -{} +function mysqli_more_results(mysqli $mysql): bool {} /** * Performs a query on the database @@ -1994,8 +1974,7 @@ function mysqli_more_results (mysqli $mysql): bool * @param string $query One or more queries which are separated by semicolons. * @return bool Returns FALSE if the first statement failed. To retrieve subsequent errors from other statements you have to call mysqli_next_result() first. */ -function mysqli_multi_query (mysqli $mysql, string $query): bool -{} +function mysqli_multi_query(mysqli $mysql, string $query): bool {} /** * Prepare next result from multi_query @@ -2003,8 +1982,7 @@ function mysqli_multi_query (mysqli $mysql, string $query): bool * @param mysqli $mysql A link identifier returned by mysqli_connect() or mysqli_init() * @return bool */ -function mysqli_next_result (mysqli $mysql): bool -{} +function mysqli_next_result(mysqli $mysql): bool {} /** * Get the number of fields in a result @@ -2013,8 +1991,7 @@ function mysqli_next_result (mysqli $mysql): bool * mysqli_store_result() or mysqli_use_result(). * @return int */ -function mysqli_num_fields (mysqli_result $result): int -{} +function mysqli_num_fields(mysqli_result $result): int {} /** * Gets the number of rows in a result @@ -2023,8 +2000,7 @@ function mysqli_num_fields (mysqli_result $result): int * mysqli_store_result() or mysqli_use_result(). * @return string|int Returns number of rows in the result set. */ -function mysqli_num_rows (mysqli_result $result): string|int -{} +function mysqli_num_rows(mysqli_result $result): string|int {} /** * Set options @@ -2034,8 +2010,7 @@ function mysqli_num_rows (mysqli_result $result): string|int * @param mixed $value * @return bool */ -function mysqli_options (mysqli $mysql, int $option, $value): bool -{} +function mysqli_options(mysqli $mysql, int $option, $value): bool {} /** * Pings a server connection, or tries to reconnect if the connection has gone down @@ -2043,8 +2018,7 @@ function mysqli_options (mysqli $mysql, int $option, $value): bool * @param mysqli $mysql A link identifier returned by mysqli_connect() or mysqli_init() * @return bool */ -function mysqli_ping (mysqli $mysql): bool -{} +function mysqli_ping(mysqli $mysql): bool {} /** * Poll connections @@ -2056,8 +2030,7 @@ function mysqli_ping (mysqli $mysql): bool * @param int $microseconds [optional] * @return int|false number of ready connections upon success, FALSE otherwise. */ -function mysqli_poll (?array &$read, ?array &$error, array &$reject, int $seconds, int $microseconds = 0): int|false -{} +function mysqli_poll(?array &$read, ?array &$error, array &$reject, int $seconds, int $microseconds = 0): int|false {} /** * Prepare an SQL statement for execution @@ -2066,8 +2039,7 @@ function mysqli_poll (?array &$read, ?array &$error, array &$reject, int $second * @param string $query * @return mysqli_stmt|false A statement object or FALSE if an error occurred. */ -function mysqli_prepare (mysqli $mysql, string $query): mysqli_stmt|false -{} +function mysqli_prepare(mysqli $mysql, string $query): mysqli_stmt|false {} /** * Enables or disables internal report functions @@ -2106,8 +2078,7 @@ function mysqli_prepare (mysqli $mysql, string $query): mysqli_stmt|false * * @return bool */ -function mysqli_report (int $flags): bool -{} +function mysqli_report(int $flags): bool {} /** * Performs a query on the database @@ -2120,8 +2091,7 @@ function mysqli_report (int $flags): bool * For other successful queries mysqli_query() will return TRUE. * Returns FALSE on failure. */ -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 = MYSQLI_STORE_RESULT): mysqli_result|bool {} /** * Opens a connection to a mysql server @@ -2137,8 +2107,7 @@ function mysqli_query (mysqli $mysql, string $query, int $result_mode = MYSQLI_S * @param int $flags [optional] * @return bool */ -function mysqli_real_connect (mysqli $mysql, ?string $hostname, ?string $username, ?string $password, ?string $database, ?int $port, ?string $socket, int $flags): bool -{} +function mysqli_real_connect(mysqli $mysql, ?string $hostname, ?string $username, ?string $password, ?string $database, ?int $port, ?string $socket, int $flags): bool {} /** * Escapes special characters in a string for use in an SQL statement, taking into account the current charset of the connection @@ -2147,8 +2116,7 @@ function mysqli_real_connect (mysqli $mysql, ?string $hostname, ?string $usernam * @param string $string The string to be escaped. Characters encoded are NUL (ASCII 0), \n, \r, \, ', ", and Control-Z. * @return string */ -function mysqli_real_escape_string (mysqli $mysql, string $string): string -{} +function mysqli_real_escape_string(mysqli $mysql, string $string): string {} /** * Execute an SQL query @@ -2158,8 +2126,7 @@ function mysqli_real_escape_string (mysqli $mysql, string $string): string * @param string $query * @return bool */ -function mysqli_real_query (mysqli $mysql, string $query): bool -{} +function mysqli_real_query(mysqli $mysql, string $query): bool {} /** * Get result from async query @@ -2169,8 +2136,7 @@ function mysqli_real_query (mysqli $mysql, string $query): bool * @param mysqli $mysql A link identifier returned by mysqli_connect() or mysqli_init() * @return mysqli_result|bool mysqli_result in success, FALSE otherwise. */ -function mysqli_reap_async_query (mysqli $mysql): mysqli_result|bool -{} +function mysqli_reap_async_query(mysqli $mysql): mysqli_result|bool {} /** * Removes the named savepoint from the set of savepoints of the current transaction @@ -2180,8 +2146,7 @@ function mysqli_reap_async_query (mysqli $mysql): mysqli_result|bool * @return bool Returns TRUE on success or FALSE on failure. * @since 5.5 */ -function mysqli_release_savepoint (mysqli $mysql, string $name): bool -{} +function mysqli_release_savepoint(mysqli $mysql, string $name): bool {} /** * Rolls back current transaction @@ -2191,8 +2156,7 @@ function mysqli_release_savepoint (mysqli $mysql, string $name): bool * @param string|null $name [optional] If provided then ROLLBACKname is executed * @return bool */ -function mysqli_rollback (mysqli $mysql, int $flags = 0, ?string $name): bool -{} +function mysqli_rollback(mysqli $mysql, int $flags = 0, ?string $name): bool {} /** * Set a named transaction savepoint @@ -2202,8 +2166,7 @@ function mysqli_rollback (mysqli $mysql, int $flags = 0, ?string $name): bool * @return bool Returns TRUE on success or FALSE on failure. * @since 5.5 */ -function mysqli_savepoint (mysqli $mysql, string $name): bool -{} +function mysqli_savepoint(mysqli $mysql, string $name): bool {} /** * Selects the default database for database queries @@ -2212,8 +2175,7 @@ function mysqli_savepoint (mysqli $mysql, string $name): bool * @param string $database * @return bool */ -function mysqli_select_db (mysqli $mysql, string $database): bool -{} +function mysqli_select_db(mysqli $mysql, string $database): bool {} /** * Sets the default client character set @@ -2222,8 +2184,7 @@ function mysqli_select_db (mysqli $mysql, string $database): bool * @param string $charset * @return bool */ -function mysqli_set_charset (mysqli $mysql, string $charset): bool -{} +function mysqli_set_charset(mysqli $mysql, string $charset): bool {} /** * Returns the total number of rows changed, deleted, or inserted by the last executed statement @@ -2231,8 +2192,7 @@ function mysqli_set_charset (mysqli $mysql, string $charset): bool * @param mysqli_stmt $statement * @return int|string If the number of affected rows is greater than maximal PHP int value, the number of affected rows will be returned as a string value. */ -function mysqli_stmt_affected_rows (mysqli_stmt $statement): string|int -{} +function mysqli_stmt_affected_rows(mysqli_stmt $statement): string|int {} /** * Used to get the current value of a statement attribute @@ -2242,8 +2202,7 @@ function mysqli_stmt_affected_rows (mysqli_stmt $statement): string|int * @return int|false Returns FALSE if the attribute is not found, otherwise returns the value of the attribute. */ #[LanguageLevelTypeAware(["8.0" => "int"], default: "int|false")] -function mysqli_stmt_attr_get (mysqli_stmt $statement, int $attribute): false|int -{} +function mysqli_stmt_attr_get(mysqli_stmt $statement, int $attribute): false|int {} /** * Used to modify the behavior of a prepared statement @@ -2253,8 +2212,7 @@ function mysqli_stmt_attr_get (mysqli_stmt $statement, int $attribute): false|in * @param int $value * @return bool */ -function mysqli_stmt_attr_set (mysqli_stmt $statement, int $attribute, int $value): bool -{} +function mysqli_stmt_attr_set(mysqli_stmt $statement, int $attribute, int $value): bool {} /** * Returns the number of fields in the given statement @@ -2262,8 +2220,7 @@ function mysqli_stmt_attr_set (mysqli_stmt $statement, int $attribute, int $valu * @param mysqli_stmt $statement * @return int */ -function mysqli_stmt_field_count (mysqli_stmt $statement): int -{} +function mysqli_stmt_field_count(mysqli_stmt $statement): int {} /** * Initializes a statement and returns an object for use with mysqli_stmt_prepare @@ -2271,8 +2228,7 @@ function mysqli_stmt_field_count (mysqli_stmt $statement): int * @param mysqli $mysql A link identifier returned by mysqli_connect() or mysqli_init() * @return mysqli_stmt|false */ -function mysqli_stmt_init (mysqli $mysql): mysqli_stmt|false -{} +function mysqli_stmt_init(mysqli $mysql): mysqli_stmt|false {} /** * Prepare an SQL statement for execution @@ -2281,8 +2237,7 @@ function mysqli_stmt_init (mysqli $mysql): mysqli_stmt|false * @param string $query * @return bool */ -function mysqli_stmt_prepare (mysqli_stmt $statement, string $query): bool -{} +function mysqli_stmt_prepare(mysqli_stmt $statement, string $query): bool {} /** * Returns result set metadata from a prepared statement @@ -2290,8 +2245,7 @@ function mysqli_stmt_prepare (mysqli_stmt $statement, string $query): bool * @param mysqli_stmt $statement * @return mysqli_result|false Returns a result object or FALSE if an error occurred */ -function mysqli_stmt_result_metadata (mysqli_stmt $statement): mysqli_result|false -{} +function mysqli_stmt_result_metadata(mysqli_stmt $statement): mysqli_result|false {} /** * Send data in blocks @@ -2301,8 +2255,7 @@ function mysqli_stmt_result_metadata (mysqli_stmt $statement): mysqli_result|fal * @param string $data * @return bool */ -function mysqli_stmt_send_long_data (mysqli_stmt $statement, int $param_num, string $data): bool -{} +function mysqli_stmt_send_long_data(mysqli_stmt $statement, int $param_num, string $data): bool {} /** * Binds variables to a prepared statement as parameters @@ -2342,8 +2295,7 @@ function mysqli_stmt_send_long_data (mysqli_stmt $statement, int $param_num, str * @param mixed &...$_ [optional] * @return bool true on success or false on failure. */ -function mysqli_stmt_bind_param (mysqli_stmt $statement, string $types, mixed &$var1, &...$_): bool -{} +function mysqli_stmt_bind_param(mysqli_stmt $statement, string $types, mixed &$var1, &...$_): bool {} /** * Binds variables to a prepared statement for result storage @@ -2353,8 +2305,7 @@ function mysqli_stmt_bind_param (mysqli_stmt $statement, string $types, mixed &$ * @param mixed &...$_ The variables to be bound. * @return bool */ -function mysqli_stmt_bind_result (mysqli_stmt $statement, mixed &$var1, &...$_): bool -{} +function mysqli_stmt_bind_result(mysqli_stmt $statement, mixed &$var1, &...$_): bool {} /** * Fetch results from a prepared statement into the bound variables @@ -2362,8 +2313,7 @@ function mysqli_stmt_bind_result (mysqli_stmt $statement, mixed &$var1, &...$_): * @param mysqli_stmt $statement * @return bool|null */ -function mysqli_stmt_fetch (mysqli_stmt $statement): ?bool -{} +function mysqli_stmt_fetch(mysqli_stmt $statement): ?bool {} /** * Frees stored result memory for the given statement handle @@ -2371,7 +2321,7 @@ function mysqli_stmt_fetch (mysqli_stmt $statement): ?bool * @param mysqli_stmt $statement * @return void */ -function mysqli_stmt_free_result (mysqli_stmt $statement): void {} +function mysqli_stmt_free_result(mysqli_stmt $statement): void {} /** * Gets a result set from a prepared statement @@ -2379,8 +2329,7 @@ function mysqli_stmt_free_result (mysqli_stmt $statement): void {} * @param mysqli_stmt $statement * @return mysqli_result|false Returns a resultset or FALSE on failure. */ -function mysqli_stmt_get_result (mysqli_stmt $statement): mysqli_result|false -{} +function mysqli_stmt_get_result(mysqli_stmt $statement): mysqli_result|false {} /** * Get result of SHOW WARNINGS @@ -2388,8 +2337,7 @@ function mysqli_stmt_get_result (mysqli_stmt $statement): mysqli_result|false * @param mysqli_stmt $statement * @return mysqli_warning|false (not documented, but it's probably a mysqli_warning object) */ -function mysqli_stmt_get_warnings (mysqli_stmt $statement): mysqli_warning|false -{} +function mysqli_stmt_get_warnings(mysqli_stmt $statement): mysqli_warning|false {} /** * Get the ID generated from the previous INSERT operation @@ -2397,8 +2345,7 @@ function mysqli_stmt_get_warnings (mysqli_stmt $statement): mysqli_warning|false * @param mysqli_stmt $statement * @return string|int */ -function mysqli_stmt_insert_id (mysqli_stmt $statement): string|int -{} +function mysqli_stmt_insert_id(mysqli_stmt $statement): string|int {} /** * Resets a prepared statement @@ -2406,8 +2353,7 @@ function mysqli_stmt_insert_id (mysqli_stmt $statement): string|int * @param mysqli_stmt $statement * @return bool */ -function mysqli_stmt_reset (mysqli_stmt $statement): bool -{} +function mysqli_stmt_reset(mysqli_stmt $statement): bool {} /** * Returns the number of parameter for the given statement @@ -2415,8 +2361,7 @@ function mysqli_stmt_reset (mysqli_stmt $statement): bool * @param mysqli_stmt $statement * @return int */ -function mysqli_stmt_param_count (mysqli_stmt $statement): int -{} +function mysqli_stmt_param_count(mysqli_stmt $statement): int {} /** * Returns the SQLSTATE error from previous MySQL operation @@ -2424,8 +2369,7 @@ function mysqli_stmt_param_count (mysqli_stmt $statement): int * @param mysqli $mysql A link identifier returned by mysqli_connect() or mysqli_init() * @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. */ -function mysqli_sqlstate (mysqli $mysql): string -{} +function mysqli_sqlstate(mysqli $mysql): string {} /** * Gets the current system status @@ -2433,8 +2377,7 @@ function mysqli_sqlstate (mysqli $mysql): string * @param mysqli $mysql A link identifier returned by mysqli_connect() or mysqli_init() * @return string|false A string describing the server status. FALSE if an error occurred. */ -function mysqli_stat (mysqli $mysql): string|false -{} +function mysqli_stat(mysqli $mysql): string|false {} /** * Used for establishing secure connections using SSL @@ -2451,9 +2394,8 @@ function mysqli_ssl_set(mysqli $mysql, #[LanguageLevelTypeAware(['8.0' => '?string'], default: 'string')] $key , #[LanguageLevelTypeAware(['8.0' => '?string'], default: 'string')] $certificate , #[LanguageLevelTypeAware(['8.0' => '?string'], default: 'string')] $ca_certificate , - #[LanguageLevelTypeAware(['8.0' => '?string'], default: 'string')] $ca_path , - #[LanguageLevelTypeAware(['8.0' => '?string'], default: 'string')] $cipher_algos): bool -{} + #[LanguageLevelTypeAware(['8.0' => '?string'], default: 'string')] $ca_path, + #[LanguageLevelTypeAware(['8.0' => '?string'], default: 'string')] $cipher_algos): bool {} /** * Closes a prepared statement @@ -2461,8 +2403,7 @@ function mysqli_ssl_set(mysqli $mysql, * @param mysqli_stmt $statement * @return bool */ -function mysqli_stmt_close (mysqli_stmt $statement): bool -{} +function mysqli_stmt_close(mysqli_stmt $statement): bool {} /** * Seeks to an arbitrary row in statement result set @@ -2471,7 +2412,7 @@ function mysqli_stmt_close (mysqli_stmt $statement): bool * @param int $offset * @return void */ -function mysqli_stmt_data_seek (mysqli_stmt $statement, int $offset): void {} +function mysqli_stmt_data_seek(mysqli_stmt $statement, int $offset): void {} /** * Returns the error code for the most recent statement call @@ -2479,8 +2420,7 @@ function mysqli_stmt_data_seek (mysqli_stmt $statement, int $offset): void {} * @param mysqli_stmt $statement * @return int */ -function mysqli_stmt_errno (mysqli_stmt $statement): int -{} +function mysqli_stmt_errno(mysqli_stmt $statement): int {} /** * Returns a string description for last statement error @@ -2488,8 +2428,7 @@ function mysqli_stmt_errno (mysqli_stmt $statement): int * @param mysqli_stmt $statement * @return string */ -function mysqli_stmt_error (mysqli_stmt $statement): string -{} +function mysqli_stmt_error(mysqli_stmt $statement): string {} /** * Check if there are more query results from a multiple query @@ -2497,8 +2436,7 @@ function mysqli_stmt_error (mysqli_stmt $statement): string * @param mysqli_stmt $statement * @return bool */ -function mysqli_stmt_more_results (mysqli_stmt $statement): bool -{} +function mysqli_stmt_more_results(mysqli_stmt $statement): bool {} /** * Reads the next result from a multiple query @@ -2506,8 +2444,7 @@ function mysqli_stmt_more_results (mysqli_stmt $statement): bool * @param mysqli_stmt $statement * @return bool */ -function mysqli_stmt_next_result (mysqli_stmt $statement): bool -{} +function mysqli_stmt_next_result(mysqli_stmt $statement): bool {} /** * Return the number of rows in statements result set @@ -2515,8 +2452,7 @@ function mysqli_stmt_next_result (mysqli_stmt $statement): bool * @param mysqli_stmt $statement * @return string|int */ -function mysqli_stmt_num_rows (mysqli_stmt $statement): string|int -{} +function mysqli_stmt_num_rows(mysqli_stmt $statement): string|int {} /** * Returns SQLSTATE error from previous statement operation @@ -2524,8 +2460,7 @@ function mysqli_stmt_num_rows (mysqli_stmt $statement): string|int * @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. */ -function mysqli_stmt_sqlstate (mysqli_stmt $statement): string -{} +function mysqli_stmt_sqlstate(mysqli_stmt $statement): string {} /** * Transfers a result set from a prepared statement @@ -2533,8 +2468,7 @@ function mysqli_stmt_sqlstate (mysqli_stmt $statement): string * @param mysqli_stmt $statement * @return bool */ -function mysqli_stmt_store_result (mysqli_stmt $statement): bool -{} +function mysqli_stmt_store_result(mysqli_stmt $statement): bool {} /** * Transfers a result set from the last query @@ -2543,8 +2477,7 @@ function mysqli_stmt_store_result (mysqli_stmt $statement): bool * @param int $mode [optional] The option that you want to set * @return mysqli_result|false */ -function mysqli_store_result (mysqli $mysql, int $mode): mysqli_result|false -{} +function mysqli_store_result(mysqli $mysql, int $mode): mysqli_result|false {} /** * Returns the thread ID for the current connection @@ -2552,16 +2485,14 @@ function mysqli_store_result (mysqli $mysql, int $mode): mysqli_result|false * @param mysqli $mysql A link identifier returned by mysqli_connect() or mysqli_init() * @return int Returns the Thread ID for the current connection. */ -function mysqli_thread_id (mysqli $mysql): int -{} +function mysqli_thread_id(mysqli $mysql): int {} /** * Returns whether thread safety is given or not * @link https://php.net/manual/en/mysqli.thread-safe.php * @return bool */ -function mysqli_thread_safe (): bool -{} +function mysqli_thread_safe(): bool {} /** * Initiate a result set retrieval @@ -2569,8 +2500,7 @@ function mysqli_thread_safe (): bool * @param mysqli $mysql A link identifier returned by mysqli_connect() or mysqli_init() * @return mysqli_result|false */ -function mysqli_use_result (mysqli $mysql): mysqli_result|false -{} +function mysqli_use_result(mysqli $mysql): mysqli_result|false {} /** * Returns the number of warnings from the last query for the given link @@ -2578,8 +2508,7 @@ function mysqli_use_result (mysqli $mysql): mysqli_result|false * @param mysqli $mysql A link identifier returned by mysqli_connect() or mysqli_init() * @return int */ -function mysqli_warning_count (mysqli $mysql): int -{} +function mysqli_warning_count(mysqli $mysql): int {} /** * Flushes tables or caches, or resets the replication server information @@ -2588,8 +2517,7 @@ function mysqli_warning_count (mysqli $mysql): int * @param int $flags * @return bool */ -function mysqli_refresh (mysqli $mysql, int $flags): bool -{} +function mysqli_refresh(mysqli $mysql, int $flags): bool {} /** * Alias for mysqli_stmt_bind_param @@ -2599,7 +2527,7 @@ function mysqli_refresh (mysqli $mysql, int $flags): bool * @removed 5.4 */ #[Deprecated(since: '5.3')] -function mysqli_bind_param (mysqli_stmt $statement, string $types) {} +function mysqli_bind_param(mysqli_stmt $statement, string $types) {} /** * Alias for mysqli_stmt_bind_result @@ -2610,7 +2538,7 @@ function mysqli_bind_param (mysqli_stmt $statement, string $types) {} * @removed 5.4 */ #[Deprecated(since: '5.3')] -function mysqli_bind_result (mysqli_stmt $statement, string $types, mixed &$var1) {} +function mysqli_bind_result(mysqli_stmt $statement, string $types, mixed &$var1) {} /** * Alias of mysqli_character_set_name @@ -2620,8 +2548,7 @@ function mysqli_bind_result (mysqli_stmt $statement, string $types, mixed &$var1 * @removed 5.4 */ #[Deprecated(since: '5.3')] -function mysqli_client_encoding (mysqli $mysql): string -{} +function mysqli_client_encoding(mysqli $mysql): string {} /** * Alias of mysqli_real_escape_string @@ -2630,8 +2557,7 @@ function mysqli_client_encoding (mysqli $mysql): string * @param string $string The string to be escaped * @return string */ -function mysqli_escape_string (mysqli $mysql, string $string): string -{} +function mysqli_escape_string(mysqli $mysql, string $string): string {} /** * Alias for mysqli_stmt_fetch @@ -2641,8 +2567,7 @@ function mysqli_escape_string (mysqli $mysql, string $string): string * @removed 5.4 */ #[Deprecated(since: '5.3')] -function mysqli_fetch (mysqli_stmt $statement): bool -{} +function mysqli_fetch(mysqli_stmt $statement): bool {} /** * Alias for mysqli_stmt_param_count @@ -2652,8 +2577,7 @@ function mysqli_fetch (mysqli_stmt $statement): bool * @removed 5.4 */ #[Deprecated(since: '5.3')] -function mysqli_param_count (mysqli_stmt $statement): int -{} +function mysqli_param_count(mysqli_stmt $statement): int {} /** * Alias for mysqli_stmt_result_metadata @@ -2663,8 +2587,7 @@ function mysqli_param_count (mysqli_stmt $statement): int * @removed 5.4 */ #[Deprecated(since: '5.3')] -function mysqli_get_metadata (mysqli_stmt $statement): false|mysqli_result -{} +function mysqli_get_metadata(mysqli_stmt $statement): false|mysqli_result {} /** * Alias for mysqli_stmt_send_long_data @@ -2676,8 +2599,7 @@ function mysqli_get_metadata (mysqli_stmt $statement): false|mysqli_result * @removed 5.4 */ #[Deprecated(since: '5.3')] -function mysqli_send_long_data (mysqli_stmt $statement, int $param_num, string $data): bool -{} +function mysqli_send_long_data(mysqli_stmt $statement, int $param_num, string $data): bool {} /** * Alias of mysqli_options @@ -2687,9 +2609,7 @@ function mysqli_send_long_data (mysqli_stmt $statement, int $param_num, string $ * @param mixed $value * @return bool */ -function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool -{} - +function mysqli_set_opt(mysqli $mysql, int $option, mixed $value): bool {} /** *@@ -2698,7 +2618,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_READ_DEFAULT_GROUP', 5); +define('MYSQLI_READ_DEFAULT_GROUP', 5); /** *@@ -2706,7 +2626,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_READ_DEFAULT_FILE', 4); +define('MYSQLI_READ_DEFAULT_FILE', 4); /** *@@ -2714,7 +2634,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_OPT_CONNECT_TIMEOUT', 0); +define('MYSQLI_OPT_CONNECT_TIMEOUT', 0); /** *@@ -2722,7 +2642,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_OPT_LOCAL_INFILE', 8); +define('MYSQLI_OPT_LOCAL_INFILE', 8); /** *@@ -2730,7 +2650,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_SERVER_PUBLIC_KEY', 35); +define('MYSQLI_SERVER_PUBLIC_KEY', 35); /** *@@ -2738,10 +2658,10 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_INIT_COMMAND', 3); -define ('MYSQLI_OPT_NET_CMD_BUFFER_SIZE', 202); -define ('MYSQLI_OPT_NET_READ_BUFFER_SIZE', 203); -define ('MYSQLI_OPT_INT_AND_FLOAT_NATIVE', 201); +define('MYSQLI_INIT_COMMAND', 3); +define('MYSQLI_OPT_NET_CMD_BUFFER_SIZE', 202); +define('MYSQLI_OPT_NET_READ_BUFFER_SIZE', 203); +define('MYSQLI_OPT_INT_AND_FLOAT_NATIVE', 201); /** *@@ -2750,7 +2670,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_CLIENT_SSL', 2048); +define('MYSQLI_CLIENT_SSL', 2048); /** *@@ -2758,7 +2678,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_CLIENT_COMPRESS', 32); +define('MYSQLI_CLIENT_COMPRESS', 32); /** *@@ -2770,7 +2690,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_CLIENT_INTERACTIVE', 1024); +define('MYSQLI_CLIENT_INTERACTIVE', 1024); /** *@@ -2778,7 +2698,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_CLIENT_IGNORE_SPACE', 256); +define('MYSQLI_CLIENT_IGNORE_SPACE', 256); /** *@@ -2786,8 +2706,8 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_CLIENT_NO_SCHEMA', 16); -define ('MYSQLI_CLIENT_FOUND_ROWS', 2); +define('MYSQLI_CLIENT_NO_SCHEMA', 16); +define('MYSQLI_CLIENT_FOUND_ROWS', 2); /** *@@ -2795,7 +2715,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_STORE_RESULT', 0); +define('MYSQLI_STORE_RESULT', 0); /** *@@ -2803,8 +2723,8 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_USE_RESULT', 1); -define ('MYSQLI_ASYNC', 8); +define('MYSQLI_USE_RESULT', 1); +define('MYSQLI_ASYNC', 8); /** *@@ -2812,7 +2732,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_ASSOC', 1); +define('MYSQLI_ASSOC', 1); /** *@@ -2820,7 +2740,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_NUM', 2); +define('MYSQLI_NUM', 2); /** *@@ -2828,42 +2748,42 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_BOTH', 3); +define('MYSQLI_BOTH', 3); /** * @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_STMT_ATTR_UPDATE_MAX_LENGTH', 0); +define('MYSQLI_STMT_ATTR_UPDATE_MAX_LENGTH', 0); /** * @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_STMT_ATTR_CURSOR_TYPE', 1); +define('MYSQLI_STMT_ATTR_CURSOR_TYPE', 1); /** * @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_CURSOR_TYPE_NO_CURSOR', 0); +define('MYSQLI_CURSOR_TYPE_NO_CURSOR', 0); /** * @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_CURSOR_TYPE_READ_ONLY', 1); +define('MYSQLI_CURSOR_TYPE_READ_ONLY', 1); /** * @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_CURSOR_TYPE_FOR_UPDATE', 2); +define('MYSQLI_CURSOR_TYPE_FOR_UPDATE', 2); /** * @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_CURSOR_TYPE_SCROLLABLE', 4); +define('MYSQLI_CURSOR_TYPE_SCROLLABLE', 4); /** * @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_STMT_ATTR_PREFETCH_ROWS', 2); +define('MYSQLI_STMT_ATTR_PREFETCH_ROWS', 2); /** *@@ -2871,7 +2791,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_NOT_NULL_FLAG', 1); +define('MYSQLI_NOT_NULL_FLAG', 1); /** *@@ -2879,7 +2799,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_PRI_KEY_FLAG', 2); +define('MYSQLI_PRI_KEY_FLAG', 2); /** *@@ -2887,7 +2807,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_UNIQUE_KEY_FLAG', 4); +define('MYSQLI_UNIQUE_KEY_FLAG', 4); /** *@@ -2895,7 +2815,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_MULTIPLE_KEY_FLAG', 8); +define('MYSQLI_MULTIPLE_KEY_FLAG', 8); /** *@@ -2903,7 +2823,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_BLOB_FLAG', 16); +define('MYSQLI_BLOB_FLAG', 16); /** *@@ -2911,7 +2831,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_UNSIGNED_FLAG', 32); +define('MYSQLI_UNSIGNED_FLAG', 32); /** *@@ -2919,7 +2839,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_ZEROFILL_FLAG', 64); +define('MYSQLI_ZEROFILL_FLAG', 64); /** *@@ -2927,7 +2847,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_AUTO_INCREMENT_FLAG', 512); +define('MYSQLI_AUTO_INCREMENT_FLAG', 512); /** *@@ -2935,7 +2855,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_TIMESTAMP_FLAG', 1024); +define('MYSQLI_TIMESTAMP_FLAG', 1024); /** *@@ -2943,7 +2863,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_SET_FLAG', 2048); +define('MYSQLI_SET_FLAG', 2048); /** *@@ -2951,7 +2871,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_NUM_FLAG', 32768); +define('MYSQLI_NUM_FLAG', 32768); /** *@@ -2959,7 +2879,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_PART_KEY_FLAG', 16384); +define('MYSQLI_PART_KEY_FLAG', 16384); /** *@@ -2967,7 +2887,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_GROUP_FLAG', 32768); +define('MYSQLI_GROUP_FLAG', 32768); /** *@@ -2975,10 +2895,10 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_ENUM_FLAG', 256); -define ('MYSQLI_BINARY_FLAG', 128); -define ('MYSQLI_NO_DEFAULT_VALUE_FLAG', 4096); -define ('MYSQLI_ON_UPDATE_NOW_FLAG', 8192); +define('MYSQLI_ENUM_FLAG', 256); +define('MYSQLI_BINARY_FLAG', 128); +define('MYSQLI_NO_DEFAULT_VALUE_FLAG', 4096); +define('MYSQLI_ON_UPDATE_NOW_FLAG', 8192); define('MYSQLI_TRANS_START_READ_ONLY', 4); define('MYSQLI_TRANS_START_READ_WRITE', 2); @@ -2989,7 +2909,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool * * @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_TYPE_DECIMAL', 0); +define('MYSQLI_TYPE_DECIMAL', 0); /** *@@ -2997,7 +2917,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_TYPE_TINY', 1); +define('MYSQLI_TYPE_TINY', 1); /** *@@ -3005,7 +2925,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_TYPE_SHORT', 2); +define('MYSQLI_TYPE_SHORT', 2); /** *@@ -3013,7 +2933,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_TYPE_LONG', 3); +define('MYSQLI_TYPE_LONG', 3); /** *@@ -3021,7 +2941,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_TYPE_FLOAT', 4); +define('MYSQLI_TYPE_FLOAT', 4); /** *@@ -3029,7 +2949,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_TYPE_DOUBLE', 5); +define('MYSQLI_TYPE_DOUBLE', 5); /** *@@ -3037,7 +2957,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_TYPE_NULL', 6); +define('MYSQLI_TYPE_NULL', 6); /** *@@ -3045,7 +2965,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_TYPE_TIMESTAMP', 7); +define('MYSQLI_TYPE_TIMESTAMP', 7); /** *@@ -3053,7 +2973,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_TYPE_LONGLONG', 8); +define('MYSQLI_TYPE_LONGLONG', 8); /** *@@ -3061,7 +2981,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_TYPE_INT24', 9); +define('MYSQLI_TYPE_INT24', 9); /** *@@ -3069,7 +2989,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_TYPE_DATE', 10); +define('MYSQLI_TYPE_DATE', 10); /** *@@ -3077,7 +2997,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_TYPE_TIME', 11); +define('MYSQLI_TYPE_TIME', 11); /** *@@ -3085,7 +3005,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_TYPE_DATETIME', 12); +define('MYSQLI_TYPE_DATETIME', 12); /** *@@ -3093,7 +3013,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_TYPE_YEAR', 13); +define('MYSQLI_TYPE_YEAR', 13); /** *@@ -3101,7 +3021,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_TYPE_NEWDATE', 14); +define('MYSQLI_TYPE_NEWDATE', 14); /** *@@ -3109,7 +3029,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_TYPE_ENUM', 247); +define('MYSQLI_TYPE_ENUM', 247); /** *@@ -3117,7 +3037,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_TYPE_SET', 248); +define('MYSQLI_TYPE_SET', 248); /** *@@ -3125,7 +3045,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_TYPE_TINY_BLOB', 249); +define('MYSQLI_TYPE_TINY_BLOB', 249); /** *@@ -3133,7 +3053,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_TYPE_MEDIUM_BLOB', 250); +define('MYSQLI_TYPE_MEDIUM_BLOB', 250); /** *@@ -3141,7 +3061,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_TYPE_LONG_BLOB', 251); +define('MYSQLI_TYPE_LONG_BLOB', 251); /** *@@ -3149,7 +3069,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_TYPE_BLOB', 252); +define('MYSQLI_TYPE_BLOB', 252); /** *@@ -3157,7 +3077,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_TYPE_VAR_STRING', 253); +define('MYSQLI_TYPE_VAR_STRING', 253); /** *@@ -3165,7 +3085,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_TYPE_STRING', 254); +define('MYSQLI_TYPE_STRING', 254); /** *@@ -3173,7 +3093,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_TYPE_CHAR', 1); +define('MYSQLI_TYPE_CHAR', 1); /** *@@ -3181,7 +3101,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_TYPE_INTERVAL', 247); +define('MYSQLI_TYPE_INTERVAL', 247); /** *@@ -3189,7 +3109,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_TYPE_GEOMETRY', 255); +define('MYSQLI_TYPE_GEOMETRY', 255); /** *@@ -3197,7 +3117,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_TYPE_NEWDECIMAL', 246); +define('MYSQLI_TYPE_NEWDECIMAL', 246); /** *@@ -3205,12 +3125,12 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_TYPE_BIT', 16); +define('MYSQLI_TYPE_BIT', 16); /** * @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_SET_CHARSET_NAME', 7); +define('MYSQLI_SET_CHARSET_NAME', 7); /** *@@ -3218,7 +3138,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_NO_DATA', 100); +define('MYSQLI_NO_DATA', 100); /** *@@ -3226,7 +3146,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_DATA_TRUNCATED', 101); +define('MYSQLI_DATA_TRUNCATED', 101); /** *@@ -3234,7 +3154,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_REPORT_INDEX', 4); +define('MYSQLI_REPORT_INDEX', 4); /** *@@ -3242,7 +3162,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_REPORT_ERROR', 1); +define('MYSQLI_REPORT_ERROR', 1); /** *@@ -3250,7 +3170,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_REPORT_STRICT', 2); +define('MYSQLI_REPORT_STRICT', 2); /** *@@ -3258,7 +3178,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_REPORT_ALL', 255); +define('MYSQLI_REPORT_ALL', 255); /** *@@ -3266,7 +3186,7 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_REPORT_OFF', 0); +define('MYSQLI_REPORT_OFF', 0); /** *@@ -3274,65 +3194,63 @@ function mysqli_set_opt (mysqli $mysql, int $option, mixed $value): bool *
* @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_DEBUG_TRACE_ENABLED', 0); +define('MYSQLI_DEBUG_TRACE_ENABLED', 0); /** * @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_SERVER_QUERY_NO_GOOD_INDEX_USED', 16); +define('MYSQLI_SERVER_QUERY_NO_GOOD_INDEX_USED', 16); /** * @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_SERVER_QUERY_NO_INDEX_USED', 32); +define('MYSQLI_SERVER_QUERY_NO_INDEX_USED', 32); /** * @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_REFRESH_GRANT', 1); +define('MYSQLI_REFRESH_GRANT', 1); /** * @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_REFRESH_LOG', 2); +define('MYSQLI_REFRESH_LOG', 2); /** * @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_REFRESH_TABLES', 4); +define('MYSQLI_REFRESH_TABLES', 4); /** * @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_REFRESH_HOSTS', 8); +define('MYSQLI_REFRESH_HOSTS', 8); /** * @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_REFRESH_STATUS', 16); +define('MYSQLI_REFRESH_STATUS', 16); /** * @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_REFRESH_THREADS', 32); +define('MYSQLI_REFRESH_THREADS', 32); /** * @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_REFRESH_SLAVE', 64); +define('MYSQLI_REFRESH_SLAVE', 64); /** * @link https://php.net/manual/en/mysqli.constants.php */ -define ('MYSQLI_REFRESH_MASTER', 128); +define('MYSQLI_REFRESH_MASTER', 128); - -define ('MYSQLI_SERVER_QUERY_WAS_SLOW', 2048); -define ('MYSQLI_REFRESH_BACKUP_LOG', 2097152); +define('MYSQLI_SERVER_QUERY_WAS_SLOW', 2048); +define('MYSQLI_REFRESH_BACKUP_LOG', 2097152); // End of mysqli v.0.1 - /** @link https://php.net/manual/en/mysqli.constants.php */ define('MYSQLI_OPT_SSL_VERIFY_SERVER_CERT', 21); /** @link https://php.net/manual/en/mysqli.constants.php */ diff --git a/ncurses/ncurses.php b/ncurses/ncurses.php index 99c24f6a6..093bcf588 100644 --- a/ncurses/ncurses.php +++ b/ncurses/ncurses.php @@ -9,7 +9,7 @@ * * @return int */ -function ncurses_addch ($ch) {} +function ncurses_addch($ch) {} /** * Set fore- and background color @@ -18,7 +18,7 @@ function ncurses_addch ($ch) {} * * @return int */ -function ncurses_color_set ($pair) {} +function ncurses_color_set($pair) {} /** * Delete a ncurses window @@ -27,35 +27,35 @@ function ncurses_color_set ($pair) {} * * @return bool */ -function ncurses_delwin ($window) {} +function ncurses_delwin($window) {} /** * Stop using ncurses, clean up the screen * @link https://php.net/manual/en/function.ncurses-end.php * @return int */ -function ncurses_end () {} +function ncurses_end() {} /** * Read a character from keyboard * @link https://php.net/manual/en/function.ncurses-getch.php * @return int */ -function ncurses_getch () {} +function ncurses_getch() {} /** * Check if terminal has colors * @link https://php.net/manual/en/function.ncurses-has-colors.php * @return bool Return true if the terminal has color capacities, false otherwise. */ -function ncurses_has_colors () {} +function ncurses_has_colors() {} /** * Initialize ncurses * @link https://php.net/manual/en/function.ncurses-init.php * @return void */ -function ncurses_init () {} +function ncurses_init() {} /** * Allocate a color pair @@ -68,7 +68,7 @@ function ncurses_init () {} * * @return int */ -function ncurses_init_pair ($pair, $fg, $bg) {} +function ncurses_init_pair($pair, $fg, $bg) {} /** * Gets the RGB value for color @@ -83,7 +83,7 @@ function ncurses_init_pair ($pair, $fg, $bg) {} * * @return int */ -function ncurses_color_content ($color, &$r, &$g, &$b) {} +function ncurses_color_content($color, &$r, &$g, &$b) {} /** * Gets the RGB value for color @@ -96,7 +96,7 @@ function ncurses_color_content ($color, &$r, &$g, &$b) {} * * @return int */ -function ncurses_pair_content ($pair, &$f, &$b) {} +function ncurses_pair_content($pair, &$f, &$b) {} /** * Move output position @@ -107,7 +107,7 @@ function ncurses_pair_content ($pair, &$f, &$b) {} * * @return int */ -function ncurses_move ($y, $x) {} +function ncurses_move($y, $x) {} /** * Create a new window @@ -126,7 +126,7 @@ function ncurses_move ($y, $x) {} * * @return resource a resource ID for the new window. */ -function ncurses_newwin ($rows, $cols, $y, $x) {} +function ncurses_newwin($rows, $cols, $y, $x) {} /** * Refresh screen @@ -135,42 +135,42 @@ function ncurses_newwin ($rows, $cols, $y, $x) {} * * @return int */ -function ncurses_refresh ($ch) {} +function ncurses_refresh($ch) {} /** * Start using colors * @link https://php.net/manual/en/function.ncurses-start-color.php * @return int */ -function ncurses_start_color () {} +function ncurses_start_color() {} /** * Start using 'standout' attribute * @link https://php.net/manual/en/function.ncurses-standout.php * @return int */ -function ncurses_standout () {} +function ncurses_standout() {} /** * Stop using 'standout' attribute * @link https://php.net/manual/en/function.ncurses-standend.php * @return int */ -function ncurses_standend () {} +function ncurses_standend() {} /** * Returns baudrate of terminal * @link https://php.net/manual/en/function.ncurses-baudrate.php * @return int */ -function ncurses_baudrate () {} +function ncurses_baudrate() {} /** * Let the terminal beep * @link https://php.net/manual/en/function.ncurses-beep.php * @return int */ -function ncurses_beep () {} +function ncurses_beep() {} /** * Check if we can change terminals colors @@ -178,98 +178,98 @@ function ncurses_beep () {} * @return bool Return true if the terminal has color capabilities and you can change * the colors, false otherwise. */ -function ncurses_can_change_color () {} +function ncurses_can_change_color() {} /** * Switch of input buffering * @link https://php.net/manual/en/function.ncurses-cbreak.php * @return bool true or NCURSES_ERR if any error occurred. */ -function ncurses_cbreak () {} +function ncurses_cbreak() {} /** * Clear screen * @link https://php.net/manual/en/function.ncurses-clear.php * @return bool */ -function ncurses_clear () {} +function ncurses_clear() {} /** * Clear screen from current position to bottom * @link https://php.net/manual/en/function.ncurses-clrtobot.php * @return bool */ -function ncurses_clrtobot () {} +function ncurses_clrtobot() {} /** * Clear screen from current position to end of line * @link https://php.net/manual/en/function.ncurses-clrtoeol.php * @return bool */ -function ncurses_clrtoeol () {} +function ncurses_clrtoeol() {} /** * Saves terminals (program) mode * @link https://php.net/manual/en/function.ncurses-def-prog-mode.php * @return bool false on success, otherwise true. */ -function ncurses_def_prog_mode () {} +function ncurses_def_prog_mode() {} /** * Resets the prog mode saved by def_prog_mode * @link https://php.net/manual/en/function.ncurses-reset-prog-mode.php * @return int */ -function ncurses_reset_prog_mode () {} +function ncurses_reset_prog_mode() {} /** * Saves terminals (shell) mode * @link https://php.net/manual/en/function.ncurses-def-shell-mode.php * @return bool false on success, true otherwise. */ -function ncurses_def_shell_mode () {} +function ncurses_def_shell_mode() {} /** * Resets the shell mode saved by def_shell_mode * @link https://php.net/manual/en/function.ncurses-reset-shell-mode.php * @return int */ -function ncurses_reset_shell_mode () {} +function ncurses_reset_shell_mode() {} /** * Delete character at current position, move rest of line left * @link https://php.net/manual/en/function.ncurses-delch.php * @return bool false on success, true otherwise. */ -function ncurses_delch () {} +function ncurses_delch() {} /** * Delete line at current position, move rest of screen up * @link https://php.net/manual/en/function.ncurses-deleteln.php * @return bool false on success, otherwise true. */ -function ncurses_deleteln () {} +function ncurses_deleteln() {} /** * Write all prepared refreshes to terminal * @link https://php.net/manual/en/function.ncurses-doupdate.php * @return bool */ -function ncurses_doupdate () {} +function ncurses_doupdate() {} /** * Activate keyboard input echo * @link https://php.net/manual/en/function.ncurses-echo.php * @return bool false on success, true if any error occurred. */ -function ncurses_echo () {} +function ncurses_echo() {} /** * Erase terminal screen * @link https://php.net/manual/en/function.ncurses-erase.php * @return bool */ -function ncurses_erase () {} +function ncurses_erase() {} /** * Erase window contents @@ -278,28 +278,28 @@ function ncurses_erase () {} * * @return int */ -function ncurses_werase ($window) {} +function ncurses_werase($window) {} /** * Returns current erase character * @link https://php.net/manual/en/function.ncurses-erasechar.php * @return string The current erase char, as a string. */ -function ncurses_erasechar () {} +function ncurses_erasechar() {} /** * Flash terminal screen (visual bell) * @link https://php.net/manual/en/function.ncurses-flash.php * @return bool false on success, otherwise true. */ -function ncurses_flash () {} +function ncurses_flash() {} /** * Flush keyboard input buffer * @link https://php.net/manual/en/function.ncurses-flushinp.php * @return bool false on success, otherwise true. */ -function ncurses_flushinp () {} +function ncurses_flushinp() {} /** * Check for insert- and delete-capabilities @@ -307,7 +307,7 @@ function ncurses_flushinp () {} * @return bool true if the terminal has insert/delete-capabilities, false * otherwise. */ -function ncurses_has_ic () {} +function ncurses_has_ic() {} /** * Check for line insert- and delete-capabilities @@ -315,21 +315,21 @@ function ncurses_has_ic () {} * @return bool true if the terminal has insert/delete-line capabilities, * false otherwise. */ -function ncurses_has_il () {} +function ncurses_has_il() {} /** * Get character and attribute at current position * @link https://php.net/manual/en/function.ncurses-inch.php * @return string the character, as a string. */ -function ncurses_inch () {} +function ncurses_inch() {} /** * Insert a line, move rest of screen down * @link https://php.net/manual/en/function.ncurses-insertln.php * @return int */ -function ncurses_insertln () {} +function ncurses_insertln() {} /** * Ncurses is in endwin mode, normal screen output may be performed @@ -338,56 +338,56 @@ function ncurses_insertln () {} * without any subsequent calls to ncurses_wrefresh, * false otherwise. */ -function ncurses_isendwin () {} +function ncurses_isendwin() {} /** * Returns current line kill character * @link https://php.net/manual/en/function.ncurses-killchar.php * @return string the kill character, as a string. */ -function ncurses_killchar () {} +function ncurses_killchar() {} /** * Translate newline and carriage return / line feed * @link https://php.net/manual/en/function.ncurses-nl.php * @return bool */ -function ncurses_nl () {} +function ncurses_nl() {} /** * Switch terminal to cooked mode * @link https://php.net/manual/en/function.ncurses-nocbreak.php * @return bool true if any error occurred, otherwise false. */ -function ncurses_nocbreak () {} +function ncurses_nocbreak() {} /** * Switch off keyboard input echo * @link https://php.net/manual/en/function.ncurses-noecho.php * @return bool true if any error occurred, false otherwise. */ -function ncurses_noecho () {} +function ncurses_noecho() {} /** * Do not translate newline and carriage return / line feed * @link https://php.net/manual/en/function.ncurses-nonl.php * @return bool */ -function ncurses_nonl () {} +function ncurses_nonl() {} /** * Switch terminal out of raw mode * @link https://php.net/manual/en/function.ncurses-noraw.php * @return bool true if any error occurred, otherwise false. */ -function ncurses_noraw () {} +function ncurses_noraw() {} /** * Switch terminal into raw mode * @link https://php.net/manual/en/function.ncurses-raw.php * @return bool true if any error occurred, otherwise false. */ -function ncurses_raw () {} +function ncurses_raw() {} /** * Enables/Disable 8-bit meta key information @@ -398,77 +398,77 @@ function ncurses_raw () {} * * @return int */ -function ncurses_meta ($window, $bit8) {} +function ncurses_meta($window, $bit8) {} /** * Restores saved terminal state * @link https://php.net/manual/en/function.ncurses-resetty.php * @return bool Always returns false. */ -function ncurses_resetty () {} +function ncurses_resetty() {} /** * Saves terminal state * @link https://php.net/manual/en/function.ncurses-savetty.php * @return bool Always returns false. */ -function ncurses_savetty () {} +function ncurses_savetty() {} /** * Returns a logical OR of all attribute flags supported by terminal * @link https://php.net/manual/en/function.ncurses-termattrs.php * @return bool */ -function ncurses_termattrs () {} +function ncurses_termattrs() {} /** * Assign terminal default colors to color id -1 * @link https://php.net/manual/en/function.ncurses-use-default-colors.php * @return bool */ -function ncurses_use_default_colors () {} +function ncurses_use_default_colors() {} /** * Returns current soft label key attribute * @link https://php.net/manual/en/function.ncurses-slk-attr.php * @return int The attribute, as an integer. */ -function ncurses_slk_attr () {} +function ncurses_slk_attr() {} /** * Clears soft labels from screen * @link https://php.net/manual/en/function.ncurses-slk-clear.php * @return bool true on errors, false otherwise. */ -function ncurses_slk_clear () {} +function ncurses_slk_clear() {} /** * Copies soft label keys to virtual screen * @link https://php.net/manual/en/function.ncurses-slk-noutrefresh.php * @return bool */ -function ncurses_slk_noutrefresh () {} +function ncurses_slk_noutrefresh() {} /** * Copies soft label keys to screen * @link https://php.net/manual/en/function.ncurses-slk-refresh.php * @return int */ -function ncurses_slk_refresh () {} +function ncurses_slk_refresh() {} /** * Restores soft label keys * @link https://php.net/manual/en/function.ncurses-slk-restore.php * @return int */ -function ncurses_slk_restore () {} +function ncurses_slk_restore() {} /** * Forces output when ncurses_slk_noutrefresh is performed * @link https://php.net/manual/en/function.ncurses-slk-touch.php * @return int */ -function ncurses_slk_touch () {} +function ncurses_slk_touch() {} /** * Turn off the given attributes @@ -477,7 +477,7 @@ function ncurses_slk_touch () {} * * @return int */ -function ncurses_attroff ($attributes) {} +function ncurses_attroff($attributes) {} /** * Turn on the given attributes @@ -486,7 +486,7 @@ function ncurses_attroff ($attributes) {} * * @return int */ -function ncurses_attron ($attributes) {} +function ncurses_attron($attributes) {} /** * Set given attributes @@ -495,7 +495,7 @@ function ncurses_attron ($attributes) {} * * @return int */ -function ncurses_attrset ($attributes) {} +function ncurses_attrset($attributes) {} /** * Set background property for terminal screen @@ -504,7 +504,7 @@ function ncurses_attrset ($attributes) {} * * @return int */ -function ncurses_bkgd ($attrchar) {} +function ncurses_bkgd($attrchar) {} /** * Set cursor state @@ -513,7 +513,7 @@ function ncurses_bkgd ($attrchar) {} * * @return int */ -function ncurses_curs_set ($visibility) {} +function ncurses_curs_set($visibility) {} /** * Delay output on terminal using padding characters @@ -522,7 +522,7 @@ function ncurses_curs_set ($visibility) {} * * @return int */ -function ncurses_delay_output ($milliseconds) {} +function ncurses_delay_output($milliseconds) {} /** * Single character output including refresh @@ -531,7 +531,7 @@ function ncurses_delay_output ($milliseconds) {} * * @return int */ -function ncurses_echochar ($character) {} +function ncurses_echochar($character) {} /** * Put terminal into halfdelay mode @@ -540,7 +540,7 @@ function ncurses_echochar ($character) {} * * @return int */ -function ncurses_halfdelay ($tenth) {} +function ncurses_halfdelay($tenth) {} /** * Check for presence of a function key on terminal keyboard @@ -549,7 +549,7 @@ function ncurses_halfdelay ($tenth) {} * * @return int */ -function ncurses_has_key ($keycode) {} +function ncurses_has_key($keycode) {} /** * Insert character moving rest of line including character at current position @@ -558,7 +558,7 @@ function ncurses_has_key ($keycode) {} * * @return int */ -function ncurses_insch ($character) {} +function ncurses_insch($character) {} /** * Insert lines before current line scrolling down (negative numbers delete and scroll up) @@ -567,7 +567,7 @@ function ncurses_insch ($character) {} * * @return int */ -function ncurses_insdelln ($count) {} +function ncurses_insdelln($count) {} /** * Set timeout for mouse button clicks @@ -576,7 +576,7 @@ function ncurses_insdelln ($count) {} * * @return int */ -function ncurses_mouseinterval ($milliseconds) {} +function ncurses_mouseinterval($milliseconds) {} /** * Sleep @@ -585,7 +585,7 @@ function ncurses_mouseinterval ($milliseconds) {} * * @return int */ -function ncurses_napms ($milliseconds) {} +function ncurses_napms($milliseconds) {} /** * Scroll window content up or down without changing current position @@ -594,7 +594,7 @@ function ncurses_napms ($milliseconds) {} * * @return int */ -function ncurses_scrl ($count) {} +function ncurses_scrl($count) {} /** * Turn off the given attributes for soft function-key labels @@ -603,7 +603,7 @@ function ncurses_scrl ($count) {} * * @return int */ -function ncurses_slk_attroff ($intarg) {} +function ncurses_slk_attroff($intarg) {} /** * Turn on the given attributes for soft function-key labels @@ -612,7 +612,7 @@ function ncurses_slk_attroff ($intarg) {} * * @return int */ -function ncurses_slk_attron ($intarg) {} +function ncurses_slk_attron($intarg) {} /** * Set given attributes for soft function-key labels @@ -621,7 +621,7 @@ function ncurses_slk_attron ($intarg) {} * * @return int */ -function ncurses_slk_attrset ($intarg) {} +function ncurses_slk_attrset($intarg) {} /** * Sets color for soft label keys @@ -630,7 +630,7 @@ function ncurses_slk_attrset ($intarg) {} * * @return int */ -function ncurses_slk_color ($intarg) {} +function ncurses_slk_color($intarg) {} /** * Initializes soft label key functions @@ -647,7 +647,7 @@ function ncurses_slk_color ($intarg) {} * * @return bool */ -function ncurses_slk_init ($format) {} +function ncurses_slk_init($format) {} /** * Sets function key labels @@ -660,7 +660,7 @@ function ncurses_slk_init ($format) {} * * @return bool */ -function ncurses_slk_set ($labelnr, $label, $format) {} +function ncurses_slk_set($labelnr, $label, $format) {} /** * Specify different filedescriptor for typeahead checking @@ -669,7 +669,7 @@ function ncurses_slk_set ($labelnr, $label, $format) {} * * @return int */ -function ncurses_typeahead ($fd) {} +function ncurses_typeahead($fd) {} /** * Put a character back into the input stream @@ -678,7 +678,7 @@ function ncurses_typeahead ($fd) {} * * @return int */ -function ncurses_ungetch ($keycode) {} +function ncurses_ungetch($keycode) {} /** * Display the string on the terminal in the video attribute mode @@ -687,7 +687,7 @@ function ncurses_ungetch ($keycode) {} * * @return int */ -function ncurses_vidattr ($intarg) {} +function ncurses_vidattr($intarg) {} /** * Refresh window on terminal screen @@ -696,7 +696,7 @@ function ncurses_vidattr ($intarg) {} * * @return int */ -function ncurses_wrefresh ($window) {} +function ncurses_wrefresh($window) {} /** * Control use of extended names in terminfo descriptions @@ -705,7 +705,7 @@ function ncurses_wrefresh ($window) {} * * @return int */ -function ncurses_use_extended_names ($flag) {} +function ncurses_use_extended_names($flag) {} /** * Control screen background @@ -714,28 +714,28 @@ function ncurses_use_extended_names ($flag) {} * * @return void */ -function ncurses_bkgdset ($attrchar) {} +function ncurses_bkgdset($attrchar) {} /** * Set LINES for iniscr() and newterm() to 1 * @link https://php.net/manual/en/function.ncurses-filter.php * @return void */ -function ncurses_filter () {} +function ncurses_filter() {} /** * Do not flush on signal characters * @link https://php.net/manual/en/function.ncurses-noqiflush.php * @return void */ -function ncurses_noqiflush () {} +function ncurses_noqiflush() {} /** * Flush on signal characters * @link https://php.net/manual/en/function.ncurses-qiflush.php * @return void */ -function ncurses_qiflush () {} +function ncurses_qiflush() {} /** * Set timeout for special key sequences @@ -744,7 +744,7 @@ function ncurses_qiflush () {} * * @return void */ -function ncurses_timeout ($millisec) {} +function ncurses_timeout($millisec) {} /** * Control use of environment information about terminal size @@ -753,7 +753,7 @@ function ncurses_timeout ($millisec) {} * * @return void */ -function ncurses_use_env ($flag) {} +function ncurses_use_env($flag) {} /** * Output text at current position @@ -762,7 +762,7 @@ function ncurses_use_env ($flag) {} * * @return int */ -function ncurses_addstr ($text) {} +function ncurses_addstr($text) {} /** * Apply padding information to the string and output it @@ -771,7 +771,7 @@ function ncurses_addstr ($text) {} * * @return int */ -function ncurses_putp ($text) {} +function ncurses_putp($text) {} /** * Dump screen content to file @@ -780,7 +780,7 @@ function ncurses_putp ($text) {} * * @return int */ -function ncurses_scr_dump ($filename) {} +function ncurses_scr_dump($filename) {} /** * Initialize screen from file dump @@ -789,7 +789,7 @@ function ncurses_scr_dump ($filename) {} * * @return int */ -function ncurses_scr_init ($filename) {} +function ncurses_scr_init($filename) {} /** * Restore screen from file dump @@ -798,7 +798,7 @@ function ncurses_scr_init ($filename) {} * * @return int */ -function ncurses_scr_restore ($filename) {} +function ncurses_scr_restore($filename) {} /** * Inherit screen from file dump @@ -807,7 +807,7 @@ function ncurses_scr_restore ($filename) {} * * @return int */ -function ncurses_scr_set ($filename) {} +function ncurses_scr_set($filename) {} /** * Move current position and add character @@ -820,7 +820,7 @@ function ncurses_scr_set ($filename) {} * * @return int */ -function ncurses_mvaddch ($y, $x, $c) {} +function ncurses_mvaddch($y, $x, $c) {} /** * Move position and add attributed string with specified length @@ -835,7 +835,7 @@ function ncurses_mvaddch ($y, $x, $c) {} * * @return int */ -function ncurses_mvaddchnstr ($y, $x, $s, $n) {} +function ncurses_mvaddchnstr($y, $x, $s, $n) {} /** * Add attributed string with specified length at current position @@ -846,7 +846,7 @@ function ncurses_mvaddchnstr ($y, $x, $s, $n) {} * * @return int */ -function ncurses_addchnstr ($s, $n) {} +function ncurses_addchnstr($s, $n) {} /** * Move position and add attributed string @@ -859,7 +859,7 @@ function ncurses_addchnstr ($s, $n) {} * * @return int */ -function ncurses_mvaddchstr ($y, $x, $s) {} +function ncurses_mvaddchstr($y, $x, $s) {} /** * Add attributed string at current position @@ -868,7 +868,7 @@ function ncurses_mvaddchstr ($y, $x, $s) {} * * @return int */ -function ncurses_addchstr ($s) {} +function ncurses_addchstr($s) {} /** * Move position and add string with specified length @@ -883,7 +883,7 @@ function ncurses_addchstr ($s) {} * * @return int */ -function ncurses_mvaddnstr ($y, $x, $s, $n) {} +function ncurses_mvaddnstr($y, $x, $s, $n) {} /** * Add string with specified length at current position @@ -894,7 +894,7 @@ function ncurses_mvaddnstr ($y, $x, $s, $n) {} * * @return int */ -function ncurses_addnstr ($s, $n) {} +function ncurses_addnstr($s, $n) {} /** * Move position and add string @@ -907,7 +907,7 @@ function ncurses_addnstr ($s, $n) {} * * @return int */ -function ncurses_mvaddstr ($y, $x, $s) {} +function ncurses_mvaddstr($y, $x, $s) {} /** * Move position and delete character, shift rest of line left @@ -918,7 +918,7 @@ function ncurses_mvaddstr ($y, $x, $s) {} * * @return int */ -function ncurses_mvdelch ($y, $x) {} +function ncurses_mvdelch($y, $x) {} /** * Move position and get character at new position @@ -929,7 +929,7 @@ function ncurses_mvdelch ($y, $x) {} * * @return int */ -function ncurses_mvgetch ($y, $x) {} +function ncurses_mvgetch($y, $x) {} /** * Move position and get attributed character at new position @@ -940,7 +940,7 @@ function ncurses_mvgetch ($y, $x) {} * * @return int */ -function ncurses_mvinch ($y, $x) {} +function ncurses_mvinch($y, $x) {} /** * Add string at new position in window @@ -955,7 +955,7 @@ function ncurses_mvinch ($y, $x) {} * * @return int */ -function ncurses_mvwaddstr ($window, $y, $x, $text) {} +function ncurses_mvwaddstr($window, $y, $x, $text) {} /** * Insert string at current position, moving rest of line right @@ -964,7 +964,7 @@ function ncurses_mvwaddstr ($window, $y, $x, $text) {} * * @return int */ -function ncurses_insstr ($text) {} +function ncurses_insstr($text) {} /** * Reads string from terminal screen @@ -974,7 +974,7 @@ function ncurses_insstr ($text) {} * * @return int the number of characters. */ -function ncurses_instr (&$buffer) {} +function ncurses_instr(&$buffer) {} /** * Set new position and draw a horizontal line using an attributed character and max. n characters long @@ -989,7 +989,7 @@ function ncurses_instr (&$buffer) {} * * @return int */ -function ncurses_mvhline ($y, $x, $attrchar, $n) {} +function ncurses_mvhline($y, $x, $attrchar, $n) {} /** * Move cursor immediately @@ -1004,7 +1004,7 @@ function ncurses_mvhline ($y, $x, $attrchar, $n) {} * * @return int */ -function ncurses_mvcur ($old_y, $old_x, $new_y, $new_x) {} +function ncurses_mvcur($old_y, $old_x, $new_y, $new_x) {} /** * Set new RGB value for color @@ -1019,7 +1019,7 @@ function ncurses_mvcur ($old_y, $old_x, $new_y, $new_x) {} * * @return int */ -function ncurses_init_color ($color, $r, $g, $b) {} +function ncurses_init_color($color, $r, $g, $b) {} /** * Draw a border around the screen using attributed characters @@ -1046,7 +1046,7 @@ function ncurses_init_color ($color, $r, $g, $b) {} * * @return int */ -function ncurses_border ($left, $right, $top, $bottom, $tl_corner, $tr_corner, $bl_corner, $br_corner) {} +function ncurses_border($left, $right, $top, $bottom, $tl_corner, $tr_corner, $bl_corner, $br_corner) {} /** * Define default colors for color 0 @@ -1057,7 +1057,7 @@ function ncurses_border ($left, $right, $top, $bottom, $tl_corner, $tr_corner, $ * * @return int */ -function ncurses_assume_default_colors ($fg, $bg) {} +function ncurses_assume_default_colors($fg, $bg) {} /** * Define a keycode @@ -1068,7 +1068,7 @@ function ncurses_assume_default_colors ($fg, $bg) {} * * @return int */ -function ncurses_define_key ($definition, $keycode) {} +function ncurses_define_key($definition, $keycode) {} /** * Draw a horizontal line at current position using an attributed character and max. n characters long @@ -1079,7 +1079,7 @@ function ncurses_define_key ($definition, $keycode) {} * * @return int */ -function ncurses_hline ($charattr, $n) {} +function ncurses_hline($charattr, $n) {} /** * Draw a vertical line at current position using an attributed character and max. n characters long @@ -1090,7 +1090,7 @@ function ncurses_hline ($charattr, $n) {} * * @return int */ -function ncurses_vline ($charattr, $n) {} +function ncurses_vline($charattr, $n) {} /** * Enable or disable a keycode @@ -1101,7 +1101,7 @@ function ncurses_vline ($charattr, $n) {} * * @return int */ -function ncurses_keyok ($keycode, $enable) {} +function ncurses_keyok($keycode, $enable) {} /** * Returns terminals (short)-name @@ -1109,7 +1109,7 @@ function ncurses_keyok ($keycode, $enable) {} * @return string|null the shortname of the terminal, truncated to 14 characters. * On errors, returns null. */ -function ncurses_termname () {} +function ncurses_termname() {} /** * Returns terminals description @@ -1117,7 +1117,7 @@ function ncurses_termname () {} * @return string|null the description, as a string truncated to 128 characters. * On errors, returns null. */ -function ncurses_longname () {} +function ncurses_longname() {} /** * Sets mouse options @@ -1133,7 +1133,7 @@ function ncurses_longname () {} * complete failure, it returns 0. * */ -function ncurses_mousemask ($newmask, &$oldmask) {} +function ncurses_mousemask($newmask, &$oldmask) {} /** * Reads mouse event @@ -1151,7 +1151,7 @@ function ncurses_mousemask ($newmask, &$oldmask) {} * otherwise returns true. * */ -function ncurses_getmouse (array &$mevent) {} +function ncurses_getmouse(array &$mevent) {} /** * Pushes mouse event to queue @@ -1162,7 +1162,7 @@ function ncurses_getmouse (array &$mevent) {} * * @return bool false on success, true otherwise. */ -function ncurses_ungetmouse (array $mevent) {} +function ncurses_ungetmouse(array $mevent) {} /** * Transforms coordinates @@ -1175,7 +1175,7 @@ function ncurses_ungetmouse (array $mevent) {} * * @return bool */ -function ncurses_mouse_trafo (&$y, &$x, $toscreen) {} +function ncurses_mouse_trafo(&$y, &$x, $toscreen) {} /** * Transforms window/stdscr coordinates @@ -1190,7 +1190,7 @@ function ncurses_mouse_trafo (&$y, &$x, $toscreen) {} * * @return bool */ -function ncurses_wmouse_trafo ($window, &$y, &$x, $toscreen) {} +function ncurses_wmouse_trafo($window, &$y, &$x, $toscreen) {} /** * Outputs text at current position in window @@ -1203,7 +1203,7 @@ function ncurses_wmouse_trafo ($window, &$y, &$x, $toscreen) {} * * @return int */ -function ncurses_waddstr ($window, $str, $n = null) {} +function ncurses_waddstr($window, $str, $n = null) {} /** * Copies window to virtual screen @@ -1212,7 +1212,7 @@ function ncurses_waddstr ($window, $str, $n = null) {} * * @return int */ -function ncurses_wnoutrefresh ($window) {} +function ncurses_wnoutrefresh($window) {} /** * Clears window @@ -1221,7 +1221,7 @@ function ncurses_wnoutrefresh ($window) {} * * @return int */ -function ncurses_wclear ($window) {} +function ncurses_wclear($window) {} /** * Sets windows color pairings @@ -1232,7 +1232,7 @@ function ncurses_wclear ($window) {} * * @return int */ -function ncurses_wcolor_set ($window, $color_pair) {} +function ncurses_wcolor_set($window, $color_pair) {} /** * Reads a character from keyboard (window) @@ -1241,7 +1241,7 @@ function ncurses_wcolor_set ($window, $color_pair) {} * * @return int */ -function ncurses_wgetch ($window) {} +function ncurses_wgetch($window) {} /** * Turns keypad on or off @@ -1252,7 +1252,7 @@ function ncurses_wgetch ($window) {} * * @return int */ -function ncurses_keypad ($window, $bf) {} +function ncurses_keypad($window, $bf) {} /** * Moves windows output position @@ -1265,7 +1265,7 @@ function ncurses_keypad ($window, $bf) {} * * @return int */ -function ncurses_wmove ($window, $y, $x) {} +function ncurses_wmove($window, $y, $x) {} /** * Creates a new pad (window) @@ -1276,7 +1276,7 @@ function ncurses_wmove ($window, $y, $x) {} * * @return resource */ -function ncurses_newpad ($rows, $cols) {} +function ncurses_newpad($rows, $cols) {} /** * Copies a region from a pad into the virtual screen @@ -1297,7 +1297,7 @@ function ncurses_newpad ($rows, $cols) {} * * @return int */ -function ncurses_prefresh ($pad, $pminrow, $pmincol, $sminrow, $smincol, $smaxrow, $smaxcol) {} +function ncurses_prefresh($pad, $pminrow, $pmincol, $sminrow, $smincol, $smaxrow, $smaxcol) {} /** * Copies a region from a pad into the virtual screen @@ -1318,7 +1318,7 @@ function ncurses_prefresh ($pad, $pminrow, $pmincol, $sminrow, $smincol, $smaxro * * @return int */ -function ncurses_pnoutrefresh ($pad, $pminrow, $pmincol, $sminrow, $smincol, $smaxrow, $smaxcol) {} +function ncurses_pnoutrefresh($pad, $pminrow, $pmincol, $sminrow, $smincol, $smaxrow, $smaxcol) {} /** * Enter standout mode for a window @@ -1327,7 +1327,7 @@ function ncurses_pnoutrefresh ($pad, $pminrow, $pmincol, $sminrow, $smincol, $sm * * @return int */ -function ncurses_wstandout ($window) {} +function ncurses_wstandout($window) {} /** * End standout mode for a window @@ -1336,7 +1336,7 @@ function ncurses_wstandout ($window) {} * * @return int */ -function ncurses_wstandend ($window) {} +function ncurses_wstandend($window) {} /** * Set the attributes for a window @@ -1347,7 +1347,7 @@ function ncurses_wstandend ($window) {} * * @return int */ -function ncurses_wattrset ($window, $attrs) {} +function ncurses_wattrset($window, $attrs) {} /** * Turns on attributes for a window @@ -1358,7 +1358,7 @@ function ncurses_wattrset ($window, $attrs) {} * * @return int */ -function ncurses_wattron ($window, $attrs) {} +function ncurses_wattron($window, $attrs) {} /** * Turns off attributes for a window @@ -1369,7 +1369,7 @@ function ncurses_wattron ($window, $attrs) {} * * @return int */ -function ncurses_wattroff ($window, $attrs) {} +function ncurses_wattroff($window, $attrs) {} /** * Adds character at current position in a window and advance cursor @@ -1380,7 +1380,7 @@ function ncurses_wattroff ($window, $attrs) {} * * @return int */ -function ncurses_waddch ($window, $ch) {} +function ncurses_waddch($window, $ch) {} /** * Draws a border around the window using attributed characters @@ -1410,7 +1410,7 @@ function ncurses_waddch ($window, $ch) {} * * @return int */ -function ncurses_wborder ($window, $left, $right, $top, $bottom, $tl_corner, $tr_corner, $bl_corner, $br_corner) {} +function ncurses_wborder($window, $left, $right, $top, $bottom, $tl_corner, $tr_corner, $bl_corner, $br_corner) {} /** * Draws a horizontal line in a window at current position using an attributed character and max. n characters long @@ -1423,7 +1423,7 @@ function ncurses_wborder ($window, $left, $right, $top, $bottom, $tl_corner, $tr * * @return int */ -function ncurses_whline ($window, $charattr, $n) {} +function ncurses_whline($window, $charattr, $n) {} /** * Draws a vertical line in a window at current position using an attributed character and max. n characters long @@ -1436,7 +1436,7 @@ function ncurses_whline ($window, $charattr, $n) {} * * @return int */ -function ncurses_wvline ($window, $charattr, $n) {} +function ncurses_wvline($window, $charattr, $n) {} /** * Returns the current cursor position for a window @@ -1449,7 +1449,7 @@ function ncurses_wvline ($window, $charattr, $n) {} * * @return void */ -function ncurses_getyx ($window, &$y, &$x) {} +function ncurses_getyx($window, &$y, &$x) {} /** * Returns the size of a window @@ -1465,14 +1465,14 @@ function ncurses_getyx ($window, &$y, &$x) {} * * @return void */ -function ncurses_getmaxyx ($window, &$y, &$x) {} +function ncurses_getmaxyx($window, &$y, &$x) {} /** * Refreshes the virtual screen to reflect the relations between panels in the stack * @link https://php.net/manual/en/function.ncurses-update-panels.php * @return void */ -function ncurses_update_panels () {} +function ncurses_update_panels() {} /** * Returns the window associated with panel @@ -1481,7 +1481,7 @@ function ncurses_update_panels () {} * * @return resource */ -function ncurses_panel_window ($panel) {} +function ncurses_panel_window($panel) {} /** * Returns the panel below panel @@ -1490,7 +1490,7 @@ function ncurses_panel_window ($panel) {} * * @return resource */ -function ncurses_panel_below ($panel) {} +function ncurses_panel_below($panel) {} /** * Returns the panel above panel @@ -1499,7 +1499,7 @@ function ncurses_panel_below ($panel) {} * * @return resource If panel is null, returns the bottom panel in the stack. */ -function ncurses_panel_above ($panel) {} +function ncurses_panel_above($panel) {} /** * Replaces the window associated with panel @@ -1510,7 +1510,7 @@ function ncurses_panel_above ($panel) {} * * @return int */ -function ncurses_replace_panel ($panel, $window) {} +function ncurses_replace_panel($panel, $window) {} /** * Moves a panel so that its upper-left corner is at [startx, starty] @@ -1523,7 +1523,7 @@ function ncurses_replace_panel ($panel, $window) {} * * @return int */ -function ncurses_move_panel ($panel, $startx, $starty) {} +function ncurses_move_panel($panel, $startx, $starty) {} /** * Moves a visible panel to the bottom of the stack @@ -1532,7 +1532,7 @@ function ncurses_move_panel ($panel, $startx, $starty) {} * * @return int */ -function ncurses_bottom_panel ($panel) {} +function ncurses_bottom_panel($panel) {} /** * Moves a visible panel to the top of the stack @@ -1541,7 +1541,7 @@ function ncurses_bottom_panel ($panel) {} * * @return int */ -function ncurses_top_panel ($panel) {} +function ncurses_top_panel($panel) {} /** * Places an invisible panel on top of the stack, making it visible @@ -1550,7 +1550,7 @@ function ncurses_top_panel ($panel) {} * * @return int */ -function ncurses_show_panel ($panel) {} +function ncurses_show_panel($panel) {} /** * Remove panel from the stack, making it invisible @@ -1559,7 +1559,7 @@ function ncurses_show_panel ($panel) {} * * @return int */ -function ncurses_hide_panel ($panel) {} +function ncurses_hide_panel($panel) {} /** * Remove panel from the stack and delete it (but not the associated window) @@ -1568,7 +1568,7 @@ function ncurses_hide_panel ($panel) {} * * @return bool */ -function ncurses_del_panel ($panel) {} +function ncurses_del_panel($panel) {} /** * Create a new panel and associate it with window @@ -1577,154 +1577,153 @@ function ncurses_del_panel ($panel) {} * * @return resource */ -function ncurses_new_panel ($window) {} - -define ('NCURSES_COLOR_BLACK', 0); -define ('NCURSES_COLOR_RED', 1); -define ('NCURSES_COLOR_GREEN', 2); -define ('NCURSES_COLOR_YELLOW', 3); -define ('NCURSES_COLOR_BLUE', 4); -define ('NCURSES_COLOR_MAGENTA', 5); -define ('NCURSES_COLOR_CYAN', 6); -define ('NCURSES_COLOR_WHITE', 7); -define ('NCURSES_KEY_DOWN', 258); -define ('NCURSES_KEY_UP', 259); -define ('NCURSES_KEY_LEFT', 260); -define ('NCURSES_KEY_RIGHT', 261); -define ('NCURSES_KEY_HOME', 262); -define ('NCURSES_KEY_END', 360); -define ('NCURSES_KEY_BACKSPACE', 263); -define ('NCURSES_KEY_MOUSE', 409); -define ('NCURSES_KEY_F0', 264); -define ('NCURSES_KEY_F1', 265); -define ('NCURSES_KEY_F2', 266); -define ('NCURSES_KEY_F3', 267); -define ('NCURSES_KEY_F4', 268); -define ('NCURSES_KEY_F5', 269); -define ('NCURSES_KEY_F6', 270); -define ('NCURSES_KEY_F7', 271); -define ('NCURSES_KEY_F8', 272); -define ('NCURSES_KEY_F9', 273); -define ('NCURSES_KEY_F10', 274); -define ('NCURSES_KEY_F11', 275); -define ('NCURSES_KEY_F12', 276); -define ('NCURSES_KEY_DL', 328); -define ('NCURSES_KEY_IL', 329); -define ('NCURSES_KEY_DC', 330); -define ('NCURSES_KEY_IC', 331); -define ('NCURSES_KEY_EIC', 332); -define ('NCURSES_KEY_CLEAR', 333); -define ('NCURSES_KEY_EOS', 334); -define ('NCURSES_KEY_EOL', 335); -define ('NCURSES_KEY_SF', 336); -define ('NCURSES_KEY_SR', 337); -define ('NCURSES_KEY_NPAGE', 338); -define ('NCURSES_KEY_PPAGE', 339); -define ('NCURSES_KEY_STAB', 340); -define ('NCURSES_KEY_CTAB', 341); -define ('NCURSES_KEY_CATAB', 342); -define ('NCURSES_KEY_ENTER', 343); -define ('NCURSES_KEY_SRESET', 344); -define ('NCURSES_KEY_RESET', 345); -define ('NCURSES_KEY_PRINT', 346); -define ('NCURSES_KEY_LL', 347); -define ('NCURSES_KEY_A1', 348); -define ('NCURSES_KEY_A3', 349); -define ('NCURSES_KEY_B2', 350); -define ('NCURSES_KEY_C1', 351); -define ('NCURSES_KEY_C3', 352); -define ('NCURSES_KEY_BTAB', 353); -define ('NCURSES_KEY_BEG', 354); -define ('NCURSES_KEY_CANCEL', 355); -define ('NCURSES_KEY_CLOSE', 356); -define ('NCURSES_KEY_COMMAND', 357); -define ('NCURSES_KEY_COPY', 358); -define ('NCURSES_KEY_CREATE', 359); -define ('NCURSES_KEY_EXIT', 361); -define ('NCURSES_KEY_FIND', 362); -define ('NCURSES_KEY_HELP', 363); -define ('NCURSES_KEY_MARK', 364); -define ('NCURSES_KEY_MESSAGE', 365); -define ('NCURSES_KEY_MOVE', 366); -define ('NCURSES_KEY_NEXT', 367); -define ('NCURSES_KEY_OPEN', 368); -define ('NCURSES_KEY_OPTIONS', 369); -define ('NCURSES_KEY_PREVIOUS', 370); -define ('NCURSES_KEY_REDO', 371); -define ('NCURSES_KEY_REFERENCE', 372); -define ('NCURSES_KEY_REFRESH', 373); -define ('NCURSES_KEY_REPLACE', 374); -define ('NCURSES_KEY_RESTART', 375); -define ('NCURSES_KEY_RESUME', 376); -define ('NCURSES_KEY_SAVE', 377); -define ('NCURSES_KEY_SBEG', 378); -define ('NCURSES_KEY_SCANCEL', 379); -define ('NCURSES_KEY_SCOMMAND', 380); -define ('NCURSES_KEY_SCOPY', 381); -define ('NCURSES_KEY_SCREATE', 382); -define ('NCURSES_KEY_SDC', 383); -define ('NCURSES_KEY_SDL', 384); -define ('NCURSES_KEY_SELECT', 385); -define ('NCURSES_KEY_SEND', 386); -define ('NCURSES_KEY_SEOL', 387); -define ('NCURSES_KEY_SEXIT', 388); -define ('NCURSES_KEY_SFIND', 389); -define ('NCURSES_KEY_SHELP', 390); -define ('NCURSES_KEY_SHOME', 391); -define ('NCURSES_KEY_SIC', 392); -define ('NCURSES_KEY_SLEFT', 393); -define ('NCURSES_KEY_SMESSAGE', 394); -define ('NCURSES_KEY_SMOVE', 395); -define ('NCURSES_KEY_SNEXT', 396); -define ('NCURSES_KEY_SOPTIONS', 397); -define ('NCURSES_KEY_SPREVIOUS', 398); -define ('NCURSES_KEY_SPRINT', 399); -define ('NCURSES_KEY_SREDO', 400); -define ('NCURSES_KEY_SREPLACE', 401); -define ('NCURSES_KEY_SRIGHT', 402); -define ('NCURSES_KEY_SRSUME', 403); -define ('NCURSES_KEY_SSAVE', 404); -define ('NCURSES_KEY_SSUSPEND', 405); -define ('NCURSES_KEY_SUNDO', 406); -define ('NCURSES_KEY_SUSPEND', 407); -define ('NCURSES_KEY_UNDO', 408); -define ('NCURSES_KEY_RESIZE', 410); -define ('NCURSES_A_NORMAL', 0); -define ('NCURSES_A_STANDOUT', 65536); -define ('NCURSES_A_UNDERLINE', 131072); -define ('NCURSES_A_REVERSE', 262144); -define ('NCURSES_A_BLINK', 524288); -define ('NCURSES_A_DIM', 1048576); -define ('NCURSES_A_BOLD', 2097152); -define ('NCURSES_A_PROTECT', 16777216); -define ('NCURSES_A_INVIS', 8388608); -define ('NCURSES_A_ALTCHARSET', 4194304); -define ('NCURSES_A_CHARTEXT', 255); -define ('NCURSES_BUTTON1_PRESSED', 2); -define ('NCURSES_BUTTON1_RELEASED', 1); -define ('NCURSES_BUTTON1_CLICKED', 4); -define ('NCURSES_BUTTON1_DOUBLE_CLICKED', 8); -define ('NCURSES_BUTTON1_TRIPLE_CLICKED', 16); -define ('NCURSES_BUTTON2_PRESSED', 128); -define ('NCURSES_BUTTON2_RELEASED', 64); -define ('NCURSES_BUTTON2_CLICKED', 256); -define ('NCURSES_BUTTON2_DOUBLE_CLICKED', 512); -define ('NCURSES_BUTTON2_TRIPLE_CLICKED', 1024); -define ('NCURSES_BUTTON3_PRESSED', 8192); -define ('NCURSES_BUTTON3_RELEASED', 4096); -define ('NCURSES_BUTTON3_CLICKED', 16384); -define ('NCURSES_BUTTON3_DOUBLE_CLICKED', 32768); -define ('NCURSES_BUTTON3_TRIPLE_CLICKED', 65536); -define ('NCURSES_BUTTON4_PRESSED', 524288); -define ('NCURSES_BUTTON4_RELEASED', 262144); -define ('NCURSES_BUTTON4_CLICKED', 1048576); -define ('NCURSES_BUTTON4_DOUBLE_CLICKED', 2097152); -define ('NCURSES_BUTTON4_TRIPLE_CLICKED', 4194304); -define ('NCURSES_BUTTON_SHIFT', 33554432); -define ('NCURSES_BUTTON_CTRL', 16777216); -define ('NCURSES_BUTTON_ALT', 67108864); -define ('NCURSES_ALL_MOUSE_EVENTS', 134217727); -define ('NCURSES_REPORT_MOUSE_POSITION', 134217728); +function ncurses_new_panel($window) {} + +define('NCURSES_COLOR_BLACK', 0); +define('NCURSES_COLOR_RED', 1); +define('NCURSES_COLOR_GREEN', 2); +define('NCURSES_COLOR_YELLOW', 3); +define('NCURSES_COLOR_BLUE', 4); +define('NCURSES_COLOR_MAGENTA', 5); +define('NCURSES_COLOR_CYAN', 6); +define('NCURSES_COLOR_WHITE', 7); +define('NCURSES_KEY_DOWN', 258); +define('NCURSES_KEY_UP', 259); +define('NCURSES_KEY_LEFT', 260); +define('NCURSES_KEY_RIGHT', 261); +define('NCURSES_KEY_HOME', 262); +define('NCURSES_KEY_END', 360); +define('NCURSES_KEY_BACKSPACE', 263); +define('NCURSES_KEY_MOUSE', 409); +define('NCURSES_KEY_F0', 264); +define('NCURSES_KEY_F1', 265); +define('NCURSES_KEY_F2', 266); +define('NCURSES_KEY_F3', 267); +define('NCURSES_KEY_F4', 268); +define('NCURSES_KEY_F5', 269); +define('NCURSES_KEY_F6', 270); +define('NCURSES_KEY_F7', 271); +define('NCURSES_KEY_F8', 272); +define('NCURSES_KEY_F9', 273); +define('NCURSES_KEY_F10', 274); +define('NCURSES_KEY_F11', 275); +define('NCURSES_KEY_F12', 276); +define('NCURSES_KEY_DL', 328); +define('NCURSES_KEY_IL', 329); +define('NCURSES_KEY_DC', 330); +define('NCURSES_KEY_IC', 331); +define('NCURSES_KEY_EIC', 332); +define('NCURSES_KEY_CLEAR', 333); +define('NCURSES_KEY_EOS', 334); +define('NCURSES_KEY_EOL', 335); +define('NCURSES_KEY_SF', 336); +define('NCURSES_KEY_SR', 337); +define('NCURSES_KEY_NPAGE', 338); +define('NCURSES_KEY_PPAGE', 339); +define('NCURSES_KEY_STAB', 340); +define('NCURSES_KEY_CTAB', 341); +define('NCURSES_KEY_CATAB', 342); +define('NCURSES_KEY_ENTER', 343); +define('NCURSES_KEY_SRESET', 344); +define('NCURSES_KEY_RESET', 345); +define('NCURSES_KEY_PRINT', 346); +define('NCURSES_KEY_LL', 347); +define('NCURSES_KEY_A1', 348); +define('NCURSES_KEY_A3', 349); +define('NCURSES_KEY_B2', 350); +define('NCURSES_KEY_C1', 351); +define('NCURSES_KEY_C3', 352); +define('NCURSES_KEY_BTAB', 353); +define('NCURSES_KEY_BEG', 354); +define('NCURSES_KEY_CANCEL', 355); +define('NCURSES_KEY_CLOSE', 356); +define('NCURSES_KEY_COMMAND', 357); +define('NCURSES_KEY_COPY', 358); +define('NCURSES_KEY_CREATE', 359); +define('NCURSES_KEY_EXIT', 361); +define('NCURSES_KEY_FIND', 362); +define('NCURSES_KEY_HELP', 363); +define('NCURSES_KEY_MARK', 364); +define('NCURSES_KEY_MESSAGE', 365); +define('NCURSES_KEY_MOVE', 366); +define('NCURSES_KEY_NEXT', 367); +define('NCURSES_KEY_OPEN', 368); +define('NCURSES_KEY_OPTIONS', 369); +define('NCURSES_KEY_PREVIOUS', 370); +define('NCURSES_KEY_REDO', 371); +define('NCURSES_KEY_REFERENCE', 372); +define('NCURSES_KEY_REFRESH', 373); +define('NCURSES_KEY_REPLACE', 374); +define('NCURSES_KEY_RESTART', 375); +define('NCURSES_KEY_RESUME', 376); +define('NCURSES_KEY_SAVE', 377); +define('NCURSES_KEY_SBEG', 378); +define('NCURSES_KEY_SCANCEL', 379); +define('NCURSES_KEY_SCOMMAND', 380); +define('NCURSES_KEY_SCOPY', 381); +define('NCURSES_KEY_SCREATE', 382); +define('NCURSES_KEY_SDC', 383); +define('NCURSES_KEY_SDL', 384); +define('NCURSES_KEY_SELECT', 385); +define('NCURSES_KEY_SEND', 386); +define('NCURSES_KEY_SEOL', 387); +define('NCURSES_KEY_SEXIT', 388); +define('NCURSES_KEY_SFIND', 389); +define('NCURSES_KEY_SHELP', 390); +define('NCURSES_KEY_SHOME', 391); +define('NCURSES_KEY_SIC', 392); +define('NCURSES_KEY_SLEFT', 393); +define('NCURSES_KEY_SMESSAGE', 394); +define('NCURSES_KEY_SMOVE', 395); +define('NCURSES_KEY_SNEXT', 396); +define('NCURSES_KEY_SOPTIONS', 397); +define('NCURSES_KEY_SPREVIOUS', 398); +define('NCURSES_KEY_SPRINT', 399); +define('NCURSES_KEY_SREDO', 400); +define('NCURSES_KEY_SREPLACE', 401); +define('NCURSES_KEY_SRIGHT', 402); +define('NCURSES_KEY_SRSUME', 403); +define('NCURSES_KEY_SSAVE', 404); +define('NCURSES_KEY_SSUSPEND', 405); +define('NCURSES_KEY_SUNDO', 406); +define('NCURSES_KEY_SUSPEND', 407); +define('NCURSES_KEY_UNDO', 408); +define('NCURSES_KEY_RESIZE', 410); +define('NCURSES_A_NORMAL', 0); +define('NCURSES_A_STANDOUT', 65536); +define('NCURSES_A_UNDERLINE', 131072); +define('NCURSES_A_REVERSE', 262144); +define('NCURSES_A_BLINK', 524288); +define('NCURSES_A_DIM', 1048576); +define('NCURSES_A_BOLD', 2097152); +define('NCURSES_A_PROTECT', 16777216); +define('NCURSES_A_INVIS', 8388608); +define('NCURSES_A_ALTCHARSET', 4194304); +define('NCURSES_A_CHARTEXT', 255); +define('NCURSES_BUTTON1_PRESSED', 2); +define('NCURSES_BUTTON1_RELEASED', 1); +define('NCURSES_BUTTON1_CLICKED', 4); +define('NCURSES_BUTTON1_DOUBLE_CLICKED', 8); +define('NCURSES_BUTTON1_TRIPLE_CLICKED', 16); +define('NCURSES_BUTTON2_PRESSED', 128); +define('NCURSES_BUTTON2_RELEASED', 64); +define('NCURSES_BUTTON2_CLICKED', 256); +define('NCURSES_BUTTON2_DOUBLE_CLICKED', 512); +define('NCURSES_BUTTON2_TRIPLE_CLICKED', 1024); +define('NCURSES_BUTTON3_PRESSED', 8192); +define('NCURSES_BUTTON3_RELEASED', 4096); +define('NCURSES_BUTTON3_CLICKED', 16384); +define('NCURSES_BUTTON3_DOUBLE_CLICKED', 32768); +define('NCURSES_BUTTON3_TRIPLE_CLICKED', 65536); +define('NCURSES_BUTTON4_PRESSED', 524288); +define('NCURSES_BUTTON4_RELEASED', 262144); +define('NCURSES_BUTTON4_CLICKED', 1048576); +define('NCURSES_BUTTON4_DOUBLE_CLICKED', 2097152); +define('NCURSES_BUTTON4_TRIPLE_CLICKED', 4194304); +define('NCURSES_BUTTON_SHIFT', 33554432); +define('NCURSES_BUTTON_CTRL', 16777216); +define('NCURSES_BUTTON_ALT', 67108864); +define('NCURSES_ALL_MOUSE_EVENTS', 134217727); +define('NCURSES_REPORT_MOUSE_POSITION', 134217728); // End of ncurses v. -?> diff --git a/newrelic/newrelic.php b/newrelic/newrelic.php index b4de02b69..7b3eb97cd 100644 --- a/newrelic/newrelic.php +++ b/newrelic/newrelic.php @@ -20,7 +20,7 @@ * @link https://docs.newrelic.com/docs/agents/php-agent/configuration/php-agent-api#api-custom-param * * @param string $key - * @param bool|float|integer|string $value + * @param bool|float|int|string $value * * @return bool */ @@ -161,7 +161,7 @@ function newrelic_end_transaction($ignore = false) {} * * @return string */ -function newrelic_get_browser_timing_footer ($includeTags = true) {} +function newrelic_get_browser_timing_footer($includeTags = true) {} /** * Returns the JavaScript string to inject as part of the header for page load timing (sometimes referred to as real @@ -253,10 +253,10 @@ function newrelic_name_transaction($name) {} * * @link https://docs.newrelic.com/docs/agents/php-agent/configuration/php-agent-api#api-notice-error * - * @param string|integer $messageOrUnused [optional] + * @param string|int $messageOrUnused [optional] * @param Exception|string $exceptionOrMessage [optional] * @param string $unused2 [optional] - * @param integer $unused3 [optional] + * @param int $unused3 [optional] * @param mixed $unused4 [optional] * * @return void diff --git a/oauth/oauth.php b/oauth/oauth.php index 217eeeb63..099c15045 100644 --- a/oauth/oauth.php +++ b/oauth/oauth.php @@ -39,7 +39,7 @@ * @param array $request_parameters * @return string */ -function oauth_get_sbs($http_method, $uri, $request_parameters = array()) { } +function oauth_get_sbs($http_method, $uri, $request_parameters = []) {} /** * Encode a URI to RFC 3986 @@ -47,13 +47,13 @@ function oauth_get_sbs($http_method, $uri, $request_parameters = array()) { } * @param string $uri * @return string */ -function oauth_urlencode($uri) { } +function oauth_urlencode($uri) {} /** * The OAuth extension provides a simple interface to interact with data providers using the OAuth HTTP specification to protect private resources. */ -class OAuth { - +class OAuth +{ /** * @var bool */ @@ -69,7 +69,6 @@ class OAuth { */ public $debugInfo; - /** * Create a new OAuth object * @param string $consumer_key @@ -78,50 +77,50 @@ class OAuth { * @param int $auth_type * @throws \OAuthException */ - public function __construct($consumer_key, $consumer_secret, $signature_method = OAUTH_SIG_METHOD_HMACSHA1, $auth_type = OAUTH_AUTH_TYPE_AUTHORIZATION) { } + public function __construct($consumer_key, $consumer_secret, $signature_method = OAUTH_SIG_METHOD_HMACSHA1, $auth_type = OAUTH_AUTH_TYPE_AUTHORIZATION) {} /** * Turn off verbose debugging * @return bool */ - public function disableDebug() { } + public function disableDebug() {} /** * Turn off redirects * @return void */ - public function disableRedirects() { } + public function disableRedirects() {} /** * Turn off SSL checks * @return bool */ - public function disableSSLChecks() { } + public function disableSSLChecks() {} /** * Turn on verbose debugging * @return bool */ - public function enableDebug() { } + public function enableDebug() {} /** * Turn on redirects * @return bool */ - public function enableRedirects() { } + public function enableRedirects() {} /** * Turn on SSL checks * @return bool */ - public function enableSSLChecks() { } + public function enableSSLChecks() {} /** * Set the timeout * @param int $timeout Time in milliseconds * @return void */ - public function setTimeout($timeout) { } + public function setTimeout($timeout) {} /** * Fetch an OAuth-protected resource @@ -132,7 +131,7 @@ public function setTimeout($timeout) { } * @throws \OAuthException * @return mixed */ - public function fetch($protected_resource_url, $extra_parameters = array(), $http_method = null, $http_headers = array()) { } + public function fetch($protected_resource_url, $extra_parameters = [], $http_method = null, $http_headers = []) {} /** * Fetch an access token @@ -142,31 +141,31 @@ public function fetch($protected_resource_url, $extra_parameters = array(), $htt * @throws \OAuthException * @return array */ - public function getAccessToken($access_token_url, $auth_session_handle = null, $verifier_token = null) { } + public function getAccessToken($access_token_url, $auth_session_handle = null, $verifier_token = null) {} /** * Get CA information * @return array */ - public function getCAPath() { } + public function getCAPath() {} /** * Get the last response * @return string */ - public function getLastResponse() { } + public function getLastResponse() {} /** * Get headers for last response * @return string|false */ - public function getLastResponseHeaders() { } + public function getLastResponseHeaders() {} /** * Get HTTP information about the last response * @return array */ - public function getLastResponseInfo() { } + public function getLastResponseInfo() {} /** * Generate OAuth header string signature @@ -175,7 +174,7 @@ public function getLastResponseInfo() { } * @param mixed $extra_parameters * @return string|false */ - public function getRequestHeader($http_method, $url, $extra_parameters = '') { } + public function getRequestHeader($http_method, $url, $extra_parameters = '') {} /** * Fetch a request token @@ -185,14 +184,14 @@ public function getRequestHeader($http_method, $url, $extra_parameters = '') { } * @throws \OAuthException * @return array */ - public function getRequestToken($request_token_url, $callback_url = null, $http_method = 'GET') { } + public function getRequestToken($request_token_url, $callback_url = null, $http_method = 'GET') {} /** * Set authorization type * @param int $auth_type * @return bool */ - public function setAuthType($auth_type) { } + public function setAuthType($auth_type) {} /** * Set CA path and info @@ -200,35 +199,34 @@ public function setAuthType($auth_type) { } * @param string $ca_info * @return mixed */ - public function setCAPath($ca_path = null, $ca_info = null) { } + public function setCAPath($ca_path = null, $ca_info = null) {} /** * Set the nonce for subsequent requests * @param string $nonce * @return mixed */ - public function setNonce($nonce) { } + public function setNonce($nonce) {} /** - * * @param int $reqengine * @return void */ - public function setRequestEngine($reqengine) { } + public function setRequestEngine($reqengine) {} /** * Set the RSA certificate * @param string $cert * @return mixed */ - public function setRSACertificate($cert) { } + public function setRSACertificate($cert) {} /** * Set the timestamp * @param string $timestamp * @return mixed */ - public function setTimestamp($timestamp) { } + public function setTimestamp($timestamp) {} /** * Set the token and secret @@ -236,21 +234,18 @@ public function setTimestamp($timestamp) { } * @param string $token_secret * @return bool */ - public function setToken($token, $token_secret) { } + public function setToken($token, $token_secret) {} /** * Set the OAuth version * @param string $version * @return bool */ - public function setVersion($version) { } + public function setVersion($version) {} } -/** - * - */ -class OAuthException extends Exception { - +class OAuthException extends Exception +{ /** * The response of the exception which occurred, if any * @var string @@ -268,102 +263,101 @@ class OAuthException extends Exception { /** * Manages an OAuth provider class. */ -class OAuthProvider { - +class OAuthProvider +{ /** * @param string $req_params * @return bool */ - final public function addRequiredParameter($req_params) { } + final public function addRequiredParameter($req_params) {} /** * @return void */ - public function callconsumerHandler() { } + public function callconsumerHandler() {} /** * @return void */ - public function callTimestampNonceHandler() { } + public function callTimestampNonceHandler() {} /** * @return void */ - public function calltokenHandler() { } + public function calltokenHandler() {} /** * @param string $uri * @param string $method * @return void */ - public function checkOAuthRequest($uri = '', $method = '') { } + public function checkOAuthRequest($uri = '', $method = '') {} /** * @param array $params_array */ - public function __construct($params_array) { } + public function __construct($params_array) {} /** * @param callback $callback_function * @return void */ - public function consumerHandler($callback_function) { } + public function consumerHandler($callback_function) {} /** * @param int $size * @param bool $strong * @return string */ - final public static function generateToken($size, $strong = false) { } + final public static function generateToken($size, $strong = false) {} /** * @param mixed $params_array * @return void */ - public function is2LeggedEndpoint($params_array) { } + public function is2LeggedEndpoint($params_array) {} /** * @param bool $will_issue_request_token * @return void */ - public function isRequestTokenEndpoint($will_issue_request_token) { } + public function isRequestTokenEndpoint($will_issue_request_token) {} /** * @param string $req_params * @return bool */ - final public function removeRequiredParameter($req_params) { } + final public function removeRequiredParameter($req_params) {} /** * @param string $oauthexception * @param bool $send_headers * @return string */ - final public static function reportProblem($oauthexception, $send_headers = true) { } + final public static function reportProblem($oauthexception, $send_headers = true) {} /** * @param string $param_key * @param mixed $param_val * @return bool */ - final public function setParam($param_key, $param_val = null) { } - + final public function setParam($param_key, $param_val = null) {} /** * @param string $path * @return bool */ - final public function setRequestTokenPath($path) { } + final public function setRequestTokenPath($path) {} /** * @param callback $callback_function * @return void */ - public function timestampNonceHandler($callback_function) { } + public function timestampNonceHandler($callback_function) {} /** * @param callback $callback_function * @return void */ - public function tokenHandler($callback_function) { } + public function tokenHandler($callback_function) {} } diff --git a/oci8/oci8.php b/oci8/oci8.php index cfce720d1..d57beda00 100644 --- a/oci8/oci8.php +++ b/oci8/oci8.php @@ -6,365 +6,363 @@ * OCI8 LOB functionality for large binary (BLOB) and character (CLOB) objects. * @link https://php.net/manual/en/class.OCI-Lob.php */ -class OCI_Lob { - - /** - * (PHP 5, PECL OCI8 >= 1.1.0)- * If provided, this method will truncate the LOB to - * length bytes. Otherwise, it will completely - * purge the LOB. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function truncate ($length = 0) {} - - /** - * (PHP 5, PECL OCI8 >= 1.1.0)- * By default, resources are not freed, but using flag - * OCI_LOB_BUFFER_FREE you can do it explicitly. - * Be sure you know what you're doing - next read/write operation to the - * same part of LOB will involve a round-trip to the server and initialize - * new buffer resources. It is recommended to use - * OCI_LOB_BUFFER_FREE flag only when you are not - * going to work with the LOB anymore. - *
- * @return bool TRUE on success or FALSE on failure. - * - *
- * Returns FALSE if buffering was not enabled or an error occurred.
- */
- public function flush ($flag = null) {}
-
- /**
- * (PHP 5, PECL OCI8 >= 1.1.0)
- * Changes current state of buffering for the large object
- * @link https://php.net/manual/en/oci-lob.setbuffering.php
- * @param bool $on_off
- * TRUE for on and FALSE for off. - *
- * @return bool TRUE on success or FALSE on failure. Repeated calls to this method with the same flag will - * return TRUE. - */ - public function setbuffering ($on_off) {} - - /** - * (PHP 5, PECL OCI8 >= 1.1.0)- * The length of data to read, in bytes. Large values will be rounded down to 1 MB. - *
- * @return string|false The contents as a string, or FALSE on failure. - */ - public function read ($length) {} - - /** - * (PHP 5, PECL OCI8 >= 1.1.0)- * Indicates the amount of bytes, on which internal pointer should be - * moved from the position, pointed by whence. - *
- * @param int $whence [optional]- * May be one of: - * OCI_SEEK_SET - sets the position equal to - * offset - * OCI_SEEK_CUR - adds offset - * bytes to the current position - * OCI_SEEK_END - adds offset - * bytes to the end of large object (use negative value to move to a position - * before the end of large object) - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function seek ($offset, $whence = OCI_SEEK_SET) {} - - /** - * (PHP 5, PECL OCI8 >= 1.1.0)- * The data to write in the LOB. - *
- * @param int $length [optional]- * If this parameter is given, writing will stop after - * length bytes have been written or the end of - * data is reached, whichever comes first. - *
- * @return int|false The number of bytes written or FALSE on failure. - */ - public function write ($data, $length = null) {} - - /** - * (PHP 5, PECL OCI8 >= 1.1.0)- * The copied LOB. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function append (OCI_Lob $lob_from) {} - - /** - * (PHP 5, PECL OCI8 >= 1.1.0)+ * If provided, this method will truncate the LOB to + * length bytes. Otherwise, it will completely + * purge the LOB. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function truncate($length = 0) {} + + /** + * (PHP 5, PECL OCI8 >= 1.1.0)+ * By default, resources are not freed, but using flag + * OCI_LOB_BUFFER_FREE you can do it explicitly. + * Be sure you know what you're doing - next read/write operation to the + * same part of LOB will involve a round-trip to the server and initialize + * new buffer resources. It is recommended to use + * OCI_LOB_BUFFER_FREE flag only when you are not + * going to work with the LOB anymore. + *
+ * @return bool TRUE on success or FALSE on failure. + * + *
+ * Returns FALSE if buffering was not enabled or an error occurred.
+ */
+ public function flush($flag = null) {}
+
+ /**
+ * (PHP 5, PECL OCI8 >= 1.1.0)
+ * Changes current state of buffering for the large object
+ * @link https://php.net/manual/en/oci-lob.setbuffering.php
+ * @param bool $on_off
+ * TRUE for on and FALSE for off. + *
+ * @return bool TRUE on success or FALSE on failure. Repeated calls to this method with the same flag will + * return TRUE. + */ + public function setbuffering($on_off) {} + + /** + * (PHP 5, PECL OCI8 >= 1.1.0)+ * The length of data to read, in bytes. Large values will be rounded down to 1 MB. + *
+ * @return string|false The contents as a string, or FALSE on failure. + */ + public function read($length) {} + + /** + * (PHP 5, PECL OCI8 >= 1.1.0)+ * Indicates the amount of bytes, on which internal pointer should be + * moved from the position, pointed by whence. + *
+ * @param int $whence [optional]+ * May be one of: + * OCI_SEEK_SET - sets the position equal to + * offset + * OCI_SEEK_CUR - adds offset + * bytes to the current position + * OCI_SEEK_END - adds offset + * bytes to the end of large object (use negative value to move to a position + * before the end of large object) + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function seek($offset, $whence = OCI_SEEK_SET) {} + + /** + * (PHP 5, PECL OCI8 >= 1.1.0)+ * The data to write in the LOB. + *
+ * @param int $length [optional]+ * If this parameter is given, writing will stop after + * length bytes have been written or the end of + * data is reached, whichever comes first. + *
+ * @return int|false The number of bytes written or FALSE on failure. + */ + public function write($data, $length = null) {} + + /** + * (PHP 5, PECL OCI8 >= 1.1.0)+ * The copied LOB. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function append(OCI_Lob $lob_from) {} + + /** + * (PHP 5, PECL OCI8 >= 1.1.0)- * Path to the file. - *
- * @param int $start [optional]- * Indicates from where to start exporting. - *
- * @param int $length [optional]- * Indicates the length of data to be exported. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function export ($filename, $start = null, $length = null) {} - - /** - * (PHP 5, PECL OCI8 >= 1.1.0)- * Path to the file. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function import ($filename) {} - - /** - * (PHP 5, PECL OCI8 >= 1.1.0)- * The data to write. - *
- * @param int $lob_type [optional]- * Can be one of the following: - * OCI_TEMP_BLOB is used to create temporary BLOBs - * OCI_TEMP_CLOB is used to create - * temporary CLOBs - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function writeTemporary ($data, $lob_type = OCI_TEMP_CLOB) {} - - /** - * (PHP 5, PECL OCI8 >= 1.1.0)- * The data to be saved. - *
- * @param int $offset [optional]- * Can be used to indicate offset from the beginning of the large object. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function save ($data, $offset = null) {} - - /** - * (PHP 5, PECL OCI8 >= 1.1.0)+ * Path to the file. + *
+ * @param int $start [optional]+ * Indicates from where to start exporting. + *
+ * @param int $length [optional]+ * Indicates the length of data to be exported. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function export($filename, $start = null, $length = null) {} + + /** + * (PHP 5, PECL OCI8 >= 1.1.0)+ * Path to the file. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function import($filename) {} + + /** + * (PHP 5, PECL OCI8 >= 1.1.0)+ * The data to write. + *
+ * @param int $lob_type [optional]+ * Can be one of the following: + * OCI_TEMP_BLOB is used to create temporary BLOBs + * OCI_TEMP_CLOB is used to create + * temporary CLOBs + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function writeTemporary($data, $lob_type = OCI_TEMP_CLOB) {} + + /** + * (PHP 5, PECL OCI8 >= 1.1.0)+ * The data to be saved. + *
+ * @param int $offset [optional]+ * Can be used to indicate offset from the beginning of the large object. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function save($data, $offset = null) {} + + /** + * (PHP 5, PECL OCI8 >= 1.1.0)- * The value to be added to the collection. Can be a string or a number. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function append ($value) {} - - /** - * (PHP 5, PECL OCI8 >= 1.1.0)- * The element index. First index is 0. - *
- * @return mixed FALSE if such element doesn't exist; NULL if element is NULL; - * string if element is column of a string datatype or number if element is - * numeric field. - */ - public function getelem ($index) {} - - /** - * (PHP 5, PECL OCI8 >= 1.1.0)- * The element index. First index is 0. - *
- * @param mixed $value- * Can be a string or a number. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function assignelem ($index, $value) {} - - /** - * (PHP 5, PECL OCI8 >= 1.1.0)- * An instance of OCI-Collection. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function assign (OCI_Collection $from) {} - - /** - * (PHP 5, PECL OCI8 >= 1.1.0)
- * If the returned value is 0, then the number of elements is not limited.
- */
- public function max () {}
-
- /**
- * (PHP 5, PECL OCI8 >= 1.1.0)
- * Trims elements from the end of the collection
- * @link https://php.net/manual/en/oci-collection.trim.php
- * @param int $num
- * The number of elements to be trimmed. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function trim ($num) {} - - /** - * (PHP 5, PECL OCI8 >= 1.1.0)+ * The value to be added to the collection. Can be a string or a number. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function append($value) {} + + /** + * (PHP 5, PECL OCI8 >= 1.1.0)+ * The element index. First index is 0. + *
+ * @return mixed FALSE if such element doesn't exist; NULL if element is NULL; + * string if element is column of a string datatype or number if element is + * numeric field. + */ + public function getelem($index) {} + + /** + * (PHP 5, PECL OCI8 >= 1.1.0)+ * The element index. First index is 0. + *
+ * @param mixed $value+ * Can be a string or a number. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function assignelem($index, $value) {} + + /** + * (PHP 5, PECL OCI8 >= 1.1.0)+ * An instance of OCI-Collection. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function assign(OCI_Collection $from) {} + + /** + * (PHP 5, PECL OCI8 >= 1.1.0)
+ * If the returned value is 0, then the number of elements is not limited.
+ */
+ public function max() {}
+
+ /**
+ * (PHP 5, PECL OCI8 >= 1.1.0)
+ * Trims elements from the end of the collection
+ * @link https://php.net/manual/en/oci-collection.trim.php
+ * @param int $num
+ * The number of elements to be trimmed. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function trim($num) {} + + /** + * (PHP 5, PECL OCI8 >= 1.1.0)
* Returns FALSE on error.
*/
-function oci_statement_type ($statement) {}
+function oci_statement_type($statement) {}
/**
* (PHP 5, PECL OCI8 >= 1.1.0)
@@ -1145,7 +1143,7 @@ function oci_statement_type ($statement) {}
*
Returns a connection identifier or FALSE on error.
*/ -function ocinlogon ($username, $password, $connection_string, $character_set, $session_mode) {} +function ocinlogon($username, $password, $connection_string, $character_set, $session_mode) {} /** * (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)Returns a connection identifier or FALSE on error.
*/ -function ociplogon ($username, $password, $connection_string, $character_set, $session_mode) {} +function ociplogon($username, $password, $connection_string, $character_set, $session_mode) {} /** * (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)Returns TRUE on success or FALSE on failure.
*/ -function ocifreedesc ($lob_descriptor) {} +function ocifreedesc($lob_descriptor) {} /** * (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)Indicates the length of data to be exported.
* @return bool Returns TRUE on success or FALSE on failure. */ -function ociwritelobtofile ($lob_descriptor, $filename, $start, $length) {} +function ociwritelobtofile($lob_descriptor, $filename, $start, $length) {} /** * (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)Returns the contents of the object, or FALSE on errors.
*/ -function ociloadlob ($lob_descriptor) {} +function ociloadlob($lob_descriptor) {} /** * (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)Returns TRUE on success or FALSE on failure.
*/ -function ocicommit ($connection_resource) {} +function ocicommit($connection_resource) {} /** * (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)Returns TRUE on success or FALSE on failure.
*/ -function ocirollback ($connection_resource) {} +function ocirollback($connection_resource) {} /** * (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)Valid values for type are: OCI_DTYPE_FILE, OCI_DTYPE_LOB and OCI_DTYPE_ROWID.
* @return OCI_LOB|false Returns a new LOB or FILE descriptor on success, FALSE on error. */ -function ocinewdescriptor ($connection_resource, $type = OCI_DTYPE_LOB) {} +function ocinewdescriptor($connection_resource, $type = OCI_DTYPE_LOB) {} /** * (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)Returns TRUE on success or FALSE on failure.
*/ -function ocisetprefetch ($statement_resource, $number_of_rows) {} +function ocisetprefetch($statement_resource, $number_of_rows) {} /** * (PHP 5, PECL OCI8 >= 1.1.0)The new password to be set.
* @return resource|boolReturns TRUE on success or FALSE on failure or resource, depending on the function parameters.
*/ -function ocipasswordchange ($connection_resource_or_connection_string_or_dbname, $username, $old_password, $new_password) {} +function ocipasswordchange($connection_resource_or_connection_string_or_dbname, $username, $old_password, $new_password) {} /** * (PHP 4 >= 4.0.7, PHP 5, PECL OCI8 >= 1.0.0)Returns a new OCI_Collection object or FALSE on error.
*/ -function ocinewcollection ($connection_resource, $tdo, $schema = null) {} +function ocinewcollection($connection_resource, $tdo, $schema = null) {} /** * (PHP 4 >= 4.0.6, PHP 5, PECL OCI8 >= 1.0.0)The value to be added to the collection. Can be a string or a number.
* @return boolReturns TRUE on success or FALSE on failure.
*/ -function ocicollappend ($collection, $value) {} +function ocicollappend($collection, $value) {} /** * (PHP 4 >= 4.0.6, PHP 5, PECL OCI8 >= 1.0.0)The element index. First index is 0.
* @return mixedReturns FALSE if such element doesn't exist; NULL if element is NULL; string if element is column of a string datatype or number if element is numeric field.
*/ -function ocicollgetelem ($collection, $index) {} +function ocicollgetelem($collection, $index) {} /** * (PHP 4 >= 4.0.6, PHP 5, PECL OCI8 >= 1.0.0)Can be a string or a number.
* @return boolReturns TRUE on success or FALSE on failure.
*/ -function ocicollassignelem ($collection, $index, $value) {} +function ocicollassignelem($collection, $index, $value) {} /** * (PHP 4 >= 4.0.6, PHP 5, PECL OCI8 >= 1.0.0)Returns the number of elements in the collection or FALSE on error.
*/ -function ocicollsize ($collection) {} +function ocicollsize($collection) {} /** * (PHP 4 >= 4.0.6, PHP 5, PECL OCI8 >= 1.0.0)Returns the maximum number as an integer, or FALSE on errors. * If the returned value is 0, then the number of elements is not limited.
*/ -function ocicollmax ($collection) {} +function ocicollmax($collection) {} /** * (PHP 4 >= 4.0.6, PHP 5, PECL OCI8 >= 1.0.0)Returns TRUE on success or FALSE on failure.
*/ -function ociwritetemporarylob($lob_descriptor, $data, $lob_type = OCI_TEMP_CLOB ) {} +function ociwritetemporarylob($lob_descriptor, $data, $lob_type = OCI_TEMP_CLOB) {} /** * (PHP 4 >= 4.0.6, PECL OCI8 1.0) @@ -2244,7 +2241,7 @@ function ociwritetemporarylob($lob_descriptor, $data, $lob_type = OCI_TEMP_CLOB * @param OCI_Lob $lob_descriptor * @return boolReturns TRUE on success or FALSE on failure.
*/ -function ocicloselob($lob_descriptor){} +function ocicloselob($lob_descriptor) {} /** * (PHP 4 >= 4.0.6, PECL OCI8 1.0) @@ -2255,12 +2252,12 @@ function ocicloselob($lob_descriptor){} * @param OCI_Collection $from An instance of OCI-Collection. * @return boolReturns TRUE on success or FALSE on failure.
*/ -function ocicollassign($to, $from ) {} +function ocicollassign($to, $from) {} /** * See OCI_NO_AUTO_COMMIT. * @link https://php.net/manual/en/oci8.constants.php */ -define ('OCI_DEFAULT', 0); +define('OCI_DEFAULT', 0); /** * Used with {@see oci_connect} to connect with @@ -2269,7 +2266,7 @@ function ocicollassign($to, $from ) {} * should be enabled to use this. * @link https://php.net/manual/en/oci8.constants.php */ -define ('OCI_SYSOPER', 4); +define('OCI_SYSOPER', 4); /** * Used with {@see oci_connect} to connect with @@ -2278,7 +2275,7 @@ function ocicollassign($to, $from ) {} * should be enabled to use this. * @link https://php.net/manual/en/oci8.constants.php */ -define ('OCI_SYSDBA', 2); +define('OCI_SYSDBA', 2); /** * Used with {@see oci_connect} for using @@ -2286,7 +2283,7 @@ function ocicollassign($to, $from ) {} * 5.3 and PECL OCI8 1.3.4. * @link https://php.net/manual/en/oci8.constants.php */ -define ('OCI_CRED_EXT', -2147483648); +define('OCI_CRED_EXT', -2147483648); /** * Statement execution mode @@ -2295,7 +2292,7 @@ function ocicollassign($to, $from ) {} * fetch rows from the query. * @link https://php.net/manual/en/oci8.constants.php */ -define ('OCI_DESCRIBE_ONLY', 16); +define('OCI_DESCRIBE_ONLY', 16); /** * Statement execution mode for {@see oci_execute} @@ -2303,7 +2300,7 @@ function ocicollassign($to, $from ) {} * succeeded. * @link https://php.net/manual/en/oci8.constants.php */ -define ('OCI_COMMIT_ON_SUCCESS', 32); +define('OCI_COMMIT_ON_SUCCESS', 32); /** * Statement execution mode @@ -2314,7 +2311,7 @@ function ocicollassign($to, $from ) {} * Introduced in PHP 5.3.2 (PECL OCI8 1.4). * @link https://php.net/manual/en/oci8.constants.php */ -define ('OCI_NO_AUTO_COMMIT', 0); +define('OCI_NO_AUTO_COMMIT', 0); /** * Obsolete. Statement fetch mode. Used when the application @@ -2325,87 +2322,87 @@ function ocicollassign($to, $from ) {} * resource usage. * @link https://php.net/manual/en/oci8.constants.php */ -define ('OCI_EXACT_FETCH', 2); +define('OCI_EXACT_FETCH', 2); /** * Used with to set the seek position. * @link https://php.net/manual/en/oci8.constants.php */ -define ('OCI_SEEK_SET', 0); +define('OCI_SEEK_SET', 0); /** * Used with to set the seek position. * @link https://php.net/manual/en/oci8.constants.php */ -define ('OCI_SEEK_CUR', 1); +define('OCI_SEEK_CUR', 1); /** * Used with to set the seek position. * @link https://php.net/manual/en/oci8.constants.php */ -define ('OCI_SEEK_END', 2); +define('OCI_SEEK_END', 2); /** * Used with to free * buffers used. * @link https://php.net/manual/en/oci8.constants.php */ -define ('OCI_LOB_BUFFER_FREE', 1); +define('OCI_LOB_BUFFER_FREE', 1); /** * The same as OCI_B_BFILE. * @link https://php.net/manual/en/oci8.constants.php */ -define ('SQLT_BFILEE', 114); +define('SQLT_BFILEE', 114); /** * The same as OCI_B_CFILEE. * @link https://php.net/manual/en/oci8.constants.php */ -define ('SQLT_CFILEE', 115); +define('SQLT_CFILEE', 115); /** * The same as OCI_B_CLOB. * @link https://php.net/manual/en/oci8.constants.php */ -define ('SQLT_CLOB', 112); +define('SQLT_CLOB', 112); /** * The same as OCI_B_BLOB. * @link https://php.net/manual/en/oci8.constants.php */ -define ('SQLT_BLOB', 113); +define('SQLT_BLOB', 113); /** * The same as OCI_B_ROWID. * @link https://php.net/manual/en/oci8.constants.php */ -define ('SQLT_RDD', 104); +define('SQLT_RDD', 104); /** * The same as OCI_B_INT. * @link https://php.net/manual/en/oci8.constants.php */ -define ('SQLT_INT', 3); +define('SQLT_INT', 3); /** * The same as OCI_B_NUM. * @link https://php.net/manual/en/oci8.constants.php */ -define ('SQLT_NUM', 2); +define('SQLT_NUM', 2); /** * The same as OCI_B_CURSOR. * @link https://php.net/manual/en/oci8.constants.php */ -define ('SQLT_RSET', 116); +define('SQLT_RSET', 116); /** * Used with {@see oci_bind_array_by_name} to bind arrays of * CHAR. * @link https://php.net/manual/en/oci8.constants.php */ -define ('SQLT_AFC', 96); +define('SQLT_AFC', 96); /** * Used with {@see oci_bind_array_by_name} to bind arrays of @@ -2413,85 +2410,85 @@ function ocicollassign($to, $from ) {} * Also used with {@see oci_bind_by_name}. * @link https://php.net/manual/en/oci8.constants.php */ -define ('SQLT_CHR', 1); +define('SQLT_CHR', 1); /** * Used with {@see oci_bind_array_by_name} to bind arrays of * VARCHAR. * @link https://php.net/manual/en/oci8.constants.php */ -define ('SQLT_VCS', 9); +define('SQLT_VCS', 9); /** * Used with {@see oci_bind_array_by_name} to bind arrays of * VARCHAR2. * @link https://php.net/manual/en/oci8.constants.php */ -define ('SQLT_AVC', 97); +define('SQLT_AVC', 97); /** * Used with {@see oci_bind_array_by_name} to bind arrays of * STRING. * @link https://php.net/manual/en/oci8.constants.php */ -define ('SQLT_STR', 5); +define('SQLT_STR', 5); /** * Used with {@see oci_bind_array_by_name} to bind arrays of * LONG VARCHAR. * @link https://php.net/manual/en/oci8.constants.php */ -define ('SQLT_LVC', 94); +define('SQLT_LVC', 94); /** * Used with {@see oci_bind_array_by_name} to bind arrays of * FLOAT. * @link https://php.net/manual/en/oci8.constants.php */ -define ('SQLT_FLT', 4); +define('SQLT_FLT', 4); /** * Not supported. * @link https://php.net/manual/en/oci8.constants.php */ -define ('SQLT_UIN', 68); +define('SQLT_UIN', 68); /** * Used with {@see oci_bind_by_name} to bind LONG values. * @link https://php.net/manual/en/oci8.constants.php */ -define ('SQLT_LNG', 8); +define('SQLT_LNG', 8); /** * Used with {@see oci_bind_by_name} to bind LONG RAW values. * @link https://php.net/manual/en/oci8.constants.php */ -define ('SQLT_LBI', 24); +define('SQLT_LBI', 24); /** * The same as OCI_B_BIN. * @link https://php.net/manual/en/oci8.constants.php */ -define ('SQLT_BIN', 23); +define('SQLT_BIN', 23); /** * Used with {@see oci_bind_array_by_name} to bind arrays of * LONG. * @link https://php.net/manual/en/oci8.constants.php */ -define ('SQLT_ODT', 156); +define('SQLT_ODT', 156); /** * Not supported. * @link https://php.net/manual/en/oci8.constants.php */ -define ('SQLT_BDOUBLE', 22); +define('SQLT_BDOUBLE', 22); /** * Not supported. * @link https://php.net/manual/en/oci8.constants.php */ -define ('SQLT_BFLOAT', 21); +define('SQLT_BFLOAT', 21); /** * Used with {@see oci_bind_by_name} when binding @@ -2499,54 +2496,54 @@ function ocicollassign($to, $from ) {} * OCI_B_SQLT_NTY. * @link https://php.net/manual/en/oci8.constants.php */ -define ('OCI_B_NTY', 108); +define('OCI_B_NTY', 108); /** * The same as OCI_B_NTY. * @link https://php.net/manual/en/oci8.constants.php */ -define ('SQLT_NTY', 108); +define('SQLT_NTY', 108); /** * Obsolete. * @link https://php.net/manual/en/oci8.constants.php */ -define ('OCI_SYSDATE', "SYSDATE"); +define('OCI_SYSDATE', "SYSDATE"); /** * Used with {@see oci_bind_by_name} when binding * BFILEs. * @link https://php.net/manual/en/oci8.constants.php */ -define ('OCI_B_BFILE', 114); +define('OCI_B_BFILE', 114); /** * Used with {@see oci_bind_by_name} when binding * CFILEs. * @link https://php.net/manual/en/oci8.constants.php */ -define ('OCI_B_CFILEE', 115); +define('OCI_B_CFILEE', 115); /** * Used with {@see oci_bind_by_name} when binding * CLOBs. * @link https://php.net/manual/en/oci8.constants.php */ -define ('OCI_B_CLOB', 112); +define('OCI_B_CLOB', 112); /** * Used with {@see oci_bind_by_name} when * binding BLOBs. * @link https://php.net/manual/en/oci8.constants.php */ -define ('OCI_B_BLOB', 113); +define('OCI_B_BLOB', 113); /** * Used with {@see oci_bind_by_name} when binding * ROWIDs. * @link https://php.net/manual/en/oci8.constants.php */ -define ('OCI_B_ROWID', 104); +define('OCI_B_ROWID', 104); /** * Used with {@see oci_bind_by_name} when binding @@ -2554,39 +2551,39 @@ function ocicollassign($to, $from ) {} * with {@see oci_new_descriptor}. * @link https://php.net/manual/en/oci8.constants.php */ -define ('OCI_B_CURSOR', 116); +define('OCI_B_CURSOR', 116); /** * Used with {@see oci_bind_by_name} to bind RAW values. * @link https://php.net/manual/en/oci8.constants.php */ -define ('OCI_B_BIN', 23); +define('OCI_B_BIN', 23); /** * Used with {@see oci_bind_array_by_name} to bind arrays of * INTEGER. * @link https://php.net/manual/en/oci8.constants.php */ -define ('OCI_B_INT', 3); +define('OCI_B_INT', 3); /** * Used with {@see oci_bind_array_by_name} to bind arrays of * NUMBER. * @link https://php.net/manual/en/oci8.constants.php */ -define ('OCI_B_NUM', 2); +define('OCI_B_NUM', 2); /** * Default mode of {@see oci_fetch_all}. * @link https://php.net/manual/en/oci8.constants.php */ -define ('OCI_FETCHSTATEMENT_BY_COLUMN', 16); +define('OCI_FETCHSTATEMENT_BY_COLUMN', 16); /** * Alternative mode of {@see oci_fetch_all}. * @link https://php.net/manual/en/oci8.constants.php */ -define ('OCI_FETCHSTATEMENT_BY_ROW', 32); +define('OCI_FETCHSTATEMENT_BY_ROW', 32); /** * Used with {@see oci_fetch_all} and @@ -2594,7 +2591,7 @@ function ocicollassign($to, $from ) {} * array. * @link https://php.net/manual/en/oci8.constants.php */ -define ('OCI_ASSOC', 1); +define('OCI_ASSOC', 1); /** * Used with {@see oci_fetch_all} and @@ -2602,7 +2599,7 @@ function ocicollassign($to, $from ) {} * enumerated array. * @link https://php.net/manual/en/oci8.constants.php */ -define ('OCI_NUM', 2); +define('OCI_NUM', 2); /** * Used with {@see oci_fetch_all} and @@ -2610,81 +2607,81 @@ function ocicollassign($to, $from ) {} * array with both associative and number indices. * @link https://php.net/manual/en/oci8.constants.php */ -define ('OCI_BOTH', 3); +define('OCI_BOTH', 3); /** * Used with {@see oci_fetch_array} to get empty * array elements if the row items value is NULL. * @link https://php.net/manual/en/oci8.constants.php */ -define ('OCI_RETURN_NULLS', 4); +define('OCI_RETURN_NULLS', 4); /** * Used with {@see oci_fetch_array} to get the * data value of the LOB instead of the descriptor. * @link https://php.net/manual/en/oci8.constants.php */ -define ('OCI_RETURN_LOBS', 8); +define('OCI_RETURN_LOBS', 8); /** * This flag tells {@see oci_new_descriptor} to * initialize a new FILE descriptor. * @link https://php.net/manual/en/oci8.constants.php */ -define ('OCI_DTYPE_FILE', 56); +define('OCI_DTYPE_FILE', 56); /** * This flag tells {@see oci_new_descriptor} to * initialize a new LOB descriptor. * @link https://php.net/manual/en/oci8.constants.php */ -define ('OCI_DTYPE_LOB', 50); +define('OCI_DTYPE_LOB', 50); /** * This flag tells {@see oci_new_descriptor} to * initialize a new ROWID descriptor. * @link https://php.net/manual/en/oci8.constants.php */ -define ('OCI_DTYPE_ROWID', 54); +define('OCI_DTYPE_ROWID', 54); /** * The same as OCI_DTYPE_FILE. * @link https://php.net/manual/en/oci8.constants.php */ -define ('OCI_D_FILE', 56); +define('OCI_D_FILE', 56); /** * The same as OCI_DTYPE_LOB. * @link https://php.net/manual/en/oci8.constants.php */ -define ('OCI_D_LOB', 50); +define('OCI_D_LOB', 50); /** * The same as OCI_DTYPE_ROWID. * @link https://php.net/manual/en/oci8.constants.php */ -define ('OCI_D_ROWID', 54); +define('OCI_D_ROWID', 54); /** * Used with * to indicate that a temporary CLOB should be created. * @link https://php.net/manual/en/oci8.constants.php */ -define ('OCI_TEMP_CLOB', 2); +define('OCI_TEMP_CLOB', 2); /** * Used with * to indicate that a temporary BLOB should be created. * @link https://php.net/manual/en/oci8.constants.php */ -define ('OCI_TEMP_BLOB', 1); +define('OCI_TEMP_BLOB', 1); /** * (PECL OCI8 >= 2.0.7)Additional authentication data.
* @return string|false The decrypted string on success or false on failure. */ -function openssl_decrypt(string $data, string $cipher_algo, string $passphrase, int $options = 0, string $iv = "", string $tag = "", string $aad = ""): string|false -{ } +function openssl_decrypt(string $data, string $cipher_algo, string $passphrase, int $options = 0, string $iv = "", string $tag = "", string $aad = ""): string|false {} /** * (PHP 5 >= PHP 5.3.3)- * pcov\all shall collect coverage information for all files - * pcov\inclusive shall collect coverage information for the specified files - * pcov\exclusive shall collect coverage information for all but the specified files - *
- * @param array $filter- * path of files (realpath) that should be filtered - *
- * @return array - */ + /** + * (PHP >= 7.0, PECL pcov >= 1.0.0)+ * pcov\all shall collect coverage information for all files + * pcov\inclusive shall collect coverage information for the specified files + * pcov\exclusive shall collect coverage information for all but the specified files + *
+ * @param array $filter+ * path of files (realpath) that should be filtered + *
+ * @return array + */ function collect(int $type = all, array $filter = []) {} - /** - * (PHP >= 7.0, PECL pcov >= 1.0.0)- * set true to clear file tables - * Note: clearing the file tables may have surprising consequences - *
- * @return void - */ + /** + * (PHP >= 7.0, PECL pcov >= 1.0.0)+ * set true to clear file tables + * Note: clearing the file tables may have surprising consequences + *
+ * @return void + */ function clear(bool $files = false) {} - /** - * (PHP >= 7.0, PECL pcov >= 1.0.0)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.
*/ -function preg_replace_callback_array (array $pattern, array|string $subject , int $limit = -1, &$count, int $flags = 0): array|string|null -{} +function preg_replace_callback_array(array $pattern, array|string $subject, int $limit = -1, &$count, int $flags = 0): array|string|null {} /** * Perform a regular expression search and replace @@ -408,8 +403,7 @@ function preg_replace_callback_array (array $pattern, array|string $subject , in * is returned when subject is an array * or NULL otherwise. */ -function preg_filter (array|string $pattern, array|string $replacement, array|string $subject, int $limit = -1, &$count): array|string|null -{} +function preg_filter(array|string $pattern, array|string $replacement, array|string $subject, int $limit = -1, &$count): array|string|null {} /** * Split string by a regular expression @@ -439,8 +433,7 @@ function preg_filter (array|string $pattern, array|string $replacement, array|st * if an error occurred. */ #[Pure] -function preg_split (string $pattern, string $subject, int $limit = -1, int $flags = 0): array|false -{} +function preg_split(string $pattern, string $subject, int $limit = -1, int $flags = 0): array|false {} /** * Quote regular expression characters @@ -457,8 +450,7 @@ function preg_split (string $pattern, string $subject, int $limit = -1, int $fla * @return string the quoted (escaped) string. */ #[Pure] -function preg_quote (string $str, ?string $delimiter): string -{} +function preg_quote(string $str, ?string $delimiter): string {} /** * Return array entries that match the pattern @@ -478,8 +470,7 @@ function preg_quote (string $str, ?string $delimiter): string * input array or false when pattern cannot be compiled. */ #[Pure] -function preg_grep (string $pattern, array $array, int $flags = 0): array|false -{} +function preg_grep(string $pattern, array $array, int $flags = 0): array|false {} /** * Returns the error code of the last PCRE regex execution @@ -493,8 +484,7 @@ function preg_grep (string $pattern, array $array, int $flags = 0): array|false * PREG_BAD_UTF8_OFFSET_ERROR (since PHP 5.3.0) */ #[Pure] -function preg_last_error (): int -{} +function preg_last_error(): int {} /** * Returns the error message of the last PCRE regex execution @@ -512,41 +502,41 @@ function preg_last_error_msg(): string {} * preg_match_all. * @link https://php.net/manual/en/pcre.constants.php */ -define ('PREG_PATTERN_ORDER', 1); +define('PREG_PATTERN_ORDER', 1); /** * Returned by {@see preg_last_error()} if the last PCRE function failed due to limited JIT stack space. * @since 7.0 */ -define ('PREG_JIT_STACKLIMIT_ERROR', 6); +define('PREG_JIT_STACKLIMIT_ERROR', 6); /** * Orders results so that $matches[0] is an array of first set of * matches, $matches[1] is an array of second set of matches, and so * on. This flag is only used with preg_match_all. * @link https://php.net/manual/en/pcre.constants.php */ -define ('PREG_SET_ORDER', 2); +define('PREG_SET_ORDER', 2); /** * See the description of * PREG_SPLIT_OFFSET_CAPTURE. * @link https://php.net/manual/en/pcre.constants.php */ -define ('PREG_OFFSET_CAPTURE', 256); +define('PREG_OFFSET_CAPTURE', 256); /** * This flag tells preg_split to return only non-empty * pieces. * @link https://php.net/manual/en/pcre.constants.php */ -define ('PREG_SPLIT_NO_EMPTY', 1); +define('PREG_SPLIT_NO_EMPTY', 1); /** * This flag tells preg_split to capture * parenthesized expression in the delimiter pattern as well. * @link https://php.net/manual/en/pcre.constants.php */ -define ('PREG_SPLIT_DELIM_CAPTURE', 2); +define('PREG_SPLIT_DELIM_CAPTURE', 2); /** * If this flag is set, for every occurring match the appendant string @@ -556,41 +546,41 @@ function preg_last_error_msg(): string {} * offset 1. This flag is only used for preg_split. * @link https://php.net/manual/en/pcre.constants.php */ -define ('PREG_SPLIT_OFFSET_CAPTURE', 4); -define ('PREG_GREP_INVERT', 1); +define('PREG_SPLIT_OFFSET_CAPTURE', 4); +define('PREG_GREP_INVERT', 1); /** * Returned by preg_last_error if there were no * errors. * @link https://php.net/manual/en/pcre.constants.php */ -define ('PREG_NO_ERROR', 0); +define('PREG_NO_ERROR', 0); /** * Returned by preg_last_error if there was an * internal PCRE error. * @link https://php.net/manual/en/pcre.constants.php */ -define ('PREG_INTERNAL_ERROR', 1); +define('PREG_INTERNAL_ERROR', 1); /** * Returned by preg_last_error if backtrack limit was exhausted. * @link https://php.net/manual/en/pcre.constants.php */ -define ('PREG_BACKTRACK_LIMIT_ERROR', 2); +define('PREG_BACKTRACK_LIMIT_ERROR', 2); /** * Returned by preg_last_error if recursion limit was exhausted. * @link https://php.net/manual/en/pcre.constants.php */ -define ('PREG_RECURSION_LIMIT_ERROR', 3); +define('PREG_RECURSION_LIMIT_ERROR', 3); /** * Returned by preg_last_error if the last error was * caused by malformed UTF-8 data (only when running a regex in UTF-8 mode). * @link https://php.net/manual/en/pcre.constants.php */ -define ('PREG_BAD_UTF8_ERROR', 4); +define('PREG_BAD_UTF8_ERROR', 4); /** * Returned by preg_last_error if the offset didn't @@ -599,7 +589,7 @@ function preg_last_error_msg(): string {} * mode). * @link https://php.net/manual/en/pcre.constants.php */ -define ('PREG_BAD_UTF8_OFFSET_ERROR', 5); +define('PREG_BAD_UTF8_OFFSET_ERROR', 5); /** * This flag tells {@see preg_match()} and {@see preg_match_all()} @@ -608,22 +598,22 @@ function preg_last_error_msg(): string {} * as if they were empty matches. Setting this flag allows to distinguish between these two cases. * @since 7.2 */ -define ('PREG_UNMATCHED_AS_NULL', 512); +define('PREG_UNMATCHED_AS_NULL', 512); /** * PCRE version and release date (e.g. "7.0 18-Dec-2006"). * @link https://php.net/manual/en/pcre.constants.php */ -define ('PCRE_VERSION', "8.31 2012-07-06"); +define('PCRE_VERSION', "8.31 2012-07-06"); /** * @since 7.3 */ -define ('PCRE_VERSION_MAJOR', 10); +define('PCRE_VERSION_MAJOR', 10); /** * @since 7.3 */ -define ('PCRE_VERSION_MINOR', 35); +define('PCRE_VERSION_MINOR', 35); /** * @since 7.3 diff --git a/pdflib/PDFlib.php b/pdflib/PDFlib.php index e946f7876..b95dc4397 100644 --- a/pdflib/PDFlib.php +++ b/pdflib/PDFlib.php @@ -4,1683 +4,1636 @@ class PDFlib { - /** - * Activates a previously created structure element or other content item. - * @param $id - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-activate-item.php - */ - function activate_item($id){} - - /** - * Adds a link to a web resource. - * @param float $llx - * @param float $lly - * @param float $urx - * @param float $ury - * @param string $filename - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-add-launchlink.php - * @see PDF_create_action() - */ - #[Deprecated(" This function is deprecated since PDFlib version 6, use PDF_create_action() with type=Launch and PDF_create_annotation() with type=Link instead.")] - function add_launchlink($llx, $lly, $urx, $ury, $filename){} - - /** - * Add a link annotation to a target within the current PDF file. - * - * @param float $lowerleftx - * @param float $lowerlefty - * @param float $upperrightx - * @param float $upperrighty - * @param int $page - * @param string $dest - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-add-locallink.php + /** + * Activates a previously created structure element or other content item. + * @param $id + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-activate-item.php + */ + public function activate_item($id) {} + + /** + * Adds a link to a web resource. + * @param float $llx + * @param float $lly + * @param float $urx + * @param float $ury + * @param string $filename + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-add-launchlink.php * @see PDF_create_action() - */ - #[Deprecated('This function is deprecated since PDFlib version 6, use PDF_create_action() with type=GoTo and PDF_create_annotation() with type=Link instead.')] - function add_locallink($lowerleftx, $lowerlefty, $upperrightx, $upperrighty, $page, $dest){} - - /** - * Creates a named destination on an arbitrary page in the current document. - * - * @param string $name - * @param string $optlist - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-add-nameddest.php - */ - function add_nameddest($name, $optlist){} - - /** - * Sets an annotation for the current page. - * - * @param float $llx - * @param float $lly - * @param float $urx - * @param float $ury - * @param string $contents - * @param string $title - * @param string $icon - * @param int $open - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-add-note.php + */ + #[Deprecated(" This function is deprecated since PDFlib version 6, use PDF_create_action() with type=Launch and PDF_create_annotation() with type=Link instead.")] + public function add_launchlink($llx, $lly, $urx, $ury, $filename) {} + + /** + * Add a link annotation to a target within the current PDF file. + * + * @param float $lowerleftx + * @param float $lowerlefty + * @param float $upperrightx + * @param float $upperrighty + * @param int $page + * @param string $dest + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-add-locallink.php + * @see PDF_create_action() + */ + #[Deprecated('This function is deprecated since PDFlib version 6, use PDF_create_action() with type=GoTo and PDF_create_annotation() with type=Link instead.')] + public function add_locallink($lowerleftx, $lowerlefty, $upperrightx, $upperrighty, $page, $dest) {} + + /** + * Creates a named destination on an arbitrary page in the current document. + * + * @param string $name + * @param string $optlist + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-add-nameddest.php + */ + public function add_nameddest($name, $optlist) {} + + /** + * Sets an annotation for the current page. + * + * @param float $llx + * @param float $lly + * @param float $urx + * @param float $ury + * @param string $contents + * @param string $title + * @param string $icon + * @param int $open + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-add-note.php * @see PDF_create_annotation() - */ - #[Deprecated('This function is deprecated since PDFlib version 6, use PDF_create_annotation() with type=Text instead.')] - function add_note($llx, $lly, $urx, $ury, $contents, $title, $icon, $open){} - - /** - * Add a file link annotation to a PDF target. - * - * @param float $bottom_left_x - * @param float $bottom_left_y - * @param float $up_right_x - * @param float $up_right_y - * @param string $filename - * @param int $page - * @param string $dest - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-add-pdflink.php + */ + #[Deprecated('This function is deprecated since PDFlib version 6, use PDF_create_annotation() with type=Text instead.')] + public function add_note($llx, $lly, $urx, $ury, $contents, $title, $icon, $open) {} + + /** + * Add a file link annotation to a PDF target. + * + * @param float $bottom_left_x + * @param float $bottom_left_y + * @param float $up_right_x + * @param float $up_right_y + * @param string $filename + * @param int $page + * @param string $dest + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-add-pdflink.php * @see PDF_create_action - */ - #[Deprecated('This function is deprecated since PDFlib version 6, use PDF_create_action() with type=GoToR and PDF_create_annotation() with type=Link instead.')] - function add_pdflink($bottom_left_x, $bottom_left_y, $up_right_x, $up_right_y, $filename, $page, $dest){} - - /** - * Adds a cell to a new or existing table. - * - * @param int $table - * @param int $column - * @param int $row - * @param string $text - * @param string $optlist - * - * @return int - * - * @link https://secure.php.net/manual/en/function.pdf-add-table-cell.php - */ - function add_table_cell($table, $column, $row, $text, $optlist){} - - /** - * Creates a Textflow object, or adds text and explicit options to an existing Textflow. - * - * @param int $textflow - * @param string $text - * @param string $optlist - * - * @return int - * - * @link https://secure.php.net/manual/en/function.pdf-add-textflow.php - */ - function add_textflow($textflow, $text, $optlist){} - - /** - * Adds an existing image as thumbnail for the current page. - * - * @param int $image - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-add-thumbnail.php - */ - function add_thumbnail($image){} - - /** - * Adds a weblink annotation to a target url on the Web. - * - * @param float $lowerleftx - * @param float $lowerlefty - * @param float $upperrightx - * @param float $upperrighty - * @param string $url - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-add-weblink.php + */ + #[Deprecated('This function is deprecated since PDFlib version 6, use PDF_create_action() with type=GoToR and PDF_create_annotation() with type=Link instead.')] + public function add_pdflink($bottom_left_x, $bottom_left_y, $up_right_x, $up_right_y, $filename, $page, $dest) {} + + /** + * Adds a cell to a new or existing table. + * + * @param int $table + * @param int $column + * @param int $row + * @param string $text + * @param string $optlist + * + * @return int + * + * @link https://secure.php.net/manual/en/function.pdf-add-table-cell.php + */ + public function add_table_cell($table, $column, $row, $text, $optlist) {} + + /** + * Creates a Textflow object, or adds text and explicit options to an existing Textflow. + * + * @param int $textflow + * @param string $text + * @param string $optlist + * + * @return int + * + * @link https://secure.php.net/manual/en/function.pdf-add-textflow.php + */ + public function add_textflow($textflow, $text, $optlist) {} + + /** + * Adds an existing image as thumbnail for the current page. + * + * @param int $image + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-add-thumbnail.php + */ + public function add_thumbnail($image) {} + + /** + * Adds a weblink annotation to a target url on the Web. + * + * @param float $lowerleftx + * @param float $lowerlefty + * @param float $upperrightx + * @param float $upperrighty + * @param string $url + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-add-weblink.php * @see PDF_create_action() - */ - #[Deprecated('This function is deprecated since PDFlib version 6, use PDF_create_action() with type=URI and PDF_create_annotation() with type=Link instead.')] - function add_weblink($lowerleftx, $lowerlefty, $upperrightx, $upperrighty, $url){} - - /** - * Adds a counterclockwise circular arc - * - * @param float $x - * @param float $y - * @param float $r - * @param float $alpha - * @param float $beta - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-arc.php - */ - function arc($x, $y, $r, $alpha, $beta){} - - /** - * Except for the drawing direction, this function behaves exactly like PDF_arc(). - * - * @param float $x - * @param float $y - * @param float $r - * @param float $alpha - * @param float $beta - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-arcn.php - */ - function arcn($x, $y, $r, $alpha, $beta){} - - /** - * Adds a file attachment annotation. - * - * @param float $llx - * @param float $lly - * @param float $urx - * @param float $ury - * @param string $filename - * @param string $description - * @param string $author - * @param string $mimetype - * @param string $icon - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-attach-file.php + */ + #[Deprecated('This function is deprecated since PDFlib version 6, use PDF_create_action() with type=URI and PDF_create_annotation() with type=Link instead.')] + public function add_weblink($lowerleftx, $lowerlefty, $upperrightx, $upperrighty, $url) {} + + /** + * Adds a counterclockwise circular arc + * + * @param float $x + * @param float $y + * @param float $r + * @param float $alpha + * @param float $beta + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-arc.php + */ + public function arc($x, $y, $r, $alpha, $beta) {} + + /** + * Except for the drawing direction, this function behaves exactly like PDF_arc(). + * + * @param float $x + * @param float $y + * @param float $r + * @param float $alpha + * @param float $beta + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-arcn.php + */ + public function arcn($x, $y, $r, $alpha, $beta) {} + + /** + * Adds a file attachment annotation. + * + * @param float $llx + * @param float $lly + * @param float $urx + * @param float $ury + * @param string $filename + * @param string $description + * @param string $author + * @param string $mimetype + * @param string $icon + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-attach-file.php * @see PDF_create_annotation() - */ - #[Deprecated('This function is deprecated since PDFlib version 6, use PDF_create_annotation() with type=FileAttachment instead.')] - function attach_file($llx, $lly, $urx, $ury, $filename, $description, $author, $mimetype, $icon){} - - /** - * Creates a new PDF file subject to various options. - * - * @param string $filename - * @param string $optlist - * - * @return int - * - * @link https://secure.php.net/manual/en/function.pdf-begin-document.php - * @link https://www.pdflib.com/fileadmin/pdflib/pdf/manuals/PDFlib-9.1.2-API-reference.pdf - */ - function begin_document($filename, $optlist){} - - /** - * Starts a Type 3 font definition. - * - * @param string $filename - * @param float $a - * @param float $b - * @param float $c - * @param float $d - * @param float $e - * @param float $f - * @param string $optlist - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-begin-font.php - */ - function begin_font($filename, $a, $b, $c, $d, $e, $f, $optlist){} - - /** - * Starts a glyph definition for a Type 3 font. - * - * @param string $glyphname - * @param float $wx - * @param float $llx - * @param float $lly - * @param float $urx - * @param float $ury - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-begin-glyph.php - */ - function begin_glyph($glyphname, $wx, $llx, $lly, $urx, $ury){} - - /** - * Opens a structure element or other content item with attributes supplied as options. - * - * @param string $tag - * @param string $optlist - * - * @return int - * - * @link https://secure.php.net/manual/en/function.pdf-begin-item.php - */ - function begin_item($tag, $optlist){} - - /** - * Starts a layer for subsequent output on the page. - * - * @param int $layer - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-begin-layer.php - */ - function begin_layer($layer){} - - /** - * Adds a new page to the document, and specifies various options. The parameters width and height are the dimensions of the new page in points. - * - * @param float $width - * @param float $height - * @param string $optlist - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-begin-page-ext.php - */ - function begin_page_ext($width, $height, $optlist){} - - - /** - * Adds a new page to the document. - * - * @param float $width - * @param float $height - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-begin-page.php - * + */ + #[Deprecated('This function is deprecated since PDFlib version 6, use PDF_create_annotation() with type=FileAttachment instead.')] + public function attach_file($llx, $lly, $urx, $ury, $filename, $description, $author, $mimetype, $icon) {} + + /** + * Creates a new PDF file subject to various options. + * + * @param string $filename + * @param string $optlist + * + * @return int + * + * @link https://secure.php.net/manual/en/function.pdf-begin-document.php + * @link https://www.pdflib.com/fileadmin/pdflib/pdf/manuals/PDFlib-9.1.2-API-reference.pdf + */ + public function begin_document($filename, $optlist) {} + + /** + * Starts a Type 3 font definition. + * + * @param string $filename + * @param float $a + * @param float $b + * @param float $c + * @param float $d + * @param float $e + * @param float $f + * @param string $optlist + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-begin-font.php + */ + public function begin_font($filename, $a, $b, $c, $d, $e, $f, $optlist) {} + + /** + * Starts a glyph definition for a Type 3 font. + * + * @param string $glyphname + * @param float $wx + * @param float $llx + * @param float $lly + * @param float $urx + * @param float $ury + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-begin-glyph.php + */ + public function begin_glyph($glyphname, $wx, $llx, $lly, $urx, $ury) {} + + /** + * Opens a structure element or other content item with attributes supplied as options. + * + * @param string $tag + * @param string $optlist + * + * @return int + * + * @link https://secure.php.net/manual/en/function.pdf-begin-item.php + */ + public function begin_item($tag, $optlist) {} + + /** + * Starts a layer for subsequent output on the page. + * + * @param int $layer + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-begin-layer.php + */ + public function begin_layer($layer) {} + + /** + * Adds a new page to the document, and specifies various options. The parameters width and height are the dimensions of the new page in points. + * + * @param float $width + * @param float $height + * @param string $optlist + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-begin-page-ext.php + */ + public function begin_page_ext($width, $height, $optlist) {} + + /** + * Adds a new page to the document. + * + * @param float $width + * @param float $height + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-begin-page.php + * * @see PDF_begin_page_ext() - */ - #[Deprecated('This function is deprecated since PDFlib version 6, use PDF_begin_page_ext() instead.')] - function begin_page($width, $height){} - - /** - * Starts a new pattern definition. - * - * @param float $width - * @param float $height - * @param float $xstep - * @param float $ystep - * @param int $painttype - * - * @return int - * - * @link https://secure.php.net/manual/en/function.pdf-begin-pattern.php - */ - function begin_pattern($width, $height, $xstep, $ystep, $painttype){} - - /** - * Starts a new template definition. - * - * @param float $width - * @param float $height - * @param string $optlist - * - * @return int - * - * @link https://secure.php.net/manual/en/function.pdf-begin-template-ext.php - */ - function begin_template_ext($width, $height, $optlist){} - - /** - * @param float $width - * @param float $height - * - * @return int - * - * @link https://secure.php.net/manual/en/function.pdf-begin-template.php - * + */ + #[Deprecated('This function is deprecated since PDFlib version 6, use PDF_begin_page_ext() instead.')] + public function begin_page($width, $height) {} + + /** + * Starts a new pattern definition. + * + * @param float $width + * @param float $height + * @param float $xstep + * @param float $ystep + * @param int $painttype + * + * @return int + * + * @link https://secure.php.net/manual/en/function.pdf-begin-pattern.php + */ + public function begin_pattern($width, $height, $xstep, $ystep, $painttype) {} + + /** + * Starts a new template definition. + * + * @param float $width + * @param float $height + * @param string $optlist + * + * @return int + * + * @link https://secure.php.net/manual/en/function.pdf-begin-template-ext.php + */ + public function begin_template_ext($width, $height, $optlist) {} + + /** + * @param float $width + * @param float $height + * + * @return int + * + * @link https://secure.php.net/manual/en/function.pdf-begin-template.php + * * @see PDF_begin_template_ext - */ - #[Deprecated('This function is deprecated since PDFlib version 7, use PDF_begin_template_ext() instead.')] - function begin_template($width, $height){} - - /** - * @param float $x - * @param float $y - * @param float $r - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-circle.php - */ - function circle($x, $y, $r){} - - /** - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-clip.php - */ - function clip(){} - - /** - * @param int $image - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-close-image.php - */ - function close_image($image){} - - /** - * Closes the page handle, and frees all page-related resources - * - * @param int $page - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-close-pdi-page.php - */ - function close_pdi_page($page){} - - /** - * @param int $doc - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-close-pdi.php - * + */ + #[Deprecated('This function is deprecated since PDFlib version 7, use PDF_begin_template_ext() instead.')] + public function begin_template($width, $height) {} + + /** + * @param float $x + * @param float $y + * @param float $r + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-circle.php + */ + public function circle($x, $y, $r) {} + + /** + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-clip.php + */ + public function clip() {} + + /** + * @param int $image + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-close-image.php + */ + public function close_image($image) {} + + /** + * Closes the page handle, and frees all page-related resources + * + * @param int $page + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-close-pdi-page.php + */ + public function close_pdi_page($page) {} + + /** + * @param int $doc + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-close-pdi.php + * * @see PDF_close_pdi_document() - */ - #[Deprecated('This function is deprecated since PDFlib version 7, use PDF_close_pdi_document() instead.')] - function close_pdi($doc){} - - /** - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-close.php - * + */ + #[Deprecated('This function is deprecated since PDFlib version 7, use PDF_close_pdi_document() instead.')] + public function close_pdi($doc) {} + + /** + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-close.php + * * @see PDF_end_document - */ - #[Deprecated('This function is deprecated since PDFlib version 6, use PDF_end_document() instead.')] - function close(){} - - /** - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-closepath-fill-stroke.php - */ - function closepath_fill_stroke(){} - - /** - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-closepath-stroke.php - */ - function closepath_stroke(){} - - /** - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-closepath.php - */ - function closepath(){} - - /** - * @param float $a - * @param float $b - * @param float $c - * @param float $d - * @param float $e - * @param float $f - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-concat.php - */ - function concat($a, $b, $c, $d, $e, $f){} - - /** - * @param string $text - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-continue-text.php - */ - function continue_text($text){} - - /** - * @param string $username - * @param string $optlist - * - * @return int - * - * @link https://secure.php.net/manual/en/function.pdf-create-3dview.php - */ - function create_3dview($username, $optlist){} - - /** - * @param string $type - * @param string $optlist - * - * @return int - * - * @link https://secure.php.net/manual/en/function.pdf-create-action.php - */ - function create_action($type, $optlist){} - - /** - * @param float $llx - * @param float $lly - * @param float $urx - * @param float $ury - * @param string $type - * @param string $optlist - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-create-annotation.php - */ - function create_annotation($llx, $lly, $urx, $ury, $type, $optlist){} - - /** - * @param string $text - * @param string $optlist - * - * @return int - * - * @link https://secure.php.net/manual/en/function.pdf-create-bookmark.php - */ - function create_bookmark($text, $optlist){} - - /** - * @param float $llx - * @param float $lly - * @param float $urx - * @param float $ury - * @param string $name - * @param string $type - * @param string $optlist - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-create-field.php - */ - function create_field($llx, $lly, $urx, $ury, $name, $type, $optlist){} - - /** - * @param string $name - * @param string $optlist - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-create-fieldgroup.php - */ - function create_fieldgroup($name, $optlist){} - - /** - * @param string $optlist - * - * @return int - * - * @link https://secure.php.net/manual/en/function.pdf-create-gstate.php - */ - function create_gstate($optlist){} - - /** - * @param string $filename - * @param string $data - * @param string $optlist - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-create-pvf.php - */ - function create_pvf($filename, $data, $optlist){} - - /** - * @param string $text - * @param string $optlist - * - * @return int - * - * @link https://secure.php.net/manual/en/function.pdf-create-textflow.php - */ - function create_textflow($text, $optlist){} - - /** - * @param float $x1 - * @param float $y1 - * @param float $x2 - * @param float $y2 - * @param float $x3 - * @param float $y3 - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-curveto.php - */ - function curveto($x1, $y1, $x2, $y2, $x3, $y3){} - - /** - * @param string $name - * @param string $optlist - * - * @return int - * - * @link https://secure.php.net/manual/en/function.pdf-define-layer.php - */ - function define_layer($name, $optlist){} - - /** - * @param string $filename - * - * @return int - * - * @link https://secure.php.net/manual/en/function.pdf-delete-pvf.php - */ - function delete_pvf($filename){} - - /** - * @param int $table - * @param string $optlist - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-delete-table.php - */ - function delete_table($table, $optlist){} - - /** - * @param int $textflow - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-delete-textflow.php - */ - function delete_textflow($textflow){} - - /** - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-delete.php - */ - function delete(){} - - /** - * @param string $encoding - * @param int $slot - * @param string $glyphname - * @param int $uv - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-encoding-set-char.php - */ - function encoding_set_char($encoding, $slot, $glyphname, $uv){} - - /** - * @param string $optlist - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-end-document.php - */ - function end_document($optlist){} - - /** - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-end-font.php - */ - function end_font(){} - - /** - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-end-glyph.php - */ - function end_glyph(){} - - /** - * @param int $id - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-end-item.php - */ - function end_item($id){} - - /** - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-end-layer.php - */ - function end_layer(){} - - /** - * @param string $optlist - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-end-page-ext.php - */ - function end_page_ext($optlist){} - - /** - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-end-page.php - */ - function end_page($p){} - - /** - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-end-pattern.php - */ - function end_pattern($p){} - - /** - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-end-template.php - */ - function end_template($p){} - - /** - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-endpath.php - */ - function endpath($p){} - - /** - * @param int $page - * @param string $blockname - * @param int $image - * @param string $optlist - * - * @return int - * - * @link https://secure.php.net/manual/en/function.pdf-fill-imageblock.php - */ - function fill_imageblock($page, $blockname, $image, $optlist){} - - /** - * @param int $page - * @param string $blockname - * @param int $contents - * @param string $optlist - * - * @return int - * - * @link https://secure.php.net/manual/en/function.pdf-fill-pdfblock.php - */ - function fill_pdfblock($page, $blockname, $contents, $optlist){} - - /** - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-fill-stroke.php - */ - function fill_stroke(){} - - /** - * @param int $page - * @param string $blockname - * @param string $text - * @param string $optlist - * - * @return int - * - * @link https://secure.php.net/manual/en/function.pdf-fill-textblock.php - - */ - function fill_textblock($page, $blockname, $text, $optlist){} - - /** - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-fill.php - - */ - function fill(){} - /** - * @param string $fontname - * @param string $encoding - * @param int $embed - * - * @return int - * - * @link https://secure.php.net/manual/en/function.pdf-findfont.php(Dep) - - */ - function findfont($fontname , $encoding , $embed){} - /** - * @param int $image - * @param float $x - * @param float $y - * @param string $optlist - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-fit-image.php - - */ - function fit_image($image , $x , $y , $optlist){} - /** - * @param int $page - * @param float $x - * @param float $y - * @param string $optlist - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-fit-pdi-page.php - - */ - function fit_pdi_page($page , $x , $y , $optlist){} - /** - * @param int $table - * @param float $llx - * @param float $lly - * @param float $urx - * @param float $ury - * @param string $optlist - * - * @return string - * - * @link https://secure.php.net/manual/en/function.pdf-fit-table.php - - */ - function fit_table($table , $llx , $lly , $urx , $ury , $optlist){} - /** - * @param int $textflow - * @param float $llx - * @param float $lly - * @param float $urx - * @param float $ury - * @param string $optlist - * - * @return string - * - * @link https://secure.php.net/manual/en/function.pdf-fit-textflow.php - - */ - function fit_textflow($textflow , $llx , $lly , $urx , $ury , $optlist){} - /** - * @param string $text - * @param float $x - * @param float $y - * @param string $optlist - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-fit-textline.php - - */ - function fit_textline($text , $x , $y , $optlist){} - /** - * - * @return string - * - * @link https://secure.php.net/manual/en/function.pdf-get-apiname.php - - */ - function get_apiname(){} - /** - * - * @return string - * - * @link https://secure.php.net/manual/en/function.pdf-get-buffer.php - - */ - function get_buffer(){} - /** - * - * @return string - * - * @link https://secure.php.net/manual/en/function.pdf-get-errmsg.php - - */ - function get_errmsg(){} - /** - * - * @return int - * - * @link https://secure.php.net/manual/en/function.pdf-get-errnum.php - - */ - function get_errnum(){} - /** - * @param void $ - * - * @return int - * - * @link https://secure.php.net/manual/en/function.pdf-get-majorversion.php(dep) - - */ - function get_majorversion(){} - /** - * @param void $ - * - * @return int - * - * @link https://secure.php.net/manual/en/function.pdf-get-minorversion.php(dep) - - */ - function get_minorversion(){} - /** - * @param string $key - * @param float $modifier - * - * @return string - * - * @link https://secure.php.net/manual/en/function.pdf-get-parameter.php - - */ - function get_parameter($key , $modifier){} - /** - * @param string $key - * @param int $doc - * @param int $page - * @param int $reserved - * - * @return string - * - * @link https://secure.php.net/manual/en/function.pdf-get-pdi-parameter.php - - */ - function get_pdi_parameter($key , $doc , $page , $reserved){} - /** - * @param string $key - * @param int $doc - * @param int $page - * @param int $reserved - * - * @return float - * - * @link https://secure.php.net/manual/en/function.pdf-get-pdi-value.php - - */ - function get_pdi_value($key , $doc , $page , $reserved){} - /** - * @param string $key - * @param float $modifier - * - * @return float - * - * @link https://secure.php.net/manual/en/function.pdf-get-value.php - - */ - function get_value($key , $modifier){} - /** - * @param int $font - * @param string $keyword - * @param string $optlist - * - * @return float - * - * @link https://secure.php.net/manual/en/function.pdf-info-font.php - - */ - function info_font($font , $keyword , $optlist){} - /** - * @param string $boxname - * @param int $num - * @param string $keyword - * - * @return float - * - * @link https://secure.php.net/manual/en/function.pdf-info-matchbox.php - - */ - function info_matchbox($boxname , $num , $keyword){} - /** - * @param int $table - * @param string $keyword - * - * @return float - * - * @link https://secure.php.net/manual/en/function.pdf-info-table.php - - */ - function info_table($table , $keyword){} - /** - * @param int $textflow - * @param string $keyword - * - * @return float - * - * @link https://secure.php.net/manual/en/function.pdf-info-textflow.php - - */ - function info_textflow($textflow , $keyword){} - - /** - * @param string $text - * @param string $keyword - * @param string $optlist - * - * @return float - * - * @link https://secure.php.net/manual/en/function.pdf-info-textline.php - */ - function info_textline($text , $keyword , $optlist){} - - /** - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-initgraphics.php - */ - function initgraphics(){} - - /** - * @param float $x - * @param float $y - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-lineto.php - */ - function lineto($x , $y){} - - /** - * @param string $filename - * @param string $optlist - * - * @return int - * - * @link https://secure.php.net/manual/en/function.pdf-load-3ddata.php - */ - function load_3ddata($filename , $optlist){} - - /** - * @param string $fontname - * @param string $encoding - * @param string $optlist - * - * @return int - * - * @link https://secure.php.net/manual/en/function.pdf-load-font.php - */ - function load_font($fontname , $encoding , $optlist){} - - /** - * @param string $profilename - * @param string $optlist - * - * @return int - * - * @link https://secure.php.net/manual/en/function.pdf-load-iccprofile.php - */ - function load_iccprofile($profilename , $optlist){} - - /** - * @param string $imagetype - * @param string $filename - * @param string $optlist - * - * @return int - * - * @link https://secure.php.net/manual/en/function.pdf-load-image.php - */ - function load_image($imagetype , $filename , $optlist){} - - /** - * @param string $spotname - * - * @return int - * - * @link https://secure.php.net/manual/en/function.pdf-makespotcolor.php - */ - function makespotcolor($spotname){} - - /** - * @param float $x - * @param float $y - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-moveto.php - */ - function moveto($x , $y){} - - /** - * @param string $filename - * @param int $width - * @param int $height - * @param int $BitReverse - * @param int $k - * @param int $Blackls1 - * - * @return int - * - * @link https://secure.php.net/manual/en/function.pdf-open-ccitt.php(dep) - */ - function open_ccitt($filename , $width , $height , $BitReverse , $k , $Blackls1){} - - /** - * @param string $filename - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-open-file.php(dep) - */ - function open_file($filename){} - - /** - * @param string $imagetype - * @param string $filename - * @param string $stringparam - * @param int $intparam - * - * @return int - * - * @link https://secure.php.net/manual/en/function.pdf-open-image-file.php(dep) - */ - function open_image_file($imagetype , $filename , $stringparam , $intparam){} - - /** - * @param string $imagetype - * @param string $source - * @param string $data - * @param int $length - * @param int $width - * @param int $height - * @param int $components - * @param int $bpc - * @param string $params - * - * @return int - * - * @link https://secure.php.net/manual/en/function.pdf-open-image.php(dep) - */ - function open_image($imagetype , $source , $data , $length , $width , $height , $components , $bpc , $params){} - - /** - * @param resource $image - * - * @return int - * - * @link https://secure.php.net/manual/en/function.pdf-open-memory-image.php(not supported) - */ - function open_memory_image($image){} - - /** - * @param string $filename - * @param string $optlist - * - * @return int - * - * @link https://secure.php.net/manual/en/function.pdf-open-pdi-document.php - */ - function open_pdi_document($filename , $optlist){} - - /** - * @param int $doc - * @param int $pagenumber - * @param string $optlist - * - * @return int - * - * @link https://secure.php.net/manual/en/function.pdf-open-pdi-page.php - */ - function open_pdi_page($doc , $pagenumber , $optlist){} - - /** - * @param string $filename - * @param string $optlist - * @param int $len - * - * @return int - * - * @link https://secure.php.net/manual/en/function.pdf-open-pdi.php - */ - function open_pdi($filename , $optlist , $len){} - - /** - * @param int $doc - * @param string $path - * - * @return float - * - * @link https://secure.php.net/manual/en/function.pdf-pcos-get-number.php - */ - function pcos_get_number($doc , $path){} - - /** - * @param int $doc - * @param string $optlist - * @param string $path - * - * @return string - * - * @link https://secure.php.net/manual/en/function.pdf-pcos-get-stream.php - */ - function pcos_get_stream($doc, $optlist, $path){} - - /** - * @param int $doc - * @param string $path - * - * @return string - * - * @link https://secure.php.net/manual/en/function.pdf-pcos-get-string.php - */ - function pcos_get_string($doc, $path){} - - /** - * @param int $image - * @param float $x - * @param float $y - * @param float $scale - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-place-image.php (dep) - */ - function place_image($image, $x, $y, $scale){} - - /** - * @param int $page - * @param float $x - * @param float $y - * @param float $sx - * @param float $sy - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-place-pdi-page.php (dep) - */ - function place_pdi_page($page, $x, $y, $sx, $sy){} - - /** - * @param int $doc - * @param int $page - * @param string $optlist - * - * @return int - * - * @link https://secure.php.net/manual/en/function.pdf-process-pdi.php - */ - function process_pdi($doc, $page, $optlist){} - - /** - * @param float $x - * @param float $y - * @param float $width - * @param float $height - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-rect.php - */ - function rect($x, $y, $width, $height){} - - /** - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-restore.php - */ - function restore($p){} - - /** - * @param string $optlist - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-resume-page.php - */ - function resume_page($optlist){} - - /** - * @param float $phi - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-rotate.php - */ - function rotate($phi){} - - /** - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-save.php - */ - function save($p){} - - /** - * @param float $sx - * @param float $sy - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-scale.php - */ - function scale($sx, $sy){} - - /** - * @param float $red - * @param float $green - * @param float $blue - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-set-border-color.php (dep) - */ - function set_border_color($red, $green, $blue){} - - /** - * @param float $black - * @param float $white - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-set-border-dash.php (dep) - */ - function set_border_dash($black, $white){} - - /** - * @param string $style - * @param float $width - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-set-border-style.php (dep) - */ - function set_border_style($style, $width){} - - /** - * @param int $gstate - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-set-gstate.php - */ - function set_gstate($gstate){} - - /** - * @param string $key - * @param string $value - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-set-info.php - */ - function set_info($key, $value){} - - /** - * @param string $type - * @param string $optlist - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-set-layer-dependency.php - */ - function set_layer_dependency($type, $optlist){} - - /** - * @param string $key - * @param string $value - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-set-parameter.php - */ - function set_parameter($key, $value){} - - /** - * @param float $x - * @param float $y - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-set-text-pos.php - */ - function set_text_pos($x, $y){} - - /** - * @param string $key - * @param float $value - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-set-value.php - */ - function set_value($key, $value){} - - /** - * @param string $fstype - * @param string $colorspace - * @param float $c1 - * @param float $c2 - * @param float $c3 - * @param float $c4 - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-setcolor.php - */ - function setcolor($fstype, $colorspace, $c1, $c2, $c3, $c4){} - - /** - * @param float $b - * @param float $w - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-setdash.php - */ - function setdash($b, $w){} - - /** - * @param string $optlist - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-setdashpattern.php - */ - function setdashpattern($optlist){} - - /** - * @param float $flatness - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-setflat.php - */ - function setflat($flatness){} - - /** - * @param int $font - * @param float $fontsize - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-setfont.php - */ - function setfont($font, $fontsize){} - - /** - * @param float $g - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-setgray-fill.php (dep) - */ - function setgray_fill($g){} - - /** - * @param float $g - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-setgray-stroke.php (dep) - */ - function setgray_stroke($g){} - - /** - * @param float $g - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-setgray.php (dep) - */ - function setgray($g){} - - /** - * @param int $linecap - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-setlinecap.php - */ - function setlinecap($linecap){} - - /** - * @param int $value - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-setlinejoin.php - */ - function setlinejoin($value){} - - /** - * @param float $width - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-setlinewidth.php - */ - function setlinewidth($width){} - - /** - * @param float $a - * @param float $b - * @param float $c - * @param float $d - * @param float $e - * @param float $f - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-setmatrix.php - */ - function setmatrix($a, $b, $c, $d, $e, $f){} - - /** - * @param float $miter - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-setmiterlimit.php - */ - function setmiterlimit($miter){} - - /** - * @param float $red - * @param float $green - * @param float $blue - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-setrgbcolor-fill.php (dep) - */ - function setrgbcolor_fill($red, $green, $blue){} - - /** - * @param float $red - * @param float $green - * @param float $blue - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-setrgbcolor-stroke.php (dep) - */ - function setrgbcolor_stroke($red, $green, $blue){} - - /** - * @param float $red - * @param float $green - * @param float $blue - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-setrgbcolor.php (dep) - */ - function setrgbcolor($red, $green, $blue){} - - /** - * @param int $shading - * @param string $optlist - * - * @return int - * - * @link https://secure.php.net/manual/en/function.pdf-shading-pattern.php - */ - function shading_pattern($shading, $optlist){} - - /** - * @param string $shtype - * @param float $x0 - * @param float $y0 - * @param float $x1 - * @param float $y1 - * @param float $c1 - * @param float $c2 - * @param float $c3 - * @param float $c4 - * @param string $optlist - * - * @return int - * - * @link https://secure.php.net/manual/en/function.pdf-shading.php - */ - function shading($shtype, $x0, $y0, $x1, $y1, $c1, $c2, $c3, $c4, $optlist){} - - /** - * @param int $shading - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-shfill.php - */ - function shfill($shading){} - - /** - * @param string $text - * @param float $left - * @param float $top - * @param float $width - * @param float $height - * @param string $mode - * @param string $feature - * - * @return int - * - * @link https://secure.php.net/manual/en/function.pdf-show-boxed.php (dep) - */ - function show_boxed($text, $left, $top, $width, $height, $mode, $feature){} - - /** - * @param string $text - * @param float $x - * @param float $y - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-show-xy.php - */ - function show_xy($text, $x, $y){} - - /** - * @param string $text - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-show.php - */ - function show($text){} - - /** - * @param float $alpha - * @param float $beta - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-skew.php - */ - function skew($alpha, $beta){} - - /** - * @param string $text - * @param int $font - * @param float $fontsize - * - * @return float - * - * @link https://secure.php.net/manual/en/function.pdf-stringwidth.php - */ - function stringwidth($text, $font, $fontsize){} - - /** - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-stroke.php - */ - function stroke(){} - - /** - * @param string $optlist - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-suspend-page.php - */ - function suspend_page($optlist){} - - /** - * @param float $tx - * @param float $ty - * - * @return bool - * - * @link https://secure.php.net/manual/en/function.pdf-translate.php - */ - function translate($tx, $ty){} - - /** - * @param string $utf16string - * - * @return string - * - * @link https://secure.php.net/manual/en/function.pdf-utf16-to-utf8.php - */ - function utf16_to_utf8($utf16string){} - - /** - * @param string $utf32string - * @param string $ordering - * - * @return string - * - * @link https://secure.php.net/manual/en/function.pdf-utf32-to-utf16.php - */ - function utf32_to_utf16($utf32string, $ordering){} - - /** - * @param string $utf8string - * @param string $ordering - * - * @return string - * - * @link https://secure.php.net/manual/en/function.pdf-utf8-to-utf16.php - */ - function utf8_to_utf16($utf8string, $ordering){} - + */ + #[Deprecated('This function is deprecated since PDFlib version 6, use PDF_end_document() instead.')] + public function close() {} + + /** + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-closepath-fill-stroke.php + */ + public function closepath_fill_stroke() {} + + /** + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-closepath-stroke.php + */ + public function closepath_stroke() {} + + /** + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-closepath.php + */ + public function closepath() {} + + /** + * @param float $a + * @param float $b + * @param float $c + * @param float $d + * @param float $e + * @param float $f + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-concat.php + */ + public function concat($a, $b, $c, $d, $e, $f) {} + + /** + * @param string $text + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-continue-text.php + */ + public function continue_text($text) {} + + /** + * @param string $username + * @param string $optlist + * + * @return int + * + * @link https://secure.php.net/manual/en/function.pdf-create-3dview.php + */ + public function create_3dview($username, $optlist) {} + + /** + * @param string $type + * @param string $optlist + * + * @return int + * + * @link https://secure.php.net/manual/en/function.pdf-create-action.php + */ + public function create_action($type, $optlist) {} + + /** + * @param float $llx + * @param float $lly + * @param float $urx + * @param float $ury + * @param string $type + * @param string $optlist + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-create-annotation.php + */ + public function create_annotation($llx, $lly, $urx, $ury, $type, $optlist) {} + + /** + * @param string $text + * @param string $optlist + * + * @return int + * + * @link https://secure.php.net/manual/en/function.pdf-create-bookmark.php + */ + public function create_bookmark($text, $optlist) {} + + /** + * @param float $llx + * @param float $lly + * @param float $urx + * @param float $ury + * @param string $name + * @param string $type + * @param string $optlist + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-create-field.php + */ + public function create_field($llx, $lly, $urx, $ury, $name, $type, $optlist) {} + + /** + * @param string $name + * @param string $optlist + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-create-fieldgroup.php + */ + public function create_fieldgroup($name, $optlist) {} + + /** + * @param string $optlist + * + * @return int + * + * @link https://secure.php.net/manual/en/function.pdf-create-gstate.php + */ + public function create_gstate($optlist) {} + + /** + * @param string $filename + * @param string $data + * @param string $optlist + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-create-pvf.php + */ + public function create_pvf($filename, $data, $optlist) {} + + /** + * @param string $text + * @param string $optlist + * + * @return int + * + * @link https://secure.php.net/manual/en/function.pdf-create-textflow.php + */ + public function create_textflow($text, $optlist) {} + + /** + * @param float $x1 + * @param float $y1 + * @param float $x2 + * @param float $y2 + * @param float $x3 + * @param float $y3 + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-curveto.php + */ + public function curveto($x1, $y1, $x2, $y2, $x3, $y3) {} + + /** + * @param string $name + * @param string $optlist + * + * @return int + * + * @link https://secure.php.net/manual/en/function.pdf-define-layer.php + */ + public function define_layer($name, $optlist) {} + + /** + * @param string $filename + * + * @return int + * + * @link https://secure.php.net/manual/en/function.pdf-delete-pvf.php + */ + public function delete_pvf($filename) {} + + /** + * @param int $table + * @param string $optlist + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-delete-table.php + */ + public function delete_table($table, $optlist) {} + + /** + * @param int $textflow + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-delete-textflow.php + */ + public function delete_textflow($textflow) {} + + /** + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-delete.php + */ + public function delete() {} + + /** + * @param string $encoding + * @param int $slot + * @param string $glyphname + * @param int $uv + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-encoding-set-char.php + */ + public function encoding_set_char($encoding, $slot, $glyphname, $uv) {} + + /** + * @param string $optlist + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-end-document.php + */ + public function end_document($optlist) {} + + /** + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-end-font.php + */ + public function end_font() {} + + /** + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-end-glyph.php + */ + public function end_glyph() {} + + /** + * @param int $id + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-end-item.php + */ + public function end_item($id) {} + + /** + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-end-layer.php + */ + public function end_layer() {} + + /** + * @param string $optlist + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-end-page-ext.php + */ + public function end_page_ext($optlist) {} + + /** + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-end-page.php + */ + public function end_page($p) {} + + /** + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-end-pattern.php + */ + public function end_pattern($p) {} + + /** + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-end-template.php + */ + public function end_template($p) {} + + /** + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-endpath.php + */ + public function endpath($p) {} + + /** + * @param int $page + * @param string $blockname + * @param int $image + * @param string $optlist + * + * @return int + * + * @link https://secure.php.net/manual/en/function.pdf-fill-imageblock.php + */ + public function fill_imageblock($page, $blockname, $image, $optlist) {} + + /** + * @param int $page + * @param string $blockname + * @param int $contents + * @param string $optlist + * + * @return int + * + * @link https://secure.php.net/manual/en/function.pdf-fill-pdfblock.php + */ + public function fill_pdfblock($page, $blockname, $contents, $optlist) {} + + /** + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-fill-stroke.php + */ + public function fill_stroke() {} + + /** + * @param int $page + * @param string $blockname + * @param string $text + * @param string $optlist + * + * @return int + * + * @link https://secure.php.net/manual/en/function.pdf-fill-textblock.php + */ + public function fill_textblock($page, $blockname, $text, $optlist) {} + + /** + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-fill.php + */ + public function fill() {} + /** + * @param string $fontname + * @param string $encoding + * @param int $embed + * + * @return int + * + * @link https://secure.php.net/manual/en/function.pdf-findfont.php(Dep) + */ + public function findfont($fontname, $encoding, $embed) {} + /** + * @param int $image + * @param float $x + * @param float $y + * @param string $optlist + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-fit-image.php + */ + public function fit_image($image, $x, $y, $optlist) {} + /** + * @param int $page + * @param float $x + * @param float $y + * @param string $optlist + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-fit-pdi-page.php + */ + public function fit_pdi_page($page, $x, $y, $optlist) {} + /** + * @param int $table + * @param float $llx + * @param float $lly + * @param float $urx + * @param float $ury + * @param string $optlist + * + * @return string + * + * @link https://secure.php.net/manual/en/function.pdf-fit-table.php + */ + public function fit_table($table, $llx, $lly, $urx, $ury, $optlist) {} + /** + * @param int $textflow + * @param float $llx + * @param float $lly + * @param float $urx + * @param float $ury + * @param string $optlist + * + * @return string + * + * @link https://secure.php.net/manual/en/function.pdf-fit-textflow.php + */ + public function fit_textflow($textflow, $llx, $lly, $urx, $ury, $optlist) {} + /** + * @param string $text + * @param float $x + * @param float $y + * @param string $optlist + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-fit-textline.php + */ + public function fit_textline($text, $x, $y, $optlist) {} + /** + * @return string + * + * @link https://secure.php.net/manual/en/function.pdf-get-apiname.php + */ + public function get_apiname() {} + /** + * @return string + * + * @link https://secure.php.net/manual/en/function.pdf-get-buffer.php + */ + public function get_buffer() {} + /** + * @return string + * + * @link https://secure.php.net/manual/en/function.pdf-get-errmsg.php + */ + public function get_errmsg() {} + /** + * @return int + * + * @link https://secure.php.net/manual/en/function.pdf-get-errnum.php + */ + public function get_errnum() {} + /** + * @param void $ + * + * @return int + * + * @link https://secure.php.net/manual/en/function.pdf-get-majorversion.php(dep) + */ + public function get_majorversion() {} + /** + * @param void $ + * + * @return int + * + * @link https://secure.php.net/manual/en/function.pdf-get-minorversion.php(dep) + */ + public function get_minorversion() {} + /** + * @param string $key + * @param float $modifier + * + * @return string + * + * @link https://secure.php.net/manual/en/function.pdf-get-parameter.php + */ + public function get_parameter($key, $modifier) {} + /** + * @param string $key + * @param int $doc + * @param int $page + * @param int $reserved + * + * @return string + * + * @link https://secure.php.net/manual/en/function.pdf-get-pdi-parameter.php + */ + public function get_pdi_parameter($key, $doc, $page, $reserved) {} + /** + * @param string $key + * @param int $doc + * @param int $page + * @param int $reserved + * + * @return float + * + * @link https://secure.php.net/manual/en/function.pdf-get-pdi-value.php + */ + public function get_pdi_value($key, $doc, $page, $reserved) {} + /** + * @param string $key + * @param float $modifier + * + * @return float + * + * @link https://secure.php.net/manual/en/function.pdf-get-value.php + */ + public function get_value($key, $modifier) {} + /** + * @param int $font + * @param string $keyword + * @param string $optlist + * + * @return float + * + * @link https://secure.php.net/manual/en/function.pdf-info-font.php + */ + public function info_font($font, $keyword, $optlist) {} + /** + * @param string $boxname + * @param int $num + * @param string $keyword + * + * @return float + * + * @link https://secure.php.net/manual/en/function.pdf-info-matchbox.php + */ + public function info_matchbox($boxname, $num, $keyword) {} + /** + * @param int $table + * @param string $keyword + * + * @return float + * + * @link https://secure.php.net/manual/en/function.pdf-info-table.php + */ + public function info_table($table, $keyword) {} + /** + * @param int $textflow + * @param string $keyword + * + * @return float + * + * @link https://secure.php.net/manual/en/function.pdf-info-textflow.php + */ + public function info_textflow($textflow, $keyword) {} + + /** + * @param string $text + * @param string $keyword + * @param string $optlist + * + * @return float + * + * @link https://secure.php.net/manual/en/function.pdf-info-textline.php + */ + public function info_textline($text, $keyword, $optlist) {} + + /** + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-initgraphics.php + */ + public function initgraphics() {} + + /** + * @param float $x + * @param float $y + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-lineto.php + */ + public function lineto($x, $y) {} + + /** + * @param string $filename + * @param string $optlist + * + * @return int + * + * @link https://secure.php.net/manual/en/function.pdf-load-3ddata.php + */ + public function load_3ddata($filename, $optlist) {} + + /** + * @param string $fontname + * @param string $encoding + * @param string $optlist + * + * @return int + * + * @link https://secure.php.net/manual/en/function.pdf-load-font.php + */ + public function load_font($fontname, $encoding, $optlist) {} + + /** + * @param string $profilename + * @param string $optlist + * + * @return int + * + * @link https://secure.php.net/manual/en/function.pdf-load-iccprofile.php + */ + public function load_iccprofile($profilename, $optlist) {} + + /** + * @param string $imagetype + * @param string $filename + * @param string $optlist + * + * @return int + * + * @link https://secure.php.net/manual/en/function.pdf-load-image.php + */ + public function load_image($imagetype, $filename, $optlist) {} + + /** + * @param string $spotname + * + * @return int + * + * @link https://secure.php.net/manual/en/function.pdf-makespotcolor.php + */ + public function makespotcolor($spotname) {} + + /** + * @param float $x + * @param float $y + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-moveto.php + */ + public function moveto($x, $y) {} + + /** + * @param string $filename + * @param int $width + * @param int $height + * @param int $BitReverse + * @param int $k + * @param int $Blackls1 + * + * @return int + * + * @link https://secure.php.net/manual/en/function.pdf-open-ccitt.php(dep) + */ + public function open_ccitt($filename, $width, $height, $BitReverse, $k, $Blackls1) {} + + /** + * @param string $filename + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-open-file.php(dep) + */ + public function open_file($filename) {} + + /** + * @param string $imagetype + * @param string $filename + * @param string $stringparam + * @param int $intparam + * + * @return int + * + * @link https://secure.php.net/manual/en/function.pdf-open-image-file.php(dep) + */ + public function open_image_file($imagetype, $filename, $stringparam, $intparam) {} + + /** + * @param string $imagetype + * @param string $source + * @param string $data + * @param int $length + * @param int $width + * @param int $height + * @param int $components + * @param int $bpc + * @param string $params + * + * @return int + * + * @link https://secure.php.net/manual/en/function.pdf-open-image.php(dep) + */ + public function open_image($imagetype, $source, $data, $length, $width, $height, $components, $bpc, $params) {} + + /** + * @param resource $image + * + * @return int + * + * @link https://secure.php.net/manual/en/function.pdf-open-memory-image.php(not supported) + */ + public function open_memory_image($image) {} + + /** + * @param string $filename + * @param string $optlist + * + * @return int + * + * @link https://secure.php.net/manual/en/function.pdf-open-pdi-document.php + */ + public function open_pdi_document($filename, $optlist) {} + + /** + * @param int $doc + * @param int $pagenumber + * @param string $optlist + * + * @return int + * + * @link https://secure.php.net/manual/en/function.pdf-open-pdi-page.php + */ + public function open_pdi_page($doc, $pagenumber, $optlist) {} + + /** + * @param string $filename + * @param string $optlist + * @param int $len + * + * @return int + * + * @link https://secure.php.net/manual/en/function.pdf-open-pdi.php + */ + public function open_pdi($filename, $optlist, $len) {} + + /** + * @param int $doc + * @param string $path + * + * @return float + * + * @link https://secure.php.net/manual/en/function.pdf-pcos-get-number.php + */ + public function pcos_get_number($doc, $path) {} + + /** + * @param int $doc + * @param string $optlist + * @param string $path + * + * @return string + * + * @link https://secure.php.net/manual/en/function.pdf-pcos-get-stream.php + */ + public function pcos_get_stream($doc, $optlist, $path) {} + + /** + * @param int $doc + * @param string $path + * + * @return string + * + * @link https://secure.php.net/manual/en/function.pdf-pcos-get-string.php + */ + public function pcos_get_string($doc, $path) {} + + /** + * @param int $image + * @param float $x + * @param float $y + * @param float $scale + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-place-image.php (dep) + */ + public function place_image($image, $x, $y, $scale) {} + + /** + * @param int $page + * @param float $x + * @param float $y + * @param float $sx + * @param float $sy + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-place-pdi-page.php (dep) + */ + public function place_pdi_page($page, $x, $y, $sx, $sy) {} + + /** + * @param int $doc + * @param int $page + * @param string $optlist + * + * @return int + * + * @link https://secure.php.net/manual/en/function.pdf-process-pdi.php + */ + public function process_pdi($doc, $page, $optlist) {} + + /** + * @param float $x + * @param float $y + * @param float $width + * @param float $height + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-rect.php + */ + public function rect($x, $y, $width, $height) {} + + /** + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-restore.php + */ + public function restore($p) {} + + /** + * @param string $optlist + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-resume-page.php + */ + public function resume_page($optlist) {} + + /** + * @param float $phi + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-rotate.php + */ + public function rotate($phi) {} + + /** + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-save.php + */ + public function save($p) {} + + /** + * @param float $sx + * @param float $sy + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-scale.php + */ + public function scale($sx, $sy) {} + + /** + * @param float $red + * @param float $green + * @param float $blue + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-set-border-color.php (dep) + */ + public function set_border_color($red, $green, $blue) {} + + /** + * @param float $black + * @param float $white + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-set-border-dash.php (dep) + */ + public function set_border_dash($black, $white) {} + + /** + * @param string $style + * @param float $width + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-set-border-style.php (dep) + */ + public function set_border_style($style, $width) {} + + /** + * @param int $gstate + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-set-gstate.php + */ + public function set_gstate($gstate) {} + + /** + * @param string $key + * @param string $value + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-set-info.php + */ + public function set_info($key, $value) {} + + /** + * @param string $type + * @param string $optlist + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-set-layer-dependency.php + */ + public function set_layer_dependency($type, $optlist) {} + + /** + * @param string $key + * @param string $value + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-set-parameter.php + */ + public function set_parameter($key, $value) {} + + /** + * @param float $x + * @param float $y + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-set-text-pos.php + */ + public function set_text_pos($x, $y) {} + + /** + * @param string $key + * @param float $value + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-set-value.php + */ + public function set_value($key, $value) {} + + /** + * @param string $fstype + * @param string $colorspace + * @param float $c1 + * @param float $c2 + * @param float $c3 + * @param float $c4 + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-setcolor.php + */ + public function setcolor($fstype, $colorspace, $c1, $c2, $c3, $c4) {} + + /** + * @param float $b + * @param float $w + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-setdash.php + */ + public function setdash($b, $w) {} + + /** + * @param string $optlist + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-setdashpattern.php + */ + public function setdashpattern($optlist) {} + + /** + * @param float $flatness + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-setflat.php + */ + public function setflat($flatness) {} + + /** + * @param int $font + * @param float $fontsize + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-setfont.php + */ + public function setfont($font, $fontsize) {} + + /** + * @param float $g + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-setgray-fill.php (dep) + */ + public function setgray_fill($g) {} + + /** + * @param float $g + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-setgray-stroke.php (dep) + */ + public function setgray_stroke($g) {} + + /** + * @param float $g + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-setgray.php (dep) + */ + public function setgray($g) {} + + /** + * @param int $linecap + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-setlinecap.php + */ + public function setlinecap($linecap) {} + + /** + * @param int $value + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-setlinejoin.php + */ + public function setlinejoin($value) {} + + /** + * @param float $width + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-setlinewidth.php + */ + public function setlinewidth($width) {} + + /** + * @param float $a + * @param float $b + * @param float $c + * @param float $d + * @param float $e + * @param float $f + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-setmatrix.php + */ + public function setmatrix($a, $b, $c, $d, $e, $f) {} + + /** + * @param float $miter + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-setmiterlimit.php + */ + public function setmiterlimit($miter) {} + + /** + * @param float $red + * @param float $green + * @param float $blue + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-setrgbcolor-fill.php (dep) + */ + public function setrgbcolor_fill($red, $green, $blue) {} + + /** + * @param float $red + * @param float $green + * @param float $blue + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-setrgbcolor-stroke.php (dep) + */ + public function setrgbcolor_stroke($red, $green, $blue) {} + + /** + * @param float $red + * @param float $green + * @param float $blue + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-setrgbcolor.php (dep) + */ + public function setrgbcolor($red, $green, $blue) {} + + /** + * @param int $shading + * @param string $optlist + * + * @return int + * + * @link https://secure.php.net/manual/en/function.pdf-shading-pattern.php + */ + public function shading_pattern($shading, $optlist) {} + + /** + * @param string $shtype + * @param float $x0 + * @param float $y0 + * @param float $x1 + * @param float $y1 + * @param float $c1 + * @param float $c2 + * @param float $c3 + * @param float $c4 + * @param string $optlist + * + * @return int + * + * @link https://secure.php.net/manual/en/function.pdf-shading.php + */ + public function shading($shtype, $x0, $y0, $x1, $y1, $c1, $c2, $c3, $c4, $optlist) {} + + /** + * @param int $shading + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-shfill.php + */ + public function shfill($shading) {} + + /** + * @param string $text + * @param float $left + * @param float $top + * @param float $width + * @param float $height + * @param string $mode + * @param string $feature + * + * @return int + * + * @link https://secure.php.net/manual/en/function.pdf-show-boxed.php (dep) + */ + public function show_boxed($text, $left, $top, $width, $height, $mode, $feature) {} + + /** + * @param string $text + * @param float $x + * @param float $y + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-show-xy.php + */ + public function show_xy($text, $x, $y) {} + + /** + * @param string $text + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-show.php + */ + public function show($text) {} + + /** + * @param float $alpha + * @param float $beta + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-skew.php + */ + public function skew($alpha, $beta) {} + + /** + * @param string $text + * @param int $font + * @param float $fontsize + * + * @return float + * + * @link https://secure.php.net/manual/en/function.pdf-stringwidth.php + */ + public function stringwidth($text, $font, $fontsize) {} + + /** + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-stroke.php + */ + public function stroke() {} + + /** + * @param string $optlist + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-suspend-page.php + */ + public function suspend_page($optlist) {} + + /** + * @param float $tx + * @param float $ty + * + * @return bool + * + * @link https://secure.php.net/manual/en/function.pdf-translate.php + */ + public function translate($tx, $ty) {} + + /** + * @param string $utf16string + * + * @return string + * + * @link https://secure.php.net/manual/en/function.pdf-utf16-to-utf8.php + */ + public function utf16_to_utf8($utf16string) {} + + /** + * @param string $utf32string + * @param string $ordering + * + * @return string + * + * @link https://secure.php.net/manual/en/function.pdf-utf32-to-utf16.php + */ + public function utf32_to_utf16($utf32string, $ordering) {} + + /** + * @param string $utf8string + * @param string $ordering + * + * @return string + * + * @link https://secure.php.net/manual/en/function.pdf-utf8-to-utf16.php + */ + public function utf8_to_utf16($utf8string, $ordering) {} } /** @@ -1692,7 +1645,7 @@ function utf8_to_utf16($utf8string, $ordering){} * * @link https://secure.php.net/manual/en/function.pdf-activate-item.php */ -function PDF_activate_item($pdf, $id){} +function PDF_activate_item($pdf, $id) {} /** * Add launch annotation for current page [deprecated]. @@ -1709,7 +1662,7 @@ function PDF_activate_item($pdf, $id){} * @see PDF_create_action */ #[Deprecated('This function is deprecated since PDFlib version 6, use PDF_create_action() with type=Launch and PDF_create_annotation() with type=Link instead.')] -function PDF_add_launchlink($pdf, $llx, $lly, $urx, $ury, $filename){} +function PDF_add_launchlink($pdf, $llx, $lly, $urx, $ury, $filename) {} /** * Add a link annotation to a target within the current PDF file. @@ -1728,7 +1681,7 @@ function PDF_add_launchlink($pdf, $llx, $lly, $urx, $ury, $filename){} * @see PDF_create_action */ #[Deprecated('This function is deprecated since PDFlib version 6, use PDF_create_action() with type=GoTo and PDF_create_annotation() with type=Link instead.')] -function PDF_add_locallink($pdf, $lowerleftx, $lowerlefty, $upperrightx, $upperrighty, $page, $dest){} +function PDF_add_locallink($pdf, $lowerleftx, $lowerlefty, $upperrightx, $upperrighty, $page, $dest) {} /** * Creates a named destination on an arbitrary page in the current document. @@ -1741,7 +1694,7 @@ function PDF_add_locallink($pdf, $lowerleftx, $lowerlefty, $upperrightx, $upperr * * @link https://secure.php.net/manual/en/function.pdf-add-nameddest.php */ -function PDF_add_nameddest($pdf, $name, $optlist){} +function PDF_add_nameddest($pdf, $name, $optlist) {} /** * Sets an annotation for the current page. @@ -1762,7 +1715,7 @@ function PDF_add_nameddest($pdf, $name, $optlist){} * @see PDF_create_annotation */ #[Deprecated('This function is deprecated since PDFlib version 6, use PDF_create_annotation() with type=Text instead.')] -function PDF_add_note($pdf, $llx, $lly, $urx, $ury, $contents, $title, $icon, $open){} +function PDF_add_note($pdf, $llx, $lly, $urx, $ury, $contents, $title, $icon, $open) {} /** * Add a file link annotation to a PDF target. @@ -1782,7 +1735,7 @@ function PDF_add_note($pdf, $llx, $lly, $urx, $ury, $contents, $title, $icon, $o * @see PDF_create_action */ #[Deprecated('This function is deprecated since PDFlib version 6, use PDF_create_action() with type=GoToR and PDF_create_annotation() with type=Link instead.')] -function PDF_add_pdflink($pdf, $bottom_left_x, $bottom_left_y, $up_right_x, $up_right_y, $filename, $page, $dest){} +function PDF_add_pdflink($pdf, $bottom_left_x, $bottom_left_y, $up_right_x, $up_right_y, $filename, $page, $dest) {} /** * Adds a cell to a new or existing table. @@ -1798,7 +1751,7 @@ function PDF_add_pdflink($pdf, $bottom_left_x, $bottom_left_y, $up_right_x, $up_ * * @link https://secure.php.net/manual/en/function.pdf-add-table-cell.php */ -function PDF_add_table_cell($pdf, $table, $column, $row, $text, $optlist){} +function PDF_add_table_cell($pdf, $table, $column, $row, $text, $optlist) {} /** * Creates a Textflow object, or adds text and explicit options to an existing Textflow. @@ -1812,7 +1765,7 @@ function PDF_add_table_cell($pdf, $table, $column, $row, $text, $optlist){} * * @link https://secure.php.net/manual/en/function.pdf-add-textflow.php */ -function PDF_add_textflow($pdf , $textflow , $text , $optlist){} +function PDF_add_textflow($pdf, $textflow, $text, $optlist) {} /** * Adds an existing image as thumbnail for the current page. @@ -1824,7 +1777,7 @@ function PDF_add_textflow($pdf , $textflow , $text , $optlist){} * * @link https://secure.php.net/manual/en/function.pdf-add-thumbnail.php */ -function PDF_add_thumbnail($pdf, $image){} +function PDF_add_thumbnail($pdf, $image) {} /** * Adds a weblink annotation to a target url on the Web. @@ -1842,7 +1795,7 @@ function PDF_add_thumbnail($pdf, $image){} * @see PDF_create_action */ #[Deprecated('This function is deprecated since PDFlib version 6, use PDF_create_action() with type=URI and PDF_create_annotation() with type=Link instead.')] -function PDF_add_weblink($pdf, $lowerleftx, $lowerlefty, $upperrightx, $upperrighty, $url){} +function PDF_add_weblink($pdf, $lowerleftx, $lowerlefty, $upperrightx, $upperrighty, $url) {} /** * Adds a counterclockwise circular arc @@ -1858,7 +1811,7 @@ function PDF_add_weblink($pdf, $lowerleftx, $lowerlefty, $upperrightx, $upperrig * * @link https://secure.php.net/manual/en/function.pdf-arc.php */ -function PDF_arc($pdf, $x, $y, $r, $alpha, $beta){} +function PDF_arc($pdf, $x, $y, $r, $alpha, $beta) {} /** * Except for the drawing direction, this function behaves exactly like PDF_arc(). @@ -1874,7 +1827,7 @@ function PDF_arc($pdf, $x, $y, $r, $alpha, $beta){} * * @link https://secure.php.net/manual/en/function.pdf-arcn.php */ -function PDF_arcn($pdf, $x, $y, $r, $alpha, $beta){} +function PDF_arcn($pdf, $x, $y, $r, $alpha, $beta) {} /** * Adds a file attachment annotation. @@ -1896,7 +1849,7 @@ function PDF_arcn($pdf, $x, $y, $r, $alpha, $beta){} * @see PDF_create_annotation */ #[Deprecated('This function is deprecated since PDFlib version 6, use PDF_create_annotation() with type=FileAttachment instead.')] -function PDF_attach_file($pdf, $llx, $lly, $urx, $ury, $filename, $description, $author, $mimetype, $icon){} +function PDF_attach_file($pdf, $llx, $lly, $urx, $ury, $filename, $description, $author, $mimetype, $icon) {} /** * Creates a new PDF file subject to various options. @@ -1910,7 +1863,7 @@ function PDF_attach_file($pdf, $llx, $lly, $urx, $ury, $filename, $description, * @link https://secure.php.net/manual/en/function.pdf-begin-document.php * @link https://www.pdflib.com/fileadmin/pdflib/pdf/manuals/PDFlib-9.1.2-API-reference.pdf */ -function PDF_begin_document($pdf, $filename, $optlist){} +function PDF_begin_document($pdf, $filename, $optlist) {} /** * Starts a Type 3 font definition. @@ -1929,7 +1882,7 @@ function PDF_begin_document($pdf, $filename, $optlist){} * * @link https://secure.php.net/manual/en/function.pdf-begin-font.php */ -function PDF_begin_font($pdf, $filename, $a, $b, $c, $d, $e, $f, $optlist){} +function PDF_begin_font($pdf, $filename, $a, $b, $c, $d, $e, $f, $optlist) {} /** * Starts a glyph definition for a Type 3 font. @@ -1946,7 +1899,7 @@ function PDF_begin_font($pdf, $filename, $a, $b, $c, $d, $e, $f, $optlist){} * * @link https://secure.php.net/manual/en/function.pdf-begin-glyph.php */ -function PDF_begin_glyph($pdf, $glyphname, $wx, $llx, $lly, $urx, $ury){} +function PDF_begin_glyph($pdf, $glyphname, $wx, $llx, $lly, $urx, $ury) {} /** * Opens a structure element or other content item with attributes supplied as options. @@ -1959,7 +1912,7 @@ function PDF_begin_glyph($pdf, $glyphname, $wx, $llx, $lly, $urx, $ury){} * * @link https://secure.php.net/manual/en/function.pdf-begin-item.php */ -function PDF_begin_item($pdf, $tag, $optlist){} +function PDF_begin_item($pdf, $tag, $optlist) {} /** * Starts a layer for subsequent output on the page. @@ -1971,7 +1924,7 @@ function PDF_begin_item($pdf, $tag, $optlist){} * * @link https://secure.php.net/manual/en/function.pdf-begin-layer.php */ -function PDF_begin_layer($pdf, $layer){} +function PDF_begin_layer($pdf, $layer) {} /** * Adds a new page to the document, and specifies various options. The parameters width and height are the dimensions of the new page in points. @@ -1985,8 +1938,7 @@ function PDF_begin_layer($pdf, $layer){} * * @link https://secure.php.net/manual/en/function.pdf-begin-page-ext.php */ -function PDF_begin_page_ext($pdf, $width, $height, $optlist){} - +function PDF_begin_page_ext($pdf, $width, $height, $optlist) {} /** * Adds a new page to the document. @@ -2001,7 +1953,7 @@ function PDF_begin_page_ext($pdf, $width, $height, $optlist){} * @see PDF_begin_page_ext */ #[Deprecated('This function is deprecated since PDFlib version 6, use PDF_begin_page_ext() instead.')] -function PDF_begin_page($pdf, $width, $height){} +function PDF_begin_page($pdf, $width, $height) {} /** * Starts a new pattern definition. @@ -2017,7 +1969,7 @@ function PDF_begin_page($pdf, $width, $height){} * * @link https://secure.php.net/manual/en/function.pdf-begin-pattern.php */ -function PDF_begin_pattern($pdf, $width, $height, $xstep, $ystep, $painttype){} +function PDF_begin_pattern($pdf, $width, $height, $xstep, $ystep, $painttype) {} /** * Starts a new template definition. @@ -2031,7 +1983,7 @@ function PDF_begin_pattern($pdf, $width, $height, $xstep, $ystep, $painttype){} * * @link https://secure.php.net/manual/en/function.pdf-begin-template-ext.php */ -function PDF_begin_template_ext($pdf, $width, $height, $optlist){} +function PDF_begin_template_ext($pdf, $width, $height, $optlist) {} /** * Start template definition [deprecated] @@ -2045,7 +1997,7 @@ function PDF_begin_template_ext($pdf, $width, $height, $optlist){} * @see PDF_begin_template_ext */ #[Deprecated('This function is deprecated since PDFlib version 7, use PDF_begin_template_ext() instead.')] -function PDF_begin_template($pdf, $width, $height){} +function PDF_begin_template($pdf, $width, $height) {} /** * Draw a circle @@ -2058,7 +2010,7 @@ function PDF_begin_template($pdf, $width, $height){} * * @link https://secure.php.net/manual/en/function.pdf-circle.php */ -function PDF_circle($pdf, $x, $y, $r){} +function PDF_circle($pdf, $x, $y, $r) {} /** * Clip to current path @@ -2068,7 +2020,7 @@ function PDF_circle($pdf, $x, $y, $r){} * * @link https://secure.php.net/manual/en/function.pdf-clip.php */ -function PDF_clip($pdf){} +function PDF_clip($pdf) {} /** * Close image @@ -2079,7 +2031,7 @@ function PDF_clip($pdf){} * * @link https://secure.php.net/manual/en/function.pdf-close-image.php */ -function PDF_close_image($pdf, $image){} +function PDF_close_image($pdf, $image) {} /** * Closes the page handle, and frees all page-related resources @@ -2091,7 +2043,7 @@ function PDF_close_image($pdf, $image){} * * @link https://secure.php.net/manual/en/function.pdf-close-pdi-page.php */ -function PDF_close_pdi_page($pdf, $page){} +function PDF_close_pdi_page($pdf, $page) {} /** * Close the input pdf document [deprecated] @@ -2104,7 +2056,7 @@ function PDF_close_pdi_page($pdf, $page){} * @see PDF_close_pdi_document */ #[Deprecated('This function is deprecated since PDFlib version 7, use PDF_close_pdi_document() instead.')] -function PDF_close_pdi($pdf, $doc){} +function PDF_close_pdi($pdf, $doc) {} /** * Close pdf resource [deprecated] @@ -2117,7 +2069,7 @@ function PDF_close_pdi($pdf, $doc){} * @see PDF_end_document */ #[Deprecated('This function is deprecated since PDFlib version 6, use PDF_end_document() instead.')] -function PDF_close($pdf){} +function PDF_close($pdf) {} /** * Close, fill and stroke current path @@ -2127,7 +2079,7 @@ function PDF_close($pdf){} * * @link https://secure.php.net/manual/en/function.pdf-closepath-fill-stroke.php */ -function PDF_closepath_fill_stroke($pdf){} +function PDF_closepath_fill_stroke($pdf) {} /** * Close and stroke path @@ -2137,7 +2089,7 @@ function PDF_closepath_fill_stroke($pdf){} * * @link https://secure.php.net/manual/en/function.pdf-closepath-stroke.php */ -function PDF_closepath_stroke($pdf){} +function PDF_closepath_stroke($pdf) {} /** * Close current path @@ -2147,7 +2099,7 @@ function PDF_closepath_stroke($pdf){} * * @link https://secure.php.net/manual/en/function.pdf-closepath.php */ -function PDF_closepath($pdf){} +function PDF_closepath($pdf) {} /** * Concatenate a matrix to the ctm @@ -2163,7 +2115,7 @@ function PDF_closepath($pdf){} * * @link https://secure.php.net/manual/en/function.pdf-concat.php */ -function PDF_concat($pdf, $a, $b, $c, $d, $e, $f){} +function PDF_concat($pdf, $a, $b, $c, $d, $e, $f) {} /** * Output text in next line @@ -2174,7 +2126,7 @@ function PDF_concat($pdf, $a, $b, $c, $d, $e, $f){} * * @link https://secure.php.net/manual/en/function.pdf-continue-text.php */ -function PDF_continue_text($pdf, $text){} +function PDF_continue_text($pdf, $text) {} /** * Create 3d view @@ -2186,7 +2138,7 @@ function PDF_continue_text($pdf, $text){} * * @link https://secure.php.net/manual/en/function.pdf-create-3dview.php */ -function PDF_create_3dview($pdf, $username, $optlist){} +function PDF_create_3dview($pdf, $username, $optlist) {} /** * Create action for objects or events @@ -2198,7 +2150,7 @@ function PDF_create_3dview($pdf, $username, $optlist){} * * @link https://secure.php.net/manual/en/function.pdf-create-action.php */ -function PDF_create_action($pdf, $type, $optlist){} +function PDF_create_action($pdf, $type, $optlist) {} /** * Create rectangular annotation @@ -2214,7 +2166,7 @@ function PDF_create_action($pdf, $type, $optlist){} * * @link https://secure.php.net/manual/en/function.pdf-create-annotation.php */ -function PDF_create_annotation($pdf, $llx, $lly, $urx, $ury, $type, $optlist){} +function PDF_create_annotation($pdf, $llx, $lly, $urx, $ury, $type, $optlist) {} /** * Create bookmar @@ -2226,7 +2178,7 @@ function PDF_create_annotation($pdf, $llx, $lly, $urx, $ury, $type, $optlist){} * * @link https://secure.php.net/manual/en/function.pdf-create-bookmark.php */ -function PDF_create_bookmark($pdf, $text, $optlist){} +function PDF_create_bookmark($pdf, $text, $optlist) {} /** * Create form field @@ -2243,7 +2195,7 @@ function PDF_create_bookmark($pdf, $text, $optlist){} * * @link https://secure.php.net/manual/en/function.pdf-create-field.php */ -function PDF_create_field($pdf, $llx, $lly, $urx, $ury, $name, $type, $optlist){} +function PDF_create_field($pdf, $llx, $lly, $urx, $ury, $name, $type, $optlist) {} /** * Create form field group @@ -2255,7 +2207,7 @@ function PDF_create_field($pdf, $llx, $lly, $urx, $ury, $name, $type, $optlist){ * * @link https://secure.php.net/manual/en/function.pdf-create-fieldgroup.php */ -function PDF_create_fieldgroup($pdf, $name, $optlist){} +function PDF_create_fieldgroup($pdf, $name, $optlist) {} /** * Create graphics state object @@ -2266,7 +2218,7 @@ function PDF_create_fieldgroup($pdf, $name, $optlist){} * * @link https://secure.php.net/manual/en/function.pdf-create-gstate.php */ -function PDF_create_gstate($pdf, $optlist){} +function PDF_create_gstate($pdf, $optlist) {} /** * Create pdflib virtual file @@ -2279,7 +2231,7 @@ function PDF_create_gstate($pdf, $optlist){} * * @link https://secure.php.net/manual/en/function.pdf-create-pvf.php */ -function PDF_create_pvf($pdf, $filename, $data, $optlist){} +function PDF_create_pvf($pdf, $filename, $data, $optlist) {} /** * Create textflow object @@ -2291,7 +2243,7 @@ function PDF_create_pvf($pdf, $filename, $data, $optlist){} * * @link https://secure.php.net/manual/en/function.pdf-create-textflow.php */ -function PDF_create_textflow($pdf, $text, $optlist){} +function PDF_create_textflow($pdf, $text, $optlist) {} /** * Draw bezier curve @@ -2307,7 +2259,7 @@ function PDF_create_textflow($pdf, $text, $optlist){} * * @link https://secure.php.net/manual/en/function.pdf-curveto.php */ -function PDF_curveto($pdf, $x1, $y1, $x2, $y2, $x3, $y3){} +function PDF_curveto($pdf, $x1, $y1, $x2, $y2, $x3, $y3) {} /** * Create layer definition @@ -2319,7 +2271,7 @@ function PDF_curveto($pdf, $x1, $y1, $x2, $y2, $x3, $y3){} * * @link https://secure.php.net/manual/en/function.pdf-define-layer.php */ -function PDF_define_layer($pdf, $name, $optlist){} +function PDF_define_layer($pdf, $name, $optlist) {} /** * Delete pdflib virtual file @@ -2330,7 +2282,7 @@ function PDF_define_layer($pdf, $name, $optlist){} * * @link https://secure.php.net/manual/en/function.pdf-delete-pvf.php */ -function PDF_delete_pvf($pdf, $filename){} +function PDF_delete_pvf($pdf, $filename) {} /** * @param resource $pdf @@ -2341,7 +2293,7 @@ function PDF_delete_pvf($pdf, $filename){} * * @link https://secure.php.net/manual/en/function.pdf-delete-table.php */ -function PDF_delete_table($pdf, $table, $optlist){} +function PDF_delete_table($pdf, $table, $optlist) {} /** * @param resource $pdf @@ -2351,7 +2303,7 @@ function PDF_delete_table($pdf, $table, $optlist){} * * @link https://secure.php.net/manual/en/function.pdf-delete-textflow.php */ -function PDF_delete_textflow($pdf, $textflow){} +function PDF_delete_textflow($pdf, $textflow) {} /** * @param resource $pdf @@ -2360,7 +2312,7 @@ function PDF_delete_textflow($pdf, $textflow){} * * @link https://secure.php.net/manual/en/function.pdf-delete.php */ -function PDF_delete($pdf){} +function PDF_delete($pdf) {} /** * @param resource $pdf @@ -2373,7 +2325,7 @@ function PDF_delete($pdf){} * * @link https://secure.php.net/manual/en/function.pdf-encoding-set-char.php */ -function PDF_encoding_set_char($pdf, $encoding, $slot, $glyphname, $uv){} +function PDF_encoding_set_char($pdf, $encoding, $slot, $glyphname, $uv) {} /** * @param resource $pdf @@ -2383,7 +2335,7 @@ function PDF_encoding_set_char($pdf, $encoding, $slot, $glyphname, $uv){} * * @link https://secure.php.net/manual/en/function.pdf-end-document.php */ -function PDF_end_document($pdf, $optlist){} +function PDF_end_document($pdf, $optlist) {} /** * @param resource $pdf @@ -2392,7 +2344,7 @@ function PDF_end_document($pdf, $optlist){} * * @link https://secure.php.net/manual/en/function.pdf-end-font.php */ -function PDF_end_font($pdf){} +function PDF_end_font($pdf) {} /** * @param resource $pdf @@ -2401,7 +2353,7 @@ function PDF_end_font($pdf){} * * @link https://secure.php.net/manual/en/function.pdf-end-glyph.php */ -function PDF_end_glyph($pdf){} +function PDF_end_glyph($pdf) {} /** * @param resource $pdf @@ -2411,7 +2363,7 @@ function PDF_end_glyph($pdf){} * * @link https://secure.php.net/manual/en/function.pdf-end-item.php */ -function PDF_end_item($pdf, $id){} +function PDF_end_item($pdf, $id) {} /** * @param resource $pdf @@ -2420,7 +2372,7 @@ function PDF_end_item($pdf, $id){} * * @link https://secure.php.net/manual/en/function.pdf-end-layer.php */ -function PDF_end_layer($pdf){} +function PDF_end_layer($pdf) {} /** * @param resource $pdf @@ -2430,7 +2382,7 @@ function PDF_end_layer($pdf){} * * @link https://secure.php.net/manual/en/function.pdf-end-page-ext.php */ -function PDF_end_page_ext($pdf, $optlist){} +function PDF_end_page_ext($pdf, $optlist) {} /** * @param resource $pdf @@ -2439,7 +2391,7 @@ function PDF_end_page_ext($pdf, $optlist){} * * @link https://secure.php.net/manual/en/function.pdf-end-page.php */ -function PDF_end_page($p){} +function PDF_end_page($p) {} /** * @param resource $pdf @@ -2448,7 +2400,7 @@ function PDF_end_page($p){} * * @link https://secure.php.net/manual/en/function.pdf-end-pattern.php */ -function PDF_end_pattern($p){} +function PDF_end_pattern($p) {} /** * @param resource $pdf @@ -2457,7 +2409,7 @@ function PDF_end_pattern($p){} * * @link https://secure.php.net/manual/en/function.pdf-end-template.php */ -function PDF_end_template($p){} +function PDF_end_template($p) {} /** * @param resource $pdf @@ -2466,7 +2418,7 @@ function PDF_end_template($p){} * * @link https://secure.php.net/manual/en/function.pdf-endpath.php */ -function PDF_endpath($p){} +function PDF_endpath($p) {} /** * @param resource $pdf @@ -2479,7 +2431,7 @@ function PDF_endpath($p){} * * @link https://secure.php.net/manual/en/function.pdf-fill-imageblock.php */ -function PDF_fill_imageblock($pdf, $page, $blockname, $image, $optlist){} +function PDF_fill_imageblock($pdf, $page, $blockname, $image, $optlist) {} /** * @param resource $pdf @@ -2492,7 +2444,7 @@ function PDF_fill_imageblock($pdf, $page, $blockname, $image, $optlist){} * * @link https://secure.php.net/manual/en/function.pdf-fill-pdfblock.php */ -function PDF_fill_pdfblock($pdf, $page, $blockname, $contents, $optlist){} +function PDF_fill_pdfblock($pdf, $page, $blockname, $contents, $optlist) {} /** * @param resource $pdf @@ -2501,7 +2453,7 @@ function PDF_fill_pdfblock($pdf, $page, $blockname, $contents, $optlist){} * * @link https://secure.php.net/manual/en/function.pdf-fill-stroke.php */ -function PDF_fill_stroke($pdf){} +function PDF_fill_stroke($pdf) {} /** * @param resource $pdf @@ -2513,9 +2465,8 @@ function PDF_fill_stroke($pdf){} * @return int * * @link https://secure.php.net/manual/en/function.pdf-fill-textblock.php - */ -function PDF_fill_textblock($pdf, $page, $blockname, $text, $optlist){} +function PDF_fill_textblock($pdf, $page, $blockname, $text, $optlist) {} /** * @param resource $pdf @@ -2523,9 +2474,8 @@ function PDF_fill_textblock($pdf, $page, $blockname, $text, $optlist){} * @return bool * * @link https://secure.php.net/manual/en/function.pdf-fill.php - */ -function PDF_fill($pdf){} +function PDF_fill($pdf) {} /** * @param resource $pdf * @param string $fontname @@ -2535,9 +2485,8 @@ function PDF_fill($pdf){} * @return int * * @link https://secure.php.net/manual/en/function.pdf-findfont.php(Dep) - */ -function PDF_findfont($pdf, $fontname , $encoding , $embed){} +function PDF_findfont($pdf, $fontname, $encoding, $embed) {} /** * @param resource $pdf * @param int $image @@ -2548,9 +2497,8 @@ function PDF_findfont($pdf, $fontname , $encoding , $embed){} * @return bool * * @link https://secure.php.net/manual/en/function.pdf-fit-image.php - */ -function PDF_fit_image($pdf, $image , $x , $y , $optlist){} +function PDF_fit_image($pdf, $image, $x, $y, $optlist) {} /** * @param resource $pdf * @param int $page @@ -2561,9 +2509,8 @@ function PDF_fit_image($pdf, $image , $x , $y , $optlist){} * @return bool * * @link https://secure.php.net/manual/en/function.pdf-fit-pdi-page.php - */ -function PDF_fit_pdi_page($pdf, $page , $x , $y , $optlist){} +function PDF_fit_pdi_page($pdf, $page, $x, $y, $optlist) {} /** * @param resource $pdf * @param int $table @@ -2576,9 +2523,8 @@ function PDF_fit_pdi_page($pdf, $page , $x , $y , $optlist){} * @return string * * @link https://secure.php.net/manual/en/function.pdf-fit-table.php - */ -function PDF_fit_table($pdf, $table , $llx , $lly , $urx , $ury , $optlist){} +function PDF_fit_table($pdf, $table, $llx, $lly, $urx, $ury, $optlist) {} /** * @param resource $pdf * @param int $textflow @@ -2591,9 +2537,8 @@ function PDF_fit_table($pdf, $table , $llx , $lly , $urx , $ury , $optlist){} * @return string * * @link https://secure.php.net/manual/en/function.pdf-fit-textflow.php - */ -function PDF_fit_textflow($pdf, $textflow , $llx , $lly , $urx , $ury , $optlist){} +function PDF_fit_textflow($pdf, $textflow, $llx, $lly, $urx, $ury, $optlist) {} /** * @param resource $pdf * @param string $text @@ -2604,63 +2549,56 @@ function PDF_fit_textflow($pdf, $textflow , $llx , $lly , $urx , $ury , $optlist * @return bool * * @link https://secure.php.net/manual/en/function.pdf-fit-textline.php - */ -function PDF_fit_textline($pdf, $text , $x , $y , $optlist){} +function PDF_fit_textline($pdf, $text, $x, $y, $optlist) {} /** * @param resource $pdf * * @return string * * @link https://secure.php.net/manual/en/function.pdf-get-apiname.php - */ -function PDF_get_apiname($pdf){} +function PDF_get_apiname($pdf) {} /** * @param resource $pdf * * @return string * * @link https://secure.php.net/manual/en/function.pdf-get-buffer.php - */ -function PDF_get_buffer($pdf){} +function PDF_get_buffer($pdf) {} /** * @param resource $pdf * * @return string * * @link https://secure.php.net/manual/en/function.pdf-get-errmsg.php - */ -function PDF_get_errmsg($pdf){} +function PDF_get_errmsg($pdf) {} /** * @param resource $pdf * * @return int * * @link https://secure.php.net/manual/en/function.pdf-get-errnum.php - */ -function PDF_get_errnum($pdf){} +function PDF_get_errnum($pdf) {} /** * @param void $ * * @return int * * @link https://secure.php.net/manual/en/function.pdf-get-majorversion.php(dep) - */ -function PDF_get_majorversion(){} +function PDF_get_majorversion() {} /** * @param void $ * * @return int * * @link https://secure.php.net/manual/en/function.pdf-get-minorversion.php(dep) - */ -function PDF_get_minorversion(){} +function PDF_get_minorversion() {} /** * @param resource $pdf * @param string $key @@ -2669,9 +2607,8 @@ function PDF_get_minorversion(){} * @return string * * @link https://secure.php.net/manual/en/function.pdf-get-parameter.php - */ -function PDF_get_parameter($pdf, $key , $modifier){} +function PDF_get_parameter($pdf, $key, $modifier) {} /** * @param resource $pdf * @param string $key @@ -2682,9 +2619,8 @@ function PDF_get_parameter($pdf, $key , $modifier){} * @return string * * @link https://secure.php.net/manual/en/function.pdf-get-pdi-parameter.php - */ -function PDF_get_pdi_parameter($pdf, $key , $doc , $page , $reserved){} +function PDF_get_pdi_parameter($pdf, $key, $doc, $page, $reserved) {} /** * @param resource $pdf * @param string $key @@ -2695,9 +2631,8 @@ function PDF_get_pdi_parameter($pdf, $key , $doc , $page , $reserved){} * @return float * * @link https://secure.php.net/manual/en/function.pdf-get-pdi-value.php - */ -function PDF_get_pdi_value($pdf, $key , $doc , $page , $reserved){} +function PDF_get_pdi_value($pdf, $key, $doc, $page, $reserved) {} /** * @param resource $pdf * @param string $key @@ -2706,9 +2641,8 @@ function PDF_get_pdi_value($pdf, $key , $doc , $page , $reserved){} * @return float * * @link https://secure.php.net/manual/en/function.pdf-get-value.php - */ -function PDF_get_value($pdf, $key , $modifier){} +function PDF_get_value($pdf, $key, $modifier) {} /** * @param resource $pdf * @param int $font @@ -2718,9 +2652,8 @@ function PDF_get_value($pdf, $key , $modifier){} * @return float * * @link https://secure.php.net/manual/en/function.pdf-info-font.php - */ -function PDF_info_font($pdf, $font , $keyword , $optlist){} +function PDF_info_font($pdf, $font, $keyword, $optlist) {} /** * @param resource $pdf * @param string $boxname @@ -2730,9 +2663,8 @@ function PDF_info_font($pdf, $font , $keyword , $optlist){} * @return float * * @link https://secure.php.net/manual/en/function.pdf-info-matchbox.php - */ -function PDF_info_matchbox($pdf, $boxname , $num , $keyword){} +function PDF_info_matchbox($pdf, $boxname, $num, $keyword) {} /** * @param resource $pdf * @param int $table @@ -2741,9 +2673,8 @@ function PDF_info_matchbox($pdf, $boxname , $num , $keyword){} * @return float * * @link https://secure.php.net/manual/en/function.pdf-info-table.php - */ -function PDF_info_table($pdf, $table , $keyword){} +function PDF_info_table($pdf, $table, $keyword) {} /** * @param resource $pdf * @param int $textflow @@ -2752,9 +2683,8 @@ function PDF_info_table($pdf, $table , $keyword){} * @return float * * @link https://secure.php.net/manual/en/function.pdf-info-textflow.php - */ -function PDF_info_textflow($pdf, $textflow , $keyword){} +function PDF_info_textflow($pdf, $textflow, $keyword) {} /** * @param resource $pdf @@ -2766,7 +2696,7 @@ function PDF_info_textflow($pdf, $textflow , $keyword){} * * @link https://secure.php.net/manual/en/function.pdf-info-textline.php */ -function PDF_info_textline($pdf, $text , $keyword , $optlist){} +function PDF_info_textline($pdf, $text, $keyword, $optlist) {} /** * @param resource $pdf @@ -2775,7 +2705,7 @@ function PDF_info_textline($pdf, $text , $keyword , $optlist){} * * @link https://secure.php.net/manual/en/function.pdf-initgraphics.php */ -function PDF_initgraphics($pdf){} +function PDF_initgraphics($pdf) {} /** * @param resource $pdf @@ -2786,7 +2716,7 @@ function PDF_initgraphics($pdf){} * * @link https://secure.php.net/manual/en/function.pdf-lineto.php */ -function PDF_lineto($pdf, $x , $y){} +function PDF_lineto($pdf, $x, $y) {} /** * @param resource $pdf @@ -2797,7 +2727,7 @@ function PDF_lineto($pdf, $x , $y){} * * @link https://secure.php.net/manual/en/function.pdf-load-3ddata.php */ -function PDF_load_3ddata($pdf, $filename , $optlist){} +function PDF_load_3ddata($pdf, $filename, $optlist) {} /** * @param resource $pdf @@ -2809,7 +2739,7 @@ function PDF_load_3ddata($pdf, $filename , $optlist){} * * @link https://secure.php.net/manual/en/function.pdf-load-font.php */ -function PDF_load_font($pdf, $fontname , $encoding , $optlist){} +function PDF_load_font($pdf, $fontname, $encoding, $optlist) {} /** * @param resource $pdf @@ -2820,7 +2750,7 @@ function PDF_load_font($pdf, $fontname , $encoding , $optlist){} * * @link https://secure.php.net/manual/en/function.pdf-load-iccprofile.php */ -function PDF_load_iccprofile($pdf, $profilename , $optlist){} +function PDF_load_iccprofile($pdf, $profilename, $optlist) {} /** * @param resource $pdf @@ -2832,7 +2762,7 @@ function PDF_load_iccprofile($pdf, $profilename , $optlist){} * * @link https://secure.php.net/manual/en/function.pdf-load-image.php */ -function PDF_load_image($pdf, $imagetype , $filename , $optlist){} +function PDF_load_image($pdf, $imagetype, $filename, $optlist) {} /** * @param resource $pdf @@ -2842,7 +2772,7 @@ function PDF_load_image($pdf, $imagetype , $filename , $optlist){} * * @link https://secure.php.net/manual/en/function.pdf-makespotcolor.php */ -function PDF_makespotcolor($pdf, $spotname){} +function PDF_makespotcolor($pdf, $spotname) {} /** * @param resource $pdf @@ -2853,14 +2783,14 @@ function PDF_makespotcolor($pdf, $spotname){} * * @link https://secure.php.net/manual/en/function.pdf-moveto.php */ -function PDF_moveto($pdf, $x , $y){} +function PDF_moveto($pdf, $x, $y) {} /** * @return resource * * @link https://secure.php.net/manual/en/function.pdf-new.php */ -function PDF_new(){} +function PDF_new() {} /** * @param resource $pdf @@ -2875,7 +2805,7 @@ function PDF_new(){} * * @link https://secure.php.net/manual/en/function.pdf-open-ccitt.php(dep) */ -function PDF_open_ccitt($pdf, $filename , $width , $height , $BitReverse , $k , $Blackls1){} +function PDF_open_ccitt($pdf, $filename, $width, $height, $BitReverse, $k, $Blackls1) {} /** * @param resource $pdf @@ -2885,7 +2815,7 @@ function PDF_open_ccitt($pdf, $filename , $width , $height , $BitReverse , $k , * * @link https://secure.php.net/manual/en/function.pdf-open-file.php(dep) */ -function PDF_open_file($pdf, $filename){} +function PDF_open_file($pdf, $filename) {} /** * @param resource $pdf @@ -2898,7 +2828,7 @@ function PDF_open_file($pdf, $filename){} * * @link https://secure.php.net/manual/en/function.pdf-open-image-file.php(dep) */ -function PDF_open_image_file($pdf, $imagetype , $filename , $stringparam , $intparam){} +function PDF_open_image_file($pdf, $imagetype, $filename, $stringparam, $intparam) {} /** * @param resource $pdf @@ -2916,7 +2846,7 @@ function PDF_open_image_file($pdf, $imagetype , $filename , $stringparam , $intp * * @link https://secure.php.net/manual/en/function.pdf-open-image.php(dep) */ -function PDF_open_image($pdf, $imagetype , $source , $data , $length , $width , $height , $components , $bpc , $params){} +function PDF_open_image($pdf, $imagetype, $source, $data, $length, $width, $height, $components, $bpc, $params) {} /** * @param resource $pdf @@ -2926,7 +2856,7 @@ function PDF_open_image($pdf, $imagetype , $source , $data , $length , $width , * * @link https://secure.php.net/manual/en/function.pdf-open-memory-image.php(not supported) */ -function PDF_open_memory_image($pdf, $image){} +function PDF_open_memory_image($pdf, $image) {} /** * @param resource $pdf @@ -2937,7 +2867,7 @@ function PDF_open_memory_image($pdf, $image){} * * @link https://secure.php.net/manual/en/function.pdf-open-pdi-document.php */ -function PDF_open_pdi_document($pdf, $filename , $optlist){} +function PDF_open_pdi_document($pdf, $filename, $optlist) {} /** * @param resource $pdf @@ -2949,7 +2879,7 @@ function PDF_open_pdi_document($pdf, $filename , $optlist){} * * @link https://secure.php.net/manual/en/function.pdf-open-pdi-page.php */ -function PDF_open_pdi_page($pdf, $doc , $pagenumber , $optlist){} +function PDF_open_pdi_page($pdf, $doc, $pagenumber, $optlist) {} /** * @param resource $pdf @@ -2961,7 +2891,7 @@ function PDF_open_pdi_page($pdf, $doc , $pagenumber , $optlist){} * * @link https://secure.php.net/manual/en/function.pdf-open-pdi.php */ -function PDF_open_pdi($pdf, $filename , $optlist , $len){} +function PDF_open_pdi($pdf, $filename, $optlist, $len) {} /** * @param resource $pdf @@ -2972,7 +2902,7 @@ function PDF_open_pdi($pdf, $filename , $optlist , $len){} * * @link https://secure.php.net/manual/en/function.pdf-pcos-get-number.php */ -function PDF_pcos_get_number($pdf, $doc , $path){} +function PDF_pcos_get_number($pdf, $doc, $path) {} /** * @param resource $pdf @@ -2984,7 +2914,7 @@ function PDF_pcos_get_number($pdf, $doc , $path){} * * @link https://secure.php.net/manual/en/function.pdf-pcos-get-stream.php */ -function PDF_pcos_get_stream($pdf, $doc, $optlist, $path){} +function PDF_pcos_get_stream($pdf, $doc, $optlist, $path) {} /** * @param resource $pdf @@ -2995,7 +2925,7 @@ function PDF_pcos_get_stream($pdf, $doc, $optlist, $path){} * * @link https://secure.php.net/manual/en/function.pdf-pcos-get-string.php */ -function PDF_pcos_get_string($pdf, $doc, $path){} +function PDF_pcos_get_string($pdf, $doc, $path) {} /** * @param resource $pdf @@ -3008,7 +2938,7 @@ function PDF_pcos_get_string($pdf, $doc, $path){} * * @link https://secure.php.net/manual/en/function.pdf-place-image.php (dep) */ -function PDF_place_image($pdf, $image, $x, $y, $scale){} +function PDF_place_image($pdf, $image, $x, $y, $scale) {} /** * @param resource $pdf @@ -3022,7 +2952,7 @@ function PDF_place_image($pdf, $image, $x, $y, $scale){} * * @link https://secure.php.net/manual/en/function.pdf-place-pdi-page.php (dep) */ -function PDF_place_pdi_page($pdf, $page, $x, $y, $sx, $sy){} +function PDF_place_pdi_page($pdf, $page, $x, $y, $sx, $sy) {} /** * @param resource $pdf @@ -3034,7 +2964,7 @@ function PDF_place_pdi_page($pdf, $page, $x, $y, $sx, $sy){} * * @link https://secure.php.net/manual/en/function.pdf-process-pdi.php */ -function PDF_process_pdi($pdf, $doc, $page, $optlist){} +function PDF_process_pdi($pdf, $doc, $page, $optlist) {} /** * @param resource $pdf @@ -3047,7 +2977,7 @@ function PDF_process_pdi($pdf, $doc, $page, $optlist){} * * @link https://secure.php.net/manual/en/function.pdf-rect.php */ -function PDF_rect($pdf, $x, $y, $width, $height){} +function PDF_rect($pdf, $x, $y, $width, $height) {} /** * @param resource $pdf @@ -3056,7 +2986,7 @@ function PDF_rect($pdf, $x, $y, $width, $height){} * * @link https://secure.php.net/manual/en/function.pdf-restore.php */ -function PDF_restore($p){} +function PDF_restore($p) {} /** * @param resource $pdf @@ -3066,7 +2996,7 @@ function PDF_restore($p){} * * @link https://secure.php.net/manual/en/function.pdf-resume-page.php */ -function PDF_resume_page($pdf, $optlist){} +function PDF_resume_page($pdf, $optlist) {} /** * @param resource $pdf @@ -3076,7 +3006,7 @@ function PDF_resume_page($pdf, $optlist){} * * @link https://secure.php.net/manual/en/function.pdf-rotate.php */ -function PDF_rotate($pdf, $phi){} +function PDF_rotate($pdf, $phi) {} /** * @param resource $pdf @@ -3085,7 +3015,7 @@ function PDF_rotate($pdf, $phi){} * * @link https://secure.php.net/manual/en/function.pdf-save.php */ -function PDF_save($p){} +function PDF_save($p) {} /** * @param resource $pdf @@ -3096,7 +3026,7 @@ function PDF_save($p){} * * @link https://secure.php.net/manual/en/function.pdf-scale.php */ -function PDF_scale($pdf, $sx, $sy){} +function PDF_scale($pdf, $sx, $sy) {} /** * @param resource $pdf @@ -3108,7 +3038,7 @@ function PDF_scale($pdf, $sx, $sy){} * * @link https://secure.php.net/manual/en/function.pdf-set-border-color.php (dep) */ -function PDF_set_border_color($pdf, $red, $green, $blue){} +function PDF_set_border_color($pdf, $red, $green, $blue) {} /** * @param resource $pdf @@ -3119,7 +3049,7 @@ function PDF_set_border_color($pdf, $red, $green, $blue){} * * @link https://secure.php.net/manual/en/function.pdf-set-border-dash.php (dep) */ -function PDF_set_border_dash($pdf, $black, $white){} +function PDF_set_border_dash($pdf, $black, $white) {} /** * @param resource $pdf @@ -3130,7 +3060,7 @@ function PDF_set_border_dash($pdf, $black, $white){} * * @link https://secure.php.net/manual/en/function.pdf-set-border-style.php (dep) */ -function PDF_set_border_style($pdf, $style, $width){} +function PDF_set_border_style($pdf, $style, $width) {} /** * @param resource $pdf @@ -3140,7 +3070,7 @@ function PDF_set_border_style($pdf, $style, $width){} * * @link https://secure.php.net/manual/en/function.pdf-set-gstate.php */ -function PDF_set_gstate($pdf, $gstate){} +function PDF_set_gstate($pdf, $gstate) {} /** * @param resource $pdf @@ -3151,7 +3081,7 @@ function PDF_set_gstate($pdf, $gstate){} * * @link https://secure.php.net/manual/en/function.pdf-set-info.php */ -function PDF_set_info($pdf, $key, $value){} +function PDF_set_info($pdf, $key, $value) {} /** * @param resource $pdf @@ -3162,7 +3092,7 @@ function PDF_set_info($pdf, $key, $value){} * * @link https://secure.php.net/manual/en/function.pdf-set-layer-dependency.php */ -function PDF_set_layer_dependency($pdf, $type, $optlist){} +function PDF_set_layer_dependency($pdf, $type, $optlist) {} /** * @param resource $pdf @@ -3173,7 +3103,7 @@ function PDF_set_layer_dependency($pdf, $type, $optlist){} * * @link https://secure.php.net/manual/en/function.pdf-set-parameter.php */ -function PDF_set_parameter($pdf, $key, $value){} +function PDF_set_parameter($pdf, $key, $value) {} /** * @param resource $pdf @@ -3184,7 +3114,7 @@ function PDF_set_parameter($pdf, $key, $value){} * * @link https://secure.php.net/manual/en/function.pdf-set-text-pos.php */ -function PDF_set_text_pos($pdf, $x, $y){} +function PDF_set_text_pos($pdf, $x, $y) {} /** * @param resource $pdf @@ -3195,7 +3125,7 @@ function PDF_set_text_pos($pdf, $x, $y){} * * @link https://secure.php.net/manual/en/function.pdf-set-value.php */ -function PDF_set_value($pdf, $key, $value){} +function PDF_set_value($pdf, $key, $value) {} /** * @param resource $pdf @@ -3210,7 +3140,7 @@ function PDF_set_value($pdf, $key, $value){} * * @link https://secure.php.net/manual/en/function.pdf-setcolor.php */ -function PDF_setcolor($pdf, $fstype, $colorspace, $c1, $c2, $c3, $c4){} +function PDF_setcolor($pdf, $fstype, $colorspace, $c1, $c2, $c3, $c4) {} /** * @param resource $pdf @@ -3221,7 +3151,7 @@ function PDF_setcolor($pdf, $fstype, $colorspace, $c1, $c2, $c3, $c4){} * * @link https://secure.php.net/manual/en/function.pdf-setdash.php */ -function PDF_setdash($pdf, $b, $w){} +function PDF_setdash($pdf, $b, $w) {} /** * @param resource $pdf @@ -3231,7 +3161,7 @@ function PDF_setdash($pdf, $b, $w){} * * @link https://secure.php.net/manual/en/function.pdf-setdashpattern.php */ -function PDF_setdashpattern($pdf, $optlist){} +function PDF_setdashpattern($pdf, $optlist) {} /** * @param resource $pdf @@ -3241,7 +3171,7 @@ function PDF_setdashpattern($pdf, $optlist){} * * @link https://secure.php.net/manual/en/function.pdf-setflat.php */ -function PDF_setflat($pdf, $flatness){} +function PDF_setflat($pdf, $flatness) {} /** * @param resource $pdf @@ -3252,7 +3182,7 @@ function PDF_setflat($pdf, $flatness){} * * @link https://secure.php.net/manual/en/function.pdf-setfont.php */ -function PDF_setfont($pdf, $font, $fontsize){} +function PDF_setfont($pdf, $font, $fontsize) {} /** * @param resource $pdf @@ -3262,7 +3192,7 @@ function PDF_setfont($pdf, $font, $fontsize){} * * @link https://secure.php.net/manual/en/function.pdf-setgray-fill.php (dep) */ -function PDF_setgray_fill($pdf, $g){} +function PDF_setgray_fill($pdf, $g) {} /** * @param resource $pdf @@ -3272,7 +3202,7 @@ function PDF_setgray_fill($pdf, $g){} * * @link https://secure.php.net/manual/en/function.pdf-setgray-stroke.php (dep) */ -function PDF_setgray_stroke($pdf, $g){} +function PDF_setgray_stroke($pdf, $g) {} /** * @param resource $pdf @@ -3282,7 +3212,7 @@ function PDF_setgray_stroke($pdf, $g){} * * @link https://secure.php.net/manual/en/function.pdf-setgray.php (dep) */ -function PDF_setgray($pdf, $g){} +function PDF_setgray($pdf, $g) {} /** * @param resource $pdf @@ -3292,7 +3222,7 @@ function PDF_setgray($pdf, $g){} * * @link https://secure.php.net/manual/en/function.pdf-setlinecap.php */ -function PDF_setlinecap($pdf, $linecap){} +function PDF_setlinecap($pdf, $linecap) {} /** * @param resource $pdf @@ -3302,7 +3232,7 @@ function PDF_setlinecap($pdf, $linecap){} * * @link https://secure.php.net/manual/en/function.pdf-setlinejoin.php */ -function PDF_setlinejoin($pdf, $value){} +function PDF_setlinejoin($pdf, $value) {} /** * @param resource $pdf @@ -3312,7 +3242,7 @@ function PDF_setlinejoin($pdf, $value){} * * @link https://secure.php.net/manual/en/function.pdf-setlinewidth.php */ -function PDF_setlinewidth($pdf, $width){} +function PDF_setlinewidth($pdf, $width) {} /** * @param resource $pdf @@ -3327,7 +3257,7 @@ function PDF_setlinewidth($pdf, $width){} * * @link https://secure.php.net/manual/en/function.pdf-setmatrix.php */ -function PDF_setmatrix($pdf, $a, $b, $c, $d, $e, $f){} +function PDF_setmatrix($pdf, $a, $b, $c, $d, $e, $f) {} /** * @param resource $pdf @@ -3337,7 +3267,7 @@ function PDF_setmatrix($pdf, $a, $b, $c, $d, $e, $f){} * * @link https://secure.php.net/manual/en/function.pdf-setmiterlimit.php */ -function PDF_setmiterlimit($pdf, $miter){} +function PDF_setmiterlimit($pdf, $miter) {} /** * @param resource $pdf @@ -3349,7 +3279,7 @@ function PDF_setmiterlimit($pdf, $miter){} * * @link https://secure.php.net/manual/en/function.pdf-setrgbcolor-fill.php (dep) */ -function PDF_setrgbcolor_fill($pdf, $red, $green, $blue){} +function PDF_setrgbcolor_fill($pdf, $red, $green, $blue) {} /** * @param resource $pdf @@ -3361,7 +3291,7 @@ function PDF_setrgbcolor_fill($pdf, $red, $green, $blue){} * * @link https://secure.php.net/manual/en/function.pdf-setrgbcolor-stroke.php (dep) */ -function PDF_setrgbcolor_stroke($pdf, $red, $green, $blue){} +function PDF_setrgbcolor_stroke($pdf, $red, $green, $blue) {} /** * @param resource $pdf @@ -3373,7 +3303,7 @@ function PDF_setrgbcolor_stroke($pdf, $red, $green, $blue){} * * @link https://secure.php.net/manual/en/function.pdf-setrgbcolor.php (dep) */ -function PDF_setrgbcolor($pdf, $red, $green, $blue){} +function PDF_setrgbcolor($pdf, $red, $green, $blue) {} /** * @param resource $pdf @@ -3384,7 +3314,7 @@ function PDF_setrgbcolor($pdf, $red, $green, $blue){} * * @link https://secure.php.net/manual/en/function.pdf-shading-pattern.php */ -function PDF_shading_pattern($pdf, $shading, $optlist){} +function PDF_shading_pattern($pdf, $shading, $optlist) {} /** * @param resource $pdf @@ -3403,7 +3333,7 @@ function PDF_shading_pattern($pdf, $shading, $optlist){} * * @link https://secure.php.net/manual/en/function.pdf-shading.php */ -function PDF_shading($pdf, $shtype, $x0, $y0, $x1, $y1, $c1, $c2, $c3, $c4, $optlist){} +function PDF_shading($pdf, $shtype, $x0, $y0, $x1, $y1, $c1, $c2, $c3, $c4, $optlist) {} /** * @param resource $pdf @@ -3413,7 +3343,7 @@ function PDF_shading($pdf, $shtype, $x0, $y0, $x1, $y1, $c1, $c2, $c3, $c4, $opt * * @link https://secure.php.net/manual/en/function.pdf-shfill.php */ -function PDF_shfill($pdf, $shading){} +function PDF_shfill($pdf, $shading) {} /** * @param resource $pdf @@ -3429,7 +3359,7 @@ function PDF_shfill($pdf, $shading){} * * @link https://secure.php.net/manual/en/function.pdf-show-boxed.php (dep) */ -function PDF_show_boxed($pdf, $text, $left, $top, $width, $height, $mode, $feature){} +function PDF_show_boxed($pdf, $text, $left, $top, $width, $height, $mode, $feature) {} /** * @param resource $pdf @@ -3441,7 +3371,7 @@ function PDF_show_boxed($pdf, $text, $left, $top, $width, $height, $mode, $featu * * @link https://secure.php.net/manual/en/function.pdf-show-xy.php */ -function PDF_show_xy($pdf, $text, $x, $y){} +function PDF_show_xy($pdf, $text, $x, $y) {} /** * @param resource $pdf @@ -3451,7 +3381,7 @@ function PDF_show_xy($pdf, $text, $x, $y){} * * @link https://secure.php.net/manual/en/function.pdf-show.php */ -function PDF_show($pdf, $text){} +function PDF_show($pdf, $text) {} /** * @param resource $pdf @@ -3462,7 +3392,7 @@ function PDF_show($pdf, $text){} * * @link https://secure.php.net/manual/en/function.pdf-skew.php */ -function PDF_skew($pdf, $alpha, $beta){} +function PDF_skew($pdf, $alpha, $beta) {} /** * @param resource $pdf @@ -3474,7 +3404,7 @@ function PDF_skew($pdf, $alpha, $beta){} * * @link https://secure.php.net/manual/en/function.pdf-stringwidth.php */ -function PDF_stringwidth($pdf, $text, $font, $fontsize){} +function PDF_stringwidth($pdf, $text, $font, $fontsize) {} /** * @param resource $pdf @@ -3483,7 +3413,7 @@ function PDF_stringwidth($pdf, $text, $font, $fontsize){} * * @link https://secure.php.net/manual/en/function.pdf-stroke.php */ -function PDF_stroke($p){} +function PDF_stroke($p) {} /** * @param resource $pdf @@ -3493,7 +3423,7 @@ function PDF_stroke($p){} * * @link https://secure.php.net/manual/en/function.pdf-suspend-page.php */ -function PDF_suspend_page($pdf, $optlist){} +function PDF_suspend_page($pdf, $optlist) {} /** * @param resource $pdf @@ -3504,7 +3434,7 @@ function PDF_suspend_page($pdf, $optlist){} * * @link https://secure.php.net/manual/en/function.pdf-translate.php */ -function PDF_translate($pdf, $tx, $ty){} +function PDF_translate($pdf, $tx, $ty) {} /** * @param resource $pdf @@ -3514,7 +3444,7 @@ function PDF_translate($pdf, $tx, $ty){} * * @link https://secure.php.net/manual/en/function.pdf-utf16-to-utf8.php */ -function PDF_utf16_to_utf8($pdf, $utf16string){} +function PDF_utf16_to_utf8($pdf, $utf16string) {} /** * @param resource $pdf @@ -3525,7 +3455,7 @@ function PDF_utf16_to_utf8($pdf, $utf16string){} * * @link https://secure.php.net/manual/en/function.pdf-utf32-to-utf16.php */ -function PDF_utf32_to_utf16($pdf, $utf32string, $ordering){} +function PDF_utf32_to_utf16($pdf, $utf32string, $ordering) {} /** * @param resource $pdf @@ -3536,4 +3466,4 @@ function PDF_utf32_to_utf16($pdf, $utf32string, $ordering){} * * @link https://secure.php.net/manual/en/function.pdf-utf8-to-utf16.php */ -function PDF_utf8_to_utf16($pdf, $utf8string, $ordering){} +function PDF_utf8_to_utf16($pdf, $utf8string, $ordering) {} diff --git a/pdo_ibm/pdo_ibm.php b/pdo_ibm/pdo_ibm.php index f9b9f6346..e84a94d39 100644 --- a/pdo_ibm/pdo_ibm.php +++ b/pdo_ibm/pdo_ibm.php @@ -2,7 +2,6 @@ // Start of pdo_ibm v.1.2.3 -function confirm_pdo_ibm_compiled () {} +function confirm_pdo_ibm_compiled() {} // End of pdo_ibm v.1.2.3 -?> diff --git a/pdo_mysql/pdo_mysql.php b/pdo_mysql/pdo_mysql.php index b6fdd63d6..77870f4f1 100644 --- a/pdo_mysql/pdo_mysql.php +++ b/pdo_mysql/pdo_mysql.php @@ -2,4 +2,3 @@ // Start of pdo_mysql v.1.0.2 // End of pdo_mysql v.1.0.2 -?> diff --git a/pdo_pgsql/pdo_pgsql.php b/pdo_pgsql/pdo_pgsql.php index e551b7ae6..5dab8b540 100644 --- a/pdo_pgsql/pdo_pgsql.php +++ b/pdo_pgsql/pdo_pgsql.php @@ -2,4 +2,3 @@ // Start of pdo_pgsql v.1.0.2 // End of pdo_pgsql v.1.0.2 -?> diff --git a/pdo_sqlite/pdo_sqlite.php b/pdo_sqlite/pdo_sqlite.php index d33f2d2ae..b63019a5b 100644 --- a/pdo_sqlite/pdo_sqlite.php +++ b/pdo_sqlite/pdo_sqlite.php @@ -2,4 +2,3 @@ // Start of pdo_sqlite v.1.0.1 // End of pdo_sqlite v.1.0.1 -?> diff --git a/pgsql/pgsql.php b/pgsql/pgsql.php index 6ce5a1d12..ce819f12f 100644 --- a/pgsql/pgsql.php +++ b/pgsql/pgsql.php @@ -37,7 +37,7 @@ * * @return resource|false PostgreSQL connection resource on success, FALSE on failure. */ -function pg_connect ($connection_string, $connect_type = null) {} +function pg_connect($connection_string, $connect_type = null) {} /** * Open a persistent PostgreSQL connection @@ -68,7 +68,7 @@ function pg_connect ($connection_string, $connect_type = null) {} * * @return resource|false PostgreSQL connection resource on success, FALSE on failure. */ -function pg_pconnect ($connection_string, $connect_type = null) {} +function pg_pconnect($connection_string, $connect_type = null) {} /** * Closes a PostgreSQL connection @@ -81,7 +81,7 @@ function pg_pconnect ($connection_string, $connect_type = null) {} * * @return bool TRUE on success or FALSE on failure. */ -function pg_close ($connection = null) {} +function pg_close($connection = null) {} /** * Poll the status of an in-progress asynchronous PostgreSQL connection attempt. @@ -93,7 +93,7 @@ function pg_close ($connection = null) {} * PGSQL_POLLING_OK, or PGSQL_POLLING_ACTIVE. * @since 5.6 */ -function pg_connect_poll ($connection = null) {} +function pg_connect_poll($connection = null) {} /** * Get connection status @@ -104,7 +104,7 @@ function pg_connect_poll ($connection = null) {} * @return int PGSQL_CONNECTION_OK or * PGSQL_CONNECTION_BAD. */ -function pg_connection_status ($connection) {} +function pg_connection_status($connection) {} /** * Get connection is busy or not @@ -114,7 +114,7 @@ function pg_connection_status ($connection) {} * * @return bool TRUE if the connection is busy, FALSE otherwise. */ -function pg_connection_busy ($connection) {} +function pg_connection_busy($connection) {} /** * Reset connection (reconnect) @@ -124,7 +124,7 @@ function pg_connection_busy ($connection) {} * * @return bool TRUE on success or FALSE on failure. */ -function pg_connection_reset ($connection) {} +function pg_connection_reset($connection) {} /** * Get a read only handle to the socket underlying a PostgreSQL connection @@ -135,7 +135,7 @@ function pg_connection_reset ($connection) {} * @return resource|false A socket resource on success or FALSE on failure. * @since 5.6 */ -function pg_socket ($connection) {} +function pg_socket($connection) {} /** * Returns the host name associated with the connection @@ -149,7 +149,7 @@ function pg_socket ($connection) {} * @return string|false A string containing the name of the host the * connection is to, or FALSE on error. */ -function pg_host ($connection = null) {} +function pg_host($connection = null) {} /** * Get the database name @@ -163,7 +163,7 @@ function pg_host ($connection = null) {} * @return string|false A string containing the name of the database the * connection is to, or FALSE on error. */ -function pg_dbname ($connection = null) {} +function pg_dbname($connection = null) {} /** * Return the port number associated with the connection @@ -178,7 +178,7 @@ function pg_dbname ($connection = null) {} * server the connection is to, * or FALSE on error. */ -function pg_port ($connection = null) {} +function pg_port($connection = null) {} /** * Return the TTY name associated with the connection @@ -192,7 +192,7 @@ function pg_port ($connection = null) {} * @return string A string containing the debug TTY of * the connection, or FALSE on error. */ -function pg_tty ($connection = null) {} +function pg_tty($connection = null) {} /** * Get the options associated with the connection @@ -206,7 +206,7 @@ function pg_tty ($connection = null) {} * @return string A string containing the connection * options, or FALSE on error. */ -function pg_options ($connection = null) {} +function pg_options($connection = null) {} /** * Returns an array with client, protocol and server version (when available) @@ -221,7 +221,7 @@ function pg_options ($connection = null) {} * and server keys and values (if available). Returns * FALSE on error or invalid connection. */ -function pg_version ($connection = null) {} +function pg_version($connection = null) {} /** * Ping database connection @@ -234,7 +234,7 @@ function pg_version ($connection = null) {} * * @return bool TRUE on success or FALSE on failure. */ -function pg_ping ($connection = null) {} +function pg_ping($connection = null) {} /** * Looks up a current parameter setting of the server. @@ -255,7 +255,7 @@ function pg_ping ($connection = null) {} * @return string|false A string containing the value of the parameter, FALSE on failure or invalid * param_name. */ -function pg_parameter_status ($connection = null, $param_name) {} +function pg_parameter_status($connection = null, $param_name) {} /** * Returns the current in-transaction status of the server. @@ -271,7 +271,7 @@ function pg_parameter_status ($connection = null, $param_name) {} * PGSQL_TRANSACTION_ACTIVE is reported only when a query * has been sent to the server and not yet completed. */ -function pg_transaction_status ($connection) {} +function pg_transaction_status($connection) {} /** * Execute a query @@ -301,7 +301,7 @@ function pg_transaction_status ($connection) {} * * @return resource|false A query result resource on success or FALSE on failure. */ -function pg_query ($connection = null, $query) {} +function pg_query($connection = null, $query) {} /** * Submits a command to the server and waits for the result, with the ability to pass parameters separately from the SQL command text. @@ -337,7 +337,7 @@ function pg_query ($connection = null, $query) {} * * @return resource|false A query result resource on success or FALSE on failure. */ -function pg_query_params ($connection = null, $query, array $params) {} +function pg_query_params($connection = null, $query, array $params) {} /** * Submits a request to create a prepared statement with the @@ -361,7 +361,7 @@ function pg_query_params ($connection = null, $query, array $params) {} * * @return resource|false A query result resource on success or FALSE on failure. */ -function pg_prepare ($connection = null, $stmtname, $query) {} +function pg_prepare($connection = null, $stmtname, $query) {} /** * Sends a request to execute a prepared statement with given parameters, and waits for the result. @@ -389,7 +389,7 @@ function pg_prepare ($connection = null, $stmtname, $query) {} * * @return resource|false A query result resource on success or FALSE on failure. */ -function pg_execute ($connection = null, $stmtname, array $params) {} +function pg_execute($connection = null, $stmtname, array $params) {} /** * Sends asynchronous query @@ -407,7 +407,7 @@ function pg_execute ($connection = null, $stmtname, array $params) {} ** Use pg_get_result to determine the query result. */ -function pg_send_query ($connection, $query) {} +function pg_send_query($connection, $query) {} /** * Submits a command and separate parameters to the server without waiting for the result(s). @@ -429,7 +429,7 @@ function pg_send_query ($connection, $query) {} *
* Use pg_get_result to determine the query result. */ -function pg_send_query_params ($connection, $query, array $params) {} +function pg_send_query_params($connection, $query, array $params) {} /** * Sends a request to create a prepared statement with the given parameters, without waiting for completion. @@ -453,7 +453,7 @@ function pg_send_query_params ($connection, $query, array $params) {} * @return bool TRUE on success, FALSE on failure. Use pg_get_result * to determine the query result. */ -function pg_send_prepare ($connection, $stmtname, $query) {} +function pg_send_prepare($connection, $stmtname, $query) {} /** * Sends a request to execute a prepared statement with given parameters, without waiting for the result(s). @@ -479,7 +479,7 @@ function pg_send_prepare ($connection, $stmtname, $query) {} * @return bool TRUE on success, FALSE on failure. Use pg_get_result * to determine the query result. */ -function pg_send_execute ($connection, $stmtname, array $params) {} +function pg_send_execute($connection, $stmtname, array $params) {} /** * Cancel an asynchronous query @@ -489,7 +489,7 @@ function pg_send_execute ($connection, $stmtname, array $params) {} *
* @return bool TRUE on success or FALSE on failure. */ -function pg_cancel_query ($connection) {} +function pg_cancel_query($connection) {} /** * Returns values from a result resource @@ -518,7 +518,7 @@ function pg_cancel_query ($connection) {} * FALSE is returned if row exceeds the number * of rows in the set, or on any other error. */ -function pg_fetch_result ($result, $row = null, $field) {} +function pg_fetch_result($result, $row = null, $field) {} /** * Get a row as an enumerated array @@ -541,7 +541,7 @@ function pg_fetch_result ($result, $row = null, $field) {} * FALSE is returned if row exceeds the number * of rows in the set, there are no more rows, or on any other error. */ -function pg_fetch_row ($result, $row = null, $result_type = null) {} +function pg_fetch_row($result, $row = null, $result_type = null) {} /** * Fetch a row as an associative array @@ -564,7 +564,7 @@ function pg_fetch_row ($result, $row = null, $result_type = null) {} * FALSE is returned if row exceeds the number * of rows in the set, there are no more rows, or on any other error. */ -function pg_fetch_assoc ($result, $row = null) {} +function pg_fetch_assoc($result, $row = null) {} /** * Fetch a row as an array @@ -600,7 +600,7 @@ function pg_fetch_assoc ($result, $row = null) {} * FALSE is returned if row exceeds the number * of rows in the set, there are no more rows, or on any other error. */ -function pg_fetch_array ($result, $row = null, $result_type = PGSQL_BOTH) {} +function pg_fetch_array($result, $row = null, $result_type = PGSQL_BOTH) {} /** * Fetch a row as an object @@ -625,7 +625,7 @@ function pg_fetch_array ($result, $row = null, $result_type = PGSQL_BOTH) {} * FALSE is returned if row exceeds the number * of rows in the set, there are no more rows, or on any other error. */ -function pg_fetch_object ($result, $row = null, $result_type = PGSQL_ASSOC) {} +function pg_fetch_object($result, $row = null, $result_type = PGSQL_ASSOC) {} /** * Fetches all rows from a result as an array @@ -654,7 +654,7 @@ function pg_fetch_object ($result, $row = null, $result_type = PGSQL_ASSOC) {} * FALSE is returned if there are no rows in the result, or on any * other error. */ -function pg_fetch_all ($result, $result_type = PGSQL_ASSOC) {} +function pg_fetch_all($result, $result_type = PGSQL_ASSOC) {} /** * Fetches all rows in a particular result column as an array @@ -674,7 +674,7 @@ function pg_fetch_all ($result, $result_type = PGSQL_ASSOC) {} * of columns in the result, or on any other error. * */ -function pg_fetch_all_columns ($result, $column = 0) {} +function pg_fetch_all_columns($result, $column = 0) {} /** * Returns number of affected records (tuples) @@ -687,7 +687,7 @@ function pg_fetch_all_columns ($result, $column = 0) {} * @return int The number of rows affected by the query. If no tuple is * affected, it will return 0. */ -function pg_affected_rows ($result) {} +function pg_affected_rows($result) {} /** * Get asynchronous query result @@ -697,7 +697,7 @@ function pg_affected_rows ($result) {} * * @return resource|false The result resource, or FALSE if no more results are available. */ -function pg_get_result ($connection = null) {} +function pg_get_result($connection = null) {} /** * Set internal row offset in result resource @@ -713,7 +713,7 @@ function pg_get_result ($connection = null) {} * * @return bool TRUE on success or FALSE on failure. */ -function pg_result_seek ($result, $offset) {} +function pg_result_seek($result, $offset) {} /** * Get status of query result @@ -735,7 +735,7 @@ function pg_result_seek ($result, $offset) {} * PGSQL_FATAL_ERROR if PGSQL_STATUS_LONG is * specified. Otherwise, a string containing the PostgreSQL command tag is returned. */ -function pg_result_status ($result, $type = PGSQL_STATUS_LONG) {} +function pg_result_status($result, $type = PGSQL_STATUS_LONG) {} /** * Free result memory @@ -747,7 +747,7 @@ function pg_result_status ($result, $type = PGSQL_STATUS_LONG) {} * * @return bool TRUE on success or FALSE on failure. */ -function pg_free_result ($result) {} +function pg_free_result($result) {} /** * Returns the last row's OID @@ -761,7 +761,7 @@ function pg_free_result ($result) {} * row in the specified connection, or FALSE on error or * no available OID. */ -function pg_last_oid ($result) {} +function pg_last_oid($result) {} /** * Returns the number of rows in a result @@ -773,7 +773,7 @@ function pg_last_oid ($result) {} * * @return int The number of rows in the result. On error, -1 is returned. */ -function pg_num_rows ($result) {} +function pg_num_rows($result) {} /** * Returns the number of fields in a result @@ -785,7 +785,7 @@ function pg_num_rows ($result) {} * * @return int The number of fields (columns) in the result. On error, -1 is returned. */ -function pg_num_fields ($result) {} +function pg_num_fields($result) {} /** * Returns the name of a field @@ -800,7 +800,7 @@ function pg_num_fields ($result) {} * * @return string|false The field name, or FALSE on error. */ -function pg_field_name ($result, $field_number) {} +function pg_field_name($result, $field_number) {} /** * Returns the field number of the named field @@ -815,7 +815,7 @@ function pg_field_name ($result, $field_number) {} * * @return int The field number (numbered from 0), or -1 on error. */ -function pg_field_num ($result, $field_name) {} +function pg_field_num($result, $field_name) {} /** * Returns the internal storage size of the named field @@ -831,7 +831,7 @@ function pg_field_num ($result, $field_name) {} * @return int The internal field storage size (in bytes). -1 indicates a variable * length field. FALSE is returned on error. */ -function pg_field_size ($result, $field_number) {} +function pg_field_size($result, $field_number) {} /** * Returns the type name for the corresponding field number @@ -847,7 +847,7 @@ function pg_field_size ($result, $field_number) {} * @return string|false A string containing the base name of the field's type, or FALSE * on error. */ -function pg_field_type ($result, $field_number) {} +function pg_field_type($result, $field_number) {} /** * Returns the type ID (OID) for the corresponding field number @@ -862,7 +862,7 @@ function pg_field_type ($result, $field_number) {} * * @return int|false The OID of the field's base type. FALSE is returned on error. */ -function pg_field_type_oid ($result, $field_number) {} +function pg_field_type_oid($result, $field_number) {} /** * Returns the printed length @@ -876,7 +876,7 @@ function pg_field_type_oid ($result, $field_number) {} * @param mixed $field_name_or_number * @return int|false The field printed length, or FALSE on error. */ -function pg_field_prtlen ($result, $row_number, $field_name_or_number) {} +function pg_field_prtlen($result, $row_number, $field_name_or_number) {} /** * Test if a field is SQL NULL @@ -897,7 +897,7 @@ function pg_field_prtlen ($result, $row_number, $field_name_or_number) {} * @return int 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. */ -function pg_field_is_null ($result, $row, $field) {} +function pg_field_is_null($result, $row, $field) {} /** * Returns the name or oid of the tables field @@ -917,7 +917,7 @@ function pg_field_is_null ($result, $row, $field) {} * * @return mixed On success either the fields table name or oid. Or, FALSE on failure. */ -function pg_field_table ($result, $field_number, $oid_only = false) {} +function pg_field_table($result, $field_number, $oid_only = false) {} /** * Gets SQL NOTIFY message @@ -940,7 +940,7 @@ function pg_field_table ($result, $field_number, $oid_only = false) {} * @return array|false An array containing the NOTIFY message name and backend PID. * Otherwise if no NOTIFY is waiting, then FALSE is returned. */ -function pg_get_notify ($connection, $result_type = null) {} +function pg_get_notify($connection, $result_type = null) {} /** * Gets the backend's process ID @@ -950,7 +950,7 @@ function pg_get_notify ($connection, $result_type = null) {} * * @return int The backend database process ID. */ -function pg_get_pid ($connection) {} +function pg_get_pid($connection) {} /** * Get error message associated with result @@ -963,7 +963,7 @@ function pg_get_pid ($connection) {} * @return string a string if there is an error associated with the * result parameter, FALSE otherwise. */ -function pg_result_error ($result) {} +function pg_result_error($result) {} /** * Returns an individual field of an error report. @@ -986,7 +986,7 @@ function pg_result_error ($result) {} * @return string|null|false A string containing the contents of the error field, NULL if the field does not exist or FALSE * on failure. */ -function pg_result_error_field ($result, $fieldcode) {} +function pg_result_error_field($result, $fieldcode) {} /** * Get the last error message string of a connection @@ -1000,7 +1000,7 @@ function pg_result_error_field ($result, $fieldcode) {} * @return string A string containing the last error message on the * given connection, or FALSE on error. */ -function pg_last_error ($connection = null) {} +function pg_last_error($connection = null) {} /** * Returns the last notice message from PostgreSQL server @@ -1019,7 +1019,7 @@ function pg_last_error ($connection = null) {} * a bool with PGSQL_NOTICE_CLEAR, or * FALSE on error. */ -function pg_last_notice ($connection, $option = PGSQL_NOTICE_LAST) {} +function pg_last_notice($connection, $option = PGSQL_NOTICE_LAST) {} /** * Send a NULL-terminated string to PostgreSQL backend @@ -1036,7 +1036,7 @@ function pg_last_notice ($connection, $option = PGSQL_NOTICE_LAST) {} * * @return bool TRUE on success or FALSE on failure. */ -function pg_put_line ($connection = null, $data) {} +function pg_put_line($connection = null, $data) {} /** * Sync with PostgreSQL backend @@ -1049,7 +1049,7 @@ function pg_put_line ($connection = null, $data) {} * * @return bool TRUE on success or FALSE on failure. */ -function pg_end_copy ($connection = null) {} +function pg_end_copy($connection = null) {} /** * Copy a table to an array @@ -1071,7 +1071,7 @@ function pg_end_copy ($connection = null) {} * @return array|false An array with one element for each line of COPY data. * It returns FALSE on failure. */ -function pg_copy_to ($connection, $table_name, $delimiter = null, $null_as = null) {} +function pg_copy_to($connection, $table_name, $delimiter = null, $null_as = null) {} /** * Insert records into a table from an array @@ -1098,7 +1098,7 @@ function pg_copy_to ($connection, $table_name, $delimiter = null, $null_as = nul * * @return bool TRUE on success or FALSE on failure. */ -function pg_copy_from ($connection, $table_name, array $rows, $delimiter = null, $null_as = null) {} +function pg_copy_from($connection, $table_name, array $rows, $delimiter = null, $null_as = null) {} /** * Enable tracing a PostgreSQL connection @@ -1118,7 +1118,7 @@ function pg_copy_from ($connection, $table_name, array $rows, $delimiter = null, * * @return bool TRUE on success or FALSE on failure. */ -function pg_trace ($pathname, $mode = "w", $connection = null) {} +function pg_trace($pathname, $mode = "w", $connection = null) {} /** * Disable tracing of a PostgreSQL connection @@ -1131,7 +1131,7 @@ function pg_trace ($pathname, $mode = "w", $connection = null) {} * * @return bool Always returns TRUE. */ -function pg_untrace ($connection = null) {} +function pg_untrace($connection = null) {} /** * Create a large object @@ -1151,7 +1151,7 @@ function pg_untrace ($connection = null) {} * * @return int|false A large object OID or FALSE on error. */ -function pg_lo_create ($connection = null, $object_id = null) {} +function pg_lo_create($connection = null, $object_id = null) {} /** * Delete a large object @@ -1167,7 +1167,7 @@ function pg_lo_create ($connection = null, $object_id = null) {} * * @return bool TRUE on success or FALSE on failure. */ -function pg_lo_unlink ($connection, $oid) {} +function pg_lo_unlink($connection, $oid) {} /** * Open a large object @@ -1187,7 +1187,7 @@ function pg_lo_unlink ($connection, $oid) {} * * @return resource|false A large object resource or FALSE on error. */ -function pg_lo_open ($connection, $oid, $mode) {} +function pg_lo_open($connection, $oid, $mode) {} /** * Close a large object @@ -1195,7 +1195,7 @@ function pg_lo_open ($connection, $oid, $mode) {} * @param resource $large_object * @return bool TRUE on success or FALSE on failure. */ -function pg_lo_close ($large_object) {} +function pg_lo_close($large_object) {} /** * Read a large object @@ -1209,7 +1209,7 @@ function pg_lo_close ($large_object) {} * @return string A string containing len bytes from the * large object, or FALSE on error. */ -function pg_lo_read ($large_object, $len = 8192) {} +function pg_lo_read($large_object, $len = 8192) {} /** * Write to a large object @@ -1229,7 +1229,7 @@ function pg_lo_read ($large_object, $len = 8192) {} * * @return int|false The number of bytes written to the large object, or FALSE on error. */ -function pg_lo_write ($large_object, $data, $len = null) {} +function pg_lo_write($large_object, $data, $len = null) {} /** * Reads an entire large object and send straight to browser @@ -1239,7 +1239,7 @@ function pg_lo_write ($large_object, $data, $len = null) {} * * @return int|false Number of bytes read or FALSE on error. */ -function pg_lo_read_all ($large_object) {} +function pg_lo_read_all($large_object) {} /** * Import a large object from file @@ -1265,7 +1265,7 @@ function pg_lo_read_all ($large_object) {} * FALSE on failure. */ #[PhpStormStubsElementAvailable(to: '7.4')] -function pg_lo_import ($connection = null, $pathname, $object_id = null) {} +function pg_lo_import($connection = null, $pathname, $object_id = null) {} /** * Import a large object from file @@ -1291,7 +1291,7 @@ function pg_lo_import ($connection = null, $pathname, $object_id = null) {} * FALSE on failure. */ #[PhpStormStubsElementAvailable('8.0')] -function pg_lo_import ($connection, $pathname, $object_id = null) {} +function pg_lo_import($connection, $pathname, $object_id = null) {} /** * Export a large object to file @@ -1312,7 +1312,7 @@ function pg_lo_import ($connection, $pathname, $object_id = null) {} * @return bool TRUE on success or FALSE on failure. */ #[PhpStormStubsElementAvailable(to: '7.4')] -function pg_lo_export ($connection = null, $oid, $pathname) {} +function pg_lo_export($connection = null, $oid, $pathname) {} /** * Export a large object to file @@ -1333,7 +1333,7 @@ function pg_lo_export ($connection = null, $oid, $pathname) {} * @return bool TRUE on success or FALSE on failure. */ #[PhpStormStubsElementAvailable('8.0')] -function pg_lo_export ($connection, $oid, $pathname) {} +function pg_lo_export($connection, $oid, $pathname) {} /** * Seeks position within a large object @@ -1351,7 +1351,7 @@ function pg_lo_export ($connection, $oid, $pathname) {} * * @return bool TRUE on success or FALSE on failure. */ -function pg_lo_seek ($large_object, $offset, $whence = PGSQL_SEEK_CUR) {} +function pg_lo_seek($large_object, $offset, $whence = PGSQL_SEEK_CUR) {} /** * Returns current seek position a of large object @@ -1362,7 +1362,7 @@ function pg_lo_seek ($large_object, $offset, $whence = PGSQL_SEEK_CUR) {} * @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. */ -function pg_lo_tell ($large_object) {} +function pg_lo_tell($large_object) {} /** * Escape a string for query @@ -1378,7 +1378,7 @@ function pg_lo_tell ($large_object) {} * * @return string A string containing the escaped data. */ -function pg_escape_string ($connection = null, $data) {} +function pg_escape_string($connection = null, $data) {} /** * Escape a string for insertion into a bytea field @@ -1395,7 +1395,7 @@ function pg_escape_string ($connection = null, $data) {} * * @return string A string containing the escaped data. */ -function pg_escape_bytea ($connection = null, $data) {} +function pg_escape_bytea($connection = null, $data) {} /** * Escape a identifier for insertion into a text field @@ -1412,7 +1412,7 @@ function pg_escape_bytea ($connection = null, $data) {} * @return string A string containing the escaped data. * @since 5.4.4 */ -function pg_escape_identifier ($connection = null, $data) {} +function pg_escape_identifier($connection = null, $data) {} /** * Escape a literal for insertion into a text field @@ -1429,7 +1429,7 @@ function pg_escape_identifier ($connection = null, $data) {} * @return string A string containing the escaped data. * @since 5.4.4 */ -function pg_escape_literal ($connection = null, $data) {} +function pg_escape_literal($connection = null, $data) {} /** * Unescape binary for bytea type @@ -1440,7 +1440,7 @@ function pg_escape_literal ($connection = null, $data) {} * * @return string A string containing the unescaped data. */ -function pg_unescape_bytea ($data) {} +function pg_unescape_bytea($data) {} /** * Determines the verbosity of messages returned by pg_last_error @@ -1461,7 +1461,7 @@ function pg_unescape_bytea ($data) {} * PGSQL_ERRORS_DEFAULT * or PGSQL_ERRORS_VERBOSE. */ -function pg_set_error_verbosity ($connection = null, $verbosity) {} +function pg_set_error_verbosity($connection = null, $verbosity) {} /** * Gets the client encoding @@ -1474,7 +1474,7 @@ function pg_set_error_verbosity ($connection = null, $verbosity) {} * * @return string|false The client encoding, or FALSE on error. */ -function pg_client_encoding ($connection = null) {} +function pg_client_encoding($connection = null) {} /** * Set the client encoding @@ -1498,7 +1498,7 @@ function pg_client_encoding ($connection = null) {} * * @return int 0 on success or -1 on error. */ -function pg_set_client_encoding ($connection = null, $encoding) {} +function pg_set_client_encoding($connection = null, $encoding) {} /** * Get meta data for table @@ -1511,7 +1511,7 @@ function pg_set_client_encoding ($connection = null, $encoding) {} * * @return array An array of the table definition, or FALSE on error. */ -function pg_meta_data ($connection, $table_name) {} +function pg_meta_data($connection, $table_name) {} /** * Convert associative array values into suitable for SQL statement @@ -1532,7 +1532,7 @@ function pg_meta_data ($connection, $table_name) {} * * @return array An array of converted values, or FALSE on error. */ -function pg_convert ($connection, $table_name, array $assoc_array, $options = 0) {} +function pg_convert($connection, $table_name, array $assoc_array, $options = 0) {} /** * Insert array into table @@ -1559,7 +1559,7 @@ function pg_convert ($connection, $table_name, array $assoc_array, $options = 0) * @return mixed TRUE on success or FALSE on failure. Returns string if PGSQL_DML_STRING is passed * via options. */ -function pg_insert ($connection, $table_name, array $assoc_array, $options = PGSQL_DML_EXEC) {} +function pg_insert($connection, $table_name, array $assoc_array, $options = PGSQL_DML_EXEC) {} /** * Update table @@ -1588,7 +1588,7 @@ function pg_insert ($connection, $table_name, array $assoc_array, $options = PGS * @return mixed TRUE on success or FALSE on failure. Returns string if PGSQL_DML_STRING is passed * via options. */ -function pg_update ($connection, $table_name, array $data, array $condition, $options = PGSQL_DML_EXEC) {} +function pg_update($connection, $table_name, array $data, array $condition, $options = PGSQL_DML_EXEC) {} /** * Deletes records @@ -1613,7 +1613,7 @@ function pg_update ($connection, $table_name, array $data, array $condition, $op * @return mixed TRUE on success or FALSE on failure. Returns string if PGSQL_DML_STRING is passed * via options. */ -function pg_delete ($connection, $table_name, array $assoc_array, $options = PGSQL_DML_EXEC) {} +function pg_delete($connection, $table_name, array $assoc_array, $options = PGSQL_DML_EXEC) {} /** * Select records @@ -1651,71 +1651,71 @@ function pg_delete ($connection, $table_name, array $assoc_array, $options = PGS * @return mixed TRUE on success or FALSE on failure. Returns string if PGSQL_DML_STRING is passed * via options. */ -function pg_select ($connection, $table_name, array $assoc_array, $options = PGSQL_DML_EXEC, $result_type = PGSQL_ASSOC) {} +function pg_select($connection, $table_name, array $assoc_array, $options = PGSQL_DML_EXEC, $result_type = PGSQL_ASSOC) {} /** * @param $connection [optional] * @param $query [optional] * @return mixed */ -function pg_exec ($connection, $query) {} +function pg_exec($connection, $query) {} /** * @param $result * @return string */ -function pg_getlastoid ($result) {} +function pg_getlastoid($result) {} /** * @param $result */ -function pg_cmdtuples ($result) {} // TODO remove +function pg_cmdtuples($result) {} // TODO remove /** * @param $connection [optional] * @return string */ -function pg_errormessage ($connection) {} +function pg_errormessage($connection) {} /** * @param $result * @return int */ -function pg_numrows ($result) {} +function pg_numrows($result) {} /** * @param $result * @return int */ -function pg_numfields ($result) {} +function pg_numfields($result) {} /** * @param $result * @param $field_number * @return string */ -function pg_fieldname ($result, $field_number) {} +function pg_fieldname($result, $field_number) {} /** * @param $result * @param $field_number * @return int */ -function pg_fieldsize ($result, $field_number) {} +function pg_fieldsize($result, $field_number) {} /** * @param $result * @param $field_number * @return string */ -function pg_fieldtype ($result, $field_number) {} +function pg_fieldtype($result, $field_number) {} /** * @param $result * @param $field_name * @return int */ -function pg_fieldnum ($result, $field_name) {} +function pg_fieldnum($result, $field_name) {} /** * @param $result @@ -1723,7 +1723,7 @@ function pg_fieldnum ($result, $field_name) {} * @param $field_name_or_number [optional] * @return int */ -function pg_fieldprtlen ($result, $row, $field_name_or_number) {} +function pg_fieldprtlen($result, $row, $field_name_or_number) {} /** * @param $result @@ -1731,37 +1731,37 @@ function pg_fieldprtlen ($result, $row, $field_name_or_number) {} * @param $field_name_or_number [optional] * @return int */ -function pg_fieldisnull ($result, $row, $field_name_or_number) {} +function pg_fieldisnull($result, $row, $field_name_or_number) {} /** * @param $result * @return bool */ -function pg_freeresult ($result) {} +function pg_freeresult($result) {} /** * @param $connection */ -function pg_result ($connection) {} // TODO remove +function pg_result($connection) {} // TODO remove /** * @param $large_object */ -function pg_loreadall ($large_object) {} // TODO remove +function pg_loreadall($large_object) {} // TODO remove /** * @param $connection [optional] * @param $large_object_id [optional] * @return int */ -function pg_locreate ($connection, $large_object_id) {} +function pg_locreate($connection, $large_object_id) {} /** * @param $connection [optional] * @param $large_object_oid [optional] * @return bool */ -function pg_lounlink ($connection, $large_object_oid) {} +function pg_lounlink($connection, $large_object_oid) {} /** * @param $connection [optional] @@ -1769,20 +1769,20 @@ function pg_lounlink ($connection, $large_object_oid) {} * @param $mode [optional] * @return resource */ -function pg_loopen ($connection, $large_object_oid, $mode) {} +function pg_loopen($connection, $large_object_oid, $mode) {} /** * @param $large_object * @return bool */ -function pg_loclose ($large_object) {} +function pg_loclose($large_object) {} /** * @param $large_object * @param $len [optional] * @return string */ -function pg_loread ($large_object, $len) {} +function pg_loread($large_object, $len) {} /** * @param $large_object @@ -1790,7 +1790,7 @@ function pg_loread ($large_object, $len) {} * @param $len [optional] * @return int */ -function pg_lowrite ($large_object, $buf, $len) {} +function pg_lowrite($large_object, $buf, $len) {} /** * @param $connection [optional] @@ -1798,7 +1798,7 @@ function pg_lowrite ($large_object, $buf, $len) {} * @param $large_object_oid [optional] * @return int */ -function pg_loimport ($connection, $filename, $large_object_oid) {} +function pg_loimport($connection, $filename, $large_object_oid) {} /** * @param $connection [optional] @@ -1806,72 +1806,72 @@ function pg_loimport ($connection, $filename, $large_object_oid) {} * @param $filename [optional] * @return bool */ -function pg_loexport ($connection, $objoid, $filename) {} +function pg_loexport($connection, $objoid, $filename) {} /** * @param $connection [optional] * @return string */ -function pg_clientencoding ($connection) {} +function pg_clientencoding($connection) {} /** * @param $connection [optional] * @param $encoding [optional] * @return int */ -function pg_setclientencoding ($connection, $encoding) {} +function pg_setclientencoding($connection, $encoding) {} -define ('PGSQL_LIBPQ_VERSION', "9.1.10"); -define ('PGSQL_LIBPQ_VERSION_STR', "PostgreSQL 9.1.10 on x86_64-unknown-linux-gnu, compiled by gcc (Ubuntu/Linaro 4.8.1-10ubuntu7) 4.8.1, 64-bit"); +define('PGSQL_LIBPQ_VERSION', "9.1.10"); +define('PGSQL_LIBPQ_VERSION_STR', "PostgreSQL 9.1.10 on x86_64-unknown-linux-gnu, compiled by gcc (Ubuntu/Linaro 4.8.1-10ubuntu7) 4.8.1, 64-bit"); /** * Passed to pg_connect to force the creation of a new connection, * rather than re-using an existing identical connection. * @link https://php.net/manual/en/pgsql.constants.php */ -define ('PGSQL_CONNECT_FORCE_NEW', 2); +define('PGSQL_CONNECT_FORCE_NEW', 2); /** * Passed to pg_fetch_array. Return an associative array of field * names and values. * @link https://php.net/manual/en/pgsql.constants.php */ -define ('PGSQL_ASSOC', 1); +define('PGSQL_ASSOC', 1); /** * Passed to pg_fetch_array. Return a numerically indexed array of field * numbers and values. * @link https://php.net/manual/en/pgsql.constants.php */ -define ('PGSQL_NUM', 2); +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 https://php.net/manual/en/pgsql.constants.php */ -define ('PGSQL_BOTH', 3); +define('PGSQL_BOTH', 3); /** * Returned by pg_connection_status indicating that the database * connection is in an invalid state. * @link https://php.net/manual/en/pgsql.constants.php */ -define ('PGSQL_CONNECTION_BAD', 1); +define('PGSQL_CONNECTION_BAD', 1); /** * Returned by pg_connection_status indicating that the database * connection is in a valid state. * @link https://php.net/manual/en/pgsql.constants.php */ -define ('PGSQL_CONNECTION_OK', 0); +define('PGSQL_CONNECTION_OK', 0); /** * Returned by pg_transaction_status. Connection is * currently idle, not in a transaction. * @link https://php.net/manual/en/pgsql.constants.php */ -define ('PGSQL_TRANSACTION_IDLE', 0); +define('PGSQL_TRANSACTION_IDLE', 0); /** * Returned by pg_transaction_status. A command @@ -1879,28 +1879,28 @@ function pg_setclientencoding ($connection, $encoding) {} * and not yet completed. * @link https://php.net/manual/en/pgsql.constants.php */ -define ('PGSQL_TRANSACTION_ACTIVE', 1); +define('PGSQL_TRANSACTION_ACTIVE', 1); /** * Returned by pg_transaction_status. The connection * is idle, in a transaction block. * @link https://php.net/manual/en/pgsql.constants.php */ -define ('PGSQL_TRANSACTION_INTRANS', 2); +define('PGSQL_TRANSACTION_INTRANS', 2); /** * Returned by pg_transaction_status. The connection * is idle, in a failed transaction block. * @link https://php.net/manual/en/pgsql.constants.php */ -define ('PGSQL_TRANSACTION_INERROR', 3); +define('PGSQL_TRANSACTION_INERROR', 3); /** * Returned by pg_transaction_status. The connection * is bad. * @link https://php.net/manual/en/pgsql.constants.php */ -define ('PGSQL_TRANSACTION_UNKNOWN', 4); +define('PGSQL_TRANSACTION_UNKNOWN', 4); /** * Passed to pg_set_error_verbosity. @@ -1908,7 +1908,7 @@ function pg_setclientencoding ($connection, $encoding) {} * and position only; this will normally fit on a single line. * @link https://php.net/manual/en/pgsql.constants.php */ -define ('PGSQL_ERRORS_TERSE', 0); +define('PGSQL_ERRORS_TERSE', 0); /** * Passed to pg_set_error_verbosity. @@ -1917,105 +1917,105 @@ function pg_setclientencoding ($connection, $encoding) {} * multiple lines). * @link https://php.net/manual/en/pgsql.constants.php */ -define ('PGSQL_ERRORS_DEFAULT', 1); +define('PGSQL_ERRORS_DEFAULT', 1); /** * Passed to pg_set_error_verbosity. * The verbose mode includes all available fields. * @link https://php.net/manual/en/pgsql.constants.php */ -define ('PGSQL_ERRORS_VERBOSE', 2); +define('PGSQL_ERRORS_VERBOSE', 2); /** * Passed to pg_lo_seek. Seek operation is to begin * from the start of the object. * @link https://php.net/manual/en/pgsql.constants.php */ -define ('PGSQL_SEEK_SET', 0); +define('PGSQL_SEEK_SET', 0); /** * Passed to pg_lo_seek. Seek operation is to begin * from the current position. * @link https://php.net/manual/en/pgsql.constants.php */ -define ('PGSQL_SEEK_CUR', 1); +define('PGSQL_SEEK_CUR', 1); /** * Passed to pg_lo_seek. Seek operation is to begin * from the end of the object. * @link https://php.net/manual/en/pgsql.constants.php */ -define ('PGSQL_SEEK_END', 2); +define('PGSQL_SEEK_END', 2); /** * Passed to pg_result_status. Indicates that * numerical result code is desired. * @link https://php.net/manual/en/pgsql.constants.php */ -define ('PGSQL_STATUS_LONG', 1); +define('PGSQL_STATUS_LONG', 1); /** * Passed to pg_result_status. Indicates that * textual result command tag is desired. * @link https://php.net/manual/en/pgsql.constants.php */ -define ('PGSQL_STATUS_STRING', 2); +define('PGSQL_STATUS_STRING', 2); /** * Returned by pg_result_status. The string sent to the server * was empty. * @link https://php.net/manual/en/pgsql.constants.php */ -define ('PGSQL_EMPTY_QUERY', 0); +define('PGSQL_EMPTY_QUERY', 0); /** * Returned by pg_result_status. Successful completion of a * command returning no data. * @link https://php.net/manual/en/pgsql.constants.php */ -define ('PGSQL_COMMAND_OK', 1); +define('PGSQL_COMMAND_OK', 1); /** * Returned by pg_result_status. Successful completion of a command * returning data (such as a SELECT or SHOW). * @link https://php.net/manual/en/pgsql.constants.php */ -define ('PGSQL_TUPLES_OK', 2); +define('PGSQL_TUPLES_OK', 2); /** * Returned by pg_result_status. Copy Out (from server) data * transfer started. * @link https://php.net/manual/en/pgsql.constants.php */ -define ('PGSQL_COPY_OUT', 3); +define('PGSQL_COPY_OUT', 3); /** * Returned by pg_result_status. Copy In (to server) data * transfer started. * @link https://php.net/manual/en/pgsql.constants.php */ -define ('PGSQL_COPY_IN', 4); +define('PGSQL_COPY_IN', 4); /** * Returned by pg_result_status. The server's response * was not understood. * @link https://php.net/manual/en/pgsql.constants.php */ -define ('PGSQL_BAD_RESPONSE', 5); +define('PGSQL_BAD_RESPONSE', 5); /** * Returned by pg_result_status. A nonfatal error * (a notice or warning) occurred. * @link https://php.net/manual/en/pgsql.constants.php */ -define ('PGSQL_NONFATAL_ERROR', 6); +define('PGSQL_NONFATAL_ERROR', 6); /** * Returned by pg_result_status. A fatal error * occurred. * @link https://php.net/manual/en/pgsql.constants.php */ -define ('PGSQL_FATAL_ERROR', 7); +define('PGSQL_FATAL_ERROR', 7); /** * Passed to pg_result_error_field. @@ -2026,7 +2026,7 @@ function pg_setclientencoding ($connection, $encoding) {} * translation of one of these. Always present. * @link https://php.net/manual/en/pgsql.constants.php */ -define ('PGSQL_DIAG_SEVERITY', 83); +define('PGSQL_DIAG_SEVERITY', 83); /** * Passed to pg_result_error_field. @@ -2036,21 +2036,21 @@ function pg_setclientencoding ($connection, $encoding) {} * This field is not localizable, and is always present. * @link https://php.net/manual/en/pgsql.constants.php */ -define ('PGSQL_DIAG_SQLSTATE', 67); +define('PGSQL_DIAG_SQLSTATE', 67); /** * Passed to pg_result_error_field. * The primary human-readable error message (typically one line). Always present. * @link https://php.net/manual/en/pgsql.constants.php */ -define ('PGSQL_DIAG_MESSAGE_PRIMARY', 77); +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 https://php.net/manual/en/pgsql.constants.php */ -define ('PGSQL_DIAG_MESSAGE_DETAIL', 68); +define('PGSQL_DIAG_MESSAGE_DETAIL', 68); /** * Passed to pg_result_error_field. @@ -2058,7 +2058,7 @@ function pg_setclientencoding ($connection, $encoding) {} * offers advice (potentially inappropriate) rather than hard facts. May run to multiple lines. * @link https://php.net/manual/en/pgsql.constants.php */ -define ('PGSQL_DIAG_MESSAGE_HINT', 72); +define('PGSQL_DIAG_MESSAGE_HINT', 72); /** * Passed to pg_result_error_field. @@ -2066,7 +2066,7 @@ function pg_setclientencoding ($connection, $encoding) {} * statement string. The first character has index 1, and positions are measured in characters not bytes. * @link https://php.net/manual/en/pgsql.constants.php */ -define ('PGSQL_DIAG_STATEMENT_POSITION', 80); +define('PGSQL_DIAG_STATEMENT_POSITION', 80); /** * Passed to pg_result_error_field. @@ -2077,7 +2077,7 @@ function pg_setclientencoding ($connection, $encoding) {} * field appears. * @link https://php.net/manual/en/pgsql.constants.php */ -define ('PGSQL_DIAG_INTERNAL_POSITION', 112); +define('PGSQL_DIAG_INTERNAL_POSITION', 112); /** * Passed to pg_result_error_field. @@ -2085,7 +2085,7 @@ function pg_setclientencoding ($connection, $encoding) {} * SQL query issued by a PL/pgSQL function. * @link https://php.net/manual/en/pgsql.constants.php */ -define ('PGSQL_DIAG_INTERNAL_QUERY', 113); +define('PGSQL_DIAG_INTERNAL_QUERY', 113); /** * Passed to pg_result_error_field. @@ -2095,7 +2095,7 @@ function pg_setclientencoding ($connection, $encoding) {} * per line, most recent first. * @link https://php.net/manual/en/pgsql.constants.php */ -define ('PGSQL_DIAG_CONTEXT', 87); +define('PGSQL_DIAG_CONTEXT', 87); /** * Passed to pg_result_error_field. @@ -2103,7 +2103,7 @@ function pg_setclientencoding ($connection, $encoding) {} * was reported. * @link https://php.net/manual/en/pgsql.constants.php */ -define ('PGSQL_DIAG_SOURCE_FILE', 70); +define('PGSQL_DIAG_SOURCE_FILE', 70); /** * Passed to pg_result_error_field. @@ -2111,45 +2111,45 @@ function pg_setclientencoding ($connection, $encoding) {} * error was reported. * @link https://php.net/manual/en/pgsql.constants.php */ -define ('PGSQL_DIAG_SOURCE_LINE', 76); +define('PGSQL_DIAG_SOURCE_LINE', 76); /** * Passed to pg_result_error_field. * The name of the PostgreSQL source-code function reporting the error. * @link https://php.net/manual/en/pgsql.constants.php */ -define ('PGSQL_DIAG_SOURCE_FUNCTION', 82); +define('PGSQL_DIAG_SOURCE_FUNCTION', 82); /** * Passed to pg_convert. * Ignore default values in the table during conversion. * @link https://php.net/manual/en/pgsql.constants.php */ -define ('PGSQL_CONV_IGNORE_DEFAULT', 2); +define('PGSQL_CONV_IGNORE_DEFAULT', 2); /** * Passed to pg_convert. * Use SQL NULL in place of an empty string. * @link https://php.net/manual/en/pgsql.constants.php */ -define ('PGSQL_CONV_FORCE_NULL', 4); +define('PGSQL_CONV_FORCE_NULL', 4); /** * Passed to pg_convert. * Ignore conversion of NULL into SQL NOT NULL columns. * @link https://php.net/manual/en/pgsql.constants.php */ -define ('PGSQL_CONV_IGNORE_NOT_NULL', 8); -define ('PGSQL_DML_NO_CONV', 256); -define ('PGSQL_DML_EXEC', 512); -define ('PGSQL_DML_ASYNC', 1024); -define ('PGSQL_DML_STRING', 2048); +define('PGSQL_CONV_IGNORE_NOT_NULL', 8); +define('PGSQL_DML_NO_CONV', 256); +define('PGSQL_DML_EXEC', 512); +define('PGSQL_DML_ASYNC', 1024); +define('PGSQL_DML_STRING', 2048); /** * @link https://php.net/manual/en/function.pg-last-notice.php * @since 7.1 */ -define ('PGSQL_NOTICE_LAST', 1); +define('PGSQL_NOTICE_LAST', 1); /** * @link https://php.net/manual/en/function.pg-last-notice.php diff --git a/posix/posix.php b/posix/posix.php index 14eabdcec..3b14217fb 100644 --- a/posix/posix.php +++ b/posix/posix.php @@ -14,8 +14,7 @@ * * @return bool TRUE on success or FALSE on failure. */ -function posix_kill (int $process_id, int $signal): bool -{} +function posix_kill(int $process_id, int $signal): bool {} /** * Return the current process identifier @@ -23,8 +22,7 @@ function posix_kill (int $process_id, int $signal): bool * @return int the identifier, as an integer. */ #[Pure] -function posix_getpid (): int -{} +function posix_getpid(): int {} /** * Return the parent process identifier @@ -32,8 +30,7 @@ function posix_getpid (): int * @return int the identifier, as an integer. */ #[Pure] -function posix_getppid (): int -{} +function posix_getppid(): int {} /** * Return the real user ID of the current process @@ -41,8 +38,7 @@ function posix_getppid (): int * @return int the user id, as an integer */ #[Pure] -function posix_getuid (): int -{} +function posix_getuid(): int {} /** * Set the UID of the current process @@ -52,8 +48,7 @@ function posix_getuid (): int * * @return bool TRUE on success or FALSE on failure. */ -function posix_setuid (int $user_id): bool -{} +function posix_setuid(int $user_id): bool {} /** * Return the effective user ID of the current process @@ -61,8 +56,7 @@ function posix_setuid (int $user_id): bool * @return int the user id, as an integer */ #[Pure] -function posix_geteuid (): int -{} +function posix_geteuid(): int {} /** * Set the effective UID of the current process @@ -72,8 +66,7 @@ function posix_geteuid (): int * * @return bool TRUE on success or FALSE on failure. */ -function posix_seteuid (int $user_id): bool -{} +function posix_seteuid(int $user_id): bool {} /** * Set system resource limits @@ -88,16 +81,14 @@ function posix_seteuid (int $user_id): bool * @return bool Returns TRUE on success or FALSE on failure. * @since 7.0 */ -function posix_setrlimit (int $resource, int $soft_limit, int $hard_limit): bool -{} +function posix_setrlimit(int $resource, int $soft_limit, int $hard_limit): bool {} /** * Return the real group ID of the current process * @link https://php.net/manual/en/function.posix-getgid.php * @return int the real group id, as an integer. */ #[Pure] -function posix_getgid (): int -{} +function posix_getgid(): int {} /** * Set the GID of the current process @@ -107,8 +98,7 @@ function posix_getgid (): int * * @return bool TRUE on success or FALSE on failure. */ -function posix_setgid (int $group_id): bool -{} +function posix_setgid(int $group_id): bool {} /** * Return the effective group ID of the current process @@ -116,8 +106,7 @@ function posix_setgid (int $group_id): bool * @return int an integer of the effective group ID. */ #[Pure] -function posix_getegid (): int -{} +function posix_getegid(): int {} /** * Set the effective GID of the current process @@ -127,8 +116,7 @@ function posix_getegid (): int * * @return bool TRUE on success or FALSE on failure. */ -function posix_setegid (int $group_id): bool -{} +function posix_setegid(int $group_id): bool {} /** * Return the group set of the current process @@ -137,8 +125,7 @@ function posix_setegid (int $group_id): bool * set of the current process. */ #[Pure] -function posix_getgroups (): array|false -{} +function posix_getgroups(): array|false {} /** * Return login name @@ -146,8 +133,7 @@ function posix_getgroups (): array|false * @return string|false the login name of the user, as a string. */ #[Pure] -function posix_getlogin (): string|false -{} +function posix_getlogin(): string|false {} /** * Return the current process group identifier @@ -155,16 +141,14 @@ function posix_getlogin (): string|false * @return int the identifier, as an integer. */ #[Pure] -function posix_getpgrp (): int -{} +function posix_getpgrp(): int {} /** * Make the current process a session leader * @link https://php.net/manual/en/function.posix-setsid.php * @return int the session id, or -1 on errors. */ -function posix_setsid (): int -{} +function posix_setsid(): int {} /** * Set process group id for job control @@ -177,8 +161,7 @@ function posix_setsid (): int * * @return bool TRUE on success or FALSE on failure. */ -function posix_setpgid (int $process_id, int $process_group_id): bool -{} +function posix_setpgid(int $process_id, int $process_group_id): bool {} /** * Get process group id for job control @@ -189,8 +172,7 @@ function posix_setpgid (int $process_id, int $process_group_id): bool * @return int|false the identifier, as an integer. */ #[Pure] -function posix_getpgid (int $process_id): int|false -{} +function posix_getpgid(int $process_id): int|false {} /** * Get the current sid of the process @@ -204,8 +186,7 @@ function posix_getpgid (int $process_id): int|false * @return int|false the identifier, as an integer. */ #[Pure] -function posix_getsid (int $process_id): int|false -{} +function posix_getsid(int $process_id): int|false {} /** * Get system name @@ -226,8 +207,7 @@ function posix_getsid (int $process_id): int|false * libc. */ #[Pure] -function posix_uname (): array|false -{} +function posix_uname(): array|false {} /** * Get process times @@ -242,8 +222,7 @@ function posix_uname (): array|false * cstime - system time used by current process and children. */ #[Pure] -function posix_times (): array|false -{} +function posix_times(): array|false {} /** * Get path name of controlling terminal @@ -253,8 +232,7 @@ function posix_times (): array|false * is set, which can be checked with posix_get_last_error. */ #[Pure] -function posix_ctermid (): string|false -{} +function posix_ctermid(): string|false {} /** * Determine terminal device name @@ -266,8 +244,7 @@ function posix_ctermid (): string|false * fd. On failure, returns FALSE */ #[Pure] -function posix_ttyname ($file_descriptor): string|false -{} +function posix_ttyname($file_descriptor): string|false {} /** * Determine if a file descriptor is an interactive terminal @@ -282,8 +259,7 @@ function posix_ttyname ($file_descriptor): string|false * to a terminal and FALSE otherwise. */ #[Pure] -function posix_isatty ($file_descriptor): bool -{} +function posix_isatty($file_descriptor): bool {} /** * Pathname of current directory @@ -293,8 +269,7 @@ function posix_isatty ($file_descriptor): bool * posix_get_last_error. */ #[Pure] -function posix_getcwd (): string|false -{} +function posix_getcwd(): string|false {} /** * Create a fifo special file (a named pipe) @@ -311,8 +286,7 @@ function posix_getcwd (): string|false * * @return bool TRUE on success or FALSE on failure. */ -function posix_mkfifo (string $filename, int $permissions): bool -{} +function posix_mkfifo(string $filename, int $permissions): bool {} /** * Create a special or ordinary file (POSIX.1) @@ -336,8 +310,7 @@ function posix_mkfifo (string $filename, int $permissions): bool * * @return bool TRUE on success or FALSE on failure. */ -function posix_mknod (string $filename, int $flags, int $major = 0, int $minor = 0): bool -{} +function posix_mknod(string $filename, int $flags, int $major = 0, int $minor = 0): bool {} /** * Determine accessibility of a file @@ -359,8 +332,7 @@ function posix_mknod (string $filename, int $flags, int $major = 0, int $minor = * * @return bool TRUE on success or FALSE on failure. */ -function posix_access (string $filename, int $flags = POSIX_F_OK): bool -{} +function posix_access(string $filename, int $flags = POSIX_F_OK): bool {} /** * Return info about a group by name @@ -407,8 +379,7 @@ function posix_access (string $filename, int $flags = POSIX_F_OK): bool * */ #[Pure] -function posix_getgrnam (string $name): array|false -{} +function posix_getgrnam(string $name): array|false {} /** * Return info about a group by group id @@ -457,8 +428,7 @@ function posix_getgrnam (string $name): array|false * */ #[Pure] -function posix_getgrgid (int $group_id): array|false -{} +function posix_getgrgid(int $group_id): array|false {} /** * Return info about a user by username @@ -535,8 +505,7 @@ function posix_getgrgid (int $group_id): array|false * */ #[Pure] -function posix_getpwnam (string $username): array|false -{} +function posix_getpwnam(string $username): array|false {} /** * Return info about a user by user id @@ -612,8 +581,7 @@ function posix_getpwnam (string $username): array|false * */ #[Pure] -function posix_getpwuid (int $user_id): array|false -{} +function posix_getpwuid(int $user_id): array|false {} /** * Return info about system resource limits @@ -698,8 +666,7 @@ function posix_getpwuid (int $user_id): array|false * */ #[Pure] -function posix_getrlimit (): array|false -{} +function posix_getrlimit(): array|false {} /** * Retrieve the error number set by the last posix function that failed @@ -708,15 +675,14 @@ function posix_getrlimit (): array|false * failed. If no errors exist, 0 is returned. */ #[Pure] -function posix_get_last_error (): int -{} +function posix_get_last_error(): int {} /** * Alias of posix_get_last_error * @link https://php.net/manual/en/function.posix-errno.php */ #[Pure] -function posix_errno (): int {} +function posix_errno(): int {} /** * Retrieve the system error message associated with the given errno @@ -729,8 +695,7 @@ function posix_errno (): int {} * @return string the error message, as a string. */ #[Pure] -function posix_strerror (int $error_code): string -{} +function posix_strerror(int $error_code): string {} /** * Calculate the group access list @@ -744,74 +709,72 @@ function posix_strerror (int $error_code): string * @return bool TRUE on success or FALSE on failure. */ #[Pure] -function posix_initgroups (string $username, int $group_id): bool -{} - +function posix_initgroups(string $username, int $group_id): bool {} /** * Check whether the file exists. * @link https://php.net/manual/en/posix.constants.php */ -define ('POSIX_F_OK', 0); +define('POSIX_F_OK', 0); /** * Check whether the file exists and has execute permissions. * @link https://php.net/manual/en/posix.constants.php */ -define ('POSIX_X_OK', 1); +define('POSIX_X_OK', 1); /** * Check whether the file exists and has write permissions. * @link https://php.net/manual/en/posix.constants.php */ -define ('POSIX_W_OK', 2); +define('POSIX_W_OK', 2); /** * Check whether the file exists and has read permissions. * @link https://php.net/manual/en/posix.constants.php */ -define ('POSIX_R_OK', 4); +define('POSIX_R_OK', 4); /** * Normal file * @link https://php.net/manual/en/posix.constants.php */ -define ('POSIX_S_IFREG', 32768); +define('POSIX_S_IFREG', 32768); /** * Character special file * @link https://php.net/manual/en/posix.constants.php */ -define ('POSIX_S_IFCHR', 8192); +define('POSIX_S_IFCHR', 8192); /** * Block special file * @link https://php.net/manual/en/posix.constants.php */ -define ('POSIX_S_IFBLK', 24576); +define('POSIX_S_IFBLK', 24576); /** * FIFO (named pipe) special file * @link https://php.net/manual/en/posix.constants.php */ -define ('POSIX_S_IFIFO', 4096); +define('POSIX_S_IFIFO', 4096); /** * Socket * @link https://php.net/manual/en/posix.constants.php */ -define ('POSIX_S_IFSOCK', 49152); +define('POSIX_S_IFSOCK', 49152); /** * The maximum size of the process's address space in bytes. See also PHP's memory_limit configuration directive. * @link https://php.net/manual/en/posix.constants.setrlimit.php */ -define ('POSIX_RLIMIT_AS', 5); +define('POSIX_RLIMIT_AS', 5); /** * The maximum size of a core file. If the limit is set to 0, no core file will be generated. * @link https://php.net/manual/en/posix.constants.setrlimit.php */ -define ('POSIX_RLIMIT_CORE', 4); +define('POSIX_RLIMIT_CORE', 4); /** * The maximum amount of CPU time that the process can use, in seconds. @@ -820,7 +783,7 @@ function posix_initgroups (string $username, int $group_id): bool * at which point an uncatchable SIGKILL signal is sent. See also set_time_limit(). * @link https://php.net/manual/en/posix.constants.setrlimit.php */ -define ('POSIX_RLIMIT_CPU', 0); +define('POSIX_RLIMIT_CPU', 0); /** * The maximum size of the process's data segment, in bytes. @@ -828,13 +791,13 @@ function posix_initgroups (string $username, int $group_id): bool * the execution of PHP unless an extension is in use that calls brk() or sbrk(). * @link https://php.net/manual/en/posix.constants.setrlimit.php */ -define ('POSIX_RLIMIT_DATA', 2); +define('POSIX_RLIMIT_DATA', 2); /** * The maximum size of files that the process can create, in bytes. * @link https://php.net/manual/en/posix.constants.setrlimit.php */ -define ('POSIX_RLIMIT_FSIZE', 1); +define('POSIX_RLIMIT_FSIZE', 1); /** * The maximum number of locks that the process can create. @@ -880,40 +843,37 @@ function posix_initgroups (string $username, int $group_id): bool * The maximum number of bytes that can be locked into memory. * @link https://php.net/manual/en/posix.constants.setrlimit.php */ -define ('POSIX_RLIMIT_MEMLOCK', 6); +define('POSIX_RLIMIT_MEMLOCK', 6); /** * A value one greater than the maximum file descriptor number that can be opened by this process. * @link https://php.net/manual/en/posix.constants.setrlimit.php */ -define ('POSIX_RLIMIT_NOFILE', 8); +define('POSIX_RLIMIT_NOFILE', 8); /** * The maximum number of processes (and/or threads, on some operating systems) * that can be created for the real user ID of the process. * @link https://php.net/manual/en/posix.constants.setrlimit.php */ -define ('POSIX_RLIMIT_NPROC', 7); +define('POSIX_RLIMIT_NPROC', 7); /** * The maximum size of the process's resident set, in pages. * @link https://php.net/manual/en/posix.constants.setrlimit.php */ -define ('POSIX_RLIMIT_RSS', 5); +define('POSIX_RLIMIT_RSS', 5); /** * The maximum size of the process stack, in bytes. * @link https://php.net/manual/en/posix.constants.setrlimit.php */ -define ('POSIX_RLIMIT_STACK', 3); +define('POSIX_RLIMIT_STACK', 3); /** * Used to indicate an infinite value for a resource limit. * @link https://php.net/manual/en/posix.constants.setrlimit.php */ -define ('POSIX_RLIMIT_INFINITY', 9223372036854775807); - - +define('POSIX_RLIMIT_INFINITY', 9223372036854775807); // End of posix v. -?> diff --git a/pq/pq.php b/pq/pq.php index 1881d1e50..1b5a58083 100644 --- a/pq/pq.php +++ b/pq/pq.php @@ -9,990 +9,1000 @@ * * Fetching simple [multi-dimensional array maps](pq/Result/map). * * Working [Gateway implementation](https://bitbucket.org/m6w6/pq-gateway). */ + namespace pq; + use pq; + /** * Fast import/export using COPY. */ -class COPY { - /** - * Start a COPY operation from STDIN to the PostgreSQL server. - */ - const FROM_STDIN = 0; - /** - * Start a COPY operation from the server to STDOUT. - */ - const TO_STDOUT = 1; - /** - * The connection to the PostgreSQL server. - * - * @public - * @readonly - * @var \pq\Connection - */ - public $connection; - /** - * The expression of the COPY statement used to start the operation. - * - * @public - * @readonly - * @var string - */ - public $expression; - /** - * The drection of the COPY operation (pq\COPY::FROM_STDIN or pq\COPY::TO_STDOUT). - * - * @public - * @readonly - * @var int - */ - public $direction; - /** - * Any additional options used to start the COPY operation. - * - * @public - * @readonly - * @var string - */ - public $options; - /** - * Start a COPY operation. - * - * @param \pq\Connection $conn The connection to use for the COPY operation. - * @param string $expression The expression generating the data to copy. - * @param int $direction Data direction (pq\COPY::FROM_STDIN or pq\COPY::TO_STDOUT). - * @param string $options Any COPY options (see the [official PostgreSQL documentation](http://www.postgresql.org/docs/current/static/sql-copy.html) for details. - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - */ - function __construct(\pq\Connection $conn, string $expression, int $direction, string $options = null) {} - /** - * End the COPY operation to the server during pq\Result::COPY_IN state. - * - * @param string $error If set, the COPY operation will abort with provided message. - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - */ - function end(string $error = null) {} - /** - * Receive data from the server during pq\Result::COPY_OUT state. - * - * @param string &$data Data read from the server. - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - * @return bool success. - */ - function get(string &$data) {} - /** - * Send data to the server during pq\Result::COPY_IN state. - * - * @param string $data Data to send to the server. - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - */ - function put(string $data) {} +class COPY +{ + /** + * Start a COPY operation from STDIN to the PostgreSQL server. + */ + public const FROM_STDIN = 0; + /** + * Start a COPY operation from the server to STDOUT. + */ + public const TO_STDOUT = 1; + /** + * The connection to the PostgreSQL server. + * + * @public + * @readonly + * @var \pq\Connection + */ + public $connection; + /** + * The expression of the COPY statement used to start the operation. + * + * @public + * @readonly + * @var string + */ + public $expression; + /** + * The drection of the COPY operation (pq\COPY::FROM_STDIN or pq\COPY::TO_STDOUT). + * + * @public + * @readonly + * @var int + */ + public $direction; + /** + * Any additional options used to start the COPY operation. + * + * @public + * @readonly + * @var string + */ + public $options; + /** + * Start a COPY operation. + * + * @param \pq\Connection $conn The connection to use for the COPY operation. + * @param string $expression The expression generating the data to copy. + * @param int $direction Data direction (pq\COPY::FROM_STDIN or pq\COPY::TO_STDOUT). + * @param string $options Any COPY options (see the [official PostgreSQL documentation](http://www.postgresql.org/docs/current/static/sql-copy.html) for details. + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + */ + public function __construct(pq\Connection $conn, string $expression, int $direction, string $options = null) {} + /** + * End the COPY operation to the server during pq\Result::COPY_IN state. + * + * @param string $error If set, the COPY operation will abort with provided message. + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + */ + public function end(string $error = null) {} + /** + * Receive data from the server during pq\Result::COPY_OUT state. + * + * @param string &$data Data read from the server. + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + * @return bool success. + */ + public function get(string &$data) {} + /** + * Send data to the server during pq\Result::COPY_IN state. + * + * @param string $data Data to send to the server. + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + */ + public function put(string $data) {} } /** * Request cancellation of an asynchronous query. */ -class Cancel { - /** - * The connection to cancel the query on. - * - * @public - * @readonly - * @var \pq\Connection - */ - public $connection; - /** - * Create a new cancellation request for an [asynchronous](pq/Connection/: Asynchronous Usage) query. - * - * @param \pq\Connection $conn The connection to request cancellation on. - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - */ - function __construct(\pq\Connection $conn) {} - /** - * Perform the cancellation request. - * - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - */ - function cancel() {} +class Cancel +{ + /** + * The connection to cancel the query on. + * + * @public + * @readonly + * @var \pq\Connection + */ + public $connection; + /** + * Create a new cancellation request for an [asynchronous](pq/Connection/: Asynchronous Usage) query. + * + * @param \pq\Connection $conn The connection to request cancellation on. + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + */ + public function __construct(pq\Connection $conn) {} + /** + * Perform the cancellation request. + * + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + */ + public function cancel() {} } /** * The connection to the PostgreSQL server. * * See the [General Usage](pq/Connection/: General Usage) page for an introduction on how to use this class. */ -class Connection { - /** - * (Re-)open a persistent connection. - */ - const PERSISTENT = 2; - /** - * If the connection is not already open, perform the connection attempt [asynchronously](pq/Connection/: Asynchronous Usage). - */ - const ASYNC = 1; - /** - * Everything well; if a connection has been newly and synchronously created, the connection will always have this status right after creation. - */ - const OK = 0; - /** - * Broken connection; consider pq\Connection::reset() or recreation. - */ - const BAD = 1; - /** - * Waiting for connection to be made. - */ - const STARTED = 2; - /** - * Connection okay; waiting to send. - */ - const MADE = 3; - /** - * Waiting for a response from the server. - */ - const AWAITING_RESPONSE = 4; - /** - * Received authentication; waiting for backend start-up to finish. - */ - const AUTH_OK = 5; - /** - * Negotiating SSL encryption. - */ - const SSL_STARTUP = 7; - /** - * Negotiating environment-driven parameter settings. - */ - const SETENV = 6; - /** - * No active transaction. - */ - const TRANS_IDLE = 0; - /** - * A transaction command is in progress. - */ - const TRANS_ACTIVE = 1; - /** - * Idling in a valid transaction block. - */ - const TRANS_INTRANS = 2; - /** - * Idling in a failed transaction block. - */ - const TRANS_INERROR = 3; - /** - * Bad connection. - */ - const TRANS_UNKNOWN = 4; - /** - * The connection procedure has failed. - */ - const POLLING_FAILED = 0; - /** - * Select for read-readiness. - */ - const POLLING_READING = 1; - /** - * Select for write-readiness. - */ - const POLLING_WRITING = 2; - /** - * The connection has been successfully made. - */ - const POLLING_OK = 3; - /** - * Register the event handler for notices. - */ - const EVENT_NOTICE = 'notice'; - /** - * Register the event handler for any created results. - */ - const EVENT_RESULT = 'result'; - /** - * Register the event handler for connection resets. - */ - const EVENT_RESET = 'reset'; - /** - * A [connection status constant](pq/Connection#Connection.Status:) value. - * - * @public - * @readonly - * @var int - */ - public $status; - /** - * A [transaction status constant](pq/Connection#Transaction.Status:) value. - * - * @public - * @readonly - * @var int - */ - public $transactionStatus; - /** - * The server socket resource. - * - * @public - * @readonly - * @var resource - */ - public $socket; - /** - * Whether the connection is busy with [asynchronous operations](pq/Connection/: Asynchronous Usage). - * - * @public - * @readonly - * @var bool - */ - public $busy; - /** - * Any error message on failure. - * - * @public - * @readonly - * @var string - */ - public $errorMessage; - /** - * List of registered event handlers. - * - * @public - * @readonly - * @var array - */ - public $eventHandlers; - /** - * Connection character set. - * - * @public - * @var string - */ - public $encoding = null; - /** - * Whether to fetch [asynchronous](pq/Connection/: Asynchronous Usage) results in unbuffered mode, i.e. each row generates a distinct pq\Result. - * - * @public - * @var bool - */ - public $unbuffered = false; - /** - * Whether to set the underlying socket nonblocking, useful for asynchronous handling of writes. See also pq\Connection::flush(). - * - * ### Connection Information: - * - * @public - * @var bool - */ - public $nonblocking = false; - /** - * The database name of the connection. - * - * @public - * @readonly - * @var string - */ - public $db; - /** - * The user name of the connection. - * - * @public - * @readonly - * @var string - */ - public $user; - /** - * The password of the connection. - * - * @public - * @readonly - * @var string - */ - public $pass; - /** - * The server host name of the connection. - * - * @public - * @readonly - * @var string - */ - public $host; - /** - * The port of the connection. - * - * @public - * @readonly - * @var string - */ - public $port; - /** - * The command-line options passed in the connection request. - * - * ### Inheritable Defaults: - * - * @public - * @readonly - * @var string - */ - public $options; - /** - * Default fetch type for future pq\Result instances. - * - * @public - * @var int - */ - public $defaultFetchType = \pq\Result::FETCH_ARRAY; - /** - * Default conversion bitmask for future pq\Result instances. - * - * @public - * @var int - */ - public $defaultAutoConvert = \pq\Result::CONV_ALL; - /** - * Default transaction isolation level for future pq\Transaction instances. - * - * @public - * @var int - */ - public $defaultTransactionIsolation = \pq\Transaction::READ_COMMITTED; - /** - * Default transaction readonlyness for future pq\Transaction instances. - * - * @public - * @var bool - */ - public $defaultTransactionReadonly = false; - /** - * Default transaction deferrability for future pq\Transaction instances. - * - * @public - * @var bool - */ - public $defaultTransactionDeferrable = false; - /** - * Create a new PostgreSQL connection. - * See also [General Usage](pq/Connection/: General Usage). - * - * @param string $dsn A ***connection string*** as described [in the PostgreSQL documentation](http://www.postgresql.org/docs/current/static/libpq-connect.html#LIBPQ-CONNSTRING). - * @param int $flags See [connection flag constants](pq/Connection#Connection.Flags:). - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - */ - function __construct(string $dsn = "", int $flags = 0) {} - /** - * Declare a cursor for a query. - * - * @param string $name The identifying name of the cursor. - * @param int $flags Any combination of pq\Cursor constants. - * @param string $query The query for which to open a cursor. - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\RuntimeException - * @throws \pq\Exception\BadMethodCallException - * @return \pq\Cursor an open cursor instance. - */ - function declare(string $name, int $flags, string $query) {} - /** - * [Asynchronously](pq/Connection/: Asynchronous Usage) declare a cursor for a query. - * - * > ***NOTE***: - * If pq\Connection::$unbuffered is TRUE, each call to pq\Connection::getResult() will generate a distinct pq\Result containing exactly one row. - * - * @param string $name The identifying name of the cursor. - * @param int $flags Any combination of pq\Cursor constants. - * @param string $query The query for which to open a cursor. - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\RuntimeException - * @throws \pq\Exception\BadMethodCallException - * @return \pq\Cursor an open cursor instance. - */ - function declareAsync(string $name, int $flags, string $query) {} - /** - * Escape binary data for use within a query with the type bytea. - * - * ***NOTE:*** - * The result is not wrapped in single quotes. - * - * @param string $binary The binary data to escape. - * @throws \pq\Exception\BadMethodCallException - * @return string|FALSE string the escaped binary data. - * or FALSE if escaping fails. - */ - function escapeBytea(string $binary) {} - /** - * [Execute one or multiple SQL queries](pq/Connection/: Executing Queries) on the connection. - * - * ***NOTE:*** - * Only the last result will be returned, if the query string contains more than one SQL query. - * - * @param string $query The queries to send to the server, separated by semi-colon. - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - * @throws \pq\Exception\DomainException - * @return \pq\Result - */ - function exec(string $query) {} - /** - * [Asynchronously](pq/Connection/: Asynchronous Usage) [execute an SQL query](pq/Connection: Executing Queries) on the connection. - * - * > ***NOTE***: - * If pq\Connection::$unbuffered is TRUE, each call to pq\Connection::getResult() will generate a distinct pq\Result containing exactly one row. - * - * @param string $query The query to send to the server. - * @param callable $callback as function(pq\Result $res) - * The callback to execute when the query finishes. - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - */ - function execAsync(string $query, callable $callback = null) {} - /** - * [Execute an SQL query](pq/Connection: Executing Queries) with properly escaped parameters substituted. - * - * @param string $query The query to execute. - * @param array $params The parameter list to substitute. - * @param array $types Corresponding list of type OIDs for the parameters. - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\RuntimeException - * @throws \pq\Exception\DomainException - * @return \pq\Result - */ - function execParams(string $query, array $params, array $types = null) {} - /** - * [Asynchronously](pq/Connection/: Asynchronous Usage) [execute an SQL query](pq/Connection: Executing Queries) with properly escaped parameters substituted. - * - * > ***NOTE***: - * If pq\Connection::$unbuffered is TRUE, each call to pq\Connection::getResult() will generate a distinct pq\Result containing exactly one row. - * - * @param string $query The query to execute. - * @param array $params The parameter list to substitute. - * @param array $types Corresponding list of type OIDs for the parameters. - * @param callable $cb as function(\pq\Result $res) : void - * Result handler callback. - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\RuntimeException - * @throws \pq\Exception\BadMethodCallException - */ - function execParamsAsync(string $query, array $params, array $types = null, callable $cb = null) {} - /** - * Flush pending writes on the connection. - * Call after sending any command or data on a nonblocking connection. - * - * If it returns FALSE, wait for the socket to become read or write-ready. - * If it becomes write-ready, call pq\Connection::flush() again. - * If it becomes read-ready, call pq\Connection::poll(), then call pq\Connection::flush() again. - * Repeat until pq\Connection::flush() returns TRUE. - * - * ***NOTE:*** - * This method was added in v1.1.0, resp. v2.1.0. - * - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\RuntimeException - * @return bool whether everything has been flushed. - */ - function flush() {} - /** - * Fetch the result of an [asynchronous](pq/Connection/: Asynchronous Usage) query. - * - * If the query hasn't finished yet, the call will block until the result is available. - * - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @return \pq\Result|null NULL if there has not been a query - * or \pq\Result when the query has finished - */ - function getResult() {} - /** - * Listen on $channel for notifications. - * See pq\Connection::unlisten(). - * - * @param string $channel The channel to listen on. - * @param callable $listener as function(string $channel, string $message, int $pid) - * A callback automatically called whenever a notification on $channel arrives. - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - */ - function listen(string $channel, callable $listener) {} - /** - * [Asynchronously](pq/Connection/: Asynchronous Usage) start listening on $channel for notifications. - * See pq\Connection::listen(). - * - * @param string $channel The channel to listen on. - * @param callable $listener as function(string $channel, string $message, int $pid) - * A callback automatically called whenever a notification on $channel arrives. - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - */ - function listenAsync(string $channel, callable $listener) {} - /** - * Notify all listeners on $channel with $message. - * - * @param string $channel The channel to notify. - * @param string $message The message to send. - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - */ - function notify(string $channel, string $message) {} - /** - * [Asynchronously](pq/Connection/: Asynchronous Usage) start notifying all listeners on $channel with $message. - * - * @param string $channel The channel to notify. - * @param string $message The message to send. - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - */ - function notifyAsync(string $channel, string $message) {} - /** - * Stops listening for an event type. - * - * @param string $event Any pq\Connection::EVENT_*. - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @return bool success. - */ - function off(string $event) {} - /** - * Listen for an event. - * - * @param string $event Any pq\Connection::EVENT_*. - * @param callable $callback as function(pq\Connection $c[, pq\Result $r) - * The callback to invoke on event. - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @return int number of previously attached event listeners. - */ - function on(string $event, callable $callback) {} - /** - * Poll an [asynchronously](pq/Connection/: Asynchronous Usage) operating connection. - * See pq\Connection::resetAsync() for an usage example. - * - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\RuntimeException - * @throws \pq\Exception\BadMethodCallException - * @return int pq\Connection::POLLING_* constant - */ - function poll() {} - /** - * Prepare a named statement for later execution with pq\Statement::execute(). - * - * @param string $name The identifying name of the prepared statement. - * @param string $query The query to prepare. - * @param array $types An array of type OIDs for the substitution parameters. - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - * @return \pq\Statement a prepared statement instance. - */ - function prepare(string $name, string $query, array $types = null) {} - /** - * [Asynchronously](pq/Connection/: Asynchronous Usage) prepare a named statement for later execution with pq\Statement::exec(). - * - * > ***NOTE***: - * If pq\Connection::$unbuffered is TRUE, each call to pq\Connection::getResult() will generate a distinct pq\Result containing exactly one row. - * - * @param string $name The identifying name of the prepared statement. - * @param string $query The query to prepare. - * @param array $types An array of type OIDs for the substitution parameters. - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - * @return \pq\Statement a prepared statement instance. - */ - function prepareAsync(string $name, string $query, array $types = null) {} - /** - * Quote a string for safe use in a query. - * The result is truncated at any zero byte and wrapped in single quotes. - * - * ***NOTE:*** - * Beware of matching character encodings. - * - * @param string $payload The payload to quote for use in a query. - * @throws \pq\Exception\BadMethodCallException - * @return string|FALSE string a single-quote wrapped string safe for literal use in a query. - * or FALSE if quoting fails. - */ - function quote(string $payload) {} - /** - * Quote an identifier for safe usage as name. - * - * ***NOTE:*** - * Beware of case-sensitivity. - * - * @param string $name The name to quote. - * @throws \pq\Exception\BadMethodCallException - * @return string|FALSE string the quoted identifier. - * or FALSE if quoting fails. - */ - function quoteName(string $name) {} - /** - * Attempt to reset a possibly broken connection to a working state. - * - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - */ - function reset() {} - /** - * [Asynchronously](pq/Connection/: Asynchronous Usage) reset a possibly broken connection to a working state. - * - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - */ - function resetAsync() {} - /** - * Set a data type converter. - * - * @param \pq\Converter $converter An instance implementing pq\Converter. - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - */ - function setConverter(\pq\Converter $converter) {} - /** - * Begin a transaction. - * - * @param int $isolation Any pq\Transaction isolation level constant - * (defaults to pq\Connection::$defaultTransactionIsolation). - * @param bool $readonly Whether the transaction executes only reads - * (defaults to pq\Connection::$defaultTransactionReadonly). - * @param bool $deferrable Whether the transaction is deferrable - * (defaults to pq\Connection::$defaultTransactionDeferrable). - * - * ***NOTE:*** - * A transaction can only be deferrable if it also is readonly and serializable. - * See the official [PostgreSQL documentation](http://www.postgresql.org/docs/current/static/sql-set-transaction.html) for further information. +class Connection +{ + /** + * (Re-)open a persistent connection. + */ + public const PERSISTENT = 2; + /** + * If the connection is not already open, perform the connection attempt [asynchronously](pq/Connection/: Asynchronous Usage). + */ + public const ASYNC = 1; + /** + * Everything well; if a connection has been newly and synchronously created, the connection will always have this status right after creation. + */ + public const OK = 0; + /** + * Broken connection; consider pq\Connection::reset() or recreation. + */ + public const BAD = 1; + /** + * Waiting for connection to be made. + */ + public const STARTED = 2; + /** + * Connection okay; waiting to send. + */ + public const MADE = 3; + /** + * Waiting for a response from the server. + */ + public const AWAITING_RESPONSE = 4; + /** + * Received authentication; waiting for backend start-up to finish. + */ + public const AUTH_OK = 5; + /** + * Negotiating SSL encryption. + */ + public const SSL_STARTUP = 7; + /** + * Negotiating environment-driven parameter settings. + */ + public const SETENV = 6; + /** + * No active transaction. + */ + public const TRANS_IDLE = 0; + /** + * A transaction command is in progress. + */ + public const TRANS_ACTIVE = 1; + /** + * Idling in a valid transaction block. + */ + public const TRANS_INTRANS = 2; + /** + * Idling in a failed transaction block. + */ + public const TRANS_INERROR = 3; + /** + * Bad connection. + */ + public const TRANS_UNKNOWN = 4; + /** + * The connection procedure has failed. + */ + public const POLLING_FAILED = 0; + /** + * Select for read-readiness. + */ + public const POLLING_READING = 1; + /** + * Select for write-readiness. + */ + public const POLLING_WRITING = 2; + /** + * The connection has been successfully made. + */ + public const POLLING_OK = 3; + /** + * Register the event handler for notices. + */ + public const EVENT_NOTICE = 'notice'; + /** + * Register the event handler for any created results. + */ + public const EVENT_RESULT = 'result'; + /** + * Register the event handler for connection resets. + */ + public const EVENT_RESET = 'reset'; + /** + * A [connection status constant](pq/Connection#Connection.Status:) value. + * + * @public + * @readonly + * @var int + */ + public $status; + /** + * A [transaction status constant](pq/Connection#Transaction.Status:) value. + * + * @public + * @readonly + * @var int + */ + public $transactionStatus; + /** + * The server socket resource. + * + * @public + * @readonly + * @var resource + */ + public $socket; + /** + * Whether the connection is busy with [asynchronous operations](pq/Connection/: Asynchronous Usage). + * + * @public + * @readonly + * @var bool + */ + public $busy; + /** + * Any error message on failure. + * + * @public + * @readonly + * @var string + */ + public $errorMessage; + /** + * List of registered event handlers. + * + * @public + * @readonly + * @var array + */ + public $eventHandlers; + /** + * Connection character set. + * + * @public + * @var string + */ + public $encoding = null; + /** + * Whether to fetch [asynchronous](pq/Connection/: Asynchronous Usage) results in unbuffered mode, i.e. each row generates a distinct pq\Result. + * + * @public + * @var bool + */ + public $unbuffered = false; + /** + * Whether to set the underlying socket nonblocking, useful for asynchronous handling of writes. See also pq\Connection::flush(). + * + * ### Connection Information: + * + * @public + * @var bool + */ + public $nonblocking = false; + /** + * The database name of the connection. + * + * @public + * @readonly + * @var string + */ + public $db; + /** + * The user name of the connection. + * + * @public + * @readonly + * @var string + */ + public $user; + /** + * The password of the connection. + * + * @public + * @readonly + * @var string + */ + public $pass; + /** + * The server host name of the connection. + * + * @public + * @readonly + * @var string + */ + public $host; + /** + * The port of the connection. + * + * @public + * @readonly + * @var string + */ + public $port; + /** + * The command-line options passed in the connection request. + * + * ### Inheritable Defaults: + * + * @public + * @readonly + * @var string + */ + public $options; + /** + * Default fetch type for future pq\Result instances. + * + * @public + * @var int + */ + public $defaultFetchType = \pq\Result::FETCH_ARRAY; + /** + * Default conversion bitmask for future pq\Result instances. + * + * @public + * @var int + */ + public $defaultAutoConvert = \pq\Result::CONV_ALL; + /** + * Default transaction isolation level for future pq\Transaction instances. + * + * @public + * @var int + */ + public $defaultTransactionIsolation = \pq\Transaction::READ_COMMITTED; + /** + * Default transaction readonlyness for future pq\Transaction instances. + * + * @public + * @var bool + */ + public $defaultTransactionReadonly = false; + /** + * Default transaction deferrability for future pq\Transaction instances. + * + * @public + * @var bool + */ + public $defaultTransactionDeferrable = false; + /** + * Create a new PostgreSQL connection. + * See also [General Usage](pq/Connection/: General Usage). + * + * @param string $dsn A ***connection string*** as described [in the PostgreSQL documentation](http://www.postgresql.org/docs/current/static/libpq-connect.html#LIBPQ-CONNSTRING). + * @param int $flags See [connection flag constants](pq/Connection#Connection.Flags:). + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + */ + public function __construct(string $dsn = "", int $flags = 0) {} + /** + * Declare a cursor for a query. + * + * @param string $name The identifying name of the cursor. + * @param int $flags Any combination of pq\Cursor constants. + * @param string $query The query for which to open a cursor. + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\RuntimeException + * @throws \pq\Exception\BadMethodCallException + * @return \pq\Cursor an open cursor instance. + */ + public function declare(string $name, int $flags, string $query) {} + /** + * [Asynchronously](pq/Connection/: Asynchronous Usage) declare a cursor for a query. + * + * > ***NOTE***: + * If pq\Connection::$unbuffered is TRUE, each call to pq\Connection::getResult() will generate a distinct pq\Result containing exactly one row. + * + * @param string $name The identifying name of the cursor. + * @param int $flags Any combination of pq\Cursor constants. + * @param string $query The query for which to open a cursor. + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\RuntimeException + * @throws \pq\Exception\BadMethodCallException + * @return \pq\Cursor an open cursor instance. + */ + public function declareAsync(string $name, int $flags, string $query) {} + /** + * Escape binary data for use within a query with the type bytea. + * + * ***NOTE:*** + * The result is not wrapped in single quotes. + * + * @param string $binary The binary data to escape. + * @throws \pq\Exception\BadMethodCallException + * @return string|false string the escaped binary data. + * or FALSE if escaping fails. + */ + public function escapeBytea(string $binary) {} + /** + * [Execute one or multiple SQL queries](pq/Connection/: Executing Queries) on the connection. + * + * ***NOTE:*** + * Only the last result will be returned, if the query string contains more than one SQL query. + * + * @param string $query The queries to send to the server, separated by semi-colon. + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + * @throws \pq\Exception\DomainException + * @return \pq\Result + */ + public function exec(string $query) {} + /** + * [Asynchronously](pq/Connection/: Asynchronous Usage) [execute an SQL query](pq/Connection: Executing Queries) on the connection. + * + * > ***NOTE***: + * If pq\Connection::$unbuffered is TRUE, each call to pq\Connection::getResult() will generate a distinct pq\Result containing exactly one row. + * + * @param string $query The query to send to the server. + * @param callable $callback as function(pq\Result $res) + * The callback to execute when the query finishes. + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + */ + public function execAsync(string $query, callable $callback = null) {} + /** + * [Execute an SQL query](pq/Connection: Executing Queries) with properly escaped parameters substituted. + * + * @param string $query The query to execute. + * @param array $params The parameter list to substitute. + * @param array $types Corresponding list of type OIDs for the parameters. + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\RuntimeException + * @throws \pq\Exception\DomainException + * @return \pq\Result + */ + public function execParams(string $query, array $params, array $types = null) {} + /** + * [Asynchronously](pq/Connection/: Asynchronous Usage) [execute an SQL query](pq/Connection: Executing Queries) with properly escaped parameters substituted. + * + * > ***NOTE***: + * If pq\Connection::$unbuffered is TRUE, each call to pq\Connection::getResult() will generate a distinct pq\Result containing exactly one row. + * + * @param string $query The query to execute. + * @param array $params The parameter list to substitute. + * @param array $types Corresponding list of type OIDs for the parameters. + * @param callable $cb as function(\pq\Result $res) : void + * Result handler callback. + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\RuntimeException + * @throws \pq\Exception\BadMethodCallException + */ + public function execParamsAsync(string $query, array $params, array $types = null, callable $cb = null) {} + /** + * Flush pending writes on the connection. + * Call after sending any command or data on a nonblocking connection. + * + * If it returns FALSE, wait for the socket to become read or write-ready. + * If it becomes write-ready, call pq\Connection::flush() again. + * If it becomes read-ready, call pq\Connection::poll(), then call pq\Connection::flush() again. + * Repeat until pq\Connection::flush() returns TRUE. + * + * ***NOTE:*** + * This method was added in v1.1.0, resp. v2.1.0. + * + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\RuntimeException + * @return bool whether everything has been flushed. + */ + public function flush() {} + /** + * Fetch the result of an [asynchronous](pq/Connection/: Asynchronous Usage) query. + * + * If the query hasn't finished yet, the call will block until the result is available. + * + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @return \pq\Result|null NULL if there has not been a query + * or \pq\Result when the query has finished + */ + public function getResult() {} + /** + * Listen on $channel for notifications. + * See pq\Connection::unlisten(). + * + * @param string $channel The channel to listen on. + * @param callable $listener as function(string $channel, string $message, int $pid) + * A callback automatically called whenever a notification on $channel arrives. + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + */ + public function listen(string $channel, callable $listener) {} + /** + * [Asynchronously](pq/Connection/: Asynchronous Usage) start listening on $channel for notifications. + * See pq\Connection::listen(). + * + * @param string $channel The channel to listen on. + * @param callable $listener as function(string $channel, string $message, int $pid) + * A callback automatically called whenever a notification on $channel arrives. + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + */ + public function listenAsync(string $channel, callable $listener) {} + /** + * Notify all listeners on $channel with $message. + * + * @param string $channel The channel to notify. + * @param string $message The message to send. + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + */ + public function notify(string $channel, string $message) {} + /** + * [Asynchronously](pq/Connection/: Asynchronous Usage) start notifying all listeners on $channel with $message. + * + * @param string $channel The channel to notify. + * @param string $message The message to send. + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + */ + public function notifyAsync(string $channel, string $message) {} + /** + * Stops listening for an event type. + * + * @param string $event Any pq\Connection::EVENT_*. + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @return bool success. + */ + public function off(string $event) {} + /** + * Listen for an event. + * + * @param string $event Any pq\Connection::EVENT_*. + * @param callable $callback as function(pq\Connection $c[, pq\Result $r) + * The callback to invoke on event. + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @return int number of previously attached event listeners. + */ + public function on(string $event, callable $callback) {} + /** + * Poll an [asynchronously](pq/Connection/: Asynchronous Usage) operating connection. + * See pq\Connection::resetAsync() for an usage example. + * + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\RuntimeException + * @throws \pq\Exception\BadMethodCallException + * @return int pq\Connection::POLLING_* constant + */ + public function poll() {} + /** + * Prepare a named statement for later execution with pq\Statement::execute(). + * + * @param string $name The identifying name of the prepared statement. + * @param string $query The query to prepare. + * @param array $types An array of type OIDs for the substitution parameters. + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + * @return \pq\Statement a prepared statement instance. + */ + public function prepare(string $name, string $query, array $types = null) {} + /** + * [Asynchronously](pq/Connection/: Asynchronous Usage) prepare a named statement for later execution with pq\Statement::exec(). + * + * > ***NOTE***: + * If pq\Connection::$unbuffered is TRUE, each call to pq\Connection::getResult() will generate a distinct pq\Result containing exactly one row. + * + * @param string $name The identifying name of the prepared statement. + * @param string $query The query to prepare. + * @param array $types An array of type OIDs for the substitution parameters. + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + * @return \pq\Statement a prepared statement instance. + */ + public function prepareAsync(string $name, string $query, array $types = null) {} + /** + * Quote a string for safe use in a query. + * The result is truncated at any zero byte and wrapped in single quotes. + * + * ***NOTE:*** + * Beware of matching character encodings. + * + * @param string $payload The payload to quote for use in a query. + * @throws \pq\Exception\BadMethodCallException + * @return string|false string a single-quote wrapped string safe for literal use in a query. + * or FALSE if quoting fails. + */ + public function quote(string $payload) {} + /** + * Quote an identifier for safe usage as name. + * + * ***NOTE:*** + * Beware of case-sensitivity. + * + * @param string $name The name to quote. + * @throws \pq\Exception\BadMethodCallException + * @return string|false string the quoted identifier. + * or FALSE if quoting fails. + */ + public function quoteName(string $name) {} + /** + * Attempt to reset a possibly broken connection to a working state. + * + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + */ + public function reset() {} + /** + * [Asynchronously](pq/Connection/: Asynchronous Usage) reset a possibly broken connection to a working state. + * + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + */ + public function resetAsync() {} + /** + * Set a data type converter. + * + * @param \pq\Converter $converter An instance implementing pq\Converter. + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + */ + public function setConverter(pq\Converter $converter) {} + /** + * Begin a transaction. + * + * @param int $isolation Any pq\Transaction isolation level constant + * (defaults to pq\Connection::$defaultTransactionIsolation). + * @param bool $readonly Whether the transaction executes only reads + * (defaults to pq\Connection::$defaultTransactionReadonly). + * @param bool $deferrable Whether the transaction is deferrable + * (defaults to pq\Connection::$defaultTransactionDeferrable). + * + * ***NOTE:*** + * A transaction can only be deferrable if it also is readonly and serializable. + * See the official [PostgreSQL documentation](http://www.postgresql.org/docs/current/static/sql-set-transaction.html) for further information. * * @return \pq\Transaction a begun transaction instance. - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - * @throws \pq\Exception\InvalidArgumentException - */ - function startTransaction(int $isolation = \pq\Transaction::READ_COMMITTED, bool $readonly = false, bool $deferrable = false) {} - /** - * [Asynchronously](pq/Connection/: Asynchronous Usage) begin a transaction. - * - * @param int $isolation Any pq\Transaction isolation level constant - * (defaults to pq\Connection::$defaultTransactionIsolation). - * @param bool $readonly Whether the transaction executes only reads - * (defaults to pq\Connection::$defaultTransactionReadonly). - * @param bool $deferrable Whether the transaction is deferrable - * (defaults to pq\Connection::$defaultTransactionDeferrable). - * - * ***NOTE:*** - * A transaction can only be deferrable if it also is readonly and serializable. - * See the official [PostgreSQL documentation](http://www.postgresql.org/docs/current/static/sql-set-transaction.html) for further information. + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + * @throws \pq\Exception\InvalidArgumentException + */ + public function startTransaction(int $isolation = \pq\Transaction::READ_COMMITTED, bool $readonly = false, bool $deferrable = false) {} + /** + * [Asynchronously](pq/Connection/: Asynchronous Usage) begin a transaction. + * + * @param int $isolation Any pq\Transaction isolation level constant + * (defaults to pq\Connection::$defaultTransactionIsolation). + * @param bool $readonly Whether the transaction executes only reads + * (defaults to pq\Connection::$defaultTransactionReadonly). + * @param bool $deferrable Whether the transaction is deferrable + * (defaults to pq\Connection::$defaultTransactionDeferrable). + * + * ***NOTE:*** + * A transaction can only be deferrable if it also is readonly and serializable. + * See the official [PostgreSQL documentation](http://www.postgresql.org/docs/current/static/sql-set-transaction.html) for further information. * * @return \pq\Transaction an asynchronously begun transaction instance. - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - * @throws \pq\Exception\InvalidArgumentException - */ - function startTransactionAsync(int $isolation = \pq\Transaction::READ_COMMITTED, bool $readonly = false, bool $deferrable = false) {} - /** - * Trace protocol communication with the server. - * - * ***NOTE:*** - * Calling pq\Connection::trace() without argument or NULL stops tracing. - * - * @param resource $stream The resource to which the protocol trace will be output. - * (The stream must be castable to STDIO). - * @throws \pq\Exception\BadMethodCallException - * @return bool success. - */ - function trace($stream = null) {} - /** - * Unescape bytea data retrieved from the server. - * - * @param string $bytea Bytea data retrieved from the server. - * @throws \pq\Exception\BadMethodCallException - * @return string|FALSE string unescaped binary data. - * or FALSE if unescaping fails. - */ - function unescapeBytea(string $bytea) {} - /** - * Stop listening for notifications on channel $channel. - * See pq\Connection::listen(). - * - * @param string $channel The name of a channel which is currently listened on. - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - */ - function unlisten(string $channel) {} - /** - * [Asynchronously](pq/Connection/: Asynchronous Usage) stop listening for notifications on channel $channel. - * See pq\Connection::unlisten() and pq\Connection::listenAsync(). - * - * @param string $channel The name of a channel which is currently listened on. - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - */ - function unlistenAsync(string $channel) {} - /** - * Stop applying a data type converter. - * - * @param \pq\Converter $converter A converter previously set with pq\Connection::setConverter(). - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - */ - function unsetConverter(\pq\Converter $converter) {} + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + * @throws \pq\Exception\InvalidArgumentException + */ + public function startTransactionAsync(int $isolation = \pq\Transaction::READ_COMMITTED, bool $readonly = false, bool $deferrable = false) {} + /** + * Trace protocol communication with the server. + * + * ***NOTE:*** + * Calling pq\Connection::trace() without argument or NULL stops tracing. + * + * @param resource $stream The resource to which the protocol trace will be output. + * (The stream must be castable to STDIO). + * @throws \pq\Exception\BadMethodCallException + * @return bool success. + */ + public function trace($stream = null) {} + /** + * Unescape bytea data retrieved from the server. + * + * @param string $bytea Bytea data retrieved from the server. + * @throws \pq\Exception\BadMethodCallException + * @return string|false string unescaped binary data. + * or FALSE if unescaping fails. + */ + public function unescapeBytea(string $bytea) {} + /** + * Stop listening for notifications on channel $channel. + * See pq\Connection::listen(). + * + * @param string $channel The name of a channel which is currently listened on. + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + */ + public function unlisten(string $channel) {} + /** + * [Asynchronously](pq/Connection/: Asynchronous Usage) stop listening for notifications on channel $channel. + * See pq\Connection::unlisten() and pq\Connection::listenAsync(). + * + * @param string $channel The name of a channel which is currently listened on. + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + */ + public function unlistenAsync(string $channel) {} + /** + * Stop applying a data type converter. + * + * @param \pq\Converter $converter A converter previously set with pq\Connection::setConverter(). + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + */ + public function unsetConverter(pq\Converter $converter) {} } /** * Interface for type conversions. */ -interface Converter { - /** - * Convert a string received from the PostgreSQL server back to a PHP type. - * - * @param string $data String data received from the server. - * @param int $type The type OID of the data. Irrelevant for single-type converters. - * @return mixed the value converted to a PHP type. - */ - function convertFromString(string $data, int $type); - /** - * Convert a value to a string for use in a query. - * - * @param mixed $value The PHP value which should be converted to a string. - * @param int $type The type OID the converter should handle. Irrelevant for singly-type converters. - * @return string a textual representation of the value accepted by the PostgreSQL server. - */ - function convertToString($value, int $type); - /** - * Announce which types the implementing converter can handle. - * - * @return array OIDs of handled types. - */ - function convertTypes(); +interface Converter +{ + /** + * Convert a string received from the PostgreSQL server back to a PHP type. + * + * @param string $data String data received from the server. + * @param int $type The type OID of the data. Irrelevant for single-type converters. + * @return mixed the value converted to a PHP type. + */ + public function convertFromString(string $data, int $type); + /** + * Convert a value to a string for use in a query. + * + * @param mixed $value The PHP value which should be converted to a string. + * @param int $type The type OID the converter should handle. Irrelevant for singly-type converters. + * @return string a textual representation of the value accepted by the PostgreSQL server. + */ + public function convertToString($value, int $type); + /** + * Announce which types the implementing converter can handle. + * + * @return array OIDs of handled types. + */ + public function convertTypes(); } /** * Declare a cursor. */ -class Cursor { - /** - * Causes the cursor to return data in binary rather than in text format. You probably do not want to use that. - */ - const BINARY = 1; - /** - * The data returned by the cursor should be unaffected by updates to the tables underlying the cursor that take place after the cursor was opened. - */ - const INSENSITIVE = 2; - /** - * The cursor should stay usable after the transaction that created it was successfully committed. - */ - const WITH_HOLD = 4; - /** - * Force that rows can be retrieved in any order from the cursor. - */ - const SCROLL = 16; - /** - * Force that rows are only retrievable in sequiential order. - * - * ***NOTE:*** - * See the [notes in the official PostgreSQL documentation](http://www.postgresql.org/docs/current/static/sql-declare.html#SQL-DECLARE-NOTES) for more information. - */ - const NO_SCROLL = 32; - /** - * The connection the cursor was declared on. - * - * @public - * @readonly - * @var \pq\Connection - */ - public $connection; - /** - * The identifying name of the cursor. - * - * @public - * @readonly - * @var string - */ - public $name; - /** - * Declare a cursor. - * See pq\Connection::declare(). - * - * @param \pq\Connection $connection The connection on which the cursor should be declared. - * @param string $name The name of the cursor. - * @param int $flags See pq\Cursor constants. - * @param string $query The query for which the cursor should be opened. - * @param bool $async Whether to declare the cursor [asynchronously](pq/Connection/: Asynchronous Usage). - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - */ - function __construct(\pq\Connection $connection, string $name, int $flags, string $query, bool $async) {} - /** - * Close an open cursor. - * This is a no-op on already closed cursors. - * - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - */ - function close() {} - /** - * [Asynchronously](pq/Connection/: Asynchronous Usage) close an open cursor. - * See pq\Cursor::close(). - * - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - */ - function closeAsync() {} - /** - * Fetch rows from the cursor. - * See pq\Cursor::move(). - * - * @param string $spec What to fetch. - * - * ### Fetch argument: - * - * FETCH and MOVE usually accepts arguments like the following, where `count` is the number of rows: - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - * @return \pq\Result the fetched row(s). - */ - function fetch(string $spec = "1") {} - /** - * [Asynchronously](pq/Connection/: Asynchronous Usage) fetch rows from the cursor. - * See pq\Cursor::fetch(). - * - * @param string $spec What to fetch. - * @param callable $callback as function(pq\Result $res) - * A callback to execute when the result is ready. - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - */ - function fetchAsync(string $spec = "1", callable $callback = null) {} - /** - * Move the cursor. - * See pq\Cursor::fetch(). - * - * @param string $spec What to fetch. - * - * ### Fetch argument: - * - * FETCH and MOVE usually accepts arguments like the following, where `count` is the number of rows: - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - * @return \pq\Result command status. - */ - function move(string $spec = "1") {} - /** - * [Asynchronously](pq/Connection/: Asynchronous Usage) move the cursor. - * See pq\Cursor::move(). - * - * @param string $spec What to fetch. - * @param callable $callback as function(pq\Result $res) - * A callback to execute when the command completed. - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - */ - function moveAsync(string $spec = "1", callable $callback = null) {} - /** - * Reopen a cursor. - * This is a no-op on already open cursors. - * - * ***NOTE:*** - * Only cursors closed by pq\Cursor::close() will be reopened. - * - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - */ - function open() {} - /** - * [Asynchronously](pq/Connection/: Asynchronous Usage) reopen a cursor. - * See pq\Cursor::open(). - * - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - */ - function openAsync() {} +class Cursor +{ + /** + * Causes the cursor to return data in binary rather than in text format. You probably do not want to use that. + */ + public const BINARY = 1; + /** + * The data returned by the cursor should be unaffected by updates to the tables underlying the cursor that take place after the cursor was opened. + */ + public const INSENSITIVE = 2; + /** + * The cursor should stay usable after the transaction that created it was successfully committed. + */ + public const WITH_HOLD = 4; + /** + * Force that rows can be retrieved in any order from the cursor. + */ + public const SCROLL = 16; + /** + * Force that rows are only retrievable in sequiential order. + * + * ***NOTE:*** + * See the [notes in the official PostgreSQL documentation](http://www.postgresql.org/docs/current/static/sql-declare.html#SQL-DECLARE-NOTES) for more information. + */ + public const NO_SCROLL = 32; + /** + * The connection the cursor was declared on. + * + * @public + * @readonly + * @var \pq\Connection + */ + public $connection; + /** + * The identifying name of the cursor. + * + * @public + * @readonly + * @var string + */ + public $name; + /** + * Declare a cursor. + * See pq\Connection::declare(). + * + * @param \pq\Connection $connection The connection on which the cursor should be declared. + * @param string $name The name of the cursor. + * @param int $flags See pq\Cursor constants. + * @param string $query The query for which the cursor should be opened. + * @param bool $async Whether to declare the cursor [asynchronously](pq/Connection/: Asynchronous Usage). + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + */ + public function __construct(pq\Connection $connection, string $name, int $flags, string $query, bool $async) {} + /** + * Close an open cursor. + * This is a no-op on already closed cursors. + * + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + */ + public function close() {} + /** + * [Asynchronously](pq/Connection/: Asynchronous Usage) close an open cursor. + * See pq\Cursor::close(). + * + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + */ + public function closeAsync() {} + /** + * Fetch rows from the cursor. + * See pq\Cursor::move(). + * + * @param string $spec What to fetch. + * + * ### Fetch argument: + * + * FETCH and MOVE usually accepts arguments like the following, where `count` is the number of rows: + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + * @return \pq\Result the fetched row(s). + */ + public function fetch(string $spec = "1") {} + /** + * [Asynchronously](pq/Connection/: Asynchronous Usage) fetch rows from the cursor. + * See pq\Cursor::fetch(). + * + * @param string $spec What to fetch. + * @param callable $callback as function(pq\Result $res) + * A callback to execute when the result is ready. + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + */ + public function fetchAsync(string $spec = "1", callable $callback = null) {} + /** + * Move the cursor. + * See pq\Cursor::fetch(). + * + * @param string $spec What to fetch. + * + * ### Fetch argument: + * + * FETCH and MOVE usually accepts arguments like the following, where `count` is the number of rows: + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + * @return \pq\Result command status. + */ + public function move(string $spec = "1") {} + /** + * [Asynchronously](pq/Connection/: Asynchronous Usage) move the cursor. + * See pq\Cursor::move(). + * + * @param string $spec What to fetch. + * @param callable $callback as function(pq\Result $res) + * A callback to execute when the command completed. + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + */ + public function moveAsync(string $spec = "1", callable $callback = null) {} + /** + * Reopen a cursor. + * This is a no-op on already open cursors. + * + * ***NOTE:*** + * Only cursors closed by pq\Cursor::close() will be reopened. + * + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + */ + public function open() {} + /** + * [Asynchronously](pq/Connection/: Asynchronous Usage) reopen a cursor. + * See pq\Cursor::open(). + * + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + */ + public function openAsync() {} } /** * A simple DateTime wrapper with predefined formats which supports stringification and JSON. */ -class DateTime extends \DateTime implements \JsonSerializable { - /** - * The default format of any date/time type automatically converted by pq\Result (depends on the actual type of the column). - * - * @public - * @var string - */ - public $format = "Y-m-d H:i:s.uO"; - /** - * Stringify the DateTime instance according to pq\DateTime::$format. - * - * @return string the DateTime as string. - */ - function __toString() {} - /** - * Serialize to JSON. - * Alias of pq\DateTime::__toString(). - * - * @return string the DateTime stringified according to pq\DateTime::$format. - */ - function jsonSerialize() {} +class DateTime extends \DateTime implements \JsonSerializable +{ + /** + * The default format of any date/time type automatically converted by pq\Result (depends on the actual type of the column). + * + * @public + * @var string + */ + public $format = "Y-m-d H:i:s.uO"; + /** + * Stringify the DateTime instance according to pq\DateTime::$format. + * + * @return string the DateTime as string. + */ + public function __toString() {} + /** + * Serialize to JSON. + * Alias of pq\DateTime::__toString(). + * + * @return string the DateTime stringified according to pq\DateTime::$format. + */ + public function jsonSerialize() {} } /** * A base interface for all pq\Exception classes. */ -interface Exception { - /** - * An invalid argument was passed to a method (pq\Exception\InvalidArgumentException). - */ - const INVALID_ARGUMENT = 0; - /** - * A runtime exception occurred (pq\Exception\RuntimeException). - */ - const RUNTIME = 1; - /** - * The connection failed (pq\Exception\RuntimeException). - */ - const CONNECTION_FAILED = 2; - /** - * An input/output exception occurred (pq\Exception\RuntimeException). - */ - const IO = 3; - /** - * Escaping an argument or identifier failed internally (pq\Exception\RuntimeException). - */ - const ESCAPE = 4; - /** - * An object's constructor was not called (pq\Exception\BadMethodCallException). - */ - const UNINITIALIZED = 6; - /** - * Calling this method was not expected (yet) (pq\Exception\BadMethodCallException). - */ - const BAD_METHODCALL = 5; - /** - * SQL syntax error (pq\Exception\DomainException). - */ - const SQL = 8; - /** - * Implementation domain error (pq\Exception\DomainException). - */ - const DOMAIN = 7; +interface Exception +{ + /** + * An invalid argument was passed to a method (pq\Exception\InvalidArgumentException). + */ + public const INVALID_ARGUMENT = 0; + /** + * A runtime exception occurred (pq\Exception\RuntimeException). + */ + public const RUNTIME = 1; + /** + * The connection failed (pq\Exception\RuntimeException). + */ + public const CONNECTION_FAILED = 2; + /** + * An input/output exception occurred (pq\Exception\RuntimeException). + */ + public const IO = 3; + /** + * Escaping an argument or identifier failed internally (pq\Exception\RuntimeException). + */ + public const ESCAPE = 4; + /** + * An object's constructor was not called (pq\Exception\BadMethodCallException). + */ + public const UNINITIALIZED = 6; + /** + * Calling this method was not expected (yet) (pq\Exception\BadMethodCallException). + */ + public const BAD_METHODCALL = 5; + /** + * SQL syntax error (pq\Exception\DomainException). + */ + public const SQL = 8; + /** + * Implementation domain error (pq\Exception\DomainException). + */ + public const DOMAIN = 7; } /** * A *large object*. @@ -1000,496 +1010,499 @@ interface Exception { * ***NOTE:*** * Working with *large objects* requires an active transaction. */ -class LOB { - /** - * 0, representing an invalid OID. - */ - const INVALID_OID = 0; - /** - * Read/write mode. - */ - const RW = 393216; - /** - * The transaction wrapping the operations on the *large object*. - * - * @public - * @readonly - * @var \pq\Transaction - */ - public $transaction; - /** - * The OID of the *large object*. - * - * @public - * @readonly - * @var int - */ - public $oid; - /** - * The stream connected to the *large object*. - * - * @public - * @readonly - * @var resource - */ - public $stream; - /** - * Open or create a *large object*. - * See pq\Transaction::openLOB() and pq\Transaction::createLOB(). - * - * @param \pq\Transaction $txn The transaction which wraps the *large object* operations. - * @param int $oid The OID of the existing *large object* to open. - * @param int $mode Access mode (read, write or read/write). - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - */ - function __construct(\pq\Transaction $txn, int $oid = \pq\LOB::INVALID_OID, int $mode = \pq\LOB::RW) {} - /** - * Read a string of data from the current position of the *large object*. - * - * @param int $length The amount of bytes to read from the *large object*. - * @param int &$read The amount of bytes actually read from the *large object*. - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - * @return string the data read. - */ - function read(int $length = 0x1000, int &$read = null) {} - /** - * Seek to a position within the *large object*. - * - * @param int $offset The position to seek to. - * @param int $whence From where to seek (SEEK_SET, SEEK_CUR or SEEK_END). - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - * @return int the new position. - */ - function seek(int $offset, int $whence = SEEK_SET) {} - /** - * Retrieve the current position within the *large object*. - * - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - * @return int the current position. - */ - function tell() {} - /** - * Truncate the *large object*. - * - * @param int $length The length to truncate to. - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - */ - function truncate(int $length = 0) {} - /** - * Write data to the *large object*. - * - * @param string $data The data that should be written to the current position. - * @return int the number of bytes written. - */ - function write(string $data) {} +class LOB +{ + /** + * 0, representing an invalid OID. + */ + public const INVALID_OID = 0; + /** + * Read/write mode. + */ + public const RW = 393216; + /** + * The transaction wrapping the operations on the *large object*. + * + * @public + * @readonly + * @var \pq\Transaction + */ + public $transaction; + /** + * The OID of the *large object*. + * + * @public + * @readonly + * @var int + */ + public $oid; + /** + * The stream connected to the *large object*. + * + * @public + * @readonly + * @var resource + */ + public $stream; + /** + * Open or create a *large object*. + * See pq\Transaction::openLOB() and pq\Transaction::createLOB(). + * + * @param \pq\Transaction $txn The transaction which wraps the *large object* operations. + * @param int $oid The OID of the existing *large object* to open. + * @param int $mode Access mode (read, write or read/write). + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + */ + public function __construct(pq\Transaction $txn, int $oid = \pq\LOB::INVALID_OID, int $mode = \pq\LOB::RW) {} + /** + * Read a string of data from the current position of the *large object*. + * + * @param int $length The amount of bytes to read from the *large object*. + * @param int &$read The amount of bytes actually read from the *large object*. + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + * @return string the data read. + */ + public function read(int $length = 0x1000, int &$read = null) {} + /** + * Seek to a position within the *large object*. + * + * @param int $offset The position to seek to. + * @param int $whence From where to seek (SEEK_SET, SEEK_CUR or SEEK_END). + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + * @return int the new position. + */ + public function seek(int $offset, int $whence = SEEK_SET) {} + /** + * Retrieve the current position within the *large object*. + * + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + * @return int the current position. + */ + public function tell() {} + /** + * Truncate the *large object*. + * + * @param int $length The length to truncate to. + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + */ + public function truncate(int $length = 0) {} + /** + * Write data to the *large object*. + * + * @param string $data The data that should be written to the current position. + * @return int the number of bytes written. + */ + public function write(string $data) {} } /** * A query result. * * See [Fetching Results](pq/Result/: Fetching Results) for a general overview. */ -class Result implements \Traversable, \Countable { - /** - * The query sent to the server was empty. - */ - const EMPTY_QUERY = 0; - /** - * The query did not generate a result set and completed successfully. - */ - const COMMAND_OK = 1; - /** - * The query successfully generated a result set. - */ - const TUPLES_OK = 2; - /** - * The result contains a single row of the result set when using pq\Connection::$unbuffered. - */ - const SINGLE_TUPLE = 9; - /** - * COPY data can be received from the server. - */ - const COPY_OUT = 3; - /** - * COPY data can be sent to the server. - */ - const COPY_IN = 4; - /** - * COPY in/out data transfer in progress. - */ - const COPY_BOTH = 8; - /** - * The server sent a bad response. - */ - const BAD_RESPONSE = 5; - /** - * A nonfatal error (notice or warning) occurred. - */ - const NONFATAL_ERROR = 6; - /** - * A fatal error occurred. - */ - const FATAL_ERROR = 7; - /** - * Fetch rows numerically indexed, where the index start with 0. - */ - const FETCH_ARRAY = 0; - /** - * Fetch rows associatively indexed by column name. - */ - const FETCH_ASSOC = 1; - /** - * Fetch rows as stdClass instance, where the column names are the property names. - */ - const FETCH_OBJECT = 2; - /** - * Automatically convert 'f' and 't' to FALSE and TRUE and vice versa. - */ - const CONV_BOOL = 1; - /** - * Automatically convert integral strings to either int if it fits into maximum integer size or else to float and vice versa. - */ - const CONV_INT = 2; - /** - * Automatically convert floating point numbers. - */ - const CONV_FLOAT = 4; - /** - * Do all scalar conversions listed above. - */ - const CONV_SCALAR = 15; - /** - * Automatically convert arrays. - */ - const CONV_ARRAY = 16; - /** - * Automatically convert date strings to pq\DateTime and vice versa. - */ - const CONV_DATETIME = 32; - /** - * Automatically convert JSON. - */ - const CONV_JSON = 256; - /** - * Do all of the above. - */ - const CONV_ALL = 65535; - /** - * A [status constant](pq/Result#Status.values:). - * - * @public - * @readonly - * @var int - */ - public $status; - /** - * The accompanying status message. - * - * @public - * @readonly - * @var string - */ - public $statusMessage; - /** - * Any error message if $status indicates an error. - * - * @public - * @readonly - * @var string - */ - public $errorMessage; - /** - * The number of rows in the result set. - * - * @public - * @readonly - * @var int - */ - public $numRows; - /** - * The number of fields in a single tuple of the result set. - * - * @public - * @readonly - * @var int - */ - public $numCols; - /** - * The number of rows affected by a statement. - * - * @public - * @readonly - * @var int - */ - public $affectedRows; - /** - * Error details. See [PQresultErrorField](https://www.postgresql.org/docs/current/static/libpq-exec.html#LIBPQ-PQRESULTERRORFIELD) docs. - * - * @public - * @readonly - * @var array - */ - public $diag; - /** - * The [type of return value](pq/Result#Fetch.types:) the fetch methods should return when no fetch type argument was given. Defaults to pq\Connection::$defaultFetchType. - * - * @public - * @var int - */ - public $fetchType = \pq\Result::FETCH_ARRAY; - /** - * What [type of conversions](pq/Result#Conversion.bits:) to perform automatically. - * - * @public - * @var int - */ - public $autoConvert = \pq\Result::CONV_ALL; - /** - * Bind a variable to a result column. - * See pq\Result::fetchBound(). - * - * @param mixed $col The column name or index to bind to. - * @param mixed $var The variable reference. - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @return bool success. - */ - function bind($col, $var) {} - /** - * Count number of rows in this result set. - * - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @return int the number of rows. - */ - function count() {} - /** - * Describe a prepared statement. - * - * ***NOTE:*** - * This will only return meaningful information for a result of pq\Statement::desc(). - * - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @return array list of parameter type OIDs for the prepared statement. - */ - function desc() {} - /** - * Fetch all rows at once. - * - * @param int $fetch_type The type the return value should have, see pq\Result::FETCH_* constants, defaults to pq\Result::$fetchType. - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @return array all fetched rows. - */ - function fetchAll(int $fetch_type = null) {} - /** - * Fetch all rows of a single column. - * - * @param int $col The column name or index to fetch. - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - * @return array list of column values. - */ - function fetchAllCols(int $col = 0) {} - /** - * Iteratively fetch a row into bound variables. - * See pq\Result::bind(). - * - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - * @return array|null array the fetched row as numerically indexed array. - * or NULL when iteration ends. - */ - function fetchBound() {} - /** - * Iteratively fetch a single column. - * - * @param mixed $ref The variable where the column value will be stored in. - * @param mixed $col The column name or index. - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - * @return bool|null bool success. - * or NULL when iteration ends. - */ - function fetchCol($ref, $col = 0) {} - /** - * Iteratively fetch a row. - * - * @param int $fetch_type The type the return value should have, see pq\Result::FETCH_* constants, defaults to pq\Result::$fetchType. - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - * @return array|array|object|null array numerically indexed for pq\Result::FETCH_ARRAY - * or array associatively indexed for pq\Result::FETCH_ASSOC - * or object stdClass instance for pq\Result::FETCH_OBJECT - * or NULL when iteration ends. - */ - function fetchRow(int $fetch_type = null) {} - /** - * Fetch the complete result set as a simple map, a *multi dimensional array*, each dimension indexed by a column. - * - * @param mixed $keys The the column indices/names used to index the map. - * @param mixed $vals The column indices/names which should build up the leaf entry of the map. - * @param int $fetch_type The type the return value should have, see pq\Result::FETCH_* constants, defaults to pq\Result::$fetchType. - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - * @return array |object, the mapped columns. - */ - function map($keys = 0, $vals = null, int $fetch_type = null) {} +class Result implements \Traversable, \Countable +{ + /** + * The query sent to the server was empty. + */ + public const EMPTY_QUERY = 0; + /** + * The query did not generate a result set and completed successfully. + */ + public const COMMAND_OK = 1; + /** + * The query successfully generated a result set. + */ + public const TUPLES_OK = 2; + /** + * The result contains a single row of the result set when using pq\Connection::$unbuffered. + */ + public const SINGLE_TUPLE = 9; + /** + * COPY data can be received from the server. + */ + public const COPY_OUT = 3; + /** + * COPY data can be sent to the server. + */ + public const COPY_IN = 4; + /** + * COPY in/out data transfer in progress. + */ + public const COPY_BOTH = 8; + /** + * The server sent a bad response. + */ + public const BAD_RESPONSE = 5; + /** + * A nonfatal error (notice or warning) occurred. + */ + public const NONFATAL_ERROR = 6; + /** + * A fatal error occurred. + */ + public const FATAL_ERROR = 7; + /** + * Fetch rows numerically indexed, where the index start with 0. + */ + public const FETCH_ARRAY = 0; + /** + * Fetch rows associatively indexed by column name. + */ + public const FETCH_ASSOC = 1; + /** + * Fetch rows as stdClass instance, where the column names are the property names. + */ + public const FETCH_OBJECT = 2; + /** + * Automatically convert 'f' and 't' to FALSE and TRUE and vice versa. + */ + public const CONV_BOOL = 1; + /** + * Automatically convert integral strings to either int if it fits into maximum integer size or else to float and vice versa. + */ + public const CONV_INT = 2; + /** + * Automatically convert floating point numbers. + */ + public const CONV_FLOAT = 4; + /** + * Do all scalar conversions listed above. + */ + public const CONV_SCALAR = 15; + /** + * Automatically convert arrays. + */ + public const CONV_ARRAY = 16; + /** + * Automatically convert date strings to pq\DateTime and vice versa. + */ + public const CONV_DATETIME = 32; + /** + * Automatically convert JSON. + */ + public const CONV_JSON = 256; + /** + * Do all of the above. + */ + public const CONV_ALL = 65535; + /** + * A [status constant](pq/Result#Status.values:). + * + * @public + * @readonly + * @var int + */ + public $status; + /** + * The accompanying status message. + * + * @public + * @readonly + * @var string + */ + public $statusMessage; + /** + * Any error message if $status indicates an error. + * + * @public + * @readonly + * @var string + */ + public $errorMessage; + /** + * The number of rows in the result set. + * + * @public + * @readonly + * @var int + */ + public $numRows; + /** + * The number of fields in a single tuple of the result set. + * + * @public + * @readonly + * @var int + */ + public $numCols; + /** + * The number of rows affected by a statement. + * + * @public + * @readonly + * @var int + */ + public $affectedRows; + /** + * Error details. See [PQresultErrorField](https://www.postgresql.org/docs/current/static/libpq-exec.html#LIBPQ-PQRESULTERRORFIELD) docs. + * + * @public + * @readonly + * @var array + */ + public $diag; + /** + * The [type of return value](pq/Result#Fetch.types:) the fetch methods should return when no fetch type argument was given. Defaults to pq\Connection::$defaultFetchType. + * + * @public + * @var int + */ + public $fetchType = \pq\Result::FETCH_ARRAY; + /** + * What [type of conversions](pq/Result#Conversion.bits:) to perform automatically. + * + * @public + * @var int + */ + public $autoConvert = \pq\Result::CONV_ALL; + /** + * Bind a variable to a result column. + * See pq\Result::fetchBound(). + * + * @param mixed $col The column name or index to bind to. + * @param mixed $var The variable reference. + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @return bool success. + */ + public function bind($col, $var) {} + /** + * Count number of rows in this result set. + * + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @return int the number of rows. + */ + public function count() {} + /** + * Describe a prepared statement. + * + * ***NOTE:*** + * This will only return meaningful information for a result of pq\Statement::desc(). + * + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @return array list of parameter type OIDs for the prepared statement. + */ + public function desc() {} + /** + * Fetch all rows at once. + * + * @param int $fetch_type The type the return value should have, see pq\Result::FETCH_* constants, defaults to pq\Result::$fetchType. + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @return array all fetched rows. + */ + public function fetchAll(int $fetch_type = null) {} + /** + * Fetch all rows of a single column. + * + * @param int $col The column name or index to fetch. + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + * @return array list of column values. + */ + public function fetchAllCols(int $col = 0) {} + /** + * Iteratively fetch a row into bound variables. + * See pq\Result::bind(). + * + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + * @return array|null array the fetched row as numerically indexed array. + * or NULL when iteration ends. + */ + public function fetchBound() {} + /** + * Iteratively fetch a single column. + * + * @param mixed $ref The variable where the column value will be stored in. + * @param mixed $col The column name or index. + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + * @return bool|null bool success. + * or NULL when iteration ends. + */ + public function fetchCol($ref, $col = 0) {} + /** + * Iteratively fetch a row. + * + * @param int $fetch_type The type the return value should have, see pq\Result::FETCH_* constants, defaults to pq\Result::$fetchType. + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + * @return array|array|object|null array numerically indexed for pq\Result::FETCH_ARRAY + * or array associatively indexed for pq\Result::FETCH_ASSOC + * or object stdClass instance for pq\Result::FETCH_OBJECT + * or NULL when iteration ends. + */ + public function fetchRow(int $fetch_type = null) {} + /** + * Fetch the complete result set as a simple map, a *multi dimensional array*, each dimension indexed by a column. + * + * @param mixed $keys The the column indices/names used to index the map. + * @param mixed $vals The column indices/names which should build up the leaf entry of the map. + * @param int $fetch_type The type the return value should have, see pq\Result::FETCH_* constants, defaults to pq\Result::$fetchType. + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + * @return array |object, the mapped columns. + */ + public function map($keys = 0, $vals = null, int $fetch_type = null) {} } /** * A named prepared statement. * See pq\Connection::prepare(). */ -class Statement { - /** - * The connection to the server. - * - * @public - * @readonly - * @var \pq\Connection - */ - public $connection; - /** - * The identifiying name of the prepared statement. - * - * @public - * @readonly - * @var string - */ - public $name; - /** - * The query string used to prepare the statement. - * - * @public - * @readonly - * @var string - */ - public $query; - /** - * List of corresponding query parameter type OIDs for the prepared statement. - * - * @public - * @readonly - * @var array - */ - public $types; - /** - * Prepare a new statement. - * See pq\Connection::prepare(). - * - * @param \pq\Connection $conn The connection to prepare the statement on. - * @param string $name The name identifying this statement. - * @param string $query The actual query to prepare. - * @param array $types A list of corresponding query parameter type OIDs. - * @param bool $async Whether to prepare the statement [asynchronously](pq/Connection/: Asynchronous Usage). - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - * @throws \pq\Exception\DomainException - */ - function __construct(\pq\Connection $conn, string $name, string $query, array $types = null, bool $async = false) {} - /** - * Bind a variable to an input parameter. - * - * @param int $param_no The parameter index to bind to. - * @param mixed &$param_ref The variable to bind. - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - */ - function bind(int $param_no, &$param_ref) {} - /** - * Free the server resources used by the prepared statement, so it can no longer be executed. - * This is done implicitly when the object is destroyed. - * - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - */ - function deallocate() {} - /** - * [Asynchronously](pq/Connection/: Asynchronous Usage) free the server resources used by the - * prepared statement, so it can no longer be executed. - * - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - */ - function deallocateAsync() {} - /** - * Describe the parameters of the prepared statement. - * - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - * @throws \pq\Exception\DomainException - * @return array list of type OIDs of the substitution parameters. - */ - function desc() {} - /** - * [Asynchronously](pq/Connection/: Asynchronous Usage) describe the parameters of the prepared statement. - * - * @param callable $callback as function(array $oids) - * A callback to receive list of type OIDs of the substitution parameters. - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - */ - function descAsync(callable $callback) {} - /** - * Execute the prepared statement. - * - * @param array $params Any parameters to substitute in the prepared statement (defaults to any bou - * nd variables). - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - * @return \pq\Result the result of the execution of the prepared statement. - */ - function exec(array $params = null) {} - /** - * [Asynchronously](pq/Connection/: Asynchronous Usage) execute the prepared statement. - * - * @param array $params Any parameters to substitute in the prepared statement (defaults to any bou - * nd variables). - * @param callable $cb as function(\pq\Result $res) : void - * Result handler callback. - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - */ - function execAsync(array $params = null, callable $cb = null) {} - /** - * Re-prepare a statement that has been deallocated. This is a no-op on already open statements. - * - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - */ - function prepare() {} - /** - * [Asynchronously](pq/Connection/: Asynchronous Usage) re-prepare a statement that has been - * deallocated. This is a no-op on already open statements. - * - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - */ - function prepareAsync() {} +class Statement +{ + /** + * The connection to the server. + * + * @public + * @readonly + * @var \pq\Connection + */ + public $connection; + /** + * The identifiying name of the prepared statement. + * + * @public + * @readonly + * @var string + */ + public $name; + /** + * The query string used to prepare the statement. + * + * @public + * @readonly + * @var string + */ + public $query; + /** + * List of corresponding query parameter type OIDs for the prepared statement. + * + * @public + * @readonly + * @var array + */ + public $types; + /** + * Prepare a new statement. + * See pq\Connection::prepare(). + * + * @param \pq\Connection $conn The connection to prepare the statement on. + * @param string $name The name identifying this statement. + * @param string $query The actual query to prepare. + * @param array $types A list of corresponding query parameter type OIDs. + * @param bool $async Whether to prepare the statement [asynchronously](pq/Connection/: Asynchronous Usage). + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + * @throws \pq\Exception\DomainException + */ + public function __construct(pq\Connection $conn, string $name, string $query, array $types = null, bool $async = false) {} + /** + * Bind a variable to an input parameter. + * + * @param int $param_no The parameter index to bind to. + * @param mixed &$param_ref The variable to bind. + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + */ + public function bind(int $param_no, &$param_ref) {} + /** + * Free the server resources used by the prepared statement, so it can no longer be executed. + * This is done implicitly when the object is destroyed. + * + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + */ + public function deallocate() {} + /** + * [Asynchronously](pq/Connection/: Asynchronous Usage) free the server resources used by the + * prepared statement, so it can no longer be executed. + * + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + */ + public function deallocateAsync() {} + /** + * Describe the parameters of the prepared statement. + * + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + * @throws \pq\Exception\DomainException + * @return array list of type OIDs of the substitution parameters. + */ + public function desc() {} + /** + * [Asynchronously](pq/Connection/: Asynchronous Usage) describe the parameters of the prepared statement. + * + * @param callable $callback as function(array $oids) + * A callback to receive list of type OIDs of the substitution parameters. + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + */ + public function descAsync(callable $callback) {} + /** + * Execute the prepared statement. + * + * @param array $params Any parameters to substitute in the prepared statement (defaults to any bou + * nd variables). + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + * @return \pq\Result the result of the execution of the prepared statement. + */ + public function exec(array $params = null) {} + /** + * [Asynchronously](pq/Connection/: Asynchronous Usage) execute the prepared statement. + * + * @param array $params Any parameters to substitute in the prepared statement (defaults to any bou + * nd variables). + * @param callable $cb as function(\pq\Result $res) : void + * Result handler callback. + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + */ + public function execAsync(array $params = null, callable $cb = null) {} + /** + * Re-prepare a statement that has been deallocated. This is a no-op on already open statements. + * + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + */ + public function prepare() {} + /** + * [Asynchronously](pq/Connection/: Asynchronous Usage) re-prepare a statement that has been + * deallocated. This is a no-op on already open statements. + * + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + */ + public function prepareAsync() {} } /** * A database transaction. @@ -1497,891 +1510,893 @@ function prepareAsync() {} * ***NOTE:*** * Transactional properties like pq\Transaction::$isolation, pq\Transaction::$readonly and pq\Transaction::$deferrable can be changed after the transaction begun and the first query has been executed. Doing this will lead to appropriate `SET TRANSACTION` queries. */ -class Transaction { - /** - * Transaction isolation level where only rows committed before the transaction began can be seen. - */ - const READ_COMMITTED = 0; - /** - * Transaction isolation level where only rows committed before the first query was executed in this transaction. - */ - const REPEATABLE_READ = 1; - /** - * Transaction isolation level that guarantees serializable repeatability which might lead to serialization_failure on high concurrency. - */ - const SERIALIZABLE = 2; - /** - * The connection the transaction was started on. - * - * @public - * @readonly - * @var \pq\Connection - */ - public $connection; - /** - * The transaction isolation level. - * - * @public - * @var int - */ - public $isolation = \pq\Transaction::READ_COMMITTED; - /** - * Whether this transaction performs read only queries. - * - * @public - * @var bool - */ - public $readonly = false; - /** - * Whether the transaction is deferrable. See pq\Connection::startTransaction(). - * - * @public - * @var bool - */ - public $deferrable = false; - /** - * Start a transaction. - * See pq\Connection::startTransaction(). - * - * @param \pq\Connection $conn The connection to start the transaction on. - * @param bool $async Whether to start the transaction [asynchronously](pq/Connection/: Asynchronous Usage). - * @param int $isolation The transaction isolation level (defaults to pq\Connection::$defaultTransactionIsolation). - * @param bool $readonly Whether the transaction is readonly (defaults to pq\Connection::$defaultTransactionReadonly). - * @param bool $deferrable Whether the transaction is deferrable (defaults to pq\Connection::$defaultTransactionDeferrable). - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - */ - function __construct(\pq\Connection $conn, bool $async = false, int $isolation = \pq\Transaction::READ_COMMITTED, bool $readonly = false, bool $deferrable = false) {} - /** - * Commit the transaction or release the previous savepoint. - * See pq\Transaction::savepoint(). - * - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - * @throws \pq\Exception\DomainException - */ - function commit() {} - /** - * [Asynchronously](pq/Connection/: Asynchronous Usage) commit the transaction or release the previous savepoint. - * See pq\Transaction::commit() and pq\Transaction::savepoint(). - * - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - */ - function commitAsync() {} - /** - * Create a new *large object* and open it. - * See pq\Transaction::openLOB(). - * - * @param int $mode How to open the *large object* (read, write or both; see pq\LOB constants). - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - * @return \pq\LOB instance of the new *large object*. - */ - function createLOB(int $mode = \pq\LOB::RW) {} - /** - * Export a *large object* to a local file. - * See pq\Transaction::importLOB(). - * - * @param int $oid The OID of the *large object*. - * @param string $path The path of a local file to export to. - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - */ - function exportLOB(int $oid, string $path) {} - /** - * Export a snapshot for transaction synchronization. - * See pq\Transaction::importSnapshot(). - * - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - * @throws \pq\Exception\DomainException - * @return string the snapshot identifier usable with pq\Transaction::importSnapshot(). - */ - function exportSnapshot() {} - /** - * [Asynchronously](pq/Connection/: Asynchronous Usage) export a snapshot for transaction synchronization. - * See pq\Transaction::exportSnapshot(). - * - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - */ - function exportSnapshotAsync() {} - /** - * Import a local file into a *large object*. - * - * @param string $local_path A path to a local file to import. - * @param int $oid The target OID. A new *large object* will be created if INVALID_OID. - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - * @return int the (new) OID of the *large object*. - */ - function importLOB(string $local_path, int $oid = \pq\LOB::INVALID_OID) {} - /** - * Import a snapshot from another transaction to synchronize with. - * See pq\Transaction::exportSnapshot(). - * - * ***NOTE:*** - * The transaction must have an isolation level of at least pq\Transaction::REPEATABLE_READ. - * - * @param string $snapshot_id The snapshot identifier obtained by exporting a snapshot from a transaction. - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - * @throws \pq\Exception\DomainException - */ - function importSnapshot(string $snapshot_id) {} - /** - * [Asynchronously](pq/Connection/: Asynchronous Usage) import a snapshot from another transaction to synchronize with. - * See pq\Transaction::importSnapshot(). - * - * ***NOTE:*** - * The transaction must have an isolation level of at least pq\Transaction::REPEATABLE_READ. - * - * @param string $snapshot_id The snapshot identifier obtained by exporting a snapshot from a transaction. - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - */ - function importSnapshotAsync(string $snapshot_id) {} - /** - * Open a *large object*. - * See pq\Transaction::createLOB(). - * - * @param int $oid The OID of the *large object*. - * @param int $mode Operational mode; read, write or both. - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - * @return \pq\LOB instance of the opened *large object*. - */ - function openLOB(int $oid, int $mode = \pq\LOB::RW) {} - /** - * Rollback the transaction or to the previous savepoint within this transaction. - * See pq\Transaction::commit() and pq\Transaction::savepoint(). - * - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - * @throws \pq\Exception\DomainException - */ - function rollback() {} - /** - * [Asynchronously](pq/Connection/: Asynchronous Usage) rollback the transaction or to the previous savepoint within this transaction. - * See pq\Transaction::rollback() and pq\Transaction::savepoint(). - * - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - */ - function rollbackAsync() {} - /** - * Create a `SAVEPOINT` within this transaction. - * - * ***NOTE:*** - * pq\Transaction tracks an internal counter as savepoint identifier. - * - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - */ - function savepoint() {} - /** - * [Asynchronously](pq/Connection/: Asynchronous Usage) create a `SAVEPOINT` within this transaction. - * See pq\Transaction::savepoint(). - * - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - */ - function savepointAsync() {} - /** - * Unlink a *large object*. - * See pq\Transaction::createLOB(). - * - * @param int $oid The OID of the *large object*. - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - * @return \pq\LOB instance of the opened *large object*. - */ - function unlinkLOB(int $oid) {} +class Transaction +{ + /** + * Transaction isolation level where only rows committed before the transaction began can be seen. + */ + public const READ_COMMITTED = 0; + /** + * Transaction isolation level where only rows committed before the first query was executed in this transaction. + */ + public const REPEATABLE_READ = 1; + /** + * Transaction isolation level that guarantees serializable repeatability which might lead to serialization_failure on high concurrency. + */ + public const SERIALIZABLE = 2; + /** + * The connection the transaction was started on. + * + * @public + * @readonly + * @var \pq\Connection + */ + public $connection; + /** + * The transaction isolation level. + * + * @public + * @var int + */ + public $isolation = \pq\Transaction::READ_COMMITTED; + /** + * Whether this transaction performs read only queries. + * + * @public + * @var bool + */ + public $readonly = false; + /** + * Whether the transaction is deferrable. See pq\Connection::startTransaction(). + * + * @public + * @var bool + */ + public $deferrable = false; + /** + * Start a transaction. + * See pq\Connection::startTransaction(). + * + * @param \pq\Connection $conn The connection to start the transaction on. + * @param bool $async Whether to start the transaction [asynchronously](pq/Connection/: Asynchronous Usage). + * @param int $isolation The transaction isolation level (defaults to pq\Connection::$defaultTransactionIsolation). + * @param bool $readonly Whether the transaction is readonly (defaults to pq\Connection::$defaultTransactionReadonly). + * @param bool $deferrable Whether the transaction is deferrable (defaults to pq\Connection::$defaultTransactionDeferrable). + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + */ + public function __construct(pq\Connection $conn, bool $async = false, int $isolation = \pq\Transaction::READ_COMMITTED, bool $readonly = false, bool $deferrable = false) {} + /** + * Commit the transaction or release the previous savepoint. + * See pq\Transaction::savepoint(). + * + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + * @throws \pq\Exception\DomainException + */ + public function commit() {} + /** + * [Asynchronously](pq/Connection/: Asynchronous Usage) commit the transaction or release the previous savepoint. + * See pq\Transaction::commit() and pq\Transaction::savepoint(). + * + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + */ + public function commitAsync() {} + /** + * Create a new *large object* and open it. + * See pq\Transaction::openLOB(). + * + * @param int $mode How to open the *large object* (read, write or both; see pq\LOB constants). + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + * @return \pq\LOB instance of the new *large object*. + */ + public function createLOB(int $mode = \pq\LOB::RW) {} + /** + * Export a *large object* to a local file. + * See pq\Transaction::importLOB(). + * + * @param int $oid The OID of the *large object*. + * @param string $path The path of a local file to export to. + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + */ + public function exportLOB(int $oid, string $path) {} + /** + * Export a snapshot for transaction synchronization. + * See pq\Transaction::importSnapshot(). + * + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + * @throws \pq\Exception\DomainException + * @return string the snapshot identifier usable with pq\Transaction::importSnapshot(). + */ + public function exportSnapshot() {} + /** + * [Asynchronously](pq/Connection/: Asynchronous Usage) export a snapshot for transaction synchronization. + * See pq\Transaction::exportSnapshot(). + * + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + */ + public function exportSnapshotAsync() {} + /** + * Import a local file into a *large object*. + * + * @param string $local_path A path to a local file to import. + * @param int $oid The target OID. A new *large object* will be created if INVALID_OID. + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + * @return int the (new) OID of the *large object*. + */ + public function importLOB(string $local_path, int $oid = \pq\LOB::INVALID_OID) {} + /** + * Import a snapshot from another transaction to synchronize with. + * See pq\Transaction::exportSnapshot(). + * + * ***NOTE:*** + * The transaction must have an isolation level of at least pq\Transaction::REPEATABLE_READ. + * + * @param string $snapshot_id The snapshot identifier obtained by exporting a snapshot from a transaction. + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + * @throws \pq\Exception\DomainException + */ + public function importSnapshot(string $snapshot_id) {} + /** + * [Asynchronously](pq/Connection/: Asynchronous Usage) import a snapshot from another transaction to synchronize with. + * See pq\Transaction::importSnapshot(). + * + * ***NOTE:*** + * The transaction must have an isolation level of at least pq\Transaction::REPEATABLE_READ. + * + * @param string $snapshot_id The snapshot identifier obtained by exporting a snapshot from a transaction. + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + */ + public function importSnapshotAsync(string $snapshot_id) {} + /** + * Open a *large object*. + * See pq\Transaction::createLOB(). + * + * @param int $oid The OID of the *large object*. + * @param int $mode Operational mode; read, write or both. + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + * @return \pq\LOB instance of the opened *large object*. + */ + public function openLOB(int $oid, int $mode = \pq\LOB::RW) {} + /** + * Rollback the transaction or to the previous savepoint within this transaction. + * See pq\Transaction::commit() and pq\Transaction::savepoint(). + * + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + * @throws \pq\Exception\DomainException + */ + public function rollback() {} + /** + * [Asynchronously](pq/Connection/: Asynchronous Usage) rollback the transaction or to the previous savepoint within this transaction. + * See pq\Transaction::rollback() and pq\Transaction::savepoint(). + * + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + */ + public function rollbackAsync() {} + /** + * Create a `SAVEPOINT` within this transaction. + * + * ***NOTE:*** + * pq\Transaction tracks an internal counter as savepoint identifier. + * + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + */ + public function savepoint() {} + /** + * [Asynchronously](pq/Connection/: Asynchronous Usage) create a `SAVEPOINT` within this transaction. + * See pq\Transaction::savepoint(). + * + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + */ + public function savepointAsync() {} + /** + * Unlink a *large object*. + * See pq\Transaction::createLOB(). + * + * @param int $oid The OID of the *large object*. + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + * @return \pq\LOB instance of the opened *large object*. + */ + public function unlinkLOB(int $oid) {} } /** * Accessor to the PostgreSQL `pg_type` relation. * See [here for an overview](pq/Types/: Overview). */ -class Types implements \ArrayAccess { - /** - * OID of the `bool` type. - */ - const BOOL = 16; - /** - * OID of the `bytea` type. - */ - const BYTEA = 17; - /** - * OID of the `char` type. - */ - const CHAR = 18; - /** - * OID of the `name` type. - */ - const NAME = 19; - /** - * OID of the `int8` type. - */ - const INT8 = 20; - /** - * OID of the `int2` type. - */ - const INT2 = 21; - /** - * OID of the `int2vector` type. - */ - const INT2VECTOR = 22; - /** - * OID of the `int4` type. - */ - const INT4 = 23; - /** - * OID of the `regproc` type. - */ - const REGPROC = 24; - /** - * OID of the `text` type. - */ - const TEXT = 25; - /** - * OID of the `oid` type. - */ - const OID = 26; - /** - * OID of the `tid` type. - */ - const TID = 27; - /** - * OID of the `xid` type. - */ - const XID = 28; - /** - * OID of the `cid` type. - */ - const CID = 29; - /** - * OID of the `oidvector` type. - */ - const OIDVECTOR = 30; - /** - * OID of the `pg_type` type. - */ - const PG_TYPE = 71; - /** - * OID of the `pg_attribute` type. - */ - const PG_ATTRIBUTE = 75; - /** - * OID of the `pg_proc` type. - */ - const PG_PROC = 81; - /** - * OID of the `pg_class` type. - */ - const PG_CLASS = 83; - /** - * OID of the `json` type. - */ - const JSON = 114; - /** - * OID of the `xml` type. - */ - const XML = 142; - /** - * OID of the `xmlarray` type. - */ - const XMLARRAY = 143; - /** - * OID of the `jsonarray` type. - */ - const JSONARRAY = 199; - /** - * OID of the `pg_node_tree` type. - */ - const PG_NODE_TREE = 194; - /** - * OID of the `smgr` type. - */ - const SMGR = 210; - /** - * OID of the `point` type. - */ - const POINT = 600; - /** - * OID of the `lseg` type. - */ - const LSEG = 601; - /** - * OID of the `path` type. - */ - const PATH = 602; - /** - * OID of the `box` type. - */ - const BOX = 603; - /** - * OID of the `polygon` type. - */ - const POLYGON = 604; - /** - * OID of the `line` type. - */ - const LINE = 628; - /** - * OID of the `linearray` type. - */ - const LINEARRAY = 629; - /** - * OID of the `float4` type. - */ - const FLOAT4 = 700; - /** - * OID of the `float8` type. - */ - const FLOAT8 = 701; - /** - * OID of the `abstime` type. - */ - const ABSTIME = 702; - /** - * OID of the `reltime` type. - */ - const RELTIME = 703; - /** - * OID of the `tinterval` type. - */ - const TINTERVAL = 704; - /** - * OID of the `unknown` type. - */ - const UNKNOWN = 705; - /** - * OID of the `circle` type. - */ - const CIRCLE = 718; - /** - * OID of the `circlearray` type. - */ - const CIRCLEARRAY = 719; - /** - * OID of the `money` type. - */ - const MONEY = 790; - /** - * OID of the `moneyarray` type. - */ - const MONEYARRAY = 791; - /** - * OID of the `macaddr` type. - */ - const MACADDR = 829; - /** - * OID of the `inet` type. - */ - const INET = 869; - /** - * OID of the `cidr` type. - */ - const CIDR = 650; - /** - * OID of the `boolarray` type. - */ - const BOOLARRAY = 1000; - /** - * OID of the `byteaarray` type. - */ - const BYTEAARRAY = 1001; - /** - * OID of the `chararray` type. - */ - const CHARARRAY = 1002; - /** - * OID of the `namearray` type. - */ - const NAMEARRAY = 1003; - /** - * OID of the `int2array` type. - */ - const INT2ARRAY = 1005; - /** - * OID of the `int2vectorarray` type. - */ - const INT2VECTORARRAY = 1006; - /** - * OID of the `int4array` type. - */ - const INT4ARRAY = 1007; - /** - * OID of the `regprocarray` type. - */ - const REGPROCARRAY = 1008; - /** - * OID of the `textarray` type. - */ - const TEXTARRAY = 1009; - /** - * OID of the `oidarray` type. - */ - const OIDARRAY = 1028; - /** - * OID of the `tidarray` type. - */ - const TIDARRAY = 1010; - /** - * OID of the `xidarray` type. - */ - const XIDARRAY = 1011; - /** - * OID of the `cidarray` type. - */ - const CIDARRAY = 1012; - /** - * OID of the `oidvectorarray` type. - */ - const OIDVECTORARRAY = 1013; - /** - * OID of the `bpchararray` type. - */ - const BPCHARARRAY = 1014; - /** - * OID of the `varchararray` type. - */ - const VARCHARARRAY = 1015; - /** - * OID of the `int8array` type. - */ - const INT8ARRAY = 1016; - /** - * OID of the `pointarray` type. - */ - const POINTARRAY = 1017; - /** - * OID of the `lsegarray` type. - */ - const LSEGARRAY = 1018; - /** - * OID of the `patharray` type. - */ - const PATHARRAY = 1019; - /** - * OID of the `boxarray` type. - */ - const BOXARRAY = 1020; - /** - * OID of the `float4array` type. - */ - const FLOAT4ARRAY = 1021; - /** - * OID of the `float8array` type. - */ - const FLOAT8ARRAY = 1022; - /** - * OID of the `abstimearray` type. - */ - const ABSTIMEARRAY = 1023; - /** - * OID of the `reltimearray` type. - */ - const RELTIMEARRAY = 1024; - /** - * OID of the `tintervalarray` type. - */ - const TINTERVALARRAY = 1025; - /** - * OID of the `polygonarray` type. - */ - const POLYGONARRAY = 1027; - /** - * OID of the `aclitem` type. - */ - const ACLITEM = 1033; - /** - * OID of the `aclitemarray` type. - */ - const ACLITEMARRAY = 1034; - /** - * OID of the `macaddrarray` type. - */ - const MACADDRARRAY = 1040; - /** - * OID of the `inetarray` type. - */ - const INETARRAY = 1041; - /** - * OID of the `cidrarray` type. - */ - const CIDRARRAY = 651; - /** - * OID of the `cstringarray` type. - */ - const CSTRINGARRAY = 1263; - /** - * OID of the `bpchar` type. - */ - const BPCHAR = 1042; - /** - * OID of the `varchar` type. - */ - const VARCHAR = 1043; - /** - * OID of the `date` type. - */ - const DATE = 1082; - /** - * OID of the `time` type. - */ - const TIME = 1083; - /** - * OID of the `timestamp` type. - */ - const TIMESTAMP = 1114; - /** - * OID of the `timestamparray` type. - */ - const TIMESTAMPARRAY = 1115; - /** - * OID of the `datearray` type. - */ - const DATEARRAY = 1182; - /** - * OID of the `timearray` type. - */ - const TIMEARRAY = 1183; - /** - * OID of the `timestamptz` type. - */ - const TIMESTAMPTZ = 1184; - /** - * OID of the `timestamptzarray` type. - */ - const TIMESTAMPTZARRAY = 1185; - /** - * OID of the `interval` type. - */ - const INTERVAL = 1186; - /** - * OID of the `intervalarray` type. - */ - const INTERVALARRAY = 1187; - /** - * OID of the `numericarray` type. - */ - const NUMERICARRAY = 1231; - /** - * OID of the `timetz` type. - */ - const TIMETZ = 1266; - /** - * OID of the `timetzarray` type. - */ - const TIMETZARRAY = 1270; - /** - * OID of the `bit` type. - */ - const BIT = 1560; - /** - * OID of the `bitarray` type. - */ - const BITARRAY = 1561; - /** - * OID of the `varbit` type. - */ - const VARBIT = 1562; - /** - * OID of the `varbitarray` type. - */ - const VARBITARRAY = 1563; - /** - * OID of the `numeric` type. - */ - const NUMERIC = 1700; - /** - * OID of the `refcursor` type. - */ - const REFCURSOR = 1790; - /** - * OID of the `refcursorarray` type. - */ - const REFCURSORARRAY = 2201; - /** - * OID of the `regprocedure` type. - */ - const REGPROCEDURE = 2202; - /** - * OID of the `regoper` type. - */ - const REGOPER = 2203; - /** - * OID of the `regoperator` type. - */ - const REGOPERATOR = 2204; - /** - * OID of the `regclass` type. - */ - const REGCLASS = 2205; - /** - * OID of the `regtype` type. - */ - const REGTYPE = 2206; - /** - * OID of the `regprocedurearray` type. - */ - const REGPROCEDUREARRAY = 2207; - /** - * OID of the `regoperarray` type. - */ - const REGOPERARRAY = 2208; - /** - * OID of the `regoperatorarray` type. - */ - const REGOPERATORARRAY = 2209; - /** - * OID of the `regclassarray` type. - */ - const REGCLASSARRAY = 2210; - /** - * OID of the `regtypearray` type. - */ - const REGTYPEARRAY = 2211; - /** - * OID of the `uuid` type. - */ - const UUID = 2950; - /** - * OID of the `uuidarray` type. - */ - const UUIDARRAY = 2951; - /** - * OID of the `tsvector` type. - */ - const TSVECTOR = 3614; - /** - * OID of the `gtsvector` type. - */ - const GTSVECTOR = 3642; - /** - * OID of the `tsquery` type. - */ - const TSQUERY = 3615; - /** - * OID of the `regconfig` type. - */ - const REGCONFIG = 3734; - /** - * OID of the `regdictionary` type. - */ - const REGDICTIONARY = 3769; - /** - * OID of the `tsvectorarray` type. - */ - const TSVECTORARRAY = 3643; - /** - * OID of the `gtsvectorarray` type. - */ - const GTSVECTORARRAY = 3644; - /** - * OID of the `tsqueryarray` type. - */ - const TSQUERYARRAY = 3645; - /** - * OID of the `regconfigarray` type. - */ - const REGCONFIGARRAY = 3735; - /** - * OID of the `regdictionaryarray` type. - */ - const REGDICTIONARYARRAY = 3770; - /** - * OID of the `txid_snapshot` type. - */ - const TXID_SNAPSHOT = 2970; - /** - * OID of the `txid_snapshotarray` type. - */ - const TXID_SNAPSHOTARRAY = 2949; - /** - * OID of the `int4range` type. - */ - const INT4RANGE = 3904; - /** - * OID of the `int4rangearray` type. - */ - const INT4RANGEARRAY = 3905; - /** - * OID of the `numrange` type. - */ - const NUMRANGE = 3906; - /** - * OID of the `numrangearray` type. - */ - const NUMRANGEARRAY = 3907; - /** - * OID of the `tsrange` type. - */ - const TSRANGE = 3908; - /** - * OID of the `tsrangearray` type. - */ - const TSRANGEARRAY = 3909; - /** - * OID of the `tstzrange` type. - */ - const TSTZRANGE = 3910; - /** - * OID of the `tstzrangearray` type. - */ - const TSTZRANGEARRAY = 3911; - /** - * OID of the `daterange` type. - */ - const DATERANGE = 3912; - /** - * OID of the `daterangearray` type. - */ - const DATERANGEARRAY = 3913; - /** - * OID of the `int8range` type. - */ - const INT8RANGE = 3926; - /** - * OID of the `int8rangearray` type. - */ - const INT8RANGEARRAY = 3927; - /** - * OID of the `record` type. - */ - const RECORD = 2249; - /** - * OID of the `recordarray` type. - */ - const RECORDARRAY = 2287; - /** - * OID of the `cstring` type. - */ - const CSTRING = 2275; - /** - * OID of the `any` type. - */ - const ANY = 2276; - /** - * OID of the `anyarray` type. - */ - const ANYARRAY = 2277; - /** - * OID of the `void` type. - */ - const VOID = 2278; - /** - * OID of the `trigger` type. - */ - const TRIGGER = 2279; - /** - * OID of the `event_trigger` type. - */ - const EVENT_TRIGGER = 3838; - /** - * OID of the `language_handler` type. - */ - const LANGUAGE_HANDLER = 2280; - /** - * OID of the `internal` type. - */ - const INTERNAL = 2281; - /** - * OID of the `opaque` type. - */ - const OPAQUE = 2282; - /** - * OID of the `anyelement` type. - */ - const ANYELEMENT = 2283; - /** - * OID of the `anynonarray` type. - */ - const ANYNONARRAY = 2776; - /** - * OID of the `anyenum` type. - */ - const ANYENUM = 3500; - /** - * OID of the `fdw_handler` type. - */ - const FDW_HANDLER = 3115; - /** - * OID of the `anyrange` type. - */ - const ANYRANGE = 3831; - /** - * The connection which was used to obtain type information. - * - * @public - * @readonly - * @var \pq\Connection - */ - public $connection; - /** - * Create a new instance populated with information obtained from the `pg_type` relation. - * - * @param \pq\Connection $conn The connection to use. - * @param array $namespaces Which namespaces to query (defaults to `public` and `pg_catalog`). - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - */ - function __construct(\pq\Connection $conn, array $namespaces = null) {} - /** - * Refresh type information from `pg_type`. - * - * @param array $namespaces Which namespaces to query (defaults to `public` and `pg_catalog`). - * @throws \pq\Exception\InvalidArgumentException - * @throws \pq\Exception\BadMethodCallException - * @throws \pq\Exception\RuntimeException - */ - function refresh(array $namespaces = null) {} +class Types implements \ArrayAccess +{ + /** + * OID of the `bool` type. + */ + public const BOOL = 16; + /** + * OID of the `bytea` type. + */ + public const BYTEA = 17; + /** + * OID of the `char` type. + */ + public const CHAR = 18; + /** + * OID of the `name` type. + */ + public const NAME = 19; + /** + * OID of the `int8` type. + */ + public const INT8 = 20; + /** + * OID of the `int2` type. + */ + public const INT2 = 21; + /** + * OID of the `int2vector` type. + */ + public const INT2VECTOR = 22; + /** + * OID of the `int4` type. + */ + public const INT4 = 23; + /** + * OID of the `regproc` type. + */ + public const REGPROC = 24; + /** + * OID of the `text` type. + */ + public const TEXT = 25; + /** + * OID of the `oid` type. + */ + public const OID = 26; + /** + * OID of the `tid` type. + */ + public const TID = 27; + /** + * OID of the `xid` type. + */ + public const XID = 28; + /** + * OID of the `cid` type. + */ + public const CID = 29; + /** + * OID of the `oidvector` type. + */ + public const OIDVECTOR = 30; + /** + * OID of the `pg_type` type. + */ + public const PG_TYPE = 71; + /** + * OID of the `pg_attribute` type. + */ + public const PG_ATTRIBUTE = 75; + /** + * OID of the `pg_proc` type. + */ + public const PG_PROC = 81; + /** + * OID of the `pg_class` type. + */ + public const PG_CLASS = 83; + /** + * OID of the `json` type. + */ + public const JSON = 114; + /** + * OID of the `xml` type. + */ + public const XML = 142; + /** + * OID of the `xmlarray` type. + */ + public const XMLARRAY = 143; + /** + * OID of the `jsonarray` type. + */ + public const JSONARRAY = 199; + /** + * OID of the `pg_node_tree` type. + */ + public const PG_NODE_TREE = 194; + /** + * OID of the `smgr` type. + */ + public const SMGR = 210; + /** + * OID of the `point` type. + */ + public const POINT = 600; + /** + * OID of the `lseg` type. + */ + public const LSEG = 601; + /** + * OID of the `path` type. + */ + public const PATH = 602; + /** + * OID of the `box` type. + */ + public const BOX = 603; + /** + * OID of the `polygon` type. + */ + public const POLYGON = 604; + /** + * OID of the `line` type. + */ + public const LINE = 628; + /** + * OID of the `linearray` type. + */ + public const LINEARRAY = 629; + /** + * OID of the `float4` type. + */ + public const FLOAT4 = 700; + /** + * OID of the `float8` type. + */ + public const FLOAT8 = 701; + /** + * OID of the `abstime` type. + */ + public const ABSTIME = 702; + /** + * OID of the `reltime` type. + */ + public const RELTIME = 703; + /** + * OID of the `tinterval` type. + */ + public const TINTERVAL = 704; + /** + * OID of the `unknown` type. + */ + public const UNKNOWN = 705; + /** + * OID of the `circle` type. + */ + public const CIRCLE = 718; + /** + * OID of the `circlearray` type. + */ + public const CIRCLEARRAY = 719; + /** + * OID of the `money` type. + */ + public const MONEY = 790; + /** + * OID of the `moneyarray` type. + */ + public const MONEYARRAY = 791; + /** + * OID of the `macaddr` type. + */ + public const MACADDR = 829; + /** + * OID of the `inet` type. + */ + public const INET = 869; + /** + * OID of the `cidr` type. + */ + public const CIDR = 650; + /** + * OID of the `boolarray` type. + */ + public const BOOLARRAY = 1000; + /** + * OID of the `byteaarray` type. + */ + public const BYTEAARRAY = 1001; + /** + * OID of the `chararray` type. + */ + public const CHARARRAY = 1002; + /** + * OID of the `namearray` type. + */ + public const NAMEARRAY = 1003; + /** + * OID of the `int2array` type. + */ + public const INT2ARRAY = 1005; + /** + * OID of the `int2vectorarray` type. + */ + public const INT2VECTORARRAY = 1006; + /** + * OID of the `int4array` type. + */ + public const INT4ARRAY = 1007; + /** + * OID of the `regprocarray` type. + */ + public const REGPROCARRAY = 1008; + /** + * OID of the `textarray` type. + */ + public const TEXTARRAY = 1009; + /** + * OID of the `oidarray` type. + */ + public const OIDARRAY = 1028; + /** + * OID of the `tidarray` type. + */ + public const TIDARRAY = 1010; + /** + * OID of the `xidarray` type. + */ + public const XIDARRAY = 1011; + /** + * OID of the `cidarray` type. + */ + public const CIDARRAY = 1012; + /** + * OID of the `oidvectorarray` type. + */ + public const OIDVECTORARRAY = 1013; + /** + * OID of the `bpchararray` type. + */ + public const BPCHARARRAY = 1014; + /** + * OID of the `varchararray` type. + */ + public const VARCHARARRAY = 1015; + /** + * OID of the `int8array` type. + */ + public const INT8ARRAY = 1016; + /** + * OID of the `pointarray` type. + */ + public const POINTARRAY = 1017; + /** + * OID of the `lsegarray` type. + */ + public const LSEGARRAY = 1018; + /** + * OID of the `patharray` type. + */ + public const PATHARRAY = 1019; + /** + * OID of the `boxarray` type. + */ + public const BOXARRAY = 1020; + /** + * OID of the `float4array` type. + */ + public const FLOAT4ARRAY = 1021; + /** + * OID of the `float8array` type. + */ + public const FLOAT8ARRAY = 1022; + /** + * OID of the `abstimearray` type. + */ + public const ABSTIMEARRAY = 1023; + /** + * OID of the `reltimearray` type. + */ + public const RELTIMEARRAY = 1024; + /** + * OID of the `tintervalarray` type. + */ + public const TINTERVALARRAY = 1025; + /** + * OID of the `polygonarray` type. + */ + public const POLYGONARRAY = 1027; + /** + * OID of the `aclitem` type. + */ + public const ACLITEM = 1033; + /** + * OID of the `aclitemarray` type. + */ + public const ACLITEMARRAY = 1034; + /** + * OID of the `macaddrarray` type. + */ + public const MACADDRARRAY = 1040; + /** + * OID of the `inetarray` type. + */ + public const INETARRAY = 1041; + /** + * OID of the `cidrarray` type. + */ + public const CIDRARRAY = 651; + /** + * OID of the `cstringarray` type. + */ + public const CSTRINGARRAY = 1263; + /** + * OID of the `bpchar` type. + */ + public const BPCHAR = 1042; + /** + * OID of the `varchar` type. + */ + public const VARCHAR = 1043; + /** + * OID of the `date` type. + */ + public const DATE = 1082; + /** + * OID of the `time` type. + */ + public const TIME = 1083; + /** + * OID of the `timestamp` type. + */ + public const TIMESTAMP = 1114; + /** + * OID of the `timestamparray` type. + */ + public const TIMESTAMPARRAY = 1115; + /** + * OID of the `datearray` type. + */ + public const DATEARRAY = 1182; + /** + * OID of the `timearray` type. + */ + public const TIMEARRAY = 1183; + /** + * OID of the `timestamptz` type. + */ + public const TIMESTAMPTZ = 1184; + /** + * OID of the `timestamptzarray` type. + */ + public const TIMESTAMPTZARRAY = 1185; + /** + * OID of the `interval` type. + */ + public const INTERVAL = 1186; + /** + * OID of the `intervalarray` type. + */ + public const INTERVALARRAY = 1187; + /** + * OID of the `numericarray` type. + */ + public const NUMERICARRAY = 1231; + /** + * OID of the `timetz` type. + */ + public const TIMETZ = 1266; + /** + * OID of the `timetzarray` type. + */ + public const TIMETZARRAY = 1270; + /** + * OID of the `bit` type. + */ + public const BIT = 1560; + /** + * OID of the `bitarray` type. + */ + public const BITARRAY = 1561; + /** + * OID of the `varbit` type. + */ + public const VARBIT = 1562; + /** + * OID of the `varbitarray` type. + */ + public const VARBITARRAY = 1563; + /** + * OID of the `numeric` type. + */ + public const NUMERIC = 1700; + /** + * OID of the `refcursor` type. + */ + public const REFCURSOR = 1790; + /** + * OID of the `refcursorarray` type. + */ + public const REFCURSORARRAY = 2201; + /** + * OID of the `regprocedure` type. + */ + public const REGPROCEDURE = 2202; + /** + * OID of the `regoper` type. + */ + public const REGOPER = 2203; + /** + * OID of the `regoperator` type. + */ + public const REGOPERATOR = 2204; + /** + * OID of the `regclass` type. + */ + public const REGCLASS = 2205; + /** + * OID of the `regtype` type. + */ + public const REGTYPE = 2206; + /** + * OID of the `regprocedurearray` type. + */ + public const REGPROCEDUREARRAY = 2207; + /** + * OID of the `regoperarray` type. + */ + public const REGOPERARRAY = 2208; + /** + * OID of the `regoperatorarray` type. + */ + public const REGOPERATORARRAY = 2209; + /** + * OID of the `regclassarray` type. + */ + public const REGCLASSARRAY = 2210; + /** + * OID of the `regtypearray` type. + */ + public const REGTYPEARRAY = 2211; + /** + * OID of the `uuid` type. + */ + public const UUID = 2950; + /** + * OID of the `uuidarray` type. + */ + public const UUIDARRAY = 2951; + /** + * OID of the `tsvector` type. + */ + public const TSVECTOR = 3614; + /** + * OID of the `gtsvector` type. + */ + public const GTSVECTOR = 3642; + /** + * OID of the `tsquery` type. + */ + public const TSQUERY = 3615; + /** + * OID of the `regconfig` type. + */ + public const REGCONFIG = 3734; + /** + * OID of the `regdictionary` type. + */ + public const REGDICTIONARY = 3769; + /** + * OID of the `tsvectorarray` type. + */ + public const TSVECTORARRAY = 3643; + /** + * OID of the `gtsvectorarray` type. + */ + public const GTSVECTORARRAY = 3644; + /** + * OID of the `tsqueryarray` type. + */ + public const TSQUERYARRAY = 3645; + /** + * OID of the `regconfigarray` type. + */ + public const REGCONFIGARRAY = 3735; + /** + * OID of the `regdictionaryarray` type. + */ + public const REGDICTIONARYARRAY = 3770; + /** + * OID of the `txid_snapshot` type. + */ + public const TXID_SNAPSHOT = 2970; + /** + * OID of the `txid_snapshotarray` type. + */ + public const TXID_SNAPSHOTARRAY = 2949; + /** + * OID of the `int4range` type. + */ + public const INT4RANGE = 3904; + /** + * OID of the `int4rangearray` type. + */ + public const INT4RANGEARRAY = 3905; + /** + * OID of the `numrange` type. + */ + public const NUMRANGE = 3906; + /** + * OID of the `numrangearray` type. + */ + public const NUMRANGEARRAY = 3907; + /** + * OID of the `tsrange` type. + */ + public const TSRANGE = 3908; + /** + * OID of the `tsrangearray` type. + */ + public const TSRANGEARRAY = 3909; + /** + * OID of the `tstzrange` type. + */ + public const TSTZRANGE = 3910; + /** + * OID of the `tstzrangearray` type. + */ + public const TSTZRANGEARRAY = 3911; + /** + * OID of the `daterange` type. + */ + public const DATERANGE = 3912; + /** + * OID of the `daterangearray` type. + */ + public const DATERANGEARRAY = 3913; + /** + * OID of the `int8range` type. + */ + public const INT8RANGE = 3926; + /** + * OID of the `int8rangearray` type. + */ + public const INT8RANGEARRAY = 3927; + /** + * OID of the `record` type. + */ + public const RECORD = 2249; + /** + * OID of the `recordarray` type. + */ + public const RECORDARRAY = 2287; + /** + * OID of the `cstring` type. + */ + public const CSTRING = 2275; + /** + * OID of the `any` type. + */ + public const ANY = 2276; + /** + * OID of the `anyarray` type. + */ + public const ANYARRAY = 2277; + /** + * OID of the `void` type. + */ + public const VOID = 2278; + /** + * OID of the `trigger` type. + */ + public const TRIGGER = 2279; + /** + * OID of the `event_trigger` type. + */ + public const EVENT_TRIGGER = 3838; + /** + * OID of the `language_handler` type. + */ + public const LANGUAGE_HANDLER = 2280; + /** + * OID of the `internal` type. + */ + public const INTERNAL = 2281; + /** + * OID of the `opaque` type. + */ + public const OPAQUE = 2282; + /** + * OID of the `anyelement` type. + */ + public const ANYELEMENT = 2283; + /** + * OID of the `anynonarray` type. + */ + public const ANYNONARRAY = 2776; + /** + * OID of the `anyenum` type. + */ + public const ANYENUM = 3500; + /** + * OID of the `fdw_handler` type. + */ + public const FDW_HANDLER = 3115; + /** + * OID of the `anyrange` type. + */ + public const ANYRANGE = 3831; + /** + * The connection which was used to obtain type information. + * + * @public + * @readonly + * @var \pq\Connection + */ + public $connection; + /** + * Create a new instance populated with information obtained from the `pg_type` relation. + * + * @param \pq\Connection $conn The connection to use. + * @param array $namespaces Which namespaces to query (defaults to `public` and `pg_catalog`). + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + */ + public function __construct(pq\Connection $conn, array $namespaces = null) {} + /** + * Refresh type information from `pg_type`. + * + * @param array $namespaces Which namespaces to query (defaults to `public` and `pg_catalog`). + * @throws \pq\Exception\InvalidArgumentException + * @throws \pq\Exception\BadMethodCallException + * @throws \pq\Exception\RuntimeException + */ + public function refresh(array $namespaces = null) {} } + namespace pq\Exception; + /** * A method call was not expected. */ -class BadMethodCallException extends \BadMethodCallException implements \pq\Exception { -} +class BadMethodCallException extends \BadMethodCallException implements \pq\Exception {} /** * Implementation or SQL syntax error. */ -class DomainException extends \DomainException implements \pq\Exception { - /** - * The SQLSTATE code, see the [official documentation](http://www.postgresql.org/docs/current/static/errcodes-appendix.html) for further information. - * - * @public - * @readonly - * @var string - */ - public $sqlstate; +class DomainException extends \DomainException implements \pq\Exception +{ + /** + * The SQLSTATE code, see the [official documentation](http://www.postgresql.org/docs/current/static/errcodes-appendix.html) for further information. + * + * @public + * @readonly + * @var string + */ + public $sqlstate; } /** * An invalid argument was passed to a method. */ -class InvalidArgumentException extends \InvalidArgumentException implements \pq\Exception { -} +class InvalidArgumentException extends \InvalidArgumentException implements \pq\Exception {} /** * A runtime exception occurred. */ -class RuntimeException extends \RuntimeException implements \pq\Exception { -} +class RuntimeException extends \RuntimeException implements \pq\Exception {} diff --git a/pspell/pspell.php b/pspell/pspell.php index a8cc8ca92..38a7d0253 100644 --- a/pspell/pspell.php +++ b/pspell/pspell.php @@ -34,7 +34,7 @@ * suggestions) * @return int|false the dictionary link identifier on success or FALSE on failure. */ -function pspell_new ($language, $spelling = null, $jargon = null, $encoding = null, $mode = 0) {} +function pspell_new($language, $spelling = null, $jargon = null, $encoding = null, $mode = 0) {} /** * Load a new dictionary with personal wordlist @@ -71,7 +71,7 @@ function pspell_new ($language, $spelling = null, $jargon = null, $encoding = nu * suggestions) * @return int the dictionary link identifier for use in other pspell functions. */ -function pspell_new_personal ($personal, $language, $spelling = null, $jargon = null, $encoding = null, $mode = 0) {} +function pspell_new_personal($personal, $language, $spelling = null, $jargon = null, $encoding = null, $mode = 0) {} /** * Load a new dictionary with settings based on a given config @@ -82,7 +82,7 @@ function pspell_new_personal ($personal, $language, $spelling = null, $jargon = * * @return int a dictionary link identifier on success. */ -function pspell_new_config ($config) {} +function pspell_new_config($config) {} /** * Check a word @@ -93,7 +93,7 @@ function pspell_new_config ($config) {} * * @return bool TRUE if the spelling is correct, FALSE if not. */ -function pspell_check ($dictionary_link, $word) {} +function pspell_check($dictionary_link, $word) {} /** * Suggest spellings of a word @@ -104,7 +104,7 @@ function pspell_check ($dictionary_link, $word) {} * * @return array an array of possible spellings. */ -function pspell_suggest ($dictionary_link, $word) {} +function pspell_suggest($dictionary_link, $word) {} /** * Store a replacement pair for a word @@ -121,7 +121,7 @@ function pspell_suggest ($dictionary_link, $word) {} * * @return bool TRUE on success or FALSE on failure. */ -function pspell_store_replacement ($dictionary_link, $misspelled, $correct) {} +function pspell_store_replacement($dictionary_link, $misspelled, $correct) {} /** * Add the word to a personal wordlist @@ -132,7 +132,7 @@ function pspell_store_replacement ($dictionary_link, $misspelled, $correct) {} * * @return bool TRUE on success or FALSE on failure. */ -function pspell_add_to_personal ($dictionary_link, $word) {} +function pspell_add_to_personal($dictionary_link, $word) {} /** * Add the word to the wordlist in the current session @@ -143,7 +143,7 @@ function pspell_add_to_personal ($dictionary_link, $word) {} * * @return bool TRUE on success or FALSE on failure. */ -function pspell_add_to_session ($dictionary_link, $word) {} +function pspell_add_to_session($dictionary_link, $word) {} /** * Clear the current session @@ -151,7 +151,7 @@ function pspell_add_to_session ($dictionary_link, $word) {} * @param int $dictionary_link * @return bool TRUE on success or FALSE on failure. */ -function pspell_clear_session ($dictionary_link) {} +function pspell_clear_session($dictionary_link) {} /** * Save the personal wordlist to a file @@ -162,7 +162,7 @@ function pspell_clear_session ($dictionary_link) {} * * @return bool TRUE on success or FALSE on failure. */ -function pspell_save_wordlist ($dictionary_link) {} +function pspell_save_wordlist($dictionary_link) {} /** * Create a config used to open a dictionary @@ -191,7 +191,7 @@ function pspell_save_wordlist ($dictionary_link) {} * * @return int|false Retuns a pspell config identifier, or FALSE on error. */ -function pspell_config_create ($language, $spelling = null, $jargon = null, $encoding = null) {} +function pspell_config_create($language, $spelling = null, $jargon = null, $encoding = null) {} /** * Consider run-together words as valid compounds @@ -203,7 +203,7 @@ function pspell_config_create ($language, $spelling = null, $jargon = null, $enc * * @return bool TRUE on success or FALSE on failure. */ -function pspell_config_runtogether ($dictionary_link, $flag) {} +function pspell_config_runtogether($dictionary_link, $flag) {} /** * Change the mode number of suggestions returned @@ -216,7 +216,7 @@ function pspell_config_runtogether ($dictionary_link, $flag) {} * suggestions) * @return bool TRUE on success or FALSE on failure. */ -function pspell_config_mode ($dictionary_link, $mode) {} +function pspell_config_mode($dictionary_link, $mode) {} /** * Ignore words less than N characters long @@ -227,7 +227,7 @@ function pspell_config_mode ($dictionary_link, $mode) {} * * @return bool TRUE on success or FALSE on failure. */ -function pspell_config_ignore ($dictionary_link, $n) {} +function pspell_config_ignore($dictionary_link, $n) {} /** * Set a file that contains personal wordlist @@ -239,7 +239,7 @@ function pspell_config_ignore ($dictionary_link, $n) {} * * @return bool TRUE on success or FALSE on failure. */ -function pspell_config_personal ($dictionary_link, $file) {} +function pspell_config_personal($dictionary_link, $file) {} /** * Location of the main word list @@ -248,7 +248,7 @@ function pspell_config_personal ($dictionary_link, $file) {} * @param string $directory * @return bool TRUE on success or FALSE on failure. */ -function pspell_config_dict_dir ($conf, $directory) {} +function pspell_config_dict_dir($conf, $directory) {} /** * location of language data files @@ -257,7 +257,7 @@ function pspell_config_dict_dir ($conf, $directory) {} * @param string $directory * @return bool TRUE on success or FALSE on failure. */ -function pspell_config_data_dir ($conf, $directory) {} +function pspell_config_data_dir($conf, $directory) {} /** * Set a file that contains replacement pairs @@ -268,7 +268,7 @@ function pspell_config_data_dir ($conf, $directory) {} * * @return bool TRUE on success or FALSE on failure. */ -function pspell_config_repl ($dictionary_link, $file) {} +function pspell_config_repl($dictionary_link, $file) {} /** * Determine whether to save a replacement pairs list @@ -280,12 +280,11 @@ function pspell_config_repl ($dictionary_link, $file) {} * * @return bool TRUE on success or FALSE on failure. */ -function pspell_config_save_repl ($dictionary_link, $flag) {} +function pspell_config_save_repl($dictionary_link, $flag) {} -define ('PSPELL_FAST', 1); -define ('PSPELL_NORMAL', 2); -define ('PSPELL_BAD_SPELLERS', 3); -define ('PSPELL_RUN_TOGETHER', 8); +define('PSPELL_FAST', 1); +define('PSPELL_NORMAL', 2); +define('PSPELL_BAD_SPELLERS', 3); +define('PSPELL_RUN_TOGETHER', 8); // End of pspell v. -?> diff --git a/pthreads/pthreads.php b/pthreads/pthreads.php index 389b192ea..05cd71ae7 100644 --- a/pthreads/pthreads.php +++ b/pthreads/pthreads.php @@ -65,7 +65,8 @@ * including the management of references in the way required by pthreads. * @link https://secure.php.net/manual/en/class.pool.php */ -class Pool { +class Pool +{ /** * Maximum number of Workers this Pool can use * @var int @@ -107,7 +108,7 @@ class Pool { * @param array $ctor [optional]An array of arguments to be passed to new * Workers
*/ - public function __construct( int $size, string $class = 'Worker', array $ctor = [] ) {} + public function __construct(int $size, string $class = 'Worker', array $ctor = []) {} /** * (PECL pthreads >= 2.0.0)The number of remaining tasks in the pool to be collected
*/ - public function collect( ?callable $collector = null ) {} + public function collect(?callable $collector = null) {} /** * (PECL pthreads >= 2.0.0)The maximum number of Workers this Pool can create
* @return void */ - public function resize( int $size ) {} + public function resize(int $size) {} /** * (PECL pthreads >= 2.0.0)The task for execution
* @return intthe identifier of the Worker executing the object
*/ - public function submit( Threaded $task ) {} + public function submit(Threaded $task) {} /** * (PECL pthreads >= 2.0.0)The task for execution
* @return intThe identifier of the worker that accepted the task
*/ - public function submitTo( int $worker, Threaded $task ) {} + public function submitTo(int $worker, Threaded $task) {} } /** @@ -170,7 +171,8 @@ public function submitTo( int $worker, Threaded $task ) {} * * @link https://secure.php.net/manual/en/class.threaded.php */ -class Threaded implements Collectable, Traversable, Countable, ArrayAccess { +class Threaded implements Collectable, Traversable, Countable, ArrayAccess +{ /** * Worker object in which this Threaded is being executed * @var Worker @@ -193,7 +195,7 @@ public function addRef() {} * @param bool $preserve [optional]Preserve the keys of members, by default false
* @return arrayAn array of items from the objects property table
*/ - public function chunk( $size, $preserve = false ) {} + public function chunk($size, $preserve = false) {} /** * (PECL pthreads >= 2.0.0)The class to extend
* @return boolA boolean indication of success
*/ - public static function extend( $class ) {} + public static function extend($class) {} /** * (PECL pthreads >= 3.0.0)The data to merge
- * @var bool $overwrite [optional]Overwrite existing keys, by default true
+ * @var mixedThe data to merge
+ * @var bool [optional]Overwrite existing keys, by default true
* @return boolA boolean indication of success
*/ - public function merge( $from, $overwrite = true ) {} + public function merge($from, $overwrite = true) {} /** * (PECL pthreads >= 2.0.0)The return value from the block
*/ - public function synchronized( Closure $block, ...$_ ) {} + public function synchronized(Closure $block, ...$_) {} /** * (PECL pthreads >= 2.0.0)An optional timeout in microseconds
* @return boolA boolean indication of success
*/ - public function wait( int $timeout = 0 ) {} - + public function wait(int $timeout = 0) {} /** * @inheritdoc * @see ArrayAccess::offsetExists() */ - public function offsetExists( $offset ) {} + public function offsetExists($offset) {} /** * @inheritdoc * @see ArrayAccess::offsetGet() */ - public function offsetGet( $offset ) {} + public function offsetGet($offset) {} /** * @inheritdoc * @see ArrayAccess::offsetSet() */ - public function offsetSet( $offset, $value ) {} + public function offsetSet($offset, $value) {} /** * @inheritdoc * @see ArrayAccess::offsetUnset() */ - public function offsetUnset( $offset ) {} + public function offsetUnset($offset) {} } /** @@ -360,8 +361,8 @@ public function offsetUnset( $offset ) {} * * @link https://secure.php.net/manual/en/class.thread.php */ -class Thread extends Threaded implements Countable, Traversable, ArrayAccess { - +class Thread extends Threaded implements Countable, Traversable, ArrayAccess +{ /** * (PECL pthreads >= 2.0.0)A boolean indication of success
*/ - public function start( int $options = PTHREADS_INHERIT_ALL ) {} + public function start(int $options = PTHREADS_INHERIT_ALL) {} } /** @@ -443,7 +444,8 @@ public function start( int $options = PTHREADS_INHERIT_ALL ) {} * objects run method. * @link https://secure.php.net/manual/en/class.worker.php */ -class Worker extends Thread implements Traversable, Countable, ArrayAccess { +class Worker extends Thread implements Traversable, Countable, ArrayAccess +{ /** * (PECL pthreads >= 3.0.0)The number of remaining tasks on the worker's stack to be * collected
*/ - public function collect( ?callable $collector = null ) {} + public function collect(?callable $collector = null) {} /** * (PECL pthreads >= 2.0.0)A Threaded object to be executed by the Worker
* @return intThe new size of the stack
*/ - public function stack( Threaded $work ) {} + public function stack(Threaded $work) {} /** * (PECL pthreads >= 2.0.0)* If called with one or two parameters, the old value is returned. */ -function readline_info (?string $var_name, $value): mixed {} +function readline_info(?string $var_name, $value): mixed {} /** * Adds a line to the history @@ -41,16 +41,14 @@ function readline_info (?string $var_name, $value): mixed {} *
* @return bool TRUE on success or FALSE on failure. */ -function readline_add_history (string $prompt): bool -{} +function readline_add_history(string $prompt): bool {} /** * Clears the history * @link https://php.net/manual/en/function.readline-clear-history.php * @return bool TRUE on success or FALSE on failure. */ -function readline_clear_history (): bool -{} +function readline_clear_history(): bool {} /** * Lists the history @@ -58,8 +56,7 @@ function readline_clear_history (): bool * @return array an array of the entire command line history. The elements are * indexed by integers starting at zero. */ -function readline_list_history (): array -{} +function readline_list_history(): array {} /** * Reads the history @@ -69,8 +66,7 @@ function readline_list_history (): array * * @return bool TRUE on success or FALSE on failure. */ -function readline_read_history (?string $filename): bool -{} +function readline_read_history(?string $filename): bool {} /** * Writes the history @@ -80,8 +76,7 @@ function readline_read_history (?string $filename): bool * * @return bool TRUE on success or FALSE on failure. */ -function readline_write_history (?string $filename): bool -{} +function readline_write_history(?string $filename): bool {} /** * Registers a completion function @@ -92,8 +87,7 @@ function readline_write_history (?string $filename): bool * * @return bool TRUE on success or FALSE on failure. */ -function readline_completion_function (callable $callback): bool -{} +function readline_completion_function(callable $callback): bool {} /** * Initializes the readline callback interface and terminal, prints the prompt and returns immediately @@ -107,15 +101,14 @@ function readline_completion_function (callable $callback): bool * * @return bool TRUE on success or FALSE on failure. */ -function readline_callback_handler_install (string $prompt, callable $callback): bool -{} +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 https://php.net/manual/en/function.readline-callback-read-char.php * @return void No value is returned. */ -function readline_callback_read_char (): void {} +function readline_callback_read_char(): void {} /** * Removes a previously installed callback handler and restores terminal settings @@ -123,24 +116,22 @@ function readline_callback_read_char (): void {} * @return bool TRUE if a previously installed callback handler was removed, or * FALSE if one could not be found. */ -function readline_callback_handler_remove (): bool -{} +function readline_callback_handler_remove(): bool {} /** * Redraws the display * @link https://php.net/manual/en/function.readline-redisplay.php * @return void No value is returned. */ -function readline_redisplay (): void {} +function readline_redisplay(): void {} /** * Inform readline that the cursor has moved to a new line * @link https://php.net/manual/en/function.readline-on-new-line.php * @return void No value is returned. */ -function readline_on_new_line (): void {} +function readline_on_new_line(): void {} -define ('READLINE_LIB', "libedit"); +define('READLINE_LIB', "libedit"); // End of readline v.5.5.3-1ubuntu2.1 -?> diff --git a/recode/recode.php b/recode/recode.php index 26f23cc44..4db76bec7 100644 --- a/recode/recode.php +++ b/recode/recode.php @@ -14,7 +14,7 @@ * @return string|false the recoded string or FALSE, if unable to * perform the recode request. */ -function recode_string ($request, $string) {} +function recode_string($request, $string) {} /** * Recode from file to file according to recode request @@ -32,7 +32,7 @@ function recode_string ($request, $string) {} * * @return bool FALSE, if unable to comply, TRUE otherwise. */ -function recode_file ($request, $input, $output) {} +function recode_file($request, $input, $output) {} /** * Alias of recode_string @@ -40,7 +40,6 @@ function recode_file ($request, $input, $output) {} * @param $request * @param $str */ -function recode ($request, $str) {} +function recode($request, $str) {} // End of recode v. -?> diff --git a/redis/Redis.php b/redis/Redis.php index 37577d2ad..ef63fff8f 100644 --- a/redis/Redis.php +++ b/redis/Redis.php @@ -10,96 +10,94 @@ */ class Redis { - const AFTER = 'after'; - const BEFORE = 'before'; + public const AFTER = 'after'; + public const BEFORE = 'before'; /** * Options */ - const OPT_SERIALIZER = 1; - const OPT_PREFIX = 2; - const OPT_READ_TIMEOUT = 3; - const OPT_SCAN = 4; - const OPT_FAILOVER = 5; - const OPT_TCP_KEEPALIVE = 6; - const OPT_COMPRESSION = 7; - const OPT_REPLY_LITERAL = 8; - const OPT_COMPRESSION_LEVEL = 9; + public const OPT_SERIALIZER = 1; + public const OPT_PREFIX = 2; + public const OPT_READ_TIMEOUT = 3; + public const OPT_SCAN = 4; + public const OPT_FAILOVER = 5; + public const OPT_TCP_KEEPALIVE = 6; + public const OPT_COMPRESSION = 7; + public const OPT_REPLY_LITERAL = 8; + public const OPT_COMPRESSION_LEVEL = 9; /** * Cluster options */ - const FAILOVER_NONE = 0; - const FAILOVER_ERROR = 1; - const FAILOVER_DISTRIBUTE = 2; - const FAILOVER_DISTRIBUTE_SLAVES = 3; + public const FAILOVER_NONE = 0; + public const FAILOVER_ERROR = 1; + public const FAILOVER_DISTRIBUTE = 2; + public const FAILOVER_DISTRIBUTE_SLAVES = 3; /** * SCAN options */ - const SCAN_NORETRY = 0; - const SCAN_RETRY = 1; + public const SCAN_NORETRY = 0; + public const SCAN_RETRY = 1; /** * @since 5.3.0 */ - const SCAN_PREFIX = 2; + public const SCAN_PREFIX = 2; /** * @since 5.3.0 */ - const SCAN_NOPREFIX = 3; + public const SCAN_NOPREFIX = 3; /** * Serializers */ - const SERIALIZER_NONE = 0; - const SERIALIZER_PHP = 1; - const SERIALIZER_IGBINARY = 2; - const SERIALIZER_MSGPACK = 3; - const SERIALIZER_JSON = 4; + public const SERIALIZER_NONE = 0; + public const SERIALIZER_PHP = 1; + public const SERIALIZER_IGBINARY = 2; + public const SERIALIZER_MSGPACK = 3; + public const SERIALIZER_JSON = 4; /** * Compressions */ - const COMPRESSION_NONE = 0; - const COMPRESSION_LZF = 1; - const COMPRESSION_ZSTD = 2; - const COMPRESSION_LZ4 = 3; + public const COMPRESSION_NONE = 0; + public const COMPRESSION_LZF = 1; + public const COMPRESSION_ZSTD = 2; + public const COMPRESSION_LZ4 = 3; /** * Compression ZSTD levels */ - const COMPRESSION_ZSTD_MIN = 1; - const COMPRESSION_ZSTD_DEFAULT = 3; - const COMPRESSION_ZSTD_MAX = 22; + public const COMPRESSION_ZSTD_MIN = 1; + public const COMPRESSION_ZSTD_DEFAULT = 3; + public const COMPRESSION_ZSTD_MAX = 22; /** * Multi */ - const ATOMIC = 0; - const MULTI = 1; - const PIPELINE = 2; + public const ATOMIC = 0; + public const MULTI = 1; + public const PIPELINE = 2; /** * Type */ - const REDIS_NOT_FOUND = 0; - const REDIS_STRING = 1; - const REDIS_SET = 2; - const REDIS_LIST = 3; - const REDIS_ZSET = 4; - const REDIS_HASH = 5; - const REDIS_STREAM = 6; + public const REDIS_NOT_FOUND = 0; + public const REDIS_STRING = 1; + public const REDIS_SET = 2; + public const REDIS_LIST = 3; + public const REDIS_ZSET = 4; + public const REDIS_HASH = 5; + public const REDIS_STREAM = 6; /** * Creates a Redis client * * @example $redis = new Redis(); */ - public function __construct() - { - } + public function __construct() {} /** * Connects to a Redis instance. @@ -128,8 +126,7 @@ public function connect( $reserved = null, $retryInterval = 0, $readTimeout = 0.0 - ) { - } + ) {} /** * Connects to a Redis instance. @@ -151,35 +148,28 @@ public function open( $reserved = null, $retryInterval = 0, $readTimeout = 0.0 - ) { - } + ) {} /** * A method to determine if a phpredis object thinks it's connected to a server * * @return bool Returns TRUE if phpredis thinks it's connected and FALSE if not */ - public function isConnected() - { - } + public function isConnected() {} /** * Retrieve our host or unix socket that we're connected to * * @return string|false The host or unix socket we're connected to or FALSE if we're not connected */ - public function getHost() - { - } + public function getHost() {} /** * Get the port we're connected to * * @return int|false Returns the port we're connected to or FALSE if we're not connected */ - public function getPort() - { - } + public function getPort() {} /** * Get the database number phpredis is pointed to @@ -187,18 +177,14 @@ public function getPort() * @return int|bool Returns the database number (int) phpredis thinks it's pointing to * or FALSE if we're not connected */ - public function getDbNum() - { - } + public function getDbNum() {} /** * Get the (write) timeout in use for phpredis * * @return float|false The timeout (DOUBLE) specified in our connect call or FALSE if we're not connected */ - public function getTimeout() - { - } + public function getTimeout() {} /** * Get the read timeout specified to phpredis or FALSE if we're not connected @@ -206,9 +192,7 @@ public function getTimeout() * @return float|bool Returns the read timeout (which can be set using setOption and Redis::OPT_READ_TIMEOUT) * or FALSE if we're not connected */ - public function getReadTimeout() - { - } + public function getReadTimeout() {} /** * Gets the persistent ID that phpredis is using @@ -218,9 +202,7 @@ public function getReadTimeout() * NULL if we're not using a persistent ID, * and FALSE if we're not connected */ - public function getPersistentID() - { - } + public function getPersistentID() {} /** * Get the password used to authenticate the phpredis connection @@ -228,9 +210,7 @@ public function getPersistentID() * @return string|null|bool Returns the password used to authenticate a phpredis session or NULL if none was used, * and FALSE if we're not connected */ - public function getAuth() - { - } + public function getAuth() {} /** * Connects to a Redis instance or reuse a connection already established with pconnect/popen. @@ -278,8 +258,7 @@ public function pconnect( $persistentId = null, $retryInterval = 0, $readTimeout = 0.0 - ) { - } + ) {} /** * @param string $host @@ -299,8 +278,7 @@ public function popen( $persistentId = '', $retryInterval = 0, $readTimeout = 0.0 - ) { - } + ) {} /** * Disconnects from the Redis instance. @@ -311,9 +289,7 @@ public function popen( * * @return bool TRUE on success, FALSE on error */ - public function close() - { - } + public function close() {} /** * Swap one Redis database with another atomically @@ -333,9 +309,7 @@ public function close() * $redis->swapdb(0, 1); * */ - public function swapdb(int $db1, int $db2) - { - } + public function swapdb(int $db1, int $db2) {} /** * Set client option @@ -364,9 +338,7 @@ public function swapdb(int $db1, int $db2) * $redis->setOption(Redis::OPT_SCAN, Redis::SCAN_RETRY); * */ - public function setOption($option, $value) - { - } + public function setOption($option, $value) {} /** * Get client option @@ -380,9 +352,7 @@ public function setOption($option, $value) * // return option value * $redis->getOption(Redis::OPT_SERIALIZER); */ - public function getOption($option) - { - } + public function getOption($option) {} /** * Check the current connection status @@ -394,9 +364,7 @@ public function getOption($option) * @throws RedisException * @link https://redis.io/commands/ping */ - public function ping($message = null) - { - } + public function ping($message = null) {} /** * Echo the given string @@ -407,9 +375,7 @@ public function ping($message = null) * * @link https://redis.io/commands/echo */ - public function echo($message) - { - } + public function echo($message) {} /** * Get the value related to the specified key @@ -438,9 +404,7 @@ public function echo($message) * } * */ - public function get($key) - { - } + public function get($key) {} /** * Set the string value in argument as value of the key. @@ -473,9 +437,7 @@ public function get($key) * * @link https://redis.io/commands/set */ - public function set($key, $value, $timeout = null) - { - } + public function set($key, $value, $timeout = null) {} /** * Set the string value in argument as value of the key, with a time to live. @@ -489,9 +451,7 @@ public function set($key, $value, $timeout = null) * @link https://redis.io/commands/setex * @example $redis->setex('key', 3600, 'value'); // sets key → value, with 1h TTL. */ - public function setex($key, $ttl, $value) - { - } + public function setex($key, $ttl, $value) {} /** * Set the value and expiration in milliseconds of a key. @@ -506,9 +466,7 @@ public function setex($key, $ttl, $value) * @link https://redis.io/commands/psetex * @example $redis->psetex('key', 1000, 'value'); // sets key → value, with 1sec TTL. */ - public function psetex($key, $ttl, $value) - { - } + public function psetex($key, $ttl, $value) {} /** * Set the string value in argument as value of the key if the key doesn't already exist in the database. @@ -525,9 +483,7 @@ public function psetex($key, $ttl, $value) * $redis->setnx('key', 'value'); // return FALSE * */ - public function setnx($key, $value) - { - } + public function setnx($key, $value) {} /** * Remove specified keys. @@ -549,9 +505,7 @@ public function setnx($key, $value) * $redis->del(['key3', 'key4']); // return 2 * */ - public function del($key1, ...$otherKeys) - { - } + public function del($key1, ...$otherKeys) {} /** * @param string|string[] $key1 @@ -561,9 +515,7 @@ public function del($key1, ...$otherKeys) * @return int Number of keys deleted */ #[Deprecated(replacement: "%class%->del(%parametersList%)")] - public function delete($key1, $key2 = null, $key3 = null) - { - } + public function delete($key1, $key2 = null, $key3 = null) {} /** * Delete a key asynchronously in another thread. Otherwise it is just as DEL, but non blocking. @@ -586,9 +538,7 @@ public function delete($key1, $key2 = null, $key3 = null) * $redis->unlink(array('key3', 'key4')); // return 2 * */ - public function unlink($key1, $key2 = null, $key3 = null) - { - } + public function unlink($key1, $key2 = null, $key3 = null) {} /** * Enter and exit transactional mode. @@ -619,9 +569,7 @@ public function unlink($key1, $key2 = null, $key3 = null) * // 3 => 'val2'); * */ - public function multi($mode = Redis::MULTI) - { - } + public function multi($mode = Redis::MULTI) {} /** * Returns a Redis instance which can simply transmitted faster to the server. @@ -650,10 +598,7 @@ public function multi($mode = Redis::MULTI) * // 4 => '+PONG'); * */ - public function pipeline() - { - } - + public function pipeline() {} /** * @return void|array @@ -661,17 +606,13 @@ public function pipeline() * @see multi() * @link https://redis.io/commands/exec */ - public function exec() - { - } + public function exec() {} /** * @see multi() * @link https://redis.io/commands/discard */ - public function discard() - { - } + public function discard() {} /** * Watches a key for modifications by another client. If the key is modified between WATCH and EXEC, @@ -691,17 +632,13 @@ public function discard() * // $ret = FALSE if x has been modified between the call to WATCH and the call to EXEC. * */ - public function watch($key) - { - } + public function watch($key) {} /** * @see watch() * @link https://redis.io/commands/unwatch */ - public function unwatch() - { - } + public function unwatch() {} /** * Subscribe to channels. @@ -736,9 +673,7 @@ public function unwatch() * $redis->subscribe(array('chan-1', 'chan-2', 'chan-3'), 'f'); // subscribe to 3 chans * */ - public function subscribe($channels, $callback) - { - } + public function subscribe($channels, $callback) {} /** * Subscribe to channels by pattern @@ -758,9 +693,7 @@ public function subscribe($channels, $callback) * } * */ - public function psubscribe($patterns, $callback) - { - } + public function psubscribe($patterns, $callback) {} /** * Publish messages to channels. @@ -775,9 +708,7 @@ public function psubscribe($patterns, $callback) * @link https://redis.io/commands/publish * @example $redis->publish('chan-1', 'hello, world!'); // send message. */ - public function publish($channel, $message) - { - } + public function publish($channel, $message) {} /** * A command allowing you to get information on the Redis pub/sub system @@ -802,9 +733,7 @@ public function publish($channel, $message) * $redis->pubsub('numpat'); // Get the number of pattern subscribers * */ - public function pubsub($keyword, $argument) - { - } + public function pubsub($keyword, $argument) {} /** * Stop listening for messages posted to the given channels. @@ -813,9 +742,7 @@ public function pubsub($keyword, $argument) * * @link https://redis.io/commands/unsubscribe */ - public function unsubscribe($channels = null) - { - } + public function unsubscribe($channels = null) {} /** * Stop listening for messages posted to the given channels. @@ -824,9 +751,7 @@ public function unsubscribe($channels = null) * * @link https://redis.io/commands/punsubscribe */ - public function punsubscribe($patterns = null) - { - } + public function punsubscribe($patterns = null) {} /** * Verify if the specified key/keys exists @@ -851,9 +776,7 @@ public function punsubscribe($patterns = null) * $redis->exists('foo', 'bar', 'baz'); // 3 * */ - public function exists($key) - { - } + public function exists($key) {} /** * Increment the number stored at key by one. @@ -871,9 +794,7 @@ public function exists($key) * $redis->incr('key1'); // 4 * */ - public function incr($key) - { - } + public function incr($key) {} /** * Increment the float value of a key by the given amount @@ -891,9 +812,7 @@ public function incr($key) * $redis->get('x'); // float(4.5) * */ - public function incrByFloat($key, $increment) - { - } + public function incrByFloat($key, $increment) {} /** * Increment the number stored at key by one. @@ -914,9 +833,7 @@ public function incrByFloat($key, $increment) * $redis->incrBy('key1', 10); // 14 * */ - public function incrBy($key, $value) - { - } + public function incrBy($key, $value) {} /** * Decrement the number stored at key by one. @@ -933,9 +850,7 @@ public function incrBy($key, $value) * $redis->decr('key1'); // -3 * */ - public function decr($key) - { - } + public function decr($key) {} /** * Decrement the number stored at key by one. @@ -955,9 +870,7 @@ public function decr($key) * $redis->decrBy('key1', 10); // -13 * */ - public function decrBy($key, $value) - { - } + public function decrBy($key, $value) {} /** * Adds the string values to the head (left) of the list. @@ -983,9 +896,7 @@ public function decrBy($key, $value) * // } * */ - public function lPush($key, ...$value1) - { - } + public function lPush($key, ...$value1) {} /** * Adds the string values to the tail (right) of the list. @@ -1011,9 +922,7 @@ public function lPush($key, ...$value1) * // } * */ - public function rPush($key, ...$value1) - { - } + public function rPush($key, ...$value1) {} /** * Adds the string value to the head (left) of the list if the list exists. @@ -1034,9 +943,7 @@ public function rPush($key, ...$value1) * // key1 now points to the following list: [ 'A', 'B', 'C' ] * */ - public function lPushx($key, $value) - { - } + public function lPushx($key, $value) {} /** * Adds the string value to the tail (right) of the list if the ist exists. FALSE in case of Failure. @@ -1057,9 +964,7 @@ public function lPushx($key, $value) * // key1 now points to the following list: [ 'A', 'B', 'C' ] * */ - public function rPushx($key, $value) - { - } + public function rPushx($key, $value) {} /** * Returns and removes the first element of the list. @@ -1077,9 +982,7 @@ public function rPushx($key, $value) * $redis->lPop('key1'); // key1 => [ 'B', 'C' ] * */ - public function lPop($key) - { - } + public function lPop($key) {} /** * Returns and removes the last element of the list. @@ -1097,9 +1000,7 @@ public function lPop($key) * $redis->rPop('key1'); // key1 => [ 'A', 'B' ] * */ - public function rPop($key) - { - } + public function rPop($key) {} /** * Is a blocking lPop primitive. If at least one of the lists contains at least one element, @@ -1141,9 +1042,7 @@ public function rPop($key) * // array('key1', 'A') is returned * */ - public function blPop($keys, $timeout) - { - } + public function blPop($keys, $timeout) {} /** * Is a blocking rPop primitive. If at least one of the lists contains at least one element, @@ -1186,9 +1085,7 @@ public function blPop($keys, $timeout) * // array('key1', 'A') is returned * */ - public function brPop(array $keys, $timeout) - { - } + public function brPop(array $keys, $timeout) {} /** * Returns the size of a list identified by Key. If the list didn't exist or is empty, @@ -1210,9 +1107,7 @@ public function brPop(array $keys, $timeout) * $redis->lLen('key1'); // 2 * */ - public function lLen($key) - { - } + public function lLen($key) {} /** * @link https://redis.io/commands/llen @@ -1222,9 +1117,7 @@ public function lLen($key) * @return int The size of the list identified by Key exists */ #[Deprecated(replacement: '%class%->lLen(%parametersList%)')] - public function lSize($key) - { - } + public function lSize($key) {} /** * Return the specified element of the list stored at the specified key. @@ -1249,9 +1142,7 @@ public function lSize($key) * $redis->lIndex('key1', 10); // `FALSE` * */ - public function lIndex($key, $index) - { - } + public function lIndex($key, $index) {} /** * @link https://redis.io/commands/lindex @@ -1261,9 +1152,7 @@ public function lIndex($key, $index) * @return mixed|bool the element at this index */ #[Deprecated(replacement: '%class%->lIndex(%parametersList%)')] - public function lGet($key, $index) - { - } + public function lGet($key, $index) {} /** * Set the list at index with the new value. @@ -1286,9 +1175,7 @@ public function lGet($key, $index) * $redis->lIndex('key1', 0); // 'X' * */ - public function lSet($key, $index, $value) - { - } + public function lSet($key, $index, $value) {} /** * Returns the specified elements of the list stored at the specified key in @@ -1310,9 +1197,7 @@ public function lSet($key, $index, $value) * $redis->lRange('key1', 0, -1); // array('A', 'B', 'C') * */ - public function lRange($key, $start, $end) - { - } + public function lRange($key, $start, $end) {} /** * @link https://redis.io/commands/lrange @@ -1323,9 +1208,7 @@ public function lRange($key, $start, $end) * @return array */ #[Deprecated(replacement: '%class%->lRange(%parametersList%)')] - public function lGetRange($key, $start, $end) - { - } + public function lGetRange($key, $start, $end) {} /** * Trims an existing list so that it will contain only a specified range of elements. @@ -1347,9 +1230,7 @@ public function lGetRange($key, $start, $end) * $redis->lRange('key1', 0, -1); // array('A', 'B') * */ - public function lTrim($key, $start, $stop) - { - } + public function lTrim($key, $start, $stop) {} /** * @link https://redis.io/commands/ltrim @@ -1359,9 +1240,7 @@ public function lTrim($key, $start, $stop) * @param int $stop */ #[Deprecated(replacement: '%class%->lTrim(%parametersList%)')] - public function listTrim($key, $start, $stop) - { - } + public function listTrim($key, $start, $stop) {} /** * Removes the first count occurrences of the value element from the list. @@ -1389,9 +1268,7 @@ public function listTrim($key, $start, $stop) * $redis->lRange('key1', 0, -1); // array('C', 'B', 'A') * */ - public function lRem($key, $value, $count) - { - } + public function lRem($key, $value, $count) {} /** * @link https://redis.io/commands/lremove @@ -1401,9 +1278,7 @@ public function lRem($key, $value, $count) * @param int $count */ #[Deprecated(replacement: '%class%->lRem(%parametersList%)')] - public function lRemove($key, $value, $count) - { - } + public function lRemove($key, $value, $count) {} /** * Insert value in the list before or after the pivot value. the parameter options @@ -1436,9 +1311,7 @@ public function lRemove($key, $value, $count) * $redis->lInsert('key1', Redis::AFTER, 'W', 'value'); // -1 * */ - public function lInsert($key, $position, $pivot, $value) - { - } + public function lInsert($key, $position, $pivot, $value) {} /** * Adds a values to the set value stored at key. @@ -1456,9 +1329,7 @@ public function lInsert($key, $position, $pivot, $value) * $redis->sAdd('k', 'v1', 'v2', 'v3'); // int(2) * */ - public function sAdd($key, ...$value1) - { - } + public function sAdd($key, ...$value1) {} /** * Removes the specified members from the set value stored at key. @@ -1480,9 +1351,7 @@ public function sAdd($key, ...$value1) * // } * */ - public function sRem($key, ...$member1) - { - } + public function sRem($key, ...$member1) {} /** * @link https://redis.io/commands/srem @@ -1491,9 +1360,7 @@ public function sRem($key, ...$member1) * @param string|mixed ...$member1 */ #[Deprecated(replacement: '%class%->sRem(%parametersList%)')] - public function sRemove($key, ...$member1) - { - } + public function sRemove($key, ...$member1) {} /** * Moves the specified member from the set at srcKey to the set at dstKey. @@ -1517,9 +1384,7 @@ public function sRemove($key, ...$member1) * // 'key2' => {'set21', 'set22', 'set13'} * */ - public function sMove($srcKey, $dstKey, $member) - { - } + public function sMove($srcKey, $dstKey, $member) {} /** * Checks if value is a member of the set stored at the key key. @@ -1540,9 +1405,7 @@ public function sMove($srcKey, $dstKey, $member) * $redis->sIsMember('key1', 'setX'); // FALSE * */ - public function sIsMember($key, $value) - { - } + public function sIsMember($key, $value) {} /** * @link https://redis.io/commands/sismember @@ -1551,9 +1414,7 @@ public function sIsMember($key, $value) * @param string|mixed $value */ #[Deprecated(replacement: '%class%->sIsMember(%parametersList%)')] - public function sContains($key, $value) - { - } + public function sContains($key, $value) {} /** * Returns the cardinality of the set identified by key. @@ -1572,9 +1433,7 @@ public function sContains($key, $value) * $redis->sCard('keyX'); // 0 * */ - public function sCard($key) - { - } + public function sCard($key) {} /** * Removes and returns a random element from the set value at Key. @@ -1605,9 +1464,7 @@ public function sCard($key) * // } * */ - public function sPop($key, $count = 1) - { - } + public function sPop($key, $count = 1) {} /** * Returns a random element(s) from the set value at Key, without removing it. @@ -1637,9 +1494,7 @@ public function sPop($key, $count = 1) * // } * */ - public function sRandMember($key, $count = 1) - { - } + public function sRandMember($key, $count = 1) {} /** * Returns the members of a set resulting from the intersection of all the sets @@ -1676,9 +1531,7 @@ public function sRandMember($key, $count = 1) * //} * */ - public function sInter($key1, ...$otherKeys) - { - } + public function sInter($key1, ...$otherKeys) {} /** * Performs a sInter command and stores the result in a new set. @@ -1716,9 +1569,7 @@ public function sInter($key1, ...$otherKeys) * //} * */ - public function sInterStore($dstKey, $key1, ...$otherKeys) - { - } + public function sInterStore($dstKey, $key1, ...$otherKeys) {} /** * Performs the union between N sets and returns it. @@ -1752,9 +1603,7 @@ public function sInterStore($dstKey, $key1, ...$otherKeys) * //} * */ - public function sUnion($key1, ...$otherKeys) - { - } + public function sUnion($key1, ...$otherKeys) {} /** * Performs the same action as sUnion, but stores the result in the first key @@ -1793,9 +1642,7 @@ public function sUnion($key1, ...$otherKeys) * //} * */ - public function sUnionStore($dstKey, $key1, ...$otherKeys) - { - } + public function sUnionStore($dstKey, $key1, ...$otherKeys) {} /** * Performs the difference between N sets and returns it. @@ -1828,9 +1675,7 @@ public function sUnionStore($dstKey, $key1, ...$otherKeys) * //} * */ - public function sDiff($key1, ...$otherKeys) - { - } + public function sDiff($key1, ...$otherKeys) {} /** * Performs the same action as sDiff, but stores the result in the first key @@ -1866,9 +1711,7 @@ public function sDiff($key1, ...$otherKeys) * //} * */ - public function sDiffStore($dstKey, $key1, ...$otherKeys) - { - } + public function sDiffStore($dstKey, $key1, ...$otherKeys) {} /** * Returns the contents of a set. @@ -1898,9 +1741,7 @@ public function sDiffStore($dstKey, $key1, ...$otherKeys) * // The order is random and corresponds to redis' own internal representation of the set structure. * */ - public function sMembers($key) - { - } + public function sMembers($key) {} /** * @link https://redis.io/commands/smembers @@ -1909,9 +1750,7 @@ public function sMembers($key) * @return array An array of elements, the contents of the set */ #[Deprecated(replacement: '%class%->sMembers(%parametersList%)')] - public function sGetMembers($key) - { - } + public function sGetMembers($key) {} /** * Scan a set for members @@ -1934,9 +1773,7 @@ public function sGetMembers($key) * } * */ - public function sScan($key, &$iterator, $pattern = null, $count = 0) - { - } + public function sScan($key, &$iterator, $pattern = null, $count = 0) {} /** * Sets a value and returns the previous entry at that key. @@ -1954,9 +1791,7 @@ public function sScan($key, &$iterator, $pattern = null, $count = 0) * $newValue = $redis->get('x')' // return 'lol' * */ - public function getSet($key, $value) - { - } + public function getSet($key, $value) {} /** * Returns a random key @@ -1970,9 +1805,7 @@ public function getSet($key, $value) * $surprise = $redis->get($key); // who knows what's in there. * */ - public function randomKey() - { - } + public function randomKey() {} /** * Switches to a given database @@ -1991,9 +1824,7 @@ public function randomKey() * $redis->get('x'); // will return 42 * */ - public function select($dbIndex) - { - } + public function select($dbIndex) {} /** * Moves a key to a different database. @@ -2013,9 +1844,7 @@ public function select($dbIndex) * $redis->get('x'); // will return 42 * */ - public function move($key, $dbIndex) - { - } + public function move($key, $dbIndex) {} /** * Renames a key @@ -2034,9 +1863,7 @@ public function move($key, $dbIndex) * $redis->get('x'); // → `FALSE` * */ - public function rename($srcKey, $dstKey) - { - } + public function rename($srcKey, $dstKey) {} /** * @link https://redis.io/commands/rename @@ -2045,9 +1872,7 @@ public function rename($srcKey, $dstKey) * @param string $dstKey */ #[Deprecated(replacement: '%class%->rename(%parametersList%)')] - public function renameKey($srcKey, $dstKey) - { - } + public function renameKey($srcKey, $dstKey) {} /** * Renames a key @@ -2069,9 +1894,7 @@ public function renameKey($srcKey, $dstKey) * $redis->get('x'); // → `FALSE` * */ - public function renameNx($srcKey, $dstKey) - { - } + public function renameNx($srcKey, $dstKey) {} /** * Sets an expiration date (a timeout) on an item @@ -2090,9 +1913,7 @@ public function renameNx($srcKey, $dstKey) * $redis->get('x'); // will return `FALSE`, as 'x' has expired. * */ - public function expire($key, $ttl) - { - } + public function expire($key, $ttl) {} /** * Sets an expiration date (a timeout in milliseconds) on an item @@ -2111,9 +1932,7 @@ public function expire($key, $ttl) * $redis->pttl('x'); // 11500 * */ - public function pExpire($key, $ttl) - { - } + public function pExpire($key, $ttl) {} /** * @link https://redis.io/commands/expire @@ -2123,9 +1942,7 @@ public function pExpire($key, $ttl) * @return bool */ #[Deprecated(replacement: '%class%->expire(%parametersList%)')] - public function setTimeout($key, $ttl) - { - } + public function setTimeout($key, $ttl) {} /** * Sets an expiration date (a timestamp) on an item. @@ -2145,9 +1962,7 @@ public function setTimeout($key, $ttl) * $redis->get('x'); // will return `FALSE`, as 'x' has expired. * */ - public function expireAt($key, $timestamp) - { - } + public function expireAt($key, $timestamp) {} /** * Sets an expiration date (a timestamp) on an item. Requires a timestamp in milliseconds @@ -2166,9 +1981,7 @@ public function expireAt($key, $timestamp) * echo $redis->pttl('x'); // 218270120575 * */ - public function pExpireAt($key, $timestamp) - { - } + public function pExpireAt($key, $timestamp) {} /** * Returns the keys that match a certain pattern. @@ -2184,18 +1997,14 @@ public function pExpireAt($key, $timestamp) * $keyWithUserPrefix = $redis->keys('user*'); * */ - public function keys($pattern) - { - } + public function keys($pattern) {} /** * @param string $pattern * @link https://redis.io/commands/keys */ #[Deprecated(replacement: '%class%->keys(%parametersList%)')] - public function getKeys($pattern) - { - } + public function getKeys($pattern) {} /** * Returns the current database's size @@ -2209,9 +2018,7 @@ public function getKeys($pattern) * echo "Redis has $count keys\n"; * */ - public function dbSize() - { - } + public function dbSize() {} /** * Authenticate the connection using a password. @@ -2224,9 +2031,7 @@ public function dbSize() * @link https://redis.io/commands/auth * @example $redis->auth('foobared'); */ - public function auth($password) - { - } + public function auth($password) {} /** * Starts the background rewrite of AOF (Append-Only File) @@ -2236,9 +2041,7 @@ public function auth($password) * @link https://redis.io/commands/bgrewriteaof * @example $redis->bgrewriteaof(); */ - public function bgrewriteaof() - { - } + public function bgrewriteaof() {} /** * Changes the slave status @@ -2257,9 +2060,7 @@ public function bgrewriteaof() * $redis->slaveof(); * */ - public function slaveof($host = '127.0.0.1', $port = 6379) - { - } + public function slaveof($host = '127.0.0.1', $port = 6379) {} /** * Access the Redis slowLog @@ -2288,10 +2089,7 @@ public function slaveof($host = '127.0.0.1', $port = 6379) * * @link https://redis.io/commands/slowlog */ - public function slowLog(string $operation, int $length = null) - { - } - + public function slowLog(string $operation, int $length = null) {} /** * Describes the object pointed to by a key. @@ -2315,9 +2113,7 @@ public function slowLog(string $operation, int $length = null) * $redis->object("idletime", "l"); // → 400 (in seconds, with a precision of 10 seconds). * */ - public function object($string = '', $key = '') - { - } + public function object($string = '', $key = '') {} /** * Performs a synchronous save. @@ -2328,9 +2124,7 @@ public function object($string = '', $key = '') * @link https://redis.io/commands/save * @example $redis->save(); */ - public function save() - { - } + public function save() {} /** * Performs a background save. @@ -2341,9 +2135,7 @@ public function save() * @link https://redis.io/commands/bgsave * @example $redis->bgSave(); */ - public function bgsave() - { - } + public function bgsave() {} /** * Returns the timestamp of the last disk save. @@ -2353,9 +2145,7 @@ public function bgsave() * @link https://redis.io/commands/lastsave * @example $redis->lastSave(); */ - public function lastSave() - { - } + public function lastSave() {} /** * Blocks the current client until all the previous write commands are successfully transferred and @@ -2370,9 +2160,7 @@ public function lastSave() * @link https://redis.io/commands/wait * @example $redis->wait(2, 1000); */ - public function wait($numSlaves, $timeout) - { - } + public function wait($numSlaves, $timeout) {} /** * Returns the type of data pointed by a given key. @@ -2392,9 +2180,7 @@ public function wait($numSlaves, $timeout) * @link https://redis.io/commands/type * @example $redis->type('key'); */ - public function type($key) - { - } + public function type($key) {} /** * Append specified string to the string stored in specified key. @@ -2412,9 +2198,7 @@ public function type($key) * $redis->get('key'); // 'value1value2' * */ - public function append($key, $value) - { - } + public function append($key, $value) {} /** * Return a substring of a larger string @@ -2433,9 +2217,7 @@ public function append($key, $value) * $redis->getRange('key', -5, -1); // 'value' * */ - public function getRange($key, $start, $end) - { - } + public function getRange($key, $start, $end) {} /** * Return a substring of a larger string @@ -2445,9 +2227,7 @@ public function getRange($key, $start, $end) * @param int $end */ #[Deprecated] - public function substr($key, $start, $end) - { - } + public function substr($key, $start, $end) {} /** * Changes a substring of a larger string. @@ -2466,9 +2246,7 @@ public function substr($key, $start, $end) * $redis->get('key'); // "Hello redis" * */ - public function setRange($key, $offset, $value) - { - } + public function setRange($key, $offset, $value) {} /** * Get the length of a string value. @@ -2483,9 +2261,7 @@ public function setRange($key, $offset, $value) * $redis->strlen('key'); // 5 * */ - public function strlen($key) - { - } + public function strlen($key) {} /** * Return the position of the first bit set to 1 or 0 in a string. The position is returned, thinking of the @@ -2520,9 +2296,7 @@ public function strlen($key) * $redis->bitpos('key', 0, 1, 5); // int(-1) * */ - public function bitpos($key, $bit, $start = 0, $end = null) - { - } + public function bitpos($key, $bit, $start = 0, $end = null) {} /** * Return a single bit out of a larger string @@ -2540,9 +2314,7 @@ public function bitpos($key, $bit, $start = 0, $end = null) * $redis->getBit('key', 1); // 1 * */ - public function getBit($key, $offset) - { - } + public function getBit($key, $offset) {} /** * Changes a single bit of a string. @@ -2562,9 +2334,7 @@ public function getBit($key, $offset) * $redis->get('key'); // chr(0x2f) = "/" = b("0010 1111") * */ - public function setBit($key, $offset, $value) - { - } + public function setBit($key, $offset, $value) {} /** * Count bits in a string @@ -2583,9 +2353,7 @@ public function setBit($key, $offset, $value) * var_dump( $redis->bitCount('bit', 0, 2) ); // int(11) * */ - public function bitCount($key) - { - } + public function bitCount($key) {} /** * Bitwise operation on multiple keys. @@ -2609,9 +2377,7 @@ public function bitCount($key) * $redis->bitOp('XOR', 'bit', 'bit1', 'bit2'); // bit = 11 * */ - public function bitOp($operation, $retKey, $key1, ...$otherKeys) - { - } + public function bitOp($operation, $retKey, $key1, ...$otherKeys) {} /** * Removes all entries from the current database. @@ -2620,9 +2386,7 @@ public function bitOp($operation, $retKey, $key1, ...$otherKeys) * @link https://redis.io/commands/flushdb * @example $redis->flushDB(); */ - public function flushDB() - { - } + public function flushDB() {} /** * Removes all entries from all databases. @@ -2632,9 +2396,7 @@ public function flushDB() * @link https://redis.io/commands/flushall * @example $redis->flushAll(); */ - public function flushAll() - { - } + public function flushAll() {} /** * Sort @@ -2666,9 +2428,7 @@ public function flushAll() * var_dump($redis->sort('s', array('sort' => 'desc', 'store' => 'out'))); // (int)5 * */ - public function sort($key, $option = null) - { - } + public function sort($key, $option = null) {} /** * Returns an associative array of strings and integers @@ -2733,9 +2493,7 @@ public function sort($key, $option = null) * $redis->info("CPU"); // just CPU information from Redis INFO * */ - public function info($option = null) - { - } + public function info($option = null) {} /** * Resets the statistics reported by Redis using the INFO command (`info()` function). @@ -2751,9 +2509,7 @@ public function info($option = null) * @example $redis->resetStat(); * @link https://redis.io/commands/config-resetstat */ - public function resetStat() - { - } + public function resetStat() {} /** * Returns the time to live left for a given key, in seconds. If the key doesn't exist, FALSE is returned. @@ -2769,9 +2525,7 @@ public function resetStat() * $redis->ttl('key'); // int(123) * */ - public function ttl($key) - { - } + public function ttl($key) {} /** * Returns a time to live left for a given key, in milliseconds. @@ -2789,9 +2543,7 @@ public function ttl($key) * $redis->pttl('key'); // int(122999) * */ - public function pttl($key) - { - } + public function pttl($key) {} /** * Remove the expiration timer from a key. @@ -2803,9 +2555,7 @@ public function pttl($key) * @link https://redis.io/commands/persist * @example $redis->persist('key'); */ - public function persist($key) - { - } + public function persist($key) {} /** * Sets multiple key-value pairs in one atomic command. @@ -2826,9 +2576,7 @@ public function persist($key) * // string(6) "value1" * */ - public function mset(array $array) - { - } + public function mset(array $array) {} /** * Get the values of all the specified keys. @@ -2848,9 +2596,7 @@ public function mset(array $array) * */ #[Deprecated(replacement: '%class%->mGet(%parametersList%)')] - public function getMultiple(array $keys) - { - } + public function getMultiple(array $keys) {} /** * Returns the values of all specified keys. @@ -2878,9 +2624,7 @@ public function getMultiple(array $keys) * // } * */ - public function mget(array $array) - { - } + public function mget(array $array) {} /** * @see mset() @@ -2889,9 +2633,7 @@ public function mget(array $array) * * @link https://redis.io/commands/msetnx */ - public function msetnx(array $array) - { - } + public function msetnx(array $array) {} /** * Pops a value from the tail of a list, and pushes it to the front of another list. @@ -2936,9 +2678,7 @@ public function msetnx(array $array) * //} * */ - public function rpoplpush($srcKey, $dstKey) - { - } + public function rpoplpush($srcKey, $dstKey) {} /** * A blocking version of rpoplpush, with an integral timeout in the third parameter. @@ -2951,9 +2691,7 @@ public function rpoplpush($srcKey, $dstKey) * * @link https://redis.io/commands/brpoplpush */ - public function brpoplpush($srcKey, $dstKey, $timeout) - { - } + public function brpoplpush($srcKey, $dstKey, $timeout) {} /** * Adds the specified member with a given score to the sorted set stored at key @@ -2997,9 +2735,7 @@ public function brpoplpush($srcKey, $dstKey, $timeout) * // ["v6"]=> float(8) * */ - public function zAdd($key, $options, $score1, $value1 = null, $score2 = null, $value2 = null, $scoreN = null, $valueN = null) - { - } + public function zAdd($key, $options, $score1, $value1 = null, $score2 = null, $value2 = null, $scoreN = null, $valueN = null) {} /** * Returns a range of elements from the ordered set stored at the specified key, @@ -3027,9 +2763,7 @@ public function zAdd($key, $options, $score1, $value1 = null, $score2 = null, $v * $redis->zRange('key1', 0, -1, true); // array('val0' => 0, 'val2' => 2, 'val10' => 10) * */ - public function zRange($key, $start, $end, $withscores = null) - { - } + public function zRange($key, $start, $end, $withscores = null) {} /** * Deletes a specified member from the ordered set. @@ -3053,9 +2787,7 @@ public function zRange($key, $start, $end, $withscores = null) * // } * */ - public function zRem($key, $member1, ...$otherMembers) - { - } + public function zRem($key, $member1, ...$otherMembers) {} /** * @link https://redis.io/commands/zrem @@ -3067,9 +2799,7 @@ public function zRem($key, $member1, ...$otherMembers) * @return int Number of deleted values */ #[Deprecated(replacement: '%class%->zRem(%parametersList%)')] - public function zDelete($key, $member1, ...$otherMembers) - { - } + public function zDelete($key, $member1, ...$otherMembers) {} /** * Returns the elements of the sorted set stored at the specified key in the range [start, end] @@ -3098,9 +2828,7 @@ public function zDelete($key, $member1, ...$otherMembers) * $redis->zRevRange('key', 0, -1, true); // array('val10' => 10, 'val2' => 2, 'val0' => 0) * */ - public function zRevRange($key, $start, $end, $withscore = null) - { - } + public function zRevRange($key, $start, $end, $withscore = null) {} /** * Returns the elements of the sorted set stored at the specified key which have scores in the @@ -3130,9 +2858,7 @@ public function zRevRange($key, $start, $end, $withscore = null) * $redis->zRangeByScore('key', 0, 3, array('withscores' => TRUE, 'limit' => array(1, 1)); // array('val2' => 2) * */ - public function zRangeByScore($key, $start, $end, array $options = array()) - { - } + public function zRangeByScore($key, $start, $end, array $options = []) {} /** * @see zRangeByScore() @@ -3143,9 +2869,7 @@ public function zRangeByScore($key, $start, $end, array $options = array()) * * @return array */ - public function zRevRangeByScore($key, $start, $end, array $options = array()) - { - } + public function zRevRangeByScore($key, $start, $end, array $options = []) {} /** * Returns a lexigraphical range of members in a sorted set, assuming the members have the same score. The @@ -3173,9 +2897,7 @@ public function zRevRangeByScore($key, $start, $end, array $options = array()) * $redis->zRangeByLex('key', '-', '[c'); // array('b', 'c') * */ - public function zRangeByLex($key, $min, $max, $offset = null, $limit = null) - { - } + public function zRangeByLex($key, $min, $max, $offset = null, $limit = null) {} /** * @see zRangeByLex() @@ -3189,9 +2911,7 @@ public function zRangeByLex($key, $min, $max, $offset = null, $limit = null) * * @link https://redis.io/commands/zrevrangebylex */ - public function zRevRangeByLex($key, $min, $max, $offset = null, $limit = null) - { - } + public function zRevRangeByLex($key, $min, $max, $offset = null, $limit = null) {} /** * Returns the number of elements of the sorted set stored at the specified key which have @@ -3213,9 +2933,7 @@ public function zRevRangeByLex($key, $min, $max, $offset = null, $limit = null) * $redis->zCount('key', 0, 3); // 2, corresponding to array('val0', 'val2') * */ - public function zCount($key, $start, $end) - { - } + public function zCount($key, $start, $end) {} /** * Deletes the elements of the sorted set stored at the specified key which have scores in the range [start,end]. @@ -3235,9 +2953,7 @@ public function zCount($key, $start, $end) * $redis->zRemRangeByScore('key', 0, 3); // 2 * */ - public function zRemRangeByScore($key, $start, $end) - { - } + public function zRemRangeByScore($key, $start, $end) {} /** * @param string $key @@ -3245,9 +2961,7 @@ public function zRemRangeByScore($key, $start, $end) * @param float $end */ #[Deprecated(replacement: '%class%->zRemRangeByScore(%parametersList%)')] - public function zDeleteRangeByScore($key, $start, $end) - { - } + public function zDeleteRangeByScore($key, $start, $end) {} /** * Deletes the elements of the sorted set stored at the specified key which have rank in the range [start,end]. @@ -3268,9 +2982,7 @@ public function zDeleteRangeByScore($key, $start, $end) * $redis->zRange('key', 0, -1, array('withscores' => TRUE)); // array('three' => 3) * */ - public function zRemRangeByRank($key, $start, $end) - { - } + public function zRemRangeByRank($key, $start, $end) {} /** * @link https://redis.io/commands/zremrangebyscore @@ -3280,9 +2992,7 @@ public function zRemRangeByRank($key, $start, $end) * @param int $end */ #[Deprecated(replacement: '%class%->zRemRangeByRank(%parametersList%)')] - public function zDeleteRangeByRank($key, $start, $end) - { - } + public function zDeleteRangeByRank($key, $start, $end) {} /** * Returns the cardinality of an ordered set. @@ -3300,18 +3010,14 @@ public function zDeleteRangeByRank($key, $start, $end) * $redis->zCard('key'); // 3 * */ - public function zCard($key) - { - } + public function zCard($key) {} /** * @param string $key * @return int */ #[Deprecated(replacement: '%class%->zCard(%parametersList%)')] - public function zSize($key) - { - } + public function zSize($key) {} /** * Returns the score of a given member in the specified sorted set. @@ -3328,9 +3034,7 @@ public function zSize($key) * $redis->zScore('key', 'val2'); // 2.5 * */ - public function zScore($key, $member) - { - } + public function zScore($key, $member) {} /** * Returns the rank of a given member in the specified sorted set, starting at 0 for the item @@ -3353,9 +3057,7 @@ public function zScore($key, $member) * $redis->zRevRank('key', 'two'); // 0 * */ - public function zRank($key, $member) - { - } + public function zRank($key, $member) {} /** * @see zRank() @@ -3366,9 +3068,7 @@ public function zRank($key, $member) * * @link https://redis.io/commands/zrevrank */ - public function zRevRank($key, $member) - { - } + public function zRevRank($key, $member) {} /** * Increments the score of a member from a sorted set by a given amount. @@ -3388,9 +3088,7 @@ public function zRevRank($key, $member) * $redis->zIncrBy('key', 1, 'member1'); // 3.5 * */ - public function zIncrBy($key, $value, $member) - { - } + public function zIncrBy($key, $value, $member) {} /** * Creates an union of sorted sets given in second argument. @@ -3431,9 +3129,7 @@ public function zIncrBy($key, $value, $member) * $redis->zUnionStore('ko3', array('k1', 'k2'), array(5, 1)); // 4, 'ko3' => array('val0', 'val2', 'val3', 'val1') * */ - public function zUnionStore($output, $zSetKeys, ?array $weights = null, $aggregateFunction = 'SUM') - { - } + public function zUnionStore($output, $zSetKeys, ?array $weights = null, $aggregateFunction = 'SUM') {} /** * @param string $Output @@ -3442,9 +3138,7 @@ public function zUnionStore($output, $zSetKeys, ?array $weights = null, $aggrega * @param string $aggregateFunction */ #[Deprecated(replacement: '%class%->zUnionStore(%parametersList%)')] - public function zUnion($Output, $ZSetKeys, array $Weights = null, $aggregateFunction = 'SUM') - { - } + public function zUnion($Output, $ZSetKeys, array $Weights = null, $aggregateFunction = 'SUM') {} /** * Creates an intersection of sorted sets given in second argument. @@ -3489,9 +3183,7 @@ public function zUnion($Output, $ZSetKeys, array $Weights = null, $aggregateFunc * $redis->zInterStore('ko4', array('k1', 'k2'), array(1, 5), 'max'); // 2, 'ko4' => array('val3', 'val1') * */ - public function zInterStore($output, $zSetKeys, array $weights = null, $aggregateFunction = 'SUM') - { - } + public function zInterStore($output, $zSetKeys, array $weights = null, $aggregateFunction = 'SUM') {} /** * @param $Output @@ -3500,9 +3192,7 @@ public function zInterStore($output, $zSetKeys, array $weights = null, $aggregat * @param string $aggregateFunction */ #[Deprecated(replacement: '%class%->zInterStore(%parametersList%)')] - public function zInter($Output, $ZSetKeys, array $Weights = null, $aggregateFunction = 'SUM') - { - } + public function zInter($Output, $ZSetKeys, array $Weights = null, $aggregateFunction = 'SUM') {} /** * Scan a sorted set for members, with optional pattern and count @@ -3525,9 +3215,7 @@ public function zInter($Output, $ZSetKeys, array $Weights = null, $aggregateFunc * } * */ - public function zScan($key, &$iterator, $pattern = null, $count = 0) - { - } + public function zScan($key, &$iterator, $pattern = null, $count = 0) {} /** * Block until Redis can pop the highest or lowest scoring members from one or more ZSETs. @@ -3553,9 +3241,7 @@ public function zScan($key, &$iterator, $pattern = null, $count = 0) * $redis->bzPopMax('zs1', 'zs2', 5); * */ - public function bzPopMax($key1, $key2, $timeout) - { - } + public function bzPopMax($key1, $key2, $timeout) {} /** * @param string|array $key1 @@ -3569,9 +3255,7 @@ public function bzPopMax($key1, $key2, $timeout) * @since >= 5.0 * @link https://redis.io/commands/bzpopmin */ - public function bzPopMin($key1, $key2, $timeout) - { - } + public function bzPopMin($key1, $key2, $timeout) {} /** * Can pop the highest scoring members from one ZSET. @@ -3592,9 +3276,7 @@ public function bzPopMin($key1, $key2, $timeout) * $redis->zPopMax('zs1', 3); * */ - public function zPopMax($key, $count = 1) - { - } + public function zPopMax($key, $count = 1) {} /** * Can pop the lowest scoring members from one ZSET. @@ -3615,9 +3297,7 @@ public function zPopMax($key, $count = 1) * $redis->zPopMin('zs1', 3); * */ - public function zPopMin($key, $count = 1) - { - } + public function zPopMin($key, $count = 1) {} /** * Adds a value to the hash stored at key. If this value is already in the hash, FALSE is returned. @@ -3641,9 +3321,7 @@ public function zPopMin($key, $count = 1) * $redis->hGet('h', 'key1'); // returns "plop" * */ - public function hSet($key, $hashKey, $value) - { - } + public function hSet($key, $hashKey, $value) {} /** * Adds a value to the hash stored at key only if this field isn't already in the hash. @@ -3663,9 +3341,7 @@ public function hSet($key, $hashKey, $value) * wasn't replaced. * */ - public function hSetNx($key, $hashKey, $value) - { - } + public function hSetNx($key, $hashKey, $value) {} /** * Gets a value from the hash stored at key. @@ -3678,9 +3354,7 @@ public function hSetNx($key, $hashKey, $value) * * @link https://redis.io/commands/hget */ - public function hGet($key, $hashKey) - { - } + public function hGet($key, $hashKey) {} /** * Returns the length of a hash, in number of items @@ -3698,9 +3372,7 @@ public function hGet($key, $hashKey) * $redis->hLen('h'); // returns 2 * */ - public function hLen($key) - { - } + public function hLen($key) {} /** * Removes a values from the hash stored at key. @@ -3733,9 +3405,7 @@ public function hLen($key) * // } * */ - public function hDel($key, $hashKey1, ...$otherHashKeys) - { - } + public function hDel($key, $hashKey1, ...$otherHashKeys) {} /** * Returns the keys in a hash, as an array of strings. @@ -3768,9 +3438,7 @@ public function hDel($key, $hashKey1, ...$otherHashKeys) * // The order is random and corresponds to redis' own internal representation of the set structure. * */ - public function hKeys($key) - { - } + public function hKeys($key) {} /** * Returns the values in a hash, as an array of strings. @@ -3803,9 +3471,7 @@ public function hKeys($key) * // The order is random and corresponds to redis' own internal representation of the set structure. * */ - public function hVals($key) - { - } + public function hVals($key) {} /** * Returns the whole hash, as an array of strings indexed by strings. @@ -3838,9 +3504,7 @@ public function hVals($key) * // The order is random and corresponds to redis' own internal representation of the set structure. * */ - public function hGetAll($key) - { - } + public function hGetAll($key) {} /** * Verify if the specified member exists in a key. @@ -3858,9 +3522,7 @@ public function hGetAll($key) * $redis->hExists('h', 'NonExistingKey'); // FALSE * */ - public function hExists($key, $hashKey) - { - } + public function hExists($key, $hashKey) {} /** * Increments the value of a member from a hash by a given amount. @@ -3879,9 +3541,7 @@ public function hExists($key, $hashKey) * $redis->hIncrBy('h', 'x', 1); // h[x] ← 2 + 1. Returns 3 * */ - public function hIncrBy($key, $hashKey, $value) - { - } + public function hIncrBy($key, $hashKey, $value) {} /** * Increment the float value of a hash field by the given amount @@ -3912,9 +3572,7 @@ public function hIncrBy($key, $hashKey, $value) * } * */ - public function hIncrByFloat($key, $field, $increment) - { - } + public function hIncrByFloat($key, $field, $increment) {} /** * Fills in a whole hash. Non-string values are converted to string, using the standard (string) cast. @@ -3933,9 +3591,7 @@ public function hIncrByFloat($key, $field, $increment) * $redis->hIncrBy('user:1', 'salary', 100); // Joe earns 100 more now. * */ - public function hMSet($key, $hashKeys) - { - } + public function hMSet($key, $hashKeys) {} /** * Retrieve the values associated to the specified fields in the hash. @@ -3955,9 +3611,7 @@ public function hMSet($key, $hashKeys) * $redis->hmGet('h', array('field1', 'field2')); // returns array('field1' => 'value1', 'field2' => 'value2') * */ - public function hMGet($key, $hashKeys) - { - } + public function hMGet($key, $hashKeys) {} /** * Scan a HASH value for members, with an optional pattern and count. @@ -3980,9 +3634,7 @@ public function hMGet($key, $hashKeys) * // } * */ - public function hScan($key, &$iterator, $pattern = null, $count = 0) - { - } + public function hScan($key, &$iterator, $pattern = null, $count = 0) {} /** * Get the string length of the value associated with field in the hash stored at key @@ -3996,9 +3648,7 @@ public function hScan($key, &$iterator, $pattern = null, $count = 0) * @link https://redis.io/commands/hstrlen * @since >= 3.2 */ - public function hStrLen(string $key, string $field) - { - } + public function hStrLen(string $key, string $field) {} /** * Add one or more geospatial items to the specified key. @@ -4026,9 +3676,7 @@ public function hStrLen(string $key, string $field) * ); // 2 * */ - public function geoadd($key, $longitude, $latitude, $member) - { - } + public function geoadd($key, $longitude, $latitude, $member) {} /** * Retrieve Geohash strings for one or more elements of a geospatial index. @@ -4054,9 +3702,7 @@ public function geoadd($key, $longitude, $latitude, $member) * // } * */ - public function geohash($key, ...$member) - { - } + public function geohash($key, ...$member) {} /** * Return longitude, latitude positions for each requested member. @@ -4087,9 +3733,7 @@ public function geohash($key, ...$member) * } * */ - public function geopos(string $key, string $member) - { - } + public function geopos(string $key, string $member) {} /** * Return the distance between two members in a geospatial set. @@ -4140,9 +3784,7 @@ public function geopos(string $key, string $member) * bool(false) * */ - public function geodist($key, $member1, $member2, $unit = null) - { - } + public function geodist($key, $member1, $member2, $unit = null) {} /** * Return members of a set with geospatial information that are within the radius specified by the caller. @@ -4242,9 +3884,7 @@ public function geodist($key, $member1, $member2, $unit = null) * } * */ - public function georadius($key, $longitude, $latitude, $radius, $unit, array $options = null) - { - } + public function georadius($key, $longitude, $latitude, $radius, $unit, array $options = null) {} /** * This method is identical to geoRadius except that instead of passing a longitude and latitude as the "source" @@ -4284,9 +3924,7 @@ public function georadius($key, $longitude, $latitude, $radius, $unit, array $op * } * */ - public function georadiusbymember($key, $member, $radius, $units, array $options = null) - { - } + public function georadiusbymember($key, $member, $radius, $units, array $options = null) {} /** * Get or Set the redis config keys. @@ -4304,9 +3942,7 @@ public function georadiusbymember($key, $member, $radius, $units, array $options * $redis->config("SET", "dir", "/var/run/redis/dumps/"); * */ - public function config($operation, $key, $value) - { - } + public function config($operation, $key, $value) {} /** * Evaluate a LUA script serverside @@ -4333,9 +3969,7 @@ public function config($operation, $key, $value) * $redis->eval("return {1,2,3,redis.call('lrange','mylist',0,-1)}}"); * */ - public function eval($script, $args = array(), $numKeys = 0) - { - } + public function eval($script, $args = [], $numKeys = 0) {} /** * @param string $script @@ -4344,9 +3978,7 @@ public function eval($script, $args = array(), $numKeys = 0) * @return mixed @see eval() */ #[Deprecated(replacement: '%class%->eval(%parametersList%)')] - public function evaluate($script, $args = array(), $numKeys = 0) - { - } + public function evaluate($script, $args = [], $numKeys = 0) {} /** * Evaluate a LUA script serverside, from the SHA1 hash of the script instead of the script itself. @@ -4368,9 +4000,7 @@ public function evaluate($script, $args = array(), $numKeys = 0) * $redis->evalSha($sha); // Returns 1 * */ - public function evalSha($scriptSha, $args = array(), $numKeys = 0) - { - } + public function evalSha($scriptSha, $args = [], $numKeys = 0) {} /** * @param string $scriptSha @@ -4378,9 +4008,7 @@ public function evalSha($scriptSha, $args = array(), $numKeys = 0) * @param int $numKeys */ #[Deprecated(replacement: '%class%->evalSha(%parametersList%)')] - public function evaluateSha($scriptSha, $args = array(), $numKeys = 0) - { - } + public function evaluateSha($scriptSha, $args = [], $numKeys = 0) {} /** * Execute the Redis SCRIPT command to perform various operations on the scripting subsystem. @@ -4406,9 +4034,7 @@ public function evaluateSha($scriptSha, $args = array(), $numKeys = 0) * SCRIPT KILL will return true if a script was able to be killed and false if not * SCRIPT EXISTS will return an array with TRUE or FALSE for each passed script */ - public function script($command, $script) - { - } + public function script($command, $script) {} /** * The last error message (if any) @@ -4422,9 +4048,7 @@ public function script($command, $script) * // "ERR Error compiling script (new function): user_script:1: '=' expected near '-'" * */ - public function getLastError() - { - } + public function getLastError() {} /** * Clear the last error message @@ -4442,9 +4066,7 @@ public function getLastError() * // NULL * */ - public function clearLastError() - { - } + public function clearLastError() {} /** * Issue the CLIENT command with various arguments. @@ -4477,9 +4099,7 @@ public function clearLastError() * $redis->client('kill',
*/
- public function geoRadius($key, $longitude, $latitude, $radius, $radiusUnit, array $options) { }
+ public function geoRadius($key, $longitude, $latitude, $radius, $radiusUnit, array $options) {}
/**
* Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from a member
@@ -3567,8 +3565,7 @@ public function geoRadius($key, $longitude, $latitude, $radius, $radiusUnit, arr
* @param string $radiusUnit
* @param array $options
*/
- public function geoRadiusByMember($key, $member, $radius, $radiusUnit, array $options) { }
-
+ public function geoRadiusByMember($key, $member, $radius, $radiusUnit, array $options) {}
}
class RedisClusterException extends Exception {}
diff --git a/redis/RedisSentinel.php b/redis/RedisSentinel.php
index 3bfa16641..43b3d5466 100755
--- a/redis/RedisSentinel.php
+++ b/redis/RedisSentinel.php
@@ -32,166 +32,166 @@
* @author Tawana Musewe
* @link https://github.com/tbtmuse/phpredis-sentinel-phpdoc
*/
-class RedisSentinel {
+class RedisSentinel
+{
+ /**
+ * Creates a Redis Sentinel
+ *
+ * @param string $host Sentinel IP address or hostname
+ * @param int $port Sentinel Port
+ * @param float $timeout Value in seconds (optional, default is 0 meaning unlimited)
+ * @param string|null $persistent Persistent connection id (optional, default is null meaning not persistent)
+ * @param int $retryInterval Value in milliseconds (optional, default is 0)
+ * @param float $readTimeout Value in seconds (optional, default is 0 meaning unlimited)
+ *
+ * @example
+ * // 1s timeout, 100ms delay between reconnection attempts.
+ * $sentinel = new RedisSentinel('127.0.0.1', 26379, 1, null, 100);
+ */
+ public function __construct(
+ string $host,
+ int $port,
+ float $timeout = 0,
+ ?string $persistent = null,
+ int $retryInterval = 0,
+ float $readTimeout = 0
+ ) {}
- /**
- * Creates a Redis Sentinel
- *
- * @param string $host Sentinel IP address or hostname
- * @param int $port Sentinel Port
- * @param float $timeout Value in seconds (optional, default is 0 meaning unlimited)
- * @param string|null $persistent Persistent connection id (optional, default is null meaning not persistent)
- * @param int $retryInterval Value in milliseconds (optional, default is 0)
- * @param float $readTimeout Value in seconds (optional, default is 0 meaning unlimited)
- *
- * @example
- * // 1s timeout, 100ms delay between reconnection attempts.
- * $sentinel = new RedisSentinel('127.0.0.1', 26379, 1, null, 100);
- */
- public function __construct(
- string $host,
- int $port,
- float $timeout = 0,
- ?string $persistent = null,
- int $retryInterval = 0,
- float $readTimeout = 0
- ) {}
+ /**
+ * Check if the current Sentinel configuration is able to reach the quorum needed to failover a master, and the
+ * majority needed to authorize the failover. This command should be used in monitoring systems to check if a
+ * Sentinel deployment is ok.
+ *
+ * @param string $master Name of master
+ *
+ * @return bool True in case of success, False in case of failure.
+ *
+ * @example $sentinel->ckquorum('mymaster');
+ *
+ * @since >= 5.2.0
+ */
+ public function ckquorum(string $master): bool {}
- /**
- * Check if the current Sentinel configuration is able to reach the quorum needed to failover a master, and the
- * majority needed to authorize the failover. This command should be used in monitoring systems to check if a
- * Sentinel deployment is ok.
- *
- * @param string $master Name of master
- *
- * @return bool True in case of success, False in case of failure.
- *
- * @example $sentinel->ckquorum('mymaster');
- *
- * @since >= 5.2.0
- */
- public function ckquorum(string $master): bool {}
+ /**
+ * Force a failover as if the master was not reachable, and without asking for agreement to other Sentinels
+ * (however a new version of the configuration will be published so that the other Sentinels will update
+ * their configurations).
+ *
+ * @param string $master Name of master
+ *
+ * @return bool True in case of success, False in case of failure.
+ *
+ * @example $sentinel->failover('mymaster');
+ *
+ * @since >= 5.2.0
+ */
+ public function failover(string $master): bool {}
- /**
- * Force a failover as if the master was not reachable, and without asking for agreement to other Sentinels
- * (however a new version of the configuration will be published so that the other Sentinels will update
- * their configurations).
- *
- * @param string $master Name of master
- *
- * @return bool True in case of success, False in case of failure.
- *
- * @example $sentinel->failover('mymaster');
- *
- * @since >= 5.2.0
- */
- public function failover(string $master): bool {}
+ /**
+ * Force Sentinel to rewrite its configuration on disk, including the current Sentinel state.
+ *
+ * Normally Sentinel rewrites the configuration every time something changes in its state (in the context of the
+ * subset of the state which is persisted on disk across restart). However sometimes it is possible that the
+ * configuration file is lost because of operation errors, disk failures, package upgrade scripts or configuration
+ * managers. In those cases a way to to force Sentinel to rewrite the configuration file is handy.
+ *
+ * This command works even if the previous configuration file is completely missing.
+ *
+ * @return bool True in case of success, False in case of failure.
+ *
+ * @example $sentinel->flushconfig();
+ *
+ * @since >= 5.2.0
+ */
+ public function flushconfig(): bool {}
- /**
- * Force Sentinel to rewrite its configuration on disk, including the current Sentinel state.
- *
- * Normally Sentinel rewrites the configuration every time something changes in its state (in the context of the
- * subset of the state which is persisted on disk across restart). However sometimes it is possible that the
- * configuration file is lost because of operation errors, disk failures, package upgrade scripts or configuration
- * managers. In those cases a way to to force Sentinel to rewrite the configuration file is handy.
- *
- * This command works even if the previous configuration file is completely missing.
- *
- * @return bool True in case of success, False in case of failure.
- *
- * @example $sentinel->flushconfig();
- *
- * @since >= 5.2.0
- */
- public function flushconfig(): bool {}
+ /**
+ * Return the ip and port number of the master with that name. If a failover is in progress or terminated
+ * successfully for this master it returns the address and port of the promoted replica.
+ *
+ * @param string $master Name of master
+ *
+ * @return array|false ['address', 'port'] in case of success, False in case of failure.
+ *
+ * @example $sentinel->getMasterAddrByName('mymaster');
+ *
+ * @since >= 5.2.0
+ */
+ public function getMasterAddrByName(string $master) {}
- /**
- * Return the ip and port number of the master with that name. If a failover is in progress or terminated
- * successfully for this master it returns the address and port of the promoted replica.
- *
- * @param string $master Name of master
- *
- * @return array|false ['address', 'port'] in case of success, False in case of failure.
- *
- * @example $sentinel->getMasterAddrByName('mymaster');
- *
- * @since >= 5.2.0
- */
- public function getMasterAddrByName(string $master) {}
+ /**
+ * Return the state and info of the specified master
+ *
+ * @param string $master Name of master
+ *
+ * @return array|false Associative array with info in case of success, False in case of failure.
+ *
+ * @example $sentinel->master('mymaster');
+ *
+ * @since >= 5.2.0
+ */
+ public function master(string $master) {}
- /**
- * Return the state and info of the specified master
- *
- * @param string $master Name of master
- *
- * @return array|false Associative array with info in case of success, False in case of failure.
- *
- * @example $sentinel->master('mymaster');
- *
- * @since >= 5.2.0
- */
- public function master(string $master) {}
+ /**
+ * Return a list of monitored masters and their state
+ *
+ * @return array|false Array of arrays with info for each master in case of success, FALSE in case of failure.
+ *
+ * @example $sentinel->masters();
+ *
+ * @since >= 5.2.0
+ */
+ public function masters() {}
- /**
- * Return a list of monitored masters and their state
- *
- * @return array|false Array of arrays with info for each master in case of success, FALSE in case of failure.
- *
- * @example $sentinel->masters();
- *
- * @since >= 5.2.0
- */
- public function masters() {}
+ /**
+ * Ping the sentinel
+ *
+ * @return bool True in case of success, False in case of failure
+ *
+ * @example $sentinel->ping();
+ *
+ * @since >= 5.2.0
+ */
+ public function ping(): bool {}
- /**
- * Ping the sentinel
- *
- * @return bool True in case of success, False in case of failure
- *
- * @example $sentinel->ping();
- *
- * @since >= 5.2.0
- */
- public function ping(): bool {}
+ /**
+ * Reset all the masters with matching name. The pattern argument is a glob-style pattern.
+ * The reset process clears any previous state in a master (including a failover in progress), and removes every
+ * replica and sentinel already discovered and associated with the master.
+ *
+ * @param string $pattern Glob-style pattern
+ *
+ * @return bool True in case of success, False in case of failure
+ *
+ * @example $sentinel->reset('*');
+ *
+ * @since >= 5.2.0
+ */
+ public function reset(string $pattern): bool {}
- /**
- * Reset all the masters with matching name. The pattern argument is a glob-style pattern.
- * The reset process clears any previous state in a master (including a failover in progress), and removes every
- * replica and sentinel already discovered and associated with the master.
- *
- * @param string $pattern Glob-style pattern
- *
- * @return bool True in case of success, False in case of failure
- *
- * @example $sentinel->reset('*');
- *
- * @since >= 5.2.0
- */
- public function reset(string $pattern): bool {}
+ /**
+ * Return a list of sentinel instances for this master, and their state
+ *
+ * @param string $master Name of master
+ *
+ * @return array|false Array of arrays with info for each sentinel in case of success, False in case of failure
+ *
+ * @example $sentinel->sentinels('mymaster');
+ *
+ * @since >= 5.2.0
+ */
+ public function sentinels(string $master) {}
- /**
- * Return a list of sentinel instances for this master, and their state
- *
- * @param string $master Name of master
- *
- * @return array|false Array of arrays with info for each sentinel in case of success, False in case of failure
- *
- * @example $sentinel->sentinels('mymaster');
- *
- * @since >= 5.2.0
- */
- public function sentinels(string $master) {}
-
- /**
- * Return a list of sentinel instances for this master, and their state
- *
- * @param string $master Name of master
- *
- * @return array|false Array of arrays with info for each replica in case of success, False in case of failure
- *
- * @example $sentinel->slaves('mymaster');
- *
- * @since >= 5.2.0
- */
- public function slaves(string $master) {}
+ /**
+ * Return a list of sentinel instances for this master, and their state
+ *
+ * @param string $master Name of master
+ *
+ * @return array|false Array of arrays with info for each replica in case of success, False in case of failure
+ *
+ * @example $sentinel->slaves('mymaster');
+ *
+ * @since >= 5.2.0
+ */
+ public function slaves(string $master) {}
}
diff --git a/regex/ereg.php b/regex/ereg.php
index 1ec6ebf71..c94ac2f57 100644
--- a/regex/ereg.php
+++ b/regex/ereg.php
@@ -36,7 +36,7 @@
* @see preg_match()
*/
#[Deprecated(reason: "Use preg_match() instead", since: "5.3")]
-function ereg ($pattern, $string, ?array &$regs = null) {}
+function ereg($pattern, $string, ?array &$regs = null) {}
/**
* Replace regular expression
@@ -62,7 +62,7 @@ function ereg ($pattern, $string, ?array &$regs = null) {}
* @see preg_replace()
*/
#[Deprecated(reason: "Use preg_replace() instead", since: "5.3")]
-function ereg_replace ($pattern, $replacement, $string) {}
+function ereg_replace($pattern, $replacement, $string) {}
/**
* Case insensitive regular expression match
@@ -96,7 +96,7 @@ function ereg_replace ($pattern, $replacement, $string) {}
* @see preg_match()
*/
#[Deprecated(reason: "Use preg_match() instead", since: "5.3")]
-function eregi ($pattern, $string, array &$regs = null) {}
+function eregi($pattern, $string, array &$regs = null) {}
/**
* Replace regular expression case insensitive
@@ -122,7 +122,7 @@ function eregi ($pattern, $string, array &$regs = null) {}
* @see preg_replace()
*/
#[Deprecated(reason: "Use preg_replace() instead", since: "5.3")]
-function eregi_replace ($pattern, $replacement, $string) {}
+function eregi_replace($pattern, $replacement, $string) {}
/**
* Split string into array by regular expression
@@ -165,7 +165,7 @@ function eregi_replace ($pattern, $replacement, $string) {}
* @see preg_split()
*/
#[Deprecated(reason: "Use preg_split() instead", since: "5.3")]
-function split ($pattern, $string, $limit = -1) {}
+function split($pattern, $string, $limit = -1) {}
/**
* Split string into array by regular expression case insensitive
@@ -208,7 +208,7 @@ function split ($pattern, $string, $limit = -1) {}
* @see preg_split()
*/
#[Deprecated(reason: "Use preg_split() instead", since: "5.3")]
-function spliti ($pattern, $string, $limit = -1) {}
+function spliti($pattern, $string, $limit = -1) {}
/**
* Make regular expression for case insensitive match
@@ -224,7 +224,6 @@ function spliti ($pattern, $string, $limit = -1) {}
* @removed 7.0
*/
#[Deprecated(since: '5.3')]
-function sql_regcase ($string) {}
+function sql_regcase($string) {}
// End of ereg v.
-?>
diff --git a/rpminfo/rpminfo.php b/rpminfo/rpminfo.php
index 984d34e0e..c0be9dacb 100644
--- a/rpminfo/rpminfo.php
+++ b/rpminfo/rpminfo.php
@@ -274,7 +274,6 @@
const RPMTAG_VERSION = 1001;
const RPMTAG_XPM = 1013;
-
/**
* Compare two RPM evr (epoch:version-release) strings
*
@@ -289,7 +288,7 @@
*
* @since 0.1.0
*/
-function rpmvercmp (string $evr1, string $evr2) {}
+function rpmvercmp(string $evr1, string $evr2) {}
/**
* Retrieve information from a RPM file, reading its metadata.
@@ -313,7 +312,7 @@ function rpmvercmp (string $evr1, string $evr2) {}
*
* @since 0.1.0
*/
-function rpminfo (string $path, bool $full = false, ?string &$error = null) {}
+function rpminfo(string $path, bool $full = false, ?string &$error = null) {}
/**
* Retrieve information about an installed package, from the system RPM database.
@@ -330,7 +329,7 @@ function rpminfo (string $path, bool $full = false, ?string &$error = null) {}
*
* @since 0.2.0
*/
-function rpmdbinfo (string $nevr, bool $full = false) {}
+function rpmdbinfo(string $nevr, bool $full = false) {}
/**
* Retriev information from the local RPM database.
@@ -354,4 +353,4 @@ function rpmdbinfo (string $nevr, bool $full = false) {}
*
* @since 0.3.0
*/
-function rpmdbsearch (string $pattern, int $rpmtag = RPMTAG_NAME, int $rpmmire = -1, bool $full = false) {}
+function rpmdbsearch(string $pattern, int $rpmtag = RPMTAG_NAME, int $rpmmire = -1, bool $full = false) {}
diff --git a/rrd/rrd.php b/rrd/rrd.php
index 9eb9a51db..256b30fcc 100644
--- a/rrd/rrd.php
+++ b/rrd/rrd.php
@@ -120,7 +120,7 @@ function rrd_lastupdate($file) {}
* @return bool Returns TRUE on success, FALSE otherwise.
* @since PECL rrd >= 0.9.0
*/
-function rrd_restore($xml_file, $rrd_file, $options = array()) {}
+function rrd_restore($xml_file, $rrd_file, $options = []) {}
/**
* Change some options in the RRD dabase header file. E.g. renames the source for the data etc.
@@ -185,15 +185,15 @@ function rrd_disconnect() {}
* For example, it's called automatically at the end of command line script.
* It's up user whether he wants to call this function at the end of every request or otherwise.
*/
-function rrdc_disconnect(){}
+function rrdc_disconnect() {}
/**
* Class for creation of RRD database file.
* @link https://php.net/manual/en/class.rrdcreator.php
* @since PECL rrd >= 0.9.0
*/
-class RRDCreator {
-
+class RRDCreator
+{
/**
* Adds RRA - archive of data values for each data source.
* Archive consists of a number of data values or statistics for each of the defined data-sources (DS). Data sources are defined by method RRDCreator::addDataSource(). You need call this method for each requested archive.
@@ -245,7 +245,6 @@ public function __construct($path, $startTime = '', $step = 0) {}
* @since PECL rrd >= 0.9.0
*/
public function save() {}
-
}
/**
@@ -253,8 +252,8 @@ public function save() {}
* @link https://php.net/manual/en/class.rrdgraph.php
* @since PECL rrd >= 0.9.0
*/
-class RRDGraph {
-
+class RRDGraph
+{
/**
* Creates new RRDGraph instance. This instance is responsible for rendering the result of RRD database query into image.
* @link https://php.net/manual/en/rrdgraph.construct.php
@@ -293,7 +292,6 @@ public function saveVerbose() {}
* @since PECL rrd >= 0.9.0
*/
public function setOptions($options) {}
-
}
/**
@@ -301,8 +299,8 @@ public function setOptions($options) {}
* @link https://php.net/manual/en/class.rrdupdater.php
* @since PECL rrd >= 0.9.0
*/
-class RRDUpdater {
-
+class RRDUpdater
+{
/**
* Creates new RRDUpdater instance. This instance is responsible for updating the RRD database file.
* RRDUpdater constructor.
@@ -328,7 +326,6 @@ public function __construct($path) {}
* @since PECL rrd >= 0.9.0
*/
public function update($values, $time = '') {}
-
}
// end of PECL/rrd v1.0
diff --git a/session/SessionHandler.php b/session/SessionHandler.php
index 4e1f74030..302b9ffed 100644
--- a/session/SessionHandler.php
+++ b/session/SessionHandler.php
@@ -8,91 +8,90 @@
* @link https://php.net/manual/en/class.sessionhandlerinterface.php
* @since 5.4
*/
-interface SessionHandlerInterface {
-
- /**
- * Close the session
- * @link https://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.
- *
- * @since 5.4
- */
- public function close();
-
- /**
- * Destroy a session
- * @link https://php.net/manual/en/sessionhandlerinterface.destroy.php
- * @param string $id The session ID being destroyed.
- * @return bool
- * The return value (usually TRUE on success, FALSE on failure).
- * Note this value is returned internally to PHP for processing.
- *
- * @since 5.4
- */
- public function destroy($id);
+interface SessionHandlerInterface
+{
+ /**
+ * Close the session
+ * @link https://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.
+ *
+ * @since 5.4
+ */
+ public function close();
- /**
- * Cleanup old sessions
- * @link https://php.net/manual/en/sessionhandlerinterface.gc.php
- * @param int $max_lifetime
- * Sessions that have not updated for
- * the last maxlifetime seconds will be removed.
- *
- * @return bool
- * The return value (usually TRUE on success, FALSE on failure).
- * Note this value is returned internally to PHP for processing.
- *
- * @since 5.4
- */
- public function gc($max_lifetime);
+ /**
+ * Destroy a session
+ * @link https://php.net/manual/en/sessionhandlerinterface.destroy.php
+ * @param string $id The session ID being destroyed.
+ * @return bool
+ * The return value (usually TRUE on success, FALSE on failure).
+ * Note this value is returned internally to PHP for processing.
+ *
+ * @since 5.4
+ */
+ public function destroy($id);
- /**
- * Initialize session
- * @link https://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.
- *
- * @since 5.4
- */
- public function open($path, $name);
+ /**
+ * Cleanup old sessions
+ * @link https://php.net/manual/en/sessionhandlerinterface.gc.php
+ * @param int $max_lifetime
+ * Sessions that have not updated for
+ * the last maxlifetime seconds will be removed.
+ *
+ * @return bool
+ * The return value (usually TRUE on success, FALSE on failure).
+ * Note this value is returned internally to PHP for processing.
+ *
+ * @since 5.4
+ */
+ public function gc($max_lifetime);
+ /**
+ * Initialize session
+ * @link https://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.
+ *
+ * @since 5.4
+ */
+ public function open($path, $name);
- /**
- * Read session data
- * @link https://php.net/manual/en/sessionhandlerinterface.read.php
- * @param string $id The session id to read data for.
- * @return string
- * Returns an encoded string of the read data.
- * If nothing was read, it must return an empty string.
- * Note this value is returned internally to PHP for processing.
- *
- * @since 5.4
- */
- public function read($id);
+ /**
+ * Read session data
+ * @link https://php.net/manual/en/sessionhandlerinterface.read.php
+ * @param string $id The session id to read data for.
+ * @return string
+ * Returns an encoded string of the read data.
+ * If nothing was read, it must return an empty string.
+ * Note this value is returned internally to PHP for processing.
+ *
+ * @since 5.4
+ */
+ public function read($id);
- /**
- * Write session data
- * @link https://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.
- *
- * @since 5.4
- */
- public function write($id, $data);
+ /**
+ * Write session data
+ * @link https://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.
+ *
+ * @since 5.4
+ */
+ public function write($id, $data);
}
/**
@@ -100,7 +99,8 @@ public function write($id, $data);
* @link https://php.net/manual/en/class.sessionidinterface.php
* @since 5.5.1
*/
-interface SessionIdInterface {
+interface SessionIdInterface
+{
/**
* Create session ID
* @link https://php.net/manual/en/sessionidinterface.create-sid.php
@@ -116,8 +116,8 @@ public function create_sid();
* handler must implement this interface.
* @since 7.0
*/
-interface SessionUpdateTimestampHandlerInterface {
-
+interface SessionUpdateTimestampHandlerInterface
+{
/**
* Validate session id
* @param string $id The session id
@@ -140,7 +140,6 @@ public function validateId($id);
* @return bool
*/
public function updateTimestamp($id, $data);
-
}
/**
@@ -160,17 +159,16 @@ public function updateTimestamp($id, $data);
*/
class SessionHandler implements SessionHandlerInterface, SessionIdInterface
{
-
- /**
- * Close the session
- * @link https://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.
- *
- * @since 5.4
- */
- public function close() { }
+ /**
+ * Close the session
+ * @link https://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.
+ *
+ * @since 5.4
+ */
+ public function close() {}
/**
* Return a new session ID
@@ -178,80 +176,79 @@ public function close() { }
* @return string A session ID valid for the default session handler.
* @since 5.5.1
*/
- public function create_sid() {}
-
- /**
- * Destroy a session
- * @link https://php.net/manual/en/sessionhandler.destroy.php
- * @param string $id The session ID being destroyed.
- * @return bool
- * The return value (usually TRUE on success, FALSE on failure).
- * Note this value is returned internally to PHP for processing.
- *
- * @since 5.4
- */
- public function destroy($id) { }
+ public function create_sid() {}
- /**
- * Cleanup old sessions
- * @link https://php.net/manual/en/sessionhandler.gc.php
- * @param int $max_lifetime
- * Sessions that have not updated for
- * the last maxlifetime seconds will be removed.
- *
- * @return bool
- * The return value (usually TRUE on success, FALSE on failure).
- * Note this value is returned internally to PHP for processing.
- *
- * @since 5.4
- */
- public function gc($max_lifetime) { }
+ /**
+ * Destroy a session
+ * @link https://php.net/manual/en/sessionhandler.destroy.php
+ * @param string $id The session ID being destroyed.
+ * @return bool
+ * The return value (usually TRUE on success, FALSE on failure).
+ * Note this value is returned internally to PHP for processing.
+ *
+ * @since 5.4
+ */
+ public function destroy($id) {}
- /**
- * Initialize session
- * @link https://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.
- *
- * @since 5.4
- */
- public function open($path, $name) { }
+ /**
+ * Cleanup old sessions
+ * @link https://php.net/manual/en/sessionhandler.gc.php
+ * @param int $max_lifetime
+ * Sessions that have not updated for
+ * the last maxlifetime seconds will be removed.
+ *
+ * @return bool
+ * The return value (usually TRUE on success, FALSE on failure).
+ * Note this value is returned internally to PHP for processing.
+ *
+ * @since 5.4
+ */
+ public function gc($max_lifetime) {}
+ /**
+ * Initialize session
+ * @link https://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.
+ *
+ * @since 5.4
+ */
+ public function open($path, $name) {}
- /**
- * Read session data
- * @link https://php.net/manual/en/sessionhandler.read.php
- * @param string $id The session id to read data for.
- * @return string
- * Returns an encoded string of the read data.
- * If nothing was read, it must return an empty string.
- * Note this value is returned internally to PHP for processing.
- *
- * @since 5.4
- */
- public function read($id) { }
+ /**
+ * Read session data
+ * @link https://php.net/manual/en/sessionhandler.read.php
+ * @param string $id The session id to read data for.
+ * @return string
+ * Returns an encoded string of the read data.
+ * If nothing was read, it must return an empty string.
+ * Note this value is returned internally to PHP for processing.
+ *
+ * @since 5.4
+ */
+ public function read($id) {}
- /**
- * Write session data
- * @link https://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.
- *
- * @since 5.4
- */
- public function write($id, $data) { }
+ /**
+ * Write session data
+ * @link https://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.
+ *
+ * @since 5.4
+ */
+ public function write($id, $data) {}
/**
* Validate session id
@@ -260,7 +257,7 @@ public function write($id, $data) { }
* Note this value is returned internally to PHP for processing.
*
*/
- public function validateId($session_id) { }
+ public function validateId($session_id) {}
/**
* Update timestamp of a session
@@ -274,6 +271,5 @@ public function validateId($session_id) { }
*
* @return bool
*/
- public function updateTimestamp($session_id, $session_data) { }
-
+ public function updateTimestamp($session_id, $session_data) {}
}
diff --git a/session/session.php b/session/session.php
index 40a4186e3..46d585bca 100644
--- a/session/session.php
+++ b/session/session.php
@@ -25,8 +25,7 @@
*
* @return string|false the name of the current session.
*/
-function session_name (?string $name): string|false
-{}
+function session_name(?string $name): string|false {}
/**
* Get and/or set the current session module.
@@ -38,8 +37,7 @@ function session_name (?string $name): string|false
*
* @return string|false the name of the current session module.
*/
-function session_module_name (?string $module): string|false
-{}
+function session_module_name(?string $module): string|false {}
/**
* Get and/or set the current session save path
@@ -58,8 +56,7 @@ function session_module_name (?string $module): string|false
*
* @return string|false the path of the current directory used for data storage.
*/
-function session_save_path (?string $path): string|false
-{}
+function session_save_path(?string $path): string|false {}
/**
* Get and/or set the current session id
@@ -80,8 +77,7 @@ function session_save_path (?string $path): string|false
* session or the empty string ("") if there is no current
* session (no current session id exists).
*/
-function session_id (?string $id): string|false
-{}
+function session_id(?string $id): string|false {}
/**
* Update the current session id with a newly generated one
@@ -91,8 +87,7 @@ function session_id (?string $id): string|false
*
* @return bool true on success or false on failure.
*/
-function session_regenerate_id (bool $delete_old_session = false): bool
-{}
+function session_regenerate_id(bool $delete_old_session = false): bool {}
/**
* PHP > 5.4.0
@@ -100,7 +95,7 @@ function session_regenerate_id (bool $delete_old_session = false): bool
* @link https://secure.php.net/manual/en/function.session-register-shutdown.php
* @return void
*/
-function session_register_shutdown (): void {}
+function session_register_shutdown(): void {}
/**
* Decodes session data from a string
@@ -110,8 +105,7 @@ function session_register_shutdown (): void {}
*
* @return bool true on success or false on failure.
*/
-function session_decode (string $data): bool
-{}
+function session_decode(string $data): bool {}
/**
* Register one or more global variables with the current session
@@ -125,8 +119,7 @@ function session_decode (string $data): bool
* @removed 5.4
*/
#[Deprecated(since: '5.3')]
-function session_register (mixed $name, ...$_): bool
-{}
+function session_register(mixed $name, ...$_): bool {}
/**
* Unregister a global variable from the current session
@@ -138,8 +131,7 @@ function session_register (mixed $name, ...$_): bool
* @removed 5.4
*/
#[Deprecated(since: '5.3')]
-function session_unregister (string $name): bool
-{}
+function session_unregister(string $name): bool {}
/**
* Find out whether a global variable is registered in a session
@@ -153,16 +145,14 @@ function session_unregister (string $name): bool
* @removed 5.4
*/
#[Deprecated(since: '5.3')]
-function session_is_registered (string $name): bool
-{}
+function session_is_registered(string $name): bool {}
/**
* Encodes the current session data as a string
* @link https://php.net/manual/en/function.session-encode.php
* @return string|false the contents of the current session encoded.
*/
-function session_encode (): string|false
-{}
+function session_encode(): string|false {}
/**
* Initialize session data
@@ -172,8 +162,7 @@ function session_encode (): string|false
* @return bool This function returns true if a session was successfully started,
* otherwise false.
*/
-function session_start (array $options = []): bool
-{}
+function session_start(array $options = []): bool {}
/**
* Create new session id
@@ -185,24 +174,21 @@ function session_start (array $options = []): bool
* If it is used without active session, it omits collision check.
* @since 7.1
*/
-function session_create_id(string $prefix): string|false
-{}
+function session_create_id(string $prefix): string|false {}
/**
* Perform session data garbage collection
* @return int|false number of deleted session data for success, false for failure.
* @since 7.1
*/
-function session_gc(): int|false
-{}
+function session_gc(): int|false {}
/**
* Destroys all data registered to a session
* @link https://php.net/manual/en/function.session-destroy.php
* @return bool true on success or false on failure.
*/
-function session_destroy (): bool
-{}
+function session_destroy(): bool {}
/**
* Free all session variables
@@ -210,8 +196,7 @@ function session_destroy (): bool
* @return void|bool since 7.2.0 returns true on success or false on failure.
*/
#[LanguageLevelTypeAware(["7.2" => "bool"], default: "void")]
-function session_unset()
-{}
+function session_unset() {}
/**
* Sets user-level session storage functions
@@ -261,8 +246,7 @@ function session_unset()
* @param callback $update_timestamp [optional]
* @return bool true on success or false on failure.
*/
-function session_set_save_handler (callable $open, callable $close, callable $read, callable $write, callable $destroy, callable $gc, $create_sid, $validate_sid, $update_timestamp): bool
-{}
+function session_set_save_handler(callable $open, callable $close, callable $read, callable $write, callable $destroy, callable $gc, $create_sid, $validate_sid, $update_timestamp): bool {}
/**
* (PHP 5.4)
@@ -273,8 +257,7 @@ function session_set_save_handler (callable $open, callable $close, callable $re
* @param bool $register_shutdown [optional] Register session_write_close() as a register_shutdown_function() function.
* @return bool true on success or false on failure.
*/
-function session_set_save_handler (SessionHandlerInterface $session_handler, $register_shutdown = true): bool
-{}
+function session_set_save_handler(SessionHandlerInterface $session_handler, $register_shutdown = true): bool {}
/**
* Get and/or set the current cache limiter
@@ -331,8 +314,7 @@ function session_set_save_handler (SessionHandlerInterface $session_handler, $re
*
* @return string|false the name of the current cache limiter.
*/
-function session_cache_limiter (?string $value): string|false
-{}
+function session_cache_limiter(?string $value): string|false {}
/**
* Return current cache expire
@@ -349,8 +331,7 @@ function session_cache_limiter (?string $value): string|false
* @return int|false the current setting of session.cache_expire.
* The value returned should be read in minutes, defaults to 180.
*/
-function session_cache_expire (?int $value): int|false
-{}
+function session_cache_expire(?int $value): int|false {}
/**
* Set the session cookie parameters
@@ -367,9 +348,7 @@ function session_cache_expire (?int $value): int|false
* @return bool returns true on success or false on failure.
* @since 7.3
*/
-function session_set_cookie_params (array $options): bool
-{}
-
+function session_set_cookie_params(array $options): bool {}
/**
* Set the session cookie parameters
@@ -400,8 +379,7 @@ function session_set_cookie_params (array $options): bool
* @return void|bool since 7.2.0 returns true on success or false on failure.
*/
#[LanguageLevelTypeAware(["7.2" => "bool"], default: "void")]
-function session_set_cookie_params (array|int $lifetime_or_options, ?string $path, ?string $domain, ?bool $secure = false, ?bool $httponly = false)
-{}
+function session_set_cookie_params(array|int $lifetime_or_options, ?string $path, ?string $domain, ?bool $secure = false, ?bool $httponly = false) {}
/**
* Get the session cookie parameters
@@ -427,8 +405,7 @@ function session_set_cookie_params (array|int $lifetime_or_options, ?string $pat
"httponly" => "bool",
"samesite" => "string"
])]
-function session_get_cookie_params (): array
-{}
+function session_get_cookie_params(): array {}
/**
* Write session data and end session
@@ -436,8 +413,7 @@ function session_get_cookie_params (): array
* @return void|bool since 7.2.0 returns true on success or false on failure.
*/
#[LanguageLevelTypeAware(["7.2" => "bool"], default: "void")]
-function session_write_close()
-{}
+function session_write_close() {}
/**
* Alias of session_write_close
@@ -445,8 +421,7 @@ function session_write_close()
* @return void|bool since 7.2.0 returns true on success or false on failure.
*/
#[LanguageLevelTypeAware(["7.2" => "bool"], default: "void")]
-function session_commit()
-{}
+function session_commit() {}
/**
* (PHP 5 >= 5.4.0)
@@ -457,8 +432,7 @@ function session_commit()
* PHP_SESSION_ACTIVE if sessions are enabled, and one exists.
* @since 5.4
*/
-function session_status (): int
-{}
+function session_status(): int {}
/**
* (PHP 5 >= 5.6.0)
@@ -468,8 +442,7 @@ function session_status (): int
* @since 5.6
*/
#[LanguageLevelTypeAware(["7.2" => "bool"], default: "void")]
-function session_abort()
-{}
+function session_abort() {}
/**
* (PHP 5 >= 5.6.0)
@@ -479,8 +452,6 @@ function session_abort()
* @since 5.6
*/
#[LanguageLevelTypeAware(["7.2" => "bool"], default: "void")]
-function session_reset()
-{}
+function session_reset() {}
// End of session v.
-?>
diff --git a/shmop/shmop.php b/shmop/shmop.php
index 6a8807c6a..23e30c6cb 100644
--- a/shmop/shmop.php
+++ b/shmop/shmop.php
@@ -29,7 +29,7 @@
* returned on failure.
*/
#[LanguageLevelTypeAware(["8.0" => "Shmop|false"], default: "resource|false")]
-function shmop_open (int $key, string $mode, int $permissions, int $size) {}
+function shmop_open(int $key, string $mode, int $permissions, int $size) {}
/**
* Read data from shared memory block
@@ -47,7 +47,7 @@ function shmop_open (int $key, string $mode, int $permissions, int $size) {}
* @return string|false the data or FALSE on failure.
*/
#[LanguageLevelTypeAware(["8.0" => "string"], default: "string|false")]
-function shmop_read (#[LanguageLevelTypeAware(["8.0" => "Shmop"], default: "resource")] $shmop, int $offset, int $size) {}
+function shmop_read(#[LanguageLevelTypeAware(["8.0" => "Shmop"], default: "resource")] $shmop, int $offset, int $size) {}
/**
* Close shared memory block
@@ -59,7 +59,7 @@ function shmop_read (#[LanguageLevelTypeAware(["8.0" => "Shmop"], default: "reso
* @return void No value is returned.
*/
#[Deprecated(since: '8.0')]
-function shmop_close (#[LanguageLevelTypeAware(["8.0" => "Shmop"], default: "resource")] $shmop): void {}
+function shmop_close(#[LanguageLevelTypeAware(["8.0" => "Shmop"], default: "resource")] $shmop): void {}
/**
* Get size of shared memory block
@@ -71,7 +71,7 @@ function shmop_close (#[LanguageLevelTypeAware(["8.0" => "Shmop"], default: "res
* @return int an int, which represents the number of bytes the shared memory
* block occupies.
*/
-function shmop_size (#[LanguageLevelTypeAware(["8.0" => "Shmop"], default: "resource")] $shmop): int {}
+function shmop_size(#[LanguageLevelTypeAware(["8.0" => "Shmop"], default: "resource")] $shmop): int {}
/**
* Write data into shared memory block
@@ -91,7 +91,7 @@ function shmop_size (#[LanguageLevelTypeAware(["8.0" => "Shmop"], default: "reso
* failure.
*/
#[LanguageLevelTypeAware(["8.0" => "int"], default: "int|false")]
-function shmop_write (#[LanguageLevelTypeAware(["8.0" => "Shmop"], default: "resource")] $shmop, string $data, int $offset) {}
+function shmop_write(#[LanguageLevelTypeAware(["8.0" => "Shmop"], default: "resource")] $shmop, string $data, int $offset) {}
/**
* Delete shared memory block
@@ -102,12 +102,11 @@ function shmop_write (#[LanguageLevelTypeAware(["8.0" => "Shmop"], default: "res
*
* @return bool TRUE on success or FALSE on failure.
*/
-function shmop_delete (#[LanguageLevelTypeAware(["8.0" => "Shmop"], default: "resource")] $shmop): bool {}
+function shmop_delete(#[LanguageLevelTypeAware(["8.0" => "Shmop"], default: "resource")] $shmop): bool {}
/**
* @since 8.0
*/
-final class Shmop{}
+final class Shmop {}
// End of shmop v.
-?>
diff --git a/snmp/snmp.php b/snmp/snmp.php
index 3f6056bc0..9bf1eee90 100644
--- a/snmp/snmp.php
+++ b/snmp/snmp.php
@@ -6,7 +6,8 @@
* Represents SNMP session.
* @link https://php.net/manual/en/class.snmp.php
*/
-class SNMP {
+class SNMP
+{
/**
* @var int Maximum OID per GET/SET/GETBULK request
* @link https://secure.php.net/manual/en/class.snmp.php#snmp.props.max-oids
@@ -72,24 +73,23 @@ class SNMP {
*/
public $info;
- const VERSION_1 = 0;
- const VERSION_2c = 1;
- const VERSION_2C = 1;
- const VERSION_3 = 3;
- const ERRNO_NOERROR = 0;
- const ERRNO_ANY = 126;
- const ERRNO_GENERIC = 2;
- const ERRNO_TIMEOUT = 4;
- const ERRNO_ERROR_IN_REPLY = 8;
- const ERRNO_OID_NOT_INCREASING = 16;
- const ERRNO_OID_PARSING_ERROR = 32;
- const ERRNO_MULTIPLE_SET_QUERIES = 64;
+ public const VERSION_1 = 0;
+ public const VERSION_2c = 1;
+ public const VERSION_2C = 1;
+ public const VERSION_3 = 3;
+ public const ERRNO_NOERROR = 0;
+ public const ERRNO_ANY = 126;
+ public const ERRNO_GENERIC = 2;
+ public const ERRNO_TIMEOUT = 4;
+ public const ERRNO_ERROR_IN_REPLY = 8;
+ public const ERRNO_OID_NOT_INCREASING = 16;
+ public const ERRNO_OID_PARSING_ERROR = 32;
+ public const ERRNO_MULTIPLE_SET_QUERIES = 64;
-
- /**
- * Creates SNMP instance representing session to remote SNMP agent
- * @link https://php.net/manual/en/snmp.construct.php
- * @param int $version SNMP protocol version:
+ /**
+ * Creates SNMP instance representing session to remote SNMP agent
+ * @link https://php.net/manual/en/snmp.construct.php
+ * @param int $version
SNMP protocol version:
* SNMP::VERSION_1,
* SNMP::VERSION_2C,
* SNMP::VERSION_3.
@@ -111,7 +111,7 @@ class SNMP {
* FQDN with specific port, force usage of IPv6 address [host.domain]:1161 The purpuse of community is
+ * @param string $community
The purpuse of community is
* SNMP version specific:
*
*
@@ -120,19 +120,19 @@ class SNMP {
* SNMP::VERSION_3 SNMPv3 securityName
- * @param int $timeout [optional] The number of microseconds until the first timeout.
- * @param int $retries [optional] The number of retries in case timeout occurs.
+ * @param int $timeout [optional] The number of microseconds until the first timeout.
+ * @param int $retries [optional] The number of retries in case timeout occurs.
* @since 5.4
*/
- public function __construct ($version, $hostname, $community, $timeout = 1000000, $retries = 5) {}
+ public function __construct($version, $hostname, $community, $timeout = 1000000, $retries = 5) {}
- /**
- * Close SNMP session
- * @link https://php.net/manual/en/snmp.close.php
- * @return bool TRUE on success or FALSE on failure.
- * @since 5.4
- */
- public function close () {}
+ /**
+ * Close SNMP session
+ * @link https://php.net/manual/en/snmp.close.php
+ * @return bool TRUE on success or FALSE on failure.
+ * @since 5.4
+ */
+ public function close() {}
/**
* Configures security-related SNMPv3 session parameters
@@ -147,53 +147,53 @@ public function close () {}
* @return bool TRUE on success or FALSE on failure.
* @since 5.4
*/
- public function setSecurity ($sec_level, $auth_protocol, $auth_passphrase, $priv_protocol, $priv_passphrase, $contextName, $contextEngineID) {}
+ public function setSecurity($sec_level, $auth_protocol, $auth_passphrase, $priv_protocol, $priv_passphrase, $contextName, $contextEngineID) {}
- /**
- * Fetch an SNMP object
- * @link https://php.net/manual/en/snmp.get.php
- * @param mixed $object_id The SNMP object (OID) or objects
+ /**
+ * Fetch an SNMP object
+ * @link https://php.net/manual/en/snmp.get.php
+ * @param mixed $object_id The SNMP object (OID) or objects
* @param bool $preserve_keys [optional] When object_id is a array and preserve_keys set to TRUE keys in results will be taken exactly as in object_id, otherwise SNMP::oid_output_format property is used to determinate the form of keys.
- * @return mixed SNMP objects requested as string or array
- * depending on object_id type or FALSE on error.
- * @since 5.4
- */
- public function get ($object_id, $preserve_keys = false) {}
+ * @return mixed SNMP objects requested as string or array
+ * depending on object_id type or FALSE on error.
+ * @since 5.4
+ */
+ public function get($object_id, $preserve_keys = false) {}
- /**
- * Fetch an SNMP object which
+ /**
+ * Fetch an SNMP object which
* follows the given object id
- * @link https://php.net/manual/en/snmp.getnext.php
- * @param mixed $object_id
+ * @link https://php.net/manual/en/snmp.getnext.php
+ * @param mixed $object_id
* The SNMP object (OID) or objects
*
- * @return mixed SNMP objects requested as string or array
- * depending on object_id type or FALSE on error.
- * @since 5.4
- */
- public function getnext ($object_id) {}
+ * @return mixed SNMP objects requested as string or array
+ * depending on object_id type or FALSE on error.
+ * @since 5.4
+ */
+ public function getnext($object_id) {}
- /**
- * Fetch SNMP object subtree
- * @link https://php.net/manual/en/snmp.walk.php
- * @param string $object_id Root of subtree to be fetched
+ /**
+ * Fetch SNMP object subtree
+ * @link https://php.net/manual/en/snmp.walk.php
+ * @param string $object_id Root of subtree to be fetched
* @param bool $suffix_as_keys [optional] By default full OID notation is used for keys in output array. If set to TRUE subtree prefix will be removed from keys leaving only suffix of object_id.
* @param int $max_repetitions [optional] This specifies the maximum number of iterations over the repeating variables. The default is to use this value from SNMP object.
* @param int $non_repeaters [optional] This specifies the number of supplied variables that should not be iterated over. The default is to use this value from SNMP object.
* @return array|false associative array of the SNMP object ids and their values on success or FALSE on error.
- * When a SNMP error occures SNMP::getErrno and
- * SNMP::getError can be used for retrieving error
- * number (specific to SNMP extension, see class constants) and error message
- * respectively.
- * @since 5.4
- */
- public function walk ($object_id, $suffix_as_keys = false, $max_repetitions, $non_repeaters) {}
+ * When a SNMP error occures SNMP::getErrno and
+ * SNMP::getError can be used for retrieving error
+ * number (specific to SNMP extension, see class constants) and error message
+ * respectively.
+ * @since 5.4
+ */
+ public function walk($object_id, $suffix_as_keys = false, $max_repetitions, $non_repeaters) {}
- /**
- * Set the value of an SNMP object
- * @link https://php.net/manual/en/snmp.set.php
- * @param string $object_id The SNMP object id
- * @since 5.4
+ /**
+ * Set the value of an SNMP object
+ * @link https://php.net/manual/en/snmp.set.php
+ * @param string $object_id The SNMP object id
+ * @since 5.4
*
* When count of OIDs in object_id array is greater than
* max_oids object property set method will have to use multiple queries
@@ -256,28 +256,27 @@ public function walk ($object_id, $suffix_as_keys = false, $max_repetitions, $no
*
* See examples section for more details.
*
- * @param mixed $value
+ * @param mixed $value
* The new value.
* @return bool TRUE on success or FALSE on failure.
- */
- public function set ($object_id, $type, $value) {}
-
- /**
- * Get last error code
- * @link https://php.net/manual/en/snmp.geterrno.php
- * @return int one of SNMP error code values described in constants chapter.
- * @since 5.4
- */
- public function getErrno () {}
+ */
+ public function set($object_id, $type, $value) {}
- /**
- * Get last error message
- * @link https://php.net/manual/en/snmp.geterror.php
- * @return string String describing error from last SNMP request.
- * @since 5.4
- */
- public function getError () {}
+ /**
+ * Get last error code
+ * @link https://php.net/manual/en/snmp.geterrno.php
+ * @return int one of SNMP error code values described in constants chapter.
+ * @since 5.4
+ */
+ public function getErrno() {}
+ /**
+ * Get last error message
+ * @link https://php.net/manual/en/snmp.geterror.php
+ * @return string String describing error from last SNMP request.
+ * @since 5.4
+ */
+ public function getError() {}
}
/**
@@ -287,7 +286,8 @@ public function getError () {}
* information about Exceptions in PHP.
* @link https://php.net/manual/en/class.snmpexception.php
*/
-class SNMPException extends RuntimeException {
+class SNMPException extends RuntimeException
+{
/**
* @var string Textual error message. Exception::getMessage() to access it.
*/
@@ -318,7 +318,7 @@ class SNMPException extends RuntimeException {
*
* @return string|false SNMP object value on success or FALSE on error.
*/
-function snmpget ($hostname, $community, $object_id, $timeout = 1000000, $retries = 5) {}
+function snmpget($hostname, $community, $object_id, $timeout = 1000000, $retries = 5) {}
/**
* Fetch the SNMP object which follows the given object id
@@ -331,7 +331,7 @@ function snmpget ($hostname, $community, $object_id, $timeout = 1000000, $retrie
* @return string|false SNMP object value on success or FALSE on error.
* In case of an error, an E_WARNING message is shown.
*/
-function snmpgetnext ($host, $community, $object_id, $timeout = 1000000, $retries = 5) {}
+function snmpgetnext($host, $community, $object_id, $timeout = 1000000, $retries = 5) {}
/**
* Fetch all the SNMP objects from an agent
@@ -358,7 +358,7 @@ function snmpgetnext ($host, $community, $object_id, $timeout = 1000000, $retrie
* @return array an array of SNMP object values starting from the
* object_id as root or FALSE on error.
*/
-function snmpwalk ($hostname, $community, $object_id, $timeout = 1000000, $retries = 5) {}
+function snmpwalk($hostname, $community, $object_id, $timeout = 1000000, $retries = 5) {}
/**
* Return all objects including their respective object ID within the specified one
@@ -371,7 +371,7 @@ function snmpwalk ($hostname, $community, $object_id, $timeout = 1000000, $retri
* @return array|false 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.
*/
-function snmprealwalk ($host, $community, $object_id, $timeout = 1000000, $retries = 5) {}
+function snmprealwalk($host, $community, $object_id, $timeout = 1000000, $retries = 5) {}
/**
* Query for a tree of information about a network entity
@@ -401,7 +401,7 @@ function snmprealwalk ($host, $community, $object_id, $timeout = 1000000, $retri
* object value starting from the object_id
* as root or FALSE on error.
*/
-function snmpwalkoid ($hostname, $community, $object_id, $timeout = 1000000, $retries = 5) {}
+function snmpwalkoid($hostname, $community, $object_id, $timeout = 1000000, $retries = 5) {}
/**
* Set the value of an SNMP object
@@ -466,14 +466,14 @@ function snmpwalkoid ($hostname, $community, $object_id, $timeout = 1000000, $re
* If an unknown or invalid OID is specified the warning probably reads "Could not add variable".
*
*/
-function snmpset ($host, $community, $object_id, $type, $value, $timeout = 1000000, $retries = 5) {}
+function snmpset($host, $community, $object_id, $type, $value, $timeout = 1000000, $retries = 5) {}
/**
* Fetches the current value of the UCD library's quick_print setting
* @link https://php.net/manual/en/function.snmp-get-quick-print.php
* @return bool TRUE if quick_print is on, FALSE otherwise.
*/
-function snmp_get_quick_print () {}
+function snmp_get_quick_print() {}
/**
* Set the value of quick_print within the UCD SNMP library
@@ -481,7 +481,7 @@ function snmp_get_quick_print () {}
* @param bool $quick_print
* @return bool No value is returned.
*/
-function snmp_set_quick_print ($quick_print) {}
+function snmp_set_quick_print($quick_print) {}
/**
* Return all values that are enums with their enum value instead of the raw integer
@@ -491,7 +491,7 @@ function snmp_set_quick_print ($quick_print) {}
*
* @return bool
*/
-function snmp_set_enum_print ($enum_print) {}
+function snmp_set_enum_print($enum_print) {}
/**
* Set the OID output format
@@ -511,7 +511,7 @@ function snmp_set_enum_print ($enum_print) {}
*
* @return bool No value is returned.
*/
-function snmp_set_oid_output_format ($oid_format = SNMP_OID_OUTPUT_MODULE) {}
+function snmp_set_oid_output_format($oid_format = SNMP_OID_OUTPUT_MODULE) {}
/**
* Set the oid output format
@@ -519,7 +519,7 @@ function snmp_set_oid_output_format ($oid_format = SNMP_OID_OUTPUT_MODULE) {}
* @param int $oid_format
* @return void
*/
-function snmp_set_oid_numeric_print ($oid_format) {}
+function snmp_set_oid_numeric_print($oid_format) {}
/**
* Fetch an SNMP object
@@ -541,7 +541,7 @@ function snmp_set_oid_numeric_print ($oid_format) {}
*
* @return string|false SNMP object value on success or FALSE on error.
*/
-function snmp2_get ($host, $community, $object_id, $timeout = 1000000, $retries = 5) {}
+function snmp2_get($host, $community, $object_id, $timeout = 1000000, $retries = 5) {}
/**
* Fetch the SNMP object which follows the given object id
@@ -564,7 +564,7 @@ function snmp2_get ($host, $community, $object_id, $timeout = 1000000, $retries
* @return string|false SNMP object value on success or FALSE on error.
* In case of an error, an E_WARNING message is shown.
*/
-function snmp2_getnext ($host, $community, $object_id, $timeout = 1000000, $retries = 5) {}
+function snmp2_getnext($host, $community, $object_id, $timeout = 1000000, $retries = 5) {}
/**
* Fetch all the SNMP objects from an agent
@@ -593,7 +593,7 @@ function snmp2_getnext ($host, $community, $object_id, $timeout = 1000000, $retr
* @return array an array of SNMP object values starting from the
* object_id as root or FALSE on error.
*/
-function snmp2_walk ($host, $community, $object_id, $timeout = 1000000, $retries = 5) {}
+function snmp2_walk($host, $community, $object_id, $timeout = 1000000, $retries = 5) {}
/**
* Return all objects including their respective object ID within the specified one
@@ -616,7 +616,7 @@ function snmp2_walk ($host, $community, $object_id, $timeout = 1000000, $retries
* @return array|false 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.
*/
-function snmp2_real_walk ($host, $community, $object_id, $timeout = 1000000, $retries = 5) {}
+function snmp2_real_walk($host, $community, $object_id, $timeout = 1000000, $retries = 5) {}
/**
* Set the value of an SNMP object
@@ -683,7 +683,7 @@ function snmp2_real_walk ($host, $community, $object_id, $timeout = 1000000, $re
* If an unknown or invalid OID is specified the warning probably reads "Could not add variable".
*
*/
-function snmp2_set ($host, $community, $object_id, $type, $value, $timeout = 1000000, $retries = 5) {}
+function snmp2_set($host, $community, $object_id, $type, $value, $timeout = 1000000, $retries = 5) {}
/**
* Fetch an SNMP object
@@ -720,7 +720,7 @@ function snmp2_set ($host, $community, $object_id, $type, $value, $timeout = 100
*
* @return string|false SNMP object value on success or FALSE on error.
*/
-function snmp3_get ($host, $sec_name, $sec_level, $auth_protocol, $auth_passphrase, $priv_protocol, $priv_passphrase, $object_id, $timeout = 1000000, $retries = 5) {}
+function snmp3_get($host, $sec_name, $sec_level, $auth_protocol, $auth_passphrase, $priv_protocol, $priv_passphrase, $object_id, $timeout = 1000000, $retries = 5) {}
/**
* Fetch the SNMP object which follows the given object id
@@ -759,7 +759,7 @@ function snmp3_get ($host, $sec_name, $sec_level, $auth_protocol, $auth_passphra
* @return string|false SNMP object value on success or FALSE on error.
* In case of an error, an E_WARNING message is shown.
*/
-function snmp3_getnext ($host, $sec_name, $sec_level, $auth_protocol, $auth_passphrase, $priv_protocol, $priv_passphrase, $object_id, $timeout = 1000000, $retries = 5) {}
+function snmp3_getnext($host, $sec_name, $sec_level, $auth_protocol, $auth_passphrase, $priv_protocol, $priv_passphrase, $object_id, $timeout = 1000000, $retries = 5) {}
/**
* Fetch all the SNMP objects from an agent
@@ -803,7 +803,7 @@ function snmp3_getnext ($host, $sec_name, $sec_level, $auth_protocol, $auth_pass
* @return array an array of SNMP object values starting from the
* object_id as root or FALSE on error.
*/
-function snmp3_walk ($host, $sec_name, $sec_level, $auth_protocol, $auth_passphrase, $priv_protocol, $priv_passphrase, $object_id, $timeout = 1000000, $retries = 5) {}
+function snmp3_walk($host, $sec_name, $sec_level, $auth_protocol, $auth_passphrase, $priv_protocol, $priv_passphrase, $object_id, $timeout = 1000000, $retries = 5) {}
/**
* Return all objects including their respective object ID within the specified one
@@ -843,7 +843,7 @@ function snmp3_walk ($host, $sec_name, $sec_level, $auth_protocol, $auth_passphr
* SNMP object ids and their values on success or FALSE on error.
* In case of an error, an E_WARNING message is shown.
*/
-function snmp3_real_walk ($host, $sec_name, $sec_level, $auth_protocol, $auth_passphrase, $priv_protocol, $priv_passphrase, $object_id, $timeout = null, $retries = null) {}
+function snmp3_real_walk($host, $sec_name, $sec_level, $auth_protocol, $auth_passphrase, $priv_protocol, $priv_passphrase, $object_id, $timeout = null, $retries = null) {}
/**
* Set the value of an SNMP object
@@ -927,7 +927,7 @@ function snmp3_real_walk ($host, $sec_name, $sec_level, $auth_protocol, $auth_pa
* If an unknown or invalid OID is specified the warning probably reads "Could not add variable".
*
*/
-function snmp3_set ($host, $sec_name, $sec_level, $auth_protocol, $auth_passphrase, $priv_protocol, $priv_passphrase, $object_id, $type, $value, $timeout = 1000000, $retries = 5) {}
+function snmp3_set($host, $sec_name, $sec_level, $auth_protocol, $auth_passphrase, $priv_protocol, $priv_passphrase, $object_id, $type, $value, $timeout = 1000000, $retries = 5) {}
/**
* Specify the method how the SNMP values will be returned
@@ -954,7 +954,7 @@ function snmp3_set ($host, $sec_name, $sec_level, $auth_protocol, $auth_passphra
*
* @return bool
*/
-function snmp_set_valueretrieval ($method) {}
+function snmp_set_valueretrieval($method) {}
/**
* Return the method how the SNMP values will be returned
@@ -963,7 +963,7 @@ function snmp_set_valueretrieval ($method) {}
* SNMP_VALUE_PLAIN ) with
* possible SNMP_VALUE_OBJECT set.
*/
-function snmp_get_valueretrieval () {}
+function snmp_get_valueretrieval() {}
/**
* Reads and parses a MIB file into the active MIB tree
@@ -971,58 +971,57 @@ function snmp_get_valueretrieval () {}
* @param string $filename The filename of the MIB.
* @return bool
*/
-function snmp_read_mib ($filename) {}
-
+function snmp_read_mib($filename) {}
/**
* As of 5.4
* @link https://php.net/manual/en/snmp.constants.php
*/
-define ('SNMP_OID_OUTPUT_SUFFIX', 1);
+define('SNMP_OID_OUTPUT_SUFFIX', 1);
/**
* As of 5.4
* @link https://php.net/manual/en/snmp.constants.php
*/
-define ('SNMP_OID_OUTPUT_MODULE', 2);
+define('SNMP_OID_OUTPUT_MODULE', 2);
/**
* As of 5.2
* @link https://php.net/manual/en/snmp.constants.php
*/
-define ('SNMP_OID_OUTPUT_FULL', 3);
+define('SNMP_OID_OUTPUT_FULL', 3);
/**
* As of 5.2
* @link https://php.net/manual/en/snmp.constants.php
*/
-define ('SNMP_OID_OUTPUT_NUMERIC', 4);
+define('SNMP_OID_OUTPUT_NUMERIC', 4);
/**
* As of 5.4
* @link https://php.net/manual/en/snmp.constants.php
*/
-define ('SNMP_OID_OUTPUT_UCD', 5);
+define('SNMP_OID_OUTPUT_UCD', 5);
/**
* As of 5.4
* @link https://php.net/manual/en/snmp.constants.php
*/
-define ('SNMP_OID_OUTPUT_NONE', 6);
-define ('SNMP_VALUE_LIBRARY', 0);
-define ('SNMP_VALUE_PLAIN', 1);
-define ('SNMP_VALUE_OBJECT', 2);
-define ('SNMP_BIT_STR', 3);
-define ('SNMP_OCTET_STR', 4);
-define ('SNMP_OPAQUE', 68);
-define ('SNMP_NULL', 5);
-define ('SNMP_OBJECT_ID', 6);
-define ('SNMP_IPADDRESS', 64);
-define ('SNMP_COUNTER', 66);
-define ('SNMP_UNSIGNED', 66);
-define ('SNMP_TIMETICKS', 67);
-define ('SNMP_UINTEGER', 71);
-define ('SNMP_INTEGER', 2);
-define ('SNMP_COUNTER64', 70);
+define('SNMP_OID_OUTPUT_NONE', 6);
+define('SNMP_VALUE_LIBRARY', 0);
+define('SNMP_VALUE_PLAIN', 1);
+define('SNMP_VALUE_OBJECT', 2);
+define('SNMP_BIT_STR', 3);
+define('SNMP_OCTET_STR', 4);
+define('SNMP_OPAQUE', 68);
+define('SNMP_NULL', 5);
+define('SNMP_OBJECT_ID', 6);
+define('SNMP_IPADDRESS', 64);
+define('SNMP_COUNTER', 66);
+define('SNMP_UNSIGNED', 66);
+define('SNMP_TIMETICKS', 67);
+define('SNMP_UINTEGER', 71);
+define('SNMP_INTEGER', 2);
+define('SNMP_COUNTER64', 70);
// End of snmp v.0.1
diff --git a/soap/soap.php b/soap/soap.php
index 08be64cbb..5dbc659ca 100644
--- a/soap/soap.php
+++ b/soap/soap.php
@@ -8,134 +8,134 @@
* or non-WSDL mode.
* @link https://php.net/manual/en/class.soapclient.php
*/
-class SoapClient {
-
- /**
- * SoapClient constructor
- * @link https://php.net/manual/en/soapclient.soapclient.php
- * @param mixed $wsdl
- * URI of the WSDL file or NULL if working in
- * non-WSDL mode.
- *
- *
- * During development, WSDL caching may be disabled by the
- * use of the soap.wsdl_cache_ttl php.ini setting
- * otherwise changes made to the WSDL file will have no effect until
- * soap.wsdl_cache_ttl is expired.
- *
- * @param array $options [optional]
- * An array of options. If working in WSDL mode, this parameter is optional.
- * If working in non-WSDL mode, the location and
- * uri options must be set, where location
- * is the URL of the SOAP server to send the request to, and uri
- * is the target namespace of the SOAP service.
- *
- *
- * The style and use options only work in
- * non-WSDL mode. In WSDL mode, they come from the WSDL file.
- *
- *
- * The soap_version option should be one of either
- * SOAP_1_1 or SOAP_1_2 to
- * select SOAP 1.1 or 1.2, respectively. If omitted, 1.1 is used.
- *
- *
- * For HTTP authentication, the login and
- * password options can be used to supply credentials.
- * For making an HTTP connection through
- * a proxy server, the options proxy_host,
- * proxy_port, proxy_login
- * and proxy_password are also available.
- * For HTTPS client certificate authentication use
- * local_cert and passphrase options. An
- * authentication may be supplied in the authentication
- * option. The authentication method may be either
- * SOAP_AUTHENTICATION_BASIC (default) or
- * SOAP_AUTHENTICATION_DIGEST.
- *
- *
- * The compression option allows to use compression
- * of HTTP SOAP requests and responses.
- *
- *
- * The encoding option defines internal character
- * encoding. This option does not change the encoding of SOAP requests (it is
- * always utf-8), but converts strings into it.
- *
- *
- * The trace option enables tracing of request so faults
- * can be backtraced. This defaults to FALSE
- *
- *
- * The classmap option can be used to map some WSDL
- * types to PHP classes. This option must be an array with WSDL types
- * as keys and names of PHP classes as values.
- *
- *
- * Setting the boolean trace option enables use of the
- * methods
- * SoapClient->__getLastRequest,
- * SoapClient->__getLastRequestHeaders,
- * SoapClient->__getLastResponse and
- * SoapClient->__getLastResponseHeaders.
- *
- *
- * The exceptions option is a boolean value defining whether
- * soap errors throw exceptions of type
- * SoapFault.
- *
- *
- * The connection_timeout option defines a timeout in seconds
- * for the connection to the SOAP service. This option does not define a timeout
- * for services with slow responses. To limit the time to wait for calls to finish the
- * default_socket_timeout setting
- * is available.
- *
- *
- * The typemap option is an array of type mappings.
- * Type mapping is an array with keys type_name,
- * type_ns (namespace URI), from_xml
- * (callback accepting one string parameter) and to_xml
- * (callback accepting one object parameter).
- *
- *
- * The cache_wsdl option is one of
- * WSDL_CACHE_NONE,
- * WSDL_CACHE_DISK,
- * WSDL_CACHE_MEMORY or
- * WSDL_CACHE_BOTH.
- *
- *
- * The user_agent option specifies string to use in
- * User-Agent header.
- *
- *
- * The stream_context option is a resource
- * for context.
- *
- *
- * The features option is a bitmask of
- * SOAP_SINGLE_ELEMENT_ARRAYS,
- * SOAP_USE_XSI_ARRAY_TYPE,
- * SOAP_WAIT_ONE_WAY_CALLS.
- *
- *
- * The keep_alive option is a boolean value defining whether
- * to send the Connection: Keep-Alive header or
- * Connection: close.
- *
- *
- * The ssl_method option is one of
- * SOAP_SSL_METHOD_TLS,
- * SOAP_SSL_METHOD_SSLv2,
- * SOAP_SSL_METHOD_SSLv3 or
- * SOAP_SSL_METHOD_SSLv23.
- *
- * @since 5.0.1
- *
- * @removed 8.0
- */
- public function SoapClient ($wsdl, array $options = null) {}
+class SoapClient
+{
+ /**
+ * SoapClient constructor
+ * @link https://php.net/manual/en/soapclient.soapclient.php
+ * @param mixed $wsdl
+ * URI of the WSDL file or NULL if working in
+ * non-WSDL mode.
+ *
+ *
+ * During development, WSDL caching may be disabled by the
+ * use of the soap.wsdl_cache_ttl php.ini setting
+ * otherwise changes made to the WSDL file will have no effect until
+ * soap.wsdl_cache_ttl is expired.
+ *
+ * @param array $options [optional]
+ * An array of options. If working in WSDL mode, this parameter is optional.
+ * If working in non-WSDL mode, the location and
+ * uri options must be set, where location
+ * is the URL of the SOAP server to send the request to, and uri
+ * is the target namespace of the SOAP service.
+ *
+ *
+ * The style and use options only work in
+ * non-WSDL mode. In WSDL mode, they come from the WSDL file.
+ *
+ *
+ * The soap_version option should be one of either
+ * SOAP_1_1 or SOAP_1_2 to
+ * select SOAP 1.1 or 1.2, respectively. If omitted, 1.1 is used.
+ *
+ *
+ * For HTTP authentication, the login and
+ * password options can be used to supply credentials.
+ * For making an HTTP connection through
+ * a proxy server, the options proxy_host,
+ * proxy_port, proxy_login
+ * and proxy_password are also available.
+ * For HTTPS client certificate authentication use
+ * local_cert and passphrase options. An
+ * authentication may be supplied in the authentication
+ * option. The authentication method may be either
+ * SOAP_AUTHENTICATION_BASIC (default) or
+ * SOAP_AUTHENTICATION_DIGEST.
+ *
+ *
+ * The compression option allows to use compression
+ * of HTTP SOAP requests and responses.
+ *
+ *
+ * The encoding option defines internal character
+ * encoding. This option does not change the encoding of SOAP requests (it is
+ * always utf-8), but converts strings into it.
+ *
+ *
+ * The trace option enables tracing of request so faults
+ * can be backtraced. This defaults to FALSE
+ *
+ *
+ * The classmap option can be used to map some WSDL
+ * types to PHP classes. This option must be an array with WSDL types
+ * as keys and names of PHP classes as values.
+ *
+ *
+ * Setting the boolean trace option enables use of the
+ * methods
+ * SoapClient->__getLastRequest,
+ * SoapClient->__getLastRequestHeaders,
+ * SoapClient->__getLastResponse and
+ * SoapClient->__getLastResponseHeaders.
+ *
+ *
+ * The exceptions option is a boolean value defining whether
+ * soap errors throw exceptions of type
+ * SoapFault.
+ *
+ *
+ * The connection_timeout option defines a timeout in seconds
+ * for the connection to the SOAP service. This option does not define a timeout
+ * for services with slow responses. To limit the time to wait for calls to finish the
+ * default_socket_timeout setting
+ * is available.
+ *
+ *
+ * The typemap option is an array of type mappings.
+ * Type mapping is an array with keys type_name,
+ * type_ns (namespace URI), from_xml
+ * (callback accepting one string parameter) and to_xml
+ * (callback accepting one object parameter).
+ *
+ *
+ * The cache_wsdl option is one of
+ * WSDL_CACHE_NONE,
+ * WSDL_CACHE_DISK,
+ * WSDL_CACHE_MEMORY or
+ * WSDL_CACHE_BOTH.
+ *
+ *
+ * The user_agent option specifies string to use in
+ * User-Agent header.
+ *
+ *
+ * The stream_context option is a resource
+ * for context.
+ *
+ *
+ * The features option is a bitmask of
+ * SOAP_SINGLE_ELEMENT_ARRAYS,
+ * SOAP_USE_XSI_ARRAY_TYPE,
+ * SOAP_WAIT_ONE_WAY_CALLS.
+ *
+ *
+ * The keep_alive option is a boolean value defining whether
+ * to send the Connection: Keep-Alive header or
+ * Connection: close.
+ *
+ *
+ * The ssl_method option is one of
+ * SOAP_SSL_METHOD_TLS,
+ * SOAP_SSL_METHOD_SSLv2,
+ * SOAP_SSL_METHOD_SSLv3 or
+ * SOAP_SSL_METHOD_SSLv23.
+ *
+ * @since 5.0.1
+ *
+ * @removed 8.0
+ */
+ public function SoapClient($wsdl, array $options = null) {}
/**
* SoapClient constructor
@@ -261,469 +261,467 @@ public function SoapClient ($wsdl, array $options = null) {}
* @throws SoapFault A SoapFault exception will be thrown if the wsdl URI cannot be loaded.
* @since 5.0.1
*/
- public function __construct ($wsdl, array $options = null) {}
+ public function __construct($wsdl, array $options = null) {}
- /**
- * @link https://php.net/manual/en/soapclient.call.php
- * @param string $name
- * @param array $args
- * @return mixed
- * @since 5.0.1
- */
- #[Deprecated]
- public function __call ($name, $args) {}
-
- /**
- * Calls a SOAP function
- * @link https://php.net/manual/en/soapclient.soapcall.php
- * @param string $name
- * The name of the SOAP function to call.
- *
- * @param array $args
- * An array of the arguments to pass to the function. This can be either
- * an ordered or an associative array. Note that most SOAP servers require
- * parameter names to be provided, in which case this must be an
- * associative array.
- *
- * @param array $options [optional]
- * An associative array of options to pass to the client.
- *
- *
- * The location option is the URL of the remote Web service.
- *
- *
- * The uri option is the target namespace of the SOAP service.
- *
- *
- * The soapaction option is the action to call.
- *
- * @param mixed $inputHeaders [optional]
- * An array of headers to be sent along with the SOAP request.
- *
- * @param array &$outputHeaders [optional]
- * If supplied, this array will be filled with the headers from the SOAP response.
- *
- * @return mixed SOAP functions may return one, or multiple values. If only one value is returned
- * by the SOAP function, the return value of __soapCall will be
- * a simple value (e.g. an integer, a string, etc). If multiple values are
- * returned, __soapCall will return
- * an associative array of named output parameters.
- *
- *
- * On error, if the SoapClient object was constructed with the exceptions
- * option set to FALSE, a SoapFault object will be returned.
- * @since 5.0.1
- */
- public function __soapCall ($name, $args, $options = null, $inputHeaders = null, &$outputHeaders = null) {}
+ /**
+ * @link https://php.net/manual/en/soapclient.call.php
+ * @param string $name
+ * @param array $args
+ * @return mixed
+ * @since 5.0.1
+ */
+ #[Deprecated]
+ public function __call($name, $args) {}
- /**
- * Returns last SOAP request
- * @link https://php.net/manual/en/soapclient.getlastrequest.php
- * @return string The last SOAP request, as an XML string.
- * @since 5.0.1
- */
- public function __getLastRequest () {}
+ /**
+ * Calls a SOAP function
+ * @link https://php.net/manual/en/soapclient.soapcall.php
+ * @param string $name
+ * The name of the SOAP function to call.
+ *
+ * @param array $args
+ * An array of the arguments to pass to the function. This can be either
+ * an ordered or an associative array. Note that most SOAP servers require
+ * parameter names to be provided, in which case this must be an
+ * associative array.
+ *
+ * @param array $options [optional]
+ * An associative array of options to pass to the client.
+ *
+ *
+ * The location option is the URL of the remote Web service.
+ *
+ *
+ * The uri option is the target namespace of the SOAP service.
+ *
+ *
+ * The soapaction option is the action to call.
+ *
+ * @param mixed $inputHeaders [optional]
+ * An array of headers to be sent along with the SOAP request.
+ *
+ * @param array &$outputHeaders [optional]
+ * If supplied, this array will be filled with the headers from the SOAP response.
+ *
+ * @return mixed SOAP functions may return one, or multiple values. If only one value is returned
+ * by the SOAP function, the return value of __soapCall will be
+ * a simple value (e.g. an integer, a string, etc). If multiple values are
+ * returned, __soapCall will return
+ * an associative array of named output parameters.
+ *
+ *
+ * On error, if the SoapClient object was constructed with the exceptions
+ * option set to FALSE, a SoapFault object will be returned.
+ * @since 5.0.1
+ */
+ public function __soapCall($name, $args, $options = null, $inputHeaders = null, &$outputHeaders = null) {}
- /**
- * Returns last SOAP response
- * @link https://php.net/manual/en/soapclient.getlastresponse.php
- * @return string The last SOAP response, as an XML string.
- * @since 5.0.1
- */
- public function __getLastResponse () {}
+ /**
+ * Returns last SOAP request
+ * @link https://php.net/manual/en/soapclient.getlastrequest.php
+ * @return string The last SOAP request, as an XML string.
+ * @since 5.0.1
+ */
+ public function __getLastRequest() {}
- /**
- * Returns the SOAP headers from the last request
- * @link https://php.net/manual/en/soapclient.getlastrequestheaders.php
- * @return string The last SOAP request headers.
- * @since 5.0.1
- */
- public function __getLastRequestHeaders () {}
+ /**
+ * Returns last SOAP response
+ * @link https://php.net/manual/en/soapclient.getlastresponse.php
+ * @return string The last SOAP response, as an XML string.
+ * @since 5.0.1
+ */
+ public function __getLastResponse() {}
- /**
- * Returns the SOAP headers from the last response
- * @link https://php.net/manual/en/soapclient.getlastresponseheaders.php
- * @return string The last SOAP response headers.
- * @since 5.0.1
- */
- public function __getLastResponseHeaders () {}
+ /**
+ * Returns the SOAP headers from the last request
+ * @link https://php.net/manual/en/soapclient.getlastrequestheaders.php
+ * @return string The last SOAP request headers.
+ * @since 5.0.1
+ */
+ public function __getLastRequestHeaders() {}
- /**
- * Returns list of available SOAP functions
- * @link https://php.net/manual/en/soapclient.getfunctions.php
- * @return array The array of SOAP function prototypes, detailing the return type,
- * the function name and type-hinted parameters.
- * @since 5.0.1
- */
- public function __getFunctions () {}
+ /**
+ * Returns the SOAP headers from the last response
+ * @link https://php.net/manual/en/soapclient.getlastresponseheaders.php
+ * @return string The last SOAP response headers.
+ * @since 5.0.1
+ */
+ public function __getLastResponseHeaders() {}
- /**
- * Returns a list of SOAP types
- * @link https://php.net/manual/en/soapclient.gettypes.php
- * @return array The array of SOAP types, detailing all structures and types.
- * @since 5.0.1
- */
- public function __getTypes () {}
+ /**
+ * Returns list of available SOAP functions
+ * @link https://php.net/manual/en/soapclient.getfunctions.php
+ * @return array The array of SOAP function prototypes, detailing the return type,
+ * the function name and type-hinted parameters.
+ * @since 5.0.1
+ */
+ public function __getFunctions() {}
- /**
- * Returns a list of all cookies
- * @link https://php.net/manual/en/soapclient.getcookies.php
- * @return array The array of all cookies
- * @since 5.4.3
- */
- public function __getCookies () {}
+ /**
+ * Returns a list of SOAP types
+ * @link https://php.net/manual/en/soapclient.gettypes.php
+ * @return array The array of SOAP types, detailing all structures and types.
+ * @since 5.0.1
+ */
+ public function __getTypes() {}
- /**
- * Performs a SOAP request
- * @link https://php.net/manual/en/soapclient.dorequest.php
- * @param string $request
- * The XML SOAP request.
- *
- * @param string $location
- * The URL to request.
- *
- * @param string $action
- * The SOAP action.
- *
- * @param int $version
- * The SOAP version.
- *
- * @param int $oneWay [optional]
- * If one_way is set to 1, this method returns nothing.
- * Use this where a response is not expected.
- *
- * @return string The XML SOAP response.
- * @since 5.0.1
- */
- public function __doRequest ($request, $location, $action, $version, $oneWay = false) {}
+ /**
+ * Returns a list of all cookies
+ * @link https://php.net/manual/en/soapclient.getcookies.php
+ * @return array The array of all cookies
+ * @since 5.4.3
+ */
+ public function __getCookies() {}
- /**
- * The __setCookie purpose
- * @link https://php.net/manual/en/soapclient.setcookie.php
- * @param string $name
- * The name of the cookie.
- *
- * @param string $value [optional]
- * The value of the cookie. If not specified, the cookie will be deleted.
- *
- * @return void No value is returned.
- * @since 5.0.4
- */
- public function __setCookie ($name, $value = null) {}
+ /**
+ * Performs a SOAP request
+ * @link https://php.net/manual/en/soapclient.dorequest.php
+ * @param string $request
+ * The XML SOAP request.
+ *
+ * @param string $location
+ * The URL to request.
+ *
+ * @param string $action
+ * The SOAP action.
+ *
+ * @param int $version
+ * The SOAP version.
+ *
+ * @param int $oneWay [optional]
+ * If one_way is set to 1, this method returns nothing.
+ * Use this where a response is not expected.
+ *
+ * @return string The XML SOAP response.
+ * @since 5.0.1
+ */
+ public function __doRequest($request, $location, $action, $version, $oneWay = false) {}
- /**
- * Sets the location of the Web service to use
- * @link https://php.net/manual/en/soapclient.setlocation.php
- * @param string|null $location [optional]
- * The new endpoint URL.
- *
- * @return string The old endpoint URL.
- * @since 5.0.1
- */
- public function __setLocation ($location = null) {}
+ /**
+ * The __setCookie purpose
+ * @link https://php.net/manual/en/soapclient.setcookie.php
+ * @param string $name
+ * The name of the cookie.
+ *
+ * @param string $value [optional]
+ * The value of the cookie. If not specified, the cookie will be deleted.
+ *
+ * @return void No value is returned.
+ * @since 5.0.4
+ */
+ public function __setCookie($name, $value = null) {}
- /**
- * Sets SOAP headers for subsequent calls
- * @link https://php.net/manual/en/soapclient.setsoapheaders.php
- * @param mixed $headers [optional]
- * The headers to be set. It could be SoapHeader
- * object or array of SoapHeader objects.
- * If not specified or set to NULL, the headers will be deleted.
- *
- * @return bool TRUE on success or FALSE on failure.
- * @since 5.0.5
- */
- public function __setSoapHeaders ($headers = null) {}
+ /**
+ * Sets the location of the Web service to use
+ * @link https://php.net/manual/en/soapclient.setlocation.php
+ * @param string|null $location [optional]
+ * The new endpoint URL.
+ *
+ * @return string The old endpoint URL.
+ * @since 5.0.1
+ */
+ public function __setLocation($location = null) {}
+ /**
+ * Sets SOAP headers for subsequent calls
+ * @link https://php.net/manual/en/soapclient.setsoapheaders.php
+ * @param mixed $headers [optional]
+ * The headers to be set. It could be SoapHeader
+ * object or array of SoapHeader objects.
+ * If not specified or set to NULL, the headers will be deleted.
+ *
+ * @return bool TRUE on success or FALSE on failure.
+ * @since 5.0.5
+ */
+ public function __setSoapHeaders($headers = null) {}
}
/**
* A class representing a variable or object for use with SOAP services.
* @link https://php.net/manual/en/class.soapvar.php
*/
-class SoapVar {
-
- /**
- * SoapVar constructor
- * @link https://php.net/manual/en/soapvar.soapvar.php
- * @param mixed $data
- * The data to pass or return.
- *
- * @param string|int $encoding
- * The encoding ID, one of the XSD_... constants.
- *
- * @param string $typeName [optional]
- * The type name.
- *
- * @param string $typeNamespace [optional]
- * The type namespace.
- *
- * @param string $nodeName [optional]
- * The XML node name.
- *
- * @param string $nodeNamespace [optional]
- * The XML node namespace.
- *
- * @since 5.0.1
- */
- public function __construct ($data, $encoding, $typeName = null, $typeNamespace = null, $nodeName = null, $nodeNamespace = null) {}
-
- /**
- * SoapVar constructor
- * @link https://php.net/manual/en/soapvar.soapvar.php
- * @param mixed $data
- * The data to pass or return.
- *
- * @param string|int $encoding
- * The encoding ID, one of the XSD_... constants.
- *
- * @param string $type_name [optional]
- * The type name.
- *
- * @param string $type_namespace [optional]
- * The type namespace.
- *
- * @param string $node_name [optional]
- * The XML node name.
- *
- * @param string $node_namespace [optional]
- * The XML node namespace.
- *
- * @since 5.0.1
- * @removed 8.0
- */
- public function SoapVar ($data, $encoding, $type_name = null, $type_namespace = null, $node_name = null, $node_namespace = null) {}
+class SoapVar
+{
+ /**
+ * SoapVar constructor
+ * @link https://php.net/manual/en/soapvar.soapvar.php
+ * @param mixed $data
+ * The data to pass or return.
+ *
+ * @param string|int $encoding
+ * The encoding ID, one of the XSD_... constants.
+ *
+ * @param string $typeName [optional]
+ * The type name.
+ *
+ * @param string $typeNamespace [optional]
+ * The type namespace.
+ *
+ * @param string $nodeName [optional]
+ * The XML node name.
+ *
+ * @param string $nodeNamespace [optional]
+ * The XML node namespace.
+ *
+ * @since 5.0.1
+ */
+ public function __construct($data, $encoding, $typeName = null, $typeNamespace = null, $nodeName = null, $nodeNamespace = null) {}
+ /**
+ * SoapVar constructor
+ * @link https://php.net/manual/en/soapvar.soapvar.php
+ * @param mixed $data
+ * The data to pass or return.
+ *
+ * @param string|int $encoding
+ * The encoding ID, one of the XSD_... constants.
+ *
+ * @param string $type_name [optional]
+ * The type name.
+ *
+ * @param string $type_namespace [optional]
+ * The type namespace.
+ *
+ * @param string $node_name [optional]
+ * The XML node name.
+ *
+ * @param string $node_namespace [optional]
+ * The XML node namespace.
+ *
+ * @since 5.0.1
+ * @removed 8.0
+ */
+ public function SoapVar($data, $encoding, $type_name = null, $type_namespace = null, $node_name = null, $node_namespace = 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 https://php.net/manual/en/class.soapserver.php
*/
-class SoapServer {
-
- /**
- * SoapServer constructor
- * @link https://php.net/manual/en/soapserver.soapserver.php
- * @param mixed $wsdl
- * To use the SoapServer in WSDL mode, pass the URI of a WSDL file.
- * Otherwise, pass NULL and set the uri option to the
- * target namespace for the server.
- *
- * @param array $options [optional]
- * Allow setting a default SOAP version (soap_version),
- * internal character encoding (encoding),
- * and actor URI (actor).
- *
- *
- * The classmap option can be used to map some WSDL
- * types to PHP classes. This option must be an array with WSDL types
- * as keys and names of PHP classes as values.
- *
- *
- * The typemap option is an array of type mappings.
- * Type mapping is an array with keys type_name,
- * type_ns (namespace URI), from_xml
- * (callback accepting one string parameter) and to_xml
- * (callback accepting one object parameter).
- *
- *
- * The cache_wsdl option is one of
- * WSDL_CACHE_NONE,
- * WSDL_CACHE_DISK,
- * WSDL_CACHE_MEMORY or
- * WSDL_CACHE_BOTH.
- *
- *
- * There is also a features option which can be set to
- * SOAP_WAIT_ONE_WAY_CALLS,
- * SOAP_SINGLE_ELEMENT_ARRAYS,
- * SOAP_USE_XSI_ARRAY_TYPE.
- *
- * @since 5.0.1
- */
- public function __construct ($wsdl, array $options = null) {}
-
- /**
- * SoapServer constructor
- * @link https://php.net/manual/en/soapserver.soapserver.php
- * @param mixed $wsdl
- * To use the SoapServer in WSDL mode, pass the URI of a WSDL file.
- * Otherwise, pass NULL and set the uri option to the
- * target namespace for the server.
- *
- * @param array $options [optional]
- * Allow setting a default SOAP version (soap_version),
- * internal character encoding (encoding),
- * and actor URI (actor).
- *
- *
- * The classmap option can be used to map some WSDL
- * types to PHP classes. This option must be an array with WSDL types
- * as keys and names of PHP classes as values.
- *
- *
- * The typemap option is an array of type mappings.
- * Type mapping is an array with keys type_name,
- * type_ns (namespace URI), from_xml
- * (callback accepting one string parameter) and to_xml
- * (callback accepting one object parameter).
- *
- *
- * The cache_wsdl option is one of
- * WSDL_CACHE_NONE,
- * WSDL_CACHE_DISK,
- * WSDL_CACHE_MEMORY or
- * WSDL_CACHE_BOTH.
- *
- *
- * There is also a features option which can be set to
- * SOAP_WAIT_ONE_WAY_CALLS,
- * SOAP_SINGLE_ELEMENT_ARRAYS,
- * SOAP_USE_XSI_ARRAY_TYPE.
- *
- * @since 5.0.1
- * @removed 8.0
- */
- public function SoapServer ($wsdl, array $options = null) {}
+class SoapServer
+{
+ /**
+ * SoapServer constructor
+ * @link https://php.net/manual/en/soapserver.soapserver.php
+ * @param mixed $wsdl
+ * To use the SoapServer in WSDL mode, pass the URI of a WSDL file.
+ * Otherwise, pass NULL and set the uri option to the
+ * target namespace for the server.
+ *
+ * @param array $options [optional]
+ * Allow setting a default SOAP version (soap_version),
+ * internal character encoding (encoding),
+ * and actor URI (actor).
+ *
+ *
+ * The classmap option can be used to map some WSDL
+ * types to PHP classes. This option must be an array with WSDL types
+ * as keys and names of PHP classes as values.
+ *
+ *
+ * The typemap option is an array of type mappings.
+ * Type mapping is an array with keys type_name,
+ * type_ns (namespace URI), from_xml
+ * (callback accepting one string parameter) and to_xml
+ * (callback accepting one object parameter).
+ *
+ *
+ * The cache_wsdl option is one of
+ * WSDL_CACHE_NONE,
+ * WSDL_CACHE_DISK,
+ * WSDL_CACHE_MEMORY or
+ * WSDL_CACHE_BOTH.
+ *
+ *
+ * There is also a features option which can be set to
+ * SOAP_WAIT_ONE_WAY_CALLS,
+ * SOAP_SINGLE_ELEMENT_ARRAYS,
+ * SOAP_USE_XSI_ARRAY_TYPE.
+ *
+ * @since 5.0.1
+ */
+ public function __construct($wsdl, array $options = null) {}
- /**
- * Sets SoapServer persistence mode
- * @link https://php.net/manual/en/soapserver.setpersistence.php
- * @param int $mode
- * One of the SOAP_PERSISTENCE_XXX constants.
- *
- *
- * SOAP_PERSISTENCE_REQUEST - SoapServer data does not persist between
- * requests. This is the default behavior of any SoapServer
- * object after setClass is called.
- *
- *
- * SOAP_PERSISTENCE_SESSION - SoapServer data persists between requests.
- * This is accomplished by serializing the SoapServer class data into
- * $_SESSION['_bogus_session_name'], because of this
- * session_start must be called before this persistence mode is set.
- *
- * @return void No value is returned.
- * @since 5.1.2
- */
- public function setPersistence ($mode) {}
+ /**
+ * SoapServer constructor
+ * @link https://php.net/manual/en/soapserver.soapserver.php
+ * @param mixed $wsdl
+ * To use the SoapServer in WSDL mode, pass the URI of a WSDL file.
+ * Otherwise, pass NULL and set the uri option to the
+ * target namespace for the server.
+ *
+ * @param array $options [optional]
+ * Allow setting a default SOAP version (soap_version),
+ * internal character encoding (encoding),
+ * and actor URI (actor).
+ *
+ *
+ * The classmap option can be used to map some WSDL
+ * types to PHP classes. This option must be an array with WSDL types
+ * as keys and names of PHP classes as values.
+ *
+ *
+ * The typemap option is an array of type mappings.
+ * Type mapping is an array with keys type_name,
+ * type_ns (namespace URI), from_xml
+ * (callback accepting one string parameter) and to_xml
+ * (callback accepting one object parameter).
+ *
+ *
+ * The cache_wsdl option is one of
+ * WSDL_CACHE_NONE,
+ * WSDL_CACHE_DISK,
+ * WSDL_CACHE_MEMORY or
+ * WSDL_CACHE_BOTH.
+ *
+ *
+ * There is also a features option which can be set to
+ * SOAP_WAIT_ONE_WAY_CALLS,
+ * SOAP_SINGLE_ELEMENT_ARRAYS,
+ * SOAP_USE_XSI_ARRAY_TYPE.
+ *
+ * @since 5.0.1
+ * @removed 8.0
+ */
+ public function SoapServer($wsdl, array $options = null) {}
- /**
- * Sets the class which handles SOAP requests
- * @link https://php.net/manual/en/soapserver.setclass.php
- * @param string $class
- * The name of the exported class.
- *
- * @param mixed ...$args [optional] These optional parameters will be passed to the default class constructor during object creation.
- * @return void No value is returned.
- * @since 5.0.1
- */
- public function setClass ($class, ...$args) {}
+ /**
+ * Sets SoapServer persistence mode
+ * @link https://php.net/manual/en/soapserver.setpersistence.php
+ * @param int $mode
+ * One of the SOAP_PERSISTENCE_XXX constants.
+ *
+ *
+ * SOAP_PERSISTENCE_REQUEST - SoapServer data does not persist between
+ * requests. This is the default behavior of any SoapServer
+ * object after setClass is called.
+ *
+ *
+ * SOAP_PERSISTENCE_SESSION - SoapServer data persists between requests.
+ * This is accomplished by serializing the SoapServer class data into
+ * $_SESSION['_bogus_session_name'], because of this
+ * session_start must be called before this persistence mode is set.
+ *
+ * @return void No value is returned.
+ * @since 5.1.2
+ */
+ public function setPersistence($mode) {}
- /**
- * Sets the object which will be used to handle SOAP requests
- * @link https://php.net/manual/en/soapserver.setobject.php
- * @param object $object
- * The object to handle the requests.
- *
- * @return void No value is returned.
- */
- public function setObject ($object) {}
+ /**
+ * Sets the class which handles SOAP requests
+ * @link https://php.net/manual/en/soapserver.setclass.php
+ * @param string $class
+ * The name of the exported class.
+ *
+ * @param mixed ...$args [optional] These optional parameters will be passed to the default class constructor during object creation.
+ * @return void No value is returned.
+ * @since 5.0.1
+ */
+ public function setClass($class, ...$args) {}
- /**
- * Adds one or more functions to handle SOAP requests
- * @link https://php.net/manual/en/soapserver.addfunction.php
- * @param mixed $functions
- * To export one function, pass the function name into this parameter as
- * a string.
- *
- *
- * To export several functions, pass an array of function names.
- *
- *
- * To export all the functions, pass a special constant SOAP_FUNCTIONS_ALL.
- *
- *
- * functions must receive all input arguments in the same
- * order as defined in the WSDL file (They should not receive any output parameters
- * as arguments) and return one or more values. To return several values they must
- * return an array with named output parameters.
- *
- * @return void No value is returned.
- * @since 5.0.1
- */
- public function addFunction ($functions) {}
+ /**
+ * Sets the object which will be used to handle SOAP requests
+ * @link https://php.net/manual/en/soapserver.setobject.php
+ * @param object $object
+ * The object to handle the requests.
+ *
+ * @return void No value is returned.
+ */
+ public function setObject($object) {}
- /**
- * Returns list of defined functions
- * @link https://php.net/manual/en/soapserver.getfunctions.php
- * @return array An array of the defined functions.
- * @since 5.0.1
- */
- public function getFunctions () {}
+ /**
+ * Adds one or more functions to handle SOAP requests
+ * @link https://php.net/manual/en/soapserver.addfunction.php
+ * @param mixed $functions
+ * To export one function, pass the function name into this parameter as
+ * a string.
+ *
+ *
+ * To export several functions, pass an array of function names.
+ *
+ *
+ * To export all the functions, pass a special constant SOAP_FUNCTIONS_ALL.
+ *
+ *
+ * functions must receive all input arguments in the same
+ * order as defined in the WSDL file (They should not receive any output parameters
+ * as arguments) and return one or more values. To return several values they must
+ * return an array with named output parameters.
+ *
+ * @return void No value is returned.
+ * @since 5.0.1
+ */
+ public function addFunction($functions) {}
- /**
- * Handles a SOAP request
- * @link https://php.net/manual/en/soapserver.handle.php
- * @param string $request [optional]
- * The SOAP request. If this argument is omitted, the request is assumed to be
- * in the raw POST data of the HTTP request.
- *
- * @return void No value is returned.
- * @since 5.0.1
- */
- public function handle ($request = null) {}
+ /**
+ * Returns list of defined functions
+ * @link https://php.net/manual/en/soapserver.getfunctions.php
+ * @return array An array of the defined functions.
+ * @since 5.0.1
+ */
+ public function getFunctions() {}
- /**
- * Issue SoapServer fault indicating an error
- * @link https://php.net/manual/en/soapserver.fault.php
- * @param string $code
- * The error code to return
- *
- * @param string $string
- * A brief description of the error
- *
- * @param string $actor [optional]
- * A string identifying the actor that caused the fault.
- *
- * @param string $details [optional]
- * More details of the fault
- *
- * @param string $name [optional]
- * The name of the fault. This can be used to select a name from a WSDL file.
- *
- * @return void No value is returned.
- * @since 5.0.1
- */
- public function fault ($code, $string, $actor = null, $details = null, $name = null) {}
+ /**
+ * Handles a SOAP request
+ * @link https://php.net/manual/en/soapserver.handle.php
+ * @param string $request [optional]
+ * The SOAP request. If this argument is omitted, the request is assumed to be
+ * in the raw POST data of the HTTP request.
+ *
+ * @return void No value is returned.
+ * @since 5.0.1
+ */
+ public function handle($request = null) {}
- /**
- * Add a SOAP header to the response
- * @link https://php.net/manual/en/soapserver.addsoapheader.php
- * @param SoapHeader $header
- * The header to be returned.
- *
- * @return void No value is returned.
- * @since 5.0.1
- */
- public function addSoapHeader (SoapHeader $header) {}
+ /**
+ * Issue SoapServer fault indicating an error
+ * @link https://php.net/manual/en/soapserver.fault.php
+ * @param string $code
+ * The error code to return
+ *
+ * @param string $string
+ * A brief description of the error
+ *
+ * @param string $actor [optional]
+ * A string identifying the actor that caused the fault.
+ *
+ * @param string $details [optional]
+ * More details of the fault
+ *
+ * @param string $name [optional]
+ * The name of the fault. This can be used to select a name from a WSDL file.
+ *
+ * @return void No value is returned.
+ * @since 5.0.1
+ */
+ public function fault($code, $string, $actor = null, $details = null, $name = null) {}
+ /**
+ * Add a SOAP header to the response
+ * @link https://php.net/manual/en/soapserver.addsoapheader.php
+ * @param SoapHeader $header
+ * The header to be returned.
+ *
+ * @return void No value is returned.
+ * @since 5.0.1
+ */
+ public function addSoapHeader(SoapHeader $header) {}
}
/**
* Represents a SOAP fault.
* @link https://php.net/manual/en/class.soapfault.php
*/
-class SoapFault extends Exception {
+class SoapFault extends Exception
+{
/**
* @var string
*/
- public $faultcode;
+ public $faultcode;
/**
* @var string
*/
- public $faultstring;
+ public $faultstring;
/**
* @var string
*/
@@ -741,161 +739,157 @@ class SoapFault extends Exception {
*/
public $headerfault;
- /**
- * SoapFault constructor
- * @link https://php.net/manual/en/soapfault.soapfault.php
- * @param string $code
- * The error code of the SoapFault.
- *
- * @param string $string
- * The error message of the SoapFault.
- *
- * @param string $actor [optional]
- * A string identifying the actor that caused the error.
- *
- * @param string $details [optional]
- * More details about the cause of the error.
- *
- * @param string $name [optional]
- * Can be used to select the proper fault encoding from WSDL.
- *
- * @param mixed $headerFault [optional]
- * Can be used during SOAP header handling to report an error in the
- * response header.
- *
- * @since 5.0.1
- */
- #[\JetBrains\PhpStorm\Pure]
- public function __construct ($code, $string, $actor = null, $details = null, $name = null, $headerFault = null) {}
-
- /**
- * SoapFault constructor
- * @link https://php.net/manual/en/soapfault.soapfault.php
- * @param string $faultcode
- * The error code of the SoapFault.
- *
- * @param string $faultstring
- * The error message of the SoapFault.
- *
- * @param string $faultactor [optional]
- * A string identifying the actor that caused the error.
- *
- * @param string $detail [optional]
- * More details about the cause of the error.
- *
- * @param string $faultname [optional]
- * Can be used to select the proper fault encoding from WSDL.
- *
- * @param mixed $headerfault [optional]
- * Can be used during SOAP header handling to report an error in the
- * response header.
- *
- * @since 5.0.1
- * @removed 8.0
- */
- public function SoapFault ($faultcode, $faultstring, $faultactor = null, $detail = null, $faultname = null, $headerfault = null) {}
-
- /**
- * Obtain a string representation of a SoapFault
- * @link https://php.net/manual/en/soapfault.tostring.php
- * @return string A string describing the SoapFault.
- * @since 5.0.1
- */
- public function __toString () {}
+ /**
+ * SoapFault constructor
+ * @link https://php.net/manual/en/soapfault.soapfault.php
+ * @param string $code
+ * The error code of the SoapFault.
+ *
+ * @param string $string
+ * The error message of the SoapFault.
+ *
+ * @param string $actor [optional]
+ * A string identifying the actor that caused the error.
+ *
+ * @param string $details [optional]
+ * More details about the cause of the error.
+ *
+ * @param string $name [optional]
+ * Can be used to select the proper fault encoding from WSDL.
+ *
+ * @param mixed $headerFault [optional]
+ * Can be used during SOAP header handling to report an error in the
+ * response header.
+ *
+ * @since 5.0.1
+ */
+ #[\JetBrains\PhpStorm\Pure]
+ public function __construct($code, $string, $actor = null, $details = null, $name = null, $headerFault = null) {}
+ /**
+ * SoapFault constructor
+ * @link https://php.net/manual/en/soapfault.soapfault.php
+ * @param string $faultcode
+ * The error code of the SoapFault.
+ *
+ * @param string $faultstring
+ * The error message of the SoapFault.
+ *
+ * @param string $faultactor [optional]
+ * A string identifying the actor that caused the error.
+ *
+ * @param string $detail [optional]
+ * More details about the cause of the error.
+ *
+ * @param string $faultname [optional]
+ * Can be used to select the proper fault encoding from WSDL.
+ *
+ * @param mixed $headerfault [optional]
+ * Can be used during SOAP header handling to report an error in the
+ * response header.
+ *
+ * @since 5.0.1
+ * @removed 8.0
+ */
+ public function SoapFault($faultcode, $faultstring, $faultactor = null, $detail = null, $faultname = null, $headerfault = null) {}
+ /**
+ * Obtain a string representation of a SoapFault
+ * @link https://php.net/manual/en/soapfault.tostring.php
+ * @return string A string describing the SoapFault.
+ * @since 5.0.1
+ */
+ public function __toString() {}
}
/**
* Represents parameter to a SOAP call.
* @link https://php.net/manual/en/class.soapparam.php
*/
-class SoapParam {
-
- /**
- * SoapParam constructor
- * @link https://php.net/manual/en/soapparam.soapparam.php
- * @param mixed $data
- * The data to pass or return. This parameter can be passed directly as PHP
- * value, but in this case it will be named as paramN and
- * the SOAP service may not understand it.
- *
- * @param string $name
- * The parameter name.
- *
- * @since 5.0.1
- */
- public function __construct ($data, $name) {}
-
- /**
- * SoapParam constructor
- * @link https://php.net/manual/en/soapparam.soapparam.php
- * @param mixed $data
- * The data to pass or return. This parameter can be passed directly as PHP
- * value, but in this case it will be named as paramN and
- * the SOAP service may not understand it.
- *
- * @param string $name
- * The parameter name.
- *
- * @since 5.0.1
- * @removed 8.0
- */
- public function SoapParam ($data, $name) {}
+class SoapParam
+{
+ /**
+ * SoapParam constructor
+ * @link https://php.net/manual/en/soapparam.soapparam.php
+ * @param mixed $data
+ * The data to pass or return. This parameter can be passed directly as PHP
+ * value, but in this case it will be named as paramN and
+ * the SOAP service may not understand it.
+ *
+ * @param string $name
+ * The parameter name.
+ *
+ * @since 5.0.1
+ */
+ public function __construct($data, $name) {}
+ /**
+ * SoapParam constructor
+ * @link https://php.net/manual/en/soapparam.soapparam.php
+ * @param mixed $data
+ * The data to pass or return. This parameter can be passed directly as PHP
+ * value, but in this case it will be named as paramN and
+ * the SOAP service may not understand it.
+ *
+ * @param string $name
+ * The parameter name.
+ *
+ * @since 5.0.1
+ * @removed 8.0
+ */
+ public function SoapParam($data, $name) {}
}
/**
* Represents a SOAP header.
* @link https://php.net/manual/en/class.soapheader.php
*/
-class SoapHeader {
-
- /**
- * SoapHeader constructor
- * @link https://www.php.net/manual/en/soapheader.construct.php
- * @param string $namespace
- * The namespace of the SOAP header element.
- *
- * @param string $name
- * The name of the SoapHeader object.
- *
- * @param mixed $data [optional]
- * A SOAP header's content. It can be a PHP value or a
- * SoapVar object.
- *
- * @param bool $mustUnderstand [optional]
- * @param string $actor [optional]
- * Value of the actor attribute of the SOAP header
- * element.
- *
- * @since 5.0.1
- */
- public function __construct ($namespace, $name, $data = null, $mustUnderstand = false, $actor = null) {}
-
- /**
- * SoapHeader constructor
- * @link https://php.net/manual/en/soapheader.soapheader.php
- * @param string $namespace
- * The namespace of the SOAP header element.
- *
- * @param string $name
- * The name of the SoapHeader object.
- *
- * @param mixed $data [optional]
- * A SOAP header's content. It can be a PHP value or a
- * SoapVar object.
- *
- * @param bool $mustunderstand [optional]
- * @param string $actor [optional]
- * Value of the actor attribute of the SOAP header
- * element.
- *
- * @since 5.0.1
- * @removed 8.0
- */
- public function SoapHeader ($namespace, $name, $data = null, $mustunderstand = false, $actor = null) {}
+class SoapHeader
+{
+ /**
+ * SoapHeader constructor
+ * @link https://www.php.net/manual/en/soapheader.construct.php
+ * @param string $namespace
+ * The namespace of the SOAP header element.
+ *
+ * @param string $name
+ * The name of the SoapHeader object.
+ *
+ * @param mixed $data [optional]
+ * A SOAP header's content. It can be a PHP value or a
+ * SoapVar object.
+ *
+ * @param bool $mustUnderstand [optional]
+ * @param string $actor [optional]
+ * Value of the actor attribute of the SOAP header
+ * element.
+ *
+ * @since 5.0.1
+ */
+ public function __construct($namespace, $name, $data = null, $mustUnderstand = false, $actor = null) {}
+ /**
+ * SoapHeader constructor
+ * @link https://php.net/manual/en/soapheader.soapheader.php
+ * @param string $namespace
+ * The namespace of the SOAP header element.
+ *
+ * @param string $name
+ * The name of the SoapHeader object.
+ *
+ * @param mixed $data [optional]
+ * A SOAP header's content. It can be a PHP value or a
+ * SoapVar object.
+ *
+ * @param bool $mustunderstand [optional]
+ * @param string $actor [optional]
+ * Value of the actor attribute of the SOAP header
+ * element.
+ *
+ * @since 5.0.1
+ * @removed 8.0
+ */
+ public function SoapHeader($namespace, $name, $data = null, $mustunderstand = false, $actor = null) {}
}
/**
@@ -906,7 +900,7 @@ public function SoapHeader ($namespace, $name, $data = null, $mustunderstand = f
*
* @return bool the original value.
*/
-function use_soap_error_handler (bool $enable = true): bool {}
+function use_soap_error_handler(bool $enable = true): bool {}
/**
* Checks if a SOAP call has failed
@@ -916,109 +910,108 @@ function use_soap_error_handler (bool $enable = true): bool {}
*
* @return bool This will return TRUE on error, and FALSE otherwise.
*/
-function is_soap_fault (mixed $object): bool {}
-
-define ('SOAP_1_1', 1);
-define ('SOAP_1_2', 2);
-define ('SOAP_PERSISTENCE_SESSION', 1);
-define ('SOAP_PERSISTENCE_REQUEST', 2);
-define ('SOAP_FUNCTIONS_ALL', 999);
-define ('SOAP_ENCODED', 1);
-define ('SOAP_LITERAL', 2);
-define ('SOAP_RPC', 1);
-define ('SOAP_DOCUMENT', 2);
-define ('SOAP_ACTOR_NEXT', 1);
-define ('SOAP_ACTOR_NONE', 2);
-define ('SOAP_ACTOR_UNLIMATERECEIVER', 3);
-define ('SOAP_COMPRESSION_ACCEPT', 32);
-define ('SOAP_COMPRESSION_GZIP', 0);
-define ('SOAP_COMPRESSION_DEFLATE', 16);
-define ('SOAP_AUTHENTICATION_BASIC', 0);
-define ('SOAP_AUTHENTICATION_DIGEST', 1);
-define ('UNKNOWN_TYPE', 999998);
-define ('XSD_STRING', 101);
-define ('XSD_BOOLEAN', 102);
-define ('XSD_DECIMAL', 103);
-define ('XSD_FLOAT', 104);
-define ('XSD_DOUBLE', 105);
-define ('XSD_DURATION', 106);
-define ('XSD_DATETIME', 107);
-define ('XSD_TIME', 108);
-define ('XSD_DATE', 109);
-define ('XSD_GYEARMONTH', 110);
-define ('XSD_GYEAR', 111);
-define ('XSD_GMONTHDAY', 112);
-define ('XSD_GDAY', 113);
-define ('XSD_GMONTH', 114);
-define ('XSD_HEXBINARY', 115);
-define ('XSD_BASE64BINARY', 116);
-define ('XSD_ANYURI', 117);
-define ('XSD_QNAME', 118);
-define ('XSD_NOTATION', 119);
-define ('XSD_NORMALIZEDSTRING', 120);
-define ('XSD_TOKEN', 121);
-define ('XSD_LANGUAGE', 122);
-define ('XSD_NMTOKEN', 123);
-define ('XSD_NAME', 124);
-define ('XSD_NCNAME', 125);
-define ('XSD_ID', 126);
-define ('XSD_IDREF', 127);
-define ('XSD_IDREFS', 128);
-define ('XSD_ENTITY', 129);
-define ('XSD_ENTITIES', 130);
-define ('XSD_INTEGER', 131);
-define ('XSD_NONPOSITIVEINTEGER', 132);
-define ('XSD_NEGATIVEINTEGER', 133);
-define ('XSD_LONG', 134);
-define ('XSD_INT', 135);
-define ('XSD_SHORT', 136);
-define ('XSD_BYTE', 137);
-define ('XSD_NONNEGATIVEINTEGER', 138);
-define ('XSD_UNSIGNEDLONG', 139);
-define ('XSD_UNSIGNEDINT', 140);
-define ('XSD_UNSIGNEDSHORT', 141);
-define ('XSD_UNSIGNEDBYTE', 142);
-define ('XSD_POSITIVEINTEGER', 143);
-define ('XSD_NMTOKENS', 144);
-define ('XSD_ANYTYPE', 145);
-define ('XSD_ANYXML', 147);
-define ('APACHE_MAP', 200);
-define ('SOAP_ENC_OBJECT', 301);
-define ('SOAP_ENC_ARRAY', 300);
-define ('XSD_1999_TIMEINSTANT', 401);
-define ('XSD_NAMESPACE', "http://www.w3.org/2001/XMLSchema");
-define ('XSD_1999_NAMESPACE', "http://www.w3.org/1999/XMLSchema");
-define ('SOAP_SINGLE_ELEMENT_ARRAYS', 1);
-define ('SOAP_WAIT_ONE_WAY_CALLS', 2);
-define ('SOAP_USE_XSI_ARRAY_TYPE', 4);
-define ('WSDL_CACHE_NONE', 0);
-define ('WSDL_CACHE_DISK', 1);
-define ('WSDL_CACHE_MEMORY', 2);
-define ('WSDL_CACHE_BOTH', 3);
+function is_soap_fault(mixed $object): bool {}
+
+define('SOAP_1_1', 1);
+define('SOAP_1_2', 2);
+define('SOAP_PERSISTENCE_SESSION', 1);
+define('SOAP_PERSISTENCE_REQUEST', 2);
+define('SOAP_FUNCTIONS_ALL', 999);
+define('SOAP_ENCODED', 1);
+define('SOAP_LITERAL', 2);
+define('SOAP_RPC', 1);
+define('SOAP_DOCUMENT', 2);
+define('SOAP_ACTOR_NEXT', 1);
+define('SOAP_ACTOR_NONE', 2);
+define('SOAP_ACTOR_UNLIMATERECEIVER', 3);
+define('SOAP_COMPRESSION_ACCEPT', 32);
+define('SOAP_COMPRESSION_GZIP', 0);
+define('SOAP_COMPRESSION_DEFLATE', 16);
+define('SOAP_AUTHENTICATION_BASIC', 0);
+define('SOAP_AUTHENTICATION_DIGEST', 1);
+define('UNKNOWN_TYPE', 999998);
+define('XSD_STRING', 101);
+define('XSD_BOOLEAN', 102);
+define('XSD_DECIMAL', 103);
+define('XSD_FLOAT', 104);
+define('XSD_DOUBLE', 105);
+define('XSD_DURATION', 106);
+define('XSD_DATETIME', 107);
+define('XSD_TIME', 108);
+define('XSD_DATE', 109);
+define('XSD_GYEARMONTH', 110);
+define('XSD_GYEAR', 111);
+define('XSD_GMONTHDAY', 112);
+define('XSD_GDAY', 113);
+define('XSD_GMONTH', 114);
+define('XSD_HEXBINARY', 115);
+define('XSD_BASE64BINARY', 116);
+define('XSD_ANYURI', 117);
+define('XSD_QNAME', 118);
+define('XSD_NOTATION', 119);
+define('XSD_NORMALIZEDSTRING', 120);
+define('XSD_TOKEN', 121);
+define('XSD_LANGUAGE', 122);
+define('XSD_NMTOKEN', 123);
+define('XSD_NAME', 124);
+define('XSD_NCNAME', 125);
+define('XSD_ID', 126);
+define('XSD_IDREF', 127);
+define('XSD_IDREFS', 128);
+define('XSD_ENTITY', 129);
+define('XSD_ENTITIES', 130);
+define('XSD_INTEGER', 131);
+define('XSD_NONPOSITIVEINTEGER', 132);
+define('XSD_NEGATIVEINTEGER', 133);
+define('XSD_LONG', 134);
+define('XSD_INT', 135);
+define('XSD_SHORT', 136);
+define('XSD_BYTE', 137);
+define('XSD_NONNEGATIVEINTEGER', 138);
+define('XSD_UNSIGNEDLONG', 139);
+define('XSD_UNSIGNEDINT', 140);
+define('XSD_UNSIGNEDSHORT', 141);
+define('XSD_UNSIGNEDBYTE', 142);
+define('XSD_POSITIVEINTEGER', 143);
+define('XSD_NMTOKENS', 144);
+define('XSD_ANYTYPE', 145);
+define('XSD_ANYXML', 147);
+define('APACHE_MAP', 200);
+define('SOAP_ENC_OBJECT', 301);
+define('SOAP_ENC_ARRAY', 300);
+define('XSD_1999_TIMEINSTANT', 401);
+define('XSD_NAMESPACE', "http://www.w3.org/2001/XMLSchema");
+define('XSD_1999_NAMESPACE', "http://www.w3.org/1999/XMLSchema");
+define('SOAP_SINGLE_ELEMENT_ARRAYS', 1);
+define('SOAP_WAIT_ONE_WAY_CALLS', 2);
+define('SOAP_USE_XSI_ARRAY_TYPE', 4);
+define('WSDL_CACHE_NONE', 0);
+define('WSDL_CACHE_DISK', 1);
+define('WSDL_CACHE_MEMORY', 2);
+define('WSDL_CACHE_BOTH', 3);
/**
* @link https://php.net/manual/en/soap.constants.php
* @since 5.5
*/
-define ('SOAP_SSL_METHOD_TLS', 0);
+define('SOAP_SSL_METHOD_TLS', 0);
/**
* @link https://php.net/manual/en/soap.constants.php
* @since 5.5
*/
-define ('SOAP_SSL_METHOD_SSLv2', 1);
+define('SOAP_SSL_METHOD_SSLv2', 1);
/**
* @link https://php.net/manual/en/soap.constants.php
* @since 5.5
*/
-define ('SOAP_SSL_METHOD_SSLv3', 2);
+define('SOAP_SSL_METHOD_SSLv3', 2);
/**
* @link https://php.net/manual/en/soap.constants.php
* @since 5.5
*/
-define ('SOAP_SSL_METHOD_SSLv23', 3);
+define('SOAP_SSL_METHOD_SSLv23', 3);
// End of soap v.
-?>
diff --git a/sockets/sockets.php b/sockets/sockets.php
index a0808ccd2..574411886 100644
--- a/sockets/sockets.php
+++ b/sockets/sockets.php
@@ -105,7 +105,7 @@ function socket_addrinfo_explain(AddressInfo $address): array {}
* }
*
*/
-function socket_select (?array &$read, ?array &$write, ?array &$except, ?int $seconds, int $microseconds = 0): int|false {}
+function socket_select(?array &$read, ?array &$write, ?array &$except, ?int $seconds, int $microseconds = 0): int|false {}
/**
* Create a socket (endpoint for communication)
@@ -243,7 +243,7 @@ function socket_select (?array &$read, ?array &$write, ?array &$except, ?int $se
* socket_strerror to get a textual explanation of the
* error.
*/
-function socket_create (int $domain, int $type, int $protocol): Socket|false {}
+function socket_create(int $domain, int $type, int $protocol): Socket|false {}
/**
* @param resource|Socket $socket
@@ -270,7 +270,7 @@ function socket_export_stream(Socket $socket) {}
* socket_strerror to get a textual explanation of the
* error.
*/
-function socket_create_listen (int $port, int $backlog = 128): Socket|false {}
+function socket_create_listen(int $port, int $backlog = 128): Socket|false {}
/**
* Creates a pair of indistinguishable sockets and stores them in an array
@@ -303,7 +303,7 @@ function socket_create_listen (int $port, int $backlog = 128): Socket|false {}
*
* @return bool TRUE on success or FALSE on failure.
*/
-function socket_create_pair (int $domain, int $type, int $protocol, &$pair): bool {}
+function socket_create_pair(int $domain, int $type, int $protocol, &$pair): bool {}
/**
* Accepts a connection on a socket
@@ -317,7 +317,7 @@ function socket_create_pair (int $domain, int $type, int $protocol, &$pair): boo
* socket_strerror to get a textual explanation of the
* error.
*/
-function socket_accept (Socket $socket): Socket|false {}
+function socket_accept(Socket $socket): Socket|false {}
/**
* Sets nonblocking mode for file descriptor fd
@@ -328,7 +328,7 @@ function socket_accept (Socket $socket): Socket|false {}
*
* @return bool TRUE on success or FALSE on failure.
*/
-function socket_set_nonblock (Socket $socket):bool {}
+function socket_set_nonblock(Socket $socket): bool {}
/**
* Sets blocking mode on a socket resource
@@ -339,7 +339,7 @@ function socket_set_nonblock (Socket $socket):bool {}
*
* @return bool TRUE on success or FALSE on failure.
*/
-function socket_set_block (Socket $socket): bool {}
+function socket_set_block(Socket $socket): bool {}
/**
* Listens for a connection on a socket
@@ -368,7 +368,7 @@ function socket_set_block (Socket $socket): bool {}
* socket_strerror to get a textual explanation of the
* error.
*/
-function socket_listen (Socket $socket, int $backlog = 0): bool {}
+function socket_listen(Socket $socket, int $backlog = 0): bool {}
/**
* Closes a socket resource
@@ -379,7 +379,7 @@ function socket_listen (Socket $socket, int $backlog = 0): bool {}
*
* @return void No value is returned.
*/
-function socket_close (Socket $socket): void {}
+function socket_close(Socket $socket): void {}
/**
* Write to a socket
@@ -406,7 +406,7 @@ function socket_close (Socket $socket): void {}
* === operator to check for FALSE in case of an
* error.
*/
-function socket_write (Socket $socket, string $data, ?int $length = 0): int|false {}
+function socket_write(Socket $socket, string $data, ?int $length = 0): int|false {}
/**
* Reads a maximum of length bytes from a socket
@@ -437,7 +437,7 @@ function socket_write (Socket $socket, string $data, ?int $length = 0): int|fals
* socket_read returns a zero length string ("")
* when there is no more data to read.
*/
-function socket_read (Socket $socket, int $length, int $mode = PHP_BINARY_READ): string|false {}
+function socket_read(Socket $socket, int $length, int $mode = PHP_BINARY_READ): 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
@@ -468,7 +468,7 @@ function socket_read (Socket $socket, int $length, int $mode = PHP_BINARY_READ):
* AF_INET6, or AF_UNIX, in which
* case the last socket error code is not updated.
*/
-function socket_getsockname (Socket $socket, &$address, &$port = null): bool {}
+function socket_getsockname(Socket $socket, &$address, &$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
@@ -501,7 +501,7 @@ function socket_getsockname (Socket $socket, &$address, &$port = null): bool {}
* AF_INET6, or AF_UNIX, in which
* case the last socket error code is not updated.
*/
-function socket_getpeername (Socket $socket, &$address, &$port = null): bool {}
+function socket_getpeername(Socket $socket, &$address, &$port = null): bool {}
/**
* Initiates a connection on a socket
@@ -531,7 +531,7 @@ function socket_getpeername (Socket $socket, &$address, &$port = null): bool {}
* If the socket is non-blocking then this function returns FALSE with an
* error Operation now in progress.
*/
-function socket_connect (Socket $socket, string $address, ?int $port = 0): bool {}
+function socket_connect(Socket $socket, string $address, ?int $port = 0): bool {}
/**
* Return a string describing a socket error
@@ -543,7 +543,7 @@ function socket_connect (Socket $socket, string $address, ?int $port = 0): bool
* @return string the error message associated with the errno
* parameter.
*/
-function socket_strerror (int $error_code): string {}
+function socket_strerror(int $error_code): string {}
/**
* Binds a name to a socket
@@ -573,7 +573,7 @@ function socket_strerror (int $error_code): string {}
* textual explanation of the error.
*
*/
-function socket_bind (Socket $socket, string $address, int $port = 0): bool {}
+function socket_bind(Socket $socket, string $address, int $port = 0): bool {}
/**
* Receives data from a connected socket
@@ -637,7 +637,7 @@ function socket_bind (Socket $socket, string $address, int $port = 0): bool {}
* passed to socket_strerror to get a textual explanation
* of the error.
*/
-function socket_recv (Socket $socket, &$data, int $length, int $flags): int|false {}
+function socket_recv(Socket $socket, &$data, int $length, int $flags): int|false {}
/**
* Sends data to a connected socket
@@ -689,7 +689,7 @@ function socket_recv (Socket $socket, &$data, int $length, int $flags): int|fals
*
* @return int|false socket_send returns the number of bytes sent, or FALSE on error.
*/
-function socket_send (Socket $socket, string $data, int $length, int $flags): int|false {}
+function socket_send(Socket $socket, string $data, int $length, int $flags): int|false {}
/**
* (PHP 5 >=5.5.0)
@@ -701,7 +701,7 @@ function socket_send (Socket $socket, string $data, int $length, int $flags): in
* @return int|false
* @since 5.5
*/
-function socket_sendmsg (Socket $socket, array $message, int $flags = 0): int|false {}
+function socket_sendmsg(Socket $socket, array $message, int $flags = 0): int|false {}
/**
* Receives data from a socket whether or not it is connection-oriented
@@ -775,7 +775,7 @@ function socket_sendmsg (Socket $socket, array $message, int $flags = 0): int|fa
* passed to socket_strerror to get a textual explanation
* of the error.
*/
-function socket_recvfrom (Socket $socket, &$data, int $length, int $flags, &$address, &$port = null): int|false {}
+function socket_recvfrom(Socket $socket, &$data, int $length, int $flags, &$address, &$port = null): int|false {}
/**
* Read a message
@@ -786,7 +786,7 @@ function socket_recvfrom (Socket $socket, &$data, int $length, int $flags, &$add
* @return int|false
* @since 5.5
*/
-function socket_recvmsg (Socket $socket , array &$message, int $flags): int|false {}
+function socket_recvmsg(Socket $socket, array &$message, int $flags): int|false {}
/**
* Sends a message to a socket, whether it is connected or not
@@ -845,7 +845,7 @@ function socket_recvmsg (Socket $socket , array &$message, int $flags): int|fals
* @return int|false socket_sendto returns the number of bytes sent to the
* remote host, or FALSE if an error occurred.
*/
-function socket_sendto (Socket $socket, string $data, int $length, int $flags, string $address, ?int $port = 0): int|false {}
+function socket_sendto(Socket $socket, string $data, int $length, int $flags, string $address, ?int $port = 0): int|false {}
/**
* Gets socket options for the socket
@@ -1211,7 +1211,7 @@ function socket_sendto (Socket $socket, string $data, int $length, int $flags, s
*
* @return array|int|false the value of the given option, or FALSE on errors.
*/
-function socket_get_option (Socket $socket, int $level, int $option): array|int|false {}
+function socket_get_option(Socket $socket, int $level, int $option): array|int|false {}
/**
* Sets socket options for the socket
@@ -1238,7 +1238,7 @@ function socket_get_option (Socket $socket, int $level, int $option): array|int|
*
* @return bool TRUE on success or FALSE on failure.
*/
-function socket_set_option (Socket $socket, int $level, int $option, $value): bool {}
+function socket_set_option(Socket $socket, int $level, int $option, $value): bool {}
/**
* Shuts down a socket for receiving, sending, or both
@@ -1272,7 +1272,7 @@ function socket_set_option (Socket $socket, int $level, int $option, $value): bo
*
* @return bool TRUE on success or FALSE on failure.
*/
-function socket_shutdown (Socket $socket, int $mode = 2): bool {}
+function socket_shutdown(Socket $socket, int $mode = 2): bool {}
/**
* Returns the last error on the socket
@@ -1282,7 +1282,7 @@ function socket_shutdown (Socket $socket, int $mode = 2): bool {}
*
* @return int This function returns a socket error code.
*/
-function socket_last_error (?Socket $socket = null): int {}
+function socket_last_error(?Socket $socket = null): int {}
/**
* Clears the error on the socket or the last error code
@@ -1292,7 +1292,7 @@ function socket_last_error (?Socket $socket = null): int {}
*
* @return void No value is returned.
*/
-function socket_clear_error (?Socket $socket = null): void {}
+function socket_clear_error(?Socket $socket = null): void {}
/**
* Import a stream
@@ -1303,7 +1303,7 @@ function socket_clear_error (?Socket $socket = null): void {}
* @return resource|Socket|false|null FALSE or NULL on failure.
* @since 5.4
*/
-function socket_import_stream ($stream): Socket|false {}
+function socket_import_stream($stream): Socket|false {}
/**
* Calculate message buffer size
@@ -1314,7 +1314,7 @@ function socket_import_stream ($stream): Socket|false {}
* @return int|null
* @since 5.5
*/
-function socket_cmsg_space ($level, $type, $n = 0): ?int {}
+function socket_cmsg_space($level, $type, $n = 0): ?int {}
/**
* Alias of {@see socket_get_option}
@@ -1322,7 +1322,7 @@ function socket_cmsg_space ($level, $type, $n = 0): ?int {}
* @param int $level
* @param int $option
*/
-function socket_getopt (Socket $socket, int $level, int $option): array|int|false {}
+function socket_getopt(Socket $socket, int $level, int $option): array|int|false {}
/**
* Alias of {@see socket_set_option}
@@ -1332,7 +1332,7 @@ function socket_getopt (Socket $socket, int $level, int $option): array|int|fals
* @param $value
* @return bool
*/
-function socket_setopt (Socket $socket, int $level, int $option, $value): bool {}
+function socket_setopt(Socket $socket, int $level, int $option, $value): bool {}
/**
* Exports the WSAPROTOCOL_INFO Structure
@@ -1371,47 +1371,46 @@ function socket_wsaprotocol_info_import($info_id) {}
*/
function socket_wsaprotocol_info_release($info_id) {}
-
-define ('AF_UNIX', 1);
-define ('AF_INET', 2);
+define('AF_UNIX', 1);
+define('AF_INET', 2);
/**
* Only available if compiled with IPv6 support.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('AF_INET6', 10);
-define ('SOCK_STREAM', 1);
-define ('SOCK_DGRAM', 2);
-define ('SOCK_RAW', 3);
-define ('SOCK_SEQPACKET', 5);
-define ('SOCK_RDM', 4);
-define ('MSG_OOB', 1);
-define ('MSG_WAITALL', 256);
-define ('MSG_CTRUNC', 8);
-define ('MSG_TRUNC', 32);
-define ('MSG_PEEK', 2);
-define ('MSG_DONTROUTE', 4);
+define('AF_INET6', 10);
+define('SOCK_STREAM', 1);
+define('SOCK_DGRAM', 2);
+define('SOCK_RAW', 3);
+define('SOCK_SEQPACKET', 5);
+define('SOCK_RDM', 4);
+define('MSG_OOB', 1);
+define('MSG_WAITALL', 256);
+define('MSG_CTRUNC', 8);
+define('MSG_TRUNC', 32);
+define('MSG_PEEK', 2);
+define('MSG_DONTROUTE', 4);
/**
* Not available on Windows platforms.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('MSG_EOR', 128);
+define('MSG_EOR', 128);
/**
* Not available on Windows platforms.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('MSG_EOF', 512);
-define ('MSG_CONFIRM', 2048);
-define ('MSG_ERRQUEUE', 8192);
-define ('MSG_NOSIGNAL', 16384);
-define ('MSG_DONTWAIT', 64);
-define ('MSG_MORE', 32768);
-define ('MSG_WAITFORONE', 65536);
-define ('MSG_CMSG_CLOEXEC', 1073741824);
-define ('SO_DEBUG', 1);
-define ('SO_REUSEADDR', 2);
+define('MSG_EOF', 512);
+define('MSG_CONFIRM', 2048);
+define('MSG_ERRQUEUE', 8192);
+define('MSG_NOSIGNAL', 16384);
+define('MSG_DONTWAIT', 64);
+define('MSG_MORE', 32768);
+define('MSG_WAITFORONE', 65536);
+define('MSG_CMSG_CLOEXEC', 1073741824);
+define('SO_DEBUG', 1);
+define('SO_REUSEADDR', 2);
/**
* This constant is only available in PHP 5.4.10 or later on platforms that
@@ -1419,32 +1418,32 @@ function socket_wsaprotocol_info_release($info_id) {}
* includes Mac OS X and FreeBSD, but does not include Linux or Windows.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SO_REUSEPORT', 15);
-define ('SO_KEEPALIVE', 9);
-define ('SO_DONTROUTE', 5);
-define ('SO_LINGER', 13);
-define ('SO_BROADCAST', 6);
-define ('SO_OOBINLINE', 10);
-define ('SO_SNDBUF', 7);
-define ('SO_RCVBUF', 8);
-define ('SO_SNDLOWAT', 19);
-define ('SO_RCVLOWAT', 18);
-define ('SO_SNDTIMEO', 21);
-define ('SO_RCVTIMEO', 20);
-define ('SO_TYPE', 3);
-define ('SO_ERROR', 4);
-define ('SO_BINDTODEVICE', 25);
-define ('SOL_SOCKET', 1);
-define ('SOMAXCONN', 128);
+define('SO_REUSEPORT', 15);
+define('SO_KEEPALIVE', 9);
+define('SO_DONTROUTE', 5);
+define('SO_LINGER', 13);
+define('SO_BROADCAST', 6);
+define('SO_OOBINLINE', 10);
+define('SO_SNDBUF', 7);
+define('SO_RCVBUF', 8);
+define('SO_SNDLOWAT', 19);
+define('SO_RCVLOWAT', 18);
+define('SO_SNDTIMEO', 21);
+define('SO_RCVTIMEO', 20);
+define('SO_TYPE', 3);
+define('SO_ERROR', 4);
+define('SO_BINDTODEVICE', 25);
+define('SOL_SOCKET', 1);
+define('SOMAXCONN', 128);
/**
* Used to disable Nagle TCP algorithm.
* Added in PHP 5.2.7.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('TCP_NODELAY', 1);
-define ('PHP_NORMAL_READ', 1);
-define ('PHP_BINARY_READ', 2);
+define('TCP_NODELAY', 1);
+define('PHP_NORMAL_READ', 1);
+define('PHP_BINARY_READ', 2);
/**
* Joins a multicast group.
* @since 5.4
@@ -1528,656 +1527,658 @@ function socket_wsaprotocol_info_release($info_id) {}
* @link https://php.net/manual/en/function.socket-get-option.php
*/
define('IPV6_MULTICAST_LOOP', 19);
-define ('IPV6_V6ONLY', 26);
+define('IPV6_V6ONLY', 26);
/**
* Operation not permitted.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EPERM', 1);
+define('SOCKET_EPERM', 1);
/**
* No such file or directory.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_ENOENT', 2);
+define('SOCKET_ENOENT', 2);
/**
* Interrupted system call.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EINTR', 4);
+define('SOCKET_EINTR', 4);
/**
* I/O error.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EIO', 5);
+define('SOCKET_EIO', 5);
/**
* No such device or address.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_ENXIO', 6);
+define('SOCKET_ENXIO', 6);
/**
* Arg list too long.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_E2BIG', 7);
+define('SOCKET_E2BIG', 7);
/**
* Bad file number.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EBADF', 9);
+define('SOCKET_EBADF', 9);
/**
* Try again.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EAGAIN', 11);
+define('SOCKET_EAGAIN', 11);
/**
* Out of memory.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_ENOMEM', 12);
+define('SOCKET_ENOMEM', 12);
/**
* Permission denied.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EACCES', 13);
+define('SOCKET_EACCES', 13);
/**
* Bad address.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EFAULT', 14);
+define('SOCKET_EFAULT', 14);
/**
* Block device required.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_ENOTBLK', 15);
+define('SOCKET_ENOTBLK', 15);
/**
* Device or resource busy.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EBUSY', 16);
+define('SOCKET_EBUSY', 16);
/**
* File exists.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EEXIST', 17);
+define('SOCKET_EEXIST', 17);
/**
* Cross-device link.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EXDEV', 18);
+define('SOCKET_EXDEV', 18);
/**
* No such device.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_ENODEV', 19);
+define('SOCKET_ENODEV', 19);
/**
* Not a directory.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_ENOTDIR', 20);
+define('SOCKET_ENOTDIR', 20);
/**
* Is a directory.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EISDIR', 21);
+define('SOCKET_EISDIR', 21);
/**
* Invalid argument.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EINVAL', 22);
+define('SOCKET_EINVAL', 22);
/**
* File table overflow.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_ENFILE', 23);
+define('SOCKET_ENFILE', 23);
/**
* Too many open files.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EMFILE', 24);
+define('SOCKET_EMFILE', 24);
/**
* Not a typewriter.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_ENOTTY', 25);
+define('SOCKET_ENOTTY', 25);
/**
* No space left on device.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_ENOSPC', 28);
+define('SOCKET_ENOSPC', 28);
/**
* Illegal seek.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_ESPIPE', 29);
+define('SOCKET_ESPIPE', 29);
/**
* Read-only file system.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EROFS', 30);
+define('SOCKET_EROFS', 30);
/**
* Too many links.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EMLINK', 31);
+define('SOCKET_EMLINK', 31);
/**
* Broken pipe.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EPIPE', 32);
+define('SOCKET_EPIPE', 32);
/**
* File name too long.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_ENAMETOOLONG', 36);
+define('SOCKET_ENAMETOOLONG', 36);
/**
* No record locks available.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_ENOLCK', 37);
+define('SOCKET_ENOLCK', 37);
/**
* Function not implemented.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_ENOSYS', 38);
+define('SOCKET_ENOSYS', 38);
/**
* Directory not empty.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_ENOTEMPTY', 39);
+define('SOCKET_ENOTEMPTY', 39);
/**
* Too many symbolic links encountered.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_ELOOP', 40);
+define('SOCKET_ELOOP', 40);
/**
* Operation would block.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EWOULDBLOCK', 11);
+define('SOCKET_EWOULDBLOCK', 11);
/**
* No message of desired type.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_ENOMSG', 42);
+define('SOCKET_ENOMSG', 42);
/**
* Identifier removed.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EIDRM', 43);
+define('SOCKET_EIDRM', 43);
/**
* Channel number out of range.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_ECHRNG', 44);
+define('SOCKET_ECHRNG', 44);
/**
* Level 2 not synchronized.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EL2NSYNC', 45);
+define('SOCKET_EL2NSYNC', 45);
/**
* Level 3 halted.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EL3HLT', 46);
+define('SOCKET_EL3HLT', 46);
/**
* Level 3 reset.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EL3RST', 47);
+define('SOCKET_EL3RST', 47);
/**
* Link number out of range.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_ELNRNG', 48);
+define('SOCKET_ELNRNG', 48);
/**
* Protocol driver not attached.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EUNATCH', 49);
+define('SOCKET_EUNATCH', 49);
/**
* No CSI structure available.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_ENOCSI', 50);
+define('SOCKET_ENOCSI', 50);
/**
* Level 2 halted.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EL2HLT', 51);
+define('SOCKET_EL2HLT', 51);
/**
* Invalid exchange.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EBADE', 52);
+define('SOCKET_EBADE', 52);
/**
* Invalid request descriptor.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EBADR', 53);
+define('SOCKET_EBADR', 53);
/**
* Exchange full.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EXFULL', 54);
+define('SOCKET_EXFULL', 54);
/**
* No anode.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_ENOANO', 55);
+define('SOCKET_ENOANO', 55);
/**
* Invalid request code.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EBADRQC', 56);
+define('SOCKET_EBADRQC', 56);
/**
* Invalid slot.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EBADSLT', 57);
+define('SOCKET_EBADSLT', 57);
/**
* Device not a stream.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_ENOSTR', 60);
+define('SOCKET_ENOSTR', 60);
/**
* No data available.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_ENODATA', 61);
+define('SOCKET_ENODATA', 61);
/**
* Timer expired.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_ETIME', 62);
+define('SOCKET_ETIME', 62);
/**
* Out of streams resources.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_ENOSR', 63);
+define('SOCKET_ENOSR', 63);
/**
* Machine is not on the network.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_ENONET', 64);
+define('SOCKET_ENONET', 64);
/**
* Object is remote.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EREMOTE', 66);
+define('SOCKET_EREMOTE', 66);
/**
* Link has been severed.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_ENOLINK', 67);
+define('SOCKET_ENOLINK', 67);
/**
* Advertise error.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EADV', 68);
+define('SOCKET_EADV', 68);
/**
* Srmount error.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_ESRMNT', 69);
+define('SOCKET_ESRMNT', 69);
/**
* Communication error on send.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_ECOMM', 70);
+define('SOCKET_ECOMM', 70);
/**
* Protocol error.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EPROTO', 71);
+define('SOCKET_EPROTO', 71);
/**
* Multihop attempted.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EMULTIHOP', 72);
+define('SOCKET_EMULTIHOP', 72);
/**
* Not a data message.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EBADMSG', 74);
+define('SOCKET_EBADMSG', 74);
/**
* Name not unique on network.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_ENOTUNIQ', 76);
+define('SOCKET_ENOTUNIQ', 76);
/**
* File descriptor in bad state.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EBADFD', 77);
+define('SOCKET_EBADFD', 77);
/**
* Remote address changed.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EREMCHG', 78);
+define('SOCKET_EREMCHG', 78);
/**
* Interrupted system call should be restarted.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_ERESTART', 85);
+define('SOCKET_ERESTART', 85);
/**
* Streams pipe error.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_ESTRPIPE', 86);
+define('SOCKET_ESTRPIPE', 86);
/**
* Too many users.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EUSERS', 87);
+define('SOCKET_EUSERS', 87);
/**
* Socket operation on non-socket.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_ENOTSOCK', 88);
+define('SOCKET_ENOTSOCK', 88);
/**
* Destination address required.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EDESTADDRREQ', 89);
+define('SOCKET_EDESTADDRREQ', 89);
/**
* Message too long.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EMSGSIZE', 90);
+define('SOCKET_EMSGSIZE', 90);
/**
* Protocol wrong type for socket.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EPROTOTYPE', 91);
-define ('SOCKET_ENOPROTOOPT', 92);
+define('SOCKET_EPROTOTYPE', 91);
+define('SOCKET_ENOPROTOOPT', 92);
/**
* Protocol not supported.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EPROTONOSUPPORT', 93);
+define('SOCKET_EPROTONOSUPPORT', 93);
/**
* Socket type not supported.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_ESOCKTNOSUPPORT', 94);
+define('SOCKET_ESOCKTNOSUPPORT', 94);
/**
* Operation not supported on transport endpoint.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EOPNOTSUPP', 95);
+define('SOCKET_EOPNOTSUPP', 95);
/**
* Protocol family not supported.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EPFNOSUPPORT', 96);
+define('SOCKET_EPFNOSUPPORT', 96);
/**
* Address family not supported by protocol.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EAFNOSUPPORT', 97);
-define ('SOCKET_EADDRINUSE', 98);
+define('SOCKET_EAFNOSUPPORT', 97);
+define('SOCKET_EADDRINUSE', 98);
/**
* Cannot assign requested address.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EADDRNOTAVAIL', 99);
+define('SOCKET_EADDRNOTAVAIL', 99);
/**
* Network is down.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_ENETDOWN', 100);
+define('SOCKET_ENETDOWN', 100);
/**
* Network is unreachable.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_ENETUNREACH', 101);
+define('SOCKET_ENETUNREACH', 101);
/**
* Network dropped connection because of reset.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_ENETRESET', 102);
+define('SOCKET_ENETRESET', 102);
/**
* Software caused connection abort.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_ECONNABORTED', 103);
+define('SOCKET_ECONNABORTED', 103);
/**
* Connection reset by peer.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_ECONNRESET', 104);
+define('SOCKET_ECONNRESET', 104);
/**
* No buffer space available.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_ENOBUFS', 105);
+define('SOCKET_ENOBUFS', 105);
/**
* Transport endpoint is already connected.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EISCONN', 106);
+define('SOCKET_EISCONN', 106);
/**
* Transport endpoint is not connected.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_ENOTCONN', 107);
+define('SOCKET_ENOTCONN', 107);
/**
* Cannot send after transport endpoint shutdown.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_ESHUTDOWN', 108);
+define('SOCKET_ESHUTDOWN', 108);
/**
* Too many references: cannot splice.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_ETOOMANYREFS', 109);
+define('SOCKET_ETOOMANYREFS', 109);
/**
* Connection timed out.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_ETIMEDOUT', 110);
+define('SOCKET_ETIMEDOUT', 110);
/**
* Connection refused.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_ECONNREFUSED', 111);
+define('SOCKET_ECONNREFUSED', 111);
/**
* Host is down.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EHOSTDOWN', 112);
+define('SOCKET_EHOSTDOWN', 112);
/**
* No route to host.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EHOSTUNREACH', 113);
+define('SOCKET_EHOSTUNREACH', 113);
/**
* Operation already in progress.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EALREADY', 114);
+define('SOCKET_EALREADY', 114);
/**
* Operation now in progress.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EINPROGRESS', 115);
+define('SOCKET_EINPROGRESS', 115);
/**
* Is a named type file.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EISNAM', 120);
+define('SOCKET_EISNAM', 120);
/**
* Remote I/O error.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EREMOTEIO', 121);
+define('SOCKET_EREMOTEIO', 121);
/**
* Quota exceeded.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EDQUOT', 122);
+define('SOCKET_EDQUOT', 122);
/**
* No medium found.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_ENOMEDIUM', 123);
+define('SOCKET_ENOMEDIUM', 123);
/**
* Wrong medium type.
* @link https://php.net/manual/en/sockets.constants.php
*/
-define ('SOCKET_EMEDIUMTYPE', 124);
-define ('IPPROTO_IP', 0);
-define ('IPPROTO_IPV6', 41);
-define ('SOL_TCP', 6);
-define ('SOL_UDP', 17);
-define ('IPV6_UNICAST_HOPS', 16);
-define ('IPV6_RECVPKTINFO', 49);
-define ('IPV6_PKTINFO', 50);
-define ('IPV6_RECVHOPLIMIT', 51);
-define ('IPV6_HOPLIMIT', 52);
-define ('IPV6_RECVTCLASS', 66);
-define ('IPV6_TCLASS', 67);
-define ('SCM_RIGHTS', 1);
-define ('SCM_CREDENTIALS', 2);
-define ('SO_PASSCRED', 16);
-
-define ('SOCKET_EPROCLIM', 10067);
-define ('SOCKET_ESTALE', 10070);
-define ('SOCKET_EDISCON', 10101);
-define ('SOCKET_SYSNOTREADY', 10091);
-define ('SOCKET_VERNOTSUPPORTED', 10092);
-define ('SOCKET_NOTINITIALISED', 10093);
-define ('SOCKET_HOST_NOT_FOUND', 11001);
-define ('SOCKET_TRY_AGAIN', 11002);
-define ('SOCKET_NO_RECOVERY', 11003);
-define ('SOCKET_NO_DATA', 11004);
-define ('SOCKET_NO_ADDRESS', 11004);
-
-define ('AI_PASSIVE', 1);
-define ('AI_CANONNAME', 2);
-define ('AI_NUMERICHOST', 4);
-define ('AI_ADDRCONFIG', 32);
-define ('AI_NUMERICSERV', 1024);
-define ('AI_V4MAPPED', 8);
-define ('AI_ALL', 16);
+define('SOCKET_EMEDIUMTYPE', 124);
+define('IPPROTO_IP', 0);
+define('IPPROTO_IPV6', 41);
+define('SOL_TCP', 6);
+define('SOL_UDP', 17);
+define('IPV6_UNICAST_HOPS', 16);
+define('IPV6_RECVPKTINFO', 49);
+define('IPV6_PKTINFO', 50);
+define('IPV6_RECVHOPLIMIT', 51);
+define('IPV6_HOPLIMIT', 52);
+define('IPV6_RECVTCLASS', 66);
+define('IPV6_TCLASS', 67);
+define('SCM_RIGHTS', 1);
+define('SCM_CREDENTIALS', 2);
+define('SO_PASSCRED', 16);
+
+define('SOCKET_EPROCLIM', 10067);
+define('SOCKET_ESTALE', 10070);
+define('SOCKET_EDISCON', 10101);
+define('SOCKET_SYSNOTREADY', 10091);
+define('SOCKET_VERNOTSUPPORTED', 10092);
+define('SOCKET_NOTINITIALISED', 10093);
+define('SOCKET_HOST_NOT_FOUND', 11001);
+define('SOCKET_TRY_AGAIN', 11002);
+define('SOCKET_NO_RECOVERY', 11003);
+define('SOCKET_NO_DATA', 11004);
+define('SOCKET_NO_ADDRESS', 11004);
+
+define('AI_PASSIVE', 1);
+define('AI_CANONNAME', 2);
+define('AI_NUMERICHOST', 4);
+define('AI_ADDRCONFIG', 32);
+define('AI_NUMERICSERV', 1024);
+define('AI_V4MAPPED', 8);
+define('AI_ALL', 16);
/**
* @since 8.0
*/
-final class Socket {
+final class Socket
+{
/**
* Cannot directly construct Socket, use socket_create() instead
* @see socket_create()
*/
- private function __construct(){}
+ private function __construct() {}
}
/**
* @since 8.0
*/
-final class AddressInfo {
+final class AddressInfo
+{
/**
* Cannot directly construct AddressInfo, use socket_addrinfo_lookup() instead
* @see socket_addrinfo_lookup()
*/
- private function __construct(){}
+ private function __construct() {}
}
diff --git a/sodium/sodium.php b/sodium/sodium.php
index 215545245..e73cb52a5 100644
--- a/sodium/sodium.php
+++ b/sodium/sodium.php
@@ -73,7 +73,7 @@
const SODIUM_CRYPTO_PWHASH_MEMLIMIT_MODERATE = 268435456;
const SODIUM_CRYPTO_PWHASH_OPSLIMIT_SENSITIVE = 4;
const SODIUM_CRYPTO_PWHASH_MEMLIMIT_SENSITIVE = 1073741824;
-const SODIUM_LIBRARY_VERSION="1.0.18";
+const SODIUM_LIBRARY_VERSION = "1.0.18";
const SODIUM_LIBRARY_MAJOR_VERSION = 10;
const SODIUM_LIBRARY_MINOR_VERSION = 3;
const SODIUM_CRYPTO_KDF_BYTES_MIN = 16;
@@ -216,7 +216,7 @@ function sodium_crypto_auth_keygen(): string {}
* @throws SodiumException
* @since 7.2
*/
-function sodium_crypto_kx_keypair (): string {}
+function sodium_crypto_kx_keypair(): string {}
/**
* @link https://php.net/manual/en/function.sodium-crypto-kx-publickey.php
@@ -226,7 +226,7 @@ function sodium_crypto_kx_keypair (): string {}
* @throws SodiumException
* @since 7.2
*/
-function sodium_crypto_kx_publickey (string $key_pair): string {}
+function sodium_crypto_kx_publickey(string $key_pair): string {}
/**
* @link https://php.net/manual/en/function.sodium-crypto-kx-secretkey.php
@@ -235,7 +235,7 @@ function sodium_crypto_kx_publickey (string $key_pair): string {}
* @throws SodiumException
* @since 7.2
*/
-function sodium_crypto_kx_secretkey (string $key_pair): string {}
+function sodium_crypto_kx_secretkey(string $key_pair): string {}
/**
* @link https://php.net/manual/en/function.sodium-crypto-kx-seed-keypair.php
@@ -245,7 +245,7 @@ function sodium_crypto_kx_secretkey (string $key_pair): string {}
* @throws SodiumException
* @since 7.2
*/
-function sodium_crypto_kx_seed_keypair (string $seed): string {}
+function sodium_crypto_kx_seed_keypair(string $seed): string {}
/**
* @link https://php.net/manual/en/function.sodium-crypto-kx-server-session-keys.php
@@ -256,7 +256,7 @@ function sodium_crypto_kx_seed_keypair (string $seed): string {}
* @throws SodiumException
* @since 7.2
*/
-function sodium_crypto_kx_server_session_keys (string $server_key_pair , string $client_key): array {}
+function sodium_crypto_kx_server_session_keys(string $server_key_pair, string $client_key): array {}
/**
* Get random bytes for key
@@ -266,7 +266,6 @@ function sodium_crypto_kx_server_session_keys (string $server_key_pair , string
*/
function sodium_crypto_generichash_keygen(): string {}
-
/**
* @link https://php.net/manual/en/function.sodium-crypto-kx-client-session-keys.php
* @param string $client_key_pair
@@ -275,7 +274,7 @@ function sodium_crypto_generichash_keygen(): string {}
* @throws SodiumException
* @since 7.2
*/
-function sodium_crypto_kx_client_session_keys (string $client_key_pair, string $server_key): array {}
+function sodium_crypto_kx_client_session_keys(string $client_key_pair, string $server_key): array {}
/**
* @link https://www.php.net/manual/en/function.sodium-crypto-kdf-derive-from-key.php
@@ -287,7 +286,7 @@ function sodium_crypto_kx_client_session_keys (string $client_key_pair, string $
* @throws SodiumException
* @since 7.2
*/
-function sodium_crypto_kdf_derive_from_key (int $subkey_length, int $subkey_id, string $context, string $key): string {}
+function sodium_crypto_kdf_derive_from_key(int $subkey_length, int $subkey_id, string $context, string $key): string {}
/**
* Get random bytes for key
@@ -322,7 +321,7 @@ function sodium_crypto_stream_keygen(): string {}
* @throws SodiumException
* @since 7.2
*/
-function sodium_pad (string $string, int $length): string {}
+function sodium_pad(string $string, int $length): string {}
/**
* Remove padding data
@@ -333,9 +332,7 @@ function sodium_pad (string $string, int $length): string {}
* @throws SodiumException
* @since 7.2
*/
-function sodium_unpad (string $string, int $block_size): string {}
-
-
+function sodium_unpad(string $string, int $block_size): string {}
/**
* Secret-key message verification
@@ -714,7 +711,6 @@ function sodium_crypto_sign_ed25519_sk_to_curve25519(string $secret_key): string
*/
function sodium_crypto_sign_keypair(): string {}
-
/**
* Create an Ed25519 keypair from an Ed25519 secret key + Ed25519 public key
* @link https://www.php.net/manual/en/function.sodium-crypto-sign-keypair-from-secretkey-and-publickey.php
@@ -1030,7 +1026,7 @@ function sodium_crypto_aead_xchacha20poly1305_ietf_encrypt(string $message, stri
* @since 7.2
* @see https://www.php.net/manual/en/function.sodium-crypto-aead-xchacha20poly1305-ietf-keygen.php
*/
-function sodium_crypto_aead_xchacha20poly1305_ietf_keygen():string {}
+function sodium_crypto_aead_xchacha20poly1305_ietf_keygen(): string {}
/**
* @param string $password
@@ -1096,7 +1092,7 @@ function sodium_crypto_secretstream_xchacha20poly1305_pull(string &$state, strin
* @since 7.2
* @see https://www.php.net/manual/en/function.sodium-crypto-secretstream-xchacha20poly1305-rekey.php
*/
-function sodium_crypto_secretstream_xchacha20poly1305_rekey(string &$state): void{}
+function sodium_crypto_secretstream_xchacha20poly1305_rekey(string &$state): void {}
/**
* @param string $string
@@ -1119,6 +1115,4 @@ function sodium_bin2base64(string $string, int $id): string {}
*/
function sodium_base642bin(string $string, int $id, string $ignore = ''): string {}
-class SodiumException extends Exception {
-
-}
+class SodiumException extends Exception {}
diff --git a/solr/Documents/SolrDocument.php b/solr/Documents/SolrDocument.php
index 9e6cccfd2..96c9a1ee2 100644
--- a/solr/Documents/SolrDocument.php
+++ b/solr/Documents/SolrDocument.php
@@ -12,395 +12,394 @@
* This class represents a Solr document retrieved from a query response.
* @link https://php.net/manual/en/class.solrinputdocument.php
*/
-final class SolrDocument implements ArrayAccess, Iterator, Serializable {
-
- /** @var int Sorts the fields in ascending order. */
- const SORT_DEFAULT = 1 ;
-
- /** @var int Sorts the fields in ascending order. */
- const SORT_ASC = 1 ;
-
- /** @var int Sorts the fields in descending order. */
- const SORT_DESC = 2 ;
-
- /** @var int Sorts the fields by name */
- const SORT_FIELD_NAME = 1 ;
-
- /** @var int Sorts the fields by number of values. */
- const SORT_FIELD_VALUE_COUNT = 2 ;
-
- /** @var int Sorts the fields by boost value. */
- const SORT_FIELD_BOOST_VALUE = 4 ;
-
- /**
- * (PECL solr >= 0.9.2)
- * Adds a field to the document
- * @link https://php.net/manual/en/solrdocument.addfield.php
- * @param string $fieldName
- * The name of the field
- *
- * @param string $fieldValue
- * The value for the field.
- *
- * @return bool
- * Returns TRUE on success or FALSE on failure.
- *
- */
- public function addField($fieldName, $fieldValue) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Drops all the fields in the document
- * @link https://php.net/manual/en/solrdocument.clear.php
- * @return bool
- * Returns TRUE on success or FALSE on failure.
- *
- */
- public function clear() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Creates a copy of a SolrDocument object
- * @link https://php.net/manual/en/solrdocument.clone.php
- */
- public function __clone() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * SolrDocument constructor.
- * @link https://php.net/manual/en/solrdocument.construct.php
- */
- public function __construct () {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Retrieves the current field
- * @link https://php.net/manual/en/solrdocument.current.php
- * @return SolrDocumentField
- * Returns the field
- *
- */
- public function current() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Removes a field from the document
- * @link https://php.net/manual/en/solrdocument.deletefield.php
- * @param string $fieldName
- * The name of the field.
- *
- * @return bool
- * Returns TRUE on success or FALSE on failure.
- *
- */
- public function deleteField($fieldName) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Destructor
- * @link https://php.net/manual/en/solrdocument.destruct.php
- */
- public function __destruct() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Checks if a field exists in the document
- * @link https://php.net/manual/en/solrdocument.fieldexists.php
- * @param string $fieldName
- * Name of the field.
- *
- * @return bool
- * Returns TRUE if the field is present and FALSE if it does not.
- *
- */
- public function fieldExists($fieldName) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Access the field as a property
- * @link https://php.net/manual/en/solrdocument.get.php
- * @param string $fieldName
- * The name of the field.
- *
- * @return SolrDocumentField
- * Returns a SolrDocumentField instance.
- *
- */
- public function __get($fieldName) {}
-
- /**
- * (PECL solr >= 2.3.0)
- * Returns an array of child documents (SolrInputDocument)
- * @link https://php.net/manual/en/solrdocument.getchilddocuments.php
- * @return SolrInputDocument[]
- */
- public function getChildDocuments() {}
-
- /**
- * (PECL solr >= 2.3.0)
- * Returns the number of child documents
- * @link https://php.net/manual/en/solrdocument.getchilddocumentscount.php
- * @return int
- */
- public function getChildDocumentsCount() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Retrieves a field by name
- * @link https://php.net/manual/en/solrdocument.getfield.php
- * @param string $fieldName
- * The name of the field.
- *
- * @return SolrDocumentField|false Returns a SolrDocumentField object on success and FALSE on failure
- */
- public function getField($fieldName) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the number of fields in this document
- * @link https://php.net/manual/en/solrdocument.getfieldcount.php
- * @return int|false
- * Returns an integer on success and FALSE on failure.
- *
- */
- public function getFieldCount() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns an array containing all the fields in the document
- * @link https://php.net/manual/en/solrdocument.getfieldnames.php
- * @return array|false
- * Returns an array on success and FALSE on failure.
- *
- */
- public function getFieldNames() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns a SolrInputDocument equivalent of the object
- * @link https://php.net/manual/en/solrdocument.getinputdocument.php
- * @return SolrInputDocument
- * Returns a SolrInputDocument on success and NULL on failure.
- *
- */
- public function getInputDocument() {}
-
- /**
- * (PECL solr >= 2.3.0)
- * Checks whether the document has any child documents
- * @link https://php.net/manual/en/solrdocument.haschilddocuments.php
- * @return bool
- * Returns TRUE if the document has any child documents
- *
- */
- public function hasChildDocuments() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Checks if a field exists
- * @link https://php.net/manual/en/solrdocument.isset.php
- * @param string $fieldName
- * Name of the field.
- *
- * @return bool
- * Returns TRUE on success or FALSE on failure.
- *
- */
- public function __isset($fieldName) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Retrieves the current key
- * @link https://php.net/manual/en/solrdocument.key.php
- * @return string
- * Returns the current key.
- *
- */
- public function key() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Merges one input document into another
- * @link https://php.net/manual/en/solrdocument.merge.php
- * @param SolrInputDocument $sourceDoc
- * The source document.
- *
- * @param bool $overwrite [optional]
- * If this is TRUE then fields with the same name in the destination document will be overwritten.
- *
- * @return bool
- * Returns TRUE on success or FALSE on failure.
- *
- */
- public function merge(SolrInputDocument $sourceDoc, $overwrite = true) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Moves the internal pointer to the next field
- * @link https://php.net/manual/en/solrdocument.next.php
- */
- public function next() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Checks if a particular field exists
- * @link https://php.net/manual/en/solrdocument.offsetexists.php
- * @param string $fieldName
- * The name of the field.
- *
- * @return bool
- * Returns TRUE on success or FALSE on failure.
- *
- */
- public function offsetExists($fieldName) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Retrieves a field
- * @link https://php.net/manual/en/solrdocument.offsetget.php
- * @param string $fieldName
- * The name of the field.
- *
- * @return SolrDocumentField
- * Returns a SolrDocumentField object.
- *
- */
- public function offsetGet($fieldName) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Adds a field to the document
- * @link https://php.net/manual/en/solrdocument.offsetset.php
- * @param string $fieldName
- * The name of the field.
- *
- * @param string $fieldValue
- * The value for this field.
- *
+final class SolrDocument implements ArrayAccess, Iterator, Serializable
+{
+ /** @var int Sorts the fields in ascending order. */
+ public const SORT_DEFAULT = 1;
+
+ /** @var int Sorts the fields in ascending order. */
+ public const SORT_ASC = 1;
+
+ /** @var int Sorts the fields in descending order. */
+ public const SORT_DESC = 2;
+
+ /** @var int Sorts the fields by name */
+ public const SORT_FIELD_NAME = 1;
+
+ /** @var int Sorts the fields by number of values. */
+ public const SORT_FIELD_VALUE_COUNT = 2;
+
+ /** @var int Sorts the fields by boost value. */
+ public const SORT_FIELD_BOOST_VALUE = 4;
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Adds a field to the document
+ * @link https://php.net/manual/en/solrdocument.addfield.php
+ * @param string $fieldName
+ * The name of the field
+ *
+ * @param string $fieldValue
+ * The value for the field.
+ *
+ * @return bool
+ * Returns TRUE on success or FALSE on failure.
+ *
+ */
+ public function addField($fieldName, $fieldValue) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Drops all the fields in the document
+ * @link https://php.net/manual/en/solrdocument.clear.php
+ * @return bool
+ * Returns TRUE on success or FALSE on failure.
+ *
+ */
+ public function clear() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Creates a copy of a SolrDocument object
+ * @link https://php.net/manual/en/solrdocument.clone.php
+ */
+ public function __clone() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * SolrDocument constructor.
+ * @link https://php.net/manual/en/solrdocument.construct.php
+ */
+ public function __construct() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Retrieves the current field
+ * @link https://php.net/manual/en/solrdocument.current.php
+ * @return SolrDocumentField
+ * Returns the field
+ *
+ */
+ public function current() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Removes a field from the document
+ * @link https://php.net/manual/en/solrdocument.deletefield.php
+ * @param string $fieldName
+ * The name of the field.
+ *
+ * @return bool
+ * Returns TRUE on success or FALSE on failure.
+ *
+ */
+ public function deleteField($fieldName) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Destructor
+ * @link https://php.net/manual/en/solrdocument.destruct.php
+ */
+ public function __destruct() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Checks if a field exists in the document
+ * @link https://php.net/manual/en/solrdocument.fieldexists.php
+ * @param string $fieldName
+ * Name of the field.
+ *
+ * @return bool
+ * Returns TRUE if the field is present and FALSE if it does not.
+ *
+ */
+ public function fieldExists($fieldName) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Access the field as a property
+ * @link https://php.net/manual/en/solrdocument.get.php
+ * @param string $fieldName
+ * The name of the field.
+ *
+ * @return SolrDocumentField
+ * Returns a SolrDocumentField instance.
+ *
+ */
+ public function __get($fieldName) {}
+
+ /**
+ * (PECL solr >= 2.3.0)
+ * Returns an array of child documents (SolrInputDocument)
+ * @link https://php.net/manual/en/solrdocument.getchilddocuments.php
+ * @return SolrInputDocument[]
+ */
+ public function getChildDocuments() {}
+
+ /**
+ * (PECL solr >= 2.3.0)
+ * Returns the number of child documents
+ * @link https://php.net/manual/en/solrdocument.getchilddocumentscount.php
+ * @return int
+ */
+ public function getChildDocumentsCount() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Retrieves a field by name
+ * @link https://php.net/manual/en/solrdocument.getfield.php
+ * @param string $fieldName
+ * The name of the field.
+ *
+ * @return SolrDocumentField|false Returns a SolrDocumentField object on success and FALSE on failure
+ */
+ public function getField($fieldName) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the number of fields in this document
+ * @link https://php.net/manual/en/solrdocument.getfieldcount.php
+ * @return int|false
+ * Returns an integer on success and FALSE on failure.
+ *
+ */
+ public function getFieldCount() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns an array containing all the fields in the document
+ * @link https://php.net/manual/en/solrdocument.getfieldnames.php
+ * @return array|false
+ * Returns an array on success and FALSE on failure.
+ *
+ */
+ public function getFieldNames() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns a SolrInputDocument equivalent of the object
+ * @link https://php.net/manual/en/solrdocument.getinputdocument.php
+ * @return SolrInputDocument
+ * Returns a SolrInputDocument on success and NULL on failure.
+ *
+ */
+ public function getInputDocument() {}
+
+ /**
+ * (PECL solr >= 2.3.0)
+ * Checks whether the document has any child documents
+ * @link https://php.net/manual/en/solrdocument.haschilddocuments.php
+ * @return bool
+ * Returns TRUE if the document has any child documents
+ *
+ */
+ public function hasChildDocuments() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Checks if a field exists
+ * @link https://php.net/manual/en/solrdocument.isset.php
+ * @param string $fieldName
+ * Name of the field.
+ *
+ * @return bool
+ * Returns TRUE on success or FALSE on failure.
+ *
+ */
+ public function __isset($fieldName) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Retrieves the current key
+ * @link https://php.net/manual/en/solrdocument.key.php
+ * @return string
+ * Returns the current key.
+ *
+ */
+ public function key() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Merges one input document into another
+ * @link https://php.net/manual/en/solrdocument.merge.php
+ * @param SolrInputDocument $sourceDoc
+ * The source document.
+ *
+ * @param bool $overwrite [optional]
+ * If this is TRUE then fields with the same name in the destination document will be overwritten.
+ *
+ * @return bool
+ * Returns TRUE on success or FALSE on failure.
+ *
+ */
+ public function merge(SolrInputDocument $sourceDoc, $overwrite = true) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Moves the internal pointer to the next field
+ * @link https://php.net/manual/en/solrdocument.next.php
+ */
+ public function next() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Checks if a particular field exists
+ * @link https://php.net/manual/en/solrdocument.offsetexists.php
+ * @param string $fieldName
+ * The name of the field.
+ *
+ * @return bool
+ * Returns TRUE on success or FALSE on failure.
+ *
+ */
+ public function offsetExists($fieldName) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Retrieves a field
+ * @link https://php.net/manual/en/solrdocument.offsetget.php
+ * @param string $fieldName
+ * The name of the field.
+ *
+ * @return SolrDocumentField
+ * Returns a SolrDocumentField object.
+ *
+ */
+ public function offsetGet($fieldName) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Adds a field to the document
+ * @link https://php.net/manual/en/solrdocument.offsetset.php
+ * @param string $fieldName
+ * The name of the field.
+ *
+ * @param string $fieldValue
+ * The value for this field.
+ *
* @return bool
- */
- public function offsetSet($fieldName , $fieldValue) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Removes a field
- * @link https://php.net/manual/en/solrdocument.offsetunset.php
- * @param string $fieldName
- * The name of the field.
- *
- */
- public function offsetUnset($fieldName) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * This is an alias of SolrDocument::clear
- * @link https://php.net/manual/en/solrdocument.reset.php
- * @return bool
- * Returns TRUE on success or FALSE on failure.
- *
- */
- public function reset() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Resets the internal pointer to the beginning
- * @link https://php.net/manual/en/solrdocument.rewind.php
- */
- public function rewind() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Used for custom serialization
- * @link https://php.net/manual/en/solrdocument.serialize.php
- * @return string
- * Returns a string representing the serialized Solr document.
- *
- */
- public function serialize() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Adds another field to the document
- * @link https://php.net/manual/en/solrdocument.set.php
- * @param string $fieldName
- * Name of the field.
- *
- * @param string $fieldValue
- * Field value.
- *
- * @return bool
- * Returns TRUE on success or FALSE on failure.
- *
- */
- public function __set($fieldName, $fieldValue) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Sorts the fields within the document
- * @link https://php.net/manual/en/solrdocument.sort.php
- * @param int $sortOrderBy
- * The sort criteria, must be one of :
- *
- * - SolrDocument::SORT_FIELD_NAME
- * - SolrDocument::SORT_FIELD_BOOST_VALUE
- * - SolrDocument::SORT_FIELD_VALUE_COUNT
- *
- *
- * @param int $sortDirection [optional]
- * The sort direction, can be one of :
- *
- * - SolrDocument::SORT_DEFAULT
- * - SolrDocument::SORT_ASC
- * - SolrDocument::SORT_DESC
- *
- *
- * @return bool
- * Returns TRUE on success or FALSE on failure.
- *
- */
- public function sort($sortOrderBy, $sortDirection = SolrInputDocument::SORT_ASC) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns an array representation of the document
- * @link https://secure.php.net/manual/en/solrdocument.toarray.php
- * @return array
- * Returns an array representation of the document.
- *
- */
- public function toArray() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Custom serialization of SolrDocument objects
- * @link https://php.net/manual/en/solrdocument.unserialize.php
- * @param string $serialized
- * An XML representation of the document.
- *
- */
- public function unserialize($serialized) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Removes a field from the document
- * @link https://php.net/manual/en/solrdocument.unset.php
- * @param string $fieldName
- * The name of the field.
- *
- * @return bool
- * Returns TRUE on success or FALSE on failure.
- *
- */
- public function __unset($fieldName) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Checks if the current position internally is still valid
- * @link https://php.net/manual/en/solrdocument.valid.php
- * @return bool
- * Returns TRUE on success or FALSE on failure.
- *
- */
- public function valid() {}
-
+ */
+ public function offsetSet($fieldName, $fieldValue) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Removes a field
+ * @link https://php.net/manual/en/solrdocument.offsetunset.php
+ * @param string $fieldName
+ * The name of the field.
+ *
+ */
+ public function offsetUnset($fieldName) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * This is an alias of SolrDocument::clear
+ * @link https://php.net/manual/en/solrdocument.reset.php
+ * @return bool
+ * Returns TRUE on success or FALSE on failure.
+ *
+ */
+ public function reset() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Resets the internal pointer to the beginning
+ * @link https://php.net/manual/en/solrdocument.rewind.php
+ */
+ public function rewind() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Used for custom serialization
+ * @link https://php.net/manual/en/solrdocument.serialize.php
+ * @return string
+ * Returns a string representing the serialized Solr document.
+ *
+ */
+ public function serialize() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Adds another field to the document
+ * @link https://php.net/manual/en/solrdocument.set.php
+ * @param string $fieldName
+ * Name of the field.
+ *
+ * @param string $fieldValue
+ * Field value.
+ *
+ * @return bool
+ * Returns TRUE on success or FALSE on failure.
+ *
+ */
+ public function __set($fieldName, $fieldValue) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Sorts the fields within the document
+ * @link https://php.net/manual/en/solrdocument.sort.php
+ * @param int $sortOrderBy
+ * The sort criteria, must be one of :
+ *
+ * - SolrDocument::SORT_FIELD_NAME
+ * - SolrDocument::SORT_FIELD_BOOST_VALUE
+ * - SolrDocument::SORT_FIELD_VALUE_COUNT
+ *
+ *
+ * @param int $sortDirection [optional]
+ * The sort direction, can be one of :
+ *
+ * - SolrDocument::SORT_DEFAULT
+ * - SolrDocument::SORT_ASC
+ * - SolrDocument::SORT_DESC
+ *
+ *
+ * @return bool
+ * Returns TRUE on success or FALSE on failure.
+ *
+ */
+ public function sort($sortOrderBy, $sortDirection = SolrInputDocument::SORT_ASC) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns an array representation of the document
+ * @link https://secure.php.net/manual/en/solrdocument.toarray.php
+ * @return array
+ * Returns an array representation of the document.
+ *
+ */
+ public function toArray() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Custom serialization of SolrDocument objects
+ * @link https://php.net/manual/en/solrdocument.unserialize.php
+ * @param string $serialized
+ * An XML representation of the document.
+ *
+ */
+ public function unserialize($serialized) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Removes a field from the document
+ * @link https://php.net/manual/en/solrdocument.unset.php
+ * @param string $fieldName
+ * The name of the field.
+ *
+ * @return bool
+ * Returns TRUE on success or FALSE on failure.
+ *
+ */
+ public function __unset($fieldName) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Checks if the current position internally is still valid
+ * @link https://php.net/manual/en/solrdocument.valid.php
+ * @return bool
+ * Returns TRUE on success or FALSE on failure.
+ *
+ */
+ public function valid() {}
}
diff --git a/solr/Documents/SolrDocumentField.php b/solr/Documents/SolrDocumentField.php
index c12ce5e7d..79cfd146f 100644
--- a/solr/Documents/SolrDocumentField.php
+++ b/solr/Documents/SolrDocumentField.php
@@ -12,29 +12,28 @@
* This class represents a field in a Solr document. All its properties are read-only.
* @link https://php.net/manual/en/class.solrdocumentfield.php
*/
-final class SolrDocumentField {
+final class SolrDocumentField
+{
+ /** @var string [readonly] The name of the field. */
+ public $name;
- /** @var string [readonly] The name of the field. */
- public $name;
+ /** @var string [readonly] The boost value for the field */
+ public $boost;
- /** @var string [readonly] The boost value for the field */
- public $boost;
+ /** @var string [readonly] An array of values for this field */
+ public $values;
- /** @var string [readonly] An array of values for this field */
- public $values;
-
- /**
- * (PECL solr >= 0.9.2)
- * SolrDocument constructor.
- * @link https://php.net/manual/en/solrdocumentfield.construct.php
- */
- public function __construct () {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Destructor
- * @link https://php.net/manual/en/solrdocumentfield.destruct.php
- */
- public function __destruct() {}
+ /**
+ * (PECL solr >= 0.9.2)
+ * SolrDocument constructor.
+ * @link https://php.net/manual/en/solrdocumentfield.construct.php
+ */
+ public function __construct() {}
+ /**
+ * (PECL solr >= 0.9.2)
+ * Destructor
+ * @link https://php.net/manual/en/solrdocumentfield.destruct.php
+ */
+ public function __destruct() {}
}
diff --git a/solr/Documents/SolrInputDocument.php b/solr/Documents/SolrInputDocument.php
index b968ea426..3be945308 100644
--- a/solr/Documents/SolrInputDocument.php
+++ b/solr/Documents/SolrInputDocument.php
@@ -12,294 +12,293 @@
* This class represents a Solr document that is about to be submitted to the Solr index.
* @link https://php.net/manual/en/class.solrinputdocument.php
*/
-final class SolrInputDocument {
+final class SolrInputDocument
+{
+ /** @var int Sorts the fields in ascending order. */
+ public const SORT_DEFAULT = 1;
- /** @var int Sorts the fields in ascending order. */
- const SORT_DEFAULT = 1 ;
+ /** @var int Sorts the fields in ascending order. */
+ public const SORT_ASC = 1;
- /** @var int Sorts the fields in ascending order. */
- const SORT_ASC = 1 ;
+ /** @var int Sorts the fields in descending order. */
+ public const SORT_DESC = 2;
- /** @var int Sorts the fields in descending order. */
- const SORT_DESC = 2 ;
+ /** @var int Sorts the fields by name */
+ public const SORT_FIELD_NAME = 1;
- /** @var int Sorts the fields by name */
- const SORT_FIELD_NAME = 1 ;
+ /** @var int Sorts the fields by number of values. */
+ public const SORT_FIELD_VALUE_COUNT = 2;
- /** @var int Sorts the fields by number of values. */
- const SORT_FIELD_VALUE_COUNT = 2 ;
+ /** @var int Sorts the fields by boost value. */
+ public const SORT_FIELD_BOOST_VALUE = 4;
- /** @var int Sorts the fields by boost value. */
- const SORT_FIELD_BOOST_VALUE = 4 ;
+ /**
+ * (PECL solr >= 2.3.0)
+ * Adds a child document for block indexing
+ * @link https://php.net/manual/en/solrinputdocument.addchilddocument.php
+ * @param SolrInputDocument $child
+ * A SolrInputDocument object.
+ *
+ * @throws SolrIllegalArgumentException
+ * @throws SolrException
+ */
+ public function addChildDocument(SolrInputDocument $child) {}
- /**
- * (PECL solr >= 2.3.0)
- * Adds a child document for block indexing
- * @link https://php.net/manual/en/solrinputdocument.addchilddocument.php
- * @param SolrInputDocument $child
- * A SolrInputDocument object.
- *
- * @throws SolrIllegalArgumentException
- * @throws SolrException
- */
- public function addChildDocument(SolrInputDocument $child) {}
+ /**
+ * (PECL solr >= 2.3.0)
+ * Adds an array of child documents
+ * @link https://php.net/manual/en/solrinputdocument.addchilddocuments.php
+ * @param array &$docs
+ * An array of SolrInputDocument objects.
+ *
+ * @throws SolrIllegalArgumentException
+ * @throws SolrException
+ */
+ public function addChildDocuments(array &$docs) {}
- /**
- * (PECL solr >= 2.3.0)
- * Adds an array of child documents
- * @link https://php.net/manual/en/solrinputdocument.addchilddocuments.php
- * @param array &$docs
- * An array of SolrInputDocument objects.
- *
- * @throws SolrIllegalArgumentException
- * @throws SolrException
- */
- public function addChildDocuments(array &$docs) {}
+ /**
+ * (PECL solr >= 0.9.2)
+ * Adds a field to the document
+ * @link https://php.net/manual/en/solrinputdocument.addfield.php
+ * @param string $fieldName
+ * The name of the field
+ *
+ * @param string $fieldValue
+ * The value for the field.
+ *
+ * @param float $fieldBoostValue [optional]
+ * The index time boost for the field. Though this cannot be negative, you can still pass values less than 1.0 but
+ * they must be greater than zero.
+ *
+ * @return bool
+ * Returns TRUE on success or FALSE on failure.
+ *
+ */
+ public function addField($fieldName, $fieldValue, $fieldBoostValue = 0.0) {}
- /**
- * (PECL solr >= 0.9.2)
- * Adds a field to the document
- * @link https://php.net/manual/en/solrinputdocument.addfield.php
- * @param string $fieldName
- * The name of the field
- *
- * @param string $fieldValue
- * The value for the field.
- *
- * @param float $fieldBoostValue [optional]
- * The index time boost for the field. Though this cannot be negative, you can still pass values less than 1.0 but
- * they must be greater than zero.
- *
- * @return bool
- * Returns TRUE on success or FALSE on failure.
- *
- */
- public function addField($fieldName, $fieldValue, $fieldBoostValue = 0.0) {}
+ /**
+ * (PECL solr >= 0.9.2)
+ * Resets the input document
+ * @link https://php.net/manual/en/solrinputdocument.clear.php
+ * @return bool
+ * Returns TRUE on success or FALSE on failure.
+ *
+ */
+ public function clear() {}
- /**
- * (PECL solr >= 0.9.2)
- * Resets the input document
- * @link https://php.net/manual/en/solrinputdocument.clear.php
- * @return bool
- * Returns TRUE on success or FALSE on failure.
- *
- */
- public function clear() {}
+ /**
+ * (PECL solr >= 0.9.2)
+ * Creates a copy of a SolrDocument
+ * @link https://php.net/manual/en/solrinputdocument.clone.php
+ */
+ public function __clone() {}
- /**
- * (PECL solr >= 0.9.2)
- * Creates a copy of a SolrDocument
- * @link https://php.net/manual/en/solrinputdocument.clone.php
- */
- public function __clone() {}
+ /**
+ * (PECL solr >= 0.9.2)
+ * SolrInputDocument constructor.
+ * @link https://php.net/manual/en/solrinputdocument.construct.php
+ */
+ public function __construct() {}
- /**
- * (PECL solr >= 0.9.2)
- * SolrInputDocument constructor.
- * @link https://php.net/manual/en/solrinputdocument.construct.php
- */
- public function __construct () {}
+ /**
+ * (PECL solr >= 0.9.2)
+ * Removes a field from the document
+ * @link https://php.net/manual/en/solrinputdocument.construct.php
+ * @param string $fieldName
+ * The name of the field.
+ *
+ * @return bool
+ * Returns TRUE on success or FALSE on failure.
+ *
+ */
+ public function deleteField($fieldName) {}
- /**
- * (PECL solr >= 0.9.2)
- * Removes a field from the document
- * @link https://php.net/manual/en/solrinputdocument.construct.php
- * @param string $fieldName
- * The name of the field.
- *
- * @return bool
- * Returns TRUE on success or FALSE on failure.
- *
- */
- public function deleteField($fieldName) {}
+ /**
+ * (PECL solr >= 0.9.2)
+ * Destructor
+ * @link https://php.net/manual/en/solrinputdocument.destruct.php
+ */
+ public function __destruct() {}
- /**
- * (PECL solr >= 0.9.2)
- * Destructor
- * @link https://php.net/manual/en/solrinputdocument.destruct.php
- */
- public function __destruct() {}
+ /**
+ * (PECL solr >= 0.9.2)
+ * Checks if a field exists
+ * @link https://php.net/manual/en/solrinputdocument.fieldexists.php
+ * @param string $fieldName
+ * Name of the field.
+ *
+ * @return bool
+ * Returns TRUE if the field was found and FALSE if it was not found.
+ *
+ */
+ public function fieldExists($fieldName) {}
- /**
- * (PECL solr >= 0.9.2)
- * Checks if a field exists
- * @link https://php.net/manual/en/solrinputdocument.fieldexists.php
- * @param string $fieldName
- * Name of the field.
- *
- * @return bool
- * Returns TRUE if the field was found and FALSE if it was not found.
- *
- */
- public function fieldExists($fieldName) {}
+ /**
+ * (PECL solr >= 0.9.2)
+ * Retrieves the current boost value for the document
+ * @link https://php.net/manual/en/solrinputdocument.getboost.php
+ * @return float|false
+ * Returns the boost value on success and FALSE on failure.
+ *
+ */
+ public function getBoost() {}
- /**
- * (PECL solr >= 0.9.2)
- * Retrieves the current boost value for the document
- * @link https://php.net/manual/en/solrinputdocument.getboost.php
- * @return float|false
- * Returns the boost value on success and FALSE on failure.
- *
- */
- public function getBoost() {}
+ /**
+ * (PECL solr >= 2.3.0)
+ * Returns an array of child documents (SolrInputDocument)
+ * @link https://php.net/manual/en/solrinputdocument.getchilddocuments.php
+ * @return SolrInputDocument[]
+ */
+ public function getChildDocuments() {}
- /**
- * (PECL solr >= 2.3.0)
- * Returns an array of child documents (SolrInputDocument)
- * @link https://php.net/manual/en/solrinputdocument.getchilddocuments.php
- * @return SolrInputDocument[]
- */
- public function getChildDocuments() {}
+ /**
+ * (PECL solr >= 2.3.0)
+ * Returns the number of child documents
+ * @link https://php.net/manual/en/solrinputdocument.getchilddocumentscount.php
+ * @return int
+ */
+ public function getChildDocumentsCount() {}
- /**
- * (PECL solr >= 2.3.0)
- * Returns the number of child documents
- * @link https://php.net/manual/en/solrinputdocument.getchilddocumentscount.php
- * @return int
- */
- public function getChildDocumentsCount() {}
+ /**
+ * (PECL solr >= 0.9.2)
+ * Retrieves a field by name
+ * @link https://php.net/manual/en/solrinputdocument.getfield.php
+ * @param string $fieldName
+ * The name of the field.
+ *
+ * @return SolrDocumentField|false Returns a SolrDocumentField object on success and FALSE on failure.
+ */
+ public function getField($fieldName) {}
- /**
- * (PECL solr >= 0.9.2)
- * Retrieves a field by name
- * @link https://php.net/manual/en/solrinputdocument.getfield.php
- * @param string $fieldName
- * The name of the field.
- *
- * @return SolrDocumentField|false Returns a SolrDocumentField object on success and FALSE on failure.
- */
- public function getField($fieldName) {}
+ /**
+ * (PECL solr >= 0.9.2)
+ * Retrieves the boost value for a particular field
+ * @link https://php.net/manual/en/solrinputdocument.getfieldboost.php
+ * @param string $fieldName
+ * The name of the field.
+ *
+ * @return float|false
+ * Returns the boost value for the field or FALSE if there was an error.
+ *
+ */
+ public function getFieldBoost($fieldName) {}
- /**
- * (PECL solr >= 0.9.2)
- * Retrieves the boost value for a particular field
- * @link https://php.net/manual/en/solrinputdocument.getfieldboost.php
- * @param string $fieldName
- * The name of the field.
- *
- * @return float|false
- * Returns the boost value for the field or FALSE if there was an error.
- *
- */
- public function getFieldBoost($fieldName) {}
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the number of fields in the document
+ * @link https://php.net/manual/en/solrinputdocument.getfieldcount.php
+ * @return int|false
+ * Returns an integer on success or FALSE on failure.
+ *
+ */
+ public function getFieldCount() {}
- /**
- * (PECL solr >= 0.9.2)
- * Returns the number of fields in the document
- * @link https://php.net/manual/en/solrinputdocument.getfieldcount.php
- * @return int|false
- * Returns an integer on success or FALSE on failure.
- *
- */
- public function getFieldCount() {}
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns an array containing all the fields in the document
+ * @link https://php.net/manual/en/solrinputdocument.getfieldnames.php
+ * @return array|false
+ * Returns an array on success and FALSE on failure.
+ *
+ */
+ public function getFieldNames() {}
- /**
- * (PECL solr >= 0.9.2)
- * Returns an array containing all the fields in the document
- * @link https://php.net/manual/en/solrinputdocument.getfieldnames.php
- * @return array|false
- * Returns an array on success and FALSE on failure.
- *
- */
- public function getFieldNames() {}
+ /**
+ * (PECL solr >= 2.3.0)
+ * Checks whether the document has any child documents
+ * @link https://php.net/manual/en/solrinputdocument.haschilddocuments.php
+ * @return bool
+ * Returns TRUE if the document has any child documents
+ *
+ */
+ public function hasChildDocuments() {}
- /**
- * (PECL solr >= 2.3.0)
- * Checks whether the document has any child documents
- * @link https://php.net/manual/en/solrinputdocument.haschilddocuments.php
- * @return bool
- * Returns TRUE if the document has any child documents
- *
- */
- public function hasChildDocuments() {}
+ /**
+ * (PECL solr >= 0.9.2)
+ * Merges one input document into another
+ * @link https://php.net/manual/en/solrinputdocument.merge.php
+ * @param SolrInputDocument $sourceDoc
+ * The source document.
+ *
+ * @param bool $overwrite [optional]
+ * If this is TRUE it will replace matching fields in the destination document.
+ *
+ * @return bool
+ * Returns TRUE on success or FALSE on failure. In the future, this will be modified to return the
+ * number of fields in the new document.
+ *
+ */
+ public function merge(SolrInputDocument $sourceDoc, $overwrite = true) {}
- /**
- * (PECL solr >= 0.9.2)
- * Merges one input document into another
- * @link https://php.net/manual/en/solrinputdocument.merge.php
- * @param SolrInputDocument $sourceDoc
- * The source document.
- *
- * @param bool $overwrite [optional]
- * If this is TRUE it will replace matching fields in the destination document.
- *
- * @return bool
- * Returns TRUE on success or FALSE on failure. In the future, this will be modified to return the
- * number of fields in the new document.
- *
- */
- public function merge(SolrInputDocument $sourceDoc, $overwrite = true) {}
+ /**
+ * (PECL solr >= 0.9.2)
+ * This is an alias of SolrInputDocument::clear
+ * @link https://php.net/manual/en/solrinputdocument.reset.php
+ * @return bool
+ * Returns TRUE on success or FALSE on failure.
+ *
+ */
+ public function reset() {}
- /**
- * (PECL solr >= 0.9.2)
- * This is an alias of SolrInputDocument::clear
- * @link https://php.net/manual/en/solrinputdocument.reset.php
- * @return bool
- * Returns TRUE on success or FALSE on failure.
- *
- */
- public function reset() {}
+ /**
+ * (PECL solr >= 0.9.2)
+ * Sets the boost value for this document
+ * @link https://php.net/manual/en/solrinputdocument.setboost.php
+ * @param float $documentBoostValue
+ * The index-time boost value for this document.
+ *
+ * @return bool
+ * Returns TRUE on success or FALSE on failure.
+ *
+ */
+ public function setBoost($documentBoostValue) {}
- /**
- * (PECL solr >= 0.9.2)
- * Sets the boost value for this document
- * @link https://php.net/manual/en/solrinputdocument.setboost.php
- * @param float $documentBoostValue
- * The index-time boost value for this document.
- *
- * @return bool
- * Returns TRUE on success or FALSE on failure.
- *
- */
- public function setBoost($documentBoostValue) {}
+ /**
+ * (PECL solr >= 0.9.2)
+ * Sets the index-time boost value for a field
+ * https://php.net/manual/en/solrinputdocument.setfieldboost.php
+ * @param string $fieldName
+ * The name of the field.
+ *
+ * @param float $fieldBoostValue
+ * The index time boost value.
+ *
+ */
+ public function setFieldBoost($fieldName, $fieldBoostValue) {}
- /**
- * (PECL solr >= 0.9.2)
- * Sets the index-time boost value for a field
- * https://php.net/manual/en/solrinputdocument.setfieldboost.php
- * @param string $fieldName
- * The name of the field.
- *
- * @param float $fieldBoostValue
- * The index time boost value.
- *
- */
- public function setFieldBoost($fieldName, $fieldBoostValue) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Sorts the fields within the document
- * @link https://php.net/manual/en/solrinputdocument.sort.php
- * @param int $sortOrderBy
- * The sort criteria, must be one of :
- *
- * - SolrInputDocument::SORT_FIELD_NAME
- * - SolrInputDocument::SORT_FIELD_BOOST_VALUE
- * - SolrInputDocument::SORT_FIELD_VALUE_COUNT
- *
- *
- * @param int $sortDirection [optional]
- * The sort direction, can be one of :
- *
- * - SolrInputDocument::SORT_DEFAULT
- * - SolrInputDocument::SORT_ASC
- * - SolrInputDocument::SORT_DESC
- *
- *
- * @return bool
- * Returns TRUE on success or FALSE on failure.
- *
- */
- public function sort($sortOrderBy, $sortDirection = SolrInputDocument::SORT_ASC) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns an array representation of the input document
- * @link https://php.net/manual/en/solrinputdocument.toarray.php
- * @return array|false
- * Returns an array containing the fields. It returns FALSE on failure.
- *
- */
- public function toArray() {}
+ /**
+ * (PECL solr >= 0.9.2)
+ * Sorts the fields within the document
+ * @link https://php.net/manual/en/solrinputdocument.sort.php
+ * @param int $sortOrderBy
+ * The sort criteria, must be one of :
+ *
+ * - SolrInputDocument::SORT_FIELD_NAME
+ * - SolrInputDocument::SORT_FIELD_BOOST_VALUE
+ * - SolrInputDocument::SORT_FIELD_VALUE_COUNT
+ *
+ *
+ * @param int $sortDirection [optional]
+ * The sort direction, can be one of :
+ *
+ * - SolrInputDocument::SORT_DEFAULT
+ * - SolrInputDocument::SORT_ASC
+ * - SolrInputDocument::SORT_DESC
+ *
+ *
+ * @return bool
+ * Returns TRUE on success or FALSE on failure.
+ *
+ */
+ public function sort($sortOrderBy, $sortDirection = SolrInputDocument::SORT_ASC) {}
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns an array representation of the input document
+ * @link https://php.net/manual/en/solrinputdocument.toarray.php
+ * @return array|false
+ * Returns an array containing the fields. It returns FALSE on failure.
+ *
+ */
+ public function toArray() {}
}
diff --git a/solr/Exceptions/SolrClientException.php b/solr/Exceptions/SolrClientException.php
index 7d7f20f4e..3c7a87777 100644
--- a/solr/Exceptions/SolrClientException.php
+++ b/solr/Exceptions/SolrClientException.php
@@ -12,17 +12,16 @@
* An exception thrown when there is an error while making a request to the server from the client.
* @link https://php.net/manual/en/class.solrclientexception.php
*/
-class SolrClientException extends SolrException {
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns internal information where the Exception was thrown
- * @link https://php.net/manual/en/solrclientexception.getinternalinfo.php
- * @return array
- * Returns an array containing internal information where the error was thrown. Used only for debugging by extension
- * developers.
- *
- */
- public function getInternalInfo() {}
-
+class SolrClientException extends SolrException
+{
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns internal information where the Exception was thrown
+ * @link https://php.net/manual/en/solrclientexception.getinternalinfo.php
+ * @return array
+ * Returns an array containing internal information where the error was thrown. Used only for debugging by extension
+ * developers.
+ *
+ */
+ public function getInternalInfo() {}
}
diff --git a/solr/Exceptions/SolrException.php b/solr/Exceptions/SolrException.php
index be5fc067d..71af42801 100644
--- a/solr/Exceptions/SolrException.php
+++ b/solr/Exceptions/SolrException.php
@@ -12,26 +12,25 @@
* This is the base class for all exception thrown by the Solr extension classes.
* @link https://php.net/manual/en/class.solrexception.php
*/
-class SolrException extends Exception {
+class SolrException extends Exception
+{
+ /** @var int The line in c-space source file where exception was generated */
+ protected $sourceline;
- /** @var int The line in c-space source file where exception was generated */
- protected $sourceline;
+ /** @var string The c-space source file where exception was generated */
+ protected $sourcefile;
- /** @var string The c-space source file where exception was generated */
- protected $sourcefile;
-
- /** @var string The c-space function where exception was generated */
- protected $zif_name;
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns internal information where the Exception was thrown
- * @link https://php.net/manual/en/solrexception.getinternalinfo.php
- * @return array
- * Returns an array containing internal information where the error was thrown. Used only for debugging by extension
- * developers.
- *
- */
- public function getInternalInfo() {}
+ /** @var string The c-space function where exception was generated */
+ protected $zif_name;
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns internal information where the Exception was thrown
+ * @link https://php.net/manual/en/solrexception.getinternalinfo.php
+ * @return array
+ * Returns an array containing internal information where the error was thrown. Used only for debugging by extension
+ * developers.
+ *
+ */
+ public function getInternalInfo() {}
}
diff --git a/solr/Exceptions/SolrIllegalArgumentException.php b/solr/Exceptions/SolrIllegalArgumentException.php
index 285628dfc..aa3b3fba2 100644
--- a/solr/Exceptions/SolrIllegalArgumentException.php
+++ b/solr/Exceptions/SolrIllegalArgumentException.php
@@ -12,17 +12,16 @@
* This object is thrown when an illegal or invalid argument is passed to a method.
* @link https://php.net/manual/en/class.solrillegalargumentexception.php
*/
-class SolrIllegalArgumentException extends SolrException {
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns internal information where the Exception was thrown
- * @link https://php.net/manual/en/solrillegalargumentexception.getinternalinfo.php
- * @return array
- * Returns an array containing internal information where the error was thrown. Used only for debugging by extension
- * developers.
- *
- */
- public function getInternalInfo() {}
-
+class SolrIllegalArgumentException extends SolrException
+{
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns internal information where the Exception was thrown
+ * @link https://php.net/manual/en/solrillegalargumentexception.getinternalinfo.php
+ * @return array
+ * Returns an array containing internal information where the error was thrown. Used only for debugging by extension
+ * developers.
+ *
+ */
+ public function getInternalInfo() {}
}
diff --git a/solr/Exceptions/SolrIllegalOperationException.php b/solr/Exceptions/SolrIllegalOperationException.php
index 701098992..e7b4f0755 100644
--- a/solr/Exceptions/SolrIllegalOperationException.php
+++ b/solr/Exceptions/SolrIllegalOperationException.php
@@ -12,17 +12,16 @@
* This object is thrown when an illegal or unsupported operation is performed on an object.
* @link https://php.net/manual/en/class.solrillegaloperationexception.php
*/
-class SolrIllegalOperationException extends SolrException {
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns internal information where the Exception was thrown
- * @link https://php.net/manual/en/solrillegaloperationexception.getinternalinfo.php
- * @return array
- * Returns an array containing internal information where the error was thrown. Used only for debugging by extension
- * developers.
- *
- */
- public function getInternalInfo() {}
-
+class SolrIllegalOperationException extends SolrException
+{
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns internal information where the Exception was thrown
+ * @link https://php.net/manual/en/solrillegaloperationexception.getinternalinfo.php
+ * @return array
+ * Returns an array containing internal information where the error was thrown. Used only for debugging by extension
+ * developers.
+ *
+ */
+ public function getInternalInfo() {}
}
diff --git a/solr/Exceptions/SolrMissingMandatoryParameterException.php b/solr/Exceptions/SolrMissingMandatoryParameterException.php
index dbe692468..79995d48a 100644
--- a/solr/Exceptions/SolrMissingMandatoryParameterException.php
+++ b/solr/Exceptions/SolrMissingMandatoryParameterException.php
@@ -11,6 +11,4 @@
* Class SolrMissingMandatoryParameterException
* @link https://php.net/manual/en/class.solrmissingmandatoryparameterexception.php
*/
-class SolrMissingMandatoryParameterException extends SolrException {
-
-}
+class SolrMissingMandatoryParameterException extends SolrException {}
diff --git a/solr/Exceptions/SolrServerException.php b/solr/Exceptions/SolrServerException.php
index 31a175061..54d46797c 100644
--- a/solr/Exceptions/SolrServerException.php
+++ b/solr/Exceptions/SolrServerException.php
@@ -12,17 +12,16 @@
* An exception thrown when there is an error produced by the Solr Server itself.
* @link https://php.net/manual/en/class.solrserverexception.php
*/
-class SolrServerException extends SolrException {
-
- /**
- * (PECL solr >= 1.1.0, >=2.0.0)
- * Returns internal information where the Exception was thrown
- * @link https://php.net/manual/en/solrserverexception.getinternalinfo.php
- * @return array
- * Returns an array containing internal information where the error was thrown. Used only for debugging by extension
- * developers.
- *
- */
- public function getInternalInfo() {}
-
+class SolrServerException extends SolrException
+{
+ /**
+ * (PECL solr >= 1.1.0, >=2.0.0)
+ * Returns internal information where the Exception was thrown
+ * @link https://php.net/manual/en/solrserverexception.getinternalinfo.php
+ * @return array
+ * Returns an array containing internal information where the error was thrown. Used only for debugging by extension
+ * developers.
+ *
+ */
+ public function getInternalInfo() {}
}
diff --git a/solr/Queries/SolrCollapseFunction.php b/solr/Queries/SolrCollapseFunction.php
index c95cba16d..08c41c619 100644
--- a/solr/Queries/SolrCollapseFunction.php
+++ b/solr/Queries/SolrCollapseFunction.php
@@ -11,141 +11,140 @@
* Class SolrCollapseFunction
* @link https://php.net/manual/en/class.solrcollapsefunction.php
*/
-class SolrCollapseFunction {
-
- /** @var string */
- const NULLPOLICY_IGNORE = 'ignore';
-
- /** @var string */
- const NULLPOLICY_EXPAND = 'expand';
-
- /** @var string */
- const NULLPOLICY_COLLAPSE = 'collapse';
-
- /**
- * (PECL solr >= 2.2.0)
- * SolrCollapseFunction constructor.
- * @link https://php.net/manual/en/solrcollapsefunction.construct.php
- * @param string $field [optional]
- * The field name to collapse on.
- * In order to collapse a result. The field type must be a single valued String, Int or Float.
- *
- */
- public function __construct ($field) {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Returns the field that is being collapsed on.
- * @link https://php.net/manual/en/solrcollapsefunction.getfield.php
- * @return string
- */
- public function getField() {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Returns collapse hint
- * @link https://php.net/manual/en/solrcollapsefunction.gethint.php
- * @return string
- */
- public function getHint() {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Returns max parameter
- * @link https://php.net/manual/en/solrcollapsefunction.getmax.php
- * @return string
- */
- public function getMax() {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Returns min parameter
- * @link https://php.net/manual/en/solrcollapsefunction.getmin.php
- * @return string
- */
- public function getMin() {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Returns null policy
- * @link https://php.net/manual/en/solrcollapsefunction.getnullpolicy.php
- * @return string
- */
- public function getNullPolicy() {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Returns size parameter
- * @link https://php.net/manual/en/solrcollapsefunction.getsize.php
- * @return int
- */
- public function getSize() {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Sets the field to collapse on
- * @link https://php.net/manual/en/solrcollapsefunction.setfield.php
- * @param string $fieldName
- * The field name to collapse on. In order to collapse a result. The field type must be a single valued String, Int
- * or Float.
- *
- * @return SolrCollapseFunction
- */
- public function setField($fieldName) {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Sets collapse hint
- * @link https://php.net/manual/en/solrcollapsefunction.sethint.php
- * @param string $hint
- * Currently there is only one hint available "top_fc", which stands for top level FieldCache
- *
- * @return SolrCollapseFunction
- */
- public function setHint($hint) {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Selects the group heads by the max value of a numeric field or function query.
- * @link https://php.net/manual/en/solrcollapsefunction.setmax.php
- * @param string $max
- * @return SolrCollapseFunction
- */
- public function setMax($max) {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Sets the initial size of the collapse data structures when collapsing on a numeric field only
- * @link https://php.net/manual/en/solrcollapsefunction.setmin.php
- * @param string $min
- * @return SolrCollapseFunction
- */
- public function setMin($min) {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Sets the NULL Policy
- * @link https://php.net/manual/en/solrcollapsefunction.setnullpolicy.php
- * @param string $nullPolicy
- * @return SolrCollapseFunction
- */
- public function setNullPolicy($nullPolicy) {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Sets the initial size of the collapse data structures when collapsing on a numeric field only.
- * @link https://php.net/manual/en/solrcollapsefunction.setsize.php
- * @param int $size
- * @return SolrCollapseFunction
- */
- public function setSize($size) {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Returns a string representing the constructed collapse function
- * @link https://php.net/manual/en/solrcollapsefunction.tostring.php
- * @return string
- */
- public function __toString() {}
-
+class SolrCollapseFunction
+{
+ /** @var string */
+ public const NULLPOLICY_IGNORE = 'ignore';
+
+ /** @var string */
+ public const NULLPOLICY_EXPAND = 'expand';
+
+ /** @var string */
+ public const NULLPOLICY_COLLAPSE = 'collapse';
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * SolrCollapseFunction constructor.
+ * @link https://php.net/manual/en/solrcollapsefunction.construct.php
+ * @param string $field [optional]
+ * The field name to collapse on.
+ * In order to collapse a result. The field type must be a single valued String, Int or Float.
+ *
+ */
+ public function __construct($field) {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Returns the field that is being collapsed on.
+ * @link https://php.net/manual/en/solrcollapsefunction.getfield.php
+ * @return string
+ */
+ public function getField() {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Returns collapse hint
+ * @link https://php.net/manual/en/solrcollapsefunction.gethint.php
+ * @return string
+ */
+ public function getHint() {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Returns max parameter
+ * @link https://php.net/manual/en/solrcollapsefunction.getmax.php
+ * @return string
+ */
+ public function getMax() {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Returns min parameter
+ * @link https://php.net/manual/en/solrcollapsefunction.getmin.php
+ * @return string
+ */
+ public function getMin() {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Returns null policy
+ * @link https://php.net/manual/en/solrcollapsefunction.getnullpolicy.php
+ * @return string
+ */
+ public function getNullPolicy() {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Returns size parameter
+ * @link https://php.net/manual/en/solrcollapsefunction.getsize.php
+ * @return int
+ */
+ public function getSize() {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Sets the field to collapse on
+ * @link https://php.net/manual/en/solrcollapsefunction.setfield.php
+ * @param string $fieldName
+ * The field name to collapse on. In order to collapse a result. The field type must be a single valued String, Int
+ * or Float.
+ *
+ * @return SolrCollapseFunction
+ */
+ public function setField($fieldName) {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Sets collapse hint
+ * @link https://php.net/manual/en/solrcollapsefunction.sethint.php
+ * @param string $hint
+ * Currently there is only one hint available "top_fc", which stands for top level FieldCache
+ *
+ * @return SolrCollapseFunction
+ */
+ public function setHint($hint) {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Selects the group heads by the max value of a numeric field or function query.
+ * @link https://php.net/manual/en/solrcollapsefunction.setmax.php
+ * @param string $max
+ * @return SolrCollapseFunction
+ */
+ public function setMax($max) {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Sets the initial size of the collapse data structures when collapsing on a numeric field only
+ * @link https://php.net/manual/en/solrcollapsefunction.setmin.php
+ * @param string $min
+ * @return SolrCollapseFunction
+ */
+ public function setMin($min) {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Sets the NULL Policy
+ * @link https://php.net/manual/en/solrcollapsefunction.setnullpolicy.php
+ * @param string $nullPolicy
+ * @return SolrCollapseFunction
+ */
+ public function setNullPolicy($nullPolicy) {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Sets the initial size of the collapse data structures when collapsing on a numeric field only.
+ * @link https://php.net/manual/en/solrcollapsefunction.setsize.php
+ * @param int $size
+ * @return SolrCollapseFunction
+ */
+ public function setSize($size) {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Returns a string representing the constructed collapse function
+ * @link https://php.net/manual/en/solrcollapsefunction.tostring.php
+ * @return string
+ */
+ public function __toString() {}
}
diff --git a/solr/Queries/SolrDisMaxQuery.php b/solr/Queries/SolrDisMaxQuery.php
index b0da56662..fa2581a79 100644
--- a/solr/Queries/SolrDisMaxQuery.php
+++ b/solr/Queries/SolrDisMaxQuery.php
@@ -13,339 +13,338 @@
* Class SolrDisMaxQuery
* @link https://php.net/manual/en/class.solrdismaxquery.php
*/
-class SolrDisMaxQuery extends SolrQuery implements Serializable {
+class SolrDisMaxQuery extends SolrQuery implements Serializable
+{
+ /**
+ * (PECL solr >= 2.1.0)
+ * Adds a Phrase Bigram Field (pf2 parameter)
+ * @link https://php.net/manual/en/solrdismaxquery.addbigramphrasefield.php
+ * @param string $field
+ * Field name
+ *
+ * @param string $boost [optional]
+ * Boost value. Boosts documents with matching terms.
+ *
+ * @param string $slop [optional]
+ * Field Slop
+ *
+ * @return SolrDisMaxQuery
+ */
+ public function addBigramPhraseField($field, $boost, $slop) {}
- /**
- * (PECL solr >= 2.1.0)
- * Adds a Phrase Bigram Field (pf2 parameter)
- * @link https://php.net/manual/en/solrdismaxquery.addbigramphrasefield.php
- * @param string $field
- * Field name
- *
- * @param string $boost [optional]
- * Boost value. Boosts documents with matching terms.
- *
- * @param string $slop [optional]
- * Field Slop
- *
- * @return SolrDisMaxQuery
- */
- public function addBigramPhraseField($field, $boost, $slop) {}
+ /**
+ * (PECL solr >= 2.1.0)
+ * Adds a boost query field with value and optional boost (bq parameter)
+ * @link https://php.net/manual/en/solrdismaxquery.addboostquery.php
+ * @param string $field
+ * Field name
+ *
+ * @param string $value
+ * @param string $boost [optional]
+ * Boost value. Boosts documents with matching terms.
+ *
+ * @return SolrDisMaxQuery
+ */
+ public function addBoostQuery($field, $value, $boost) {}
- /**
- * (PECL solr >= 2.1.0)
- * Adds a boost query field with value and optional boost (bq parameter)
- * @link https://php.net/manual/en/solrdismaxquery.addboostquery.php
- * @param string $field
- * Field name
- *
- * @param string $value
- * @param string $boost [optional]
- * Boost value. Boosts documents with matching terms.
- *
- * @return SolrDisMaxQuery
- */
- public function addBoostQuery($field, $value, $boost) {}
+ /**
+ * (PECL solr >= 2.1.0)
+ * Adds a Phrase Field (pf parameter)
+ * @link https://php.net/manual/en/solrdismaxquery.addphrasefield.php
+ * @param string $field
+ * Field name
+ *
+ * @param string $boost [optional]
+ * Boost value. Boosts documents with matching terms.
+ *
+ * @param string $slop [optional]
+ * Field Slop
+ *
+ * @return SolrDisMaxQuery
+ */
+ public function addPhraseField($field, $boost, $slop) {}
- /**
- * (PECL solr >= 2.1.0)
- * Adds a Phrase Field (pf parameter)
- * @link https://php.net/manual/en/solrdismaxquery.addphrasefield.php
- * @param string $field
- * Field name
- *
- * @param string $boost [optional]
- * Boost value. Boosts documents with matching terms.
- *
- * @param string $slop [optional]
- * Field Slop
- *
- * @return SolrDisMaxQuery
- */
- public function addPhraseField($field, $boost, $slop) {}
+ /**
+ * (PECL solr >= 2.1.0)
+ * Add a query field with optional boost (qf parameter)
+ * @link https://php.net/manual/en/solrdismaxquery.addqueryfield.php
+ * @param string $field
+ * Field name
+ *
+ * @param string $boost [optional]
+ * Boost value. Boosts documents with matching terms.
+ *
+ * @return SolrDisMaxQuery
+ */
+ public function addQueryField($field, $boost) {}
- /**
- * (PECL solr >= 2.1.0)
- * Add a query field with optional boost (qf parameter)
- * @link https://php.net/manual/en/solrdismaxquery.addqueryfield.php
- * @param string $field
- * Field name
- *
- * @param string $boost [optional]
- * Boost value. Boosts documents with matching terms.
- *
- * @return SolrDisMaxQuery
- */
- public function addQueryField($field, $boost) {}
+ /**
+ * (PECL solr >= 2.1.0)
+ * Adds a Trigram Phrase Field (pf3 parameter)
+ * @link https://php.net/manual/en/solrdismaxquery.addtrigramphrasefield.php
+ * @param string $field
+ * Field name
+ *
+ * @param string $boost [optional]
+ * Boost value. Boosts documents with matching terms.
+ *
+ * @param string $slop [optional]
+ * Field Slop
+ *
+ * @return SolrDisMaxQuery
+ */
+ public function addTrigramPhraseField($field, $boost, $slop) {}
- /**
- * (PECL solr >= 2.1.0)
- * Adds a Trigram Phrase Field (pf3 parameter)
- * @link https://php.net/manual/en/solrdismaxquery.addtrigramphrasefield.php
- * @param string $field
- * Field name
- *
- * @param string $boost [optional]
- * Boost value. Boosts documents with matching terms.
- *
- * @param string $slop [optional]
- * Field Slop
- *
- * @return SolrDisMaxQuery
- */
- public function addTrigramPhraseField($field, $boost, $slop) {}
+ /**
+ * (PECL solr >= 2.1.0)
+ * Adds a field to User Fields Parameter (uf)
+ * @link https://php.net/manual/en/solrdismaxquery.adduserfield.php
+ * @param string $field
+ * Field name
+ *
+ * @return SolrDisMaxQuery
+ */
+ public function addUserField($field) {}
- /**
- * (PECL solr >= 2.1.0)
- * Adds a field to User Fields Parameter (uf)
- * @link https://php.net/manual/en/solrdismaxquery.adduserfield.php
- * @param string $field
- * Field name
- *
- * @return SolrDisMaxQuery
- */
- public function addUserField($field) {}
+ /**
+ * (PECL solr >= 2.1.0)
+ * Removes phrase bigram field (pf2 parameter)
+ * @link https://php.net/manual/en/solrdismaxquery.removebigramphrasefield.php
+ * @param string $field
+ * Field name
+ *
+ * @return SolrDisMaxQuery
+ */
+ public function removeBigramPhraseField($field) {}
- /**
- * (PECL solr >= 2.1.0)
- * Removes phrase bigram field (pf2 parameter)
- * @link https://php.net/manual/en/solrdismaxquery.removebigramphrasefield.php
- * @param string $field
- * Field name
- *
- * @return SolrDisMaxQuery
- */
- public function removeBigramPhraseField($field) {}
+ /**
+ * (PECL solr >= 2.1.0)
+ * Removes a boost query partial by field name (bq)
+ * @link https://php.net/manual/en/solrdismaxquery.removeboostquery.php
+ * @param string $field
+ * Field name
+ *
+ * @return SolrDisMaxQuery
+ */
+ public function removeBoostQuery($field) {}
- /**
- * (PECL solr >= 2.1.0)
- * Removes a boost query partial by field name (bq)
- * @link https://php.net/manual/en/solrdismaxquery.removeboostquery.php
- * @param string $field
- * Field name
- *
- * @return SolrDisMaxQuery
- */
- public function removeBoostQuery($field) {}
+ /**
+ * (PECL solr >= 2.1.0)
+ * Removes a Phrase Field (pf parameter)
+ * @link https://php.net/manual/en/solrdismaxquery.removephrasefield.php
+ * @param string $field
+ * Field name
+ *
+ * @return SolrDisMaxQuery
+ */
+ public function removePhraseField($field) {}
- /**
- * (PECL solr >= 2.1.0)
- * Removes a Phrase Field (pf parameter)
- * @link https://php.net/manual/en/solrdismaxquery.removephrasefield.php
- * @param string $field
- * Field name
- *
- * @return SolrDisMaxQuery
- */
- public function removePhraseField($field) {}
+ /**
+ * (PECL solr >= 2.1.0)
+ * Removes a Query Field (qf parameter)
+ * @link https://php.net/manual/en/solrdismaxquery.removequeryfield.php
+ * @param string $field
+ * Field name
+ *
+ * @return SolrDisMaxQuery
+ */
+ public function removeQueryField($field) {}
- /**
- * (PECL solr >= 2.1.0)
- * Removes a Query Field (qf parameter)
- * @link https://php.net/manual/en/solrdismaxquery.removequeryfield.php
- * @param string $field
- * Field name
- *
- * @return SolrDisMaxQuery
- */
- public function removeQueryField($field) {}
+ /**
+ * (PECL solr >= 2.1.0)
+ * Removes a Trigram Phrase Field (pf3 parameter)
+ * @link https://php.net/manual/en/solrdismaxquery.removetrigramphrasefield.php
+ * @param string $field
+ * Field name
+ *
+ * @return SolrDisMaxQuery
+ */
+ public function removeTrigramPhraseField($field) {}
- /**
- * (PECL solr >= 2.1.0)
- * Removes a Trigram Phrase Field (pf3 parameter)
- * @link https://php.net/manual/en/solrdismaxquery.removetrigramphrasefield.php
- * @param string $field
- * Field name
- *
- * @return SolrDisMaxQuery
- */
- public function removeTrigramPhraseField($field) {}
+ /**
+ * (PECL solr >= 2.1.0)
+ * Removes a field from The User Fields Parameter (uf)
+ *
+ * Warning
+ * This function is currently not documented; only its argument list is available.
+ *
+ * @link https://php.net/manual/en/solrdismaxquery.removeuserfield.php
+ * @param string $field
+ * Field name
+ *
+ * @return SolrDisMaxQuery
+ */
+ public function removeUserField($field) {}
- /**
- * (PECL solr >= 2.1.0)
- * Removes a field from The User Fields Parameter (uf)
- *
- * Warning
- * This function is currently not documented; only its argument list is available.
- *
- * @link https://php.net/manual/en/solrdismaxquery.removeuserfield.php
- * @param string $field
- * Field name
- *
- * @return SolrDisMaxQuery
- */
- public function removeUserField($field) {}
+ /**
+ * (PECL solr >= 2.1.0)
+ * Sets Bigram Phrase Fields and their boosts (and slops) using pf2 parameter
+ * @link https://php.net/manual/en/solrdismaxquery.setbigramphrasefields.php
+ * @param string $fields
+ * Fields boosts (slops)
+ *
+ * @return SolrDisMaxQuery
+ */
+ public function setBigramPhraseFields($fields) {}
- /**
- * (PECL solr >= 2.1.0)
- * Sets Bigram Phrase Fields and their boosts (and slops) using pf2 parameter
- * @link https://php.net/manual/en/solrdismaxquery.setbigramphrasefields.php
- * @param string $fields
- * Fields boosts (slops)
- *
- * @return SolrDisMaxQuery
- */
- public function setBigramPhraseFields($fields) {}
+ /**
+ * (PECL solr >= 2.1.0)
+ * Sets Bigram Phrase Slop (ps2 parameter)
+ * @link https://php.net/manual/en/solrdismaxquery.setbigramphraseslop.php
+ * @param string $slop
+ * A default slop for Bigram phrase fields.
+ *
+ * @return SolrDisMaxQuery
+ */
+ public function setBigramPhraseSlop($slop) {}
- /**
- * (PECL solr >= 2.1.0)
- * Sets Bigram Phrase Slop (ps2 parameter)
- * @link https://php.net/manual/en/solrdismaxquery.setbigramphraseslop.php
- * @param string $slop
- * A default slop for Bigram phrase fields.
- *
- * @return SolrDisMaxQuery
- */
- public function setBigramPhraseSlop($slop) {}
+ /**
+ * (PECL solr >= 2.1.0)
+ * Sets a Boost Function (bf parameter).
+ * @link https://php.net/manual/en/solrdismaxquery.setboostfunction.php
+ * @param string $function
+ * Functions (with optional boosts) that will be included in the user's query to influence the score. Any function
+ * supported natively by Solr can be used, along with a boost value. e.g.:
+ * recip(rord(myfield),1,2,3)^1.5
+ *
+ * @return SolrDisMaxQuery
+ */
+ public function setBoostFunction($function) {}
- /**
- * (PECL solr >= 2.1.0)
- * Sets a Boost Function (bf parameter).
- * @link https://php.net/manual/en/solrdismaxquery.setboostfunction.php
- * @param string $function
- * Functions (with optional boosts) that will be included in the user's query to influence the score. Any function
- * supported natively by Solr can be used, along with a boost value. e.g.:
- * recip(rord(myfield),1,2,3)^1.5
- *
- * @return SolrDisMaxQuery
- */
- public function setBoostFunction($function) {}
+ /**
+ * (PECL solr >= 2.1.0)
+ * Directly Sets Boost Query Parameter (bq)
+ * @link https://php.net/manual/en/solrdismaxquery.setboostquery.php
+ * @param string $q
+ * @return SolrDisMaxQuery
+ */
+ public function setBoostQuery($q) {}
- /**
- * (PECL solr >= 2.1.0)
- * Directly Sets Boost Query Parameter (bq)
- * @link https://php.net/manual/en/solrdismaxquery.setboostquery.php
- * @param string $q
- * @return SolrDisMaxQuery
- */
- public function setBoostQuery($q) {}
+ /**
+ * (PECL solr >= 2.1.0)
+ * Set Minimum "Should" Match (mm)
+ * @link https://php.net/manual/en/solrdismaxquery.setminimummatch.php
+ * @param string $value
+ * Minimum match value/expression
+ * Set Minimum "Should" Match parameter (mm). If the default query operator is AND then mm=100%, if the default
+ * query operator (q.op) is OR, then mm=0%.
+ *
+ * @return SolrDisMaxQuery
+ */
+ public function setMinimumMatch($value) {}
- /**
- * (PECL solr >= 2.1.0)
- * Set Minimum "Should" Match (mm)
- * @link https://php.net/manual/en/solrdismaxquery.setminimummatch.php
- * @param string $value
- * Minimum match value/expression
- * Set Minimum "Should" Match parameter (mm). If the default query operator is AND then mm=100%, if the default
- * query operator (q.op) is OR, then mm=0%.
- *
- * @return SolrDisMaxQuery
- */
- public function setMinimumMatch($value) {}
+ /**
+ * (PECL solr >= 2.1.0)
+ * Sets Phrase Fields and their boosts (and slops) using pf2 parameter
+ * @link https://php.net/manual/en/solrdismaxquery.setphrasefields.php
+ * @param string $fields
+ * Fields, boosts [, slops]
+ *
+ * @return SolrDisMaxQuery
+ */
+ public function setPhraseFields($fields) {}
- /**
- * (PECL solr >= 2.1.0)
- * Sets Phrase Fields and their boosts (and slops) using pf2 parameter
- * @link https://php.net/manual/en/solrdismaxquery.setphrasefields.php
- * @param string $fields
- * Fields, boosts [, slops]
- *
- * @return SolrDisMaxQuery
- */
- public function setPhraseFields($fields) {}
+ /**
+ * (PECL solr >= 2.1.0)
+ * Sets the default slop on phrase queries (ps parameter)
+ * @link https://php.net/manual/en/solrdismaxquery.setphraseslop.php
+ * @param string $slop
+ * Sets the default amount of slop on phrase queries built with "pf", "pf2" and/or "pf3" fields (affects boosting).
+ * "ps" parameter
+ *
+ * @return SolrDisMaxQuery
+ */
+ public function setPhraseSlop($slop) {}
- /**
- * (PECL solr >= 2.1.0)
- * Sets the default slop on phrase queries (ps parameter)
- * @link https://php.net/manual/en/solrdismaxquery.setphraseslop.php
- * @param string $slop
- * Sets the default amount of slop on phrase queries built with "pf", "pf2" and/or "pf3" fields (affects boosting).
- * "ps" parameter
- *
- * @return SolrDisMaxQuery
- */
- public function setPhraseSlop($slop) {}
+ /**
+ * (PECL solr >= 2.1.0)
+ * Set Query Alternate (q.alt parameter)
+ * @link https://php.net/manual/en/solrdismaxquery.setqueryalt.php
+ * @param string $q
+ * Query String
+ *
+ * @return SolrDisMaxQuery
+ */
+ public function setQueryAlt($q) {}
- /**
- * (PECL solr >= 2.1.0)
- * Set Query Alternate (q.alt parameter)
- * @link https://php.net/manual/en/solrdismaxquery.setqueryalt.php
- * @param string $q
- * Query String
- *
- * @return SolrDisMaxQuery
- */
- public function setQueryAlt($q) {}
+ /**
+ * (PECL solr >= 2.1.0)
+ * Specifies the amount of slop permitted on phrase queries explicitly included in the user's query string (qf
+ * parameter)
+ * @link https://php.net/manual/en/solrdismaxquery.setqueryphraseslop.php
+ * @param string $slop
+ * Amount of slop
+ * The Query Phrase Slop is the amount of slop permitted on phrase queries explicitly included in the user's query
+ * string with the qf parameter.
+ *
+ * slop refers to the number of positions one token needs to be moved in relation to another token in order to match
+ * a phrase specified in a query.
+ *
+ * @return SolrDisMaxQuery
+ */
+ public function setQueryPhraseSlop($slop) {}
- /**
- * (PECL solr >= 2.1.0)
- * Specifies the amount of slop permitted on phrase queries explicitly included in the user's query string (qf
- * parameter)
- * @link https://php.net/manual/en/solrdismaxquery.setqueryphraseslop.php
- * @param string $slop
- * Amount of slop
- * The Query Phrase Slop is the amount of slop permitted on phrase queries explicitly included in the user's query
- * string with the qf parameter.
- *
- * slop refers to the number of positions one token needs to be moved in relation to another token in order to match
- * a phrase specified in a query.
- *
- * @return SolrDisMaxQuery
- */
- public function setQueryPhraseSlop($slop) {}
+ /**
+ * (PECL solr >= 2.1.0)
+ * Sets Tie Breaker parameter (tie parameter)
+ * @link https://php.net/manual/en/solrdismaxquery.settiebreaker.php
+ * @param string $tieBreaker
+ * The tie parameter specifies a float value (which should be something much less than 1) to use as tiebreaker in
+ * DisMax queries.
+ *
+ * @return SolrDisMaxQuery
+ */
+ public function setTieBreaker($tieBreaker) {}
- /**
- * (PECL solr >= 2.1.0)
- * Sets Tie Breaker parameter (tie parameter)
- * @link https://php.net/manual/en/solrdismaxquery.settiebreaker.php
- * @param string $tieBreaker
- * The tie parameter specifies a float value (which should be something much less than 1) to use as tiebreaker in
- * DisMax queries.
- *
- * @return SolrDisMaxQuery
- */
- public function setTieBreaker($tieBreaker) {}
+ /**
+ * (PECL solr >= 2.1.0)
+ * Directly Sets Trigram Phrase Fields (pf3 parameter)
+ * @link https://php.net/manual/en/solrdismaxquery.settrigramphrasefields.php
+ * @param string $fields
+ * Trigram Phrase Fields
+ *
+ * @return SolrDisMaxQuery
+ */
+ public function setTrigramPhraseFields($fields) {}
- /**
- * (PECL solr >= 2.1.0)
- * Directly Sets Trigram Phrase Fields (pf3 parameter)
- * @link https://php.net/manual/en/solrdismaxquery.settrigramphrasefields.php
- * @param string $fields
- * Trigram Phrase Fields
- *
- * @return SolrDisMaxQuery
- */
- public function setTrigramPhraseFields($fields) {}
+ /**
+ * (PECL solr >= 2.1.0)
+ * Sets Trigram Phrase Slop (ps3 parameter)
+ * @link https://php.net/manual/en/solrdismaxquery.settrigramphraseslop.php
+ * @param string $slop
+ * Phrase slop
+ *
+ * @return SolrDisMaxQuery
+ */
+ public function setTrigramPhraseSlop($slop) {}
- /**
- * (PECL solr >= 2.1.0)
- * Sets Trigram Phrase Slop (ps3 parameter)
- * @link https://php.net/manual/en/solrdismaxquery.settrigramphraseslop.php
- * @param string $slop
- * Phrase slop
- *
- * @return SolrDisMaxQuery
- */
- public function setTrigramPhraseSlop($slop) {}
+ /**
+ * (PECL solr >= 2.1.0)
+ * Sets User Fields parameter (uf)
+ * @link https://php.net/manual/en/solrdismaxquery.setuserfields.php
+ * @param string $fields
+ * Fields names separated by space
+ * This parameter supports wildcards.
+ *
+ * @return SolrDisMaxQuery
+ */
+ public function setUserFields($fields) {}
- /**
- * (PECL solr >= 2.1.0)
- * Sets User Fields parameter (uf)
- * @link https://php.net/manual/en/solrdismaxquery.setuserfields.php
- * @param string $fields
- * Fields names separated by space
- * This parameter supports wildcards.
- *
- * @return SolrDisMaxQuery
- */
- public function setUserFields($fields) {}
-
- /**
- * (PECL solr >= 2.1.0)
- * Switch QueryParser to be DisMax Query Parser
- * @link https://php.net/manual/en/solrdismaxquery.usedismaxqueryparser.php
- * @return SolrDisMaxQuery
- */
- public function useDisMaxQueryParser() {}
-
- /**
- * (PECL solr >= 2.1.0)
- * Switch QueryParser to be EDisMax
- * By default the query builder uses edismax, if it was switched using
- * SolrDisMaxQuery::useDisMaxQueryParser(), it can be switched back using this method.
- * @link https://php.net/manual/en/solrdismaxquery.useedismaxqueryparser.php
- * @return SolrDisMaxQuery
- */
- public function useEDisMaxQueryParser() {}
+ /**
+ * (PECL solr >= 2.1.0)
+ * Switch QueryParser to be DisMax Query Parser
+ * @link https://php.net/manual/en/solrdismaxquery.usedismaxqueryparser.php
+ * @return SolrDisMaxQuery
+ */
+ public function useDisMaxQueryParser() {}
+ /**
+ * (PECL solr >= 2.1.0)
+ * Switch QueryParser to be EDisMax
+ * By default the query builder uses edismax, if it was switched using
+ * SolrDisMaxQuery::useDisMaxQueryParser(), it can be switched back using this method.
+ * @link https://php.net/manual/en/solrdismaxquery.useedismaxqueryparser.php
+ * @return SolrDisMaxQuery
+ */
+ public function useEDisMaxQueryParser() {}
}
diff --git a/solr/Queries/SolrModifiableParams.php b/solr/Queries/SolrModifiableParams.php
index 30d4144da..769ade59b 100644
--- a/solr/Queries/SolrModifiableParams.php
+++ b/solr/Queries/SolrModifiableParams.php
@@ -12,20 +12,19 @@
* This class represents a collection of name-value pairs sent to the Solr server during a request.
* @link https://php.net/manual/en/class.solrmodifiableparams.php
*/
-class SolrModifiableParams extends SolrParams implements Serializable {
-
- /**
- * (PECL solr >= 0.9.2)
- * SolrModifiableParams constructor.
- * @link https://php.net/manual/en/solrmodifiableparams.construct.php
- */
- public function __construct() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Destructor
- * @link https://php.net/manual/en/solrmodifiableparams.destruct.php
- */
- public function __destruct() {}
+class SolrModifiableParams extends SolrParams implements Serializable
+{
+ /**
+ * (PECL solr >= 0.9.2)
+ * SolrModifiableParams constructor.
+ * @link https://php.net/manual/en/solrmodifiableparams.construct.php
+ */
+ public function __construct() {}
+ /**
+ * (PECL solr >= 0.9.2)
+ * Destructor
+ * @link https://php.net/manual/en/solrmodifiableparams.destruct.php
+ */
+ public function __destruct() {}
}
diff --git a/solr/Queries/SolrParams.php b/solr/Queries/SolrParams.php
index 9e949b9ec..4e34bbf2b 100644
--- a/solr/Queries/SolrParams.php
+++ b/solr/Queries/SolrParams.php
@@ -12,149 +12,148 @@
* This class represents a a collection of name-value pairs sent to the Solr server during a request.
* @link https://php.net/manual/en/class.solrparams.php
*/
-abstract class SolrParams implements Serializable {
+abstract class SolrParams implements Serializable
+{
+ /**
+ * (PECL solr >= 0.9.2)
+ * This is an alias for SolrParams::addParam
+ * @link https://php.net/manual/en/solrparams.add.php
+ * @param string $name
+ * The name of the parameter
+ *
+ * @param string $value
+ * The value of the parameter
+ *
+ * @return SolrParams|false
+ * Returns a SolrParams instance on success and FALSE on failure.
+ *
+ */
+ public function add($name, $value) {}
- /**
- * (PECL solr >= 0.9.2)
- * This is an alias for SolrParams::addParam
- * @link https://php.net/manual/en/solrparams.add.php
- * @param string $name
- * The name of the parameter
- *
- * @param string $value
- * The value of the parameter
- *
- * @return SolrParams|false
- * Returns a SolrParams instance on success and FALSE on failure.
- *
- */
- public function add($name, $value) {}
+ /**
+ * (PECL solr >= 0.9.2)
+ * Adds a parameter to the object
+ * @link https://php.net/manual/en/solrparams.addparam.php
+ * @param string $name
+ * The name of the parameter
+ *
+ * @param string $value
+ * The value of the parameter
+ *
+ * @return SolrParams|false
+ * Returns a SolrParams instance on success and FALSE on failure.
+ *
+ */
+ public function addParam($name, $value) {}
- /**
- * (PECL solr >= 0.9.2)
- * Adds a parameter to the object
- * @link https://php.net/manual/en/solrparams.addparam.php
- * @param string $name
- * The name of the parameter
- *
- * @param string $value
- * The value of the parameter
- *
- * @return SolrParams|false
- * Returns a SolrParams instance on success and FALSE on failure.
- *
- */
- public function addParam($name, $value) {}
+ /**
+ * (PECL solr >= 0.9.2)
+ * This is an alias for SolrParams::getParam
+ * @link https://php.net/manual/en/solrparams.get.php
+ * @param string $param_name
+ * The name of the parameter
+ *
+ * @return mixed
+ * Returns an array or string depending on the type of parameter
+ *
+ */
+ final public function get($param_name) {}
- /**
- * (PECL solr >= 0.9.2)
- * This is an alias for SolrParams::getParam
- * @link https://php.net/manual/en/solrparams.get.php
- * @param string $param_name
- * The name of the parameter
- *
- * @return mixed
- * Returns an array or string depending on the type of parameter
- *
- */
- final public function get($param_name) {}
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns a parameter value
+ * @link https://php.net/manual/en/solrparams.getparam.php
+ * @param string $param_name
+ * The name of the parameter
+ *
+ * @return mixed
+ * Returns an array or string depending on the type of parameter
+ *
+ */
+ final public function getParam($param_name) {}
- /**
- * (PECL solr >= 0.9.2)
- * Returns a parameter value
- * @link https://php.net/manual/en/solrparams.getparam.php
- * @param string $param_name
- * The name of the parameter
- *
- * @return mixed
- * Returns an array or string depending on the type of parameter
- *
- */
- final public function getParam($param_name) {}
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns an array of non URL-encoded parameters
+ * @link https://php.net/manual/en/solrparams.getparams.php
+ * @return array
+ * Returns an array of non URL-encoded parameters
+ *
+ */
+ final public function getParams() {}
- /**
- * (PECL solr >= 0.9.2)
- * Returns an array of non URL-encoded parameters
- * @link https://php.net/manual/en/solrparams.getparams.php
- * @return array
- * Returns an array of non URL-encoded parameters
- *
- */
- final public function getParams() {}
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns an array of URL-encoded parameters
+ * @link https://php.net/manual/en/solrparams.getpreparedparams.php
+ * @return array
+ * Returns an array of URL-encoded parameters
+ *
+ */
+ final public function getPreparedParams() {}
- /**
- * (PECL solr >= 0.9.2)
- * Returns an array of URL-encoded parameters
- * @link https://php.net/manual/en/solrparams.getpreparedparams.php
- * @return array
- * Returns an array of URL-encoded parameters
- *
- */
- final public function getPreparedParams() {}
+ /**
+ * (PECL solr >= 0.9.2)
+ * Used for custom serialization
+ * @link https://php.net/manual/en/solrparams.serialize.php
+ * @return string
+ * Used for custom serialization
+ *
+ */
+ final public function serialize() {}
- /**
- * (PECL solr >= 0.9.2)
- * Used for custom serialization
- * @link https://php.net/manual/en/solrparams.serialize.php
- * @return string
- * Used for custom serialization
- *
- */
- final public function serialize() {}
+ /**
+ * (PECL solr >= 0.9.2)
+ * An alias of SolrParams::setParam
+ * @link https://php.net/manual/en/solrparams.set.php
+ * @param string $name
+ * The name of the parameter
+ *
+ * @param string $value
+ * The parameter value
+ *
+ * @return SolrParams|false
+ * Returns a SolrParams instance on success and FALSE on failure.
+ *
+ */
+ final public function set($name, $value) {}
- /**
- * (PECL solr >= 0.9.2)
- * An alias of SolrParams::setParam
- * @link https://php.net/manual/en/solrparams.set.php
- * @param string $name
- * The name of the parameter
- *
- * @param string $value
- * The parameter value
- *
- * @return SolrParams|false
- * Returns a SolrParams instance on success and FALSE on failure.
- *
- */
- final public function set($name, $value) {}
+ /**
+ * (PECL solr >= 0.9.2)
+ * Sets the parameter to the specified value
+ * @link https://php.net/manual/en/solrparams.setparam.php
+ * @param string $name
+ * The name of the parameter
+ *
+ * @param string $value
+ * The parameter value
+ *
+ * @return SolrParams|false
+ * Returns a SolrParams instance on success and FALSE on failure.
+ *
+ */
+ public function setParam($name, $value) {}
- /**
- * (PECL solr >= 0.9.2)
- * Sets the parameter to the specified value
- * @link https://php.net/manual/en/solrparams.setparam.php
- * @param string $name
- * The name of the parameter
- *
- * @param string $value
- * The parameter value
- *
- * @return SolrParams|false
- * Returns a SolrParams instance on success and FALSE on failure.
- *
- */
- public function setParam($name, $value) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns all the name-value pair parameters in the object
- * @link https://php.net/manual/en/solrparams.tostring.php
- * @param bool $url_encode
- * Whether to return URL-encoded values
- *
- * @return string|false
- * Returns a string on success and FALSE on failure.
- *
- */
- final public function toString($url_encode = false) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Used for custom serialization
- * @link https://php.net/manual/en/solrparams.unserialize.php
- * @param string $serialized
- * The serialized representation of the object
- *
- */
- final public function unserialize($serialized) {}
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns all the name-value pair parameters in the object
+ * @link https://php.net/manual/en/solrparams.tostring.php
+ * @param bool $url_encode
+ * Whether to return URL-encoded values
+ *
+ * @return string|false
+ * Returns a string on success and FALSE on failure.
+ *
+ */
+ final public function toString($url_encode = false) {}
+ /**
+ * (PECL solr >= 0.9.2)
+ * Used for custom serialization
+ * @link https://php.net/manual/en/solrparams.unserialize.php
+ * @param string $serialized
+ * The serialized representation of the object
+ *
+ */
+ final public function unserialize($serialized) {}
}
diff --git a/solr/Queries/SolrQuery.php b/solr/Queries/SolrQuery.php
index dc6a7d848..3bea5c615 100644
--- a/solr/Queries/SolrQuery.php
+++ b/solr/Queries/SolrQuery.php
@@ -12,2415 +12,2414 @@
* This class represents a collection of name-value pairs sent to the Solr server during a request.
* @link https://php.net/manual/en/class.solrquery.php
*/
-class SolrQuery extends SolrModifiableParams implements Serializable {
-
- /** @var int Used to specify that the sorting should be in acending order */
- const ORDER_ASC = 0;
-
- /** @var int Used to specify that the sorting should be in descending order */
- const ORDER_DESC = 1;
-
- /** @var int Used to specify that the facet should sort by index */
- const FACET_SORT_INDEX = 0;
-
- /** @var int Used to specify that the facet should sort by count */
- const FACET_SORT_COUNT = 1;
-
- /** @var int Used in the TermsComponent */
- const TERMS_SORT_INDEX = 0;
-
- /** @var int Used in the TermsComponent */
- const TERMS_SORT_COUNT = 1;
-
- /**
- * (PECL solr >= 2.2.0)
- * Overrides main filter query, determines which documents to include in the main group.
- * @link https://php.net/manual/en/solrquery.addexpandfilterquery.php
- * @param string $fq
- * @return SolrQuery
- * Returns a SolrQuery object.
- *
- */
- public function addExpandFilterQuery($fq) {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Orders the documents within the expanded groups (expand.sort parameter).
- * @link https://php.net/manual/en/solrquery.addexpandsortfield.php
- * @param string $field
- * Field name
- *
- * @param string $order [optional]
- * Order ASC/DESC, utilizes SolrQuery::ORDER_* constants.
- *
- *
- * Default: SolrQuery::ORDER_DESC
- *
- * @return SolrQuery
- * Returns a SolrQuery object.
- *
- */
- public function addExpandSortField($field, $order) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Maps to facet.date
- * @link https://php.net/manual/en/solrquery.addfacetdatefield.php
- * @param string $dateField
- * The name of the date field.
- *
- * @return SolrQuery
- * Returns a SolrQuery object.
- *
- */
- public function addFacetDateField($dateField) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Adds another facet.date.other parameter
- * @link https://php.net/manual/en/solrquery.addfacetdateother.php
- * @param string $value
- * The value to use.
- *
- * @param string $field_override
- * The field name for the override.
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function addFacetDateOther($value, $field_override) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Adds another field to the facet
- * @link https://php.net/manual/en/solrquery.addfacetfield.php
- * @param string $field
- * The name of the field
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function addFacetField($field) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Adds a facet query
- * @link https://php.net/manual/en/solrquery.addfacetquery.php
- * @param string $facetQuery
- * The facet query
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function addFacetQuery($facetQuery) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Specifies which fields to return in the result
- * @link https://php.net/manual/en/solrquery.addfield.php
- * @param string $field
- * The name of the field
- *
- * @return SolrQuery
- * Returns a SolrQuery object.
- *
- */
- public function addField($field) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Specifies a filter query
- * @link https://php.net/manual/en/solrquery.addfilterquery.php
- * @param string $fq
- * The filter query
- *
- * @return SolrQuery
- * Returns a SolrQuery object.
- *
- */
- public function addFilterQuery($fq) {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Add a field to be used to group results.
- * @link https://php.net/manual/en/solrquery.addgroupfield.php
- * @param string $value
- * @return SolrQuery
- * Returns a SolrQuery object.
- *
- */
- public function addGroupField($value) {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Allows grouping results based on the unique values of a function query (group.func parameter).
- * @link https://php.net/manual/en/solrquery.addgroupfunction.php
- * @param string $value
- * @return SolrQuery
- * Returns a SolrQuery object.
- *
- */
- public function addGroupFunction($value) {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Allows grouping of documents that match the given query.
- * @link https://php.net/manual/en/solrquery.addgroupquery.php
- * @param string $value
- * @return SolrQuery
- * Returns a SolrQuery object.
- *
- */
- public function addGroupQuery($value) {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Add a group sort field (group.sort parameter).
- * @link https://php.net/manual/en/solrquery.addgroupsortfield.php
- * @param string $field
- * Field name
- *
- * @param int $order
- * Order ASC/DESC, utilizes SolrQuery::ORDER_* constants
- *
- * @return SolrQuery
- * Returns a SolrQuery object.
- *
- */
- public function addGroupSortField($field, $order) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Maps to hl.fl
- * @link https://php.net/manual/en/solrquery.addhighlightfield.php
- * @param string $field
- * Name of the field
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function addHighlightField($field) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Sets a field to use for similarity
- * @link https://php.net/manual/en/solrquery.addmltfield.php
- * @param string $field
- * The name of the field
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function addMltField($field) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Maps to mlt.qf
- * @link https://php.net/manual/en/solrquery.addmltqueryfield.php
- * @param string $field
- * The name of the field
- *
- * @param float $boost
- * Its boost value
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function addMltQueryField($field, $boost) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Used to control how the results should be sorted
- * @link https://php.net/manual/en/solrquery.addsortfield.php
- * @param string $field
- * The name of the field
- *
- * @param int $order
- * The sort direction. This should be either SolrQuery::ORDER_ASC or SolrQuery::ORDER_DESC.
- *
- * @return SolrQuery
- * Returns a SolrQuery object.
- *
- */
- public function addSortField($field, $order = SolrQuery::ORDER_DESC) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Requests a return of sub results for values within the given facet
- * @link https://php.net/manual/en/solrquery.addstatsfacet.php
- * @param string $field
- * The name of the field
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function addStatsFacet($field) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Maps to stats.field parameter
- * @link https://php.net/manual/en/solrquery.addstatsfield.php
- * @param string $field
- * The name of the field
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function addStatsField($field) {}
-
- /**
- * (No version information available, might only be in Git)
- * Collapses the result set to a single document per group
- * @link https://php.net/manual/en/solrquery.collapse.php
- * @param SolrCollapseFunction $collapseFunction
- * @return SolrQuery
- * Returns a SolrQuery object.
- *
- */
- public function collapse(SolrCollapseFunction $collapseFunction) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * SolrQuery constructor.
- * @link https://php.net/manual/en/solrquery.construct.php
- * @param string $q
- * Optional search query
- *
- */
- public function __construct($q = '') {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Destructor
- * @link https://php.net/manual/en/solrquery.destruct.php
- */
- public function __destruct() {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Returns true if group expanding is enabled
- * @link https://php.net/manual/en/solrquery.getexpand.php
- * @return bool
- * Returns TRUE if group expanding is enabled
- *
- */
- public function getExpand() {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Returns the expand filter queries
- * @link https://php.net/manual/en/solrquery.getexpandfilterqueries.php
- * @return array
- * Returns the expand filter queries
- *
- */
- public function getExpandFilterQueries() {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Returns the expand query expand.q parameter
- * @link https://php.net/manual/en/solrquery.getexpandquery.php
- * @return array
- * Returns the expand query expand.q parameter
- *
- */
- public function getExpandQuery() {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Returns The number of rows to display in each group (expand.rows)
- * @link https://php.net/manual/en/solrquery.getexpandrows.php
- * @return int
- * Returns The number of rows to display in each group (expand.rows)
- *
- */
- public function getExpandRows() {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Returns an array of fields
- * @link https://php.net/manual/en/solrquery.getexpandsortfields.php
- * @return array
- * Returns an array of fields
- *
- */
- public function getExpandSortFields() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the value of the facet parameter
- * @link https://php.net/manual/en/solrquery.getfacet.php
- * @return bool|null
- * Returns a boolean on success and NULL if not set
- *
- */
- public function getFacet() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the value for the facet.date.end parameter
- * @link https://php.net/manual/en/solrquery.getfacetdateend.php
- * @param string $field_override [optional]
- * The name of the field
- *
- * @return string|null
- * Returns a string on success and NULL if not set
- *
- */
- public function getFacetDateEnd($field_override) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns all the facet.date fields
- * @link https://php.net/manual/en/solrquery.getfacetdatefields.php
- * @return array|null
- * Returns all the facet.date fields as an array or NULL if none was set
- *
- */
- public function getFacetDateFields() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the value of the facet.date.gap parameter
- * @link https://php.net/manual/en/solrquery.getfacetdategap.php
- * @param string $field_override [optional]
- * The name of the field
- *
- * @return string|null
- * Returns a string on success and NULL if not set
- *
- */
- public function getFacetDateGap($field_override) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the value of the facet.date.hardend parameter
- * @link https://php.net/manual/en/solrquery.getfacetdatehardend.php
- * @param string $field_override [optional]
- * The name of the field
- *
- * @return string|null
- * Returns a string on success and NULL if not set
- *
- */
- public function getFacetDateHardEnd($field_override) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the value for the facet.date.other parameter
- * @link https://php.net/manual/en/solrquery.getfacetdatehardend.php
- * @param string $field_override [optional]
- * The name of the field
- *
- * @return array|null
- * Returns an array on success and NULL if not set
- *
- */
- public function getFacetDateOther($field_override) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the lower bound for the first date range for all date faceting on this field
- * @link https://php.net/manual/en/solrquery.getfacetdatestart.php
- * @param string $field_override [optional]
- * The name of the field
- *
- * @return string|null
- * Returns a string on success and NULL if not set
- *
- */
- public function getFacetDateStart($field_override) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns all the facet fields
- * @link https://php.net/manual/en/solrquery.getfacetfields.php
- * @return array|null
- * Returns an array of all the fields and NULL if none was set
- *
- */
- public function getFacetFields() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the maximum number of constraint counts that should be returned for the facet fields
- * @link https://php.net/manual/en/solrquery.getfacetlimit.php
- * @param string $field_override [optional]
- * The name of the field
- *
- * @return int|null
- * Returns an integer on success and NULL if not set
- *
- */
- public function getFacetLimit($field_override) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the value of the facet.method parameter
- * @link https://php.net/manual/en/solrquery.getfacetmethod.php
- * @param string $field_override [optional]
- * The name of the field
- *
- * @return string|null
- * Returns a string on success and NULL if not set
- *
- */
- public function getFacetMethod($field_override) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the minimum counts for facet fields should be included in the response
- * @link https://php.net/manual/en/solrquery.getfacetmincount.php
- * @param string $field_override [optional]
- * The name of the field
- *
- * @return int|null
- * Returns an integer on success and NULL if not set
- *
- */
- public function getFacetMinCount($field_override) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the current state of the facet.missing parameter
- * @link https://php.net/manual/en/solrquery.getfacetmissing.php
- * @param string $field_override [optional]
- * The name of the field
- *
- * @return string|null
- * Returns a boolean on success and NULL if not set
- *
- */
- public function getFacetMissing($field_override) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns an offset into the list of constraints to be used for pagination
- * @link https://php.net/manual/en/solrquery.getfacetoffset.php
- * @param string $field_override [optional]
- * The name of the field
- *
- * @return int|null
- * Returns an integer on success and NULL if not set
- *
- */
- public function getFacetOffset($field_override) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the facet prefix
- * @link https://php.net/manual/en/solrquery.getfacetprefix.php
- * @param string $field_override [optional]
- * The name of the field
- *
- * @return string|null
- * Returns a string on success and NULL if not set
- *
- */
- public function getFacetPrefix($field_override) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns all the facet queries
- * @link https://php.net/manual/en/solrquery.getfacetqueries.php
- * @return string|null
- * Returns an array on success and NULL if not set
- *
- */
- public function getFacetQueries() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the facet sort type
- * @link https://php.net/manual/en/solrquery.getfacetsort.php
- * @param string $field_override [optional]
- * The name of the field
- *
- * @return int|null
- * Returns an integer (SolrQuery::FACET_SORT_INDEX or SolrQuery::FACET_SORT_COUNT) on success or NULL if not
- * set.
- *
- */
- public function getFacetSort($field_override) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the list of fields that will be returned in the response
- * @link https://php.net/manual/en/solrquery.getfields.php
- * @return string|null
- * Returns an array on success and NULL if not set
- *
- */
- public function getFields() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns an array of filter queries
- * @link https://php.net/manual/en/solrquery.getfilterqueries.php
- * @return string|null
- * Returns an array on success and NULL if not set
- *
- */
- public function getFilterQueries() {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Returns true if grouping is enabled
- * https://secure.php.net/manual/en/solrquery.getgroup.php
- * @return bool
- * Returns true if grouping is enabled
- *
- */
- public function getGroup() {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Returns group cache percent value
- * @link https://php.net/manual/en/solrquery.getgroupcachepercent.php
- * @return int
- * Returns group cache percent value
- *
- */
- public function getGroupCachePercent() {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Returns the group.facet parameter value
- * @link https://php.net/manual/en/solrquery.getgroupfacet.php
- * @return bool
- * Returns the group.facet parameter value
- *
- */
- public function getGroupFacet() {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Returns group fields (group.field parameter values)
- * @link https://php.net/manual/en/solrquery.getgroupfields.php
- * @return array
- * Returns group fields (group.field parameter values)
- *
- */
- public function getGroupFields() {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Returns the group.format value
- * @link https://php.net/manual/en/solrquery.getgroupformat.php
- * @return string
- * Returns the group.format value
- *
- */
- public function getGroupFormat() {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Returns group functions (group.func parameter values)
- * @link https://php.net/manual/en/solrquery.getgroupfunctions.php
- * @return array
- * Returns group functions (group.func parameter values)
- *
- */
- public function getGroupFunctions() {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Returns the group.limit value
- * @link https://php.net/manual/en/solrquery.getgrouplimit.php
- * @return int
- * Returns the group.limit value
- *
- */
- public function getGroupLimit() {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Returns the group.main value
- * @link https://php.net/manual/en/solrquery.getgroupmain.php
- * @return bool
- * Returns the group.main value
- *
- */
- public function getGroupMain() {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Returns the group.ngroups value
- * @link https://php.net/manual/en/solrquery.getgroupngroups.php
- * @return bool
- * Returns the group.ngroups value
- *
- */
- public function getGroupNGroups() {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Returns the group.offset value
- * @link https://php.net/manual/en/solrquery.getgroupoffset.php
- * @return bool
- * Returns the group.offset value
- *
- */
- public function getGroupOffset() {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Returns all the group.query parameter values
- * @link https://php.net/manual/en/solrquery.getgroupqueries.php
- * @return array
- * Returns all the group.query parameter values
- *
- */
- public function getGroupQueries() {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Returns the group.sort value
- * @link https://php.net/manual/en/solrquery.getgroupsortfields.php
- * @return array
- * Returns all the group.sort parameter values
- *
- */
- public function getGroupSortFields() {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Returns the group.truncate value
- * @link https://php.net/manual/en/solrquery.getgrouptruncate.php
- * @return bool
- * Returns the group.truncate value
- *
- */
- public function getGroupTruncate() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the state of the hl parameter
- * @link https://php.net/manual/en/solrquery.gethighlight.php
- * @return bool
- * Returns the state of the hl parameter
- *
- */
- public function getHighlight() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the highlight field to use as backup or default
- * @link https://php.net/manual/en/solrquery.gethighlightalternatefield.php
- * @param string $field_override [optional]
- * The name of the field
- *
- * @return string|null
- * Returns a string on success and NULL if not set
- *
- */
- public function getHighlightAlternateField($field_override) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns all the fields that Solr should generate highlighted snippets for
- * @link https://php.net/manual/en/solrquery.gethighlightfields.php
- * @return array|null
- * Returns an array on success and NULL if not set
- *
- */
- public function getHighlightFields() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the formatter for the highlighted output
- * @link https://php.net/manual/en/solrquery.gethighlightformatter.php
- * @param string $field_override [optional]
- * The name of the field
- *
- * @return string|null
- * Returns a string on success and NULL if not set
- *
- */
- public function getHighlightFormatter($field_override) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the text snippet generator for highlighted text
- * @link https://php.net/manual/en/solrquery.gethighlightfragmenter.php
- * @param string $field_override [optional]
- * The name of the field
- *
- * @return string|null
- * Returns a string on success and NULL if not set
- *
- */
- public function getHighlightFragmenter($field_override) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the number of characters of fragments to consider for highlighting
- * @link https://php.net/manual/en/solrquery.gethighlightfragsize.php
- * @param string $field_override [optional]
- * The name of the field
- *
- * @return int|null
- * Returns an integer on success and NULL if not set
- *
- */
- public function getHighlightFragsize($field_override) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns whether or not to enable highlighting for range/wildcard/fuzzy/prefix queries
- * @link https://php.net/manual/en/solrquery.gethighlighthighlightmultiterm.php
- * @return bool|null
- * Returns a boolean on success and NULL if not set
- *
- */
- public function getHighlightHighlightMultiTerm() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the maximum number of characters of the field to return
- * @link https://php.net/manual/en/solrquery.gethighlightmaxalternatefieldlength.php
- * @param string $field_override [optional]
- * The name of the field
- *
- * @return int|null
- * Returns an integer on success and NULL if not set
- *
- */
- public function getHighlightMaxAlternateFieldLength($field_override) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the maximum number of characters into a document to look for suitable snippets
- * @link https://php.net/manual/en/solrquery.gethighlightmaxanalyzedchars.php
- * @return int|null
- * Returns an integer on success and NULL if not set
- *
- */
- public function getHighlightMaxAnalyzedChars() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns whether or not the collapse contiguous fragments into a single fragment
- * @link https://php.net/manual/en/solrquery.gethighlightmergecontiguous.php
- * @param string $field_override [optional]
- * The name of the field
- *
- * @return bool|null
- * Returns a boolean on success and NULL if not set
- *
- */
- public function getHighlightMergeContiguous($field_override) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the maximum number of characters from a field when using the regex fragmenter
- * @link https://php.net/manual/en/solrquery.gethighlightregexmaxanalyzedchars.php
- * @return int|null
- * Returns an integer on success and NULL if not set
- *
- */
- public function getHighlightRegexMaxAnalyzedChars() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the regular expression for fragmenting
- * @link https://php.net/manual/en/solrquery.gethighlightregexpattern.php
- * @return string
- * Returns a string on success and NULL if not set
- *
- */
- public function getHighlightRegexPattern() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the deviation factor from the ideal fragment size
- * @link https://php.net/manual/en/solrquery.gethighlightregexslop.php
- * @return float|null
- * Returns a double on success and NULL if not set.
- *
- */
- public function getHighlightRegexSlop() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns if a field will only be highlighted if the query matched in this particular field
- * @link https://php.net/manual/en/solrquery.gethighlightrequirefieldmatch.php
- * @return bool|null
- * Returns a boolean on success and NULL if not set
- *
- */
- public function getHighlightRequireFieldMatch() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the text which appears after a highlighted term
- * @link https://php.net/manual/en/solrquery.gethighlightsimplepost.php
- * @param string $field_override [optional]
- * The name of the field
- *
- * @return string|null
- * Returns a string on success and NULL if not set
- *
- */
- public function getHighlightSimplePost($field_override) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the text which appears before a highlighted term
- * @link https://php.net/manual/en/solrquery.gethighlightsimplepre.php
- * @param string $field_override [optional]
- * The name of the field
- *
- * @return string|null
- * Returns a string on success and NULL if not set
- *
- */
- public function getHighlightSimplePre($field_override) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the maximum number of highlighted snippets to generate per field
- * @link https://php.net/manual/en/solrquery.gethighlightsnippets.php
- * @param string $field_override [optional]
- * The name of the field
- *
- * @return int|null
- * Returns an integer on success and NULL if not set
- *
- */
- public function getHighlightSnippets($field_override) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the state of the hl.usePhraseHighlighter parameter
- * @link https://php.net/manual/en/solrquery.gethighlightusephrasehighlighter.php
- * @return bool|null
- * Returns a boolean on success and NULL if not set
- *
- */
- public function getHighlightUsePhraseHighlighter() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns whether or not MoreLikeThis results should be enabled
- * @link https://php.net/manual/en/solrquery.getmlt.php
- * @return bool|null
- * Returns a boolean on success and NULL if not set
- *
- */
- public function getMlt() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns whether or not the query will be boosted by the interesting term relevance
- * @link https://php.net/manual/en/solrquery.getmltboost.php
- * @return bool|null
- * Returns a boolean on success and NULL if not set
- *
- */
- public function getMltBoost() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the number of similar documents to return for each result
- * @link https://php.net/manual/en/solrquery.getmltcount.php
- * @return int|null
- * Returns an integer on success and NULL if not set
- *
- */
- public function getMltCount() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns all the fields to use for similarity
- * @link https://php.net/manual/en/solrquery.getmltfields.php
- * @return array
- * Returns an array on success and NULL if not set
- *
- */
- public function getMltFields() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the maximum number of query terms that will be included in any generated query
- * @link https://php.net/manual/en/solrquery.getmltmaxnumqueryterms.php
- * @return int|null
- * Returns an integer on success and NULL if not set
- *
- */
- public function getMltMaxNumQueryTerms() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the maximum number of tokens to parse in each document field that is not stored with TermVector support
- * @link https://php.net/manual/en/solrquery.getmltmaxnumtokens.php
- * @return int
- * Returns an integer on success and NULL if not set
- *
- */
- public function getMltMaxNumTokens() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the maximum word length above which words will be ignored
- * @link https://php.net/manual/en/solrquery.getmltmaxwordlength.php
- * @return int|null
- * Returns an integer on success and NULL if not set
- *
- */
- public function getMltMaxWordLength() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the threshold frequency at which words will be ignored which do not occur in at least this many docs
- * @link https://php.net/manual/en/solrquery.getmltmindocfrequency.php
- * @return int|null
- * Returns an integer on success and NULL if not set
- *
- */
- public function getMltMinDocFrequency() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the frequency below which terms will be ignored in the source document
- * @link https://php.net/manual/en/solrquery.getmltmintermfrequency.php
- * @return int|null
- * Returns an integer on success and NULL if not set
- *
- */
- public function getMltMinTermFrequency() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the minimum word length below which words will be ignored
- * @link https://php.net/manual/en/solrquery.getmltminwordlength.php
- * @return int
- * Returns an integer on success and NULL if not set
- *
- */
- public function getMltMinWordLength() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the query fields and their boosts
- * @link https://php.net/manual/en/solrquery.getmltqueryfields.php
- * @return array|null
- * Returns an array on success and NULL if not set
- *
- */
- public function getMltQueryFields() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the main query
- * @link https://php.net/manual/en/solrquery.getquery.php
- * @return string
- * Returns a string on success and NULL if not set
- *
- */
- public function getQuery() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the maximum number of documents
- * @link https://php.net/manual/en/solrquery.getrows.php
- * @return int|null
- * Returns an integer on success and NULL if not set
- *
- */
- public function getRows() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns all the sort fields
- * @link https://php.net/manual/en/solrquery.getsortfields.php
- * @return array
- * Returns an array on success and NULL if none of the parameters was set.
- *
- */
- public function getSortFields() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the offset in the complete result set
- * @link https://php.net/manual/en/solrquery.getstart.php
- * @return int|null
- * Returns an integer on success and NULL if not set
- *
- */
- public function getStart() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns whether or not stats is enabled
- * @link https://php.net/manual/en/solrquery.getstats.php
- * @return bool|null
- * Returns a boolean on success and NULL if not set
- *
- */
- public function getStats() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns all the stats facets that were set
- * @link https://php.net/manual/en/solrquery.getstatsfacets.php
- * @return array|null
- * Returns an array on success and NULL if not set
- *
- */
- public function getStatsFacets() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns all the statistics fields
- * @link https://php.net/manual/en/solrquery.getstatsfields.php
- * @return array|null
- * Returns an array on success and NULL if not set
- *
- */
- public function getStatsFields() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns whether or not the TermsComponent is enabled
- * @link https://php.net/manual/en/solrquery.getterms.php
- * @return bool|null
- * Returns a boolean on success and NULL if not set
- *
- */
- public function getTerms() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the field from which the terms are retrieved
- * @link https://php.net/manual/en/solrquery.gettermsfield.php
- * @return string|null
- * Returns a string on success and NULL if not set
- *
- */
- public function getTermsField() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns whether or not to include the lower bound in the result set
- * @link https://php.net/manual/en/solrquery.gettermsincludelowerbound.php
- * @return bool|null
- * Returns a boolean on success and NULL if not set
- *
- */
- public function getTermsIncludeLowerBound() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns whether or not to include the upper bound term in the result set
- * @link https://php.net/manual/en/solrquery.gettermsincludeupperbound.php
- * @return bool|null
- * Returns a boolean on success and NULL if not set
- *
- */
- public function getTermsIncludeUpperBound() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the maximum number of terms Solr should return
- * @link https://php.net/manual/en/solrquery.gettermslimit.php
- * @return int|null
- * Returns an integer on success and NULL if not set
- *
- */
- public function getTermsLimit() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the term to start at
- * @link https://php.net/manual/en/solrquery.gettermslowerbound.php
- * @return string|null
- * Returns a string on success and NULL if not set
- *
- */
- public function getTermsLowerBound() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the maximum document frequency
- * @link https://php.net/manual/en/solrquery.gettermsmaxcount.php
- * @return int|null
- * Returns an integer on success and NULL if not set
- *
- */
- public function getTermsMaxCount() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the minimum document frequency to return in order to be included
- * @link https://php.net/manual/en/solrquery.gettermsmincount.php
- * @return int|null
- * Returns an integer on success and NULL if not set
- *
- */
- public function getTermsMinCount() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the term prefix
- * @link https://php.net/manual/en/solrquery.gettermsprefix.php
- * @return string|null
- * Returns a string on success and NULL if not set
- *
- */
- public function getTermsPrefix() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Whether or not to return raw characters
- * @link https://php.net/manual/en/solrquery.gettermsreturnraw.php
- * @return bool|null
- * Returns a boolean on success and NULL if not set
- *
- */
- public function getTermsReturnRaw() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns an integer indicating how terms are sorted
- * @link https://php.net/manual/en/solrquery.gettermssort.php
- * @return int|null
- * Returns an integer on success and NULL if not set
- * SolrQuery::TERMS_SORT_INDEX indicates that the terms are returned by index order.
- * SolrQuery::TERMS_SORT_COUNT implies that the terms are sorted by term frequency (highest count first)
- *
- */
- public function getTermsSort() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the term to stop at
- * @link https://php.net/manual/en/solrquery.gettermsupperbound.php
- * @return string|null
- * Returns a string on success and NULL if not set
- *
- */
- public function getTermsUpperBound() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the time in milliseconds allowed for the query to finish
- * @link https://php.net/manual/en/solrquery.gettimeallowed.php
- * @return int|null
- * Returns an integer on success and NULL if not set
- *
- */
- public function getTimeAllowed() {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Removes an expand filter query
- * @link https://php.net/manual/en/solrquery.removeexpandfilterquery.php
- * @param string $fq
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function removeExpandFilterQuery($fq) {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Removes an expand sort field from the expand.sort parameter.
- * @link https://php.net/manual/en/solrquery.removeexpandsortfield.php
- * @param string $field
- * Field name
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function removeExpandSortField($field) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Removes one of the facet date fields
- * @link https://php.net/manual/en/solrquery.removefacetdatefield.php
- * @param string $field
- * The name of the date field to remove
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function removeFacetDateField($field) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Removes one of the facet.date.other parameters
- * @link https://php.net/manual/en/solrquery.removefacetdateother.php
- * @param string $value
- * The value
- *
- * @param string $field_override [optional]
- * The name of the field.
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function removeFacetDateOther($value, $field_override) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Removes one of the facet.date parameters
- * @link https://php.net/manual/en/solrquery.removefacetfield.php
- * @param string $field
- * The name of the field
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function removeFacetField($field) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Removes one of the facet.query parameters
- * @link https://php.net/manual/en/solrquery.removefacetquery.php
- * @param string $value
- * The value
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function removeFacetQuery($value) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Removes a field from the list of fields
- * @link https://php.net/manual/en/solrquery.removefield.php
- * @param string $field
- * The name of the field
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function removeField($field) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Removes a filter query
- * @link https://php.net/manual/en/solrquery.removefilterquery.php
- * @param string $fq
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function removeFilterQuery($fq) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Removes one of the fields used for highlighting
- * @link https://php.net/manual/en/solrquery.removehighlightfield.php
- * @param string $field
- * The name of the field
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function removeHighlightField($field) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Removes one of the moreLikeThis fields
- * @link https://php.net/manual/en/solrquery.removemltfield.php
- * @param string $field
- * The name of the field
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function removeMltField($field) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Removes one of the moreLikeThis query fields
- * @link https://php.net/manual/en/solrquery.removemltqueryfield.php
- * @param string $queryField
- * The query field
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function removeMltQueryField($queryField) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Removes one of the sort fields
- * @link https://php.net/manual/en/solrquery.removesortfield.php
- * @param string $field
- * The name of the field
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function removeSortField($field) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Removes one of the stats.facet parameters
- * @link https://php.net/manual/en/solrquery.removestatsfacet.php
- * @param string $value
- * The value
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function removeStatsFacet($value) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Removes one of the stats.field parameters
- * @link https://php.net/manual/en/solrquery.removestatsfield.php
- * @param string $field
- * The name of the field
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function removeStatsField($field) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Toggles the echoHandler parameter
- * @link https://php.net/manual/en/solrquery.setechohandler.php
- * @param bool $flag
- * TRUE or FALSE
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setEchoHandler($flag) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Determines what kind of parameters to include in the response
- * @link https://php.net/manual/en/solrquery.setechoparams.php
- * @param string $type
- * The type of parameters to include:
- *
- *
- * - none: don't include any request parameters for debugging
- * - explicit: include the parameters explicitly specified by the client in the request
- * - all: include all parameters involved in this request, either specified explicitly by the client, or
- * implicit because of the request handler configuration.
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setEchoParams($type) {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Enables/Disables the Expand Component
- * @link https://php.net/manual/en/solrquery.setexpand.php
- * @param bool $value
- * Bool flag
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setExpand($value) {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Sets the expand.q parameter
- * @link https://php.net/manual/en/solrquery.setexpandquery.php
- * @param string $q
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setExpandQuery($q) {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Sets the number of rows to display in each group (expand.rows). Server Default 5
- * @link https://php.net/manual/en/solrquery.setexpandrows.php
- * @param integer $value
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setExpandRows($value) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Sets the explainOther common query parameter
- * @link https://php.net/manual/en/solrquery.setexplainother.php
- * @param string $query
- * The Lucene query to identify a set of documents
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setExplainOther($query) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Maps to the facet parameter. Enables or disables facetting
- * @link https://php.net/manual/en/solrquery.setfacet.php
- * @param bool $flag
- * TRUE enables faceting and FALSE disables it.
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setFacet($flag) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Maps to facet.date.end
- * @link https://php.net/manual/en/solrquery.setfacetdateend.php
- * @param string $value
- * See facet.date.end
- *
- * @param string $field_override [optional]
- * Name of the field
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setFacetDateEnd($value, $field_override) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Maps to facet.date.gap
- * @link https://php.net/manual/en/solrquery.setfacetdategap.php
- * @param string $value
- * See facet.date.gap
- *
- * @param string $field_override [optional]
- * Name of the field
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setFacetDateGap($value, $field_override) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Maps to facet.date.hardend
- * @link https://php.net/manual/en/solrquery.setfacetdatehardend.php
- * @param bool $value
- * See facet.date.hardend
- *
- * @param string $field_override [optional]
- * Name of the field
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setFacetDateHardEnd($value, $field_override) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Maps to facet.date.start
- * @link https://php.net/manual/en/solrquery.setfacetdatestart.php
- * @param string $value
- * See facet.date.start
- *
- * @param string $field_override [optional]
- * Name of the field
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setFacetDateStart($value, $field_override) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Sets the minimum document frequency used for determining term count
- * @link https://php.net/manual/en/solrquery.setfacetenumcachemindefaultfrequency.php
- * @param int $frequency
- * The minimum frequency
- *
- * @param string $field_override [optional]
- * Name of the field
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setFacetEnumCacheMinDefaultFrequency($frequency, $field_override) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Maps to facet.limit
- * @link https://php.net/manual/en/solrquery.setfacetlimit.php
- * @param int $limit
- * The maximum number of constraint counts
- *
- * @param string $field_override [optional]
- * Name of the field
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setFacetLimit($limit, $field_override) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Specifies the type of algorithm to use when faceting a field
- * @link https://php.net/manual/en/solrquery.setfacetmethod.php
- * @param string $method
- * The method to use.
- *
- * @param string $field_override [optional]
- * Name of the field
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setFacetMethod($method, $field_override) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Maps to facet.mincount
- * @link https://php.net/manual/en/solrquery.setfacetmincount.php
- * @param int $mincount
- * The minimum count
- *
- * @param string $field_override [optional]
- * Name of the field
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setFacetMinCount($mincount, $field_override) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Maps to facet.missing
- * @link https://php.net/manual/en/solrquery.setfacetmissing.php
- * @param bool $flag
- * TRUE turns this feature on. FALSE disables it.
- *
- * @param string $field_override [optional]
- * Name of the field
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setFacetMissing($flag, $field_override) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Sets the offset into the list of constraints to allow for pagination
- * @link https://php.net/manual/en/solrquery.setfacetoffset.php
- * @param int $offset
- * The offset
- *
- * @param string $field_override [optional]
- * Name of the field
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setFacetOffset($offset, $field_override) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Specifies a string prefix with which to limits the terms on which to facet
- * @link https://php.net/manual/en/solrquery.setfacetprefix.php
- * @param string $prefix
- * The prefix string
- *
- * @param string $field_override [optional]
- * Name of the field
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setFacetPrefix($prefix, $field_override) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Determines the ordering of the facet field constraints
- * @link https://php.net/manual/en/solrquery.setfacetsort.php
- * @param int $facetSort
- * Use SolrQuery::FACET_SORT_INDEX for sorting by index order or SolrQuery::FACET_SORT_COUNT for sorting by count.
- *
- * @param string $field_override [optional]
- * Name of the field
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setFacetSort($facetSort, $field_override) {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Enable/Disable result grouping (group parameter)
- * @link https://php.net/manual/en/solrquery.setgroup.php
- * @param bool $value
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setGroup($value) {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Enables caching for result grouping
- * @link https://php.net/manual/en/solrquery.setgroupcachepercent.php
- * @param int $percent
- * Setting this parameter to a number greater than 0 enables caching for result grouping. Result Grouping executes
- * two searches; this option caches the second search. The server default value is 0. Testing has shown that group
- * caching only improves search time with Boolean, wildcard, and fuzzy queries. For simple queries like term or
- * "match all" queries, group caching degrades performance. group.cache.percent parameter.
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setGroupCachePercent($percent) {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Sets group.facet parameter
- * @link https://php.net/manual/en/solrquery.setgroupfacet.php
- * @param bool $value
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setGroupFacet($value) {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Sets the group format, result structure (group.format parameter).
- * @link https://php.net/manual/en/solrquery.setgroupformat.php
- * @param string $value
- * Sets the group.format parameter. If this parameter is set to simple, the grouped documents are presented in a
- * single flat list, and the start and rows parameters affect the numbers of documents instead of groups.
- * Accepts: grouped/simple
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setGroupFormat($value) {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Specifies the number of results to return for each group. The server default value is 1.
- * @link https://php.net/manual/en/solrquery.setgrouplimit.php
- * @param int $value
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setGroupLimit($value) {}
-
- /**
- * (PECL solr >= 2.2.0)
- * If true, the result of the first field grouping command is used as the main result list in the response, using
- * group.format=simple.
- * @link https://php.net/manual/en/solrquery.setgroupmain.php
- * @param string $value
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setGroupMain($value) {}
-
- /**
- * (PECL solr >= 2.2.0)
- * If true, Solr includes the number of groups that have matched the query in the results.
- * @link https://php.net/manual/en/solrquery.setgroupngroups.php
- * @param bool $value
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setGroupNGroups($value) {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Sets the group.offset parameter.
- * @link https://php.net/manual/en/solrquery.setgroupoffset.php
- * @param int $value
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setGroupOffset($value) {}
-
- /**
- * (PECL solr >= 2.2.0)
- * If true, facet counts are based on the most relevant document of each group matching the query.
- * @link https://php.net/manual/en/solrquery.setgrouptruncate.php
- * @param bool $value
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setGroupTruncate($value) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Enables or disables highlighting
- * @link https://php.net/manual/en/solrquery.sethighlight.php
- * @param bool $flag
- * Setting it to TRUE enables highlighted snippets to be generated in the query response.
- * Setting it to FALSE disables highlighting
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setHighlight($flag) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Specifies the backup field to use
- * @link https://php.net/manual/en/solrquery.sethighlightalternatefield.php
- * @param string $field
- * The name of the backup field
- *
- * @param string $field_override [optional]
- * Name of the field
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setHighlightAlternateField($field, $field_override) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Specify a formatter for the highlight output
- * @link https://php.net/manual/en/solrquery.sethighlightformatter.php
- * @param string $formatter
- * Currently the only legal value is "simple"
- *
- * @param string $field_override [optional]
- * Name of the field
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setHighlightFormatter($formatter, $field_override) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Sets a text snippet generator for highlighted text
- * @link https://php.net/manual/en/solrquery.sethighlightfragmenter.php
- * @param string $fragmenter
- * The standard fragmenter is gap. Another option is regex, which tries to create fragments that resembles a certain
- * regular expression
- *
- * @param string $field_override [optional]
- * Name of the field
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setHighlightFragmenter($fragmenter, $field_override) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * The size of fragments to consider for highlighting
- * @link https://php.net/manual/en/solrquery.sethighlightfragsize.php
- * @param int $size
- * The size, in characters, of fragments to consider for highlighting
- *
- * @param string $field_override [optional]
- * Name of the field
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setHighlightFragsize($size, $field_override) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Use SpanScorer to highlight phrase terms
- * @link https://php.net/manual/en/solrquery.sethighlighthighlightmultiterm.php
- * @param bool $flag
- * Whether or not to use SpanScorer to highlight phrase terms only when they appear within the query phrase in the
- * document.
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setHighlightHighlightMultiTerm($flag) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Sets the maximum number of characters of the field to return
- * @link https://php.net/manual/en/solrquery.sethighlightmaxalternatefieldlength.php
- * @param int $fieldLength
- * The length of the field
- *
- *
- * If SolrQuery::setHighlightAlternateField() was passed the value TRUE, this parameter specifies the maximum
- * number of characters of the field to return
- *
- *
- * Any value less than or equal to 0 means unlimited.
- *
- * @param string $field_override [optional]
- * Name of the field
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setHighlightMaxAlternateFieldLength($fieldLength, $field_override) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Specifies the number of characters into a document to look for suitable snippets
- * @link https://php.net/manual/en/solrquery.sethighlightmaxanalyzedchars.php
- * @param int $value
- * The number of characters into a document to look for suitable snippets
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setHighlightMaxAnalyzedChars($value) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Whether or not to collapse contiguous fragments into a single fragment
- * @link https://php.net/manual/en/solrquery.sethighlightmergecontiguous.php
- * @param bool $flag
- * Whether or not to collapse contiguous fragments into a single fragment
- *
- * @param string $field_override [optional]
- * Name of the field
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setHighlightMergeContiguous($flag, $field_override) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Specify the maximum number of characters to analyze
- * @link https://php.net/manual/en/solrquery.sethighlightregexmaxanalyzedchars.php
- * @param int $maxAnalyzedChars
- * The maximum number of characters to analyze from a field when using the regex fragmenter
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setHighlightRegexMaxAnalyzedChars($maxAnalyzedChars) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Specify the regular expression for fragmenting
- * @link https://php.net/manual/en/solrquery.sethighlightregexpattern.php
- * @param string $value
- * The regular expression for fragmenting. This could be used to extract sentences
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setHighlightRegexPattern($value) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Sets the factor by which the regex fragmenter can stray from the ideal fragment size
- * @link https://php.net/manual/en/solrquery.sethighlightregexslop.php
- * @param float $factor
- * The factor by which the regex fragmenter can stray from the ideal fragment size (specified by
- * SolrQuery::setHighlightFragsize) to accommodate the regular expression.
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setHighlightRegexSlop($factor) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Require field matching during highlighting
- * @link https://php.net/manual/en/solrquery.sethighlightrequirefieldmatch.php
- * @param bool $flag
- * If TRUE, then a field will only be highlighted if the query matched in this particular field.
- * This will only work if SolrQuery::setHighlightUsePhraseHighlighter() was set to TRUE.
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setHighlightRequireFieldMatch($flag) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Sets the text which appears after a highlighted term
- * @link https://php.net/manual/en/solrquery.sethighlightsimplepost.php
- * @param string $simplePost
- * Sets the text which appears after a highlighted term. The default is </em>
- *
- * @param string $field_override [optional]
- * Name of the field
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setHighlightSimplePost($simplePost, $field_override) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Sets the text which appears before a highlighted term
- * @link https://php.net/manual/en/solrquery.sethighlightsimplepre.php
- * @param string $simplePre
- * Sets the text which appears before a highlighted term. The default is <em>
- *
- * @param string $field_override [optional]
- * Name of the field
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setHighlightSimplePre($simplePre, $field_override) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Sets the maximum number of highlighted snippets to generate per field
- * @link https://php.net/manual/en/solrquery.sethighlightsnippets.php
- * @param int $value
- * The maximum number of highlighted snippets to generate per field
- *
- * @param string $field_override [optional]
- * Name of the field
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setHighlightSnippets($value, $field_override) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Whether to highlight phrase terms only when they appear within the query phrase
- * @link https://php.net/manual/en/solrquery.sethighlightusephrasehighlighter.php
- * @param bool $flag
- * Whether or not to use SpanScorer to highlight phrase terms only when they appear within the query phrase in the
- * document.
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setHighlightUsePhraseHighlighter($flag) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Enables or disables moreLikeThis
- * @link https://php.net/manual/en/solrquery.setmlt.php
- * @param bool $flag
- * TRUE enables it and FALSE turns it off.
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setMlt($flag) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Set if the query will be boosted by the interesting term relevance
- * @link https://php.net/manual/en/solrquery.setmltboost.php
- * @param bool $flag
- * Sets to TRUE or FALSE
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setMltBoost($flag) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Set the number of similar documents to return for each result
- * @link https://php.net/manual/en/solrquery.setmltcount.php
- * @param int $count
- * The number of similar documents to return for each result
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setMltCount($count) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Sets the maximum number of query terms included
- * @link https://php.net/manual/en/solrquery.setmltmaxnumqueryterms.php
- * @param int $value
- * The maximum number of query terms that will be included in any generated query
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setMltMaxNumQueryTerms($value) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Specifies the maximum number of tokens to parse
- * @link https://php.net/manual/en/solrquery.setmltmaxnumtokens.php
- * @param int $value
- * The maximum number of tokens to parse
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setMltMaxNumTokens($value) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Sets the maximum word length
- * @link https://php.net/manual/en/solrquery.setmltmaxwordlength.php
- * @param int $maxWordLength
- * The maximum word length above which words will be ignored
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setMltMaxWordLength($maxWordLength) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Sets the mltMinDoc frequency
- * @link https://php.net/manual/en/solrquery.setmltmindocfrequency.php
- * @param int $minDocFrequency
- * Sets the frequency at which words will be ignored which do not occur in at least this many docs.
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setMltMinDocFrequency($minDocFrequency) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Sets the frequency below which terms will be ignored in the source docs
- * @link https://php.net/manual/en/solrquery.setmltmintermfrequency.php
- * @param int $minTermFrequency
- * The frequency below which terms will be ignored in the source docs
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setMltMinTermFrequency($minTermFrequency) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Sets the minimum word length
- * @link https://php.net/manual/en/solrquery.setmltminwordlength.php
- * @param int $minWordLength
- * The minimum word length below which words will be ignored
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setMltMinWordLength($minWordLength) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Exclude the header from the returned results
- * @link https://php.net/manual/en/solrquery.setomitheader.php
- * @param bool $flag
- * TRUE excludes the header from the result.
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setOmitHeader($flag) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Sets the search query
- * @link https://php.net/manual/en/solrquery.setquery.php
- * @param string $query
- * The search query
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setQuery($query) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Specifies the maximum number of rows to return in the result
- * @link https://php.net/manual/en/solrquery.setrows.php
- * @param int $rows
- * The maximum number of rows to return
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setRows($rows) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Flag to show debug information
- * @link https://php.net/manual/en/solrquery.setshowdebuginfo.php
- * @param bool $flag
- * Whether to show debug info. TRUE or FALSE
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setShowDebugInfo($flag) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Specifies the number of rows to skip
- * @link https://php.net/manual/en/solrquery.setstart.php
- * @param int $start
- * The number of rows to skip.
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setStart($start) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Enables or disables the Stats component
- * @link https://php.net/manual/en/solrquery.setstats.php
- * @param bool $flag
- * TRUE turns on the stats component and FALSE disables it.
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setStats($flag) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Enables or disables the TermsComponent
- * @link https://php.net/manual/en/solrquery.setterms.php
- * @param bool $flag
- * TRUE enables it. FALSE turns it off
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setTerms($flag) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Sets the name of the field to get the Terms from
- * @link https://php.net/manual/en/solrquery.settermsfield.php
- * @param string $fieldname
- * The field name
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setTermsField($fieldname) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Include the lower bound term in the result set
- * @link https://php.net/manual/en/solrquery.settermsincludelowerbound.php
- * @param bool $flag
- * Include the lower bound term in the result set
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setTermsIncludeLowerBound($flag) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Include the upper bound term in the result set
- * @link https://php.net/manual/en/solrquery.settermsincludeupperbound.php
- * @param bool $flag
- * TRUE or FALSE
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setTermsIncludeUpperBound($flag) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Sets the maximum number of terms to return
- * @link https://php.net/manual/en/solrquery.settermslimit.php
- * @param int $limit
- * The maximum number of terms to return. All the terms will be returned if the limit is negative.
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setTermsLimit($limit) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Specifies the Term to start from
- * @link https://php.net/manual/en/solrquery.settermslowerbound.php
- * @param string $lowerBound
- * The lower bound Term
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setTermsLowerBound($lowerBound) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Sets the maximum document frequency
- * @link https://php.net/manual/en/solrquery.settermsmaxcount.php
- * @param int $frequency
- * The maximum document frequency.
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setTermsMaxCount($frequency) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Sets the minimum document frequency
- * @link https://php.net/manual/en/solrquery.settermsmincount.php
- * @param int $frequency
- * The minimum frequency
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setTermsMinCount($frequency) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Restrict matches to terms that start with the prefix
- * @link https://php.net/manual/en/solrquery.settermsprefix.php
- * @param string $prefix
- * Restrict matches to terms that start with the prefix
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setTermsPrefix($prefix) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Return the raw characters of the indexed term
- * @link https://php.net/manual/en/solrquery.settermsreturnraw.php
- * @param bool $flag
- * TRUE or FALSE
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setTermsReturnRaw($flag) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Specifies how to sort the returned terms
- * @link https://php.net/manual/en/solrquery.settermssort.php
- * @param int $sortType
- * If SolrQuery::TERMS_SORT_COUNT, sorts the terms by the term frequency (highest count first).
- * If SolrQuery::TERMS_SORT_INDEX, returns the terms in index order
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setTermsSort($sortType) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Sets the term to stop at
- * @link https://php.net/manual/en/solrquery.settermsupperbound.php
- * @param string $upperBound
- * The term to stop at
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setTermsUpperBound($upperBound) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * The time allowed for search to finish
- * @link https://php.net/manual/en/solrquery.settimeallowed.php
- * @param int $timeAllowed
- * The time allowed for a search to finish. This value only applies to the search and not to requests in general.
- * Time is in milliseconds. Values less than or equal to zero implies no time restriction. Partial results may be
- * returned, if there are any.
- *
- * @return SolrQuery
- * Returns the current SolrQuery object, if the return value is used.
- *
- */
- public function setTimeAllowed($timeAllowed) {}
-
+class SolrQuery extends SolrModifiableParams implements Serializable
+{
+ /** @var int Used to specify that the sorting should be in acending order */
+ public const ORDER_ASC = 0;
+
+ /** @var int Used to specify that the sorting should be in descending order */
+ public const ORDER_DESC = 1;
+
+ /** @var int Used to specify that the facet should sort by index */
+ public const FACET_SORT_INDEX = 0;
+
+ /** @var int Used to specify that the facet should sort by count */
+ public const FACET_SORT_COUNT = 1;
+
+ /** @var int Used in the TermsComponent */
+ public const TERMS_SORT_INDEX = 0;
+
+ /** @var int Used in the TermsComponent */
+ public const TERMS_SORT_COUNT = 1;
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Overrides main filter query, determines which documents to include in the main group.
+ * @link https://php.net/manual/en/solrquery.addexpandfilterquery.php
+ * @param string $fq
+ * @return SolrQuery
+ * Returns a SolrQuery object.
+ *
+ */
+ public function addExpandFilterQuery($fq) {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Orders the documents within the expanded groups (expand.sort parameter).
+ * @link https://php.net/manual/en/solrquery.addexpandsortfield.php
+ * @param string $field
+ * Field name
+ *
+ * @param string $order [optional]
+ * Order ASC/DESC, utilizes SolrQuery::ORDER_* constants.
+ *
+ *
+ * Default: SolrQuery::ORDER_DESC
+ *
+ * @return SolrQuery
+ * Returns a SolrQuery object.
+ *
+ */
+ public function addExpandSortField($field, $order) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Maps to facet.date
+ * @link https://php.net/manual/en/solrquery.addfacetdatefield.php
+ * @param string $dateField
+ * The name of the date field.
+ *
+ * @return SolrQuery
+ * Returns a SolrQuery object.
+ *
+ */
+ public function addFacetDateField($dateField) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Adds another facet.date.other parameter
+ * @link https://php.net/manual/en/solrquery.addfacetdateother.php
+ * @param string $value
+ * The value to use.
+ *
+ * @param string $field_override
+ * The field name for the override.
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function addFacetDateOther($value, $field_override) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Adds another field to the facet
+ * @link https://php.net/manual/en/solrquery.addfacetfield.php
+ * @param string $field
+ * The name of the field
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function addFacetField($field) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Adds a facet query
+ * @link https://php.net/manual/en/solrquery.addfacetquery.php
+ * @param string $facetQuery
+ * The facet query
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function addFacetQuery($facetQuery) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Specifies which fields to return in the result
+ * @link https://php.net/manual/en/solrquery.addfield.php
+ * @param string $field
+ * The name of the field
+ *
+ * @return SolrQuery
+ * Returns a SolrQuery object.
+ *
+ */
+ public function addField($field) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Specifies a filter query
+ * @link https://php.net/manual/en/solrquery.addfilterquery.php
+ * @param string $fq
+ * The filter query
+ *
+ * @return SolrQuery
+ * Returns a SolrQuery object.
+ *
+ */
+ public function addFilterQuery($fq) {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Add a field to be used to group results.
+ * @link https://php.net/manual/en/solrquery.addgroupfield.php
+ * @param string $value
+ * @return SolrQuery
+ * Returns a SolrQuery object.
+ *
+ */
+ public function addGroupField($value) {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Allows grouping results based on the unique values of a function query (group.func parameter).
+ * @link https://php.net/manual/en/solrquery.addgroupfunction.php
+ * @param string $value
+ * @return SolrQuery
+ * Returns a SolrQuery object.
+ *
+ */
+ public function addGroupFunction($value) {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Allows grouping of documents that match the given query.
+ * @link https://php.net/manual/en/solrquery.addgroupquery.php
+ * @param string $value
+ * @return SolrQuery
+ * Returns a SolrQuery object.
+ *
+ */
+ public function addGroupQuery($value) {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Add a group sort field (group.sort parameter).
+ * @link https://php.net/manual/en/solrquery.addgroupsortfield.php
+ * @param string $field
+ * Field name
+ *
+ * @param int $order
+ * Order ASC/DESC, utilizes SolrQuery::ORDER_* constants
+ *
+ * @return SolrQuery
+ * Returns a SolrQuery object.
+ *
+ */
+ public function addGroupSortField($field, $order) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Maps to hl.fl
+ * @link https://php.net/manual/en/solrquery.addhighlightfield.php
+ * @param string $field
+ * Name of the field
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function addHighlightField($field) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Sets a field to use for similarity
+ * @link https://php.net/manual/en/solrquery.addmltfield.php
+ * @param string $field
+ * The name of the field
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function addMltField($field) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Maps to mlt.qf
+ * @link https://php.net/manual/en/solrquery.addmltqueryfield.php
+ * @param string $field
+ * The name of the field
+ *
+ * @param float $boost
+ * Its boost value
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function addMltQueryField($field, $boost) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Used to control how the results should be sorted
+ * @link https://php.net/manual/en/solrquery.addsortfield.php
+ * @param string $field
+ * The name of the field
+ *
+ * @param int $order
+ * The sort direction. This should be either SolrQuery::ORDER_ASC or SolrQuery::ORDER_DESC.
+ *
+ * @return SolrQuery
+ * Returns a SolrQuery object.
+ *
+ */
+ public function addSortField($field, $order = SolrQuery::ORDER_DESC) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Requests a return of sub results for values within the given facet
+ * @link https://php.net/manual/en/solrquery.addstatsfacet.php
+ * @param string $field
+ * The name of the field
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function addStatsFacet($field) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Maps to stats.field parameter
+ * @link https://php.net/manual/en/solrquery.addstatsfield.php
+ * @param string $field
+ * The name of the field
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function addStatsField($field) {}
+
+ /**
+ * (No version information available, might only be in Git)
+ * Collapses the result set to a single document per group
+ * @link https://php.net/manual/en/solrquery.collapse.php
+ * @param SolrCollapseFunction $collapseFunction
+ * @return SolrQuery
+ * Returns a SolrQuery object.
+ *
+ */
+ public function collapse(SolrCollapseFunction $collapseFunction) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * SolrQuery constructor.
+ * @link https://php.net/manual/en/solrquery.construct.php
+ * @param string $q
+ * Optional search query
+ *
+ */
+ public function __construct($q = '') {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Destructor
+ * @link https://php.net/manual/en/solrquery.destruct.php
+ */
+ public function __destruct() {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Returns true if group expanding is enabled
+ * @link https://php.net/manual/en/solrquery.getexpand.php
+ * @return bool
+ * Returns TRUE if group expanding is enabled
+ *
+ */
+ public function getExpand() {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Returns the expand filter queries
+ * @link https://php.net/manual/en/solrquery.getexpandfilterqueries.php
+ * @return array
+ * Returns the expand filter queries
+ *
+ */
+ public function getExpandFilterQueries() {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Returns the expand query expand.q parameter
+ * @link https://php.net/manual/en/solrquery.getexpandquery.php
+ * @return array
+ * Returns the expand query expand.q parameter
+ *
+ */
+ public function getExpandQuery() {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Returns The number of rows to display in each group (expand.rows)
+ * @link https://php.net/manual/en/solrquery.getexpandrows.php
+ * @return int
+ * Returns The number of rows to display in each group (expand.rows)
+ *
+ */
+ public function getExpandRows() {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Returns an array of fields
+ * @link https://php.net/manual/en/solrquery.getexpandsortfields.php
+ * @return array
+ * Returns an array of fields
+ *
+ */
+ public function getExpandSortFields() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the value of the facet parameter
+ * @link https://php.net/manual/en/solrquery.getfacet.php
+ * @return bool|null
+ * Returns a boolean on success and NULL if not set
+ *
+ */
+ public function getFacet() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the value for the facet.date.end parameter
+ * @link https://php.net/manual/en/solrquery.getfacetdateend.php
+ * @param string $field_override [optional]
+ * The name of the field
+ *
+ * @return string|null
+ * Returns a string on success and NULL if not set
+ *
+ */
+ public function getFacetDateEnd($field_override) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns all the facet.date fields
+ * @link https://php.net/manual/en/solrquery.getfacetdatefields.php
+ * @return array|null
+ * Returns all the facet.date fields as an array or NULL if none was set
+ *
+ */
+ public function getFacetDateFields() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the value of the facet.date.gap parameter
+ * @link https://php.net/manual/en/solrquery.getfacetdategap.php
+ * @param string $field_override [optional]
+ * The name of the field
+ *
+ * @return string|null
+ * Returns a string on success and NULL if not set
+ *
+ */
+ public function getFacetDateGap($field_override) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the value of the facet.date.hardend parameter
+ * @link https://php.net/manual/en/solrquery.getfacetdatehardend.php
+ * @param string $field_override [optional]
+ * The name of the field
+ *
+ * @return string|null
+ * Returns a string on success and NULL if not set
+ *
+ */
+ public function getFacetDateHardEnd($field_override) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the value for the facet.date.other parameter
+ * @link https://php.net/manual/en/solrquery.getfacetdatehardend.php
+ * @param string $field_override [optional]
+ * The name of the field
+ *
+ * @return array|null
+ * Returns an array on success and NULL if not set
+ *
+ */
+ public function getFacetDateOther($field_override) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the lower bound for the first date range for all date faceting on this field
+ * @link https://php.net/manual/en/solrquery.getfacetdatestart.php
+ * @param string $field_override [optional]
+ * The name of the field
+ *
+ * @return string|null
+ * Returns a string on success and NULL if not set
+ *
+ */
+ public function getFacetDateStart($field_override) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns all the facet fields
+ * @link https://php.net/manual/en/solrquery.getfacetfields.php
+ * @return array|null
+ * Returns an array of all the fields and NULL if none was set
+ *
+ */
+ public function getFacetFields() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the maximum number of constraint counts that should be returned for the facet fields
+ * @link https://php.net/manual/en/solrquery.getfacetlimit.php
+ * @param string $field_override [optional]
+ * The name of the field
+ *
+ * @return int|null
+ * Returns an integer on success and NULL if not set
+ *
+ */
+ public function getFacetLimit($field_override) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the value of the facet.method parameter
+ * @link https://php.net/manual/en/solrquery.getfacetmethod.php
+ * @param string $field_override [optional]
+ * The name of the field
+ *
+ * @return string|null
+ * Returns a string on success and NULL if not set
+ *
+ */
+ public function getFacetMethod($field_override) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the minimum counts for facet fields should be included in the response
+ * @link https://php.net/manual/en/solrquery.getfacetmincount.php
+ * @param string $field_override [optional]
+ * The name of the field
+ *
+ * @return int|null
+ * Returns an integer on success and NULL if not set
+ *
+ */
+ public function getFacetMinCount($field_override) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the current state of the facet.missing parameter
+ * @link https://php.net/manual/en/solrquery.getfacetmissing.php
+ * @param string $field_override [optional]
+ * The name of the field
+ *
+ * @return string|null
+ * Returns a boolean on success and NULL if not set
+ *
+ */
+ public function getFacetMissing($field_override) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns an offset into the list of constraints to be used for pagination
+ * @link https://php.net/manual/en/solrquery.getfacetoffset.php
+ * @param string $field_override [optional]
+ * The name of the field
+ *
+ * @return int|null
+ * Returns an integer on success and NULL if not set
+ *
+ */
+ public function getFacetOffset($field_override) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the facet prefix
+ * @link https://php.net/manual/en/solrquery.getfacetprefix.php
+ * @param string $field_override [optional]
+ * The name of the field
+ *
+ * @return string|null
+ * Returns a string on success and NULL if not set
+ *
+ */
+ public function getFacetPrefix($field_override) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns all the facet queries
+ * @link https://php.net/manual/en/solrquery.getfacetqueries.php
+ * @return string|null
+ * Returns an array on success and NULL if not set
+ *
+ */
+ public function getFacetQueries() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the facet sort type
+ * @link https://php.net/manual/en/solrquery.getfacetsort.php
+ * @param string $field_override [optional]
+ * The name of the field
+ *
+ * @return int|null
+ * Returns an integer (SolrQuery::FACET_SORT_INDEX or SolrQuery::FACET_SORT_COUNT) on success or NULL if not
+ * set.
+ *
+ */
+ public function getFacetSort($field_override) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the list of fields that will be returned in the response
+ * @link https://php.net/manual/en/solrquery.getfields.php
+ * @return string|null
+ * Returns an array on success and NULL if not set
+ *
+ */
+ public function getFields() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns an array of filter queries
+ * @link https://php.net/manual/en/solrquery.getfilterqueries.php
+ * @return string|null
+ * Returns an array on success and NULL if not set
+ *
+ */
+ public function getFilterQueries() {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Returns true if grouping is enabled
+ * https://secure.php.net/manual/en/solrquery.getgroup.php
+ * @return bool
+ * Returns true if grouping is enabled
+ *
+ */
+ public function getGroup() {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Returns group cache percent value
+ * @link https://php.net/manual/en/solrquery.getgroupcachepercent.php
+ * @return int
+ * Returns group cache percent value
+ *
+ */
+ public function getGroupCachePercent() {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Returns the group.facet parameter value
+ * @link https://php.net/manual/en/solrquery.getgroupfacet.php
+ * @return bool
+ * Returns the group.facet parameter value
+ *
+ */
+ public function getGroupFacet() {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Returns group fields (group.field parameter values)
+ * @link https://php.net/manual/en/solrquery.getgroupfields.php
+ * @return array
+ * Returns group fields (group.field parameter values)
+ *
+ */
+ public function getGroupFields() {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Returns the group.format value
+ * @link https://php.net/manual/en/solrquery.getgroupformat.php
+ * @return string
+ * Returns the group.format value
+ *
+ */
+ public function getGroupFormat() {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Returns group functions (group.func parameter values)
+ * @link https://php.net/manual/en/solrquery.getgroupfunctions.php
+ * @return array
+ * Returns group functions (group.func parameter values)
+ *
+ */
+ public function getGroupFunctions() {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Returns the group.limit value
+ * @link https://php.net/manual/en/solrquery.getgrouplimit.php
+ * @return int
+ * Returns the group.limit value
+ *
+ */
+ public function getGroupLimit() {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Returns the group.main value
+ * @link https://php.net/manual/en/solrquery.getgroupmain.php
+ * @return bool
+ * Returns the group.main value
+ *
+ */
+ public function getGroupMain() {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Returns the group.ngroups value
+ * @link https://php.net/manual/en/solrquery.getgroupngroups.php
+ * @return bool
+ * Returns the group.ngroups value
+ *
+ */
+ public function getGroupNGroups() {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Returns the group.offset value
+ * @link https://php.net/manual/en/solrquery.getgroupoffset.php
+ * @return bool
+ * Returns the group.offset value
+ *
+ */
+ public function getGroupOffset() {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Returns all the group.query parameter values
+ * @link https://php.net/manual/en/solrquery.getgroupqueries.php
+ * @return array
+ * Returns all the group.query parameter values
+ *
+ */
+ public function getGroupQueries() {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Returns the group.sort value
+ * @link https://php.net/manual/en/solrquery.getgroupsortfields.php
+ * @return array
+ * Returns all the group.sort parameter values
+ *
+ */
+ public function getGroupSortFields() {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Returns the group.truncate value
+ * @link https://php.net/manual/en/solrquery.getgrouptruncate.php
+ * @return bool
+ * Returns the group.truncate value
+ *
+ */
+ public function getGroupTruncate() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the state of the hl parameter
+ * @link https://php.net/manual/en/solrquery.gethighlight.php
+ * @return bool
+ * Returns the state of the hl parameter
+ *
+ */
+ public function getHighlight() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the highlight field to use as backup or default
+ * @link https://php.net/manual/en/solrquery.gethighlightalternatefield.php
+ * @param string $field_override [optional]
+ * The name of the field
+ *
+ * @return string|null
+ * Returns a string on success and NULL if not set
+ *
+ */
+ public function getHighlightAlternateField($field_override) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns all the fields that Solr should generate highlighted snippets for
+ * @link https://php.net/manual/en/solrquery.gethighlightfields.php
+ * @return array|null
+ * Returns an array on success and NULL if not set
+ *
+ */
+ public function getHighlightFields() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the formatter for the highlighted output
+ * @link https://php.net/manual/en/solrquery.gethighlightformatter.php
+ * @param string $field_override [optional]
+ * The name of the field
+ *
+ * @return string|null
+ * Returns a string on success and NULL if not set
+ *
+ */
+ public function getHighlightFormatter($field_override) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the text snippet generator for highlighted text
+ * @link https://php.net/manual/en/solrquery.gethighlightfragmenter.php
+ * @param string $field_override [optional]
+ * The name of the field
+ *
+ * @return string|null
+ * Returns a string on success and NULL if not set
+ *
+ */
+ public function getHighlightFragmenter($field_override) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the number of characters of fragments to consider for highlighting
+ * @link https://php.net/manual/en/solrquery.gethighlightfragsize.php
+ * @param string $field_override [optional]
+ * The name of the field
+ *
+ * @return int|null
+ * Returns an integer on success and NULL if not set
+ *
+ */
+ public function getHighlightFragsize($field_override) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns whether or not to enable highlighting for range/wildcard/fuzzy/prefix queries
+ * @link https://php.net/manual/en/solrquery.gethighlighthighlightmultiterm.php
+ * @return bool|null
+ * Returns a boolean on success and NULL if not set
+ *
+ */
+ public function getHighlightHighlightMultiTerm() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the maximum number of characters of the field to return
+ * @link https://php.net/manual/en/solrquery.gethighlightmaxalternatefieldlength.php
+ * @param string $field_override [optional]
+ * The name of the field
+ *
+ * @return int|null
+ * Returns an integer on success and NULL if not set
+ *
+ */
+ public function getHighlightMaxAlternateFieldLength($field_override) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the maximum number of characters into a document to look for suitable snippets
+ * @link https://php.net/manual/en/solrquery.gethighlightmaxanalyzedchars.php
+ * @return int|null
+ * Returns an integer on success and NULL if not set
+ *
+ */
+ public function getHighlightMaxAnalyzedChars() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns whether or not the collapse contiguous fragments into a single fragment
+ * @link https://php.net/manual/en/solrquery.gethighlightmergecontiguous.php
+ * @param string $field_override [optional]
+ * The name of the field
+ *
+ * @return bool|null
+ * Returns a boolean on success and NULL if not set
+ *
+ */
+ public function getHighlightMergeContiguous($field_override) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the maximum number of characters from a field when using the regex fragmenter
+ * @link https://php.net/manual/en/solrquery.gethighlightregexmaxanalyzedchars.php
+ * @return int|null
+ * Returns an integer on success and NULL if not set
+ *
+ */
+ public function getHighlightRegexMaxAnalyzedChars() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the regular expression for fragmenting
+ * @link https://php.net/manual/en/solrquery.gethighlightregexpattern.php
+ * @return string
+ * Returns a string on success and NULL if not set
+ *
+ */
+ public function getHighlightRegexPattern() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the deviation factor from the ideal fragment size
+ * @link https://php.net/manual/en/solrquery.gethighlightregexslop.php
+ * @return float|null
+ * Returns a double on success and NULL if not set.
+ *
+ */
+ public function getHighlightRegexSlop() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns if a field will only be highlighted if the query matched in this particular field
+ * @link https://php.net/manual/en/solrquery.gethighlightrequirefieldmatch.php
+ * @return bool|null
+ * Returns a boolean on success and NULL if not set
+ *
+ */
+ public function getHighlightRequireFieldMatch() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the text which appears after a highlighted term
+ * @link https://php.net/manual/en/solrquery.gethighlightsimplepost.php
+ * @param string $field_override [optional]
+ * The name of the field
+ *
+ * @return string|null
+ * Returns a string on success and NULL if not set
+ *
+ */
+ public function getHighlightSimplePost($field_override) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the text which appears before a highlighted term
+ * @link https://php.net/manual/en/solrquery.gethighlightsimplepre.php
+ * @param string $field_override [optional]
+ * The name of the field
+ *
+ * @return string|null
+ * Returns a string on success and NULL if not set
+ *
+ */
+ public function getHighlightSimplePre($field_override) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the maximum number of highlighted snippets to generate per field
+ * @link https://php.net/manual/en/solrquery.gethighlightsnippets.php
+ * @param string $field_override [optional]
+ * The name of the field
+ *
+ * @return int|null
+ * Returns an integer on success and NULL if not set
+ *
+ */
+ public function getHighlightSnippets($field_override) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the state of the hl.usePhraseHighlighter parameter
+ * @link https://php.net/manual/en/solrquery.gethighlightusephrasehighlighter.php
+ * @return bool|null
+ * Returns a boolean on success and NULL if not set
+ *
+ */
+ public function getHighlightUsePhraseHighlighter() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns whether or not MoreLikeThis results should be enabled
+ * @link https://php.net/manual/en/solrquery.getmlt.php
+ * @return bool|null
+ * Returns a boolean on success and NULL if not set
+ *
+ */
+ public function getMlt() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns whether or not the query will be boosted by the interesting term relevance
+ * @link https://php.net/manual/en/solrquery.getmltboost.php
+ * @return bool|null
+ * Returns a boolean on success and NULL if not set
+ *
+ */
+ public function getMltBoost() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the number of similar documents to return for each result
+ * @link https://php.net/manual/en/solrquery.getmltcount.php
+ * @return int|null
+ * Returns an integer on success and NULL if not set
+ *
+ */
+ public function getMltCount() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns all the fields to use for similarity
+ * @link https://php.net/manual/en/solrquery.getmltfields.php
+ * @return array
+ * Returns an array on success and NULL if not set
+ *
+ */
+ public function getMltFields() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the maximum number of query terms that will be included in any generated query
+ * @link https://php.net/manual/en/solrquery.getmltmaxnumqueryterms.php
+ * @return int|null
+ * Returns an integer on success and NULL if not set
+ *
+ */
+ public function getMltMaxNumQueryTerms() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the maximum number of tokens to parse in each document field that is not stored with TermVector support
+ * @link https://php.net/manual/en/solrquery.getmltmaxnumtokens.php
+ * @return int
+ * Returns an integer on success and NULL if not set
+ *
+ */
+ public function getMltMaxNumTokens() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the maximum word length above which words will be ignored
+ * @link https://php.net/manual/en/solrquery.getmltmaxwordlength.php
+ * @return int|null
+ * Returns an integer on success and NULL if not set
+ *
+ */
+ public function getMltMaxWordLength() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the threshold frequency at which words will be ignored which do not occur in at least this many docs
+ * @link https://php.net/manual/en/solrquery.getmltmindocfrequency.php
+ * @return int|null
+ * Returns an integer on success and NULL if not set
+ *
+ */
+ public function getMltMinDocFrequency() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the frequency below which terms will be ignored in the source document
+ * @link https://php.net/manual/en/solrquery.getmltmintermfrequency.php
+ * @return int|null
+ * Returns an integer on success and NULL if not set
+ *
+ */
+ public function getMltMinTermFrequency() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the minimum word length below which words will be ignored
+ * @link https://php.net/manual/en/solrquery.getmltminwordlength.php
+ * @return int
+ * Returns an integer on success and NULL if not set
+ *
+ */
+ public function getMltMinWordLength() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the query fields and their boosts
+ * @link https://php.net/manual/en/solrquery.getmltqueryfields.php
+ * @return array|null
+ * Returns an array on success and NULL if not set
+ *
+ */
+ public function getMltQueryFields() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the main query
+ * @link https://php.net/manual/en/solrquery.getquery.php
+ * @return string
+ * Returns a string on success and NULL if not set
+ *
+ */
+ public function getQuery() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the maximum number of documents
+ * @link https://php.net/manual/en/solrquery.getrows.php
+ * @return int|null
+ * Returns an integer on success and NULL if not set
+ *
+ */
+ public function getRows() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns all the sort fields
+ * @link https://php.net/manual/en/solrquery.getsortfields.php
+ * @return array
+ * Returns an array on success and NULL if none of the parameters was set.
+ *
+ */
+ public function getSortFields() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the offset in the complete result set
+ * @link https://php.net/manual/en/solrquery.getstart.php
+ * @return int|null
+ * Returns an integer on success and NULL if not set
+ *
+ */
+ public function getStart() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns whether or not stats is enabled
+ * @link https://php.net/manual/en/solrquery.getstats.php
+ * @return bool|null
+ * Returns a boolean on success and NULL if not set
+ *
+ */
+ public function getStats() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns all the stats facets that were set
+ * @link https://php.net/manual/en/solrquery.getstatsfacets.php
+ * @return array|null
+ * Returns an array on success and NULL if not set
+ *
+ */
+ public function getStatsFacets() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns all the statistics fields
+ * @link https://php.net/manual/en/solrquery.getstatsfields.php
+ * @return array|null
+ * Returns an array on success and NULL if not set
+ *
+ */
+ public function getStatsFields() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns whether or not the TermsComponent is enabled
+ * @link https://php.net/manual/en/solrquery.getterms.php
+ * @return bool|null
+ * Returns a boolean on success and NULL if not set
+ *
+ */
+ public function getTerms() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the field from which the terms are retrieved
+ * @link https://php.net/manual/en/solrquery.gettermsfield.php
+ * @return string|null
+ * Returns a string on success and NULL if not set
+ *
+ */
+ public function getTermsField() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns whether or not to include the lower bound in the result set
+ * @link https://php.net/manual/en/solrquery.gettermsincludelowerbound.php
+ * @return bool|null
+ * Returns a boolean on success and NULL if not set
+ *
+ */
+ public function getTermsIncludeLowerBound() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns whether or not to include the upper bound term in the result set
+ * @link https://php.net/manual/en/solrquery.gettermsincludeupperbound.php
+ * @return bool|null
+ * Returns a boolean on success and NULL if not set
+ *
+ */
+ public function getTermsIncludeUpperBound() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the maximum number of terms Solr should return
+ * @link https://php.net/manual/en/solrquery.gettermslimit.php
+ * @return int|null
+ * Returns an integer on success and NULL if not set
+ *
+ */
+ public function getTermsLimit() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the term to start at
+ * @link https://php.net/manual/en/solrquery.gettermslowerbound.php
+ * @return string|null
+ * Returns a string on success and NULL if not set
+ *
+ */
+ public function getTermsLowerBound() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the maximum document frequency
+ * @link https://php.net/manual/en/solrquery.gettermsmaxcount.php
+ * @return int|null
+ * Returns an integer on success and NULL if not set
+ *
+ */
+ public function getTermsMaxCount() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the minimum document frequency to return in order to be included
+ * @link https://php.net/manual/en/solrquery.gettermsmincount.php
+ * @return int|null
+ * Returns an integer on success and NULL if not set
+ *
+ */
+ public function getTermsMinCount() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the term prefix
+ * @link https://php.net/manual/en/solrquery.gettermsprefix.php
+ * @return string|null
+ * Returns a string on success and NULL if not set
+ *
+ */
+ public function getTermsPrefix() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Whether or not to return raw characters
+ * @link https://php.net/manual/en/solrquery.gettermsreturnraw.php
+ * @return bool|null
+ * Returns a boolean on success and NULL if not set
+ *
+ */
+ public function getTermsReturnRaw() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns an integer indicating how terms are sorted
+ * @link https://php.net/manual/en/solrquery.gettermssort.php
+ * @return int|null
+ * Returns an integer on success and NULL if not set
+ * SolrQuery::TERMS_SORT_INDEX indicates that the terms are returned by index order.
+ * SolrQuery::TERMS_SORT_COUNT implies that the terms are sorted by term frequency (highest count first)
+ *
+ */
+ public function getTermsSort() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the term to stop at
+ * @link https://php.net/manual/en/solrquery.gettermsupperbound.php
+ * @return string|null
+ * Returns a string on success and NULL if not set
+ *
+ */
+ public function getTermsUpperBound() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the time in milliseconds allowed for the query to finish
+ * @link https://php.net/manual/en/solrquery.gettimeallowed.php
+ * @return int|null
+ * Returns an integer on success and NULL if not set
+ *
+ */
+ public function getTimeAllowed() {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Removes an expand filter query
+ * @link https://php.net/manual/en/solrquery.removeexpandfilterquery.php
+ * @param string $fq
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function removeExpandFilterQuery($fq) {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Removes an expand sort field from the expand.sort parameter.
+ * @link https://php.net/manual/en/solrquery.removeexpandsortfield.php
+ * @param string $field
+ * Field name
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function removeExpandSortField($field) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Removes one of the facet date fields
+ * @link https://php.net/manual/en/solrquery.removefacetdatefield.php
+ * @param string $field
+ * The name of the date field to remove
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function removeFacetDateField($field) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Removes one of the facet.date.other parameters
+ * @link https://php.net/manual/en/solrquery.removefacetdateother.php
+ * @param string $value
+ * The value
+ *
+ * @param string $field_override [optional]
+ * The name of the field.
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function removeFacetDateOther($value, $field_override) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Removes one of the facet.date parameters
+ * @link https://php.net/manual/en/solrquery.removefacetfield.php
+ * @param string $field
+ * The name of the field
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function removeFacetField($field) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Removes one of the facet.query parameters
+ * @link https://php.net/manual/en/solrquery.removefacetquery.php
+ * @param string $value
+ * The value
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function removeFacetQuery($value) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Removes a field from the list of fields
+ * @link https://php.net/manual/en/solrquery.removefield.php
+ * @param string $field
+ * The name of the field
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function removeField($field) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Removes a filter query
+ * @link https://php.net/manual/en/solrquery.removefilterquery.php
+ * @param string $fq
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function removeFilterQuery($fq) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Removes one of the fields used for highlighting
+ * @link https://php.net/manual/en/solrquery.removehighlightfield.php
+ * @param string $field
+ * The name of the field
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function removeHighlightField($field) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Removes one of the moreLikeThis fields
+ * @link https://php.net/manual/en/solrquery.removemltfield.php
+ * @param string $field
+ * The name of the field
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function removeMltField($field) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Removes one of the moreLikeThis query fields
+ * @link https://php.net/manual/en/solrquery.removemltqueryfield.php
+ * @param string $queryField
+ * The query field
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function removeMltQueryField($queryField) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Removes one of the sort fields
+ * @link https://php.net/manual/en/solrquery.removesortfield.php
+ * @param string $field
+ * The name of the field
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function removeSortField($field) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Removes one of the stats.facet parameters
+ * @link https://php.net/manual/en/solrquery.removestatsfacet.php
+ * @param string $value
+ * The value
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function removeStatsFacet($value) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Removes one of the stats.field parameters
+ * @link https://php.net/manual/en/solrquery.removestatsfield.php
+ * @param string $field
+ * The name of the field
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function removeStatsField($field) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Toggles the echoHandler parameter
+ * @link https://php.net/manual/en/solrquery.setechohandler.php
+ * @param bool $flag
+ * TRUE or FALSE
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setEchoHandler($flag) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Determines what kind of parameters to include in the response
+ * @link https://php.net/manual/en/solrquery.setechoparams.php
+ * @param string $type
+ * The type of parameters to include:
+ *
+ *
+ * - none: don't include any request parameters for debugging
+ * - explicit: include the parameters explicitly specified by the client in the request
+ * - all: include all parameters involved in this request, either specified explicitly by the client, or
+ * implicit because of the request handler configuration.
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setEchoParams($type) {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Enables/Disables the Expand Component
+ * @link https://php.net/manual/en/solrquery.setexpand.php
+ * @param bool $value
+ * Bool flag
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setExpand($value) {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Sets the expand.q parameter
+ * @link https://php.net/manual/en/solrquery.setexpandquery.php
+ * @param string $q
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setExpandQuery($q) {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Sets the number of rows to display in each group (expand.rows). Server Default 5
+ * @link https://php.net/manual/en/solrquery.setexpandrows.php
+ * @param int $value
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setExpandRows($value) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Sets the explainOther common query parameter
+ * @link https://php.net/manual/en/solrquery.setexplainother.php
+ * @param string $query
+ * The Lucene query to identify a set of documents
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setExplainOther($query) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Maps to the facet parameter. Enables or disables facetting
+ * @link https://php.net/manual/en/solrquery.setfacet.php
+ * @param bool $flag
+ * TRUE enables faceting and FALSE disables it.
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setFacet($flag) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Maps to facet.date.end
+ * @link https://php.net/manual/en/solrquery.setfacetdateend.php
+ * @param string $value
+ * See facet.date.end
+ *
+ * @param string $field_override [optional]
+ * Name of the field
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setFacetDateEnd($value, $field_override) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Maps to facet.date.gap
+ * @link https://php.net/manual/en/solrquery.setfacetdategap.php
+ * @param string $value
+ * See facet.date.gap
+ *
+ * @param string $field_override [optional]
+ * Name of the field
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setFacetDateGap($value, $field_override) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Maps to facet.date.hardend
+ * @link https://php.net/manual/en/solrquery.setfacetdatehardend.php
+ * @param bool $value
+ * See facet.date.hardend
+ *
+ * @param string $field_override [optional]
+ * Name of the field
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setFacetDateHardEnd($value, $field_override) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Maps to facet.date.start
+ * @link https://php.net/manual/en/solrquery.setfacetdatestart.php
+ * @param string $value
+ * See facet.date.start
+ *
+ * @param string $field_override [optional]
+ * Name of the field
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setFacetDateStart($value, $field_override) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Sets the minimum document frequency used for determining term count
+ * @link https://php.net/manual/en/solrquery.setfacetenumcachemindefaultfrequency.php
+ * @param int $frequency
+ * The minimum frequency
+ *
+ * @param string $field_override [optional]
+ * Name of the field
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setFacetEnumCacheMinDefaultFrequency($frequency, $field_override) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Maps to facet.limit
+ * @link https://php.net/manual/en/solrquery.setfacetlimit.php
+ * @param int $limit
+ * The maximum number of constraint counts
+ *
+ * @param string $field_override [optional]
+ * Name of the field
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setFacetLimit($limit, $field_override) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Specifies the type of algorithm to use when faceting a field
+ * @link https://php.net/manual/en/solrquery.setfacetmethod.php
+ * @param string $method
+ * The method to use.
+ *
+ * @param string $field_override [optional]
+ * Name of the field
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setFacetMethod($method, $field_override) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Maps to facet.mincount
+ * @link https://php.net/manual/en/solrquery.setfacetmincount.php
+ * @param int $mincount
+ * The minimum count
+ *
+ * @param string $field_override [optional]
+ * Name of the field
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setFacetMinCount($mincount, $field_override) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Maps to facet.missing
+ * @link https://php.net/manual/en/solrquery.setfacetmissing.php
+ * @param bool $flag
+ * TRUE turns this feature on. FALSE disables it.
+ *
+ * @param string $field_override [optional]
+ * Name of the field
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setFacetMissing($flag, $field_override) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Sets the offset into the list of constraints to allow for pagination
+ * @link https://php.net/manual/en/solrquery.setfacetoffset.php
+ * @param int $offset
+ * The offset
+ *
+ * @param string $field_override [optional]
+ * Name of the field
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setFacetOffset($offset, $field_override) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Specifies a string prefix with which to limits the terms on which to facet
+ * @link https://php.net/manual/en/solrquery.setfacetprefix.php
+ * @param string $prefix
+ * The prefix string
+ *
+ * @param string $field_override [optional]
+ * Name of the field
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setFacetPrefix($prefix, $field_override) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Determines the ordering of the facet field constraints
+ * @link https://php.net/manual/en/solrquery.setfacetsort.php
+ * @param int $facetSort
+ * Use SolrQuery::FACET_SORT_INDEX for sorting by index order or SolrQuery::FACET_SORT_COUNT for sorting by count.
+ *
+ * @param string $field_override [optional]
+ * Name of the field
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setFacetSort($facetSort, $field_override) {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Enable/Disable result grouping (group parameter)
+ * @link https://php.net/manual/en/solrquery.setgroup.php
+ * @param bool $value
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setGroup($value) {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Enables caching for result grouping
+ * @link https://php.net/manual/en/solrquery.setgroupcachepercent.php
+ * @param int $percent
+ * Setting this parameter to a number greater than 0 enables caching for result grouping. Result Grouping executes
+ * two searches; this option caches the second search. The server default value is 0. Testing has shown that group
+ * caching only improves search time with Boolean, wildcard, and fuzzy queries. For simple queries like term or
+ * "match all" queries, group caching degrades performance. group.cache.percent parameter.
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setGroupCachePercent($percent) {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Sets group.facet parameter
+ * @link https://php.net/manual/en/solrquery.setgroupfacet.php
+ * @param bool $value
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setGroupFacet($value) {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Sets the group format, result structure (group.format parameter).
+ * @link https://php.net/manual/en/solrquery.setgroupformat.php
+ * @param string $value
+ * Sets the group.format parameter. If this parameter is set to simple, the grouped documents are presented in a
+ * single flat list, and the start and rows parameters affect the numbers of documents instead of groups.
+ * Accepts: grouped/simple
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setGroupFormat($value) {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Specifies the number of results to return for each group. The server default value is 1.
+ * @link https://php.net/manual/en/solrquery.setgrouplimit.php
+ * @param int $value
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setGroupLimit($value) {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * If true, the result of the first field grouping command is used as the main result list in the response, using
+ * group.format=simple.
+ * @link https://php.net/manual/en/solrquery.setgroupmain.php
+ * @param string $value
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setGroupMain($value) {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * If true, Solr includes the number of groups that have matched the query in the results.
+ * @link https://php.net/manual/en/solrquery.setgroupngroups.php
+ * @param bool $value
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setGroupNGroups($value) {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Sets the group.offset parameter.
+ * @link https://php.net/manual/en/solrquery.setgroupoffset.php
+ * @param int $value
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setGroupOffset($value) {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * If true, facet counts are based on the most relevant document of each group matching the query.
+ * @link https://php.net/manual/en/solrquery.setgrouptruncate.php
+ * @param bool $value
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setGroupTruncate($value) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Enables or disables highlighting
+ * @link https://php.net/manual/en/solrquery.sethighlight.php
+ * @param bool $flag
+ * Setting it to TRUE enables highlighted snippets to be generated in the query response.
+ * Setting it to FALSE disables highlighting
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setHighlight($flag) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Specifies the backup field to use
+ * @link https://php.net/manual/en/solrquery.sethighlightalternatefield.php
+ * @param string $field
+ * The name of the backup field
+ *
+ * @param string $field_override [optional]
+ * Name of the field
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setHighlightAlternateField($field, $field_override) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Specify a formatter for the highlight output
+ * @link https://php.net/manual/en/solrquery.sethighlightformatter.php
+ * @param string $formatter
+ * Currently the only legal value is "simple"
+ *
+ * @param string $field_override [optional]
+ * Name of the field
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setHighlightFormatter($formatter, $field_override) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Sets a text snippet generator for highlighted text
+ * @link https://php.net/manual/en/solrquery.sethighlightfragmenter.php
+ * @param string $fragmenter
+ * The standard fragmenter is gap. Another option is regex, which tries to create fragments that resembles a certain
+ * regular expression
+ *
+ * @param string $field_override [optional]
+ * Name of the field
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setHighlightFragmenter($fragmenter, $field_override) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * The size of fragments to consider for highlighting
+ * @link https://php.net/manual/en/solrquery.sethighlightfragsize.php
+ * @param int $size
+ * The size, in characters, of fragments to consider for highlighting
+ *
+ * @param string $field_override [optional]
+ * Name of the field
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setHighlightFragsize($size, $field_override) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Use SpanScorer to highlight phrase terms
+ * @link https://php.net/manual/en/solrquery.sethighlighthighlightmultiterm.php
+ * @param bool $flag
+ * Whether or not to use SpanScorer to highlight phrase terms only when they appear within the query phrase in the
+ * document.
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setHighlightHighlightMultiTerm($flag) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Sets the maximum number of characters of the field to return
+ * @link https://php.net/manual/en/solrquery.sethighlightmaxalternatefieldlength.php
+ * @param int $fieldLength
+ * The length of the field
+ *
+ *
+ * If SolrQuery::setHighlightAlternateField() was passed the value TRUE, this parameter specifies the maximum
+ * number of characters of the field to return
+ *
+ *
+ * Any value less than or equal to 0 means unlimited.
+ *
+ * @param string $field_override [optional]
+ * Name of the field
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setHighlightMaxAlternateFieldLength($fieldLength, $field_override) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Specifies the number of characters into a document to look for suitable snippets
+ * @link https://php.net/manual/en/solrquery.sethighlightmaxanalyzedchars.php
+ * @param int $value
+ * The number of characters into a document to look for suitable snippets
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setHighlightMaxAnalyzedChars($value) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Whether or not to collapse contiguous fragments into a single fragment
+ * @link https://php.net/manual/en/solrquery.sethighlightmergecontiguous.php
+ * @param bool $flag
+ * Whether or not to collapse contiguous fragments into a single fragment
+ *
+ * @param string $field_override [optional]
+ * Name of the field
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setHighlightMergeContiguous($flag, $field_override) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Specify the maximum number of characters to analyze
+ * @link https://php.net/manual/en/solrquery.sethighlightregexmaxanalyzedchars.php
+ * @param int $maxAnalyzedChars
+ * The maximum number of characters to analyze from a field when using the regex fragmenter
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setHighlightRegexMaxAnalyzedChars($maxAnalyzedChars) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Specify the regular expression for fragmenting
+ * @link https://php.net/manual/en/solrquery.sethighlightregexpattern.php
+ * @param string $value
+ * The regular expression for fragmenting. This could be used to extract sentences
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setHighlightRegexPattern($value) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Sets the factor by which the regex fragmenter can stray from the ideal fragment size
+ * @link https://php.net/manual/en/solrquery.sethighlightregexslop.php
+ * @param float $factor
+ * The factor by which the regex fragmenter can stray from the ideal fragment size (specified by
+ * SolrQuery::setHighlightFragsize) to accommodate the regular expression.
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setHighlightRegexSlop($factor) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Require field matching during highlighting
+ * @link https://php.net/manual/en/solrquery.sethighlightrequirefieldmatch.php
+ * @param bool $flag
+ * If TRUE, then a field will only be highlighted if the query matched in this particular field.
+ * This will only work if SolrQuery::setHighlightUsePhraseHighlighter() was set to TRUE.
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setHighlightRequireFieldMatch($flag) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Sets the text which appears after a highlighted term
+ * @link https://php.net/manual/en/solrquery.sethighlightsimplepost.php
+ * @param string $simplePost
+ * Sets the text which appears after a highlighted term. The default is </em>
+ *
+ * @param string $field_override [optional]
+ * Name of the field
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setHighlightSimplePost($simplePost, $field_override) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Sets the text which appears before a highlighted term
+ * @link https://php.net/manual/en/solrquery.sethighlightsimplepre.php
+ * @param string $simplePre
+ * Sets the text which appears before a highlighted term. The default is <em>
+ *
+ * @param string $field_override [optional]
+ * Name of the field
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setHighlightSimplePre($simplePre, $field_override) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Sets the maximum number of highlighted snippets to generate per field
+ * @link https://php.net/manual/en/solrquery.sethighlightsnippets.php
+ * @param int $value
+ * The maximum number of highlighted snippets to generate per field
+ *
+ * @param string $field_override [optional]
+ * Name of the field
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setHighlightSnippets($value, $field_override) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Whether to highlight phrase terms only when they appear within the query phrase
+ * @link https://php.net/manual/en/solrquery.sethighlightusephrasehighlighter.php
+ * @param bool $flag
+ * Whether or not to use SpanScorer to highlight phrase terms only when they appear within the query phrase in the
+ * document.
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setHighlightUsePhraseHighlighter($flag) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Enables or disables moreLikeThis
+ * @link https://php.net/manual/en/solrquery.setmlt.php
+ * @param bool $flag
+ * TRUE enables it and FALSE turns it off.
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setMlt($flag) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Set if the query will be boosted by the interesting term relevance
+ * @link https://php.net/manual/en/solrquery.setmltboost.php
+ * @param bool $flag
+ * Sets to TRUE or FALSE
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setMltBoost($flag) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Set the number of similar documents to return for each result
+ * @link https://php.net/manual/en/solrquery.setmltcount.php
+ * @param int $count
+ * The number of similar documents to return for each result
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setMltCount($count) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Sets the maximum number of query terms included
+ * @link https://php.net/manual/en/solrquery.setmltmaxnumqueryterms.php
+ * @param int $value
+ * The maximum number of query terms that will be included in any generated query
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setMltMaxNumQueryTerms($value) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Specifies the maximum number of tokens to parse
+ * @link https://php.net/manual/en/solrquery.setmltmaxnumtokens.php
+ * @param int $value
+ * The maximum number of tokens to parse
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setMltMaxNumTokens($value) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Sets the maximum word length
+ * @link https://php.net/manual/en/solrquery.setmltmaxwordlength.php
+ * @param int $maxWordLength
+ * The maximum word length above which words will be ignored
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setMltMaxWordLength($maxWordLength) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Sets the mltMinDoc frequency
+ * @link https://php.net/manual/en/solrquery.setmltmindocfrequency.php
+ * @param int $minDocFrequency
+ * Sets the frequency at which words will be ignored which do not occur in at least this many docs.
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setMltMinDocFrequency($minDocFrequency) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Sets the frequency below which terms will be ignored in the source docs
+ * @link https://php.net/manual/en/solrquery.setmltmintermfrequency.php
+ * @param int $minTermFrequency
+ * The frequency below which terms will be ignored in the source docs
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setMltMinTermFrequency($minTermFrequency) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Sets the minimum word length
+ * @link https://php.net/manual/en/solrquery.setmltminwordlength.php
+ * @param int $minWordLength
+ * The minimum word length below which words will be ignored
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setMltMinWordLength($minWordLength) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Exclude the header from the returned results
+ * @link https://php.net/manual/en/solrquery.setomitheader.php
+ * @param bool $flag
+ * TRUE excludes the header from the result.
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setOmitHeader($flag) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Sets the search query
+ * @link https://php.net/manual/en/solrquery.setquery.php
+ * @param string $query
+ * The search query
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setQuery($query) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Specifies the maximum number of rows to return in the result
+ * @link https://php.net/manual/en/solrquery.setrows.php
+ * @param int $rows
+ * The maximum number of rows to return
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setRows($rows) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Flag to show debug information
+ * @link https://php.net/manual/en/solrquery.setshowdebuginfo.php
+ * @param bool $flag
+ * Whether to show debug info. TRUE or FALSE
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setShowDebugInfo($flag) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Specifies the number of rows to skip
+ * @link https://php.net/manual/en/solrquery.setstart.php
+ * @param int $start
+ * The number of rows to skip.
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setStart($start) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Enables or disables the Stats component
+ * @link https://php.net/manual/en/solrquery.setstats.php
+ * @param bool $flag
+ * TRUE turns on the stats component and FALSE disables it.
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setStats($flag) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Enables or disables the TermsComponent
+ * @link https://php.net/manual/en/solrquery.setterms.php
+ * @param bool $flag
+ * TRUE enables it. FALSE turns it off
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setTerms($flag) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Sets the name of the field to get the Terms from
+ * @link https://php.net/manual/en/solrquery.settermsfield.php
+ * @param string $fieldname
+ * The field name
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setTermsField($fieldname) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Include the lower bound term in the result set
+ * @link https://php.net/manual/en/solrquery.settermsincludelowerbound.php
+ * @param bool $flag
+ * Include the lower bound term in the result set
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setTermsIncludeLowerBound($flag) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Include the upper bound term in the result set
+ * @link https://php.net/manual/en/solrquery.settermsincludeupperbound.php
+ * @param bool $flag
+ * TRUE or FALSE
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setTermsIncludeUpperBound($flag) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Sets the maximum number of terms to return
+ * @link https://php.net/manual/en/solrquery.settermslimit.php
+ * @param int $limit
+ * The maximum number of terms to return. All the terms will be returned if the limit is negative.
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setTermsLimit($limit) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Specifies the Term to start from
+ * @link https://php.net/manual/en/solrquery.settermslowerbound.php
+ * @param string $lowerBound
+ * The lower bound Term
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setTermsLowerBound($lowerBound) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Sets the maximum document frequency
+ * @link https://php.net/manual/en/solrquery.settermsmaxcount.php
+ * @param int $frequency
+ * The maximum document frequency.
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setTermsMaxCount($frequency) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Sets the minimum document frequency
+ * @link https://php.net/manual/en/solrquery.settermsmincount.php
+ * @param int $frequency
+ * The minimum frequency
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setTermsMinCount($frequency) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Restrict matches to terms that start with the prefix
+ * @link https://php.net/manual/en/solrquery.settermsprefix.php
+ * @param string $prefix
+ * Restrict matches to terms that start with the prefix
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setTermsPrefix($prefix) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Return the raw characters of the indexed term
+ * @link https://php.net/manual/en/solrquery.settermsreturnraw.php
+ * @param bool $flag
+ * TRUE or FALSE
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setTermsReturnRaw($flag) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Specifies how to sort the returned terms
+ * @link https://php.net/manual/en/solrquery.settermssort.php
+ * @param int $sortType
+ * If SolrQuery::TERMS_SORT_COUNT, sorts the terms by the term frequency (highest count first).
+ * If SolrQuery::TERMS_SORT_INDEX, returns the terms in index order
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setTermsSort($sortType) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Sets the term to stop at
+ * @link https://php.net/manual/en/solrquery.settermsupperbound.php
+ * @param string $upperBound
+ * The term to stop at
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setTermsUpperBound($upperBound) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * The time allowed for search to finish
+ * @link https://php.net/manual/en/solrquery.settimeallowed.php
+ * @param int $timeAllowed
+ * The time allowed for a search to finish. This value only applies to the search and not to requests in general.
+ * Time is in milliseconds. Values less than or equal to zero implies no time restriction. Partial results may be
+ * returned, if there are any.
+ *
+ * @return SolrQuery
+ * Returns the current SolrQuery object, if the return value is used.
+ *
+ */
+ public function setTimeAllowed($timeAllowed) {}
}
diff --git a/solr/Responses/SolrGenericResponse.php b/solr/Responses/SolrGenericResponse.php
index 1e3f1e381..dc09673a4 100644
--- a/solr/Responses/SolrGenericResponse.php
+++ b/solr/Responses/SolrGenericResponse.php
@@ -12,20 +12,19 @@
* This class represents a response from the solr server.
* @link https://php.net/manual/en/class.solrgenericresponse.php
*/
-final class SolrGenericResponse extends SolrResponse {
-
- /**
- * (PECL solr >= 0.9.2)
- * SolrGenericResponse constructor.
- * @link https://php.net/manual/en/solrgenericresponse.construct.php
- */
- public function __construct() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Destructor
- * @link https://php.net/manual/en/solrgenericresponse.destruct.php
- */
- public function __destruct() {}
+final class SolrGenericResponse extends SolrResponse
+{
+ /**
+ * (PECL solr >= 0.9.2)
+ * SolrGenericResponse constructor.
+ * @link https://php.net/manual/en/solrgenericresponse.construct.php
+ */
+ public function __construct() {}
+ /**
+ * (PECL solr >= 0.9.2)
+ * Destructor
+ * @link https://php.net/manual/en/solrgenericresponse.destruct.php
+ */
+ public function __destruct() {}
}
diff --git a/solr/Responses/SolrPingResponse.php b/solr/Responses/SolrPingResponse.php
index 6204ae3f2..72ce7d5d5 100644
--- a/solr/Responses/SolrPingResponse.php
+++ b/solr/Responses/SolrPingResponse.php
@@ -12,31 +12,30 @@
* This class represents a response to a ping request to the server
* @link https://php.net/manual/en/class.solrpingresponse.php
*/
-final class SolrPingResponse extends SolrResponse {
+final class SolrPingResponse extends SolrResponse
+{
+ /**
+ * (PECL solr >= 0.9.2)
+ * SolrPingResponse constructor.
+ * @link https://php.net/manual/en/solrpingresponse.construct.php
+ */
+ public function __construct() {}
- /**
- * (PECL solr >= 0.9.2)
- * SolrPingResponse constructor.
- * @link https://php.net/manual/en/solrpingresponse.construct.php
- */
- public function __construct() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Destructor
- * @link https://php.net/manual/en/solrpingresponse.destruct.php
- */
- public function __destruct() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the response from the server
- * @link https://php.net/manual/en/solrpingresponse.getresponse.php
- * @return string
- * Returns an empty string. (Returns the response from the server. This should be empty because the request as a
- * HEAD request.)
- *
- */
- public function getResponse() {}
+ /**
+ * (PECL solr >= 0.9.2)
+ * Destructor
+ * @link https://php.net/manual/en/solrpingresponse.destruct.php
+ */
+ public function __destruct() {}
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the response from the server
+ * @link https://php.net/manual/en/solrpingresponse.getresponse.php
+ * @return string
+ * Returns an empty string. (Returns the response from the server. This should be empty because the request as a
+ * HEAD request.)
+ *
+ */
+ public function getResponse() {}
}
diff --git a/solr/Responses/SolrQueryResponse.php b/solr/Responses/SolrQueryResponse.php
index 85c1a9563..ba666bf44 100644
--- a/solr/Responses/SolrQueryResponse.php
+++ b/solr/Responses/SolrQueryResponse.php
@@ -12,20 +12,19 @@
* This class represents a response to a query request.
* @link https://php.net/manual/en/class.solrqueryresponse.php
*/
-final class SolrQueryResponse extends SolrResponse {
-
- /**
- * (PECL solr >= 0.9.2)
- * SolrQueryResponse constructor.
- * @link https://php.net/manual/en/solrqueryresponse.construct.php
- */
- public function __construct() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Destructor
- * @link https://php.net/manual/en/solrqueryresponse.destruct.php
- */
- public function __destruct() {}
+final class SolrQueryResponse extends SolrResponse
+{
+ /**
+ * (PECL solr >= 0.9.2)
+ * SolrQueryResponse constructor.
+ * @link https://php.net/manual/en/solrqueryresponse.construct.php
+ */
+ public function __construct() {}
+ /**
+ * (PECL solr >= 0.9.2)
+ * Destructor
+ * @link https://php.net/manual/en/solrqueryresponse.destruct.php
+ */
+ public function __destruct() {}
}
diff --git a/solr/Responses/SolrResponse.php b/solr/Responses/SolrResponse.php
index 7e632f0ce..f76b3dcd7 100644
--- a/solr/Responses/SolrResponse.php
+++ b/solr/Responses/SolrResponse.php
@@ -12,156 +12,155 @@
* This class represents a response from the Solr server.
* @link https://php.net/manual/en/class.solrresponse.php
*/
-abstract class SolrResponse {
-
- /** @var int Documents should be parsed as SolrObject instances */
- const PARSE_SOLR_OBJ = 0;
-
- /** @var int Documents should be parsed as SolrDocument instances. */
- const PARSE_SOLR_DOC = 1;
-
- /** @var int The http status of the response. */
- protected $http_status;
-
- /** @var int Whether to parse the solr documents as SolrObject or SolrDocument instances. */
- protected $parser_mode;
-
- /** @var bool Was there an error during the request */
- protected $success;
-
- /** @var string Detailed message on http status */
- protected $http_status_message;
-
- /** @var string The request URL */
- protected $http_request_url;
-
- /** @var string A string of raw headers sent during the request. */
- protected $http_raw_request_headers;
-
- /** @var string The raw request sent to the server */
- protected $http_raw_request;
-
- /** @var string Response headers from the Solr server. */
- protected $http_raw_response_headers;
-
- /** @var string The response message from the server. */
- protected $http_raw_response;
-
- /** @var string The response in PHP serialized format. */
- protected $http_digested_response;
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the XML response as serialized PHP data
- * @link https://php.net/manual/en/solrresponse.getdigestedresponse.php
- * @return string
- * Returns the XML response as serialized PHP data
- *
- */
- public function getDigestedResponse() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the HTTP status of the response
- * @link https://php.net/manual/en/solrresponse.gethttpstatus.php
- * @return int
- * Returns the HTTP status of the response.
- *
- */
- public function getHttpStatus() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns more details on the HTTP status
- * @link https://php.net/manual/en/solrresponse.gethttpstatusmessage.php
- * @return string
- * Returns more details on the HTTP status
- *
- */
- public function getHttpStatusMessage () {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the raw request sent to the Solr server
- * @link https://php.net/manual/en/solrresponse.getrawrequest.php
- * @return string
- * Returns the raw request sent to the Solr server
- *
- */
- public function getRawRequest () {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the raw request headers sent to the Solr server
- * @link https://php.net/manual/en/solrresponse.getrawrequestheaders.php
- * @return string
- * Returns the raw request headers sent to the Solr server
- *
- */
- public function getRawRequestHeaders () {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the raw response from the server
- * @link https://php.net/manual/en/solrresponse.getrawresponse.php
- * @return string
- * Returns the raw response from the server.
- *
- */
- public function getRawResponse () {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the raw response headers from the server
- * @link https://php.net/manual/en/solrresponse.getrawresponseheaders.php
- * @return string
- * Returns the raw response headers from the server.
- *
- */
- public function getRawResponseHeaders () {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the full URL the request was sent to
- * @link https://php.net/manual/en/solrresponse.getrequesturl.php
- * @return string
- * Returns the full URL the request was sent to
- *
- */
- public function getRequestUrl () {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns a SolrObject representing the XML response from the server
- * @link https://php.net/manual/en/solrresponse.getresponse.php
- * @return SolrObject
- * Returns a SolrObject representing the XML response from the server
- *
- */
- public function getResponse () {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Sets the parse mode
- * @link https://php.net/manual/en/solrresponse.setparsemode.php
- * @param int $parser_mode
- * - SolrResponse::PARSE_SOLR_DOC parses documents in SolrDocument instances.
- * - SolrResponse::PARSE_SOLR_OBJ parses document into SolrObjects.
- *
- * @return bool
- * Returns TRUE on success or FALSE on failure.
- *
- */
- public function setParseMode ($parser_mode = 0) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Was the request a success
- * @link https://php.net/manual/en/solrresponse.success.php
- * @return bool
- * Returns TRUE if it was successful and FALSE if it was not.
- *
- */
- public function success () {}
-
+abstract class SolrResponse
+{
+ /** @var int Documents should be parsed as SolrObject instances */
+ public const PARSE_SOLR_OBJ = 0;
+
+ /** @var int Documents should be parsed as SolrDocument instances. */
+ public const PARSE_SOLR_DOC = 1;
+
+ /** @var int The http status of the response. */
+ protected $http_status;
+
+ /** @var int Whether to parse the solr documents as SolrObject or SolrDocument instances. */
+ protected $parser_mode;
+
+ /** @var bool Was there an error during the request */
+ protected $success;
+
+ /** @var string Detailed message on http status */
+ protected $http_status_message;
+
+ /** @var string The request URL */
+ protected $http_request_url;
+
+ /** @var string A string of raw headers sent during the request. */
+ protected $http_raw_request_headers;
+
+ /** @var string The raw request sent to the server */
+ protected $http_raw_request;
+
+ /** @var string Response headers from the Solr server. */
+ protected $http_raw_response_headers;
+
+ /** @var string The response message from the server. */
+ protected $http_raw_response;
+
+ /** @var string The response in PHP serialized format. */
+ protected $http_digested_response;
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the XML response as serialized PHP data
+ * @link https://php.net/manual/en/solrresponse.getdigestedresponse.php
+ * @return string
+ * Returns the XML response as serialized PHP data
+ *
+ */
+ public function getDigestedResponse() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the HTTP status of the response
+ * @link https://php.net/manual/en/solrresponse.gethttpstatus.php
+ * @return int
+ * Returns the HTTP status of the response.
+ *
+ */
+ public function getHttpStatus() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns more details on the HTTP status
+ * @link https://php.net/manual/en/solrresponse.gethttpstatusmessage.php
+ * @return string
+ * Returns more details on the HTTP status
+ *
+ */
+ public function getHttpStatusMessage() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the raw request sent to the Solr server
+ * @link https://php.net/manual/en/solrresponse.getrawrequest.php
+ * @return string
+ * Returns the raw request sent to the Solr server
+ *
+ */
+ public function getRawRequest() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the raw request headers sent to the Solr server
+ * @link https://php.net/manual/en/solrresponse.getrawrequestheaders.php
+ * @return string
+ * Returns the raw request headers sent to the Solr server
+ *
+ */
+ public function getRawRequestHeaders() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the raw response from the server
+ * @link https://php.net/manual/en/solrresponse.getrawresponse.php
+ * @return string
+ * Returns the raw response from the server.
+ *
+ */
+ public function getRawResponse() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the raw response headers from the server
+ * @link https://php.net/manual/en/solrresponse.getrawresponseheaders.php
+ * @return string
+ * Returns the raw response headers from the server.
+ *
+ */
+ public function getRawResponseHeaders() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the full URL the request was sent to
+ * @link https://php.net/manual/en/solrresponse.getrequesturl.php
+ * @return string
+ * Returns the full URL the request was sent to
+ *
+ */
+ public function getRequestUrl() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns a SolrObject representing the XML response from the server
+ * @link https://php.net/manual/en/solrresponse.getresponse.php
+ * @return SolrObject
+ * Returns a SolrObject representing the XML response from the server
+ *
+ */
+ public function getResponse() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Sets the parse mode
+ * @link https://php.net/manual/en/solrresponse.setparsemode.php
+ * @param int $parser_mode
+ * - SolrResponse::PARSE_SOLR_DOC parses documents in SolrDocument instances.
+ * - SolrResponse::PARSE_SOLR_OBJ parses document into SolrObjects.
+ *
+ * @return bool
+ * Returns TRUE on success or FALSE on failure.
+ *
+ */
+ public function setParseMode($parser_mode = 0) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Was the request a success
+ * @link https://php.net/manual/en/solrresponse.success.php
+ * @return bool
+ * Returns TRUE if it was successful and FALSE if it was not.
+ *
+ */
+ public function success() {}
}
diff --git a/solr/Responses/SolrUpdateResponse.php b/solr/Responses/SolrUpdateResponse.php
index 9c5e53d99..3c81f67f2 100644
--- a/solr/Responses/SolrUpdateResponse.php
+++ b/solr/Responses/SolrUpdateResponse.php
@@ -12,20 +12,19 @@
* This class represents a response to an update request.
* @link https://php.net/manual/en/class.solrupdateresponse.php
*/
-final class SolrUpdateResponse extends SolrResponse {
-
- /**
- * (PECL solr >= 0.9.2)
- * SolrUpdateResponse constructor.
- * @link https://php.net/manual/en/solrupdateresponse.construct.php
- */
- public function __construct() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Destructor
- * @link https://php.net/manual/en/solrupdateresponse.destruct.php
- */
- public function __destruct() {}
+final class SolrUpdateResponse extends SolrResponse
+{
+ /**
+ * (PECL solr >= 0.9.2)
+ * SolrUpdateResponse constructor.
+ * @link https://php.net/manual/en/solrupdateresponse.construct.php
+ */
+ public function __construct() {}
+ /**
+ * (PECL solr >= 0.9.2)
+ * Destructor
+ * @link https://php.net/manual/en/solrupdateresponse.destruct.php
+ */
+ public function __destruct() {}
}
diff --git a/solr/SolrClient.php b/solr/SolrClient.php
index 0a4dd60c3..99a1f725a 100644
--- a/solr/SolrClient.php
+++ b/solr/SolrClient.php
@@ -13,486 +13,485 @@
* not supported.
* @link https://php.net/manual/en/class.solrclient.php
*/
-final class SolrClient {
-
- /** @var int Used when updating the search servlet. */
- const SEARCH_SERVLET_TYPE = 1;
-
- /** @var int Used when updating the update servlet. */
- const UPDATE_SERVLET_TYPE = 2;
-
- /** @var int Used when updating the threads servlet. */
- const THREADS_SERVLET_TYPE = 4;
-
- /** @var int Used when updating the ping servlet. */
- const PING_SERVLET_TYPE = 8;
-
- /** @var int Used when updating the terms servlet. */
- const TERMS_SERVLET_TYPE = 16;
-
- /** @var int Used when retrieving system information from the system servlet. */
- const SYSTEM_SERVLET_TYPE = 32;
-
- /** @var string This is the initial value for the search servlet. */
- const DEFAULT_SEARCH_SERVLET = 'select';
-
- /** @var string This is the initial value for the update servlet. */
- const DEFAULT_UPDATE_SERVLET = 'update';
-
- /** @var string This is the initial value for the threads servlet. */
- const DEFAULT_THREADS_SERVLET = 'admin/threads';
-
- /** @var string This is the initial value for the ping servlet. */
- const DEFAULT_PING_SERVLET = 'admin/ping';
-
- /** @var string This is the initial value for the terms servlet used for the TermsComponent. */
- const DEFAULT_TERMS_SERVLET = 'terms';
-
- /** @var string This is the initial value for the system servlet used to obtain Solr Server information. */
- const DEFAULT_SYSTEM_SERVLET = 'admin/system';
-
- /**
- * (PECL solr >= 0.9.2)
- * Adds a document to the index
- * @link https://php.net/manual/en/solrclient.adddocument.php
- * @param SolrInputDocument $doc
- * The SolrInputDocument instance.
- *
- * @param bool $overwrite [optional]
- * Whether to overwrite existing document or not. If FALSE there will be duplicates (several documents with
- * the same ID).
- *
- *
- * Warning
- * PECL Solr < 2.0 $allowDups was used instead of $overwrite, which does the same functionality with exact opposite
- * bool flag.
- *
- * $allowDups = false is the same as $overwrite = true
- *
- * @param int $commitWithin [optional]
- * Number of milliseconds within which to auto commit this document. Available since Solr 1.4 . Default (0) means
- * disabled.
- *
- *
- * When this value specified, it leaves the control of when to do the commit to Solr itself, optimizing number of
- * commits to a minimum while still fulfilling the update latency requirements, and Solr will automatically do a
- * commit when the oldest add in the buffer is due.
- *
- * @return SolrUpdateResponse
- * Returns a SolrUpdateResponse object or throws an Exception on failure.
- *
- * @throws SolrClientException
- * Throws SolrClientException if the client had failed, or there was a connection issue.
- *
- * @throws SolrServerException
- * Throws SolrServerException if the Solr Server had failed to satisfy the request.
- *
- */
- public function addDocument(SolrInputDocument $doc, $overwrite = true, $commitWithin = 0) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Adds a collection of SolrInputDocument instances to the index
- * @link https://php.net/manual/en/solrclient.adddocuments.php
- * @param array $docs
- * An array containing the collection of SolrInputDocument instances. This array must be an actual variable.
- *
- * @param bool $overwrite [optional]
- * Whether to overwrite existing document or not. If FALSE there will be duplicates (several documents with
- * the same ID).
- *
- *
- * Warning
- * PECL Solr < 2.0 $allowDups was used instead of $overwrite, which does the same functionality with exact opposite
- * bool flag.
- *
- * $allowDups = false is the same as $overwrite = true
- *
- * @param int $commitWithin [optional]
- * Number of milliseconds within which to auto commit this document. Available since Solr 1.4 . Default (0) means
- * disabled.
- *
- *
- * When this value specified, it leaves the control of when to do the commit to Solr itself, optimizing number of
- * commits to a minimum while still fulfilling the update latency requirements, and Solr will automatically do a
- * commit when the oldest add in the buffer is due.
- *
- * @return SolrUpdateResponse
- * Returns a SolrUpdateResponse object or throws an Exception on failure.
- *
- * @throws SolrClientException
- * Throws SolrClientException if the client had failed, or there was a connection issue.
- *
- * @throws SolrServerException
- * Throws SolrServerException if the Solr Server had failed to satisfy the request.
- *
- */
- public function addDocuments(array $docs, $overwrite = true, $commitWithin = 0) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Finalizes all add/deletes made to the index
- * @link https://php.net/manual/en/solrclient.commit.php
- * @param bool $softCommit [optional]
- * This will refresh the 'view' of the index in a more performant manner, but without "on-disk" guarantees.
- * (Solr4.0+)
- *
- *
- * A soft commit is much faster since it only makes index changes visible and does not fsync index files or write a
- * new index descriptor. If the JVM crashes or there is a loss of power, changes that occurred after the last hard
- * commit will be lost. Search collections that have near-real-time requirements (that want index changes to be
- * quickly visible to searches) will want to soft commit often but hard commit less frequently.
- *
- * @param bool $waitSearcher [optional]
- * block until a new searcher is opened and registered as the main query searcher, making the changes visible.
- *
- * @param bool $expungeDeletes [optional]
- * Merge segments with deletes away. (Solr1.4+)
- *
- * @return SolrUpdateResponse
- * Returns a SolrUpdateResponse object or throws an Exception on failure.
- *
- * @throws SolrClientException
- * Throws SolrClientException if the client had failed, or there was a connection issue.
- *
- * @throws SolrServerException
- * Throws SolrServerException if the Solr Server had failed to satisfy the request.
- *
- */
- public function commit($softCommit = false, $waitSearcher = true, $expungeDeletes = false) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * SolrClient constructor.
- * @link https://php.net/manual/en/solrclient.construct.php
- * @param array $clientOptions
- * This is an array containing one of the following keys :
- *
- *
- * - secure: (Boolean value indicating whether or not to connect in secure mode)
- * - hostname: (The hostname for the Solr server)
- * - port: (The port number)
- * - path: (The path to solr)
- * - wt: (The name of the response writer e.g. xml, json)
- * - login: (The username used for HTTP Authentication, if any)
- * - password: (The HTTP Authentication password)
- * - proxy_host: (The hostname for the proxy server, if any)
- * - proxy_port: (The proxy port)
- * - proxy_login: (The proxy username)
- * - proxy_password: (The proxy password)
- * - timeout: (This is maximum time in seconds allowed for the http data transfer operation. Default is 30
- * seconds)
- * - ssl_cert: (File name to a PEM-formatted file containing the private key + private certificate
- * (concatenated in that order) )
- * - ssl_key: (File name to a PEM-formatted private key file only)
- * - ssl_keypassword: (Password for private key)
- * - ssl_cainfo: (Name of file holding one or more CA certificates to verify peer with)
- * - ssl_capath: (Name of directory holding multiple CA certificates to verify peer with )
- *
- *
- * Please note the if the ssl_cert file only contains the private certificate, you have to specify a separate
- * ssl_key file.
- *
- *
- * The ssl_keypassword option is required if the ssl_cert or ssl_key options are set.
- *
- * @throws SolrIllegalArgumentException
- */
- public function __construct (array $clientOptions) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Delete by Id
- * @link https://php.net/manual/en/solrclient.deletebyid.php
- * @param string $id
- * The value of the uniqueKey field declared in the schema
- *
- * @return SolrUpdateResponse
- * Returns a SolrUpdateResponse on success and throws an exception on failure.
- *
- * @throws SolrClientException
- * Throws SolrClientException if the client had failed, or there was a connection issue.
- *
- * @throws SolrServerException
- * Throws SolrServerException if the Solr Server had failed to satisfy the request.
- *
- */
- public function deleteById($id) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Deletes by Ids
- * @link https://php.net/manual/en/solrclient.deletebyids.php
- * @param array $ids
- * An array of IDs representing the uniqueKey field declared in the schema for each document to be deleted. This
- * must be an actual php variable.
- *
- * @return SolrUpdateResponse
- * Returns a SolrUpdateResponse on success and throws an exception on failure.
- *
- * @throws SolrClientException
- * Throws SolrClientException if the client had failed, or there was a connection issue.
- *
- * @throws SolrServerException
- * Throws SolrServerException if the Solr Server had failed to satisfy the request.
- *
- */
- public function deleteByIds(array $ids) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Removes all documents matching any of the queries
- * @link https://php.net/manual/en/solrclient.deletebyqueries.php
- * @param array $queries
- * The array of queries. This must be an actual php variable.
- *
- * @return SolrUpdateResponse
- * Returns a SolrUpdateResponse on success and throws an exception on failure.
- *
- * @throws SolrClientException
- * Throws SolrClientException if the client had failed, or there was a connection issue.
- *
- * @throws SolrServerException
- * Throws SolrServerException if the Solr Server had failed to satisfy the request.
- *
- */
- public function deleteByQueries(array $queries) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Deletes all documents matching the given query
- * @link https://php.net/manual/en/solrclient.deletebyquery.php
- * @param string $query
- * The query
- *
- * @return SolrUpdateResponse
- * Returns a SolrUpdateResponse on success and throws an exception on failure.
- *
- * @throws SolrClientException
- * Throws SolrClientException if the client had failed, or there was a connection issue.
- *
- * @throws SolrServerException
- * Throws SolrServerException if the Solr Server had failed to satisfy the request.
- *
- */
- public function deleteByQuery($query) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Destructor for SolrClient
- * @link https://php.net/manual/en/solrclient.destruct.php
- */
- public function __destruct() {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Get Document By Id. Utilizes Solr Realtime Get (RTG).
- * @link https://php.net/manual/en/solrclient.getbyid.php
- * @param string $id
- * Document ID
- *
- * @return SolrQueryResponse
- */
- public function getById ($id) {}
-
- /**
- * (PECL solr >= 2.2.0)
- * Get Documents by their Ids. Utilizes Solr Realtime Get (RTG).
- * @link https://php.net/manual/en/solrclient.getbyids.php
- * @param array $ids
- * Document ids
- *
- * @return SolrQueryResponse
- */
- public function getByIds(array $ids) {}
-
- /**
- * (PECL solr >= 0.9.7)
- * Returns the debug data for the last connection attempt
- * @link https://php.net/manual/en/solrclient.getdebug.php
- * @return string
- * Returns a string on success and null if there is nothing to return.
- *
- */
- public function getDebug () {}
-
- /**
- * (PECL solr >= 0.9.6)
- * Returns the client options set internally
- * @link https://php.net/manual/en/solrclient.getoptions.php
- * @return array
- * Returns an array containing all the options for the SolrClient object set internally.
- *
- */
- public function getOptions() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Defragments the index
- * @link https://php.net/manual/en/solrclient.optimize.php
- * @param int $maxSegments
- * Optimizes down to at most this number of segments. Since Solr 1.3
- *
- * @param bool $softCommit
- * This will refresh the 'view' of the index in a more performant manner, but without "on-disk" guarantees.
- * (Solr4.0+)
- *
- * @param bool $waitSearcher
- * Block until a new searcher is opened and registered as the main query searcher, making the changes visible.
- *
- * @return SolrUpdateResponse
- * Returns a SolrUpdateResponse on success and throws an exception on failure.
- *
- * @throws SolrClientException
- * Throws SolrClientException if the client had failed, or there was a connection issue.
- *
- * @throws SolrServerException
- * Throws SolrServerException if the Solr Server had failed to satisfy the request.
- *
- */
- public function optimize($maxSegments = 1, $softCommit = true, $waitSearcher = true) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Checks if Solr server is still up
- * @link https://php.net/manual/en/solrclient.ping.php
- * @return SolrPingResponse
- * Returns a SolrPingResponse object on success and throws an exception on failure.
- *
- * @throws SolrClientException
- * Throws SolrClientException if the client had failed, or there was a connection issue.
- *
- * @throws SolrServerException
- * Throws SolrServerException if the Solr Server had failed to satisfy the request.
- *
- */
- public function ping() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Sends a query to the server
- * @link https://php.net/manual/en/solrclient.query.php
- * @param SolrParams $query
- * A SolrParams object. It is recommended to use SolrQuery for advanced queries.
- *
- * @return SolrQueryResponse
- * Returns a SolrUpdateResponse on success and throws an exception on failure.
- *
- * @throws SolrClientException
- * Throws SolrClientException if the client had failed, or there was a connection issue.
- *
- * @throws SolrServerException
- * Throws SolrServerException if the Solr Server had failed to satisfy the request.
- *
- */
- public function query(SolrParams $query) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Sends a raw update request
- * @link https://php.net/manual/en/solrclient.request.php
- * @param string $raw_request
- * An XML string with the raw request to the server.
- *
- * @return SolrUpdateResponse
- * Returns a SolrUpdateResponse on success and throws an exception on failure.
- *
- * @throws SolrIllegalArgumentException
- * Throws SolrIllegalArgumentException if raw_request was an empty string.
- *
- * @throws SolrClientException
- * Throws SolrClientException if the client had failed, or there was a connection issue.
- *
- * @throws SolrServerException
- * Throws SolrServerException if the Solr Server had failed to satisfy the request.
- *
- */
- public function request($raw_request) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Rollbacks all add/deletes made to the index since the last commit
- * @link https://php.net/manual/en/solrclient.rollback.php
- * @return SolrUpdateResponse
- * Returns a SolrUpdateResponse on success and throws an exception on failure.
- *
- * @throws SolrClientException
- * Throws SolrClientException if the client had failed, or there was a connection issue.
- *
- * @throws SolrServerException
- * Throws SolrServerException if the Solr Server had failed to satisfy the request.
- *
- */
- public function rollback() {}
-
- /**
- * (PECL solr >= 0.9.11)
- * Sets the response writer used to prepare the response from Solr
- * @link https://php.net/manual/en/solrclient.setresponsewriter.php
- * @param string $responseWriter
- * One of the following:
- *
- *
- * - json
- * - phps
- * - xml
- *
- */
- public function setResponseWriter($responseWriter) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Changes the specified servlet type to a new value
- * @link https://php.net/manual/en/solrclient.setservlet.php
- * @param int $type
- * One of the following :
- *
- *
- * - SolrClient::SEARCH_SERVLET_TYPE
- * - SolrClient::UPDATE_SERVLET_TYPE
- * - SolrClient::THREADS_SERVLET_TYPE
- * - SolrClient::PING_SERVLET_TYPE
- * - SolrClient::TERMS_SERVLET_TYPE
- *
- * @param string $value
- * The new value for the servlet
- *
- * @return bool
- * Returns TRUE on success or FALSE on failure.
- *
- */
- public function setServlet($type, $value) {}
-
- /**
- * (PECL solr >= 2.0.0)
- * Retrieve Solr Server information
- * @link https://php.net/manual/en/solrclient.system.php
- * @return SolrGenericResponse
- * Returns a SolrGenericResponse object on success.
- *
- * @throws SolrClientException
- * Throws SolrClientException if the client had failed, or there was a connection issue.
- *
- * @throws SolrServerException
- * Throws SolrServerException if the Solr Server had failed to satisfy the request.
- *
- */
- public function system() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Checks the threads status
- * @link https://php.net/manual/en/solrclient.threads.php
- * @return SolrGenericResponse
- * Returns a SolrGenericResponse object on success.
- *
- * @throws SolrClientException
- * Throws SolrClientException if the client had failed, or there was a connection issue.
- *
- * @throws SolrServerException
- * Throws SolrServerException if the Solr Server had failed to satisfy the request.
- *
- */
- public function threads() {}
-
+final class SolrClient
+{
+ /** @var int Used when updating the search servlet. */
+ public const SEARCH_SERVLET_TYPE = 1;
+
+ /** @var int Used when updating the update servlet. */
+ public const UPDATE_SERVLET_TYPE = 2;
+
+ /** @var int Used when updating the threads servlet. */
+ public const THREADS_SERVLET_TYPE = 4;
+
+ /** @var int Used when updating the ping servlet. */
+ public const PING_SERVLET_TYPE = 8;
+
+ /** @var int Used when updating the terms servlet. */
+ public const TERMS_SERVLET_TYPE = 16;
+
+ /** @var int Used when retrieving system information from the system servlet. */
+ public const SYSTEM_SERVLET_TYPE = 32;
+
+ /** @var string This is the initial value for the search servlet. */
+ public const DEFAULT_SEARCH_SERVLET = 'select';
+
+ /** @var string This is the initial value for the update servlet. */
+ public const DEFAULT_UPDATE_SERVLET = 'update';
+
+ /** @var string This is the initial value for the threads servlet. */
+ public const DEFAULT_THREADS_SERVLET = 'admin/threads';
+
+ /** @var string This is the initial value for the ping servlet. */
+ public const DEFAULT_PING_SERVLET = 'admin/ping';
+
+ /** @var string This is the initial value for the terms servlet used for the TermsComponent. */
+ public const DEFAULT_TERMS_SERVLET = 'terms';
+
+ /** @var string This is the initial value for the system servlet used to obtain Solr Server information. */
+ public const DEFAULT_SYSTEM_SERVLET = 'admin/system';
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Adds a document to the index
+ * @link https://php.net/manual/en/solrclient.adddocument.php
+ * @param SolrInputDocument $doc
+ * The SolrInputDocument instance.
+ *
+ * @param bool $overwrite [optional]
+ * Whether to overwrite existing document or not. If FALSE there will be duplicates (several documents with
+ * the same ID).
+ *
+ *
+ * Warning
+ * PECL Solr < 2.0 $allowDups was used instead of $overwrite, which does the same functionality with exact opposite
+ * bool flag.
+ *
+ * $allowDups = false is the same as $overwrite = true
+ *
+ * @param int $commitWithin [optional]
+ * Number of milliseconds within which to auto commit this document. Available since Solr 1.4 . Default (0) means
+ * disabled.
+ *
+ *
+ * When this value specified, it leaves the control of when to do the commit to Solr itself, optimizing number of
+ * commits to a minimum while still fulfilling the update latency requirements, and Solr will automatically do a
+ * commit when the oldest add in the buffer is due.
+ *
+ * @return SolrUpdateResponse
+ * Returns a SolrUpdateResponse object or throws an Exception on failure.
+ *
+ * @throws SolrClientException
+ * Throws SolrClientException if the client had failed, or there was a connection issue.
+ *
+ * @throws SolrServerException
+ * Throws SolrServerException if the Solr Server had failed to satisfy the request.
+ *
+ */
+ public function addDocument(SolrInputDocument $doc, $overwrite = true, $commitWithin = 0) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Adds a collection of SolrInputDocument instances to the index
+ * @link https://php.net/manual/en/solrclient.adddocuments.php
+ * @param array $docs
+ * An array containing the collection of SolrInputDocument instances. This array must be an actual variable.
+ *
+ * @param bool $overwrite [optional]
+ * Whether to overwrite existing document or not. If FALSE there will be duplicates (several documents with
+ * the same ID).
+ *
+ *
+ * Warning
+ * PECL Solr < 2.0 $allowDups was used instead of $overwrite, which does the same functionality with exact opposite
+ * bool flag.
+ *
+ * $allowDups = false is the same as $overwrite = true
+ *
+ * @param int $commitWithin [optional]
+ * Number of milliseconds within which to auto commit this document. Available since Solr 1.4 . Default (0) means
+ * disabled.
+ *
+ *
+ * When this value specified, it leaves the control of when to do the commit to Solr itself, optimizing number of
+ * commits to a minimum while still fulfilling the update latency requirements, and Solr will automatically do a
+ * commit when the oldest add in the buffer is due.
+ *
+ * @return SolrUpdateResponse
+ * Returns a SolrUpdateResponse object or throws an Exception on failure.
+ *
+ * @throws SolrClientException
+ * Throws SolrClientException if the client had failed, or there was a connection issue.
+ *
+ * @throws SolrServerException
+ * Throws SolrServerException if the Solr Server had failed to satisfy the request.
+ *
+ */
+ public function addDocuments(array $docs, $overwrite = true, $commitWithin = 0) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Finalizes all add/deletes made to the index
+ * @link https://php.net/manual/en/solrclient.commit.php
+ * @param bool $softCommit [optional]
+ * This will refresh the 'view' of the index in a more performant manner, but without "on-disk" guarantees.
+ * (Solr4.0+)
+ *
+ *
+ * A soft commit is much faster since it only makes index changes visible and does not fsync index files or write a
+ * new index descriptor. If the JVM crashes or there is a loss of power, changes that occurred after the last hard
+ * commit will be lost. Search collections that have near-real-time requirements (that want index changes to be
+ * quickly visible to searches) will want to soft commit often but hard commit less frequently.
+ *
+ * @param bool $waitSearcher [optional]
+ * block until a new searcher is opened and registered as the main query searcher, making the changes visible.
+ *
+ * @param bool $expungeDeletes [optional]
+ * Merge segments with deletes away. (Solr1.4+)
+ *
+ * @return SolrUpdateResponse
+ * Returns a SolrUpdateResponse object or throws an Exception on failure.
+ *
+ * @throws SolrClientException
+ * Throws SolrClientException if the client had failed, or there was a connection issue.
+ *
+ * @throws SolrServerException
+ * Throws SolrServerException if the Solr Server had failed to satisfy the request.
+ *
+ */
+ public function commit($softCommit = false, $waitSearcher = true, $expungeDeletes = false) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * SolrClient constructor.
+ * @link https://php.net/manual/en/solrclient.construct.php
+ * @param array $clientOptions
+ * This is an array containing one of the following keys :
+ *
+ *
+ * - secure: (Boolean value indicating whether or not to connect in secure mode)
+ * - hostname: (The hostname for the Solr server)
+ * - port: (The port number)
+ * - path: (The path to solr)
+ * - wt: (The name of the response writer e.g. xml, json)
+ * - login: (The username used for HTTP Authentication, if any)
+ * - password: (The HTTP Authentication password)
+ * - proxy_host: (The hostname for the proxy server, if any)
+ * - proxy_port: (The proxy port)
+ * - proxy_login: (The proxy username)
+ * - proxy_password: (The proxy password)
+ * - timeout: (This is maximum time in seconds allowed for the http data transfer operation. Default is 30
+ * seconds)
+ * - ssl_cert: (File name to a PEM-formatted file containing the private key + private certificate
+ * (concatenated in that order) )
+ * - ssl_key: (File name to a PEM-formatted private key file only)
+ * - ssl_keypassword: (Password for private key)
+ * - ssl_cainfo: (Name of file holding one or more CA certificates to verify peer with)
+ * - ssl_capath: (Name of directory holding multiple CA certificates to verify peer with )
+ *
+ *
+ * Please note the if the ssl_cert file only contains the private certificate, you have to specify a separate
+ * ssl_key file.
+ *
+ *
+ * The ssl_keypassword option is required if the ssl_cert or ssl_key options are set.
+ *
+ * @throws SolrIllegalArgumentException
+ */
+ public function __construct(array $clientOptions) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Delete by Id
+ * @link https://php.net/manual/en/solrclient.deletebyid.php
+ * @param string $id
+ * The value of the uniqueKey field declared in the schema
+ *
+ * @return SolrUpdateResponse
+ * Returns a SolrUpdateResponse on success and throws an exception on failure.
+ *
+ * @throws SolrClientException
+ * Throws SolrClientException if the client had failed, or there was a connection issue.
+ *
+ * @throws SolrServerException
+ * Throws SolrServerException if the Solr Server had failed to satisfy the request.
+ *
+ */
+ public function deleteById($id) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Deletes by Ids
+ * @link https://php.net/manual/en/solrclient.deletebyids.php
+ * @param array $ids
+ * An array of IDs representing the uniqueKey field declared in the schema for each document to be deleted. This
+ * must be an actual php variable.
+ *
+ * @return SolrUpdateResponse
+ * Returns a SolrUpdateResponse on success and throws an exception on failure.
+ *
+ * @throws SolrClientException
+ * Throws SolrClientException if the client had failed, or there was a connection issue.
+ *
+ * @throws SolrServerException
+ * Throws SolrServerException if the Solr Server had failed to satisfy the request.
+ *
+ */
+ public function deleteByIds(array $ids) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Removes all documents matching any of the queries
+ * @link https://php.net/manual/en/solrclient.deletebyqueries.php
+ * @param array $queries
+ * The array of queries. This must be an actual php variable.
+ *
+ * @return SolrUpdateResponse
+ * Returns a SolrUpdateResponse on success and throws an exception on failure.
+ *
+ * @throws SolrClientException
+ * Throws SolrClientException if the client had failed, or there was a connection issue.
+ *
+ * @throws SolrServerException
+ * Throws SolrServerException if the Solr Server had failed to satisfy the request.
+ *
+ */
+ public function deleteByQueries(array $queries) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Deletes all documents matching the given query
+ * @link https://php.net/manual/en/solrclient.deletebyquery.php
+ * @param string $query
+ * The query
+ *
+ * @return SolrUpdateResponse
+ * Returns a SolrUpdateResponse on success and throws an exception on failure.
+ *
+ * @throws SolrClientException
+ * Throws SolrClientException if the client had failed, or there was a connection issue.
+ *
+ * @throws SolrServerException
+ * Throws SolrServerException if the Solr Server had failed to satisfy the request.
+ *
+ */
+ public function deleteByQuery($query) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Destructor for SolrClient
+ * @link https://php.net/manual/en/solrclient.destruct.php
+ */
+ public function __destruct() {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Get Document By Id. Utilizes Solr Realtime Get (RTG).
+ * @link https://php.net/manual/en/solrclient.getbyid.php
+ * @param string $id
+ * Document ID
+ *
+ * @return SolrQueryResponse
+ */
+ public function getById($id) {}
+
+ /**
+ * (PECL solr >= 2.2.0)
+ * Get Documents by their Ids. Utilizes Solr Realtime Get (RTG).
+ * @link https://php.net/manual/en/solrclient.getbyids.php
+ * @param array $ids
+ * Document ids
+ *
+ * @return SolrQueryResponse
+ */
+ public function getByIds(array $ids) {}
+
+ /**
+ * (PECL solr >= 0.9.7)
+ * Returns the debug data for the last connection attempt
+ * @link https://php.net/manual/en/solrclient.getdebug.php
+ * @return string
+ * Returns a string on success and null if there is nothing to return.
+ *
+ */
+ public function getDebug() {}
+
+ /**
+ * (PECL solr >= 0.9.6)
+ * Returns the client options set internally
+ * @link https://php.net/manual/en/solrclient.getoptions.php
+ * @return array
+ * Returns an array containing all the options for the SolrClient object set internally.
+ *
+ */
+ public function getOptions() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Defragments the index
+ * @link https://php.net/manual/en/solrclient.optimize.php
+ * @param int $maxSegments
+ * Optimizes down to at most this number of segments. Since Solr 1.3
+ *
+ * @param bool $softCommit
+ * This will refresh the 'view' of the index in a more performant manner, but without "on-disk" guarantees.
+ * (Solr4.0+)
+ *
+ * @param bool $waitSearcher
+ * Block until a new searcher is opened and registered as the main query searcher, making the changes visible.
+ *
+ * @return SolrUpdateResponse
+ * Returns a SolrUpdateResponse on success and throws an exception on failure.
+ *
+ * @throws SolrClientException
+ * Throws SolrClientException if the client had failed, or there was a connection issue.
+ *
+ * @throws SolrServerException
+ * Throws SolrServerException if the Solr Server had failed to satisfy the request.
+ *
+ */
+ public function optimize($maxSegments = 1, $softCommit = true, $waitSearcher = true) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Checks if Solr server is still up
+ * @link https://php.net/manual/en/solrclient.ping.php
+ * @return SolrPingResponse
+ * Returns a SolrPingResponse object on success and throws an exception on failure.
+ *
+ * @throws SolrClientException
+ * Throws SolrClientException if the client had failed, or there was a connection issue.
+ *
+ * @throws SolrServerException
+ * Throws SolrServerException if the Solr Server had failed to satisfy the request.
+ *
+ */
+ public function ping() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Sends a query to the server
+ * @link https://php.net/manual/en/solrclient.query.php
+ * @param SolrParams $query
+ * A SolrParams object. It is recommended to use SolrQuery for advanced queries.
+ *
+ * @return SolrQueryResponse
+ * Returns a SolrUpdateResponse on success and throws an exception on failure.
+ *
+ * @throws SolrClientException
+ * Throws SolrClientException if the client had failed, or there was a connection issue.
+ *
+ * @throws SolrServerException
+ * Throws SolrServerException if the Solr Server had failed to satisfy the request.
+ *
+ */
+ public function query(SolrParams $query) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Sends a raw update request
+ * @link https://php.net/manual/en/solrclient.request.php
+ * @param string $raw_request
+ * An XML string with the raw request to the server.
+ *
+ * @return SolrUpdateResponse
+ * Returns a SolrUpdateResponse on success and throws an exception on failure.
+ *
+ * @throws SolrIllegalArgumentException
+ * Throws SolrIllegalArgumentException if raw_request was an empty string.
+ *
+ * @throws SolrClientException
+ * Throws SolrClientException if the client had failed, or there was a connection issue.
+ *
+ * @throws SolrServerException
+ * Throws SolrServerException if the Solr Server had failed to satisfy the request.
+ *
+ */
+ public function request($raw_request) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Rollbacks all add/deletes made to the index since the last commit
+ * @link https://php.net/manual/en/solrclient.rollback.php
+ * @return SolrUpdateResponse
+ * Returns a SolrUpdateResponse on success and throws an exception on failure.
+ *
+ * @throws SolrClientException
+ * Throws SolrClientException if the client had failed, or there was a connection issue.
+ *
+ * @throws SolrServerException
+ * Throws SolrServerException if the Solr Server had failed to satisfy the request.
+ *
+ */
+ public function rollback() {}
+
+ /**
+ * (PECL solr >= 0.9.11)
+ * Sets the response writer used to prepare the response from Solr
+ * @link https://php.net/manual/en/solrclient.setresponsewriter.php
+ * @param string $responseWriter
+ * One of the following:
+ *
+ *
+ * - json
+ * - phps
+ * - xml
+ *
+ */
+ public function setResponseWriter($responseWriter) {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Changes the specified servlet type to a new value
+ * @link https://php.net/manual/en/solrclient.setservlet.php
+ * @param int $type
+ * One of the following :
+ *
+ *
+ * - SolrClient::SEARCH_SERVLET_TYPE
+ * - SolrClient::UPDATE_SERVLET_TYPE
+ * - SolrClient::THREADS_SERVLET_TYPE
+ * - SolrClient::PING_SERVLET_TYPE
+ * - SolrClient::TERMS_SERVLET_TYPE
+ *
+ * @param string $value
+ * The new value for the servlet
+ *
+ * @return bool
+ * Returns TRUE on success or FALSE on failure.
+ *
+ */
+ public function setServlet($type, $value) {}
+
+ /**
+ * (PECL solr >= 2.0.0)
+ * Retrieve Solr Server information
+ * @link https://php.net/manual/en/solrclient.system.php
+ * @return SolrGenericResponse
+ * Returns a SolrGenericResponse object on success.
+ *
+ * @throws SolrClientException
+ * Throws SolrClientException if the client had failed, or there was a connection issue.
+ *
+ * @throws SolrServerException
+ * Throws SolrServerException if the Solr Server had failed to satisfy the request.
+ *
+ */
+ public function system() {}
+
+ /**
+ * (PECL solr >= 0.9.2)
+ * Checks the threads status
+ * @link https://php.net/manual/en/solrclient.threads.php
+ * @return SolrGenericResponse
+ * Returns a SolrGenericResponse object on success.
+ *
+ * @throws SolrClientException
+ * Throws SolrClientException if the client had failed, or there was a connection issue.
+ *
+ * @throws SolrServerException
+ * Throws SolrServerException if the Solr Server had failed to satisfy the request.
+ *
+ */
+ public function threads() {}
}
diff --git a/solr/Utils/SolrObject.php b/solr/Utils/SolrObject.php
index ef7d4bb1a..80a970986 100644
--- a/solr/Utils/SolrObject.php
+++ b/solr/Utils/SolrObject.php
@@ -13,80 +13,79 @@
* read-only.
* @link https://php.net/manual/en/class.solrobject.php
*/
-final class SolrObject implements ArrayAccess {
+final class SolrObject implements ArrayAccess
+{
+ /**
+ * (PECL solr >= 0.9.2)
+ * SolrObject constructor.
+ * @link https://php.net/manual/en/solrobject.construct.php
+ */
+ public function __construct() {}
- /**
- * (PECL solr >= 0.9.2)
- * SolrObject constructor.
- * @link https://php.net/manual/en/solrobject.construct.php
- */
- public function __construct () {}
+ /**
+ * (PECL solr >= 0.9.2)
+ * Destructor
+ * @link https://php.net/manual/en/solrobject.destruct.php
+ */
+ public function __destruct() {}
- /**
- * (PECL solr >= 0.9.2)
- * Destructor
- * @link https://php.net/manual/en/solrobject.destruct.php
- */
- public function __destruct() {}
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns an array of all the names of the properties
+ * @link https://php.net/manual/en/solrobject.getpropertynames.php
+ * @return array
+ * Returns an array.
+ *
+ */
+ public function getPropertyNames() {}
- /**
- * (PECL solr >= 0.9.2)
- * Returns an array of all the names of the properties
- * @link https://php.net/manual/en/solrobject.getpropertynames.php
- * @return array
- * Returns an array.
- *
- */
- public function getPropertyNames() {}
+ /**
+ * (PECL solr >= 0.9.2)
+ * Checks if the property exists
+ * @link https://php.net/manual/en/solrobject.offsetexists.php
+ * @param string $property_name
+ * The name of the property.
+ *
+ * @return bool
+ * Returns TRUE on success or FALSE on failure.
+ *
+ */
+ public function offsetExists($property_name) {}
- /**
- * (PECL solr >= 0.9.2)
- * Checks if the property exists
- * @link https://php.net/manual/en/solrobject.offsetexists.php
- * @param string $property_name
- * The name of the property.
- *
- * @return bool
- * Returns TRUE on success or FALSE on failure.
- *
- */
- public function offsetExists($property_name) {}
+ /**
+ * (PECL solr >= 0.9.2)
+ * Used to retrieve a property
+ * @link https://php.net/manual/en/solrobject.offsetget.php
+ * @param string $property_name
+ * The name of the property.
+ *
+ * @return SolrDocumentField
+ * Returns the property value.
+ *
+ */
+ public function offsetGet($property_name) {}
- /**
- * (PECL solr >= 0.9.2)
- * Used to retrieve a property
- * @link https://php.net/manual/en/solrobject.offsetget.php
- * @param string $property_name
- * The name of the property.
- *
- * @return SolrDocumentField
- * Returns the property value.
- *
- */
- public function offsetGet($property_name) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Sets the value for a property
- * @link https://php.net/manual/en/solrobject.offsetset.php
- * @param string $property_name
- * The name of the property.
- *
- * @param string $property_value
- * The new value.
- *
- */
- public function offsetSet($property_name , $property_value) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Unsets the value for the property
- * @link https://php.net/manual/en/solrobject.offsetunset.php
- * @param string $property_name
- * The name of the property.
- *
- * @return bool
- */
- public function offsetUnset($property_name) {}
+ /**
+ * (PECL solr >= 0.9.2)
+ * Sets the value for a property
+ * @link https://php.net/manual/en/solrobject.offsetset.php
+ * @param string $property_name
+ * The name of the property.
+ *
+ * @param string $property_value
+ * The new value.
+ *
+ */
+ public function offsetSet($property_name, $property_value) {}
+ /**
+ * (PECL solr >= 0.9.2)
+ * Unsets the value for the property
+ * @link https://php.net/manual/en/solrobject.offsetunset.php
+ * @param string $property_name
+ * The name of the property.
+ *
+ * @return bool
+ */
+ public function offsetUnset($property_name) {}
}
diff --git a/solr/Utils/SolrUtils.php b/solr/Utils/SolrUtils.php
index 1d4075cb9..ee0caaba3 100644
--- a/solr/Utils/SolrUtils.php
+++ b/solr/Utils/SolrUtils.php
@@ -13,65 +13,64 @@
* Also contains method for escaping query strings and parsing XML responses.
* @link https://php.net/manual/en/class.solrutils.php
*/
-abstract class SolrUtils {
+abstract class SolrUtils
+{
+ /**
+ * (PECL solr >= 0.9.2)
+ * Parses an response XML string into a SolrObject
+ * @link https://php.net/manual/en/solrutils.digestxmlresponse.php
+ * @param string $xmlresponse
+ * The XML response string from the Solr server.
+ *
+ * @param int $parse_mode [optional]
+ * Use SolrResponse::PARSE_SOLR_OBJ or SolrResponse::PARSE_SOLR_DOC
+ *
+ * @return SolrObject
+ * Returns the SolrObject representing the XML response.
+ *
+ *
+ * If the parse_mode parameter is set to SolrResponse::PARSE_SOLR_OBJ Solr documents will be parses as SolrObject instances.
+ *
+ *
+ * If it is set to SolrResponse::PARSE_SOLR_DOC, they will be parsed as SolrDocument instances.
+ *
+ * @throws SolrException
+ */
+ public static function digestXmlResponse($xmlresponse, $parse_mode = 0) {}
- /**
- * (PECL solr >= 0.9.2)
- * Parses an response XML string into a SolrObject
- * @link https://php.net/manual/en/solrutils.digestxmlresponse.php
- * @param string $xmlresponse
- * The XML response string from the Solr server.
- *
- * @param int $parse_mode [optional]
- * Use SolrResponse::PARSE_SOLR_OBJ or SolrResponse::PARSE_SOLR_DOC
- *
- * @return SolrObject
- * Returns the SolrObject representing the XML response.
- *
- *
- * If the parse_mode parameter is set to SolrResponse::PARSE_SOLR_OBJ Solr documents will be parses as SolrObject instances.
- *
- *
- * If it is set to SolrResponse::PARSE_SOLR_DOC, they will be parsed as SolrDocument instances.
- *
- * @throws SolrException
- */
- public static function digestXmlResponse($xmlresponse, $parse_mode = 0) {}
+ /**
+ * (PECL solr >= 0.9.2)
+ * Escapes a lucene query string
+ * @link https://php.net/manual/en/solrutils.escapequerychars.php
+ * @param string $str
+ * This is the query string to be escaped.
+ *
+ * @return string|false
+ * Returns the escaped string or FALSE on failure.
+ *
+ */
+ public static function escapeQueryChars($str) {}
- /**
- * (PECL solr >= 0.9.2)
- * Escapes a lucene query string
- * @link https://php.net/manual/en/solrutils.escapequerychars.php
- * @param string $str
- * This is the query string to be escaped.
- *
- * @return string|false
- * Returns the escaped string or FALSE on failure.
- *
- */
- public static function escapeQueryChars($str) {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Returns the current version of the Solr extension
- * @link https://php.net/manual/en/solrutils.getsolrversion.php
- * @return string
- * The current version of the Apache Solr extension.
- *
- */
- public static function getSolrVersion() {}
-
- /**
- * (PECL solr >= 0.9.2)
- * Prepares a phrase from an unescaped lucene string
- * @link https://php.net/manual/en/solrutils.queryphrase.php
- * @param string $str
- * The lucene phrase.
- *
- * @return string
- * Returns the phrase contained in double quotes.
- *
- */
- public static function queryPhrase($str) {}
+ /**
+ * (PECL solr >= 0.9.2)
+ * Returns the current version of the Solr extension
+ * @link https://php.net/manual/en/solrutils.getsolrversion.php
+ * @return string
+ * The current version of the Apache Solr extension.
+ *
+ */
+ public static function getSolrVersion() {}
+ /**
+ * (PECL solr >= 0.9.2)
+ * Prepares a phrase from an unescaped lucene string
+ * @link https://php.net/manual/en/solrutils.queryphrase.php
+ * @param string $str
+ * The lucene phrase.
+ *
+ * @return string
+ * Returns the phrase contained in double quotes.
+ *
+ */
+ public static function queryPhrase($str) {}
}
diff --git a/sqlite3/sqlite3.php b/sqlite3/sqlite3.php
index 33294bc31..4e43bf312 100644
--- a/sqlite3/sqlite3.php
+++ b/sqlite3/sqlite3.php
@@ -7,523 +7,520 @@
* A class that interfaces SQLite 3 databases.
* @link https://php.net/manual/en/class.sqlite3.php
*/
-class SQLite3 {
-
- const OK = 0;
- const DENY = 1;
- const IGNORE = 2;
- const CREATE_INDEX = 1;
- const CREATE_TABLE = 2;
- const CREATE_TEMP_INDEX = 3;
- const CREATE_TEMP_TABLE = 4;
- const CREATE_TEMP_TRIGGER = 5;
- const CREATE_TEMP_VIEW = 6;
- const CREATE_TRIGGER = 7;
- const CREATE_VIEW = 8;
- const DELETE = 9;
- const DROP_INDEX = 10;
- const DROP_TABLE = 11;
- const DROP_TEMP_INDEX = 12;
- const DROP_TEMP_TABLE = 13;
- const DROP_TEMP_TRIGGER = 14;
- const DROP_TEMP_VIEW = 15;
- const DROP_TRIGGER = 16;
- const DROP_VIEW = 17;
- const INSERT = 18;
- const PRAGMA = 19;
- const READ = 20;
- const SELECT = 21;
- const TRANSACTION = 22;
- const UPDATE = 23;
- const ATTACH = 24;
- const DETACH = 25;
- const ALTER_TABLE = 26;
- const REINDEX = 27;
- const ANALYZE = 28;
- const CREATE_VTABLE = 29;
- const DROP_VTABLE = 30;
- const FUNCTION = 31;
- const SAVEPOINT = 32;
- const COPY = 0;
- const RECURSIVE = 33;
-
- /**
- * Opens an SQLite database
- * @link https://php.net/manual/en/sqlite3.open.php
- * @param string $filename
- * Path to the SQLite database, or :memory: to use in-memory database.
- *
- * @param int $flags [optional]
- * Optional flags used to determine how to open the SQLite database. By
- * default, open uses SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE.
- *
- *
- * SQLITE3_OPEN_READONLY: Open the database for
- * reading only.
- *
- * @param string $encryptionKey [optional]
- * An optional encryption key used when encrypting and decrypting an
- * SQLite database.
- *
- * @return void No value is returned.
- */
- public function open ($filename, $flags = SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE, $encryptionKey = null) {}
-
- /**
- * Closes the database connection
- * @link https://php.net/manual/en/sqlite3.close.php
- * @return bool TRUE on success, FALSE on failure.
- */
- public function close () {}
-
- /**
- * Executes a result-less query against a given database
- * @link https://php.net/manual/en/sqlite3.exec.php
- * @param string $query
- * The SQL query to execute (typically an INSERT, UPDATE, or DELETE
- * query).
- *
- * @return bool TRUE if the query succeeded, FALSE on failure.
- */
- public function exec ($query) {}
-
- /**
- * Returns the SQLite3 library version as a string constant and as a number
- * @link https://php.net/manual/en/sqlite3.version.php
- * @return array an associative array with the keys "versionString" and
- * "versionNumber".
- */
- #[ArrayShape(["versionString" => "string", "versionNumber" => "int"])]
- public static function version () {}
-
- /**
- * Returns the row ID of the most recent INSERT into the database
- * @link https://php.net/manual/en/sqlite3.lastinsertrowid.php
- * @return int the row ID of the most recent INSERT into the database
- */
- public function lastInsertRowID () {}
-
- /**
- * Returns the numeric result code of the most recent failed SQLite request
- * @link https://php.net/manual/en/sqlite3.lasterrorcode.php
- * @return int an integer value representing the numeric result code of the most
- * recent failed SQLite request.
- */
- public function lastErrorCode () {}
-
- /**
- * Returns English text describing the most recent failed SQLite request
- * @link https://php.net/manual/en/sqlite3.lasterrormsg.php
- * @return string an English string describing the most recent failed SQLite request.
- */
- public function lastErrorMsg () {}
-
- /**
- * Sets the busy connection handler
- * @link https://php.net/manual/en/sqlite3.busytimeout.php
- * @param int $milliseconds
- * The milliseconds to sleep. Setting this value to a value less than
- * or equal to zero, will turn off an already set timeout handler.
- *
- * @return bool TRUE on success, FALSE on failure.
- * @since 5.3.3
- */
- public function busyTimeout ($milliseconds) {}
-
- /**
- * Attempts to load an SQLite extension library
- * @link https://php.net/manual/en/sqlite3.loadextension.php
- * @param string $name
- * The name of the library to load. The library must be located in the
- * directory specified in the configure option sqlite3.extension_dir.
- *
- * @return bool TRUE if the extension is successfully loaded, FALSE on failure.
- */
- public function loadExtension ($name) {}
-
- /**
- * Returns the number of database rows that were changed (or inserted or
- * deleted) by the most recent SQL statement
- * @link https://php.net/manual/en/sqlite3.changes.php
- * @return int an integer value corresponding to the number of
- * database rows changed (or inserted or deleted) by the most recent SQL
- * statement.
- */
- public function changes () {}
-
- /**
- * Returns a string that has been properly escaped
- * @link https://php.net/manual/en/sqlite3.escapestring.php
- * @param string $string
- * The string to be escaped.
- *
- * @return string a properly escaped string that may be used safely in an SQL
- * statement.
- */
- public static function escapeString ($string) {}
-
- /**
- * Prepares an SQL statement for execution
- * @link https://php.net/manual/en/sqlite3.prepare.php
- * @param string $query
- * The SQL query to prepare.
- *
- * @return SQLite3Stmt|false an SQLite3Stmt object on success or FALSE on failure.
- */
- public function prepare ($query) {}
-
- /**
- * Executes an SQL query
- * @link https://php.net/manual/en/sqlite3.query.php
- * @param string $query
- * The SQL query to execute.
- *
- * @return SQLite3Result an SQLite3Result object if the query returns results. Otherwise,
- * returns TRUE if the query succeeded, FALSE on failure.
- */
- public function query ($query) {}
-
- /**
- * Executes a query and returns a single result
- * @link https://php.net/manual/en/sqlite3.querysingle.php
- * @param string $query
- * The SQL query to execute.
- *
- * @param bool $entireRow [optional]
- * By default, querySingle returns the value of the
- * first column returned by the query. If
- * entire_row is TRUE, then it returns an array
- * of the entire first row.
- *
- * @return mixed the value of the first column of results or an array of the entire
- * first row (if entire_row is TRUE).
- *
- *
- * If the query is valid but no results are returned, then NULL will be
- * returned if entire_row is FALSE, otherwise an
- * empty array is returned.
- *
- *
- * Invalid or failing queries will return FALSE.
- */
- public function querySingle ($query, $entireRow = false) {}
-
- /**
- * Registers a PHP function for use as an SQL scalar function
- * @link https://php.net/manual/en/sqlite3.createfunction.php
- * @param string $name
- * Name of the SQL function to be created or redefined.
- *
- * @param mixed $callback
- * The name of a PHP function or user-defined function to apply as a
- * callback, defining the behavior of the SQL function.
- *
- * @param int $argCount [optional]
- * The number of arguments that the SQL function takes. If
- * this parameter is negative, then the SQL function may take
- * any number of arguments.
- *
- * @param int $flags [optional]
- * A bitwise conjunction of flags.
- * Currently, only SQLITE3_DETERMINISTIC is supported, which specifies that the function always returns
- * the same result given the same inputs within a single SQL statement.
- * @return bool TRUE upon successful creation of the function, FALSE on failure.
- */
- public function createFunction ($name, $callback, $argCount = -1, int $flags = 0) {}
-
- /**
- * Registers a PHP function for use as an SQL aggregate function
- * @link https://php.net/manual/en/sqlite3.createaggregate.php
- * @param string $name
- * Name of the SQL aggregate to be created or redefined.
- *
- * @param mixed $stepCallback
- * The name of a PHP function or user-defined function to apply as a
- * callback for every item in the aggregate.
- *
- * @param mixed $finalCallback
- * The name of a PHP function or user-defined function to apply as a
- * callback at the end of the aggregate data.
- *
- * @param int $argCount [optional]
- * The number of arguments that the SQL aggregate takes. If
- * this parameter is negative, then the SQL aggregate may take
- * any number of arguments.
- *
- * @return bool TRUE upon successful creation of the aggregate, FALSE on
- * failure.
- */
- public function createAggregate ($name, $stepCallback, $finalCallback, $argCount = -1) {}
-
- /**
- * Registers a PHP function for use as an SQL collating function
- * @link https://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
- * strings 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.
- *
- * @return bool TRUE on success or FALSE on failure.
- * @since 5.3.11
- */
- public function createCollation ($name, callable $callback) {}
-
- /**
- * Opens a stream resource to read a BLOB
- * @link https://php.net/manual/en/sqlite3.openblob.php
- * @param string $table The table name.
- * @param string $column The column name.
- * @param int $rowid The row ID.
- * @param string $database [optional] The symbolic name of the DB
- * @param int $flags [optional]
- * Either SQLITE3_OPEN_READONLY or SQLITE3_OPEN_READWRITE to open the stream for reading only, or for reading and writing, respectively.
- * @return resource|false Returns a stream resource, or FALSE on failure.
- */
- public function openBlob ($table, $column, $rowid, $database = 'main', int $flags = SQLITE3_OPEN_READONLY) {}
-
- /**
- * Enable throwing exceptions
- * @link https://www.php.net/manual/en/sqlite3.enableexceptions
- * @param bool $enable
- * @return bool Returns the old value; true if exceptions were enabled, false otherwise.
- */
- public function enableExceptions ($enable = false) {}
-
- /**
- * Instantiates an SQLite3 object and opens an SQLite 3 database
- * @link https://php.net/manual/en/sqlite3.construct.php
- * @param string $filename
- * Path to the SQLite database, or :memory: to use in-memory database.
- *
- * @param int $flags [optional]
- * Optional flags used to determine how to open the SQLite database. By
- * default, open uses SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE.
- *
- *
- * SQLITE3_OPEN_READONLY: Open the database for
- * reading only.
- *
- * @param string $encryptionKey [optional]
- * An optional encryption key used when encrypting and decrypting an
- * SQLite database.
- *
- */
- public function __construct ($filename, $flags = SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE, $encryptionKey = null) {}
-
- /**
- * @return int
- * @since 7.4
- */
- public function lastExtendedErrorCode(){}
-
- /**
- * @param bool $enable
- * @since 7.4
- */
- public function enableExtendedResultCodes(bool $enable = true){}
-
- /**
- * @param SQLite3 $destination
- * @param string $sourceDatabase
- * @param string $destinationDatabase
- * @since 7.4
- */
- public function backup(SQLite3 $destination, string $sourceDatabase = 'main', string $destinationDatabase = 'main'){}
-
- /**
- * @param null|callable $callback
- * @return bool
- * @since 8.0
- */
- function setAuthorizer(?callable $callback) {}
-
+class SQLite3
+{
+ public const OK = 0;
+ public const DENY = 1;
+ public const IGNORE = 2;
+ public const CREATE_INDEX = 1;
+ public const CREATE_TABLE = 2;
+ public const CREATE_TEMP_INDEX = 3;
+ public const CREATE_TEMP_TABLE = 4;
+ public const CREATE_TEMP_TRIGGER = 5;
+ public const CREATE_TEMP_VIEW = 6;
+ public const CREATE_TRIGGER = 7;
+ public const CREATE_VIEW = 8;
+ public const DELETE = 9;
+ public const DROP_INDEX = 10;
+ public const DROP_TABLE = 11;
+ public const DROP_TEMP_INDEX = 12;
+ public const DROP_TEMP_TABLE = 13;
+ public const DROP_TEMP_TRIGGER = 14;
+ public const DROP_TEMP_VIEW = 15;
+ public const DROP_TRIGGER = 16;
+ public const DROP_VIEW = 17;
+ public const INSERT = 18;
+ public const PRAGMA = 19;
+ public const READ = 20;
+ public const SELECT = 21;
+ public const TRANSACTION = 22;
+ public const UPDATE = 23;
+ public const ATTACH = 24;
+ public const DETACH = 25;
+ public const ALTER_TABLE = 26;
+ public const REINDEX = 27;
+ public const ANALYZE = 28;
+ public const CREATE_VTABLE = 29;
+ public const DROP_VTABLE = 30;
+ public const FUNCTION = 31;
+ public const SAVEPOINT = 32;
+ public const COPY = 0;
+ public const RECURSIVE = 33;
+
+ /**
+ * Opens an SQLite database
+ * @link https://php.net/manual/en/sqlite3.open.php
+ * @param string $filename
+ * Path to the SQLite database, or :memory: to use in-memory database.
+ *
+ * @param int $flags [optional]
+ * Optional flags used to determine how to open the SQLite database. By
+ * default, open uses SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE.
+ *
+ *
+ * SQLITE3_OPEN_READONLY: Open the database for
+ * reading only.
+ *
+ * @param string $encryptionKey [optional]
+ * An optional encryption key used when encrypting and decrypting an
+ * SQLite database.
+ *
+ * @return void No value is returned.
+ */
+ public function open($filename, $flags = SQLITE3_OPEN_READWRITE|SQLITE3_OPEN_CREATE, $encryptionKey = null) {}
+
+ /**
+ * Closes the database connection
+ * @link https://php.net/manual/en/sqlite3.close.php
+ * @return bool TRUE on success, FALSE on failure.
+ */
+ public function close() {}
+
+ /**
+ * Executes a result-less query against a given database
+ * @link https://php.net/manual/en/sqlite3.exec.php
+ * @param string $query
+ * The SQL query to execute (typically an INSERT, UPDATE, or DELETE
+ * query).
+ *
+ * @return bool TRUE if the query succeeded, FALSE on failure.
+ */
+ public function exec($query) {}
+
+ /**
+ * Returns the SQLite3 library version as a string constant and as a number
+ * @link https://php.net/manual/en/sqlite3.version.php
+ * @return array an associative array with the keys "versionString" and
+ * "versionNumber".
+ */
+ #[ArrayShape(["versionString" => "string", "versionNumber" => "int"])]
+ public static function version() {}
+
+ /**
+ * Returns the row ID of the most recent INSERT into the database
+ * @link https://php.net/manual/en/sqlite3.lastinsertrowid.php
+ * @return int the row ID of the most recent INSERT into the database
+ */
+ public function lastInsertRowID() {}
+
+ /**
+ * Returns the numeric result code of the most recent failed SQLite request
+ * @link https://php.net/manual/en/sqlite3.lasterrorcode.php
+ * @return int an integer value representing the numeric result code of the most
+ * recent failed SQLite request.
+ */
+ public function lastErrorCode() {}
+
+ /**
+ * Returns English text describing the most recent failed SQLite request
+ * @link https://php.net/manual/en/sqlite3.lasterrormsg.php
+ * @return string an English string describing the most recent failed SQLite request.
+ */
+ public function lastErrorMsg() {}
+
+ /**
+ * Sets the busy connection handler
+ * @link https://php.net/manual/en/sqlite3.busytimeout.php
+ * @param int $milliseconds
+ * The milliseconds to sleep. Setting this value to a value less than
+ * or equal to zero, will turn off an already set timeout handler.
+ *
+ * @return bool TRUE on success, FALSE on failure.
+ * @since 5.3.3
+ */
+ public function busyTimeout($milliseconds) {}
+
+ /**
+ * Attempts to load an SQLite extension library
+ * @link https://php.net/manual/en/sqlite3.loadextension.php
+ * @param string $name
+ * The name of the library to load. The library must be located in the
+ * directory specified in the configure option sqlite3.extension_dir.
+ *
+ * @return bool TRUE if the extension is successfully loaded, FALSE on failure.
+ */
+ public function loadExtension($name) {}
+
+ /**
+ * Returns the number of database rows that were changed (or inserted or
+ * deleted) by the most recent SQL statement
+ * @link https://php.net/manual/en/sqlite3.changes.php
+ * @return int an integer value corresponding to the number of
+ * database rows changed (or inserted or deleted) by the most recent SQL
+ * statement.
+ */
+ public function changes() {}
+
+ /**
+ * Returns a string that has been properly escaped
+ * @link https://php.net/manual/en/sqlite3.escapestring.php
+ * @param string $string
+ * The string to be escaped.
+ *
+ * @return string a properly escaped string that may be used safely in an SQL
+ * statement.
+ */
+ public static function escapeString($string) {}
+
+ /**
+ * Prepares an SQL statement for execution
+ * @link https://php.net/manual/en/sqlite3.prepare.php
+ * @param string $query
+ * The SQL query to prepare.
+ *
+ * @return SQLite3Stmt|false an SQLite3Stmt object on success or FALSE on failure.
+ */
+ public function prepare($query) {}
+
+ /**
+ * Executes an SQL query
+ * @link https://php.net/manual/en/sqlite3.query.php
+ * @param string $query
+ * The SQL query to execute.
+ *
+ * @return SQLite3Result an SQLite3Result object if the query returns results. Otherwise,
+ * returns TRUE if the query succeeded, FALSE on failure.
+ */
+ public function query($query) {}
+
+ /**
+ * Executes a query and returns a single result
+ * @link https://php.net/manual/en/sqlite3.querysingle.php
+ * @param string $query
+ * The SQL query to execute.
+ *
+ * @param bool $entireRow [optional]
+ * By default, querySingle returns the value of the
+ * first column returned by the query. If
+ * entire_row is TRUE, then it returns an array
+ * of the entire first row.
+ *
+ * @return mixed the value of the first column of results or an array of the entire
+ * first row (if entire_row is TRUE).
+ *
+ *
+ * If the query is valid but no results are returned, then NULL will be
+ * returned if entire_row is FALSE, otherwise an
+ * empty array is returned.
+ *
+ *
+ * Invalid or failing queries will return FALSE.
+ */
+ public function querySingle($query, $entireRow = false) {}
+
+ /**
+ * Registers a PHP function for use as an SQL scalar function
+ * @link https://php.net/manual/en/sqlite3.createfunction.php
+ * @param string $name
+ * Name of the SQL function to be created or redefined.
+ *
+ * @param mixed $callback
+ * The name of a PHP function or user-defined function to apply as a
+ * callback, defining the behavior of the SQL function.
+ *
+ * @param int $argCount [optional]
+ * The number of arguments that the SQL function takes. If
+ * this parameter is negative, then the SQL function may take
+ * any number of arguments.
+ *
+ * @param int $flags [optional]
+ * A bitwise conjunction of flags.
+ * Currently, only SQLITE3_DETERMINISTIC is supported, which specifies that the function always returns
+ * the same result given the same inputs within a single SQL statement.
+ * @return bool TRUE upon successful creation of the function, FALSE on failure.
+ */
+ public function createFunction($name, $callback, $argCount = -1, int $flags = 0) {}
+
+ /**
+ * Registers a PHP function for use as an SQL aggregate function
+ * @link https://php.net/manual/en/sqlite3.createaggregate.php
+ * @param string $name
+ * Name of the SQL aggregate to be created or redefined.
+ *
+ * @param mixed $stepCallback
+ * The name of a PHP function or user-defined function to apply as a
+ * callback for every item in the aggregate.
+ *
+ * @param mixed $finalCallback
+ * The name of a PHP function or user-defined function to apply as a
+ * callback at the end of the aggregate data.
+ *
+ * @param int $argCount [optional]
+ * The number of arguments that the SQL aggregate takes. If
+ * this parameter is negative, then the SQL aggregate may take
+ * any number of arguments.
+ *
+ * @return bool TRUE upon successful creation of the aggregate, FALSE on
+ * failure.
+ */
+ public function createAggregate($name, $stepCallback, $finalCallback, $argCount = -1) {}
+
+ /**
+ * Registers a PHP function for use as an SQL collating function
+ * @link https://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
+ * strings 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.
+ *
+ * @return bool TRUE on success or FALSE on failure.
+ * @since 5.3.11
+ */
+ public function createCollation($name, callable $callback) {}
+
+ /**
+ * Opens a stream resource to read a BLOB
+ * @link https://php.net/manual/en/sqlite3.openblob.php
+ * @param string $table The table name.
+ * @param string $column The column name.
+ * @param int $rowid The row ID.
+ * @param string $database [optional] The symbolic name of the DB
+ * @param int $flags [optional]
+ * Either SQLITE3_OPEN_READONLY or SQLITE3_OPEN_READWRITE to open the stream for reading only, or for reading and writing, respectively.
+ * @return resource|false Returns a stream resource, or FALSE on failure.
+ */
+ public function openBlob($table, $column, $rowid, $database = 'main', int $flags = SQLITE3_OPEN_READONLY) {}
+
+ /**
+ * Enable throwing exceptions
+ * @link https://www.php.net/manual/en/sqlite3.enableexceptions
+ * @param bool $enable
+ * @return bool Returns the old value; true if exceptions were enabled, false otherwise.
+ */
+ public function enableExceptions($enable = false) {}
+
+ /**
+ * Instantiates an SQLite3 object and opens an SQLite 3 database
+ * @link https://php.net/manual/en/sqlite3.construct.php
+ * @param string $filename
+ * Path to the SQLite database, or :memory: to use in-memory database.
+ *
+ * @param int $flags [optional]
+ * Optional flags used to determine how to open the SQLite database. By
+ * default, open uses SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE.
+ *
+ *
+ * SQLITE3_OPEN_READONLY: Open the database for
+ * reading only.
+ *
+ * @param string $encryptionKey [optional]
+ * An optional encryption key used when encrypting and decrypting an
+ * SQLite database.
+ *
+ */
+ public function __construct($filename, $flags = SQLITE3_OPEN_READWRITE|SQLITE3_OPEN_CREATE, $encryptionKey = null) {}
+
+ /**
+ * @return int
+ * @since 7.4
+ */
+ public function lastExtendedErrorCode() {}
+
+ /**
+ * @param bool $enable
+ * @since 7.4
+ */
+ public function enableExtendedResultCodes(bool $enable = true) {}
+
+ /**
+ * @param SQLite3 $destination
+ * @param string $sourceDatabase
+ * @param string $destinationDatabase
+ * @since 7.4
+ */
+ public function backup(SQLite3 $destination, string $sourceDatabase = 'main', string $destinationDatabase = 'main') {}
+
+ /**
+ * @param null|callable $callback
+ * @return bool
+ * @since 8.0
+ */
+ public function setAuthorizer(?callable $callback) {}
}
/**
* A class that handles prepared statements for the SQLite 3 extension.
* @link https://php.net/manual/en/class.sqlite3stmt.php
*/
-class SQLite3Stmt {
-
- /**
- * Returns the number of parameters within the prepared statement
- * @link https://php.net/manual/en/sqlite3stmt.paramcount.php
- * @return int the number of parameters within the prepared statement.
- */
- public function paramCount () {}
-
- /**
- * Closes the prepared statement
- * @link https://php.net/manual/en/sqlite3stmt.close.php
- * @return bool TRUE
- */
- public function close () {}
-
- /**
- * Resets the prepared statement
- * @link https://php.net/manual/en/sqlite3stmt.reset.php
- * @return bool TRUE if the statement is successfully reset, FALSE on failure.
- */
- public function reset () {}
-
- /**
- * Clears all current bound parameters
- * @link https://php.net/manual/en/sqlite3stmt.clear.php
- * @return bool TRUE on successful clearing of bound parameters, FALSE on
- * failure.
- */
- public function clear () {}
-
- /**
- * Executes a prepared statement and returns a result set object
- * @link https://php.net/manual/en/sqlite3stmt.execute.php
- * @return SQLite3Result an SQLite3Result object on successful execution of the prepared
- * statement, FALSE on failure.
- */
- public function execute () {}
-
- /**
- * Binds a parameter to a statement variable
- * @link https://php.net/manual/en/sqlite3stmt.bindparam.php
- * @param string $param
- * An string identifying the statement variable to which the
- * parameter should be bound.
- *
- * @param mixed &$var
- * The parameter to bind to a statement variable.
- *
- * @param int $type [optional]
- * The data type of the parameter to bind.
- *
- *
- * SQLITE3_INTEGER: The value is a signed integer,
- * stored in 1, 2, 3, 4, 6, or 8 bytes depending on the magnitude of
- * the value.
- *
- * @return bool TRUE if the parameter is bound to the statement variable, FALSE
- * on failure.
- */
- public function bindParam ($param, &$var, $type = SQLITE3_TEXT) {}
-
- /**
- * Binds the value of a parameter to a statement variable
- * @link https://php.net/manual/en/sqlite3stmt.bindvalue.php
- * @param string $param
- * An string identifying the statement variable to which the
- * value should be bound.
- *
- * @param mixed $value
- * The value to bind to a statement variable.
- *
- * @param int $type [optional]
- * The data type of the value to bind.
- *
- *
- * SQLITE3_INTEGER: The value is a signed integer,
- * stored in 1, 2, 3, 4, 6, or 8 bytes depending on the magnitude of
- * the value.
- *
- * @return bool TRUE if the value is bound to the statement variable, FALSE
- * on failure.
- */
- public function bindValue ($param, $value, $type = SQLITE3_TEXT) {}
-
- public function readOnly () {}
-
- /**
- * @param SQLite3 $sqlite3
- * @param string $query
- */
- private function __construct ($sqlite3, $query) {}
-
- /**
- * Retrieves the SQL of the prepared statement. If expanded is FALSE, the unmodified SQL is retrieved.
- * If expanded is TRUE, all query parameters are replaced with their bound values, or with an SQL NULL, if not already bound.
- * @param bool $expand 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.
- * @since 7.4
- */
- public function getSQL(bool $expand = false){}
-
+class SQLite3Stmt
+{
+ /**
+ * Returns the number of parameters within the prepared statement
+ * @link https://php.net/manual/en/sqlite3stmt.paramcount.php
+ * @return int the number of parameters within the prepared statement.
+ */
+ public function paramCount() {}
+
+ /**
+ * Closes the prepared statement
+ * @link https://php.net/manual/en/sqlite3stmt.close.php
+ * @return bool TRUE
+ */
+ public function close() {}
+
+ /**
+ * Resets the prepared statement
+ * @link https://php.net/manual/en/sqlite3stmt.reset.php
+ * @return bool TRUE if the statement is successfully reset, FALSE on failure.
+ */
+ public function reset() {}
+
+ /**
+ * Clears all current bound parameters
+ * @link https://php.net/manual/en/sqlite3stmt.clear.php
+ * @return bool TRUE on successful clearing of bound parameters, FALSE on
+ * failure.
+ */
+ public function clear() {}
+
+ /**
+ * Executes a prepared statement and returns a result set object
+ * @link https://php.net/manual/en/sqlite3stmt.execute.php
+ * @return SQLite3Result an SQLite3Result object on successful execution of the prepared
+ * statement, FALSE on failure.
+ */
+ public function execute() {}
+
+ /**
+ * Binds a parameter to a statement variable
+ * @link https://php.net/manual/en/sqlite3stmt.bindparam.php
+ * @param string $param
+ * An string identifying the statement variable to which the
+ * parameter should be bound.
+ *
+ * @param mixed &$var
+ * The parameter to bind to a statement variable.
+ *
+ * @param int $type [optional]
+ * The data type of the parameter to bind.
+ *
+ *
+ * SQLITE3_INTEGER: The value is a signed integer,
+ * stored in 1, 2, 3, 4, 6, or 8 bytes depending on the magnitude of
+ * the value.
+ *
+ * @return bool TRUE if the parameter is bound to the statement variable, FALSE
+ * on failure.
+ */
+ public function bindParam($param, &$var, $type = SQLITE3_TEXT) {}
+
+ /**
+ * Binds the value of a parameter to a statement variable
+ * @link https://php.net/manual/en/sqlite3stmt.bindvalue.php
+ * @param string $param
+ * An string identifying the statement variable to which the
+ * value should be bound.
+ *
+ * @param mixed $value
+ * The value to bind to a statement variable.
+ *
+ * @param int $type [optional]
+ * The data type of the value to bind.
+ *
+ *
+ * SQLITE3_INTEGER: The value is a signed integer,
+ * stored in 1, 2, 3, 4, 6, or 8 bytes depending on the magnitude of
+ * the value.
+ *
+ * @return bool TRUE if the value is bound to the statement variable, FALSE
+ * on failure.
+ */
+ public function bindValue($param, $value, $type = SQLITE3_TEXT) {}
+
+ public function readOnly() {}
+
+ /**
+ * @param SQLite3 $sqlite3
+ * @param string $query
+ */
+ private function __construct($sqlite3, $query) {}
+
+ /**
+ * Retrieves the SQL of the prepared statement. If expanded is FALSE, the unmodified SQL is retrieved.
+ * If expanded is TRUE, all query parameters are replaced with their bound values, or with an SQL NULL, if not already bound.
+ * @param bool $expand 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.
+ * @since 7.4
+ */
+ public function getSQL(bool $expand = false) {}
}
/**
* A class that handles result sets for the SQLite 3 extension.
* @link https://php.net/manual/en/class.sqlite3result.php
*/
-class SQLite3Result {
-
- /**
- * Returns the number of columns in the result set
- * @link https://php.net/manual/en/sqlite3result.numcolumns.php
- * @return int the number of columns in the result set.
- */
- public function numColumns () {}
-
- /**
- * Returns the name of the nth column
- * @link https://php.net/manual/en/sqlite3result.columnname.php
- * @param int $column
- * The numeric zero-based index of the column.
- *
- * @return string the string name of the column identified by
- * column_number.
- */
- public function columnName ($column) {}
-
- /**
- * Returns the type of the nth column
- * @link https://php.net/manual/en/sqlite3result.columntype.php
- * @param int $column
- * The numeric zero-based index of the column.
- *
- * @return int the data type index of the column identified by
- * column_number (one of
- * SQLITE3_INTEGER, SQLITE3_FLOAT,
- * SQLITE3_TEXT, SQLITE3_BLOB, or
- * SQLITE3_NULL).
- */
- public function columnType ($column) {}
-
- /**
- * Fetches a result row as an associative or numerically indexed array or both
- * @link https://php.net/manual/en/sqlite3result.fetcharray.php
- * @param int $mode [optional]
- * Controls how the next row will be returned to the caller. This value
- * must be one of either SQLITE3_ASSOC,
- * SQLITE3_NUM, or SQLITE3_BOTH.
- *
- *
- * SQLITE3_ASSOC: returns an array indexed by column
- * name as returned in the corresponding result set
- *
- * @return array|false a result row as an associatively or numerically indexed array or
- * both. Alternately will return FALSE if there are no more rows.
- */
- public function fetchArray ($mode = SQLITE3_BOTH) {}
-
- /**
- * Resets the result set back to the first row
- * @link https://php.net/manual/en/sqlite3result.reset.php
- * @return bool TRUE if the result set is successfully reset
- * back to the first row, FALSE on failure.
- */
- public function reset () {}
-
- /**
- * Closes the result set
- * @link https://php.net/manual/en/sqlite3result.finalize.php
- * @return bool TRUE.
- */
- public function finalize () {}
-
- private function __construct () {}
-
+class SQLite3Result
+{
+ /**
+ * Returns the number of columns in the result set
+ * @link https://php.net/manual/en/sqlite3result.numcolumns.php
+ * @return int the number of columns in the result set.
+ */
+ public function numColumns() {}
+
+ /**
+ * Returns the name of the nth column
+ * @link https://php.net/manual/en/sqlite3result.columnname.php
+ * @param int $column
+ * The numeric zero-based index of the column.
+ *
+ * @return string the string name of the column identified by
+ * column_number.
+ */
+ public function columnName($column) {}
+
+ /**
+ * Returns the type of the nth column
+ * @link https://php.net/manual/en/sqlite3result.columntype.php
+ * @param int $column
+ * The numeric zero-based index of the column.
+ *
+ * @return int the data type index of the column identified by
+ * column_number (one of
+ * SQLITE3_INTEGER, SQLITE3_FLOAT,
+ * SQLITE3_TEXT, SQLITE3_BLOB, or
+ * SQLITE3_NULL).
+ */
+ public function columnType($column) {}
+
+ /**
+ * Fetches a result row as an associative or numerically indexed array or both
+ * @link https://php.net/manual/en/sqlite3result.fetcharray.php
+ * @param int $mode [optional]
+ * Controls how the next row will be returned to the caller. This value
+ * must be one of either SQLITE3_ASSOC,
+ * SQLITE3_NUM, or SQLITE3_BOTH.
+ *
+ *
+ * SQLITE3_ASSOC: returns an array indexed by column
+ * name as returned in the corresponding result set
+ *
+ * @return array|false a result row as an associatively or numerically indexed array or
+ * both. Alternately will return FALSE if there are no more rows.
+ */
+ public function fetchArray($mode = SQLITE3_BOTH) {}
+
+ /**
+ * Resets the result set back to the first row
+ * @link https://php.net/manual/en/sqlite3result.reset.php
+ * @return bool TRUE if the result set is successfully reset
+ * back to the first row, FALSE on failure.
+ */
+ public function reset() {}
+
+ /**
+ * Closes the result set
+ * @link https://php.net/manual/en/sqlite3result.finalize.php
+ * @return bool TRUE.
+ */
+ public function finalize() {}
+
+ private function __construct() {}
}
/**
@@ -532,7 +529,7 @@ private function __construct () {}
* corresponding result set.
* @link https://php.net/manual/en/sqlite3.constants.php
*/
-define ('SQLITE3_ASSOC', 1);
+define('SQLITE3_ASSOC', 1);
/**
* Specifies that the Sqlite3Result::fetchArray
@@ -540,7 +537,7 @@ private function __construct () {}
* corresponding result set, starting at column 0.
* @link https://php.net/manual/en/sqlite3.constants.php
*/
-define ('SQLITE3_NUM', 2);
+define('SQLITE3_NUM', 2);
/**
* Specifies that the Sqlite3Result::fetchArray
@@ -548,56 +545,55 @@ private function __construct () {}
* returned in the corresponding result set, starting at column 0.
* @link https://php.net/manual/en/sqlite3.constants.php
*/
-define ('SQLITE3_BOTH', 3);
+define('SQLITE3_BOTH', 3);
/**
* Represents the SQLite3 INTEGER storage class.
* @link https://php.net/manual/en/sqlite3.constants.php
*/
-define ('SQLITE3_INTEGER', 1);
+define('SQLITE3_INTEGER', 1);
/**
* Represents the SQLite3 REAL (FLOAT) storage class.
* @link https://php.net/manual/en/sqlite3.constants.php
*/
-define ('SQLITE3_FLOAT', 2);
+define('SQLITE3_FLOAT', 2);
/**
* Represents the SQLite3 TEXT storage class.
* @link https://php.net/manual/en/sqlite3.constants.php
*/
-define ('SQLITE3_TEXT', 3);
+define('SQLITE3_TEXT', 3);
/**
* Represents the SQLite3 BLOB storage class.
* @link https://php.net/manual/en/sqlite3.constants.php
*/
-define ('SQLITE3_BLOB', 4);
+define('SQLITE3_BLOB', 4);
/**
* Represents the SQLite3 NULL storage class.
* @link https://php.net/manual/en/sqlite3.constants.php
*/
-define ('SQLITE3_NULL', 5);
+define('SQLITE3_NULL', 5);
/**
* Specifies that the SQLite3 database be opened for reading only.
* @link https://php.net/manual/en/sqlite3.constants.php
*/
-define ('SQLITE3_OPEN_READONLY', 1);
+define('SQLITE3_OPEN_READONLY', 1);
/**
* Specifies that the SQLite3 database be opened for reading and writing.
* @link https://php.net/manual/en/sqlite3.constants.php
*/
-define ('SQLITE3_OPEN_READWRITE', 2);
+define('SQLITE3_OPEN_READWRITE', 2);
/**
* Specifies that the SQLite3 database be created if it does not already
* exist.
* @link https://php.net/manual/en/sqlite3.constants.php
*/
-define ('SQLITE3_OPEN_CREATE', 4);
+define('SQLITE3_OPEN_CREATE', 4);
// End of sqlite3 v.0.7-dev
-?>
diff --git a/sqlsrv/sqlsrv.php b/sqlsrv/sqlsrv.php
index 97520ffe3..c2f057a57 100644
--- a/sqlsrv/sqlsrv.php
+++ b/sqlsrv/sqlsrv.php
@@ -49,7 +49,7 @@
* Additional Information at {@link http://msdn.microsoft.com/en-us/library/cc296152.aspx SQLSRV Driver API Reference}
* @link https://docs.microsoft.com/en-us/sql/connect/php/constants-microsoft-drivers-for-php-for-sql-server
*/
-define('SQLSRV_LOG_SYSTEM_ALL',-1);
+define('SQLSRV_LOG_SYSTEM_ALL', -1);
/**
* Turns logging off.
@@ -262,7 +262,7 @@
*
* @link https://docs.microsoft.com/en-us/sql/connect/php/constants-microsoft-drivers-for-php-for-sql-server
*/
-define('SQLSRV_ENC_CHAR','char');
+define('SQLSRV_ENC_CHAR', 'char');
/**
* The column is not nullable.
@@ -928,7 +928,6 @@
*/
define('SQLSRV_CURSOR_CLIENT_BUFFERED', 'buffered');
-
/**
* Creates and opens a connection.
*
@@ -960,7 +959,7 @@
* See {@link http://msdn.microsoft.com/en-us/library/ff628167.aspx Connection Options} for a list of the supported keys for the array.
* @return resource|false A PHP connection resource. If a connection cannot be successfully created and opened, false is returned.
*/
-function sqlsrv_connect($server_name, $connection_info = array()){}
+function sqlsrv_connect($server_name, $connection_info = []) {}
/**
* Closes a connection. Frees all resources associated with the connection.
@@ -975,7 +974,7 @@ function sqlsrv_connect($server_name, $connection_info = array()){}
* @param resource|null $conn The connection to be closed.
* @return bool The Boolean value true unless the function is called with an invalid parameter. If the function is called with an invalid parameter, false is returned.
*/
-function sqlsrv_close($conn){}
+function sqlsrv_close($conn) {}
/**
* Commits a transaction that was begun with sqlsrv_begin_transaction.
@@ -996,7 +995,7 @@ function sqlsrv_close($conn){}
* @param resource $conn The connection on which the transaction is active.
* @return bool A Boolean value: true if the transaction was successfully committed. Otherwise, false.
*/
-function sqlsrv_commit($conn){}
+function sqlsrv_commit($conn) {}
/**
* Begins a database transaction.
@@ -1023,7 +1022,7 @@ function sqlsrv_commit($conn){}
* @param resource $conn The connection with which the transaction is associated.
* @return bool A Boolean value: true if the transaction was successfully begun. Otherwise, false.
*/
-function sqlsrv_begin_transaction($conn){}
+function sqlsrv_begin_transaction($conn) {}
/**
* Rolls back a transaction that was begun with {@see sqlsrv_begin_transaction}.
@@ -1047,7 +1046,7 @@ function sqlsrv_begin_transaction($conn){}
* @param resource $conn The connection on which the transaction is active.
* @return bool A Boolean value: true if the transaction was successfully rolled back. Otherwise, false.
*/
-function sqlsrv_rollback($conn){}
+function sqlsrv_rollback($conn) {}
/**
* Returns error and/or warning information about the last operation.
@@ -1100,7 +1099,7 @@ function sqlsrv_rollback($conn){}
*
* If no errors or warnings occur, null is returned.
*/
-function sqlsrv_errors($errorsAndOrWarnings = SQLSRV_ERR_ALL){}
+function sqlsrv_errors($errorsAndOrWarnings = SQLSRV_ERR_ALL) {}
/**
* Changes the driver error handling and logging configurations.
@@ -1129,7 +1128,7 @@ function sqlsrv_errors($errorsAndOrWarnings = SQLSRV_ERR_ALL){}
* false (0)
* @return bool If sqlsrv_configure is called with an unsupported setting or value, the function returns false. Otherwise, the function returns true.
*/
-function sqlsrv_configure($setting, $value){}
+function sqlsrv_configure($setting, $value) {}
/**
* Returns the current value of the specified configuration setting.
@@ -1144,7 +1143,7 @@ function sqlsrv_configure($setting, $value){}
* @param string $setting The configuration setting for which the value is returned.
* @return mixed|false The value of the setting specified by the $setting parameter. If an invalid setting is specified, false is returned and an error is added to the error collection.
*/
-function sqlsrv_get_config($setting){}
+function sqlsrv_get_config($setting) {}
/**
* Prepares a Transact-SQL query without executing it. Implicitly binds parameters.
@@ -1211,7 +1210,7 @@ function sqlsrv_get_config($setting){}
* SQLSRV_CURSOR_CLIENT_BUFFERED
* @return resource|false A statement resource. If the statement resource cannot be created, false is returned.
*/
-function sqlsrv_prepare($conn, $tsql, $params = array(), $options = array()){}
+function sqlsrv_prepare($conn, $tsql, $params = [], $options = []) {}
/**
* Executes a statement prepared with {@see sqlsrv_prepare}
@@ -1230,7 +1229,7 @@ function sqlsrv_prepare($conn, $tsql, $params = array(), $options = array()){}
* statement resource, see {@link sqlsrv_prepare() sqlsrv_prepare}.
* @return bool A Boolean value: true if the statement was successfully executed. Otherwise, false.
*/
-function sqlsrv_execute($stmt){}
+function sqlsrv_execute($stmt) {}
/**
* Prepares and executes a Transact-SQL query.
@@ -1285,7 +1284,7 @@ function sqlsrv_execute($stmt){}
* SQLSRV_CURSOR_CLIENT_BUFFERED
* @return resource|false A statement resource. If the statement cannot be created and/or executed, false is returned.
*/
-function sqlsrv_query($conn, $tsql, $params = array(), $options = array()){}
+function sqlsrv_query($conn, $tsql, $params = [], $options = []) {}
/**
* Makes the next row in a result set available for reading.
@@ -1310,7 +1309,7 @@ function sqlsrv_query($conn, $tsql, $params = array(), $options = array()){}
* @return bool|null If the next row of the result set was successfully retrieved, true is returned. If there are
* no more results in the result set, null is returned. If an error occurred, false is returned.
*/
-function sqlsrv_fetch($stmt, $row = null, $offset = null){}
+function sqlsrv_fetch($stmt, $row = null, $offset = null) {}
/**
* Retrieves a field in the current row by index. The PHP return type can be specified.
@@ -1345,7 +1344,7 @@ function sqlsrv_fetch($stmt, $row = null, $offset = null){}
* information about specifying PHP data types,
* see {@link http://msdn.microsoft.com/en-us/library/cc296208.aspx How to: Specify PHP Data Types}.
*/
-function sqlsrv_get_field($stmt, $field_index, $get_as_type=null){}
+function sqlsrv_get_field($stmt, $field_index, $get_as_type = null) {}
/**
* Retrieves the next row of data as a numerically indexed array, an associative array, or both.
@@ -1393,7 +1392,7 @@ function sqlsrv_get_field($stmt, $field_index, $get_as_type=null){}
* retrieve. The first record in the result set is 0.
* @return array|null|false If a row of data is retrieved, an array is returned. If there are no more rows to retrieve, null is returned. If an error occurs, false is returned.
*/
-function sqlsrv_fetch_array($stmt, $fetch_type = null, $row = null, $offset = null){}
+function sqlsrv_fetch_array($stmt, $fetch_type = null, $row = null, $offset = null) {}
/**
* Retrieves the next row of data as an object.
@@ -1426,7 +1425,7 @@ function sqlsrv_fetch_array($stmt, $fetch_type = null, $row = null, $offset = nu
* The data type of a value in the returned object will be the default PHP data type. For information on default PHP data
* types, see {@link http://msdn.microsoft.com/en-us/library/cc296193.aspx Default PHP Data Types}.
*/
-function sqlsrv_fetch_object($stmt, $class_name = null, $ctor_params = null, $row = null, $offset = null){}
+function sqlsrv_fetch_object($stmt, $class_name = null, $ctor_params = null, $row = null, $offset = null) {}
/**
* Detects if a result set has one or more rows.
@@ -1440,7 +1439,7 @@ function sqlsrv_fetch_object($stmt, $class_name = null, $ctor_params = null, $ro
* @return bool If there are rows in the result set, the return value will be true. If there are no rows, or if the
* function call fails, the return value will be false.
*/
-function sqlsrv_has_rows($stmt){}
+function sqlsrv_has_rows($stmt) {}
/**
* Retrieves the number of fields (columns) on a statemen.
@@ -1456,7 +1455,7 @@ function sqlsrv_has_rows($stmt){}
* @return int|false An integer value that represents the number of fields in the active result set. If an error occurs,
* the Boolean value false is returned.
*/
-function sqlsrv_num_fields($stmt){}
+function sqlsrv_num_fields($stmt) {}
/**
* Makes the next result of the specified statement active.
@@ -1474,7 +1473,7 @@ function sqlsrv_num_fields($stmt){}
* @return bool|null If the next result was successfully made active, the Boolean value true is returned. If an error occurred in
* making the next result active, false is returned. If no more results are available, null is returned.
*/
-function sqlsrv_next_result($stmt){}
+function sqlsrv_next_result($stmt) {}
/**
* Retrieves the number of rows in a result set.
@@ -1491,7 +1490,7 @@ function sqlsrv_next_result($stmt){}
* @param resource $stmt The result set for which to count the rows.
* @return int|false False if there was an error calculating the number of rows. Otherwise, returns the number of rows in the result set.
*/
-function sqlsrv_num_rows($stmt){}
+function sqlsrv_num_rows($stmt) {}
/**
* Returns the number of modified rows.
@@ -1507,7 +1506,7 @@ function sqlsrv_num_rows($stmt){}
* modified, zero (0) is returned. If no information about the number of modified rows is available, negative one (-1)
* is returned. If an error occurred in retrieving the number of modified rows, false is returned.
*/
-function sqlsrv_rows_affected($stmt){}
+function sqlsrv_rows_affected($stmt) {}
/**
* Provides information about the client.
@@ -1525,7 +1524,7 @@ function sqlsrv_rows_affected($stmt){}
* DriverVer - SQL Server Native Client DLL version: 10.50.xxx (Microsoft Drivers for PHP for SQL Server version 2.0)
* ExtensionVer - php_sqlsrv.dll version: 2.0.xxxx.x(Microsoft Drivers for PHP for SQL Server version 2.0)
*/
-function sqlsrv_client_info($conn){}
+function sqlsrv_client_info($conn) {}
/**
* Returns information about the server.
@@ -1541,7 +1540,7 @@ function sqlsrv_client_info($conn){}
* SQLServerVersion - The version of SQL Server.
* SQLServerName - The name of the server.
*/
-function sqlsrv_server_info($conn){}
+function sqlsrv_server_info($conn) {}
/**
* Cancels a statement; discards any pending results for the statement.
@@ -1561,7 +1560,7 @@ function sqlsrv_server_info($conn){}
* @param resource $stmt The statement to be canceled.
* @return bool A Boolean value: true if the operation was successful. Otherwise, false.
*/
-function sqlsrv_cancel($stmt){}
+function sqlsrv_cancel($stmt) {}
/**
* Closes a statement. Frees all resources associated with the statement.
@@ -1582,7 +1581,7 @@ function sqlsrv_cancel($stmt){}
* @return bool The Boolean value true unless the function is called with an invalid parameter. If the function is
* called with an invalid parameter, false is returned.
*/
-function sqlsrv_free_stmt($stmt){}
+function sqlsrv_free_stmt($stmt) {}
/**
* Returns field metadata.
@@ -1613,7 +1612,7 @@ function sqlsrv_free_stmt($stmt){}
* See the {@link http://msdn.microsoft.com/en-us/library/cc296197.aspx function documentation} for more information on
* the keys for each sub-array.
*/
-function sqlsrv_field_metadata($stmt){}
+function sqlsrv_field_metadata($stmt) {}
/**
* Sends up to eight kilobytes (8 KB) of data to the server with each call to the function.
@@ -1632,7 +1631,7 @@ function sqlsrv_field_metadata($stmt){}
* @param resource $stmt A statement resource corresponding to an executed statement.
* @return bool Boolean : true if there is more data to be sent. Otherwise, false.
*/
-function sqlsrv_send_stream_data($stmt){}
+function sqlsrv_send_stream_data($stmt) {}
/**
* Specifies the encoding of a stream of data from the server.
@@ -1661,7 +1660,7 @@ function sqlsrv_send_stream_data($stmt){}
* @return int Value to use in any place that accepts a SQLSRV_PHPTYPE_* constant to represent a PHP stream with the
* given encoding.
*/
-function SQLSRV_PHPTYPE_STREAM($encoding){}
+function SQLSRV_PHPTYPE_STREAM($encoding) {}
/**
* Specifies the encoding of a string being received form the server.
@@ -1690,7 +1689,7 @@ function SQLSRV_PHPTYPE_STREAM($encoding){}
* @return int Value to use in any place that accepts a SQLSRV_PHPTYPE_* constant to represent a PHP string with the
* given encoding.
*/
-function SQLSRV_PHPTYPE_STRING($encoding){}
+function SQLSRV_PHPTYPE_STRING($encoding) {}
/**
* Specifies a SQL Server binary field.
@@ -1703,7 +1702,7 @@ function SQLSRV_PHPTYPE_STRING($encoding){}
* @param int $byteCount Must be between 1 and 8000.
* @return int Value to use in any place that accepts a SQLSRV_SQLTYPE_* constant to represent the 'binary' data type.
*/
-function SQLSRV_SQLTYPE_BINARY($byteCount){}
+function SQLSRV_SQLTYPE_BINARY($byteCount) {}
/**
* Specifies a SQL Server varbinary field.
@@ -1716,7 +1715,7 @@ function SQLSRV_SQLTYPE_BINARY($byteCount){}
* @param int|string $byteCount Must be between 1 and 8000 or 'max'.
* @return int Value to use in any place that accepts a SQLSRV_SQLTYPE_* constant to represent the varbinary data type.
*/
-function SQLSRV_SQLTYPE_VARBINARY($byteCount){}
+function SQLSRV_SQLTYPE_VARBINARY($byteCount) {}
/**
* Specifies a SQL Server varchar filed.
@@ -1744,7 +1743,7 @@ function SQLSRV_SQLTYPE_VARCHAR($charCount) {}
* @param int $charCount Must be between 1 and 8000.
* @return int Value to use in any place that accepts a SQLSRV_SQLTYPE_* constant to represent the char data type.
*/
-function SQLSRV_SQLTYPE_CHAR($charCount){}
+function SQLSRV_SQLTYPE_CHAR($charCount) {}
/**
* Specifies a SQL Server nchar field.
@@ -1757,7 +1756,7 @@ function SQLSRV_SQLTYPE_CHAR($charCount){}
* @param int $charCount Must be between 1 and 4000.
* @return int Value to use in any place that accepts a SQLSRV_SQLTYPE_* constant to represent the nchar data type.
*/
-function SQLSRV_SQLTYPE_NCHAR($charCount){}
+function SQLSRV_SQLTYPE_NCHAR($charCount) {}
/**
* Specifies a SQL Server nvarchar field.
@@ -1770,7 +1769,7 @@ function SQLSRV_SQLTYPE_NCHAR($charCount){}
* @param int|string $charCount Must be between 1 and 4000 or 'max'.
* @return int Value to use in any place that accepts a SQLSRV_SQLTYPE_* constant to represent the nvarchar data type.
*/
-function SQLSRV_SQLTYPE_NVARCHAR($charCount){}
+function SQLSRV_SQLTYPE_NVARCHAR($charCount) {}
/**
* Specifies a SQL Server decimal field.
@@ -1784,7 +1783,7 @@ function SQLSRV_SQLTYPE_NVARCHAR($charCount){}
* @param int $scale Must be between 1 and $precision.
* @return int Value to use in any place that accepts a SQLSRV_SQLTYPE_* constant to represent the decimal data type.
*/
-function SQLSRV_SQLTYPE_DECIMAL($precision, $scale){}
+function SQLSRV_SQLTYPE_DECIMAL($precision, $scale) {}
/**
* Specifies a SQL Server numeric field.
@@ -1798,4 +1797,4 @@ function SQLSRV_SQLTYPE_DECIMAL($precision, $scale){}
* @param int $scale Must be between 1 and $precision.
* @return int Value to use in any place that accepts a SQLSRV_SQLTYPE_* constant to represent the numeric data type.
*/
-function SQLSRV_SQLTYPE_NUMERIC($precision, $scale){}
+function SQLSRV_SQLTYPE_NUMERIC($precision, $scale) {}
diff --git a/ssh2/ssh2.php b/ssh2/ssh2.php
index 5ddbe440f..ddf007b8e 100644
--- a/ssh2/ssh2.php
+++ b/ssh2/ssh2.php
@@ -175,7 +175,7 @@
*
* @return resource|false a resource on success, or false on error.
*/
-function ssh2_connect ($host, $port = null, ?array $methods = null , ?array $callbacks = null ) {}
+function ssh2_connect($host, $port = null, ?array $methods = null, ?array $callbacks = null) {}
/**
* (PECL ssh2 >= 1.0)
@@ -187,7 +187,7 @@ function ssh2_connect ($host, $port = null, ?array $methods = null , ?array $cal
*
* @return bool
*/
-function ssh2_disconnect ($session) {}
+function ssh2_disconnect($session) {}
/**
* (PECL ssh2 >= 0.9.0)
@@ -199,7 +199,7 @@ function ssh2_disconnect ($session) {}
*
* @return array
*/
-function ssh2_methods_negotiated ($session) {}
+function ssh2_methods_negotiated($session) {}
/**
* (PECL ssh2 >= 0.9.0)
@@ -218,7 +218,7 @@ function ssh2_methods_negotiated ($session) {}
*
* @return string the hostkey hash as a string.
*/
-function ssh2_fingerprint ($session, $flags = null) {}
+function ssh2_fingerprint($session, $flags = null) {}
/**
* (PECL ssh2 >= 0.9.0)
@@ -234,7 +234,7 @@ function ssh2_fingerprint ($session, $flags = null) {}
* @return array|bool true if the server does accept "none" as an authentication
* method, or an array of accepted authentication methods on failure.
*/
-function ssh2_auth_none ($session, $username) {}
+function ssh2_auth_none($session, $username) {}
/**
* (PECL ssh2 >= 0.9.0)
@@ -252,7 +252,7 @@ function ssh2_auth_none ($session, $username) {}
*
* @return bool true on success or false on failure.
*/
-function ssh2_auth_password ($session, $username, $password) {}
+function ssh2_auth_password($session, $username, $password) {}
/**
* (PECL ssh2 >= 0.9.0)
@@ -274,7 +274,7 @@ function ssh2_auth_password ($session, $username, $password) {}
*
* @return bool true on success or false on failure.
*/
-function ssh2_auth_pubkey_file ($session, $username, $pubkeyfile, $privkeyfile, $passphrase = null) {}
+function ssh2_auth_pubkey_file($session, $username, $pubkeyfile, $privkeyfile, $passphrase = null) {}
/**
* (PECL ssh2 >= 0.9.0)
@@ -302,11 +302,11 @@ function ssh2_auth_pubkey_file ($session, $username, $pubkeyfile, $privkeyfile,
*
* @return bool true on success or false on failure.
*/
-function ssh2_auth_hostbased_file ($session, $username, $hostname, $pubkeyfile, $privkeyfile, $passphrase = null, $local_username = null) {}
+function ssh2_auth_hostbased_file($session, $username, $hostname, $pubkeyfile, $privkeyfile, $passphrase = null, $local_username = null) {}
-function ssh2_forward_listen () {}
+function ssh2_forward_listen() {}
-function ssh2_forward_accept () {}
+function ssh2_forward_accept() {}
/**
* (PECL ssh2 >= 0.9.0)
@@ -337,7 +337,7 @@ function ssh2_forward_accept () {}
*
* @return resource
*/
-function ssh2_shell ($session, $term_type = null, ?array $env = null , $width = null, $height = null, $width_height_type = null) {}
+function ssh2_shell($session, $term_type = null, ?array $env = null, $width = null, $height = null, $width_height_type = null) {}
/**
* (PECL ssh2 >= 0.9.0)
@@ -368,7 +368,7 @@ function ssh2_shell ($session, $term_type = null, ?array $env = null , $width =
*
* @return resource|false a stream on success or false on failure.
*/
-function ssh2_exec ($session, $command, $pty = null, ?array $env = null , $width = null, $height = null, $width_height_type = null) {}
+function ssh2_exec($session, $command, $pty = null, ?array $env = null, $width = null, $height = null, $width_height_type = null) {}
/**
* (PECL ssh2 >= 0.9.0)
@@ -384,7 +384,7 @@ function ssh2_exec ($session, $command, $pty = null, ?array $env = null , $width
*
* @return resource
*/
-function ssh2_tunnel ($session, $host, $port) {}
+function ssh2_tunnel($session, $host, $port) {}
/**
* (PECL ssh2 >= 0.9.0)
@@ -402,7 +402,7 @@ function ssh2_tunnel ($session, $host, $port) {}
*
* @return bool true on success or false on failure.
*/
-function ssh2_scp_recv ($session, $remote_file, $local_file) {}
+function ssh2_scp_recv($session, $remote_file, $local_file) {}
/**
* (PECL ssh2 >= 0.9.0)
@@ -424,7 +424,7 @@ function ssh2_scp_recv ($session, $remote_file, $local_file) {}
*
* @return bool true on success or false on failure.
*/
-function ssh2_scp_send ($session, $local_file, $remote_file, $create_mode = null) {}
+function ssh2_scp_send($session, $local_file, $remote_file, $create_mode = null) {}
/**
* (PECL ssh2 >= 0.9.0)
@@ -437,12 +437,12 @@ function ssh2_scp_send ($session, $local_file, $remote_file, $create_mode = null
*
* @return resource the requested stream resource.
*/
-function ssh2_fetch_stream ($channel, $streamid) {}
+function ssh2_fetch_stream($channel, $streamid) {}
/**
* @param array &$var1
*/
-function ssh2_poll (&$var1) {}
+function ssh2_poll(&$var1) {}
/**
* (PECL ssh2 >= 0.9.0)
@@ -456,7 +456,7 @@ function ssh2_poll (&$var1) {}
* all other ssh2_sftp_*() methods and the
* ssh2.sftp:// fopen wrapper.
*/
-function ssh2_sftp ($session) {}
+function ssh2_sftp($session) {}
/**
* (PECL ssh2 >= 0.9.0)
@@ -473,7 +473,7 @@ function ssh2_sftp ($session) {}
*
* @return bool true on success or false on failure.
*/
-function ssh2_sftp_rename ($sftp, $from, $to) {}
+function ssh2_sftp_rename($sftp, $from, $to) {}
/**
* (PECL ssh2 >= 0.9.0)
@@ -486,7 +486,7 @@ function ssh2_sftp_rename ($sftp, $from, $to) {}
*
* @return bool true on success or false on failure.
*/
-function ssh2_sftp_unlink ($sftp, $filename) {}
+function ssh2_sftp_unlink($sftp, $filename) {}
/**
* (PECL ssh2 >= 0.9.0)
@@ -507,7 +507,7 @@ function ssh2_sftp_unlink ($sftp, $filename) {}
*
* @return bool true on success or false on failure.
*/
-function ssh2_sftp_mkdir ($sftp, $dirname, $mode = null, $recursive = null) {}
+function ssh2_sftp_mkdir($sftp, $dirname, $mode = null, $recursive = null) {}
/**
* (PECL ssh2 >= 0.9.0)
@@ -520,7 +520,7 @@ function ssh2_sftp_mkdir ($sftp, $dirname, $mode = null, $recursive = null) {}
*
* @return bool true on success or false on failure.
*/
-function ssh2_sftp_rmdir ($sftp, $dirname) {}
+function ssh2_sftp_rmdir($sftp, $dirname) {}
/**
* (PECL ssh2 >= 0.9.0)
@@ -534,7 +534,7 @@ function ssh2_sftp_rmdir ($sftp, $dirname) {}
* @return array|false See the documentation for stat for details on the
* values which may be returned.
*/
-function ssh2_sftp_stat ($sftp, $path) {}
+function ssh2_sftp_stat($sftp, $path) {}
/**
* (PECL ssh2 >= 0.9.0)
@@ -548,7 +548,7 @@ function ssh2_sftp_stat ($sftp, $path) {}
* @return array See the documentation for stat for details on the
* values which may be returned.
*/
-function ssh2_sftp_lstat ($sftp, $path) {}
+function ssh2_sftp_lstat($sftp, $path) {}
/**
* (PECL ssh2 >= 0.9.0)
@@ -564,7 +564,7 @@ function ssh2_sftp_lstat ($sftp, $path) {}
*
* @return bool true on success or false on failure.
*/
-function ssh2_sftp_symlink ($sftp, $target, $link) {}
+function ssh2_sftp_symlink($sftp, $target, $link) {}
/**
* (PECL ssh2 >= 0.9.0)
@@ -578,7 +578,7 @@ function ssh2_sftp_symlink ($sftp, $target, $link) {}
*
* @return string the target of the symbolic link.
*/
-function ssh2_sftp_readlink ($sftp, $link) {}
+function ssh2_sftp_readlink($sftp, $link) {}
/**
* (PECL ssh2 >= 0.9.0)
@@ -591,7 +591,7 @@ function ssh2_sftp_readlink ($sftp, $link) {}
*
* @return string the real path as a string.
*/
-function ssh2_sftp_realpath ($sftp, $filename) {}
+function ssh2_sftp_realpath($sftp, $filename) {}
/**
* (PECL ssh2 >= 0.10)
@@ -602,7 +602,7 @@ function ssh2_sftp_realpath ($sftp, $filename) {}
* @return resource|false an SSH2 Publickey Subsystem resource for use
* with all other ssh2_publickey_*() methods or false on failure.
*/
-function ssh2_publickey_init ($session) {}
+function ssh2_publickey_init($session) {}
/**
* (PECL ssh2 >= 0.10)
@@ -629,7 +629,7 @@ function ssh2_publickey_init ($session) {}
*
* @return bool true on success or false on failure.
*/
-function ssh2_publickey_add ($pkey, $algoname, $blob, $overwrite = null, ?array $attributes = null ) {}
+function ssh2_publickey_add($pkey, $algoname, $blob, $overwrite = null, ?array $attributes = null) {}
/**
* (PECL ssh2 >= 0.10)
@@ -646,7 +646,7 @@ function ssh2_publickey_add ($pkey, $algoname, $blob, $overwrite = null, ?array
*
* @return bool true on success or false on failure.
*/
-function ssh2_publickey_remove ($pkey, $algoname, $blob) {}
+function ssh2_publickey_remove($pkey, $algoname, $blob) {}
/**
* (PECL ssh2 >= 0.10)
@@ -684,7 +684,7 @@ function ssh2_publickey_remove ($pkey, $algoname, $blob) {}
*
*
*/
-function ssh2_publickey_list ($pkey) {}
+function ssh2_publickey_list($pkey) {}
/**
* (PECL ssh2 >= 0.12)
@@ -695,7 +695,7 @@ function ssh2_publickey_list ($pkey) {}
* @param int $mode Permissions on the file. See the chmod() for more details on this parameter.
* @return bool Returns TRUE on success or FALSE on failure.
*/
-function ssh2_sftp_chmod ($sftp, $filename, $mode) {}
+function ssh2_sftp_chmod($sftp, $filename, $mode) {}
/**
* (PECL ssh2 >= 0.12)
@@ -711,35 +711,35 @@ function ssh2_sftp_chmod ($sftp, $filename, $mode) {}
* @param string $username Remote user name.
* @return bool Returns TRUE on success or FALSE on failure.
*/
-function ssh2_auth_agent ($session, $username) {}
+function ssh2_auth_agent($session, $username) {}
/**
* Flag to ssh2_fingerprint requesting hostkey
* fingerprint as an MD5 hash.
* @link https://php.net/manual/en/ssh2.constants.php
*/
-define ('SSH2_FINGERPRINT_MD5', 0);
+define('SSH2_FINGERPRINT_MD5', 0);
/**
* Flag to ssh2_fingerprint requesting hostkey
* fingerprint as an SHA1 hash.
* @link https://php.net/manual/en/ssh2.constants.php
*/
-define ('SSH2_FINGERPRINT_SHA1', 1);
+define('SSH2_FINGERPRINT_SHA1', 1);
/**
* Flag to ssh2_fingerprint requesting hostkey
* fingerprint as a string of hexits.
* @link https://php.net/manual/en/ssh2.constants.php
*/
-define ('SSH2_FINGERPRINT_HEX', 0);
+define('SSH2_FINGERPRINT_HEX', 0);
/**
* Flag to ssh2_fingerprint requesting hostkey
* fingerprint as a raw string of 8-bit characters.
* @link https://php.net/manual/en/ssh2.constants.php
*/
-define ('SSH2_FINGERPRINT_RAW', 2);
+define('SSH2_FINGERPRINT_RAW', 2);
/**
* Flag to ssh2_shell specifying that
@@ -747,7 +747,7 @@ function ssh2_auth_agent ($session, $username) {}
* are provided as character sizes.
* @link https://php.net/manual/en/ssh2.constants.php
*/
-define ('SSH2_TERM_UNIT_CHARS', 0);
+define('SSH2_TERM_UNIT_CHARS', 0);
/**
* Flag to ssh2_shell specifying that
@@ -755,50 +755,50 @@ function ssh2_auth_agent ($session, $username) {}
* are provided in pixel units.
* @link https://php.net/manual/en/ssh2.constants.php
*/
-define ('SSH2_TERM_UNIT_PIXELS', 1);
+define('SSH2_TERM_UNIT_PIXELS', 1);
/**
* Default terminal type (e.g. vt102, ansi, xterm, vanilla) requested
* by ssh2_shell.
* @link https://php.net/manual/en/ssh2.constants.php
*/
-define ('SSH2_DEFAULT_TERMINAL', "vanilla");
+define('SSH2_DEFAULT_TERMINAL', "vanilla");
/**
* Default terminal width requested by ssh2_shell.
* @link https://php.net/manual/en/ssh2.constants.php
*/
-define ('SSH2_DEFAULT_TERM_WIDTH', 80);
+define('SSH2_DEFAULT_TERM_WIDTH', 80);
/**
* Default terminal height requested by ssh2_shell.
* @link https://php.net/manual/en/ssh2.constants.php
*/
-define ('SSH2_DEFAULT_TERM_HEIGHT', 25);
+define('SSH2_DEFAULT_TERM_HEIGHT', 25);
/**
* Default terminal units requested by ssh2_shell.
* @link https://php.net/manual/en/ssh2.constants.php
*/
-define ('SSH2_DEFAULT_TERM_UNIT', 0);
+define('SSH2_DEFAULT_TERM_UNIT', 0);
/**
* Flag to ssh2_fetch_stream requesting STDIO subchannel.
* @link https://php.net/manual/en/ssh2.constants.php
*/
-define ('SSH2_STREAM_STDIO', 0);
+define('SSH2_STREAM_STDIO', 0);
/**
* Flag to ssh2_fetch_stream requesting STDERR subchannel.
* @link https://php.net/manual/en/ssh2.constants.php
*/
-define ('SSH2_STREAM_STDERR', 1);
-define ('SSH2_POLLIN', 1);
-define ('SSH2_POLLEXT', 2);
-define ('SSH2_POLLOUT', 4);
-define ('SSH2_POLLERR', 8);
-define ('SSH2_POLLHUP', 16);
-define ('SSH2_POLLNVAL', 32);
-define ('SSH2_POLL_SESSION_CLOSED', 16);
-define ('SSH2_POLL_CHANNEL_CLOSED', 128);
-define ('SSH2_POLL_LISTENER_CLOSED', 128);
+define('SSH2_STREAM_STDERR', 1);
+define('SSH2_POLLIN', 1);
+define('SSH2_POLLEXT', 2);
+define('SSH2_POLLOUT', 4);
+define('SSH2_POLLERR', 8);
+define('SSH2_POLLHUP', 16);
+define('SSH2_POLLNVAL', 32);
+define('SSH2_POLL_SESSION_CLOSED', 16);
+define('SSH2_POLL_CHANNEL_CLOSED', 128);
+define('SSH2_POLL_LISTENER_CLOSED', 128);
diff --git a/standard/CSPRNG.php b/standard/CSPRNG.php
index d9d30d172..e591f9412 100644
--- a/standard/CSPRNG.php
+++ b/standard/CSPRNG.php
@@ -7,8 +7,7 @@
* @since 7.0
* @throws Exception if it was not possible to gather sufficient entropy.
*/
-function random_bytes (int $length): string
-{}
+function random_bytes(int $length): string {}
/**
* Generates cryptographically secure pseudo-random integers
@@ -19,5 +18,4 @@ function random_bytes (int $length): string
* @since 7.0
* @throws Exception if it was not possible to gather sufficient entropy.
*/
-function random_int (int $min, int $max): int
-{}
+function random_int(int $min, int $max): int {}
diff --git a/standard/_standard_manual.php b/standard/_standard_manual.php
index e8f1df426..f8bfb23b1 100644
--- a/standard/_standard_manual.php
+++ b/standard/_standard_manual.php
@@ -9,7 +9,7 @@
* @link https://php.net/manual/en/function.halt-compiler.php
* @return void
*/
-function PS_UNRESERVE_PREFIX___halt_compiler(){}
+function PS_UNRESERVE_PREFIX___halt_compiler() {}
/**
* (PHP 5.1)
@@ -17,8 +17,7 @@ function PS_UNRESERVE_PREFIX___halt_compiler(){}
* @link https://php.net/manual/en/function.halt-compiler.php
* @return void
*/
-define("__COMPILER_HALT_OFFSET__",0);
-
+define("__COMPILER_HALT_OFFSET__", 0);
/**
* Convert hexadecimal string to its binary representation.
@@ -32,13 +31,11 @@ function PS_UNRESERVE_PREFIX___halt_compiler(){}
* @see unpack()
* @since 5.4
*/
-function hex2bin(string $string): string|false
-{};
+function hex2bin(string $string): string|false {};
/**
* Get or Set the HTTP response code
* @param int $response_code [optional] The optional response_code will set the response code.
* @return int|bool The current response code. By default the return value is int(200).
*/
-function http_response_code(int $response_code): int|bool
-{}
+function http_response_code(int $response_code): int|bool {}
diff --git a/standard/_types.php b/standard/_types.php
index 1e8710682..5a92c1543 100644
--- a/standard/_types.php
+++ b/standard/_types.php
@@ -1,7 +1,6 @@
* @return array an array of the parameters. The parameters can be given an index with the => operator.
*/
- function PS_UNRESERVE_PREFIX_array(...$_){};
+ function PS_UNRESERVE_PREFIX_array(...$_) {};
/**
* Assigns a list of variables in one operation.
@@ -25,7 +24,7 @@ function PS_UNRESERVE_PREFIX_array(...$_){};
* @param mixed ...$_ [optional] Another variable ...
* @return array the assigned array.
*/
- function PS_UNRESERVE_PREFIX_list($var1, ...$_){};
+ function PS_UNRESERVE_PREFIX_list($var1, ...$_) {};
/**
* Terminates execution of the script. Shutdown functions and object destructors will always be executed even if exit is called.
@@ -43,7 +42,7 @@ function PS_UNRESERVE_PREFIX_list($var1, ...$_){};
*
* @return void
*/
- function PS_UNRESERVE_PREFIX_die($status = ""){};
+ function PS_UNRESERVE_PREFIX_die($status = "") {};
/**
* Terminates execution of the script. Shutdown functions and object destructors will always be executed even if exit is called.
@@ -61,7 +60,7 @@ function PS_UNRESERVE_PREFIX_die($status = ""){};
*
* @return void
*/
- function PS_UNRESERVE_PREFIX_exit($status = ""){};
+ function PS_UNRESERVE_PREFIX_exit($status = "") {};
/**
* Determine whether a variable is considered to be empty. A variable is considered empty if it does not exist or if its value
@@ -90,7 +89,7 @@ function PS_UNRESERVE_PREFIX_exit($status = ""){};
*
*
*/
- function PS_UNRESERVE_PREFIX_empty($var){};
+ function PS_UNRESERVE_PREFIX_empty($var) {};
/**
* Determine if a variable is set and is not NULL.
@@ -103,7 +102,7 @@ function PS_UNRESERVE_PREFIX_empty($var){};
* @param mixed ...$_ [optional] Another variable ...
* @return bool Returns TRUE if var exists and has value other than NULL, FALSE otherwise.
*/
- function PS_UNRESERVE_PREFIX_isset($var, ...$_){};
+ function PS_UNRESERVE_PREFIX_isset($var, ...$_) {};
/**
* Destroys the specified variables.
@@ -113,7 +112,7 @@ function PS_UNRESERVE_PREFIX_isset($var, ...$_){};
* @param mixed ...$_ [optional] Another variable ...
* @return void
*/
- function PS_UNRESERVE_PREFIX_unset($var, ...$_){};
+ function PS_UNRESERVE_PREFIX_unset($var, ...$_) {};
/**
* Evaluates the given code as PHP.
@@ -145,14 +144,15 @@ function PS_UNRESERVE_PREFIX_unset($var, ...$_){};
* case eval() returned FALSE and execution of the following code continued normally. It is not possible to catch a parse
* error in eval() using set_error_handler().
*/
- function PS_UNRESERVE_PREFIX_eval($code){};
+ function PS_UNRESERVE_PREFIX_eval($code) {};
/**
* Generator objects are returned from generators, cannot be instantiated via new.
* @link https://secure.php.net/manual/en/class.generator.php
* @link https://wiki.php.net/rfc/generators
*/
- final class Generator implements Iterator {
+ final class Generator implements Iterator
+{
/**
* Throws an exception if the generator is currently after the first yield.
* @return void
@@ -208,18 +208,17 @@ public function getReturn() {}
* @link https://php.net/manual/en/generator.wakeup.php
* @return void
*/
- public function __wakeup(){}
+ public function __wakeup() {}
}
class ClosedGeneratorException extends Exception {}
-
}
namespace ___PHPSTORM_HELPERS {
-
class PS_UNRESERVE_PREFIX_this {}
class PS_UNRESERVE_PREFIX_static {}
-class object {
+class object
+{
/**
* PHP 5 allows developers to declare constructor methods for classes.
* Classes which have a constructor method call this method on each newly-created object,
@@ -280,14 +279,14 @@ public static function __callStatic(string $name, array $arguments) {}
*/
public function __get(string $name) {}
- /**
- * run when writing data to inaccessible members.
- *
- * @param string $name
- * @param mixed $value
- * @return void
- * @link https://php.net/manual/en/language.oop5.overloading.php#language.oop5.overloading.members
- */
+ /**
+ * run when writing data to inaccessible members.
+ *
+ * @param string $name
+ * @param mixed $value
+ * @return void
+ * @link https://php.net/manual/en/language.oop5.overloading.php#language.oop5.overloading.members
+ */
public function __set(string $name, $value): void {}
/**
@@ -383,9 +382,7 @@ public function __clone(): void {}
* @since 7.4
* @link https://wiki.php.net/rfc/custom_object_serialization
*/
- public function __serialize(): array
- {
- }
+ public function __serialize(): array {}
/**
* Restores the object state from the given data array.
@@ -393,9 +390,6 @@ public function __serialize(): array
* @since 7.4
* @link https://wiki.php.net/rfc/custom_object_serialization
*/
- public function __unserialize(array $data): void
- {
- }
-
+ public function __unserialize(array $data): void {}
}
}
diff --git a/standard/basic.php b/standard/basic.php
index 9485a0530..d40ca9485 100644
--- a/standard/basic.php
+++ b/standard/basic.php
@@ -38,8 +38,7 @@
* @link https://php.net/manual/en/function.dl.php
*/
#[Deprecated(since: '5.3')]
-function dl (string $extension_filename): bool
-{}
+function dl(string $extension_filename): bool {}
/**
* Sets the process title
@@ -50,8 +49,7 @@ function dl (string $extension_filename): bool
* @return bool TRUE on success or FALSE on failure.
* @since 5.5
*/
-function cli_set_process_title (string $title): bool
-{}
+function cli_set_process_title(string $title): bool {}
/**
* Returns the current process title
@@ -60,8 +58,7 @@ function cli_set_process_title (string $title): bool
* @since 5.5
*/
#[Pure]
-function cli_get_process_title (): ?string
-{}
+function cli_get_process_title(): ?string {}
/**
* Verify that the contents of a variable is accepted by the iterable pseudo-type, i.e. that it is an array or an object implementing Traversable
@@ -71,8 +68,7 @@ function cli_get_process_title (): ?string
* @link https://php.net/manual/en/function.is-iterable.php
*/
#[Pure]
-function is_iterable(mixed $value): bool
-{}
+function is_iterable(mixed $value): bool {}
/**
* Encodes an ISO-8859-1 string to UTF-8
@@ -83,8 +79,7 @@ function is_iterable(mixed $value): bool
* @return string the UTF-8 translation of data.
*/
#[Pure]
-function utf8_encode (string $string): string
-{}
+function utf8_encode(string $string): string {}
/**
* Converts a string with ISO-8859-1 characters encoded with UTF-8
@@ -96,8 +91,7 @@ function utf8_encode (string $string): string
* @return string the ISO-8859-1 translation of data.
*/
#[Pure]
-function utf8_decode (string $string): string
-{}
+function utf8_decode(string $string): string {}
/**
* Clear the most recent error
@@ -105,7 +99,7 @@ function utf8_decode (string $string): string
* @return void
* @since 7.0
*/
-function error_clear_last (): void {}
+function error_clear_last(): void {}
/**
* Get process codepage
@@ -113,8 +107,7 @@ function error_clear_last (): void {}
* @return int
* @since 7.1
*/
-function sapi_windows_cp_get(string $kind): int
-{}
+function sapi_windows_cp_get(string $kind): int {}
/**
* Set process codepage
@@ -122,8 +115,7 @@ function sapi_windows_cp_get(string $kind): int
* @return bool
* @since 7.1
*/
-function sapi_windows_cp_set(int $cp): bool
-{}
+function sapi_windows_cp_set(int $cp): bool {}
/**
* Convert string from one codepage to another
@@ -133,16 +125,14 @@ function sapi_windows_cp_set(int $cp): bool
* @return string
* @since 7.1
*/
-function sapi_windows_cp_conv(int|string $in_codepage, int|string $out_codepage, string $subject): string
-{}
+function sapi_windows_cp_conv(int|string $in_codepage, int|string $out_codepage, string $subject): string {}
/**
* Indicates whether the codepage is utf-8 compatible
* @return bool
* @since 7.1
*/
-function sapi_windows_cp_is_utf8(): bool
-{}
+function sapi_windows_cp_is_utf8(): bool {}
/**
* Get or set VT100 support for the specified stream associated to an output buffer of a Windows console.
@@ -165,8 +155,7 @@ function sapi_windows_cp_is_utf8(): bool
* If enable is specified: Returns TRUE on success or FALSE on failure.
* @since 7.2
*/
-function sapi_windows_vt100_support ($stream, bool $enable): bool
-{}
+function sapi_windows_vt100_support($stream, bool $enable): bool {}
/**
* Set or remove a CTRL event handler.
@@ -177,8 +166,7 @@ function sapi_windows_vt100_support ($stream, bool $enable): bool
* @return bool TRUE on success or FALSE on failure.
* @since 7.4
*/
-function sapi_windows_set_ctrl_handler (callable $callable, bool $add = true): bool
-{}
+function sapi_windows_set_ctrl_handler(callable $callable, bool $add = true): bool {}
/**
* Send a CTRL event to another process.
@@ -189,8 +177,7 @@ function sapi_windows_set_ctrl_handler (callable $callable, bool $add = true): b
* @return bool TRUE on success or FALSE on failure.
* @since 7.4
*/
-function sapi_windows_generate_ctrl_event (int $event, int $pid = 0): bool
-{}
+function sapi_windows_generate_ctrl_event(int $event, int $pid = 0): bool {}
/**
* The full path and filename of the file. If used inside an include,
@@ -200,13 +187,13 @@ function sapi_windows_generate_ctrl_event (int $event, int $pid = 0): bool
* under some circumstances.
* @link https://php.net/manual/en/language.constants.predefined.php
*/
-define ('__FILE__', '', true);
+define('__FILE__', '', true);
/**
* The current line number of the file.
* @link https://php.net/manual/en/language.constants.predefined.php
*/
-define ('__LINE__', 0, true);
+define('__LINE__', 0, true);
/**
* The class name. (Added in PHP 4.3.0) As of PHP 5 this constant
@@ -218,7 +205,7 @@ function sapi_windows_generate_ctrl_event (int $event, int $pid = 0): bool
* is used in.
* @link https://php.net/manual/en/language.constants.predefined.php
*/
-define ('__CLASS__', '', true);
+define('__CLASS__', '', true);
/**
* The function name. (Added in PHP 4.3.0) As of PHP 5 this constant
@@ -226,14 +213,14 @@ function sapi_windows_generate_ctrl_event (int $event, int $pid = 0): bool
* PHP 4 its value is always lowercased.
* @link https://php.net/manual/en/language.constants.predefined.php
*/
-define ('__FUNCTION__', '', true);
+define('__FUNCTION__', '', true);
/**
* The class method name. (Added in PHP 5.0.0) The method name is
* returned as it was declared (case-sensitive).
* @link https://php.net/manual/en/language.constants.predefined.php
*/
-define ('__METHOD__', '', true);
+define('__METHOD__', '', true);
/**
* The trait name. (Added in PHP 5.4.0) As of PHP 5.4 this constant
@@ -242,7 +229,7 @@ function sapi_windows_generate_ctrl_event (int $event, int $pid = 0): bool
* @since 5.4
* @link https://php.net/manual/en/language.constants.predefined.php
*/
-define ('__TRAIT__', '', true);
+define('__TRAIT__', '', true);
/**
* The directory of the file. If used inside an include,
@@ -251,11 +238,11 @@ function sapi_windows_generate_ctrl_event (int $event, int $pid = 0): bool
* does not have a trailing slash unless it is the root directory.
* @link https://php.net/manual/en/language.constants.predefined.php
*/
-define ('__DIR__', '', true);
+define('__DIR__', '', true);
/**
* The name of the current namespace (case-sensitive). This constant
* is defined in compile-time (Added in PHP 5.3.0).
* @link https://php.net/manual/en/language.constants.predefined.php
*/
-define ('__NAMESPACE__', '', true);
+define('__NAMESPACE__', '', true);
diff --git a/standard/password.php b/standard/password.php
index 3dc6ee2b8..e86a130bd 100644
--- a/standard/password.php
+++ b/standard/password.php
@@ -82,7 +82,6 @@
define("PASSWORD_BCRYPT", '2y');
/**
- *
* PASSWORD_ARGON2I is used to create new password hashes using the Argon2i algorithm.
*
* Supported Options:
@@ -99,7 +98,6 @@
define('PASSWORD_ARGON2I', 'argon2i');
/**
- *
* PASSWORD_ARGON2ID is used to create new password hashes using the Argon2id algorithm.
*
* Supported Options:
@@ -120,14 +118,14 @@
* Available as of PHP 7.2.0.
* @since 7.2
*/
-define ('PASSWORD_ARGON2_DEFAULT_MEMORY_COST', 65536);
+define('PASSWORD_ARGON2_DEFAULT_MEMORY_COST', 65536);
/**
* Default amount of time that Argon2lib will spend trying to compute a hash.
* Available as of PHP 7.2.0.
* @since 7.2
*/
-define ('PASSWORD_ARGON2_DEFAULT_TIME_COST', 4);
+define('PASSWORD_ARGON2_DEFAULT_TIME_COST', 4);
/**
* Default number of threads that Argon2lib will use.
@@ -163,8 +161,7 @@
*/
#[ArrayShape(["algo" => "int", "algoName" => "string", "options" => "array"])]
#[LanguageLevelTypeAware(['8.0' => 'array'], default: '?array')]
-function password_get_info (string $hash)
-{}
+function password_get_info(string $hash) {}
/**
* (PHP 5 >= 5.5.0, PHP 5)
@@ -184,8 +181,7 @@ function password_get_info (string $hash)
* @since 5.5
*/
#[LanguageLevelTypeAware(["8.0" => "string"], default: "string|false|null")]
-function password_hash (string $password, string|int|null $algo, array $options = [])
-{}
+function password_hash(string $password, string|int|null $algo, array $options = []) {}
/**
* Checks if the given hash matches the given options.
@@ -196,8 +192,7 @@ function password_hash (string $password, string|int|null $algo, array $options
* @return bool Returns TRUE if the hash should be rehashed to match the given algo and options, or FALSE otherwise.
* @since 5.5
*/
-function password_needs_rehash (string $hash, string|int|null $algo, array $options = []): bool
-{}
+function password_needs_rehash(string $hash, string|int|null $algo, array $options = []): bool {}
/**
* Checks if the given hash matches the given options.
@@ -207,14 +202,12 @@ function password_needs_rehash (string $hash, string|int|null $algo, array $opti
* @return bool Returns TRUE if the password and hash match, or FALSE otherwise.
* @since 5.5
*/
-function password_verify (string $password, string $hash): bool
-{}
+function password_verify(string $password, string $hash): bool {}
/**
* Return a complete list of all registered password hashing algorithms.
* @return string[]
* @since 7.4
*/
-function password_algos(): array
-{}
+function password_algos(): array {}
// End of password v.
diff --git a/standard/standard_0.php b/standard/standard_0.php
index f6ed6c328..36560b03c 100644
--- a/standard/standard_0.php
+++ b/standard/standard_0.php
@@ -6,18 +6,19 @@
use JetBrains\PhpStorm\Internal\LanguageLevelTypeAware;
use JetBrains\PhpStorm\Pure;
-class __PHP_Incomplete_Class {
+class __PHP_Incomplete_Class
+{
/**
* @var string
*/
public $__PHP_Incomplete_Class_Name;
}
-class php_user_filter {
+class php_user_filter
+{
public $filtername;
public $params;
-
/**
* @link https://php.net/manual/en/php-user-filter.filter.php
* @param resource $in is a resource pointing to a bucket brigadebucket objects containing data to be filtered.
@@ -61,32 +62,25 @@ class php_user_filter {
*
*
*/
- public function filter($in, $out, &$consumed, $closing)
- {
- }
+ public function filter($in, $out, &$consumed, $closing) {}
/**
* @link https://php.net/manual/en/php-user-filter.oncreate.php
* @return bool
*/
- public function onCreate()
- {
- }
+ public function onCreate() {}
/**
* @link https://php.net/manual/en/php-user-filter.onclose.php
*/
- public function onClose()
- {
- }
-
+ public function onClose() {}
}
/**
* Instances of Directory are created by calling the dir() function, not by the new operator.
*/
-class Directory {
-
+class Directory
+{
/**
* @var string The directory that was opened.
*/
@@ -103,7 +97,7 @@ class Directory {
* @param resource $dir_handle [optional]
* @link https://secure.php.net/manual/en/directory.close.php
*/
- public function close ($dir_handle = null) {}
+ public function close($dir_handle = null) {}
/**
* Rewind directory handle.
@@ -111,7 +105,7 @@ public function close ($dir_handle = null) {}
* @param resource $dir_handle [optional]
* @link https://secure.php.net/manual/en/directory.rewind.php
*/
- public function rewind ($dir_handle = null) {}
+ public function rewind($dir_handle = null) {}
/**
* Read entry from directory handle.
@@ -120,8 +114,7 @@ public function rewind ($dir_handle = null) {}
* @return string|false
* @link https://secure.php.net/manual/en/directory.read.php
*/
- public function read ($dir_handle = null) { }
-
+ public function read($dir_handle = null) {}
}
/**
@@ -134,8 +127,7 @@ public function read ($dir_handle = null) { }
* defined.
*/
#[Pure]
-function constant (string $name): mixed
-{}
+function constant(string $name): mixed {}
/**
* Convert binary data into hexadecimal representation
@@ -146,8 +138,7 @@ function constant (string $name): mixed
* @return string the hexadecimal representation of the given string.
*/
#[Pure]
-function bin2hex (string $string): string
-{}
+function bin2hex(string $string): string {}
/**
* Delay execution
@@ -160,8 +151,7 @@ function bin2hex (string $string): string
* to sleep.
*/
#[LanguageLevelTypeAware(["8.0" => "int"], default: "int|false")]
-function sleep (int $seconds)
-{}
+function sleep(int $seconds) {}
/**
* Delay execution in microseconds
@@ -172,7 +162,7 @@ function sleep (int $seconds)
*
* @return void
*/
-function usleep (int $microseconds): void {}
+function usleep(int $microseconds): void {}
/**
* Delay for a number of seconds and nanoseconds
@@ -193,8 +183,7 @@ function usleep (int $microseconds): void {}
* remaining in the delay
*
*/
-function time_nanosleep (int $seconds, int $nanoseconds): array|bool
-{}
+function time_nanosleep(int $seconds, int $nanoseconds): array|bool {}
/**
* Make the script sleep until the specified time
@@ -204,8 +193,7 @@ function time_nanosleep (int $seconds, int $nanoseconds): array|bool
*
* @return bool true on success or false on failure.
*/
-function time_sleep_until (float $timestamp): bool
-{}
+function time_sleep_until(float $timestamp): bool {}
/**
* Parse a time/date generated with strftime
@@ -270,15 +258,14 @@ function time_sleep_until (float $timestamp): bool
*
*/
#[Pure]
-function strptime (string $timestamp, string $format): array|false
-{}
+function strptime(string $timestamp, string $format): array|false {}
/**
* Flush the output buffer
* @link https://php.net/manual/en/function.flush.php
* @return void
*/
-function flush (): void {}
+function flush(): void {}
/**
* Wraps a string to a given number of characters
@@ -302,8 +289,7 @@ function flush (): void {}
* @return string the given string wrapped at the specified column.
*/
#[Pure]
-function wordwrap (string $string, int $width = 75, string $break = "\n", bool $cut_long_words = false): string
-{}
+function wordwrap(string $string, int $width = 75, string $break = "\n", bool $cut_long_words = false): string {}
/**
* Convert special characters to HTML entities
@@ -422,8 +408,7 @@ function wordwrap (string $string, int $width = 75, string $break = "\n", bool $
* @return string The converted string.
*/
#[Pure]
-function htmlspecialchars (string $string, int $flags = ENT_COMPAT | ENT_HTML401, ?string $encoding = 'UTF-8', bool $double_encode = true): string
-{}
+function htmlspecialchars(string $string, int $flags = ENT_COMPAT|ENT_HTML401, ?string $encoding = 'UTF-8', bool $double_encode = true): string {}
/**
* Convert all applicable characters to HTML entities
@@ -469,8 +454,7 @@ function htmlspecialchars (string $string, int $flags = ENT_COMPAT | ENT_HTML401
* @return string the encoded string.
*/
#[Pure]
-function htmlentities (string $string, int $flags = ENT_COMPAT, ?string $encoding, bool $double_encode = true): string
-{}
+function htmlentities(string $string, int $flags = ENT_COMPAT, ?string $encoding, bool $double_encode = true): string {}
/**
* Convert HTML entities to their corresponding characters
@@ -511,8 +495,7 @@ function htmlentities (string $string, int $flags = ENT_COMPAT, ?string $encodin
* @return string the decoded string.
*/
#[Pure]
-function html_entity_decode (string $string, int $flags = ENT_COMPAT, ?string $encoding): string
-{}
+function html_entity_decode(string $string, int $flags = ENT_COMPAT, ?string $encoding): string {}
/**
* Convert special HTML entities back to characters
@@ -546,8 +529,7 @@ function html_entity_decode (string $string, int $flags = ENT_COMPAT, ?string $e
* @return string the decoded string.
*/
#[Pure]
-function htmlspecialchars_decode (string $string, int $flags = ENT_COMPAT): string
-{}
+function htmlspecialchars_decode(string $string, int $flags = ENT_COMPAT): string {}
/**
* Returns the translation table used by htmlspecialchars and htmlentities
@@ -723,8 +705,7 @@ function htmlspecialchars_decode (string $string, int $flags = ENT_COMPAT): stri
* @return array the translation table as an array.
*/
#[Pure]
-function get_html_translation_table (int $table, int $flags = ENT_COMPAT, string $encoding = "UTF-8"): array
-{}
+function get_html_translation_table(int $table, int $flags = ENT_COMPAT, string $encoding = "UTF-8"): array {}
/**
* Calculate the sha1 hash of a string
@@ -741,8 +722,7 @@ function get_html_translation_table (int $table, int $flags = ENT_COMPAT, string
* @return string the sha1 hash as a string.
*/
#[Pure]
-function sha1 (string $string, bool $binary = false): string
-{}
+function sha1(string $string, bool $binary = false): string {}
/**
* Calculate the sha1 hash of a file
@@ -757,8 +737,7 @@ function sha1 (string $string, bool $binary = false): string
* @return string|false a string on success, false otherwise.
*/
#[Pure]
-function sha1_file (string $filename, bool $binary = false): string|false
-{}
+function sha1_file(string $filename, bool $binary = false): string|false {}
/**
* Calculate the md5 hash of a string
@@ -774,8 +753,7 @@ function sha1_file (string $filename, bool $binary = false): string|false
* @return string the hash as a 32-character hexadecimal number.
*/
#[Pure]
-function md5 (string $string, bool $binary = false): string
-{}
+function md5(string $string, bool $binary = false): string {}
/**
* Calculates the md5 hash of a given file
@@ -790,8 +768,7 @@ function md5 (string $string, bool $binary = false): string
* @return string|false a string on success, false otherwise.
*/
#[Pure]
-function md5_file (string $filename, bool $binary = false): string|false
-{}
+function md5_file(string $filename, bool $binary = false): string|false {}
/**
* Calculates the crc32 polynomial of a string
@@ -802,8 +779,7 @@ function md5_file (string $filename, bool $binary = false): string|false
* @return int the crc32 checksum of str as an integer..1
*/
#[Pure]
-function crc32 (string $string): int
-{}
+function crc32(string $string): int {}
/**
* Parse a binary IPTC block into single tags.
@@ -816,8 +792,7 @@ function crc32 (string $string): int
* value. It returns false on error or if no IPTC data was found.
*/
#[Pure]
-function iptcparse (string $iptc_block): array|false
-{}
+function iptcparse(string $iptc_block): array|false {}
/**
* Embeds binary IPTC data into a JPEG image.
@@ -836,8 +811,7 @@ function iptcparse (string $iptc_block): array|false
* @return string|bool If success and spool flag is lower than 2 then the JPEG will not be
* returned as a string, false on errors.
*/
-function iptcembed (string $iptc_data, string $filename, int $spool): string|bool
-{}
+function iptcembed(string $iptc_data, string $filename, int $spool): string|bool {}
/**
* Get the size of an image
@@ -900,8 +874,7 @@ function iptcembed (string $iptc_data, string $filename, int $spool): string|boo
* On failure, false is returned.
*
*/
-function getimagesize (string $filename, &$image_info): array|false
-{}
+function getimagesize(string $filename, &$image_info): array|false {}
/**
* Get Mime-Type for image-type returned by getimagesize, exif_read_data, exif_thumbnail, exif_imagetype
@@ -989,8 +962,7 @@ function getimagesize (string $filename, &$image_info): array|false
*
*/
#[Pure]
-function image_type_to_mime_type (int $image_type): string
-{}
+function image_type_to_mime_type(int $image_type): string {}
/**
* Get file extension for image type
@@ -1005,8 +977,7 @@ function image_type_to_mime_type (int $image_type): string
* @return string|false A string with the extension corresponding to the given image type.
*/
#[Pure]
-function image_type_to_extension (int $image_type, $include_dot = true): string|false
-{}
+function image_type_to_extension(int $image_type, $include_dot = true): string|false {}
/**
* Outputs information about PHP's configuration
@@ -1092,8 +1063,7 @@ function image_type_to_extension (int $image_type, $include_dot = true): string|
*
* @return bool true on success or false on failure.
*/
-function phpinfo (#[ExpectedValues(flags: [INFO_GENERAL, INFO_CREDITS, INFO_CONFIGURATION, INFO_MODULES, INFO_ENVIRONMENT, INFO_VARIABLES, INFO_LICENSE, INFO_ALL])] int $flags = INFO_ALL): bool
-{}
+function phpinfo(#[ExpectedValues(flags: [INFO_GENERAL, INFO_CREDITS, INFO_CONFIGURATION, INFO_MODULES, INFO_ENVIRONMENT, INFO_VARIABLES, INFO_LICENSE, INFO_ALL])] int $flags = INFO_ALL): bool {}
/**
* Gets the current PHP version
@@ -1107,8 +1077,7 @@ function phpinfo (#[ExpectedValues(flags: [INFO_GENERAL, INFO_CREDITS, INFO_CONF
* the extension isn't enabled.
*/
#[Pure]
-function phpversion (?string $extension): string|false
-{}
+function phpversion(?string $extension): string|false {}
/**
* Prints out the credits for PHP
@@ -1173,8 +1142,7 @@ function phpversion (?string $extension): string|false
*
* @return bool true on success or false on failure.
*/
-function phpcredits (int $flags = CREDITS_ALL): bool
-{}
+function phpcredits(int $flags = CREDITS_ALL): bool {}
/**
* Gets the logo guid
@@ -1183,18 +1151,17 @@ function phpcredits (int $flags = CREDITS_ALL): bool
* @return string PHPE9568F34-D428-11d2-A769-00AA001ACF42.
*/
#[Pure]
-function php_logo_guid (): string
-{}
+function php_logo_guid(): string {}
/**
* @removed 5.5
*/
-function php_real_logo_guid () {}
+function php_real_logo_guid() {}
/**
* @removed 5.5
*/
-function php_egg_logo_guid () {}
+function php_egg_logo_guid() {}
/**
* Gets the Zend guid
@@ -1202,8 +1169,7 @@ function php_egg_logo_guid () {}
* @link https://php.net/manual/en/function.zend-logo-guid.php
* @return string PHPE9568F35-D428-11d2-A769-00AA001ACF42.
*/
-function zend_logo_guid (): string
-{}
+function zend_logo_guid(): string {}
/**
* Returns the type of interface between web server and PHP
@@ -1223,8 +1189,7 @@ function zend_logo_guid (): string
*
*/
#[Pure]
-function php_sapi_name (): string|false
-{}
+function php_sapi_name(): string|false {}
/**
* Returns information about the operating system PHP is running on
@@ -1237,8 +1202,7 @@ function php_sapi_name (): string|false
* @return string the description, as a string.
*/
#[Pure]
-function php_uname (string $mode = 'a'): string
-{}
+function php_uname(string $mode = 'a'): string {}
/**
* Return a list of .ini files parsed from the additional ini dir
@@ -1252,8 +1216,7 @@ function php_uname (string $mode = 'a'): string
* php_ini_scanned_files.
*/
#[Pure]
-function php_ini_scanned_files (): string|false
-{}
+function php_ini_scanned_files(): string|false {}
/**
* Retrieve a path to the loaded php.ini file
@@ -1262,8 +1225,7 @@ function php_ini_scanned_files (): string|false
* @since 5.2.4
*/
#[Pure]
-function php_ini_loaded_file (): string|false
-{}
+function php_ini_loaded_file(): string|false {}
/**
* String comparisons using a "natural order" algorithm
@@ -1280,8 +1242,7 @@ function php_ini_loaded_file (): string|false
* str2, and 0 if they are equal.
*/
#[Pure]
-function strnatcmp (string $string1, string $string2): int
-{}
+function strnatcmp(string $string1, string $string2): int {}
/**
* Case insensitive string comparisons using a "natural order" algorithm
@@ -1298,8 +1259,7 @@ function strnatcmp (string $string1, string $string2): int
* str2, and 0 if they are equal.
*/
#[Pure]
-function strnatcasecmp (string $string1, string $string2): int
-{}
+function strnatcasecmp(string $string1, string $string2): int {}
/**
* Count the number of substring occurrences
@@ -1321,8 +1281,7 @@ function strnatcasecmp (string $string1, string $string2): int
* @return int This functions returns an integer.
*/
#[Pure]
-function substr_count (string $haystack, string $needle, int $offset, ?int $length): int
-{}
+function substr_count(string $haystack, string $needle, int $offset, ?int $length): int {}
/**
* Finds the length of the initial segment of a string consisting
@@ -1375,8 +1334,7 @@ function substr_count (string $haystack, string $needle, int $offset, ?int $leng
* which consists entirely of characters in str2.
*/
#[Pure]
-function strspn (string $string, string $characters, int $offset, ?int $length): int
-{}
+function strspn(string $string, string $characters, int $offset, ?int $length): int {}
/**
* Find length of initial segment not matching mask
@@ -1396,8 +1354,7 @@ function strspn (string $string, string $characters, int $offset, ?int $length):
* @return int the length of the segment as an integer.
*/
#[Pure]
-function strcspn (string $string, string $characters, int $offset, ?int $length): int
-{}
+function strcspn(string $string, string $characters, int $offset, ?int $length): int {}
/**
* Tokenize string
@@ -1415,5 +1372,4 @@ function strcspn (string $string, string $characters, int $offset, ?int $length)
*
* @return string|false A string token.
*/
-function strtok (string $string, ?string $token): string|false
-{}
+function strtok(string $string, ?string $token): string|false {}
diff --git a/standard/standard_1.php b/standard/standard_1.php
index e3cd86b1e..a97c2675c 100644
--- a/standard/standard_1.php
+++ b/standard/standard_1.php
@@ -5,7 +5,6 @@
use JetBrains\PhpStorm\Internal\LanguageLevelTypeAware;
use JetBrains\PhpStorm\Pure;
-
/**
* Make a string uppercase
* @link https://php.net/manual/en/function.strtoupper.php
@@ -15,8 +14,7 @@
* @return string the uppercased string.
*/
#[Pure]
-function strtoupper (string $string): string
-{}
+function strtoupper(string $string): string {}
/**
* Make a string lowercase
@@ -27,8 +25,7 @@ function strtoupper (string $string): string
* @return string the lowercased string.
*/
#[Pure]
-function strtolower (string $string): string
-{}
+function strtolower(string $string): string {}
/**
* Find the position of the first occurrence of a substring in a string
@@ -55,8 +52,7 @@ function strtolower (string $string): string
*
*/
#[Pure]
-function strpos (string $haystack, string $needle, int $offset = 0): int|false
-{}
+function strpos(string $haystack, string $needle, int $offset = 0): int|false {}
/**
* Find position of first occurrence of a case-insensitive string
@@ -82,8 +78,7 @@ function strpos (string $haystack, string $needle, int $offset = 0): int|false
* stripos will return boolean false.
*/
#[Pure]
-function stripos (string $haystack, string $needle, int $offset): int|false
-{}
+function stripos(string $haystack, string $needle, int $offset): int|false {}
/**
* Find the position of the last occurrence of a substring in a string
@@ -108,8 +103,7 @@ function stripos (string $haystack, string $needle, int $offset): int|false
*
*/
#[Pure]
-function strrpos (string $haystack, string $needle, int $offset = 0): int|false
-{}
+function strrpos(string $haystack, string $needle, int $offset = 0): int|false {}
/**
* Find position of last occurrence of a case-insensitive string in a string
@@ -138,8 +132,7 @@ function strrpos (string $haystack, string $needle, int $offset = 0): int|false
* If needle is not found, false is returned.
*/
#[Pure]
-function strripos (string $haystack, string $needle, int $offset): int|false
-{}
+function strripos(string $haystack, string $needle, int $offset): int|false {}
/**
* Reverse a string
@@ -150,8 +143,7 @@ function strripos (string $haystack, string $needle, int $offset): int|false
* @return string the reversed string.
*/
#[Pure]
-function strrev (string $string): string
-{}
+function strrev(string $string): string {}
/**
* Convert logical Hebrew text to visual text
@@ -166,8 +158,7 @@ function strrev (string $string): string
* @return string the visual string.
*/
#[Pure]
-function hebrev (string $string, int $max_chars_per_line): string
-{}
+function hebrev(string $string, int $max_chars_per_line): string {}
/**
* Convert logical Hebrew text to visual text with newline conversion
@@ -183,8 +174,7 @@ function hebrev (string $string, int $max_chars_per_line): string
* @removed 8.0
*/
#[Deprecated(replacement: 'nl2br(hebrev(%parameter0%))', since: '7.4')]
-function hebrevc (string $hebrew_text, $max_chars_per_line): string
-{}
+function hebrevc(string $hebrew_text, $max_chars_per_line): string {}
/**
* Inserts HTML line breaks before all newlines in a string
@@ -198,8 +188,7 @@ function hebrevc (string $hebrew_text, $max_chars_per_line): string
* @return string the altered string.
*/
#[Pure]
-function nl2br (string $string, bool $use_xhtml = true): string
-{}
+function nl2br(string $string, bool $use_xhtml = true): string {}
/**
* Returns trailing name component of path
@@ -219,8 +208,7 @@ function nl2br (string $string, bool $use_xhtml = true): string
* @return string the base name of the given path.
*/
#[Pure]
-function basename (string $path, string $suffix): string
-{}
+function basename(string $path, string $suffix): string {}
/**
* Returns a parent directory's path
@@ -244,8 +232,7 @@ function basename (string $path, string $suffix): string
* /component removed.
*/
#[Pure]
-function dirname (string $path, int $levels = 1): string
-{}
+function dirname(string $path, int $levels = 1): string {}
/**
* Returns information about a file path
@@ -271,8 +258,7 @@ function dirname (string $path, int $levels = 1): string
* string if not all elements are requested.
*/
#[Pure]
-function pathinfo (string $path, int $flags = PATHINFO_ALL): array|string
-{}
+function pathinfo(string $path, int $flags = PATHINFO_ALL): array|string {}
/**
* Un-quotes a quoted string
@@ -286,8 +272,7 @@ function pathinfo (string $path, int $flags = PATHINFO_ALL): array|string
* backslash (\).
*/
#[Pure]
-function stripslashes (string $string): string
-{}
+function stripslashes(string $string): string {}
/**
* Un-quote string quoted with addcslashes
@@ -298,8 +283,7 @@ function stripslashes (string $string): string
* @return string the unescaped string.
*/
#[Pure]
-function stripcslashes (string $string): string
-{}
+function stripcslashes(string $string): string {}
/**
* Find the first occurrence of a string
@@ -320,8 +304,7 @@ function stripcslashes (string $string): string
* is not found.
*/
#[Pure]
-function strstr (string $haystack, string $needle, bool $before_needle = false): string|false
-{}
+function strstr(string $haystack, string $needle, bool $before_needle = false): string|false {}
/**
* Case-insensitive strstr
@@ -342,8 +325,7 @@ function strstr (string $haystack, string $needle, bool $before_needle = false):
* found, returns false.
*/
#[Pure]
-function stristr (string $haystack, string $needle, bool $before_needle = false): string|false
-{}
+function stristr(string $haystack, string $needle, bool $before_needle = false): string|false {}
/**
* Find the last occurrence of a character in a string
@@ -365,8 +347,7 @@ function stristr (string $haystack, string $needle, bool $before_needle = false)
*
*/
#[Pure]
-function strrchr (string $haystack, string $needle): string|false
-{}
+function strrchr(string $haystack, string $needle): string|false {}
/**
* Randomly shuffles a string
@@ -377,8 +358,7 @@ function strrchr (string $haystack, string $needle): string|false
* @return string the shuffled string.
*/
#[Pure]
-function str_shuffle (string $string): string
-{}
+function str_shuffle(string $string): string {}
/**
* Return information about words used in a string
@@ -398,8 +378,7 @@ function str_shuffle (string $string): string
* format chosen.
*/
#[Pure]
-function str_word_count (string $string, int $format = 0, ?string $characters): array|int
-{}
+function str_word_count(string $string, int $format = 0, ?string $characters): array|int {}
/**
* Convert a string to an array
@@ -424,8 +403,7 @@ function str_word_count (string $string, int $format = 0, ?string $characters):
*/
#[Pure]
#[LanguageLevelTypeAware(["8.0" => "array"], default: "array|false")]
-function str_split (string $string, int $length = 1): array|false
-{}
+function str_split(string $string, int $length = 1): array|false {}
/**
* Search a string for any of a set of characters
@@ -440,8 +418,7 @@ function str_split (string $string, int $length = 1): array|false
* not found.
*/
#[Pure]
-function strpbrk (string $string, string $characters): string|false
-{}
+function strpbrk(string $string, string $characters): string|false {}
/**
* Binary safe comparison of two strings from an offset, up to length characters
@@ -472,8 +449,7 @@ function strpbrk (string $string, string $characters): string|false
* false.
*/
#[Pure]
-function substr_compare (string $haystack, string $needle, int $offset, ?int $length, bool $case_insensitive = false): int
-{}
+function substr_compare(string $haystack, string $needle, int $offset, ?int $length, bool $case_insensitive = false): int {}
/**
* Locale based string comparison
@@ -490,8 +466,7 @@ function substr_compare (string $haystack, string $needle, int $offset, ?int $le
* str2, and 0 if they are equal.
*/
#[Pure]
-function strcoll (string $string1, string $string2): int
-{}
+function strcoll(string $string1, string $string2): int {}
/**
* Formats a number as a currency string
@@ -510,8 +485,7 @@ function strcoll (string $string1, string $string2): int
* @see NumberFormatter
*/
#[Deprecated(reason: 'Use the NumberFormatter functionality', since: '7.4')]
-function money_format (string $format, float $number): ?string
-{}
+function money_format(string $format, float $number): ?string {}
/**
* Return part of a string
@@ -578,8 +552,7 @@ function money_format (string $format, float $number): ?string
*/
#[Pure]
#[LanguageLevelTypeAware(["8.0" => "string"], default: "string|false")]
-function substr (string $string, int $offset, ?int $length)
-{}
+function substr(string $string, int $offset, ?int $length) {}
/**
* Replace text within a portion of a string
@@ -617,8 +590,7 @@ function substr (string $string, int $offset, ?int $length)
* array then array is returned.
*/
#[Pure]
-function substr_replace (array|string $string, array|string $replace, array|int $offset, array|int|null $length = null): array|string
-{}
+function substr_replace(array|string $string, array|string $replace, array|int $offset, array|int|null $length = null): array|string {}
/**
* Quote meta characters
@@ -629,8 +601,7 @@ function substr_replace (array|string $string, array|string $replace, array|int
* @return string the string with meta characters quoted.
*/
#[Pure]
-function quotemeta (string $string): string
-{}
+function quotemeta(string $string): string {}
/**
* Make a string's first character uppercase
@@ -641,8 +612,7 @@ function quotemeta (string $string): string
* @return string the resulting string.
*/
#[Pure]
-function ucfirst (string $string): string
-{}
+function ucfirst(string $string): string {}
/**
* Make a string's first character lowercase
@@ -653,8 +623,7 @@ function ucfirst (string $string): string
* @return string the resulting string.
*/
#[Pure]
-function lcfirst (string $string): string
-{}
+function lcfirst(string $string): string {}
/**
* Uppercase the first character of each word in a string
@@ -668,8 +637,7 @@ function lcfirst (string $string): string
* @return string the modified string.
*/
#[Pure]
-function ucwords (string $string, string $separators = " \t\r\n\f\v"): string
-{}
+function ucwords(string $string, string $separators = " \t\r\n\f\v"): string {}
/**
* Translate characters or replace substrings
@@ -689,8 +657,7 @@ function ucwords (string $string, string $separators = " \t\r\n\f\v"): string
* to.
*/
#[Pure]
-function strtr (string $string, string $from, string $to): string
-{}
+function strtr(string $string, string $from, string $to): string {}
/**
* Translate certain characters
@@ -700,8 +667,7 @@ function strtr (string $string, string $from, string $to): string
* @return string A copy of str, translating all occurrences of each character in from to the corresponding character in to.
*/
#[Pure]
-function strtr (string $str, array $replace_pairs): string
-{}
+function strtr(string $str, array $replace_pairs): string {}
/**
* Quote string with slashes
@@ -712,8 +678,7 @@ function strtr (string $str, array $replace_pairs): string
* @return string the escaped string.
*/
#[Pure]
-function addslashes (string $string): string
-{}
+function addslashes(string $string): string {}
/**
* Quote string with slashes in a C style
@@ -766,8 +731,7 @@ function addslashes (string $string): string
* @return string the escaped string.
*/
#[Pure]
-function addcslashes (string $string, string $characters): string
-{}
+function addcslashes(string $string, string $characters): string {}
/**
* Strip whitespace (or other characters) from the end of a string.
@@ -793,8 +757,7 @@ function addcslashes (string $string, string $characters): string
* @return string the modified string.
*/
#[Pure]
-function rtrim (string $string, string $characters = " \t\n\r\0\x0B"): string
-{}
+function rtrim(string $string, string $characters = " \t\n\r\0\x0B"): string {}
/**
* Replace all occurrences of the search string with the replacement string
@@ -820,8 +783,7 @@ function rtrim (string $string, string $characters = " \t\n\r\0\x0B"): string
* @param int &$count [optional] If passed, this will hold the number of matched and replaced needles.
* @return string|string[] This function returns a string or an array with the replaced values.
*/
-function str_replace (array|string $search, array|string $replace, array|string $subject, &$count): array|string
-{}
+function str_replace(array|string $search, array|string $replace, array|string $subject, &$count): array|string {}
/**
* Case-insensitive version of str_replace .
@@ -845,8 +807,7 @@ function str_replace (array|string $search, array|string $replace, array|string
*
* @return string|string[] a string or an array of replacements.
*/
-function str_ireplace (array|string $search, array|string $replace, array|string $subject, &$count): array|string
-{}
+function str_ireplace(array|string $search, array|string $replace, array|string $subject, &$count): array|string {}
/**
* Repeat a string
@@ -866,8 +827,7 @@ function str_ireplace (array|string $search, array|string $replace, array|string
* @return string the repeated string.
*/
#[Pure]
-function str_repeat (string $string, int $times): string
-{}
+function str_repeat(string $string, int $times): string {}
/**
* Return information about characters used in a string
@@ -890,8 +850,7 @@ function str_repeat (string $string, int $times): string
* 4 - a string containing all not used characters is returned.
*/
#[Pure]
-function count_chars (string $string, int $mode): array|string
-{}
+function count_chars(string $string, int $mode): array|string {}
/**
* Split a string into smaller chunks
@@ -908,8 +867,7 @@ function count_chars (string $string, int $mode): array|string
* @return string the chunked string.
*/
#[Pure]
-function chunk_split (string $string, int $length = 76, string $separator = "\r\n"): string
-{}
+function chunk_split(string $string, int $length = 76, string $separator = "\r\n"): string {}
/**
* Strip whitespace (or other characters) from the beginning and end of a string
@@ -926,8 +884,7 @@ function chunk_split (string $string, int $length = 76, string $separator = "\r\
* @return string The trimmed string.
*/
#[Pure]
-function trim (string $string, string $characters = " \t\n\r\0\x0B"): string
-{}
+function trim(string $string, string $characters = " \t\n\r\0\x0B"): string {}
/**
* Strip whitespace (or other characters) from the beginning of a string
@@ -959,8 +916,7 @@ function trim (string $string, string $characters = " \t\n\r\0\x0B"): string
* (0x0B)), a vertical tab.
*/
#[Pure]
-function ltrim (string $string, string $characters = " \t\n\r\0\x0B"): string
-{}
+function ltrim(string $string, string $characters = " \t\n\r\0\x0B"): string {}
/**
* Strip HTML and PHP tags from a string
@@ -979,8 +935,7 @@ function ltrim (string $string, string $characters = " \t\n\r\0\x0B"): string
* @return string the stripped string.
*/
#[Pure]
-function strip_tags (string $string, #[LanguageLevelTypeAware(["7.4" => "string[]|string|null"], default: "string|null")] $allowed_tags = null): string
-{}
+function strip_tags(string $string, #[LanguageLevelTypeAware(["7.4" => "string[]|string|null"], default: "string|null")] $allowed_tags = null): string {}
/**
* Calculate the similarity between two strings
@@ -998,8 +953,7 @@ function strip_tags (string $string, #[LanguageLevelTypeAware(["7.4" => "string[
*
* @return int the number of matching chars in both strings.
*/
-function similar_text (string $string1, string $string2, &$percent): int
-{}
+function similar_text(string $string1, string $string2, &$percent): int {}
/**
* Split a string by a string
@@ -1032,8 +986,7 @@ function similar_text (string $string1, string $string2, &$percent): int
*/
#[Pure]
#[LanguageLevelTypeAware(["8.0" => "string[]"], default: "string[]|false")]
-function explode (string $separator, string $string, int $limit): array|false
-{}
+function explode(string $separator, string $string, int $limit): array|false {}
/**
* Join array elements with a string
@@ -1050,8 +1003,7 @@ function explode (string $separator, string $string, int $limit): array|false
* elements in the same order, with the glue string between each element.
*/
#[Pure]
-function implode (array|string $separator = "", ?array $array): string
-{}
+function implode(array|string $separator = "", ?array $array): string {}
/**
* Alias:
@@ -1069,8 +1021,7 @@ function implode (array|string $separator = "", ?array $array): string
* elements in the same order, with the glue string between each element.
*/
#[Pure]
-function join (array|string $separator = "", ?array $array): string
-{}
+function join(array|string $separator = "", ?array $array): string {}
/**
* Set locale information
@@ -1141,8 +1092,7 @@ function join (array|string $separator = "", ?array $array): string
* on the system that PHP is running. It returns exactly
* what the system setlocale function returns.
*/
-function setlocale (int $category, array|string|int $locales, ...$rest): string|false
-{}
+function setlocale(int $category, array|string|int $locales, ...$rest): string|false {}
/**
* Get numeric formatting information
@@ -1262,7 +1212,6 @@ function setlocale (int $category, array|string|int $locales, ...$rest): string|
* no further grouping is done. If an array element is equal to 0, the previous
* element should be used.
*/
-#[ArrayShape(["decimal_point" => "string", "thousands_sep" => "string", "grouping" => "array", "int_curr_symbol" => "string", "currency_symbol" => "string", "mon_decimal_point" => "string", "mon_thousands_sep" => "string", "mon_grouping" => "string", "positive_sign" => "string", "negative_sign" => "string", "int_frac_digits" => "string", "frac_digits" => "string", "p_cs_precedes" => "bool", "p_sep_by_space" => "bool", "n_cs_precedes" => "bool", "n_sep_by_space" => "bool", "p_sign_posn" => "int", "n_sign_posn" => "int",])]
+#[ArrayShape(["decimal_point" => "string", "thousands_sep" => "string", "grouping" => "array", "int_curr_symbol" => "string", "currency_symbol" => "string", "mon_decimal_point" => "string", "mon_thousands_sep" => "string", "mon_grouping" => "string", "positive_sign" => "string", "negative_sign" => "string", "int_frac_digits" => "string", "frac_digits" => "string", "p_cs_precedes" => "bool", "p_sep_by_space" => "bool", "n_cs_precedes" => "bool", "n_sep_by_space" => "bool", "p_sign_posn" => "int", "n_sign_posn" => "int"])]
#[Pure]
-function localeconv (): array
-{}
+function localeconv(): array {}
diff --git a/standard/standard_2.php b/standard/standard_2.php
index 64eb015a9..6d6fbe2e3 100644
--- a/standard/standard_2.php
+++ b/standard/standard_2.php
@@ -151,8 +151,7 @@
* is not valid.
*/
#[Pure]
-function nl_langinfo (int $item): string|false
-{}
+function nl_langinfo(int $item): string|false {}
/**
* Calculate the soundex key of a string
@@ -163,8 +162,7 @@ function nl_langinfo (int $item): string|false
* @return string the soundex key as a string.
*/
#[Pure]
-function soundex (string $string): string
-{}
+function soundex(string $string): string {}
/**
* Calculate Levenshtein distance between two strings
@@ -194,9 +192,7 @@ function soundex (string $string): string
* two argument strings or -1, if one of the argument strings
* is longer than the limit of 255 characters.
*/
-function levenshtein (string $string1, string $string2, int $insertion_cost = 1, int $replacement_cost = 1, int $deletion_cost = 1): int
-{
-}
+function levenshtein(string $string1, string $string2, int $insertion_cost = 1, int $replacement_cost = 1, int $deletion_cost = 1): int {}
/**
* Generate a single-byte string from a number
@@ -207,8 +203,7 @@ function levenshtein (string $string1, string $string2, int $insertion_cost = 1,
* @return string the specified character.
*/
#[Pure]
-function chr (int $codepoint): string
-{}
+function chr(int $codepoint): string {}
/**
* Convert the first byte of a string to a value between 0 and 255
@@ -219,8 +214,7 @@ function chr (int $codepoint): string
* @return int the ASCII value as an integer.
*/
#[Pure]
-function ord (string $character): int
-{}
+function ord(string $character): int {}
/**
* Parses the string into variables
@@ -235,8 +229,7 @@ function ord (string $character): int
*
* @return void
*/
-function parse_str (string $string, &$result): void
-{}
+function parse_str(string $string, &$result): void {}
/**
* Parse a CSV string into an array
@@ -257,8 +250,7 @@ function parse_str (string $string, &$result): void
* @return array an indexed array containing the fields read.
*/
#[Pure]
-function str_getcsv (string $string, string $separator = ",", string $enclosure = '"', string $escape = "\\"): array
-{}
+function str_getcsv(string $string, string $separator = ",", string $enclosure = '"', string $escape = "\\"): array {}
/**
* Pad a string to a certain length with another string
@@ -286,8 +278,7 @@ function str_getcsv (string $string, string $separator = ",", string $enclosure
* @return string the padded string.
*/
#[Pure]
-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 = STR_PAD_RIGHT): string {}
/**
* Alias:
@@ -299,8 +290,7 @@ function str_pad (string $string, int $length, string $pad_string = " ", int $pa
* @see rtrim()
*/
#[Pure]
-function chop (string $string, string $characters): string
-{}
+function chop(string $string, string $characters): string {}
/**
* Alias:
@@ -316,8 +306,7 @@ function chop (string $string, string $characters): string
* @return string|false Returns the portion of string, or FALSE if needle is not found.
*/
#[Pure]
-function strchr (string $haystack, string $needle, bool $before_needle = false): string|false
-{}
+function strchr(string $haystack, string $needle, bool $before_needle = false): string|false {}
/**
* Return a formatted string
@@ -344,8 +333,7 @@ function strchr (string $haystack, string $needle, bool $before_needle = false):
* format.
*/
#[Pure]
-function sprintf (string $format, ...$values): string
-{}
+function sprintf(string $format, ...$values): string {}
/**
* Output a formatted string
@@ -358,8 +346,7 @@ function sprintf (string $format, ...$values): string
*
* @return int the length of the outputted string.
*/
-function printf (string $format, ...$values): int
-{}
+function printf(string $format, ...$values): int {}
/**
* Output a formatted string
@@ -372,8 +359,7 @@ function printf (string $format, ...$values): int
*
* @return int the length of the outputted string.
*/
-function vprintf (string $format, array $values): int
-{}
+function vprintf(string $format, array $values): int {}
/**
* Return a formatted string
@@ -389,8 +375,7 @@ function vprintf (string $format, array $values): int
* for sprintf).
*/
#[Pure]
-function vsprintf (string $format, array $values): string
-{}
+function vsprintf(string $format, array $values): string {}
/**
* Write a formatted string to a stream
@@ -404,8 +389,7 @@ function vsprintf (string $format, array $values): string
*
* @return int the length of the string written.
*/
-function fprintf ($stream, string $format, ...$values): int
-{}
+function fprintf($stream, string $format, ...$values): int {}
/**
* Write a formatted string to a stream
@@ -420,8 +404,7 @@ function fprintf ($stream, string $format, ...$values): int
*
* @return int the length of the outputted string.
*/
-function vfprintf ($stream, string $format, array $values): int
-{}
+function vfprintf($stream, string $format, array $values): int {}
/**
* Parses input from a string according to a format
@@ -447,8 +430,7 @@ function vfprintf ($stream, string $format, array $values): int
* the function will return the number of assigned values. The optional
* parameters must be passed by reference.
*/
-function sscanf (string $string, string $format, #[TypeContract(exists: "int|null", notExists: "array|null")] mixed &...$vars): array|int|null
-{}
+function sscanf(string $string, string $format, #[TypeContract(exists: "int|null", notExists: "array|null")] mixed &...$vars): array|int|null {}
/**
* Parses input from a file according to a format
@@ -464,8 +446,7 @@ function sscanf (string $string, string $format, #[TypeContract(exists: "int|nul
* function will return the number of assigned values. The optional
* parameters must be passed by reference.
*/
-function fscanf ($stream, string $format, #[TypeContract(exists: "int|false|null", notExists: "array|false|null")] mixed &...$vars): array|int|false|null
-{}
+function fscanf($stream, string $format, #[TypeContract(exists: "int|false|null", notExists: "array|false|null")] mixed &...$vars): array|int|false|null {}
/**
* Parse a URL and return its components
@@ -509,8 +490,7 @@ function fscanf ($stream, string $format, #[TypeContract(exists: "int|false|null
"fragment" => "string",
])]
#[Pure]
-function parse_url (string $url, int $component = -1)
-{}
+function parse_url(string $url, int $component = -1) {}
/**
* URL-encodes string
@@ -529,8 +509,7 @@ function parse_url (string $url, int $component = -1)
* are encoded as plus (+) signs.
*/
#[Pure]
-function urlencode (string $string): string
-{}
+function urlencode(string $string): string {}
/**
* Decodes URL-encoded string
@@ -541,8 +520,7 @@ function urlencode (string $string): string
* @return string the decoded string.
*/
#[Pure]
-function urldecode (string $string): string
-{}
+function urldecode(string $string): string {}
/**
* URL-encode according to RFC 3986
@@ -559,8 +537,7 @@ function urldecode (string $string): string
* media with character conversions (like some email systems).
*/
#[Pure]
-function rawurlencode (string $string): string
-{}
+function rawurlencode(string $string): string {}
/**
* Decode URL-encoded strings
@@ -571,8 +548,7 @@ function rawurlencode (string $string): string
* @return string the decoded URL, as a string.
*/
#[Pure]
-function rawurldecode (string $string): string
-{}
+function rawurldecode(string $string): string {}
/**
* Generate URL-encoded query string
@@ -608,8 +584,7 @@ function rawurldecode (string $string): string
* @return string a URL-encoded string.
*/
#[Pure]
-function http_build_query (object|array $data, string $numeric_prefix = "", ?string $arg_separator = "&", int $encoding_type = PHP_QUERY_RFC1738): string
-{}
+function http_build_query(object|array $data, string $numeric_prefix = "", ?string $arg_separator = "&", int $encoding_type = PHP_QUERY_RFC1738): string {}
/**
* Returns the target of a symbolic link
@@ -619,8 +594,7 @@ function http_build_query (object|array $data, string $numeric_prefix = "", ?str
*
* @return string|false the contents of the symbolic link path or false on error.
*/
-function readlink (string $path): string|false
-{}
+function readlink(string $path): string|false {}
/**
* Gets information about a link
@@ -633,8 +607,7 @@ function readlink (string $path): string|false
* system call. Returns 0 or false in case of error.
*/
#[Pure]
-function linkinfo (string $path): int|false
-{}
+function linkinfo(string $path): int|false {}
/**
* Creates a symbolic link
@@ -647,8 +620,7 @@ function linkinfo (string $path): int|false
*
* @return bool true on success or false on failure.
*/
-function symlink (string $target, string $link): bool
-{}
+function symlink(string $target, string $link): bool {}
/**
* Create a hard link
@@ -657,7 +629,7 @@ function symlink (string $target, string $link): bool
* @param string $link The link name.
* @return bool true on success or false on failure.
*/
-function link (string $target , string $link):bool {}
+function link(string $target, string $link): bool {}
/**
* Deletes a file
@@ -668,7 +640,7 @@ function link (string $target , string $link):bool {}
* @param resource $context [optional]
* @return bool true on success or false on failure.
*/
-function unlink (string $filename, $context):bool {}
+function unlink(string $filename, $context): bool {}
/**
* Execute an external program
@@ -700,8 +672,7 @@ function unlink (string $filename, $context):bool {}
* To get the output of the executed command, be sure to set and use the
* output parameter.
*/
-function exec (string $command, &$output, &$result_code): string|false
-{}
+function exec(string $command, &$output, &$result_code): string|false {}
/**
* Execute an external program and display the output
@@ -717,8 +688,7 @@ function exec (string $command, &$output, &$result_code): string|false
* @return string|false the last line of the command output on success, and false
* on failure.
*/
-function system (string $command, &$result_code): string|false
-{}
+function system(string $command, &$result_code): string|false {}
/**
* Escape shell metacharacters
@@ -729,8 +699,7 @@ function system (string $command, &$result_code): string|false
* @return string The escaped string.
*/
#[Pure]
-function escapeshellcmd (string $command): string
-{}
+function escapeshellcmd(string $command): string {}
/**
* Escape a string to be used as a shell argument
@@ -741,8 +710,7 @@ function escapeshellcmd (string $command): string
* @return string The escaped string.
*/
#[Pure]
-function escapeshellarg (string $arg): string
-{}
+function escapeshellarg(string $arg): string {}
/**
* Execute an external program and display raw output
@@ -756,8 +724,7 @@ function escapeshellarg (string $arg): string
*
* @return bool|null
*/
-function passthru (string $command, &$result_code): ?bool
-{}
+function passthru(string $command, &$result_code): ?bool {}
/**
* Execute command via shell and return the complete output as a string
@@ -767,8 +734,7 @@ function passthru (string $command, &$result_code): ?bool
*
* @return string|false|null The output from the executed command or NULL if an error occurred or the command produces no output.
*/
-function shell_exec (string $command): string|false|null
-{}
+function shell_exec(string $command): string|false|null {}
/**
* Execute a command and open file pointers for input/output
@@ -840,8 +806,7 @@ function shell_exec (string $command): string|false|null
* proc_close when you are finished with it. On failure
* returns false.
*/
-function proc_open (array|string $command, array $descriptor_spec, &$pipes, ?string $cwd, ?array $env_vars, ?array $options)
-{}
+function proc_open(array|string $command, array $descriptor_spec, &$pipes, ?string $cwd, ?array $env_vars, ?array $options) {}
/**
* Close a process opened by {@see proc_open} and return the exit code of that process
@@ -852,8 +817,7 @@ function proc_open (array|string $command, array $descriptor_spec, &$pipes, ?str
*
* @return int the termination status of the process that was run.
*/
-function proc_close ($process): int
-{}
+function proc_close($process): int {}
/**
* Kills a process opened by proc_open
@@ -870,8 +834,7 @@ function proc_close ($process): int
*
* @return bool the termination status of the process that was run.
*/
-function proc_terminate ($process, int $signal = 15): bool
-{}
+function proc_terminate($process, int $signal = 15): bool {}
/**
* Get information about a process opened by {@see proc_open}
@@ -959,8 +922,7 @@ function proc_terminate ($process, int $signal = 15): bool
"stopsig" => "int",
])]
#[LanguageLevelTypeAware(["8.0" => "array"], default: "array|false")]
-function proc_get_status ($process)
-{}
+function proc_get_status($process) {}
/**
* Change the priority of the current process.
@@ -973,8 +935,7 @@ function proc_get_status ($process)
* If an error occurs, like the user lacks permission to change the priority,
* an error of level E_WARNING is also generated.
*/
-function proc_nice (int $priority): bool
-{}
+function proc_nice(int $priority): bool {}
/**
* Generate a random integer
@@ -984,8 +945,7 @@ function proc_nice (int $priority): bool
* @return int A pseudo random value between min
* (or 0) and max (or getrandmax, inclusive).
*/
-function rand (int $min = 0, int $max): int
-{}
+function rand(int $min = 0, int $max): int {}
/**
* Seed the random number generator
@@ -1001,7 +961,7 @@ function rand (int $min = 0, int $max): int
*
* @return void
*/
-function srand (int $seed, int $mode = MT_RAND_MT19937): void {}
+function srand(int $seed, int $mode = MT_RAND_MT19937): void {}
/**
* Show largest possible random value
@@ -1009,8 +969,7 @@ function srand (int $seed, int $mode = MT_RAND_MT19937): void {}
* @return int The largest possible random value returned by rand
*/
#[Pure]
-function getrandmax (): int
-{}
+function getrandmax(): int {}
/**
* Generate a random value via the Mersenne Twister Random Number Generator
@@ -1024,8 +983,7 @@ function getrandmax (): int
* @return int A random integer value between min (or 0)
* and max (or mt_getrandmax, inclusive)
*/
-function mt_rand (int $min = 0, int $max): int
-{}
+function mt_rand(int $min = 0, int $max): int {}
/**
* Seeds the Mersenne Twister Random Number Generator
@@ -1038,7 +996,7 @@ function mt_rand (int $min = 0, int $max): int
*
* @return void
*/
-function mt_srand (int $seed, int $mode = MT_RAND_MT19937): void {}
+function mt_srand(int $seed, int $mode = MT_RAND_MT19937): void {}
/**
* Show largest possible random value
@@ -1046,8 +1004,7 @@ function mt_srand (int $seed, int $mode = MT_RAND_MT19937): void {}
* @return int the maximum random value returned by mt_rand
*/
#[Pure]
-function mt_getrandmax (): int
-{}
+function mt_getrandmax(): int {}
/**
* Get port number associated with an Internet service and protocol
@@ -1063,8 +1020,7 @@ function mt_getrandmax (): int
* protocol is not found.
*/
#[Pure]
-function getservbyname (string $service, string $protocol): int|false
-{}
+function getservbyname(string $service, string $protocol): int|false {}
/**
* Get Internet service which corresponds to port and protocol
@@ -1079,8 +1035,7 @@ function getservbyname (string $service, string $protocol): int|false
* @return string|false the Internet service name as a string.
*/
#[Pure]
-function getservbyport (int $port, string $protocol): string|false
-{}
+function getservbyport(int $port, string $protocol): string|false {}
/**
* Get protocol number associated with protocol name
@@ -1091,8 +1046,7 @@ function getservbyport (int $port, string $protocol): string|false
* @return int|false the protocol number or -1 if the protocol is not found.
*/
#[Pure]
-function getprotobyname (string $protocol): int|false
-{}
+function getprotobyname(string $protocol): int|false {}
/**
* Get protocol name associated with protocol number
@@ -1103,8 +1057,7 @@ function getprotobyname (string $protocol): int|false
* @return string|false the protocol name as a string.
*/
#[Pure]
-function getprotobynumber (int $protocol): string|false
-{}
+function getprotobynumber(int $protocol): string|false {}
/**
* Gets PHP script owner's UID
@@ -1112,8 +1065,7 @@ function getprotobynumber (int $protocol): string|false
* @return int|false the user ID of the current script, or false on error.
*/
#[Pure]
-function getmyuid (): int|false
-{}
+function getmyuid(): int|false {}
/**
* Get PHP script owner's GID
@@ -1121,8 +1073,7 @@ function getmyuid (): int|false
* @return int|false the group ID of the current script, or false on error.
*/
#[Pure]
-function getmygid (): int|false
-{}
+function getmygid(): int|false {}
/**
* Gets PHP's process ID
@@ -1130,8 +1081,7 @@ function getmygid (): int|false
* @return int|false the current PHP process ID, or false on error.
*/
#[Pure]
-function getmypid (): int|false
-{}
+function getmypid(): int|false {}
/**
* Gets the inode of the current script
@@ -1139,5 +1089,4 @@ function getmypid (): int|false
* @return int|false the current script's inode as an integer, or false on error.
*/
#[Pure]
-function getmyinode (): int|false
-{}
+function getmyinode(): int|false {}
diff --git a/standard/standard_3.php b/standard/standard_3.php
index 89aedbbc9..93aad79ed 100644
--- a/standard/standard_3.php
+++ b/standard/standard_3.php
@@ -1,6 +1,5 @@
"float"], default: "float|false")]
-function ceil (int|float $num)
-{}
+function ceil(int|float $num) {}
/**
* Round fractions down
* @link https://php.net/manual/en/function.floor.php
@@ -117,8 +108,7 @@ function ceil (int|float $num)
*/
#[Pure]
#[LanguageLevelTypeAware(["8.0" => "float"], default: "float|false")]
-function floor (int|float $num)
-{}
+function floor(int|float $num) {}
/**
* Returns the rounded value of val to specified precision (number of digits after the decimal point).
@@ -140,8 +130,7 @@ function floor (int|float $num)
* @return float The rounded value
*/
#[Pure]
-function round (int|float $num, int $precision = 0, int $mode = PHP_ROUND_HALF_UP): float
-{}
+function round(int|float $num, int $precision = 0, int $mode = PHP_ROUND_HALF_UP): float {}
/**
* Sine
@@ -152,8 +141,7 @@ function round (int|float $num, int $precision = 0, int $mode = PHP_ROUND_HALF_U
* @return float The sine of arg
*/
#[Pure]
-function sin (float $num): float
-{}
+function sin(float $num): float {}
/**
* Cosine
@@ -164,8 +152,7 @@ function sin (float $num): float
* @return float The cosine of arg
*/
#[Pure]
-function cos (float $num): float
-{}
+function cos(float $num): float {}
/**
* Tangent
@@ -176,8 +163,7 @@ function cos (float $num): float
* @return float The tangent of arg
*/
#[Pure]
-function tan (float $num): float
-{}
+function tan(float $num): float {}
/**
* Arc sine
@@ -188,8 +174,7 @@ function tan (float $num): float
* @return float The arc sine of arg in radians
*/
#[Pure]
-function asin (float $num): float
-{}
+function asin(float $num): float {}
/**
* Arc cosine
@@ -200,8 +185,7 @@ function asin (float $num): float
* @return float The arc cosine of arg in radians.
*/
#[Pure]
-function acos (float $num): float
-{}
+function acos(float $num): float {}
/**
* Arc tangent
@@ -212,8 +196,7 @@ function acos (float $num): float
* @return float The arc tangent of arg in radians.
*/
#[Pure]
-function atan (float $num): float
-{}
+function atan(float $num): float {}
/**
* Inverse hyperbolic tangent
@@ -224,8 +207,7 @@ function atan (float $num): float
* @return float Inverse hyperbolic tangent of arg
*/
#[Pure]
-function atanh (float $num): float
-{}
+function atanh(float $num): float {}
/**
* Arc tangent of two variables
@@ -240,8 +222,7 @@ function atanh (float $num): float
* in radians.
*/
#[Pure]
-function atan2 (float $y, float $x): float
-{}
+function atan2(float $y, float $x): float {}
/**
* Hyperbolic sine
@@ -252,8 +233,7 @@ function atan2 (float $y, float $x): float
* @return float The hyperbolic sine of arg
*/
#[Pure]
-function sinh (float $num): float
-{}
+function sinh(float $num): float {}
/**
* Hyperbolic cosine
@@ -264,8 +244,7 @@ function sinh (float $num): float
* @return float The hyperbolic cosine of arg
*/
#[Pure]
-function cosh (float $num): float
-{}
+function cosh(float $num): float {}
/**
* Hyperbolic tangent
@@ -276,8 +255,7 @@ function cosh (float $num): float
* @return float The hyperbolic tangent of arg
*/
#[Pure]
-function tanh (float $num): float
-{}
+function tanh(float $num): float {}
/**
* Inverse hyperbolic sine
@@ -288,8 +266,7 @@ function tanh (float $num): float
* @return float The inverse hyperbolic sine of arg
*/
#[Pure]
-function asinh (float $num): float
-{}
+function asinh(float $num): float {}
/**
* Inverse hyperbolic cosine
@@ -300,8 +277,7 @@ function asinh (float $num): float
* @return float The inverse hyperbolic cosine of arg
*/
#[Pure]
-function acosh (float $num): float
-{}
+function acosh(float $num): float {}
/**
* Returns exp(number) - 1, computed in a way that is accurate even
@@ -313,8 +289,7 @@ function acosh (float $num): float
* @return float 'e' to the power of arg minus one
*/
#[Pure]
-function expm1(float $num): float
-{}
+function expm1(float $num): float {}
/**
* Returns log(1 + number), computed in a way that is accurate even when
@@ -326,8 +301,7 @@ function expm1(float $num): float
* @return float log(1 + number)
*/
#[Pure]
-function log1p(float $num): float
-{}
+function log1p(float $num): float {}
/**
* Get value of pi
@@ -335,8 +309,7 @@ function log1p(float $num): float
* @return float The value of pi as float.
*/
#[Pure]
-function pi (): float
-{}
+function pi(): float {}
/**
* Finds whether a value is a legal finite number
@@ -349,8 +322,7 @@ function pi (): float
* else false.
*/
#[Pure]
-function is_finite (float $num): bool
-{}
+function is_finite(float $num): bool {}
/**
* Finds whether a value is not a number
@@ -362,8 +334,7 @@ function is_finite (float $num): bool
* else false.
*/
#[Pure]
-function is_nan (float $num): bool
-{}
+function is_nan(float $num): bool {}
/**
* Integer division
@@ -378,8 +349,7 @@ function is_nan (float $num): bool
* @since 7.0
*/
#[Pure]
-function intdiv (int $num1, int $num2): int
-{}
+function intdiv(int $num1, int $num2): int {}
/**
* Finds whether a value is infinite
@@ -390,8 +360,7 @@ function intdiv (int $num1, int $num2): int
* @return bool true if val is infinite, else false.
*/
#[Pure]
-function is_infinite (float $num): bool
-{}
+function is_infinite(float $num): bool {}
/**
* Exponential expression
@@ -408,8 +377,7 @@ function is_infinite (float $num): bool
* If the power cannot be computed false will be returned instead.
*/
#[Pure]
-function pow (mixed $num, mixed $exponent): object|int|float
-{}
+function pow(mixed $num, mixed $exponent): object|int|float {}
/**
* Calculates the exponent of e
@@ -420,8 +388,7 @@ function pow (mixed $num, mixed $exponent): object|int|float
* @return float 'e' raised to the power of arg
*/
#[Pure]
-function exp (float $num): float
-{}
+function exp(float $num): float {}
/**
* Natural logarithm
@@ -438,8 +405,7 @@ function exp (float $num): float
* natural logarithm.
*/
#[Pure]
-function log (float $num, float $base = M_E): float
-{}
+function log(float $num, float $base = M_E): float {}
/**
* Base-10 logarithm
@@ -450,8 +416,7 @@ function log (float $num, float $base = M_E): float
* @return float The base-10 logarithm of arg
*/
#[Pure]
-function log10 (float $num): float
-{}
+function log10(float $num): float {}
/**
* Square root
@@ -463,8 +428,7 @@ function log10 (float $num): float
* or the special value NAN for negative numbers.
*/
#[Pure]
-function sqrt (float $num): float
-{}
+function sqrt(float $num): float {}
/**
* Calculate the length of the hypotenuse of a right-angle triangle
@@ -478,8 +442,7 @@ function sqrt (float $num): float
* @return float Calculated length of the hypotenuse
*/
#[Pure]
-function hypot (float $x, float $y): float
-{}
+function hypot(float $x, float $y): float {}
/**
* Converts the number in degrees to the radian equivalent
@@ -490,8 +453,7 @@ function hypot (float $x, float $y): float
* @return float The radian equivalent of number
*/
#[Pure]
-function deg2rad (float $num): float
-{}
+function deg2rad(float $num): float {}
/**
* Converts the radian number to the equivalent number in degrees
@@ -502,8 +464,7 @@ function deg2rad (float $num): float
* @return float The equivalent of number in degrees
*/
#[Pure]
-function rad2deg (float $num): float
-{}
+function rad2deg(float $num): float {}
/**
* Binary to decimal
@@ -514,8 +475,7 @@ function rad2deg (float $num): float
* @return int|float The decimal value of binary_string
*/
#[Pure]
-function bindec (string $binary_string): int|float
-{}
+function bindec(string $binary_string): int|float {}
/**
* Hexadecimal to decimal
@@ -526,8 +486,7 @@ function bindec (string $binary_string): int|float
* @return int|float The decimal representation of hex_string
*/
#[Pure]
-function hexdec (string $hex_string): int|float
-{}
+function hexdec(string $hex_string): int|float {}
/**
* Octal to decimal
@@ -538,8 +497,7 @@ function hexdec (string $hex_string): int|float
* @return int|float The decimal representation of octal_string
*/
#[Pure]
-function octdec (string $octal_string): int|float
-{}
+function octdec(string $octal_string): int|float {}
/**
* Decimal to binary
@@ -658,8 +616,7 @@ function octdec (string $octal_string): int|float
* @return string Binary string representation of number
*/
#[Pure]
-function decbin (int $num): string
-{}
+function decbin(int $num): string {}
/**
* Decimal to octal
@@ -670,8 +627,7 @@ function decbin (int $num): string
* @return string Octal string representation of number
*/
#[Pure]
-function decoct (int $num): string
-{}
+function decoct(int $num): string {}
/**
* Decimal to hexadecimal
@@ -682,8 +638,7 @@ function decoct (int $num): string
* @return string Hexadecimal string representation of number
*/
#[Pure]
-function dechex (int $num): string
-{}
+function dechex(int $num): string {}
/**
* Convert a number between arbitrary bases
@@ -700,8 +655,7 @@ function dechex (int $num): string
* @return string number converted to base tobase
*/
#[Pure]
-function base_convert (string $num, int $from_base, int $to_base): string
-{}
+function base_convert(string $num, int $from_base, int $to_base): string {}
/**
* Format a number with grouped thousands
@@ -717,8 +671,7 @@ function base_convert (string $num, int $from_base, int $to_base): string
* @return string A formatted version of number.
*/
#[Pure]
-function number_format (float $num , int $decimals = 0 , ?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
@@ -734,8 +687,7 @@ function number_format (float $num , int $decimals = 0 , ?string $decimal_separa
* x/y
*/
#[Pure]
-function fmod(float $num1, float $num2): float
-{}
+function fmod(float $num1, float $num2): float {}
/**
* Performs a floating-point division under
@@ -758,8 +710,7 @@ function fdiv(float $num1, float $num2): float {}
* @return string|false a string representation of the address or false on failure.
*/
#[Pure]
-function inet_ntop (string $ip): string|false
-{}
+function inet_ntop(string $ip): string|false {}
/**
* Converts a human readable IP address to its packed in_addr representation
@@ -771,8 +722,7 @@ function inet_ntop (string $ip): string|false
* address
*/
#[Pure]
-function inet_pton (string $ip): string|false
-{}
+function inet_pton(string $ip): string|false {}
/**
* Converts a string containing an (IPv4) Internet Protocol dotted address into a long integer
@@ -784,8 +734,7 @@ function inet_pton (string $ip): string|false
* is invalid.
*/
#[Pure]
-function ip2long (string $ip): int|false
-{}
+function ip2long(string $ip): int|false {}
/**
* Converts an long integer address into a string in (IPv4) internet standard dotted format
@@ -796,8 +745,7 @@ function ip2long (string $ip): int|false
* @return string|false the Internet IP address as a string.
*/
#[Pure]
-function long2ip (int $ip): string|false
-{}
+function long2ip(int $ip): string|false {}
/**
* Gets the value of an environment variable
@@ -813,8 +761,7 @@ function long2ip (int $ip): string|false
* is provided, or false on an error.
*/
#[Pure]
-function getenv (?string $name, bool $local_only = false): array|string|false
-{}
+function getenv(?string $name, bool $local_only = false): array|string|false {}
/**
* Sets the value of an environment variable
@@ -824,8 +771,7 @@ function getenv (?string $name, bool $local_only = false): array|string|false
*
* @return bool true on success or false on failure.
*/
-function putenv (string $assignment): bool
-{}
+function putenv(string $assignment): bool {}
/**
* Gets options from the command line argument list
@@ -846,8 +792,7 @@ function putenv (string $assignment): bool
* @return string[]|false[]|false This function will return an array of option / argument pairs or false on
* failure.
*/
-function getopt (string $short_options, array $long_options, &$rest_index): array|false
-{}
+function getopt(string $short_options, array $long_options, &$rest_index): array|false {}
/**
* Gets system load average
@@ -857,8 +802,7 @@ function getopt (string $short_options, array $long_options, &$rest_index): arra
* @since 5.1.3
*/
#[Pure]
-function sys_getloadavg (): array|false
-{}
+function sys_getloadavg(): array|false {}
/**
* Return current Unix timestamp with microseconds
@@ -877,8 +821,7 @@ function sys_getloadavg (): array|false
* @return string|float
*/
#[Pure]
-function microtime (#[TypeContract(true: "float", false: "string")] bool $as_float = false): string|float
-{}
+function microtime(#[TypeContract(true: "float", false: "string")] bool $as_float = false): string|float {}
/**
* Get current time
@@ -903,8 +846,7 @@ function microtime (#[TypeContract(true: "float", false: "string")] bool $as_flo
"minuteswest" => "int",
"dsttime" => "int"
])]
-function gettimeofday (#[TypeContract(true: "float", false: "int[]")] bool $as_float = false): array|float
-{}
+function gettimeofday(#[TypeContract(true: "float", false: "int[]")] bool $as_float = false): array|float {}
/**
* Gets the current resource usages
@@ -917,8 +859,7 @@ function gettimeofday (#[TypeContract(true: "float", false: "int[]")] bool $as_f
* call. All entries are accessible by using their documented field names.
*/
#[Pure]
-function getrusage (int $mode): array|false
-{}
+function getrusage(int $mode): array|false {}
/**
* Generate a unique ID
@@ -941,8 +882,7 @@ function getrusage (int $mode): array|false
* @return string the unique identifier, as a string.
*/
#[Pure]
-function uniqid (string $prefix = "", bool $more_entropy = false): string
-{}
+function uniqid(string $prefix = "", bool $more_entropy = false): string {}
/**
* Convert a quoted-printable string to an 8 bit string
@@ -953,8 +893,7 @@ function uniqid (string $prefix = "", bool $more_entropy = false): string
* @return string the 8-bit binary string.
*/
#[Pure]
-function quoted_printable_decode (string $string): string
-{}
+function quoted_printable_decode(string $string): string {}
/**
* Convert a 8 bit string to a quoted-printable string
@@ -965,8 +904,7 @@ function quoted_printable_decode (string $string): string
* @return string the encoded string.
*/
#[Pure]
-function quoted_printable_encode (string $string): string
-{}
+function quoted_printable_encode(string $string): string {}
/**
* Convert from one Cyrillic character set to another
@@ -987,9 +925,8 @@ function quoted_printable_encode (string $string): string
* @see UConverter
*/
#[Pure]
-#[Deprecated(since: '7.4',reason: 'Us mb_convert_string(), iconv() or UConverter instead.')]
-function convert_cyr_string (string $str, string $from, string $to): string
-{}
+#[Deprecated(since: '7.4', reason: 'Us mb_convert_string(), iconv() or UConverter instead.')]
+function convert_cyr_string(string $str, string $from, string $to): string {}
/**
* Gets the name of the owner of the current PHP script
@@ -997,8 +934,7 @@ function convert_cyr_string (string $str, string $from, string $to): string
* @return string the username as a string.
*/
#[Pure]
-function get_current_user (): string
-{}
+function get_current_user(): string {}
/**
* Limits the maximum execution time
@@ -1009,8 +945,7 @@ function get_current_user (): string
*
* @return bool Returns TRUE on success, or FALSE on failure.
*/
-function set_time_limit (int $seconds): bool
-{}
+function set_time_limit(int $seconds): bool {}
/**
* Gets the value of a PHP configuration option
@@ -1022,8 +957,7 @@ function set_time_limit (int $seconds): bool
* option, or false if an error occurs.
*/
#[Pure]
-function get_cfg_var (string $option): array|string|false
-{}
+function get_cfg_var(string $option): array|string|false {}
/**
* Alias:
@@ -1033,7 +967,7 @@ function get_cfg_var (string $option): array|string|false
* @removed 7.0
*/
#[Deprecated(since: '5.3')]
-function magic_quotes_runtime (bool $new_setting) {}
+function magic_quotes_runtime(bool $new_setting) {}
/**
* Sets the current active configuration setting of magic_quotes_runtime
@@ -1045,8 +979,7 @@ function magic_quotes_runtime (bool $new_setting) {}
* @removed 7.0
*/
#[Deprecated(reason: "This function has been DEPRECATED as of PHP 5.4.0. Raises an E_CORE_ERROR", since: "5.3")]
-function set_magic_quotes_runtime (bool $new_setting): bool
-{}
+function set_magic_quotes_runtime(bool $new_setting): bool {}
/**
* Gets the current configuration setting of magic quotes gpc
@@ -1055,8 +988,7 @@ function set_magic_quotes_runtime (bool $new_setting): bool
* @removed 8.0
*/
#[Deprecated(since: '7.4')]
-function get_magic_quotes_gpc (): int
-{}
+function get_magic_quotes_gpc(): int {}
/**
* Gets the current active configuration setting of magic_quotes_runtime
@@ -1064,8 +996,7 @@ function get_magic_quotes_gpc (): int
* @return int 0 if magic quotes runtime is off, 1 otherwise.
*/
#[Deprecated(since: '7.4')]
-function get_magic_quotes_runtime (): int
-{}
+function get_magic_quotes_runtime(): int {}
/**
* Import GET/POST/Cookie variables into the global scope
@@ -1101,8 +1032,7 @@ function get_magic_quotes_runtime (): int
* @removed 5.4
*/
#[Deprecated(reason: "This function has been DEPRECATED as of PHP 5.3.0", since: "5.3")]
-function import_request_variables (string $types, $prefix = null): bool
-{}
+function import_request_variables(string $types, $prefix = null): bool {}
/**
* Send an error message to the defined error handling routines
@@ -1170,6 +1100,4 @@ function import_request_variables (string $types, $prefix = null): bool
*
* @return bool true on success or false on failure.
*/
-function error_log (string $message, int $message_type, ?string $destination, ?string $additional_headers): bool
-{
-}
+function error_log(string $message, int $message_type, ?string $destination, ?string $additional_headers): bool {}
diff --git a/standard/standard_4.php b/standard/standard_4.php
index 872c511f8..aaa448380 100644
--- a/standard/standard_4.php
+++ b/standard/standard_4.php
@@ -18,8 +18,7 @@
"line" => "int",
])]
#[Pure]
-function error_get_last (): ?array
-{}
+function error_get_last(): ?array {}
/**
* Call the callback given by the first parameter
@@ -41,8 +40,7 @@ function error_get_last (): ?array
*
* @return mixed|false the function result, or false on error.
*/
-function call_user_func (callable $callback, mixed ...$args): mixed
-{}
+function call_user_func(callable $callback, mixed ...$args): mixed {}
/**
* Call a callback with an array of parameters
@@ -55,8 +53,7 @@ function call_user_func (callable $callback, mixed ...$args): mixed
*
* @return mixed|false the function result, or false on error.
*/
-function call_user_func_array (callable $callback, array $args): mixed
-{}
+function call_user_func_array(callable $callback, array $args): mixed {}
/**
* Call a user method on an specific object
@@ -69,8 +66,7 @@ function call_user_func_array (callable $callback, array $args): mixed
* @see call_user_func()
*/
#[Deprecated(reason: "use call_user_func() instead", since: "5.3")]
-function call_user_method (string $method_name, object &$obj, ...$parameter): mixed
-{}
+function call_user_method(string $method_name, object &$obj, ...$parameter): mixed {}
/**
* Call a user method given with an array of parameters
@@ -83,8 +79,7 @@ function call_user_method (string $method_name, object &$obj, ...$parameter): mi
* @see call_user_func()
*/
#[Deprecated(reason: "use call_user_func() instead", since: "5.3")]
-function call_user_method_array (string $method_name, object &$obj, array $params): mixed
-{}
+function call_user_method_array(string $method_name, object &$obj, array $params): mixed {}
/**
* Call a static method
@@ -99,8 +94,7 @@ function call_user_method_array (string $method_name, object &$obj, array $param
*
* @return mixed|false the function result, or false on error.
*/
-function forward_static_call (callable $callback, ...$args): mixed
-{}
+function forward_static_call(callable $callback, ...$args): mixed {}
/**
* Call a static method and pass the arguments as array
@@ -113,8 +107,7 @@ function forward_static_call (callable $callback, ...$args): mixed
* @param array $args
* @return mixed|false the function result, or false on error.
*/
-function forward_static_call_array (callable $callback, array $args): mixed
-{}
+function forward_static_call_array(callable $callback, array $args): mixed {}
/**
* Generates a storable representation of a value
@@ -142,8 +135,7 @@ function forward_static_call_array (callable $callback, array $args): mixed
* @return string a string containing a byte-stream representation of
* value that can be stored anywhere.
*/
-function serialize (mixed $value): string
-{}
+function serialize(mixed $value): string {}
/**
* Creates a PHP value from a stored representation
@@ -187,8 +179,7 @@ function serialize (mixed $value): string
* In case the passed string is not unserializeable, false is returned and
* E_NOTICE is issued.
*/
-function unserialize (string $data, array $options = []): mixed
-{}
+function unserialize(string $data, array $options = []): mixed {}
/**
* Dumps information about a variable
@@ -199,7 +190,7 @@ function unserialize (string $data, array $options = []): mixed
* @param mixed ...$values [optional]
* @return void
*/
-function var_dump (mixed $value, ...$values): void {}
+function var_dump(mixed $value, ...$values): void {}
/**
* Outputs or returns a parsable string representation of a variable
@@ -215,8 +206,7 @@ function var_dump (mixed $value, ...$values): void {}
* parameter is used and evaluates to true. Otherwise, this function will
* return null.
*/
-function var_export (mixed $value, bool $return = false): ?string
-{}
+function var_export(mixed $value, bool $return = false): ?string {}
/**
* Dumps a string representation of an internal zend value to output
@@ -227,7 +217,7 @@ function var_export (mixed $value, bool $return = false): ?string
*
* @return void
*/
-function debug_zval_dump (mixed $value, mixed ...$values): void {}
+function debug_zval_dump(mixed $value, mixed ...$values): void {}
/**
* Prints human-readable information about a variable
@@ -246,8 +236,7 @@ function debug_zval_dump (mixed $value, mixed ...$values): void {}
* will be presented in a format that shows keys and elements. Similar
* notation is used for objects.
*/
-function print_r (mixed $value, bool $return = false): string|bool
-{}
+function print_r(mixed $value, bool $return = false): string|bool {}
/**
* Returns the amount of memory allocated to PHP
@@ -260,8 +249,7 @@ function print_r (mixed $value, bool $return = false): string|bool
* @return int the memory amount in bytes.
*/
#[Pure]
-function memory_get_usage (bool $real_usage = false): int
-{}
+function memory_get_usage(bool $real_usage = false): int {}
/**
* Returns the peak of memory allocated by PHP
@@ -274,8 +262,7 @@ function memory_get_usage (bool $real_usage = false): int
* @return int the memory peak in bytes.
*/
#[Pure]
-function memory_get_peak_usage (bool $real_usage = false): int
-{}
+function memory_get_peak_usage(bool $real_usage = false): int {}
/**
* Register a function for execution on shutdown
@@ -300,7 +287,7 @@ function memory_get_peak_usage (bool $real_usage = false): int
*
* @return bool|null
*/
-function register_shutdown_function (callable $callback, ...$args): ?bool {}
+function register_shutdown_function(callable $callback, ...$args): ?bool {}
/**
* Register a function for execution on each tick
@@ -313,8 +300,7 @@ function register_shutdown_function (callable $callback, ...$args): ?bool {}
*
* @return bool true on success or false on failure.
*/
-function register_tick_function (callable $callback, ...$args): bool
-{}
+function register_tick_function(callable $callback, ...$args): bool {}
/**
* De-register a function for execution on each tick
@@ -325,7 +311,7 @@ function register_tick_function (callable $callback, ...$args): bool
*
* @return void
*/
-function unregister_tick_function (callable $callback): void {}
+function unregister_tick_function(callable $callback): void {}
/**
* Syntax highlighting of a file
@@ -341,8 +327,7 @@ function unregister_tick_function (callable $callback): void {}
* code as a string instead of printing it out. Otherwise, it will return
* true on success, false on failure.
*/
-function highlight_file (string $filename, bool $return = false): string|bool
-{}
+function highlight_file(string $filename, bool $return = false): string|bool {}
/**
* Alias:
@@ -352,8 +337,7 @@ function highlight_file (string $filename, bool $return = false): string|bool
* @param bool $return [optional]
* @return string|bool
*/
-function show_source (string $filename, bool $return = false): string|bool
-{}
+function show_source(string $filename, bool $return = false): string|bool {}
/**
* Syntax highlighting of a string
@@ -369,8 +353,7 @@ function show_source (string $filename, bool $return = false): string|bool
* code as a string instead of printing it out. Otherwise, it will return
* true on success, false on failure.
*/
-function highlight_string (string $string, bool $return = false): string|bool
-{}
+function highlight_string(string $string, bool $return = false): string|bool {}
/**
* Get the system's high resolution time
@@ -381,8 +364,7 @@ function highlight_string (string $string, bool $return = false): string|bool
* Otherwise the nanoseconds are returned as integer (64bit platforms) or float (32bit platforms).
*/
#[Pure]
-function hrtime(bool $as_number = false): array|int|float|false
-{}
+function hrtime(bool $as_number = false): array|int|float|false {}
/**
* Return source with stripped comments and whitespace
@@ -400,8 +382,7 @@ function hrtime(bool $as_number = false): array|int|float|false
* #29606.
*/
#[Pure]
-function php_strip_whitespace (string $filename): string
-{}
+function php_strip_whitespace(string $filename): string {}
/**
* Gets the value of a configuration option
@@ -414,8 +395,7 @@ function php_strip_whitespace (string $filename): string
* an empty string on failure or for null values.
*/
#[Pure]
-function ini_get (string $option): string|false
-{}
+function ini_get(string $option): string|false {}
/**
* Gets all configuration options
@@ -451,8 +431,7 @@ function ini_get (string $option): string|false
*
*/
#[Pure]
-function ini_get_all (?string $extension, bool $details = true): array|false
-{}
+function ini_get_all(?string $extension, bool $details = true): array|false {}
/**
* Sets the value of a configuration option
@@ -470,8 +449,7 @@ function ini_get_all (?string $extension, bool $details = true): array|false
*
* @return string|false the old value on success, false on failure.
*/
-function ini_set (string $option, string $value): string|false
-{}
+function ini_set(string $option, string $value): string|false {}
/**
* Alias:
@@ -482,8 +460,7 @@ function ini_set (string $option, string $value): string|false
* @param string $value
* @return string|false
*/
-function ini_alter (string $option, string $value): string|false
-{}
+function ini_alter(string $option, string $value): string|false {}
/**
* Restores the value of a configuration option
@@ -494,7 +471,7 @@ function ini_alter (string $option, string $value): string|false
*
* @return void
*/
-function ini_restore (string $option): void {}
+function ini_restore(string $option): void {}
/**
* Gets the current include_path configuration option
@@ -502,8 +479,7 @@ function ini_restore (string $option): void {}
* @return string|false the path, as a string.
*/
#[Pure]
-function get_include_path (): string|false
-{}
+function get_include_path(): string|false {}
/**
* Sets the include_path configuration option
@@ -514,8 +490,7 @@ function get_include_path (): string|false
* @return string|false the old include_path on
* success or false on failure.
*/
-function set_include_path (string $include_path): string|false
-{}
+function set_include_path(string $include_path): string|false {}
/**
* Restores the value of the include_path configuration option
@@ -524,7 +499,7 @@ function set_include_path (string $include_path): string|false
* @removed 8.0
*/
#[Deprecated(since: '7.4')]
-function restore_include_path () {}
+function restore_include_path() {}
/**
* Send a cookie
@@ -601,8 +576,7 @@ function restore_include_path () {}
* setcookie successfully runs, it will return true.
* This does not indicate whether the user accepted the cookie.
*/
-function setcookie (string $name, $value = "", $expires_or_options = 0, $path = "", $domain = "", $secure = false, $httponly = false): bool
-{}
+function setcookie(string $name, $value = "", $expires_or_options = 0, $path = "", $domain = "", $secure = false, $httponly = false): bool {}
/**
* Send a cookie
@@ -625,8 +599,7 @@ function setcookie (string $name, $value = "", $expires_or_options = 0, $path =
* This does not indicate whether the user accepted the cookie.
* @since 7.3
*/
-function setcookie(string $name, $value = '', array $options = []): bool
-{}
+function setcookie(string $name, $value = '', array $options = []): bool {}
/**
* Send a cookie without urlencoding the cookie value
@@ -640,8 +613,7 @@ function setcookie(string $name, $value = '', array $options = []): bool
* @param bool $httponly [optional]
* @return bool true on success or false on failure.
*/
-function setrawcookie (string $name, $value = '', $expires_or_options = 0, $path = "", $domain = "", $secure = false, $httponly = false): bool
-{}
+function setrawcookie(string $name, $value = '', $expires_or_options = 0, $path = "", $domain = "", $secure = false, $httponly = false): bool {}
/**
* Send a cookie without urlencoding the cookie value
@@ -663,8 +635,7 @@ function setrawcookie (string $name, $value = '', $expires_or_options = 0, $path
* setcookie successfully runs, it will return true.
* This does not indicate whether the user accepted the cookie.
*/
-function setrawcookie (string $name, $value = '', array $options = []): bool
-{}
+function setrawcookie(string $name, $value = '', array $options = []): bool {}
/**
* Send a raw HTTP header
@@ -700,8 +671,7 @@ function setrawcookie (string $name, $value = '', array $options = []): bool
*
* @return void
*/
-function header (string $header, bool $replace = true, int $response_code): void
-{}
+function header(string $header, bool $replace = true, int $response_code): void {}
/**
* Remove previously set headers
@@ -712,7 +682,7 @@ function header (string $header, bool $replace = true, int $response_code): void
* This parameter is case-insensitive.
* @return void
*/
-function header_remove (?string $name): void {}
+function header_remove(?string $name): void {}
/**
* Checks if or where headers have been sent
@@ -730,8 +700,7 @@ function header_remove (?string $name): void {}
* @return bool headers_sent will return false if no HTTP headers
* have already been sent or true otherwise.
*/
-function headers_sent (&$filename, &$line): bool
-{}
+function headers_sent(&$filename, &$line): bool {}
/**
* Returns a list of response headers sent (or ready to send)
@@ -739,8 +708,7 @@ function headers_sent (&$filename, &$line): bool
* @return array a numerically indexed array of headers.
*/
#[Pure]
-function headers_list (): array
-{}
+function headers_list(): array {}
/**
* Fetches all HTTP request headers from the current request
@@ -748,8 +716,7 @@ function headers_list (): array
* @return array|false An associative array of all the HTTP headers in the current request, or FALSE on failure.
*/
#[Pure]
-function apache_request_headers (): false|array
-{}
+function apache_request_headers(): false|array {}
/**
* Fetches all HTTP headers from the current request.
@@ -758,8 +725,7 @@ function apache_request_headers (): false|array
* @return array|false An associative array of all the HTTP headers in the current request, or FALSE on failure.
*/
#[Pure]
-function getallheaders (): false|array
-{}
+function getallheaders(): false|array {}
/**
* Check whether client disconnected
@@ -767,8 +733,7 @@ function getallheaders (): false|array
* @return int 1 if client disconnected, 0 otherwise.
*/
#[Pure]
-function connection_aborted (): int
-{}
+function connection_aborted(): int {}
/**
* Returns connection status bitfield
@@ -778,8 +743,7 @@ function connection_aborted (): int
* status.
*/
#[Pure]
-function connection_status (): int
-{}
+function connection_status(): int {}
/**
* Set whether a client disconnect should abort script execution
@@ -791,8 +755,7 @@ function connection_status (): int
*
* @return int the previous setting, as an integer.
*/
-function ignore_user_abort (?bool $enable): int
-{}
+function ignore_user_abort(?bool $enable): int {}
/**
* Parse a configuration file
@@ -822,8 +785,7 @@ function ignore_user_abort (?bool $enable): int
* @return array|false The settings are returned as an associative array on success,
* and false on failure.
*/
-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 = INI_SCANNER_NORMAL): array|false {}
/**
* Parse a configuration string
@@ -846,8 +808,7 @@ function parse_ini_file (string $filename, bool $process_sections = false, int $
* and false on failure.
*/
#[Pure]
-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 = INI_SCANNER_NORMAL): array|false {}
/**
* Tells whether the file was uploaded via HTTP POST
@@ -858,8 +819,7 @@ function parse_ini_string (string $ini_string, bool $process_sections = false, i
* @return bool true on success or false on failure.
*/
#[Pure]
-function is_uploaded_file (string $filename): bool
-{}
+function is_uploaded_file(string $filename): bool {}
/**
* Moves an uploaded file to a new location
@@ -881,16 +841,14 @@ function is_uploaded_file (string $filename): bool
* move_uploaded_file will return
* false. Additionally, a warning will be issued.
*/
-function move_uploaded_file (string $from, string $to): bool
-{}
+function move_uploaded_file(string $from, string $to): bool {}
/**
* @return array|false
* @since 7.3
*/
#[Pure]
-function net_get_interfaces(): array|false
-{}
+function net_get_interfaces(): array|false {}
/**
* Get the Internet host name corresponding to a given IP address
@@ -902,8 +860,7 @@ function net_get_interfaces(): array|false
* on failure.
*/
#[Pure]
-function gethostbyaddr (string $ip): string|false
-{}
+function gethostbyaddr(string $ip): string|false {}
/**
* Get the IPv4 address corresponding to a given Internet host name
@@ -915,8 +872,7 @@ function gethostbyaddr (string $ip): string|false
* hostname on failure.
*/
#[Pure]
-function gethostbyname (string $hostname): string
-{}
+function gethostbyname(string $hostname): string {}
/**
* Get a list of IPv4 addresses corresponding to a given Internet host
@@ -929,8 +885,7 @@ function gethostbyname (string $hostname): string
* hostname could not be resolved.
*/
#[Pure]
-function gethostbynamel(string $hostname): array|false
-{}
+function gethostbynamel(string $hostname): array|false {}
/**
* Gets the host name
@@ -939,8 +894,7 @@ function gethostbynamel(string $hostname): array|false
* returned.
*/
#[Pure]
-function gethostname (): string|false
-{}
+function gethostname(): string|false {}
/**
* Alias:
@@ -956,8 +910,7 @@ function gethostname (): string|false
*
* @return bool Returns TRUE if any records are found; returns FALSE if no records were found or if an error occurred.
*/
-function dns_check_record (string $hostname, string $type = 'MX'): bool
-{}
+function dns_check_record(string $hostname, string $type = 'MX'): bool {}
/**
* Check DNS records corresponding to a given Internet host name or IP address
@@ -974,8 +927,7 @@ function dns_check_record (string $hostname, string $type = 'MX'): bool
* were found or if an error occurred.
*/
#[Pure]
-function checkdnsrr (string $hostname, string $type = 'MX'): bool
-{}
+function checkdnsrr(string $hostname, string $type = 'MX'): bool {}
/**
* Alias:
@@ -986,8 +938,7 @@ function checkdnsrr (string $hostname, string $type = 'MX'): bool
* @param array &$weights [optional]
* @return bool
*/
-function dns_get_mx (string $hostname, &$hosts, &$weights): bool
-{}
+function dns_get_mx(string $hostname, &$hosts, &$weights): bool {}
/**
* Get MX records corresponding to a given Internet host name
@@ -1006,8 +957,7 @@ function dns_get_mx (string $hostname, &$hosts, &$weights): bool
* @return bool true if any records are found; returns false if no records
* were found or if an error occurred.
*/
-function getmxrr (string $hostname, &$hosts, &$weights): bool
-{}
+function getmxrr(string $hostname, &$hosts, &$weights): bool {}
/**
* Fetch DNS Resource Records associated with a hostname
@@ -1216,5 +1166,4 @@ function getmxrr (string $hostname, &$hosts, &$weights): bool
*
*
*/
-function dns_get_record (string $hostname, int $type = DNS_ANY, &$authoritative_name_servers, &$additional_records, bool $raw = false): array|false
-{}
+function dns_get_record(string $hostname, int $type = DNS_ANY, &$authoritative_name_servers, &$additional_records, bool $raw = false): array|false {}
diff --git a/standard/standard_5.php b/standard/standard_5.php
index b893a7071..0473bf214 100644
--- a/standard/standard_5.php
+++ b/standard/standard_5.php
@@ -13,8 +13,7 @@
* @since 5.5
*/
#[Pure]
-function boolval(mixed $value): bool
-{}
+function boolval(mixed $value): bool {}
/**
* Get the integer value of a variable
@@ -43,8 +42,7 @@ function boolval(mixed $value): bool
* apply.
*/
#[Pure]
-function intval (mixed $value, int $base = 10): int
-{}
+function intval(mixed $value, int $base = 10): int {}
/**
* Get float value of a variable
@@ -53,8 +51,7 @@ function intval (mixed $value, int $base = 10): int
* @return float value of the given variable. Empty arrays return 0, non-empty arrays return 1.
*/
#[Pure]
-function floatval (mixed $value): float
-{}
+function floatval(mixed $value): float {}
/**
* (PHP 4.2.0, PHP 5)
@@ -66,8 +63,7 @@ function floatval (mixed $value): float
* @return float value of the given variable. Empty arrays return 0, non-empty arrays return 1.
*/
#[Pure]
-function doubleval (mixed $value): float
-{}
+function doubleval(mixed $value): float {}
/**
* Get string value of a variable
@@ -82,8 +78,7 @@ function doubleval (mixed $value): float
* @return string The string value of var.
*/
#[Pure]
-function strval (mixed $value): string
-{}
+function strval(mixed $value): string {}
/**
* Get the type of a variable
@@ -107,20 +102,9 @@ function strval (mixed $value): string
*/
#[Pure]
#[ExpectedValues([
- "boolean"
- , "integer"
- , "double"
- , "string"
- , "array"
- , "object"
- , "resource"
- , "NULL"
- , "unknown type"
- , "resource (closed)"
+ "boolean", "integer", "double", "string", "array", "object", "resource", "NULL", "unknown type", "resource (closed)"
])]
-function gettype(mixed $value): string
-{
-}
+function gettype(mixed $value): string {}
/**
* Set the type of a variable
@@ -156,8 +140,7 @@ function gettype(mixed $value): string
*
* @return bool true on success or false on failure.
*/
-function settype (mixed &$var, #[ExpectedValues(["bool", "boolean", "int", "integer", "float", "double", "string", "array", "object", "null"])] string $type): bool
-{}
+function settype(mixed &$var, #[ExpectedValues(["bool", "boolean", "int", "integer", "float", "double", "string", "array", "object", "null"])] string $type): bool {}
/**
* Finds whether a variable is null.
@@ -169,8 +152,7 @@ function settype (mixed &$var, #[ExpectedValues(["bool", "boolean", "int", "inte
* otherwise.
*/
#[Pure]
-function is_null (mixed $value): bool
-{}
+function is_null(mixed $value): bool {}
/**
* Finds whether a variable is a resource
@@ -182,8 +164,7 @@ function is_null (mixed $value): bool
* false otherwise.
*/
#[Pure]
-function is_resource (mixed $value): bool
-{}
+function is_resource(mixed $value): bool {}
/**
* Finds out whether a variable is a boolean
@@ -195,8 +176,7 @@ function is_resource (mixed $value): bool
* false otherwise.
*/
#[Pure]
-function is_bool (mixed $value): bool
-{}
+function is_bool(mixed $value): bool {}
/**
* Alias:
@@ -209,8 +189,7 @@ function is_bool (mixed $value): bool
* false otherwise.
*/
#[Pure]
-function is_long (mixed $value): bool
-{}
+function is_long(mixed $value): bool {}
/**
* Finds whether the type of a variable is float
@@ -222,8 +201,7 @@ function is_long (mixed $value): bool
* false otherwise.
*/
#[Pure]
-function is_float (mixed $value): bool
-{}
+function is_float(mixed $value): bool {}
/**
* Find whether the type of a variable is integer
@@ -235,8 +213,7 @@ function is_float (mixed $value): bool
* false otherwise.
*/
#[Pure]
-function is_int (mixed $value): bool
-{}
+function is_int(mixed $value): bool {}
/**
* Alias:
@@ -249,8 +226,7 @@ function is_int (mixed $value): bool
* false otherwise.
*/
#[Pure]
-function is_integer (mixed $value): bool
-{}
+function is_integer(mixed $value): bool {}
/**
* Alias:
@@ -263,8 +239,7 @@ function is_integer (mixed $value): bool
* false otherwise.
*/
#[Pure]
-function is_double (mixed $value): bool
-{}
+function is_double(mixed $value): bool {}
/**
* Alias:
@@ -278,8 +253,7 @@ function is_double (mixed $value): bool
*/
#[Pure]
#[Deprecated(since: '7.4')]
-function is_real (mixed $var): bool
-{}
+function is_real(mixed $var): bool {}
/**
* Finds whether a variable is a number or a numeric string
@@ -291,8 +265,7 @@ function is_real (mixed $var): bool
* string, false otherwise.
*/
#[Pure]
-function is_numeric (mixed $value): bool
-{}
+function is_numeric(mixed $value): bool {}
/**
* Find whether the type of a variable is string
@@ -304,8 +277,7 @@ function is_numeric (mixed $value): bool
* false otherwise.
*/
#[Pure]
-function is_string (mixed $value): bool
-{}
+function is_string(mixed $value): bool {}
/**
* Finds whether a variable is an array
@@ -317,8 +289,7 @@ function is_string (mixed $value): bool
* false otherwise.
*/
#[Pure]
-function is_array (mixed $value): bool
-{}
+function is_array(mixed $value): bool {}
/**
* Finds whether a variable is an object
@@ -330,8 +301,7 @@ function is_array (mixed $value): bool
* Since 7.2.0 returns true for unserialized objects without a class definition (class of __PHP_Incomplete_Class).
*/
#[Pure]
-function is_object (mixed $value): bool
-{}
+function is_object(mixed $value): bool {}
/**
* Finds whether a variable is a scalar
@@ -343,8 +313,7 @@ function is_object (mixed $value): bool
* otherwise.
*/
#[Pure]
-function is_scalar (mixed $value): bool
-{}
+function is_scalar(mixed $value): bool {}
/**
* Verify that the contents of a variable can be called as a function
@@ -369,8 +338,7 @@ function is_scalar (mixed $value): bool
* @return bool TRUE if $var is callable, FALSE
* otherwise.
*/
-function is_callable (mixed $value, bool $syntax_only = false, &$callable_name): bool
-{}
+function is_callable(mixed $value, bool $syntax_only = false, &$callable_name): bool {}
/**
* Verify that the contents of a variable is a countable value
@@ -381,8 +349,7 @@ function is_callable (mixed $value, bool $syntax_only = false, &$callable_name):
* @since 7.3
*/
#[Pure]
-function is_countable(mixed $value): bool
-{}
+function is_countable(mixed $value): bool {}
/**
* Closes process file pointer
@@ -396,8 +363,7 @@ function is_countable(mixed $value): bool
* If PHP has been compiled with --enable-sigchild, the return value of this function is undefined.
*
*/
-function pclose ($handle): int
-{}
+function pclose($handle): int {}
/**
* Opens process file pointer
@@ -418,8 +384,7 @@ function pclose ($handle): int
*
* If an error occurs, returns false.
*/
-function popen (string $command, string $mode)
-{}
+function popen(string $command, string $mode) {}
/**
* Outputs a file
@@ -436,8 +401,7 @@ function popen (string $command, string $mode)
*
* @return false|int the number of bytes read from the file, or FALSE on failure
*/
-function readfile (string $filename, bool $use_include_path = false, $context): int|false
-{}
+function readfile(string $filename, bool $use_include_path = false, $context): int|false {}
/**
* Rewind the position of a file pointer
@@ -448,8 +412,7 @@ function readfile (string $filename, bool $use_include_path = false, $context):
*
* @return bool true on success or false on failure.
*/
-function rewind ($stream): bool
-{}
+function rewind($stream): bool {}
/**
* Removes directory
@@ -460,8 +423,7 @@ function rewind ($stream): bool
* @param resource $context [optional]
* @return bool true on success or false on failure.
*/
-function rmdir (string $directory, $context): bool
-{}
+function rmdir(string $directory, $context): bool {}
/**
* Changes the current umask
@@ -472,8 +434,7 @@ function rmdir (string $directory, $context): bool
* @return int umask without arguments simply returns the
* current umask otherwise the old umask is returned.
*/
-function umask (?int $mask): int
-{}
+function umask(?int $mask): int {}
/**
* Closes an open file pointer
@@ -484,8 +445,7 @@ function umask (?int $mask): int
*
* @return bool true on success or false on failure.
*/
-function fclose ($stream): bool
-{}
+function fclose($stream): bool {}
/**
* Tests for end-of-file on a file pointer
@@ -494,8 +454,7 @@ function fclose ($stream): bool
* @return bool true if the file pointer is at EOF or an error occurs
* (including socket timeout); otherwise returns false.
*/
-function feof ($stream): bool
-{}
+function feof($stream): bool {}
/**
* Gets character from file pointer
@@ -504,8 +463,7 @@ function feof ($stream): bool
* @return string|false a string containing a single character read from the file pointed
* to by handle. Returns false on EOF.
*/
-function fgetc ($stream): string|false
-{}
+function fgetc($stream): string|false {}
/**
* Gets line from file pointer
@@ -529,8 +487,7 @@ function fgetc ($stream): string|false
*
* If an error occurs, returns false.
*/
-function fgets ($stream, ?int $length): string|false
-{}
+function fgets($stream, ?int $length): string|false {}
/**
* Gets line from file pointer and strip HTML tags
@@ -552,8 +509,7 @@ function fgets ($stream, ?int $length): string|false
* @removed 8.0
*/
#[Deprecated(since: '7.3')]
-function fgetss ($handle, ?int $length = null, $allowable_tags = null): false|string
-{}
+function fgetss($handle, ?int $length = null, $allowable_tags = null): false|string {}
/**
* Binary-safe file read
@@ -564,8 +520,7 @@ function fgetss ($handle, ?int $length = null, $allowable_tags = null): false|st
*
* @return string|false the read string or false on failure.
*/
-function fread ($stream, int $length): string|false
-{}
+function fread($stream, int $length): string|false {}
/**
* Opens file or URL
@@ -748,8 +703,7 @@ function fread ($stream, int $length): string|false
* @param resource $context [optional]
* @return resource|false a file pointer resource on success, or false on error.
*/
-function fopen (string $filename, string $mode, bool $use_include_path = false, $context)
-{}
+function fopen(string $filename, string $mode, bool $use_include_path = false, $context) {}
/**
* Output all remaining data on a file pointer
@@ -761,8 +715,7 @@ function fopen (string $filename, string $mode, bool $use_include_path = false,
* and passed through to the output.
*/
#[LanguageLevelTypeAware(["8.0" => "int"], default: "int|false")]
-function fpassthru ($stream)
-{}
+function fpassthru($stream) {}
/**
* Truncates a file to a given length
@@ -786,8 +739,7 @@ function fpassthru ($stream)
*
* @return bool true on success or false on failure.
*/
-function ftruncate ($stream, int $size): bool
-{}
+function ftruncate($stream, int $size): bool {}
/**
* Gets information about a file using an open file pointer
@@ -796,8 +748,7 @@ function ftruncate ($stream, int $size): bool
* @return array|false an array with the statistics of the file; the format of the array
* is described in detail on the stat manual page.
*/
-function fstat ($stream): array|false
-{}
+function fstat($stream): array|false {}
/**
* Seeks on a file pointer
@@ -825,8 +776,7 @@ function fstat ($stream): array|false
* @return int Upon success, returns 0; otherwise, returns -1. Note that seeking
* past EOF is not considered an error.
*/
-function fseek ($stream, int $offset, int $whence = SEEK_SET): int
-{}
+function fseek($stream, int $offset, int $whence = SEEK_SET): int {}
/**
* Returns the current position of the file read/write pointer
@@ -843,8 +793,7 @@ function fseek ($stream, int $offset, int $whence = SEEK_SET): int
*
* If an error occurs, returns false.
*/
-function ftell ($stream): int|false
-{}
+function ftell($stream): int|false {}
/**
* Flushes the output to a file
@@ -852,8 +801,7 @@ function ftell ($stream): int|false
* @param resource $stream The file pointer must be valid, and must point to a file successfully opened by fopen() or fsockopen() (and not yet closed by fclose()).
* @return bool true on success or false on failure.
*/
-function fflush ($stream): bool
-{}
+function fflush($stream): bool {}
/**
* Binary-safe file write
@@ -876,8 +824,7 @@ function fflush ($stream): bool
*
* @return int|false the number of bytes written, or FALSE on error.
*/
-function fwrite ($stream, string $data, ?int $length): int|false
-{}
+function fwrite($stream, string $data, ?int $length): int|false {}
/**
* Alias:
@@ -903,8 +850,7 @@ function fwrite ($stream, string $data, ?int $length): int|false
* @link https://php.net/manual/en/function.fputs.php
* Binary-safe file write
*/
-function fputs ($stream, string $data, ?int $length): int|false
-{}
+function fputs($stream, string $data, ?int $length): int|false {}
/**
* Attempts to create the directory specified by pathname.
@@ -932,8 +878,7 @@ function fputs ($stream, string $data, ?int $length): int|false
* @param resource $context [optional]
* @return bool true on success or false on failure.
*/
-function mkdir (string $directory, int $permissions = 0777, bool $recursive = false, $context): bool
-{}
+function mkdir(string $directory, int $permissions = 0777, bool $recursive = false, $context): bool {}
/**
* Renames a file or directory
@@ -951,8 +896,7 @@ function mkdir (string $directory, int $permissions = 0777, bool $recursive = fa
* @param resource $context [optional]
* @return bool true on success or false on failure.
*/
-function rename (string $from, string $to, $context): bool
-{}
+function rename(string $from, string $to, $context): bool {}
/**
* Copies file
@@ -974,8 +918,7 @@ function rename (string $from, string $to, $context): bool
*
* @return bool true on success or false on failure.
*/
-function copy (string $from, string $to, $context): bool
-{}
+function copy(string $from, string $to, $context): bool {}
/**
* Create file with unique file name
@@ -990,8 +933,7 @@ function copy (string $from, string $to, $context): bool
* @return string|false the new temporary filename, or false on
* failure.
*/
-function tempnam (string $directory, string $prefix): string|false
-{}
+function tempnam(string $directory, string $prefix): string|false {}
/**
* Creates a temporary file
@@ -999,8 +941,7 @@ function tempnam (string $directory, string $prefix): string|false
* @return resource|false a file handle, similar to the one returned by
* fopen, for the new file or false on failure.
*/
-function tmpfile ()
-{}
+function tmpfile() {}
/**
* Reads entire file into an array
@@ -1027,8 +968,7 @@ function tmpfile ()
* present.
*
*/
-function file (string $filename, int $flags, $context): array|false
-{}
+function file(string $filename, int $flags, $context): array|false {}
/**
* Reads entire file into a string
@@ -1054,8 +994,7 @@ function file (string $filename, int $flags, $context): array|false
*
* @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, int $offset = 0, ?int $length): string|false
-{}
+function file_get_contents(string $filename, bool $use_include_path = false, $context, int $offset = 0, ?int $length): string|false {}
/**
* Write a string to a file
@@ -1128,5 +1067,4 @@ function file_get_contents (string $filename, bool $use_include_path = false, $c
* @return int|false The 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 = 0, $context): int|false
-{}
+function file_put_contents(string $filename, mixed $data, int $flags = 0, $context): int|false {}
diff --git a/standard/standard_6.php b/standard/standard_6.php
index 5b90974d5..783e9dfab 100644
--- a/standard/standard_6.php
+++ b/standard/standard_6.php
@@ -77,8 +77,7 @@
* is returned and a warning raised (this can happen if the system call is
* interrupted by an incoming signal).
*/
-function stream_select (?array &$read, ?array &$write, ?array &$except, ?int $seconds, int $microseconds): int|false
-{}
+function stream_select(?array &$read, ?array &$write, ?array &$except, ?int $seconds, int $microseconds): int|false {}
/**
* Create a stream context
@@ -98,7 +97,7 @@ function stream_select (?array &$read, ?array &$write, ?array &$except, ?int $se
*
* @return resource A stream context resource.
*/
-function stream_context_create (?array $options, ?array $params) {}
+function stream_context_create(?array $options, ?array $params) {}
/**
* Set parameters for a stream/wrapper/context
@@ -115,8 +114,7 @@ function stream_context_create (?array $options, ?array $params) {}
*
* @return bool true on success or false on failure.
*/
-function stream_context_set_params ($context, array $params): bool
-{}
+function stream_context_set_params($context, array $params): bool {}
/**
* Retrieves parameters from a context
@@ -127,8 +125,7 @@ function stream_context_set_params ($context, array $params): bool
*
* @return array an associate array containing all context options and parameters.
*/
-function stream_context_get_params ($context): array
-{}
+function stream_context_get_params($context): array {}
/**
* Sets an option for a stream/wrapper/context
@@ -141,8 +138,7 @@ function stream_context_get_params ($context): array
* @param mixed $value
* @return bool true on success or false on failure.
*/
-function stream_context_set_option ($context, string $wrapper_or_options, string $option_name, mixed $value): bool
-{}
+function stream_context_set_option($context, string $wrapper_or_options, string $option_name, mixed $value): bool {}
/**
* Sets an option for a stream/wrapper/context
@@ -151,8 +147,7 @@ function stream_context_set_option ($context, string $wrapper_or_options, string
* @param array $options The options to set for the default context.
* @return bool true on success or false on failure.
*/
-function stream_context_set_option ($stream_or_context, array $options): bool
-{}
+function stream_context_set_option($stream_or_context, array $options): bool {}
/**
* Retrieve options for a stream/wrapper/context
@@ -162,8 +157,7 @@ function stream_context_set_option ($stream_or_context, array $options): bool
*
* @return array an associative array with the options.
*/
-function stream_context_get_options ($stream_or_context): array
-{}
+function stream_context_get_options($stream_or_context): array {}
/**
* Retreive the default stream context
@@ -177,7 +171,7 @@ function stream_context_get_options ($stream_or_context): array
*
* @return resource A stream context resource.
*/
-function stream_context_get_default (?array $options) {}
+function stream_context_get_default(?array $options) {}
/**
* Set the default stream context
@@ -192,7 +186,7 @@ function stream_context_get_default (?array $options) {}
*
* @return resource the default stream context.
*/
-function stream_context_set_default (array $options) {}
+function stream_context_set_default(array $options) {}
/**
* Attach a filter to a stream
@@ -227,8 +221,7 @@ function stream_context_set_default (array $options) {}
* @return resource|false a resource which can be used to refer to this filter
* instance during a call to stream_filter_remove.
*/
-function stream_filter_prepend ($stream, string $filter_name, int $mode, mixed $params)
-{}
+function stream_filter_prepend($stream, string $filter_name, int $mode, mixed $params) {}
/**
* Attach a filter to a stream
@@ -262,8 +255,7 @@ function stream_filter_prepend ($stream, string $filter_name, int $mode, mixed $
* @return resource|false a resource which can be used to refer to this filter
* instance during a call to stream_filter_remove.
*/
-function stream_filter_append ($stream, string $filter_name, int $mode, mixed $params)
-{}
+function stream_filter_append($stream, string $filter_name, int $mode, mixed $params) {}
/**
* Remove a filter from a stream
@@ -273,8 +265,7 @@ function stream_filter_append ($stream, string $filter_name, int $mode, mixed $p
*
* @return bool true on success or false on failure.
*/
-function stream_filter_remove ($stream_filter): bool
-{}
+function stream_filter_remove($stream_filter): bool {}
/**
* Open Internet or Unix domain socket connection
@@ -316,8 +307,7 @@ function stream_filter_remove ($stream_filter): bool
* fwrite, fclose, and
* feof), false on failure.
*/
-function stream_socket_client (string $address, &$error_code, &$error_message, ?float $timeout, int $flags = STREAM_CLIENT_CONNECT, $context)
-{}
+function stream_socket_client(string $address, &$error_code, &$error_message, ?float $timeout, int $flags = STREAM_CLIENT_CONNECT, $context) {}
/**
* Create an Internet or Unix domain server socket
@@ -367,8 +357,7 @@ function stream_socket_client (string $address, &$error_code, &$error_message, ?
*
* @return resource|false the created stream, or false on error.
*/
-function stream_socket_server (string $address, &$error_code, &$error_message, int $flags = STREAM_SERVER_BIND | STREAM_SERVER_LISTEN, $context)
-{}
+function stream_socket_server(string $address, &$error_code, &$error_message, int $flags = STREAM_SERVER_BIND|STREAM_SERVER_LISTEN, $context) {}
/**
* Accept a connection on a socket created by {@see stream_socket_server}
@@ -388,8 +377,7 @@ function stream_socket_server (string $address, &$error_code, &$error_message, i
*
* @return resource|false Returns a stream to the accepted socket connection or FALSE on failure.
*/
-function stream_socket_accept ($socket, ?float $timeout, &$peer_name)
-{}
+function stream_socket_accept($socket, ?float $timeout, &$peer_name) {}
/**
* Retrieve the name of the local or remote sockets
@@ -403,8 +391,7 @@ function stream_socket_accept ($socket, ?float $timeout, &$peer_name)
*
* @return string|false The name of the socket or false on error.
*/
-function stream_socket_get_name ($socket, bool $remote): string|false
-{}
+function stream_socket_get_name($socket, bool $remote): string|false {}
/**
* Receives data from a socket, connected or not
@@ -443,8 +430,7 @@ function stream_socket_get_name ($socket, bool $remote): string|false
*
* @return string|false the read data, as a string, or false on error
*/
-function stream_socket_recvfrom ($socket, int $length, int $flags, &$address): string|false
-{}
+function stream_socket_recvfrom($socket, int $length, int $flags, &$address): string|false {}
/**
* Sends a message to a socket, whether it is connected or not
@@ -477,8 +463,7 @@ function stream_socket_recvfrom ($socket, int $length, int $flags, &$address): s
*
* @return int|false a result code, as an integer.
*/
-function stream_socket_sendto ($socket, string $data, int $flags, string $address): int|false
-{}
+function stream_socket_sendto($socket, string $data, int $flags, string $address): int|false {}
/**
* Turns encryption on/off on an already connected socket
@@ -500,8 +485,7 @@ function stream_socket_sendto ($socket, string $data, int $flags, string $addres
* 0 if there isn't enough data and you should try again
* (only for non-blocking sockets).
*/
-function stream_socket_enable_crypto ($stream, bool $enable, ?int $crypto_method, $session_stream): int|bool
-{}
+function stream_socket_enable_crypto($stream, bool $enable, ?int $crypto_method, $session_stream): int|bool {}
/**
* Shutdown a full-duplex connection
@@ -520,8 +504,7 @@ function stream_socket_enable_crypto ($stream, bool $enable, ?int $crypto_method
* @return bool true on success or false on failure.
* @since 5.2.1
*/
-function stream_socket_shutdown ($stream, int $mode): bool
-{}
+function stream_socket_shutdown($stream, int $mode): bool {}
/**
* Creates a pair of connected, indistinguishable socket streams
@@ -549,8 +532,7 @@ function stream_socket_shutdown ($stream, int $mode): bool
* @return array|false an array with the two socket resources on success, or
* false on failure.
*/
-function stream_socket_pair (int $domain, int $type, int $protocol): array|false
-{}
+function stream_socket_pair(int $domain, int $type, int $protocol): array|false {}
/**
* Copies data from one stream to another
@@ -569,8 +551,7 @@ function stream_socket_pair (int $domain, int $type, int $protocol): array|false
*
* @return int|false the total count of bytes copied, or false on failure.
*/
-function stream_copy_to_stream ($from, $to, ?int $length, int $offset): int|false
-{}
+function stream_copy_to_stream($from, $to, ?int $length, int $offset): int|false {}
/**
* Reads remainder of a stream into a string
@@ -587,8 +568,7 @@ function stream_copy_to_stream ($from, $to, ?int $length, int $offset): int|fals
*
* @return string|false a string or false on failure.
*/
-function stream_get_contents ($stream, ?int $length = -1, int $offset = -1): string|false
-{}
+function stream_get_contents($stream, ?int $length = -1, int $offset = -1): string|false {}
/**
* Tells whether the stream supports locking.
@@ -598,8 +578,7 @@ function stream_get_contents ($stream, ?int $length = -1, int $offset = -1): str
*
* @return bool true on success or false on failure.
*/
-function stream_supports_lock ($stream): bool
-{}
+function stream_supports_lock($stream): bool {}
/**
* Gets line from file pointer and parse for CSV fields
@@ -637,8 +616,7 @@ function stream_supports_lock ($stream): bool
* including end of file.
*
*/
-function fgetcsv ($stream, ?int $length = 0, string $separator = ',', string $enclosure = '"', string $escape = '\\'): array|false
-{}
+function fgetcsv($stream, ?int $length = 0, string $separator = ',', string $enclosure = '"', string $escape = '\\'): array|false {}
/**
* Format line as CSV and write to file pointer
@@ -660,8 +638,7 @@ function fgetcsv ($stream, ?int $length = 0, string $separator = ',', string $en
*
* @return int|false the length of the written string or false on failure.
*/
-function fputcsv ($stream, array $fields, string $separator = ",", string $enclosure = '"', string $escape = "\\"): int|false
-{}
+function fputcsv($stream, array $fields, string $separator = ",", string $enclosure = '"', string $escape = "\\"): int|false {}
/**
* Portable advisory file locking
@@ -678,8 +655,7 @@ function fputcsv ($stream, array $fields, string $separator = ",", string $enclo
*
* @return bool true on success or false on failure.
*/
-function flock ($stream, int $operation, &$would_block): bool
-{}
+function flock($stream, int $operation, &$would_block): bool {}
/**
* Extracts all meta tag content attributes from a file and returns an array
@@ -719,8 +695,7 @@ function flock ($stream, int $operation, &$would_block): bool
*
*/
#[Pure]
-function get_meta_tags (string $filename, bool $use_include_path = false): array|false
-{}
+function get_meta_tags(string $filename, bool $use_include_path = false): array|false {}
/**
* Sets write file buffering on the given stream
@@ -737,8 +712,7 @@ function get_meta_tags (string $filename, bool $use_include_path = false): array
* @return int 0 on success, or EOF if the request cannot be honored.
* @see stream_set_read_buffer()
*/
-function stream_set_write_buffer ($stream, int $size): int
-{}
+function stream_set_write_buffer($stream, int $size): int {}
/**
* Sets read file buffering on the given stream
@@ -755,8 +729,7 @@ function stream_set_write_buffer ($stream, int $size): int
* @return int 0 on success, or EOF if the request cannot be honored.
* @see stream_set_write_buffer()
*/
-function stream_set_read_buffer ($stream, int $size): int
-{}
+function stream_set_read_buffer($stream, int $size): int {}
/**
* Alias:
@@ -772,8 +745,7 @@ function stream_set_read_buffer ($stream, int $size): int
* This ensures that all writes with fwrite() are completed before other processes are allowed to write to that output stream.
* @return int
*/
-function set_file_buffer ($stream, int $size): int
-{}
+function set_file_buffer($stream, int $size): int {}
/**
* Alias:
@@ -791,8 +763,7 @@ function set_file_buffer ($stream, int $size): int
* @see stream_set_blocking()
*/
#[Deprecated(replacement: "stream_set_blocking(%parametersList%)", since: 5.3)]
-function set_socket_blocking ($socket, bool $mode): bool
-{}
+function set_socket_blocking($socket, bool $mode): bool {}
/**
* Set blocking/non-blocking mode on a stream
@@ -812,8 +783,7 @@ function set_socket_blocking ($socket, bool $mode): bool
*
* @return bool true on success or false on failure.
*/
-function stream_set_blocking ($stream, bool $enable): bool
-{}
+function stream_set_blocking($stream, bool $enable): bool {}
/**
* Alias:
@@ -834,8 +804,7 @@ function stream_set_blocking ($stream, bool $enable): bool
*
* @return bool true on success or false on failure.
*/
-function socket_set_blocking ($stream, bool $enable): bool
-{}
+function socket_set_blocking($stream, bool $enable): bool {}
/**
* Retrieves header/meta data from streams/file pointers
@@ -913,8 +882,7 @@ function socket_set_blocking ($stream, bool $enable): bool
"crypto" => "array",
"mediatype" => "string",
])]
-function stream_get_meta_data ($stream): array
-{}
+function stream_get_meta_data($stream): array {}
/**
* Gets line from stream resource up to a given delimiter
@@ -934,8 +902,7 @@ function stream_get_meta_data ($stream): array
* If an error occurs, returns false.
*
*/
-function stream_get_line ($stream, int $length, string $ending): string|false
-{}
+function stream_get_line($stream, int $length, string $ending): string|false {}
/**
* Register a URL wrapper implemented as a PHP class
@@ -957,8 +924,7 @@ function stream_get_line ($stream, int $length, string $ending): string|false
* protocol already has a handler.
*
*/
-function stream_wrapper_register (string $protocol, string $class, int $flags): bool
-{}
+function stream_wrapper_register(string $protocol, string $class, int $flags): bool {}
/**
* Alias:
@@ -982,8 +948,7 @@ function stream_wrapper_register (string $protocol, string $class, int $flags):
* protocol already has a handler.
*
*/
-function stream_register_wrapper (string $protocol, string $class, int $flags = 0): bool
-{}
+function stream_register_wrapper(string $protocol, string $class, int $flags = 0): bool {}
/**
* Resolve filename against the include path according to the same rules as fopen()/include().
@@ -992,8 +957,7 @@ function stream_register_wrapper (string $protocol, string $class, int $flags =
* @return string|false containing the resolved absolute filename, or FALSE on failure.
* @since 5.3.2
*/
-function stream_resolve_include_path (string $filename): string|false
-{}
+function stream_resolve_include_path(string $filename): string|false {}
/**
* Unregister a URL wrapper
@@ -1002,8 +966,7 @@ function stream_resolve_include_path (string $filename): string|false
*
* @return bool true on success or false on failure.
*/
-function stream_wrapper_unregister (string $protocol): bool
-{}
+function stream_wrapper_unregister(string $protocol): bool {}
/**
* Restores a previously unregistered built-in wrapper
@@ -1012,8 +975,7 @@ function stream_wrapper_unregister (string $protocol): bool
*
* @return bool true on success or false on failure.
*/
-function stream_wrapper_restore (string $protocol): bool
-{}
+function stream_wrapper_restore(string $protocol): bool {}
/**
* Retrieve list of registered streams
@@ -1022,8 +984,7 @@ function stream_wrapper_restore (string $protocol): bool
* available on the running system.
*/
#[Pure]
-function stream_get_wrappers (): array
-{}
+function stream_get_wrappers(): array {}
/**
* Retrieve list of registered socket transports
@@ -1031,8 +992,7 @@ function stream_get_wrappers (): array
* @return array an indexed array of socket transports names.
*/
#[Pure]
-function stream_get_transports (): array
-{}
+function stream_get_transports(): array {}
/**
* Checks if a stream is a local stream
@@ -1044,8 +1004,7 @@ function stream_get_transports (): array
* @since 5.2.4
*/
#[Pure]
-function stream_is_local ($stream): bool
-{}
+function stream_is_local($stream): bool {}
/**
* Fetches all the headers sent by the server in response to an HTTP request
@@ -1063,8 +1022,7 @@ function stream_is_local ($stream): bool
* failure.
*/
#[Pure]
-function get_headers (string $url, bool $associative = false, $context): array|false
-{}
+function get_headers(string $url, bool $associative = false, $context): array|false {}
/**
* Set timeout period on a stream
@@ -1080,8 +1038,7 @@ function get_headers (string $url, bool $associative = false, $context): array|f
*
* @return bool true on success or false on failure.
*/
-function stream_set_timeout ($stream, int $seconds, int $microseconds): bool
-{}
+function stream_set_timeout($stream, int $seconds, int $microseconds): bool {}
/**
* Alias:
@@ -1099,8 +1056,7 @@ function stream_set_timeout ($stream, int $seconds, int $microseconds): bool
*
* @return bool true on success or false on failure.
*/
-function socket_set_timeout ($stream, int $seconds, int $microseconds = 0): bool
-{}
+function socket_set_timeout($stream, int $seconds, int $microseconds = 0): bool {}
/**
* Alias:
@@ -1166,8 +1122,7 @@ function socket_set_timeout ($stream, int $seconds, int $microseconds = 0): bool
* stream.
*
*/
-function socket_get_status ($stream): array
-{}
+function socket_get_status($stream): array {}
/**
* Returns canonicalized absolute pathname
@@ -1183,8 +1138,7 @@ function socket_get_status ($stream): array
*
*/
#[Pure]
-function realpath (string $path): string|false
-{}
+function realpath(string $path): string|false {}
/**
* Match filename against a pattern
@@ -1242,6 +1196,4 @@ function realpath (string $path): string|false
*
* @return bool true if there is a match, false otherwise.
*/
-function fnmatch (string $pattern, string $filename, int $flags): bool
-{}
-?>
+function fnmatch(string $pattern, string $filename, int $flags): bool {}
diff --git a/standard/standard_7.php b/standard/standard_7.php
index 4c9b3252a..d464a2c2b 100644
--- a/standard/standard_7.php
+++ b/standard/standard_7.php
@@ -47,8 +47,7 @@
* fwrite, fclose, and
* feof). If the call fails, it will return false
*/
-function fsockopen (string $hostname, int $port = -1, &$error_code, &$error_message, ?float $timeout)
-{}
+function fsockopen(string $hostname, int $port = -1, &$error_code, &$error_message, ?float $timeout) {}
/**
* Open persistent Internet or Unix domain socket connection
@@ -61,8 +60,7 @@ function fsockopen (string $hostname, int $port = -1, &$error_code, &$error_mess
* @param float|null $timeout [optional]
* @return resource|false
*/
-function pfsockopen (string $hostname, int $port = -1, &$error_code, &$error_message, ?float $timeout)
-{}
+function pfsockopen(string $hostname, int $port = -1, &$error_code, &$error_message, ?float $timeout) {}
/**
* Pack data into binary string
@@ -170,8 +168,7 @@ function pfsockopen (string $hostname, int $port = -1, &$error_code, &$error_mes
*/
#[Pure]
#[LanguageLevelTypeAware(["8.0" => "string"], default: "string|false")]
-function pack (string $format, ...$values)
-{}
+function pack(string $format, ...$values) {}
/**
* Unpack data from binary string
@@ -187,8 +184,7 @@ function pack (string $format, ...$values)
* string or false if the format string contains errors
*/
#[Pure]
-function unpack (string $format, string $string, int $offset = 0): array|false
-{}
+function unpack(string $format, string $string, int $offset = 0): array|false {}
/**
* Tells what the user's browser is capable of
@@ -218,8 +214,7 @@ function unpack (string $format, string $string, int $offset = 0): array|false
* reload, and check for the value.
*/
#[Pure]
-function get_browser (?string $user_agent, bool $return_array = false): object|array|false
-{}
+function get_browser(?string $user_agent, bool $return_array = false): object|array|false {}
/**
* One-way string encryption (hashing)
@@ -241,8 +236,7 @@ function get_browser (?string $user_agent, bool $return_array = false): object|a
*/
#[Pure]
#[PhpStormStubsElementAvailable(to: '7.4')]
-function crypt ($string, $salt = null): ?string
-{}
+function crypt($string, $salt = null): ?string {}
/**
* One-way string encryption (hashing)
@@ -264,8 +258,7 @@ function crypt ($string, $salt = null): ?string
*/
#[Pure]
#[PhpStormStubsElementAvailable('8.0')]
-function crypt (string $string, string $salt): string
-{}
+function crypt(string $string, string $salt): string {}
/**
* Open directory handle
@@ -291,8 +284,7 @@ function crypt (string $string, string $salt): string
* '@' to the
* front of the function name.
*/
-function opendir (string $directory, $context)
-{}
+function opendir(string $directory, $context) {}
/**
* Close directory handle
@@ -305,7 +297,7 @@ function opendir (string $directory, $context)
*
* @return void
*/
-function closedir ($dir_handle): void {}
+function closedir($dir_handle): void {}
/**
* Change directory
@@ -315,8 +307,7 @@ function closedir ($dir_handle): void {}
*
* @return bool true on success or false on failure.
*/
-function chdir (string $directory): bool
-{}
+function chdir(string $directory): bool {}
/**
* Change the root directory
@@ -326,8 +317,7 @@ function chdir (string $directory): bool
*
* @return bool true on success or false on failure.
*/
-function chroot (string $directory): bool
-{}
+function chroot(string $directory): bool {}
/**
* Gets the current working directory
@@ -344,8 +334,7 @@ function chroot (string $directory): bool
*
*/
#[Pure]
-function getcwd (): string|false
-{}
+function getcwd(): string|false {}
/**
* Rewind directory handle
@@ -358,7 +347,7 @@ function getcwd (): string|false
*
* @return void
*/
-function rewinddir ($dir_handle): void {}
+function rewinddir($dir_handle): void {}
/**
* Read entry from directory handle
@@ -371,8 +360,7 @@ function rewinddir ($dir_handle): void {}
*
* @return string|false the filename on success or false on failure.
*/
-function readdir ($dir_handle): string|false
-{}
+function readdir($dir_handle): string|false {}
/**
* Return an instance of the Directory class
@@ -384,8 +372,7 @@ function readdir ($dir_handle): string|false
* @return Directory|false an instance of Directory, or NULL with wrong
* parameters, or FALSE in case of another error
*/
-function dir (string $directory, $context): Directory|false
-{}
+function dir(string $directory, $context): Directory|false {}
/**
* Alias of dir()
@@ -395,8 +382,7 @@ function dir (string $directory, $context): Directory|false
* @return Directory|false
* @see dir()
*/
-function getdir(string $directory, $context = null): Directory|false
-{}
+function getdir(string $directory, $context = null): Directory|false {}
/**
* List files and directories inside the specified path
@@ -419,8 +405,7 @@ function getdir(string $directory, $context = null): Directory|false
* boolean false is returned, and an error of level
* E_WARNING is generated.
*/
-function scandir (string $directory, int $sorting_order, $context): array|false
-{}
+function scandir(string $directory, int $sorting_order, $context): array|false {}
/**
* Find pathnames matching a pattern
@@ -445,8 +430,7 @@ function scandir (string $directory, int $sorting_order, $context): array|false
* error.
*/
#[Pure]
-function glob (string $pattern, int $flags): array|false
-{}
+function glob(string $pattern, int $flags): array|false {}
/**
* Gets last access time of file
@@ -458,8 +442,7 @@ function glob (string $pattern, int $flags): array|false
* The time is returned as a Unix timestamp.
*/
#[Pure]
-function fileatime (string $filename): int|false
-{}
+function fileatime(string $filename): int|false {}
/**
* Gets inode change time of file
@@ -471,8 +454,7 @@ function fileatime (string $filename): int|false
* The time is returned as a Unix timestamp.
*/
#[Pure]
-function filectime (string $filename): int|false
-{}
+function filectime(string $filename): int|false {}
/**
* Gets file group
@@ -486,8 +468,7 @@ function filectime (string $filename): int|false
* Upon failure, false is returned.
*/
#[Pure]
-function filegroup (string $filename): int|false
-{}
+function filegroup(string $filename): int|false {}
/**
* Gets file inode
@@ -498,8 +479,7 @@ function filegroup (string $filename): int|false
* @return int|false the inode number of the file, or false on failure.
*/
#[Pure]
-function fileinode (string $filename): int|false
-{}
+function fileinode(string $filename): int|false {}
/**
* Gets file modification time
@@ -512,8 +492,7 @@ function fileinode (string $filename): int|false
* suitable for the date function.
*/
#[Pure]
-function filemtime (string $filename): int|false
-{}
+function filemtime(string $filename): int|false {}
/**
* Gets file owner
@@ -526,8 +505,7 @@ function filemtime (string $filename): int|false
* posix_getpwuid to resolve it to a username.
*/
#[Pure]
-function fileowner (string $filename): int|false
-{}
+function fileowner(string $filename): int|false {}
/**
* Gets file permissions
@@ -538,8 +516,7 @@ function fileowner (string $filename): int|false
* @return int|false the permissions on the file, or false on failure.
*/
#[Pure]
-function fileperms (string $filename): int|false
-{}
+function fileperms(string $filename): int|false {}
/**
* Gets file size
@@ -551,8 +528,7 @@ function fileperms (string $filename): int|false
* of level E_WARNING) in case of an error.
*/
#[Pure]
-function filesize (string $filename): int|false
-{}
+function filesize(string $filename): int|false {}
/**
* Gets file type
@@ -569,8 +545,7 @@ function filesize (string $filename): int|false
* or if the file type is unknown.
*/
#[Pure]
-function filetype (string $filename): string|false
-{}
+function filetype(string $filename): string|false {}
/**
* Checks whether a file or directory exists
@@ -599,8 +574,7 @@ function filetype (string $filename): string|false
* The check is done using the real UID/GID instead of the effective one.
*/
#[Pure]
-function file_exists (string $filename): bool
-{}
+function file_exists(string $filename): bool {}
/**
* Tells whether the filename is writable
@@ -612,8 +586,7 @@ function file_exists (string $filename): bool
* writable.
*/
#[Pure]
-function is_writable (string $filename): bool
-{}
+function is_writable(string $filename): bool {}
/**
* Alias:
@@ -626,8 +599,7 @@ function is_writable (string $filename): bool
* writable.
*/
#[Pure]
-function is_writeable (string $filename): bool
-{}
+function is_writeable(string $filename): bool {}
/**
* Tells whether a file or a directory exists and is readable
@@ -639,8 +611,7 @@ function is_writeable (string $filename): bool
* filename exists and is readable, false otherwise.
*/
#[Pure]
-function is_readable (string $filename): bool
-{}
+function is_readable(string $filename): bool {}
/**
* Tells whether the filename is executable
@@ -652,8 +623,7 @@ function is_readable (string $filename): bool
* error.
*/
#[Pure]
-function is_executable (string $filename): bool
-{}
+function is_executable(string $filename): bool {}
/**
* Tells whether the filename is a regular file
@@ -665,8 +635,7 @@ function is_executable (string $filename): bool
* otherwise.
*/
#[Pure]
-function is_file (string $filename): bool
-{}
+function is_file(string $filename): bool {}
/**
* Tells whether the filename is a directory
@@ -681,8 +650,7 @@ function is_file (string $filename): bool
* otherwise.
*/
#[Pure]
-function is_dir (string $filename): bool
-{}
+function is_dir(string $filename): bool {}
/**
* Tells whether the filename is a symbolic link
@@ -694,8 +662,7 @@ function is_dir (string $filename): bool
* otherwise.
*/
#[Pure]
-function is_link (string $filename): bool
-{}
+function is_link(string $filename): bool {}
/**
* Gives information about a file
@@ -787,8 +754,7 @@ function is_link (string $filename): bool
* In case of error, stat returns false.
*/
#[Pure]
-function stat (string $filename): array|false
-{}
+function stat(string $filename): array|false {}
/**
* Gives information about a file or symbolic link
@@ -805,8 +771,7 @@ function stat (string $filename): array|false
* file pointed to by the symbolic link.
*/
#[Pure]
-function lstat (string $filename): array|false
-{}
+function lstat(string $filename): array|false {}
/**
* Changes file owner
@@ -819,8 +784,7 @@ function lstat (string $filename): array|false
*
* @return bool true on success or false on failure.
*/
-function chown (string $filename, string|int $user): bool
-{}
+function chown(string $filename, string|int $user): bool {}
/**
* Changes file group
@@ -833,8 +797,7 @@ function chown (string $filename, string|int $user): bool
*
* @return bool true on success or false on failure.
*/
-function chgrp (string $filename, string|int $group): bool
-{}
+function chgrp(string $filename, string|int $group): bool {}
/**
* Changes user ownership of symlink
@@ -848,8 +811,7 @@ function chgrp (string $filename, string|int $group): bool
* @return bool true on success or false on failure.
* @since 5.1.2
*/
-function lchown (string $filename, string|int $user): bool
-{}
+function lchown(string $filename, string|int $user): bool {}
/**
* Changes group ownership of symlink
@@ -863,8 +825,7 @@ function lchown (string $filename, string|int $user): bool
* @return bool true on success or false on failure.
* @since 5.1.2
*/
-function lchgrp (string $filename, string|int $group): bool
-{}
+function lchgrp(string $filename, string|int $group): bool {}
/**
* Changes file mode
@@ -899,8 +860,7 @@ function lchgrp (string $filename, string|int $group): bool
*
* @return bool true on success or false on failure.
*/
-function chmod (string $filename, int $permissions): bool
-{}
+function chmod(string $filename, int $permissions): bool {}
/**
* Sets access and modification time of file
@@ -919,8 +879,7 @@ function chmod (string $filename, int $permissions): bool
*
* @return bool true on success or false on failure.
*/
-function touch (string $filename, ?int $mtime, ?int $atime): bool
-{}
+function touch(string $filename, ?int $mtime, ?int $atime): bool {}
/**
* Clears file status cache
@@ -934,7 +893,7 @@ function touch (string $filename, ?int $mtime, ?int $atime): bool
*
* @return void
*/
-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
@@ -945,8 +904,7 @@ function clearstatcache (bool $clear_realpath_cache = false, string $filename):
* @return float|false the total number of bytes as a float
* or false on failure.
*/
-function disk_total_space (string $directory): float|false
-{}
+function disk_total_space(string $directory): float|false {}
/**
* Returns available space in directory
@@ -963,8 +921,7 @@ function disk_total_space (string $directory): float|false
* or false on failure.
*/
#[Pure]
-function disk_free_space (string $directory): float|false
-{}
+function disk_free_space(string $directory): float|false {}
/**
* Alias of {@see disk_free_space}
@@ -974,8 +931,7 @@ function disk_free_space (string $directory): float|false
* @return float|false
*/
#[Pure]
-function diskfreespace (string $directory): float|false
-{}
+function diskfreespace(string $directory): float|false {}
/**
* Send mail
@@ -1063,8 +1019,7 @@ function diskfreespace (string $directory): float|false
* it does NOT mean the mail will actually reach the intended destination.
*
*/
-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, string $additional_params): bool {}
/**
* Calculate the hash value needed by EZMLM
@@ -1076,8 +1031,7 @@ function mail (string $to, string $subject, string $message, array|string $addit
* @removed 8.0
*/
#[Deprecated(since: '7.4')]
-function ezmlm_hash (string $addr): int
-{}
+function ezmlm_hash(string $addr): int {}
/**
* Open connection to system logger
@@ -1199,7 +1153,4 @@ function ezmlm_hash (string $addr): int
*
* @return bool true on success or false on failure.
*/
-function openlog (string $prefix, int $flags, int $facility): bool
-{}
-
-?>
+function openlog(string $prefix, int $flags, int $facility): bool {}
diff --git a/standard/standard_8.php b/standard/standard_8.php
index 0ccfe9566..3bf54865f 100644
--- a/standard/standard_8.php
+++ b/standard/standard_8.php
@@ -4,7 +4,6 @@
use JetBrains\PhpStorm\Internal\LanguageLevelTypeAware;
use JetBrains\PhpStorm\Pure;
-
/**
* Generate a system log message
* @link https://php.net/manual/en/function.syslog.php
@@ -59,16 +58,14 @@
*
* @return bool true on success or false on failure.
*/
-function syslog (int $priority, string $message): bool
-{}
+function syslog(int $priority, string $message): bool {}
/**
* Close connection to system logger
* @link https://php.net/manual/en/function.closelog.php
* @return bool true on success or false on failure.
*/
-function closelog (): bool
-{}
+function closelog(): bool {}
/**
* Registers a function that will be called when PHP starts sending output.
@@ -78,8 +75,7 @@ function closelog (): bool
* @param callable $callback Function called just before the headers are sent.
* @return bool true on success or false on failure.
*/
-function header_register_callback ( callable $callback ): bool
-{}
+function header_register_callback(callable $callback): bool {}
/**
* Get the size of an image from a string.
@@ -101,8 +97,7 @@ function header_register_callback ( callable $callback ): bool
* @link https://secure.php.net/manual/en/function.getimagesizefromstring.php
* @since 5.4
*/
-function getimagesizefromstring (string $string , &$image_info): array|false
-{}
+function getimagesizefromstring(string $string, &$image_info): array|false {}
/**
* Set the stream chunk size.
@@ -114,8 +109,7 @@ function getimagesizefromstring (string $string , &$image_info): array|false
* @since 5.4
*/
#[LanguageLevelTypeAware(["8.0" => "int"], default: "int|false")]
-function stream_set_chunk_size ($stream , int $size)
-{}
+function stream_set_chunk_size($stream, int $size) {}
/**
* Initializes all syslog related variables
@@ -124,15 +118,14 @@ function stream_set_chunk_size ($stream , int $size)
* @removed 5.4
*/
#[Deprecated(since: '5.3')]
-function define_syslog_variables () {}
+function define_syslog_variables() {}
/**
* Combined linear congruential generator
* @link https://php.net/manual/en/function.lcg-value.php
* @return float A pseudo random float value in the range of (0, 1)
*/
-function lcg_value (): float
-{}
+function lcg_value(): float {}
/**
* Calculate the metaphone key of a string
@@ -148,8 +141,7 @@ function lcg_value (): float
*/
#[Pure]
#[LanguageLevelTypeAware(["8.0" => "string"], default: "string|false")]
-function metaphone (string $string, int $max_phonemes = 0): false|string
-{}
+function metaphone(string $string, int $max_phonemes = 0): false|string {}
/**
* Turn on output buffering
@@ -216,22 +208,21 @@ function metaphone (string $string, int $max_phonemes = 0): false|string
*
* @return bool true on success or false on failure.
*/
-function ob_start ($callback, int $chunk_size, int $flags = PHP_OUTPUT_HANDLER_STDFLAGS): bool
-{}
+function ob_start($callback, int $chunk_size, int $flags = PHP_OUTPUT_HANDLER_STDFLAGS): bool {}
/**
* Flush (send) the output buffer
* @link https://php.net/manual/en/function.ob-flush.php
* @return bool
*/
-function ob_flush (): bool {}
+function ob_flush(): bool {}
/**
* Clean (erase) the output buffer
* @link https://php.net/manual/en/function.ob-clean.php
* @return bool
*/
-function ob_clean (): bool {}
+function ob_clean(): bool {}
/**
* Flush (send) the output buffer and turn off output buffering
@@ -240,8 +231,7 @@ function ob_clean (): bool {}
* function without an active buffer or that for some reason a buffer could
* not be deleted (possible for special buffer).
*/
-function ob_end_flush (): bool
-{}
+function ob_end_flush(): bool {}
/**
* Clean (erase) the output buffer and turn off output buffering
@@ -250,16 +240,14 @@ function ob_end_flush (): bool
* function without an active buffer or that for some reason a buffer could
* not be deleted (possible for special buffer).
*/
-function ob_end_clean (): bool
-{}
+function ob_end_clean(): bool {}
/**
* Flush the output buffer, return it as a string and turn off output buffering
* @link https://php.net/manual/en/function.ob-get-flush.php
* @return string|false the output buffer or false if no buffering is active.
*/
-function ob_get_flush (): string|false
-{}
+function ob_get_flush(): string|false {}
/**
* Get current buffer contents and delete current output buffer
@@ -267,8 +255,7 @@ function ob_get_flush (): string|false
* @return string|false the contents of the output buffer and end output buffering.
* If output buffering isn't active then false is returned.
*/
-function ob_get_clean (): string|false
-{}
+function ob_get_clean(): string|false {}
/**
* Return the length of the output buffer
@@ -276,8 +263,7 @@ function ob_get_clean (): string|false
* @return int|false the length of the output buffer contents or false if no
* buffering is active.
*/
-function ob_get_length (): int|false
-{}
+function ob_get_length(): int|false {}
/**
* Return the nesting level of the output buffering mechanism
@@ -285,8 +271,7 @@ function ob_get_length (): int|false
* @return int the level of nested output buffering handlers or zero if output
* buffering is not active.
*/
-function ob_get_level (): int
-{}
+function ob_get_level(): int {}
/**
* Get status of output buffers
@@ -357,8 +342,7 @@ function ob_get_level (): int
* blocksize ...
@@ -116,8 +109,7 @@ function array_count_values(array $array): array
* @since 5.5
*/
#[Pure]
-function array_column(array $array, string|int|null $column_key, string|int|null $index_key = null): array
-{ }
+function array_column(array $array, string|int|null $column_key, string|int|null $index_key = null): array {}
/**
* Return an array with elements in reverse order
@@ -132,7 +124,7 @@ function array_column(array $array, string|int|null $column_key, string|int|null
* @meta
*/
#[Pure]
-function array_reverse(array $array, bool $preserve_keys = false): array { }
+function array_reverse(array $array, bool $preserve_keys = false): array {}
/**
* Iteratively reduce the array to a single value using a callback function
@@ -164,7 +156,7 @@ function array_reverse(array $array, bool $preserve_keys = false): array { }
*
* @meta
*/
-function array_reduce(array $array, callable $callback, mixed $initial): mixed { }
+function array_reduce(array $array, callable $callback, mixed $initial): mixed {}
/**
* Pad array to the specified length with a value
@@ -187,8 +179,7 @@ function array_reduce(array $array, callable $callback, mixed $initial): mixed {
* the length of the input then no padding takes place.
*/
#[Pure]
-function array_pad(array $array, int $length, mixed $value): array
-{ }
+function array_pad(array $array, int $length, mixed $value): array {}
/**
* Exchanges all keys with their associated values in an array
@@ -199,8 +190,7 @@ function array_pad(array $array, int $length, mixed $value): array
* @return int[]|string[] Returns the flipped array.
*/
#[Pure]
-function array_flip(array $array): array
-{ }
+function array_flip(array $array): array {}
/**
* Changes the case of all keys in an arra
@@ -216,7 +206,7 @@ function array_flip(array $array): array
* @meta
*/
#[Pure]
-function array_change_key_case(array $array, int $case): array { }
+function array_change_key_case(array $array, int $case): array {}
/**
* Pick one or more random keys out of an array
@@ -233,8 +223,7 @@ function array_change_key_case(array $array, int $case): array { }
* random keys as well as values out of the array.
*/
#[Pure]
-function array_rand(array $array, int $num = 1): array|string|int
-{ }
+function array_rand(array $array, int $num = 1): array|string|int {}
/**
* Removes duplicate values from an array
@@ -268,7 +257,7 @@ function array_rand(array $array, int $num = 1): array|string|int
* @meta
*/
#[Pure]
-function array_unique(array $array, int $flags = SORT_STRING): array { }
+function array_unique(array $array, int $flags = SORT_STRING): array {}
/**
* Computes the intersection of arrays
@@ -285,7 +274,7 @@ function array_unique(array $array, int $flags = SORT_STRING): array { }
*/
#[Pure]
#[PhpStormStubsElementAvailable('8.0')]
-function array_intersect(array $array, array ...$arrays): array { }
+function array_intersect(array $array, array ...$arrays): array {}
/**
* Computes the intersection of arrays
@@ -303,7 +292,7 @@ function array_intersect(array $array, array ...$arrays): array { }
*/
#[Pure]
#[PhpStormStubsElementAvailable(to: '7.4')]
-function array_intersect(array $array1, array $array2, array ...$_): array { }
+function array_intersect(array $array1, array $array2, array ...$_): array {}
/**
* Computes the intersection of arrays using keys for comparison
@@ -321,7 +310,7 @@ function array_intersect(array $array1, array $array2, array ...$_): array { }
* @meta
*/
#[Pure]
-function array_intersect_key(array $array1, array $array2, array ...$_): array { }
+function array_intersect_key(array $array1, array $array2, array ...$_): array {}
/**
* Computes the intersection of arrays using a callback function on the keys for comparison
@@ -340,7 +329,7 @@ function array_intersect_key(array $array1, array $array2, array ...$_): array {
* in all the arguments.
* @meta
*/
-function array_intersect_ukey(array $array1, array $array2, array $_ = null, callable $key_compare_func): array { }
+function array_intersect_ukey(array $array1, array $array2, array $_ = null, callable $key_compare_func): array {}
/**
* Computes the intersection of arrays, compares data by a callback function
@@ -365,7 +354,7 @@ function array_intersect_ukey(array $array1, array $array2, array $_ = null, cal
* that are present in all the arguments.
* @meta
*/
-function array_uintersect(array $array1, array $array2, array $_ = null, callable $data_compare_func): array { }
+function array_uintersect(array $array1, array $array2, array $_ = null, callable $data_compare_func): array {}
/**
* Computes the intersection of arrays with additional index check
@@ -382,7 +371,7 @@ function array_uintersect(array $array1, array $array2, array $_ = null, callabl
* @meta
*/
#[Pure]
-function array_intersect_assoc(array $array1, array $array2, array $_ = null): array { }
+function array_intersect_assoc(array $array1, array $array2, array $_ = null): array {}
/**
* Computes the intersection of arrays with additional index check, compares data by a callback function
@@ -405,7 +394,7 @@ function array_intersect_assoc(array $array1, array $array2, array $_ = null): a
* array1 that are present in all the arguments.
* @meta
*/
-function array_uintersect_assoc(array $array1, array $array2, array $_ = null, callable $data_compare_func): array { }
+function array_uintersect_assoc(array $array1, array $array2, array $_ = null, callable $data_compare_func): array {}
/**
* Computes the intersection of arrays with additional index check, compares indexes by a callback function
@@ -424,7 +413,7 @@ function array_uintersect_assoc(array $array1, array $array2, array $_ = null, c
* in all of the arguments.
* @meta
*/
-function array_intersect_uassoc(array $array1, array $array2, array $_ = null, callable $key_compare_func): array { }
+function array_intersect_uassoc(array $array1, array $array2, array $_ = null, callable $key_compare_func): array {}
/**
* Computes the intersection of arrays with additional index check, compares data and indexes by separate callback functions
@@ -451,7 +440,7 @@ function array_intersect_uassoc(array $array1, array $array2, array $_ = null, c
* @meta
*/
#[Pure]
-function array_uintersect_uassoc(array $array1, array $array2, array $_ = null, callable $data_compare_func, callable $key_compare_func): array { }
+function array_uintersect_uassoc(array $array1, array $array2, array $_ = null, callable $data_compare_func, callable $key_compare_func): array {}
/**
* Computes the difference of arrays
@@ -468,7 +457,7 @@ function array_uintersect_uassoc(array $array1, array $array2, array $_ = null,
*/
#[Pure]
#[PhpStormStubsElementAvailable('8.0')]
-function array_diff(array $array, array ...$excludes): array { }
+function array_diff(array $array, array ...$excludes): array {}
/**
* Computes the difference of arrays
@@ -486,7 +475,7 @@ function array_diff(array $array, array ...$excludes): array { }
*/
#[Pure]
#[PhpStormStubsElementAvailable(to: '7.4')]
-function array_diff(array $array1, array $array2, array ...$_): array { }
+function array_diff(array $array1, array $array2, array ...$_): array {}
/**
* Computes the difference of arrays using keys for comparison
@@ -504,7 +493,7 @@ function array_diff(array $array1, array $array2, array ...$_): array { }
* @meta
*/
#[Pure]
-function array_diff_key(array $array1, array $array2, array ...$_): array { }
+function array_diff_key(array $array1, array $array2, array ...$_): array {}
/**
* Computes the difference of arrays using a callback function on the keys for comparison
@@ -526,7 +515,7 @@ function array_diff_key(array $array1, array $array2, array ...$_): array { }
* array1 that are not present in any of the other arrays.
* @meta
*/
-function array_diff_ukey(array $array1, array $array2, array $_ = null, callable $key_compare_func): array { }
+function array_diff_ukey(array $array1, array $array2, array $_ = null, callable $key_compare_func): array {}
/**
* Computes the difference of arrays by using a callback function for data comparison
@@ -551,7 +540,7 @@ function array_diff_ukey(array $array1, array $array2, array $_ = null, callable
* that are not present in any of the other arguments.
* @meta
*/
-function array_udiff(array $array1, array $array2, array $_ = null, callable $data_compare_func): array { }
+function array_udiff(array $array1, array $array2, array $_ = null, callable $data_compare_func): array {}
/**
* Computes the difference of arrays with additional index check
@@ -568,7 +557,7 @@ function array_udiff(array $array1, array $array2, array $_ = null, callable $da
* @meta
*/
#[Pure]
-function array_diff_assoc(array $array1, array $array2, array ...$_): array { }
+function array_diff_assoc(array $array1, array $array2, array ...$_): array {}
/**
* Computes the difference of arrays with additional index check, compares data by a callback function
@@ -600,7 +589,7 @@ function array_diff_assoc(array $array1, array $array2, array ...$_): array { }
* comparison.
* @meta
*/
-function array_udiff_assoc(array $array1, array $array2, array $_ = null, callable $data_compare_func): array { }
+function array_udiff_assoc(array $array1, array $array2, array $_ = null, callable $data_compare_func): array {}
/**
* Computes the difference of arrays with additional index check which is performed by a user supplied callback function
@@ -622,7 +611,7 @@ function array_udiff_assoc(array $array1, array $array2, array $_ = null, callab
* array1 that are not present in any of the other arrays.
* @meta
*/
-function array_diff_uassoc(array $array1, array $array2, array $_ = null, callable $key_compare_func): array { }
+function array_diff_uassoc(array $array1, array $array2, array $_ = null, callable $key_compare_func): array {}
/**
* Computes the difference of arrays with additional index check, compares data and indexes by a callback function
@@ -661,7 +650,7 @@ function array_diff_uassoc(array $array1, array $array2, array $_ = null, callab
* arguments.
* @meta
*/
-function array_udiff_uassoc(array $array1, array $array2, array $_ = null, callable $data_compare_func, callable $key_compare_func): array { }
+function array_udiff_uassoc(array $array1, array $array2, array $_ = null, callable $data_compare_func, callable $key_compare_func): array {}
/**
* Calculate the sum of values in an array
@@ -672,8 +661,7 @@ function array_udiff_uassoc(array $array1, array $array2, array $_ = null, calla
* @return int|float the sum of values as an integer or float.
*/
#[Pure]
-function array_sum(array $array): int|float
-{ }
+function array_sum(array $array): int|float {}
/**
* Calculate the product of values in an array
@@ -684,8 +672,7 @@ function array_sum(array $array): int|float
* @return int|float the product as an integer or float.
*/
#[Pure]
-function array_product(array $array): int|float
-{ }
+function array_product(array $array): int|float {}
/**
* Iterates over each value in the array
@@ -721,7 +708,7 @@ function array_product(array $array): int|float
* @return array the filtered array.
* @meta
*/
-function array_filter(array $array, ?callable $callback, int $mode = 0): array { }
+function array_filter(array $array, ?callable $callback, int $mode = 0): array {}
/**
* Applies the callback to the elements of the given arrays
@@ -737,7 +724,7 @@ function array_filter(array $array, ?callable $callback, int $mode = 0): array {
* after applying the callback function to each one.
* @meta
*/
-function array_map(callable $callback, array $array, array ...$arrays): array { }
+function array_map(callable $callback, array $array, array ...$arrays): array {}
/**
* Split an array into chunks
@@ -756,8 +743,7 @@ function array_map(callable $callback, array $array, array ...$arrays): array {
* with each dimension containing size elements.
*/
#[Pure]
-function array_chunk(array $array, int $length, bool $preserve_keys = false): array
-{ }
+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
@@ -775,7 +761,7 @@ function array_chunk(array $array, int $length, bool $preserve_keys = false): ar
*/
#[Pure]
#[LanguageLevelTypeAware(["8.0" => "array"], default: "array|false")]
-function array_combine(array $keys, array $values) { }
+function array_combine(array $keys, array $values) {}
/**
* Checks if the given key or index exists in the array
@@ -789,8 +775,7 @@ function array_combine(array $keys, array $values) { }
* @return bool true on success or false on failure.
*/
#[Pure]
-function array_key_exists($key, #[LanguageLevelTypeAware(["8.0" => "array"], default: "array|ArrayObject")] $array): bool
-{ }
+function array_key_exists($key, #[LanguageLevelTypeAware(["8.0" => "array"], default: "array|ArrayObject")] $array): bool {}
/**
* Gets the first key of an array
@@ -803,8 +788,7 @@ function array_key_exists($key, #[LanguageLevelTypeAware(["8.0" => "array"], def
* @since 7.3
*/
#[Pure]
-function array_key_first(array $array): string|int|null
-{ }
+function array_key_first(array $array): string|int|null {}
/**
* Gets the last key of an array
@@ -817,8 +801,7 @@ function array_key_first(array $array): string|int|null
* @since 7.3
*/
#[Pure]
-function array_key_last(array $array): string|int|null
-{ }
+function array_key_last(array $array): string|int|null {}
/**
* Alias:
@@ -828,8 +811,7 @@ function array_key_last(array $array): string|int|null
* @return mixed
*/
#[Pure]
-function pos(object|array $array): mixed
-{ }
+function pos(object|array $array): mixed {}
/**
* Alias:
@@ -840,8 +822,7 @@ function pos(object|array $array): mixed
* @return int
*/
#[Pure]
-function sizeof(Countable|array $value, int $mode = COUNT_NORMAL): int
-{ }
+function sizeof(Countable|array $value, int $mode = COUNT_NORMAL): int {}
/**
* Checks if the given key or index exists in the array. The name of this function is array_key_exists() in PHP > 4.0.6.
@@ -855,8 +836,7 @@ function sizeof(Countable|array $value, int $mode = COUNT_NORMAL): int
* @return bool true on success or false on failure.
*/
#[Pure]
-function key_exists($key, array $array): bool
-{ }
+function key_exists($key, array $array): bool {}
/**
* Checks if assertion is FALSE
@@ -872,17 +852,14 @@ function key_exists($key, array $array): bool
* An optional description that will be included in the failure message if the assertion fails.
* @return bool false if the assertion is false, true otherwise.
*/
-function assert(mixed $assertion, $description = ''): bool
-{ }
+function assert(mixed $assertion, $description = ''): bool {}
/**
* AssertionError is thrown when an assertion made via {@see assert()} fails.
* @link https://php.net/manual/en/class.assertionerror.php
* @since 7.0
*/
-class AssertionError extends Error {
-
-}
+class AssertionError extends Error {}
/**
* Set/get the various assert flags
@@ -936,8 +913,7 @@ class AssertionError extends Error {
*
* @return object|array|string|int|null The original setting of any option.
*/
-function assert_options(int $option, mixed $value): object|array|string|int|null
-{ }
+function assert_options(int $option, mixed $value): object|array|string|int|null {}
/**
* Compares two "PHP-standardized" version number strings
@@ -973,8 +949,7 @@ function assert_options(int $option, mixed $value): object|array|string|int|null
* 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): int|bool
-{ }
+function version_compare(string $version1, string $version2, ?string $operator): int|bool {}
/**
* Convert a pathname and a project identifier to a System V IPC key
@@ -989,8 +964,7 @@ function version_compare(string $version1, string $version2, ?string $operator):
* -1 is returned.
*/
#[Pure]
-function ftok(string $filename, string $project_id): int
-{ }
+function ftok(string $filename, string $project_id): int {}
/**
* Perform the rot13 transform on a string
@@ -1001,8 +975,7 @@ function ftok(string $filename, string $project_id): int
* @return string the ROT13 version of the given string.
*/
#[Pure]
-function str_rot13(string $string): string
-{ }
+function str_rot13(string $string): string {}
/**
* Retrieve list of registered filters
@@ -1011,8 +984,7 @@ function str_rot13(string $string): string
* available.
*/
#[Pure]
-function stream_get_filters(): array
-{ }
+function stream_get_filters(): array {}
/**
* Check if a stream is a TTY
@@ -1022,8 +994,7 @@ function stream_get_filters(): array
* @since 7.2
*/
#[Pure]
-function stream_isatty($stream): bool
-{}
+function stream_isatty($stream): bool {}
/**
* Register a user defined stream filter
@@ -1139,8 +1110,7 @@ function stream_isatty($stream): bool
* filtername is already defined.
*
*/
-function stream_filter_register(string $filter_name, string $class): bool
-{ }
+function stream_filter_register(string $filter_name, string $class): bool {}
/**
* Return a bucket object from the brigade for operating on
@@ -1148,8 +1118,7 @@ function stream_filter_register(string $filter_name, string $class): bool
* @param resource $brigade
* @return object|null
*/
-function stream_bucket_make_writeable($brigade): ?object
-{ }
+function stream_bucket_make_writeable($brigade): ?object {}
/**
* Prepend bucket to brigade
@@ -1158,7 +1127,7 @@ function stream_bucket_make_writeable($brigade): ?object
* @param object $bucket
* @return void
*/
-function stream_bucket_prepend($brigade, object $bucket): void { }
+function stream_bucket_prepend($brigade, object $bucket): void {}
/**
* Append bucket to brigade
@@ -1167,7 +1136,7 @@ function stream_bucket_prepend($brigade, object $bucket): void { }
* @param object $bucket
* @return void
*/
-function stream_bucket_append($brigade, object $bucket): void { }
+function stream_bucket_append($brigade, object $bucket): void {}
/**
* Create a new bucket for use on the current stream
@@ -1176,8 +1145,7 @@ function stream_bucket_append($brigade, object $bucket): void { }
* @param string $buffer
* @return object
*/
-function stream_bucket_new($stream, string $buffer): object
-{ }
+function stream_bucket_new($stream, string $buffer): object {}
/**
* Add URL rewriter values
@@ -1190,8 +1158,7 @@ function stream_bucket_new($stream, string $buffer): object
*
* @return bool true on success or false on failure.
*/
-function output_add_rewrite_var(string $name, string $value): bool
-{ }
+function output_add_rewrite_var(string $name, string $value): bool {}
/**
* Reset URL rewriter values
@@ -1222,8 +1189,7 @@ function output_add_rewrite_var(string $name, string $value): bool
* @link https://php.net/manual/en/function.output-reset-rewrite-vars.php
* @return bool true on success or false on failure.
*/
-function output_reset_rewrite_vars(): bool
-{ }
+function output_reset_rewrite_vars(): bool {}
/**
* Returns directory path used for temporary files
@@ -1231,8 +1197,7 @@ function output_reset_rewrite_vars(): bool
* @return string the path of the temporary directory.
* @since 5.2.1
*/
-function sys_get_temp_dir(): string
-{ }
+function sys_get_temp_dir(): string {}
/**
* Get the contents of the realpath cache.
@@ -1244,8 +1209,7 @@ function sys_get_temp_dir(): string
* @since 5.3.2
*/
#[Pure]
-function realpath_cache_get(): array
-{ }
+function realpath_cache_get(): array {}
/**
* Get the amount of memory used by the realpath cache.
@@ -1254,8 +1218,7 @@ function realpath_cache_get(): array
* @since 5.3.2
*/
#[Pure]
-function realpath_cache_size(): int
-{ }
+function realpath_cache_size(): int {}
/**
* It returns the same result as (array) $object, with the
@@ -1265,8 +1228,7 @@ function realpath_cache_size(): int
* @return array returns the mangled object properties
* @since 7.4
*/
-function get_mangled_object_vars(object $object): array
-{}
+function get_mangled_object_vars(object $object): array {}
/**
* Get the type or object name of a variable
diff --git a/standard/standard_defines.php b/standard/standard_defines.php
index 3e154bc9c..87e93cbc8 100644
--- a/standard/standard_defines.php
+++ b/standard/standard_defines.php
@@ -2,187 +2,187 @@
// Start of standard v.5.3.1-0.dotdeb.1
-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('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);
/**
* Normal INI scanner mode
* @link https://php.net/manual/en/filesystem.constants.php
*/
-define ('INI_SCANNER_NORMAL', 0);
+define('INI_SCANNER_NORMAL', 0);
/**
* Typed INI scanner mode
* @since 5.6.1
* @link https://php.net/manual/en/function.parse-ini-file.php
*/
-define ('INI_SCANNER_TYPED', 2);
+define('INI_SCANNER_TYPED', 2);
/**
* Raw INI scanner mode
* @link https://php.net/manual/en/filesystem.constants.php
*/
-define ('INI_SCANNER_RAW', 1);
+define('INI_SCANNER_RAW', 1);
-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_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);
/**
* e constant
*/
-define ('M_E', 2.718281828459);
+define('M_E', 2.718281828459);
/**
* {@link log}2e constant
*/
-define ('M_LOG2E', 1.442695040889);
+define('M_LOG2E', 1.442695040889);
/**
* {@link log}10e constant
*/
-define ('M_LOG10E', 0.43429448190325);
+define('M_LOG10E', 0.43429448190325);
/**
* {@link log}e2 constant
*/
-define ('M_LN2', 0.69314718055995);
+define('M_LN2', 0.69314718055995);
/**
* {@link log}e10 constant
*/
-define ('M_LN10', 2.302585092994);
+define('M_LN10', 2.302585092994);
/**
* π constant
*/
-define ('M_PI', 3.1415926535898);
+define('M_PI', 3.1415926535898);
/**
* π/2 constant
*/
-define ('M_PI_2', 1.5707963267949);
+define('M_PI_2', 1.5707963267949);
/**
* π/4 constant
*/
-define ('M_PI_4', 0.78539816339745);
+define('M_PI_4', 0.78539816339745);
/**
* 1/π constant
*/
-define ('M_1_PI', 0.31830988618379);
+define('M_1_PI', 0.31830988618379);
/**
* 2/π constant
*/
-define ('M_2_PI', 0.63661977236758);
+define('M_2_PI', 0.63661977236758);
/**
* {@link sqrt}(π) constant
*/
-define ('M_SQRTPI', 1.7724538509055);
+define('M_SQRTPI', 1.7724538509055);
/**
* 2/{@link sqrt}(π) constant
*/
-define ('M_2_SQRTPI', 1.1283791670955);
+define('M_2_SQRTPI', 1.1283791670955);
/**
* {@link log}eπ constant
*/
-define ('M_LNPI', 1.1447298858494);
+define('M_LNPI', 1.1447298858494);
/**
* Euler constant
*/
-define ('M_EULER', 0.57721566490153);
+define('M_EULER', 0.57721566490153);
/**
* {@link sqrt}(2) constant
*/
-define ('M_SQRT2', 1.4142135623731);
+define('M_SQRT2', 1.4142135623731);
/**
* 1/{@link sqrt}(2) constant
*/
-define ('M_SQRT1_2', 0.70710678118655);
+define('M_SQRT1_2', 0.70710678118655);
/**
* {@link sqrt}(3) constant
*/
-define ('M_SQRT3', 1.7320508075689);
+define('M_SQRT3', 1.7320508075689);
/**
* The infinite
*/
-define ('INF', INF);
+define('INF', INF);
/**
* Not A Number
*/
-define ('NAN', NAN);
+define('NAN', NAN);
/**
* Round halves up
* @link https://php.net/manual/en/math.constants.php
*/
-define ('PHP_ROUND_HALF_UP', 1);
+define('PHP_ROUND_HALF_UP', 1);
/**
* Round halves down
* @link https://php.net/manual/en/math.constants.php
*/
-define ('PHP_ROUND_HALF_DOWN', 2);
+define('PHP_ROUND_HALF_DOWN', 2);
/**
* Round halves to even numbers
* @link https://php.net/manual/en/math.constants.php
*/
-define ('PHP_ROUND_HALF_EVEN', 3);
+define('PHP_ROUND_HALF_EVEN', 3);
/**
* Round halves to odd numbers
* @link https://php.net/manual/en/math.constants.php
*/
-define ('PHP_ROUND_HALF_ODD', 4);
-define ('INFO_GENERAL', 1);
+define('PHP_ROUND_HALF_ODD', 4);
+define('INFO_GENERAL', 1);
/**
* PHP Credits. See also phpcredits.
* @link https://php.net/manual/en/info.constants.php
*/
-define ('INFO_CREDITS', 2);
+define('INFO_CREDITS', 2);
/**
* Current Local and Main values for PHP directives. See
* also ini_get.
* @link https://php.net/manual/en/info.constants.php
*/
-define ('INFO_CONFIGURATION', 4);
+define('INFO_CONFIGURATION', 4);
/**
* Loaded modules and their respective settings.
* @link https://php.net/manual/en/info.constants.php
*/
-define ('INFO_MODULES', 8);
+define('INFO_MODULES', 8);
/**
* Environment Variable information that's also available in
* $_ENV.
* @link https://php.net/manual/en/info.constants.php
*/
-define ('INFO_ENVIRONMENT', 16);
+define('INFO_ENVIRONMENT', 16);
/**
* Shows all
@@ -190,45 +190,45 @@
* POST, Cookie, Server).
* @link https://php.net/manual/en/info.constants.php
*/
-define ('INFO_VARIABLES', 32);
+define('INFO_VARIABLES', 32);
/**
* PHP License information. See also the license faq.
* @link https://php.net/manual/en/info.constants.php
*/
-define ('INFO_LICENSE', 64);
-define ('INFO_ALL', 4294967295);
+define('INFO_LICENSE', 64);
+define('INFO_ALL', 4294967295);
/**
* A list of the core developers
* @link https://php.net/manual/en/info.constants.php
*/
-define ('CREDITS_GROUP', 1);
+define('CREDITS_GROUP', 1);
/**
* General credits: Language design and concept, PHP
* authors and SAPI module.
* @link https://php.net/manual/en/info.constants.php
*/
-define ('CREDITS_GENERAL', 2);
+define('CREDITS_GENERAL', 2);
/**
* A list of the server API modules for PHP, and their authors.
* @link https://php.net/manual/en/info.constants.php
*/
-define ('CREDITS_SAPI', 4);
+define('CREDITS_SAPI', 4);
/**
* A list of the extension modules for PHP, and their authors.
* @link https://php.net/manual/en/info.constants.php
*/
-define ('CREDITS_MODULES', 8);
+define('CREDITS_MODULES', 8);
/**
* The credits for the documentation team.
* @link https://php.net/manual/en/info.constants.php
*/
-define ('CREDITS_DOCS', 16);
+define('CREDITS_DOCS', 16);
/**
* Usually used in combination with the other flags. Indicates
@@ -237,100 +237,100 @@
* flags.
* @link https://php.net/manual/en/info.constants.php
*/
-define ('CREDITS_FULLPAGE', 32);
+define('CREDITS_FULLPAGE', 32);
/**
* The credits for the quality assurance team.
* @link https://php.net/manual/en/info.constants.php
*/
-define ('CREDITS_QA', 64);
+define('CREDITS_QA', 64);
/**
* The configuration line, "php.ini" location, build date, Web
* Server, System and more.
* @link https://php.net/manual/en/info.constants.php
*/
-define ('CREDITS_ALL', 4294967295);
-define ('HTML_SPECIALCHARS', 0);
-define ('HTML_ENTITIES', 1);
+define('CREDITS_ALL', 4294967295);
+define('HTML_SPECIALCHARS', 0);
+define('HTML_ENTITIES', 1);
/**
* Will convert double-quotes and leave single-quotes alone.
* @link https://php.net/manual/en/function.htmlspecialchars.php
*/
-define ('ENT_COMPAT', 2);
+define('ENT_COMPAT', 2);
/**
* Will convert both double and single quotes.
* @link https://php.net/manual/en/function.htmlspecialchars.php
*/
-define ('ENT_QUOTES', 3);
+define('ENT_QUOTES', 3);
/**
* Will leave both double and single quotes unconverted.
* @link https://php.net/manual/en/function.htmlspecialchars.php
*/
-define ('ENT_NOQUOTES', 0);
+define('ENT_NOQUOTES', 0);
/**
* Silently discard invalid code unit sequences instead of returning an empty string.
* Using this flag is discouraged as it may have security implications.
* @link https://php.net/manual/en/function.htmlspecialchars.php
*/
-define ('ENT_IGNORE', 4);
-define ('STR_PAD_LEFT', 0);
-define ('STR_PAD_RIGHT', 1);
-define ('STR_PAD_BOTH', 2);
-define ('PATHINFO_DIRNAME', 1);
-define ('PATHINFO_BASENAME', 2);
-define ('PATHINFO_EXTENSION', 4);
+define('ENT_IGNORE', 4);
+define('STR_PAD_LEFT', 0);
+define('STR_PAD_RIGHT', 1);
+define('STR_PAD_BOTH', 2);
+define('PATHINFO_DIRNAME', 1);
+define('PATHINFO_BASENAME', 2);
+define('PATHINFO_EXTENSION', 4);
/**
* @link https://php.net/manual/en/filesystem.constants.php
*/
-define ('PATHINFO_FILENAME', 8);
-define ('PATHINFO_ALL', 15);
-define ('CHAR_MAX', 127);
-define ('LC_CTYPE', 0);
-define ('LC_NUMERIC', 1);
-define ('LC_TIME', 2);
-define ('LC_COLLATE', 3);
-define ('LC_MONETARY', 4);
-define ('LC_ALL', 6);
-define ('LC_MESSAGES', 5);
-define ('SEEK_SET', 0);
-define ('SEEK_CUR', 1);
-define ('SEEK_END', 2);
+define('PATHINFO_FILENAME', 8);
+define('PATHINFO_ALL', 15);
+define('CHAR_MAX', 127);
+define('LC_CTYPE', 0);
+define('LC_NUMERIC', 1);
+define('LC_TIME', 2);
+define('LC_COLLATE', 3);
+define('LC_MONETARY', 4);
+define('LC_ALL', 6);
+define('LC_MESSAGES', 5);
+define('SEEK_SET', 0);
+define('SEEK_CUR', 1);
+define('SEEK_END', 2);
/**
* Acquire a shared lock (reader).
* @link https://www.php.net/manual/en/function.flock.php
*/
-define ('LOCK_SH', 1);
+define('LOCK_SH', 1);
/**
* Acquire an exclusive lock (writer).
* @link https://www.php.net/manual/en/function.flock.php
*/
-define ('LOCK_EX', 2);
+define('LOCK_EX', 2);
/**
* Release lock (shared or exclusive).
* @link https://www.php.net/manual/en/function.flock.php
*/
-define ('LOCK_UN', 3);
+define('LOCK_UN', 3);
/**
* Non-blocking operation while locking.
* @link https://www.php.net/manual/en/function.flock.php
*/
-define ('LOCK_NB', 4);
+define('LOCK_NB', 4);
/**
* A connection with an external resource has been established.
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('STREAM_NOTIFY_CONNECT', 2);
+define('STREAM_NOTIFY_CONNECT', 2);
/**
* Additional authorization is required to access the specified resource.
@@ -338,13 +338,13 @@
* STREAM_NOTIFY_SEVERITY_ERR.
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('STREAM_NOTIFY_AUTH_REQUIRED', 3);
+define('STREAM_NOTIFY_AUTH_REQUIRED', 3);
/**
* Authorization has been completed (with or without success).
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('STREAM_NOTIFY_AUTH_RESULT', 10);
+define('STREAM_NOTIFY_AUTH_RESULT', 10);
/**
* The mime-type of resource has been identified,
@@ -352,20 +352,20 @@
* discovered type.
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('STREAM_NOTIFY_MIME_TYPE_IS', 4);
+define('STREAM_NOTIFY_MIME_TYPE_IS', 4);
/**
* The size of the resource has been discovered.
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('STREAM_NOTIFY_FILE_SIZE_IS', 5);
+define('STREAM_NOTIFY_FILE_SIZE_IS', 5);
/**
* The external resource has redirected the stream to an alternate
* location. Refer to message.
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('STREAM_NOTIFY_REDIRECTED', 6);
+define('STREAM_NOTIFY_REDIRECTED', 6);
/**
* Indicates current progress of the stream transfer in
@@ -373,7 +373,7 @@
* bytes_max as well.
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('STREAM_NOTIFY_PROGRESS', 7);
+define('STREAM_NOTIFY_PROGRESS', 7);
/**
* A generic error occurred on the stream, consult
@@ -381,38 +381,38 @@
* for details.
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('STREAM_NOTIFY_FAILURE', 9);
+define('STREAM_NOTIFY_FAILURE', 9);
/**
* There is no more data available on the stream.
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('STREAM_NOTIFY_COMPLETED', 8);
+define('STREAM_NOTIFY_COMPLETED', 8);
/**
* A remote address required for this stream has been resolved, or the resolution
* failed. See severity for an indication of which happened.
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('STREAM_NOTIFY_RESOLVE', 1);
+define('STREAM_NOTIFY_RESOLVE', 1);
/**
* Normal, non-error related, notification.
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('STREAM_NOTIFY_SEVERITY_INFO', 0);
+define('STREAM_NOTIFY_SEVERITY_INFO', 0);
/**
* Non critical error condition. Processing may continue.
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('STREAM_NOTIFY_SEVERITY_WARN', 1);
+define('STREAM_NOTIFY_SEVERITY_WARN', 1);
/**
* A critical error occurred. Processing cannot continue.
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('STREAM_NOTIFY_SEVERITY_ERR', 2);
+define('STREAM_NOTIFY_SEVERITY_ERR', 2);
/**
* Used with stream_filter_append and
@@ -421,7 +421,7 @@
* reading
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('STREAM_FILTER_READ', 1);
+define('STREAM_FILTER_READ', 1);
/**
* Used with stream_filter_append and
@@ -430,21 +430,21 @@
* writing
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('STREAM_FILTER_WRITE', 2);
+define('STREAM_FILTER_WRITE', 2);
/**
* This constant is equivalent to
* STREAM_FILTER_READ | STREAM_FILTER_WRITE
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('STREAM_FILTER_ALL', 3);
+define('STREAM_FILTER_ALL', 3);
/**
* Client socket opened with stream_socket_client
* should remain persistent between page loads.
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('STREAM_CLIENT_PERSISTENT', 1);
+define('STREAM_CLIENT_PERSISTENT', 1);
/**
* Open client socket asynchronously. This option must be used
@@ -452,14 +452,14 @@
* Used with stream_socket_client.
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('STREAM_CLIENT_ASYNC_CONNECT', 2);
+define('STREAM_CLIENT_ASYNC_CONNECT', 2);
/**
* Open client socket connection. Client sockets should always
* include this flag. Used with stream_socket_client.
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('STREAM_CLIENT_CONNECT', 4);
+define('STREAM_CLIENT_CONNECT', 4);
/**
* Used with stream_socket_shutdown to disable
@@ -467,7 +467,7 @@
* @since 5.2.1
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('STREAM_SHUT_RD', 0);
+define('STREAM_SHUT_RD', 0);
/**
* Used with stream_socket_shutdown to disable
@@ -475,7 +475,7 @@
* @since 5.2.1
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('STREAM_SHUT_WR', 1);
+define('STREAM_SHUT_WR', 1);
/**
* Used with stream_socket_shutdown to disable
@@ -483,69 +483,69 @@
* @since 5.2.1
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('STREAM_SHUT_RDWR', 2);
+define('STREAM_SHUT_RDWR', 2);
/**
* Internet Protocol Version 4 (IPv4).
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('STREAM_PF_INET', 2);
+define('STREAM_PF_INET', 2);
/**
* Internet Protocol Version 6 (IPv6).
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('STREAM_PF_INET6', 10);
+define('STREAM_PF_INET6', 10);
/**
* Unix system internal protocols.
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('STREAM_PF_UNIX', 1);
+define('STREAM_PF_UNIX', 1);
/**
* Provides a IP socket.
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('STREAM_IPPROTO_IP', 0);
+define('STREAM_IPPROTO_IP', 0);
/**
* Provides a TCP socket.
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('STREAM_IPPROTO_TCP', 6);
+define('STREAM_IPPROTO_TCP', 6);
/**
* Provides a UDP socket.
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('STREAM_IPPROTO_UDP', 17);
+define('STREAM_IPPROTO_UDP', 17);
/**
* Provides a ICMP socket.
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('STREAM_IPPROTO_ICMP', 1);
+define('STREAM_IPPROTO_ICMP', 1);
/**
* Provides a RAW socket.
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('STREAM_IPPROTO_RAW', 255);
+define('STREAM_IPPROTO_RAW', 255);
/**
* Provides sequenced, two-way byte streams with a transmission mechanism
* for out-of-band data (TCP, for example).
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('STREAM_SOCK_STREAM', 1);
+define('STREAM_SOCK_STREAM', 1);
/**
* Provides datagrams, which are connectionless messages (UDP, for
* example).
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('STREAM_SOCK_DGRAM', 2);
+define('STREAM_SOCK_DGRAM', 2);
/**
* Provides a raw socket, which provides access to internal network
@@ -553,28 +553,28 @@
* to the root user.
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('STREAM_SOCK_RAW', 3);
+define('STREAM_SOCK_RAW', 3);
/**
* Provides a sequenced packet stream socket.
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('STREAM_SOCK_SEQPACKET', 5);
+define('STREAM_SOCK_SEQPACKET', 5);
/**
* Provides a RDM (Reliably-delivered messages) socket.
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('STREAM_SOCK_RDM', 4);
-define ('STREAM_PEEK', 2);
-define ('STREAM_OOB', 1);
+define('STREAM_SOCK_RDM', 4);
+define('STREAM_PEEK', 2);
+define('STREAM_OOB', 1);
/**
* Tells a stream created with stream_socket_server
* to bind to the specified target. Server sockets should always include this flag.
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('STREAM_SERVER_BIND', 4);
+define('STREAM_SERVER_BIND', 4);
/**
* Tells a stream created with stream_socket_server
@@ -584,32 +584,32 @@
* Using this flag for connect-less transports (such as UDP) is an error.
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('STREAM_SERVER_LISTEN', 8);
+define('STREAM_SERVER_LISTEN', 8);
/**
* Search for filename in include_path
* @link https://php.net/manual/en/filesystem.constants.php
*/
-define ('FILE_USE_INCLUDE_PATH', 1);
+define('FILE_USE_INCLUDE_PATH', 1);
/**
* Strip EOL characters
* @link https://php.net/manual/en/filesystem.constants.php
*/
-define ('FILE_IGNORE_NEW_LINES', 2);
+define('FILE_IGNORE_NEW_LINES', 2);
/**
* Skip empty lines
* @link https://php.net/manual/en/filesystem.constants.php
*/
-define ('FILE_SKIP_EMPTY_LINES', 4);
+define('FILE_SKIP_EMPTY_LINES', 4);
/**
* Append content to existing file.
* @link https://php.net/manual/en/filesystem.constants.php
*/
-define ('FILE_APPEND', 8);
-define ('FILE_NO_DEFAULT_CONTEXT', 16);
+define('FILE_APPEND', 8);
+define('FILE_NO_DEFAULT_CONTEXT', 16);
/**
*
@@ -619,7 +619,7 @@
* @since 5.2.7
* @link https://php.net/manual/en/filesystem.constants.php
*/
-define ('FILE_TEXT', 0);
+define('FILE_TEXT', 0);
/**
*
@@ -629,38 +629,38 @@
* @since 5.2.7
* @link https://php.net/manual/en/filesystem.constants.php
*/
-define ('FILE_BINARY', 0);
+define('FILE_BINARY', 0);
/**
* Disable backslash escaping.
* @link https://php.net/manual/en/filesystem.constants.php
*/
-define ('FNM_NOESCAPE', 2);
+define('FNM_NOESCAPE', 2);
/**
* Slash in string only matches slash in the given pattern.
* @link https://php.net/manual/en/filesystem.constants.php
*/
-define ('FNM_PATHNAME', 1);
+define('FNM_PATHNAME', 1);
/**
* Leading period in string must be exactly matched by period in the given pattern.
* @link https://php.net/manual/en/filesystem.constants.php
*/
-define ('FNM_PERIOD', 4);
+define('FNM_PERIOD', 4);
/**
* Caseless match. Part of the GNU extension.
* @link https://php.net/manual/en/filesystem.constants.php
*/
-define ('FNM_CASEFOLD', 16);
+define('FNM_CASEFOLD', 16);
/**
* Return Code indicating that the
* userspace filter returned buckets in $out.
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('PSFS_PASS_ON', 2);
+define('PSFS_PASS_ON', 2);
/**
* Return Code indicating that the
@@ -668,7 +668,7 @@
* (i.e. No data available).
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('PSFS_FEED_ME', 1);
+define('PSFS_FEED_ME', 1);
/**
* Return Code indicating that the
@@ -676,139 +676,139 @@
* (i.e. Invalid data received).
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('PSFS_ERR_FATAL', 0);
+define('PSFS_ERR_FATAL', 0);
/**
* Regular read/write.
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('PSFS_FLAG_NORMAL', 0);
+define('PSFS_FLAG_NORMAL', 0);
/**
* An incremental flush.
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('PSFS_FLAG_FLUSH_INC', 1);
+define('PSFS_FLAG_FLUSH_INC', 1);
/**
* Final flush prior to closing.
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('PSFS_FLAG_FLUSH_CLOSE', 2);
-define ('ABDAY_1', 131072);
-define ('ABDAY_2', 131073);
-define ('ABDAY_3', 131074);
-define ('ABDAY_4', 131075);
-define ('ABDAY_5', 131076);
-define ('ABDAY_6', 131077);
-define ('ABDAY_7', 131078);
-define ('DAY_1', 131079);
-define ('DAY_2', 131080);
-define ('DAY_3', 131081);
-define ('DAY_4', 131082);
-define ('DAY_5', 131083);
-define ('DAY_6', 131084);
-define ('DAY_7', 131085);
-define ('ABMON_1', 131086);
-define ('ABMON_2', 131087);
-define ('ABMON_3', 131088);
-define ('ABMON_4', 131089);
-define ('ABMON_5', 131090);
-define ('ABMON_6', 131091);
-define ('ABMON_7', 131092);
-define ('ABMON_8', 131093);
-define ('ABMON_9', 131094);
-define ('ABMON_10', 131095);
-define ('ABMON_11', 131096);
-define ('ABMON_12', 131097);
-define ('MON_1', 131098);
-define ('MON_2', 131099);
-define ('MON_3', 131100);
-define ('MON_4', 131101);
-define ('MON_5', 131102);
-define ('MON_6', 131103);
-define ('MON_7', 131104);
-define ('MON_8', 131105);
-define ('MON_9', 131106);
-define ('MON_10', 131107);
-define ('MON_11', 131108);
-define ('MON_12', 131109);
-define ('AM_STR', 131110);
-define ('PM_STR', 131111);
-define ('D_T_FMT', 131112);
-define ('D_FMT', 131113);
-define ('T_FMT', 131114);
-define ('T_FMT_AMPM', 131115);
-define ('ERA', 131116);
-define ('ERA_D_T_FMT', 131120);
-define ('ERA_D_FMT', 131118);
-define ('ERA_T_FMT', 131121);
-define ('ALT_DIGITS', 131119);
-define ('CRNCYSTR', 262159);
-define ('RADIXCHAR', 65536);
-define ('THOUSEP', 65537);
-define ('YESEXPR', 327680);
-define ('NOEXPR', 327681);
-define ('YESSTR', 327682);
-define ('NOSTR', 327683);
-define ('CODESET', 14);
-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 ('DIRECTORY_SEPARATOR', "/");
-define ('PATH_SEPARATOR', ":");
-define ('GLOB_BRACE', 1024);
-define ('GLOB_MARK', 2);
-define ('GLOB_NOSORT', 4);
-define ('GLOB_NOCHECK', 16);
-define ('GLOB_NOESCAPE', 64);
-define ('GLOB_ERR', 1);
-define ('GLOB_ONLYDIR', 1073741824);
-define ('GLOB_AVAILABLE_FLAGS', 1073741911);
-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('PSFS_FLAG_FLUSH_CLOSE', 2);
+define('ABDAY_1', 131072);
+define('ABDAY_2', 131073);
+define('ABDAY_3', 131074);
+define('ABDAY_4', 131075);
+define('ABDAY_5', 131076);
+define('ABDAY_6', 131077);
+define('ABDAY_7', 131078);
+define('DAY_1', 131079);
+define('DAY_2', 131080);
+define('DAY_3', 131081);
+define('DAY_4', 131082);
+define('DAY_5', 131083);
+define('DAY_6', 131084);
+define('DAY_7', 131085);
+define('ABMON_1', 131086);
+define('ABMON_2', 131087);
+define('ABMON_3', 131088);
+define('ABMON_4', 131089);
+define('ABMON_5', 131090);
+define('ABMON_6', 131091);
+define('ABMON_7', 131092);
+define('ABMON_8', 131093);
+define('ABMON_9', 131094);
+define('ABMON_10', 131095);
+define('ABMON_11', 131096);
+define('ABMON_12', 131097);
+define('MON_1', 131098);
+define('MON_2', 131099);
+define('MON_3', 131100);
+define('MON_4', 131101);
+define('MON_5', 131102);
+define('MON_6', 131103);
+define('MON_7', 131104);
+define('MON_8', 131105);
+define('MON_9', 131106);
+define('MON_10', 131107);
+define('MON_11', 131108);
+define('MON_12', 131109);
+define('AM_STR', 131110);
+define('PM_STR', 131111);
+define('D_T_FMT', 131112);
+define('D_FMT', 131113);
+define('T_FMT', 131114);
+define('T_FMT_AMPM', 131115);
+define('ERA', 131116);
+define('ERA_D_T_FMT', 131120);
+define('ERA_D_FMT', 131118);
+define('ERA_T_FMT', 131121);
+define('ALT_DIGITS', 131119);
+define('CRNCYSTR', 262159);
+define('RADIXCHAR', 65536);
+define('THOUSEP', 65537);
+define('YESEXPR', 327680);
+define('NOEXPR', 327681);
+define('YESSTR', 327682);
+define('NOSTR', 327683);
+define('CODESET', 14);
+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('DIRECTORY_SEPARATOR', "/");
+define('PATH_SEPARATOR', ":");
+define('GLOB_BRACE', 1024);
+define('GLOB_MARK', 2);
+define('GLOB_NOSORT', 4);
+define('GLOB_NOCHECK', 16);
+define('GLOB_NOESCAPE', 64);
+define('GLOB_ERR', 1);
+define('GLOB_ONLYDIR', 1073741824);
+define('GLOB_AVAILABLE_FLAGS', 1073741911);
+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);
/**
* SORT_ASC is used with
* array_multisort to sort in ascending order.
* @link https://php.net/manual/en/array.constants.php
*/
-define ('SORT_ASC', 4);
+define('SORT_ASC', 4);
/**
* SORT_DESC is used with
* array_multisort to sort in descending order.
* @link https://php.net/manual/en/array.constants.php
*/
-define ('SORT_DESC', 3);
+define('SORT_DESC', 3);
/**
* SORT_REGULAR is used to compare items normally.
* @link https://php.net/manual/en/array.constants.php
*/
-define ('SORT_REGULAR', 0);
+define('SORT_REGULAR', 0);
/**
* SORT_NUMERIC is used to compare items numerically.
* @link https://php.net/manual/en/array.constants.php
*/
-define ('SORT_NUMERIC', 1);
+define('SORT_NUMERIC', 1);
/**
* SORT_STRING is used to compare items as strings.
* @link https://php.net/manual/en/array.constants.php
*/
-define ('SORT_STRING', 2);
+define('SORT_STRING', 2);
/**
* SORT_LOCALE_STRING is used to compare items as
@@ -816,7 +816,7 @@
* @since 5.0.2
* @link https://php.net/manual/en/array.constants.php
*/
-define ('SORT_LOCALE_STRING', 5);
+define('SORT_LOCALE_STRING', 5);
/**
* CASE_LOWER is used with
@@ -825,7 +825,7 @@
* array_change_key_case.
* @link https://php.net/manual/en/array.constants.php
*/
-define ('CASE_LOWER', 0);
+define('CASE_LOWER', 0);
/**
* CASE_UPPER is used with
@@ -833,23 +833,23 @@
* keys to upper case.
* @link https://php.net/manual/en/array.constants.php
*/
-define ('CASE_UPPER', 1);
-define ('COUNT_NORMAL', 0);
-define ('COUNT_RECURSIVE', 1);
-define ('ASSERT_ACTIVE', 1);
-define ('ASSERT_CALLBACK', 2);
-define ('ASSERT_BAIL', 3);
-define ('ASSERT_WARNING', 4);
-define ('ASSERT_QUIET_EVAL', 5);
-define ('ASSERT_EXCEPTION', 5);
+define('CASE_UPPER', 1);
+define('COUNT_NORMAL', 0);
+define('COUNT_RECURSIVE', 1);
+define('ASSERT_ACTIVE', 1);
+define('ASSERT_CALLBACK', 2);
+define('ASSERT_BAIL', 3);
+define('ASSERT_WARNING', 4);
+define('ASSERT_QUIET_EVAL', 5);
+define('ASSERT_EXCEPTION', 5);
/**
* Flag indicating if the stream used the include path.
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('STREAM_USE_PATH', 1);
-define ('STREAM_IGNORE_URL', 2);
-define ('STREAM_ENFORCE_SAFE_MODE', 4);
+define('STREAM_USE_PATH', 1);
+define('STREAM_IGNORE_URL', 2);
+define('STREAM_ENFORCE_SAFE_MODE', 4);
/**
* Flag indicating if the wrapper
@@ -858,7 +858,7 @@
* should not raise any errors.
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('STREAM_REPORT_ERRORS', 8);
+define('STREAM_REPORT_ERRORS', 8);
/**
* This flag is useful when your extension really must be able to randomly
@@ -874,140 +874,140 @@
* opener to block until the whole contents have been downloaded.
* @link https://php.net/manual/en/internals2.ze1.streams.constants.php
*/
-define ('STREAM_MUST_SEEK', 16);
-define ('STREAM_URL_STAT_LINK', 1);
-define ('STREAM_URL_STAT_QUIET', 2);
-define ('STREAM_MKDIR_RECURSIVE', 1);
-define ('STREAM_IS_URL', 1);
-define ('STREAM_OPTION_BLOCKING', 1);
-define ('STREAM_OPTION_READ_TIMEOUT', 4);
-define ('STREAM_OPTION_READ_BUFFER', 2);
-define ('STREAM_OPTION_WRITE_BUFFER', 3);
-define ('STREAM_BUFFER_NONE', 0);
-define ('STREAM_BUFFER_LINE', 1);
-define ('STREAM_BUFFER_FULL', 2);
+define('STREAM_MUST_SEEK', 16);
+define('STREAM_URL_STAT_LINK', 1);
+define('STREAM_URL_STAT_QUIET', 2);
+define('STREAM_MKDIR_RECURSIVE', 1);
+define('STREAM_IS_URL', 1);
+define('STREAM_OPTION_BLOCKING', 1);
+define('STREAM_OPTION_READ_TIMEOUT', 4);
+define('STREAM_OPTION_READ_BUFFER', 2);
+define('STREAM_OPTION_WRITE_BUFFER', 3);
+define('STREAM_BUFFER_NONE', 0);
+define('STREAM_BUFFER_LINE', 1);
+define('STREAM_BUFFER_FULL', 2);
/**
* Stream casting, when stream_cast is called
* otherwise (see above).
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('STREAM_CAST_AS_STREAM', 0);
+define('STREAM_CAST_AS_STREAM', 0);
/**
* Stream casting, for when stream_select is
* calling stream_cast.
* @link https://php.net/manual/en/stream.constants.php
*/
-define ('STREAM_CAST_FOR_SELECT', 3);
+define('STREAM_CAST_FOR_SELECT', 3);
/**
* Image type constant used by the {@link image_type_to_mime_type()} and {@link image_type_to_extension()} functions.
* @link https://php.net/manual/en/image.constants.php
*/
-define ('IMAGETYPE_GIF', 1);
+define('IMAGETYPE_GIF', 1);
/**
* Image type constant used by the {@link image_type_to_mime_type()} and {@link image_type_to_extension()} functions.
* @link https://php.net/manual/en/image.constants.php
*/
-define ('IMAGETYPE_JPEG', 2);
+define('IMAGETYPE_JPEG', 2);
/**
* Image type constant used by the {@link image_type_to_mime_type()} and {@link image_type_to_extension()} functions.
* @link https://php.net/manual/en/image.constants.php
*/
-define ('IMAGETYPE_PNG', 3);
+define('IMAGETYPE_PNG', 3);
/**
* Image type constant used by the {@link image_type_to_mime_type()} and {@link image_type_to_extension()} functions.
* @link https://php.net/manual/en/image.constants.php
*/
-define ('IMAGETYPE_SWF', 4);
+define('IMAGETYPE_SWF', 4);
/**
* Image type constant used by the {@link image_type_to_mime_type()} and {@link image_type_to_extension()} functions.
* @link https://php.net/manual/en/image.constants.php
*/
-define ('IMAGETYPE_PSD', 5);
+define('IMAGETYPE_PSD', 5);
/**
* Image type constant used by the {@link image_type_to_mime_type()} and {@link image_type_to_extension()} functions.
* @link https://php.net/manual/en/image.constants.php
*/
-define ('IMAGETYPE_BMP', 6);
+define('IMAGETYPE_BMP', 6);
/**
* Image type constant used by the {@link image_type_to_mime_type()} and {@link image_type_to_extension()} functions.
* @link https://php.net/manual/en/image.constants.php
*/
-define ('IMAGETYPE_TIFF_II', 7);
+define('IMAGETYPE_TIFF_II', 7);
/**
* Image type constant used by the {@link image_type_to_mime_type()} and {@link image_type_to_extension()} functions.
* @link https://php.net/manual/en/image.constants.php
*/
-define ('IMAGETYPE_TIFF_MM', 8);
+define('IMAGETYPE_TIFF_MM', 8);
/**
* Image type constant used by the {@link image_type_to_mime_type()} and {@link image_type_to_extension()} functions.
* @link https://php.net/manual/en/image.constants.php
*/
-define ('IMAGETYPE_JPC', 9);
+define('IMAGETYPE_JPC', 9);
/**
* Image type constant used by the {@link image_type_to_mime_type()} and {@link image_type_to_extension()} functions.
* @link https://php.net/manual/en/image.constants.php
*/
-define ('IMAGETYPE_JP2', 10);
+define('IMAGETYPE_JP2', 10);
/**
* Image type constant used by the {@link image_type_to_mime_type()} and {@link image_type_to_extension()} functions.
* @link https://php.net/manual/en/image.constants.php
*/
-define ('IMAGETYPE_JPX', 11);
+define('IMAGETYPE_JPX', 11);
/**
* Image type constant used by the {@link image_type_to_mime_type()} and {@link image_type_to_extension()} functions.
* @link https://php.net/manual/en/image.constants.php
*/
-define ('IMAGETYPE_JB2', 12);
+define('IMAGETYPE_JB2', 12);
/**
* Image type constant used by the {@link image_type_to_mime_type()} and {@link image_type_to_extension()} functions.
* @link https://php.net/manual/en/image.constants.php
*/
-define ('IMAGETYPE_SWC', 13);
+define('IMAGETYPE_SWC', 13);
/**
* Image type constant used by the {@link image_type_to_mime_type()} and {@link image_type_to_extension()} functions.
* @link https://php.net/manual/en/image.constants.php
*/
-define ('IMAGETYPE_IFF', 14);
+define('IMAGETYPE_IFF', 14);
/**
* Image type constant used by the {@link image_type_to_mime_type()} and {@link image_type_to_extension()} functions.
* @link https://php.net/manual/en/image.constants.php
*/
-define ('IMAGETYPE_WBMP', 15);
+define('IMAGETYPE_WBMP', 15);
/**
* Image type constant used by the {@link image_type_to_mime_type()} and {@link image_type_to_extension()} functions.
* @link https://php.net/manual/en/image.constants.php
*/
-define ('IMAGETYPE_JPEG2000', 9);
+define('IMAGETYPE_JPEG2000', 9);
/**
* Image type constant used by the {@link image_type_to_mime_type()} and {@link image_type_to_extension()} functions.
* @link https://php.net/manual/en/image.constants.php
*/
-define ('IMAGETYPE_XBM', 16);
+define('IMAGETYPE_XBM', 16);
/**
* Image type constant used by the {@link image_type_to_mime_type()} and {@link image_type_to_extension()} functions.
* @link https://php.net/manual/en/image.constants.php
*/
-define ('IMAGETYPE_ICO', 17);
+define('IMAGETYPE_ICO', 17);
/**
* Image type constant used by the {@link image_type_to_mime_type()} and {@link image_type_to_extension()} functions.
@@ -1022,7 +1022,7 @@
* IPv4 Address Resource
* @link https://php.net/manual/en/network.constants.php
*/
-define ('DNS_A', 1);
+define('DNS_A', 1);
define('DNS_CAA', 8192);
@@ -1030,25 +1030,25 @@
* Authoritative Name Server Resource
* @link https://php.net/manual/en/network.constants.php
*/
-define ('DNS_NS', 2);
+define('DNS_NS', 2);
/**
* Alias (Canonical Name) Resource
* @link https://php.net/manual/en/network.constants.php
*/
-define ('DNS_CNAME', 16);
+define('DNS_CNAME', 16);
/**
* Start of Authority Resource
* @link https://php.net/manual/en/network.constants.php
*/
-define ('DNS_SOA', 32);
+define('DNS_SOA', 32);
/**
* Pointer Resource
* @link https://php.net/manual/en/network.constants.php
*/
-define ('DNS_PTR', 2048);
+define('DNS_PTR', 2048);
/**
* Host Info Resource (See IANA's
@@ -1056,28 +1056,28 @@
* for the meaning of these values)
* @link https://php.net/manual/en/network.constants.php
*/
-define ('DNS_HINFO', 4096);
+define('DNS_HINFO', 4096);
/**
* Mail Exchanger Resource
* @link https://php.net/manual/en/network.constants.php
*/
-define ('DNS_MX', 16384);
+define('DNS_MX', 16384);
/**
* Text Resource
* @link https://php.net/manual/en/network.constants.php
*/
-define ('DNS_TXT', 32768);
-define ('DNS_SRV', 33554432);
-define ('DNS_NAPTR', 67108864);
+define('DNS_TXT', 32768);
+define('DNS_SRV', 33554432);
+define('DNS_NAPTR', 67108864);
/**
* IPv6 Address Resource
* @link https://php.net/manual/en/network.constants.php
*/
-define ('DNS_AAAA', 134217728);
-define ('DNS_A6', 16777216);
+define('DNS_AAAA', 134217728);
+define('DNS_A6', 16777216);
/**
* Any Resource Record. On most systems
@@ -1086,18 +1086,17 @@
* uses. Try DNS_ALL instead.
* @link https://php.net/manual/en/network.constants.php
*/
-define ('DNS_ANY', 268435456);
+define('DNS_ANY', 268435456);
/**
* Iteratively query the name server for
* each available record type.
* @link https://php.net/manual/en/network.constants.php
*/
-define ('DNS_ALL', 251721779);
+define('DNS_ALL', 251721779);
// End of standard v.5.3.1-0.dotdeb.1
-
//WI-11084 Constant not defined PHP_QUERY_RFC3986
/**
@@ -1112,7 +1111,6 @@
*/
define('PHP_QUERY_RFC3986', 2);
-
//WI-11254 Stubs for missing constants from PHP 5.4
/**
@@ -1192,7 +1190,6 @@
*/
define('ENT_HTML5', 48);
-
/** @link https://php.net/manual/en/function.scandir.php */
define('SCANDIR_SORT_ASCENDING', 0);
/** @link https://php.net/manual/en/function.scandir.php */
@@ -1200,8 +1197,6 @@
/** @link https://php.net/manual/en/function.scandir.php */
define('SCANDIR_SORT_NONE', 2);
-
-
/**
* SORT_NATURAL is used to compare items as strings using "natural ordering" like natsort().
* @since 5.4
@@ -1215,8 +1210,6 @@
*/
define('SORT_FLAG_CASE', 8);
-
-
/** @link https://php.net/manual/en/streamwrapper.stream-metadata.php */
define('STREAM_META_TOUCH', 1);
/** @link https://php.net/manual/en/streamwrapper.stream-metadata.php */
@@ -1278,154 +1271,154 @@
* system is unusable
* @link https://php.net/manual/en/network.constants.php
*/
-define ('LOG_EMERG', 0);
+define('LOG_EMERG', 0);
/**
* action must be taken immediately
* @link https://php.net/manual/en/network.constants.php
*/
-define ('LOG_ALERT', 1);
+define('LOG_ALERT', 1);
/**
* critical conditions
* @link https://php.net/manual/en/network.constants.php
*/
-define ('LOG_CRIT', 2);
+define('LOG_CRIT', 2);
/**
* error conditions
* @link https://php.net/manual/en/network.constants.php
*/
-define ('LOG_ERR', 3);
+define('LOG_ERR', 3);
/**
* warning conditions
* @link https://php.net/manual/en/network.constants.php
*/
-define ('LOG_WARNING', 4);
+define('LOG_WARNING', 4);
/**
* normal, but significant, condition
* @link https://php.net/manual/en/network.constants.php
*/
-define ('LOG_NOTICE', 5);
+define('LOG_NOTICE', 5);
/**
* informational message
* @link https://php.net/manual/en/network.constants.php
*/
-define ('LOG_INFO', 6);
+define('LOG_INFO', 6);
/**
* debug-level message
* @link https://php.net/manual/en/network.constants.php
*/
-define ('LOG_DEBUG', 7);
+define('LOG_DEBUG', 7);
/**
* kernel messages
* @link https://php.net/manual/en/network.constants.php
*/
-define ('LOG_KERN', 0);
+define('LOG_KERN', 0);
/**
* generic user-level messages
* @link https://php.net/manual/en/network.constants.php
*/
-define ('LOG_USER', 8);
+define('LOG_USER', 8);
/**
* mail subsystem
* @link https://php.net/manual/en/network.constants.php
*/
-define ('LOG_MAIL', 16);
+define('LOG_MAIL', 16);
/**
* other system daemons
* @link https://php.net/manual/en/network.constants.php
*/
-define ('LOG_DAEMON', 24);
+define('LOG_DAEMON', 24);
/**
* security/authorization messages (use LOG_AUTHPRIV instead
* in systems where that constant is defined)
* @link https://php.net/manual/en/network.constants.php
*/
-define ('LOG_AUTH', 32);
+define('LOG_AUTH', 32);
/**
* messages generated internally by syslogd
* @link https://php.net/manual/en/network.constants.php
*/
-define ('LOG_SYSLOG', 40);
+define('LOG_SYSLOG', 40);
/**
* line printer subsystem
* @link https://php.net/manual/en/network.constants.php
*/
-define ('LOG_LPR', 48);
+define('LOG_LPR', 48);
/**
* USENET news subsystem
* @link https://php.net/manual/en/network.constants.php
*/
-define ('LOG_NEWS', 56);
+define('LOG_NEWS', 56);
/**
* UUCP subsystem
* @link https://php.net/manual/en/network.constants.php
*/
-define ('LOG_UUCP', 64);
+define('LOG_UUCP', 64);
/**
* clock daemon (cron and at)
* @link https://php.net/manual/en/network.constants.php
*/
-define ('LOG_CRON', 72);
+define('LOG_CRON', 72);
/**
* security/authorization messages (private)
* @link https://php.net/manual/en/network.constants.php
*/
-define ('LOG_AUTHPRIV', 80);
-define ('LOG_LOCAL0', 128);
-define ('LOG_LOCAL1', 136);
-define ('LOG_LOCAL2', 144);
-define ('LOG_LOCAL3', 152);
-define ('LOG_LOCAL4', 160);
-define ('LOG_LOCAL5', 168);
-define ('LOG_LOCAL6', 176);
-define ('LOG_LOCAL7', 184);
+define('LOG_AUTHPRIV', 80);
+define('LOG_LOCAL0', 128);
+define('LOG_LOCAL1', 136);
+define('LOG_LOCAL2', 144);
+define('LOG_LOCAL3', 152);
+define('LOG_LOCAL4', 160);
+define('LOG_LOCAL5', 168);
+define('LOG_LOCAL6', 176);
+define('LOG_LOCAL7', 184);
/**
* include PID with each message
* @link https://php.net/manual/en/network.constants.php
*/
-define ('LOG_PID', 1);
+define('LOG_PID', 1);
/**
* if there is an error while sending data to the system logger,
* write directly to the system console
* @link https://php.net/manual/en/network.constants.php
*/
-define ('LOG_CONS', 2);
+define('LOG_CONS', 2);
/**
* (default) delay opening the connection until the first
* message is logged
* @link https://php.net/manual/en/network.constants.php
*/
-define ('LOG_ODELAY', 4);
+define('LOG_ODELAY', 4);
/**
* open the connection to the logger immediately
* @link https://php.net/manual/en/network.constants.php
*/
-define ('LOG_NDELAY', 8);
-define ('LOG_NOWAIT', 16);
+define('LOG_NDELAY', 8);
+define('LOG_NOWAIT', 16);
/**
* print log message also to standard error
* @link https://php.net/manual/en/network.constants.php
*/
-define ('LOG_PERROR', 32);
+define('LOG_PERROR', 32);
diff --git a/stats/stats.php b/stats/stats.php
index 4397547cc..16107794b 100644
--- a/stats/stats.php
+++ b/stats/stats.php
@@ -13,8 +13,7 @@
* @param array $a
* @return float|false
*/
-function stats_absolute_deviation (array $a) {
-}
+function stats_absolute_deviation(array $a) {}
/**
* Returns CDF, x, alpha, or beta, determined by which.
@@ -26,8 +25,7 @@ function stats_absolute_deviation (array $a) {
* @param int $which
* @return float
*/
-function stats_cdf_beta (float $par1, float $par2, float $par3, int $which): float {
-}
+function stats_cdf_beta(float $par1, float $par2, float $par3, int $which): float {}
/**
* Returns CDF, x, n, or p, determined by which.
@@ -39,8 +37,7 @@ function stats_cdf_beta (float $par1, float $par2, float $par3, int $which): flo
* @param int $which
* @return float
*/
-function stats_cdf_binomial (float $par1, float $par2, float $par3, int $which): float {
-}
+function stats_cdf_binomial(float $par1, float $par2, float $par3, int $which): float {}
/**
* Returns CDF, x, x0, or gamma, determined by which.
@@ -52,8 +49,7 @@ function stats_cdf_binomial (float $par1, float $par2, float $par3, int $which):
* @param int $which
* @return float
*/
-function stats_cdf_cauchy (float $par1, float $par2, float $par3, int $which): float {
-}
+function stats_cdf_cauchy(float $par1, float $par2, float $par3, int $which): float {}
/**
* Returns CDF, x, or k, determined by which.
@@ -64,8 +60,7 @@ function stats_cdf_cauchy (float $par1, float $par2, float $par3, int $which): f
* @param int $which
* @return float
*/
-function stats_cdf_chisquare (float $par1, float $par2, int $which): float {
-}
+function stats_cdf_chisquare(float $par1, float $par2, int $which): float {}
/**
* Returns CDF, x, or lambda, determined by which.
@@ -76,8 +71,7 @@ function stats_cdf_chisquare (float $par1, float $par2, int $which): float {
* @param int $which
* @return float
*/
-function stats_cdf_exponential (float $par1, float $par2, int $which): float {
-}
+function stats_cdf_exponential(float $par1, float $par2, int $which): float {}
/**
* Returns CDF, x, d1, or d2, determined by which.
@@ -89,8 +83,7 @@ function stats_cdf_exponential (float $par1, float $par2, int $which): float {
* @param int $which
* @return float
*/
-function stats_cdf_f (float $par1, float $par2, float $par3, int $which): float {
-}
+function stats_cdf_f(float $par1, float $par2, float $par3, int $which): float {}
/**
* Returns CDF, x, k, or theta, determined by which.
@@ -102,8 +95,7 @@ function stats_cdf_f (float $par1, float $par2, float $par3, int $which): float
* @param int $which
* @return float
*/
-function stats_cdf_gamma (float $par1, float $par2, float $par3, int $which): float {
-}
+function stats_cdf_gamma(float $par1, float $par2, float $par3, int $which): float {}
/**
* Returns CDF, x, mu, or b, determined by which.
@@ -115,8 +107,7 @@ function stats_cdf_gamma (float $par1, float $par2, float $par3, int $which): fl
* @param int $which
* @return float
*/
-function stats_cdf_laplace (float $par1, float $par2, float $par3, int $which): float {
-}
+function stats_cdf_laplace(float $par1, float $par2, float $par3, int $which): float {}
/**
* Returns CDF, x, mu, or s, determined by which.
@@ -128,8 +119,7 @@ function stats_cdf_laplace (float $par1, float $par2, float $par3, int $which):
* @param int $which
* @return float
*/
-function stats_cdf_logistic (float $par1, float $par2, float $par3, int $which): float {
-}
+function stats_cdf_logistic(float $par1, float $par2, float $par3, int $which): float {}
/**
* Returns CDF, x, r, or p, determined by which.
@@ -141,8 +131,7 @@ function stats_cdf_logistic (float $par1, float $par2, float $par3, int $which):
* @param int $which
* @return float
*/
-function stats_cdf_negative_binomial (float $par1, float $par2, float $par3, int $which): float {
-}
+function stats_cdf_negative_binomial(float $par1, float $par2, float $par3, int $which): float {}
/**
* Returns CDF, x, k, or lambda, determined by which.
@@ -154,8 +143,7 @@ function stats_cdf_negative_binomial (float $par1, float $par2, float $par3, int
* @param int $which
* @return float
*/
-function stats_cdf_noncentral_chisquare (float $par1, float $par2, float $par3, int $which): float {
-}
+function stats_cdf_noncentral_chisquare(float $par1, float $par2, float $par3, int $which): float {}
/**
* Returns CDF, x, nu1, nu2, or lambda, determined by which.
@@ -168,8 +156,7 @@ function stats_cdf_noncentral_chisquare (float $par1, float $par2, float $par3,
* @param int $which
* @return float
*/
-function stats_cdf_noncentral_f (float $par1, float $par2, float $par3, float $par4, int $which): float {
-}
+function stats_cdf_noncentral_f(float $par1, float $par2, float $par3, float $par4, int $which): float {}
/**
* Returns CDF, x, nu, or mu, determined by which.
@@ -181,8 +168,7 @@ function stats_cdf_noncentral_f (float $par1, float $par2, float $par3, float $p
* @param int $which
* @return float
*/
-function stats_cdf_noncentral_t (float $par1, float $par2, float $par3, int $which): float {
-}
+function stats_cdf_noncentral_t(float $par1, float $par2, float $par3, int $which): float {}
/**
* Returns CDF, x, mu, or sigma, determined by which.
@@ -194,8 +180,7 @@ function stats_cdf_noncentral_t (float $par1, float $par2, float $par3, int $whi
* @param int $which
* @return float
*/
-function stats_cdf_normal (float $par1, float $par2, float $par3, int $which): float {
-}
+function stats_cdf_normal(float $par1, float $par2, float $par3, int $which): float {}
/**
* Returns CDF, x, or lambda, determined by which.
@@ -206,8 +191,7 @@ function stats_cdf_normal (float $par1, float $par2, float $par3, int $which): f
* @param int $which
* @return float
*/
-function stats_cdf_poisson (float $par1, float $par2, int $which): float {
-}
+function stats_cdf_poisson(float $par1, float $par2, int $which): float {}
/**
* Returns CDF, x, or nu, determined by which.
@@ -218,8 +202,7 @@ function stats_cdf_poisson (float $par1, float $par2, int $which): float {
* @param int $which
* @return float
*/
-function stats_cdf_t (float $par1, float $par2, int $which): float {
-}
+function stats_cdf_t(float $par1, float $par2, int $which): float {}
/**
* Returns CDF, x, a, or b, determined by which.
@@ -231,8 +214,7 @@ function stats_cdf_t (float $par1, float $par2, int $which): float {
* @param int $which
* @return float
*/
-function stats_cdf_uniform (float $par1, float $par2, float $par3, int $which): float {
-}
+function stats_cdf_uniform(float $par1, float $par2, float $par3, int $which): float {}
/**
* Returns CDF, x, k, or lambda, determined by which.
@@ -244,8 +226,7 @@ function stats_cdf_uniform (float $par1, float $par2, float $par3, int $which):
* @param int $which
* @return float
*/
-function stats_cdf_weibull (float $par1, float $par2, float $par3, int $which): float {
-}
+function stats_cdf_weibull(float $par1, float $par2, float $par3, int $which): float {}
/**
* Returns the covariance of a and b, or FALSE on failure.
@@ -255,8 +236,7 @@ function stats_cdf_weibull (float $par1, float $par2, float $par3, int $which):
* @param array $b
* @return float|false
*/
-function stats_covariance (array $a, array $b) {
-}
+function stats_covariance(array $a, array $b) {}
/**
* The probability density at x or FALSE for failure.
@@ -267,8 +247,7 @@ function stats_covariance (array $a, array $b) {
* @param float $b
* @return float|false
*/
-function stats_dens_beta (float $x, float $a, float $b) {
-}
+function stats_dens_beta(float $x, float $a, float $b) {}
/**
* The probability density at x or FALSE for failure.
@@ -279,8 +258,7 @@ function stats_dens_beta (float $x, float $a, float $b) {
* @param float $stdev
* @return float|false
*/
-function stats_dens_cauchy (float $x, float $ave, float $stdev) {
-}
+function stats_dens_cauchy(float $x, float $ave, float $stdev) {}
/**
* The probability density at x or FALSE for failure.
@@ -290,8 +268,7 @@ function stats_dens_cauchy (float $x, float $ave, float $stdev) {
* @param float $dfr
* @return float|false
*/
-function stats_dens_chisquare (float $x, float $dfr) {
-}
+function stats_dens_chisquare(float $x, float $dfr) {}
/**
* The probability density at x or FALSE for failure.
@@ -301,8 +278,7 @@ function stats_dens_chisquare (float $x, float $dfr) {
* @param float $scale
* @return float|false
*/
-function stats_dens_exponential (float $x, float $scale) {
-}
+function stats_dens_exponential(float $x, float $scale) {}
/**
* The probability density at x or FALSE for failure.
@@ -313,8 +289,7 @@ function stats_dens_exponential (float $x, float $scale) {
* @param float $dfr2
* @return float|false
*/
-function stats_dens_f (float $x, float $dfr1, float $dfr2) {
-}
+function stats_dens_f(float $x, float $dfr1, float $dfr2) {}
/**
* The probability density at x or FALSE for failure.
@@ -325,8 +300,7 @@ function stats_dens_f (float $x, float $dfr1, float $dfr2) {
* @param float $scale
* @return float|false
*/
-function stats_dens_gamma (float $x, float $shape, float $scale) {
-}
+function stats_dens_gamma(float $x, float $shape, float $scale) {}
/**
* The probability density at x or FALSE for failure.
@@ -337,8 +311,7 @@ function stats_dens_gamma (float $x, float $shape, float $scale) {
* @param float $stdev
* @return float|false
*/
-function stats_dens_laplace (float $x, float $ave, float $stdev) {
-}
+function stats_dens_laplace(float $x, float $ave, float $stdev) {}
/**
* The probability density at x or FALSE for failure.
@@ -349,8 +322,7 @@ function stats_dens_laplace (float $x, float $ave, float $stdev) {
* @param float $stdev
* @return float|false
*/
-function stats_dens_logistic (float $x, float $ave, float $stdev) {
-}
+function stats_dens_logistic(float $x, float $ave, float $stdev) {}
/**
* The probability density at x or FALSE for failure.
@@ -361,8 +333,7 @@ function stats_dens_logistic (float $x, float $ave, float $stdev) {
* @param float $stdev
* @return float|false
*/
-function stats_dens_normal (float $x, float $ave, float $stdev) {
-}
+function stats_dens_normal(float $x, float $ave, float $stdev) {}
/**
* The probability mass at x or FALSE for failure.
@@ -373,8 +344,7 @@ function stats_dens_normal (float $x, float $ave, float $stdev) {
* @param float $pi
* @return float|false
*/
-function stats_dens_pmf_binomial (float $x, float $n, float $pi) {
-}
+function stats_dens_pmf_binomial(float $x, float $n, float $pi) {}
/**
* The probability mass at n1 or FALSE for failure.
@@ -386,8 +356,7 @@ function stats_dens_pmf_binomial (float $x, float $n, float $pi) {
* @param float $N2
* @return float|false
*/
-function stats_dens_pmf_hypergeometric (float $n1, float $n2, float $N1, float $N2) {
-}
+function stats_dens_pmf_hypergeometric(float $n1, float $n2, float $N1, float $N2) {}
/**
* The probability mass at x or FALSE for failure.
@@ -398,8 +367,7 @@ function stats_dens_pmf_hypergeometric (float $n1, float $n2, float $N1, float $
* @param float $pi
* @return float|false
*/
-function stats_dens_pmf_negative_binomial (float $x, float $n, float $pi) {
-}
+function stats_dens_pmf_negative_binomial(float $x, float $n, float $pi) {}
/**
* The probability mass at x or FALSE for failure.
@@ -409,8 +377,7 @@ function stats_dens_pmf_negative_binomial (float $x, float $n, float $pi) {
* @param float $lb
* @return float|false
*/
-function stats_dens_pmf_poisson (float $x, float $lb) {
-}
+function stats_dens_pmf_poisson(float $x, float $lb) {}
/**
* The probability density at x or FALSE for failure.
@@ -420,8 +387,7 @@ function stats_dens_pmf_poisson (float $x, float $lb) {
* @param float $dfr
* @return float|false
*/
-function stats_dens_t (float $x, float $dfr) {
-}
+function stats_dens_t(float $x, float $dfr) {}
/**
* The probability density at x or FALSE for failure.
@@ -432,8 +398,7 @@ function stats_dens_t (float $x, float $dfr) {
* @param float $b
* @return float|false
*/
-function stats_dens_uniform (float $x, float $a, float $b) {
-}
+function stats_dens_uniform(float $x, float $a, float $b) {}
/**
* The probability density at x or FALSE for failure.
@@ -444,8 +409,7 @@ function stats_dens_uniform (float $x, float $a, float $b) {
* @param float $b
* @return float|false
*/
-function stats_dens_weibull (float $x, float $a, float $b) {
-}
+function stats_dens_weibull(float $x, float $a, float $b) {}
/**
* Returns the harmonic mean of the values in a, or FALSE if a is empty or is not an array.
@@ -454,8 +418,7 @@ function stats_dens_weibull (float $x, float $a, float $b) {
* @param array $a
* @return number|false
*/
-function stats_harmonic_mean (array $a) {
-}
+function stats_harmonic_mean(array $a) {}
/**
* Returns the kurtosis of the values in a, or FALSE if a is empty or is not an array.
@@ -464,8 +427,7 @@ function stats_harmonic_mean (array $a) {
* @param array $a
* @return float|false
*/
-function stats_kurtosis (array $a) {
-}
+function stats_kurtosis(array $a) {}
/**
* A random deviate
@@ -475,8 +437,7 @@ function stats_kurtosis (array $a) {
* @param float $b
* @return float
*/
-function stats_rand_gen_beta (float $a, float $b): float {
-}
+function stats_rand_gen_beta(float $a, float $b): float {}
/**
* A random deviate
@@ -485,8 +446,7 @@ function stats_rand_gen_beta (float $a, float $b): float {
* @param float $df
* @return float
*/
-function stats_rand_gen_chisquare (float $df): float {
-}
+function stats_rand_gen_chisquare(float $df): float {}
/**
* A random deviate
@@ -495,8 +455,7 @@ function stats_rand_gen_chisquare (float $df): float {
* @param float $av
* @return float
*/
-function stats_rand_gen_exponential (float $av): float {
-}
+function stats_rand_gen_exponential(float $av): float {}
/**
* A random deviate
@@ -506,8 +465,7 @@ function stats_rand_gen_exponential (float $av): float {
* @param float $dfd
* @return float
*/
-function stats_rand_gen_f (float $dfn, float $dfd): float {
-}
+function stats_rand_gen_f(float $dfn, float $dfd): float {}
/**
* A random deviate
@@ -517,8 +475,7 @@ function stats_rand_gen_f (float $dfn, float $dfd): float {
* @param float $high
* @return float
*/
-function stats_rand_gen_funiform (float $low, float $high): float {
-}
+function stats_rand_gen_funiform(float $low, float $high): float {}
/**
* A random deviate
@@ -528,8 +485,7 @@ function stats_rand_gen_funiform (float $low, float $high): float {
* @param float $r
* @return float
*/
-function stats_rand_gen_gamma (float $a, float $r): float {
-}
+function stats_rand_gen_gamma(float $a, float $r): float {}
/**
* A random deviate, which is the number of failure.
@@ -539,8 +495,7 @@ function stats_rand_gen_gamma (float $a, float $r): float {
* @param float $p
* @return int
*/
-function stats_rand_gen_ibinomial_negative (int $n, float $p): int {
-}
+function stats_rand_gen_ibinomial_negative(int $n, float $p): int {}
/**
* A random deviate
@@ -550,8 +505,7 @@ function stats_rand_gen_ibinomial_negative (int $n, float $p): int {
* @param float $pp
* @return int
*/
-function stats_rand_gen_ibinomial (int $n, float $pp): int {
-}
+function stats_rand_gen_ibinomial(int $n, float $pp): int {}
/**
* A random integer
@@ -559,8 +513,7 @@ function stats_rand_gen_ibinomial (int $n, float $pp): int {
* @link https://www.php.net/manual/en/function.stats-rand-gen-int.php
* @return int
*/
-function stats_rand_gen_int (): int {
-}
+function stats_rand_gen_int(): int {}
/**
* A random deviate
@@ -569,8 +522,7 @@ function stats_rand_gen_int (): int {
* @param float $mu
* @return int
*/
-function stats_rand_gen_ipoisson (float $mu): int {
-}
+function stats_rand_gen_ipoisson(float $mu): int {}
/**
* A random integer
@@ -580,8 +532,7 @@ function stats_rand_gen_ipoisson (float $mu): int {
* @param int $high
* @return int
*/
-function stats_rand_gen_iuniform (int $low, int $high): int {
-}
+function stats_rand_gen_iuniform(int $low, int $high): int {}
/**
* A random deviate
@@ -592,8 +543,7 @@ function stats_rand_gen_iuniform (int $low, int $high): int {
* @param float $xnonc
* @return float
*/
-function stats_rand_gen_noncentral_f (float $dfn, float $dfd, float $xnonc): float {
-}
+function stats_rand_gen_noncentral_f(float $dfn, float $dfd, float $xnonc): float {}
/**
* A random deviate
@@ -603,8 +553,7 @@ function stats_rand_gen_noncentral_f (float $dfn, float $dfd, float $xnonc): flo
* @param float $xnonc
* @return float
*/
-function stats_rand_gen_noncentral_t (float $df, float $xnonc): float {
-}
+function stats_rand_gen_noncentral_t(float $df, float $xnonc): float {}
/**
* A random deviate
@@ -614,8 +563,7 @@ function stats_rand_gen_noncentral_t (float $df, float $xnonc): float {
* @param float $sd
* @return float
*/
-function stats_rand_gen_normal (float $av, float $sd): float {
-}
+function stats_rand_gen_normal(float $av, float $sd): float {}
/**
* A random deviate
@@ -624,8 +572,7 @@ function stats_rand_gen_normal (float $av, float $sd): float {
* @param float $df
* @return float
*/
-function stats_rand_gen_t (float $df): float {
-}
+function stats_rand_gen_t(float $df): float {}
/**
* Returns an array of two integers.
@@ -633,8 +580,7 @@ function stats_rand_gen_t (float $df): float {
* @link https://www.php.net/manual/en/function.stats-rand-get-seeds.php
* @return int[]
*/
-function stats_rand_get_seeds () {
-}
+function stats_rand_get_seeds() {}
/**
* Returns an array of two integers.
@@ -643,8 +589,7 @@ function stats_rand_get_seeds () {
* @param string $phrase
* @return int[]
*/
-function stats_rand_phrase_to_seeds (string $phrase) {
-}
+function stats_rand_phrase_to_seeds(string $phrase) {}
/**
* A random floating point number
@@ -652,8 +597,7 @@ function stats_rand_phrase_to_seeds (string $phrase) {
* @link https://www.php.net/manual/en/function.stats-rand-ranf.php
* @return float
*/
-function stats_rand_ranf (): float {
-}
+function stats_rand_ranf(): float {}
/**
* No values are returned.
@@ -662,8 +606,7 @@ function stats_rand_ranf (): float {
* @param int $iseed1
* @param int $iseed2
*/
-function stats_rand_setall (int $iseed1, int $iseed2): void {
-}
+function stats_rand_setall(int $iseed1, int $iseed2): void {}
/**
* Returns the skewness of the values in a, or FALSE if a is empty or is not an array.
@@ -672,8 +615,7 @@ function stats_rand_setall (int $iseed1, int $iseed2): void {
* @param array $a
* @return float|false
*/
-function stats_skew (array $a) {
-}
+function stats_skew(array $a) {}
/**
* Returns the standard deviation on success; FALSE on failure.
@@ -684,8 +626,7 @@ function stats_skew (array $a) {
* @param bool $sample
* @return float|false
*/
-function stats_standard_deviation (array $a, bool $sample = false) {
-}
+function stats_standard_deviation(array $a, bool $sample = false) {}
/**
* Returns the binomial coefficient
@@ -695,8 +636,7 @@ function stats_standard_deviation (array $a, bool $sample = false) {
* @param int $n
* @return float
*/
-function stats_stat_binomial_coef (int $x, int $n): float {
-}
+function stats_stat_binomial_coef(int $x, int $n): float {}
/**
* Returns the Pearson correlation coefficient between arr1 and arr2, or FALSE on failure.
@@ -706,8 +646,7 @@ function stats_stat_binomial_coef (int $x, int $n): float {
* @param array $arr2
* @return float|false
*/
-function stats_stat_correlation (array $arr1, array $arr2) {
-}
+function stats_stat_correlation(array $arr1, array $arr2) {}
/**
* The factorial of n.
@@ -716,8 +655,7 @@ function stats_stat_correlation (array $arr1, array $arr2) {
* @param int $n
* @return float
*/
-function stats_stat_factorial (int $n): float {
-}
+function stats_stat_factorial(int $n): float {}
/**
* Returns the t-value, or FALSE if failure.
@@ -727,8 +665,7 @@ function stats_stat_factorial (int $n): float {
* @param array $arr2
* @return float|false
*/
-function stats_stat_independent_t (array $arr1, array $arr2) {
-}
+function stats_stat_independent_t(array $arr1, array $arr2) {}
/**
* Returns the inner product of arr1 and arr2, or FALSE on failure.
@@ -738,8 +675,7 @@ function stats_stat_independent_t (array $arr1, array $arr2) {
* @param array $arr2
* @return float|false
*/
-function stats_stat_innerproduct (array $arr1, array $arr2) {
-}
+function stats_stat_innerproduct(array $arr1, array $arr2) {}
/**
* Returns the t-value, or FALSE if failure.
@@ -749,8 +685,7 @@ function stats_stat_innerproduct (array $arr1, array $arr2) {
* @param array $arr2
* @return float|false
*/
-function stats_stat_paired_t (array $arr1, array $arr2) {
-}
+function stats_stat_paired_t(array $arr1, array $arr2) {}
/**
* Returns the percentile values of the input array.
@@ -760,8 +695,7 @@ function stats_stat_paired_t (array $arr1, array $arr2) {
* @param float $perc
* @return float
*/
-function stats_stat_percentile (array $array, float $perc): float {
-}
+function stats_stat_percentile(array $array, float $perc): float {}
/**
* Returns the power sum of the input array.
@@ -771,8 +705,7 @@ function stats_stat_percentile (array $array, float $perc): float {
* @param float $power
* @return float
*/
-function stats_stat_powersum (array $array, float $power): float {
-}
+function stats_stat_powersum(array $array, float $power): float {}
/**
* Returns the variance on success; FALSE on failure.
@@ -782,5 +715,4 @@ function stats_stat_powersum (array $array, float $power): float {
* @param bool $sample
* @return float|false
*/
-function stats_variance (array $a, bool $sample = false) {
-}
+function stats_variance(array $a, bool $sample = false) {}
diff --git a/stomp/stomp.php b/stomp/stomp.php
index 4631673bd..303c85b00 100644
--- a/stomp/stomp.php
+++ b/stomp/stomp.php
@@ -3,10 +3,8 @@
* Stubs for stomp
* https://pecl.php.net/package/stomp
*/
-
class Stomp
{
-
/**
* Connect to server
*
@@ -15,7 +13,7 @@ class Stomp
* @param string $password The password
* @param array $headers additional headers (example: receipt).
*/
- public function __construct($broker = null, $username = null, $password = null, array $headers = array()) {}
+ public function __construct($broker = null, $username = null, $password = null, array $headers = []) {}
/**
* Get the current stomp session ID
@@ -27,7 +25,7 @@ public function getSessionId() {}
/**
* Close stomp connection
*
- * @return boolean TRUE on success, or FALSE on failure
+ * @return bool TRUE on success, or FALSE on failure
*/
public function disconnect() {}
@@ -37,32 +35,32 @@ public function disconnect() {}
* @param string $destination indicates where to send the message
* @param string|StompFrame $msg message to be sent
* @param array $headers additional headers (example: receipt).
- * @return boolean TRUE on success, or FALSE on failure
+ * @return bool TRUE on success, or FALSE on failure
*/
- public function send($destination, $msg, array $headers = array()) {}
+ public function send($destination, $msg, array $headers = []) {}
/**
* Register to listen to a given destination
*
* @param string $destination indicates which destination to subscribe to
* @param array $headers additional headers (example: receipt).
- * @return boolean TRUE on success, or FALSE on failure
+ * @return bool TRUE on success, or FALSE on failure
*/
- public function subscribe($destination, array $headers = array()) {}
+ public function subscribe($destination, array $headers = []) {}
/**
* Remove an existing subscription
*
* @param string $destination indicates which subscription to remove
* @param array $headers additional headers (example: receipt).
- * @return boolean TRUE on success, or FALSE on failure
+ * @return bool TRUE on success, or FALSE on failure
*/
- public function unsubscribe($destination, array $headers = array()) {}
+ public function unsubscribe($destination, array $headers = []) {}
/**
* Indicate whether or not there is a frame ready to read
*
- * @return boolean TRUE if there is one, or FALSE otherwise
+ * @return bool TRUE if there is one, or FALSE otherwise
*/
public function hasFrame() {}
@@ -78,7 +76,7 @@ public function readFrame($className = 'stompFrame') {}
* Start a transaction
*
* @param string $transaction_id transaction id
- * @return boolean TRUE on success, or FALSE on failure
+ * @return bool TRUE on success, or FALSE on failure
*/
public function begin($transaction_id) {}
@@ -86,7 +84,7 @@ public function begin($transaction_id) {}
* Commit a transaction in progress
*
* @param string $transaction_id transaction id
- * @return boolean TRUE on success, or FALSE on failure
+ * @return bool TRUE on success, or FALSE on failure
*/
public function commit($transaction_id) {}
@@ -94,7 +92,7 @@ public function commit($transaction_id) {}
* Roll back a transaction in progress
*
* @param string $transaction_id transaction id
- * @return boolean TRUE on success, or FALSE on failure
+ * @return bool TRUE on success, or FALSE on failure
*/
public function abort($transaction_id) {}
@@ -103,9 +101,9 @@ public function abort($transaction_id) {}
*
* @param string|StompFrame $msg message/messageId to be acknowledged
* @param array $headers additional headers (example: receipt).
- * @return boolean TRUE on success, or FALSE on failure
+ * @return bool TRUE on success, or FALSE on failure
*/
- public function ack($msg, array $headers = array()) {}
+ public function ack($msg, array $headers = []) {}
/**
* Get the last stomp error
@@ -129,12 +127,10 @@ public function setTimeout($seconds, $microseconds = 0) {}
* @return array Array with timeout informations
*/
public function getTimeout() {}
-
}
class StompFrame
{
-
/**
* Frame Command
* @var string
@@ -156,7 +152,6 @@ class StompFrame
class StompException extends Exception
{
-
/**
* Get the stomp server error details
*
@@ -181,7 +176,7 @@ function stomp_version() {}
* @param array $headers additional headers (example: receipt).
* @return resource|false stomp connection identifier on success, or FALSE on failure
*/
-function stomp_connect($broker = null, $username = null, $password = null, array $headers = array()) {}
+function stomp_connect($broker = null, $username = null, $password = null, array $headers = []) {}
/**
* Gets the current stomp session ID
@@ -195,7 +190,7 @@ function stomp_get_session_id($link) {}
* Closes stomp connection
*
* @param resource $link identifier returned by stomp_connect
- * @return boolean TRUE on success, or FALSE on failure
+ * @return bool TRUE on success, or FALSE on failure
*/
function stomp_close($link) {}
@@ -206,9 +201,9 @@ function stomp_close($link) {}
* @param string $destination indicates where to send the message
* @param string|StompFrame $msg message to be sent
* @param array $headers additional headers (example: receipt).
- * @return boolean TRUE on success, or FALSE on failure
+ * @return bool TRUE on success, or FALSE on failure
*/
-function stomp_send($link, $destination, $msg, array $headers = array()) {}
+function stomp_send($link, $destination, $msg, array $headers = []) {}
/**
* Registers to listen to a given destination
@@ -216,9 +211,9 @@ function stomp_send($link, $destination, $msg, array $headers = array()) {}
* @param resource $link identifier returned by stomp_connect
* @param string $destination indicates which destination to subscribe to
* @param array $headers additional headers (example: receipt).
- * @return boolean TRUE on success, or FALSE on failure
+ * @return bool TRUE on success, or FALSE on failure
*/
-function stomp_subscribe($link, $destination, array $headers = array()) {}
+function stomp_subscribe($link, $destination, array $headers = []) {}
/**
* Removes an existing subscription
@@ -226,15 +221,15 @@ function stomp_subscribe($link, $destination, array $headers = array()) {}
* @param resource $link identifier returned by stomp_connect
* @param string $destination indicates which subscription to remove
* @param array $headers additional headers (example: receipt).
- * @return boolean TRUE on success, or FALSE on failure
+ * @return bool TRUE on success, or FALSE on failure
*/
-function stomp_unsubscribe($link, $destination, array $headers = array()) {}
+function stomp_unsubscribe($link, $destination, array $headers = []) {}
/**
* Indicates whether or not there is a frame ready to read
*
* @param resource $link identifier returned by stomp_connect
- * @return boolean TRUE if there is one, or FALSE otherwise
+ * @return bool TRUE if there is one, or FALSE otherwise
*/
function stomp_has_frame($link) {}
@@ -251,7 +246,7 @@ function stomp_read_frame($link) {}
*
* @param resource $link identifier returned by stomp_connect
* @param string $transaction_id transaction id
- * @return boolean TRUE on success, or FALSE on failure
+ * @return bool TRUE on success, or FALSE on failure
*/
function stomp_begin($link, $transaction_id) {}
@@ -260,7 +255,7 @@ function stomp_begin($link, $transaction_id) {}
*
* @param resource $link identifier returned by stomp_connect
* @param string $transaction_id transaction id
- * @return boolean TRUE on success, or FALSE on failure
+ * @return bool TRUE on success, or FALSE on failure
*/
function stomp_commit($link, $transaction_id) {}
@@ -269,7 +264,7 @@ function stomp_commit($link, $transaction_id) {}
*
* @param resource $link identifier returned by stomp_connect
* @param string $transaction_id transaction id
- * @return boolean TRUE on success, or FALSE on failure
+ * @return bool TRUE on success, or FALSE on failure
*/
function stomp_abort($link, $transaction_id) {}
@@ -279,9 +274,9 @@ function stomp_abort($link, $transaction_id) {}
* @param resource $link identifier returned by stomp_connect
* @param string|StompFrame $msg message/messageId to be acknowledged
* @param array $headers additional headers (example: receipt).
- * @return boolean TRUE on success, or FALSE on failure
+ * @return bool TRUE on success, or FALSE on failure
*/
-function stomp_ack($link, $msg, array $headers = array()) {}
+function stomp_ack($link, $msg, array $headers = []) {}
/**
* Gets the last stomp error
diff --git a/suhosin/suhosin.php b/suhosin/suhosin.php
index 57e933a58..d72dddf21 100644
--- a/suhosin/suhosin.php
+++ b/suhosin/suhosin.php
@@ -13,11 +13,11 @@
*
* @return string|false the encrypted string or false on failure.
*/
-function suhosin_encrypt_cookie ($name, $value) {}
+function suhosin_encrypt_cookie($name, $value) {}
/**
* Returns an array containing the raw cookie values
* @link https://php.net/manual/en/function.suhosin-get-raw-cookies.php
* @return array an array containing the raw cookie values.
*/
-function suhosin_get_raw_cookies () {}
+function suhosin_get_raw_cookies() {}
diff --git a/superglobals/_superglobals.php b/superglobals/_superglobals.php
index 470ee6949..111335728 100644
--- a/superglobals/_superglobals.php
+++ b/superglobals/_superglobals.php
@@ -7,7 +7,7 @@
*
* https://secure.php.net/manual/en/reserved.variables.php
*/
-$GLOBALS = array();
+$GLOBALS = [];
/**
* @xglobal $_COOKIE array
@@ -17,7 +17,7 @@
*
* https://secure.php.net/manual/en/reserved.variables.php
*/
-$_COOKIE = array();
+$_COOKIE = [];
/**
* @xglobal $_ENV array
@@ -29,11 +29,11 @@
*
* https://secure.php.net/manual/en/reserved.variables.php
*/
-$_ENV = array();
+$_ENV = [];
/**
* @deprecated 4.1
*/
-$HTTP_ENV_VARS = array();
+$HTTP_ENV_VARS = [];
/**
* @xglobal $_FILES array
@@ -46,12 +46,11 @@
*
* https://secure.php.net/manual/en/reserved.variables.php
*/
-$_FILES = array();
+$_FILES = [];
/**
* @deprecated 4.1
*/
-$HTTP_POST_FILES = array();
-
+$HTTP_POST_FILES = [];
/**
* @xglobal $_GET array
@@ -63,11 +62,11 @@
*
* https://secure.php.net/manual/en/reserved.variables.php
*/
-$_GET = array();
+$_GET = [];
/**
* @deprecated 4.1
*/
-$HTTP_GET_VARS = array();
+$HTTP_GET_VARS = [];
/**
* @xglobal $_POST array
@@ -80,11 +79,11 @@
*
* https://secure.php.net/manual/en/reserved.variables.php
*/
-$_POST = array();
+$_POST = [];
/**
* @deprecated 4.1
*/
-$HTTP_POST_VARS = array();
+$HTTP_POST_VARS = [];
/**
* @xglobal $_REQUEST array
@@ -104,7 +103,7 @@
*
* https://secure.php.net/manual/en/reserved.variables.php
*/
-$_REQUEST = array();
+$_REQUEST = [];
/**
* @xglobal $_SERVER array
@@ -116,11 +115,11 @@
*
* https://secure.php.net/manual/en/reserved.variables.php
*/
-$_SERVER = array();
+$_SERVER = [];
/**
* @deprecated 4.1
*/
-$HTTP_SERVER_VARS = array();
+$HTTP_SERVER_VARS = [];
$_SERVER['PHP_SELF'] = '';
$_SERVER['argv'] = '';
@@ -171,11 +170,11 @@
*
* https://secure.php.net/manual/en/reserved.variables.php
*/
-$_SESSION = array();
+$_SESSION = [];
/**
* @deprecated 4.1
*/
-$HTTP_SESSION_VARS = array();
+$HTTP_SESSION_VARS = [];
/**
* @xglobal $argc int
@@ -195,7 +194,7 @@
*
* https://secure.php.net/manual/en/reserved.variables.php
*/
-$argv = array();
+$argv = [];
/**
* @xglobal $HTTP_RAW_POST_DATA string
@@ -217,7 +216,7 @@
*
* https://secure.php.net/manual/en/reserved.variables.php
*/
-$http_response_header = array();
+$http_response_header = [];
/**
* @xglobal $php_errormsg string
diff --git a/svm/SVM.php b/svm/SVM.php
index 9b5f61d77..3cf5d2bf9 100644
--- a/svm/SVM.php
+++ b/svm/SVM.php
@@ -6,98 +6,99 @@
* @since 7.0
* @link https://www.php.net/manual/en/class.svm.php
*/
-class SVM {
- /* Constants */
+class SVM
+{
+ /* Constants */
/**
* @const The basic C_SVC SVM type. The default, and a good starting point
*/
- const C_SVC = 0;
+ public const C_SVC = 0;
/**
* @const NU_SVC type uses a different, more flexible, error weighting
*/
- const NU_SVC = 1;
+ public const NU_SVC = 1;
/**
* @const One class SVM type. Train just on a single class, using outliers as negative examples
*/
- const ONE_CLASS = 2;
+ public const ONE_CLASS = 2;
/**
* @const A SVM type for regression (predicting a value rather than just a class)
*/
- const EPSILON_SVR = 3;
+ public const EPSILON_SVR = 3;
/**
* @const A NU style SVM regression type
*/
- const NU_SVR = 4;
+ public const NU_SVR = 4;
/**
* @const A very simple kernel, can work well on large document classification problems
*/
- const KERNEL_LINEAR = 0;
+ public const KERNEL_LINEAR = 0;
/**
* @const A polynomial kernel
*/
- const KERNEL_POLY = 1;
+ public const KERNEL_POLY = 1;
/**
* @const The common Gaussian RBD kernel. Handles non-linear problems well and is a good default for classification
*/
- const KERNEL_RBF = 2;
+ public const KERNEL_RBF = 2;
/**
* @const A kernel based on the sigmoid function. Using this makes the SVM very similar to a two layer sigmoid based neural network
*/
- const KERNEL_SIGMOID = 3;
+ public const KERNEL_SIGMOID = 3;
/**
* @const A precomputed kernel - currently unsupported.
*/
- const KERNEL_PRECOMPUTED = 4;
+ public const KERNEL_PRECOMPUTED = 4;
/**
* @const The options key for the SVM type
*/
- const OPT_TYPE = 101;
+ public const OPT_TYPE = 101;
/**
* @const The options key for the kernel type
*/
- const OPT_KERNEL_TYPE = 102;
+ public const OPT_KERNEL_TYPE = 102;
/**
* @const OPT_DEGREE
*/
- const OPT_DEGREE = 103;
+ public const OPT_DEGREE = 103;
/**
* @const Training parameter, boolean, for whether to use the shrinking heuristics
*/
- const OPT_SHRINKING = 104;
+ public const OPT_SHRINKING = 104;
/**
* @const Training parameter, boolean, for whether to collect and use probability estimates
*/
- const OPT_PROPABILITY = 105;
+ public const OPT_PROPABILITY = 105;
/**
* @const Algorithm parameter for Poly, RBF and Sigmoid kernel types.
*/
- const OPT_GAMMA = 201;
+ public const OPT_GAMMA = 201;
/**
* @const The option key for the nu parameter, only used in the NU_ SVM types
*/
- const OPT_NU = 202;
+ public const OPT_NU = 202;
/**
* @const The option key for the Epsilon parameter, used in epsilon regression
*/
- const OPT_EPS = 203;
+ public const OPT_EPS = 203;
/**
* @const Training parameter used by Episilon SVR regression
*/
- const OPT_P = 204;
+ public const OPT_P = 204;
/**
* @const Algorithm parameter for poly and sigmoid kernels
*/
- const OPT_COEF_ZERO = 205;
+ public const OPT_COEF_ZERO = 205;
/**
* @const The option for the cost parameter that controls tradeoff between errors and generality - effectively the penalty for misclassifying training examples.
*/
- const OPT_C = 206;
+ public const OPT_C = 206;
/**
* @const Memory cache size, in MB
*/
- const OPT_CACHE_SIZE = 207;
+ public const OPT_CACHE_SIZE = 207;
- /* Methods */
+ /* Methods */
/**
* Construct a new SVM object
*
@@ -105,7 +106,7 @@ class SVM {
* @throws SVMException Throws SVMException if the libsvm library could not be loaded
* @link https://www.php.net/manual/en/svm.construct.php
*/
- public function __construct () {}
+ public function __construct() {}
/**
* Test training params on subsets of the training data
@@ -116,7 +117,7 @@ public function __construct () {}
* @return float The correct percentage, expressed as a floating point number from 0-1. In the case of NU_SVC or EPSILON_SVR kernels the mean squared error will returned instead.
* @link https://www.php.net/manual/en/svm.crossvalidate.php
*/
- public function crossvalidate ( array $problem , int $number_of_folds ) : float {}
+ public function crossvalidate(array $problem, int $number_of_folds): float {}
/**
* Return the current training parameters
@@ -125,7 +126,7 @@ public function crossvalidate ( array $problem , int $number_of_folds ) : float
* @return array Returns an array of configuration settings.
* @link https://www.php.net/manual/en/svm.getoptions.php
*/
- public function getOptions () : array {}
+ public function getOptions(): array {}
/**
* Set training parameters
@@ -136,7 +137,7 @@ public function getOptions () : array {}
* @throws SVMException
* @link https://www.php.net/manual/en/svm.setoptions.php
*/
- public function setOptions ( array $params ) : bool {}
+ public function setOptions(array $params): bool {}
/**
* Create a SVMModel based on training data
@@ -148,5 +149,5 @@ public function setOptions ( array $params ) : bool {}
* @throws SMVException
* @link https://www.php.net/manual/en/svm.train.php
*/
- public function train ( array $problem, array $weights = null ) : SVMModel {}
+ public function train(array $problem, array $weights = null): SVMModel {}
}
diff --git a/svm/SVMModel.php b/svm/SVMModel.php
index 910dcc7e2..27baa6e8d 100644
--- a/svm/SVMModel.php
+++ b/svm/SVMModel.php
@@ -5,90 +5,91 @@
* @since 7.0
* @link https://www.php.net/manual/en/class.svmmodel.php
*/
-class SVMModel {
- /* Methods */
+class SVMModel
+{
+ /* Methods */
/**
* Returns true if the model has probability information
*
* @return bool Return a boolean value
* @link https://www.php.net/manual/en/svmmodel.checkprobabilitymodel.php
*/
- public function checkProbabilityModel () : bool {}
- /**
- * Construct a new SVMModel
- *
- * Build a new SVMModel. Models will usually be created from the SVM::train function, but then saved models may be restored directly.
- * @param string $filename The filename for the saved model file this model should load.
- * @throws Throws SVMException on error
- * @link https://www.php.net/manual/en/svmmodel.construct.php
- */
- public function __construct ( string $filename = '' ) {}
- /**
- * Get the labels the model was trained on
+ public function checkProbabilityModel(): bool {}
+ /**
+ * Construct a new SVMModel
+ *
+ * Build a new SVMModel. Models will usually be created from the SVM::train function, but then saved models may be restored directly.
+ * @param string $filename The filename for the saved model file this model should load.
+ * @throws Throws SVMException on error
+ * @link https://www.php.net/manual/en/svmmodel.construct.php
+ */
+ public function __construct(string $filename = '') {}
+ /**
+ * Get the labels the model was trained on
*
* Return an array of labels that the model was trained on. For regression and one class models an empty array is returned.
- * @return array Return an array of labels
- * @link https://www.php.net/manual/en/svmmodel.getlabels.php
+ * @return array Return an array of labels
+ * @link https://www.php.net/manual/en/svmmodel.getlabels.php
*/
- public function getLabels () : array {}
- /**
- * Returns the number of classes the model was trained with
+ public function getLabels(): array {}
+ /**
+ * Returns the number of classes the model was trained with
*
* Returns the number of classes the model was trained with, will return 2 for one class and regression models.
- * @return int Return an integer number of classes
- * @link https://www.php.net/manual/en/svmmodel.getnrclass.php
- */
- public function getNrClass () : int {}
- /**
- * Get the SVM type the model was trained with
+ * @return int Return an integer number of classes
+ * @link https://www.php.net/manual/en/svmmodel.getnrclass.php
+ */
+ public function getNrClass(): int {}
+ /**
+ * Get the SVM type the model was trained with
*
* Returns an integer value representing the type of the SVM model used, e.g SVM::C_SVC.
- * @return int Return an integer SVM type
- * @link https://www.php.net/manual/en/svmmodel.getsvmtype.php
+ * @return int Return an integer SVM type
+ * @link https://www.php.net/manual/en/svmmodel.getsvmtype.php
*/
- public function getSvmType () : int {}
- /**
- * Get the sigma value for regression types
+ public function getSvmType(): int {}
+ /**
+ * Get the sigma value for regression types
*
* For regression models, returns a sigma value. If there is no probability information or the model is not SVR, 0 is returned.
- * @return float Returns a sigma value
- * @link https://www.php.net/manual/en/svmmodel.getsvrprobability.php
+ * @return float Returns a sigma value
+ * @link https://www.php.net/manual/en/svmmodel.getsvrprobability.php
+ */
+ public function getSvrProbability(): float {}
+ /**
+ * Load a saved SVM Model
+ * @param string $filename The filename of the model.
+ * @return bool Returns true on success.
+ * @throws SVMException
+ * @link https://www.php.net/manual/en/svmmodel.load.php
+ */
+ public function load(string $filename): bool {}
+ /**
+ * Return class probabilities for previous unseen data
+ *
+ * This function accepts an array of data and attempts to predict the class, as with the predict function. Additionally, however, this function returns an array of probabilities, one per class in the model, which represent the estimated chance of the data supplied being a member of that class. Requires that the model to be used has been trained with the probability parameter set to true.
+ * @param array $data The array to be classified. This should be a series of key => value pairs in increasing key order, but not necessarily continuous.
+ * @return float the predicted value. This will be a class label in the case of classification, a real value in the case of regression. Throws SVMException on error
+ * @throws SVMException Throws SVMException on error
+ * @link https://www.php.net/manual/en/svmmodel.predict-probability.php
+ */
+ public function predict_probability(array $data): float {}
+ /**
+ * Predict a value for previously unseen data
+ *
+ * This function accepts an array of data and attempts to predict the class or regression value based on the model extracted from previously trained data.
+ * @param array $data The array to be classified. This should be a series of key => value pairs in increasing key order, but not necessarily continuous.
+ * @return float the predicted value. This will be a class label in the case of classification, a real value in the case of regression. Throws SVMException on error
+ * @throws SVMException Throws SVMException on error
+ * @link https://www.php.net/manual/en/svmmodel.predict.php
+ */
+ public function predict(array $data): float {}
+ /**
+ * Save a model to a file, for later use
+ * @param string $filename The file to save the model to.
+ * @return bool Throws SVMException on error. Returns true on success.
+ * @throws SVMException Throws SVMException on error
+ * @link https://www.php.net/manual/en/svmmodel.save.php
*/
- public function getSvrProbability () : float {}
- /**
- * Load a saved SVM Model
- * @param string $filename The filename of the model.
- * @return bool Returns true on success.
- * @throws SVMException
- * @link https://www.php.net/manual/en/svmmodel.load.php
- */
- public function load ( string $filename ) : bool {}
- /**
- * Return class probabilities for previous unseen data
- *
- * This function accepts an array of data and attempts to predict the class, as with the predict function. Additionally, however, this function returns an array of probabilities, one per class in the model, which represent the estimated chance of the data supplied being a member of that class. Requires that the model to be used has been trained with the probability parameter set to true.
- * @param array $data The array to be classified. This should be a series of key => value pairs in increasing key order, but not necessarily continuous.
- * @return Float the predicted value. This will be a class label in the case of classification, a real value in the case of regression. Throws SVMException on error
- * @throws SVMException Throws SVMException on error
- * @link https://www.php.net/manual/en/svmmodel.predict-probability.php
- */
- public function predict_probability ( array $data ) : float {}
- /**
- * Predict a value for previously unseen data
- *
- * This function accepts an array of data and attempts to predict the class or regression value based on the model extracted from previously trained data.
- * @param array $data The array to be classified. This should be a series of key => value pairs in increasing key order, but not necessarily continuous.
- * @return Float the predicted value. This will be a class label in the case of classification, a real value in the case of regression. Throws SVMException on error
- * @throws SVMException Throws SVMException on error
- * @link https://www.php.net/manual/en/svmmodel.predict.php
- */
- public function predict ( array $data ) : float {}
- /**
- * Save a model to a file, for later use
- * @param string $filename The file to save the model to.
- * @return bool Throws SVMException on error. Returns true on success.
- * @throws SVMException Throws SVMException on error
- * @link https://www.php.net/manual/en/svmmodel.save.php
- */
- public function save ( string $filename ) : bool {}
+ public function save(string $filename): bool {}
}
diff --git a/svn/svn.php b/svn/svn.php
index 5316bd777..7f858005d 100644
--- a/svn/svn.php
+++ b/svn/svn.php
@@ -2,22 +2,22 @@
// Start of svn v.1.0.1
-class Svn {
- const NON_RECURSIVE = 1;
- const DISCOVER_CHANGED_PATHS = 2;
- const OMIT_MESSAGES = 4;
- const STOP_ON_COPY = 8;
- const ALL = 16;
- const SHOW_UPDATES = 32;
- const NO_IGNORE = 64;
- const IGNORE_EXTERNALS = 128;
- const INITIAL = 1;
- const HEAD = -1;
- const BASE = -2;
- const COMMITTED = -3;
- const PREV = -4;
- const UNSPECIFIED = -5;
-
+class Svn
+{
+ public const NON_RECURSIVE = 1;
+ public const DISCOVER_CHANGED_PATHS = 2;
+ public const OMIT_MESSAGES = 4;
+ public const STOP_ON_COPY = 8;
+ public const ALL = 16;
+ public const SHOW_UPDATES = 32;
+ public const NO_IGNORE = 64;
+ public const IGNORE_EXTERNALS = 128;
+ public const INITIAL = 1;
+ public const HEAD = -1;
+ public const BASE = -2;
+ public const COMMITTED = -3;
+ public const PREV = -4;
+ public const UNSPECIFIED = -5;
public static function checkout() {}
public static function cat() {}
@@ -61,41 +61,40 @@ public static function repos_open() {}
public static function repos_fs() {}
public static function repos_fs_begin_txn_for_commit() {}
public static function repos_fs_commit_txn() {}
-
}
-class SvnWc {
- const NONE = 1;
- const UNVERSIONED = 2;
- const NORMAL = 3;
- const ADDED = 4;
- const MISSING = 5;
- const DELETED = 6;
- const REPLACED = 7;
- const MODIFIED = 8;
- const MERGED = 9;
- const CONFLICTED = 10;
- const IGNORED = 11;
- const OBSTRUCTED = 12;
- const EXTERNAL = 13;
- const INCOMPLETE = 14;
-
+class SvnWc
+{
+ public const NONE = 1;
+ public const UNVERSIONED = 2;
+ public const NORMAL = 3;
+ public const ADDED = 4;
+ public const MISSING = 5;
+ public const DELETED = 6;
+ public const REPLACED = 7;
+ public const MODIFIED = 8;
+ public const MERGED = 9;
+ public const CONFLICTED = 10;
+ public const IGNORED = 11;
+ public const OBSTRUCTED = 12;
+ public const EXTERNAL = 13;
+ public const INCOMPLETE = 14;
}
-class SvnWcSchedule {
- const NORMAL = 0;
- const ADD = 1;
- const DELETE = 2;
- const REPLACE = 3;
-
+class SvnWcSchedule
+{
+ public const NORMAL = 0;
+ public const ADD = 1;
+ public const DELETE = 2;
+ public const REPLACE = 3;
}
-class SvnNode {
- const NONE = 0;
- const FILE = 1;
- const DIR = 2;
- const UNKNOWN = 3;
-
+class SvnNode
+{
+ public const NONE = 0;
+ public const FILE = 1;
+ public const DIR = 2;
+ public const UNKNOWN = 3;
}
/**
@@ -119,7 +118,7 @@ class SvnNode {
*
* @return bool TRUE on success or FALSE on failure.
*/
-function svn_checkout ($repos, $targetpath, $revision = SVN_REVISION_HEAD, $flags = 0) {}
+function svn_checkout($repos, $targetpath, $revision = SVN_REVISION_HEAD, $flags = 0) {}
/**
* (PECL svn >= 0.1.0)
@@ -135,7 +134,7 @@ function svn_checkout ($repos, $targetpath, $revision = SVN_REVISION_HEAD, $flag
* @return string the string contents of the item from the repository on
* success, and FALSE on failure.
*/
-function svn_cat ($repos_url, $revision_no = SVN_REVISION_HEAD) {}
+function svn_cat($repos_url, $revision_no = SVN_REVISION_HEAD) {}
/**
* (PECL svn >= 0.1.0)
@@ -164,7 +163,7 @@ function svn_cat ($repos_url, $revision_no = SVN_REVISION_HEAD) {}
* [1] => ...
*
*/
-function svn_ls ($repos_url, $revision_no = SVN_REVISION_HEAD, $recurse = false, $peg = false) {}
+function svn_ls($repos_url, $revision_no = SVN_REVISION_HEAD, $recurse = false, $peg = false) {}
/**
* (PECL svn >= 0.1.0)
* If no changes were made to the item, an empty array is returned.
*/
-function svn_log ($repos_url, $start_revision = null, $end_revision = null, $limit = 0, $flags = SVN_DISCOVER_CHANGED_PATHS | SVN_STOP_ON_COPY) {}
+function svn_log($repos_url, $start_revision = null, $end_revision = null, $limit = 0, $flags = SVN_DISCOVER_CHANGED_PATHS|SVN_STOP_ON_COPY) {}
/**
* (PECL svn >= 0.1.0)
@@ -264,7 +263,7 @@ function svn_log ($repos_url, $start_revision = null, $end_revision = null, $lim
*
- * You will find a list with each configuration option and their types - * at: http://tidy.sourceforge.net/docs/quickref.html. - *
- * @return mixed the value of the specified option. - * The return type depends on the type of the specified one. - */ - public function getOpt ($option) {} - - /** - * (PHP 5, PECL tidy >= 0.5.2)- * If the filename parameter is given, this function - * will also read that file and initialize the object with the file, - * acting like tidy_parse_file. - *
- * @param mixed $config [optional]- * The config config can be passed either as an - * array or as a string. If a string is passed, it is interpreted as the - * name of the configuration file, otherwise, it is interpreted as the - * options themselves. - *
- *- * For an explanation about each option, see - * http://tidy.sourceforge.net/docs/quickref.html. - *
- * @param string|null $encoding [optional]- * The encoding parameter sets the encoding for - * input/output documents. The possible values for encoding are: - * ascii, latin0, latin1, - * raw, utf8, iso2022, - * mac, win1252, ibm858, - * utf16, utf16le, utf16be, - * big5, and shiftjis. - *
- * @param bool $use_include_path [optional]- * Search for the file in the include_path. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function parseFile ($filename, $config = null, $encoding = null, $use_include_path = false) {} - - /** - * (PHP 5, PECL tidy >= 0.5.2)- * The data to be parsed. - *
- * @param mixed $config [optional]- * The config config can be passed either as an - * array or as a string. If a string is passed, it is interpreted as the - * name of the configuration file, otherwise, it is interpreted as the - * options themselves. - *
- *- * For an explanation about each option, visit http://tidy.sourceforge.net/docs/quickref.html. - *
- * @param string|null $encoding [optional]- * The encoding parameter sets the encoding for - * input/output documents. The possible values for encoding are: - * ascii, latin0, latin1, - * raw, utf8, iso2022, - * mac, win1252, ibm858, - * utf16, utf16le, utf16be, - * big5, and shiftjis. - *
- * @return bool a new tidy instance. - */ - public function parseString ($input, $config = null, $encoding = null) {} - - /** - * (PHP 5, PECL tidy >= 0.7.0)- * The data to be repaired. - *
- * @param mixed $config [optional]- * The config config can be passed either as an - * array or as a string. If a string is passed, it is interpreted as the - * name of the configuration file, otherwise, it is interpreted as the - * options themselves. - *
- *- * Check http://tidy.sourceforge.net/docs/quickref.html for - * an explanation about each option. - *
- * @param string|null $encoding [optional]- * The encoding parameter sets the encoding for - * input/output documents. The possible values for encoding are: - * ascii, latin0, latin1, - * raw, utf8, iso2022, - * mac, win1252, ibm858, - * utf16, utf16le, utf16be, - * big5, and shiftjis. - *
- * @return string the repaired string. - */ - public function repairString ($data, $config = null, $encoding = null) {} - - /** - * (PHP 5, PECL tidy >= 0.7.0)- * The file to be repaired. - *
- * @param mixed $config [optional]- * The config config can be passed either as an - * array or as a string. If a string is passed, it is interpreted as the - * name of the configuration file, otherwise, it is interpreted as the - * options themselves. - *
- *- * Check http://tidy.sourceforge.net/docs/quickref.html for an - * explanation about each option. - *
- * @param string|null $encoding [optional]- * The encoding parameter sets the encoding for - * input/output documents. The possible values for encoding are: - * ascii, latin0, latin1, - * raw, utf8, iso2022, - * mac, win1252, ibm858, - * utf16, utf16le, utf16be, - * big5, and shiftjis. - *
- * @param bool $use_include_path [optional]- * Search for the file in the include_path. - *
- * @return string the repaired contents as a string. - */ - public function repairFile ($filename, $config = null, $encoding = null, $use_include_path = false) {} - - /** - * (PHP 5, PECL tidy >= 0.5.2)
- * For an explanation about each option, visit http://tidy.sourceforge.net/docs/quickref.html.
- */
- public function getConfig () {}
-
- /**
- * (PHP 5, PECL tidy >= 0.5.2)
- * Get status of specified document
- * @link https://php.net/manual/en/tidy.getstatus.php
- * @return int 0 if no error/warning was raised, 1 for warnings or accessibility
- * errors, or 2 for errors.
- */
- public function getStatus () {}
-
- /**
- * (PHP 5, PECL tidy >= 0.5.2)
- * Get the Detected HTML version for the specified document
- * @link https://php.net/manual/en/tidy.gethtmlver.php
- * @return int the detected HTML version.
- *
- * This function is not yet implemented in the Tidylib itself, so it always - * return 0. - */ - public function getHtmlVer () {} - - /** - * Returns the documentation for the given option name - * @link https://php.net/manual/en/tidy.getoptdoc.php - * @param string $optname
- * The option name - *
- * @return string a string if the option exists and has documentation available, or - * FALSE otherwise. - */ - public function getOptDoc ($optname) {} - - /** - * (PHP 5, PECL tidy >= 0.5.2)
- * This function is not yet implemented in the Tidylib itself, so it always
- * return FALSE.
- */
- public function isXhtml () {}
-
- /**
- * (PHP 5, PECL tidy >= 0.5.2)
- * Indicates if the document is a generic (non HTML/XHTML) XML document
- * @link https://php.net/manual/en/tidy.isxml.php
- * @return bool This function returns TRUE if the specified tidy
- * object 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.
- */
- public function isXml () {}
-
- /**
- * (PHP 5, PECL tidy 0.5.2-1.0.0)
- * Returns a tidyNode object representing the root of the tidy parse tree
- * @link https://php.net/manual/en/tidy.root.php
- * @return tidyNode the tidyNode object.
- */
- public function root () {}
-
- /**
- * (PHP 5, PECL tidy 0.5.2-1.0.0)
- * Returns a tidyNode object starting from the <head> tag of the tidy parse tree
- * @link https://php.net/manual/en/tidy.head.php
- * @return tidyNode the tidyNode object.
- */
- public function head () {}
-
- /**
- * (PHP 5, PECL tidy 0.5.2-1.0.0)
- * Returns a tidyNode object starting from the <html> tag of the tidy parse tree
- * @link https://php.net/manual/en/tidy.html.php
- * @return tidyNode the tidyNode object.
- */
- public function html () {}
-
- /**
- * (PHP 5, PECL tidy 0.5.2-1.0)
- * Returns a tidyNode object starting from the <body> tag of the tidy parse tree
- * @link https://php.net/manual/en/tidy.body.php
- * @return tidyNode a tidyNode object starting from the
- * <body> tag of the tidy parse tree.
- */
- public function body () {}
-
- /**
- * (PHP 5, PECL tidy >= 0.5.2)
- * Constructs a new tidy object
- * @link https://php.net/manual/en/tidy.construct.php
- * @param string $filename [optional]
- * If the filename parameter is given, this function - * will also read that file and initialize the object with the file, - * acting like tidy_parse_file. - *
- * @param mixed $config [optional]- * The config config can be passed either as an - * array or as a string. If a string is passed, it is interpreted as the - * name of the configuration file, otherwise, it is interpreted as the - * options themselves. - *
- *- * For an explanation about each option, visit http://tidy.sourceforge.net/docs/quickref.html. - *
- * @param string|null $encoding [optional]- * The encoding parameter sets the encoding for - * input/output documents. The possible values for encoding are: - * ascii, latin0, latin1, - * raw, utf8, iso2022, - * mac, win1252, ibm858, - * utf16, utf16le, utf16be, - * big5, and shiftjis. - *
- * @param bool $use_include_path [optional]- * Search for the file in the include_path. - *
- */ - public function __construct ($filename = null, $config = null, $encoding = null, $use_include_path = null) {} - +class tidy +{ + /** + * @var string The last warnings and errors from TidyLib + */ + public $errorBuffer; + + /** + * (PHP 5, PECL tidy >= 0.5.2)+ * You will find a list with each configuration option and their types + * at: http://tidy.sourceforge.net/docs/quickref.html. + *
+ * @return mixed the value of the specified option. + * The return type depends on the type of the specified one. + */ + public function getOpt($option) {} + + /** + * (PHP 5, PECL tidy >= 0.5.2)+ * If the filename parameter is given, this function + * will also read that file and initialize the object with the file, + * acting like tidy_parse_file. + *
+ * @param mixed $config [optional]+ * The config config can be passed either as an + * array or as a string. If a string is passed, it is interpreted as the + * name of the configuration file, otherwise, it is interpreted as the + * options themselves. + *
+ *+ * For an explanation about each option, see + * http://tidy.sourceforge.net/docs/quickref.html. + *
+ * @param string|null $encoding [optional]+ * The encoding parameter sets the encoding for + * input/output documents. The possible values for encoding are: + * ascii, latin0, latin1, + * raw, utf8, iso2022, + * mac, win1252, ibm858, + * utf16, utf16le, utf16be, + * big5, and shiftjis. + *
+ * @param bool $use_include_path [optional]+ * Search for the file in the include_path. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function parseFile($filename, $config = null, $encoding = null, $use_include_path = false) {} + + /** + * (PHP 5, PECL tidy >= 0.5.2)+ * The data to be parsed. + *
+ * @param mixed $config [optional]+ * The config config can be passed either as an + * array or as a string. If a string is passed, it is interpreted as the + * name of the configuration file, otherwise, it is interpreted as the + * options themselves. + *
+ *+ * For an explanation about each option, visit http://tidy.sourceforge.net/docs/quickref.html. + *
+ * @param string|null $encoding [optional]+ * The encoding parameter sets the encoding for + * input/output documents. The possible values for encoding are: + * ascii, latin0, latin1, + * raw, utf8, iso2022, + * mac, win1252, ibm858, + * utf16, utf16le, utf16be, + * big5, and shiftjis. + *
+ * @return bool a new tidy instance. + */ + public function parseString($input, $config = null, $encoding = null) {} + + /** + * (PHP 5, PECL tidy >= 0.7.0)+ * The data to be repaired. + *
+ * @param mixed $config [optional]+ * The config config can be passed either as an + * array or as a string. If a string is passed, it is interpreted as the + * name of the configuration file, otherwise, it is interpreted as the + * options themselves. + *
+ *+ * Check http://tidy.sourceforge.net/docs/quickref.html for + * an explanation about each option. + *
+ * @param string|null $encoding [optional]+ * The encoding parameter sets the encoding for + * input/output documents. The possible values for encoding are: + * ascii, latin0, latin1, + * raw, utf8, iso2022, + * mac, win1252, ibm858, + * utf16, utf16le, utf16be, + * big5, and shiftjis. + *
+ * @return string the repaired string. + */ + public function repairString($data, $config = null, $encoding = null) {} + + /** + * (PHP 5, PECL tidy >= 0.7.0)+ * The file to be repaired. + *
+ * @param mixed $config [optional]+ * The config config can be passed either as an + * array or as a string. If a string is passed, it is interpreted as the + * name of the configuration file, otherwise, it is interpreted as the + * options themselves. + *
+ *+ * Check http://tidy.sourceforge.net/docs/quickref.html for an + * explanation about each option. + *
+ * @param string|null $encoding [optional]+ * The encoding parameter sets the encoding for + * input/output documents. The possible values for encoding are: + * ascii, latin0, latin1, + * raw, utf8, iso2022, + * mac, win1252, ibm858, + * utf16, utf16le, utf16be, + * big5, and shiftjis. + *
+ * @param bool $use_include_path [optional]+ * Search for the file in the include_path. + *
+ * @return string the repaired contents as a string. + */ + public function repairFile($filename, $config = null, $encoding = null, $use_include_path = false) {} + + /** + * (PHP 5, PECL tidy >= 0.5.2)
+ * For an explanation about each option, visit http://tidy.sourceforge.net/docs/quickref.html.
+ */
+ public function getConfig() {}
+
+ /**
+ * (PHP 5, PECL tidy >= 0.5.2)
+ * Get status of specified document
+ * @link https://php.net/manual/en/tidy.getstatus.php
+ * @return int 0 if no error/warning was raised, 1 for warnings or accessibility
+ * errors, or 2 for errors.
+ */
+ public function getStatus() {}
+
+ /**
+ * (PHP 5, PECL tidy >= 0.5.2)
+ * Get the Detected HTML version for the specified document
+ * @link https://php.net/manual/en/tidy.gethtmlver.php
+ * @return int the detected HTML version.
+ *
+ * This function is not yet implemented in the Tidylib itself, so it always + * return 0. + */ + public function getHtmlVer() {} + + /** + * Returns the documentation for the given option name + * @link https://php.net/manual/en/tidy.getoptdoc.php + * @param string $optname
+ * The option name + *
+ * @return string a string if the option exists and has documentation available, or + * FALSE otherwise. + */ + public function getOptDoc($optname) {} + + /** + * (PHP 5, PECL tidy >= 0.5.2)
+ * This function is not yet implemented in the Tidylib itself, so it always
+ * return FALSE.
+ */
+ public function isXhtml() {}
+
+ /**
+ * (PHP 5, PECL tidy >= 0.5.2)
+ * Indicates if the document is a generic (non HTML/XHTML) XML document
+ * @link https://php.net/manual/en/tidy.isxml.php
+ * @return bool This function returns TRUE if the specified tidy
+ * object 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.
+ */
+ public function isXml() {}
+
+ /**
+ * (PHP 5, PECL tidy 0.5.2-1.0.0)
+ * Returns a tidyNode object representing the root of the tidy parse tree
+ * @link https://php.net/manual/en/tidy.root.php
+ * @return tidyNode the tidyNode object.
+ */
+ public function root() {}
+
+ /**
+ * (PHP 5, PECL tidy 0.5.2-1.0.0)
+ * Returns a tidyNode object starting from the <head> tag of the tidy parse tree
+ * @link https://php.net/manual/en/tidy.head.php
+ * @return tidyNode the tidyNode object.
+ */
+ public function head() {}
+
+ /**
+ * (PHP 5, PECL tidy 0.5.2-1.0.0)
+ * Returns a tidyNode object starting from the <html> tag of the tidy parse tree
+ * @link https://php.net/manual/en/tidy.html.php
+ * @return tidyNode the tidyNode object.
+ */
+ public function html() {}
+
+ /**
+ * (PHP 5, PECL tidy 0.5.2-1.0)
+ * Returns a tidyNode object starting from the <body> tag of the tidy parse tree
+ * @link https://php.net/manual/en/tidy.body.php
+ * @return tidyNode a tidyNode object starting from the
+ * <body> tag of the tidy parse tree.
+ */
+ public function body() {}
+
+ /**
+ * (PHP 5, PECL tidy >= 0.5.2)
+ * Constructs a new tidy object
+ * @link https://php.net/manual/en/tidy.construct.php
+ * @param string $filename [optional]
+ * If the filename parameter is given, this function + * will also read that file and initialize the object with the file, + * acting like tidy_parse_file. + *
+ * @param mixed $config [optional]+ * The config config can be passed either as an + * array or as a string. If a string is passed, it is interpreted as the + * name of the configuration file, otherwise, it is interpreted as the + * options themselves. + *
+ *+ * For an explanation about each option, visit http://tidy.sourceforge.net/docs/quickref.html. + *
+ * @param string|null $encoding [optional]+ * The encoding parameter sets the encoding for + * input/output documents. The possible values for encoding are: + * ascii, latin0, latin1, + * raw, utf8, iso2022, + * mac, win1252, ibm858, + * utf16, utf16le, utf16be, + * big5, and shiftjis. + *
+ * @param bool $use_include_path [optional]+ * Search for the file in the include_path. + *
+ */ + public function __construct($filename = null, $config = null, $encoding = null, $use_include_path = null) {} } /** * An HTML node in an HTML file, as detected by tidy. * @link https://php.net/manual/en/class.tidynode.php */ -final class tidyNode { - /** - *The HTML representation of the node, including the surrounding tags.
- * @var string - */ - public $value; - /** - *The name of the HTML node
- * @var string - */ - public $name; - /** - *The type of the tag (one of the constants above, e.g. TIDY_NODETYPE_PHP)
The line number at which the tags is located in the file
- * @var int - */ - public $line; - /** - *The column number at which the tags is located in the file
- * @var int - */ - public $column; - /** - *Indicates if the node is a proprietary tag
- * @var bool - */ - public $proprietary; - /** - *The ID of the tag (one of the constants above, e.g. TIDY_TAG_FRAME)
- * An array of string, representing - * the attributes names (as keys) of the current node. - *
- * @var array - */ - public $attribute; - /** - *- * An array of tidyNode, representing - * the children of the current node. - *
- * @var array - */ - public $child; - - - /** - * Checks if a node has children - * @link https://php.net/manual/en/tidynode.haschildren.php - * @return bool TRUE if the node has children, FALSE otherwise. - * @since 5.0.1 - */ - public function hasChildren () {} - - /** - * Checks if a node has siblings - * @link https://php.net/manual/en/tidynode.hassiblings.php - * @return bool TRUE if the node has siblings, FALSE otherwise. - * @since 5.0.1 - */ - public function hasSiblings () {} - - /** - * Checks if a node represents a comment - * @link https://php.net/manual/en/tidynode.iscomment.php - * @return bool TRUE if the node is a comment, FALSE otherwise. - * @since 5.0.1 - */ - public function isComment () {} - - /** - * Checks if a node is part of a HTML document - * @link https://php.net/manual/en/tidynode.ishtml.php - * @return bool TRUE if the node is part of a HTML document, FALSE otherwise. - * @since 5.0.1 - */ - public function isHtml () {} - - /** - * Checks if a node represents text (no markup) - * @link https://php.net/manual/en/tidynode.istext.php - * @return bool TRUE if the node represent a text, FALSE otherwise. - * @since 5.0.1 - */ - public function isText () {} - - /** - * Checks if this node is JSTE - * @link https://php.net/manual/en/tidynode.isjste.php - * @return bool TRUE if the node is JSTE, FALSE otherwise. - * @since 5.0.1 - */ - public function isJste () {} - - /** - * Checks if this node is ASP - * @link https://php.net/manual/en/tidynode.isasp.php - * @return bool TRUE if the node is ASP, FALSE otherwise. - * @since 5.0.1 - */ - public function isAsp () {} - - /** - * Checks if a node is PHP - * @link https://php.net/manual/en/tidynode.isphp.php - * @return bool TRUE if the current node is PHP code, FALSE otherwise. - * @since 5.0.1 - */ - public function isPhp () {} - - /** - * Returns the parent node of the current node - * @link https://php.net/manual/en/tidynode.getparent.php - * @return tidyNode a tidyNode if the node has a parent, or NULL - * otherwise. - * @since 5.2.2 - */ - public function getParent () {} - - private function __construct () {} - +final class tidyNode +{ + /** + *The HTML representation of the node, including the surrounding tags.
+ * @var string + */ + public $value; + /** + *The name of the HTML node
+ * @var string + */ + public $name; + /** + *The type of the tag (one of the constants above, e.g. TIDY_NODETYPE_PHP)
The line number at which the tags is located in the file
+ * @var int + */ + public $line; + /** + *The column number at which the tags is located in the file
+ * @var int + */ + public $column; + /** + *Indicates if the node is a proprietary tag
+ * @var bool + */ + public $proprietary; + /** + *The ID of the tag (one of the constants above, e.g. TIDY_TAG_FRAME)
+ * An array of string, representing + * the attributes names (as keys) of the current node. + *
+ * @var array + */ + public $attribute; + /** + *+ * An array of tidyNode, representing + * the children of the current node. + *
+ * @var array + */ + public $child; + + /** + * Checks if a node has children + * @link https://php.net/manual/en/tidynode.haschildren.php + * @return bool TRUE if the node has children, FALSE otherwise. + * @since 5.0.1 + */ + public function hasChildren() {} + + /** + * Checks if a node has siblings + * @link https://php.net/manual/en/tidynode.hassiblings.php + * @return bool TRUE if the node has siblings, FALSE otherwise. + * @since 5.0.1 + */ + public function hasSiblings() {} + + /** + * Checks if a node represents a comment + * @link https://php.net/manual/en/tidynode.iscomment.php + * @return bool TRUE if the node is a comment, FALSE otherwise. + * @since 5.0.1 + */ + public function isComment() {} + + /** + * Checks if a node is part of a HTML document + * @link https://php.net/manual/en/tidynode.ishtml.php + * @return bool TRUE if the node is part of a HTML document, FALSE otherwise. + * @since 5.0.1 + */ + public function isHtml() {} + + /** + * Checks if a node represents text (no markup) + * @link https://php.net/manual/en/tidynode.istext.php + * @return bool TRUE if the node represent a text, FALSE otherwise. + * @since 5.0.1 + */ + public function isText() {} + + /** + * Checks if this node is JSTE + * @link https://php.net/manual/en/tidynode.isjste.php + * @return bool TRUE if the node is JSTE, FALSE otherwise. + * @since 5.0.1 + */ + public function isJste() {} + + /** + * Checks if this node is ASP + * @link https://php.net/manual/en/tidynode.isasp.php + * @return bool TRUE if the node is ASP, FALSE otherwise. + * @since 5.0.1 + */ + public function isAsp() {} + + /** + * Checks if a node is PHP + * @link https://php.net/manual/en/tidynode.isphp.php + * @return bool TRUE if the current node is PHP code, FALSE otherwise. + * @since 5.0.1 + */ + public function isPhp() {} + + /** + * Returns the parent node of the current node + * @link https://php.net/manual/en/tidynode.getparent.php + * @return tidyNode a tidyNode if the node has a parent, or NULL + * otherwise. + * @since 5.2.2 + */ + public function getParent() {} + + private function __construct() {} } /** @@ -464,7 +462,7 @@ private function __construct () {} * @return mixed the value of the specified option. * The return type depends on the type of the specified one. */ -function tidy_getopt (tidy $object, $option) {} +function tidy_getopt(tidy $object, $option) {} /** * (PHP 5, PECL tidy >= 0.5.2)+ * The name of the attribute. + *
+ * @return string The value of the attribute, or NULL if no attribute with the given + * name is found or not positioned on an element node. + * @since 5.1.2 + */ + public function getAttribute($name) {} - /** - * Get the value of a named attribute - * @link https://php.net/manual/en/xmlreader.getattribute.php - * @param string $name- * The name of the attribute. - *
- * @return string The value of the attribute, or NULL if no attribute with the given - * name is found or not positioned on an element node. - * @since 5.1.2 - */ - public function getAttribute ($name) {} + /** + * Get the value of an attribute by index + * @link https://php.net/manual/en/xmlreader.getattributeno.php + * @param int $index+ * The position of the attribute. + *
+ * @return string|null The value of the attribute, or NULL if no attribute exists + * at index or not positioned of element. + * @since 5.1.2 + */ + public function getAttributeNo($index) {} - /** - * Get the value of an attribute by index - * @link https://php.net/manual/en/xmlreader.getattributeno.php - * @param int $index- * The position of the attribute. - *
- * @return string|null The value of the attribute, or NULL if no attribute exists - * at index or not positioned of element. - * @since 5.1.2 - */ - public function getAttributeNo ($index) {} + /** + * Get the value of an attribute by localname and URI + * @link https://php.net/manual/en/xmlreader.getattributens.php + * @param string $name+ * The local name. + *
+ * @param string $namespace+ * The namespace URI. + *
+ * @return string|null The value of the attribute, or NULL if no attribute with the + * given localName and + * namespaceURI is found or not positioned of element. + * @since 5.1.2 + */ + public function getAttributeNs($name, $namespace) {} - /** - * Get the value of an attribute by localname and URI - * @link https://php.net/manual/en/xmlreader.getattributens.php - * @param string $name- * The local name. - *
- * @param string $namespace- * The namespace URI. - *
- * @return string|null The value of the attribute, or NULL if no attribute with the - * given localName and - * namespaceURI is found or not positioned of element. - * @since 5.1.2 - */ - public function getAttributeNs ($name, $namespace) {} + /** + * Indicates if specified property has been set + * @link https://php.net/manual/en/xmlreader.getparserproperty.php + * @param int $property+ * One of the parser option + * constants. + *
+ * @return bool TRUE on success or FALSE on failure. + * @since 5.1.2 + */ + public function getParserProperty($property) {} - /** - * Indicates if specified property has been set - * @link https://php.net/manual/en/xmlreader.getparserproperty.php - * @param int $property- * One of the parser option - * constants. - *
- * @return bool TRUE on success or FALSE on failure. - * @since 5.1.2 - */ - public function getParserProperty ($property) {} + /** + * Indicates if the parsed document is valid + * @link https://php.net/manual/en/xmlreader.isvalid.php + * @return bool TRUE on success or FALSE on failure. + * @since 5.1.2 + */ + public function isValid() {} - /** - * Indicates if the parsed document is valid - * @link https://php.net/manual/en/xmlreader.isvalid.php - * @return bool TRUE on success or FALSE on failure. - * @since 5.1.2 - */ - public function isValid () {} + /** + * Lookup namespace for a prefix + * @link https://php.net/manual/en/xmlreader.lookupnamespace.php + * @param string $prefix+ * String containing the prefix. + *
+ * @return bool TRUE on success or FALSE on failure. + * @since 5.1.2 + */ + public function lookupNamespace($prefix) {} - /** - * Lookup namespace for a prefix - * @link https://php.net/manual/en/xmlreader.lookupnamespace.php - * @param string $prefix- * String containing the prefix. - *
- * @return bool TRUE on success or FALSE on failure. - * @since 5.1.2 - */ - public function lookupNamespace ($prefix) {} + /** + * Move cursor to an attribute by index + * @link https://php.net/manual/en/xmlreader.movetoattributeno.php + * @param int $index+ * The position of the attribute. + *
+ * @return bool TRUE on success or FALSE on failure. + * @since 5.1.2 + */ + public function moveToAttributeNo($index) {} - /** - * Move cursor to an attribute by index - * @link https://php.net/manual/en/xmlreader.movetoattributeno.php - * @param int $index- * The position of the attribute. - *
- * @return bool TRUE on success or FALSE on failure. - * @since 5.1.2 - */ - public function moveToAttributeNo ($index) {} + /** + * Move cursor to a named attribute + * @link https://php.net/manual/en/xmlreader.movetoattribute.php + * @param string $name+ * The name of the attribute. + *
+ * @return bool TRUE on success or FALSE on failure. + * @since 5.1.2 + */ + public function moveToAttribute($name) {} - /** - * Move cursor to a named attribute - * @link https://php.net/manual/en/xmlreader.movetoattribute.php - * @param string $name- * The name of the attribute. - *
- * @return bool TRUE on success or FALSE on failure. - * @since 5.1.2 - */ - public function moveToAttribute ($name) {} + /** + * Move cursor to a named attribute + * @link https://php.net/manual/en/xmlreader.movetoattributens.php + * @param string $name+ * The local name. + *
+ * @param string $namespace+ * The namespace URI. + *
+ * @return bool TRUE on success or FALSE on failure. + * @since 5.1.2 + */ + public function moveToAttributeNs($name, $namespace) {} - /** - * Move cursor to a named attribute - * @link https://php.net/manual/en/xmlreader.movetoattributens.php - * @param string $name- * The local name. - *
- * @param string $namespace- * The namespace URI. - *
- * @return bool TRUE on success or FALSE on failure. - * @since 5.1.2 - */ - public function moveToAttributeNs ($name, $namespace) {} + /** + * Position cursor on the parent Element of current Attribute + * @link https://php.net/manual/en/xmlreader.movetoelement.php + * @return bool TRUE if successful and FALSE if it fails or not positioned on + * Attribute when this method is called. + * @since 5.1.2 + */ + public function moveToElement() {} - /** - * Position cursor on the parent Element of current Attribute - * @link https://php.net/manual/en/xmlreader.movetoelement.php - * @return bool TRUE if successful and FALSE if it fails or not positioned on - * Attribute when this method is called. - * @since 5.1.2 - */ - public function moveToElement () {} + /** + * Position cursor on the first Attribute + * @link https://php.net/manual/en/xmlreader.movetofirstattribute.php + * @return bool TRUE on success or FALSE on failure. + * @since 5.1.2 + */ + public function moveToFirstAttribute() {} - /** - * Position cursor on the first Attribute - * @link https://php.net/manual/en/xmlreader.movetofirstattribute.php - * @return bool TRUE on success or FALSE on failure. - * @since 5.1.2 - */ - public function moveToFirstAttribute () {} + /** + * Position cursor on the next Attribute + * @link https://php.net/manual/en/xmlreader.movetonextattribute.php + * @return bool TRUE on success or FALSE on failure. + * @since 5.1.2 + */ + public function moveToNextAttribute() {} - /** - * Position cursor on the next Attribute - * @link https://php.net/manual/en/xmlreader.movetonextattribute.php - * @return bool TRUE on success or FALSE on failure. - * @since 5.1.2 - */ - public function moveToNextAttribute () {} + /** + * Set the URI containing the XML to parse + * @link https://php.net/manual/en/xmlreader.open.php + * @param string $uri+ * URI pointing to the document. + *
+ * @param string $encoding [optional]+ * The document encoding or NULL. + *
+ * @param int $flags [optional]+ * A bitmask of the LIBXML_* + * constants. + *
+ * @return bool TRUE on success or FALSE on failure. If called statically, returns an + * XMLReader or FALSE on failure. + * @since 5.1.2 + */ + public static function open($uri, $encoding = null, $flags = 0) {} - /** - * Set the URI containing the XML to parse - * @link https://php.net/manual/en/xmlreader.open.php - * @param string $uri- * URI pointing to the document. - *
- * @param string $encoding [optional]- * The document encoding or NULL. - *
- * @param int $flags [optional]- * A bitmask of the LIBXML_* - * constants. - *
- * @return bool TRUE on success or FALSE on failure. If called statically, returns an - * XMLReader or FALSE on failure. - * @since 5.1.2 - */ - public static function open ($uri, $encoding = null, $flags = 0) {} + /** + * Move to next node in document + * @link https://php.net/manual/en/xmlreader.read.php + * @return bool TRUE on success or FALSE on failure. + * @since 5.1.2 + */ + public function read() {} - /** - * Move to next node in document - * @link https://php.net/manual/en/xmlreader.read.php - * @return bool TRUE on success or FALSE on failure. - * @since 5.1.2 - */ - public function read () {} + /** + * Move cursor to next node skipping all subtrees + * @link https://php.net/manual/en/xmlreader.next.php + * @param string $name [optional]+ * The name of the next node to move to. + *
+ * @return bool TRUE on success or FALSE on failure. + * @since 5.1.2 + */ + public function next($name = null) {} - /** - * Move cursor to next node skipping all subtrees - * @link https://php.net/manual/en/xmlreader.next.php - * @param string $name [optional]- * The name of the next node to move to. - *
- * @return bool TRUE on success or FALSE on failure. - * @since 5.1.2 - */ - public function next ($name = null) {} + /** + * Retrieve XML from current node + * @link https://php.net/manual/en/xmlreader.readinnerxml.php + * @return string the contents of the current node as a string. Empty string on failure. + */ + public function readInnerXml() {} - /** - * Retrieve XML from current node - * @link https://php.net/manual/en/xmlreader.readinnerxml.php - * @return string the contents of the current node as a string. Empty string on failure. - */ - public function readInnerXml () {} + /** + * Retrieve XML from current node, including it self + * @link https://php.net/manual/en/xmlreader.readouterxml.php + * @return string the contents of current node, including itself, as a string. Empty string on failure. + */ + public function readOuterXml() {} - /** - * Retrieve XML from current node, including it self - * @link https://php.net/manual/en/xmlreader.readouterxml.php - * @return string the contents of current node, including itself, as a string. Empty string on failure. - */ - public function readOuterXml () {} + /** + * Reads the contents of the current node as a string + * @link https://php.net/manual/en/xmlreader.readstring.php + * @return string the content of the current node as a string. Empty string on + * failure. + */ + public function readString() {} - /** - * Reads the contents of the current node as a string - * @link https://php.net/manual/en/xmlreader.readstring.php - * @return string the content of the current node as a string. Empty string on - * failure. - */ - public function readString () {} + /** + * Validate document against XSD + * @link https://php.net/manual/en/xmlreader.setschema.php + * @param string $filename+ * The filename of the XSD schema. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function setSchema($filename) {} - /** - * Validate document against XSD - * @link https://php.net/manual/en/xmlreader.setschema.php - * @param string $filename- * The filename of the XSD schema. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function setSchema ($filename) {} + /** + * Set parser options + * @link https://php.net/manual/en/xmlreader.setparserproperty.php + * @param int $property+ * One of the parser option + * constants. + *
+ * @param bool $value+ * If set to TRUE the option will be enabled otherwise will + * be disabled. + *
+ * @return bool TRUE on success or FALSE on failure. + * @since 5.1.2 + */ + public function setParserProperty($property, $value) {} - /** - * Set parser options - * @link https://php.net/manual/en/xmlreader.setparserproperty.php - * @param int $property- * One of the parser option - * constants. - *
- * @param bool $value- * If set to TRUE the option will be enabled otherwise will - * be disabled. - *
- * @return bool TRUE on success or FALSE on failure. - * @since 5.1.2 - */ - public function setParserProperty ($property, $value) {} + /** + * Set the filename or URI for a RelaxNG Schema + * @link https://php.net/manual/en/xmlreader.setrelaxngschema.php + * @param string $filename+ * filename or URI pointing to a RelaxNG Schema. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function setRelaxNGSchema($filename) {} - /** - * Set the filename or URI for a RelaxNG Schema - * @link https://php.net/manual/en/xmlreader.setrelaxngschema.php - * @param string $filename- * filename or URI pointing to a RelaxNG Schema. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function setRelaxNGSchema ($filename) {} + /** + * Set the data containing a RelaxNG Schema + * @link https://php.net/manual/en/xmlreader.setrelaxngschemasource.php + * @param string $source+ * String containing the RelaxNG Schema. + *
+ * @return bool TRUE on success or FALSE on failure. + * @since 5.1.2 + */ + public function setRelaxNGSchemaSource($source) {} - /** - * Set the data containing a RelaxNG Schema - * @link https://php.net/manual/en/xmlreader.setrelaxngschemasource.php - * @param string $source- * String containing the RelaxNG Schema. - *
- * @return bool TRUE on success or FALSE on failure. - * @since 5.1.2 - */ - public function setRelaxNGSchemaSource ($source) {} - - /** - * Set the data containing the XML to parse - * @link https://php.net/manual/en/xmlreader.xml.php - * @param string $source- * String containing the XML to be parsed. - *
- * @param string $encoding [optional]- * The document encoding or NULL. - *
- * @param int $flags [optional]- * A bitmask of the LIBXML_* - * constants. - *
- * @return bool TRUE on success or FALSE on failure. If called statically, returns an - * XMLReader or FALSE on failure. - * @since 5.1.2 - */ - public static function XML ($source, $encoding = null, $flags = 0) {} - - /** - * Returns a copy of the current node as a DOM object - * @link https://php.net/manual/en/xmlreader.expand.php - * @param null|DOMNode $baseNode [optional] - * @return DOMNode|false The resulting DOMNode or FALSE on error. - * @since 5.1.2 - */ - public function expand (DOMNode $baseNode = null) {} + /** + * Set the data containing the XML to parse + * @link https://php.net/manual/en/xmlreader.xml.php + * @param string $source+ * String containing the XML to be parsed. + *
+ * @param string $encoding [optional]+ * The document encoding or NULL. + *
+ * @param int $flags [optional]+ * A bitmask of the LIBXML_* + * constants. + *
+ * @return bool TRUE on success or FALSE on failure. If called statically, returns an + * XMLReader or FALSE on failure. + * @since 5.1.2 + */ + public static function XML($source, $encoding = null, $flags = 0) {} + /** + * Returns a copy of the current node as a DOM object + * @link https://php.net/manual/en/xmlreader.expand.php + * @param null|DOMNode $baseNode [optional] + * @return DOMNode|false The resulting DOMNode or FALSE on error. + * @since 5.1.2 + */ + public function expand(DOMNode $baseNode = null) {} } // End of xmlreader v.0.2 diff --git a/xmlrpc/xmlrpc.php b/xmlrpc/xmlrpc.php index 04b74faff..8d904f355 100644 --- a/xmlrpc/xmlrpc.php +++ b/xmlrpc/xmlrpc.php @@ -8,7 +8,7 @@ * @param mixed $value * @return string */ -function xmlrpc_encode ($value) {} +function xmlrpc_encode($value) {} /** * Decodes XML into native PHP types @@ -22,7 +22,7 @@ function xmlrpc_encode ($value) {} * @return mixed either an array, or an integer, or a string, or a boolean according * to the response returned by the XMLRPC method. */ -function xmlrpc_decode ($xml, $encoding = "iso-8859-1") {} +function xmlrpc_decode($xml, $encoding = "iso-8859-1") {} /** * Decodes XML into native PHP types @@ -32,7 +32,7 @@ function xmlrpc_decode ($xml, $encoding = "iso-8859-1") {} * @param string $encoding [optional] * @return mixed */ -function xmlrpc_decode_request ($xml, &$method, $encoding = null) {} +function xmlrpc_decode_request($xml, &$method, $encoding = null) {} /** * Generates XML for a method request @@ -49,7 +49,7 @@ function xmlrpc_decode_request ($xml, &$method, $encoding = null) {} * output_type: php, xml * @return string a string containing the XML representation of the request. */ -function xmlrpc_encode_request ($method, $params, ?array $output_options = null) {} +function xmlrpc_encode_request($method, $params, ?array $output_options = null) {} /** * Gets xmlrpc type for a PHP value @@ -59,7 +59,7 @@ function xmlrpc_encode_request ($method, $params, ?array $output_options = null) * * @return string the XML-RPC type. */ -function xmlrpc_get_type ($value) {} +function xmlrpc_get_type($value) {} /** * Sets xmlrpc type, base64 or datetime, for a PHP string value @@ -73,7 +73,7 @@ function xmlrpc_get_type ($value) {} * @return bool TRUE on success or FALSE on failure. * If successful, value is converted to an object. */ -function xmlrpc_set_type (&$value, $type) {} +function xmlrpc_set_type(&$value, $type) {} /** * Determines if an array value represents an XMLRPC fault @@ -85,14 +85,14 @@ function xmlrpc_set_type (&$value, $type) {} * description is available in $arg["faultString"], fault * code is in $arg["faultCode"]. */ -function xmlrpc_is_fault (array $arg) {} +function xmlrpc_is_fault(array $arg) {} /** * Creates an xmlrpc server * @link https://php.net/manual/en/function.xmlrpc-server-create.php * @return resource */ -function xmlrpc_server_create () {} +function xmlrpc_server_create() {} /** * Destroys server resources @@ -100,7 +100,7 @@ function xmlrpc_server_create () {} * @param resource $server * @return int */ -function xmlrpc_server_destroy ($server) {} +function xmlrpc_server_destroy($server) {} /** * Register a PHP function to resource method matching method_name @@ -110,7 +110,7 @@ function xmlrpc_server_destroy ($server) {} * @param callable $function * @return bool */ -function xmlrpc_server_register_method ($server, $method_name, $function) {} +function xmlrpc_server_register_method($server, $method_name, $function) {} /** * Parses XML requests and call methods @@ -121,7 +121,7 @@ function xmlrpc_server_register_method ($server, $method_name, $function) {} * @param null|array $output_options [optional] * @return string */ -function xmlrpc_server_call_method ($server, $xml, $user_data, ?array $output_options = null) {} +function xmlrpc_server_call_method($server, $xml, $user_data, ?array $output_options = null) {} /** * Decodes XML into a list of method descriptions @@ -129,7 +129,7 @@ function xmlrpc_server_call_method ($server, $xml, $user_data, ?array $output_op * @param string $xml * @return array */ -function xmlrpc_parse_method_descriptions ($xml) {} +function xmlrpc_parse_method_descriptions($xml) {} /** * Adds introspection documentation @@ -138,7 +138,7 @@ function xmlrpc_parse_method_descriptions ($xml) {} * @param array $desc * @return int */ -function xmlrpc_server_add_introspection_data ($server, array $desc) {} +function xmlrpc_server_add_introspection_data($server, array $desc) {} /** * Register a PHP function to generate documentation @@ -147,6 +147,6 @@ function xmlrpc_server_add_introspection_data ($server, array $desc) {} * @param string $function * @return bool */ -function xmlrpc_server_register_introspection_callback ($server, $function) {} +function xmlrpc_server_register_introspection_callback($server, $function) {} // End of xmlrpc v.0.51 diff --git a/xmlwriter/xmlwriter.php b/xmlwriter/xmlwriter.php index 93fc87461..e412022f4 100644 --- a/xmlwriter/xmlwriter.php +++ b/xmlwriter/xmlwriter.php @@ -4,512 +4,511 @@ use JetBrains\PhpStorm\Internal\LanguageLevelTypeAware; -class XMLWriter { - - /** - * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)- * The URI of the resource for the output. - *
- * @return bool Object oriented style: Returns TRUE on success or FALSE on failure. - * - *
- * Procedural style: Returns a new xmlwriter resource for later use with the
- * xmlwriter functions on success, FALSE on error.
- */
- public function openUri ($uri) {}
-
- /**
- * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)
- * Create new xmlwriter using memory for string output
- * @link https://php.net/manual/en/function.xmlwriter-open-memory.php
- * @return bool Object oriented style: Returns TRUE on success or FALSE on failure.
- *
- * Procedural style: Returns a new xmlwriter resource for later use with the
- * xmlwriter functions on success, FALSE on error.
- */
- public function openMemory () {}
-
- /**
- * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)
- * Toggle indentation on/off
- * @link https://php.net/manual/en/function.xmlwriter-set-indent.php
- * @param bool $enable
- * Whether indentation is enabled. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function setIndent ($enable) {} - - /** - * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)- * The indentation string. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function setIndentString ($indentation) {} - - /** - * (PHP 5 >= 5.1.2, PECL xmlwriter >= 1.0.0)- * The attribute name. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function startAttribute ($name) {} - - /** - * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)- * The name of the attribute. - *
- * @param string $value- * The value of the attribute. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function writeAttribute ($name, $value) {} - - /** - * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)- * The namespace prefix. - *
- * @param string $name- * The attribute name. - *
- * @param string $namespace- * The namespace URI. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function startAttributeNs ($prefix, $name, $namespace) {} - - /** - * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)- * The namespace prefix. - *
- * @param string $name- * The attribute name. - *
- * @param string $namespace- * The namespace URI. - *
- * @param string $value- * The attribute value. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function writeAttributeNs ($prefix, $name, $namespace, $value) {} - - /** - * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)- * The element name. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function startElement ($name) {} - - /** - * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)- * The namespace prefix. - *
- * @param string $name- * The element name. - *
- * @param string $namespace- * The namespace URI. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function startElementNs ($prefix, $name, $namespace) {} - - /** - * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)- * The element name. - *
- * @param string $content [optional]- * The element contents. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function writeElement ($name, $content = null) {} - - /** - * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)- * The namespace prefix. - *
- * @param string $name- * The element name. - *
- * @param string $namespace- * The namespace URI. - *
- * @param string $content [optional]- * The element contents. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function writeElementNs ($prefix, $name, $namespace, $content = null) {} - - /** - * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)- * The target of the processing instruction. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function startPi ($target) {} - - /** - * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)- * The target of the processing instruction. - *
- * @param string $content- * The content of the processing instruction. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function writePi ($target, $content) {} - - /** - * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)- * The contents of the CDATA. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function writeCdata ($content) {} - - /** - * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)- * The contents of the text. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function text ($content) {} - - /** - * (PHP 5 >= 5.2.0, PECL xmlwriter >= 2.0.4)- * The text string to write. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function writeRaw ($content) {} - - /** - * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)- * The version number of the document as part of the XML declaration. - *
- * @param string $encoding [optional]- * The encoding of the document as part of the XML declaration. - *
- * @param string $standalone [optional]- * yes or no. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function startDocument ($version = '1.0', $encoding = null, $standalone = null) {} - - /** - * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)- * The contents of the comment. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function writeComment ($content) {} - - /** - * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)- * The qualified name of the document type to create. - *
- * @param string $publicId [optional]- * The external subset public identifier. - *
- * @param string $systemId [optional]- * The external subset system identifier. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function startDtd ($qualifiedName, $publicId = null, $systemId = null) {} - - /** - * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)- * The DTD name. - *
- * @param string $publicId [optional]- * The external subset public identifier. - *
- * @param string $systemId [optional]- * The external subset system identifier. - *
- * @param string $content [optional]- * The content of the DTD. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function writeDtd ($name, $publicId = null, $systemId = null, $content = null) {} - - /** - * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)- * The qualified name of the document type to create. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function startDtdElement ($qualifiedName) {} - - /** - * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)- * The name of the DTD element. - *
- * @param string $content- * The content of the element. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function writeDtdElement ($name, $content) {} - - /** - * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)- * The attribute list name. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function startDtdAttlist ($name) {} - - /** - * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)- * The name of the DTD attribute list. - *
- * @param string $content- * The content of the DTD attribute list. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function writeDtdAttlist ($name, $content) {} - - /** - * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)- * The name of the entity. - *
- * @param bool $isParam - * @return bool TRUE on success or FALSE on failure. - */ - public function startDtdEntity ($name, $isParam) {} - - /** - * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)- * The name of the entity. - *
- * @param string $content- * The content of the entity. - *
- * @param bool $pe - * @param string $pubid - * @param string $sysid - * @param string $ndataid - * @return bool TRUE on success or FALSE on failure. - */ - public function writeDtdEntity ($name, $content, $pe, $pubid, $sysid, $ndataid) {} - - /** - * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)- * Whether to flush the output buffer or not. Default is TRUE. - *
- * @return string the current buffer as a string. - */ - public function outputMemory ($flush = true) {} - - /** - * (PHP 5 >= 5.1.2, PECL xmlwriter >= 1.0.0)- * Whether to empty the buffer or not. Default is TRUE. - *
- * @return mixed 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. - */ - public function flush ($empty = true) {} - +class XMLWriter +{ + /** + * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)+ * The URI of the resource for the output. + *
+ * @return bool Object oriented style: Returns TRUE on success or FALSE on failure. + * + *
+ * Procedural style: Returns a new xmlwriter resource for later use with the
+ * xmlwriter functions on success, FALSE on error.
+ */
+ public function openUri($uri) {}
+
+ /**
+ * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)
+ * Create new xmlwriter using memory for string output
+ * @link https://php.net/manual/en/function.xmlwriter-open-memory.php
+ * @return bool Object oriented style: Returns TRUE on success or FALSE on failure.
+ *
+ * Procedural style: Returns a new xmlwriter resource for later use with the
+ * xmlwriter functions on success, FALSE on error.
+ */
+ public function openMemory() {}
+
+ /**
+ * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)
+ * Toggle indentation on/off
+ * @link https://php.net/manual/en/function.xmlwriter-set-indent.php
+ * @param bool $enable
+ * Whether indentation is enabled. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function setIndent($enable) {} + + /** + * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)+ * The indentation string. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function setIndentString($indentation) {} + + /** + * (PHP 5 >= 5.1.2, PECL xmlwriter >= 1.0.0)+ * The attribute name. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function startAttribute($name) {} + + /** + * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)+ * The name of the attribute. + *
+ * @param string $value+ * The value of the attribute. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function writeAttribute($name, $value) {} + + /** + * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)+ * The namespace prefix. + *
+ * @param string $name+ * The attribute name. + *
+ * @param string $namespace+ * The namespace URI. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function startAttributeNs($prefix, $name, $namespace) {} + + /** + * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)+ * The namespace prefix. + *
+ * @param string $name+ * The attribute name. + *
+ * @param string $namespace+ * The namespace URI. + *
+ * @param string $value+ * The attribute value. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function writeAttributeNs($prefix, $name, $namespace, $value) {} + + /** + * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)+ * The element name. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function startElement($name) {} + + /** + * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)+ * The namespace prefix. + *
+ * @param string $name+ * The element name. + *
+ * @param string $namespace+ * The namespace URI. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function startElementNs($prefix, $name, $namespace) {} + + /** + * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)+ * The element name. + *
+ * @param string $content [optional]+ * The element contents. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function writeElement($name, $content = null) {} + + /** + * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)+ * The namespace prefix. + *
+ * @param string $name+ * The element name. + *
+ * @param string $namespace+ * The namespace URI. + *
+ * @param string $content [optional]+ * The element contents. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function writeElementNs($prefix, $name, $namespace, $content = null) {} + + /** + * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)+ * The target of the processing instruction. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function startPi($target) {} + + /** + * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)+ * The target of the processing instruction. + *
+ * @param string $content+ * The content of the processing instruction. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function writePi($target, $content) {} + + /** + * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)+ * The contents of the CDATA. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function writeCdata($content) {} + + /** + * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)+ * The contents of the text. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function text($content) {} + + /** + * (PHP 5 >= 5.2.0, PECL xmlwriter >= 2.0.4)+ * The text string to write. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function writeRaw($content) {} + + /** + * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)+ * The version number of the document as part of the XML declaration. + *
+ * @param string $encoding [optional]+ * The encoding of the document as part of the XML declaration. + *
+ * @param string $standalone [optional]+ * yes or no. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function startDocument($version = '1.0', $encoding = null, $standalone = null) {} + + /** + * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)+ * The contents of the comment. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function writeComment($content) {} + + /** + * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)+ * The qualified name of the document type to create. + *
+ * @param string $publicId [optional]+ * The external subset public identifier. + *
+ * @param string $systemId [optional]+ * The external subset system identifier. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function startDtd($qualifiedName, $publicId = null, $systemId = null) {} + + /** + * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)+ * The DTD name. + *
+ * @param string $publicId [optional]+ * The external subset public identifier. + *
+ * @param string $systemId [optional]+ * The external subset system identifier. + *
+ * @param string $content [optional]+ * The content of the DTD. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function writeDtd($name, $publicId = null, $systemId = null, $content = null) {} + + /** + * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)+ * The qualified name of the document type to create. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function startDtdElement($qualifiedName) {} + + /** + * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)+ * The name of the DTD element. + *
+ * @param string $content+ * The content of the element. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function writeDtdElement($name, $content) {} + + /** + * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)+ * The attribute list name. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function startDtdAttlist($name) {} + + /** + * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)+ * The name of the DTD attribute list. + *
+ * @param string $content+ * The content of the DTD attribute list. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function writeDtdAttlist($name, $content) {} + + /** + * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)+ * The name of the entity. + *
+ * @param bool $isParam + * @return bool TRUE on success or FALSE on failure. + */ + public function startDtdEntity($name, $isParam) {} + + /** + * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)+ * The name of the entity. + *
+ * @param string $content+ * The content of the entity. + *
+ * @param bool $pe + * @param string $pubid + * @param string $sysid + * @param string $ndataid + * @return bool TRUE on success or FALSE on failure. + */ + public function writeDtdEntity($name, $content, $pe, $pubid, $sysid, $ndataid) {} + + /** + * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)+ * Whether to flush the output buffer or not. Default is TRUE. + *
+ * @return string the current buffer as a string. + */ + public function outputMemory($flush = true) {} + + /** + * (PHP 5 >= 5.1.2, PECL xmlwriter >= 1.0.0)+ * Whether to empty the buffer or not. Default is TRUE. + *
+ * @return mixed 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. + */ + public function flush($empty = true) {} } /** @@ -526,8 +525,7 @@ public function flush ($empty = true) {} * */ #[LanguageLevelTypeAware(["8.0" => "XMLWriter|false"], default: "resource|false")] -function xmlwriter_open_uri (string $uri) -{} +function xmlwriter_open_uri(string $uri) {} /** * (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)- * The imported style sheet as a DOMDocument or - * SimpleXMLElement object. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function importStylesheet ($stylesheet) {} - - /** - * Transform to a DOMDocument - * @link https://php.net/manual/en/xsltprocessor.transformtodoc.php - * @param DOMNode $doc- * The node to be transformed. - *
- * @return DOMDocument|false The resulting DOMDocument or FALSE on error. - */ - public function transformToDoc (DOMNode $doc) {} - - /** - * Transform to URI - * @link https://php.net/manual/en/xsltprocessor.transformtouri.php - * @param DOMDocument|SimpleXMLElement $doc- * The document to transform. - *
- * @param string $uri- * The target URI for the transformation. - *
- * @return int|false the number of bytes written or FALSE if an error occurred. - */ - public function transformToUri ($doc, $uri) {} - - /** - * Transform to XML - * @link https://php.net/manual/en/xsltprocessor.transformtoxml.php - * @param DOMDocument|SimpleXMLElement $doc- * The transformed document. - *
- * @return string|false|null The result of the transformation as a string or FALSE on error. - */ - public function transformToXml ($doc) {} - - /** - * Set value for a parameter - * @link https://php.net/manual/en/xsltprocessor.setparameter.php - * @param string $namespace- * The namespace URI of the XSLT parameter. - *
- * @param array $options- * An array of name => value pairs. This syntax is available since PHP 5.1.0. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function setParameter ($namespace, $options) {} - - /** - * Set value for a parameter - * @link https://php.net/manual/en/xsltprocessor.setparameter.php - * @param string $namespace- * The namespace URI of the XSLT parameter. - *
- * @param string $name- * The local name of the XSLT parameter. - *
- * @param string $value- * The new value of the XSLT parameter. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function setParameter ($namespace, $name, $value) {} - - /** - * Get value of a parameter - * @link https://php.net/manual/en/xsltprocessor.getparameter.php - * @param string $namespaceURI- * The namespace URI of the XSLT parameter. - *
- * @param string $localName- * The local name of the XSLT parameter. - *
- * @return string|false The value of the parameter (as a string), or FALSE if it's not set. - */ - public function getParameter ($namespaceURI, $localName) {} - - /** - * Remove parameter - * @link https://php.net/manual/en/xsltprocessor.removeparameter.php - * @param string $namespaceURI- * The namespace URI of the XSLT parameter. - *
- * @param string $localName- * The local name of the XSLT parameter. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function removeParameter ($namespaceURI, $localName) {} - - /** - * Determine if PHP has EXSLT support - * @link https://php.net/manual/en/xsltprocessor.hasexsltsupport.php - * @return bool TRUE on success or FALSE on failure. - * @since 5.0.4 - */ - public function hasExsltSupport () {} - - /** - * Enables the ability to use PHP functions as XSLT functions - * @link https://php.net/manual/en/xsltprocessor.registerphpfunctions.php - * @param mixed $restrict [optional]- * Use this parameter to only allow certain functions to be called from - * XSLT. - *
- *- * This parameter can be either a string (a function name) or an array of - * functions. - *
- * @return void No value is returned. - * @since 5.0.4 - */ - public function registerPHPFunctions ($restrict = null) {} - - /** - * Sets profiling output file - * @link https://php.net/manual/en/xsltprocessor.setprofiling.php - * @param string $filename- * Path to the file to dump profiling information. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function setProfiling ($filename) {} - - /** - * Set security preferences - * @link https://php.net/manual/en/xsltprocessor.setsecurityprefs.php - * @param int $securityPrefs - * @return int - * @since 5.4 - */ - public function setSecurityPrefs ($securityPrefs) {} - - /** - * Get security preferences - * @link https://php.net/manual/en/xsltprocessor.getsecurityprefs.php - * @return int - * @since 5.4 - */ - public function getSecurityPrefs () {} - +class XSLTProcessor +{ + /** + * Import stylesheet + * @link https://php.net/manual/en/xsltprocessor.importstylesheet.php + * @param object $stylesheet+ * The imported style sheet as a DOMDocument or + * SimpleXMLElement object. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function importStylesheet($stylesheet) {} + + /** + * Transform to a DOMDocument + * @link https://php.net/manual/en/xsltprocessor.transformtodoc.php + * @param DOMNode $doc+ * The node to be transformed. + *
+ * @return DOMDocument|false The resulting DOMDocument or FALSE on error. + */ + public function transformToDoc(DOMNode $doc) {} + + /** + * Transform to URI + * @link https://php.net/manual/en/xsltprocessor.transformtouri.php + * @param DOMDocument|SimpleXMLElement $doc+ * The document to transform. + *
+ * @param string $uri+ * The target URI for the transformation. + *
+ * @return int|false the number of bytes written or FALSE if an error occurred. + */ + public function transformToUri($doc, $uri) {} + + /** + * Transform to XML + * @link https://php.net/manual/en/xsltprocessor.transformtoxml.php + * @param DOMDocument|SimpleXMLElement $doc+ * The transformed document. + *
+ * @return string|false|null The result of the transformation as a string or FALSE on error. + */ + public function transformToXml($doc) {} + + /** + * Set value for a parameter + * @link https://php.net/manual/en/xsltprocessor.setparameter.php + * @param string $namespace+ * The namespace URI of the XSLT parameter. + *
+ * @param array $options+ * An array of name => value pairs. This syntax is available since PHP 5.1.0. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function setParameter($namespace, $options) {} + + /** + * Set value for a parameter + * @link https://php.net/manual/en/xsltprocessor.setparameter.php + * @param string $namespace+ * The namespace URI of the XSLT parameter. + *
+ * @param string $name+ * The local name of the XSLT parameter. + *
+ * @param string $value+ * The new value of the XSLT parameter. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function setParameter($namespace, $name, $value) {} + + /** + * Get value of a parameter + * @link https://php.net/manual/en/xsltprocessor.getparameter.php + * @param string $namespaceURI+ * The namespace URI of the XSLT parameter. + *
+ * @param string $localName+ * The local name of the XSLT parameter. + *
+ * @return string|false The value of the parameter (as a string), or FALSE if it's not set. + */ + public function getParameter($namespaceURI, $localName) {} + + /** + * Remove parameter + * @link https://php.net/manual/en/xsltprocessor.removeparameter.php + * @param string $namespaceURI+ * The namespace URI of the XSLT parameter. + *
+ * @param string $localName+ * The local name of the XSLT parameter. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function removeParameter($namespaceURI, $localName) {} + + /** + * Determine if PHP has EXSLT support + * @link https://php.net/manual/en/xsltprocessor.hasexsltsupport.php + * @return bool TRUE on success or FALSE on failure. + * @since 5.0.4 + */ + public function hasExsltSupport() {} + + /** + * Enables the ability to use PHP functions as XSLT functions + * @link https://php.net/manual/en/xsltprocessor.registerphpfunctions.php + * @param mixed $restrict [optional]+ * Use this parameter to only allow certain functions to be called from + * XSLT. + *
+ *+ * This parameter can be either a string (a function name) or an array of + * functions. + *
+ * @return void No value is returned. + * @since 5.0.4 + */ + public function registerPHPFunctions($restrict = null) {} + + /** + * Sets profiling output file + * @link https://php.net/manual/en/xsltprocessor.setprofiling.php + * @param string $filename+ * Path to the file to dump profiling information. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function setProfiling($filename) {} + + /** + * Set security preferences + * @link https://php.net/manual/en/xsltprocessor.setsecurityprefs.php + * @param int $securityPrefs + * @return int + * @since 5.4 + */ + public function setSecurityPrefs($securityPrefs) {} + + /** + * Get security preferences + * @link https://php.net/manual/en/xsltprocessor.getsecurityprefs.php + * @return int + * @since 5.4 + */ + public function getSecurityPrefs() {} } -define ('XSL_CLONE_AUTO', 0); -define ('XSL_CLONE_NEVER', -1); -define ('XSL_CLONE_ALWAYS', 1); +define('XSL_CLONE_AUTO', 0); +define('XSL_CLONE_NEVER', -1); +define('XSL_CLONE_ALWAYS', 1); /** @link https://php.net/manual/en/xsl.constants.php */ -define ('XSL_SECPREF_NONE', 0); +define('XSL_SECPREF_NONE', 0); /** @link https://php.net/manual/en/xsl.constants.php */ -define ('XSL_SECPREF_READ_FILE', 2); +define('XSL_SECPREF_READ_FILE', 2); /** @link https://php.net/manual/en/xsl.constants.php */ -define ('XSL_SECPREF_WRITE_FILE', 4); +define('XSL_SECPREF_WRITE_FILE', 4); /** @link https://php.net/manual/en/xsl.constants.php */ -define ('XSL_SECPREF_CREATE_DIRECTORY', 8); +define('XSL_SECPREF_CREATE_DIRECTORY', 8); /** @link https://php.net/manual/en/xsl.constants.php */ -define ('XSL_SECPREF_READ_NETWORK', 16); +define('XSL_SECPREF_READ_NETWORK', 16); /** @link https://php.net/manual/en/xsl.constants.php */ -define ('XSL_SECPREF_WRITE_NETWORK', 32); +define('XSL_SECPREF_WRITE_NETWORK', 32); /** @link https://php.net/manual/en/xsl.constants.php */ -define ('XSL_SECPREF_DEFAULT', 44); +define('XSL_SECPREF_DEFAULT', 44); /** * libxslt version like 10117. Available as of PHP 5.1.2. * @link https://php.net/manual/en/xsl.constants.php */ -define ('LIBXSLT_VERSION', 10128); +define('LIBXSLT_VERSION', 10128); /** * libxslt version like 1.1.17. Available as of PHP 5.1.2. * @link https://php.net/manual/en/xsl.constants.php */ -define ('LIBXSLT_DOTTED_VERSION', "1.1.28"); +define('LIBXSLT_DOTTED_VERSION', "1.1.28"); /** * libexslt version like 813. Available as of PHP 5.1.2. * @link https://php.net/manual/en/xsl.constants.php */ -define ('LIBEXSLT_VERSION', 817); +define('LIBEXSLT_VERSION', 817); /** * libexslt version like 1.1.17. Available as of PHP 5.1.2. * @link https://php.net/manual/en/xsl.constants.php */ -define ('LIBEXSLT_DOTTED_VERSION', "1.1.28"); +define('LIBEXSLT_DOTTED_VERSION', "1.1.28"); // End of xsl v.0.1 -?> diff --git a/xxtea/xxtea.php b/xxtea/xxtea.php index 7ffdd42ed..0afc30551 100644 --- a/xxtea/xxtea.php +++ b/xxtea/xxtea.php @@ -16,7 +16,7 @@ class XXTEA * * @since 1.0.0 */ - public static function encrypt($data, $key) { } + public static function encrypt($data, $key) {} /** * Decrypts data. @@ -28,7 +28,7 @@ public static function encrypt($data, $key) { } * * @since 1.0.0 */ - public static function decrypt($data, $key) { } + public static function decrypt($data, $key) {} } /** @@ -41,7 +41,7 @@ public static function decrypt($data, $key) { } * * @since 1.0.0 */ -function xxtea_encrypt($data, $key) { } +function xxtea_encrypt($data, $key) {} /** * Decrypts data. @@ -53,4 +53,4 @@ function xxtea_encrypt($data, $key) { } * * @since 1.0.0 */ -function xxtea_decrypt($data, $key) { } +function xxtea_decrypt($data, $key) {} diff --git a/yaf/yaf.php b/yaf/yaf.php index ad7181a57..b5958ad37 100644 --- a/yaf/yaf.php +++ b/yaf/yaf.php @@ -29,8 +29,8 @@ * * @link https://secure.php.net/manual/en/class.yaf-application.php */ -final class Yaf_Application { - +final class Yaf_Application +{ /** * @var Yaf_Application */ @@ -113,7 +113,7 @@ final class Yaf_Application { * * @throws Yaf_Exception_TypeError|Yaf_Exception_StartupError */ - public function __construct($config, $envrion = null){ } + public function __construct($config, $envrion = null) {} /** * Run a Yaf_Application, let the Yaf_Application accept a request, and route the request, dispatch to controller/action, and render response. @@ -122,7 +122,7 @@ public function __construct($config, $envrion = null){ } * @link https://secure.php.net/manual/en/yaf-application.run.php * @throws Yaf_Exception_StartupError */ - public function run(){ } + public function run() {} /** * This method is typically used to run Yaf_Application in a crontab work. @@ -133,7 +133,7 @@ public function run(){ } * @param callable $entry a valid callback * @param string ...$_ parameters will pass to the callback */ - public function execute(callable $entry, ...$_){ } + public function execute(callable $entry, ...$_) {} /** * Retrieve the Yaf_Application instance, alternatively, we also could use Yaf_Dispatcher::getApplication(). @@ -142,7 +142,7 @@ public function execute(callable $entry, ...$_){ } * * @return Yaf_Application|null an Yaf_Application instance, if no Yaf_Application initialized before, NULL will be returned. */ - public static function app(){ } + public static function app() {} /** * Retrieve environ which was defined in yaf.environ which has a default value "product". @@ -151,7 +151,7 @@ public static function app(){ } * * @return string */ - public function environ(){ } + public function environ() {} /** * Run a Bootstrap, all the methods defined in the Bootstrap and named with prefix "_init" will be called according to their declaration order, if the parameter bootstrap is not supplied, Yaf will look for a Bootstrap under application.directory. @@ -161,14 +161,14 @@ public function environ(){ } * @param Yaf_Bootstrap_Abstract $bootstrap A Yaf_Bootstrap_Abstract instance * @return Yaf_Application */ - public function bootstrap(Yaf_Bootstrap_Abstract $bootstrap = null){ } + public function bootstrap(Yaf_Bootstrap_Abstract $bootstrap = null) {} /** * @link https://secure.php.net/manual/en/yaf-application.getconfig.php * * @return Yaf_Config_Abstract */ - public function getConfig(){ } + public function getConfig() {} /** * Get the modules list defined in config, if no one defined, there will always be a module named "Index". @@ -177,14 +177,14 @@ public function getConfig(){ } * * @return array */ - public function getModules(){ } + public function getModules() {} /** * @link https://secure.php.net/manual/en/yaf-application.getdispatcher.php * * @return Yaf_Dispatcher */ - public function getDispatcher(){ } + public function getDispatcher() {} /** * Change the application directory @@ -195,7 +195,7 @@ public function getDispatcher(){ } * @param string $directory * @return Yaf_Application */ - public function setAppDirectory($directory){ } + public function setAppDirectory($directory) {} /** * @since 2.1.4 @@ -203,7 +203,7 @@ public function setAppDirectory($directory){ } * * @return string */ - public function getAppDirectory(){ } + public function getAppDirectory() {} /** * @since 2.1.2 @@ -211,7 +211,7 @@ public function getAppDirectory(){ } * * @return int */ - public function getLastErrorNo(){ } + public function getLastErrorNo() {} /** * @since 2.1.2 @@ -219,38 +219,33 @@ public function getLastErrorNo(){ } * * @return string */ - public function getLastErrorMsg(){ } + public function getLastErrorMsg() {} /** - * * @since 2.1.2 * @link https://secure.php.net/manual/en/yaf-application.clearlasterror.php */ - public function clearLastError(){ } + public function clearLastError() {} /** - * * @link https://secure.php.net/manual/en/yaf-application.destruct.php */ - public function __destruct(){ } + public function __destruct() {} /** - * * @link https://secure.php.net/manual/en/yaf-application.clone.php */ - private function __clone(){ } + private function __clone() {} /** - * * @link https://secure.php.net/manual/en/yaf-application.sleep.php */ - private function __sleep(){ } + private function __sleep() {} /** - * * @link https://secure.php.net/manual/en/yaf-application.wakeup.php */ - private function __wakeup(){ } + private function __wakeup() {} } /** @@ -259,8 +254,8 @@ private function __wakeup(){ } * * @link https://secure.php.net/manual/en/class.yaf-dispatcher.php */ -final class Yaf_Dispatcher { - +final class Yaf_Dispatcher +{ /** * @var Yaf_Dispatcher */ @@ -309,22 +304,22 @@ final class Yaf_Dispatcher { /** * @link https://secure.php.net/manual/en/yaf-dispatcher.construct.php */ - private function __construct(){ } + private function __construct() {} /** * @link https://secure.php.net/manual/en/yaf-dispatcher.clone.php */ - private function __clone(){ } + private function __clone() {} /** * @link https://secure.php.net/manual/en/yaf-dispatcher.sleep.php */ - private function __sleep(){ } + private function __sleep() {} /** * @link https://secure.php.net/manual/en/yaf-dispatcher.wakeup.php */ - private function __wakeup(){ } + private function __wakeup() {} /** * enable view rendering @@ -333,7 +328,7 @@ private function __wakeup(){ } * * @return Yaf_Dispatcher */ - public function enableView(){ } + public function enableView() {} /** *disable view engine, used in some app that user will output by himself
Set error handler for Yaf. when application.dispatcher.throwException is off, Yaf will trigger catch-able error while unexpected errors occurred.
Yaf_Dispatcher will render automatically after dispatches an incoming request, you can prevent the rendering by calling this method with $flag TRUE
This method does the heavy work of the Yaf_Dispatcher. It take a request object.
Switch on/off exception throwing while unexpected error occurring. When this is on, Yaf will throwing exceptions instead of triggering catchable errors.
While the application.dispatcher.throwException is On(you can also calling to Yaf_Dispatcher::throwException(TRUE) to enable it), Yaf will throw Exception whe error occurs instead of trigger error.
If you want Yaf_Loader search some classes(libraries) in the local class directory(which is defined in application.ini, and by default, it is application.directory . "/library"), you should register the class prefix using the Yaf_Loader::registerLocalNameSpace()
* @link https://secure.php.net/manual/en/class.yaf-loader.php - * */ -class Yaf_Loader { - +class Yaf_Loader +{ /** * @var string */ @@ -573,22 +566,22 @@ class Yaf_Loader { /** * @link https://secure.php.net/manual/en/yaf-loader.construct.php */ - private function __construct(){ } + private function __construct() {} /** * @link https://secure.php.net/manual/en/yaf-loader.clone.php */ - private function __clone(){ } + private function __clone() {} /** * @link https://secure.php.net/manual/en/yaf-loader.sleep.php */ - private function __sleep(){ } + private function __sleep() {} /** * @link https://secure.php.net/manual/en/yaf-loader.wakeup.php */ - private function __wakeup(){ } + private function __wakeup() {} /** * @link https://secure.php.net/manual/en/yaf-loader.autoload.php @@ -597,7 +590,7 @@ private function __wakeup(){ } * * @return bool */ - public function autoload($class_name){ } + public function autoload($class_name) {} /** * @link https://secure.php.net/manual/en/yaf-loader.getinstance.php @@ -607,7 +600,7 @@ public function autoload($class_name){ } * * @return Yaf_Loader */ - public static function getInstance($local_library_path = null, $global_library_path = null){ } + public static function getInstance($local_library_path = null, $global_library_path = null) {} /** *Register local class prefix name, Yaf_Loader search classes in two library directories, the one is configured via application.library.directory(in application.ini) which is called local library directory; the other is configured via yaf.library (in php.ini) which is called global library directory, since it can be shared by many applications in the same server.
@@ -622,19 +615,19 @@ public static function getInstance($local_library_path = null, $global_library_p * * @return bool */ - public function registerLocalNamespace($name_prefix){ } + public function registerLocalNamespace($name_prefix) {} /** * @link https://secure.php.net/manual/en/yaf-loader.getlocalnamespace.php * * @return string */ - public function getLocalNamespace(){ } + public function getLocalNamespace() {} /** * @link https://secure.php.net/manual/en/yaf-loader.clearlocalnamespace.php */ - public function clearLocalNamespace(){ } + public function clearLocalNamespace() {} /** * @link https://secure.php.net/manual/en/yaf-loader.islocalname.php @@ -643,7 +636,7 @@ public function clearLocalNamespace(){ } * * @return bool */ - public function isLocalName($class_name){ } + public function isLocalName($class_name) {} /** * @link https://secure.php.net/manual/en/yaf-loader.import.php @@ -652,7 +645,7 @@ public function isLocalName($class_name){ } * * @return bool */ - public static function import($file){ } + public static function import($file) {} /** * @since 2.1.4 @@ -663,7 +656,7 @@ public static function import($file){ } * * @return Yaf_Loader */ - public function setLibraryPath($directory, $global = false){ } + public function setLibraryPath($directory, $global = false) {} /** * @since 2.1.4 @@ -673,15 +666,15 @@ public function setLibraryPath($directory, $global = false){ } * * @return string */ - public function getLibraryPath($is_global = false){ } + public function getLibraryPath($is_global = false) {} } /** *All methods of Yaf_Registry declared as static, making it universally accessible. This provides the ability to get or set any custom data from anyway in your code as necessary.
* @link https://secure.php.net/manual/en/class.yaf-registry.php */ -final class Yaf_Registry { - +final class Yaf_Registry +{ /** * @var Yaf_Registry */ @@ -694,12 +687,12 @@ final class Yaf_Registry { /** * @link https://secure.php.net/manual/en/yaf-registry.construct.php */ - private function __construct(){ } + private function __construct() {} /** * @link https://secure.php.net/manual/en/yaf-registry.clone.php */ - private function __clone(){ } + private function __clone() {} /** * Retrieve an item from registry @@ -710,7 +703,7 @@ private function __clone(){ } * * @return mixed */ - public static function get($name){ } + public static function get($name) {} /** * Check whether an item exists @@ -721,7 +714,7 @@ public static function get($name){ } * * @return bool */ - public static function has($name){ } + public static function has($name) {} /** * @link https://secure.php.net/manual/en/yaf-registry.set.php @@ -731,7 +724,7 @@ public static function has($name){ } * * @return bool */ - public static function set($name, $value){ } + public static function set($name, $value) {} /** * @link https://secure.php.net/manual/en/yaf-registry.del.php @@ -740,15 +733,15 @@ public static function set($name, $value){ } * * @return void|bool */ - public static function del($name){ } + public static function del($name) {} } /** * @link https://secure.php.net/manual/en/class.yaf-session.php * @version 2.2.9 */ -final class Yaf_Session implements Iterator, Traversable, ArrayAccess, Countable { - +final class Yaf_Session implements Iterator, Traversable, ArrayAccess, Countable +{ /** * @var Yaf_Session */ @@ -765,37 +758,36 @@ final class Yaf_Session implements Iterator, Traversable, ArrayAccess, Countable /** * @link https://secure.php.net/manual/en/yaf-session.construct.php */ - private function __construct(){ } + private function __construct() {} /** * @link https://secure.php.net/manual/en/yaf-session.clone.php */ - private function __clone(){ } + private function __clone() {} /** * @link https://secure.php.net/manual/en/yaf-session.sleep.php */ - private function __sleep(){ } + private function __sleep() {} /** * @link https://secure.php.net/manual/en/yaf-session.wakeup.php */ - private function __wakeup(){ } + private function __wakeup() {} /** * @link https://secure.php.net/manual/en/yaf-session.getinstance.php * * @return Yaf_Session */ - public static function getInstance(){ } + public static function getInstance() {} /** * @link https://secure.php.net/manual/en/yaf-session.start.php * * @return Yaf_Session */ - public function start(){ } - + public function start() {} /** * @link https://secure.php.net/manual/en/yaf-session.get.php @@ -804,7 +796,7 @@ public function start(){ } * * @return mixed */ - public function get($name){ } + public function get($name) {} /** * @link https://secure.php.net/manual/en/yaf-session.has.php @@ -813,7 +805,7 @@ public function get($name){ } * * @return bool */ - public function has($name){ } + public function has($name) {} /** * @link https://secure.php.net/manual/en/yaf-session.set.php @@ -823,7 +815,7 @@ public function has($name){ } * * @return Yaf_Session|false return FALSE on failure */ - public function set($name, $value){ } + public function set($name, $value) {} /** * @link https://secure.php.net/manual/en/yaf-session.del.php @@ -832,55 +824,55 @@ public function set($name, $value){ } * * @return Yaf_Session|false return FALSE on failure */ - public function del($name){ } + public function del($name) {} /** * @see Countable::count */ - public function count(){ } + public function count() {} /** * @see Iterator::rewind */ - public function rewind(){ } + public function rewind() {} /** * @see Iterator::current */ - public function current(){ } + public function current() {} /** * @see Iterator::next */ - public function next(){ } + public function next() {} /** * @see Iterator::valid */ - public function valid(){ } + public function valid() {} /** * @see Iterator::key */ - public function key(){ } + public function key() {} /** * @param string $name * @see ArrayAccess::offsetUnset */ - public function offsetUnset($name){ } + public function offsetUnset($name) {} /** * @param string $name * @see ArrayAccess::offsetGet * @return mixed */ - public function offsetGet($name){ } + public function offsetGet($name) {} /** * @see ArrayAccess::offsetExists */ - public function offsetExists($name){ } + public function offsetExists($name) {} /** * @see ArrayAccess::offsetSet @@ -889,27 +881,27 @@ public function offsetExists($name){ } * @param string $value * @return void */ - public function offsetSet($name, $value){ } + public function offsetSet($name, $value) {} /** * @see Yaf_Session::get() */ - public function __get($name){ } + public function __get($name) {} /** * @see Yaf_Session::has() */ - public function __isset($name){ } + public function __isset($name) {} /** * @see Yaf_Session::set() */ - public function __set($name, $value){ } + public function __set($name, $value) {} /** * @see Yaf_Session::del() */ - public function __unset($name){ } + public function __unset($name) {} } /** @@ -925,8 +917,8 @@ public function __unset($name){ } *** See examples by opening the external documentation
* @link https://secure.php.net/manual/en/class.yaf-router.php */ -class Yaf_Router { - +class Yaf_Router +{ /** * @var Yaf_Route_Interface[] registered routes stack */ @@ -939,7 +931,7 @@ class Yaf_Router { /** * @link https://secure.php.net/manual/en/yaf-router.construct.php */ - public function __construct(){ } + public function __construct() {} /** *by default, Yaf_Router using a Yaf_Route_Static as its default route. you can add new routes into router's route stack by calling this method.
@@ -953,7 +945,7 @@ public function __construct(){ } * * @return Yaf_Router|false return FALSE on failure */ - public function addRoute($name, Yaf_Route_Interface $route){ } + public function addRoute($name, Yaf_Route_Interface $route) {} /** *Add routes defined by configs into Yaf_Router's route stack
@@ -964,7 +956,7 @@ public function addRoute($name, Yaf_Route_Interface $route){ } * * @return Yaf_Router|false return FALSE on failure */ - public function addConfig(Yaf_Config_Abstract $config){ } + public function addConfig(Yaf_Config_Abstract $config) {} /** * @link https://secure.php.net/manual/en/yaf-router.route.php @@ -973,7 +965,7 @@ public function addConfig(Yaf_Config_Abstract $config){ } * * @return Yaf_Router|false return FALSE on failure */ - public function route(Yaf_Request_Abstract $request){ } + public function route(Yaf_Request_Abstract $request) {} /** *Retrieve a route by name, see also Yaf_Router::getCurrentRoute()
@@ -984,14 +976,14 @@ public function route(Yaf_Request_Abstract $request){ } * * @return Yaf_Route_Interface */ - public function getRoute($name){ } + public function getRoute($name) {} /** * @link https://secure.php.net/manual/en/yaf-router.getroutes.php * * @return Yaf_Route_Interface[] */ - public function getRoutes(){ } + public function getRoutes() {} /** *Get the name of the route which is effective in the route process.
@@ -1003,7 +995,7 @@ public function getRoutes(){ } * * @return string the name of the effective route. */ - public function getCurrentRoute(){ } + public function getCurrentRoute() {} } /** @@ -1013,9 +1005,7 @@ public function getCurrentRoute(){ } * * @link https://secure.php.net/manual/en/class.yaf-bootstrap-abstract.php */ -abstract class Yaf_Bootstrap_Abstract { - -} +abstract class Yaf_Bootstrap_Abstract {} /** *Yaf_Controller_Abstract is the heart of Yaf's system. MVC stands for Model-View-Controller and is a design pattern targeted at separating application logic from display logic.
@@ -1033,8 +1023,8 @@ abstract class Yaf_Bootstrap_Abstract { * * @link https://secure.php.net/manual/en/class.yaf-controller-abstract.php */ -abstract class Yaf_Controller_Abstract { - +abstract class Yaf_Controller_Abstract +{ /** * @see Yaf_Action_Abstract * @var array You can also define a action method in a separate PHP script by using this property and Yaf_Action_Abstract. @@ -1073,7 +1063,7 @@ abstract class Yaf_Controller_Abstract { * * @return string */ - protected function render($tpl, array $parameters = null){ } + protected function render($tpl, array $parameters = null) {} /** * @link https://secure.php.net/manual/en/yaf-controller-abstract.display.php @@ -1083,7 +1073,7 @@ protected function render($tpl, array $parameters = null){ } * * @return bool */ - protected function display($tpl, array $parameters = null){ } + protected function display($tpl, array $parameters = null) {} /** * retrieve current request object @@ -1092,7 +1082,7 @@ protected function display($tpl, array $parameters = null){ } * * @return Yaf_Request_Abstract */ - public function getRequest(){ } + public function getRequest() {} /** * retrieve current response object @@ -1101,7 +1091,7 @@ public function getRequest(){ } * * @return Yaf_Response_Abstract */ - public function getResponse(){ } + public function getResponse() {} /** * get the controller's module name @@ -1110,7 +1100,7 @@ public function getResponse(){ } * * @return string */ - public function getModuleName(){ } + public function getModuleName() {} /** * retrieve view engine @@ -1119,7 +1109,7 @@ public function getModuleName(){ } * * @return Yaf_View_Interface */ - public function getView(){ } + public function getView() {} /** * @deprecated not_implemented @@ -1129,7 +1119,7 @@ public function getView(){ } * * @return Yaf_Response_Abstract */ - public function initView(array $options = null){ } + public function initView(array $options = null) {} /** * @link https://secure.php.net/manual/en/yaf-controller-abstract.setviewpath.php @@ -1138,14 +1128,14 @@ public function initView(array $options = null){ } * * @return bool */ - public function setViewpath($view_directory){ } + public function setViewpath($view_directory) {} /** * @link https://secure.php.net/manual/en/yaf-controller-abstract.getviewpath.php * * @return string */ - public function getViewpath(){ } + public function getViewpath() {} /** *forward current execution process to other action.
@@ -1167,7 +1157,7 @@ public function getViewpath(){ } * * @return bool return FALSE on failure */ - public function forward($module, $controller = null, $action = null, array $parameters = null){ } + public function forward($module, $controller = null, $action = null, array $parameters = null) {} /** * redirect to a URL by sending a 302 header @@ -1178,14 +1168,14 @@ public function forward($module, $controller = null, $action = null, array $para * * @return bool */ - public function redirect($url){ } + public function redirect($url) {} /** * @link https://secure.php.net/manual/en/yaf-controller-abstract.getinvokeargs.php * * @return array */ - public function getInvokeArgs(){ } + public function getInvokeArgs() {} /** * @link https://secure.php.net/manual/en/yaf-controller-abstract.getinvokearg.php @@ -1193,15 +1183,14 @@ public function getInvokeArgs(){ } * * @return mixed|null */ - public function getInvokeArg($name){ } + public function getInvokeArg($name) {} /** *Yaf_Controller_Abstract::__construct() is final, which means users can not override it. but users can define Yaf_Controller_Abstract::init(), which will be called after controller object is instantiated.
* * @link https://secure.php.net/manual/en/yaf-controller-abstract.init.php - * */ - public function init(){ } + public function init() {} /** * Yaf_Controller_Abstract::__construct() is final, which means it can not be overridden. You may want to see Yaf_Controller_Abstract::init() instead. @@ -1214,12 +1203,12 @@ public function init(){ } * @param Yaf_View_Interface $view * @param array $invokeArgs */ - final public function __construct(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response, Yaf_View_Interface $view, array $invokeArgs = null){ } + final public function __construct(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response, Yaf_View_Interface $view, array $invokeArgs = null) {} /** * @link https://secure.php.net/manual/en/yaf-controller-abstract.clone.php */ - final private function __clone(){ } + final private function __clone() {} } /** @@ -1228,10 +1217,9 @@ final private function __clone(){ } *Since there should be a entry point which can be called by Yaf (as of PHP 5.3, there is a new magic method __invoke, but Yaf is not only works with PHP 5.3+, Yaf choose another magic method execute), you must implement the abstract method Yaf_Action_Abstract::execute() in your custom action class.
* * @link https://secure.php.net/manual/en/class.yaf-action-abstract.php - * */ -abstract class Yaf_Action_Abstract extends Yaf_Controller_Abstract { - +abstract class Yaf_Action_Abstract extends Yaf_Controller_Abstract +{ /** * @var Yaf_Controller_Abstract */ @@ -1256,14 +1244,14 @@ abstract public function execute(); * * @return Yaf_Controller_Abstract */ - public function getController(){ } + public function getController() {} } /** * @link https://secure.php.net/manual/en/class.yaf-config-abstract.php */ -abstract class Yaf_Config_Abstract { - +abstract class Yaf_Config_Abstract +{ /** * @var array */ @@ -1308,10 +1296,10 @@ abstract public function toArray(); /** * @link https://secure.php.net/manual/en/class.yaf-request-abstract.php */ -abstract class Yaf_Request_Abstract { - - const SCHEME_HTTP = 'http'; - const SCHEME_HTTPS = 'https'; +abstract class Yaf_Request_Abstract +{ + public const SCHEME_HTTP = 'http'; + public const SCHEME_HTTPS = 'https'; /** * @var string */ @@ -1362,64 +1350,63 @@ abstract class Yaf_Request_Abstract { * * @return bool */ - public function isGet(){ } + public function isGet() {} /** * @link https://secure.php.net/manual/en/yaf-request-abstract.ispost.php * * @return bool */ - public function isPost(){ } + public function isPost() {} /** * @link https://secure.php.net/manual/en/yaf-request-abstract.isput.php * * @return bool */ - public function isPut(){ } + public function isPut() {} /** * @link https://secure.php.net/manual/en/yaf-request-abstract.ishead.php * * @return bool */ - public function isHead(){ } + public function isHead() {} /** * @link https://secure.php.net/manual/en/yaf-request-abstract.isoptions.php * * @return bool */ - public function isOptions(){ } + public function isOptions() {} /** * @link https://secure.php.net/manual/en/yaf-request-abstract.iscli.php * * @return bool */ - public function isCli(){ } + public function isCli() {} /** * @link https://secure.php.net/manual/en/yaf-request-abstract.isdispached.php * * @return bool */ - public function isDispatched(){ } + public function isDispatched() {} /** * @link https://secure.php.net/manual/en/yaf-request-abstract.isrouted.php * * @return bool */ - public function isRouted(){ } + public function isRouted() {} /** - * * @link https://secure.php.net/manual/en/yaf-request-abstract.isxmlhttprequest.php * * @return bool */ - public function isXmlHttpRequest(){ } + public function isXmlHttpRequest() {} /** * Retrieve $_SERVER variable @@ -1431,7 +1418,7 @@ public function isXmlHttpRequest(){ } * * @return mixed */ - public function getServer($name = null, $default = null){ } + public function getServer($name = null, $default = null) {} /** * Retrieve $_ENV variable @@ -1443,10 +1430,9 @@ public function getServer($name = null, $default = null){ } * * @return mixed */ - public function getEnv($name = null, $default = null){ } + public function getEnv($name = null, $default = null) {} /** - * * @link https://secure.php.net/manual/en/yaf-request-abstract.getparam.php * * @param string $name @@ -1454,43 +1440,42 @@ public function getEnv($name = null, $default = null){ } * * @return mixed */ - public function getParam($name, $default = null){ } + public function getParam($name, $default = null) {} /** - * * @link https://secure.php.net/manual/en/yaf-request-abstract.getparams.php * * @return array */ - public function getParams(){ } + public function getParams() {} /** * @link https://secure.php.net/manual/en/yaf-request-abstract.getexception.php * * @return Yaf_Exception */ - public function getException(){ } + public function getException() {} /** * @link https://secure.php.net/manual/en/yaf-request-abstract.getmoudlename.php * * @return string */ - public function getModuleName(){ } + public function getModuleName() {} /** * @link https://secure.php.net/manual/en/yaf-request-abstract.getcontrollername.php * * @return string */ - public function getControllerName(){ } + public function getControllerName() {} /** * @link https://secure.php.net/manual/en/yaf-request-abstract.getactionname.php * * @return string */ - public function getActionName(){ } + public function getActionName() {} /** * @link https://secure.php.net/manual/en/yaf-request-abstract.setparam.php @@ -1500,7 +1485,7 @@ public function getActionName(){ } * * @return Yaf_Request_Abstract|bool */ - public function setParam($name, $value = null){ } + public function setParam($name, $value = null) {} /** * @link https://secure.php.net/manual/en/yaf-request-abstract.setmodulename.php @@ -1509,7 +1494,7 @@ public function setParam($name, $value = null){ } * * @return Yaf_Request_Abstract|bool */ - public function setModuleName($module){ } + public function setModuleName($module) {} /** * @link https://secure.php.net/manual/en/yaf-request-abstract.setcontrollername.php @@ -1518,7 +1503,7 @@ public function setModuleName($module){ } * * @return Yaf_Request_Abstract|bool */ - public function setControllerName($controller){ } + public function setControllerName($controller) {} /** * @link https://secure.php.net/manual/en/yaf-request-abstract.setactionname.php @@ -1527,21 +1512,21 @@ public function setControllerName($controller){ } * * @return Yaf_Request_Abstract|bool */ - public function setActionName($action){ } + public function setActionName($action) {} /** * @link https://secure.php.net/manual/en/yaf-request-abstract.getmethod.php * * @return string */ - public function getMethod(){ } + public function getMethod() {} /** * @link https://secure.php.net/manual/en/yaf-request-abstract.getlanguage.php * * @return string */ - public function getLanguage(){ } + public function getLanguage() {} /** *Set base URI, base URI is used when doing routing, in routing phase request URI is used to route a request, while base URI is used to skip the leading part(base URI) of request URI. That is, if comes a request with request URI a/b/c, then if you set base URI to "a/b", only "/c" will be used in routing phase.
@@ -1555,21 +1540,21 @@ public function getLanguage(){ } * * @return bool */ - public function setBaseUri($uri){ } + public function setBaseUri($uri) {} /** * @link https://secure.php.net/manual/en/yaf-request-abstract.getbaseuri.php * * @return string */ - public function getBaseUri(){ } + public function getBaseUri() {} /** * @link https://secure.php.net/manual/en/yaf-request-abstract.getrequesturi.php * * @return string */ - public function getRequestUri(){ } + public function getRequestUri() {} /** * @since 2.1.0 @@ -1577,7 +1562,7 @@ public function getRequestUri(){ } * * @param string $uri request URI */ - public function setRequestUri($uri){ } + public function setRequestUri($uri) {} /** * Set request as dispatched @@ -1586,7 +1571,7 @@ public function setRequestUri($uri){ } * * @return bool */ - public function setDispatched(){ } + public function setDispatched() {} /** * Set request as routed @@ -1595,7 +1580,7 @@ public function setDispatched(){ } * * @return Yaf_Request_Abstract|bool */ - public function setRouted(){ } + public function setRouted() {} } /** @@ -1606,8 +1591,8 @@ public function setRouted(){ } *A plugin could be loaded into Yaf by using Yaf_Dispatcher::registerPlugin(), after registered, All the methods which the plugin implemented according to this interface, will be called at the proper time.
* @link https://secure.php.net/manual/en/class.yaf-plugin-abstract.php */ -abstract class Yaf_Plugin_Abstract { - +abstract class Yaf_Plugin_Abstract +{ /** * This is the earliest hook in Yaf plugin hook system, if a custom plugin implement this method, then it will be called before routing a request. * @@ -1618,7 +1603,7 @@ abstract class Yaf_Plugin_Abstract { * * @return bool true */ - public function routerStartup(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response){ } + public function routerStartup(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response) {} /** * This hook will be trigged after the route process finished, this hook is usually used for login check. @@ -1630,7 +1615,7 @@ public function routerStartup(Yaf_Request_Abstract $request, Yaf_Response_Abstra * * @return bool true */ - public function routerShutdown(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response){ } + public function routerShutdown(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response) {} /** * @link https://secure.php.net/manual/en/yaf-plugin-abstract.dispatchloopstartup.php @@ -1640,7 +1625,7 @@ public function routerShutdown(Yaf_Request_Abstract $request, Yaf_Response_Abstr * * @return bool true */ - public function dispatchLoopStartup(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response){ } + public function dispatchLoopStartup(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response) {} /** * This is the latest hook in Yaf plugin hook system, if a custom plugin implement this method, then it will be called after the dispatch loop finished. @@ -1652,7 +1637,7 @@ public function dispatchLoopStartup(Yaf_Request_Abstract $request, Yaf_Response_ * * @return bool true */ - public function dispatchLoopShutdown(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response){ } + public function dispatchLoopShutdown(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response) {} /** * @link https://secure.php.net/manual/en/yaf-plugin-abstract.predispatch.php @@ -1662,7 +1647,7 @@ public function dispatchLoopShutdown(Yaf_Request_Abstract $request, Yaf_Response * * @return bool true */ - public function preDispatch(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response){ } + public function preDispatch(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response) {} /** * @link https://secure.php.net/manual/en/yaf-plugin-abstract.postdispatch.php @@ -1672,7 +1657,7 @@ public function preDispatch(Yaf_Request_Abstract $request, Yaf_Response_Abstract * * @return bool true */ - public function postDispatch(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response){ } + public function postDispatch(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response) {} /** * @link https://secure.php.net/manual/en/yaf-plugin-abstract.preresponse.php @@ -1682,15 +1667,15 @@ public function postDispatch(Yaf_Request_Abstract $request, Yaf_Response_Abstrac * * @return bool true */ - public function preResponse(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response){ } + public function preResponse(Yaf_Request_Abstract $request, Yaf_Response_Abstract $response) {} } /** * @link https://secure.php.net/manual/en/class.yaf-response-abstract.php */ -abstract class Yaf_Response_Abstract { - - const DEFAULT_BODY = "content"; +abstract class Yaf_Response_Abstract +{ + public const DEFAULT_BODY = "content"; /** * @var string */ @@ -1707,22 +1692,22 @@ abstract class Yaf_Response_Abstract { /** * @link https://secure.php.net/manual/en/yaf-response-abstract.construct.php */ - public function __construct(){ } + public function __construct() {} /** * @link https://secure.php.net/manual/en/yaf-response-abstract.destruct.php */ - public function __destruct(){ } + public function __destruct() {} /** * @link https://secure.php.net/manual/en/yaf-response-abstract.clone.php */ - private function __clone(){ } + private function __clone() {} /** * @link https://secure.php.net/manual/en/yaf-response-abstract.tostring.php */ - public function __toString(){ } + public function __toString() {} /** * Send response @@ -1730,7 +1715,7 @@ public function __toString(){ } * * @return void */ - public function response(){ } + public function response() {} /** * Set response header @@ -1742,7 +1727,7 @@ public function response(){ } * * @return bool */ - public function setHeader($name, $value, $replace = false){ } + public function setHeader($name, $value, $replace = false) {} /** * Set content to response @@ -1757,7 +1742,7 @@ public function setHeader($name, $value, $replace = false){ } * * @return bool */ - public function setBody($content, $key = self::DEFAULT_BODY){ } + public function setBody($content, $key = self::DEFAULT_BODY) {} /** * append a content to a exists content block @@ -1772,7 +1757,7 @@ public function setBody($content, $key = self::DEFAULT_BODY){ } * * @return bool */ - public function appendBody($content, $key = self::DEFAULT_BODY){ } + public function appendBody($content, $key = self::DEFAULT_BODY) {} /** * prepend a content to a exists content block @@ -1787,7 +1772,7 @@ public function appendBody($content, $key = self::DEFAULT_BODY){ } * * @return bool */ - public function prependBody($content, $key = self::DEFAULT_BODY){ } + public function prependBody($content, $key = self::DEFAULT_BODY) {} /** * Clear existing content @@ -1801,7 +1786,7 @@ public function prependBody($content, $key = self::DEFAULT_BODY){ } * * @return bool */ - public function clearBody($key = self::DEFAULT_BODY){ } + public function clearBody($key = self::DEFAULT_BODY) {} /** * Retrieve an existing content @@ -1815,7 +1800,7 @@ public function clearBody($key = self::DEFAULT_BODY){ } * * @return mixed */ - public function getBody($key = self::DEFAULT_BODY){ } + public function getBody($key = self::DEFAULT_BODY) {} } /** @@ -1823,8 +1808,8 @@ public function getBody($key = self::DEFAULT_BODY){ } * * @link https://secure.php.net/manual/en/class.yaf-view-interface.php */ -interface Yaf_View_Interface { - +interface Yaf_View_Interface +{ /** * Assign values to View engine, then the value can access directly by name in template. * @@ -1834,7 +1819,7 @@ interface Yaf_View_Interface { * @param string $value * @return bool */ - function assign($name, $value); + public function assign($name, $value); /** * Render a template and output the result immediately. @@ -1845,14 +1830,14 @@ function assign($name, $value); * @param array $tpl_vars * @return bool */ - function display($tpl, array $tpl_vars = null); + public function display($tpl, array $tpl_vars = null); /** * @link https://secure.php.net/manual/en/yaf-view-interface.getscriptpath.php * * @return string */ - function getScriptPath(); + public function getScriptPath(); /** * Render a template and return the result. @@ -1863,7 +1848,7 @@ function getScriptPath(); * @param array $tpl_vars * @return string */ - function render($tpl, array $tpl_vars = null); + public function render($tpl, array $tpl_vars = null); /** * Set the templates base directory, this is usually called by Yaf_Dispatcher @@ -1872,7 +1857,7 @@ function render($tpl, array $tpl_vars = null); * * @param string $template_dir An absolute path to the template directory, by default, Yaf_Dispatcher use application.directory . "/views" as this parameter. */ - function setScriptPath($template_dir); + public function setScriptPath($template_dir); } /** @@ -1880,8 +1865,8 @@ function setScriptPath($template_dir); * * @link https://secure.php.net/manual/en/class.yaf-route-interface.php */ -interface Yaf_Route_Interface { - +interface Yaf_Route_Interface +{ /** *Yaf_Route_Interface::route() is the only method that a custom route should implement.
if this method return TRUE, then the route process will be end. otherwise, Yaf_Router will call next route in the route stack to route request.
Yaf_Route_Interface::assemble() - assemble a request
Yaf_Config_Ini utilizes the » parse_ini_file() PHP function. Please review this documentation to be aware of its specific behaviors, which propagate to Yaf_Config_Ini, such as how the special values of "TRUE", "FALSE", "yes", "no", and "NULL" are handled.
* @link https://secure.php.net/manual/en/class.yaf-config-ini.php */ -class Yaf_Config_Ini extends Yaf_Config_Abstract implements Iterator, Traversable, ArrayAccess, Countable { - +class Yaf_Config_Ini extends Yaf_Config_Abstract implements Iterator, Traversable, ArrayAccess, Countable +{ /** * @see Yaf_Config_Abstract::get */ - public function __get($name = null){ } + public function __get($name = null) {} /** * @see Yaf_Config_Abstract::set */ - public function __set($name, $value){ } + public function __set($name, $value) {} /** * @see Yaf_Config_Abstract::get */ - public function get($name = null){ } + public function get($name = null) {} /** * @see Yaf_Config_Abstract::set * @deprecated not_implemented */ - public function set($name, $value){ } + public function set($name, $value) {} /** * @see Yaf_Config_Abstract::toArray */ - public function toArray(){ } + public function toArray() {} /** * @see Yaf_Config_Abstract::readonly */ - public function readonly(){ } + public function readonly() {} /** * @link https://secure.php.net/manual/en/yaf-config-ini.construct.php @@ -2269,165 +2238,164 @@ public function readonly(){ } * * @throws Yaf_Exception_TypeError */ - public function __construct($config_file, $section = null){ } + public function __construct($config_file, $section = null) {} /** * @link https://secure.php.net/manual/en/yaf-config-ini.isset.php * @param string $name */ - public function __isset($name){ } + public function __isset($name) {} /** * @see Countable::count */ - public function count(){ } + public function count() {} /** * @see Iterator::rewind */ - public function rewind(){ } + public function rewind() {} /** * @see Iterator::current */ - public function current(){ } + public function current() {} /** * @see Iterator::next */ - public function next(){ } + public function next() {} /** * @see Iterator::valid */ - public function valid(){ } + public function valid() {} /** * @see Iterator::key */ - public function key(){ } + public function key() {} /** * @see ArrayAccess::offsetUnset * @deprecated not_implemented */ - public function offsetUnset($name){ } + public function offsetUnset($name) {} /** * @see ArrayAccess::offsetGet */ - public function offsetGet($name){ } + public function offsetGet($name) {} /** * @see ArrayAccess::offsetExists */ - public function offsetExists($name){ } + public function offsetExists($name) {} /** * @see ArrayAccess::offsetSet */ - public function offsetSet($name, $value){ } + public function offsetSet($name, $value) {} } /** * @link https://secure.php.net/manual/en/class.yaf-config-simple.php */ -class Yaf_Config_Simple extends Yaf_Config_Abstract implements Iterator, Traversable, ArrayAccess, Countable { - +class Yaf_Config_Simple extends Yaf_Config_Abstract implements Iterator, Traversable, ArrayAccess, Countable +{ /** * @see Yaf_Config_Abstract::get */ - public function __get($name = null){ } + public function __get($name = null) {} /** * @see Yaf_Config_Abstract::set */ - public function __set($name, $value){ } + public function __set($name, $value) {} /** * @see Yaf_Config_Abstract::get */ - public function get($name = null){ } + public function get($name = null) {} /** * @see Yaf_Config_Abstract::set */ - public function set($name, $value){ } + public function set($name, $value) {} /** * @see Yaf_Config_Abstract::toArray */ - public function toArray(){ } + public function toArray() {} /** * @see Yaf_Config_Abstract::readonly */ - public function readonly(){ } + public function readonly() {} /** * @link https://secure.php.net/manual/en/yaf-config-simple.construct.php * * @param array $array * @param bool $readonly - * */ - public function __construct(array $array, $readonly = null){ } + public function __construct(array $array, $readonly = null) {} /** * @link https://secure.php.net/manual/en/yaf-config-simple.isset.php * @param string $name */ - public function __isset($name){ } + public function __isset($name) {} /** * @see Countable::count */ - public function count(){ } + public function count() {} /** * @see Iterator::rewind */ - public function rewind(){ } + public function rewind() {} /** * @see Iterator::current */ - public function current(){ } + public function current() {} /** * @see Iterator::next */ - public function next(){ } + public function next() {} /** * @see Iterator::valid */ - public function valid(){ } + public function valid() {} /** * @see Iterator::key */ - public function key(){ } + public function key() {} /** * @see ArrayAccess::offsetUnset */ - public function offsetUnset($name){ } + public function offsetUnset($name) {} /** * @see ArrayAccess::offsetGet */ - public function offsetGet($name){ } + public function offsetGet($name) {} /** * @see ArrayAccess::offsetExists */ - public function offsetExists($name){ } + public function offsetExists($name) {} /** * @see ArrayAccess::offsetSet */ - public function offsetSet($name, $value){ } + public function offsetSet($name, $value) {} } /** @@ -2443,8 +2411,8 @@ public function offsetSet($name, $value){ } * * @return void|false return FALSE on failure */ -class Yaf_View_Simple implements Yaf_View_Interface { - +class Yaf_View_Simple implements Yaf_View_Interface +{ /** * @var string */ @@ -2469,14 +2437,14 @@ class Yaf_View_Simple implements Yaf_View_Interface { * * @throws Yaf_Exception_TypeError */ - final public function __construct($template_dir, array $options = null){ } + final public function __construct($template_dir, array $options = null) {} /** * @link https://secure.php.net/manual/en/yaf-view-simple.isset.php * * @param string $name */ - public function __isset($name){ } + public function __isset($name) {} /** * assign variable to view engine @@ -2487,7 +2455,7 @@ public function __isset($name){ } * @param mixed $value mixed value * @return Yaf_View_Simple */ - public function assign($name, $value = null){ } + public function assign($name, $value = null) {} /** * @link https://secure.php.net/manual/en/yaf-view-simple.render.php @@ -2499,7 +2467,7 @@ public function assign($name, $value = null){ } * * @return string|void */ - public function render($tpl, array $tpl_vars = null){ } + public function render($tpl, array $tpl_vars = null) {} /** *Render a template and display the result instantly.
@@ -2513,7 +2481,7 @@ public function render($tpl, array $tpl_vars = null){ } * * @return bool */ - public function display($tpl, array $tpl_vars = null){ } + public function display($tpl, array $tpl_vars = null) {} /** *unlike Yaf_View_Simple::assign(), this method assign a ref value to engine.
@@ -2524,7 +2492,7 @@ public function display($tpl, array $tpl_vars = null){ } * * @return Yaf_View_Simple */ - public function assignRef($name, &$value){ } + public function assignRef($name, &$value) {} /** * clear assigned variable @@ -2534,7 +2502,7 @@ public function assignRef($name, &$value){ } * * @return Yaf_View_Simple */ - public function clear($name = null){ } + public function clear($name = null) {} /** * @link https://secure.php.net/manual/en/yaf-view-simple.setscriptpath.php @@ -2543,14 +2511,14 @@ public function clear($name = null){ } * * @return Yaf_View_Simple */ - public function setScriptPath($template_dir){ } + public function setScriptPath($template_dir) {} /** * @link https://secure.php.net/manual/en/yaf-view-simple.getscriptpath.php * * @return string */ - public function getScriptPath(){ } + public function getScriptPath() {} /** *Retrieve assigned variable
@@ -2565,7 +2533,7 @@ public function getScriptPath(){ } * * @return mixed */ - public function __get($name = null){ } + public function __get($name = null) {} /** *This is a alternative and easier way to Yaf_View_Simple::assign().
@@ -2575,7 +2543,7 @@ public function __get($name = null){ } * @param string $name A string value name. * @param mixed $value mixed value */ - public function __set($name, $value = null){ } + public function __set($name, $value = null) {} } /** @@ -2587,10 +2555,9 @@ public function __set($name, $value = null){ } *it is unnecessary to instance a Yaf_Route_Static, also unnecessary to add it into Yaf_Router's routes stack, since there is always be one in Yaf_Router's routes stack, and always be called at the last time.
* * @link https://secure.php.net/manual/en/class.yaf-route-static.php - * */ -class Yaf_Route_Static implements Yaf_Route_Interface { - +class Yaf_Route_Static implements Yaf_Route_Interface +{ /** * @deprecated not_implemented * @link https://secure.php.net/manual/en/yaf-route-static.match.php @@ -2599,7 +2566,7 @@ class Yaf_Route_Static implements Yaf_Route_Interface { * * @return bool */ - public function match($uri){ } + public function match($uri) {} /** * @link https://secure.php.net/manual/en/yaf-route-static.route.php @@ -2608,7 +2575,7 @@ public function match($uri){ } * * @return bool always TRUE */ - public function route(Yaf_Request_Abstract $request){ } + public function route(Yaf_Request_Abstract $request) {} /** *Yaf_Route_Static::assemble() - Assemble a url
@@ -2619,7 +2586,7 @@ public function route(Yaf_Request_Abstract $request){ } * @param array $query * @return bool */ - public function assemble(array $info, array $query = null){ } + public function assemble(array $info, array $query = null) {} } /** @@ -2631,8 +2598,8 @@ public function assemble(array $info, array $query = null){ } * * @link https://secure.php.net/manual/en/class.yaf-route-simple.php */ -final class Yaf_Route_Simple implements Yaf_Route_Interface { - +final class Yaf_Route_Simple implements Yaf_Route_Interface +{ /** * @var string */ @@ -2657,7 +2624,7 @@ final class Yaf_Route_Simple implements Yaf_Route_Interface { * * @throws Yaf_Exception_TypeError */ - public function __construct($module_name, $controller_name, $action_name){ } + public function __construct($module_name, $controller_name, $action_name) {} /** *see Yaf_Route_Simple::__construct()
@@ -2668,7 +2635,7 @@ public function __construct($module_name, $controller_name, $action_name){ } * * @return bool always TRUE */ - public function route(Yaf_Request_Abstract $request){ } + public function route(Yaf_Request_Abstract $request) {} /** *Yaf_Route_Simple::assemble() - Assemble a url
@@ -2679,14 +2646,14 @@ public function route(Yaf_Request_Abstract $request){ } * @param array $query * @return bool */ - public function assemble(array $info, array $query = null){ } + public function assemble(array $info, array $query = null) {} } /** * @link https://secure.php.net/manual/en/class.yaf-route-supervar.php */ -final class Yaf_Route_Supervar implements Yaf_Route_Interface { - +final class Yaf_Route_Supervar implements Yaf_Route_Interface +{ /** * @var string */ @@ -2701,7 +2668,7 @@ final class Yaf_Route_Supervar implements Yaf_Route_Interface { * * @throws Yaf_Exception_TypeError */ - public function __construct($supervar_name){ } + public function __construct($supervar_name) {} /** * @link https://secure.php.net/manual/en/yaf-route-supervar.route.php @@ -2710,7 +2677,7 @@ public function __construct($supervar_name){ } * * @return bool If there is a key(which was defined in Yaf_Route_Supervar::__construct()) in $_GET, return TRUE. otherwise return FALSE. */ - public function route(Yaf_Request_Abstract $request){ } + public function route(Yaf_Request_Abstract $request) {} /** *Yaf_Route_Supervar::assemble() - Assemble a url
@@ -2721,7 +2688,7 @@ public function route(Yaf_Request_Abstract $request){ } * @param array $query * @return bool */ - public function assemble(array $info, array $query = null){ } + public function assemble(array $info, array $query = null) {} } /** @@ -2729,8 +2696,8 @@ public function assemble(array $info, array $query = null){ } * * @link https://secure.php.net/manual/en/class.yaf-route-rewrite.php */ -final class Yaf_Route_Rewrite extends Yaf_Router implements Yaf_Route_Interface { - +final class Yaf_Route_Rewrite extends Yaf_Router implements Yaf_Route_Interface +{ /** * @var string */ @@ -2756,7 +2723,7 @@ final class Yaf_Route_Rewrite extends Yaf_Router implements Yaf_Route_Interface * * @throws Yaf_Exception_TypeError */ - public function __construct($match, array $route, array $verify = null, $reverse = null){ } + public function __construct($match, array $route, array $verify = null, $reverse = null) {} /** * @link https://secure.php.net/manual/en/yaf-route-rewrite.route.php @@ -2765,7 +2732,7 @@ public function __construct($match, array $route, array $verify = null, $reverse * * @return bool */ - public function route(Yaf_Request_Abstract $request){ } + public function route(Yaf_Request_Abstract $request) {} /** *Yaf_Route_Rewrite::assemble() - Assemble a url
@@ -2776,7 +2743,7 @@ public function route(Yaf_Request_Abstract $request){ } * @param array $query * @return bool */ - public function assemble(array $info, array $query = null){ } + public function assemble(array $info, array $query = null) {} } /** @@ -2784,8 +2751,8 @@ public function assemble(array $info, array $query = null){ } * * @link https://secure.php.net/manual/en/class.yaf-route-regex.php */ -final class Yaf_Route_Regex extends Yaf_Router implements Yaf_Route_Interface { - +final class Yaf_Route_Regex extends Yaf_Router implements Yaf_Route_Interface +{ /** * @var string */ @@ -2820,7 +2787,7 @@ final class Yaf_Route_Regex extends Yaf_Router implements Yaf_Route_Interface { * * @throws Yaf_Exception_TypeError */ - public function __construct($match, array $route, array $map = null, array $verify = null, $reverse = null){ } + public function __construct($match, array $route, array $map = null, array $verify = null, $reverse = null) {} /** * Route a incoming request. @@ -2831,7 +2798,7 @@ public function __construct($match, array $route, array $map = null, array $veri * * @return bool If the pattern given by the first parameter of Yaf_Route_Regex::_construct() matches the request uri, return TRUE, otherwise return FALSE. */ - public function route(Yaf_Request_Abstract $request){ } + public function route(Yaf_Request_Abstract $request) {} /** *Yaf_Route_Regex::assemble() - Assemble a url
@@ -2842,7 +2809,7 @@ public function route(Yaf_Request_Abstract $request){ } * @param array $query * @return bool */ - public function assemble(array $info, array $query = null){ } + public function assemble(array $info, array $query = null) {} } /** @@ -2852,8 +2819,8 @@ public function assemble(array $info, array $query = null){ } * * @link https://secure.php.net/manual/en/class.yaf-route-map.php */ -final class Yaf_Route_Map implements Yaf_Route_Interface { - +final class Yaf_Route_Map implements Yaf_Route_Interface +{ /** * @var string */ @@ -2869,7 +2836,7 @@ final class Yaf_Route_Map implements Yaf_Route_Interface { * @param bool $controller_prefer Whether the result should considering as controller or action * @param string $delimiter */ - public function __construct($controller_prefer = false, $delimiter = ''){ } + public function __construct($controller_prefer = false, $delimiter = '') {} /** * @link https://secure.php.net/manual/en/yaf-route-map.route.php @@ -2878,7 +2845,7 @@ public function __construct($controller_prefer = false, $delimiter = ''){ } * * @return bool */ - public function route(Yaf_Request_Abstract $request){ } + public function route(Yaf_Request_Abstract $request) {} /** *Yaf_Route_Map::assemble() - Assemble a url
@@ -2889,68 +2856,50 @@ public function route(Yaf_Request_Abstract $request){ } * @param array $query * @return bool */ - public function assemble(array $info, array $query = null){ } + public function assemble(array $info, array $query = null) {} } /** * @link https://secure.php.net/manual/en/class.yaf-exception-typeerror.php */ -class Yaf_Exception_TypeError extends Yaf_Exception { - -} +class Yaf_Exception_TypeError extends Yaf_Exception {} /** * @link https://secure.php.net/manual/en/class.yaf-exception-startuperror.php */ -class Yaf_Exception_StartupError extends Yaf_Exception { - -} +class Yaf_Exception_StartupError extends Yaf_Exception {} /** * @link https://secure.php.net/manual/en/class.yaf-exception-routefaild.php */ -class Yaf_Exception_RouterFailed extends Yaf_Exception { - -} +class Yaf_Exception_RouterFailed extends Yaf_Exception {} /** * @link https://secure.php.net/manual/en/class.yaf-exception-dispatchfaild.php */ -class Yaf_Exception_DispatchFailed extends Yaf_Exception { - -} +class Yaf_Exception_DispatchFailed extends Yaf_Exception {} /** * @link https://secure.php.net/manual/en/class.yaf-exception-loadfaild.php */ -class Yaf_Exception_LoadFailed extends Yaf_Exception { - -} +class Yaf_Exception_LoadFailed extends Yaf_Exception {} /** * @link https://secure.php.net/manual/en/class.yaf-exception-loadfaild-module.php */ -class Yaf_Exception_LoadFailed_Module extends Yaf_Exception_LoadFailed { - -} +class Yaf_Exception_LoadFailed_Module extends Yaf_Exception_LoadFailed {} /** * @link https://secure.php.net/manual/en/class.yaf-exception-loadfaild-controller.php */ -class Yaf_Exception_LoadFailed_Controller extends Yaf_Exception_LoadFailed { - -} +class Yaf_Exception_LoadFailed_Controller extends Yaf_Exception_LoadFailed {} /** * @link https://secure.php.net/manual/en/class.yaf-exception-loadfaild-action.php */ -class Yaf_Exception_LoadFailed_Action extends Yaf_Exception_LoadFailed { - -} +class Yaf_Exception_LoadFailed_Action extends Yaf_Exception_LoadFailed {} /** * @link https://secure.php.net/manual/en/class.yaf-exception-loadfaild-view.php */ -class Yaf_Exception_LoadFailed_View extends Yaf_Exception_LoadFailed { - -} +class Yaf_Exception_LoadFailed_View extends Yaf_Exception_LoadFailed {} diff --git a/yaf/yaf_namespace.php b/yaf/yaf_namespace.php index 811f38471..36ce276ae 100644 --- a/yaf/yaf_namespace.php +++ b/yaf/yaf_namespace.php @@ -1,7 +1,7 @@ * Note: @@ -31,7 +32,6 @@ */ final class Application { - /** * @var \Yaf\Application */ @@ -114,9 +114,7 @@ final class Application * * @throws \Yaf\Exception\TypeError|\Yaf\Exception\StartupError */ - public function __construct($config, $envrion = null) - { - } + public function __construct($config, $envrion = null) {} /** * Run a \Yaf\Application, let the \Yaf\Application accept a request, and route the request, dispatch to controller/action, and render response. @@ -125,9 +123,7 @@ public function __construct($config, $envrion = null) * @link https://secure.php.net/manual/en/yaf-application.run.php * @throws \Yaf\Exception\StartupError */ - public function run() - { - } + public function run() {} /** * This method is typically used to run \Yaf\Application in a crontab work. @@ -138,9 +134,7 @@ public function run() * @param callable $entry a valid callback * @param string ...$_ parameters will pass to the callback */ - public function execute(callable $entry, ...$_) - { - } + public function execute(callable $entry, ...$_) {} /** * Retrieve the \Yaf\Application instance, alternatively, we also could use \Yaf\Dispatcher::getApplication(). @@ -149,9 +143,7 @@ public function execute(callable $entry, ...$_) * * @return \Yaf\Application|null an \Yaf\Application instance, if no \Yaf\Application initialized before, NULL will be returned. */ - public static function app() - { - } + public static function app() {} /** * Retrieve environ which was defined in yaf.environ which has a default value "product". @@ -160,9 +152,7 @@ public static function app() * * @return string */ - public function environ() - { - } + public function environ() {} /** * Run a Bootstrap, all the methods defined in the Bootstrap and named with prefix "_init" will be called according to their declaration order, if the parameter bootstrap is not supplied, Yaf will look for a Bootstrap under application.directory. @@ -172,18 +162,14 @@ public function environ() * @param \Yaf\Bootstrap_Abstract $bootstrap A \Yaf\Bootstrap_Abstract instance * @return \Yaf\Application */ - public function bootstrap(\Yaf\Bootstrap_Abstract $bootstrap = null) - { - } + public function bootstrap(Yaf\Bootstrap_Abstract $bootstrap = null) {} /** * @link https://secure.php.net/manual/en/yaf-application.getconfig.php * * @return \Yaf\Config_Abstract */ - public function getConfig() - { - } + public function getConfig() {} /** * Get the modules list defined in config, if no one defined, there will always be a module named "Index". @@ -192,18 +178,14 @@ public function getConfig() * * @return array */ - public function getModules() - { - } + public function getModules() {} /** * @link https://secure.php.net/manual/en/yaf-application.getdispatcher.php * * @return \Yaf\Dispatcher */ - public function getDispatcher() - { - } + public function getDispatcher() {} /** * Change the application directory @@ -214,9 +196,7 @@ public function getDispatcher() * @param string $directory * @return \Yaf\Application */ - public function setAppDirectory($directory) - { - } + public function setAppDirectory($directory) {} /** * @since 2.1.4 @@ -224,9 +204,7 @@ public function setAppDirectory($directory) * * @return string */ - public function getAppDirectory() - { - } + public function getAppDirectory() {} /** * @since 2.1.2 @@ -234,9 +212,7 @@ public function getAppDirectory() * * @return int */ - public function getLastErrorNo() - { - } + public function getLastErrorNo() {} /** * @since 2.1.2 @@ -244,50 +220,33 @@ public function getLastErrorNo() * * @return string */ - public function getLastErrorMsg() - { - } + public function getLastErrorMsg() {} /** - * * @since 2.1.2 * @link https://secure.php.net/manual/en/yaf-application.clearlasterror.php */ - public function clearLastError() - { - } + public function clearLastError() {} /** - * * @link https://secure.php.net/manual/en/yaf-application.destruct.php */ - public function __destruct() - { - } + public function __destruct() {} /** - * * @link https://secure.php.net/manual/en/yaf-application.clone.php */ - private function __clone() - { - } + private function __clone() {} /** - * * @link https://secure.php.net/manual/en/yaf-application.sleep.php */ - private function __sleep() - { - } + private function __sleep() {} /** - * * @link https://secure.php.net/manual/en/yaf-application.wakeup.php */ - private function __wakeup() - { - } + private function __wakeup() {} }/** *\Yaf\Dispatcher purpose is to initialize the request environment, route the incoming request, and then dispatch any discovered actions; it aggregates any responses and returns them when the process is complete.
\Yaf\Dispatcher also implements the Singleton pattern, meaning only a single instance of it may be available at any given time. This allows it to also act as a registry on which the other objects in the dispatch process may draw.
@@ -296,7 +255,6 @@ private function __wakeup() */ final class Dispatcher { - /** * @var \Yaf\Dispatcher */ @@ -345,30 +303,22 @@ final class Dispatcher /** * @link https://secure.php.net/manual/en/yaf-dispatcher.construct.php */ - private function __construct() - { - } + private function __construct() {} /** * @link https://secure.php.net/manual/en/yaf-dispatcher.clone.php */ - private function __clone() - { - } + private function __clone() {} /** * @link https://secure.php.net/manual/en/yaf-dispatcher.sleep.php */ - private function __sleep() - { - } + private function __sleep() {} /** * @link https://secure.php.net/manual/en/yaf-dispatcher.wakeup.php */ - private function __wakeup() - { - } + private function __wakeup() {} /** * enable view rendering @@ -377,9 +327,7 @@ private function __wakeup() * * @return \Yaf\Dispatcher */ - public function enableView() - { - } + public function enableView() {} /** *disable view engine, used in some app that user will output by himself
Set error handler for Yaf. when application.dispatcher.throwException is off, Yaf will trigger catch-able error while unexpected errors occurred.
\Yaf\Dispatcher will render automatically after dispatches an incoming request, you can prevent the rendering by calling this method with $flag TRUE
This method does the heavy work of the \Yaf\Dispatcher. It take a request object.
Switch on/off exception throwing while unexpected error occurring. When this is on, Yaf will throwing exceptions instead of triggering catchable errors.
While the application.dispatcher.throwException is On(you can also calling to \Yaf\Dispatcher::throwException(TRUE) to enable it), Yaf will throw \Exception whe error occurs instead of trigger error.
\Yaf\Loader introduces a comprehensive autoloading solution for Yaf.
*If you want \Yaf\Loader search some classes(libraries) in the local class directory(which is defined in application.ini, and by default, it is application.directory . "/library"), you should register the class prefix using the \Yaf\Loader::registerLocalNameSpace()
* @link https://secure.php.net/manual/en/class.yaf-loader.php - * */ class Loader { - /** * @var string */ @@ -656,30 +563,22 @@ class Loader /** * @link https://secure.php.net/manual/en/yaf-loader.construct.php */ - private function __construct() - { - } + private function __construct() {} /** * @link https://secure.php.net/manual/en/yaf-loader.clone.php */ - private function __clone() - { - } + private function __clone() {} /** * @link https://secure.php.net/manual/en/yaf-loader.sleep.php */ - private function __sleep() - { - } + private function __sleep() {} /** * @link https://secure.php.net/manual/en/yaf-loader.wakeup.php */ - private function __wakeup() - { - } + private function __wakeup() {} /** * @link https://secure.php.net/manual/en/yaf-loader.autoload.php @@ -688,9 +587,7 @@ private function __wakeup() * * @return bool */ - public function autoload($class_name) - { - } + public function autoload($class_name) {} /** * @link https://secure.php.net/manual/en/yaf-loader.getinstance.php @@ -700,9 +597,7 @@ public function autoload($class_name) * * @return \Yaf\Loader */ - public static function getInstance($local_library_path = null, $global_library_path = null) - { - } + public static function getInstance($local_library_path = null, $global_library_path = null) {} /** *Register local class prefix name, \Yaf\Loader search classes in two library directories, the one is configured via application.library.directory(in application.ini) which is called local library directory; the other is configured via yaf.library (in php.ini) which is called global library directory, since it can be shared by many applications in the same server.
@@ -717,25 +612,19 @@ public static function getInstance($local_library_path = null, $global_library_p * * @return bool */ - public function registerLocalNamespace($name_prefix) - { - } + public function registerLocalNamespace($name_prefix) {} /** * @link https://secure.php.net/manual/en/yaf-loader.getlocalnamespace.php * * @return string */ - public function getLocalNamespace() - { - } + public function getLocalNamespace() {} /** * @link https://secure.php.net/manual/en/yaf-loader.clearlocalnamespace.php */ - public function clearLocalNamespace() - { - } + public function clearLocalNamespace() {} /** * @link https://secure.php.net/manual/en/yaf-loader.islocalname.php @@ -744,9 +633,7 @@ public function clearLocalNamespace() * * @return bool */ - public function isLocalName($class_name) - { - } + public function isLocalName($class_name) {} /** * @link https://secure.php.net/manual/en/yaf-loader.import.php @@ -755,9 +642,7 @@ public function isLocalName($class_name) * * @return bool */ - public static function import($file) - { - } + public static function import($file) {} /** * @since 2.1.4 @@ -768,9 +653,7 @@ public static function import($file) * * @return \Yaf\Loader */ - public function setLibraryPath($directory, $global = false) - { - } + public function setLibraryPath($directory, $global = false) {} /** * @since 2.1.4 @@ -780,16 +663,13 @@ public function setLibraryPath($directory, $global = false) * * @return string */ - public function getLibraryPath($is_global = false) - { - } + public function getLibraryPath($is_global = false) {} }/** *All methods of \Yaf\Registry declared as static, making it universally accessible. This provides the ability to get or set any custom data from anyway in your code as necessary.
* @link https://secure.php.net/manual/en/class.yaf-registry.php */ final class Registry { - /** * @var \Yaf\Registry */ @@ -802,16 +682,12 @@ final class Registry /** * @link https://secure.php.net/manual/en/yaf-registry.construct.php */ - private function __construct() - { - } + private function __construct() {} /** * @link https://secure.php.net/manual/en/yaf-registry.clone.php */ - private function __clone() - { - } + private function __clone() {} /** * Retrieve an item from registry @@ -822,9 +698,7 @@ private function __clone() * * @return mixed */ - public static function get($name) - { - } + public static function get($name) {} /** * Check whether an item exists @@ -835,9 +709,7 @@ public static function get($name) * * @return bool */ - public static function has($name) - { - } + public static function has($name) {} /** * @link https://secure.php.net/manual/en/yaf-registry.set.php @@ -847,9 +719,7 @@ public static function has($name) * * @return bool */ - public static function set($name, $value) - { - } + public static function set($name, $value) {} /** * @link https://secure.php.net/manual/en/yaf-registry.del.php @@ -858,16 +728,13 @@ public static function set($name, $value) * * @return void|bool */ - public static function del($name) - { - } + public static function del($name) {} }/** * @link https://secure.php.net/manual/en/class.yaf-session.php * @version 2.2.9 */ final class Session implements \Iterator, \Traversable, \ArrayAccess, \Countable { - /** * @var \Yaf\Session */ @@ -884,48 +751,36 @@ final class Session implements \Iterator, \Traversable, \ArrayAccess, \Countable /** * @link https://secure.php.net/manual/en/yaf-session.construct.php */ - private function __construct() - { - } + private function __construct() {} /** * @link https://secure.php.net/manual/en/yaf-session.clone.php */ - private function __clone() - { - } + private function __clone() {} /** * @link https://secure.php.net/manual/en/yaf-session.sleep.php */ - private function __sleep() - { - } + private function __sleep() {} /** * @link https://secure.php.net/manual/en/yaf-session.wakeup.php */ - private function __wakeup() - { - } + private function __wakeup() {} /** * @link https://secure.php.net/manual/en/yaf-session.getinstance.php * * @return \Yaf\Session */ - public static function getInstance() - { - } + public static function getInstance() {} /** * @link https://secure.php.net/manual/en/yaf-session.start.php * * @return \Yaf\Session */ - public function start() - { - } + public function start() {} /** * @link https://secure.php.net/manual/en/yaf-session.get.php @@ -934,9 +789,7 @@ public function start() * * @return mixed */ - public function get($name) - { - } + public function get($name) {} /** * @link https://secure.php.net/manual/en/yaf-session.has.php @@ -945,9 +798,7 @@ public function get($name) * * @return bool */ - public function has($name) - { - } + public function has($name) {} /** * @link https://secure.php.net/manual/en/yaf-session.set.php @@ -957,9 +808,7 @@ public function has($name) * * @return \Yaf\Session|false return FALSE on failure */ - public function set($name, $value) - { - } + public function set($name, $value) {} /** * @link https://secure.php.net/manual/en/yaf-session.del.php @@ -968,107 +817,77 @@ public function set($name, $value) * * @return \Yaf\Session|false return FALSE on failure */ - public function del($name) - { - } + public function del($name) {} /** * @see \Countable::count */ - public function count() - { - } + public function count() {} /** * @see \Iterator::rewind */ - public function rewind() - { - } + public function rewind() {} /** * @see \Iterator::current */ - public function current() - { - } + public function current() {} /** * @see \Iterator::next */ - public function next() - { - } + public function next() {} /** * @see \Iterator::valid */ - public function valid() - { - } + public function valid() {} /** * @see \Iterator::key */ - public function key() - { - } + public function key() {} /** * @see \ArrayAccess::offsetUnset */ - public function offsetUnset($name) - { - } + public function offsetUnset($name) {} /** * @see \ArrayAccess::offsetGet */ - public function offsetGet($name) - { - } + public function offsetGet($name) {} /** * @see \ArrayAccess::offsetExists */ - public function offsetExists($name) - { - } + public function offsetExists($name) {} /** * @see \ArrayAccess::offsetSet */ - public function offsetSet($name, $value) - { - } + public function offsetSet($name, $value) {} /** * @see \Yaf\Session::get() */ - public function __get($name) - { - } + public function __get($name) {} /** * @see \Yaf\Session::has() */ - public function __isset($name) - { - } + public function __isset($name) {} /** * @see \Yaf\Session::set() */ - public function __set($name, $value) - { - } + public function __set($name, $value) {} /** * @see \Yaf\Session::del() */ - public function __unset($name) - { - } + public function __unset($name) {} }/** *\Yaf\Router is the standard framework router. Routing is the process of taking a URI endpoint (that part of the URI which comes after the base URI: see \Yaf\Request_Abstract::setBaseUri()) and decomposing it into parameters to determine which module, controller, and action of that controller should receive the request. This values of the module, controller, action and other parameters are packaged into a \Yaf\Request_Abstract object which is then processed by \Yaf\Dispatcher. Routing occurs only once: when the request is initially received and before the first controller is dispatched. \Yaf\Router is designed to allow for mod_rewrite-like functionality using pure PHP structures. It is very loosely based on Ruby on Rails routing and does not require any prior knowledge of webserver URL rewriting
*by default, \Yaf\Router using a \Yaf\Route_Static as its default route. you can add new routes into router's route stack by calling this method.
@@ -1113,9 +929,7 @@ public function __construct() * * @return \Yaf\Router|false return FALSE on failure */ - public function addRoute($name, \Yaf\Route_Interface $route) - { - } + public function addRoute($name, Yaf\Route_Interface $route) {} /** *Add routes defined by configs into \Yaf\Router's route stack
@@ -1126,9 +940,7 @@ public function addRoute($name, \Yaf\Route_Interface $route) * * @return \Yaf\Router|false return FALSE on failure */ - public function addConfig(\Yaf\Config_Abstract $config) - { - } + public function addConfig(Yaf\Config_Abstract $config) {} /** * @link https://secure.php.net/manual/en/yaf-router.route.php @@ -1137,9 +949,7 @@ public function addConfig(\Yaf\Config_Abstract $config) * * @return \Yaf\Router|false return FALSE on failure */ - public function route(\Yaf\Request_Abstract $request) - { - } + public function route(Yaf\Request_Abstract $request) {} /** *Retrieve a route by name, see also \Yaf\Router::getCurrentRoute()
@@ -1150,18 +960,14 @@ public function route(\Yaf\Request_Abstract $request) * * @return \Yaf\Route_Interface */ - public function getRoute($name) - { - } + public function getRoute($name) {} /** * @link https://secure.php.net/manual/en/yaf-router.getroutes.php * * @return \Yaf\Route_Interface[] */ - public function getRoutes() - { - } + public function getRoutes() {} /** *Get the name of the route which is effective in the route process.
@@ -1173,9 +979,7 @@ public function getRoutes() * * @return string the name of the effective route. */ - public function getCurrentRoute() - { - } + public function getCurrentRoute() {} }/** *Bootstrap is a mechanism used to do some initial config before a Application run.
User may define their own Bootstrap class by inheriting \Yaf\Bootstrap_Abstract
\Yaf\Controller_Abstract is the heart of Yaf's system. MVC stands for Model-View-Controller and is a design pattern targeted at separating application logic from display logic.
*Every custom controller shall inherit \Yaf\Controller_Abstract.
@@ -1203,7 +1005,6 @@ abstract class Bootstrap_Abstract */ abstract class Controller_Abstract { - /** * @see \Yaf\Action_Abstract * @var array You can also define a action method in a separate PHP script by using this property and \Yaf\Action_Abstract. @@ -1242,9 +1043,7 @@ abstract class Controller_Abstract * * @return string */ - protected function render($tpl, array $parameters = null) - { - } + protected function render($tpl, array $parameters = null) {} /** * @link https://secure.php.net/manual/en/yaf-controller-abstract.display.php @@ -1254,9 +1053,7 @@ protected function render($tpl, array $parameters = null) * * @return bool */ - protected function display($tpl, array $parameters = null) - { - } + protected function display($tpl, array $parameters = null) {} /** * retrieve current request object @@ -1265,9 +1062,7 @@ protected function display($tpl, array $parameters = null) * * @return \Yaf\Request_Abstract */ - public function getRequest() - { - } + public function getRequest() {} /** * retrieve current response object @@ -1276,9 +1071,7 @@ public function getRequest() * * @return \Yaf\Response_Abstract */ - public function getResponse() - { - } + public function getResponse() {} /** * get the controller's module name @@ -1287,9 +1080,7 @@ public function getResponse() * * @return string */ - public function getModuleName() - { - } + public function getModuleName() {} /** * retrieve view engine @@ -1298,9 +1089,7 @@ public function getModuleName() * * @return \Yaf\View_Interface */ - public function getView() - { - } + public function getView() {} /** * @deprecated not_implemented @@ -1310,9 +1099,7 @@ public function getView() * * @return \Yaf\Response_Abstract */ - public function initView(array $options = null) - { - } + public function initView(array $options = null) {} /** * @link https://secure.php.net/manual/en/yaf-controller-abstract.setviewpath.php @@ -1321,18 +1108,14 @@ public function initView(array $options = null) * * @return bool */ - public function setViewpath($view_directory) - { - } + public function setViewpath($view_directory) {} /** * @link https://secure.php.net/manual/en/yaf-controller-abstract.getviewpath.php * * @return string */ - public function getViewpath() - { - } + public function getViewpath() {} /** *forward current execution process to other action.
@@ -1354,9 +1137,7 @@ public function getViewpath() * * @return bool return FALSE on failure */ - public function forward($module, $controller = null, $action = null, array $parameters = null) - { - } + public function forward($module, $controller = null, $action = null, array $parameters = null) {} /** * redirect to a URL by sending a 302 header @@ -1367,18 +1148,14 @@ public function forward($module, $controller = null, $action = null, array $para * * @return bool */ - public function redirect($url) - { - } + public function redirect($url) {} /** * @link https://secure.php.net/manual/en/yaf-controller-abstract.getinvokeargs.php * * @return array */ - public function getInvokeArgs() - { - } + public function getInvokeArgs() {} /** * @link https://secure.php.net/manual/en/yaf-controller-abstract.getinvokearg.php @@ -1386,19 +1163,14 @@ public function getInvokeArgs() * * @return mixed|null */ - public function getInvokeArg($name) - { - } + public function getInvokeArg($name) {} /** *\Yaf\Controller_Abstract::__construct() is final, which means users can not override it. but users can define \Yaf\Controller_Abstract::init(), which will be called after controller object is instantiated.
* * @link https://secure.php.net/manual/en/yaf-controller-abstract.init.php - * */ - public function init() - { - } + public function init() {} /** * \Yaf\Controller_Abstract::__construct() is final, which means it can not be overridden. You may want to see \Yaf\Controller_Abstract::init() instead. @@ -1411,27 +1183,21 @@ public function init() * @param \Yaf\View_Interface $view * @param array $invokeArgs */ - final public function __construct(\Yaf\Request_Abstract $request, \Yaf\Response_Abstract $response, \Yaf\View_Interface $view, array $invokeArgs = null) - { - } + final public function __construct(Yaf\Request_Abstract $request, Yaf\Response_Abstract $response, Yaf\View_Interface $view, array $invokeArgs = null) {} /** * @link https://secure.php.net/manual/en/yaf-controller-abstract.clone.php */ - final private function __clone() - { - } + final private function __clone() {} }/** *A action can be defined in a separate file in Yaf(see \Yaf\Controller_Abstract). that is a action method can also be a \Yaf\Action_Abstract class.
*Since there should be a entry point which can be called by Yaf (as of PHP 5.3, there is a new magic method __invoke, but Yaf is not only works with PHP 5.3+, Yaf choose another magic method execute), you must implement the abstract method \Yaf\Action_Abstract::execute() in your custom action class.
* * @link https://secure.php.net/manual/en/class.yaf-action-abstract.php - * */ abstract class Action_Abstract extends \Yaf\Controller_Abstract { - /** * @var \Yaf\Controller_Abstract */ @@ -1456,15 +1222,12 @@ abstract public function execute(); * * @return \Yaf\Controller_Abstract */ - public function getController() - { - } + public function getController() {} }/** * @link https://secure.php.net/manual/en/class.yaf-config-abstract.php */ abstract class Config_Abstract { - /** * @var array */ @@ -1509,8 +1272,8 @@ abstract public function toArray(); */ abstract class Request_Abstract { - const SCHEME_HTTP = 'http'; - const SCHEME_HTTPS = 'https'; + public const SCHEME_HTTP = 'http'; + public const SCHEME_HTTPS = 'https'; /** * @var string */ @@ -1561,82 +1324,63 @@ abstract class Request_Abstract * * @return bool */ - public function isGet() - { - } + public function isGet() {} /** * @link https://secure.php.net/manual/en/yaf-request-abstract.ispost.php * * @return bool */ - public function isPost() - { - } + public function isPost() {} /** * @link https://secure.php.net/manual/en/yaf-request-abstract.isput.php * * @return bool */ - public function isPut() - { - } + public function isPut() {} /** * @link https://secure.php.net/manual/en/yaf-request-abstract.ishead.php * * @return bool */ - public function isHead() - { - } + public function isHead() {} /** * @link https://secure.php.net/manual/en/yaf-request-abstract.isoptions.php * * @return bool */ - public function isOptions() - { - } + public function isOptions() {} /** * @link https://secure.php.net/manual/en/yaf-request-abstract.iscli.php * * @return bool */ - public function isCli() - { - } + public function isCli() {} /** * @link https://secure.php.net/manual/en/yaf-request-abstract.isdispached.php * * @return bool */ - public function isDispatched() - { - } + public function isDispatched() {} /** * @link https://secure.php.net/manual/en/yaf-request-abstract.isrouted.php * * @return bool */ - public function isRouted() - { - } + public function isRouted() {} /** - * * @link https://secure.php.net/manual/en/yaf-request-abstract.isxmlhttprequest.php * * @return bool false */ - public function isXmlHttpRequest() - { - } + public function isXmlHttpRequest() {} /** * Retrieve $_SERVER variable @@ -1648,9 +1392,7 @@ public function isXmlHttpRequest() * * @return mixed */ - public function getServer($name = null, $default = null) - { - } + public function getServer($name = null, $default = null) {} /** * Retrieve $_ENV variable @@ -1662,12 +1404,9 @@ public function getServer($name = null, $default = null) * * @return mixed */ - public function getEnv($name = null, $default = null) - { - } + public function getEnv($name = null, $default = null) {} /** - * * @link https://secure.php.net/manual/en/yaf-request-abstract.getparam.php * * @param string $name @@ -1675,55 +1414,42 @@ public function getEnv($name = null, $default = null) * * @return mixed */ - public function getParam($name, $default = null) - { - } + public function getParam($name, $default = null) {} /** - * * @link https://secure.php.net/manual/en/yaf-request-abstract.getparams.php * * @return array */ - public function getParams() - { - } + public function getParams() {} /** * @link https://secure.php.net/manual/en/yaf-request-abstract.getexception.php * * @return \Yaf\Exception */ - public function getException() - { - } + public function getException() {} /** * @link https://secure.php.net/manual/en/yaf-request-abstract.getmoudlename.php * * @return string */ - public function getModuleName() - { - } + public function getModuleName() {} /** * @link https://secure.php.net/manual/en/yaf-request-abstract.getcontrollername.php * * @return string */ - public function getControllerName() - { - } + public function getControllerName() {} /** * @link https://secure.php.net/manual/en/yaf-request-abstract.getactionname.php * * @return string */ - public function getActionName() - { - } + public function getActionName() {} /** * @link https://secure.php.net/manual/en/yaf-request-abstract.setparam.php @@ -1733,9 +1459,7 @@ public function getActionName() * * @return \Yaf\Request_Abstract|bool */ - public function setParam($name, $value = null) - { - } + public function setParam($name, $value = null) {} /** * @link https://secure.php.net/manual/en/yaf-request-abstract.setmodulename.php @@ -1744,9 +1468,7 @@ public function setParam($name, $value = null) * * @return \Yaf\Request_Abstract|bool */ - public function setModuleName($module) - { - } + public function setModuleName($module) {} /** * @link https://secure.php.net/manual/en/yaf-request-abstract.setcontrollername.php @@ -1755,9 +1477,7 @@ public function setModuleName($module) * * @return \Yaf\Request_Abstract|bool */ - public function setControllerName($controller) - { - } + public function setControllerName($controller) {} /** * @link https://secure.php.net/manual/en/yaf-request-abstract.setactionname.php @@ -1766,27 +1486,21 @@ public function setControllerName($controller) * * @return \Yaf\Request_Abstract|bool */ - public function setActionName($action) - { - } + public function setActionName($action) {} /** * @link https://secure.php.net/manual/en/yaf-request-abstract.getmethod.php * * @return string */ - public function getMethod() - { - } + public function getMethod() {} /** * @link https://secure.php.net/manual/en/yaf-request-abstract.getlanguage.php * * @return string */ - public function getLanguage() - { - } + public function getLanguage() {} /** *Set base URI, base URI is used when doing routing, in routing phase request URI is used to route a request, while base URI is used to skip the leading part(base URI) of request URI. That is, if comes a request with request URI a/b/c, then if you set base URI to "a/b", only "/c" will be used in routing phase.
@@ -1800,27 +1514,21 @@ public function getLanguage() * * @return bool */ - public function setBaseUri($uri) - { - } + public function setBaseUri($uri) {} /** * @link https://secure.php.net/manual/en/yaf-request-abstract.getbaseuri.php * * @return string */ - public function getBaseUri() - { - } + public function getBaseUri() {} /** * @link https://secure.php.net/manual/en/yaf-request-abstract.getrequesturi.php * * @return string */ - public function getRequestUri() - { - } + public function getRequestUri() {} /** * @since 2.1.0 @@ -1828,9 +1536,7 @@ public function getRequestUri() * * @param string $uri request URI */ - public function setRequestUri($uri) - { - } + public function setRequestUri($uri) {} /** * Set request as dispatched @@ -1839,9 +1545,7 @@ public function setRequestUri($uri) * * @return bool */ - public function setDispatched() - { - } + public function setDispatched() {} /** * Set request as routed @@ -1850,9 +1554,7 @@ public function setDispatched() * * @return \Yaf\Request_Abstract|bool */ - public function setRouted() - { - } + public function setRouted() {} }/** *Plugins allow for easy extensibility and customization of the framework.
*\Yaf\Route_Interface::route() is the only method that a custom route should implement.
if this method return TRUE, then the route process will be end. otherwise, \Yaf\Router will call next route in the route stack to route request.
\Yaf\Route_Interface::assemble() - assemble a request
by default, \Yaf\Router only have a \Yaf\Route_Static as its default route.
*\Yaf\Route_Static is designed to handle 80% of normal requirements.
@@ -2185,11 +1850,9 @@ class Exception extends \Exception *it is unnecessary to instance a \Yaf\Route_Static, also unnecessary to add it into \Yaf\Router's routes stack, since there is always be one in \Yaf\Router's routes stack, and always be called at the last time.
* * @link https://secure.php.net/manual/en/class.yaf-route-static.php - * */ class Route_Static implements \Yaf\Route_Interface { - /** * @deprecated not_implemented * @link https://secure.php.net/manual/en/yaf-route-static.match.php @@ -2198,9 +1861,7 @@ class Route_Static implements \Yaf\Route_Interface * * @return bool */ - public function match($uri) - { - } + public function match($uri) {} /** * @link https://secure.php.net/manual/en/yaf-route-static.route.php @@ -2209,9 +1870,7 @@ public function match($uri) * * @return bool always TRUE */ - public function route(\Yaf\Request_Abstract $request) - { - } + public function route(Yaf\Request_Abstract $request) {} /** *\Yaf\Route_Static::assemble() - Assemble a url
@@ -2222,37 +1881,24 @@ public function route(\Yaf\Request_Abstract $request) * @param array $query * @return bool */ - public function assemble(array $info, array $query = null) - { - } + public function assemble(array $info, array $query = null) {} }} + namespace Yaf\Response { - use Yaf\Response; - /** - * - */ -class Http extends \Yaf\Response_Abstract + class Http extends \Yaf\Response_Abstract { - /** * @var int */ protected $_response_code = 0; - /** - * - */ - private function __clone() - { - } + private function __clone() {} /** * @return string */ - private function __toString() - { - } + private function __toString() {} /** * @link https://secure.php.net/manual/en/yaf-response-abstract.setheader.php @@ -2264,9 +1910,7 @@ private function __toString() * * @return bool */ - public function setHeader($name, $value, $replace = false, $response_code = 0) - { - } + public function setHeader($name, $value, $replace = false, $response_code = 0) {} /** * @link https://secure.php.net/manual/en/yaf-response-abstract.setallheaders.php @@ -2275,9 +1919,7 @@ public function setHeader($name, $value, $replace = false, $response_code = 0) * * @return bool */ - public function setAllHeaders(array $headers) - { - } + public function setAllHeaders(array $headers) {} /** * @link https://secure.php.net/manual/en/yaf-response-abstract.getheader.php @@ -2286,9 +1928,7 @@ public function setAllHeaders(array $headers) * * @return mixed */ - public function getHeader($name = null) - { - } + public function getHeader($name = null) {} /** * @link https://secure.php.net/manual/en/yaf-response-abstract.clearheaders.php @@ -2296,9 +1936,7 @@ public function getHeader($name = null) * * @return \Yaf\Response_Abstract|false */ - public function clearHeaders() - { - } + public function clearHeaders() {} /** * @link https://secure.php.net/manual/en/yaf-response-abstract.setredirect.php @@ -2307,9 +1945,7 @@ public function clearHeaders() * * @return bool */ - public function setRedirect($url) - { - } + public function setRedirect($url) {} /** * send response @@ -2318,38 +1954,25 @@ public function setRedirect($url) * * @return bool */ - public function response() - { - } -}/** - * - */ + public function response() {} +} class Cli extends \Yaf\Response_Abstract { - - /** - * - */ - private function __clone() - { - } + private function __clone() {} /** * @return string */ - private function __toString() - { - } + private function __toString() {} }} + namespace Yaf\Request { - use Yaf\Request; - /** + /** * @link https://secure.php.net/manual/en/class.yaf-request-http.php */ class Http extends \Yaf\Request_Abstract { - /** * Retrieve $_GET variable * @@ -2360,9 +1983,7 @@ class Http extends \Yaf\Request_Abstract * * @return mixed */ - public function getQuery($name = null, $default = null) - { - } + public function getQuery($name = null, $default = null) {} /** * Retrieve $_REQUEST variable @@ -2374,9 +1995,7 @@ public function getQuery($name = null, $default = null) * * @return mixed */ - public function getRequest($name = null, $default = null) - { - } + public function getRequest($name = null, $default = null) {} /** * Retrieve $_POST variable @@ -2388,9 +2007,7 @@ public function getRequest($name = null, $default = null) * * @return mixed */ - public function getPost($name = null, $default = null) - { - } + public function getPost($name = null, $default = null) {} /** * Retrieve $_COOKIE variable @@ -2402,9 +2019,7 @@ public function getPost($name = null, $default = null) * * @return mixed */ - public function getCookie($name = null, $default = null) - { - } + public function getCookie($name = null, $default = null) {} /** * Retrieve $_FILES variable @@ -2416,9 +2031,7 @@ public function getCookie($name = null, $default = null) * * @return mixed */ - public function getFiles($name = null, $default = null) - { - } + public function getFiles($name = null, $default = null) {} /** * Retrieve variable from client, this method will search the name in $_REQUEST params, if the name is not found, then will search in $_POST, $_GET, $_COOKIE, $_SERVER @@ -2430,9 +2043,7 @@ public function getFiles($name = null, $default = null) * * @return mixed */ - public function get($name, $default = null) - { - } + public function get($name, $default = null) {} /** * Check the request whether it is a Ajax Request @@ -2446,34 +2057,26 @@ public function get($name, $default = null) * * @return bool */ - public function isXmlHttpRequest() - { - } + public function isXmlHttpRequest() {} /** * @link https://secure.php.net/manual/en/yaf-request-http.construct.php * * @param string $request_uri * @param string $base_uri - * */ - public function __construct($request_uri, $base_uri) - { - } + public function __construct($request_uri, $base_uri) {} /** * @link https://secure.php.net/manual/en/yaf-request-http.clone.php */ - private function __clone() - { - } + private function __clone() {} }/** * \Yaf\Request\Simple is particularly used for test purpose. ie. simulate a spacial request under CLI mode. * @link https://secure.php.net/manual/en/class.yaf-request-simple.php */ class Simple extends \Yaf\Request_Abstract { - /** * Retrieve $_GET variable * @@ -2484,9 +2087,7 @@ class Simple extends \Yaf\Request_Abstract * * @return mixed */ - public function getQuery($name = null, $default = null) - { - } + public function getQuery($name = null, $default = null) {} /** * Retrieve $_REQUEST variable @@ -2498,9 +2099,7 @@ public function getQuery($name = null, $default = null) * * @return mixed */ - public function getRequest($name = null, $default = null) - { - } + public function getRequest($name = null, $default = null) {} /** * Retrieve $_POST variable @@ -2512,9 +2111,7 @@ public function getRequest($name = null, $default = null) * * @return mixed */ - public function getPost($name = null, $default = null) - { - } + public function getPost($name = null, $default = null) {} /** * Retrieve $_Cookie variable @@ -2526,9 +2123,7 @@ public function getPost($name = null, $default = null) * * @return mixed */ - public function getCookie($name = null, $default = null) - { - } + public function getCookie($name = null, $default = null) {} /** * @param mixed $name @@ -2536,9 +2131,7 @@ public function getCookie($name = null, $default = null) * * @return array */ - public function getFiles($name = null, $default = null) - { - } + public function getFiles($name = null, $default = null) {} /** * Retrieve variable from client, this method will search the name in $_REQUEST params, if the name is not found, then will search in $_POST, $_GET, $_COOKIE, $_SERVER @@ -2550,9 +2143,7 @@ public function getFiles($name = null, $default = null) * * @return mixed */ - public function get($name, $default = null) - { - } + public function get($name, $default = null) {} /** * Check the request whether it is a Ajax Request @@ -2566,9 +2157,7 @@ public function get($name, $default = null) * * @return bool */ - public function isXmlHttpRequest() - { - } + public function isXmlHttpRequest() {} /** * @link https://secure.php.net/manual/en/yaf-request-simple.construct.php @@ -2580,21 +2169,17 @@ public function isXmlHttpRequest() * * @throws \Yaf\Exception\TypeError */ - public function __construct($method, $controller, $action, $params = null) - { - } + public function __construct($method, $controller, $action, $params = null) {} /** * @link https://secure.php.net/manual/en/yaf-request-simple.clone.php */ - private function __clone() - { - } + private function __clone() {} }} + namespace Yaf\Config { - use Yaf\Config; - /** + /** *\Yaf\Config\Ini enables developers to store configuration data in a familiar INI format and read them in the application by using nested object property syntax. The INI format is specialized to provide both the ability to have a hierarchy of configuration data keys and inheritance between configuration data sections. Configuration data hierarchies are supported by separating the keys with the dot or period character ("."). A section may extend or inherit from another section by following the section name with a colon character (":") and the name of the section from which data are to be inherited.
\Yaf\Config\Ini utilizes the » parse_ini_file() PHP function. Please review this documentation to be aware of its specific behaviors, which propagate to \Yaf\Config\Ini, such as how the special values of "TRUE", "FALSE", "yes", "no", and "NULL" are handled.
@@ -2602,49 +2187,36 @@ private function __clone() */ class Ini extends \Yaf\Config_Abstract implements \Iterator, \Traversable, \ArrayAccess, \Countable { - /** * @see \Yaf\Config_Abstract::get */ - public function __get($name = null) - { - } + public function __get($name = null) {} /** * @see \Yaf\Config_Abstract::set */ - public function __set($name, $value) - { - } + public function __set($name, $value) {} /** * @see \Yaf\Config_Abstract::get */ - public function get($name = null) - { - } + public function get($name = null) {} /** * @see \Yaf\Config_Abstract::set * @deprecated not_implemented */ - public function set($name, $value) - { - } + public function set($name, $value) {} /** * @see \Yaf\Config_Abstract::toArray */ - public function toArray() - { - } + public function toArray() {} /** * @see \Yaf\Config_Abstract::readonly */ - public function readonly() - { - } + public function readonly() {} /** * @link https://secure.php.net/manual/en/yaf-config-ini.construct.php @@ -2654,229 +2226,167 @@ public function readonly() * * @throws \Yaf\Exception\TypeError */ - public function __construct($config_file, $section = null) - { - } + public function __construct($config_file, $section = null) {} /** * @link https://secure.php.net/manual/en/yaf-config-ini.isset.php * @param string $name */ - public function __isset($name) - { - } + public function __isset($name) {} /** * @see \Countable::count */ - public function count() - { - } + public function count() {} /** * @see \Iterator::rewind */ - public function rewind() - { - } + public function rewind() {} /** * @see \Iterator::current */ - public function current() - { - } + public function current() {} /** * @see \Iterator::next */ - public function next() - { - } + public function next() {} /** * @see \Iterator::valid */ - public function valid() - { - } + public function valid() {} /** * @see \Iterator::key */ - public function key() - { - } + public function key() {} /** * @see \ArrayAccess::offsetUnset * @deprecated not_implemented */ - public function offsetUnset($name) - { - } + public function offsetUnset($name) {} /** * @see \ArrayAccess::offsetGet */ - public function offsetGet($name) - { - } + public function offsetGet($name) {} /** * @see \ArrayAccess::offsetExists */ - public function offsetExists($name) - { - } + public function offsetExists($name) {} /** * @see \ArrayAccess::offsetSet */ - public function offsetSet($name, $value) - { - } + public function offsetSet($name, $value) {} }/** * @link https://secure.php.net/manual/en/class.yaf-config-simple.php */ class Simple extends \Yaf\Config_Abstract implements \Iterator, \Traversable, \ArrayAccess, \Countable { - /** * @see \Yaf\Config_Abstract::get */ - public function __get($name = null) - { - } + public function __get($name = null) {} /** * @see \Yaf\Config_Abstract::set */ - public function __set($name, $value) - { - } + public function __set($name, $value) {} /** * @see \Yaf\Config_Abstract::get */ - public function get($name = null) - { - } + public function get($name = null) {} /** * @see \Yaf\Config_Abstract::set */ - public function set($name, $value) - { - } + public function set($name, $value) {} /** * @see \Yaf\Config_Abstract::toArray */ - public function toArray() - { - } + public function toArray() {} /** * @see \Yaf\Config_Abstract::readonly */ - public function readonly() - { - } + public function readonly() {} /** * @link https://secure.php.net/manual/en/yaf-config-simple.construct.php * * @param array $array * @param string $readonly - * */ - public function __construct(array $array, $readonly = null) - { - } + public function __construct(array $array, $readonly = null) {} /** * @link https://secure.php.net/manual/en/yaf-config-simple.isset.php * @param string $name */ - public function __isset($name) - { - } + public function __isset($name) {} /** * @see \Countable::count */ - public function count() - { - } + public function count() {} /** * @see \Iterator::rewind */ - public function rewind() - { - } + public function rewind() {} /** * @see \Iterator::current */ - public function current() - { - } + public function current() {} /** * @see \Iterator::next */ - public function next() - { - } + public function next() {} /** * @see \Iterator::valid */ - public function valid() - { - } + public function valid() {} /** * @see \Iterator::key */ - public function key() - { - } + public function key() {} /** * @see \ArrayAccess::offsetUnset */ - public function offsetUnset($name) - { - } + public function offsetUnset($name) {} /** * @see \ArrayAccess::offsetGet */ - public function offsetGet($name) - { - } + public function offsetGet($name) {} /** * @see \ArrayAccess::offsetExists */ - public function offsetExists($name) - { - } + public function offsetExists($name) {} /** * @see \ArrayAccess::offsetSet */ - public function offsetSet($name, $value) - { - } + public function offsetSet($name, $value) {} }} + namespace Yaf\View { - use Yaf\View; - /** + /** * \Yaf\View\Simple is the built-in template engine in Yaf, it is a simple but fast template engine, and only support PHP script template. * @link https://secure.php.net/manual/en/class.yaf-view-simple.php * @@ -2891,7 +2401,6 @@ public function offsetSet($name, $value) */ class Simple implements \Yaf\View_Interface { - /** * @var string */ @@ -2916,18 +2425,14 @@ class Simple implements \Yaf\View_Interface * * @throws \Yaf\Exception\TypeError */ - final public function __construct($template_dir, array $options = null) - { - } + final public function __construct($template_dir, array $options = null) {} /** * @link https://secure.php.net/manual/en/yaf-view-simple.isset.php * * @param string $name */ - public function __isset($name) - { - } + public function __isset($name) {} /** * assign variable to view engine @@ -2938,9 +2443,7 @@ public function __isset($name) * @param mixed $value mixed value * @return \Yaf\View\Simple */ - public function assign($name, $value = null) - { - } + public function assign($name, $value = null) {} /** * @link https://secure.php.net/manual/en/yaf-view-simple.render.php @@ -2952,9 +2455,7 @@ public function assign($name, $value = null) * * @return string|void */ - public function render($tpl, array $tpl_vars = null) - { - } + public function render($tpl, array $tpl_vars = null) {} /** *Render a template and display the result instantly.
@@ -2968,9 +2469,7 @@ public function render($tpl, array $tpl_vars = null) * * @return bool */ - public function display($tpl, array $tpl_vars = null) - { - } + public function display($tpl, array $tpl_vars = null) {} /** *unlike \Yaf\View\Simple::assign(), this method assign a ref value to engine.
@@ -2981,9 +2480,7 @@ public function display($tpl, array $tpl_vars = null) * * @return \Yaf\View\Simple */ - public function assignRef($name, &$value) - { - } + public function assignRef($name, &$value) {} /** * clear assigned variable @@ -2993,9 +2490,7 @@ public function assignRef($name, &$value) * * @return \Yaf\View\Simple */ - public function clear($name = null) - { - } + public function clear($name = null) {} /** * @link https://secure.php.net/manual/en/yaf-view-simple.setscriptpath.php @@ -3004,18 +2499,14 @@ public function clear($name = null) * * @return \Yaf\View\Simple */ - public function setScriptPath($template_dir) - { - } + public function setScriptPath($template_dir) {} /** * @link https://secure.php.net/manual/en/yaf-view-simple.getscriptpath.php * * @return string */ - public function getScriptPath() - { - } + public function getScriptPath() {} /** *Retrieve assigned variable
@@ -3030,9 +2521,7 @@ public function getScriptPath() * * @return mixed */ - public function __get($name = null) - { - } + public function __get($name = null) {} /** *This is a alternative and easier way to \Yaf\View\Simple::assign().
@@ -3042,14 +2531,12 @@ public function __get($name = null) * @param string $name A string value name. * @param mixed $value mixed value */ - public function __set($name, $value = null) - { - } + public function __set($name, $value = null) {} }} + namespace Yaf\Route { - use Yaf\Route; - /** + /** *\Yaf\Route\Simple will match the query string, and find the route info.
*all you need to do is tell \Yaf\Route\Simple what key in the $_GET is module, what key is controller, and what key is action.
@@ -3060,7 +2547,6 @@ public function __set($name, $value = null) */ final class Simple implements \Yaf\Route_Interface { - /** * @var string */ @@ -3085,9 +2571,7 @@ final class Simple implements \Yaf\Route_Interface * * @throws \Yaf\Exception\TypeError */ - public function __construct($module_name, $controller_name, $action_name) - { - } + public function __construct($module_name, $controller_name, $action_name) {} /** *see \Yaf\Route\Simple::__construct()
@@ -3098,9 +2582,7 @@ public function __construct($module_name, $controller_name, $action_name) * * @return bool always TRUE */ - public function route(\Yaf\Request_Abstract $request) - { - } + public function route(Yaf\Request_Abstract $request) {} /** *\Yaf\Route\Simple::assemble() - Assemble a url
@@ -3111,15 +2593,12 @@ public function route(\Yaf\Request_Abstract $request) * @param array $query * @return bool */ - public function assemble(array $info, array $query = null) - { - } + public function assemble(array $info, array $query = null) {} }/** * @link https://secure.php.net/manual/en/class.yaf-route-supervar.php */ final class Supervar implements \Yaf\Route_Interface { - /** * @var string */ @@ -3134,9 +2613,7 @@ final class Supervar implements \Yaf\Route_Interface * * @throws \Yaf\Exception\TypeError */ - public function __construct($supervar_name) - { - } + public function __construct($supervar_name) {} /** * @link https://secure.php.net/manual/en/yaf-route-supervar.route.php @@ -3145,9 +2622,7 @@ public function __construct($supervar_name) * * @return bool If there is a key(which was defined in \Yaf\Route\Supervar::__construct()) in $_GET, return TRUE. otherwise return FALSE. */ - public function route(\Yaf\Request_Abstract $request) - { - } + public function route(Yaf\Request_Abstract $request) {} /** *\Yaf\Route\Supervar::assemble() - Assemble a url
@@ -3158,9 +2633,7 @@ public function route(\Yaf\Request_Abstract $request) * @param array $query * @return bool */ - public function assemble(array $info, array $query = null) - { - } + public function assemble(array $info, array $query = null) {} }/** *For usage, please see the example section of \Yaf\Route\Rewrite::__construct()
* @@ -3168,7 +2641,6 @@ public function assemble(array $info, array $query = null) */ final class Rewrite extends \Yaf\Router implements \Yaf\Route_Interface { - /** * @var string */ @@ -3194,9 +2666,7 @@ final class Rewrite extends \Yaf\Router implements \Yaf\Route_Interface * * @throws \Yaf\Exception\TypeError */ - public function __construct($match, array $route, array $verify = null, $reverse = null) - { - } + public function __construct($match, array $route, array $verify = null, $reverse = null) {} /** * @link https://secure.php.net/manual/en/yaf-route-rewrite.route.php @@ -3205,9 +2675,7 @@ public function __construct($match, array $route, array $verify = null, $reverse * * @return bool */ - public function route(\Yaf\Request_Abstract $request) - { - } + public function route(Yaf\Request_Abstract $request) {} /** *\Yaf\Route\Rewrite::assemble() - Assemble a url
@@ -3218,9 +2686,7 @@ public function route(\Yaf\Request_Abstract $request) * @param array $query * @return bool */ - public function assemble(array $info, array $query = null) - { - } + public function assemble(array $info, array $query = null) {} }/** *\Yaf\Route\Regex is the most flexible route among the Yaf built-in routes.
* @@ -3228,7 +2694,6 @@ public function assemble(array $info, array $query = null) */ final class Regex extends \Yaf\Router implements \Yaf\Route_Interface { - /** * @var string */ @@ -3263,9 +2728,7 @@ final class Regex extends \Yaf\Router implements \Yaf\Route_Interface * * @throws \Yaf\Exception\TypeError */ - public function __construct($match, array $route, array $map = null, array $verify = null, $reverse = null) - { - } + public function __construct($match, array $route, array $map = null, array $verify = null, $reverse = null) {} /** * Route a incoming request. @@ -3276,9 +2739,7 @@ public function __construct($match, array $route, array $map = null, array $veri * * @return bool If the pattern given by the first parameter of \Yaf\Route\Regex::_construct() matches the request uri, return TRUE, otherwise return FALSE. */ - public function route(\Yaf\Request_Abstract $request) - { - } + public function route(Yaf\Request_Abstract $request) {} /** *\Yaf\Route\Regex::assemble() - Assemble a url
@@ -3289,9 +2750,7 @@ public function route(\Yaf\Request_Abstract $request) * @param array $query * @return bool */ - public function assemble(array $info, array $query = null) - { - } + public function assemble(array $info, array $query = null) {} }/** *\Yaf\Route\Map is a built-in route, it simply convert a URI endpoint (that part of the URI which comes after the base URI: see \Yaf\Request_Abstract::setBaseUri()) to a controller name or action name(depends on the parameter passed to \Yaf\Route\Map::__construct()) in following rule: A => controller A. A/B/C => controller A_B_C. A/B/C/D/E => controller A_B_C_D_E.
*\Yaf\Route\Map::assemble() - Assemble a url
@@ -3341,61 +2795,40 @@ public function route(\Yaf\Request_Abstract $request) * @param array $query * @return bool */ - public function assemble(array $info, array $query = null) - { - } + public function assemble(array $info, array $query = null) {} }} + namespace Yaf\Exception { - use Yaf\Exception; - /** + /** * @link https://secure.php.net/manual/en/class.yaf-exception-typeerror.php */ -class TypeError extends \Yaf\Exception -{ -}/** +class TypeError extends \Yaf\Exception {}/** * @link https://secure.php.net/manual/en/class.yaf-exception-startuperror.php */ -class StartupError extends \Yaf\Exception -{ -}/** +class StartupError extends \Yaf\Exception {}/** * @link https://secure.php.net/manual/en/class.yaf-exception-routefaild.php */ -class RouterFailed extends \Yaf\Exception -{ -}/** +class RouterFailed extends \Yaf\Exception {}/** * @link https://secure.php.net/manual/en/class.yaf-exception-dispatchfaild.php */ -class DispatchFailed extends \Yaf\Exception -{ -}/** +class DispatchFailed extends \Yaf\Exception {}/** * @link https://secure.php.net/manual/en/class.yaf-exception-loadfaild.php */ -class LoadFailed extends \Yaf\Exception -{ -}} -namespace Yaf\Exception\LoadFailed { - use Yaf\Exception\LoadFailed; +class LoadFailed extends \Yaf\Exception {}} - /** +namespace Yaf\Exception\LoadFailed { +/** * @link https://secure.php.net/manual/en/class.yaf-exception-loadfaild-module.php */ -class Module extends \Yaf\Exception\LoadFailed -{ -}/** +class Module extends \Yaf\Exception\LoadFailed {}/** * @link https://secure.php.net/manual/en/class.yaf-exception-loadfaild-controller.php */ -class Controller extends \Yaf\Exception\LoadFailed -{ -}/** +class Controller extends \Yaf\Exception\LoadFailed {}/** * @link https://secure.php.net/manual/en/class.yaf-exception-loadfaild-action.php */ -class Action extends \Yaf\Exception\LoadFailed -{ -}/** +class Action extends \Yaf\Exception\LoadFailed {}/** * @link https://secure.php.net/manual/en/class.yaf-exception-loadfaild-view.php */ -class View extends \Yaf\Exception\LoadFailed -{ -} +class View extends \Yaf\Exception\LoadFailed {} } diff --git a/yaml/yaml.php b/yaml/yaml.php index ee4e0e620..761d00f65 100644 --- a/yaml/yaml.php +++ b/yaml/yaml.php @@ -71,7 +71,7 @@ * @param array $callbacks [optional] Content handlers for YAML nodes. Associative array of YAML tag => callable mappings. See parse callbacks for more details. * @return bool Returns TRUE on success. */ -function yaml_emit_file($filename, $data, $encoding = YAML_ANY_ENCODING, $linebreak = YAML_ANY_BREAK, array $callbacks = array()) {} +function yaml_emit_file($filename, $data, $encoding = YAML_ANY_ENCODING, $linebreak = YAML_ANY_BREAK, array $callbacks = []) {} /** * (PHP 5 >= 5.2.0, PECL yaml >= 0.5.0)+ * The file name of the ZIP archive to open. + *
+ * @param int $flags [optional]+ * The mode to use to open the archive. + *
+ *+ * ZipArchive::OVERWRITE + *
+ * + * @return mixed Error codes + *+ * Returns TRUE on success or the error code. + *
+ *+ * ZipArchive::ER_EXISTS + *
+ *+ * File already exists. + *
+ *+ * ZipArchive::ER_INCONS + *
+ *+ * Zip archive inconsistent. + *
+ *+ * ZipArchive::ER_INVAL + *
+ *+ * Invalid argument. + *
+ *+ * ZipArchive::ER_MEMORY + *
+ *+ * Malloc failure. + *
+ *+ * ZipArchive::ER_NOENT + *
+ *+ * No such file. + *
+ *+ * ZipArchive::ER_NOZIP + *
+ *+ * Not a zip archive. + *
+ *+ * ZipArchive::ER_OPEN + *
+ *+ * Can't open file. + *
+ *+ * ZipArchive::ER_READ + *
+ *+ * Read error. + *
+ *+ * ZipArchive::ER_SEEK + *
+ *+ * Seek error. + *
+ */ + public function open($filename, $flags = null) {} + + /** + * (PHP 5 >= 5.2.0, PECL zip >= 1.1.0)+ * The directory to add. + *
+ * @param int $flags [optional] Set how to manage name encoding (ZipArchive::FL_ENC_*) and entry replacement (ZipArchive::FL_OVERWRITE) + * @return bool TRUE on success or FALSE on failure. + */ + public function addEmptyDir($dirname, $flags) {} + + /** + * (PHP 5 >= 5.2.0, PECL zip >= 1.1.0)+ * The name of the entry to create. + *
+ * @param string $contents+ * The contents to use to create the entry. It is used in a binary + * safe mode. + *
+ * @param int $flags [optional] Set how to manage name encoding (ZipArchive::FL_ENC_*) and entry replacement (ZipArchive::FL_OVERWRITE) + * @return bool TRUE on success or FALSE on failure. + */ + public function addFromString($localname, $contents, $flags) {} + + /** + * (PHP 5 >= 5.2.0, PECL zip >= 1.1.0)+ * The path to the file to add. + *
+ * @param string $localname [optional]+ * If supplied, this is the local name inside the ZIP archive that will override the filename. + *
+ * @param int $start [optional]+ * This parameter is not used but is required to extend ZipArchive. + *
+ * @param int $length [optional]+ * This parameter is not used but is required to extend ZipArchive. + *
+ * @param int $flags [optional] Set how to manage name encoding (ZipArchive::FL_ENC_*) and entry replacement (ZipArchive::FL_OVERWRITE) + * @return bool TRUE on success or FALSE on failure. + */ + public function addFile($filename, $localname = null, $start = 0, $length = 0, $flags) {} + + /** + * (PHP 5 >= 5.3.0, PECL zip >= 1.9.0)+ * A glob pattern against which files will be matched. + *
+ * @param int $flags [optional]+ * A bit mask of glob() flags. + *
+ * @param array $options [optional]+ * An associative array of options. Available options are: + *
+ *+ * "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. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function addGlob($pattern, $flags = 0, array $options = []) {} + + /** + * (PHP 5 >= 5.3.0, PECL zip >= 1.9.0)+ * 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 bool TRUE on success or FALSE on failure. + */ + public function addPattern($pattern, $path = '.', array $options = []) {} + + /** + * (PHP 5 >= 5.2.0, PECL zip >= 1.5.0)+ * Index of the entry to rename. + *
+ * @param string $newname+ * New name. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function renameIndex($index, $newname) {} + + /** + * (PHP 5 >= 5.2.0, PECL zip >= 1.5.0)+ * Name of the entry to rename. + *
+ * @param string $newname+ * New name. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function renameName($name, $newname) {} + + /** + * (PHP 5 >= 5.2.0, PECL zip >= 1.4.0)+ * The contents of the comment. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function setArchiveComment($comment) {} + + /** + * (PHP 5 >= 5.2.0, PECL zip >= 1.1.0)+ * If flags is set to ZipArchive::FL_UNCHANGED, the original unchanged + * comment is returned. + *
+ * @return string|false the Zip archive comment or FALSE on failure. + */ + public function getArchiveComment($flags = null) {} + + /** + * (PHP 5 >= 5.2.0, PECL zip >= 1.4.0)+ * Index of the entry. + *
+ * @param string $comment+ * The contents of the comment. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function setCommentIndex($index, $comment) {} - /** - * (PHP 5 >= 5.2.0, PECL zip >= 1.1.0)- * The file name of the ZIP archive to open. - *
- * @param int $flags [optional]- * The mode to use to open the archive. - *
- *- * ZipArchive::OVERWRITE - *
- * - * @return mixed Error codes - *- * Returns TRUE on success or the error code. - *
- *- * ZipArchive::ER_EXISTS - *
- *- * File already exists. - *
- *- * ZipArchive::ER_INCONS - *
- *- * Zip archive inconsistent. - *
- *- * ZipArchive::ER_INVAL - *
- *- * Invalid argument. - *
- *- * ZipArchive::ER_MEMORY - *
- *- * Malloc failure. - *
- *- * ZipArchive::ER_NOENT - *
- *- * No such file. - *
- *- * ZipArchive::ER_NOZIP - *
- *- * Not a zip archive. - *
- *- * ZipArchive::ER_OPEN - *
- *- * Can't open file. - *
- *- * ZipArchive::ER_READ - *
- *- * Read error. - *
- *- * ZipArchive::ER_SEEK - *
- *- * Seek error. - *
- */ - public function open ($filename, $flags = null) {} - - /** - * (PHP 5 >= 5.2.0, PECL zip >= 1.1.0)- * The directory to add. - *
- * @param int $flags [optional] Set how to manage name encoding (ZipArchive::FL_ENC_*) and entry replacement (ZipArchive::FL_OVERWRITE) - * @return bool TRUE on success or FALSE on failure. - */ - public function addEmptyDir ($dirname, $flags) {} - - /** - * (PHP 5 >= 5.2.0, PECL zip >= 1.1.0)- * The name of the entry to create. - *
- * @param string $contents- * The contents to use to create the entry. It is used in a binary - * safe mode. - *
- * @param int $flags [optional] Set how to manage name encoding (ZipArchive::FL_ENC_*) and entry replacement (ZipArchive::FL_OVERWRITE) - * @return bool TRUE on success or FALSE on failure. - */ - public function addFromString ($localname, $contents, $flags) {} - - /** - * (PHP 5 >= 5.2.0, PECL zip >= 1.1.0)- * The path to the file to add. - *
- * @param string $localname [optional]- * If supplied, this is the local name inside the ZIP archive that will override the filename. - *
- * @param int $start [optional]- * This parameter is not used but is required to extend ZipArchive. - *
- * @param int $length [optional]- * This parameter is not used but is required to extend ZipArchive. - *
- * @param int $flags [optional] Set how to manage name encoding (ZipArchive::FL_ENC_*) and entry replacement (ZipArchive::FL_OVERWRITE) - * @return bool TRUE on success or FALSE on failure. - */ - public function addFile ($filename, $localname = null, $start = 0, $length = 0, $flags) {} - - /** - * (PHP 5 >= 5.3.0, PECL zip >= 1.9.0)- * A glob pattern against which files will be matched. - *
- * @param int $flags [optional]- * A bit mask of glob() flags. - *
- * @param array $options [optional]- * An associative array of options. Available options are: - *
- *- * "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. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function addGlob ($pattern, $flags = 0, array $options = array()) {} - - /** - * (PHP 5 >= 5.3.0, PECL zip >= 1.9.0)- * 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 bool TRUE on success or FALSE on failure. - */ - public function addPattern ($pattern, $path = '.', array $options = array()) {} - - /** - * (PHP 5 >= 5.2.0, PECL zip >= 1.5.0)- * Index of the entry to rename. - *
- * @param string $newname- * New name. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function renameIndex ($index, $newname) {} - - /** - * (PHP 5 >= 5.2.0, PECL zip >= 1.5.0)- * Name of the entry to rename. - *
- * @param string $newname- * New name. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function renameName ($name, $newname) {} - - /** - * (PHP 5 >= 5.2.0, PECL zip >= 1.4.0)- * The contents of the comment. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function setArchiveComment ($comment) {} - - /** - * (PHP 5 >= 5.2.0, PECL zip >= 1.1.0)- * If flags is set to ZipArchive::FL_UNCHANGED, the original unchanged - * comment is returned. - *
- * @return string|false the Zip archive comment or FALSE on failure. - */ - public function getArchiveComment ($flags = null) {} - - /** - * (PHP 5 >= 5.2.0, PECL zip >= 1.4.0)- * Index of the entry. - *
- * @param string $comment- * The contents of the comment. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function setCommentIndex ($index, $comment) {} - - /** - * (PHP 5 >= 5.2.0, PECL zip >= 1.4.0)- * Name of the entry. - *
- * @param string $comment- * The contents of the comment. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function setCommentName ($name, $comment) {} - - /** - * Set the compression method of an entry defined by its index - * @link https://php.net/manual/en/ziparchive.setcompressionindex.php - * @param int $index Index of the entry. - * @param int $comp_method The compression method. Either ZipArchive::CM_DEFAULT, ZipArchive::CM_STORE or ZipArchive::CM_DEFLATE. - * @param int $comp_flags [optional] Compression flags. Currently unused. - * @return bool Returns TRUE on success or FALSE on failure. - * @since 7.0 - */ - public function setCompressionIndex ($index, $comp_method, $comp_flags = 0) {} - - /** - * Set the compression method of an entry defined by its name - * https://secure.php.net/manual/en/ziparchive.setcompressionname.php - * @param string $name Name of the entry. - * @param int $comp_method The compression method. Either ZipArchive::CM_DEFAULT, ZipArchive::CM_STORE or ZipArchive::CM_DEFLATE. - * @param int $comp_flags [optional] Compression flags. Currently unused. - * @return bool Returns TRUE on success or FALSE on failure. - * @since 7.0 - */ - public function setCompressionName ($name, $comp_method, $comp_flags = 0){} + /** + * (PHP 5 >= 5.2.0, PECL zip >= 1.4.0)+ * Name of the entry. + *
+ * @param string $comment+ * The contents of the comment. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function setCommentName($name, $comment) {} + + /** + * Set the compression method of an entry defined by its index + * @link https://php.net/manual/en/ziparchive.setcompressionindex.php + * @param int $index Index of the entry. + * @param int $comp_method The compression method. Either ZipArchive::CM_DEFAULT, ZipArchive::CM_STORE or ZipArchive::CM_DEFLATE. + * @param int $comp_flags [optional] Compression flags. Currently unused. + * @return bool Returns TRUE on success or FALSE on failure. + * @since 7.0 + */ + public function setCompressionIndex($index, $comp_method, $comp_flags = 0) {} + + /** + * Set the compression method of an entry defined by its name + * https://secure.php.net/manual/en/ziparchive.setcompressionname.php + * @param string $name Name of the entry. + * @param int $comp_method The compression method. Either ZipArchive::CM_DEFAULT, ZipArchive::CM_STORE or ZipArchive::CM_DEFLATE. + * @param int $comp_flags [optional] Compression flags. Currently unused. + * @return bool Returns TRUE on success or FALSE on failure. + * @since 7.0 + */ + public function setCompressionName($name, $comp_method, $comp_flags = 0) {} /** * Set the encryption method of an entry defined by its index @@ -891,7 +891,7 @@ public function setCompressionName ($name, $comp_method, $comp_flags = 0){} * @return bool Returns TRUE on success or FALSE on failure. * @since 7.2 */ - public function setEncryptionIndex (int $index, int $method, ?string $password = null) {} + public function setEncryptionIndex(int $index, int $method, ?string $password = null) {} /** * Set the encryption method of an entry defined by its name @@ -902,7 +902,7 @@ public function setEncryptionIndex (int $index, int $method, ?string $password = * @return bool Returns TRUE on success or FALSE on failure. * @since 7.2 */ - public function setEncryptionName (string $name, int $method, ?string $password = null) {} + public function setEncryptionName(string $name, int $method, ?string $password = null) {} /** * (PHP 5 >= 5.6.0, PECL zip >= 1.12.0)- * Index of the entry - *
- * @param int $flags [optional]- * If flags is set to ZipArchive::FL_UNCHANGED, the original unchanged - * comment is returned. - *
- * @return string|false the comment on success or FALSE on failure. - */ - public function getCommentIndex ($index, $flags = null) {} - - /** - * (PHP 5 >= 5.2.0, PECL zip >= 1.4.0)- * Name of the entry - *
- * @param int $flags [optional]- * If flags is set to ZipArchive::FL_UNCHANGED, the original unchanged - * comment is returned. - *
- * @return string|false the comment on success or FALSE on failure. - */ - public function getCommentName ($name, $flags = null) {} - - /** - * (PHP 5 >= 5.2.0, PECL zip >= 1.5.0)- * Index of the entry to delete. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function deleteIndex ($index) {} - - /** - * (PHP 5 >= 5.2.0, PECL zip >= 1.5.0)- * Name of the entry to delete. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function deleteName ($name) {} - - /** - * (PHP 5 >= 5.2.0, PECL zip >= 1.5.0)- * Name of the entry - *
- * @param int $flags [optional]- * The flags argument specifies how the name lookup should be done. - * Also, ZipArchive::FL_UNCHANGED may be ORed to it to request - * information about the original file in the archive, - * ignoring any changes made. - * ZipArchive::FL_NOCASE - *
- * @return array|false an array containing the entry details or FALSE on failure. - */ - public function statName ($name, $flags = null) {} - - /** - * (PHP 5 >= 5.2.0, PECL zip >= 1.1.0)- * Index of the entry - *
- * @param int $flags [optional]- * ZipArchive::FL_UNCHANGED may be ORed to it to request - * information about the original file in the archive, - * ignoring any changes made. - *
- * @return array|false an array containing the entry details or FALSE on failure. - */ - public function statIndex ($index, $flags = null) {} - - /** - * (PHP 5 >= 5.2.0, PECL zip >= 1.5.0)- * The name of the entry to look up - *
- * @param int $flags [optional]- * The flags are specified by ORing the following values, - * or 0 for none of them. - * ZipArchive::FL_NOCASE - *
- * @return int|false the index of the entry on success or FALSE on failure. - */ - public function locateName ($name, $flags = null) {} - - /** - * (PHP 5 >= 5.2.0, PECL zip >= 1.5.0)- * Index of the entry. - *
- * @param int $flags [optional]- * If flags is set to ZipArchive::FL_UNCHANGED, the original unchanged - * name is returned. - *
- * @return string|false the name on success or FALSE on failure. - */ - public function getNameIndex ($index, $flags = null) {} - - /** - * (PHP 5 >= 5.2.0, PECL zip >= 1.1.0)- * Index of the entry. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function unchangeIndex ($index) {} - - /** - * (PHP 5 >= 5.2.0, PECL zip >= 1.5.0)- * Name of the entry. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function unchangeName ($name) {} - - /** - * (PHP 5 >= 5.2.0, PECL zip >= 1.1.0)- * Location where to extract the files. - *
- * @param mixed $entries [optional]- * The entries to extract. It accepts either a single entry name or - * an array of names. - *
- * @return bool TRUE on success or FALSE on failure. - */ - public function extractTo ($destination, $entries = null) {} - - /** - * (PHP 5 >= 5.2.0, PECL zip >= 1.1.0)- * Name of the entry - *
- * @param int $length [optional]- * The length to be read from the entry. If 0, then the - * entire entry is read. - *
- * @param int $flags [optional]- * The flags to use to open the archive. the following values may - * be ORed to it. - * ZipArchive::FL_UNCHANGED - *
- * @return string|false the contents of the entry on success or FALSE on failure. - */ - public function getFromName ($name, $length = 0, $flags = null) {} - - /** - * (PHP 5 >= 5.2.0, PECL zip >= 1.3.0)- * Index of the entry - *
- * @param int $length [optional]- * The length to be read from the entry. If 0, then the - * entire entry is read. - *
- * @param int $flags [optional]- * The flags to use to open the archive. the following values may - * be ORed to it. - *
- *- * ZipArchive::FL_UNCHANGED - *
- * @return string|false the contents of the entry on success or FALSE on failure. - */ - public function getFromIndex ($index, $length = 0, $flags = null) {} - - /** - * (PHP 5 >= 5.2.0, PECL zip >= 1.1.0)- * The name of the entry to use. - *
- * @return resource|false a file pointer (resource) on success or FALSE on failure. - */ - public function getStream ($name) {} + /** + * (PHP 5 >= 5.2.0, PECL zip >= 1.4.0)+ * Index of the entry + *
+ * @param int $flags [optional]+ * If flags is set to ZipArchive::FL_UNCHANGED, the original unchanged + * comment is returned. + *
+ * @return string|false the comment on success or FALSE on failure. + */ + public function getCommentIndex($index, $flags = null) {} + + /** + * (PHP 5 >= 5.2.0, PECL zip >= 1.4.0)+ * Name of the entry + *
+ * @param int $flags [optional]+ * If flags is set to ZipArchive::FL_UNCHANGED, the original unchanged + * comment is returned. + *
+ * @return string|false the comment on success or FALSE on failure. + */ + public function getCommentName($name, $flags = null) {} + + /** + * (PHP 5 >= 5.2.0, PECL zip >= 1.5.0)+ * Index of the entry to delete. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function deleteIndex($index) {} + + /** + * (PHP 5 >= 5.2.0, PECL zip >= 1.5.0)+ * Name of the entry to delete. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function deleteName($name) {} + + /** + * (PHP 5 >= 5.2.0, PECL zip >= 1.5.0)+ * Name of the entry + *
+ * @param int $flags [optional]+ * The flags argument specifies how the name lookup should be done. + * Also, ZipArchive::FL_UNCHANGED may be ORed to it to request + * information about the original file in the archive, + * ignoring any changes made. + * ZipArchive::FL_NOCASE + *
+ * @return array|false an array containing the entry details or FALSE on failure. + */ + public function statName($name, $flags = null) {} + + /** + * (PHP 5 >= 5.2.0, PECL zip >= 1.1.0)+ * Index of the entry + *
+ * @param int $flags [optional]+ * ZipArchive::FL_UNCHANGED may be ORed to it to request + * information about the original file in the archive, + * ignoring any changes made. + *
+ * @return array|false an array containing the entry details or FALSE on failure. + */ + public function statIndex($index, $flags = null) {} + + /** + * (PHP 5 >= 5.2.0, PECL zip >= 1.5.0)+ * The name of the entry to look up + *
+ * @param int $flags [optional]+ * The flags are specified by ORing the following values, + * or 0 for none of them. + * ZipArchive::FL_NOCASE + *
+ * @return int|false the index of the entry on success or FALSE on failure. + */ + public function locateName($name, $flags = null) {} + + /** + * (PHP 5 >= 5.2.0, PECL zip >= 1.5.0)+ * Index of the entry. + *
+ * @param int $flags [optional]+ * If flags is set to ZipArchive::FL_UNCHANGED, the original unchanged + * name is returned. + *
+ * @return string|false the name on success or FALSE on failure. + */ + public function getNameIndex($index, $flags = null) {} + + /** + * (PHP 5 >= 5.2.0, PECL zip >= 1.1.0)+ * Index of the entry. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function unchangeIndex($index) {} + + /** + * (PHP 5 >= 5.2.0, PECL zip >= 1.5.0)+ * Name of the entry. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function unchangeName($name) {} + + /** + * (PHP 5 >= 5.2.0, PECL zip >= 1.1.0)+ * Location where to extract the files. + *
+ * @param mixed $entries [optional]+ * The entries to extract. It accepts either a single entry name or + * an array of names. + *
+ * @return bool TRUE on success or FALSE on failure. + */ + public function extractTo($destination, $entries = null) {} + + /** + * (PHP 5 >= 5.2.0, PECL zip >= 1.1.0)+ * Name of the entry + *
+ * @param int $length [optional]+ * The length to be read from the entry. If 0, then the + * entire entry is read. + *
+ * @param int $flags [optional]+ * The flags to use to open the archive. the following values may + * be ORed to it. + * ZipArchive::FL_UNCHANGED + *
+ * @return string|false the contents of the entry on success or FALSE on failure. + */ + public function getFromName($name, $length = 0, $flags = null) {} + + /** + * (PHP 5 >= 5.2.0, PECL zip >= 1.3.0)+ * Index of the entry + *
+ * @param int $length [optional]+ * The length to be read from the entry. If 0, then the + * entire entry is read. + *
+ * @param int $flags [optional]+ * The flags to use to open the archive. the following values may + * be ORed to it. + *
+ *+ * ZipArchive::FL_UNCHANGED + *
+ * @return string|false the contents of the entry on success or FALSE on failure. + */ + public function getFromIndex($index, $length = 0, $flags = null) {} + + /** + * (PHP 5 >= 5.2.0, PECL zip >= 1.1.0)+ * The name of the entry to use. + *
+ * @return resource|false a file pointer (resource) on success or FALSE on failure. + */ + public function getStream($name) {} /** * Set the external attributes of an entry defined by its name * @link https://www.php.net/manual/en/ziparchive.setexternalattributesname.php * @param string $name Name of the entry * @param int $opsys The operating system code defined by one of the ZipArchive::OPSYS_ constants. - * @param int $attr The external attributes. Value depends on operating system. - * @param int $flags [optional] Optional flags. Currently unused. - * @return bool Returns TRUE on success or FALSE on failure. + * @param int $attr The external attributes. Value depends on operating system. + * @param int $flags [optional] Optional flags. Currently unused. + * @return bool Returns TRUE on success or FALSE on failure. */ - public function setExternalAttributesName($name, $opsys, $attr, $flags = null) {} + public function setExternalAttributesName($name, $opsys, $attr, $flags = null) {} /** * Retrieve the external attributes of an entry defined by its name @@ -1165,7 +1165,7 @@ public function getExternalAttributesName($name, &$opsys, &$attr, $flags = null) * @param int $flags [optional] Optional flags. Currently unused. * @return bool Returns TRUE on success or FALSE on failure. */ - public function setExternalAttributesIndex($index, $opsys, $attr, $flags = null) {} + public function setExternalAttributesIndex($index, $opsys, $attr, $flags = null) {} /** * Retrieve the external attributes of an entry defined by its index @@ -1192,7 +1192,7 @@ public function getExternalAttributesIndex($index, &$opsys, &$attr, $flags = nul * exist or in case of other error. * @deprecated 8.0 Use {@link ZipArchive} instead. */ -function zip_open ($filename) {} +function zip_open($filename) {} /** * (PHP 4 >= 4.1.0, PHP 5 >= 5.2.0, PECL zip >= 1.0.0)* If the open fails, the function returns FALSE. */ -function gzopen (string $filename, string $mode, int $use_include_path = 0) {} +function gzopen(string $filename, string $mode, int $use_include_path = 0) {} /** * Output all remaining data on a gz-file pointer @@ -155,8 +152,7 @@ function gzopen (string $filename, string $mode, int $use_include_path = 0) {} * @return int The number of uncompressed characters read from gz * and passed through to the input, or FALSE on error. */ -function gzpassthru ($stream): int -{} +function gzpassthru($stream): int {} /** * Seek on a gz-file pointer @@ -180,8 +176,7 @@ function gzpassthru ($stream): int * @return int Upon success, returns 0; otherwise, returns -1. Note that seeking * past EOF is not considered an error. */ -function gzseek ($stream, int $offset, int $whence = SEEK_SET): int -{} +function gzseek($stream, int $offset, int $whence = SEEK_SET): int {} /** * Tell gz-file pointer read/write position @@ -192,7 +187,7 @@ function gzseek ($stream, int $offset, int $whence = SEEK_SET): int *
* @return int|false The position of the file pointer or FALSE if an error occurs. */ -function gztell ($stream): int|false {} +function gztell($stream): int|false {} /** * Binary-safe gz-file write @@ -219,8 +214,7 @@ function gztell ($stream): int|false {} * @return int|false the number of (uncompressed) bytes written to the given gz-file * stream. */ -function gzwrite ($stream, string $data, ?int $length): int|false -{} +function gzwrite($stream, string $data, ?int $length): int|false {} /** * Alias of gzwrite @@ -230,7 +224,7 @@ function gzwrite ($stream, string $data, ?int $length): int|false * @param int|null $length [optional] * @return int|false */ -function gzputs ($stream, string $data, ?int $length): int|false {} +function gzputs($stream, string $data, ?int $length): int|false {} /** * Read entire gz-file into an array @@ -244,7 +238,7 @@ function gzputs ($stream, string $data, ?int $length): int|false {} * * @return array|false An array containing the file, one line per cell. */ -function gzfile (string $filename, int $use_include_path = 0): array|false {} +function gzfile(string $filename, int $use_include_path = 0): array|false {} /** * Compress a string @@ -265,7 +259,7 @@ function gzfile (string $filename, int $use_include_path = 0): array|false {} * @return string|false The compressed string or FALSE if an error occurred. */ #[Pure] -function gzcompress (string $data, int $level = -1, int $encoding = ZLIB_ENCODING_DEFLATE): string|false {} +function gzcompress(string $data, int $level = -1, int $encoding = ZLIB_ENCODING_DEFLATE): string|false {} /** * Uncompress a compressed string @@ -284,7 +278,7 @@ function gzcompress (string $data, int $level = -1, int $encoding = ZLIB_ENCODIN * */ #[Pure] -function gzuncompress (string $data, int $max_length = 0): string|false {} +function gzuncompress(string $data, int $max_length = 0): string|false {} /** * Deflate a string @@ -303,7 +297,7 @@ function gzuncompress (string $data, int $max_length = 0): string|false {} * @return string|false The deflated string or FALSE if an error occurred. */ #[Pure] -function gzdeflate (string $data, int $level = -1, int $encoding = ZLIB_ENCODING_RAW): string|false {} +function gzdeflate(string $data, int $level = -1, int $encoding = ZLIB_ENCODING_RAW): string|false {} /** * Inflate a deflated string @@ -322,7 +316,7 @@ function gzdeflate (string $data, int $level = -1, int $encoding = ZLIB_ENCODING * */ #[Pure] -function gzinflate (string $data, int $max_length = 0): string|false {} +function gzinflate(string $data, int $max_length = 0): string|false {} /** * Create a gzip compressed string @@ -352,7 +346,7 @@ function gzinflate (string $data, int $max_length = 0): string|false {} * @return string|false The encoded string, or FALSE if an error occurred. */ #[Pure] -function gzencode (string $data, int $level = -1, int $encoding = FORCE_GZIP): string|false {} +function gzencode(string $data, int $level = -1, int $encoding = FORCE_GZIP): string|false {} /** * Decodes a gzip compressed string @@ -367,8 +361,7 @@ function gzencode (string $data, int $level = -1, int $encoding = FORCE_GZIP): s * @since 5.4 */ #[Pure] -function gzdecode (string $data, int $max_length): string|false -{} +function gzdecode(string $data, int $max_length): string|false {} /** * Compress data with the specified encoding @@ -383,7 +376,7 @@ function gzdecode (string $data, int $max_length): string|false * @since 5.4 */ #[Pure] -function zlib_encode (string $data, int $encoding, int $level = -1): string|false {} +function zlib_encode(string $data, int $encoding, int $level = -1): string|false {} /** * Uncompress any raw/gzip/zlib encoded data @@ -396,8 +389,7 @@ function zlib_encode (string $data, int $encoding, int $level = -1): string|fals * @since 5.4 */ #[Pure] -function zlib_decode (string $data, int $max_length): string|false -{} +function zlib_decode(string $data, int $max_length): string|false {} /** * Returns the coding type used for output compression @@ -406,7 +398,7 @@ function zlib_decode (string $data, int $max_length): string|false * or FALSE. */ #[Pure] -function zlib_get_coding_type (): string|false {} +function zlib_get_coding_type(): string|false {} /** * ob_start callback function to gzip output buffer @@ -415,7 +407,7 @@ function zlib_get_coding_type (): string|false {} * @param int $flags * @return string|false */ -function ob_gzhandler (string $data, int $flags): string|false {} +function ob_gzhandler(string $data, int $flags): string|false {} /** * Initialize an incremental deflate context @@ -440,7 +432,7 @@ function ob_gzhandler (string $data, int $flags): string|false {} */ #[Pure] #[LanguageLevelTypeAware(["8.0" => "DeflateContext|false"], default: "resource|false")] -function deflate_init (int $encoding, array $options = array()) {} +function deflate_init(int $encoding, array $options = []) {} /** * Incrementally deflate data @@ -463,7 +455,7 @@ function deflate_init (int $encoding, array $options = array()) {} * * @since 7.0 */ -function deflate_add (#[LanguageLevelTypeAware(["8.0" => "DeflateContext"], default: "resource")] $context, string $data, int $flush_mode = ZLIB_SYNC_FLUSH): string|false {} +function deflate_add(#[LanguageLevelTypeAware(["8.0" => "DeflateContext"], default: "resource")] $context, string $data, int $flush_mode = ZLIB_SYNC_FLUSH): string|false {} /** * Initialize an incremental inflate context @@ -488,7 +480,7 @@ function deflate_add (#[LanguageLevelTypeAware(["8.0" => "DeflateContext"], defa */ #[Pure] #[LanguageLevelTypeAware(["8.0" => "InflateContext|false"], default: "resource|false")] -function inflate_init (int $encoding, array $options = array()) {} +function inflate_init(int $encoding, array $options = []) {} /** * Incrementally inflate encoded data @@ -511,7 +503,7 @@ function inflate_init (int $encoding, array $options = array()) {} * * @since 7.0 */ -function inflate_add (#[LanguageLevelTypeAware(["8.0" => "InflateContext"], default: "resource")] $context, string $data, int $flush_mode = ZLIB_SYNC_FLUSH): string|false {} +function inflate_add(#[LanguageLevelTypeAware(["8.0" => "InflateContext"], default: "resource")] $context, string $data, int $flush_mode = ZLIB_SYNC_FLUSH): string|false {} /** * Get number of bytes read so far @@ -520,7 +512,7 @@ function inflate_add (#[LanguageLevelTypeAware(["8.0" => "InflateContext"], defa * @since 7.2 */ #[Pure] -function inflate_get_read_len (#[LanguageLevelTypeAware(["8.0" => "InflateContext"], default: "resource")] $context): int{} +function inflate_get_read_len(#[LanguageLevelTypeAware(["8.0" => "InflateContext"], default: "resource")] $context): int {} /** * Get decompression status @@ -529,32 +521,34 @@ function inflate_get_read_len (#[LanguageLevelTypeAware(["8.0" => "InflateContex * @since 7.2 */ #[Pure] -function inflate_get_status(#[LanguageLevelTypeAware(["8.0" => "InflateContext"], default: "resource")] $context): int {} +function inflate_get_status(#[LanguageLevelTypeAware(["8.0" => "InflateContext"], default: "resource")] $context): int {} /** * @since 8.0 */ -class InflateContext{ +class InflateContext +{ /** * Use inflate_init() instead * @see inflate_init() */ - private function __construct(){} + private function __construct() {} } /** * @since 8.0 */ -class DeflateContext{ +class DeflateContext +{ /** * Use deflate_init() instead * @see deflate_init() */ - private function __construct(){} + private function __construct() {} } -define ('FORCE_GZIP', 31); -define ('FORCE_DEFLATE', 15); +define('FORCE_GZIP', 31); +define('FORCE_DEFLATE', 15); /** @link https://php.net/manual/en/zlib.constants.php */ define('ZLIB_ENCODING_RAW', -15); /** @link https://php.net/manual/en/zlib.constants.php */ @@ -562,28 +556,27 @@ private function __construct(){} /** @link https://php.net/manual/en/zlib.constants.php */ define('ZLIB_ENCODING_DEFLATE', 15); -define ('ZLIB_NO_FLUSH', 0); -define ('ZLIB_PARTIAL_FLUSH', 1); -define ('ZLIB_SYNC_FLUSH', 2); -define ('ZLIB_FULL_FLUSH', 3); -define ('ZLIB_BLOCK', 5); -define ('ZLIB_FINISH', 4); - -define ('ZLIB_FILTERED', 1); -define ('ZLIB_HUFFMAN_ONLY', 2); -define ('ZLIB_RLE', 3); -define ('ZLIB_FIXED', 4); -define ('ZLIB_DEFAULT_STRATEGY', 0); -define ('ZLIB_OK', 0); -define ('ZLIB_STREAM_END', 1); -define ('ZLIB_NEED_DICT', 2); -define ('ZLIB_ERRNO', -1); -define ('ZLIB_STREAM_ERROR', -2); -define ('ZLIB_DATA_ERROR', -3); -define ('ZLIB_MEM_ERROR', -4); -define ('ZLIB_BUF_ERROR', -5); -define ('ZLIB_VERSION_ERROR', -6); - - -define ('ZLIB_VERSION', 'zlib_version_string'); // This is set to the zlib version -define ('ZLIB_VERNUM', 'zlib_version_string'); // This is set to the zlib version +define('ZLIB_NO_FLUSH', 0); +define('ZLIB_PARTIAL_FLUSH', 1); +define('ZLIB_SYNC_FLUSH', 2); +define('ZLIB_FULL_FLUSH', 3); +define('ZLIB_BLOCK', 5); +define('ZLIB_FINISH', 4); + +define('ZLIB_FILTERED', 1); +define('ZLIB_HUFFMAN_ONLY', 2); +define('ZLIB_RLE', 3); +define('ZLIB_FIXED', 4); +define('ZLIB_DEFAULT_STRATEGY', 0); +define('ZLIB_OK', 0); +define('ZLIB_STREAM_END', 1); +define('ZLIB_NEED_DICT', 2); +define('ZLIB_ERRNO', -1); +define('ZLIB_STREAM_ERROR', -2); +define('ZLIB_DATA_ERROR', -3); +define('ZLIB_MEM_ERROR', -4); +define('ZLIB_BUF_ERROR', -5); +define('ZLIB_VERSION_ERROR', -6); + +define('ZLIB_VERSION', 'zlib_version_string'); // This is set to the zlib version +define('ZLIB_VERNUM', 'zlib_version_string'); // This is set to the zlib version diff --git a/zmq/zmq.php b/zmq/zmq.php index 5efcb823b..8a90a76c9 100644 --- a/zmq/zmq.php +++ b/zmq/zmq.php @@ -13,61 +13,61 @@ class ZMQ /** * Exclusive pair pattern */ - const SOCKET_PAIR = 0; + public const SOCKET_PAIR = 0; /** * Publisher socket */ - const SOCKET_PUB = 1; + public const SOCKET_PUB = 1; /** * Subscriber socket */ - const SOCKET_SUB = 2; + public const SOCKET_SUB = 2; /** * Request socket */ - const SOCKET_REQ = 3; + public const SOCKET_REQ = 3; /** * Reply socket */ - const SOCKET_REP = 4; + public const SOCKET_REP = 4; /** * Alias for SOCKET_DEALER */ - const SOCKET_XREQ = 5; + public const SOCKET_XREQ = 5; /** * Alias for SOCKET_ROUTER */ - const SOCKET_XREP = 6; + public const SOCKET_XREP = 6; /** * Pipeline upstream push socket */ - const SOCKET_PUSH = 8; + public const SOCKET_PUSH = 8; /** * Pipeline downstream pull socket */ - const SOCKET_PULL = 7; + public const SOCKET_PULL = 7; /** * Extended REP socket that can route replies to requesters */ - const SOCKET_ROUTER = 6; + public const SOCKET_ROUTER = 6; /** * Extended REQ socket that load balances to all connected peers */ - const SOCKET_DEALER = 5; + public const SOCKET_DEALER = 5; /** * Similar to SOCKET_PUB, except you can receive subscriptions as messages. * The subscription message is 0 (unsubscribe) or 1 (subscribe) followed by the topic. */ - const SOCKET_XPUB = 9; + public const SOCKET_XPUB = 9; /** * Similar to SOCKET_SUB, except you can send subscriptions as messages. See SOCKET_XPUB for format. */ - const SOCKET_XSUB = 10; + public const SOCKET_XSUB = 10; /** * Used to send and receive TCP data from a non-ØMQ peer. * Available if compiled against ZeroMQ 4.x or higher. */ - const SOCKET_STREAM = 11; + public const SOCKET_STREAM = 11; /** * The high water mark for inbound and outbound messages is a hard * limit on the maximum number of outstanding messages ØMQ shall queue in memory @@ -75,210 +75,208 @@ class ZMQ * Setting this option on a socket will only affect connections made after the option has been set. * On ZeroMQ 3.x this is a wrapper for setting both SNDHWM and RCVHWM. */ - const SOCKOPT_HWM = 1; + public const SOCKOPT_HWM = 1; /** * The ZMQ_SNDHWM option shall set the high water mark for outbound messages on the specified socket. * Available if compiled against ZeroMQ 3.x or higher. */ - const SOCKOPT_SNDHWM = 23; + public const SOCKOPT_SNDHWM = 23; /** * The ZMQ_SNDHWM option shall set the high water mark for inbound messages on the specified socket. * Available if compiled against ZeroMQ 3.x or higher. */ - const SOCKOPT_RCVHWM = 24; + public const SOCKOPT_RCVHWM = 24; /** * Set I/O thread affinity */ - const SOCKOPT_AFFINITY = 4; + public const SOCKOPT_AFFINITY = 4; /** * Set socket identity */ - const SOCKOPT_IDENTITY = 5; + public const SOCKOPT_IDENTITY = 5; /** * Establish message filter. Valid for subscriber socket */ - const SOCKOPT_SUBSCRIBE = 6; + public const SOCKOPT_SUBSCRIBE = 6; /** * Remove message filter. Valid for subscriber socket */ - const SOCKOPT_UNSUBSCRIBE = 7; + public const SOCKOPT_UNSUBSCRIBE = 7; /** * Set rate for multicast sockets (pgm) (Value: int >= 0) */ - const SOCKOPT_RATE = 8; + public const SOCKOPT_RATE = 8; /** * Set multicast recovery interval (Value: int >= 0) */ - const SOCKOPT_RECOVERY_IVL = 9; + public const SOCKOPT_RECOVERY_IVL = 9; /** * Set the initial reconnection interval (Value: int >= 0) */ - const SOCKOPT_RECONNECT_IVL = 18; + public const SOCKOPT_RECONNECT_IVL = 18; /** * Set the max reconnection interval (Value: int >= 0) */ - const SOCKOPT_RECONNECT_IVL_MAX = 21; + public const SOCKOPT_RECONNECT_IVL_MAX = 21; /** * Control multicast loopback (Value: int >= 0) */ - const SOCKOPT_MCAST_LOOP = 10; + public const SOCKOPT_MCAST_LOOP = 10; /** * Set kernel transmit buffer size (Value: int >= 0) */ - const SOCKOPT_SNDBUF = 11; + public const SOCKOPT_SNDBUF = 11; /** * Set kernel receive buffer size (Value: int >= 0) */ - const SOCKOPT_RCVBUF = 12; + public const SOCKOPT_RCVBUF = 12; /** * Receive multi-part messages */ - const SOCKOPT_RCVMORE = 13; + public const SOCKOPT_RCVMORE = 13; /** * Get the socket type. Valid for getSockOpt */ - const SOCKOPT_TYPE = 16; + public const SOCKOPT_TYPE = 16; /** * The linger value of the socket. * Specifies how long the socket blocks trying flush messages after it has been closed */ - const SOCKOPT_LINGER = 17; + public const SOCKOPT_LINGER = 17; /** * The SOCKOPT_BACKLOG option shall set the maximum length of the queue of outstanding peer connections * for the specified socket; this only applies to connection-oriented transports. */ - const SOCKOPT_BACKLOG = 19; + public const SOCKOPT_BACKLOG = 19; /** * Limits the maximum size of the inbound message. Value -1 means no limit. * Available if compiled against ZeroMQ 3.x or higher */ - const SOCKOPT_MAXMSGSIZE = 22; + public const SOCKOPT_MAXMSGSIZE = 22; /** * Sets the timeout for send operation on the socket. Value -1 means no limit. * Available if compiled against ZeroMQ 3.x or higher */ - const SOCKOPT_SNDTIMEO = 28; + public const SOCKOPT_SNDTIMEO = 28; /** * Sets the timeout for receive operation on the socket. Value -1 means no limit. * Available if compiled against ZeroMQ 3.x or higher */ - const SOCKOPT_RCVTIMEO = 27; + public const SOCKOPT_RCVTIMEO = 27; /** * Disable IPV6 support if 1. * Available if compiled against ZeroMQ 3.x */ - const SOCKOPT_IPV4ONLY = 31; + public const SOCKOPT_IPV4ONLY = 31; /** * Retrieve the last connected endpoint - for use with * wildcard ports. * Available if compiled against ZeroMQ 3.x or higher */ - const SOCKOPT_LAST_ENDPOINT = 32; + public const SOCKOPT_LAST_ENDPOINT = 32; /** * Idle time for TCP keepalive. * Available if compiled against ZeroMQ 3.x or higher */ - const SOCKOPT_TCP_KEEPALIVE_IDLE = 36; + public const SOCKOPT_TCP_KEEPALIVE_IDLE = 36; /** * Count time for TCP keepalive. * Available if compiled against ZeroMQ 3.x or higher */ - const SOCKOPT_TCP_KEEPALIVE_CNT = 35; + public const SOCKOPT_TCP_KEEPALIVE_CNT = 35; /** * Interval for TCP keepalive. * Available if compiled against ZeroMQ 3.x or higher */ - const SOCKOPT_TCP_KEEPALIVE_INTVL = 37; + public const SOCKOPT_TCP_KEEPALIVE_INTVL = 37; /** * Set a CIDR string to match against incoming TCP connections. * Available if compiled against ZeroMQ 3.x or higher */ - const SOCKOPT_DELAY_ATTACH_ON_CONNECT = 39; + public const SOCKOPT_DELAY_ATTACH_ON_CONNECT = 39; /** * Set a CIDR string to match against incoming TCP connections. * Available if compiled against ZeroMQ 3.x or higher */ - const SOCKOPT_TCP_ACCEPT_FILTER = 38; + public const SOCKOPT_TCP_ACCEPT_FILTER = 38; /** * Set the XPUB to receive an application message on each instance of a subscription. * Available if compiled against ZeroMQ 3.x or higher */ - const SOCKOPT_XPUB_VERBOSE = 40; + public const SOCKOPT_XPUB_VERBOSE = 40; /** * Sets the raw mode on the ROUTER, when set to 1. * In raw mode when using tcp:// transport the socket will read and write without ZeroMQ framing. * Available if compiled against ZeroMQ 4.0 or higher */ - const SOCKOPT_ROUTER_RAW = 41; + public const SOCKOPT_ROUTER_RAW = 41; /** * Enable IPV6. * Available if compiled against ZeroMQ 4.0 or higher */ - const SOCKOPT_IPV6 = 42; + public const SOCKOPT_IPV6 = 42; /** * The socket limit for this context. * Available if compiled against ZeroMQ 3.x or higher */ - const CTXOPT_MAX_SOCKETS = 2; + public const CTXOPT_MAX_SOCKETS = 2; /** * Poll for incoming data */ - const POLL_IN = 1; + public const POLL_IN = 1; /** * Poll for outgoing data */ - const POLL_OUT = 2; + public const POLL_OUT = 2; /** * Non-blocking operation. * @deprecated use ZMQ::MODE_DONTWAIT instead */ - const MODE_NOBLOCK = 1; + public const MODE_NOBLOCK = 1; /** * Non-blocking operation */ - const MODE_DONTWAIT = 1; + public const MODE_DONTWAIT = 1; /** * Send multi-part message */ - const MODE_SNDMORE = 2; + public const MODE_SNDMORE = 2; /** * Forwarder device */ - const DEVICE_FORWARDER = 2; + public const DEVICE_FORWARDER = 2; /** * Queue device */ - const DEVICE_QUEUE = 3; + public const DEVICE_QUEUE = 3; /** * Streamer device */ - const DEVICE_STREAMER = 1; + public const DEVICE_STREAMER = 1; /** * ZMQ extension internal error */ - const ERR_INTERNAL = -99; + public const ERR_INTERNAL = -99; /** * Implies that the operation would block when ZMQ::MODE_DONTWAIT is used */ - const ERR_EAGAIN = 11; + public const ERR_EAGAIN = 11; /** * The operation is not supported by the socket type */ - const ERR_ENOTSUP = 156384713; + public const ERR_ENOTSUP = 156384713; /** * The operation can not be executed because the socket is not in correct state */ - const ERR_EFSM = 156384763; + public const ERR_EFSM = 156384763; /** * The context has been terminated */ - const ERR_ETERM = 156384765; + public const ERR_ETERM = 156384765; /** * Private constructor to prevent direct initialization. This class holds the constants for ZMQ extension. * @link https://secure.php.net/manual/en/zmq.construct.php */ - private function __construct() - { - } + private function __construct() {} } /** * Class ZMQContext @@ -295,9 +293,7 @@ class ZMQContext * @param int $io_threads Number of io-threads in the context * @param bool $is_persistent Whether the context is persistent. Persistent context is stored over multiple requests and is a requirement for persistent sockets. */ - public function __construct($io_threads = 1, $is_persistent = true) - { - } + public function __construct($io_threads = 1, $is_persistent = true) {} /** * (PECL zmq >= 1.0.4) * Returns the value of a context option. @@ -308,9 +304,7 @@ public function __construct($io_threads = 1, $is_persistent = true) * @return string|int Returns either a string or an integer depending on key. Throws ZMQContextException on error. * @throws ZMQContextException */ - public function getOpt($key) - { - } + public function getOpt($key) {} /** * (PECL zmq >= 0.5.0) * Shortcut for creating new sockets from the context. @@ -326,9 +320,7 @@ public function getOpt($key) * @return ZMQSocket * @throws ZMQSocketException */ - public function getSocket($type, $persistent_id = null, $on_new_socket = null) - { - } + public function getSocket($type, $persistent_id = null, $on_new_socket = null) {} /** * (PECL zmq >= 0.5.0) * Whether the context is persistent. @@ -338,9 +330,7 @@ public function getSocket($type, $persistent_id = null, $on_new_socket = null) * * @return bool Returns TRUE if the context is persistent and FALSE if the context is non-persistent. */ - public function isPersistent() - { - } + public function isPersistent() {} /** * (PECL zmq >= 1.0.4) * Sets a ZMQ context option. The type of the value depends on the key. @@ -353,9 +343,7 @@ public function isPersistent() * @return ZMQContext * @throws ZMQContextException */ - public function setOpt($key, $value) - { - } + public function setOpt($key, $value) {} } /** * Class ZMQSocket @@ -380,9 +368,7 @@ class ZMQSocket * * @throws ZMQSocketException */ - public function __construct(ZMQContext $context, $type, $persistent_id = null, $on_new_socket = null) - { - } + public function __construct(ZMQContext $context, $type, $persistent_id = null, $on_new_socket = null) {} /** * (PECL zmq >= 0.5.0) * Bind the socket to an endpoint. @@ -397,9 +383,7 @@ public function __construct(ZMQContext $context, $type, $persistent_id = null, $ * @return ZMQSocket * @throws ZMQSocketException if binding fails */ - public function bind($dsn, $force = false) - { - } + public function bind($dsn, $force = false) {} /** * (PECL zmq >= 0.5.0) * Connect the socket to a remote endpoint. @@ -414,9 +398,7 @@ public function bind($dsn, $force = false) * @return ZMQSocket * @throws ZMQSocketException If connection fails */ - public function connect($dsn, $force = false) - { - } + public function connect($dsn, $force = false) {} /** * (PECL zmq >= 1.0.4) * Disconnect the socket from a previously connected remote endpoint. @@ -430,9 +412,7 @@ public function connect($dsn, $force = false) * @return ZMQSocket * @throws ZMQSocketException If connection fails */ - public function disconnect($dsn) - { - } + public function disconnect($dsn) {} /** * Returns a list of endpoints where the socket is connected or bound to. * @@ -441,9 +421,7 @@ public function disconnect($dsn) * @return array contains two sub-arrays: 'connect' and 'bind' * @throws ZMQSocketException */ - public function getEndpoints() - { - } + public function getEndpoints() {} /** * Returns the persistent id string assigned of the object and NULL if socket is not persistent. * @@ -453,9 +431,7 @@ public function getEndpoints() * Returns the persistent id string assigned of the object and NULL if socket is not persistent. * */ - public function getPersistentId() - { - } + public function getPersistentId() {} /** * Returns the value of a socket option. * This method is available if ZMQ extension has been compiled against ZMQ version 2.0.7 or higher @@ -471,9 +447,7 @@ public function getPersistentId() * * @throws ZMQSocketException */ - public function getSockOpt($key) - { - } + public function getSockOpt($key) {} /** * Return the socket type. * The socket type can be compared against ZMQ::SOCKET_* constants. @@ -485,9 +459,7 @@ public function getSockOpt($key) * ZMQ::SOCKET_* constants. * */ - public function getSocketType() - { - } + public function getSocketType() {} /** * Check whether the socket is persistent. * @@ -495,9 +467,7 @@ public function getSocketType() * * @return boolReturns a boolean based on whether the socket is persistent or not.
*/ - public function isPersistent() - { - } + public function isPersistent() {} /** * Receive a message from a socket. * By default receiving will block until a message is available unless ZMQ::MODE_NOBLOCK flag is used. @@ -513,9 +483,7 @@ public function isPersistent() * @return string|falseReturns the message. Throws ZMQSocketException in error. If ZMQ::MODE_NOBLOCK is used and the operation would block boolean false shall be returned.
* @throws ZMQSocketException if receiving fails. */ - public function recv($mode = 0) - { - } + public function recv($mode = 0) {} /** * Receive an array multipart message from a socket. * By default receiving will block until a message is available unless ZMQ::MODE_NOBLOCK flag is used. @@ -529,9 +497,7 @@ public function recv($mode = 0) * @return string[] Returns the array of message parts. Throws ZMQSocketException in error. If ZMQ::MODE_NOBLOCK is used and the operation would block boolean false shall be returned. * @throws ZMQSocketException if receiving fails. */ - public function recvMulti($mode = 0) - { - } + public function recvMulti($mode = 0) {} /** * Send a message using the socket. The operation can block unless ZMQ::MODE_NOBLOCK is used. * If ZMQ::MODE_NOBLOCK is used and the operation would block bool false shall be returned. @@ -544,9 +510,7 @@ public function recvMulti($mode = 0) * @return ZMQSocket * @throws ZMQSocketException if sending message fails */ - public function send($message, $mode = 0) - { - } + public function send($message, $mode = 0) {} /** * Send a multipart message using the socket. The operation can block unless ZMQ::MODE_NOBLOCK is used. * If ZMQ::MODE_NOBLOCK is used and the operation would block bool false shall be returned. @@ -559,9 +523,7 @@ public function send($message, $mode = 0) * @return ZMQSocket * @throws ZMQSocketException if sending message fails */ - public function sendmulti(array $message, $mode = 0) - { - } + public function sendmulti(array $message, $mode = 0) {} /** * Sets a ZMQ socket option. The type of the value depends on the key. * @see ZMQ Constant Types for more information. @@ -574,9 +536,7 @@ public function sendmulti(array $message, $mode = 0) * @return ZMQSocket * @throws ZMQSocketException */ - public function setSockOpt($key, $value) - { - } + public function setSockOpt($key, $value) {} /** * Unbind the socket from an endpoint. * The endpoint is defined in format transport://address @@ -589,9 +549,7 @@ public function setSockOpt($key, $value) * @return ZMQSocket * @throws ZMQSocketException if binding fails */ - public function unbind($dsn) - { - } + public function unbind($dsn) {} } /** * Class ZMQPoll @@ -613,9 +571,7 @@ class ZMQPoll * @return int Returns a string id of the added item which can be later used to remove the item. Throws ZMQPollException on error. * @throws ZMQPollException if the object has not been initialized with polling */ - public function add(ZMQSocket $entry, $type) - { - } + public function add(ZMQSocket $entry, $type) {} /** * (PECL zmq >= 1.0.4) * Clears all elements from the poll set. @@ -624,9 +580,7 @@ public function add(ZMQSocket $entry, $type) * * @return ZMQPoll Returns the current object. */ - public function clear() - { - } + public function clear() {} /** * (PECL zmq >= 0.5.0) * Count the items in the poll set. @@ -635,9 +589,7 @@ public function clear() * * @return int Returns an integer representing the amount of items in the poll set. */ - public function count() - { - } + public function count() {} /** * (PECL zmq >= 0.5.0) * Returns the ids of the objects that had errors in the last poll. @@ -648,9 +600,7 @@ public function count() * * @return int[] */ - public function getLastErrors() - { - } + public function getLastErrors() {} /** * (PECL zmq >= 0.5.0) * Polls the items in the current poll set. @@ -667,9 +617,7 @@ public function getLastErrors() * @throws ZMQPollException if polling fails * @return int */ - public function poll(array &$readable, array &$writable, $timeout = -1) - { - } + public function poll(array &$readable, array &$writable, $timeout = -1) {} /** * (PECL zmq >= 0.5.0) * Remove item from the poll set. @@ -681,9 +629,7 @@ public function poll(array &$readable, array &$writable, $timeout = -1) * @param ZMQSocket|string|mixed $item The ZMQSocket object, PHP stream or string id of the item. * @return bool Returns true if the item was removed and false if the object with given id does not exist in the poll set. */ - public function remove($item) - { - } + public function remove($item) {} } /** * Class ZMQDevice @@ -704,9 +650,7 @@ class ZMQDevice * @param ZMQSocket $backend Backend parameter for the devices. Usually where there messages going to. * @param null|ZMQSocket $listener Listener socket, which receives a copy of all messages going both directions. The type of this socket should be SUB, PULL or DEALER. */ - public function __construct(ZMQSocket $frontend, ZMQSocket $backend, ZMQSocket $listener = null) - { - } + public function __construct(ZMQSocket $frontend, ZMQSocket $backend, ZMQSocket $listener = null) {} /** * Gets the idle callback timeout value. * This method returns the idle callback timeout value. @@ -716,9 +660,7 @@ public function __construct(ZMQSocket $frontend, ZMQSocket $backend, ZMQSocket $ * * @return int This method returns the idle callback timeout value. */ - public function getIdleTimeout() - { - } + public function getIdleTimeout() {} /** * Gets the timer callback timeout value. * Added in ZMQ extension version 1.1.0. @@ -727,9 +669,7 @@ public function getIdleTimeout() * * @return int This method returns the timer timeout value. */ - public function getTimerTimeout() - { - } + public function getTimerTimeout() {} /** * Runs the device. * Call to this method will block until the device is running. @@ -739,9 +679,7 @@ public function getTimerTimeout() * * @throws ZMQDeviceException */ - public function run() - { - } + public function run() {} /** * Sets the idle callback function. * If idle timeout is defined the idle callback function shall be called if the internal poll loop times out @@ -756,9 +694,7 @@ public function run() * * @return ZMQDevice On success this method returns the current object. */ - public function setIdleCallback($cb_func, $timeout, $user_data) - { - } + public function setIdleCallback($cb_func, $timeout, $user_data) {} /** * Sets the idle callback timeout value. The idle callback is invoked periodically when the device is idle. * On success this method returns the current object. @@ -769,9 +705,7 @@ public function setIdleCallback($cb_func, $timeout, $user_data) * * @return ZMQDevice On success this method returns the current object. */ - public function setIdleTimeout($timeout) - { - } + public function setIdleTimeout($timeout) {} /** * Sets the timer callback function. The timer callback will be invoked after timeout has passed. * The difference between idle and timer callbacks are that idle callback is invoked only when the device is idle. @@ -786,9 +720,7 @@ public function setIdleTimeout($timeout) * * @return ZMQDevice */ - public function setTimerCallback($cb_func, $timeout, $user_data) - { - } + public function setTimerCallback($cb_func, $timeout, $user_data) {} /** * Sets the timer callback timeout value. The timer callback is invoked periodically if it's set. * Added in ZMQ extension version 1.1.0. @@ -799,22 +731,10 @@ public function setTimerCallback($cb_func, $timeout, $user_data) * * @return ZMQDevice */ - public function setTimerTimeout($timeout) - { - } -} -class ZMQException extends Exception -{ -} -class ZMQContextException extends ZMQException -{ -} -class ZMQSocketException extends ZMQException -{ -} -class ZMQPollException extends ZMQException -{ -} -class ZMQDeviceException extends ZMQException -{ + public function setTimerTimeout($timeout) {} } +class ZMQException extends Exception {} +class ZMQContextException extends ZMQException {} +class ZMQSocketException extends ZMQException {} +class ZMQPollException extends ZMQException {} +class ZMQDeviceException extends ZMQException {} diff --git a/zookeeper/zookeeper.php b/zookeeper/zookeeper.php index 2aa37c3ea..60237c38e 100644 --- a/zookeeper/zookeeper.php +++ b/zookeeper/zookeeper.php @@ -9,68 +9,68 @@ class Zookeeper { /* class constants */ - const PERM_READ = 1; - const PERM_WRITE = 2; - const PERM_CREATE = 4; - const PERM_DELETE = 8; - const PERM_ADMIN = 16; - const PERM_ALL = 31; - - const EPHEMERAL = 1; - const SEQUENCE = 2; - - const EXPIRED_SESSION_STATE = -112; - const AUTH_FAILED_STATE = -113; - const CONNECTING_STATE = 1; - const ASSOCIATING_STATE = 2; - const CONNECTED_STATE = 3; - const NOTCONNECTED_STATE = 999; - - const CREATED_EVENT = 1; - const DELETED_EVENT = 2; - const CHANGED_EVENT = 3; - const CHILD_EVENT = 4; - const SESSION_EVENT = -1; - const NOTWATCHING_EVENT = -2; - - const LOG_LEVEL_ERROR = 1; - const LOG_LEVEL_WARN = 2; - const LOG_LEVEL_INFO = 3; - const LOG_LEVEL_DEBUG = 4; - - const SYSTEMERROR = -1; - const RUNTIMEINCONSISTENCY = -2; - const DATAINCONSISTENCY = -3; - const CONNECTIONLOSS = -4; - const MARSHALLINGERROR = -5; - const UNIMPLEMENTED = -6; - const OPERATIONTIMEOUT = -7; - const BADARGUMENTS = -8; - const INVALIDSTATE = -9; + public const PERM_READ = 1; + public const PERM_WRITE = 2; + public const PERM_CREATE = 4; + public const PERM_DELETE = 8; + public const PERM_ADMIN = 16; + public const PERM_ALL = 31; + + public const EPHEMERAL = 1; + public const SEQUENCE = 2; + + public const EXPIRED_SESSION_STATE = -112; + public const AUTH_FAILED_STATE = -113; + public const CONNECTING_STATE = 1; + public const ASSOCIATING_STATE = 2; + public const CONNECTED_STATE = 3; + public const NOTCONNECTED_STATE = 999; + + public const CREATED_EVENT = 1; + public const DELETED_EVENT = 2; + public const CHANGED_EVENT = 3; + public const CHILD_EVENT = 4; + public const SESSION_EVENT = -1; + public const NOTWATCHING_EVENT = -2; + + public const LOG_LEVEL_ERROR = 1; + public const LOG_LEVEL_WARN = 2; + public const LOG_LEVEL_INFO = 3; + public const LOG_LEVEL_DEBUG = 4; + + public const SYSTEMERROR = -1; + public const RUNTIMEINCONSISTENCY = -2; + public const DATAINCONSISTENCY = -3; + public const CONNECTIONLOSS = -4; + public const MARSHALLINGERROR = -5; + public const UNIMPLEMENTED = -6; + public const OPERATIONTIMEOUT = -7; + public const BADARGUMENTS = -8; + public const INVALIDSTATE = -9; /** * @since 3.5 */ - const NEWCONFIGNOQUORUM = -13 ; + public const NEWCONFIGNOQUORUM = -13; /** * @since 3.5 */ - const RECONFIGINPROGRESS = -14 ; - - const OK = 0; - const APIERROR = -100; - const NONODE = -101; - const NOAUTH = -102; - const BADVERSION = -103; - const NOCHILDRENFOREPHEMERALS = -108; - const NODEEXISTS = -110; - const NOTEMPTY = -111; - const SESSIONEXPIRED = -112; - const INVALIDCALLBACK = -113; - const INVALIDACL = -114; - const AUTHFAILED = -115; - const CLOSING = -116; - const NOTHING = -117; - const SESSIONMOVED = -118; + public const RECONFIGINPROGRESS = -14; + + public const OK = 0; + public const APIERROR = -100; + public const NONODE = -101; + public const NOAUTH = -102; + public const BADVERSION = -103; + public const NOCHILDRENFOREPHEMERALS = -108; + public const NODEEXISTS = -110; + public const NOTEMPTY = -111; + public const SESSIONEXPIRED = -112; + public const INVALIDCALLBACK = -113; + public const INVALIDACL = -114; + public const AUTHFAILED = -115; + public const CLOSING = -116; + public const NOTHING = -117; + public const SESSIONMOVED = -118; /** * Create a handle to used communicate with zookeeper. @@ -85,9 +85,7 @@ class Zookeeper * @throws ZookeeperException * @throws ZookeeperConnectionException when host is provided and when failed to connect to the host */ - public function __construct($host = '', $watcher_cb = null, $recv_timeout = 10000) - { - } + public function __construct($host = '', $watcher_cb = null, $recv_timeout = 10000) {} /** * Create a handle to used communicate with zookeeper. @@ -101,9 +99,7 @@ public function __construct($host = '', $watcher_cb = null, $recv_timeout = 1000 * @throws ZookeeperException * @throws ZookeeperConnectionException when failed to connect to Zookeeper */ - public function connect($host, $watcher_cb = null, $recv_timeout = 10000) - { - } + public function connect($host, $watcher_cb = null, $recv_timeout = 10000) {} /** * Close the zookeeper handle and free up any resources. @@ -113,9 +109,7 @@ public function connect($host, $watcher_cb = null, $recv_timeout = 10000) * @throws ZookeeperException * @throws ZookeeperConnectionException when closing an uninitialized instance */ - public function close() - { - } + public function close() {} /** * Create a node synchronously. @@ -132,9 +126,7 @@ public function close() * @throws ZookeeperException * @throws ZookeeperNoNodeException when parent path does not exist */ - public function create($path, $value, $acl, $flags = null) - { - } + public function create($path, $value, $acl, $flags = null) {} /** * Delete a node in zookeeper synchronously. @@ -149,9 +141,7 @@ public function create($path, $value, $acl, $flags = null) * @throws ZookeeperException * @throws ZookeeperNoNodeException when path does not exist */ - public function delete($path, $version = -1) - { - } + public function delete($path, $version = -1) {} /** * Sets the data associated with a node. @@ -168,9 +158,7 @@ public function delete($path, $version = -1) * @throws ZookeeperException * @throws ZookeeperNoNodeException when path does not exist */ - public function set($path, $data, $version = -1, &$stat = null) - { - } + public function set($path, $data, $version = -1, &$stat = null) {} /** * Gets the data associated with a node synchronously. @@ -187,9 +175,7 @@ public function set($path, $data, $version = -1, &$stat = null) * @throws ZookeeperException * @throws ZookeeperNoNodeException when path does not exist */ - public function get($path, $watcher_cb = null, &$stat = null, $max_size = 0) - { - } + public function get($path, $watcher_cb = null, &$stat = null, $max_size = 0) {} /** * Get children data of a path. @@ -205,9 +191,7 @@ public function get($path, $watcher_cb = null, &$stat = null, $max_size = 0) * @throws ZookeeperNoNodeException when path does not exist */ #[Pure] - public function getChildren($path, $watcher_cb = null) - { - } + public function getChildren($path, $watcher_cb = null) {} /** * Checks the existence of a node in zookeeper synchronously. @@ -221,9 +205,7 @@ public function getChildren($path, $watcher_cb = null) * * @throws ZookeeperException */ - public function exists($path, $watcher_cb = null) - { - } + public function exists($path, $watcher_cb = null) {} /** * Gets the acl associated with a node synchronously. @@ -237,9 +219,7 @@ public function exists($path, $watcher_cb = null) * @throws ZookeeperException when connection not in connected status */ #[Pure] - public function getAcl($path) - { - } + public function getAcl($path) {} /** * Sets the acl associated with a node synchronously. @@ -254,9 +234,7 @@ public function getAcl($path) * * @throws ZookeeperException when connection not in connected status */ - public function setAcl($path, $version, $acls) - { - } + public function setAcl($path, $version, $acls) {} /** * return the client session id, only valid if the connections is currently connected @@ -270,9 +248,7 @@ public function setAcl($path, $version, $acls) * @throws ZookeeperConnectionException when connection not in connected status */ #[Pure] - public function getClientId() - { - } + public function getClientId() {} /** * Set a watcher function. @@ -286,9 +262,7 @@ public function getClientId() * @throws ZookeeperException * @throws ZookeeperConnectionException when connection not in connected status */ - public function setWatcher($watcher_cb) - { - } + public function setWatcher($watcher_cb) {} /** * Get the state of the zookeeper connection. @@ -301,9 +275,7 @@ public function setWatcher($watcher_cb) * @throws ZookeeperConnectionException when connection not in connected status */ #[Pure] - public function getState() - { - } + public function getState() {} /** * Return the timeout for this session, only valid if the connections is currently connected @@ -317,9 +289,7 @@ public function getState() * @throws ZookeeperConnectionException when connection not in connected status */ #[Pure] - public function getRecvTimeout() - { - } + public function getRecvTimeout() {} /** * Specify application credentials. @@ -335,9 +305,7 @@ public function getRecvTimeout() * @throws ZookeeperException * @throws ZookeeperConnectionException when connection not in connected status */ - public function addAuth($scheme, $cert, $completion_cb = null) - { - } + public function addAuth($scheme, $cert, $completion_cb = null) {} /** * Checks if the current zookeeper connection state can be recovered. @@ -349,9 +317,7 @@ public function addAuth($scheme, $cert, $completion_cb = null) * @throws ZookeeperException * @throws ZookeeperConnectionException when connection not in connected status */ - public function isRecoverable() - { - } + public function isRecoverable() {} /** * Sets the stream to be used by the library for logging. @@ -364,9 +330,7 @@ public function isRecoverable() * * @return bool */ - public function setLogStream($file) - { - } + public function setLogStream($file) {} /** * Sets the debugging level for the library. @@ -377,9 +341,7 @@ public function setLogStream($file) * * @return bool */ - public static function setDebugLevel($level) - { - } + public static function setDebugLevel($level) {} /** * Enable/disable quorum endpoint order randomization. @@ -390,35 +352,19 @@ public static function setDebugLevel($level) * * @return bool */ - public static function setDeterministicConnOrder($trueOrFalse) - { - } + public static function setDeterministicConnOrder($trueOrFalse) {} } -class ZookeeperException extends Exception -{ -} +class ZookeeperException extends Exception {} -class ZookeeperOperationTimeoutException extends ZookeeperException -{ -} +class ZookeeperOperationTimeoutException extends ZookeeperException {} -class ZookeeperConnectionException extends ZookeeperException -{ -} +class ZookeeperConnectionException extends ZookeeperException {} -class ZookeeperMarshallingException extends ZookeeperException -{ -} +class ZookeeperMarshallingException extends ZookeeperException {} -class ZookeeperAuthenticationException extends ZookeeperException -{ -} +class ZookeeperAuthenticationException extends ZookeeperException {} -class ZookeeperSessionException extends ZookeeperException -{ -} +class ZookeeperSessionException extends ZookeeperException {} -class ZookeeperNoNodeException extends ZookeeperException -{ -} +class ZookeeperNoNodeException extends ZookeeperException {} diff --git a/zstd/zstd.php b/zstd/zstd.php index 00491a97d..de533d085 100644 --- a/zstd/zstd.php +++ b/zstd/zstd.php @@ -40,8 +40,7 @@ * * @return string|false Returns the compressed data or FALSE if an error occurred. */ - function zstd_compress(string $data, int $level = 3): string|false - {} + function zstd_compress(string $data, int $level = 3): string|false {} /** * Zstandard decompression. @@ -50,8 +49,7 @@ function zstd_compress(string $data, int $level = 3): string|false * * @return string|false Returns the decompressed data or FALSE if an error occurred. */ - function zstd_uncompress(string $data): string|false - {} + function zstd_uncompress(string $data): string|false {} /** * Zstandard compression using a digested dictionary. @@ -61,8 +59,7 @@ function zstd_uncompress(string $data): string|false * * @return string|false Returns the compressed data or FALSE if an error occurred. */ - function zstd_compress_dict(string $data, string $dict): string|false - {} + function zstd_compress_dict(string $data, string $dict): string|false {} /** * Zstandard decompression using a digested dictionary. @@ -73,8 +70,7 @@ function zstd_compress_dict(string $data, string $dict): string|false * * @return string|false Returns the compressed data or FALSE if an error occurred. */ - function zstd_compress_usingcdict(string $data, string $dict): string|false - {} + function zstd_compress_usingcdict(string $data, string $dict): string|false {} /** * Zstandard decompression using a digested dictionary. @@ -84,8 +80,7 @@ function zstd_compress_usingcdict(string $data, string $dict): string|false * * @return string|false Returns the decompressed data or FALSE if an error occurred. */ - function zstd_uncompress_dict(string $data, string $dict): string|false - {} + function zstd_uncompress_dict(string $data, string $dict): string|false {} /** * Zstandard decompression using a digested dictionary. @@ -96,8 +91,7 @@ function zstd_uncompress_dict(string $data, string $dict): string|false * * @return string|false Returns the decompressed data or FALSE if an error occurred. */ - function zstd_decompress_dict(string $data, string $dict): string|false - {} + function zstd_decompress_dict(string $data, string $dict): string|false {} /** * Zstandard decompression using a digested dictionary. @@ -108,8 +102,7 @@ function zstd_decompress_dict(string $data, string $dict): string|false * * @return string|false Returns the decompressed data or FALSE if an error occurred. */ - function zstd_uncompress_usingcdict(string $data, string $dict): string|false - {} + function zstd_uncompress_usingcdict(string $data, string $dict): string|false {} /** * Zstandard decompression using a digested dictionary. @@ -120,8 +113,7 @@ function zstd_uncompress_usingcdict(string $data, string $dict): string|false * * @return string|false Returns the decompressed data or FALSE if an error occurred. */ - function zstd_decompress_usingcdict(string $data, string $dict): string|false - {} + function zstd_decompress_usingcdict(string $data, string $dict): string|false {} } namespace Zstd { @@ -134,8 +126,7 @@ function zstd_decompress_usingcdict(string $data, string $dict): string|false * * @return string|false Returns the compressed data or FALSE if an error occurred. */ - function compress(string $data, int $level = 3): string|false - {} + function compress(string $data, int $level = 3): string|false {} /** * Zstandard decompression. @@ -144,8 +135,7 @@ function compress(string $data, int $level = 3): string|false * * @return string|false Returns the decompressed data or FALSE if an error occurred. */ - function uncompress(string $data): string|false - {} + function uncompress(string $data): string|false {} /** * Zstandard compression using a digested dictionary. @@ -155,8 +145,7 @@ function uncompress(string $data): string|false * * @return string|false Returns the compressed data or FALSE if an error occurred. */ - function compress_dict(string $data, string $dict): string|false - {} + function compress_dict(string $data, string $dict): string|false {} /** * Zstandard decompression using a digested dictionary. @@ -166,6 +155,5 @@ function compress_dict(string $data, string $dict): string|false * * @return string|false Returns the decompressed data or FALSE if an error occurred. */ - function uncompress_dict(string $data, string $dict): string|false - {} + function uncompress_dict(string $data, string $dict): string|false {} }