From 24ec4b99dfa16a9dda8369a379a8734b9648538b Mon Sep 17 00:00:00 2001
From: Jakub Vrana <vrana@php.net>
Date: Thu, 16 May 2013 21:25:05 +0000
Subject: [PATCH] Document new Reflection methods

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@330252 c90b9560-bf6c-de11-be94-00142212c4b1
---
 .../reflection/reflectionclass/getmethods.xml |  2 +-
 .../getclosurescopeclass.xml                  | 58 ++++++++++++++++++
 .../isgenerator.xml                           | 59 +++++++++++++++++++
 .../getdefaultvalueconstantname.xml           | 58 ++++++++++++++++++
 .../reflectionparameter/iscallable.xml        | 59 +++++++++++++++++++
 .../isdefaultvalueconstant.xml                | 59 +++++++++++++++++++
 6 files changed, 294 insertions(+), 1 deletion(-)
 create mode 100644 reference/reflection/reflectionfunctionabstract/getclosurescopeclass.xml
 create mode 100644 reference/reflection/reflectionfunctionabstract/isgenerator.xml
 create mode 100644 reference/reflection/reflectionparameter/getdefaultvalueconstantname.xml
 create mode 100644 reference/reflection/reflectionparameter/iscallable.xml
 create mode 100644 reference/reflection/reflectionparameter/isdefaultvalueconstant.xml

diff --git a/reference/reflection/reflectionclass/getmethods.xml b/reference/reflection/reflectionclass/getmethods.xml
index 90b060b1d3..872974be89 100644
--- a/reference/reflection/reflectionclass/getmethods.xml
+++ b/reference/reflection/reflectionclass/getmethods.xml
@@ -11,7 +11,7 @@
   &reftitle.description;
   <methodsynopsis>
    <modifier>public</modifier> <type>array</type><methodname>ReflectionClass::getMethods</methodname>
-   <methodparam choice="opt"><type>long</type><parameter>filter</parameter></methodparam>
+   <methodparam choice="opt"><type>int</type><parameter>filter</parameter></methodparam>
   </methodsynopsis>
   <para>
    Gets an array of methods for the class.
diff --git a/reference/reflection/reflectionfunctionabstract/getclosurescopeclass.xml b/reference/reflection/reflectionfunctionabstract/getclosurescopeclass.xml
new file mode 100644
index 0000000000..3e5e15e645
--- /dev/null
+++ b/reference/reflection/reflectionfunctionabstract/getclosurescopeclass.xml
@@ -0,0 +1,58 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="reflectionfunctionabstract.getclosurescopeclass" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>ReflectionFunctionAbstract::getClosureScopeClass</refname>
+  <refpurpose>Returns the scope associated to the closure</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>ReflectionClass</type><methodname>ReflectionFunctionAbstract::getClosureScopeClass</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+
+  </para>
+
+  &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns the class on success or &null; on failure.
+  </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
+-->
diff --git a/reference/reflection/reflectionfunctionabstract/isgenerator.xml b/reference/reflection/reflectionfunctionabstract/isgenerator.xml
new file mode 100644
index 0000000000..c1fd00c28b
--- /dev/null
+++ b/reference/reflection/reflectionfunctionabstract/isgenerator.xml
@@ -0,0 +1,59 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="reflectionfunctionabstract.isgenerator" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>ReflectionFunctionAbstract::isGenerator</refname>
+  <refpurpose>Returns whether this function is a generator</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>bool</type><methodname>ReflectionFunctionAbstract::isGenerator</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+
+  </para>
+
+  &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns &true; if the function is generator, &false; if it is not or &null;
+   on failure.
+  </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
+-->
diff --git a/reference/reflection/reflectionparameter/getdefaultvalueconstantname.xml b/reference/reflection/reflectionparameter/getdefaultvalueconstantname.xml
new file mode 100644
index 0000000000..dc4aabe5da
--- /dev/null
+++ b/reference/reflection/reflectionparameter/getdefaultvalueconstantname.xml
@@ -0,0 +1,58 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="reflectionparameter.getdefaultvalueconstantname" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>ReflectionParameter::getDefaultValueConstantName</refname>
+  <refpurpose>Returns the default value's constant name if default value is constant or null</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>string</type><methodname>ReflectionParameter::getDefaultValueConstantName</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+
+  </para>
+
+  &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns string on success or &null; on failure.
+  </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
+-->
diff --git a/reference/reflection/reflectionparameter/iscallable.xml b/reference/reflection/reflectionparameter/iscallable.xml
new file mode 100644
index 0000000000..6fd4be9fdc
--- /dev/null
+++ b/reference/reflection/reflectionparameter/iscallable.xml
@@ -0,0 +1,59 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="reflectionparameter.iscallable" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>ReflectionParameter::isCallable</refname>
+  <refpurpose>Returns whether parameter MUST be callable</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>bool</type><methodname>ReflectionParameter::isCallable</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+
+  </para>
+
+  &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns &true; if the parameter is <type>callable</type>, &false; if it is
+   not or &null; on failure.
+  </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
+-->
diff --git a/reference/reflection/reflectionparameter/isdefaultvalueconstant.xml b/reference/reflection/reflectionparameter/isdefaultvalueconstant.xml
new file mode 100644
index 0000000000..093b32f268
--- /dev/null
+++ b/reference/reflection/reflectionparameter/isdefaultvalueconstant.xml
@@ -0,0 +1,59 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="reflectionparameter.isdefaultvalueconstant" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>ReflectionParameter::isDefaultValueConstant</refname>
+  <refpurpose>Returns whether the default value of this parameter is constant</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>bool</type><methodname>ReflectionParameter::isDefaultValueConstant</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+
+  </para>
+
+  &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns &true; if the default value is constant, &false; if it is not or
+   &null; on failure.
+  </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
+-->