explode.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: abd75f51f4daa22d471b0d14114df3886832fb6f Maintainer: sammywg Status: ready -->
<!-- Reviewed: yes -->
<!-- Rev-Revision: abd75f51f4daa22d471b0d14114df3886832fb6f Reviewer: samesch -->
<refentry xml:id="function.explode" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>explode</refname>
  <refpurpose>Teilt eine Zeichenkette anhand einer Zeichenkette</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>explode</methodname>
   <methodparam><type>string</type><parameter>separator</parameter></methodparam>
   <methodparam><type>string</type><parameter>string</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>limit</parameter><initializer><constant>PHP_INT_MAX</constant></initializer></methodparam>
  </methodsynopsis>
  <para>
   Gibt ein Array aus Zeichenketten zurück, die jeweils Teil von
   <parameter>string</parameter> sind. Die Abtrennung erfolgt dabei an der mit
   <parameter>separator</parameter> angegebenen Zeichenkette.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>separator</parameter></term>
     <listitem>
      <para>
       Die Begrenzungszeichenkette.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>string</parameter></term>
     <listitem>
      <para>
       Die Eingabezeichenkette.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>limit</parameter></term>
     <listitem>
      <para>
       Ist der Parameter <parameter>limit</parameter> angegeben und positiv,
       enthält das zurückgegebene Array maximal <parameter>limit</parameter>
       Elemente, wobei das letzte Element den Rest von
       <parameter>string</parameter> beinhaltet.
      </para>
      <para>
       Ist der Parameter <parameter>limit</parameter> negativ, werden alle
       Teilzeichenketten bis auf die letzten
       -<parameter>limit</parameter>-Teile zurückgegeben.
      </para>
      <para>
       Wenn der Parameter <parameter>limit</parameter> gleich 0 ist, wird er
       wie 1 behandelt.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
  <note>
   <para>
    Vor PHP 8.0 akzeptierte <function>implode</function> die Parameter in
    beliebiger Reihenfolge. <function>explode</function> hat dies nie
    unterstützt. Stellen Sie daher sicher, dass Sie den Parameter
    <parameter>separator</parameter> vor dem Parameter
    <parameter>string</parameter> notieren.
   </para>
  </note>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Gibt ein <type>&array;</type> von <type>&string;</type>s zurück, die
   durch Aufsplitten des Parameters <parameter>string</parameter> an
   Begrenzungen durch <parameter>separator</parameter> erzeugt werden.
  </para>
  <para>
   Ist <parameter>separator</parameter> eine leere Zeichenkette (""), so löst
   <function>explode</function> einen <classname>ValueError</classname> aus. Enthält
   <parameter>separator</parameter> einen Wert, der nicht in
   <parameter>string</parameter> vorkommt und wird ein negativer Wert für
   <parameter>limit</parameter> verwendet, wird ein leeres
   <type>&array;</type> zurückgegeben. Für alle anderen Werte von
   <parameter>limit</parameter> wird ein <type>&array;</type> zurückgegeben,
   das <parameter>string</parameter> als einziges Element enthält. Wenn
   <parameter>separator</parameter> am Anfang oder am Ende von
   <parameter>string</parameter> steht, wird ein leeres <type>&array;</type>
   an den Anfang bzw. das Ende des zurückgegebenen <type>&array;</type>s
   angehängt.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <function>explode</function> löst nun einen
       <classname>ValueError</classname> aus, wenn an den Parameter
       <parameter>separator</parameter> eine leere Zeichenkette
       (<literal>""</literal>) übergeben wird.
       Bisher gab <function>explode</function> stattdessen &false; zurück.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>explode</function>-Beispiele</title>
    <programlisting role="php">
<![CDATA[
<?php
// Beispiel 1
$pizza  = "Teil1 Teil2 Teil3 Teil4 Teil5 Teil6";
$teile = explode(" ", $pizza);
echo $teile[0]; // Teil1
echo $teile[1]; // Teil2

// Beispiel 2
$data = "foo:*:1023:1000::/home/foo:/bin/sh";
list($user, $pass, $uid, $gid, $gecos, $home, $shell) = explode(":", $data);
echo $user; // foo
echo $pass; // *

?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title><function>explode</function>-Rückgabebeispiele</title>
    <programlisting role="php">
<![CDATA[
<?php
/*
   Eine Zeichenkette, die nicht das Trennzeichen enthält, wird einfach
   ein ein-elementiges Array mit der ursprünglichen Zeichenkette liefern.
*/
$input1 = "hallo";
$input2 = "hallo,da";
$input3 = ',';
var_dump( explode( ',', $input1 ) );
var_dump( explode( ',', $input2 ) );
var_dump( explode( ',', $input3 ) );

?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
array(1)
(
    [0] => string(5) "hallo"
)
array(2)
(
    [0] => string(5) "hallo"
    [1] => string(5) "da"
)
array(2)
(
    [0] => string(0) ""
    [1] => string(0) ""
)
]]>
    </screen>
   </example>
  </para>
  <para>
   <example>
    <title><parameter>limit</parameter>-Parameterbeispiele</title>
    <programlisting role="php">
<![CDATA[
<?php
$str = 'eins|zwei|drei|vier';

// positiver Wert in "limit"
print_r(explode('|', $str, 2));

// negative Wert in "limit"
print_r(explode('|', $str, -1));
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Array
(
    [0] => eins
    [1] => zwei|drei|vier
)
Array
(
    [0] => eins
    [1] => zwei
    [2] => drei
)
]]>
    </screen>
   </example>
  </para>
 </refsect1>

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

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>preg_split</function></member>
    <member><function>str_split</function></member>
    <member><function>mb_split</function></member>
    <member><function>str_word_count</function></member>
    <member><function>strtok</function></member>
    <member><function>implode</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
-->