<?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 => 'uk',
  ),
  '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 &gt;= 5.2.0, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">SplFileObject::setCsvControl</span> &mdash; <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">Опис</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"> = &quot;,&quot;</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"> = &quot;\&quot;&quot;</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"> = &quot;\\&quot;</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">Параметри</h3>
  <dl>
   
     <dt><code class="parameter">separator</code></dt>
     <dd>
      <p class="para">
       The <code class="parameter">separator</code> parameter sets the field separator.
       It must be a single byte character.
      </p>
     </dd>
    
   
     <dt><code class="parameter">enclosure</code></dt>
     <dd>
      <p class="para">
       The <code class="parameter">enclosure</code> parameter sets the field enclosure character.
       It must be a single byte character.
      </p>
     </dd>
    
   
     <dt><code class="parameter">escape</code></dt>
     <dd>
      <p class="para">
       The <code class="parameter">escape</code> parameter sets the escape character.
       It must be a single byte character or the empty string.
       The empty string (<code class="literal">&quot;&quot;</code>) disables the proprietary escape mechanism.
      </p>
      <blockquote class="note"><p><strong class="note">Зауваження</strong>: 
       <span class="simpara">
        Usually an <code class="parameter">enclosure</code> character is escaped inside
        a field by doubling it; however, the <code class="parameter">escape</code>
        character can be used as an alternative. So for the default parameter
        values <code class="literal">&quot;&quot;</code> and <code class="literal">\&quot;</code> have the same
        meaning. Other than allowing to escape the
        <code class="parameter">enclosure</code> character the
        <code class="parameter">escape</code> character has no special meaning; it isn&#039;t
        even meant to escape itself.
       </span>
      </p></blockquote>
      <div class="warning"><strong class="warning">Увага</strong>
       <p class="simpara">
        As of PHP 8.4.0, depending on the default value of
        <code class="parameter">escape</code> is deprecated.
        It needs to be provided explicitly either positionally or by the use
        of <a href="functions.arguments.php#functions.named-arguments" class="link">named arguments</a>.
       </p>
      </div>
     </dd>
    
  </dl>
  <div class="warning"><strong class="warning">Увага</strong><p class="simpara">
 Якщо значенням параметра <code class="parameter">escape</code> не є порожній рядок
 (<code class="literal">&quot;&quot;</code>), то результатом може бути CSV, що не відповідає вимогам
 <a href="https://datatracker.ietf.org/doc/html/rfc4180" class="link external">&raquo;&nbsp;RFC 4180</a> або не зможе оброблятись
 функціями PHP CSV. Типовим значенням параметра <code class="parameter">escape</code> є
 <code class="literal">&quot;\\&quot;</code>, але рекомендовано явно вказати порожній рядок. Типове
 значення зміниться в наступній версії PHP, та не раніше, ніж в PHP 9.0.
</p></div>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-splfileobject.setcsvcontrol-returnvalues">
  <h3 class="title">Значення, що повертаються</h3>
  <p class="para">
   Не повертає значень.
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-splfileobject.setcsvcontrol-errors">
  <h3 class="title">Помилки/виключення</h3>
  <p class="simpara">
   Throws a <span class="exceptionname"><a href="class.valueerror.php" class="exceptionname">ValueError</a></span> if
   <code class="parameter">separator</code> or <code class="parameter">enclosure</code>
   is not one byte long.
  </p>
  <p class="simpara">
   Throws a <span class="exceptionname"><a href="class.valueerror.php" class="exceptionname">ValueError</a></span> if
   <code class="parameter">escape</code> is not one byte long or the empty string.
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-splfileobject.setcsvcontrol-changelog">
  <h3 class="title">Журнал змін</h3>
  <p class="para">
   <table class="doctable informaltable">
    
     <thead>
      <tr>
       <th>Версія</th>
       <th>Опис</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>8.4.0</td>
       <td>
        Relying on the default value of <code class="parameter">escape</code> is now
        deprecated.
       </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">Приклади</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Приклад #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">&lt;?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">-&gt;</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">-&gt;</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">?&gt;</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">&lt;?php
apples|20
bananas|14
cherries|87
?&gt;</pre>
</div>
    </div>

   </div>
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-splfileobject.setcsvcontrol-seealso">
  <h3 class="title">Прогляньте також</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> - Gets line from file pointer and parse for CSV fields</span></li>
   <li><span class="function"><a href="function.str-getcsv.php" class="function" rel="rdfs-seeAlso">str_getcsv()</a> - Parse a CSV string into an array</span></li>
  </ul>
 </div>


</div><?php manual_footer($setup); ?>