substr-replace.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: e41aab5ecacf449e51179886c17f1d41735b0234 Maintainer: jpberdejo Status: ready -->
<!-- Reviewed: no -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.substr-replace">
 <refnamediv>
  <refname>substr_replace</refname>
  <refpurpose>Reemplaza el texto dentro de una porción de un string</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>mixed</type><methodname>substr_replace</methodname>
   <methodparam><type>mixed</type><parameter>string</parameter></methodparam>
   <methodparam><type>mixed</type><parameter>replacement</parameter></methodparam>
   <methodparam><type>mixed</type><parameter>start</parameter></methodparam>
   <methodparam choice="opt"><type>mixed</type><parameter>length</parameter></methodparam>
   </methodsynopsis>
  <para>
   <function>substr_replace</function> reemplaza una copia de
   <parameter>string</parameter> delimitada por los parámetros 
   <parameter>start</parameter> y (opcionalmente)
   <parameter>length</parameter> con el string dado en
   <parameter>replacement</parameter>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>string</parameter></term>
     <listitem>
      <para>
       El string de entrada.
      </para>
      <para>
       Un <type>array</type> de <type>string</type>s puede ser proporcionado, en el
       caso de que las sustituciones ocurran, a su vez, en cada string. En este caso,
       los parámetros <parameter>replacement</parameter>, <parameter>start</parameter>
       y <parameter>length</parameter> pueden ser proporcionados ya sea como
       valores escalares que serán aplicados a cada string de entrada, a su vez, o como
       <type>array</type>s, en cuyo caso el correspondiente elemento del array será
       usado para cada string de entrada.
      </para>      
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>replacement</parameter></term>
     <listitem>
      <para>
       El string de reemplazo.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>start</parameter></term>
     <listitem>
      <para>
       Si <parameter>start</parameter> es positivo, el reemplazo
       iniciará en el <parameter>start</parameter>ésimo desplazamiento 
       dentro del <parameter>string</parameter>.
      </para>
      <para>
       Si <parameter>start</parameter> es negativo, el reemplazo
       iniciará en el <parameter>start</parameter>ésimo caracter desde el
       final del <parameter>string</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>length</parameter></term>
     <listitem>
      <para>
       Si se da y es positivo, representa la longitud de la porción de
       <parameter>string</parameter> que se va a reemplazar. Si es
       negativo, representa el número de caracteres desde el final del
       <parameter>string</parameter> en el cual se deja de sustituir. Si 
       no se da, entonces se usará por defecto strlen(
       <parameter>string</parameter> ); es decir que la sustitución terminará en
       el final de <parameter>string</parameter>. Por supuesto, si
       <parameter>length</parameter> es cero, entonces esta función tendrá el
       efecto de la inserción de <parameter>replacement</parameter> dentro de
       <parameter>string</parameter> en el desplazamiento dado por
       <parameter>start</parameter>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   El string del resultado es devuelto. Si <parameter>string</parameter> es un
   array entonces un array es devuelto.
  </para>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Ejemplo de<function>substr_replace</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$var = 'ABCDEFGH:/MNRPQR/';
echo "Original: $var<hr />\n";

/* Estos dos ejemplos reemplazan todo $var por 'bob'. */
echo substr_replace($var, 'bob', 0) . "<br />\n";
echo substr_replace($var, 'bob', 0, strlen($var)) . "<br />\n";

/* Inserta 'bob' justo al comienzo de $var. */
echo substr_replace($var, 'bob', 0, 0) . "<br />\n";

/* Estos dos siguientes reemplazan 'MNRPQR' en $var por 'bob'. */
echo substr_replace($var, 'bob', 10, -1) . "<br />\n";
echo substr_replace($var, 'bob', -7, -1) . "<br />\n";

/* Elimina 'MNRPQR' de $var. */
echo substr_replace($var, '', 10, -1) . "<br />\n";
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title>
     Usando <function>substr_replace</function> para reemplazar múltiples strings de
     una vez
    </title>
    <programlisting role="php">
<![CDATA[
<?php
$input = array('A: XXX', 'B: XXX', 'C: XXX');

// Un caso simple: remplazar XXX en cada string con YYY.
echo implode('; ', substr_replace($input, 'YYY', 3, 3))."\n";

// Un caso más complicado donde cada remplazo es diferente.
$replace = array('AAA', 'BBB', 'CCC');
echo implode('; ', substr_replace($input, $replace, 3, 3))."\n";

// Remplaza un número diferente de caracteres cada vez.
$length = array(1, 2, 3);
echo implode('; ', substr_replace($input, $replace, 3, $length))."\n";
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
A: YYY; B: YYY; C: YYY
A: AAA; B: BBB; C: CCC
A: AAAXX; B: BBBX; C: CCC
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  &note.bin-safe;
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>str_replace</function></member>
    <member><function>substr</function></member>
    <member><link linkend="language.types.string.substr">String access and modification by character</link></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
-->