svn: /phpdoc/en/trunk/reference/reflection/ reflectionextension/clone.xml reflectionextension/construct.xml reflectionextension/export.xml
reflectionextension/getconstants.xml reflectionextension/getinientries.xml reflectionextension/tostring.xml reflectionextension.xml
| From: | Kalle Sommer Nielsen | Date: | Fri, 28 May 2010 14:46:46 +0000 |
| Subject: | svn: /phpdoc/en/trunk/reference/reflection/ reflectionextension/clone.xml reflectionextension/construct.xml reflectionextension/export.xml reflectionextension/getconstants.xml reflectionextension/getinientries.xml reflectionextension/tostring.xml reflectionextension.xml |
||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-6755@lists.php.net to get a copy of this message | ||
kalle Fri, 28 May 2010 14:46:46 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=299908
Log:
Documented a couple undocumented methods and fixed some bugs here and there
Changed paths:
U phpdoc/en/trunk/reference/reflection/reflectionextension/clone.xml
U phpdoc/en/trunk/reference/reflection/reflectionextension/construct.xml
U phpdoc/en/trunk/reference/reflection/reflectionextension/export.xml
U phpdoc/en/trunk/reference/reflection/reflectionextension/getconstants.xml
U phpdoc/en/trunk/reference/reflection/reflectionextension/getinientries.xml
U phpdoc/en/trunk/reference/reflection/reflectionextension/tostring.xml
U phpdoc/en/trunk/reference/reflection/reflectionextension.xml
Modified: phpdoc/en/trunk/reference/reflection/reflectionextension/clone.xml
===================================================================
--- phpdoc/en/trunk/reference/reflection/reflectionextension/clone.xml 2010-05-28 13:29:05 UTC (rev
299907)
+++ phpdoc/en/trunk/reference/reflection/reflectionextension/clone.xml 2010-05-28 14:46:46 UTC (rev
299908)
@@ -14,11 +14,9 @@
<void />
</methodsynopsis>
<para>
- Clones.
+ The clone method prevents an object from being cloned. Reflection objects
+ cannot be cloned.
</para>
-
- &warn.undocumented.func;
-
</refsect1>
<refsect1 role="parameters">
@@ -29,7 +27,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
-
+ No value is returned, if called a fatal error will occur.
</para>
</refsect1>
Modified: phpdoc/en/trunk/reference/reflection/reflectionextension/construct.xml
===================================================================
--- phpdoc/en/trunk/reference/reflection/reflectionextension/construct.xml 2010-05-28 13:29:05 UTC
(rev 299907)
+++ phpdoc/en/trunk/reference/reflection/reflectionextension/construct.xml 2010-05-28 14:46:46 UTC
(rev 299908)
@@ -16,9 +16,6 @@
<para>
Construct a <classname>ReflectionExtension</classname>
<type>object</type>.
</para>
-
- &warn.undocumented.func;
-
</refsect1>
<refsect1 role="parameters">
@@ -44,6 +41,30 @@
</para>
</refsect1>
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title><classname>ReflectionExtension</classname> example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+$ext = new ReflectionExtension('Reflection');
+
+printf('Extension: %s (version: %s)', $ext->getName(), $ext->getVersion());
+?>
+]]>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
+<![CDATA[
+Extension: Reflection (version: $Revision$)
+]]>
+ </screen>
+ </example>
+ </para>
+ </refsect1>
+
<refsect1 role="seealso">
&reftitle.seealso;
<para>
Modified: phpdoc/en/trunk/reference/reflection/reflectionextension/export.xml
===================================================================
--- phpdoc/en/trunk/reference/reflection/reflectionextension/export.xml 2010-05-28 13:29:05 UTC (rev
299907)
+++ phpdoc/en/trunk/reference/reflection/reflectionextension/export.xml 2010-05-28 14:46:46 UTC (rev
299908)
@@ -15,11 +15,9 @@
<methodparam
choice="opt"><type>string</type><parameter>return</parameter><initializer>false</initializer></methodparam>
</methodsynopsis>
<para>
- Exports a reflected extension.
+ Exports a reflected extension. The output format of this function is
+ the same as the CLI argument <literal>--re [extension]</literal>.
</para>
-
- &warn.undocumented.func;
-
</refsect1>
<refsect1 role="parameters">
Modified: phpdoc/en/trunk/reference/reflection/reflectionextension/getconstants.xml
===================================================================
--- phpdoc/en/trunk/reference/reflection/reflectionextension/getconstants.xml 2010-05-28 13:29:05
UTC (rev 299907)
+++ phpdoc/en/trunk/reference/reflection/reflectionextension/getconstants.xml 2010-05-28 14:46:46
UTC (rev 299908)
@@ -34,7 +34,7 @@
&reftitle.examples;
<para>
<example>
- <title><methodname>ReflectionExtension::getClasses</methodname>
example</title>
+ <title><methodname>ReflectionExtension::getConstants</methodname>
example</title>
<programlisting role="php">
<![CDATA[
<?php
Modified: phpdoc/en/trunk/reference/reflection/reflectionextension/getinientries.xml
===================================================================
--- phpdoc/en/trunk/reference/reflection/reflectionextension/getinientries.xml 2010-05-28 13:29:05
UTC (rev 299907)
+++ phpdoc/en/trunk/reference/reflection/reflectionextension/getinientries.xml 2010-05-28 14:46:46
UTC (rev 299908)
@@ -35,13 +35,13 @@
&reftitle.examples;
<para>
<example>
- <title><methodname>ReflectionExtension::getFunctions</methodname>
example</title>
+ <title><methodname>ReflectionExtension::getINIEntries</methodname>
example</title>
<programlisting role="php">
<![CDATA[
<?php
-$dom = new ReflectionExtension('mysql');
+$ext = new ReflectionExtension('mysql');
-print_r($dom->getINIEntries());
+print_r($ext->getINIEntries());
?>
]]>
</programlisting>
Modified: phpdoc/en/trunk/reference/reflection/reflectionextension/tostring.xml
===================================================================
--- phpdoc/en/trunk/reference/reflection/reflectionextension/tostring.xml 2010-05-28 13:29:05 UTC
(rev 299907)
+++ phpdoc/en/trunk/reference/reflection/reflectionextension/tostring.xml 2010-05-28 14:46:46 UTC
(rev 299908)
@@ -14,11 +14,10 @@
<void />
</methodsynopsis>
<para>
- To a string.
+ Exports a reflected extension and returns it as a <type>string</type>. This
+ is the same as the <methodname>ReflectionExtension::export</methodname> with
+ the <parameter>return</parameter> set to &true;.
</para>
-
- &warn.undocumented.func;
-
</refsect1>
<refsect1 role="parameters">
@@ -29,7 +28,8 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- A string.
+ Returns the exported extension as a string, in the same way as the
+ <methodname>ReflectionExtension::export</methodname>.
</para>
</refsect1>
@@ -38,6 +38,7 @@
<para>
<simplelist>
<member><methodname>ReflectionExtension::__construct</methodname></member>
+ <member><methodname>ReflectionExtension::export</methodname></member>
<member><link
linkend="language.oop5.magic.tostring">__toString</link></member>
</simplelist>
</para>
Modified: phpdoc/en/trunk/reference/reflection/reflectionextension.xml
===================================================================
--- phpdoc/en/trunk/reference/reflection/reflectionextension.xml 2010-05-28 13:29:05 UTC (rev
299907)
+++ phpdoc/en/trunk/reference/reflection/reflectionextension.xml 2010-05-28 14:46:46 UTC (rev
299908)
@@ -58,7 +58,11 @@
<varlistentry xml:id="reflectionextension.props.name">
<term><varname>name</varname></term>
<listitem>
- <para>Prop description</para>
+ <para>
+ Name of the extension, same as calling the
+ <methodname>ReflectionExtension::getName</methodname>
+ method.
+ </para>
</listitem>
</varlistentry>
</variablelist>