archived-doc-es/reference/strings/functions/substr-compare.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 14af302c9c0e561fa6f9cdd956268758ba9a89c5 Maintainer: seros Status: ready -->
<!-- Reviewed: yes Maintainer: seros -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.substr-compare">
 <refnamediv>
  <refname>substr_compare</refname>
  <refpurpose>Comparación segura a nivel binario de dos o más strings desde un índice hasta una longitud de caracteres dada</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>substr_compare</methodname>
   <methodparam><type>string</type><parameter>main_str</parameter></methodparam>
   <methodparam><type>string</type><parameter>str</parameter></methodparam>
   <methodparam><type>int</type><parameter>offset</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>case_insensitivity</parameter><initializer>false</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>substr_compare</function> compara <parameter>main_str</parameter>
   desde la posición <parameter>offset</parameter> con <parameter>str</parameter>
   hasta la cantidad <parameter>length</parameter> de caracteres.
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>main_str</parameter></term>
     <listitem>
      <para>
       El string principal a comparar.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>str</parameter></term>
     <listitem>
      <para>
       El string secundario a comparar.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>offset</parameter></term>
     <listitem>
      <para>
       La posición de inicio para la comparación. Si es negativa, se comienza a contar
       desde el final del string.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>length</parameter></term>
     <listitem>
      <para>
       La longitud de la comparación. El valor predeterminado es el que sea mayor entre la
       longitud de <parameter>str</parameter> comparado con la longitud de 
       <parameter>main_str</parameter> menos el
       <parameter>offset</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>case_insensitivity</parameter></term>
     <listitem>
      <para>
       Si <parameter>case_insensitivity</parameter> es &true;, la comparación
       no considera el uso de mayúsculas y minúsculas.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Devuelve &lt; 0 si <parameter>main_str</parameter>, desde la posición
   <parameter>offset</parameter>, es menor que <parameter>str</parameter>, &gt;
   0 si es mayor que <parameter>str</parameter>, y 0 si son iguales.
   Si <parameter>offset</parameter> es igual o mayor que la longitud de 
   <parameter>main_str</parameter>, o <parameter>length</parameter> se
   establece y es menor que 1 (antes de PHP 5.6),
   <function>substr_compare</function> muestra una advertencia y devuelve
   &false;.
  </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>5.6.0</entry>
       <entry>
        <parameter>length</parameter> ahora puede ser <literal>0</literal>.
       </entry>
      </row>
      <row>
       <entry>5.1.0</entry>
       <entry>
        Se añadió la posibilidad de usar un <parameter>offset</parameter> negativo.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Un ejemplo de <function>substr_compare</function></title>
    <programlisting role="php">
<![CDATA[
<?php
echo substr_compare("abcde", "bc", 1, 2); // 0
echo substr_compare("abcde", "de", -2, 2); // 0
echo substr_compare("abcde", "bcg", 1, 2); // 0
echo substr_compare("abcde", "BC", 1, 2, true); // 0
echo substr_compare("abcde", "bc", 1, 3); // 1
echo substr_compare("abcde", "cd", 1, 2); // -1
echo substr_compare("abcde", "abc", 5, 1); // advertencia
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>strncmp</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
-->