diff --git a/entities/entities.manual.ent b/entities/entities.manual.ent index a08e72eb0..32e1fe0ca 100644 --- a/entities/entities.manual.ent +++ b/entities/entities.manual.ent @@ -13,6 +13,10 @@ URLs rather than linkends. Any links to other manual books should live here. xmlns:xlink = "http://www.w3.org/1999/xlink" translate = "yes"> +&url.php.manual;arrayaccess.offsetexists.php +&url.php.manual;arrayaccess.offsetget.php +&url.php.manual;arrayaccess.offsetset.php +&url.php.manual;arrayaccess.offsetunset.php &url.php.manual;book.curl.php &url.php.manual;book.filesystem.php &url.php.manual;book.iconv.php @@ -26,10 +30,89 @@ URLs rather than linkends. Any links to other manual books should live here. &url.php.manual;book.pcre.php &url.php.manual;book.sodium.php &url.php.manual;book.stream.php +&url.php.manual;class.arrayaccess.php +&url.php.manual;class.closure.php +&url.php.manual;class.countable.php +&url.php.manual;class.error.php +&url.php.manual;class.exception.php +&url.php.manual;class.invalidargumentexception.php +&url.php.manual;class.iterator.php +&url.php.manual;class.iteratoraggregate.php +&url.php.manual;class.jsonserializable.php +&url.php.manual;class.logicexception.php +&url.php.manual;class.outofboundsexception.php +&url.php.manual;class.outofrangeexception.php +&url.php.manual;class.runtimeexception.php +&url.php.manual;class.serializable.php +&url.php.manual;class.stdclass.php +&url.php.manual;class.stringable.php +&url.php.manual;class.throwable.php +&url.php.manual;class.traversable.php +&url.php.manual;class.typeerror.php +&url.php.manual;class.underflowexception.php +&url.php.manual;class.unexpectedvalueexception.php +&url.php.manual;class.valueerror.php +&url.php.manual;closure.bind.php +&url.php.manual;closure.bindto.php +&url.php.manual;closure.call.php +&url.php.manual;closure.construct.php +&url.php.manual;closure.fromcallable.php +&url.php.manual;closure.getcurrent.php &url.php.manual;configuration.changes.modes.php &url.php.manual;configuration.file.php +&url.php.manual;curl.constants.php#constant.curlopt-resolve +&url.php.manual;curl.constants.php#constant.curlopt-ssl-verifyhost +&url.php.manual;curl.constants.php#constant.curlopt-ssl-verifypeer +&url.php.manual;errorfunc.constants.php#constant.e-error +&url.php.manual;errorfunc.constants.php#constant.e-notice +&url.php.manual;errorfunc.constants.php#constant.e-user-warning +&url.php.manual;errorfunc.constants.php#constant.e-warning +&url.php.manual;math.constants.php#constant.inf +&url.php.manual;info.constants.php#constant.ini-all +&url.php.manual;info.constants.php#constant.ini-perdir +&url.php.manual;info.constants.php#constant.ini-system +&url.php.manual;info.constants.php#constant.ini-user +&url.php.manual;string.constants.php#constant.lc-ctype +&url.php.manual;math.constants.php#constant.nan +&url.php.manual;reserved.constants.core.php#constant.null +&url.php.manual;reserved.constants.core.php#constant.php-int-max +&url.php.manual;reserved.constants.core.php#constant.php-int-min +&url.php.manual;reserved.constants.core.php#constant.php-int-size +&url.php.manual;reserved.constants.core.php#constant.php-version +&url.php.manual;reserved.constants.core.php#constant.php-zts +&url.php.manual;filesystem.constants.php#constant.seek-cur +&url.php.manual;filesystem.constants.php#constant.seek-end +&url.php.manual;filesystem.constants.php#constant.seek-set +&url.php.manual;pcntl.constants.php#constant.sigalrm +&url.php.manual;pcntl.constants.php#constant.sigchld +&url.php.manual;pcntl.constants.php#constant.sighup +&url.php.manual;pcntl.constants.php#constant.sigint +&url.php.manual;pcntl.constants.php#constant.sigio +&url.php.manual;pcntl.constants.php#constant.sigterm +&url.php.manual;reserved.constants.core.php#constant.stdin &url.php.manual;context.ssl.php &url.php.manual;control-structures.foreach.php +&url.php.manual;countable.count.php +&url.php.manual;error.clone.php +&url.php.manual;error.construct.php +&url.php.manual;error.getcode.php +&url.php.manual;error.getfile.php +&url.php.manual;error.getline.php +&url.php.manual;error.getmessage.php +&url.php.manual;error.getprevious.php +&url.php.manual;error.gettrace.php +&url.php.manual;error.gettraceasstring.php +&url.php.manual;error.tostring.php +&url.php.manual;exception.clone.php +&url.php.manual;exception.construct.php +&url.php.manual;exception.getcode.php +&url.php.manual;exception.getfile.php +&url.php.manual;exception.getline.php +&url.php.manual;exception.getmessage.php +&url.php.manual;exception.getprevious.php +&url.php.manual;exception.gettrace.php +&url.php.manual;exception.gettraceasstring.php +&url.php.manual;exception.tostring.php &url.php.manual;faq.installation.php#faq.installation.addtopath &url.php.manual;faq.using.php#faq.using.shorthandbytes &url.php.manual;features.commandline.php @@ -65,6 +148,13 @@ URLs rather than linkends. Any links to other manual books should live here. &url.php.manual;install.windows.building.php &url.php.manual;install.windows.manual.php &url.php.manual;book.pdo.php#intro.pdo +&url.php.manual;iterator.current.php +&url.php.manual;iterator.key.php +&url.php.manual;iterator.next.php +&url.php.manual;iterator.rewind.php +&url.php.manual;iterator.valid.php +&url.php.manual;iteratoraggregate.getiterator.php +&url.php.manual;jsonserializable.jsonserialize.php &url.php.manual;language.exceptions.php &url.php.manual;language.oop5.autoload.php &url.php.manual;language.oop5.cloning.php @@ -74,13 +164,23 @@ URLs rather than linkends. Any links to other manual books should live here. &url.php.manual;language.operators.bitwise.php &url.php.manual;language.operators.comparison.php &url.php.manual;language.references.php +&url.php.manual;language.types.php &url.php.manual;language.types.array.php &url.php.manual;language.types.boolean.php &url.php.manual;language.types.boolean.php#language.types.boolean.casting +&url.php.manual;language.types.callable.php +&url.php.manual;language.types.float.php &url.php.manual;language.types.float.php#language.types.float.nan &url.php.manual;language.types.integer.php +&url.php.manual;language.types.mixed.php +&url.php.manual;language.types.null.php +&url.php.manual;language.types.object.php +&url.php.manual;language.types.resource.php &url.php.manual;language.types.resource.php#language.types.resource.self-destruct +&url.php.manual;language.types.singleton.php +&url.php.manual;language.types.string.php &url.php.manual;language.types.type-juggling.php +&url.php.manual;language.types.void.php &url.php.manual;language.variables.scope.php &url.php.manual;mysqlinfo.api.choosing.php &url.php.manual;mysqlinfo.concepts.buffering.php @@ -101,11 +201,25 @@ URLs rather than linkends. Any links to other manual books should live here. &url.php.manual;ref.pcntl.php &url.php.manual;ref.pdo-mysql.php &url.php.manual;ref.session.php +&url.php.manual;reserved.constants.php +&url.php.manual;reserved.exceptions.php +&url.php.manual;reserved.interfaces.php &url.php.manual;reserved.variables.cookies.php &url.php.manual;reserved.variables.get.php &url.php.manual;reserved.variables.post.php &url.php.manual;security.database.sql-injection.php +&url.php.manual;serializable.serialize.php +&url.php.manual;serializable.unserialize.php &url.php.manual;spl.exceptions.php +&url.php.manual;stringable.tostring.php +&url.php.manual;throwable.getcode.php +&url.php.manual;throwable.getfile.php +&url.php.manual;throwable.getline.php +&url.php.manual;throwable.getmessage.php +&url.php.manual;throwable.getprevious.php +&url.php.manual;throwable.gettrace.php +&url.php.manual;throwable.gettraceasstring.php +&url.php.manual;throwable.tostring.php &url.php.manual;types.comparisons.php &url.php.manual;wrappers.expect.php &url.php.manual;wrappers.rar.php diff --git a/language/predefined/arrayaccess.xml b/language/predefined/arrayaccess.xml new file mode 100644 index 000000000..c777f3106 --- /dev/null +++ b/language/predefined/arrayaccess.xml @@ -0,0 +1,44 @@ + + + + + The ArrayAccess interface + ArrayAccess + + + +
+ &reftitle.intro; + + Lets an object be accessed with array syntax through the offsetExists(), + offsetGet(), offsetSet() and offsetUnset() methods. + + + This page is only a summary; the full documentation is in the PHP manual: + ArrayAccess. + +
+ +
+ &reftitle.interfacesynopsis; + + + + ArrayAccess + + + &Methods; + + + +
+ + + + &language.predefined.arrayaccess.offsetexists; + &language.predefined.arrayaccess.offsetget; + &language.predefined.arrayaccess.offsetset; + &language.predefined.arrayaccess.offsetunset; + + diff --git a/language/predefined/arrayaccess/offsetexists.xml b/language/predefined/arrayaccess/offsetexists.xml new file mode 100644 index 000000000..f8353d2b2 --- /dev/null +++ b/language/predefined/arrayaccess/offsetexists.xml @@ -0,0 +1,24 @@ + + + + + + ArrayAccess::offsetExists + Whether an offset exists + + + + &reftitle.description; + + public boolArrayAccess::offsetExists + mixedoffset + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + ArrayAccess::offsetExists. + + + + diff --git a/language/predefined/arrayaccess/offsetget.xml b/language/predefined/arrayaccess/offsetget.xml new file mode 100644 index 000000000..02b0b1323 --- /dev/null +++ b/language/predefined/arrayaccess/offsetget.xml @@ -0,0 +1,24 @@ + + + + + + ArrayAccess::offsetGet + Offset to retrieve + + + + &reftitle.description; + + public mixedArrayAccess::offsetGet + mixedoffset + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + ArrayAccess::offsetGet. + + + + diff --git a/language/predefined/arrayaccess/offsetset.xml b/language/predefined/arrayaccess/offsetset.xml new file mode 100644 index 000000000..37437f9e6 --- /dev/null +++ b/language/predefined/arrayaccess/offsetset.xml @@ -0,0 +1,25 @@ + + + + + + ArrayAccess::offsetSet + Assign a value to the specified offset + + + + &reftitle.description; + + public voidArrayAccess::offsetSet + mixedoffset + mixedvalue + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + ArrayAccess::offsetSet. + + + + diff --git a/language/predefined/arrayaccess/offsetunset.xml b/language/predefined/arrayaccess/offsetunset.xml new file mode 100644 index 000000000..81aa781ef --- /dev/null +++ b/language/predefined/arrayaccess/offsetunset.xml @@ -0,0 +1,24 @@ + + + + + + ArrayAccess::offsetUnset + Unset an offset + + + + &reftitle.description; + + public voidArrayAccess::offsetUnset + mixedoffset + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + ArrayAccess::offsetUnset. + + + + diff --git a/language/predefined/closure.xml b/language/predefined/closure.xml new file mode 100644 index 000000000..f35a457d8 --- /dev/null +++ b/language/predefined/closure.xml @@ -0,0 +1,48 @@ + + + + + The Closure class + Closure + + + +
+ &reftitle.intro; + + The class of every anonymous function and arrow function, also used to + wrap callables and rebind their bound object and scope. + + + This page is only a summary; the full documentation is in the PHP manual: + Closure. + +
+ +
+ &reftitle.classsynopsis; + + + + final + Closure + + + &Methods; + + + + +
+ + + + &language.predefined.closure.construct; + &language.predefined.closure.bind; + &language.predefined.closure.bindto; + &language.predefined.closure.call; + &language.predefined.closure.fromcallable; + &language.predefined.closure.getcurrent; + + diff --git a/language/predefined/closure/bind.xml b/language/predefined/closure/bind.xml new file mode 100644 index 000000000..7649ab316 --- /dev/null +++ b/language/predefined/closure/bind.xml @@ -0,0 +1,28 @@ + + + + + + Closure::bind + + Duplicates a closure with a specific bound object and class scope + + + + + &reftitle.description; + + public static ClosurenullClosure::bind + Closureclosure + objectnullnewThis + objectstringnullnewScope"static" + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + Closure::bind. + + + + diff --git a/language/predefined/closure/bindto.xml b/language/predefined/closure/bindto.xml new file mode 100644 index 000000000..a68f9262c --- /dev/null +++ b/language/predefined/closure/bindto.xml @@ -0,0 +1,27 @@ + + + + + + Closure::bindTo + + Duplicates the closure with a new bound object and class scope + + + + + &reftitle.description; + + public ClosurenullClosure::bindTo + objectnullnewThis + objectstringnullnewScope"static" + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + Closure::bindTo. + + + + diff --git a/language/predefined/closure/call.xml b/language/predefined/closure/call.xml new file mode 100644 index 000000000..091a262ab --- /dev/null +++ b/language/predefined/closure/call.xml @@ -0,0 +1,25 @@ + + + + + + Closure::call + Binds and calls the closure + + + + &reftitle.description; + + public mixedClosure::call + objectnewThis + mixedargs + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + Closure::call. + + + + diff --git a/language/predefined/closure/construct.xml b/language/predefined/closure/construct.xml new file mode 100644 index 000000000..d3f7a12f9 --- /dev/null +++ b/language/predefined/closure/construct.xml @@ -0,0 +1,24 @@ + + + + + + Closure::__construct + Constructor that disallows instantiation + + + + &reftitle.description; + + private Closure::__construct + + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + Closure::__construct. + + + + diff --git a/language/predefined/closure/fromcallable.xml b/language/predefined/closure/fromcallable.xml new file mode 100644 index 000000000..dbcb30c41 --- /dev/null +++ b/language/predefined/closure/fromcallable.xml @@ -0,0 +1,24 @@ + + + + + + Closure::fromCallable + Converts a callable into a closure + + + + &reftitle.description; + + public static ClosureClosure::fromCallable + callablecallback + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + Closure::fromCallable. + + + + diff --git a/language/predefined/closure/getcurrent.xml b/language/predefined/closure/getcurrent.xml new file mode 100644 index 000000000..889e93c86 --- /dev/null +++ b/language/predefined/closure/getcurrent.xml @@ -0,0 +1,24 @@ + + + + + + Closure::getCurrent + Returns the currently executing closure + + + + &reftitle.description; + + public static ClosureClosure::getCurrent + + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + Closure::getCurrent. + + + + diff --git a/language/predefined/constants.xml b/language/predefined/constants.xml new file mode 100644 index 000000000..bf64d1997 --- /dev/null +++ b/language/predefined/constants.xml @@ -0,0 +1,288 @@ + + + + + &ReservedConstants; + + Constants of PHP and its bundled extensions that the extension documentation + refers to. Each entry links to its full description in the PHP manual: + Predefined Constants. + + + + INI_USER (int) + + + The ini directive can be set in user scripts and in the Windows registry. + See INI_USER. + + + + + INI_PERDIR (int) + + + The ini directive can be set in php.ini, .htaccess, httpd.conf and + .user.ini. + See INI_PERDIR. + + + + + INI_SYSTEM (int) + + + The ini directive can only be set in php.ini or httpd.conf. + See INI_SYSTEM. + + + + + INI_ALL (int) + + + The ini directive can be set anywhere. + See INI_ALL. + + + + + E_ERROR (int) + + + Fatal run-time error that halts the script. + See E_ERROR. + + + + + E_WARNING (int) + + + Run-time warning that does not halt the script. + See E_WARNING. + + + + + E_NOTICE (int) + + + Run-time notice about something that might be an error but might also + occur during normal execution. + See E_NOTICE. + + + + + E_USER_WARNING (int) + + + User-generated warning message raised with trigger_error(). + See E_USER_WARNING. + + + + + PHP_VERSION (string) + + + The current PHP version as a string, for example "8.5.0". + See PHP_VERSION. + + + + + PHP_ZTS (bool) + + + Whether PHP was built with thread safety enabled. + See PHP_ZTS. + + + + + PHP_INT_MAX (int) + + + The largest integer supported on this build of PHP. + See PHP_INT_MAX. + + + + + PHP_INT_MIN (int) + + + The smallest integer supported on this build of PHP. + See PHP_INT_MIN. + + + + + PHP_INT_SIZE (int) + + + The size of an integer in bytes on this build of PHP. + See PHP_INT_SIZE. + + + + + NULL (null) + + + The null value. + See NULL. + + + + + STDIN (resource) + + + An already opened stream to standard input, available in the CLI SAPI. + See STDIN. + + + + + NAN (float) + + + The floating point value Not-a-Number. + See NAN. + + + + + INF (float) + + + The floating point value for infinity. + See INF. + + + + + SEEK_SET (int) + + + Set the stream position to the given offset from the start of the stream. + See SEEK_SET. + + + + + SEEK_CUR (int) + + + Set the stream position to the current position plus the given offset. + See SEEK_CUR. + + + + + SEEK_END (int) + + + Set the stream position to the end of the stream plus the given offset. + See SEEK_END. + + + + + LC_CTYPE (int) + + + Locale category for character classification and conversion, such as + strtoupper(). + See LC_CTYPE. + + + + + SIGHUP (int) + + + Signal sent when the controlling terminal is closed. + See SIGHUP. + + + + + SIGINT (int) + + + Interrupt signal, typically sent by pressing Ctrl+C. + See SIGINT. + + + + + SIGALRM (int) + + + Signal sent when a timer set with alarm() expires. + See SIGALRM. + + + + + SIGTERM (int) + + + Termination request signal. + See SIGTERM. + + + + + SIGCHLD (int) + + + Signal sent to a parent process when a child process stops or terminates. + See SIGCHLD. + + + + + SIGIO (int) + + + Signal sent when asynchronous I/O is possible on a descriptor. + See SIGIO. + + + + + CURLOPT_SSL_VERIFYPEER (int) + + + Whether cURL verifies the peer's TLS certificate. + See CURLOPT_SSL_VERIFYPEER. + + + + + CURLOPT_SSL_VERIFYHOST (int) + + + How strictly cURL checks that the TLS certificate matches the host name. + See CURLOPT_SSL_VERIFYHOST. + + + + + CURLOPT_RESOLVE (int) + + + An array of host:port:address strings that override DNS resolution for + the transfer. + See CURLOPT_RESOLVE. + + + + + diff --git a/language/predefined/countable.xml b/language/predefined/countable.xml new file mode 100644 index 000000000..5486a666b --- /dev/null +++ b/language/predefined/countable.xml @@ -0,0 +1,41 @@ + + + + + The Countable interface + Countable + + + +
+ &reftitle.intro; + + Lets an object be passed to count(), which then returns the value of its + count() method. + + + This page is only a summary; the full documentation is in the PHP manual: + Countable. + +
+ +
+ &reftitle.interfacesynopsis; + + + + Countable + + + &Methods; + + + +
+ + + + &language.predefined.countable.count; + + diff --git a/language/predefined/countable/count.xml b/language/predefined/countable/count.xml new file mode 100644 index 000000000..a9e9b3ee1 --- /dev/null +++ b/language/predefined/countable/count.xml @@ -0,0 +1,24 @@ + + + + + + Countable::count + Count elements of an object + + + + &reftitle.description; + + public intCountable::count + + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + Countable::count. + + + + diff --git a/language/predefined/error.xml b/language/predefined/error.xml new file mode 100644 index 000000000..40ff95b0c --- /dev/null +++ b/language/predefined/error.xml @@ -0,0 +1,146 @@ + + + + + Error + Error + + + +
+ &reftitle.intro; + + The base class of all internal PHP errors that are thrown rather than + reported, such as TypeError and ValueError. + + + This page is only a summary; the full documentation is in the PHP manual: + Error. + +
+ +
+ &reftitle.classsynopsis; + + + + Error + + + + implements + Throwable + + + &Properties; + + protected + string + message + "" + + + private + string + string + "" + + + protected + int + code + + + protected + string + file + "" + + + protected + int + line + + + private + array + trace + [] + + + private + Throwablenull + previous + null + + + &Methods; + + + + +
+ +
+ &reftitle.properties; + + + message + + The error message + + + + code + + The error code + + + + file + + The filename where the error happened + + + + line + + The line where the error happened + + + + previous + + The previously thrown exception + + + + string + + The string representation of the stack trace + + + + trace + + The stack trace as an array + + + +
+ + + + &language.predefined.error.construct; + &language.predefined.error.getmessage; + &language.predefined.error.getprevious; + &language.predefined.error.getcode; + &language.predefined.error.getfile; + &language.predefined.error.getline; + &language.predefined.error.gettrace; + &language.predefined.error.gettraceasstring; + &language.predefined.error.tostring; + &language.predefined.error.clone; + + diff --git a/language/predefined/error/clone.xml b/language/predefined/error/clone.xml new file mode 100644 index 000000000..1a30859ac --- /dev/null +++ b/language/predefined/error/clone.xml @@ -0,0 +1,24 @@ + + + + + + Error::__clone + Clone the error + + + + &reftitle.description; + + private voidError::__clone + + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + Error::__clone. + + + + diff --git a/language/predefined/error/construct.xml b/language/predefined/error/construct.xml new file mode 100644 index 000000000..c5d6023a7 --- /dev/null +++ b/language/predefined/error/construct.xml @@ -0,0 +1,26 @@ + + + + + + Error::__construct + Construct the error object + + + + &reftitle.description; + + public Error::__construct + stringmessage"" + intcode0 + Throwablenullprevious&null; + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + Error::__construct. + + + + diff --git a/language/predefined/error/getcode.xml b/language/predefined/error/getcode.xml new file mode 100644 index 000000000..26a6f7311 --- /dev/null +++ b/language/predefined/error/getcode.xml @@ -0,0 +1,24 @@ + + + + + + Error::getCode + Gets the error code + + + + &reftitle.description; + + final public intError::getCode + + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + Error::getCode. + + + + diff --git a/language/predefined/error/getfile.xml b/language/predefined/error/getfile.xml new file mode 100644 index 000000000..54ed01b10 --- /dev/null +++ b/language/predefined/error/getfile.xml @@ -0,0 +1,24 @@ + + + + + + Error::getFile + Gets the file in which the error occurred + + + + &reftitle.description; + + final public stringError::getFile + + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + Error::getFile. + + + + diff --git a/language/predefined/error/getline.xml b/language/predefined/error/getline.xml new file mode 100644 index 000000000..dc452672b --- /dev/null +++ b/language/predefined/error/getline.xml @@ -0,0 +1,24 @@ + + + + + + Error::getLine + Gets the line in which the error occurred + + + + &reftitle.description; + + final public intError::getLine + + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + Error::getLine. + + + + diff --git a/language/predefined/error/getmessage.xml b/language/predefined/error/getmessage.xml new file mode 100644 index 000000000..4cda520f3 --- /dev/null +++ b/language/predefined/error/getmessage.xml @@ -0,0 +1,24 @@ + + + + + + Error::getMessage + Gets the error message + + + + &reftitle.description; + + final public stringError::getMessage + + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + Error::getMessage. + + + + diff --git a/language/predefined/error/getprevious.xml b/language/predefined/error/getprevious.xml new file mode 100644 index 000000000..8766180a5 --- /dev/null +++ b/language/predefined/error/getprevious.xml @@ -0,0 +1,24 @@ + + + + + + Error::getPrevious + Returns previous Throwable + + + + &reftitle.description; + + final public ThrowablenullError::getPrevious + + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + Error::getPrevious. + + + + diff --git a/language/predefined/error/gettrace.xml b/language/predefined/error/gettrace.xml new file mode 100644 index 000000000..d2abb0097 --- /dev/null +++ b/language/predefined/error/gettrace.xml @@ -0,0 +1,24 @@ + + + + + + Error::getTrace + Gets the stack trace + + + + &reftitle.description; + + final public arrayError::getTrace + + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + Error::getTrace. + + + + diff --git a/language/predefined/error/gettraceasstring.xml b/language/predefined/error/gettraceasstring.xml new file mode 100644 index 000000000..bf0a640e4 --- /dev/null +++ b/language/predefined/error/gettraceasstring.xml @@ -0,0 +1,24 @@ + + + + + + Error::getTraceAsString + Gets the stack trace as a string + + + + &reftitle.description; + + final public stringError::getTraceAsString + + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + Error::getTraceAsString. + + + + diff --git a/language/predefined/error/tostring.xml b/language/predefined/error/tostring.xml new file mode 100644 index 000000000..b9363fce0 --- /dev/null +++ b/language/predefined/error/tostring.xml @@ -0,0 +1,24 @@ + + + + + + Error::__toString + String representation of the error + + + + &reftitle.description; + + public stringError::__toString + + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + Error::__toString. + + + + diff --git a/language/predefined/exception.xml b/language/predefined/exception.xml new file mode 100644 index 000000000..ae6d2fdf1 --- /dev/null +++ b/language/predefined/exception.xml @@ -0,0 +1,146 @@ + + + + + Exception + Exception + + + +
+ &reftitle.intro; + + The base class of all user-level exceptions; extensions usually derive + their own exception classes from it. + + + This page is only a summary; the full documentation is in the PHP manual: + Exception. + +
+ +
+ &reftitle.classsynopsis; + + + + Exception + + + + implements + Throwable + + + &Properties; + + protected + string + message + "" + + + private + string + string + "" + + + protected + int + code + + + protected + string + file + "" + + + protected + int + line + + + private + array + trace + [] + + + private + Throwablenull + previous + null + + + &Methods; + + + + +
+ +
+ &reftitle.properties; + + + message + + The exception message + + + + code + + The exception code + + + + file + + The filename where the exception was created + + + + line + + The line where the exception was created + + + + previous + + The previously thrown exception + + + + string + + The string representation of the stack trace + + + + trace + + The stack trace as an array + + + +
+ + + + &language.predefined.exception.construct; + &language.predefined.exception.getmessage; + &language.predefined.exception.getprevious; + &language.predefined.exception.getcode; + &language.predefined.exception.getfile; + &language.predefined.exception.getline; + &language.predefined.exception.gettrace; + &language.predefined.exception.gettraceasstring; + &language.predefined.exception.tostring; + &language.predefined.exception.clone; + + diff --git a/language/predefined/exception/clone.xml b/language/predefined/exception/clone.xml new file mode 100644 index 000000000..60079eddc --- /dev/null +++ b/language/predefined/exception/clone.xml @@ -0,0 +1,24 @@ + + + + + + Exception::__clone + Clone the exception + + + + &reftitle.description; + + private voidException::__clone + + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + Exception::__clone. + + + + diff --git a/language/predefined/exception/construct.xml b/language/predefined/exception/construct.xml new file mode 100644 index 000000000..b13961e64 --- /dev/null +++ b/language/predefined/exception/construct.xml @@ -0,0 +1,26 @@ + + + + + + Exception::__construct + Construct the exception + + + + &reftitle.description; + + public Exception::__construct + stringmessage"" + intcode0 + Throwablenullprevious&null; + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + Exception::__construct. + + + + diff --git a/language/predefined/exception/getcode.xml b/language/predefined/exception/getcode.xml new file mode 100644 index 000000000..4a4472e56 --- /dev/null +++ b/language/predefined/exception/getcode.xml @@ -0,0 +1,24 @@ + + + + + + Exception::getCode + Gets the Exception code + + + + &reftitle.description; + + final public intException::getCode + + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + Exception::getCode. + + + + diff --git a/language/predefined/exception/getfile.xml b/language/predefined/exception/getfile.xml new file mode 100644 index 000000000..4e40f8c40 --- /dev/null +++ b/language/predefined/exception/getfile.xml @@ -0,0 +1,24 @@ + + + + + + Exception::getFile + Gets the file in which the exception was created + + + + &reftitle.description; + + final public stringException::getFile + + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + Exception::getFile. + + + + diff --git a/language/predefined/exception/getline.xml b/language/predefined/exception/getline.xml new file mode 100644 index 000000000..3d0ec0f88 --- /dev/null +++ b/language/predefined/exception/getline.xml @@ -0,0 +1,24 @@ + + + + + + Exception::getLine + Gets the line in which the exception was created + + + + &reftitle.description; + + final public intException::getLine + + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + Exception::getLine. + + + + diff --git a/language/predefined/exception/getmessage.xml b/language/predefined/exception/getmessage.xml new file mode 100644 index 000000000..f7793bed3 --- /dev/null +++ b/language/predefined/exception/getmessage.xml @@ -0,0 +1,24 @@ + + + + + + Exception::getMessage + Gets the Exception message + + + + &reftitle.description; + + final public stringException::getMessage + + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + Exception::getMessage. + + + + diff --git a/language/predefined/exception/getprevious.xml b/language/predefined/exception/getprevious.xml new file mode 100644 index 000000000..44f805615 --- /dev/null +++ b/language/predefined/exception/getprevious.xml @@ -0,0 +1,24 @@ + + + + + + Exception::getPrevious + Returns previous Throwable + + + + &reftitle.description; + + final public ThrowablenullException::getPrevious + + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + Exception::getPrevious. + + + + diff --git a/language/predefined/exception/gettrace.xml b/language/predefined/exception/gettrace.xml new file mode 100644 index 000000000..63c656b34 --- /dev/null +++ b/language/predefined/exception/gettrace.xml @@ -0,0 +1,24 @@ + + + + + + Exception::getTrace + Gets the stack trace + + + + &reftitle.description; + + final public arrayException::getTrace + + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + Exception::getTrace. + + + + diff --git a/language/predefined/exception/gettraceasstring.xml b/language/predefined/exception/gettraceasstring.xml new file mode 100644 index 000000000..7e9da9203 --- /dev/null +++ b/language/predefined/exception/gettraceasstring.xml @@ -0,0 +1,24 @@ + + + + + + Exception::getTraceAsString + Gets the stack trace as a string + + + + &reftitle.description; + + final public stringException::getTraceAsString + + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + Exception::getTraceAsString. + + + + diff --git a/language/predefined/exception/tostring.xml b/language/predefined/exception/tostring.xml new file mode 100644 index 000000000..c74235b0c --- /dev/null +++ b/language/predefined/exception/tostring.xml @@ -0,0 +1,24 @@ + + + + + + Exception::__toString + String representation of the exception + + + + &reftitle.description; + + public stringException::__toString + + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + Exception::__toString. + + + + diff --git a/language/predefined/exceptions.xml b/language/predefined/exceptions.xml new file mode 100644 index 000000000..a2b0e66a0 --- /dev/null +++ b/language/predefined/exceptions.xml @@ -0,0 +1,29 @@ + + + + + Predefined Exceptions + + + + Summaries of the exception and error classes of PHP and its bundled + extensions that third-party extensions extend or throw. The full + documentation is in the PHP manual: + Predefined Exceptions. + + + + &language.predefined.exception; + &language.predefined.error; + &language.predefined.typeerror; + &language.predefined.valueerror; + &language.predefined.logicexception; + &language.predefined.invalidargumentexception; + &language.predefined.outofrangeexception; + &language.predefined.runtimeexception; + &language.predefined.outofboundsexception; + &language.predefined.underflowexception; + &language.predefined.unexpectedvalueexception; + + diff --git a/language/predefined/interfaces.xml b/language/predefined/interfaces.xml new file mode 100644 index 000000000..af0ab5d61 --- /dev/null +++ b/language/predefined/interfaces.xml @@ -0,0 +1,29 @@ + + + + + Predefined Interfaces and Classes + + + + Summaries of the interfaces and classes of PHP and its bundled extensions + that third-party extensions extend, implement or accept. The full + documentation is in the PHP manual: + Predefined Interfaces and Classes. + + + + &language.predefined.traversable; + &language.predefined.iterator; + &language.predefined.iteratoraggregate; + &language.predefined.arrayaccess; + &language.predefined.countable; + &language.predefined.serializable; + &language.predefined.stringable; + &language.predefined.jsonserializable; + &language.predefined.throwable; + &language.predefined.closure; + &language.predefined.stdclass; + + diff --git a/language/predefined/invalidargumentexception.xml b/language/predefined/invalidargumentexception.xml new file mode 100644 index 000000000..5f2512b70 --- /dev/null +++ b/language/predefined/invalidargumentexception.xml @@ -0,0 +1,47 @@ + + + + + The InvalidArgumentException class + InvalidArgumentException + + + +
+ &reftitle.intro; + + Thrown when an argument is not of the expected type or value. + + + This page is only a summary; the full documentation is in the PHP manual: + InvalidArgumentException. + +
+ +
+ &reftitle.classsynopsis; + + + + InvalidArgumentException + + + + extends + LogicException + + + &InheritedProperties; + + + &InheritedMethods; + + + + +
+ + + + diff --git a/language/predefined/iterator.xml b/language/predefined/iterator.xml new file mode 100644 index 000000000..58c5c9152 --- /dev/null +++ b/language/predefined/iterator.xml @@ -0,0 +1,50 @@ + + + + + The Iterator interface + Iterator + + + +
+ &reftitle.intro; + + Lets a class define its own iteration through the current(), key(), + next(), rewind() and valid() methods. + + + This page is only a summary; the full documentation is in the PHP manual: + Iterator. + +
+ +
+ &reftitle.interfacesynopsis; + + + + Iterator + + + + extends + Traversable + + + &Methods; + + + +
+ + + + &language.predefined.iterator.current; + &language.predefined.iterator.key; + &language.predefined.iterator.next; + &language.predefined.iterator.rewind; + &language.predefined.iterator.valid; + + diff --git a/language/predefined/iterator/current.xml b/language/predefined/iterator/current.xml new file mode 100644 index 000000000..bbbc93d95 --- /dev/null +++ b/language/predefined/iterator/current.xml @@ -0,0 +1,24 @@ + + + + + + Iterator::current + Return the current element + + + + &reftitle.description; + + public mixedIterator::current + + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + Iterator::current. + + + + diff --git a/language/predefined/iterator/key.xml b/language/predefined/iterator/key.xml new file mode 100644 index 000000000..ef1f0ebc5 --- /dev/null +++ b/language/predefined/iterator/key.xml @@ -0,0 +1,24 @@ + + + + + + Iterator::key + Return the key of the current element + + + + &reftitle.description; + + public mixedIterator::key + + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + Iterator::key. + + + + diff --git a/language/predefined/iterator/next.xml b/language/predefined/iterator/next.xml new file mode 100644 index 000000000..b6daac8ea --- /dev/null +++ b/language/predefined/iterator/next.xml @@ -0,0 +1,24 @@ + + + + + + Iterator::next + Move forward to next element + + + + &reftitle.description; + + public voidIterator::next + + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + Iterator::next. + + + + diff --git a/language/predefined/iterator/rewind.xml b/language/predefined/iterator/rewind.xml new file mode 100644 index 000000000..7dbcf85ac --- /dev/null +++ b/language/predefined/iterator/rewind.xml @@ -0,0 +1,24 @@ + + + + + + Iterator::rewind + Rewind the Iterator to the first element + + + + &reftitle.description; + + public voidIterator::rewind + + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + Iterator::rewind. + + + + diff --git a/language/predefined/iterator/valid.xml b/language/predefined/iterator/valid.xml new file mode 100644 index 000000000..22bdf6e92 --- /dev/null +++ b/language/predefined/iterator/valid.xml @@ -0,0 +1,24 @@ + + + + + + Iterator::valid + Checks if current position is valid + + + + &reftitle.description; + + public boolIterator::valid + + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + Iterator::valid. + + + + diff --git a/language/predefined/iteratoraggregate.xml b/language/predefined/iteratoraggregate.xml new file mode 100644 index 000000000..2754b3117 --- /dev/null +++ b/language/predefined/iteratoraggregate.xml @@ -0,0 +1,46 @@ + + + + + The IteratorAggregate interface + IteratorAggregate + + + +
+ &reftitle.intro; + + Lets a class delegate iteration to another Traversable returned from + getIterator(). + + + This page is only a summary; the full documentation is in the PHP manual: + IteratorAggregate. + +
+ +
+ &reftitle.interfacesynopsis; + + + + IteratorAggregate + + + + extends + Traversable + + + &Methods; + + + +
+ + + + &language.predefined.iteratoraggregate.getiterator; + + diff --git a/language/predefined/iteratoraggregate/getiterator.xml b/language/predefined/iteratoraggregate/getiterator.xml new file mode 100644 index 000000000..08acd350c --- /dev/null +++ b/language/predefined/iteratoraggregate/getiterator.xml @@ -0,0 +1,24 @@ + + + + + + IteratorAggregate::getIterator + Retrieve an external iterator or traversable + + + + &reftitle.description; + + public TraversableIteratorAggregate::getIterator + + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + IteratorAggregate::getIterator. + + + + diff --git a/language/predefined/jsonserializable.xml b/language/predefined/jsonserializable.xml new file mode 100644 index 000000000..e225fc5e0 --- /dev/null +++ b/language/predefined/jsonserializable.xml @@ -0,0 +1,41 @@ + + + + + The JsonSerializable interface + JsonSerializable + + + +
+ &reftitle.intro; + + Lets an object control the data that json_encode() emits for it through + the jsonSerialize() method. + + + This page is only a summary; the full documentation is in the PHP manual: + JsonSerializable. + +
+ +
+ &reftitle.interfacesynopsis; + + + + JsonSerializable + + + &Methods; + + + +
+ + + + &language.predefined.jsonserializable.jsonserialize; + + diff --git a/language/predefined/jsonserializable/jsonserialize.xml b/language/predefined/jsonserializable/jsonserialize.xml new file mode 100644 index 000000000..8ac82b158 --- /dev/null +++ b/language/predefined/jsonserializable/jsonserialize.xml @@ -0,0 +1,24 @@ + + + + + + JsonSerializable::jsonSerialize + Specify data which should be serialized to JSON + + + + &reftitle.description; + + public mixedJsonSerializable::jsonSerialize + + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + JsonSerializable::jsonSerialize. + + + + diff --git a/language/predefined/logicexception.xml b/language/predefined/logicexception.xml new file mode 100644 index 000000000..9461d0b04 --- /dev/null +++ b/language/predefined/logicexception.xml @@ -0,0 +1,48 @@ + + + + + The LogicException class + LogicException + + + +
+ &reftitle.intro; + + Represents an error in the program logic that should lead to a fix in the + code; the base class of the SPL logic exceptions. + + + This page is only a summary; the full documentation is in the PHP manual: + LogicException. + +
+ +
+ &reftitle.classsynopsis; + + + + LogicException + + + + extends + Exception + + + &InheritedProperties; + + + &InheritedMethods; + + + + +
+ + + + diff --git a/language/predefined/outofboundsexception.xml b/language/predefined/outofboundsexception.xml new file mode 100644 index 000000000..22b85f177 --- /dev/null +++ b/language/predefined/outofboundsexception.xml @@ -0,0 +1,48 @@ + + + + + The OutOfBoundsException class + OutOfBoundsException + + + +
+ &reftitle.intro; + + Thrown when a value is not a valid key, where this cannot be detected + before the code runs. + + + This page is only a summary; the full documentation is in the PHP manual: + OutOfBoundsException. + +
+ +
+ &reftitle.classsynopsis; + + + + OutOfBoundsException + + + + extends + RuntimeException + + + &InheritedProperties; + + + &InheritedMethods; + + + + +
+ + + + diff --git a/language/predefined/outofrangeexception.xml b/language/predefined/outofrangeexception.xml new file mode 100644 index 000000000..735a4cf11 --- /dev/null +++ b/language/predefined/outofrangeexception.xml @@ -0,0 +1,48 @@ + + + + + The OutOfRangeException class + OutOfRangeException + + + +
+ &reftitle.intro; + + Thrown when an illegal index is requested and the error can be detected at + compile time; the logic-error counterpart of OutOfBoundsException. + + + This page is only a summary; the full documentation is in the PHP manual: + OutOfRangeException. + +
+ +
+ &reftitle.classsynopsis; + + + + OutOfRangeException + + + + extends + LogicException + + + &InheritedProperties; + + + &InheritedMethods; + + + + +
+ + + + diff --git a/language/predefined/runtimeexception.xml b/language/predefined/runtimeexception.xml new file mode 100644 index 000000000..a8e60e5a8 --- /dev/null +++ b/language/predefined/runtimeexception.xml @@ -0,0 +1,48 @@ + + + + + The RuntimeException class + RuntimeException + + + +
+ &reftitle.intro; + + Thrown for errors that can only be detected while the program runs; the + base class of the SPL runtime exceptions. + + + This page is only a summary; the full documentation is in the PHP manual: + RuntimeException. + +
+ +
+ &reftitle.classsynopsis; + + + + RuntimeException + + + + extends + Exception + + + &InheritedProperties; + + + &InheritedMethods; + + + + +
+ + + + diff --git a/language/predefined/serializable.xml b/language/predefined/serializable.xml new file mode 100644 index 000000000..459fb4ee7 --- /dev/null +++ b/language/predefined/serializable.xml @@ -0,0 +1,43 @@ + + + + + The Serializable interface + Serializable + + + +
+ &reftitle.intro; + + Legacy interface for custom serialization through the serialize() and + unserialize() methods; new code uses __serialize() and __unserialize() + instead. + + + This page is only a summary; the full documentation is in the PHP manual: + Serializable. + +
+ +
+ &reftitle.interfacesynopsis; + + + + Serializable + + + &Methods; + + + +
+ + + + &language.predefined.serializable.serialize; + &language.predefined.serializable.unserialize; + + diff --git a/language/predefined/serializable/serialize.xml b/language/predefined/serializable/serialize.xml new file mode 100644 index 000000000..a9df242fb --- /dev/null +++ b/language/predefined/serializable/serialize.xml @@ -0,0 +1,24 @@ + + + + + + Serializable::serialize + String representation of object + + + + &reftitle.description; + + public stringnullSerializable::serialize + + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + Serializable::serialize. + + + + diff --git a/language/predefined/serializable/unserialize.xml b/language/predefined/serializable/unserialize.xml new file mode 100644 index 000000000..dff679015 --- /dev/null +++ b/language/predefined/serializable/unserialize.xml @@ -0,0 +1,24 @@ + + + + + + Serializable::unserialize + Constructs the object + + + + &reftitle.description; + + public voidSerializable::unserialize + stringdata + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + Serializable::unserialize. + + + + diff --git a/language/predefined/stdclass.xml b/language/predefined/stdclass.xml new file mode 100644 index 000000000..421834f70 --- /dev/null +++ b/language/predefined/stdclass.xml @@ -0,0 +1,37 @@ + + + + + The stdClass class + stdClass + + + +
+ &reftitle.intro; + + A generic empty class with dynamic properties, returned by casts to object + and by functions that decode data into objects. + + + This page is only a summary; the full documentation is in the PHP manual: + stdClass. + +
+ +
+ &reftitle.classsynopsis; + + + + #[\AllowDynamicProperties] + stdClass + + + +
+ + + + diff --git a/language/predefined/stringable.xml b/language/predefined/stringable.xml new file mode 100644 index 000000000..b7d92d8b3 --- /dev/null +++ b/language/predefined/stringable.xml @@ -0,0 +1,41 @@ + + + + + The Stringable interface + Stringable + + + +
+ &reftitle.intro; + + Marks a class that defines __toString() and can therefore be converted to + a string; implemented implicitly by every such class. + + + This page is only a summary; the full documentation is in the PHP manual: + Stringable. + +
+ +
+ &reftitle.interfacesynopsis; + + + + Stringable + + + &Methods; + + + +
+ + + + &language.predefined.stringable.tostring; + + diff --git a/language/predefined/stringable/tostring.xml b/language/predefined/stringable/tostring.xml new file mode 100644 index 000000000..439ded3ac --- /dev/null +++ b/language/predefined/stringable/tostring.xml @@ -0,0 +1,24 @@ + + + + + + Stringable::__toString + Gets a string representation of the object + + + + &reftitle.description; + + public stringStringable::__toString + + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + Stringable::__toString. + + + + diff --git a/language/predefined/throwable.xml b/language/predefined/throwable.xml new file mode 100644 index 000000000..ccc61f478 --- /dev/null +++ b/language/predefined/throwable.xml @@ -0,0 +1,57 @@ + + + + + Throwable + Throwable + + + +
+ &reftitle.intro; + + The base interface of everything that can be thrown, implemented by + Exception and Error; user classes implement it only by extending one of + those. + + + This page is only a summary; the full documentation is in the PHP manual: + Throwable. + +
+ +
+ &reftitle.interfacesynopsis; + + + + Throwable + + + + extends + Stringable + + + &Methods; + + + &InheritedMethods; + + + +
+ + + + &language.predefined.throwable.getmessage; + &language.predefined.throwable.getcode; + &language.predefined.throwable.getfile; + &language.predefined.throwable.getline; + &language.predefined.throwable.gettrace; + &language.predefined.throwable.gettraceasstring; + &language.predefined.throwable.getprevious; + &language.predefined.throwable.tostring; + + diff --git a/language/predefined/throwable/getcode.xml b/language/predefined/throwable/getcode.xml new file mode 100644 index 000000000..6e4555d4d --- /dev/null +++ b/language/predefined/throwable/getcode.xml @@ -0,0 +1,24 @@ + + + + + + Throwable::getCode + Gets the exception code + + + + &reftitle.description; + + public intThrowable::getCode + + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + Throwable::getCode. + + + + diff --git a/language/predefined/throwable/getfile.xml b/language/predefined/throwable/getfile.xml new file mode 100644 index 000000000..2448e0f89 --- /dev/null +++ b/language/predefined/throwable/getfile.xml @@ -0,0 +1,24 @@ + + + + + + Throwable::getFile + Gets the file in which the object was created + + + + &reftitle.description; + + public stringThrowable::getFile + + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + Throwable::getFile. + + + + diff --git a/language/predefined/throwable/getline.xml b/language/predefined/throwable/getline.xml new file mode 100644 index 000000000..0ccdd33fc --- /dev/null +++ b/language/predefined/throwable/getline.xml @@ -0,0 +1,24 @@ + + + + + + Throwable::getLine + Gets the line on which the object was instantiated + + + + &reftitle.description; + + public intThrowable::getLine + + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + Throwable::getLine. + + + + diff --git a/language/predefined/throwable/getmessage.xml b/language/predefined/throwable/getmessage.xml new file mode 100644 index 000000000..c584bd244 --- /dev/null +++ b/language/predefined/throwable/getmessage.xml @@ -0,0 +1,24 @@ + + + + + + Throwable::getMessage + Gets the message + + + + &reftitle.description; + + public stringThrowable::getMessage + + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + Throwable::getMessage. + + + + diff --git a/language/predefined/throwable/getprevious.xml b/language/predefined/throwable/getprevious.xml new file mode 100644 index 000000000..caaa62218 --- /dev/null +++ b/language/predefined/throwable/getprevious.xml @@ -0,0 +1,24 @@ + + + + + + Throwable::getPrevious + Returns the previous Throwable + + + + &reftitle.description; + + public ThrowablenullThrowable::getPrevious + + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + Throwable::getPrevious. + + + + diff --git a/language/predefined/throwable/gettrace.xml b/language/predefined/throwable/gettrace.xml new file mode 100644 index 000000000..601bb65b2 --- /dev/null +++ b/language/predefined/throwable/gettrace.xml @@ -0,0 +1,24 @@ + + + + + + Throwable::getTrace + Gets the stack trace + + + + &reftitle.description; + + public arrayThrowable::getTrace + + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + Throwable::getTrace. + + + + diff --git a/language/predefined/throwable/gettraceasstring.xml b/language/predefined/throwable/gettraceasstring.xml new file mode 100644 index 000000000..5237dfc6b --- /dev/null +++ b/language/predefined/throwable/gettraceasstring.xml @@ -0,0 +1,24 @@ + + + + + + Throwable::getTraceAsString + Gets the stack trace as a string + + + + &reftitle.description; + + public stringThrowable::getTraceAsString + + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + Throwable::getTraceAsString. + + + + diff --git a/language/predefined/throwable/tostring.xml b/language/predefined/throwable/tostring.xml new file mode 100644 index 000000000..f14c93fe4 --- /dev/null +++ b/language/predefined/throwable/tostring.xml @@ -0,0 +1,24 @@ + + + + + + Throwable::__toString + Gets a string representation of the thrown object + + + + &reftitle.description; + + public stringThrowable::__toString + + + + This entry is only a summary; parameters, return values and examples are + documented in the PHP manual: + Throwable::__toString. + + + + diff --git a/language/predefined/traversable.xml b/language/predefined/traversable.xml new file mode 100644 index 000000000..9b99b400f --- /dev/null +++ b/language/predefined/traversable.xml @@ -0,0 +1,36 @@ + + + + + The <interfacename>Traversable</interfacename> interface + Traversable + + + +
+ &reftitle.intro; + + Marks a class whose instances can be iterated with foreach; it is + implemented through Iterator or IteratorAggregate, never directly. + + + This page is only a summary; the full documentation is in the PHP manual: + Traversable. + +
+ +
+ &reftitle.interfacesynopsis; + + + + Traversable + + + +
+ + + + diff --git a/language/predefined/typeerror.xml b/language/predefined/typeerror.xml new file mode 100644 index 000000000..fdc77ecd6 --- /dev/null +++ b/language/predefined/typeerror.xml @@ -0,0 +1,49 @@ + + + + + TypeError + TypeError + + + +
+ &reftitle.intro; + + Thrown when a value does not match the declared type of a parameter, + property or return value, or when a function is called with too few + arguments. + + + This page is only a summary; the full documentation is in the PHP manual: + TypeError. + +
+ +
+ &reftitle.classsynopsis; + + + + TypeError + + + + extends + Error + + + &InheritedProperties; + + + &InheritedMethods; + + + + +
+ + + + diff --git a/language/predefined/underflowexception.xml b/language/predefined/underflowexception.xml new file mode 100644 index 000000000..9c2d92035 --- /dev/null +++ b/language/predefined/underflowexception.xml @@ -0,0 +1,48 @@ + + + + + The UnderflowException class + UnderflowException + + + +
+ &reftitle.intro; + + Thrown when an invalid operation is performed on an empty container, such + as removing an element from an empty list. + + + This page is only a summary; the full documentation is in the PHP manual: + UnderflowException. + +
+ +
+ &reftitle.classsynopsis; + + + + UnderflowException + + + + extends + RuntimeException + + + &InheritedProperties; + + + &InheritedMethods; + + + + +
+ + + + diff --git a/language/predefined/unexpectedvalueexception.xml b/language/predefined/unexpectedvalueexception.xml new file mode 100644 index 000000000..cb1852eee --- /dev/null +++ b/language/predefined/unexpectedvalueexception.xml @@ -0,0 +1,48 @@ + + + + + The UnexpectedValueException class + UnexpectedValueException + + + +
+ &reftitle.intro; + + Thrown when a value does not match a set of expected values, typically + when a function returns something it should not. + + + This page is only a summary; the full documentation is in the PHP manual: + UnexpectedValueException. + +
+ +
+ &reftitle.classsynopsis; + + + + UnexpectedValueException + + + + extends + RuntimeException + + + &InheritedProperties; + + + &InheritedMethods; + + + + +
+ + + + diff --git a/language/predefined/valueerror.xml b/language/predefined/valueerror.xml new file mode 100644 index 000000000..4b23d1c1e --- /dev/null +++ b/language/predefined/valueerror.xml @@ -0,0 +1,48 @@ + + + + + ValueError + ValueError + + + +
+ &reftitle.intro; + + Thrown when an argument has the right type but an invalid value, for + example an empty string where a non-empty one is required. + + + This page is only a summary; the full documentation is in the PHP manual: + ValueError. + +
+ +
+ &reftitle.classsynopsis; + + + + ValueError + + + + extends + Error + + + &InheritedProperties; + + + &InheritedMethods; + + + + +
+ + + + diff --git a/language/predefined/versions.xml b/language/predefined/versions.xml new file mode 100644 index 000000000..a92b895fb --- /dev/null +++ b/language/predefined/versions.xml @@ -0,0 +1,78 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/language/sync.lock b/language/sync.lock new file mode 100644 index 000000000..37eda9609 --- /dev/null +++ b/language/sync.lock @@ -0,0 +1,4 @@ +{ + "doc-en": "00b118595a963f00211e96224e3fba35bdebc83c", + "synced": "2026-09-30" +} diff --git a/language/types.xml b/language/types.xml new file mode 100644 index 000000000..8eeffb524 --- /dev/null +++ b/language/types.xml @@ -0,0 +1,30 @@ + + + + + Types + + + Introduction + + The pages in this chapter summarise the built-in types that the extension + documentation refers to. Each page links to the full description in the + PHP manual: Types. + + + + &language.types.integer; + &language.types.float; + &language.types.string; + &language.types.boolean; + &language.types.singleton; + &language.types.array; + &language.types.object; + &language.types.callable; + &language.types.resource; + &language.types.mixed; + &language.types.void; + &language.types.null; + + diff --git a/language/types/array.xml b/language/types/array.xml new file mode 100644 index 000000000..5d6137cea --- /dev/null +++ b/language/types/array.xml @@ -0,0 +1,15 @@ + + + + + Arrays + + An ordered map of integer or string keys to values, used for lists, hash + tables, stacks and queues alike. + + + This page is only a summary; the full description is in the PHP manual: + Arrays. + + diff --git a/language/types/boolean.xml b/language/types/boolean.xml new file mode 100644 index 000000000..075fb4876 --- /dev/null +++ b/language/types/boolean.xml @@ -0,0 +1,14 @@ + + + + + Booleans + + A truth value, either true or false. + + + This page is only a summary; the full description is in the PHP manual: + Booleans. + + diff --git a/language/types/callable.xml b/language/types/callable.xml new file mode 100644 index 000000000..77b1c3dde --- /dev/null +++ b/language/types/callable.xml @@ -0,0 +1,15 @@ + + + + + Callables + + Anything that can be called: a function name, a closure, an object with + __invoke(), or an array of object or class name and method name. + + + This page is only a summary; the full description is in the PHP manual: + Callables. + + diff --git a/language/types/float.xml b/language/types/float.xml new file mode 100644 index 000000000..1774e128e --- /dev/null +++ b/language/types/float.xml @@ -0,0 +1,15 @@ + + + + + Floating-point numbers + + A double-precision floating point number, including the special values INF + and NAN. + + + This page is only a summary; the full description is in the PHP manual: + Floating-point numbers. + + diff --git a/language/types/integer.xml b/language/types/integer.xml new file mode 100644 index 000000000..cba28ef91 --- /dev/null +++ b/language/types/integer.xml @@ -0,0 +1,15 @@ + + + + + Integers + + A whole number of platform-dependent size, written in decimal, hexadecimal, + octal or binary notation. + + + This page is only a summary; the full description is in the PHP manual: + Integers. + + diff --git a/language/types/mixed.xml b/language/types/mixed.xml new file mode 100644 index 000000000..5866f9cc6 --- /dev/null +++ b/language/types/mixed.xml @@ -0,0 +1,14 @@ + + + + + Mixed + + Any value of any type; equivalent to the union of all other types. + + + This page is only a summary; the full description is in the PHP manual: + Mixed. + + diff --git a/language/types/null.xml b/language/types/null.xml new file mode 100644 index 000000000..2891bb6a9 --- /dev/null +++ b/language/types/null.xml @@ -0,0 +1,14 @@ + + + + + NULL + + The single value null, which a variable holds when it has no value. + + + This page is only a summary; the full description is in the PHP manual: + NULL. + + diff --git a/language/types/object.xml b/language/types/object.xml new file mode 100644 index 000000000..8d38f3cf4 --- /dev/null +++ b/language/types/object.xml @@ -0,0 +1,14 @@ + + + + + Objects + + An instance of a class, created with new or by casting another value. + + + This page is only a summary; the full description is in the PHP manual: + Objects. + + diff --git a/language/types/resource.xml b/language/types/resource.xml new file mode 100644 index 000000000..4accc4bb7 --- /dev/null +++ b/language/types/resource.xml @@ -0,0 +1,15 @@ + + + + + Resources + + A handle to an external resource such as a file, a database connection or an + image, created and freed by dedicated functions. + + + This page is only a summary; the full description is in the PHP manual: + Resources. + + diff --git a/language/types/singleton.xml b/language/types/singleton.xml new file mode 100644 index 000000000..458706566 --- /dev/null +++ b/language/types/singleton.xml @@ -0,0 +1,15 @@ + + + + + Singleton types + + The unit types true, false and null, each of which has exactly one possible + value. + + + This page is only a summary; the full description is in the PHP manual: + Singleton types. + + diff --git a/language/types/string.xml b/language/types/string.xml new file mode 100644 index 000000000..44f851b2c --- /dev/null +++ b/language/types/string.xml @@ -0,0 +1,15 @@ + + + + + Strings + + A series of bytes; PHP strings carry no encoding and may hold arbitrary + binary data. + + + This page is only a summary; the full description is in the PHP manual: + Strings. + + diff --git a/language/types/void.xml b/language/types/void.xml new file mode 100644 index 000000000..7a5c58673 --- /dev/null +++ b/language/types/void.xml @@ -0,0 +1,14 @@ + + + + + Void + + The return type of a function that returns nothing. + + + This page is only a summary; the full description is in the PHP manual: + Void. + +