diff --git a/reference/reflection/book.xml b/reference/reflection/book.xml index bd371343a58a..859b14788231 100644 --- a/reference/reflection/book.xml +++ b/reference/reflection/book.xml @@ -28,6 +28,7 @@ &reference.reflection.reflection; &reference.reflection.reflectionclass; &reference.reflection.reflectionclassconstant; + &reference.reflection.reflectionconstant; &reference.reflection.reflectionenum; &reference.reflection.reflectionenumunitcase; &reference.reflection.reflectionenumbackedcase; diff --git a/reference/reflection/reflectionconstant.xml b/reference/reflection/reflectionconstant.xml new file mode 100644 index 000000000000..d9f3830184f7 --- /dev/null +++ b/reference/reflection/reflectionconstant.xml @@ -0,0 +1,93 @@ + + + The ReflectionConstant class + ReflectionConstant + + +
+ &reftitle.intro; + + The ReflectionConstant class reports + information about a global constant. + +
+ +
+ &reftitle.classsynopsis; + + + + final + ReflectionConstant + + + + implements + Reflector + + + &Properties; + + public + string + name + + + &Methods; + + + + + + + + +
+ +
+ &reftitle.properties; + + + name + + + Name of the constant. Read-only, throws + ReflectionException in attempt to write. + + + + +
+ +
+ &reftitle.seealso; + + ReflectionClassConstant + +
+ + + + &reference.reflection.entities.reflectionconstant; + + + diff --git a/reference/reflection/reflectionconstant/construct.xml b/reference/reflection/reflectionconstant/construct.xml new file mode 100644 index 000000000000..6cffbc3f745d --- /dev/null +++ b/reference/reflection/reflectionconstant/construct.xml @@ -0,0 +1,68 @@ + + + + ReflectionConstant::__construct + Constructs a ReflectionConstant + + + + &reftitle.description; + + public ReflectionConstant::__construct + stringname + + + Constructs a new ReflectionConstant object. + + + + + &reftitle.parameters; + + + name + + + The name of the constant. + + + + + + + + &reftitle.errors; + + Throws a ReflectionException in case the given + constant does not exist. + + + + + &reftitle.seealso; + + Constructors + + + + + diff --git a/reference/reflection/reflectionconstant/getextension.xml b/reference/reflection/reflectionconstant/getextension.xml new file mode 100644 index 000000000000..e488abadc96f --- /dev/null +++ b/reference/reflection/reflectionconstant/getextension.xml @@ -0,0 +1,83 @@ + + + + ReflectionConstant::getExtension + Gets ReflectionExtension of the defining extension + + + + &reftitle.description; + + public ReflectionExtensionnullReflectionConstant::getExtension + + + + Gets a ReflectionExtension object for the extension + which defined the constant. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + A ReflectionExtension object representing the + extension which defined the constant, or &null; for user-defined constants. + + + + + &reftitle.examples; + + Basic usage of <methodname>ReflectionConstant::getExtension</methodname> + +getExtension()); +?> +]]> + + &example.outputs; + + + string(7) "sqlite3" +} +]]> + + + + + + &reftitle.seealso; + + ReflectionConstant::getExtensionName + + + + + diff --git a/reference/reflection/reflectionconstant/getextensionname.xml b/reference/reflection/reflectionconstant/getextensionname.xml new file mode 100644 index 000000000000..e875731ff4c0 --- /dev/null +++ b/reference/reflection/reflectionconstant/getextensionname.xml @@ -0,0 +1,78 @@ + + + + ReflectionConstant::getExtensionName + Gets name of the defining extension + + + + &reftitle.description; + + public stringfalseReflectionConstant::getExtensionName + + + + Gets the name of the extension which defined the constant. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + The name of the extension which defined the constant, or &false; for user-defined constants. + + + + + &reftitle.examples; + + Basic usage of <methodname>ReflectionConstant::getExtensionName</methodname> + +getExtensionName()); +?> +]]> + + &example.outputs; + + + + + + + + &reftitle.seealso; + + ReflectionConstant::getExtension + + + + + diff --git a/reference/reflection/reflectionconstant/getfilename.xml b/reference/reflection/reflectionconstant/getfilename.xml new file mode 100644 index 000000000000..15b1625133f3 --- /dev/null +++ b/reference/reflection/reflectionconstant/getfilename.xml @@ -0,0 +1,54 @@ + + + + ReflectionConstant::getFileName + Gets name of the defining file + + + + &reftitle.description; + + public stringfalseReflectionConstant::getFileName + + + + Gets the filename of the file in which the constant has been defined. + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns the filename of the file in which the constant has been defined. + If the constant is defined in the PHP core or in a PHP extension, + &false; is returned. + + + + + diff --git a/reference/reflection/reflectionconstant/getname.xml b/reference/reflection/reflectionconstant/getname.xml new file mode 100644 index 000000000000..083c50988864 --- /dev/null +++ b/reference/reflection/reflectionconstant/getname.xml @@ -0,0 +1,82 @@ + + + + ReflectionConstant::getName + Gets name + + + + &reftitle.description; + + public stringReflectionConstant::getName + + + + Gets the name of the constant. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + The constants name, which is composed of its namespace and name. + + + + + &reftitle.examples; + + <methodname>ReflectionConstant::getName</methodname> example + +getName(); +?> +]]> + + &example.outputs; + + + + + + + + &reftitle.seealso; + + ReflectionConstant::getNamespaceName + + + + + diff --git a/reference/reflection/reflectionconstant/getnamespacename.xml b/reference/reflection/reflectionconstant/getnamespacename.xml new file mode 100644 index 000000000000..aaefa40f865d --- /dev/null +++ b/reference/reflection/reflectionconstant/getnamespacename.xml @@ -0,0 +1,80 @@ + + + + ReflectionConstant::getNamespaceName + Gets namespace name + + + + &reftitle.description; + + public stringReflectionConstant::getNamespaceName + + + + Gets the namespace name of the constant. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + The namespace name, or an empty string for the global namespace. + + + + + &reftitle.examples; + + <methodname>ReflectionConstant::getNamespaceName</methodname> example + +getNamespaceName()); +} + +namespace { + const BAR = 'bar'; + var_dump((new \ReflectionConstant('BAR'))->getNamespaceName()); +} +?> +]]> + + &example.outputs; + + + + + + + + diff --git a/reference/reflection/reflectionconstant/getshortname.xml b/reference/reflection/reflectionconstant/getshortname.xml new file mode 100644 index 000000000000..8a419067f7ff --- /dev/null +++ b/reference/reflection/reflectionconstant/getshortname.xml @@ -0,0 +1,82 @@ + + + + ReflectionConstant::getShortName + Gets short name + + + + &reftitle.description; + + public stringReflectionConstant::getShortName + + + + Gets the short name of the constant, the part without the namespace. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + The short name of the constant. + + + + + &reftitle.examples; + + <methodname>ReflectionConstant::getShortName</methodname> example + +getName(); +?> +]]> + + &example.outputs; + + + + + + + + &reftitle.seealso; + + ReflectionConstant::getName + + + + + diff --git a/reference/reflection/reflectionconstant/getvalue.xml b/reference/reflection/reflectionconstant/getvalue.xml new file mode 100644 index 000000000000..43bb3d4d7ac5 --- /dev/null +++ b/reference/reflection/reflectionconstant/getvalue.xml @@ -0,0 +1,73 @@ + + + + ReflectionConstant::getValue + Gets value + + + + &reftitle.description; + + public mixedReflectionConstant::getValue + + + + Gets the value of the constant. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + The value of the constant. + + + + + &reftitle.examples; + + <methodname>ReflectionProperty::getValue</methodname> example + +getValue()); +?> +]]> + + &example.outputs; + + + + + + + + diff --git a/reference/reflection/reflectionconstant/isdeprecated.xml b/reference/reflection/reflectionconstant/isdeprecated.xml new file mode 100644 index 000000000000..bb6d328d421d --- /dev/null +++ b/reference/reflection/reflectionconstant/isdeprecated.xml @@ -0,0 +1,75 @@ + + + + ReflectionConstant::isDeprecated + Checks if deprecated + + + + &reftitle.description; + + public boolReflectionConstant::isDeprecated + + + + Checks whether the constant is deprecated. + + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + &true; if it's deprecated, otherwise &false; + + + + + &reftitle.examples; + + + <methodname>ReflectionConstant::isDeprecated</methodname> example + + +isDeprecated()); +?> +]]> + + &example.outputs.84; + + + + + + + + diff --git a/reference/reflection/reflectionconstant/tostring.xml b/reference/reflection/reflectionconstant/tostring.xml new file mode 100644 index 000000000000..dc82fbfc86fd --- /dev/null +++ b/reference/reflection/reflectionconstant/tostring.xml @@ -0,0 +1,59 @@ + + + + ReflectionConstant::__toString + Returns string representation + + + + &reftitle.description; + + public stringReflectionConstant::__toString + + + + Returns the string representation of the + ReflectionConstant object. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + A string representation of this ReflectionConstant instance. + + + + + &reftitle.seealso; + + __toString() + + + + + diff --git a/reference/reflection/versions.xml b/reference/reflection/versions.xml index fc4b5fe39158..ac4a417018d5 100644 --- a/reference/reflection/versions.xml +++ b/reference/reflection/versions.xml @@ -292,6 +292,18 @@ + + + + + + + + + + + +