From d960106581fd3cc7010269c01a97753fe470d5d5 Mon Sep 17 00:00:00 2001 From: Christoph Michael Becker Date: Fri, 30 Oct 2020 16:38:02 +0000 Subject: [PATCH] Document ReflectionProperty::getDefaultValue and ::hasDefaultValue Patch provided by Benjamin Eberlei . git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351090 c90b9560-bf6c-de11-be94-00142212c4b1 --- .../reflectionproperty/getdefaultvalue.xml | 100 ++++++++++++++++++ .../reflectionproperty/hasdefaultvalue.xml | 100 ++++++++++++++++++ reference/reflection/versions.xml | 2 + 3 files changed, 202 insertions(+) create mode 100644 reference/reflection/reflectionproperty/getdefaultvalue.xml create mode 100644 reference/reflection/reflectionproperty/hasdefaultvalue.xml diff --git a/reference/reflection/reflectionproperty/getdefaultvalue.xml b/reference/reflection/reflectionproperty/getdefaultvalue.xml new file mode 100644 index 0000000000..235143bb5a --- /dev/null +++ b/reference/reflection/reflectionproperty/getdefaultvalue.xml @@ -0,0 +1,100 @@ + + + + + + ReflectionProperty::getDefaultValue + Returns the default value declared for a property + + + + &reftitle.description; + + public mixedReflectionProperty::getDefaultValue + + + + Gets the implicit or explicitly declared default value for a property. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + The default value if the property has any default value (including &null;). + If there is no default value, then &null; is returned. It is not possible to differentiate + between a &null; default value and an unitialized typed property. + Use ReflectionClass::hasDefaultValue to detect the difference. + + + + + &reftitle.examples; + + + <methodname>ReflectionClass::getDefaultValue</methodname> example + +getProperty('bar')->getDefaultValue()); +var_dump($ro->getProperty('baz')->getDefaultValue()); +var_dump($ro->getProperty('boing')->getDefaultValue()); +?> +]]> + + &example.outputs; + + + + + + + + + &reftitle.seealso; + + + ReflectionProperty::hasDefaultValue + + + + + + + + diff --git a/reference/reflection/reflectionproperty/hasdefaultvalue.xml b/reference/reflection/reflectionproperty/hasdefaultvalue.xml new file mode 100644 index 0000000000..610abea783 --- /dev/null +++ b/reference/reflection/reflectionproperty/hasdefaultvalue.xml @@ -0,0 +1,100 @@ + + + + + + ReflectionProperty::hasDefaultValue + Checks if property has a default value declared + + + + &reftitle.description; + + public boolReflectionProperty::hasDefaultValue + + + + Checks whether the property was declared with a default value, including an implicit + &null; default value. Only returns &false; for typed properties without default value (or + dynamic properties). + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + If the property has any default value (including &null;) &true; is returned; + if the property is typed without a default value declared or is a dynamic property, &false; is returned. + + + + + &reftitle.examples; + + + <methodname>ReflectionClass::hasDefaultValue</methodname> example + +getProperty('bar')->hasDefaultValue()); +var_dump($ro->getProperty('baz')->hasDefaultValue()); +var_dump($ro->getProperty('boing')->hasDefaultValue()); +?> +]]> + + &example.outputs; + + + + + + + + + &reftitle.seealso; + + + ReflectionProperty::getDefaultValue + + + + + + + + diff --git a/reference/reflection/versions.xml b/reference/reflection/versions.xml index a0384021f1..c80247962c 100644 --- a/reference/reflection/versions.xml +++ b/reference/reflection/versions.xml @@ -286,6 +286,8 @@ + +