substr-replace.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: e095023e408c8cb6378ae16bb6870343a3946919 Maintainer: sammywg Status: ready -->
<refentry xml:id="function.substr-replace" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>substr_replace</refname>
  <refpurpose>Ersetzt Text innerhalb einer Zeichenkette</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>array</type></type><methodname>substr_replace</methodname>
   <methodparam><type class="union"><type>array</type><type>string</type></type><parameter>string</parameter></methodparam>
   <methodparam><type class="union"><type>array</type><type>string</type></type><parameter>replace</parameter></methodparam>
   <methodparam><type class="union"><type>array</type><type>int</type></type><parameter>offset</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>array</type><type>int</type><type>null</type></type><parameter>length</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>substr_replace</function> ersetzt in einer Kopie von
   <parameter>string</parameter> alle Zeichen, die sich innerhalb der durch
   die Parameter <parameter>offset</parameter> und (optional)
   <parameter>length</parameter> festgelegten Grenze befinden, mit der in
   <parameter>replace</parameter> angegebenen Zeichenkette.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>string</parameter></term>
     <listitem>
      <para>
       Die Eingabezeichenkette.
      </para>
      <para>
       Ein <type>array</type> von <type>string</type>s kann übergeben werden;
       die Ersetzungen erfolgen dann bei jeder Zeichenkette der Reihe nach. In
       diesem Fall können die Parameter <parameter>replace</parameter>,
       <parameter>offset</parameter> und <parameter>length</parameter>
       entweder als Skalar übergeben werden, die auf jede Eingabezeichenkette
       der Reihe nach angewandt werden, oder als <type>array</type>s; in
       diesem Fall wird das entsprechende Array-Element für jede
       Eingabezeichenkette genutzt.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>replace</parameter></term>
     <listitem>
      <para>
       Die Ersetzungszeichenkette
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>offset</parameter></term>
     <listitem>
      <para>
       Ist <parameter>offset</parameter> nicht negativ, beginnt die Ersetzung
       ab der im Parameter <parameter>offset</parameter> definierten Stelle
       innerhalb von <parameter>string</parameter>.
      </para>
      <para>
       Ist <parameter>offset</parameter> negativ, wird vom Ende der
       Zeichenkette <parameter>string</parameter> bis zum Wert von
       <parameter>offset</parameter> rückwärts gezählt und dort mit dem
       Austausch begonnen.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>length</parameter></term>
     <listitem>
      <para>
       Ist der Parameter angegeben und positiv, stellt dieser Parameter die
       Länge des auszuwechselnden Teils von <parameter>string</parameter> dar.
       Ist der Wert negativ, gibt er die Zeichenzahl an, um die ab Ende von
       <parameter>string</parameter> rückwärts gezählt wird. Bis zu dieser
       Stelle erfolgt dann der Austausch. Ist der Parameter nicht angegeben,
       wird standardmäßig eine Ersetzung bis zum Ende des Strings
       (strlen(<parameter>string</parameter> )) durchgeführt, das heißt, die
       Ersetzung endet mit dem Ende von <parameter>string</parameter>. Sollte
       <parameter>length</parameter> den Wert Null (<literal>0</literal>)
       haben, wird die Funktion die Zeichenkette
       <parameter>replace</parameter> in <parameter>string</parameter> an der
       durch <parameter>offset</parameter> bezeichneten Stelle einfügen.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Der entstehende String wird zurückgegeben. Ist <parameter>string</parameter>
   ein Array, wird auch ein Array zurückgegeben.
  </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>8.0.0</entry>
       <entry>
        <parameter>length</parameter> ist jetzt ein Nullable-Typ.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Einfache <function>substr_replace</function>-Beispiele</title>
    <programlisting role="php">
<![CDATA[
<?php
$var = 'ABCDEFGH:/MNRPQR/';
echo "Original: $var<hr />\n";

/* Die beiden Beispiele ersetzen alle Vorkommen von
   $var durch 'bob'. */
echo substr_replace($var, 'bob', 0) . "<br />\n";
echo substr_replace($var, 'bob', 0, strlen($var)) . "<br />\n";

/* Einfügen von 'bob' direkt am Anfang von $var. */
echo substr_replace($var, 'bob', 0, 0) . "<br />\n";

/* Die nächsten beiden Beispiele ersetzen 'MNRPQR' in $var
   durch 'bob'. */
echo substr_replace($var, 'bob', 10, -1) . "<br />\n";
echo substr_replace($var, 'bob', -7, -1) . "<br />\n";

/* Entfernen von 'MNRPQR' aus $var. */
echo substr_replace($var, '', 10, -1) . "<br />\n";
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title>
     Nutzung von <function>substr_replace</function> um mehrere Zeichenketten
     auf einmal zu ersetzen.
    </title>
    <programlisting role="php">
<![CDATA[
<?php
$input = array('A: XXX', 'B: XXX', 'C: XXX');

// Ein einfacher Fall: ersetze XXX in jeder Zeichenkette mit YYY.
echo implode('; ', substr_replace($input, 'YYY', 3, 3))."\n";

// Ein komplizierterer Fall bei dem jede Ersetzung unterschiedlich ist.
$replace = array('AAA', 'BBB', 'CCC');
echo implode('; ', substr_replace($input, $replace, 3, 3))."\n";

// Ersetze eine jedesmal unterschiedliche Anzahl von Zeichen
$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">Zeichenketten-Zugriff
    und -Veränderung je Zeichen</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
-->