<?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 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'splfileobject.flock.php',
    1 => 'SplFileObject::flock',
    2 => 'Bloqueio de arquivo port&aacute;vel',
  ),
  'up' => 
  array (
    0 => 'class.splfileobject.php',
    1 => 'SplFileObject',
  ),
  'prev' => 
  array (
    0 => 'splfileobject.fgetss.php',
    1 => 'SplFileObject::fgetss',
  ),
  'next' => 
  array (
    0 => 'splfileobject.fpassthru.php',
    1 => 'SplFileObject::fpassthru',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'pt_BR',
    'path' => 'reference/spl/splfileobject/flock.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="splfileobject.flock" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">SplFileObject::flock</h1>
  <p class="verinfo">(PHP 5 &gt;= 5.1.0, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">SplFileObject::flock</span> &mdash; <span class="dc-title">Bloqueio de arquivo portável</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-splfileobject.flock-description">
  <h3 class="title">Descrição</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>SplFileObject::flock</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$operation</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter reference">&$wouldBlock</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="para rdfs-comment">
   Bloqueia ou desbloqueia o arquivo da mesma forma portável que <span class="function"><a href="function.flock.php" class="function">flock()</a></span>.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-splfileobject.flock-parameters">
  <h3 class="title">Parâmetros</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">operation</code></dt>
     <dd>
      <p class="para">
       <code class="parameter">operation</code> é uma das seguintes:
       <ul class="itemizedlist">
        <li class="listitem">
         <span class="simpara">
          <strong><code><a href="filesystem.constants.php#constant.lock-sh">LOCK_SH</a></code></strong> para adquirir um bloqueio compartilhado (leitor).
         </span>
        </li>
        <li class="listitem">
         <span class="simpara">
          <strong><code><a href="filesystem.constants.php#constant.lock-ex">LOCK_EX</a></code></strong> para adquirir um bloqueio exclusivo (escritor).
         </span>
        </li>
        <li class="listitem">
         <span class="simpara">
          <strong><code><a href="filesystem.constants.php#constant.lock-un">LOCK_UN</a></code></strong> para liberar um bloqueio (compartilhado ou exclusivo).
         </span>
        </li>
       </ul>
      </p>
      <p class="para">
       Também é possível adicionar <strong><code><a href="filesystem.constants.php#constant.lock-nb">LOCK_NB</a></code></strong> como uma máscara de bits para uma
       das operações acima, se <span class="function"><a href="function.flock.php" class="function">flock()</a></span> não deve
       bloquear durante a tentativa de bloqueio.
      </p>
     </dd>
    
    
     <dt><code class="parameter">wouldBlock</code></dt>
     <dd>
      <p class="para">
       Definido como <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> se o bloqueio bloqueasse (condição de errno EWOULDBLOCK).
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-splfileobject.flock-returnvalues">
  <h3 class="title">Valor Retornado</h3>
  <p class="para">
   Retorna <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> em caso de sucesso ou <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> em caso de falha.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-splfileobject.flock-examples">
  <h3 class="title">Exemplos</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Exemplo #1 Exemplo de <span class="methodname"><strong>SplFileObject::flock()</strong></span></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">"/tmp/lock.txt"</span><span style="color: #007700">, </span><span style="color: #DD0000">"w"</span><span style="color: #007700">);<br />if (</span><span style="color: #0000BB">$file</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">flock</span><span style="color: #007700">(</span><span style="color: #0000BB">LOCK_EX</span><span style="color: #007700">)) { </span><span style="color: #FF8000">// faz um bloqueio exclusivo<br />    </span><span style="color: #0000BB">$file</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">ftruncate</span><span style="color: #007700">(</span><span style="color: #0000BB">0</span><span style="color: #007700">);     </span><span style="color: #FF8000">// trunca o arquivo<br />    </span><span style="color: #0000BB">$file</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">fwrite</span><span style="color: #007700">(</span><span style="color: #DD0000">"Escrevendo algo aqui\n"</span><span style="color: #007700">);<br />    </span><span style="color: #0000BB">$file</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">flock</span><span style="color: #007700">(</span><span style="color: #0000BB">LOCK_UN</span><span style="color: #007700">);   </span><span style="color: #FF8000">// libera o bloqueio<br /></span><span style="color: #007700">} else {<br />    echo </span><span style="color: #DD0000">"Não foi possível obter o bloqueio!"</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

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


 <div class="refsect1 seealso" id="refsect1-splfileobject.flock-seealso">
  <h3 class="title">Veja Também</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.flock.php" class="function" rel="rdfs-seeAlso">flock()</a> - Travamento consultivo port&aacute;vel de arquivo</span></li>
   </ul>
  </p>
 </div>


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