array-key-exists.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0b15fb2e4be999af651dcbc118059c97ee5ed4c9 Maintainer: seros Status: ready -->
<!-- Reviewed: no Maintainer: andresdzphp -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.array-key-exists">
 <refnamediv>
  <refname>array_key_exists</refname>
  <refpurpose>Verifica si el índice o clave dada existe en el array</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>array_key_exists</methodname>
   <methodparam><type>mixed</type><parameter>key</parameter></methodparam>
   <methodparam><type>array</type><parameter>array</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>array_key_exists</function> devuelve &true; si la
   <parameter>key</parameter> dada existe en el array. La
   <parameter>key</parameter> puede ser cualquier valor posible 
   para índice de un array.
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>key</parameter></term>
     <listitem>
      <para>
       Valor para verificar.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>array</parameter></term>
     <listitem>
      <para>
       Un array con las claves para verificar.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
    <note>
   <para>
    <function>array_key_exists</function> buscará las claves en la primera dimensión solamente.
    Las claves anidadas en arrays multidimensionales no se encontrarán.
   </para>
  </note>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Ejemplo de <function>array_key_exists</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$search_array = array('first' => 1, 'second' => 4);
if (array_key_exists('first', $search_array)) {
    echo "The 'first' element is in the array";
}
?>
]]>
    </programlisting>
   </example>
  </para>
  <example>
   <title><function>array_key_exists</function> vs <function>isset</function></title>
   <para>
    <function>isset</function> no retorna &true; para claves de array
    que correspondan a un valor &null;, mientras que
    <function>array_key_exists</function> si lo hace.
   </para>
   <programlisting role="php">
<![CDATA[
<?php
$search_array = array('first' => null, 'second' => 4);

// returns false
isset($search_array['first']);

// returns true
array_key_exists('first', $search_array);
?>
]]>
   </programlisting>
  </example>
 </refsect1>
 
 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    Por razones de retrocompatilibidad, <function>array_key_exists</function>
    también devuelve &true; si <parameter>key</parameter> es una propiedad
    definida dentro de un <type>objeto</type> dado como
    <parameter>array</parameter>. No debería depender de este comportamiento,
    y se ha tener cuidado para asegurarse de que <parameter>array</parameter> es
    un <type>array</type>.
   </para>
   <para>
    Para comprobar si una propiedad existe en un objeto, use
    <function>property_exists</function>.
   </para>
  </note>
 </refsect1>
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>isset</function></member>
    <member><function>array_keys</function></member>
    <member><function>in_array</function></member>
    <member><function>property_exists</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
-->