mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-21 11:28:55 +00:00
af4410a7e1
still using this, after discussion on the phpdoc list. From now on, manual.ced will need to be found at ~/.phpdoc/manual.ced. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@288721 c90b9560-bf6c-de11-be94-00142212c4b1
149 lines
3.3 KiB
XML
149 lines
3.3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="reflectionfunction.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>ReflectionFunction::__construct</refname>
|
|
<refpurpose>Constructs a ReflectionFunction object</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<methodname>ReflectionFunction::__construct</methodname>
|
|
<methodparam><type>string</type><parameter>name</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Constructs a <classname>ReflectionFunction</classname> object.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>name</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The name of the function to reflect.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.void;
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="errors">
|
|
&reftitle.errors;
|
|
<para>
|
|
A <classname>ReflectionException</classname> if the <parameter>name</parameter>
|
|
parameter does not contain a valid function.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><methodname>ReflectionFunction::__construct</methodname> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
/**
|
|
* A simple counter
|
|
*
|
|
* @return int
|
|
*/
|
|
function counter()
|
|
{
|
|
static $c = 0;
|
|
return ++$c;
|
|
}
|
|
|
|
// Create an instance of the ReflectionFunction class
|
|
$func = new ReflectionFunction('counter');
|
|
|
|
// Print out basic information
|
|
printf(
|
|
"===> The %s function '%s'\n".
|
|
" declared in %s\n".
|
|
" lines %d to %d\n",
|
|
$func->isInternal() ? 'internal' : 'user-defined',
|
|
$func->getName(),
|
|
$func->getFileName(),
|
|
$func->getStartLine(),
|
|
$func->getEndline()
|
|
);
|
|
|
|
// Print documentation comment
|
|
printf("---> Documentation:\n %s\n", var_export($func->getDocComment(), 1));
|
|
|
|
// Print static variables if existant
|
|
if ($statics = $func->getStaticVariables())
|
|
{
|
|
printf("---> Static variables: %s\n", var_export($statics, 1));
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
===> The user-defined function 'counter'
|
|
declared in /Users/philip/test.php
|
|
lines 7 to 11
|
|
---> Documentation:
|
|
'/**
|
|
* A simple counter
|
|
*
|
|
* @return int
|
|
*/'
|
|
---> Static variables: array (
|
|
'c' => 0,
|
|
)
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><methodname>ReflectionMethod::__construct</methodname></member>
|
|
<member><link linkend="language.oop5.decon.constructor">Constructors</link></member>
|
|
</simplelist>
|
|
</para>
|
|
</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
|
|
-->
|