diff --git a/features/commandline.xml b/features/commandline.xml index 3de55fb90d46..9feabb65ca34 100644 --- a/features/commandline.xml +++ b/features/commandline.xml @@ -4,7 +4,6 @@ Using PHP from the command line Command line usage -
Introduction @@ -82,9 +81,7 @@
- - - +
Differences to other <acronym>SAPI</acronym>s @@ -319,9 +316,7 @@ $ php -f another_directory/test.php
- - - +
Command line options Options @@ -1032,9 +1027,7 @@ date.sunrise_zenith => 90.583333 => 90.583333
- - - +
Executing PHP files Usage @@ -1311,9 +1304,7 @@ This is a command line PHP script with one option.
- - - +
Input/output streams I/O streams @@ -1413,9 +1404,7 @@ php -r 'fwrite(STDERR, "stderr\n");'
- -
Interactive shell @@ -1633,9 +1622,7 @@ php >
- -
Built-in web server @@ -1915,7 +1902,6 @@ $ php -S 0.0.0.0:8000
-
INI settings diff --git a/language/context/ftp.xml b/language/context/ftp.xml index ef38b6a97fc1..ba625fee6298 100644 --- a/language/context/ftp.xml +++ b/language/context/ftp.xml @@ -15,7 +15,7 @@ - + &reftitle.options; @@ -62,7 +62,7 @@ - + &reftitle.notes; diff --git a/language/context/http.xml b/language/context/http.xml index f11e1097bca8..41fbcb1d4922 100644 --- a/language/context/http.xml +++ b/language/context/http.xml @@ -15,7 +15,7 @@ - + &reftitle.options; @@ -196,12 +196,12 @@ - + - + &reftitle.examples; - + Fetch a page and send POST data ]]> - + - + Ignore redirects but fetch headers and content ]]> - + - + &reftitle.notes; diff --git a/language/context/parameters.xml b/language/context/parameters.xml index 33788912feda..442a8c81c56d 100644 --- a/language/context/parameters.xml +++ b/language/context/parameters.xml @@ -15,7 +15,7 @@ - + &reftitle.parameters; @@ -36,7 +36,7 @@ - + diff --git a/language/context/phar.xml b/language/context/phar.xml index 32b5f4f93dee..5b8132e189fb 100644 --- a/language/context/phar.xml +++ b/language/context/phar.xml @@ -14,7 +14,7 @@ - + &reftitle.options; @@ -42,7 +42,7 @@ - + &reftitle.seealso; diff --git a/language/context/socket.xml b/language/context/socket.xml index 7308c5f91156..641df2fd8c20 100644 --- a/language/context/socket.xml +++ b/language/context/socket.xml @@ -7,16 +7,16 @@ Socket context option listing - + &reftitle.description; Socket context options are available for all wrappers that work over sockets, like tcp, http and ftp. - + - + &reftitle.options; @@ -107,9 +107,9 @@ - + - + &reftitle.changelog; @@ -137,12 +137,12 @@ - + - + &reftitle.examples; - + Basic <parameter>bindto</parameter> usage example ]]> - + - + diff --git a/language/context/ssl.xml b/language/context/ssl.xml index ef5ac318521d..c8561e037d02 100644 --- a/language/context/ssl.xml +++ b/language/context/ssl.xml @@ -15,7 +15,7 @@ - + &reftitle.options; @@ -255,9 +255,9 @@ - + - + &reftitle.changelog; @@ -279,7 +279,7 @@ - + &reftitle.notes; diff --git a/language/context/zip.xml b/language/context/zip.xml index 6edfb4d02925..f3b796c1aa53 100644 --- a/language/context/zip.xml +++ b/language/context/zip.xml @@ -7,14 +7,14 @@ Zip context option listing - + &reftitle.description; Zip context options are available for zip wrappers. - + - + &reftitle.options; @@ -28,9 +28,9 @@ - + - + &reftitle.changelog; @@ -52,12 +52,12 @@ - + - + &reftitle.examples; - + Basic <parameter>password</parameter> usage example ]]> - + - + diff --git a/language/fibers.xml b/language/fibers.xml index eae91489d4c6..7de85b6147ba 100644 --- a/language/fibers.xml +++ b/language/fibers.xml @@ -42,7 +42,7 @@ - + Basic usage - + diff --git a/language/predefined/argumentcounterror.xml b/language/predefined/argumentcounterror.xml index 5f6b147580b6..4b868d9ccb92 100644 --- a/language/predefined/argumentcounterror.xml +++ b/language/predefined/argumentcounterror.xml @@ -3,27 +3,24 @@ ArgumentCountError ArgumentCountError - + - - +
&reftitle.intro; ArgumentCountError is thrown when too few arguments are passed to a user-defined function or method. - + This error is also thrown when too many arguments are passed to a non-variadic built-in function. - +
- - +
&reftitle.classsynopsis; - - + ArgumentCountError @@ -47,9 +44,7 @@ - - - +
diff --git a/language/predefined/arithmeticerror.xml b/language/predefined/arithmeticerror.xml index f9828b894eb3..713e72675e64 100644 --- a/language/predefined/arithmeticerror.xml +++ b/language/predefined/arithmeticerror.xml @@ -3,10 +3,9 @@ ArithmeticError ArithmeticError - + - - +
&reftitle.intro; @@ -17,12 +16,10 @@ value outside the possible bounds of an int.
- - +
&reftitle.classsynopsis; - - + ArithmeticError @@ -46,9 +43,7 @@ - - - +
diff --git a/language/predefined/arrayaccess.xml b/language/predefined/arrayaccess.xml index 6c5cd30366ae..4b3f152ea67b 100644 --- a/language/predefined/arrayaccess.xml +++ b/language/predefined/arrayaccess.xml @@ -7,19 +7,16 @@ -
&reftitle.intro; Interface to provide accessing objects as arrays.
-
&reftitle.interfacesynopsis; - ArrayAccess @@ -30,13 +27,12 @@ -
&reftitle.examples; - + Basic usage - +
diff --git a/language/predefined/assertionerror.xml b/language/predefined/assertionerror.xml index 399943c51def..81a0b6045abc 100644 --- a/language/predefined/assertionerror.xml +++ b/language/predefined/assertionerror.xml @@ -3,10 +3,9 @@ AssertionError AssertionError - + - - +
&reftitle.intro; @@ -14,12 +13,10 @@ an assertion made via assert fails.
- - +
&reftitle.classsynopsis; - - + AssertionError @@ -43,9 +40,7 @@ - - - +
diff --git a/language/predefined/backedenum.xml b/language/predefined/backedenum.xml index 8ae981781ced..37a456f1839c 100644 --- a/language/predefined/backedenum.xml +++ b/language/predefined/backedenum.xml @@ -5,22 +5,19 @@ -
&reftitle.intro; - + The BackedEnum interface is automatically applied to backed enumerations by the engine. It may not be implemented by user-defined classes. Enumerations may not override its methods, as default implementations are provided by the engine. It is available only for type checks. - +
-
&reftitle.interfacesynopsis; - BackedEnum @@ -41,7 +38,6 @@ -
diff --git a/language/predefined/backedenum/from.xml b/language/predefined/backedenum/from.xml index e26ed7101f5d..4ecd30257c18 100644 --- a/language/predefined/backedenum/from.xml +++ b/language/predefined/backedenum/from.xml @@ -14,7 +14,7 @@ The from method translates a string or int into the corresponding Enum case, if any. If there is no matching case defined, it will throw - a ValueError. + a ValueError.
@@ -25,9 +25,9 @@ value - + The scalar value to map to an enum case. - + @@ -35,18 +35,18 @@ &reftitle.returnvalues; - + A case instance of this enumeration. - + &reftitle.examples; Basic usage - + The following example illustrates how enum cases are returned. - + value - + The scalar value to map to an enum case. - + @@ -35,18 +35,18 @@ &reftitle.returnvalues; - + A case instance of this enumeration, or null if not found. - + &reftitle.examples; Basic usage - + The following example illustrates how enum cases are returned. - + -
&reftitle.intro; - - A ClosedGeneratorException is thrown when trying + + A ClosedGeneratorException is thrown when trying to retrieve a value from a closed Generator. - +
-
&reftitle.classsynopsis; - ClosedGeneratorException @@ -42,7 +39,6 @@ -
diff --git a/language/predefined/closure.xml b/language/predefined/closure.xml index dafaee47dbfd..49addbff4462 100644 --- a/language/predefined/closure.xml +++ b/language/predefined/closure.xml @@ -7,34 +7,31 @@ -
&reftitle.intro; - + Class used to represent anonymous functions. - + - + Anonymous functions yield objects of this type. This class has methods that allow further control of the anonymous function after it has been created. - + - + Besides the methods listed here, this class also has an __invoke method. This is for consistency with other classes that implement calling magic, as this method is not used for calling the function. - +
-
&reftitle.classsynopsis; - final @@ -49,7 +46,6 @@ -
diff --git a/language/predefined/closure/bind.xml b/language/predefined/closure/bind.xml index 431b5913b35f..6bceb09c4d36 100644 --- a/language/predefined/closure/bind.xml +++ b/language/predefined/closure/bind.xml @@ -29,30 +29,30 @@ closure - + The anonymous functions to bind. - + newThis - + The object to which the given anonymous function should be bound, or &null; for the closure to be unbound. - + newScope - + The class scope to which the closure is to be associated, or 'static' to keep the current one. If an object is given, the type of the object will be used instead. This determines the visibility of protected and private methods of the bound object. It is not allowed to pass (an object of) an internal class as this parameter. - + @@ -60,9 +60,9 @@ &reftitle.returnvalues; - + Returns a new Closure object, or &null; on failure. - + diff --git a/language/predefined/closure/bindto.xml b/language/predefined/closure/bindto.xml index 963d7bb7a48e..0082f1b889d6 100644 --- a/language/predefined/closure/bindto.xml +++ b/language/predefined/closure/bindto.xml @@ -15,13 +15,13 @@ objectnullnewThis objectstringnullnewScope"static" - + Create and return a new anonymous function with the same body and bound variables as this one, but possibly with a different bound object and a new class scope. - + - + The “bound object” determines the value $this will have in the function body and the “class scope” represents a class which determines which private and protected members the anonymous @@ -29,27 +29,27 @@ visible are the same as if the anonymous function were a method of the class given as value of the newScope parameter. - + - + Static closures cannot have any bound object (the value of the parameter newThis should be &null;), but this method can nevertheless be used to change their class scope. - + - + This method will ensure that for a non-static closure, having a bound instance will imply being scoped and vice-versa. To this end, non-static closures that are given a scope but a &null; instance are made static and non-static non-scoped closures that are given a non-null instance are scoped to an unspecified class. - + - + If you only want to duplicate the anonymous functions, you can use cloning instead. - + @@ -60,22 +60,22 @@ newThis - + The object to which the given anonymous function should be bound, or - &null; for the closure to be unbound. - + &null; for the closure to be unbound. + newScope - + The class scope to which the closure is to be associated, or 'static' to keep the current one. If an object is given, the type of the object will be used instead. This determines the visibility of protected and private methods of the bound object. It is not allowed to pass (an object of) an internal class as this parameter. - + @@ -83,10 +83,10 @@ &reftitle.returnvalues; - + Returns the newly created Closure object or &null; on failure. - + diff --git a/language/predefined/closure/call.xml b/language/predefined/closure/call.xml index ad2331a4d7b9..030e853b3840 100644 --- a/language/predefined/closure/call.xml +++ b/language/predefined/closure/call.xml @@ -5,47 +5,47 @@ Closure::call Binds and calls the closure - + &reftitle.description; public mixedClosure::call objectnewThis mixedargs - + Temporarily binds the closure to newThis, and calls it with any given parameters. - - - + + + &reftitle.parameters; newThis - + The object to bind the closure to for the duration of the call. - + args - + Zero or more parameters, which will be given as parameters to the closure. - + - - + + &reftitle.returnvalues; - + Returns the return value of the closure. - - + + &reftitle.examples; diff --git a/language/predefined/closure/construct.xml b/language/predefined/closure/construct.xml index 85bf95450acf..1fe3d29d50ea 100644 --- a/language/predefined/closure/construct.xml +++ b/language/predefined/closure/construct.xml @@ -12,12 +12,12 @@ private Closure::__construct - + 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. - + diff --git a/language/predefined/closure/fromcallable.xml b/language/predefined/closure/fromcallable.xml index 6fee6fdae38c..f965a4417c19 100644 --- a/language/predefined/closure/fromcallable.xml +++ b/language/predefined/closure/fromcallable.xml @@ -12,17 +12,17 @@ public static ClosureClosure::fromCallable callablecallback - + Create and return a new anonymous function from given callback using the current scope. This method checks if the callback is - callable in the current scope and throws a TypeError + callable in the current scope and throws a TypeError if it is not. - + - + As of PHP 8.1.0, First class callable syntax has the same semantics as this method. - + @@ -32,9 +32,9 @@ callback - + The callable to convert. - + @@ -42,11 +42,11 @@ &reftitle.returnvalues; - + Returns the newly created Closure or throws a - TypeError if the callback is + TypeError if the callback is not callable in the current scope. - + diff --git a/language/predefined/closure/getcurrent.xml b/language/predefined/closure/getcurrent.xml index 5d307c18a73f..6524f988fb0a 100644 --- a/language/predefined/closure/getcurrent.xml +++ b/language/predefined/closure/getcurrent.xml @@ -12,15 +12,15 @@ public static ClosureClosure::getCurrent - + Returns the currently executing closure. This method is primarily useful for implementing recursive closures without needing to capture a reference to the closure variable using the use keyword. - - + + This method must be called from within a closure; calling it outside of a closure context will result in Error: Current function is not a closure. - + @@ -30,17 +30,17 @@ &reftitle.returnvalues; - + Returns the currently executing Closure instance. - + &reftitle.errors; - - Throws an Error if called outside of a closure + + Throws an Error if called outside of a closure context. - + @@ -70,10 +70,10 @@ echo $fibonacci(10); // Outputs: 55
Comparison with traditional approach - + Prior to PHP 8.5, implementing recursive closures required capturing a reference to the closure variable using the use keyword: - + -
&reftitle.intro; @@ -14,12 +13,10 @@ compilation errors, which formerly issued a fatal error.
-
&reftitle.classsynopsis; - CompileError @@ -44,8 +41,6 @@ - -
diff --git a/language/predefined/countable.xml b/language/predefined/countable.xml index 7072a167c26f..e9e7542be07d 100644 --- a/language/predefined/countable.xml +++ b/language/predefined/countable.xml @@ -7,20 +7,17 @@ -
&reftitle.intro; - + Classes implementing Countable can be used with the count function. - +
-
&reftitle.interfacesynopsis; - Countable @@ -31,7 +28,6 @@ -
diff --git a/language/predefined/divisionbyzeroerror.xml b/language/predefined/divisionbyzeroerror.xml index 227a4c775de7..a8a4a7fe781c 100644 --- a/language/predefined/divisionbyzeroerror.xml +++ b/language/predefined/divisionbyzeroerror.xml @@ -3,10 +3,9 @@ DivisionByZeroError DivisionByZeroError - + - - +
&reftitle.intro; @@ -14,12 +13,10 @@ when an attempt is made to divide a number by zero.
- - +
&reftitle.classsynopsis; - - + DivisionByZeroError @@ -43,9 +40,7 @@ - - - +
diff --git a/language/predefined/error.xml b/language/predefined/error.xml index 153f768d35d2..5a20a91ba6f1 100644 --- a/language/predefined/error.xml +++ b/language/predefined/error.xml @@ -5,8 +5,7 @@ Error - - +
&reftitle.intro; @@ -14,12 +13,10 @@ internal PHP errors.
-
&reftitle.classsynopsis; - - + Error @@ -81,10 +78,8 @@ - -
- +
&reftitle.properties; @@ -132,7 +127,6 @@
-
diff --git a/language/predefined/errorexception.xml b/language/predefined/errorexception.xml index fd250550e7ac..ca405b7d63f7 100644 --- a/language/predefined/errorexception.xml +++ b/language/predefined/errorexception.xml @@ -6,19 +6,16 @@ -
&reftitle.intro; An Error Exception.
-
&reftitle.classsynopsis; - ErrorException @@ -55,11 +52,9 @@ -
-
&reftitle.properties; @@ -71,12 +66,11 @@
- - +
&reftitle.examples; - + Use <function>set_error_handler</function> to change error messages into ErrorException - +
diff --git a/language/predefined/exception.xml b/language/predefined/exception.xml index 47f59fa654d4..4fb9c88f4f02 100644 --- a/language/predefined/exception.xml +++ b/language/predefined/exception.xml @@ -5,8 +5,7 @@ Exception - - +
&reftitle.intro; @@ -14,12 +13,10 @@ all user exceptions.
-
&reftitle.classsynopsis; - - + Exception @@ -81,11 +78,8 @@ - -
- - +
&reftitle.properties; @@ -133,7 +127,6 @@
-
diff --git a/language/predefined/fiber.xml b/language/predefined/fiber.xml index da6831abeb68..34ab929f40a7 100644 --- a/language/predefined/fiber.xml +++ b/language/predefined/fiber.xml @@ -6,20 +6,17 @@ -
&reftitle.intro; - + Fibers represent full-stack, interruptible functions. Fibers may be suspended from anywhere in the call-stack, pausing execution within the fiber until the fiber is resumed at a later time. - +
-
&reftitle.classsynopsis; - final @@ -34,13 +31,12 @@ -
&reftitle.seealso; - Fibers overview + Fibers overview
diff --git a/language/predefined/fiber/getcurrent.xml b/language/predefined/fiber/getcurrent.xml index 79449aca3d74..147e2338cae1 100644 --- a/language/predefined/fiber/getcurrent.xml +++ b/language/predefined/fiber/getcurrent.xml @@ -11,8 +11,8 @@ public static FibernullFiber::getCurrent - - + +
@@ -22,10 +22,10 @@ &reftitle.returnvalues; - + Returns the currently executing Fiber instance or &null; if this method is called from outside a fiber. - + diff --git a/language/predefined/fiber/getreturn.xml b/language/predefined/fiber/getreturn.xml index c90c46f756a6..0589da47152e 100644 --- a/language/predefined/fiber/getreturn.xml +++ b/language/predefined/fiber/getreturn.xml @@ -11,8 +11,8 @@ public mixedFiber::getReturn - - + + @@ -25,7 +25,7 @@ Returns the value returned by the callable provided to Fiber::__construct. If the fiber has not returned a value, either because it has not been started, has not terminated, or threw an - exception, a FiberError will be thrown. + exception, a FiberError will be thrown. diff --git a/language/predefined/fiber/isrunning.xml b/language/predefined/fiber/isrunning.xml index bf9d9fef840e..d1624275b133 100644 --- a/language/predefined/fiber/isrunning.xml +++ b/language/predefined/fiber/isrunning.xml @@ -11,8 +11,8 @@ public boolFiber::isRunning - - + +
diff --git a/language/predefined/fiber/isstarted.xml b/language/predefined/fiber/isstarted.xml index 620b1c63b01a..654117810b1a 100644 --- a/language/predefined/fiber/isstarted.xml +++ b/language/predefined/fiber/isstarted.xml @@ -11,8 +11,8 @@ public boolFiber::isStarted - - + + @@ -22,9 +22,9 @@ &reftitle.returnvalues; - + Returns &true; only after the fiber has been started; otherwise &false; is returned. - + diff --git a/language/predefined/fiber/issuspended.xml b/language/predefined/fiber/issuspended.xml index f3717106357e..c3d4de7fa38d 100644 --- a/language/predefined/fiber/issuspended.xml +++ b/language/predefined/fiber/issuspended.xml @@ -11,8 +11,8 @@ public boolFiber::isSuspended - - + + @@ -22,9 +22,9 @@ &reftitle.returnvalues; - + Returns &true; if the fiber is currently suspended; otherwise &false; is returned. - + diff --git a/language/predefined/fiber/isterminated.xml b/language/predefined/fiber/isterminated.xml index db77a4334078..a7e9e8e6665a 100644 --- a/language/predefined/fiber/isterminated.xml +++ b/language/predefined/fiber/isterminated.xml @@ -11,8 +11,8 @@ public boolFiber::isTerminated - - + + @@ -22,10 +22,10 @@ &reftitle.returnvalues; - + Returns &true; only after the fiber has terminated, either by returning or throwing an exception; otherwise &false; is returned. - + diff --git a/language/predefined/fiber/resume.xml b/language/predefined/fiber/resume.xml index 875b6ce21517..a99339a7dea5 100644 --- a/language/predefined/fiber/resume.xml +++ b/language/predefined/fiber/resume.xml @@ -14,9 +14,9 @@ Resumes the fiber using the given value as the result of the current Fiber::suspend call. - - If the fiber is not suspended when this method is called, a FiberError will be thrown. - + + If the fiber is not suspended when this method is called, a FiberError will be thrown. + diff --git a/language/predefined/fiber/start.xml b/language/predefined/fiber/start.xml index 7c55fe0e433a..8c3dfafd4313 100644 --- a/language/predefined/fiber/start.xml +++ b/language/predefined/fiber/start.xml @@ -11,12 +11,12 @@ public mixedFiber::start mixedargs - + A variadic list of arguments to provide to the callable used when constructing the fiber. - - - If the fiber has already been started when this method is called, a FiberError will be thrown. - + + + If the fiber has already been started when this method is called, a FiberError will be thrown. + @@ -25,9 +25,9 @@ args - + The arguments to use when invoking the callable given to the fiber constructor. - + diff --git a/language/predefined/fiber/suspend.xml b/language/predefined/fiber/suspend.xml index 9590fd23fdeb..a8d2da285022 100644 --- a/language/predefined/fiber/suspend.xml +++ b/language/predefined/fiber/suspend.xml @@ -21,9 +21,9 @@ If the fiber is resumed using Fiber::throw, the exception given to that method will be thrown from the call to this method. - - If this method is called from outside a fiber, a FiberError will be thrown. - + + If this method is called from outside a fiber, a FiberError will be thrown. + diff --git a/language/predefined/fiber/throw.xml b/language/predefined/fiber/throw.xml index 951aaafc0a5a..8de016c05191 100644 --- a/language/predefined/fiber/throw.xml +++ b/language/predefined/fiber/throw.xml @@ -14,9 +14,9 @@ Resumes the fiber by throwing the given exception from the current Fiber::suspend call. - - If the fiber is not suspended when this method is called, a FiberError will be thrown. - + + If the fiber is not suspended when this method is called, a FiberError will be thrown. + diff --git a/language/predefined/fibererror.xml b/language/predefined/fibererror.xml index d0643a375e3a..b7fdc7308174 100644 --- a/language/predefined/fibererror.xml +++ b/language/predefined/fibererror.xml @@ -6,7 +6,6 @@ -
&reftitle.intro; @@ -14,12 +13,10 @@ when an invalid operation is performed on a Fiber.
-
&reftitle.classsynopsis; - final @@ -47,8 +44,6 @@ - -
diff --git a/language/predefined/fibererror/construct.xml b/language/predefined/fibererror/construct.xml index 0f3da79a0c8c..7729dbce6bbb 100644 --- a/language/predefined/fibererror/construct.xml +++ b/language/predefined/fibererror/construct.xml @@ -19,9 +19,9 @@
&reftitle.errors; - - Throws an Error exception when called. - + + Throws an Error exception when called. +
&reftitle.intro; - + Generator objects are returned from generators. - - + + - + Generator objects cannot be instantiated via new. - +
-
&reftitle.classsynopsis; - final @@ -44,13 +41,12 @@ -
&reftitle.seealso; - See also object iteration. + See also object iteration.
diff --git a/language/predefined/internaliterator.xml b/language/predefined/internaliterator.xml index a333ff470f8d..6981e7639155 100644 --- a/language/predefined/internaliterator.xml +++ b/language/predefined/internaliterator.xml @@ -5,7 +5,6 @@ -
&reftitle.intro; @@ -13,12 +12,10 @@ for internal classes.
-
&reftitle.classsynopsis; - final @@ -38,7 +35,6 @@ -
diff --git a/language/predefined/internaliterator/current.xml b/language/predefined/internaliterator/current.xml index 5c635c37618e..08fde8ec74b7 100644 --- a/language/predefined/internaliterator/current.xml +++ b/language/predefined/internaliterator/current.xml @@ -11,9 +11,9 @@ public mixedInternalIterator::current - + Returns the current element. - + @@ -23,9 +23,9 @@ &reftitle.returnvalues; - + Returns the current element. - +
&reftitle.intro; @@ -15,12 +14,10 @@ themselves internally.
-
&reftitle.interfacesynopsis; - Iterator @@ -36,7 +33,6 @@ -
@@ -50,7 +46,7 @@
&reftitle.examples; - + Basic usage This example demonstrates in which order methods are called when @@ -136,7 +132,7 @@ string(16) "myIterator::next" string(17) "myIterator::valid" ]]> - +
diff --git a/language/predefined/iterator/key.xml b/language/predefined/iterator/key.xml index 585b0803b546..b0def189683c 100644 --- a/language/predefined/iterator/key.xml +++ b/language/predefined/iterator/key.xml @@ -29,12 +29,12 @@ - + &reftitle.errors; Issues E_NOTICE on failure. - +
&reftitle.intro; Interface to create an external Iterator.
-
&reftitle.interfacesynopsis; - IteratorAggregate @@ -35,13 +32,12 @@ -
&reftitle.examples; - + Basic usage - +
diff --git a/language/predefined/iteratoraggregate/getiterator.xml b/language/predefined/iteratoraggregate/getiterator.xml index 093d26e9cc32..4bfb564ec8df 100644 --- a/language/predefined/iteratoraggregate/getiterator.xml +++ b/language/predefined/iteratoraggregate/getiterator.xml @@ -30,12 +30,12 @@ - + &reftitle.errors; Throws an Exception on failure. - + +
&reftitle.intro; @@ -21,12 +20,10 @@
-
&reftitle.classsynopsis; - - + ParseError @@ -51,8 +48,6 @@ - -
diff --git a/language/predefined/requestparsebodyexception.xml b/language/predefined/requestparsebodyexception.xml index 6bf9225fa952..1b2a175af290 100644 --- a/language/predefined/requestparsebodyexception.xml +++ b/language/predefined/requestparsebodyexception.xml @@ -6,21 +6,18 @@ -
&reftitle.intro; - A RequestParseBodyException is thrown in + A RequestParseBodyException is thrown in request_parse_body when the request body is invalid, according to the Content-Type header.
-
&reftitle.classsynopsis; - RequestParseBodyException @@ -45,8 +42,6 @@ - -
diff --git a/language/predefined/sensitiveparametervalue.xml b/language/predefined/sensitiveparametervalue.xml index 67d8bef81ad2..e5a689301a64 100644 --- a/language/predefined/sensitiveparametervalue.xml +++ b/language/predefined/sensitiveparametervalue.xml @@ -5,25 +5,22 @@ -
&reftitle.intro; - + The SensitiveParameterValue class allows wrapping sensitive values to protect them against accidental exposure. - - + + Values of parameters having the SensitiveParameter attribute will automatically be wrapped inside of a SensitiveParameterValue object within stack traces. - +
-
&reftitle.classsynopsis; - final @@ -46,7 +43,6 @@ -
@@ -57,14 +53,13 @@ value - + The sensitive value to be protected against accidental exposure. - +
-
diff --git a/language/predefined/serializable.xml b/language/predefined/serializable.xml index 7bf30cd62090..6f87584560ae 100644 --- a/language/predefined/serializable.xml +++ b/language/predefined/serializable.xml @@ -7,7 +7,6 @@ -
&reftitle.intro; @@ -31,12 +30,10 @@
-
&reftitle.interfacesynopsis; - Serializable @@ -47,13 +44,12 @@ -
&reftitle.examples; - + Basic usage - +
diff --git a/language/predefined/stringable.xml b/language/predefined/stringable.xml index 8114ef4ea27d..c05170b4c686 100644 --- a/language/predefined/stringable.xml +++ b/language/predefined/stringable.xml @@ -7,7 +7,6 @@ -
&reftitle.intro; @@ -17,18 +16,16 @@ has the magic __toString() method defined, although it can and should be declared explicitly. - + Its primary value is to allow functions to type check against the union type string|Stringable to accept either a string primitive or an object that can be cast to a string. - +
-
&reftitle.interfacesynopsis; - Stringable @@ -39,7 +36,6 @@ -
diff --git a/language/predefined/throwable.xml b/language/predefined/throwable.xml index 81519612ceae..f72398f7c7ab 100644 --- a/language/predefined/throwable.xml +++ b/language/predefined/throwable.xml @@ -7,28 +7,25 @@ -
&reftitle.intro; - - Throwable is the base interface for any object that + + Throwable is the base interface for any object that can be thrown via a &throw; statement, including - Error and Exception. - + Error and Exception. + - - PHP classes cannot implement the Throwable + + PHP classes cannot implement the Throwable interface directly, and must instead extend - Exception. - + Exception. +
-
&reftitle.interfacesynopsis; - Throwable @@ -49,7 +46,6 @@ -
@@ -67,7 +63,7 @@ 8.0.0 - Throwable implements + Throwable implements Stringable now. diff --git a/language/predefined/traversable.xml b/language/predefined/traversable.xml index bbe69532cef1..34fae742a5a2 100644 --- a/language/predefined/traversable.xml +++ b/language/predefined/traversable.xml @@ -7,35 +7,31 @@ -
&reftitle.intro; - + Interface to detect if a class is traversable using &foreach;. - + Abstract base interface that cannot be implemented alone. Instead, it must be implemented by either IteratorAggregate or Iterator.
-
&reftitle.interfacesynopsis; - Traversable - - + This interface has no methods, its only purpose is to be the base interface for all traversable classes. - +
diff --git a/language/predefined/typeerror.xml b/language/predefined/typeerror.xml index 74df3ef47e19..f1d2c4e22833 100644 --- a/language/predefined/typeerror.xml +++ b/language/predefined/typeerror.xml @@ -6,11 +6,10 @@ -
&reftitle.intro; - A TypeError may be thrown when: + A TypeError may be thrown when: The value being set for a class property does not match @@ -27,12 +26,10 @@
-
&reftitle.classsynopsis; - TypeError @@ -57,8 +54,6 @@ - -
@@ -76,9 +71,9 @@ 7.1.0 In strict mode, passing an incorrect number of arguments to a built-in - PHP function no longer results in a generic TypeError. - Instead, a more specific ArgumentCountError, which - extends TypeError, is thrown. + PHP function no longer results in a generic TypeError. + Instead, a more specific ArgumentCountError, which + extends TypeError, is thrown. diff --git a/language/predefined/unhandledmatcherror.xml b/language/predefined/unhandledmatcherror.xml index 8a705ab56cd4..4eb5d651ff41 100644 --- a/language/predefined/unhandledmatcherror.xml +++ b/language/predefined/unhandledmatcherror.xml @@ -6,7 +6,6 @@ -
&reftitle.intro; @@ -15,12 +14,10 @@ of the &match; expression.
-
&reftitle.classsynopsis; - UnhandledMatchError @@ -45,8 +42,6 @@ - -
diff --git a/language/predefined/unitenum.xml b/language/predefined/unitenum.xml index 1639bb148ef0..526bab9dfb41 100644 --- a/language/predefined/unitenum.xml +++ b/language/predefined/unitenum.xml @@ -5,22 +5,19 @@ -
&reftitle.intro; - + The UnitEnum interface is automatically applied to all enumerations by the engine. It may not be implemented by user-defined classes. Enumerations may not override its methods, as default implementations are provided by the engine. It is available only for type checks. - +
-
&reftitle.interfacesynopsis; - UnitEnum @@ -31,7 +28,6 @@ -
diff --git a/language/predefined/valueerror.xml b/language/predefined/valueerror.xml index 81adda00af09..15ead8539195 100644 --- a/language/predefined/valueerror.xml +++ b/language/predefined/valueerror.xml @@ -6,7 +6,6 @@ -
&reftitle.intro; @@ -17,12 +16,10 @@ it to not be empty.
-
&reftitle.classsynopsis; - ValueError @@ -46,7 +43,7 @@ - +
diff --git a/language/predefined/weakmap.xml b/language/predefined/weakmap.xml index 66183a1b215c..0fcc42c406a0 100644 --- a/language/predefined/weakmap.xml +++ b/language/predefined/weakmap.xml @@ -7,7 +7,6 @@ -
&reftitle.intro; @@ -24,12 +23,10 @@ and Countable, so in most cases it can be used in the same fashion as an associative array.
-
&reftitle.classsynopsis; - final @@ -54,10 +51,9 @@ -
- +
&reftitle.examples; @@ -98,7 +94,6 @@ int(0)
-
diff --git a/language/predefined/weakmap/getiterator.xml b/language/predefined/weakmap/getiterator.xml index 6a8d00669ab8..8f68766c99e1 100644 --- a/language/predefined/weakmap/getiterator.xml +++ b/language/predefined/weakmap/getiterator.xml @@ -30,12 +30,12 @@ - + &reftitle.errors; Throws an Exception on failure. - + + &reftitle.errors; Throws an Error on failure. diff --git a/language/predefined/weakreference.xml b/language/predefined/weakreference.xml index cf3a2600561c..f8c040eb8156 100644 --- a/language/predefined/weakreference.xml +++ b/language/predefined/weakreference.xml @@ -7,7 +7,6 @@ -
&reftitle.intro; @@ -19,16 +18,14 @@ refcount for it drops to zero; creating weak references does not increase the refcount of the object being referenced. - + WeakReferences cannot be serialized. - +
-
&reftitle.classsynopsis; - final @@ -43,7 +40,6 @@ -
diff --git a/language/wrappers/audio.xml b/language/wrappers/audio.xml index d5ba3ccb913f..19f8819d00f4 100644 --- a/language/wrappers/audio.xml +++ b/language/wrappers/audio.xml @@ -7,7 +7,7 @@ Audio streams - + &reftitle.description; Files opened for reading via the ogg:// wrapper @@ -34,18 +34,18 @@ extension available from &link.pecl; must be installed. - + - + &reftitle.usage; ogg://soundfile.ogg ogg:///path/to/soundfile.ogg ogg://http://www.example.com/path/to/soundstream.ogg - + - + &reftitle.options; @@ -166,7 +166,7 @@
-
+
diff --git a/language/wrappers/compression.xml b/language/wrappers/compression.xml index 67b379de8b0f..19c60b64281e 100644 --- a/language/wrappers/compression.xml +++ b/language/wrappers/compression.xml @@ -9,7 +9,7 @@ Compression Streams - + &reftitle.description; compress.zlib:// and compress.bzip2:// @@ -35,18 +35,18 @@ passwords to be supplied by stream contexts. Passwords can be set using the 'password' stream context option. - + - + &reftitle.usage; compress.zlib://file.gz compress.bzip2://file.bz2 zip://archive.zip#dir/file.txt - + - + &reftitle.options; @@ -109,7 +109,7 @@
-
+
&reftitle.seealso; diff --git a/language/wrappers/data.xml b/language/wrappers/data.xml index 8ed147d4b69d..aa771cb085ef 100644 --- a/language/wrappers/data.xml +++ b/language/wrappers/data.xml @@ -7,23 +7,23 @@ Data (RFC 2397) - + &reftitle.description; The data: (RFC 2397) stream wrapper. - + - + &reftitle.usage; data://text/plain;base64, - + - + &reftitle.options; @@ -84,9 +84,9 @@
-
+
- + &reftitle.examples; Print data:// contents @@ -114,7 +114,7 @@ echo $meta['mediatype']; ]]> - + diff --git a/language/wrappers/expect.xml b/language/wrappers/expect.xml index 5310c79c53a3..dc2cc0ee102d 100644 --- a/language/wrappers/expect.xml +++ b/language/wrappers/expect.xml @@ -7,7 +7,7 @@ Process Interaction Streams - + &reftitle.description; Streams opened via the expect:// wrapper provide @@ -23,16 +23,16 @@ expect:// (PECL) - + - + &reftitle.usage; expect://command - + - + &reftitle.options; @@ -89,7 +89,7 @@
-
+
diff --git a/language/wrappers/file.xml b/language/wrappers/file.xml index 1fa75b74e49f..0ed3b5e20420 100644 --- a/language/wrappers/file.xml +++ b/language/wrappers/file.xml @@ -7,7 +7,7 @@ Accessing local filesystem - + &reftitle.description; file:// is the default wrapper used with PHP and @@ -25,9 +25,9 @@ file_get_contents, include_path may be optionally searched for relative paths as well. - + - + &reftitle.usage; /path/to/file.ext @@ -38,9 +38,9 @@ \\smbserver\share\path\to\winfile.ext file:///path/to/file.ext - + - + &reftitle.options; @@ -97,7 +97,7 @@
-
+
diff --git a/language/wrappers/ftp.xml b/language/wrappers/ftp.xml index 68333ca76d8c..2ff2496e21f8 100644 --- a/language/wrappers/ftp.xml +++ b/language/wrappers/ftp.xml @@ -8,7 +8,7 @@ Accessing FTP(s) URLs - + &reftitle.description; Allows read access to existing files and creation of new files @@ -30,9 +30,9 @@ in &php.ini;, then this value will be sent as the anonymous FTP password. - + - + &reftitle.usage; ftp://example.com/pub/file.txt @@ -40,9 +40,9 @@ ftps://example.com/pub/file.txt ftps://user:password@example.com/pub/file.txt - + - + &reftitle.options; @@ -104,9 +104,9 @@
-
+
- + &reftitle.notes; @@ -124,14 +124,14 @@ Files may be appended via the ftp:// URL wrapper. - + - + &reftitle.seealso; - + diff --git a/language/wrappers/glob.xml b/language/wrappers/glob.xml index cde7e4e1d733..54cb222f7712 100644 --- a/language/wrappers/glob.xml +++ b/language/wrappers/glob.xml @@ -7,22 +7,22 @@ Find pathnames matching pattern - + &reftitle.description; The glob: stream wrapper. - + - + &reftitle.usage; glob:// - + - + &reftitle.options; @@ -83,9 +83,9 @@
-
+
- + &reftitle.examples; Basic usage @@ -116,7 +116,7 @@ class_tree.php: 1.8K ]]> - + diff --git a/language/wrappers/http.xml b/language/wrappers/http.xml index 6558ed019004..a8c77d3ef00c 100644 --- a/language/wrappers/http.xml +++ b/language/wrappers/http.xml @@ -8,7 +8,7 @@ Accessing HTTP(s) URLs - + &reftitle.description; Allows read-only access to files/resources via HTTP. @@ -34,9 +34,9 @@ From: header if set and not overwritten by the . - + - + &reftitle.usage; http://example.com @@ -46,9 +46,9 @@ https://example.com/file.php?var1=val1&var2=val2 https://user:password@example.com - + - + &reftitle.options; @@ -105,11 +105,11 @@
-
+
- + &reftitle.examples; - + Detecting which URL we ended up on after redirects ]]> - - + + - + &reftitle.notes; @@ -152,16 +152,16 @@ foreach ($meta_data['wrapper_data'] as $response) { Sending POST and PUT requests, for example, can be done with the help of HTTP Contexts. - + - + &reftitle.seealso; $http_response_header stream_get_meta_data - + diff --git a/language/wrappers/phar.xml b/language/wrappers/phar.xml index 285522438dbb..69f42803bc4d 100644 --- a/language/wrappers/phar.xml +++ b/language/wrappers/phar.xml @@ -7,7 +7,7 @@ PHP Archive - + &reftitle.description; @@ -15,16 +15,16 @@ See Phar stream wrapper for a detailed description. - + - + &reftitle.usage; phar:// - + - + &reftitle.options; @@ -85,14 +85,14 @@
-
+
- + &reftitle.seealso; - + diff --git a/language/wrappers/php.xml b/language/wrappers/php.xml index 3a03bb46f985..acebaf9bd26f 100644 --- a/language/wrappers/php.xml +++ b/language/wrappers/php.xml @@ -168,7 +168,7 @@
- + &reftitle.options; @@ -274,11 +274,11 @@
-
+
- + &reftitle.examples; - + php://temp/maxmemory This optional parameter allows setting the memory limit before @@ -299,8 +299,8 @@ echo stream_get_contents($fp); ?> ]]> - - + + php://filter/resource=<stream to be filtered> This parameter must be located at @@ -318,8 +318,8 @@ readfile("php://filter/resource=http://www.example.com"); ?> ]]> - - + + php://filter/read=<filter list to apply to read chain> This parameter takes one or more @@ -338,8 +338,8 @@ readfile("php://filter/read=string.toupper|string.rot13/resource=http://www.exam ?> ]]> - - + + php://filter/write=<filter list to apply to write chain> This parameter takes one or more @@ -355,7 +355,7 @@ file_put_contents("php://filter/write=string.rot13/resource=example.txt","Hello ?> ]]> - + php://memory and php://temp are not reusable @@ -393,7 +393,7 @@ print_r($json_array); ]]> - + + &reftitle.description; The wrapper takes the url encoded path to the RAR archive (relative or absolute), @@ -49,16 +49,16 @@ Available since PECL rar 3.0.0 - +
- + &reftitle.usage; rar://<url encoded archive name>[*][#[<url encoded entry name>]] - + - + &reftitle.options; @@ -167,9 +167,9 @@
-
+
- + &reftitle.examples; Traversing a RAR archive @@ -274,7 +274,7 @@ Array ]]> - + diff --git a/language/wrappers/ssh2.xml b/language/wrappers/ssh2.xml index c4c0698d1c14..539708315321 100644 --- a/language/wrappers/ssh2.xml +++ b/language/wrappers/ssh2.xml @@ -7,7 +7,7 @@ Secure Shell 2 - + &reftitle.description; ssh2.shell:// @@ -33,9 +33,9 @@ will also reuse open connections by passing the connection resource in the host portion of the URL. - + - + &reftitle.usage; ssh2.shell://user:pass@example.com:22/xterm @@ -43,9 +43,9 @@ ssh2.tunnel://user:pass@example.com:22/192.168.0.1:14 ssh2.sftp://user:pass@example.com:22/path/to/filename - + - + &reftitle.options; @@ -230,9 +230,9 @@
-
+
- + &reftitle.examples; Opening a stream from an active connection @@ -274,7 +274,7 @@ $stream = fopen($connection_string . "path/to/file", 'r'); - + diff --git a/reference/bc/book.xml b/reference/bc/book.xml index a59db0da29e8..adf5aef5a9d4 100644 --- a/reference/bc/book.xml +++ b/reference/bc/book.xml @@ -6,27 +6,26 @@ BCMath Arbitrary Precision Mathematics BC Math - &reftitle.intro; - + For arbitrary precision mathematics PHP offers BCMath which supports numbers of any size and precision up to 2147483647 (or 0x7FFFFFFF) decimal digits, if there is sufficient memory, represented as strings. - - + + Valid (aka. well-formed) BCMath numbers are strings which match the regular expression /^[+-]?[0-9]*(\.[0-9]*)?$/. - + - + Passing values of type float to a BCMath function which expects a string as operand may not have the desired effect due to the way PHP converts float values to string, namely that the string may be in exponential notation (which is not supported by BCMath), and that, prior to PHP 8.0.0, the decimal separator is locale dependent (while BCMath always expects a decimal point). - + '0.0' - &reference.bc.setup; &reference.bc.reference; diff --git a/reference/bc/configure.xml b/reference/bc/configure.xml index 2bc126db4c25..5f102032a85b 100644 --- a/reference/bc/configure.xml +++ b/reference/bc/configure.xml @@ -2,10 +2,10 @@
&reftitle.install; - + These functions are only available if PHP was configured with . - + &windows.builtin;
diff --git a/reference/bc/functions/bcmod.xml b/reference/bc/functions/bcmod.xml index 119d5ef4f091..b204a90aec6b 100644 --- a/reference/bc/functions/bcmod.xml +++ b/reference/bc/functions/bcmod.xml @@ -34,7 +34,7 @@ - + &reftitle.changelog; @@ -75,7 +75,7 @@ - + &reftitle.examples; diff --git a/reference/bc/functions/bcmul.xml b/reference/bc/functions/bcmul.xml index 632204ef200c..bab5b62e8d2f 100644 --- a/reference/bc/functions/bcmul.xml +++ b/reference/bc/functions/bcmul.xml @@ -32,7 +32,7 @@ - + &reftitle.changelog; @@ -59,7 +59,7 @@ - + &reftitle.examples; diff --git a/reference/bc/functions/bcpow.xml b/reference/bc/functions/bcpow.xml index 7903a1919cf6..3d9bfe2f7b3b 100644 --- a/reference/bc/functions/bcpow.xml +++ b/reference/bc/functions/bcpow.xml @@ -70,7 +70,7 @@ - + &reftitle.changelog; @@ -105,7 +105,7 @@ - + &reftitle.examples; diff --git a/reference/bc/ini.xml b/reference/bc/ini.xml index 7605048ad064..b245d624ef05 100644 --- a/reference/bc/ini.xml +++ b/reference/bc/ini.xml @@ -27,9 +27,9 @@ &ini.php.constants; - + &ini.descriptions.title; - + @@ -38,16 +38,16 @@ int - + Number of decimal digits for all bcmath functions. See also bcscale. - + BcMath\Number is not affected by this setting. - +
diff --git a/reference/bc/setup.xml b/reference/bc/setup.xml index dc8bacfb824f..1b5c5cddbc5b 100644 --- a/reference/bc/setup.xml +++ b/reference/bc/setup.xml @@ -6,11 +6,9 @@ &reference.bc.configure; - &reference.bc.ini; - diff --git a/reference/curl/functions/curl-multi-errno.xml b/reference/curl/functions/curl-multi-errno.xml index 3764cf13a3d8..25454b35c08c 100644 --- a/reference/curl/functions/curl-multi-errno.xml +++ b/reference/curl/functions/curl-multi-errno.xml @@ -6,7 +6,7 @@ Return the last multi curl error number - + &reftitle.description; intcurl_multi_errno @@ -15,21 +15,21 @@ Return an integer containing the last multi curl error number. - + - + &reftitle.parameters; &curl.mh.description; - + - + &reftitle.returnvalues; Return an integer containing the last multi curl error number. - + &reftitle.changelog; @@ -54,12 +54,12 @@ - + &reftitle.seealso; curl_errno - + + &reftitle.description; intcurl_share_errno @@ -15,21 +15,21 @@ Return an integer containing the last share curl error number. - + - + &reftitle.parameters; &curl.sh.description; - + - + &reftitle.returnvalues; Returns an integer containing the last share curl error number. - + &reftitle.changelog; @@ -54,12 +54,12 @@ - + &reftitle.seealso; curl_errno - + + &reftitle.description; stringnullcurl_share_strerror @@ -15,9 +15,9 @@ Returns a text error message describing the given error code. - + - + &reftitle.parameters; @@ -29,22 +29,22 @@ - + - + &reftitle.returnvalues; Returns error description or &null; for invalid error code. - + - + &reftitle.seealso; curl_share_errno curl_strerror - +
&reftitle.intro; @@ -35,12 +34,10 @@ incomparable.
-
&reftitle.classsynopsis; - DateInterval @@ -111,7 +108,6 @@ -
@@ -229,7 +225,7 @@
-
+
&reftitle.changelog; @@ -272,7 +268,7 @@ -
+
diff --git a/reference/datetime/datetime.xml b/reference/datetime/datetime.xml index dd915ac57f17..abb11aa4a1b7 100644 --- a/reference/datetime/datetime.xml +++ b/reference/datetime/datetime.xml @@ -7,7 +7,6 @@ -
&reftitle.intro; @@ -29,12 +28,10 @@
-
&reftitle.classsynopsis; - DateTime @@ -61,11 +58,10 @@ -
-
+
&reftitle.changelog; @@ -102,7 +98,7 @@ -
+
diff --git a/reference/datetime/datetimeimmutable.xml b/reference/datetime/datetimeimmutable.xml index e8886dde666f..fcd19a0ec96f 100644 --- a/reference/datetime/datetimeimmutable.xml +++ b/reference/datetime/datetimeimmutable.xml @@ -7,7 +7,6 @@ -
&reftitle.intro; @@ -19,12 +18,10 @@ DateTime::modify are called.
-
&reftitle.classsynopsis; - DateTimeImmutable @@ -51,11 +48,10 @@ -
-
+
&reftitle.changelog; @@ -85,7 +81,7 @@ -
+
&reference.datetime.entities.datetimeimmutable; diff --git a/reference/datetime/datetimeinterface.xml b/reference/datetime/datetimeinterface.xml index af4d9f94c9d8..1ae52c429e3d 100644 --- a/reference/datetime/datetimeinterface.xml +++ b/reference/datetime/datetimeinterface.xml @@ -7,7 +7,6 @@ -
&reftitle.intro; @@ -26,12 +25,10 @@ interface.
-
&reftitle.interfacesynopsis; - DateTimeInterface @@ -142,11 +139,9 @@ -
-
&reftitle.constants; @@ -351,9 +346,8 @@
- -
+
&reftitle.changelog; @@ -394,7 +388,7 @@ -
+
diff --git a/reference/datetime/formats.xml b/reference/datetime/formats.xml index f86bd5f99c72..7a4d96fb53e8 100644 --- a/reference/datetime/formats.xml +++ b/reference/datetime/formats.xml @@ -3,7 +3,7 @@ Supported Date and Time Formats - + This section describes all the different formats in a BNF-like format, that the DateTimeImmutable, DateTime, date_create_immutable, @@ -17,16 +17,16 @@ be t or T), characters in double quotes are case-sensitive ("T" is only T). - - + + To format DateTimeImmutable and DateTime objects, please refer to the documentation of the DateTimeInterface::format method. - + - + A general set of rules should be taken into account. - + @@ -133,18 +133,18 @@ object(DateTimeImmutable)#1 (3) { Time Formats - + This page describes the different date/time formats in a BNF-like syntax, that the DateTimeImmutable, DateTime, date_create, date_create_immutable, and strtotime parser understands. - - + + To format DateTimeImmutable and DateTime objects, please refer to the documentation of the DateTimeInterface::format method. - + Used Symbols @@ -291,24 +291,22 @@ object(DateTimeImmutable)#1 (3) {
- - Date Formats - + This page describes the different date formats in a BNF-like syntax, that the DateTimeImmutable, DateTime, date_create, date_create_immutable, and strtotime parser understands. - - + + To format DateTimeImmutable and DateTime objects, please refer to the documentation of the DateTimeInterface::format method. - + Used Symbols @@ -531,7 +529,7 @@ object(DateTimeImmutable)#1 (3) {
- + For the y and yy formats, years below 100 are handled in a special way when the y or yy symbol is used. @@ -539,81 +537,79 @@ object(DateTimeImmutable)#1 (3) { 2000 is added. If the year falls in the range 70 (inclusive) to 99 (inclusive) then 1900 is added. This means that "00-01-01" is interpreted as "2000-01-01". - + - + The "Day, month and two digit year, with dots or tabs" format (dd [.\t] mm "." yy) only works for the year values 61 (inclusive) to 99 (inclusive) - outside those years the time format "HH [.:] MM [.:] SS" has precedence. - + - + The "Year (and just the year)" format only reliably works if a time string has already been found. Otherwise, if the four digit year matches HH MM then these two date elements are set instead. - - + + To consistently parse just a year, use DateTimeImmutable::createFromFormat with the Y specifier. - + - + It is possible to over- and underflow the dd and DD format. Day 0 means the last day of previous month, whereas overflows count into the next month. This makes "2008-08-00" equivalent to "2008-07-31" and "2008-06-31" equivalent to "2008-07-01" (June only has 30 days). - - + + Note that the day range is restricted to 0-31 as indicated by the regular expression above. Thus "2008-06-32" is not a valid date string, for instance. - - + + It is also possible to underflow the mm and MM formats with the value 0. A month value of 0 means December of the previous year. As example "2008-00-22" is equivalent to "2007-12-22". - - + + If you combine the previous two facts and underflow both the day and the month, the following happens: "2008-00-00" first gets converted to "2007-12-00" which then gets converted to "2007-11-30". This also happens with the string "0000-00-00", which gets transformed into "-0001-11-30" (the year -1 in the ISO 8601 calendar, which is 2 BC in the proleptic Gregorian calendar). - +
- - Compound Formats - + This page describes the different compound date/time formats in a BNF-like syntax, that the DateTimeImmutable, DateTime, date_create, date_create_immutable, and strtotime parser understands. - - + + To format DateTimeImmutable and DateTime objects, please refer to the documentation of the DateTimeInterface::format method. - + Used Symbols @@ -852,37 +848,35 @@ object(DateTimeImmutable)#1 (3) {
- + The "W" in the "ISO year with ISO week" and "ISO year with ISO week and day" formats is case-sensitive, you can only use the upper case "W". - - + + The "T" in the SOAP, XMLRPC and WDDX formats is case-sensitive, you can only use the upper case "T". - - + + The "Unix Timestamp" format sets the timezone to UTC. - +
- - Relative Formats - + This page describes the different relative date/time formats in a BNF-like syntax, that the DateTimeImmutable, DateTime, date_create, date_create_immutable, and strtotime parser understands. - - + + To format DateTimeImmutable and DateTime objects, please refer to the documentation of the DateTimeInterface::format method. - + Used Symbols @@ -1044,27 +1038,27 @@ object(DateTimeImmutable)#1 (3) {
- + Relative statements are always processed after non-relative statements. This makes "+1 week july 2008" and "july 2008 +1 week" equivalent. - - + + Exceptions to this rule are: "yesterday", "midnight", "today", "noon" and "tomorrow". Note that "tomorrow 11:00" and "11:00 tomorrow" are different. Considering today's date of "July 23rd, 2008" the first one produces "2008-07-24 11:00" where as the second one produces "2008-07-24 00:00". The reason for this is that those five statements directly influence the current time. - - + + Keywords such as "first day of" depend on the context in which the relative format string is used. If used with a static method or function, the referent is the current system timestamp. However, if used in DateTime::modify or DateTimeImmutable::modify, the referent is the object on which the modify() method is called. - + @@ -1125,13 +1119,13 @@ object(DateTimeImmutable)#1 (3) {
- + Also observe that the "of" in "ordinal space dayname space 'of' " and "'last' space dayname space 'of' " does something special. - + @@ -1172,20 +1166,20 @@ object(DateTimeImmutable)#1 (3) { - + Relative month values are calculated based on the length of months that they pass through. An example would be "+2 month 2011-11-30", which would produce "2012-01-30". This is due to November being 30 days in length, and December being 31 days in length, producing a total of 61 days. - + - + number is an integer number; if a decimal number is given, the dot (or comma) is likely interpreted as delimiter. For instance, '+1.5 hours' is parsed like '+1 5 hours', not as '+1 hour +30 minutes'. - + @@ -1228,7 +1222,6 @@ object(DateTimeImmutable)#1 (3) { -
diff --git a/reference/dom/domdocument/getelementsbytagname.xml b/reference/dom/domdocument/getelementsbytagname.xml index 0b1443413647..eb19fdda4b31 100644 --- a/reference/dom/domdocument/getelementsbytagname.xml +++ b/reference/dom/domdocument/getelementsbytagname.xml @@ -40,10 +40,10 @@ elements. - + &reftitle.examples; - + Basic Usage Example - + - + &reftitle.seealso; diff --git a/reference/dom/domnodelist.xml b/reference/dom/domnodelist.xml index c9450c2e083d..d7dd7c96acd6 100644 --- a/reference/dom/domnodelist.xml +++ b/reference/dom/domnodelist.xml @@ -22,7 +22,6 @@ Remove me once you perform substitutions
&reftitle.classsynopsis; - DOMNodeList @@ -50,11 +49,9 @@ Remove me once you perform substitutions -
-
&reftitle.properties; @@ -69,8 +66,8 @@ Remove me once you perform substitutions
- -
+ +
&reftitle.changelog; @@ -101,7 +98,7 @@ Remove me once you perform substitutions -
+
&reftitle.notes; @@ -112,7 +109,6 @@ Remove me once you perform substitutions
-
&reftitle.seealso; @@ -122,7 +118,6 @@ Remove me once you perform substitutions
- &reference.dom.entities.domnodelist; diff --git a/reference/ds/ds.collection.xml b/reference/ds/ds.collection.xml index 9a852ae8f16e..f07a1839f9d2 100644 --- a/reference/ds/ds.collection.xml +++ b/reference/ds/ds.collection.xml @@ -8,21 +8,18 @@ -
&reftitle.intro; - + Collection is the base interface which covers functionality common to all the data structures in this library. It guarantees that all structures are traversable, countable, and can be converted to json using json_encode. - +
-
&reftitle.interfacesynopsis; - Ds\Collection @@ -52,7 +49,6 @@ -
diff --git a/reference/ds/ds.deque.xml b/reference/ds/ds.deque.xml index 1eeb48359431..855b3eb67361 100644 --- a/reference/ds/ds.deque.xml +++ b/reference/ds/ds.deque.xml @@ -8,7 +8,6 @@ -
&reftitle.intro; @@ -28,7 +27,6 @@ corresponding position in the buffer: ((head + position) % capacity).
-
Strengths @@ -65,11 +63,9 @@
&reftitle.classsynopsis; - Ds\Deque - Ds\Deque @@ -82,7 +78,7 @@ ArrayAccess - + &Constants; const @@ -96,11 +92,9 @@ -
-
&reftitle.constants; @@ -114,7 +108,6 @@
-
&reftitle.changelog; diff --git a/reference/ds/ds.hashable.xml b/reference/ds/ds.hashable.xml index 190958c81573..18beecd152ef 100644 --- a/reference/ds/ds.hashable.xml +++ b/reference/ds/ds.hashable.xml @@ -8,7 +8,6 @@ -
&reftitle.intro; @@ -18,32 +17,29 @@ this means that two objects that are considered equal by an implicit definition would not be treated as equal because they are not the same instance. - + hash is used to return a scalar value to be used as the object's hash value, which determines where it goes in the hash table. While this value does not have to be unique, objects which are equal must have the same hash value. - - + + equals is used to determine if two objects are equal. It's guaranteed that the comparing object will be an instance of the same class as the subject. - +
-
&reftitle.interfacesynopsis; - Ds\Hashable &Methods; -
diff --git a/reference/ds/ds.map.xml b/reference/ds/ds.map.xml index 0079ed800748..d98861711672 100644 --- a/reference/ds/ds.map.xml +++ b/reference/ds/ds.map.xml @@ -8,7 +8,6 @@ -
&reftitle.intro; @@ -17,7 +16,7 @@ Values are replaced if added to the map using the same key.
- +
@@ -46,11 +45,9 @@
&reftitle.classsynopsis; - Ds\Map - Ds\Map @@ -63,7 +60,7 @@ ArrayAccess - + &Constants; const @@ -75,11 +72,9 @@ &Methods; -
-
&reftitle.constants; @@ -93,7 +88,6 @@
-
&reftitle.changelog; diff --git a/reference/ds/ds.pair.xml b/reference/ds/ds.pair.xml index acff6538e0d1..de1cc34d24bc 100644 --- a/reference/ds/ds.pair.xml +++ b/reference/ds/ds.pair.xml @@ -8,23 +8,19 @@ -
&reftitle.intro; - + A pair is used by Ds\Map to pair keys with values. - +
-
&reftitle.classsynopsis; - Ds\Pair - Ds\Pair @@ -34,17 +30,15 @@ JsonSerializable - &Methods; - + - + -
diff --git a/reference/ds/ds.priorityqueue.xml b/reference/ds/ds.priorityqueue.xml index d47d53343790..bc41929b8abd 100644 --- a/reference/ds/ds.priorityqueue.xml +++ b/reference/ds/ds.priorityqueue.xml @@ -8,7 +8,6 @@ -
&reftitle.intro; @@ -30,16 +29,13 @@
-
&reftitle.classsynopsis; - Ds\PriorityQueue - Ds\PriorityQueue @@ -49,7 +45,7 @@ Ds\Collection - + &Constants; const @@ -61,11 +57,9 @@ &Methods; -
-
&reftitle.constants; @@ -79,8 +73,6 @@
- -
diff --git a/reference/ds/ds.queue.xml b/reference/ds/ds.queue.xml index 73d3b2f7a517..eba8c6f4e5ad 100644 --- a/reference/ds/ds.queue.xml +++ b/reference/ds/ds.queue.xml @@ -8,7 +8,6 @@ -
&reftitle.intro; @@ -17,16 +16,13 @@ destructively.
-
&reftitle.classsynopsis; - Ds\Queue - Ds\Queue @@ -39,7 +35,7 @@ ArrayAccess - + &Constants; const @@ -51,11 +47,9 @@ &Methods; -
-
&reftitle.constants; @@ -69,7 +63,6 @@
-
&reftitle.changelog; diff --git a/reference/ds/ds.sequence.xml b/reference/ds/ds.sequence.xml index 20305d074609..ab94f352af18 100644 --- a/reference/ds/ds.sequence.xml +++ b/reference/ds/ds.sequence.xml @@ -8,7 +8,6 @@ -
&reftitle.intro; @@ -31,12 +30,10 @@
-
&reftitle.interfacesynopsis; - Ds\Sequence @@ -69,7 +66,6 @@ -
diff --git a/reference/ds/ds.set.xml b/reference/ds/ds.set.xml index 70ccf2d01f85..b85ef9161ea0 100644 --- a/reference/ds/ds.set.xml +++ b/reference/ds/ds.set.xml @@ -8,7 +8,6 @@ -
&reftitle.intro; @@ -17,8 +16,6 @@ mapped value is ignored.
- -
Strengths @@ -59,11 +56,9 @@
&reftitle.classsynopsis; - Ds\Set - Ds\Set @@ -76,7 +71,7 @@ ArrayAccess - + &Constants; const @@ -88,11 +83,9 @@ &Methods; -
-
&reftitle.constants; @@ -106,7 +99,6 @@
-
&reftitle.changelog; diff --git a/reference/ds/ds.stack.xml b/reference/ds/ds.stack.xml index 0aa2c478066e..8d2a21f4bda5 100644 --- a/reference/ds/ds.stack.xml +++ b/reference/ds/ds.stack.xml @@ -8,28 +8,24 @@ -
&reftitle.intro; - + A Stack is a “last in, first out” or “LIFO” collection that only allows access to the value at the top of the structure and iterates in that order, destructively. - - + + Uses a Ds\Vector internally. - +
-
&reftitle.classsynopsis; - Ds\Stack - Ds\Stack @@ -42,12 +38,10 @@ ArrayAccess - &Methods; -
diff --git a/reference/ds/ds.vector.xml b/reference/ds/ds.vector.xml index efd2b0c2b037..7393b3462dfc 100644 --- a/reference/ds/ds.vector.xml +++ b/reference/ds/ds.vector.xml @@ -8,7 +8,6 @@ -
&reftitle.intro; @@ -18,8 +17,6 @@ growth factor isn't bound to a specific multiple or exponent.
- -
Strengths @@ -56,13 +53,11 @@
&reftitle.classsynopsis; - Ds\Vector - Ds\Vector @@ -70,7 +65,7 @@ ArrayAccess - + &Constants; const @@ -84,11 +79,9 @@ -
-
&reftitle.constants; @@ -102,7 +95,6 @@
-
&reftitle.changelog; diff --git a/reference/ds/ds/sequence/allocate.xml b/reference/ds/ds/sequence/allocate.xml index 901d73d9effe..98b6aff42bdf 100644 --- a/reference/ds/ds/sequence/allocate.xml +++ b/reference/ds/ds/sequence/allocate.xml @@ -25,14 +25,14 @@ capacity - + The number of values for which capacity should be allocated. - + - + Capacity will stay the same if this value is less than or equal to the current capacity. - + @@ -41,9 +41,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/ds/ds/sequence/apply.xml b/reference/ds/ds/sequence/apply.xml index 202f3bdd6b3a..4d67a5f45fda 100644 --- a/reference/ds/ds/sequence/apply.xml +++ b/reference/ds/ds/sequence/apply.xml @@ -13,10 +13,10 @@ abstract public voidDs\Sequence::apply callablecallback - + Updates all values by applying a callback function to each value in the sequence. - + @@ -33,13 +33,13 @@ mixedvalue - + A callable to apply to each value in the sequence. - + - + The callback should return what the value should be replaced by. - + @@ -48,9 +48,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/ds/ds/sequence/capacity.xml b/reference/ds/ds/sequence/capacity.xml index 8ac7a11244e3..521d832f5a5c 100644 --- a/reference/ds/ds/sequence/capacity.xml +++ b/reference/ds/ds/sequence/capacity.xml @@ -13,9 +13,9 @@ abstract public intDs\Sequence::capacity - + Returns the current capacity. - + @@ -25,9 +25,9 @@ &reftitle.returnvalues; - + The current capacity. - + diff --git a/reference/ds/ds/sequence/contains.xml b/reference/ds/ds/sequence/contains.xml index 55d99d4b1d4b..56ec838c1ea7 100644 --- a/reference/ds/ds/sequence/contains.xml +++ b/reference/ds/ds/sequence/contains.xml @@ -13,9 +13,9 @@ abstract public boolDs\Sequence::contains mixedvalues - + Determines if the sequence contains all values. - + @@ -24,9 +24,9 @@ values - + Values to check. - + @@ -34,10 +34,10 @@ &reftitle.returnvalues; - + &false; if any of the provided values are not in the sequence, &true; otherwise. - + diff --git a/reference/ds/ds/sequence/filter.xml b/reference/ds/ds/sequence/filter.xml index 5d2307928558..502854b595c4 100644 --- a/reference/ds/ds/sequence/filter.xml +++ b/reference/ds/ds/sequence/filter.xml @@ -16,10 +16,10 @@ abstract public Ds\SequenceDs\Sequence::filter callablecallback - + Creates a new sequence using a callable to determine which values to include. - + @@ -37,14 +37,14 @@ mixedvalue - + Optional callable which returns &true; if the value should be included, &false; otherwise. - - + + If a callback is not provided, only values which are &true; (see converting to boolean) will be included. - + @@ -53,11 +53,11 @@ &reftitle.returnvalues; - + A new sequence containing all the values for which either the callback returned &true;, or all values that convert to &true; if a callback was not provided. - + diff --git a/reference/ds/ds/sequence/find.xml b/reference/ds/ds/sequence/find.xml index 7f0187768566..7991f9d01a27 100644 --- a/reference/ds/ds/sequence/find.xml +++ b/reference/ds/ds/sequence/find.xml @@ -15,9 +15,9 @@ abstract public mixedDs\Sequence::find mixedvalue - + Returns the index of the value, or &false; if not found. - + @@ -27,9 +27,9 @@ value - + The value to find. - + @@ -37,13 +37,13 @@ &reftitle.returnvalues; - + The index of the value, or &false; if not found. - + - + Values will be compared by value and by type. - + diff --git a/reference/ds/ds/sequence/first.xml b/reference/ds/ds/sequence/first.xml index 883074d13684..e7322c7e02a9 100644 --- a/reference/ds/ds/sequence/first.xml +++ b/reference/ds/ds/sequence/first.xml @@ -13,9 +13,9 @@ abstract public mixedDs\Sequence::first - + Returns the first value in the sequence. - + @@ -25,16 +25,16 @@ &reftitle.returnvalues; - + The first value in the sequence. - + &reftitle.errors; - - UnderflowException if empty. - + + UnderflowException if empty. + diff --git a/reference/ds/ds/sequence/get.xml b/reference/ds/ds/sequence/get.xml index 49a0b6c2dbd9..51e8df0cb380 100644 --- a/reference/ds/ds/sequence/get.xml +++ b/reference/ds/ds/sequence/get.xml @@ -13,9 +13,9 @@ abstract public mixedDs\Sequence::get intindex - + Returns the value at a given index. - + @@ -25,9 +25,9 @@ index - + The index to access, starting at 0. - + @@ -35,16 +35,16 @@ &reftitle.returnvalues; - + The value at the requested index. - + &reftitle.errors; - - OutOfRangeException if the index is not valid. - + + OutOfRangeException if the index is not valid. + diff --git a/reference/ds/ds/sequence/insert.xml b/reference/ds/ds/sequence/insert.xml index c0b3171653f3..32cc7d0ed41a 100644 --- a/reference/ds/ds/sequence/insert.xml +++ b/reference/ds/ds/sequence/insert.xml @@ -14,9 +14,9 @@ intindex mixedvalues - + Inserts values into the sequence at a given index. - + @@ -30,18 +30,18 @@ The index at which to insert. 0 <= index <= count - + You can insert at the index equal to the number of values. - + values - + The value or values to insert. - + @@ -49,16 +49,16 @@ &reftitle.returnvalues; - + &return.void; - + &reftitle.errors; - - OutOfRangeException if the index is not valid. - + + OutOfRangeException if the index is not valid. + diff --git a/reference/ds/ds/sequence/join.xml b/reference/ds/ds/sequence/join.xml index db09f84a426f..57b63cda3076 100644 --- a/reference/ds/ds/sequence/join.xml +++ b/reference/ds/ds/sequence/join.xml @@ -13,9 +13,9 @@ abstract public stringDs\Sequence::join stringglue - + Joins all values together as a string using an optional separator between each value. - + @@ -24,9 +24,9 @@ glue - + An optional string to separate each value. - + @@ -34,9 +34,9 @@ &reftitle.returnvalues; - + All values of the sequence joined together as a string. - + diff --git a/reference/ds/ds/sequence/last.xml b/reference/ds/ds/sequence/last.xml index 8455c938a634..90a7431115b6 100644 --- a/reference/ds/ds/sequence/last.xml +++ b/reference/ds/ds/sequence/last.xml @@ -13,9 +13,9 @@ abstract public mixedDs\Sequence::last - + Returns the last value in the sequence. - + @@ -25,16 +25,16 @@ &reftitle.returnvalues; - + The last value in the sequence. - + &reftitle.errors; - - UnderflowException if empty. - + + UnderflowException if empty. + diff --git a/reference/ds/ds/sequence/map.xml b/reference/ds/ds/sequence/map.xml index 310cfbff8839..644c973b2699 100644 --- a/reference/ds/ds/sequence/map.xml +++ b/reference/ds/ds/sequence/map.xml @@ -13,10 +13,10 @@ abstract public Ds\SequenceDs\Sequence::map callablecallback - + Returns the result of applying a callback function to each value in the sequence. - + @@ -33,13 +33,13 @@ mixedvalue - + A callable to apply to each value in the sequence. - + - + The callable should return what the new value will be in the new sequence. - + @@ -48,14 +48,14 @@ &reftitle.returnvalues; - + The result of applying a callback to each value in the sequence. - + - + The values of the current instance won't be affected. - + diff --git a/reference/ds/ds/sequence/merge.xml b/reference/ds/ds/sequence/merge.xml index 0c8620b83626..689af930591a 100644 --- a/reference/ds/ds/sequence/merge.xml +++ b/reference/ds/ds/sequence/merge.xml @@ -13,9 +13,9 @@ abstract public Ds\SequenceDs\Sequence::merge mixedvalues - + Returns the result of adding all given values to the sequence. - + @@ -25,9 +25,9 @@ values - + A traversable object or an &array;. - + @@ -35,14 +35,14 @@ &reftitle.returnvalues; - + The result of adding all given values to the sequence, effectively the same as adding the values to a copy, then returning that copy. - + - + The current instance won't be affected. - + diff --git a/reference/ds/ds/sequence/pop.xml b/reference/ds/ds/sequence/pop.xml index a2a10974c5b9..86fe364a3b11 100644 --- a/reference/ds/ds/sequence/pop.xml +++ b/reference/ds/ds/sequence/pop.xml @@ -13,9 +13,9 @@ abstract public mixedDs\Sequence::pop - + Removes and returns the last value. - + @@ -26,16 +26,16 @@ &reftitle.returnvalues; - + The removed last value. - + &reftitle.errors; - - UnderflowException if empty. - + + UnderflowException if empty. + diff --git a/reference/ds/ds/sequence/push.xml b/reference/ds/ds/sequence/push.xml index 607b759e9d04..a0b9232a7a52 100644 --- a/reference/ds/ds/sequence/push.xml +++ b/reference/ds/ds/sequence/push.xml @@ -13,9 +13,9 @@ abstract public voidDs\Sequence::push mixedvalues - + Adds values to the end of the sequence. - + @@ -25,9 +25,9 @@ values - + The values to add. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/ds/ds/sequence/reduce.xml b/reference/ds/ds/sequence/reduce.xml index ea8c3828911a..6ae1fbb02e2c 100644 --- a/reference/ds/ds/sequence/reduce.xml +++ b/reference/ds/ds/sequence/reduce.xml @@ -14,9 +14,9 @@ callablecallback mixedinitial - + Reduces the sequence to a single value using a callback function. - + @@ -36,18 +36,18 @@ carry - + The return value of the previous callback, or initial if it's the first iteration. - + value - + The value of the current iteration. - + @@ -57,9 +57,9 @@ initial - + The initial value of the carry value. Can be &null;. - + @@ -67,9 +67,9 @@ &reftitle.returnvalues; - + The return value of the final callback. - + diff --git a/reference/ds/ds/sequence/remove.xml b/reference/ds/ds/sequence/remove.xml index c5a21ffb0f62..5406876fb7fb 100644 --- a/reference/ds/ds/sequence/remove.xml +++ b/reference/ds/ds/sequence/remove.xml @@ -13,9 +13,9 @@ abstract public mixedDs\Sequence::remove intindex - + Removes and returns a value by index. - + @@ -25,9 +25,9 @@ index - + The index of the value to remove. - + @@ -35,16 +35,16 @@ &reftitle.returnvalues; - + The value that was removed. - + &reftitle.errors; - - OutOfRangeException if the index is not valid. - + + OutOfRangeException if the index is not valid. + diff --git a/reference/ds/ds/sequence/reverse.xml b/reference/ds/ds/sequence/reverse.xml index dbc4d50b1c31..d72348279510 100644 --- a/reference/ds/ds/sequence/reverse.xml +++ b/reference/ds/ds/sequence/reverse.xml @@ -15,9 +15,9 @@ abstract public voidDs\Sequence::reverse - + Reverses the sequence in-place. - + @@ -28,9 +28,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/ds/ds/sequence/reversed.xml b/reference/ds/ds/sequence/reversed.xml index aff581c7cc15..e5a88b8aa1cd 100644 --- a/reference/ds/ds/sequence/reversed.xml +++ b/reference/ds/ds/sequence/reversed.xml @@ -13,9 +13,9 @@ abstract public Ds\SequenceDs\Sequence::reversed - + Returns a reversed copy of the sequence. - + @@ -30,9 +30,9 @@ A reversed copy of the sequence. - + The current instance is not affected. - + diff --git a/reference/ds/ds/sequence/rotate.xml b/reference/ds/ds/sequence/rotate.xml index 46de6ba08643..aec884376937 100644 --- a/reference/ds/ds/sequence/rotate.xml +++ b/reference/ds/ds/sequence/rotate.xml @@ -27,9 +27,9 @@ rotations - + The number of times the sequence should be rotated. - + @@ -37,9 +37,9 @@ &reftitle.returnvalues; - + &return.void;. The sequence of the current instance will be rotated. - + diff --git a/reference/ds/ds/sequence/set.xml b/reference/ds/ds/sequence/set.xml index a123c531a8b7..c3528241869d 100644 --- a/reference/ds/ds/sequence/set.xml +++ b/reference/ds/ds/sequence/set.xml @@ -14,9 +14,9 @@ intindex mixedvalue - + Updates a value at a given index. - + @@ -26,17 +26,17 @@ index - + The index of the value to update. - + value - + The new value. - + @@ -44,16 +44,16 @@ &reftitle.returnvalues; - + &return.void; - + &reftitle.errors; - - OutOfRangeException if the index is not valid. - + + OutOfRangeException if the index is not valid. + diff --git a/reference/ds/ds/sequence/shift.xml b/reference/ds/ds/sequence/shift.xml index 41e47c31c194..0ab932ee4555 100644 --- a/reference/ds/ds/sequence/shift.xml +++ b/reference/ds/ds/sequence/shift.xml @@ -13,9 +13,9 @@ abstract public mixedDs\Sequence::shift - + Removes and returns the first value. - + @@ -26,16 +26,16 @@ &reftitle.returnvalues; - + The first value, which was removed. - + &reftitle.errors; - - UnderflowException if empty. - + + UnderflowException if empty. + diff --git a/reference/ds/ds/sequence/slice.xml b/reference/ds/ds/sequence/slice.xml index 83334fcd4c33..5a577eea0607 100644 --- a/reference/ds/ds/sequence/slice.xml +++ b/reference/ds/ds/sequence/slice.xml @@ -16,9 +16,9 @@ intindex intlength - + Creates a sub-sequence of a given range. - + @@ -28,19 +28,19 @@ index - + The index at which the sub-sequence starts. - - + + If positive, the sequence will start at that index in the sequence. If negative, the sequence will start that far from the end. - + length - + If a length is given and is positive, the resulting sequence will have up to that many values in it. @@ -53,7 +53,7 @@ If a length is not provided, the resulting sequence will contain all values between the index and the end of the sequence. - + @@ -61,9 +61,9 @@ &reftitle.returnvalues; - + A sub-sequence of the given range. - + diff --git a/reference/ds/ds/sequence/sort.xml b/reference/ds/ds/sequence/sort.xml index c9cf2a588c8f..984d7a2e49fc 100644 --- a/reference/ds/ds/sequence/sort.xml +++ b/reference/ds/ds/sequence/sort.xml @@ -15,9 +15,9 @@ abstract public voidDs\Sequence::sort callablecomparator - + Sorts the sequence in-place, using an optional comparator function. - + @@ -35,9 +35,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/ds/ds/sequence/sorted.xml b/reference/ds/ds/sequence/sorted.xml index d8014cf3b5c4..87cc1edb0565 100644 --- a/reference/ds/ds/sequence/sorted.xml +++ b/reference/ds/ds/sequence/sorted.xml @@ -13,9 +13,9 @@ abstract public Ds\SequenceDs\Sequence::sorted callablecomparator - + Returns a sorted copy, using an optional comparator function. - + @@ -33,9 +33,9 @@ &reftitle.returnvalues; - + Returns a sorted copy of the sequence. - + diff --git a/reference/ds/ds/sequence/sum.xml b/reference/ds/ds/sequence/sum.xml index 55a76552f22e..d780a4d320a5 100644 --- a/reference/ds/ds/sequence/sum.xml +++ b/reference/ds/ds/sequence/sum.xml @@ -13,13 +13,13 @@ abstract public intfloatDs\Sequence::sum - + Returns the sum of all values in the sequence. - + - + Arrays and objects are considered equal to zero when calculating the sum. - + @@ -31,10 +31,10 @@ &reftitle.returnvalues; - + The sum of all the values in the sequence as either a float or int depending on the values in the sequence. - + diff --git a/reference/ds/ds/sequence/unshift.xml b/reference/ds/ds/sequence/unshift.xml index 8da0e57c32d4..58e1f7a9ce5c 100644 --- a/reference/ds/ds/sequence/unshift.xml +++ b/reference/ds/ds/sequence/unshift.xml @@ -13,10 +13,10 @@ abstract public voidDs\Sequence::unshift mixedvalues - + Adds values to the front of the sequence, moving all the current values forward to make room for the new values. - + @@ -29,10 +29,10 @@ The values to add to the front of the sequence. - + Multiple values will be added in the same order that they are passed. - + @@ -42,9 +42,9 @@ &reftitle.returnvalues; - + &return.void; - + diff --git a/reference/eio/book.xml b/reference/eio/book.xml index 3f3ad63987b2..2cb3732439a1 100644 --- a/reference/eio/book.xml +++ b/reference/eio/book.xml @@ -1,10 +1,10 @@ - + Eio Eio - + &reftitle.intro; @@ -155,7 +155,7 @@ event_base_loop($base); - + &reference.eio.setup; &reference.eio.constants; &reference.eio.examples; diff --git a/reference/eio/constants.xml b/reference/eio/constants.xml index 7bb93c5c1607..04009193a62c 100644 --- a/reference/eio/constants.xml +++ b/reference/eio/constants.xml @@ -1,12 +1,11 @@ - + &reftitle.constants; &extension.constants; Request priority constants: - EIO_PRI_MIN @@ -40,7 +39,6 @@ - @@ -86,7 +84,6 @@ Flags used with eio_readdir: - EIO_READDIR_DENTS @@ -144,9 +141,7 @@ - - EIO_DT_UNKNOWN @@ -323,8 +318,6 @@ - - @@ -332,7 +325,6 @@ argument: - EIO_O_RDONLY @@ -423,7 +415,6 @@ - @@ -431,7 +422,6 @@ mode argument flags for eio_open: - EIO_S_IRUSR @@ -572,8 +562,6 @@ - - @@ -581,7 +569,6 @@ eio_sync_file_range flags: - EIO_SYNC_FILE_RANGE_WAIT_BEFORE @@ -612,8 +599,6 @@ - - diff --git a/reference/eio/functions/eio-readdir.xml b/reference/eio/functions/eio-readdir.xml index eb934dd61d59..bfd34a63f781 100644 --- a/reference/eio/functions/eio-readdir.xml +++ b/reference/eio/functions/eio-readdir.xml @@ -1,6 +1,6 @@ - + eio_readdir Reads through a whole directory @@ -78,7 +78,6 @@ - EIO_READDIR_DENTS @@ -137,14 +136,12 @@ - Node types: - EIO_DT_UNKNOWN @@ -321,8 +318,6 @@ - - diff --git a/reference/eio/setup.xml b/reference/eio/setup.xml index 622f66bffed0..3668e9dfbf48 100644 --- a/reference/eio/setup.xml +++ b/reference/eio/setup.xml @@ -1,6 +1,6 @@ - + &reftitle.setup;
@@ -13,16 +13,13 @@ &reference.eio.configure; - -
&reftitle.resources; There are two resource types in this extension: request and request group.
- - + enchant_broker_describe Enumerates the Enchant providers @@ -109,21 +109,6 @@ Array - - - - - - + The Ev class Ev -
&reftitle.intro; @@ -12,25 +11,23 @@ operations.
- +
&reftitle.classsynopsis; - Ev - final Ev - + &Constants; - + const int @@ -235,19 +232,19 @@ Ev::BACKEND_MASK 65535 - + &Methods; - +
- +
&reftitle.constants; Flags passed to create a loop: - + @@ -357,13 +354,13 @@ - + Flags passed to Ev::run, or EvLoop::run - + @@ -397,13 +394,13 @@ - + Flags passed to Ev::stop, or EvLoop::stop - + @@ -445,10 +442,9 @@ - + Watcher priorities: - @@ -472,10 +468,9 @@ - + Bit masks of (received) events: - @@ -655,10 +650,9 @@ - + Backend flags: - @@ -761,7 +755,7 @@ - + For the default loop during module initialization phase @@ -799,7 +793,7 @@
- +
&reference.ev.entities.ev; diff --git a/reference/ev/evio.xml b/reference/ev/evio.xml index 2bc9593651f6..3357cb6622db 100644 --- a/reference/ev/evio.xml +++ b/reference/ev/evio.xml @@ -1,10 +1,9 @@ - + The EvIo class EvIo -
&reftitle.intro; @@ -50,16 +49,14 @@ Always consider using non-blocking mode.
- +
&reftitle.classsynopsis; - EvIo - EvIo @@ -69,7 +66,7 @@ EvWatcher - + &Properties; public @@ -87,9 +84,8 @@ &InheritedMethods; - +
-
&reftitle.properties; @@ -111,7 +107,7 @@
- +
&reference.ev.entities.evio; diff --git a/reference/ffi/ffi/cdef.xml b/reference/ffi/ffi/cdef.xml index e0c28719356d..904873062da0 100644 --- a/reference/ffi/ffi/cdef.xml +++ b/reference/ffi/ffi/cdef.xml @@ -1,6 +1,6 @@ - + FFI::cdef Creates a new FFI object @@ -63,7 +63,7 @@ - + &reftitle.changelog; @@ -90,7 +90,7 @@ - + + &reftitle.errors; Throws a ValueError if seed is invalid. - + &reftitle.changelog; diff --git a/reference/hash/functions/hash-algos.xml b/reference/hash/functions/hash-algos.xml index 6e0e6d93aab3..2e82d13deb11 100644 --- a/reference/hash/functions/hash-algos.xml +++ b/reference/hash/functions/hash-algos.xml @@ -26,7 +26,7 @@ - + &reftitle.changelog; @@ -61,7 +61,7 @@ - + &reftitle.examples; @@ -151,13 +151,13 @@ Array - + &reftitle.seealso; hash hash_hmac_algos - + diff --git a/reference/hash/functions/hash-hmac-algos.xml b/reference/hash/functions/hash-hmac-algos.xml index 5f58447b91eb..edbaed748b93 100644 --- a/reference/hash/functions/hash-hmac-algos.xml +++ b/reference/hash/functions/hash-hmac-algos.xml @@ -7,30 +7,30 @@ Return a list of registered hashing algorithms suitable for hash_hmac - + &reftitle.description; arrayhash_hmac_algos - + &reftitle.parameters; &no.function.parameters; - + &reftitle.returnvalues; Returns a numerically indexed array containing the list of supported hashing algorithms suitable for hash_hmac. - + - + &reftitle.examples; - + <function>hash_hmac_algos</function> example - - + + - + &reftitle.notes; @@ -102,15 +102,15 @@ Array algorithms that are not suitable for hash_hmac. - + - + &reftitle.seealso; hash_hmac hash_algos - +
diff --git a/reference/hash/functions/hash-pbkdf2.xml b/reference/hash/functions/hash-pbkdf2.xml index 136fa54580f7..6634f73dcd33 100644 --- a/reference/hash/functions/hash-pbkdf2.xml +++ b/reference/hash/functions/hash-pbkdf2.xml @@ -101,16 +101,16 @@ - + &reftitle.returnvalues; Returns a string containing the derived key as lowercase hexits unless binary is set to &true; in which case the raw binary representation of the derived key is returned. - + - + &reftitle.errors; Throws a ValueError exception if the algorithm is @@ -119,7 +119,7 @@ than 0 or the salt is too long (greater than INT_MAX - 4). - + &reftitle.changelog; diff --git a/reference/ibm_db2/functions/db2-client-info.xml b/reference/ibm_db2/functions/db2-client-info.xml index b6d269ffc2a3..3528d77bd23e 100644 --- a/reference/ibm_db2/functions/db2-client-info.xml +++ b/reference/ibm_db2/functions/db2-client-info.xml @@ -1,6 +1,6 @@ - + db2_client_info Returns an object with properties that describe the DB2 database client @@ -138,39 +138,6 @@ - - - - &reftitle.examples; diff --git a/reference/ibm_db2/functions/db2-column-privileges.xml b/reference/ibm_db2/functions/db2-column-privileges.xml index e728d53845a0..c73f35844846 100644 --- a/reference/ibm_db2/functions/db2-column-privileges.xml +++ b/reference/ibm_db2/functions/db2-column-privileges.xml @@ -1,7 +1,7 @@ - + db2_column_privileges @@ -131,37 +131,6 @@ - - &reftitle.seealso; diff --git a/reference/ibm_db2/functions/db2-columns.xml b/reference/ibm_db2/functions/db2-columns.xml index 3411f1c1df19..2bd0482787a9 100644 --- a/reference/ibm_db2/functions/db2-columns.xml +++ b/reference/ibm_db2/functions/db2-columns.xml @@ -1,7 +1,7 @@ - + db2_columns @@ -189,37 +189,6 @@ - - &reftitle.seealso; diff --git a/reference/ibm_db2/functions/db2-commit.xml b/reference/ibm_db2/functions/db2-commit.xml index 6f3e92a663c0..a1907bc65b12 100644 --- a/reference/ibm_db2/functions/db2-commit.xml +++ b/reference/ibm_db2/functions/db2-commit.xml @@ -1,7 +1,7 @@ - + db2_commit @@ -45,37 +45,6 @@ - - &reftitle.seealso; diff --git a/reference/ibm_db2/functions/db2-cursor-type.xml b/reference/ibm_db2/functions/db2-cursor-type.xml index 87e9d839243f..2872d2d9fc6e 100644 --- a/reference/ibm_db2/functions/db2-cursor-type.xml +++ b/reference/ibm_db2/functions/db2-cursor-type.xml @@ -1,7 +1,7 @@ - + db2_cursor_type @@ -43,37 +43,6 @@ - - &reftitle.seealso; diff --git a/reference/ibm_db2/functions/db2-field-display-size.xml b/reference/ibm_db2/functions/db2-field-display-size.xml index a3b544150767..37425165dc65 100644 --- a/reference/ibm_db2/functions/db2-field-display-size.xml +++ b/reference/ibm_db2/functions/db2-field-display-size.xml @@ -1,7 +1,7 @@ - + db2_field_display_size @@ -54,37 +54,6 @@ - - &reftitle.seealso; diff --git a/reference/ibm_db2/functions/db2-field-name.xml b/reference/ibm_db2/functions/db2-field-name.xml index 23c4e726208e..d2454835de96 100644 --- a/reference/ibm_db2/functions/db2-field-name.xml +++ b/reference/ibm_db2/functions/db2-field-name.xml @@ -1,7 +1,7 @@ - + db2_field_name @@ -53,37 +53,6 @@ - - &reftitle.seealso; diff --git a/reference/ibm_db2/functions/db2-field-num.xml b/reference/ibm_db2/functions/db2-field-num.xml index e6e1332f0002..2f78d34c09b8 100644 --- a/reference/ibm_db2/functions/db2-field-num.xml +++ b/reference/ibm_db2/functions/db2-field-num.xml @@ -1,7 +1,7 @@ - + db2_field_num @@ -53,37 +53,6 @@ - - &reftitle.seealso; diff --git a/reference/ibm_db2/functions/db2-field-precision.xml b/reference/ibm_db2/functions/db2-field-precision.xml index cb9b15892f0c..a7ce2d299652 100644 --- a/reference/ibm_db2/functions/db2-field-precision.xml +++ b/reference/ibm_db2/functions/db2-field-precision.xml @@ -1,7 +1,7 @@ - + db2_field_precision @@ -53,37 +53,6 @@ - - &reftitle.seealso; diff --git a/reference/ibm_db2/functions/db2-field-scale.xml b/reference/ibm_db2/functions/db2-field-scale.xml index 088a3062df0e..c2c83c01136c 100644 --- a/reference/ibm_db2/functions/db2-field-scale.xml +++ b/reference/ibm_db2/functions/db2-field-scale.xml @@ -1,7 +1,7 @@ - + db2_field_scale @@ -53,37 +53,6 @@ - - &reftitle.seealso; diff --git a/reference/ibm_db2/functions/db2-field-type.xml b/reference/ibm_db2/functions/db2-field-type.xml index 768965341ca6..19ff45449119 100644 --- a/reference/ibm_db2/functions/db2-field-type.xml +++ b/reference/ibm_db2/functions/db2-field-type.xml @@ -1,7 +1,7 @@ - + db2_field_type @@ -53,37 +53,6 @@ - - &reftitle.seealso; diff --git a/reference/ibm_db2/functions/db2-field-width.xml b/reference/ibm_db2/functions/db2-field-width.xml index fb68ec2e3db8..0ca85466b0f9 100644 --- a/reference/ibm_db2/functions/db2-field-width.xml +++ b/reference/ibm_db2/functions/db2-field-width.xml @@ -1,7 +1,7 @@ - + db2_field_width @@ -56,37 +56,6 @@ - - &reftitle.seealso; diff --git a/reference/ibm_db2/functions/db2-foreign-keys.xml b/reference/ibm_db2/functions/db2-foreign-keys.xml index 478b806c24fc..86dc07fcd323 100644 --- a/reference/ibm_db2/functions/db2-foreign-keys.xml +++ b/reference/ibm_db2/functions/db2-foreign-keys.xml @@ -1,7 +1,7 @@ - + db2_foreign_keys @@ -162,37 +162,6 @@ - - &reftitle.seealso; diff --git a/reference/ibm_db2/functions/db2-free-result.xml b/reference/ibm_db2/functions/db2-free-result.xml index b2cca639cf65..5793021d2e93 100644 --- a/reference/ibm_db2/functions/db2-free-result.xml +++ b/reference/ibm_db2/functions/db2-free-result.xml @@ -1,7 +1,7 @@ - + db2_free_result @@ -43,37 +43,6 @@ - - &reftitle.seealso; diff --git a/reference/ibm_db2/functions/db2-free-stmt.xml b/reference/ibm_db2/functions/db2-free-stmt.xml index 5ac66539270e..9e66645d95e5 100644 --- a/reference/ibm_db2/functions/db2-free-stmt.xml +++ b/reference/ibm_db2/functions/db2-free-stmt.xml @@ -1,7 +1,7 @@ - + db2_free_stmt @@ -44,38 +44,6 @@ - - - &reftitle.seealso; diff --git a/reference/ibm_db2/functions/db2-next-result.xml b/reference/ibm_db2/functions/db2-next-result.xml index e81ad3dea053..8a35b6d1bfd8 100644 --- a/reference/ibm_db2/functions/db2-next-result.xml +++ b/reference/ibm_db2/functions/db2-next-result.xml @@ -1,7 +1,7 @@ - + db2_next_result @@ -148,20 +148,6 @@ array(1) { - - - - - + db2_num_rows @@ -69,51 +69,6 @@ - - - - - - - + db2_primary_keys @@ -113,37 +113,6 @@ - - &reftitle.seealso; diff --git a/reference/ibm_db2/functions/db2-procedure-columns.xml b/reference/ibm_db2/functions/db2-procedure-columns.xml index 6f360a582348..a4e6dc2356aa 100644 --- a/reference/ibm_db2/functions/db2-procedure-columns.xml +++ b/reference/ibm_db2/functions/db2-procedure-columns.xml @@ -1,7 +1,7 @@ - + db2_procedure_columns @@ -228,37 +228,6 @@ - - &reftitle.seealso; diff --git a/reference/ibm_db2/functions/db2-procedures.xml b/reference/ibm_db2/functions/db2-procedures.xml index bbfe82b5317b..56fa860f33d9 100644 --- a/reference/ibm_db2/functions/db2-procedures.xml +++ b/reference/ibm_db2/functions/db2-procedures.xml @@ -1,7 +1,7 @@ - + db2_procedures @@ -123,37 +123,6 @@ - - &reftitle.seealso; diff --git a/reference/ibm_db2/functions/db2-server-info.xml b/reference/ibm_db2/functions/db2-server-info.xml index 48c9a131a72a..d15e89245635 100644 --- a/reference/ibm_db2/functions/db2-server-info.xml +++ b/reference/ibm_db2/functions/db2-server-info.xml @@ -1,7 +1,7 @@ - + db2_server_info Returns an object with properties that describe the DB2 database server @@ -281,41 +281,6 @@ - - - - - - &reftitle.examples; diff --git a/reference/ibm_db2/functions/db2-special-columns.xml b/reference/ibm_db2/functions/db2-special-columns.xml index 93912f54af6e..5d22c62c6ebb 100644 --- a/reference/ibm_db2/functions/db2-special-columns.xml +++ b/reference/ibm_db2/functions/db2-special-columns.xml @@ -1,7 +1,7 @@ - + db2_special_columns @@ -203,37 +203,6 @@ - - &reftitle.seealso; diff --git a/reference/ibm_db2/functions/db2-statistics.xml b/reference/ibm_db2/functions/db2-statistics.xml index 1602d2400edd..4c554831e37f 100644 --- a/reference/ibm_db2/functions/db2-statistics.xml +++ b/reference/ibm_db2/functions/db2-statistics.xml @@ -1,7 +1,7 @@ - + db2_statistics @@ -242,37 +242,6 @@ - - &reftitle.seealso; diff --git a/reference/ibm_db2/functions/db2-stmt-error.xml b/reference/ibm_db2/functions/db2-stmt-error.xml index 685b407bfe70..c4a2859f83e7 100644 --- a/reference/ibm_db2/functions/db2-stmt-error.xml +++ b/reference/ibm_db2/functions/db2-stmt-error.xml @@ -1,7 +1,7 @@ - + db2_stmt_error @@ -54,37 +54,6 @@ - - &reftitle.seealso; diff --git a/reference/ibm_db2/functions/db2-stmt-errormsg.xml b/reference/ibm_db2/functions/db2-stmt-errormsg.xml index 881b64e8962f..d20db97bdf97 100644 --- a/reference/ibm_db2/functions/db2-stmt-errormsg.xml +++ b/reference/ibm_db2/functions/db2-stmt-errormsg.xml @@ -1,7 +1,7 @@ - + db2_stmt_errormsg @@ -48,37 +48,6 @@ - - &reftitle.seealso; diff --git a/reference/ibm_db2/functions/db2-table-privileges.xml b/reference/ibm_db2/functions/db2-table-privileges.xml index 249d401a70ee..3fbb24994e50 100644 --- a/reference/ibm_db2/functions/db2-table-privileges.xml +++ b/reference/ibm_db2/functions/db2-table-privileges.xml @@ -1,7 +1,7 @@ - + db2_table_privileges @@ -123,37 +123,6 @@ - - &reftitle.seealso; diff --git a/reference/ibm_db2/functions/db2-tables.xml b/reference/ibm_db2/functions/db2-tables.xml index 19b769fedc19..9f5f9e5a3c7d 100644 --- a/reference/ibm_db2/functions/db2-tables.xml +++ b/reference/ibm_db2/functions/db2-tables.xml @@ -1,7 +1,7 @@ - + db2_tables @@ -120,37 +120,6 @@ - - &reftitle.seealso; diff --git a/reference/imagick/imagick/setfont.xml b/reference/imagick/imagick/setfont.xml index 8e2c370f5c16..e453e87e99b3 100644 --- a/reference/imagick/imagick/setfont.xml +++ b/reference/imagick/imagick/setfont.xml @@ -1,6 +1,6 @@ - + Imagick::setFont Sets font @@ -12,14 +12,14 @@ public boolImagick::setFont stringfont - - Sets object's font property. This method can be used for example to set font for + + Sets object's font property. This method can be used for example to set font for caption: pseudo-format. The font needs to be configured in ImageMagick configuration or a file by the name of font must exist. This method should not be confused with ImagickDraw::setFont which sets the font for a specific ImagickDraw object. &imagick.method.available.0x637; - + @@ -45,39 +45,6 @@ - - - - &reftitle.examples; diff --git a/reference/imap/functions/imap-mutf7-to-utf8.xml b/reference/imap/functions/imap-mutf7-to-utf8.xml index e1d4a8dac0bc..d9dd13a40777 100644 --- a/reference/imap/functions/imap-mutf7-to-utf8.xml +++ b/reference/imap/functions/imap-mutf7-to-utf8.xml @@ -6,7 +6,7 @@ Decode a modified UTF-7 string to UTF-8 - + &reftitle.description; stringfalseimap_mutf7_to_utf8 @@ -20,9 +20,9 @@ This function is only available, if libcclient exports utf8_to_mutf7(). - + - + &reftitle.parameters; @@ -34,22 +34,22 @@ - + - + &reftitle.returnvalues; Returns string converted to UTF-8, &return.falseforfailure;. - + - + &reftitle.seealso; imap_utf8_to_mutf7 - + + &reftitle.description; stringfalseimap_utf8_to_mutf7 @@ -20,9 +20,9 @@ This function is only available, if libcclient exports utf8_to_mutf7(). - + - + &reftitle.parameters; @@ -34,22 +34,22 @@ - + - + &reftitle.returnvalues; Returns string converted to modified UTF-7, &return.falseforfailure;. - + - + &reftitle.seealso; imap_mutf7_to_utf8 - + - &reftitle.changelog; @@ -61,37 +52,6 @@ - - &reftitle.seealso; diff --git a/reference/info/functions/gc-disable.xml b/reference/info/functions/gc-disable.xml index 172cf8dd5aaf..f313de133dff 100644 --- a/reference/info/functions/gc-disable.xml +++ b/reference/info/functions/gc-disable.xml @@ -22,7 +22,7 @@ &reftitle.parameters; &no.function.parameters; - + &reftitle.returnvalues; @@ -30,70 +30,6 @@ - - - - - - &reftitle.seealso; diff --git a/reference/info/functions/gc-enable.xml b/reference/info/functions/gc-enable.xml index aba80e425bda..96d1b65713fe 100644 --- a/reference/info/functions/gc-enable.xml +++ b/reference/info/functions/gc-enable.xml @@ -22,7 +22,7 @@ &reftitle.parameters; &no.function.parameters; - + &reftitle.returnvalues; @@ -30,70 +30,6 @@ - - - - - - &reftitle.seealso; diff --git a/reference/info/functions/gc-enabled.xml b/reference/info/functions/gc-enabled.xml index 030c7a84193e..3b9e9d6b36a1 100644 --- a/reference/info/functions/gc-enabled.xml +++ b/reference/info/functions/gc-enabled.xml @@ -21,7 +21,7 @@ &reftitle.parameters; &no.function.parameters; - + &reftitle.returnvalues; @@ -29,39 +29,6 @@ - - - - &reftitle.examples; diff --git a/reference/info/functions/gc-mem-caches.xml b/reference/info/functions/gc-mem-caches.xml index e60cad0901d2..fc8b43d77ff6 100644 --- a/reference/info/functions/gc-mem-caches.xml +++ b/reference/info/functions/gc-mem-caches.xml @@ -23,7 +23,7 @@ &reftitle.parameters; &no.function.parameters; - + &reftitle.returnvalues; @@ -31,70 +31,6 @@ - - - - - - &reftitle.seealso; diff --git a/reference/libxml/functions/libxml-disable-entity-loader.xml b/reference/libxml/functions/libxml-disable-entity-loader.xml index f8d4f999713c..50b2ecf63cc3 100644 --- a/reference/libxml/functions/libxml-disable-entity-loader.xml +++ b/reference/libxml/functions/libxml-disable-entity-loader.xml @@ -17,12 +17,12 @@ boollibxml_disable_entity_loader booldisable&true; - + Disable/enable the ability to load external entities. Note that disabling the loading of external entities may cause general issues with loading XML documents. - - + + As of libxml 2.9.0 entity substitution is disabled by default, so there is no need to disable the loading of external entities, @@ -31,7 +31,7 @@ Generally, it is preferable to use libxml_set_external_entity_loader to suppress loading of external entities. The LIBXML_NO_XXE constant can be used to prevent this as well (only available in Libxml >= 2.13.0, as of PHP 8.4.0). - + @@ -41,11 +41,11 @@ disable - + Disable (&true;) or enable (&false;) libxml extensions (such as , and ) to load external entities. - + @@ -54,9 +54,9 @@ &reftitle.returnvalues; - + Returns the previous value. - + @@ -81,45 +81,6 @@ - - - - &reftitle.seealso; diff --git a/reference/mbstring/functions/mb-stripos.xml b/reference/mbstring/functions/mb-stripos.xml index a9dd671e9b54..93473f76f5bd 100644 --- a/reference/mbstring/functions/mb-stripos.xml +++ b/reference/mbstring/functions/mb-stripos.xml @@ -15,14 +15,14 @@ intoffset0 stringnullencoding&null; - + mb_stripos returns the numeric position of the first occurrence of needle in the haystack string. - Unlike mb_strpos, + Unlike mb_strpos, mb_stripos is case-insensitive. If needle is not found, it returns &false;. - + &reftitle.parameters; @@ -110,37 +110,6 @@ - - &reftitle.seealso; diff --git a/reference/mbstring/functions/mb-stristr.xml b/reference/mbstring/functions/mb-stristr.xml index f0f723e0ca44..1308bef641b8 100644 --- a/reference/mbstring/functions/mb-stristr.xml +++ b/reference/mbstring/functions/mb-stristr.xml @@ -15,14 +15,14 @@ boolbefore_needle&false; stringnullencoding&null; - + mb_stristr finds the first occurrence of needle in haystack and returns the portion of haystack. - Unlike mb_strstr, + Unlike mb_strstr, mb_stristr is case-insensitive. If needle is not found, it returns &false;. - + &reftitle.parameters; @@ -48,14 +48,14 @@ before_needle - + Determines which portion of haystack - this function returns. + this function returns. If set to &true;, it returns all of haystack from the beginning to the first occurrence of needle (excluding needle). If set to &false;, it returns all of haystack from the first occurrence of needle to the end (including needle). - + @@ -75,15 +75,6 @@ - - &reftitle.changelog; @@ -101,38 +92,6 @@ - - - &reftitle.seealso; diff --git a/reference/mbstring/functions/mb-strrichr.xml b/reference/mbstring/functions/mb-strrichr.xml index bf2679f2d07d..00c6c4951a46 100644 --- a/reference/mbstring/functions/mb-strrichr.xml +++ b/reference/mbstring/functions/mb-strrichr.xml @@ -48,14 +48,14 @@ before_needle - + Determines which portion of haystack - this function returns. + this function returns. If set to &true;, it returns all of haystack from the beginning to the last occurrence of needle. If set to &false;, it returns all of haystack from the last occurrence of needle to the end. - + @@ -75,15 +75,6 @@ - - &reftitle.changelog; @@ -102,38 +93,6 @@ - - - &reftitle.seealso; diff --git a/reference/mbstring/functions/mb-strripos.xml b/reference/mbstring/functions/mb-strripos.xml index fafd473fd739..6b278b78a844 100644 --- a/reference/mbstring/functions/mb-strripos.xml +++ b/reference/mbstring/functions/mb-strripos.xml @@ -15,16 +15,16 @@ intoffset0 stringnullencoding&null; - + mb_strripos performs multi-byte safe strripos operation based on number of characters. needle position is counted from the beginning of haystack. First character's position is - 0. Second character position is 1. + 0. Second character position is 1. Unlike mb_strrpos, mb_strripos is case-insensitive. - + &reftitle.parameters; @@ -107,37 +107,6 @@ - - &reftitle.seealso; diff --git a/reference/mbstring/functions/mb-strstr.xml b/reference/mbstring/functions/mb-strstr.xml index 230a367c7d9c..96ec7d64252c 100644 --- a/reference/mbstring/functions/mb-strstr.xml +++ b/reference/mbstring/functions/mb-strstr.xml @@ -46,14 +46,14 @@ before_needle - + Determines which portion of haystack - this function returns. + this function returns. If set to &true;, it returns all of haystack from the beginning to the first occurrence of needle (excluding needle). If set to &false;, it returns all of haystack from the first occurrence of needle to the end (including needle). - + @@ -73,15 +73,6 @@ - - &reftitle.changelog; @@ -100,37 +91,6 @@ - - &reftitle.seealso; diff --git a/reference/misc/functions/pack.xml b/reference/misc/functions/pack.xml index ca0c4e238679..9c67363d8168 100644 --- a/reference/misc/functions/pack.xml +++ b/reference/misc/functions/pack.xml @@ -196,7 +196,7 @@ - + &reftitle.changelog; @@ -230,7 +230,7 @@ - + &reftitle.examples; diff --git a/reference/misc/functions/sapi-windows-cp-conv.xml b/reference/misc/functions/sapi-windows-cp-conv.xml index d8f4beef3f59..67caf929fa2c 100644 --- a/reference/misc/functions/sapi-windows-cp-conv.xml +++ b/reference/misc/functions/sapi-windows-cp-conv.xml @@ -6,7 +6,7 @@ Convert string from one codepage to another - + &reftitle.description; stringnullsapi_windows_cp_conv @@ -17,9 +17,9 @@ Convert string from one codepage to another. - + - + &reftitle.parameters; @@ -49,31 +49,31 @@ - + - + &reftitle.returnvalues; The subject string converted to out_codepage, or &null; on failure. - + - + &reftitle.errors; This function issues E_WARNING level errors, if invalid codepages are given, or if the subject is not valid for in_codepage. - + - + &reftitle.seealso; sapi_windows_cp_get iconv - + + &reftitle.description; intsapi_windows_cp_get @@ -16,9 +16,9 @@ Gets the current codepage. - + - + &reftitle.parameters; @@ -32,9 +32,9 @@ - + - + &reftitle.returnvalues; If kind is 'ansi', @@ -43,14 +43,14 @@ the current OEM code page of the operating system is returned. Otherwise, the current codepage of the process is returned. - + - + &reftitle.seealso; sapi_windows_cp_set - + diff --git a/reference/misc/functions/sapi-windows-cp-is-utf8.xml b/reference/misc/functions/sapi-windows-cp-is-utf8.xml index a6323db37576..a04adb92cb2b 100644 --- a/reference/misc/functions/sapi-windows-cp-is-utf8.xml +++ b/reference/misc/functions/sapi-windows-cp-is-utf8.xml @@ -7,7 +7,7 @@ Indicates whether the codepage is UTF-8 compatible - + &reftitle.description; boolsapi_windows_cp_is_utf8 @@ -16,26 +16,26 @@ Indicates whether the codepage of the current process is UTF-8 compatible. - + - + &reftitle.parameters; &no.function.parameters; - + - + &reftitle.returnvalues; Returns whether the codepage of the current process is UTF-8 compatible. - + - + &reftitle.seealso; sapi_windows_cp_get - + diff --git a/reference/misc/functions/sapi-windows-cp-set.xml b/reference/misc/functions/sapi-windows-cp-set.xml index df622adbafc6..fe54dfb96f60 100644 --- a/reference/misc/functions/sapi-windows-cp-set.xml +++ b/reference/misc/functions/sapi-windows-cp-set.xml @@ -6,7 +6,7 @@ Set process codepage - + &reftitle.description; boolsapi_windows_cp_set @@ -15,9 +15,9 @@ Set the codepage of the current process. - + - + &reftitle.parameters; @@ -29,21 +29,21 @@ - + - + &reftitle.returnvalues; &return.success; - + - + &reftitle.seealso; sapi_windows_cp_get - + + &reftitle.description; boolsapi_windows_vt100_support @@ -32,9 +32,9 @@ This function uses the ENABLE_VIRTUAL_TERMINAL_PROCESSING flag implemented in the Windows 10 API, so the VT100 feature may not be available on older Windows versions. - + - + &reftitle.parameters; @@ -54,9 +54,9 @@ - + - + &reftitle.returnvalues; If enable is &null;: returns &true; if the VT100 feature is enabled, &false; otherwise. @@ -64,7 +64,7 @@ If enable is a bool: &return.success; - + &reftitle.changelog; @@ -88,7 +88,7 @@ - + &reftitle.examples; <function>sapi_windows_vt100_support</function> default state diff --git a/reference/misc/functions/unpack.xml b/reference/misc/functions/unpack.xml index d1619d0ade79..b2fcbab48692 100644 --- a/reference/misc/functions/unpack.xml +++ b/reference/misc/functions/unpack.xml @@ -83,7 +83,7 @@ - + &reftitle.changelog; @@ -111,7 +111,7 @@ - + &reftitle.examples; diff --git a/reference/pdo/pdo/quote.xml b/reference/pdo/pdo/quote.xml index a87d26527891..03b06c587143 100644 --- a/reference/pdo/pdo/quote.xml +++ b/reference/pdo/pdo/quote.xml @@ -30,10 +30,10 @@ are often much faster to execute than interpolated queries, as both the server and client side can cache a compiled form of the query. - + Not all PDO drivers implement this method (notably PDO_ODBC). Consider using prepared statements instead. - + Security: the default character set @@ -51,19 +51,19 @@ string - + The string to be quoted. - + type - + Provides a hint to the type of data for drivers that have alternate quoting styles. For example PDO_PARAM_LOB will tell the driver to escape binary data. - + @@ -71,21 +71,12 @@ &reftitle.returnvalues; - + Returns a quoted string that is theoretically safe to pass into an SQL statement. Returns &false; if the driver does not support quoting in this way. - - - - &reftitle.examples; diff --git a/reference/pdo/pdoexception.xml b/reference/pdo/pdoexception.xml index b7d4ab81bdab..646965d3a0f7 100644 --- a/reference/pdo/pdoexception.xml +++ b/reference/pdo/pdoexception.xml @@ -6,7 +6,6 @@ -
&reftitle.intro; @@ -16,12 +15,10 @@ information about Exceptions in PHP.
-
&reftitle.classsynopsis; - PDOException @@ -58,15 +55,13 @@ -
-
&reftitle.properties; - + errorInfo @@ -74,8 +69,8 @@ PDOStatement::errorInfo - - + + code @@ -83,10 +78,9 @@ Exception::getCode to access it. - +
-
diff --git a/reference/pdo/pdostatement/getcolumnmeta.xml b/reference/pdo/pdostatement/getcolumnmeta.xml index 4d0115cd064a..99a0079b7a06 100644 --- a/reference/pdo/pdostatement/getcolumnmeta.xml +++ b/reference/pdo/pdostatement/getcolumnmeta.xml @@ -13,7 +13,7 @@ public arrayfalsePDOStatement::getColumnMeta intcolumn - + Retrieves the metadata for a 0-indexed column in a result set as an associative array. @@ -54,8 +54,8 @@ Column metadata - - + + Name @@ -112,15 +112,6 @@ - - &reftitle.examples; diff --git a/reference/pdo/pdostatement/setfetchmode.xml b/reference/pdo/pdostatement/setfetchmode.xml index 8c7354f4ad1e..cdce4e33ad30 100644 --- a/reference/pdo/pdostatement/setfetchmode.xml +++ b/reference/pdo/pdostatement/setfetchmode.xml @@ -42,43 +42,43 @@ mode - + The fetch mode must be one of the PDO::FETCH_* constants. - + colno - + Column number. - + class - + Class name. - + constructorArgs - + Constructor arguments. - + object - + Object. - + @@ -144,19 +144,6 @@ pear green 150 - - - - + The Volatile class Volatile -
&reftitle.intro; @@ -19,16 +18,13 @@ PHP arrays in Threaded contexts.
-
&reftitle.classsynopsis; - Volatile - Volatile @@ -53,13 +49,12 @@ -
&reftitle.examples; - + New immutability semantics of Threaded data); RuntimeException: Threaded members previously set to Threaded objects are immutable, cannot overwrite data in %s:%d ]]> - - + + Volatile use-case - +
diff --git a/reference/reflection/reflectiontype.xml b/reference/reflection/reflectiontype.xml index 09f7d254f998..207104943242 100644 --- a/reference/reflection/reflectiontype.xml +++ b/reference/reflection/reflectiontype.xml @@ -7,7 +7,6 @@ -
&reftitle.intro; @@ -21,12 +20,10 @@
-
&reftitle.classsynopsis; - abstract @@ -43,10 +40,10 @@ - +
-
+
&reftitle.changelog; @@ -69,7 +66,7 @@ -
+
diff --git a/reference/simplexml/examples.xml b/reference/simplexml/examples.xml index 5573d2227b0d..b80af17a5c71 100644 --- a/reference/simplexml/examples.xml +++ b/reference/simplexml/examples.xml @@ -502,7 +502,7 @@ Failed loading XML -
+
&reftitle.seealso; diff --git a/reference/snmp/snmpexception.xml b/reference/snmp/snmpexception.xml index ae02e2957c7b..d3d07bd4f95a 100644 --- a/reference/snmp/snmpexception.xml +++ b/reference/snmp/snmpexception.xml @@ -1,12 +1,11 @@ - + The SNMPException class SNMPException -
&reftitle.intro; @@ -16,12 +15,10 @@ information about Exceptions in PHP.
-
&reftitle.classsynopsis; - SNMPException @@ -45,25 +42,22 @@ -
-
&reftitle.properties; - + code SNMP library error code. Use Exception::getCode to access it. - +
-
diff --git a/reference/spl/appenditerator/append.xml b/reference/spl/appenditerator/append.xml index 5a6dad8dd0a3..6be894583064 100644 --- a/reference/spl/appenditerator/append.xml +++ b/reference/spl/appenditerator/append.xml @@ -40,10 +40,10 @@
- + &reftitle.examples; - + <methodname>AppendIterator::append</methodname> example - + - + &reftitle.seealso; diff --git a/reference/spl/appenditerator/construct.xml b/reference/spl/appenditerator/construct.xml index f6447703e596..24fcf98c3f3e 100644 --- a/reference/spl/appenditerator/construct.xml +++ b/reference/spl/appenditerator/construct.xml @@ -22,10 +22,10 @@ &no.function.parameters; - + &reftitle.examples; - + Iterating AppendIterator with foreach $item) { 4 => Ham ]]> - - + + Iterating AppendIterator with the AppendIterator API valid()) { 1 => 4 => Ham ]]> - + - + - + &reftitle.notes; @@ -109,7 +109,7 @@ while ($appendIterator->valid()) { iterators will get overwritten in the returned array. There is no way to preserve the original keys. - + &reftitle.seealso; diff --git a/reference/spl/appenditerator/getiteratorindex.xml b/reference/spl/appenditerator/getiteratorindex.xml index 86f70faa70df..68426e4c3508 100644 --- a/reference/spl/appenditerator/getiteratorindex.xml +++ b/reference/spl/appenditerator/getiteratorindex.xml @@ -29,10 +29,10 @@ - + &reftitle.examples; - + <methodname>AppendIterator.getIteratorIndex</methodname> basic example $current) { ]]> - + - + &reftitle.seealso; diff --git a/reference/spl/appenditerator/key.xml b/reference/spl/appenditerator/key.xml index dc009b6c7460..d3c68cb29aac 100644 --- a/reference/spl/appenditerator/key.xml +++ b/reference/spl/appenditerator/key.xml @@ -30,10 +30,10 @@ - + &reftitle.examples; - + <methodname>AppendIterator::key</methodname> basic example - + - + &reftitle.seealso; diff --git a/reference/spl/functions/iterator-apply.xml b/reference/spl/functions/iterator-apply.xml index 809eb83e1cd5..9fbfc0605461 100644 --- a/reference/spl/functions/iterator-apply.xml +++ b/reference/spl/functions/iterator-apply.xml @@ -14,9 +14,9 @@ callablecallback arraynullargs&null; - + Calls a function for every element in an iterator. - + @@ -26,9 +26,9 @@ iterator - + The iterator object to iterate over. - + @@ -51,11 +51,11 @@ args - + An array of arguments; each element of args is passed to the callback callback as separate argument. - + @@ -65,9 +65,9 @@ &reftitle.returnvalues; - + Returns the iteration count. - + @@ -100,43 +100,6 @@ CHERRIES - - &reftitle.seealso; diff --git a/reference/spl/iteratoriterator.xml b/reference/spl/iteratoriterator.xml index b8d8479e9dff..56f18803b752 100644 --- a/reference/spl/iteratoriterator.xml +++ b/reference/spl/iteratoriterator.xml @@ -7,7 +7,6 @@ -
&reftitle.intro; @@ -19,12 +18,10 @@ misuse, otherwise expect exceptions or fatal errors.
-
&reftitle.classsynopsis; - IteratorIterator @@ -43,18 +40,17 @@ -
-
+
&reftitle.notes; This class permits access to methods of the inner iterator via the __call magic method. -
+
&reference.spl.entities.iteratoriterator; diff --git a/reference/spl/multipleiterator/construct.xml b/reference/spl/multipleiterator/construct.xml index 11318f645e7b..fa8c7c403522 100644 --- a/reference/spl/multipleiterator/construct.xml +++ b/reference/spl/multipleiterator/construct.xml @@ -43,10 +43,10 @@
- + &reftitle.examples; - + Iterating a MultipleIterator )]]> - + - + &reftitle.seealso; diff --git a/reference/spl/recursiveiteratoriterator/construct.xml b/reference/spl/recursiveiteratoriterator/construct.xml index b6cfe12c6e36..a53cec538633 100644 --- a/reference/spl/recursiveiteratoriterator/construct.xml +++ b/reference/spl/recursiveiteratoriterator/construct.xml @@ -67,10 +67,10 @@ - + &reftitle.examples; - + Iterating a RecursiveIteratorIterator $leaf) { 0 => Array ]]> - + - +
&reftitle.intro; The Seekable iterator.
-
&reftitle.interfacesynopsis; - SeekableIterator @@ -40,13 +37,12 @@ -
&reftitle.examples; - + Basic usage This example demonstrates creating a custom SeekableIterator, @@ -127,7 +123,7 @@ second element invalid seek position (10) ]]> - +
diff --git a/reference/spl/spldoublylinkedlist/bottom.xml b/reference/spl/spldoublylinkedlist/bottom.xml index 14145936d9f5..30288050d3b8 100644 --- a/reference/spl/spldoublylinkedlist/bottom.xml +++ b/reference/spl/spldoublylinkedlist/bottom.xml @@ -26,12 +26,12 @@
- + &reftitle.errors; Throws RuntimeException when the data-structure is empty. - + + &reftitle.errors; Throws OutOfRangeException when index is out of bounds or when index cannot be parsed as an integer. - + diff --git a/reference/spl/spldoublylinkedlist/offsetset.xml b/reference/spl/spldoublylinkedlist/offsetset.xml index bc5033faa21e..fa3588dd520e 100644 --- a/reference/spl/spldoublylinkedlist/offsetset.xml +++ b/reference/spl/spldoublylinkedlist/offsetset.xml @@ -50,12 +50,12 @@ - + &reftitle.errors; Throws OutOfRangeException when index is out of bounds or when index cannot be parsed as an integer. - + + &reftitle.errors; Throws OutOfRangeException when index is out of bounds or when index cannot be parsed as an integer. - + + &reftitle.errors; Throws RuntimeException when the data-structure is empty. - + + &reftitle.errors; Throws RuntimeException when the data-structure is empty. - + + &reftitle.errors; Throws RuntimeException when the data-structure is empty. - + + &reftitle.errors; Throws DomainException when maxLength is less than zero. - + &reftitle.examples; diff --git a/reference/spl/splfixedarray/offsetget.xml b/reference/spl/splfixedarray/offsetget.xml index 27092a7b66a3..133cd67f6bae 100644 --- a/reference/spl/splfixedarray/offsetget.xml +++ b/reference/spl/splfixedarray/offsetget.xml @@ -40,13 +40,13 @@ - + &reftitle.errors; Throws RuntimeException when index is outside the defined size of the array or when index cannot be parsed as an integer. - + + &reftitle.errors; Throws RuntimeException when index is outside the defined size of the array or when index cannot be parsed as an integer. - + + &reftitle.errors; Throws RuntimeException when index is outside the defined size of the array or when index cannot be parsed as an integer. - + + &reftitle.errors; Throws RuntimeException when the data-structure is empty. - + + &reftitle.errors; Throws RuntimeException when the data-structure is empty. - + + &reftitle.errors; Throws UnexpectedValueException when object could not be found. - + &reftitle.examples; diff --git a/reference/ssh2/functions/ssh2-disconnect.xml b/reference/ssh2/functions/ssh2-disconnect.xml index 3ba1575605ef..71ca2cfcd979 100644 --- a/reference/ssh2/functions/ssh2-disconnect.xml +++ b/reference/ssh2/functions/ssh2-disconnect.xml @@ -1,12 +1,12 @@ - + ssh2_disconnect Close a connection to a remote SSH server - + &reftitle.description; boolssh2_disconnect @@ -15,9 +15,9 @@ Close a connection to a remote SSH server. - + - + &reftitle.parameters; @@ -30,21 +30,21 @@ - + - + &reftitle.returnvalues; &return.success; - + - + &reftitle.seealso; ssh2_connect - + - + ssh2_send_eof Send EOF to stream - + &reftitle.description; boolssh2_send_eof @@ -18,9 +18,9 @@ process some data over standard input, close it to start processing, and still be able to read out the results without creating additional files. - + - + &reftitle.parameters; @@ -33,21 +33,21 @@ - + - + &reftitle.returnvalues; &return.success; - + - + &reftitle.seealso; ssh2_fetch_stream - + - - - - - - - - - diff --git a/reference/stats/functions/stats-cdf-beta.xml b/reference/stats/functions/stats-cdf-beta.xml index b20ecf6bff45..d8164345a93d 100644 --- a/reference/stats/functions/stats-cdf-beta.xml +++ b/reference/stats/functions/stats-cdf-beta.xml @@ -14,12 +14,12 @@ floatpar3 intwhich - + Returns the cumulative distribution function, its inverse, or one of its parameters, of the beta distribution. The kind of the return value and parameters (par1, par2, and par3) are determined by which. - + The following table lists the return value and parameters by which. CDF, x, alpha, and beta denotes cumulative distribution function, the value of the random @@ -77,33 +77,33 @@ par1 - + The first parameter - + par2 - + The second parameter - + par3 - + The third parameter - + which - + The flag to determine what to be calculated - + @@ -112,91 +112,11 @@ &reftitle.returnvalues; - + Returns CDF, x, alpha, or beta, determined by which. - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - &reftitle.returnvalues; - + Returns CDF, x, nu, or mu, determined by which. - + - - - - - - - - &reftitle.returnvalues; - + Returns CDF, x, mu, or sigma, determined by which. - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-dens-beta.xml b/reference/stats/functions/stats-dens-beta.xml index 8df89f19f994..2bf9d9282e0c 100644 --- a/reference/stats/functions/stats-dens-beta.xml +++ b/reference/stats/functions/stats-dens-beta.xml @@ -13,11 +13,11 @@ floata floatb - + Returns the probability density at x, where the random variable follows the beta distribution of which the shape parameters are a and b. - + &reftitle.parameters; @@ -26,25 +26,25 @@ x - + The value at which the probability density is calculated - + a - + The shape parameter of the distribution - + b - + The shape parameter of the distribution - + @@ -53,90 +53,10 @@ &reftitle.returnvalues; - + The probability density at x or &false; for failure. - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-dens-cauchy.xml b/reference/stats/functions/stats-dens-cauchy.xml index 3048d0833ca8..5ef297c17e42 100644 --- a/reference/stats/functions/stats-dens-cauchy.xml +++ b/reference/stats/functions/stats-dens-cauchy.xml @@ -13,11 +13,11 @@ floatave floatstdev - + Returns the probability density at x, where the random variable follows the Cauchy distribution whose location and scale are ave and stdev, respectively. - + &reftitle.parameters; @@ -26,25 +26,25 @@ x - + The value at which the probability density is calculated - + ave - + The location parameter of the distribution - + stdev - + The scale parameter of the distribution - + @@ -53,90 +53,10 @@ &reftitle.returnvalues; - + The probability density at x or &false; for failure. - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-dens-chisquare.xml b/reference/stats/functions/stats-dens-chisquare.xml index 812fb4ad306c..64f22ebee2ec 100644 --- a/reference/stats/functions/stats-dens-chisquare.xml +++ b/reference/stats/functions/stats-dens-chisquare.xml @@ -12,11 +12,11 @@ floatx floatdfr - + Returns the probability density at x, where the random variable follows the chi-square distribution of which the degree of freedom is dfr. - + &reftitle.parameters; @@ -25,17 +25,17 @@ x - + The value at which the probability density is calculated - + dfr - + The degree of freedom of the distribution - + @@ -44,90 +44,10 @@ &reftitle.returnvalues; - + The probability density at x or &false; for failure. - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-dens-exponential.xml b/reference/stats/functions/stats-dens-exponential.xml index dffa0e5e1551..2fa105f17640 100644 --- a/reference/stats/functions/stats-dens-exponential.xml +++ b/reference/stats/functions/stats-dens-exponential.xml @@ -12,11 +12,11 @@ floatx floatscale - + Returns the probability density at x, where the random variable follows the exponential distribution of which the scale is scale. - + &reftitle.parameters; @@ -25,17 +25,17 @@ x - + The value at which the probability density is calculated - + scale - + The scale of the distribution - + @@ -44,90 +44,10 @@ &reftitle.returnvalues; - + The probability density at x or &false; for failure. - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-dens-f.xml b/reference/stats/functions/stats-dens-f.xml index b1eb37800701..3ebdb39326e2 100644 --- a/reference/stats/functions/stats-dens-f.xml +++ b/reference/stats/functions/stats-dens-f.xml @@ -13,11 +13,11 @@ floatdfr1 floatdfr2 - + Returns the probability density at x, where the random variable follows the F distribution of which the degree of freedoms are dfr1 and dfr2. - + &reftitle.parameters; @@ -26,25 +26,25 @@ x - + The value at which the probability density is calculated - + dfr1 - + The degree of freedom of the distribution - + dfr2 - + The degree of freedom of the distribution - + @@ -53,90 +53,10 @@ &reftitle.returnvalues; - + The probability density at x or &false; for failure. - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-dens-gamma.xml b/reference/stats/functions/stats-dens-gamma.xml index 7493ecf7712a..d717d1f1c34c 100644 --- a/reference/stats/functions/stats-dens-gamma.xml +++ b/reference/stats/functions/stats-dens-gamma.xml @@ -13,11 +13,11 @@ floatshape floatscale - + Returns the probability density at x, where the random variable follows the gamma distribution of which the shape parameter is shape and the scale parameter is scale. - + &reftitle.parameters; @@ -26,25 +26,25 @@ x - + The value at which the probability density is calculated - + shape - + The shape parameter of the distribution - + scale - + The scale parameter of the distribution - + @@ -53,90 +53,10 @@ &reftitle.returnvalues; - + The probability density at x or &false; for failure. - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-dens-laplace.xml b/reference/stats/functions/stats-dens-laplace.xml index e2443edb8456..4e1f202dc2e7 100644 --- a/reference/stats/functions/stats-dens-laplace.xml +++ b/reference/stats/functions/stats-dens-laplace.xml @@ -13,11 +13,11 @@ floatave floatstdev - + Returns the probability density at x, where the random variable follows the Laplace distribution of which the location parameter is ave and the scale parameter is stdev. - + &reftitle.parameters; @@ -26,25 +26,25 @@ x - + The value at which the probability density is calculated - + ave - + The location parameter of the distribution - + stdev - + The shape parameter of the distribution - + @@ -53,90 +53,10 @@ &reftitle.returnvalues; - + The probability density at x or &false; for failure. - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-dens-logistic.xml b/reference/stats/functions/stats-dens-logistic.xml index 1b0959644f5c..ebad13484923 100644 --- a/reference/stats/functions/stats-dens-logistic.xml +++ b/reference/stats/functions/stats-dens-logistic.xml @@ -13,11 +13,11 @@ floatave floatstdev - + Returns the probability density at x, where the random variable follows the logistic distribution of which the location parameter is ave and the scale parameter is stdev. - + &reftitle.parameters; @@ -26,25 +26,25 @@ x - + The value at which the probability density is calculated - + ave - + The location parameter of the distribution - + stdev - + The shape parameter of the distribution - + @@ -53,90 +53,10 @@ &reftitle.returnvalues; - + The probability density at x or &false; for failure. - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-dens-normal.xml b/reference/stats/functions/stats-dens-normal.xml index 8053d8e3fa75..1f4b17eace1e 100644 --- a/reference/stats/functions/stats-dens-normal.xml +++ b/reference/stats/functions/stats-dens-normal.xml @@ -13,12 +13,12 @@ floatave floatstdev - + Returns the probability density at x, where the random variable follows the normal distribution of which the mean is ave and the standard deviation is stdev. - + &reftitle.parameters; @@ -27,25 +27,25 @@ x - + The value at which the probability density is calculated - + ave - + The mean of the distribution - + stdev - + The standard deviation of the distribution - + @@ -54,90 +54,10 @@ &reftitle.returnvalues; - + The probability density at x or &false; for failure. - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-dens-pmf-binomial.xml b/reference/stats/functions/stats-dens-pmf-binomial.xml index 3f6422c6da44..3dfb01c8fb9c 100644 --- a/reference/stats/functions/stats-dens-pmf-binomial.xml +++ b/reference/stats/functions/stats-dens-pmf-binomial.xml @@ -13,11 +13,11 @@ floatn floatpi - + Returns the probability mass at x, where the random variable follows the binomial distribution of which the number of trials is n and the success rate is pi. - + &reftitle.parameters; @@ -26,25 +26,25 @@ x - + The value at which the probability mass is calculated - + n - + The number of trials of the distribution - + pi - + The success rate of the distribution - + @@ -53,90 +53,10 @@ &reftitle.returnvalues; - + The probability mass at x or &false; for failure. - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-dens-pmf-hypergeometric.xml b/reference/stats/functions/stats-dens-pmf-hypergeometric.xml index 26867dbac0ae..44277e635bdc 100644 --- a/reference/stats/functions/stats-dens-pmf-hypergeometric.xml +++ b/reference/stats/functions/stats-dens-pmf-hypergeometric.xml @@ -14,12 +14,12 @@ floatN1 floatN2 - + Returns the probability mass at n1, where the random variable follows the hypergeometric distribution of which the number of failure is n2, the number of success samples is N1, and the number of failure samples is N2. - + &reftitle.parameters; @@ -28,33 +28,33 @@ n1 - + The number of success, at which the probability mass is calculated - + n2 - + The number of failure of the distribution - + N1 - + The number of success samples of the distribution - + N2 - + The number of failure samples of the distribution - + @@ -63,90 +63,10 @@ &reftitle.returnvalues; - + The probability mass at n1 or &false; for failure. - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-dens-pmf-negative-binomial.xml b/reference/stats/functions/stats-dens-pmf-negative-binomial.xml index 80e1c5c58119..06a0203e19d3 100644 --- a/reference/stats/functions/stats-dens-pmf-negative-binomial.xml +++ b/reference/stats/functions/stats-dens-pmf-negative-binomial.xml @@ -15,12 +15,12 @@ floatn floatpi - + Returns the probability mass at x, where the random variable follows the negative binomial distribution of which the number of the success is n and the success rate is pi. - + @@ -30,25 +30,25 @@ x - + The value at which the probability mass is calculated - + n - + The number of the success of the distribution - + pi - + The success rate of the distribution - + @@ -57,86 +57,10 @@ &reftitle.returnvalues; - + The probability mass at x or &false; for failure. - - - - - - - - - - diff --git a/reference/stats/functions/stats-dens-pmf-poisson.xml b/reference/stats/functions/stats-dens-pmf-poisson.xml index 633aee3c8ff0..edd15cf62c40 100644 --- a/reference/stats/functions/stats-dens-pmf-poisson.xml +++ b/reference/stats/functions/stats-dens-pmf-poisson.xml @@ -12,10 +12,10 @@ floatx floatlb - + Returns the probability mass at x, where the random variable follows the Poisson distribution whose parameter is lb. - + &reftitle.parameters; @@ -24,17 +24,17 @@ x - + The value at which the probability mass is calculated - + lb - + The parameter of the Poisson distribution - + @@ -43,90 +43,10 @@ &reftitle.returnvalues; - + The probability mass at x or &false; for failure. - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-dens-t.xml b/reference/stats/functions/stats-dens-t.xml index 1f5415b7e6f8..edba7c80c5bc 100644 --- a/reference/stats/functions/stats-dens-t.xml +++ b/reference/stats/functions/stats-dens-t.xml @@ -12,11 +12,11 @@ floatx floatdfr - + Returns the probability density at x, where the random variable follows the t-distribution of which the degree of freedom is dfr. - + &reftitle.parameters; @@ -25,17 +25,17 @@ x - + The value at which the probability density is calculated - + dfr - + The degree of freedom of the distribution - + @@ -44,90 +44,10 @@ &reftitle.returnvalues; - + The probability density at x or &false; for failure. - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-dens-uniform.xml b/reference/stats/functions/stats-dens-uniform.xml index 27aabb0943cf..aa8c144ebb39 100644 --- a/reference/stats/functions/stats-dens-uniform.xml +++ b/reference/stats/functions/stats-dens-uniform.xml @@ -15,11 +15,11 @@ floata floatb - + Returns the probability density at x, where the random variable follows the uniform distribution of which the lower bound is a and the upper bound is b. - + @@ -29,25 +29,25 @@ x - + The value at which the probability density is calculated - + a - + The lower bound of the distribution - + b - + The upper bound of the distribution - + @@ -56,86 +56,10 @@ &reftitle.returnvalues; - + The probability density at x or &false; for failure. - - - - - - - - - - diff --git a/reference/stats/functions/stats-dens-weibull.xml b/reference/stats/functions/stats-dens-weibull.xml index d71b612d1b55..54077e2c10f9 100644 --- a/reference/stats/functions/stats-dens-weibull.xml +++ b/reference/stats/functions/stats-dens-weibull.xml @@ -13,11 +13,11 @@ floata floatb - + Returns the probability density at x, where the random variable follows the Weibull distribution of which the shape parameter is a and the scale parameter is b. - + &reftitle.parameters; @@ -26,25 +26,25 @@ x - + The value at which the probability density is calculated - + a - + The shape parameter of the distribution - + b - + The scale parameter of the distribution - + @@ -53,90 +53,10 @@ &reftitle.returnvalues; - + The probability density at x or &false; for failure. - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-harmonic-mean.xml b/reference/stats/functions/stats-harmonic-mean.xml index 1327fbd1973f..8a10d56dd2cc 100644 --- a/reference/stats/functions/stats-harmonic-mean.xml +++ b/reference/stats/functions/stats-harmonic-mean.xml @@ -11,9 +11,9 @@ numberstats_harmonic_mean arraya - + Returns the harmonic mean of the values in a. - + &reftitle.parameters; @@ -22,9 +22,9 @@ a - + The input array - + @@ -33,91 +33,11 @@ &reftitle.returnvalues; - + Returns the harmonic mean of the values in a, or &false; if a is empty or is not an array. - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-kurtosis.xml b/reference/stats/functions/stats-kurtosis.xml index 47b7d4265440..d7c43760d30f 100644 --- a/reference/stats/functions/stats-kurtosis.xml +++ b/reference/stats/functions/stats-kurtosis.xml @@ -11,9 +11,9 @@ floatstats_kurtosis arraya - + Returns the kurtosis of the values in a. - + &reftitle.parameters; @@ -22,9 +22,9 @@ a - + The input array - + @@ -33,91 +33,11 @@ &reftitle.returnvalues; - + Returns the kurtosis of the values in a, or &false; if a is empty or is not an array. - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-beta.xml b/reference/stats/functions/stats-rand-gen-beta.xml index 5d5405b65319..09de6e26ea32 100644 --- a/reference/stats/functions/stats-rand-gen-beta.xml +++ b/reference/stats/functions/stats-rand-gen-beta.xml @@ -12,11 +12,11 @@ floata floatb - + Returns a random deviate from the beta distribution with parameters A and B. The density of the beta is x^(a-1) * (1-x)^(b-1) / B(a,b) for 0 < x <. Method R. C. H. Cheng. - + @@ -26,17 +26,17 @@ a - + The shape parameter of the beta distribution - + b - + The shape parameter of the beta distribution - + @@ -45,90 +45,10 @@ &reftitle.returnvalues; - + A random deviate - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-chisquare.xml b/reference/stats/functions/stats-rand-gen-chisquare.xml index 372b57b7a548..6d6645e0a922 100644 --- a/reference/stats/functions/stats-rand-gen-chisquare.xml +++ b/reference/stats/functions/stats-rand-gen-chisquare.xml @@ -11,10 +11,10 @@ floatstats_rand_gen_chisquare floatdf - + Returns a random deviate from the chi-square distribution where the degrees of freedom is df. - + &reftitle.parameters; @@ -23,9 +23,9 @@ df - + The degrees of freedom - + @@ -34,90 +34,10 @@ &reftitle.returnvalues; - + A random deviate - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-exponential.xml b/reference/stats/functions/stats-rand-gen-exponential.xml index 88d58536cdae..c86e6fdc2c3a 100644 --- a/reference/stats/functions/stats-rand-gen-exponential.xml +++ b/reference/stats/functions/stats-rand-gen-exponential.xml @@ -11,10 +11,10 @@ floatstats_rand_gen_exponential floatav - + Returns a random deviate from the exponential distribution of which the scale is av. - + &reftitle.parameters; @@ -23,9 +23,9 @@ av - + The scale parameter - + @@ -34,90 +34,10 @@ &reftitle.returnvalues; - + A random deviate - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-f.xml b/reference/stats/functions/stats-rand-gen-f.xml index 0574db6aae45..e55ba3e1fcce 100644 --- a/reference/stats/functions/stats-rand-gen-f.xml +++ b/reference/stats/functions/stats-rand-gen-f.xml @@ -12,11 +12,11 @@ floatdfn floatdfd - - Generates a random deviate from the F (variance ratio) distribution with - "dfn" degrees of freedom in the numerator and "dfd" degrees of freedom in + + Generates a random deviate from the F (variance ratio) distribution with + "dfn" degrees of freedom in the numerator and "dfd" degrees of freedom in the denominator. Method : directly generates ratio of chisquare variates. - + &reftitle.parameters; @@ -49,86 +49,6 @@ - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-gamma.xml b/reference/stats/functions/stats-rand-gen-gamma.xml index 85523b087dcb..e7dd1f1a3f42 100644 --- a/reference/stats/functions/stats-rand-gen-gamma.xml +++ b/reference/stats/functions/stats-rand-gen-gamma.xml @@ -13,10 +13,10 @@ floata floatr - + Generates a random deviate from the gamma distribution whose density is (A**R)/Gamma(R) * X**(R-1) * Exp(-A*X). - + @@ -26,19 +26,19 @@ a - + location parameter of Gamma distribution (a > 0). - + r - + shape parameter of Gamma distribution (r > 0). - + @@ -46,90 +46,10 @@ &reftitle.returnvalues; - + A random deviate - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-ibinomial-negative.xml b/reference/stats/functions/stats-rand-gen-ibinomial-negative.xml index ac7edfee03ee..37ab921ffaca 100644 --- a/reference/stats/functions/stats-rand-gen-ibinomial-negative.xml +++ b/reference/stats/functions/stats-rand-gen-ibinomial-negative.xml @@ -12,10 +12,10 @@ intn floatp - + Returns a random deviate from a negative binomial distribution where the number of success is n and the success rate is p. - + &reftitle.parameters; @@ -24,17 +24,17 @@ n - + The number of success - + p - + The success rate - + @@ -43,90 +43,10 @@ &reftitle.returnvalues; - + A random deviate, which is the number of failure. - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-ibinomial.xml b/reference/stats/functions/stats-rand-gen-ibinomial.xml index 348d4e933864..434d1900f704 100644 --- a/reference/stats/functions/stats-rand-gen-ibinomial.xml +++ b/reference/stats/functions/stats-rand-gen-ibinomial.xml @@ -12,10 +12,10 @@ intn floatpp - + Returns a random deviate from the binomial distribution whose number of trials is n and whose probability of an event in each trial is pp. - + &reftitle.parameters; @@ -24,17 +24,17 @@ n - + The number of trials - + pp - + The probability of an event in each trial - + @@ -43,90 +43,10 @@ &reftitle.returnvalues; - + A random deviate - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-int.xml b/reference/stats/functions/stats-rand-gen-int.xml index a6dbe2434b54..5988ce16caa7 100644 --- a/reference/stats/functions/stats-rand-gen-int.xml +++ b/reference/stats/functions/stats-rand-gen-int.xml @@ -11,9 +11,9 @@ intstats_rand_gen_int - + Returns a random integer between 1 and 2147483562 - + @@ -23,91 +23,11 @@ &reftitle.returnvalues; - + A random integer - + - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-iuniform.xml b/reference/stats/functions/stats-rand-gen-iuniform.xml index b676c1196f11..3c62d01446b6 100644 --- a/reference/stats/functions/stats-rand-gen-iuniform.xml +++ b/reference/stats/functions/stats-rand-gen-iuniform.xml @@ -12,10 +12,10 @@ intlow inthigh - + Returns a random integer from the discrete uniform distribution between low (inclusive) and high (inclusive). - + &reftitle.parameters; @@ -24,17 +24,17 @@ low - + The lower bound - + high - + The upper bound - + @@ -43,90 +43,10 @@ &reftitle.returnvalues; - + A random integer - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-noncentral-chisquare.xml b/reference/stats/functions/stats-rand-gen-noncentral-chisquare.xml index a9ef7c83da89..f48e065b1263 100644 --- a/reference/stats/functions/stats-rand-gen-noncentral-chisquare.xml +++ b/reference/stats/functions/stats-rand-gen-noncentral-chisquare.xml @@ -14,10 +14,10 @@ floatdf floatxnonc - + Returns a random deviate from the non-central chi-square distribution with degrees of freedom, df, and non-centrality parameter, xnonc. - + @@ -27,17 +27,17 @@ df - + The degrees of freedom - + xnonc - + The non-centrality parameter - + @@ -46,86 +46,10 @@ &reftitle.returnvalues; - + A random deviate - - - - - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-noncentral-f.xml b/reference/stats/functions/stats-rand-gen-noncentral-f.xml index de5e2cc63291..effe10ef6ff9 100644 --- a/reference/stats/functions/stats-rand-gen-noncentral-f.xml +++ b/reference/stats/functions/stats-rand-gen-noncentral-f.xml @@ -13,11 +13,11 @@ floatdfd floatxnonc - + Returns a random deviate from the non-central F distribution where the degrees of freedoms are dfn (numerator) and dfd (denominator), and the non-centrality parameter is xnonc. - + &reftitle.parameters; @@ -26,25 +26,25 @@ dfn - + The degrees of freedom of the numerator - + dfd - + The degrees of freedom of the denominator - + xnonc - + The non-centrality parameter - + @@ -53,90 +53,10 @@ &reftitle.returnvalues; - + A random deviate - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-noncentral-t.xml b/reference/stats/functions/stats-rand-gen-noncentral-t.xml index ede7d12f2b8d..e70ca0edf707 100644 --- a/reference/stats/functions/stats-rand-gen-noncentral-t.xml +++ b/reference/stats/functions/stats-rand-gen-noncentral-t.xml @@ -12,10 +12,10 @@ floatdf floatxnonc - + Returns a random deviate from the non-central t-distribution with the degrees of freedom, df, and the non-centrality parameter, xnonc. - + &reftitle.parameters; @@ -24,17 +24,17 @@ df - + The degrees of freedom - + xnonc - + The non-centrality parameter - + @@ -43,90 +43,10 @@ &reftitle.returnvalues; - + A random deviate - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-normal.xml b/reference/stats/functions/stats-rand-gen-normal.xml index 5853e8ec6cc8..1ea6d90fd44c 100644 --- a/reference/stats/functions/stats-rand-gen-normal.xml +++ b/reference/stats/functions/stats-rand-gen-normal.xml @@ -12,10 +12,10 @@ floatav floatsd - + Returns a random deviate from the normal distribution with mean, av, and standard deviation, sd. - + &reftitle.parameters; @@ -24,17 +24,17 @@ av - + The mean of the normal distribution - + sd - + The standard deviation of the normal distribution - + @@ -43,90 +43,10 @@ &reftitle.returnvalues; - + A random deviate - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-t.xml b/reference/stats/functions/stats-rand-gen-t.xml index 3294ece5f8a3..490239342e01 100644 --- a/reference/stats/functions/stats-rand-gen-t.xml +++ b/reference/stats/functions/stats-rand-gen-t.xml @@ -11,9 +11,9 @@ floatstats_rand_gen_t floatdf - + Returns a random deviate from the t-distribution with the degrees of freedom, df. - + &reftitle.parameters; @@ -22,9 +22,9 @@ df - + The degrees of freedom - + @@ -33,90 +33,10 @@ &reftitle.returnvalues; - + A random deviate - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-rand-get-seeds.xml b/reference/stats/functions/stats-rand-get-seeds.xml index 9713f307ca6d..414e4568f99e 100644 --- a/reference/stats/functions/stats-rand-get-seeds.xml +++ b/reference/stats/functions/stats-rand-get-seeds.xml @@ -11,9 +11,9 @@ arraystats_rand_get_seeds - + Returns the current seed values of the random number generator - + @@ -23,91 +23,11 @@ &reftitle.returnvalues; - + Returns an array of two integers. - + - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-rand-ranf.xml b/reference/stats/functions/stats-rand-ranf.xml index 116ff2894337..c59eb209b73e 100644 --- a/reference/stats/functions/stats-rand-ranf.xml +++ b/reference/stats/functions/stats-rand-ranf.xml @@ -11,9 +11,9 @@ floatstats_rand_ranf - + Returns a random floating point number from a uniform distribution between 0 (exclusive) and 1 (exclusive). - + @@ -23,91 +23,11 @@ &reftitle.returnvalues; - + A random floating point number - + - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-skew.xml b/reference/stats/functions/stats-skew.xml index 2180f4b2ef8b..dea1100bef6a 100644 --- a/reference/stats/functions/stats-skew.xml +++ b/reference/stats/functions/stats-skew.xml @@ -12,9 +12,9 @@ floatstats_skew arraya - + Returns the skewness of the values in a. - + &reftitle.parameters; @@ -23,9 +23,9 @@ a - + The input array - + @@ -34,91 +34,11 @@ &reftitle.returnvalues; - + Returns the skewness of the values in a, or &false; if a is empty or is not an array. - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-standard-deviation.xml b/reference/stats/functions/stats-standard-deviation.xml index f58c68a05cdc..3ffa3ad8c6a9 100644 --- a/reference/stats/functions/stats-standard-deviation.xml +++ b/reference/stats/functions/stats-standard-deviation.xml @@ -23,19 +23,19 @@ a - - The array of data to find the standard deviation for. Note that all + + The array of data to find the standard deviation for. Note that all values of the array will be cast to float. - + sample - - Indicates if a represents a sample of the + + Indicates if a represents a sample of the population; defaults to &false;. - + @@ -51,82 +51,12 @@ &reftitle.errors; - - Raises an E_WARNING when there are fewer than 2 + + Raises an E_WARNING when there are fewer than 2 values in a. - + - - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-stat-correlation.xml b/reference/stats/functions/stats-stat-correlation.xml index 20bbf43c9fc9..3fa8c140624b 100644 --- a/reference/stats/functions/stats-stat-correlation.xml +++ b/reference/stats/functions/stats-stat-correlation.xml @@ -12,9 +12,9 @@ arrayarr1 arrayarr2 - + Returns the Pearson correlation coefficient between arr1 and arr2. - + &reftitle.parameters; @@ -23,17 +23,17 @@ arr1 - + The first array - + arr2 - + The second array - + @@ -42,91 +42,11 @@ &reftitle.returnvalues; - + Returns the Pearson correlation coefficient between arr1 and arr2, or &false; on failure. - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-stat-factorial.xml b/reference/stats/functions/stats-stat-factorial.xml index f3bb459a1863..27b5ded36329 100644 --- a/reference/stats/functions/stats-stat-factorial.xml +++ b/reference/stats/functions/stats-stat-factorial.xml @@ -13,9 +13,9 @@ floatstats_stat_factorial intn - + Returns the factorial of an integer, n. - + @@ -24,9 +24,9 @@ n - + An integer - + @@ -34,87 +34,11 @@ &reftitle.returnvalues; - + The factorial of n. - + - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-stat-innerproduct.xml b/reference/stats/functions/stats-stat-innerproduct.xml index cbfe91f099c8..14c4323a0d1a 100644 --- a/reference/stats/functions/stats-stat-innerproduct.xml +++ b/reference/stats/functions/stats-stat-innerproduct.xml @@ -12,9 +12,9 @@ arrayarr1 arrayarr2 - + Returns the inner product of arr1 and arr2. - + &reftitle.parameters; @@ -23,17 +23,17 @@ arr1 - + The first array - + arr2 - + The second array - + @@ -42,91 +42,11 @@ &reftitle.returnvalues; - + Returns the inner product of arr1 and arr2, or &false; on failure. - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-stat-paired-t.xml b/reference/stats/functions/stats-stat-paired-t.xml index b4a0e028732d..f8b6c597c924 100644 --- a/reference/stats/functions/stats-stat-paired-t.xml +++ b/reference/stats/functions/stats-stat-paired-t.xml @@ -12,10 +12,10 @@ arrayarr1 arrayarr2 - + Returns the t-value of the dependent t-test for paired samples arr1 and arr2. - + &reftitle.parameters; @@ -24,17 +24,17 @@ arr1 - + The first samples - + arr2 - + The second samples - + @@ -43,90 +43,10 @@ &reftitle.returnvalues; - + Returns the t-value, or &false; if failure. - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-stat-percentile.xml b/reference/stats/functions/stats-stat-percentile.xml index 35901a186d39..b44d7774e2da 100644 --- a/reference/stats/functions/stats-stat-percentile.xml +++ b/reference/stats/functions/stats-stat-percentile.xml @@ -12,9 +12,9 @@ arrayarr floatperc - + Returns the perc-th percentile value of the array arr. - + &reftitle.parameters; @@ -23,17 +23,17 @@ arr - + The input array - + perc - + The percentile - + @@ -42,90 +42,10 @@ &reftitle.returnvalues; - + Returns the percentile values of the input array. - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-stat-powersum.xml b/reference/stats/functions/stats-stat-powersum.xml index 29f1d83a5a34..60cd6e3582e4 100644 --- a/reference/stats/functions/stats-stat-powersum.xml +++ b/reference/stats/functions/stats-stat-powersum.xml @@ -12,9 +12,9 @@ arrayarr floatpower - + Returns the sum of the power-th power of a vector represented as an array arr. - + &reftitle.parameters; @@ -23,17 +23,17 @@ arr - + The input array - + power - + The power - + @@ -42,90 +42,10 @@ &reftitle.returnvalues; - + Returns the power sum of the input array. - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-variance.xml b/reference/stats/functions/stats-variance.xml index 8d28e43b1b30..0b711ae389fa 100644 --- a/reference/stats/functions/stats-variance.xml +++ b/reference/stats/functions/stats-variance.xml @@ -23,19 +23,19 @@ a - - The array of data to find the standard deviation for. Note that all + + The array of data to find the standard deviation for. Note that all values of the array will be cast to float. - + sample - - Indicates if a represents a sample of the + + Indicates if a represents a sample of the population; defaults to &false;. - + @@ -49,86 +49,6 @@ - - - - - - - - - - - -
&reftitle.intro; @@ -33,22 +32,19 @@ tries to access the protocol it is associated with.
-
&reftitle.classsynopsis; - streamWrapper - streamWrapper - + &Properties; public @@ -62,12 +58,10 @@ -
-
&reftitle.properties; @@ -92,9 +86,8 @@
- -
+
&reftitle.seealso; @@ -104,7 +97,7 @@ stream_wrapper_restore -
+
diff --git a/reference/svn/functions/svn-add.xml b/reference/svn/functions/svn-add.xml index 504c741d8ecd..99a6b4b5e51b 100644 --- a/reference/svn/functions/svn-add.xml +++ b/reference/svn/functions/svn-add.xml @@ -1,6 +1,6 @@ - + svn_add Schedules the addition of an item in a working directory @@ -63,39 +63,6 @@ - - - - &reftitle.examples; diff --git a/reference/svn/functions/svn-auth-get-parameter.xml b/reference/svn/functions/svn-auth-get-parameter.xml index 91e0095a8cc8..61eeef93613b 100644 --- a/reference/svn/functions/svn-auth-get-parameter.xml +++ b/reference/svn/functions/svn-auth-get-parameter.xml @@ -1,6 +1,6 @@ - + svn_auth_get_parameter Retrieves authentication parameter @@ -47,70 +47,6 @@ &warn.experimental.func; - - - - - - &reftitle.seealso; diff --git a/reference/svn/functions/svn-auth-set-parameter.xml b/reference/svn/functions/svn-auth-set-parameter.xml index 12a36efd7056..17146f20bcb3 100644 --- a/reference/svn/functions/svn-auth-set-parameter.xml +++ b/reference/svn/functions/svn-auth-set-parameter.xml @@ -1,6 +1,6 @@ - + svn_auth_set_parameter Sets an authentication parameter @@ -51,39 +51,6 @@ - - - - &reftitle.examples; diff --git a/reference/svn/functions/svn-cat.xml b/reference/svn/functions/svn-cat.xml index 21dc8f1506d7..8233a1f2a0af 100644 --- a/reference/svn/functions/svn-cat.xml +++ b/reference/svn/functions/svn-cat.xml @@ -1,6 +1,6 @@ - + svn_cat Returns the contents of a file in a repository @@ -51,39 +51,6 @@ - - - - &reftitle.examples; diff --git a/reference/svn/functions/svn-checkout.xml b/reference/svn/functions/svn-checkout.xml index 64360d1b0909..0344e74149e8 100644 --- a/reference/svn/functions/svn-checkout.xml +++ b/reference/svn/functions/svn-checkout.xml @@ -1,6 +1,6 @@ - + svn_checkout Checks out a working copy from the repository @@ -69,39 +69,6 @@ - - - - &reftitle.examples; diff --git a/reference/svn/functions/svn-cleanup.xml b/reference/svn/functions/svn-cleanup.xml index 3eb146332dcf..914a1d52917f 100644 --- a/reference/svn/functions/svn-cleanup.xml +++ b/reference/svn/functions/svn-cleanup.xml @@ -1,6 +1,6 @@ - + svn_cleanup Recursively cleanup a working copy directory, finishing incomplete operations and removing locks @@ -41,39 +41,6 @@ - - - - &reftitle.examples; diff --git a/reference/svn/functions/svn-client-version.xml b/reference/svn/functions/svn-client-version.xml index a9cf345ef40f..3e7067324d23 100644 --- a/reference/svn/functions/svn-client-version.xml +++ b/reference/svn/functions/svn-client-version.xml @@ -1,6 +1,6 @@ - + svn_client_version Returns the version of the SVN client libraries @@ -29,39 +29,6 @@ - - - - &reftitle.examples; @@ -87,18 +54,6 @@ echo svn_client_version(); &warn.experimental.func; - - - + svn_commit Sends changes from the local working copy to the repository @@ -87,39 +87,6 @@ array( - - - - &reftitle.examples; diff --git a/reference/svn/functions/svn-diff.xml b/reference/svn/functions/svn-diff.xml index 926ddb1fbca2..bdb3d2513c2e 100644 --- a/reference/svn/functions/svn-diff.xml +++ b/reference/svn/functions/svn-diff.xml @@ -1,6 +1,6 @@ - + svn_diff Recursively diffs two paths @@ -94,39 +94,6 @@ - - - - &reftitle.examples; diff --git a/reference/svn/functions/svn-fs-abort-txn.xml b/reference/svn/functions/svn-fs-abort-txn.xml index 02b20c5dcf8f..caf7cc3747ab 100644 --- a/reference/svn/functions/svn-fs-abort-txn.xml +++ b/reference/svn/functions/svn-fs-abort-txn.xml @@ -1,6 +1,6 @@ - + svn_fs_abort_txn Aborts a transaction @@ -44,82 +44,6 @@ &warn.experimental.func; - - - - - - - - - + svn_fs_apply_text Creates and returns a stream that will be used to replace the contents of a file @@ -18,120 +18,12 @@ Creates and returns a stream that will be used to replace the contents of a file. - &reftitle.notes; &warn.experimental.func; - - - - - - - - - + svn_fs_begin_txn2 Create a new transaction @@ -18,120 +18,12 @@ Create a new transaction - &reftitle.notes; &warn.experimental.func; - - - - - - - - - + svn_fs_change_node_prop Return true if everything is ok, false otherwise @@ -20,136 +20,12 @@ Return true if everything is ok, false otherwise - &reftitle.notes; &warn.experimental.func; - - - - - - - - - + svn_fs_check_path Determines what kind of item lives at path in a given repository fsroot @@ -18,120 +18,12 @@ Determines what kind of item lives at path in a given repository fsroot - &reftitle.notes; &warn.experimental.func; - - - - - - - - - + svn_fs_contents_changed Return true if content is different, false otherwise @@ -20,136 +20,12 @@ Return true if content is different, false otherwise - &reftitle.notes; &warn.experimental.func; - - - - - - - - - + svn_fs_copy Copies a file or a directory @@ -71,82 +71,6 @@ &warn.experimental.func; - - - - - - - - - + svn_fs_delete Deletes a file or a directory @@ -53,82 +53,6 @@ &warn.experimental.func; - - - - - - - - - + svn_fs_dir_entries Enumerates the directory entries under path; returns a hash of dir names to file type @@ -18,120 +18,12 @@ Enumerates the directory entries under path; returns a hash of dir names to file type - &reftitle.notes; &warn.experimental.func; - - - - - - - - - + svn_fs_file_contents Returns a stream to access the contents of a file from a given version of the fs @@ -18,120 +18,12 @@ Returns a stream to access the contents of a file from a given version of the fs - &reftitle.notes; &warn.experimental.func; - - - - - - - - - + svn_fs_file_length Returns the length of a file from a given version of the fs @@ -18,120 +18,12 @@ Returns the length of a file from a given version of the fs - &reftitle.notes; &warn.experimental.func; - - - - - - - - - + svn_fs_is_dir Determines if a path points to a directory @@ -53,82 +53,6 @@ &warn.experimental.func; - - - - - - - - - + svn_fs_is_file Determines if a path points to a file @@ -53,82 +53,6 @@ &warn.experimental.func; - - - - - - - - - + svn_fs_make_dir Creates a new empty directory @@ -53,82 +53,6 @@ &warn.experimental.func; - - - - - - - - - + svn_fs_make_file Creates a new empty file @@ -53,82 +53,6 @@ &warn.experimental.func; - - - - - - - - - + svn_fs_node_created_rev Returns the revision in which path under fsroot was created @@ -18,120 +18,12 @@ Returns the revision in which path under fsroot was created - &reftitle.notes; &warn.experimental.func; - - - - - - - - - + svn_fs_node_prop Returns the value of a property for a node @@ -19,128 +19,12 @@ Returns the value of a property for a node - &reftitle.notes; &warn.experimental.func; - - - - - - - - - + svn_fs_props_changed Return true if props are different, false otherwise @@ -20,136 +20,12 @@ Return true if props are different, false otherwise - &reftitle.notes; &warn.experimental.func; - - - - - - - - - + svn_fs_revision_prop Fetches the value of a named property @@ -19,128 +19,12 @@ Fetches the value of a named property - &reftitle.notes; &warn.experimental.func; - - - - - - - - - + svn_fs_revision_root Get a handle on a specific version of the repository root @@ -18,120 +18,12 @@ Get a handle on a specific version of the repository root - &reftitle.notes; &warn.experimental.func; - - - - - - - - - + svn_fs_txn_root Creates and returns a transaction root @@ -17,112 +17,12 @@ Creates and returns a transaction root - &reftitle.notes; &warn.experimental.func; - - - - - - - - - + svn_fs_youngest_rev Returns the number of the youngest revision in the filesystem @@ -17,112 +17,12 @@ Returns the number of the youngest revision in the filesystem - &reftitle.notes; &warn.experimental.func; - - - - - - - - - + svn_import Imports an unversioned path into a repository @@ -60,39 +60,6 @@ - - - - &reftitle.examples; diff --git a/reference/svn/functions/svn-log.xml b/reference/svn/functions/svn-log.xml index 5fe13812eb34..6c4787e0980e 100644 --- a/reference/svn/functions/svn-log.xml +++ b/reference/svn/functions/svn-log.xml @@ -1,6 +1,6 @@ - + svn_log Returns the commit log messages of a repository URL @@ -148,39 +148,6 @@ - - - - &reftitle.examples; diff --git a/reference/svn/functions/svn-repos-create.xml b/reference/svn/functions/svn-repos-create.xml index a24ac5c6ed6c..e348d9ee7f85 100644 --- a/reference/svn/functions/svn-repos-create.xml +++ b/reference/svn/functions/svn-repos-create.xml @@ -1,6 +1,6 @@ - + svn_repos_create Create a new subversion repository at path @@ -19,128 +19,12 @@ Create a new subversion repository at path - &reftitle.notes; &warn.experimental.func; - - - - - - - - - + svn_repos_fs_begin_txn_for_commit Create a new transaction @@ -20,136 +20,12 @@ Create a new transaction - &reftitle.notes; &warn.experimental.func; - - - - - - - - - + svn_repos_fs_commit_txn Commits a transaction and returns the new revision @@ -17,112 +17,12 @@ Commits a transaction and returns the new revision - &reftitle.notes; &warn.experimental.func; - - - - - - - - - + svn_repos_fs Gets a handle on the filesystem for a repository @@ -17,112 +17,12 @@ Gets a handle on the filesystem for a repository - &reftitle.notes; &warn.experimental.func; - - - - - - - - - + svn_repos_hotcopy Make a hot-copy of the repos at repospath; copy it to destpath @@ -19,129 +19,12 @@ Make a hot-copy of the repos at repospath; copy it to destpath - &reftitle.notes; &warn.experimental.func; - - - - - - - - - + svn_repos_open Open a shared lock on a repository @@ -17,112 +17,12 @@ Open a shared lock on a repository. - &reftitle.notes; &warn.experimental.func; - - - - - - - - - + svn_repos_recover Run recovery procedures on the repository located at path @@ -17,112 +17,12 @@ Run recovery procedures on the repository located at path. - &reftitle.notes; &warn.experimental.func; - - - - - - - - - + svn_status Returns the status of working copy files and directories @@ -285,39 +285,6 @@ if (!defined('svn_wc_schedule_normal')) { - - - - &reftitle.examples; diff --git a/reference/svn/functions/svn-update.xml b/reference/svn/functions/svn-update.xml index cf9a794f2813..a99a586bc9b3 100644 --- a/reference/svn/functions/svn-update.xml +++ b/reference/svn/functions/svn-update.xml @@ -1,6 +1,6 @@ - + svn_update Update working copy @@ -59,39 +59,6 @@ - - - - &reftitle.examples; diff --git a/reference/uopz/functions/uopz-allow-exit.xml b/reference/uopz/functions/uopz-allow-exit.xml index 18b9e365b187..563f78d5492c 100644 --- a/reference/uopz/functions/uopz-allow-exit.xml +++ b/reference/uopz/functions/uopz-allow-exit.xml @@ -7,7 +7,7 @@ Allows control over disabled exit opcode - + &reftitle.description; voiduopz_allow_exit @@ -18,9 +18,9 @@ are practically ignored. uopz_allow_exit allows to control this behavior. - + - + &reftitle.parameters; @@ -32,18 +32,18 @@ - + - + &reftitle.returnvalues; &return.void; - + - + &reftitle.examples; - + <function>uopz_allow_exit</function> example - - + + - + &reftitle.notes; OPcache optimizes away dead code after unconditional exit. - + &reftitle.seealso; uopz_get_exit_status - + diff --git a/reference/uopz/functions/uopz-get-mock.xml b/reference/uopz/functions/uopz-get-mock.xml index d881dd1e517c..acc6abbb8610 100644 --- a/reference/uopz/functions/uopz-get-mock.xml +++ b/reference/uopz/functions/uopz-get-mock.xml @@ -72,13 +72,13 @@ mockA - + &reftitle.seealso; uopz_set_mock uopz_unset_mock - +