php-doc-en/reference/reflection/reflectionparameter.xml

108 lines
3.2 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.reflectionparameter" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The ReflectionParameter class</title>
<titleabbrev>ReflectionParameter</titleabbrev>
<partintro>
<!-- {{{ ReflectionParameter intro -->
<section xml:id="reflectionparameter.intro">
&reftitle.intro;
<para>
The <classname>ReflectionParameter</classname> class retrieves
information about function's or method's parameters.
</para>
<para>
To introspect function parameters, first create an instance
of the <classname>ReflectionFunction</classname> or
<classname>ReflectionMethod</classname> classes and then use their
<methodname>ReflectionFunctionAbstract::getParameters</methodname> method
to retrieve an array of parameters.
</para>
</section>
<!-- }}} -->
<section xml:id="reflectionparameter.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass>
<classname>ReflectionParameter</classname>
</ooclass>
<classsynopsisinfo>
<ooclass>
<classname>ReflectionParameter</classname>
</ooclass>
<oointerface>
<interfacename>Reflector</interfacename>
</oointerface>
</classsynopsisinfo>
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
<fieldsynopsis>
<modifier>public</modifier>
<type>string</type>
<varname linkend="reflectionparameter.props.name">name</varname>
</fieldsynopsis>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.reflectionparameter')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])">
<xi:fallback/>
</xi:include>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.reflectionparameter')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])">
<xi:fallback/>
</xi:include>
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ ReflectionParameter properties -->
<section xml:id="reflectionparameter.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="reflectionparameter.props.name">
<term><varname>name</varname></term>
<listitem>
<para>
Name of the parameter. Read-only, throws
<classname>ReflectionException</classname> in attempt to write.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
</partintro>
&reference.reflection.entities.reflectionparameter;
</phpdoc:classref>
<!-- 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
-->