diff --git a/language/predefined/error.xml b/language/predefined/error.xml index d99eba5f28..f08c9e0705 100644 --- a/language/predefined/error.xml +++ b/language/predefined/error.xml @@ -1,7 +1,7 @@ - Error is the base class for all - internal PHP error exceptions. + internal PHP errors. @@ -41,15 +41,81 @@ - &InheritedMethods; - + &Properties; + + protected + string + message + + + protected + int + code + + + protected + string + file + + + protected + int + line + + + &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 + + + +
+ + -
+ +&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; + + + + + Error::__clone + Clone the error + + + + &reftitle.description; + + final private voidError::__clone + + + + Error can not be clone, so this method results in fatal error. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + &return.void; + + + + + &reftitle.errors; + + Errors are not clonable. + + + + + + diff --git a/language/predefined/error/construct.xml b/language/predefined/error/construct.xml new file mode 100644 index 0000000000..de39031fed --- /dev/null +++ b/language/predefined/error/construct.xml @@ -0,0 +1,87 @@ + + + + + + Error::__construct + Construct the error object + + + + &reftitle.description; + + public Error::__construct + stringmessage"" + intcode0 + Throwableprevious&null; + + + Constructs the Error. + + + + + &reftitle.parameters; + + + + message + + + The error message. + + + + + code + + + The error code. + + + + + previous + + + The previous throwable used for the exception chaining. + + + + + + + + + &reftitle.notes; + + + The message is NOT + binary safe. + + + + + + + + diff --git a/language/predefined/error/getcode.xml b/language/predefined/error/getcode.xml new file mode 100644 index 0000000000..af3703b0f8 --- /dev/null +++ b/language/predefined/error/getcode.xml @@ -0,0 +1,89 @@ + + + + + + Error::getCode + Gets the error code + + + + &reftitle.description; + + final public mixedError::getCode + + + + Returns the error code. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns the error code as integer + + + + + &reftitle.examples; + + + <function>Error::getCode</function> example + +getCode(); +} +?> +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + Throwable::getCode + + + + + + + diff --git a/language/predefined/error/getfile.xml b/language/predefined/error/getfile.xml new file mode 100644 index 0000000000..3d4c079d4e --- /dev/null +++ b/language/predefined/error/getfile.xml @@ -0,0 +1,89 @@ + + + + + + Error::getFile + Gets the file in which the error occurred + + + + &reftitle.description; + + final public stringError::getFile + + + + Get the name of the file the error occurred. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns the filename in which the error occurred. + + + + + &reftitle.examples; + + + <function>Error::getFile</function> example + +getFile(); +} +?> +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + Throwable::getFile + + + + + + + diff --git a/language/predefined/error/getline.xml b/language/predefined/error/getline.xml new file mode 100644 index 0000000000..8800a12586 --- /dev/null +++ b/language/predefined/error/getline.xml @@ -0,0 +1,89 @@ + + + + + + Error::getLine + Gets the line in which the error occurred + + + + &reftitle.description; + + final public intError::getLine + + + + Get line number where the error occurred. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns the line number where the error occurred. + + + + + &reftitle.examples; + + + <function>Error::getLine</function> example + +getLine(); +} +?> +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + Throwable::getLine + + + + + + + diff --git a/language/predefined/error/getmessage.xml b/language/predefined/error/getmessage.xml new file mode 100644 index 0000000000..b022012d98 --- /dev/null +++ b/language/predefined/error/getmessage.xml @@ -0,0 +1,89 @@ + + + + + + Error::getMessage + Gets the error message + + + + &reftitle.description; + + final public stringError::getMessage + + + + Returns the error message. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns the error message as a string. + + + + + &reftitle.examples; + + + <function>Error::getMessage</function> example + +getMessage(); +} +?> +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + Throwable::getMessage + + + + + + + diff --git a/language/predefined/error/getprevious.xml b/language/predefined/error/getprevious.xml new file mode 100644 index 0000000000..e59c34ebd1 --- /dev/null +++ b/language/predefined/error/getprevious.xml @@ -0,0 +1,107 @@ + + + + + + Error::getPrevious + Returns previous Throwable + + + + &reftitle.description; + + final public ThrowableError::getPrevious + + + + Returns previous Throwable (the third parameter of Error::__construct). + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns the previous Throwable if available + or &null; otherwise. + + + + + &reftitle.examples; + + + <methodname>Error::getPrevious</methodname> example + + Looping over, and printing out, error trace. + + +getFile(), $e->getLine(), $e->getMessage(), $e->getCode(), get_class($e)); + } while($e = $e->getPrevious()); +} +?> +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + Throwable::getPrevious + + + + + + + diff --git a/language/predefined/error/gettrace.xml b/language/predefined/error/gettrace.xml new file mode 100644 index 0000000000..5ada41a5fb --- /dev/null +++ b/language/predefined/error/gettrace.xml @@ -0,0 +1,106 @@ + + + + + + Error::getTrace + Gets the stack trace + + + + &reftitle.description; + + final public arrayError::getTrace + + + + Returns the stack trace. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns the stack trace as an array. + + + + + &reftitle.examples; + + + <function>Error::getTrace</function> example + +getTrace()); +} +?> +]]> + + &example.outputs.similar; + + + array(4) { + ["file"]=> + string(22) "/home/bjori/tmp/ex.php" + ["line"]=> + int(7) + ["function"]=> + string(4) "test" + ["args"]=> + array(0) { + } + } +} +]]> + + + + + + + &reftitle.seealso; + + + Throwable::getTrace + + + + + + + diff --git a/language/predefined/error/gettraceasstring.xml b/language/predefined/error/gettraceasstring.xml new file mode 100644 index 0000000000..86e0cd297b --- /dev/null +++ b/language/predefined/error/gettraceasstring.xml @@ -0,0 +1,94 @@ + + + + + + Error::getTraceAsString + Gets the stack trace as a string + + + + &reftitle.description; + + final public stringError::getTraceAsString + + + + Returns the stack trace as a string. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns the stack trace as a string. + + + + + &reftitle.examples; + + + <function>Error::getTraceAsString</function> example + +getTraceAsString(); +} +?> +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + Throwable::getTraceAsString + + + + + + + diff --git a/language/predefined/error/tostring.xml b/language/predefined/error/tostring.xml new file mode 100644 index 0000000000..eaa9aa13ee --- /dev/null +++ b/language/predefined/error/tostring.xml @@ -0,0 +1,91 @@ + + + + + + Error::__toString + String representation of the error + + + + &reftitle.description; + + public string Error::__toString + + + + Returns the string representation of the error. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns the string representation of the error. + + + + + &reftitle.examples; + + + <function>Error::__toString</function> example + + +]]> + + &example.outputs.similar; + + + + + + + + + &reftitle.seealso; + + + Throwable::__toString + + + + + + + diff --git a/language/predefined/exception/construct.xml b/language/predefined/exception/construct.xml index d9ba40ae02..1187b059d0 100644 --- a/language/predefined/exception/construct.xml +++ b/language/predefined/exception/construct.xml @@ -13,7 +13,7 @@ public Exception::__construct stringmessage"" intcode0 - Exceptionprevious&null; + Throwableprevious&null; Constructs the Exception. @@ -64,6 +64,12 @@ + + 7.0.0 + + The previous parameter is now of type Throwable. + + 5.3.0