php-doc-en/reference/spl/splfixedarray/construct.xml
2014-09-05 07:44:07 +00:00

108 lines
2.4 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="splfixedarray.construct" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>SplFixedArray::__construct</refname>
<refpurpose>Constructs a new fixed array</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<constructorsynopsis>
<modifier>public</modifier> <methodname>SplFixedArray::__construct</methodname>
<methodparam choice="opt"><type>int</type><parameter>size</parameter><initializer>0</initializer></methodparam>
</constructorsynopsis>
<para>
Initializes a fixed array with a number of &null; values equal to <parameter>size</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>size</parameter></term>
<listitem>
<para>
The size of the fixed array.
This expects a number between <literal>0</literal> and <constant>PHP_INT_MAX</constant>.
</para>
</listitem>
</varlistentry>
</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.
</para>
<para>
Raises <constant>E_WARNING</constant> when <parameter>size</parameter> cannot be parsed as a number.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>SplFixedArray::__construct</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$array = new SplFixedArray(5);
$array[1] = 2;
$array[4] = "foo";
foreach($array as $v) {
var_dump($v);
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
NULL
int(2)
NULL
NULL
string(3) "foo"
]]>
</screen>
</example>
</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
-->