mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 18:38:55 +00:00
9e0f03ac35
We markup variadic parameters with the `rep=repeat` standard DocBook attribute of `<methodparam>`, and use proper variable names instead of using the old pseudo variable name `...`. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351129 c90b9560-bf6c-de11-be94-00142212c4b1
159 lines
3.9 KiB
XML
159 lines
3.9 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.array-push" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>array_push</refname>
|
|
<refpurpose>Push one or more elements onto the end of array</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>int</type><methodname>array_push</methodname>
|
|
<methodparam><type>array</type><parameter role="reference">array</parameter></methodparam>
|
|
<methodparam rep="repeat"><type>mixed</type><parameter>values</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>array_push</function> treats <parameter>array</parameter> as a
|
|
stack, and pushes the passed variables onto the end of
|
|
<parameter>array</parameter>. The length of <parameter>array</parameter>
|
|
increases by the number of variables pushed. Has the same effect as:
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$array[] = $var;
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
repeated for each passed value.
|
|
</para>
|
|
<note>
|
|
<simpara>
|
|
If you use <function>array_push</function> to add one element to the
|
|
array, it's better to use <literal>$array[] = </literal> because in that
|
|
way there is no overhead of calling a function.
|
|
</simpara>
|
|
</note>
|
|
<note>
|
|
<simpara>
|
|
<function>array_push</function> will raise a warning if the first
|
|
argument is not an array. This differs from the
|
|
<literal>$var[]</literal> behaviour where a new array is created.
|
|
</simpara>
|
|
</note>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>array</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The input array.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>values</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The values to push onto the end of the <parameter>array</parameter>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the new number of elements in the array.
|
|
</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>7.3.0</entry>
|
|
<entry>
|
|
This function can now be called with only one parameter. Formerly, at
|
|
least two parameters have been required.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>array_push</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$stack = array("orange", "banana");
|
|
array_push($stack, "apple", "raspberry");
|
|
print_r($stack);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen role="php">
|
|
<![CDATA[
|
|
Array
|
|
(
|
|
[0] => orange
|
|
[1] => banana
|
|
[2] => apple
|
|
[3] => raspberry
|
|
)
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>array_pop</function></member>
|
|
<member><function>array_shift</function></member>
|
|
<member><function>array_unshift</function></member>
|
|
</simplelist>
|
|
</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
|
|
-->
|