archived-doc-de/reference/strings/functions/str-getcsv.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: cef78b0fbe0fbe02003699b027ab50200097e949 Maintainer: sammywg Status: ready -->
<!-- Reviewed: yes -->
<!-- Rev-Revision a62a46e9c785336bb7a145d5c5805c228a515031 Reviewer: samesch -->
<refentry xml:id="function.str-getcsv" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>str_getcsv</refname>
  <refpurpose>Parst einen CSV-String in ein Array</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>str_getcsv</methodname>
   <methodparam><type>string</type><parameter>string</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>separator</parameter><initializer>","</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>enclosure</parameter><initializer>"\""</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>escape</parameter><initializer>"\\"</initializer></methodparam>
  </methodsynopsis>
  <para>
    Parst eine Zeichenketten-Eingabe für Felder im
    <acronym>CSV</acronym>-Format und gibt ein Array mit den gelesenen Feldern
    zurück.
  </para>
  <note>
   <para>
    Diese Funktion berücksichtigt die Locale-Einstellungen. Ist
    <constant>LC_CTYPE</constant> beispielsweise <literal>de_DE.UTF-8</literal>,
    werden Zeichenketten in Ein-Byte-Kodierungen von dieser Funktion
    möglicherweise falsch geparst.
   </para>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>string</parameter></term>
     <listitem>
      <para>
       Die zu parsende Zeichenkette.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>separator</parameter></term>
     <listitem>
      <para>
       Bestimmt das Feldtrennzeichen (nur ein Ein-Byte-Zeichen).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>enclosure</parameter></term>
     <listitem>
      <para>
       Bestimmt das Textmarkierungszeichen (nur ein Ein-Byte-Zeichen).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>escape</parameter></term>
     <listitem>
      <para>
       Bestimmt das Maskierungszeichen (höchstens ein Ein-Byte-Zeichen).
       Standardmäßig wird ein Backslash (<literal>\</literal>) verwendet. Eine
       leere Zeichenkette (<literal>""</literal>) deaktiviert den proprietären
       Maskierungsmechanismus.
      </para>
      <note>
       <simpara>
        Normalerweise wird ein <parameter>enclosure</parameter>-Zeichen
        innerhalb eines Feldes maskiert, indem es verdoppelt wird; allerdings
        kann das <parameter>escape</parameter>-Zeichen als Alternative
        verwendet werden. Also haben für die Standard-Parameterwerte
        <literal>""</literal> und <literal>\"</literal> dieselbe Bedeutung.
        Außer der möglichen Maskierung des
        <parameter>enclosure</parameter>-Zeichens hat das
        <parameter>escape</parameter>-Zeichen keine besondere Bedeutung; es
        kann nicht einmal verwendet werden, um sich selbst zu maskieren.
       </simpara>
      </note>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
  &warning.csv.escape-parameter;
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Gibt ein indexiertes Array zurück, das die eingelesenen Felder enthält.
  </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>7.4.0</entry>
       <entry>
        Der Parameter <parameter>escape</parameter> interpretiert nun eine leere
        Zeichenkette als Signal, um den proprietären Maskierungsmechanismus zu
        deaktivieren. Zuvor wurde eine leere Zeichenkette wie der Vorgabewert
        behandelt.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>str_getcsv</function>-Beispiel</title>
    <programlisting role="php">
<![CDATA[
<?php

$string = 'PHP,Java,Python,Kotlin,Swift';
$data = str_getcsv($string);

var_dump($data);
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
array(5) {
  [0]=>
  string(3) "PHP"
  [1]=>
  string(4) "Java"
  [2]=>
  string(6) "Python"
  [3]=>
  string(6) "Kotlin"
  [4]=>
  string(5) "Swift"
}
]]>
    </screen>
   </example>
  </para>
  <para>
   <example>
    <title><function>str_getcsv</function>-Beispiel mit einer leeren Zeichenkette</title>
    <caution>
     <simpara>
      Bei einer leeren Zeichenkette gibt diese Funktion den Wert
      <code>[null]</code> anstelle eines leeren Arrays zurück.
     </simpara>
    </caution>
    <programlisting role="php">
<![CDATA[
<?php

$string = '';
$data = str_getcsv($string);

var_dump($data);
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
array(1) {
  [0]=>
  NULL
}
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>fgetcsv</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
-->