<?xml version="1.0" encoding="utf-8"?>

<!-- $Revision$ -->

<!-- EN-Revision: aba94933258b1d1ce9fa5935a239804d71a481fa Maintainer: PhilDaiguille Status: ready -->

<!-- Reviewed: no -->

<refentry xml:id="function.array-shift" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>array_shift</refname>

<refpurpose>Despila un elemento al principio de un array</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> extrae el primer valor del &array;

<parameter>array</parameter> y lo devuelve, acortando

<parameter>array</parameter> en un elemento, y desplazando todos los elementos

hacia abajo. Todas las claves numéricas serán modificadas para comenzar en

cero mientras que las claves literales no serán afectadas.

</para>

&array.resetspointer;

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>array</parameter></term>

<listitem>

<para>

El array de entrada.

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Devuelve el valor despilado, o &null; si el array está vacío o si el valor de entrada no es un array.

</para>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title>Ejemplo con <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>

y <literal>orange</literal> ha sido colocado en

<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

-->