array-shift.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: aba94933258b1d1ce9fa5935a239804d71a481fa Maintainer: HonestQiao Status: ready -->
<!-- Reviewed: no Maintainer: HonestQiao -->
<refentry xml:id="function.array-shift" xmlns="http://docbook.org/ns/docbook">
   <refnamediv>
    <refname>array_shift</refname>
    <refpurpose>
     将数组开头的单元移出数组
    </refpurpose>
   </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
     <methodsynopsis>
      <type>mixed</type><methodname>array_shift</methodname>
      <methodparam><type>array</type><parameter role="reference">array</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>array_shift</function> 将
     <parameter>array</parameter> 的第一个单元移出并作为结果返回，将
     <parameter>array</parameter> 的长度减一并将所有其它单元向前移动一位。所有的数字键名将改为从零开始计数，文字键名将不变。
    </para>
    &array.resetspointer;
   </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>array</parameter></term>
     <listitem>
      <para>
       输入的数组。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   返回移出的值，如果 <parameter>array</parameter> 为 空或不是一个数组则返回 &null;。
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
    <example>
     <title><function>array_shift</function> 例子</title>
     <programlisting role="php">
<![CDATA[
<?php
$stack = array("orange", "banana", "apple", "raspberry");
$fruit = array_shift($stack);
print_r($stack);
?>
]]>
     </programlisting>
     &example.outputs;
     <screen role="php">
<![CDATA[
Array
(
    [0] => banana
    [1] => apple
    [2] => raspberry
)
]]>
     </screen>
     <para>
      并且 <literal>orange</literal> 被赋给了 <varname>$fruit</varname>。
     </para>
    </example>
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>array_unshift</function></member>
    <member><function>array_push</function></member>
    <member><function>array_pop</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
-->