1
0
mirror of https://github.com/php/doc-en.git synced 2026-03-23 23:32:18 +01:00
Files

108 lines
2.7 KiB
XML

<?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.outputs;
<screen>
<![CDATA[
array(1) {
["get"]=>
object(ReflectionMethod)#3 (2) {
["name"]=>
string(10) "$name::get"
["class"]=>
string(7) "Example"
}
}
array(0) {
}
]]>
</screen>
</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
-->