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

<!-- $Revision$ -->

<!-- EN-Revision: 85c47f89f35f927d7c7ad23235c830dc4b514ddd Maintainer: PhilDaiguille Status: ready -->

<!-- Reviewed: no Maintainer: Marqitos -->

<refentry xml:id="function.array-key-first" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">

<refnamediv>

<refname>array_key_first</refname>

<refpurpose>Recupera la primera clave de un array</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type class="union"><type>int</type><type>string</type><type>null</type></type><methodname>array_key_first</methodname>

<methodparam><type>array</type><parameter>array</parameter></methodparam>

</methodsynopsis>

<para>

Recupera la primera clave del array <parameter>array</parameter> dado sin

afectar el puntero interno del array.

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<variablelist>

<varlistentry>

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

<listitem>

<para>

Un array.

</para>

</listitem>

</varlistentry>

</variablelist>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Devuelve la primera clave de <parameter>array</parameter> si el array no está

vacío; &null; en caso contrario.

</para>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example xml:id="array_key_first.example.basic">

<title>Uso simple de <function>array_key_first</function></title>

<programlisting role="php">

<![CDATA[

<?php

$array = ['a' => 1, 'b' => 2, 'c' => 3];

$firstKey = array_key_first($array);

var_dump($firstKey);

?>

]]>

</programlisting>

&example.outputs;

<screen>

<![CDATA[

string(1) "a"

]]>

</screen>

</example>

</para>

</refsect1>

<refsect1 role="notes">

&reftitle.notes;

<tip>

<simpara>

Hay varias maneras de proporcionar esta funcionalidad para versiones anteriores a PHP 7.3.0.

Es posible utilizar <function>array_keys</function>, pero esto es

bastante ineficiente. También es posible utilizar

<function>reset</function> y <function>key</function>,

pero esto puede cambiar el puntero interno del array.

Una solución eficiente, que no modifica el puntero interno del array,

escrita como un polyfill:

</simpara>

<informalexample>

<programlisting role="php">

<![CDATA[

<?php

if (!function_exists('array_key_first')) {

function array_key_first(array $arr) {

foreach($arr as $key => $unused) {

return $key;

}

return NULL;

}

}

?>

]]>

</programlisting>

</informalexample>

</tip>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<simplelist>

<member><function>array_first</function></member>

<member><function>array_key_last</function></member>

<member><function>reset</function></member>

</simplelist>

</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

-->