<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.splfileobject.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'de',
),
'this' =>
array (
0 => 'splfileobject.setcsvcontrol.php',
1 => 'SplFileObject::setCsvControl',
2 => 'Set the delimiter, enclosure and escape character for CSV',
),
'up' =>
array (
0 => 'class.splfileobject.php',
1 => 'SplFileObject',
),
'prev' =>
array (
0 => 'splfileobject.seek.php',
1 => 'SplFileObject::seek',
),
'next' =>
array (
0 => 'splfileobject.setflags.php',
1 => 'SplFileObject::setFlags',
),
'alternatives' =>
array (
),
'source' =>
array (
'lang' => 'en',
'path' => 'reference/spl/splfileobject/setcsvcontrol.xml',
),
'history' =>
array (
),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);
contributors($setup);
?>
<div id="splfileobject.setcsvcontrol" class="refentry">
<div class="refnamediv">
<h1 class="refname">SplFileObject::setCsvControl</h1>
<p class="verinfo">(PHP 5 >= 5.2.0, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">SplFileObject::setCsvControl</span> — <span class="dc-title">Set the delimiter, enclosure and escape character for CSV</span></p>
</div>
<div class="refsect1 description" id="refsect1-splfileobject.setcsvcontrol-description">
<h3 class="title">Beschreibung</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="methodname"><strong>SplFileObject::setCsvControl</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$separator</code><span class="initializer"> = ","</span></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$enclosure</code><span class="initializer"> = "\""</span></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$escape</code><span class="initializer"> = "\\"</span></span>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<p class="para rdfs-comment">
Sets the delimiter, enclosure and escape character for
parsing <abbr title="Comma Separated Value">CSV</abbr> fields.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-splfileobject.setcsvcontrol-parameters">
<h3 class="title">Parameter-Liste</h3>
<dl>
<dt><code class="parameter">separator</code></dt>
<dd>
<p class="para">
Der Parameter <code class="parameter">separator</code> setzt das
Feld-Trennzeichen.
Es muss ein Single-Byte-Zeichen sein.
</p>
</dd>
<dt><code class="parameter">enclosure</code></dt>
<dd>
<p class="para">
Der Parameter <code class="parameter">enclosure</code> setzt das
Feld-Begrenzungszeichen.
Es muss ein Single-Byte-Zeichen sein.
</p>
</dd>
<dt><code class="parameter">escape</code></dt>
<dd>
<p class="para">
Der Parameter <code class="parameter">escape</code> setzt das Maskierungs-Zeichen.
Es muss ein Single-Byte-Zeichen oder die leere Zeichenkette sein.
Die leere Zeichenkette (<code class="literal">""</code>) deaktiviert den
proprietären Maskierungsmechanismus.
</p>
<blockquote class="note"><p><strong class="note">Hinweis</strong>:
<span class="simpara">
Normalerweise wird ein <code class="parameter">enclosure</code>-Zeichen in
einem Feld maskiert, indem es verdoppelt wird; allerdings kann
alternativ dazu das <code class="parameter">escape</code>-Zeichen verwendet
werden. So haben die Werte <code class="literal">""</code> und
<code class="literal">\"</code> standardmäßig dieselbe Bedeutung. Abgesehen von
der Möglichkeit, das <code class="parameter">enclosure</code>-Zeichen zu
maskieren, hat das Zeichen <code class="parameter">escape</code> keine
besondere Bedeutung; es ist nicht einmal dazu geeignet, sich selbst zu
maskieren.
</span>
</p></blockquote>
<div class="warning"><strong class="warning">Warnung</strong>
<p class="simpara">
Seit PHP 8.4.0 ist es veraltet, sich auf den Standardwert von
<code class="parameter">escape</code> zu verlassen.
Er muss explizit angegeben werden, entweder an der richtigen Stelle
oder durch die Verwendung von
<a href="functions.arguments.php#functions.named-arguments" class="link">benannten Argumenten</a>.
</p>
</div>
</dd>
</dl>
<div class="warning"><strong class="warning">Warnung</strong><p class="simpara">
Wenn <code class="parameter">escape</code> auf etwas anderes als eine leere Zeichenkette
(<code class="literal">""</code>) gesetzt wird, kann dies zu einer CSV-Datei führen, die
nicht mit <a href="https://datatracker.ietf.org/doc/html/rfc4180" class="link external">» RFC 4180</a> konform ist oder die
den Umlauf durch die PHP-CSV-Funktionen nicht übersteht. Der Standardwert für
<code class="parameter">escape</code> ist <code class="literal">"\\"</code>, weshalb empfohlen
wird, diesen Parameter explizit auf eine leere Zeichenkette zu setzen.
Der Standardwert wird sich in einer zukünftigen Version von PHP ändern, jedoch
nicht vor PHP 9.0.
</p></div>
</div>
<div class="refsect1 returnvalues" id="refsect1-splfileobject.setcsvcontrol-returnvalues">
<h3 class="title">Rückgabewerte</h3>
<p class="para">
Es wird kein Wert zurückgegeben.
</p>
</div>
<div class="refsect1 errors" id="refsect1-splfileobject.setcsvcontrol-errors">
<h3 class="title">Fehler/Exceptions</h3>
<p class="simpara">
Wenn <code class="parameter">separator</code> oder <code class="parameter">enclosure</code>
nicht ein Byte lang ist, wird ein <span class="exceptionname"><a href="class.valueerror.php" class="exceptionname">ValueError</a></span>
geworfen.
</p>
<p class="simpara">
Wenn <code class="parameter">escape</code> nicht ein Byte lang oder eine leere
Zeichenkette ist, wird ein <span class="exceptionname"><a href="class.valueerror.php" class="exceptionname">ValueError</a></span>
geworfen.
</p>
</div>
<div class="refsect1 changelog" id="refsect1-splfileobject.setcsvcontrol-changelog">
<h3 class="title">Changelog</h3>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Beschreibung</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>8.4.0</td>
<td>
Sich auf den Standardwert von <code class="parameter">escape</code> zu
verlassen, ist nun veraltet.
</td>
</tr>
<tr>
<td>7.4.0</td>
<td>
The <code class="parameter">escape</code> parameter now also accepts an empty
string to disable the proprietary escape mechanism.
</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 examples" id="refsect1-splfileobject.setcsvcontrol-examples">
<h3 class="title">Beispiele</h3>
<p class="para">
<div class="example" id="example-4017">
<p><strong>Beispiel #1 <span class="methodname"><strong>SplFileObject::setCsvControl()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB"><?php<br />$file </span><span style="color: #007700">= new </span><span style="color: #0000BB">SplFileObject</span><span style="color: #007700">(</span><span style="color: #DD0000">"data.csv"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$file</span><span style="color: #007700">-></span><span style="color: #0000BB">setFlags</span><span style="color: #007700">(</span><span style="color: #0000BB">SplFileObject</span><span style="color: #007700">::</span><span style="color: #0000BB">READ_CSV</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$file</span><span style="color: #007700">-></span><span style="color: #0000BB">setCsvControl</span><span style="color: #007700">(</span><span style="color: #DD0000">'|'</span><span style="color: #007700">);<br />foreach (</span><span style="color: #0000BB">$file </span><span style="color: #007700">as </span><span style="color: #0000BB">$row</span><span style="color: #007700">) {<br /> list (</span><span style="color: #0000BB">$fruit</span><span style="color: #007700">, </span><span style="color: #0000BB">$quantity</span><span style="color: #007700">) = </span><span style="color: #0000BB">$row</span><span style="color: #007700">;<br /> </span><span style="color: #FF8000">// Do something with values<br /></span><span style="color: #007700">}<br /></span><span style="color: #0000BB">?></span></span></code></div>
</div>
<div class="example-contents"><p>Contents of data.csv</p></div>
<div class="example-contents">
<div class="txtcode"><pre class="txtcode"><?php
apples|20
bananas|14
cherries|87
?></pre>
</div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-splfileobject.setcsvcontrol-seealso">
<h3 class="title">Siehe auch</h3>
<ul class="simplelist">
<li><span class="methodname"><a href="splfileobject.getcsvcontrol.php" class="methodname" rel="rdfs-seeAlso">SplFileObject::getCsvControl()</a> - Get the delimiter, enclosure and escape character for CSV</span></li>
<li><span class="methodname"><a href="splfileobject.fgetcsv.php" class="methodname" rel="rdfs-seeAlso">SplFileObject::fgetcsv()</a> - Gets line from file and parse as CSV fields</span></li>
<li><span class="methodname"><a href="splfileobject.fputcsv.php" class="methodname" rel="rdfs-seeAlso">SplFileObject::fputcsv()</a> - Write a field array as a CSV line</span></li>
<li><span class="function"><a href="function.fputcsv.php" class="function" rel="rdfs-seeAlso">fputcsv()</a> - Format line as CSV and write to file pointer</span></li>
<li><span class="function"><a href="function.fgetcsv.php" class="function" rel="rdfs-seeAlso">fgetcsv()</a> - Liest eine Zeile von der Position des Dateizeigers und prüft diese auf
kommaseparierte Werte (CSV)</span></li>
<li><span class="function"><a href="function.str-getcsv.php" class="function" rel="rdfs-seeAlso">str_getcsv()</a> - Parst einen CSV-String in ein Array</span></li>
</ul>
</div>
</div><?php manual_footer($setup); ?>