php/archived-doc-en
1
0
Fork 0
mirror of https://github.com/php/doc-en.git synced 2026-03-24 07:42:10 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update SPL class construtor pages (#1466)

Browse Source 
Add missing changelogs for changes in PHP 8
This commit is contained in:
George Peter Banyard
2022-04-07 12:40:48 +01:00
committed by GitHub
parent 15244038c7
commit fda6c4efe2
27 changed files with 193 additions and 233 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
reference/spl/appenditerator/construct.xml
View File

@@ -21,14 +21,7 @@
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="examples"><!-- {{{ -->
&reftitle.examples;
<para>

15
reference/spl/arrayiterator/construct.xml
View File

@@ -46,21 +46,6 @@
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
An <classname>ArrayIterator</classname> <type>object</type>.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<function>ArrayIterator::__construct</function> throws an
<classname>InvalidArgumentException</classname> if anything besides an array or an object is given.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>

34
reference/spl/arrayobject/construct.xml
View File

@@ -46,6 +46,7 @@
<listitem>
<para>
Specify the class that will be used for iteration of the <classname>ArrayObject</classname> object.
The class must implement <interfacename>Iterator</interfacename>.
</para>
</listitem>
</varlistentry>
@@ -53,39 +54,6 @@
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an ArrayObject object on success.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Throws <classname>InvalidArgumentException</classname> when:
<itemizedlist>
<listitem>
<simpara>
<parameter>array</parameter> is not an array or object
</simpara>
</listitem>
<listitem>
<simpara>
<parameter>flags</parameter> is not an integer
</simpara>
</listitem>
<listitem>
<simpara>
<parameter>iteratorClass</parameter> is not an object that implements
<classname>Iterator</classname>
</simpara>
</listitem>
</itemizedlist>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>

7
reference/spl/callbackfilteriterator/construct.xml
View File

@@ -46,13 +46,6 @@
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>

30
reference/spl/directoryiterator/construct.xml
View File

@@ -38,13 +38,39 @@
&reftitle.errors;
<para>
Throws an <classname>UnexpectedValueException</classname>
if the <parameter>directory</parameter> cannot be opened.
if the <parameter>directory</parameter> does not exist.
</para>
<para>
Throws a <classname>RuntimeException</classname>
Throws a <classname>ValueError</classname>
if the <parameter>directory</parameter> is an empty string.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
Now throws a <classname>ValueError</classname> if
<parameter>directory</parameter> is an empty string;
previously it threw a <classname>RuntimeException</classname>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;

39
reference/spl/filesystemiterator/construct.xml
View File

@@ -51,18 +51,41 @@
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Throws an <classname>UnexpectedValueException</classname>
if the <parameter>directory</parameter> cannot be found.
if the <parameter>directory</parameter> does not exist.
</para>
<para>
Throws a <classname>ValueError</classname>
if the <parameter>directory</parameter> is an empty string.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
Now throws a <classname>ValueError</classname> if
<parameter>directory</parameter> is an empty string;
previously it threw a <classname>RuntimeException</classname>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>

7
reference/spl/filteriterator/construct.xml
View File

@@ -37,13 +37,6 @@
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The <classname>FilterIterator</classname>.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>

38
reference/spl/globiterator/construct.xml
View File

@@ -43,6 +43,44 @@
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Throws an <classname>UnexpectedValueException</classname>
if the <parameter>directory</parameter> does not exist.
</para>
<para>
Throws a <classname>ValueError</classname>
if the <parameter>directory</parameter> is an empty string.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
Now throws a <classname>ValueError</classname> if
<parameter>directory</parameter> is an empty string;
previously it threw a <classname>RuntimeException</classname>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>

16
reference/spl/infiniteiterator/construct.xml
View File

@@ -35,22 +35,6 @@
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Throws an <constant>E_RECOVERABLE_ERROR</constant> if the
<parameter>iterator</parameter> parameter is not
an <classname>Iterator</classname>.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>

7
reference/spl/iteratoriterator/construct.xml
View File

@@ -34,13 +34,6 @@
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>

43
reference/spl/limititerator/construct.xml
View File

@@ -53,22 +53,49 @@
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The new <classname>LimitIterator</classname>.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Throws an <classname>OutOfRangeException</classname>
Throws a <classname>ValueError</classname>
if the <parameter>offset</parameter> is less than <literal>0</literal>
or the <parameter>limit</parameter> is less than <literal>-1</literal>.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
Now throws a <classname>ValueError</classname> if
<parameter>offset</parameter> is less than <literal>0</literal>;
previously it threw a <classname>RuntimeException</classname>.
</entry>
</row>
<row>
<entry>8.0.0</entry>
<entry>
Now throws a <classname>ValueError</classname> if
<parameter>limit</parameter> is less than <literal>-1</literal>;
previously it threw a <classname>RuntimeException</classname>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>

9
reference/spl/multipleiterator/construct.xml
View File

@@ -42,14 +42,7 @@
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="examples"><!-- {{{ -->
&reftitle.examples;
<para>

8
reference/spl/norewinditerator/construct.xml
View File

@@ -33,14 +33,6 @@
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A <methodname>NoRewindIterator</methodname> based on the passed in
<parameter>iterator</parameter>.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>

8
reference/spl/parentiterator/construct.xml
View File

@@ -36,14 +36,6 @@
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The <classname>ParentIterator</classname>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

7
reference/spl/recursivecachingiterator/construct.xml
View File

@@ -48,13 +48,6 @@
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The <classname>RecursiveCachingIterator</classname>.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>

7
reference/spl/recursivecallbackfilteriterator/construct.xml
View File

@@ -47,13 +47,6 @@
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>

39
reference/spl/recursivedirectoryiterator/construct.xml
View File

@@ -46,18 +46,41 @@
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the newly created <classname>RecursiveDirectoryIterator</classname>.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Throws an <classname>UnexpectedValueException</classname>
if the <parameter>directory</parameter> cannot be found or is not a directory.
if the <parameter>directory</parameter> does not exist.
</para>
<para>
Throws a <classname>ValueError</classname>
if the <parameter>directory</parameter> is an empty string.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
Now throws a <classname>ValueError</classname> if
<parameter>directory</parameter> is an empty string;
previously it threw a <classname>RuntimeException</classname>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>

7
reference/spl/recursivefilteriterator/construct.xml
View File

@@ -34,13 +34,6 @@
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>

8
reference/spl/recursiveiteratoriterator/construct.xml
View File

@@ -67,14 +67,6 @@
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="examples"><!-- {{{ -->
&reftitle.examples;
<para>

8
reference/spl/recursivetreeiterator/construct.xml
View File

@@ -64,14 +64,6 @@
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

7
reference/spl/splfileobject/construct.xml
View File

@@ -61,13 +61,6 @@
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>

38
reference/spl/splfixedarray/construct.xml
View File

@@ -33,22 +33,38 @@
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Throws <classname>InvalidArgumentException</classname> when <parameter>size</parameter> is a negative
number.
Throws a <classname>ValueError</classname> when <parameter>size</parameter>
is a negative integer.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
Raises <constant>E_WARNING</constant> when <parameter>size</parameter> cannot be parsed as a number.
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
Now throws a <classname>ValueError</classname> if
<parameter>size</parameter> is a negative;
previously it threw a <classname>InvalidArgumentException</classname>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>

7
reference/spl/splheap/construct.xml
View File

@@ -22,13 +22,6 @@
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

7
reference/spl/splpriorityqueue/construct.xml
View File

@@ -22,13 +22,6 @@
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

7
reference/spl/splqueue/construct.xml
View File

@@ -28,13 +28,6 @@
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>

7
reference/spl/splstack/construct.xml
View File

@@ -28,13 +28,6 @@
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>

7
reference/spl/spltempfileobject/construct.xml
View File

@@ -40,13 +40,6 @@
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>