Hooks reflection (#4110)

* Add reflection stubs for property hooks * Document getHook(). * Document hasHook() * Document getSettableType() * Document getHooks() * Document hasHooks() * Document isFinal() * Document isPrivateSet() and isProtectedSet() * Document setRawValue() * Document getRawValue() * Document isVirtual() * Document PropertyHookType. * Document isAbstract() --------- Co-authored-by: Gina Peter Banyard <girgias@php.net>
php · Feb 21, 2025 · e0e74c0 · e0e74c0
1 parent 2c6c9a4
commit e0e74c0
Show file tree

Hide file tree

Showing 16 changed files with 1,166 additions and 0 deletions.
diff --git a/reference/reflection/book.xml b/reference/reflection/book.xml
@@ -50,6 +50,7 @@
  &reference.reflection.reflectionattribute;
  &reference.reflection.reflector;
  &reference.reflection.reflectionexception;
+ &reference.reflection.propertyhooktype;
 
 </book>
 

diff --git a/reference/reflection/propertyhooktype.xml b/reference/reflection/propertyhooktype.xml
@@ -0,0 +1,57 @@
+<?xml version="1.0" encoding="utf-8"?>
+<reference xmlns="http://docbook.org/ns/docbook" xml:id="enum.reflection.propertyhooktype" role="enum">
+ <title>The \PropertyHookType Enum</title>
+ <titleabbrev>\PropertyHookType</titleabbrev>
+
+ <partintro>
+  <section xml:id="enum.reflection.propertyhooktype.intro">
+   &reftitle.intro;
+   <simpara>
+    The <enumname>\PropertyHookType</enumname> enum lists the legal
+    types of <link linkend="language.oop5.property-hooks">property hook</link>.
+   </simpara>
+  </section>
+
+  <section xml:id="enum.reflection.propertyhooktype.synopsis">
+   &reftitle.enumsynopsis;
+
+   <enumsynopsis>
+    <enumname>\PropertyHookType</enumname>
+
+    <enumitem>
+     <enumidentifier>Get</enumidentifier>
+     <enumitemdescription>
+      Indicates a <literal>get</literal> hook.
+     </enumitemdescription>
+    </enumitem>
+
+    <enumitem>
+     <enumidentifier>Set</enumidentifier>
+     <enumitemdescription>
+      Indicates a <literal>set</literal> hook.
+     </enumitemdescription>
+    </enumitem>
+   </enumsynopsis>
+  </section>
+ </partintro>
+</reference>
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/reference/reflection/reflectionproperty/gethook.xml b/reference/reflection/reflectionproperty/gethook.xml
@@ -0,0 +1,91 @@
+<?xml version="1.0" encoding="utf-8"?>
+<refentry xml:id="reflectionproperty.gethook" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>ReflectionProperty::getHook</refname>
+  <refpurpose>Returns a reflection object for a specified hook.</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis role="ReflectionProperty">
+   <modifier>public</modifier> <type class="union"><type>ReflectionMethod</type><type>null</type></type><methodname>ReflectionProperty::getHook</methodname>
+   <methodparam><type>PropertyHookType</type><parameter>type</parameter></methodparam>
+  </methodsynopsis>
+  <simpara>
+   Gets the reflection of the property's hook, if any.
+  </simpara>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <variablelist>
+   <varlistentry>
+    <term><parameter>PropertyHookType</parameter></term>
+    <listitem>
+     <simpara>
+      The type of hook to request.
+     </simpara>
+    </listitem>
+   </varlistentry>
+  </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <simpara>
+   If the requested hook is defined, a <classname>ReflectionMethod</classname> instance will be returned.
+   If not, the method will return &null;
+  </simpara>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <example xml:id="reflectionproperty.gethook.example.basic">
+   <title><methodname>ReflectionProperty::getHook</methodname> example</title>
+   <programlisting role="php">
+<![CDATA[
+<?php
+class Example
+{
+    public string $name { get => "Name here"; }
+}
+
+$rClass = new \ReflectionClass(Example::class);
+$rProp = $rClass->getProperty('name');
+var_dump($rProp->getHook(PropertyHookType::Get));
+var_dump($rProp->getHook(PropertyHookType::Set));
+?>
+]]>
+   </programlisting>
+  </example>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <simplelist>
+   <member><classname>ReflectionMethod</classname></member>
+   <member><classname>PropertyHookType</classname></member>
+  </simplelist>
+ </refsect1>
+
+</refentry>
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/reference/reflection/reflectionproperty/gethooks.xml b/reference/reflection/reflectionproperty/gethooks.xml
@@ -0,0 +1,91 @@
+<?xml version="1.0" encoding="utf-8"?>
+<refentry xml:id="reflectionproperty.gethooks" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>ReflectionProperty::getHooks</refname>
+  <refpurpose>Returns an array of all hooks on this property</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis role="ReflectionProperty">
+   <modifier>public</modifier> <type>array</type><methodname>ReflectionProperty::getHooks</methodname>
+   <void/>
+  </methodsynopsis>
+  <simpara>
+   Returns a list of all hooks on this property.
+  </simpara>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <simpara>
+   An array of <classname>ReflectionMethod</classname> objects keyed by the hook they are for.
+   For example, a property with both <literal>get</literal> and <literal>set</literal> hooks will return
+   a 2 element array with string keys <literal>get</literal> and <literal>set</literal>,
+   each of which are a <classname>ReflectionMethod</classname> object.
+   The order in which they are returned is explicitly undefined.
+   If no hooks are defined, an empty array is returned.
+  </simpara>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <example xml:id="reflectionproperty.gethooks.example.basic">
+   <title><methodname>ReflectionProperty::getHooks</methodname> example</title>
+   <programlisting role="php">
+<![CDATA[
+<?php
+class Example
+{
+    public string $name { get => "Name here"; }
+
+    public int $count;
+}
+
+$rClass = new \ReflectionClass(Example::class);
+
+$rProp = $rClass->getProperty('name');
+var_dump($rProp->getHooks());
+
+$rProp = $rClass->getProperty('count');
+var_dump($rProp->getHooks());
+?>
+]]>
+   </programlisting>
+  </example>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <simplelist>
+   <member><classname>ReflectionMethod</classname></member>
+   <member><methodname>ReflectionProperty::hasHooks</methodname></member>
+  </simplelist>
+ </refsect1>
+
+</refentry>
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/reference/reflection/reflectionproperty/getrawvalue.xml b/reference/reflection/reflectionproperty/getrawvalue.xml
@@ -0,0 +1,108 @@
+<?xml version="1.0" encoding="utf-8"?>
+<refentry xml:id="reflectionproperty.getrawvalue" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>ReflectionProperty::getRawValue</refname>
+  <refpurpose>Returns the value of a property, bypassing a get hook if defined</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis role="ReflectionProperty">
+   <modifier>public</modifier> <type>mixed</type><methodname>ReflectionProperty::getRawValue</methodname>
+   <methodparam><type>object</type><parameter>object</parameter></methodparam>
+  </methodsynopsis>
+  &warn.undocumented.func;
+  <simpara>
+   Returns the value of a property, bypassing a <literal>get</literal> hook if defined.
+  </simpara>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <variablelist>
+   <varlistentry>
+    <term><parameter>object</parameter></term>
+    <listitem>
+     <simpara>
+      The object from which to retrieve a value.
+     </simpara>
+    </listitem>
+   </varlistentry>
+  </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <simpara>
+   The stored value of the property, bypassing a <literal>get</literal> hook if defined.
+  </simpara>
+ </refsect1>
+
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <simpara>
+   If the property is virtual, an <classname>Error</classname> will be thrown,
+   as there is no raw value to retrieve.
+  </simpara>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <example xml:id="reflectionproperty.getrawvalue.example.basic">
+   <title><methodname>ReflectionProperty::getRawValue</methodname> example</title>
+   <programlisting role="php">
+<![CDATA[
+<?php
+class Example
+{
+    public string $tag {
+        get => strtolower($this->tag);
+    }
+}
+
+$example = new Example();
+$example->tag = 'PHP';
+
+$rClass = new \ReflectionClass(Example::class);
+$rProp = $rClass->getProperty('tag');
+
+// These would go through the get hook, so would produce "php".
+print $example->tag;
+print $rProp->getValue($example);
+
+// But this would bypass the hook and produce "PHP".
+print $rProp->setRawValue($example);
+?>
+]]>
+   </programlisting>
+  </example>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <simplelist>
+   <member><link linkend="language.oop5.visibility-members-aviz">Asymmetric property visibility</link></member>
+  </simplelist>
+ </refsect1>
+
+</refentry>
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->