svn: /phpdoc/en/trunk/reference/phar/PharData/ construct.xml
| From: | Adam Harvey | Date: | Thu, 23 Sep 2010 04:52:30 +0000 |
| Subject: | svn: /phpdoc/en/trunk/reference/phar/PharData/ construct.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-7152@lists.php.net to get a copy of this message | ||
aharvey Thu, 23 Sep 2010 04:52:30 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=303712
Log:
Fix doc bug #52909 by documenting the extra parameters available in
PharData::__construct().
Bug: http://bugs.php.net/52909 (Assigned)
ReflectionMethod::getParameters() return incorrect number of arguments
Changed paths:
U phpdoc/en/trunk/reference/phar/PharData/construct.xml
Modified: phpdoc/en/trunk/reference/phar/PharData/construct.xml
===================================================================
--- phpdoc/en/trunk/reference/phar/PharData/construct.xml 2010-09-23 04:51:02 UTC (rev 303711)
+++ phpdoc/en/trunk/reference/phar/PharData/construct.xml 2010-09-23 04:52:30 UTC (rev 303712)
@@ -11,6 +11,8 @@
<type>void</type><methodname>PharData::__construct</methodname>
<methodparam><type>string</type><parameter>fname</parameter></methodparam>
<methodparam
choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
+ <methodparam
choice="opt"><type>string</type><parameter>alias</parameter></methodparam>
+ <methodparam
choice="opt"><type>int</type><parameter>format</parameter><initializer><constant>Phar::TAR</constant></initializer></methodparam>
</methodsynopsis>
</refsect1>
@@ -30,10 +32,30 @@
<term><parameter>flags</parameter></term>
<listitem>
<para>
- Flags to pass to <classname>Phar</classname> parent class
<classname>RecursiveDirectoryIterator</classname>.
+ Flags to pass to <classname>Phar</classname> parent class
+ <classname>RecursiveDirectoryIterator</classname>.
</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><parameter>alias</parameter></term>
+ <listitem>
+ <para>
+ Alias with which this Phar archive should be referred to in calls to stream
+ functionality.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>format</parameter></term>
+ <listitem>
+ <para>
+ One of the
+ <link linkend="phar.constants.fileformat">file format constants</link>
+ available within the <classname>Phar</classname> class.
+ </para>
+ </listitem>
+ </varlistentry>
</variablelist>
</para>
</refsect1>
@@ -41,8 +63,9 @@
<refsect1 role="errors">
&reftitle.errors;
<para>
- Throws BadMethodCallException if called twice, UnexpectedValueException
- if the phar archive can't be opened.
+ Throws <classname>BadMethodCallException</classname> if called twice;
+ <classname>UnexpectedValueException</classname> if the Phar archive can't
+ be opened.
</para>
</refsect1>