<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.ziparchive.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'ziparchive.open.php',
    1 => 'ZipArchive::open',
    2 => 'Abre um arquivo compactado ZIP',
  ),
  'up' => 
  array (
    0 => 'class.ziparchive.php',
    1 => 'ZipArchive',
  ),
  'prev' => 
  array (
    0 => 'ziparchive.locatename.php',
    1 => 'ZipArchive::locateName',
  ),
  'next' => 
  array (
    0 => 'ziparchive.registercancelcallback.php',
    1 => 'ZipArchive::registerCancelCallback',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'pt_BR',
    'path' => 'reference/zip/ziparchive/open.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="ziparchive.open" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">ZipArchive::open</h1>
  <p class="verinfo">(PHP 5 &gt;= 5.2.0, PHP 7, PHP 8, PECL zip &gt;= 1.1.0)</p><p class="refpurpose"><span class="refname">ZipArchive::open</span> &mdash; <span class="dc-title">Abre um arquivo compactado ZIP</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-ziparchive.open-description">
  <h3 class="title">Descrição</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>ZipArchive::open</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$filename</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$flags</code><span class="initializer"> = 0</span></span>): <span class="type"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span>|<span class="type"><a href="language.types.integer.php" class="type int">int</a></span></span></div>

  <p class="para rdfs-comment">
   Abre um arquivo compactado ZIP novo ou existente para leitura, escrita ou modificação.
  </p>
  <p class="para">
   Desde o libzip 1.6.0, um arquivo vazio não é mais um arquivo compactado válido.
  </p>
 </div>

 <div class="refsect1 parameters" id="refsect1-ziparchive.open-parameters">
  <h3 class="title">Parâmetros</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">filename</code></dt>
     <dd>
      <p class="para">
       O nome do arquivo compactado ZIP a ser aberto.
      </p>
     </dd>
    
    
     <dt><code class="parameter">flags</code></dt>
     <dd>
      <p class="para">
       O modo a ser usado para abrir o arquivo compactado.
       <ul class="itemizedlist">
        <li class="listitem">
         <p class="para">
          <strong><code><a href="zip.constants.php#ziparchive.constants.overwrite">ZipArchive::OVERWRITE</a></code></strong>
         </p>
        </li>
        <li class="listitem">
         <p class="para">
          <strong><code><a href="zip.constants.php#ziparchive.constants.create">ZipArchive::CREATE</a></code></strong>
         </p>
        </li>
        <li class="listitem">
         <p class="para">
          <strong><code><a href="zip.constants.php#ziparchive.constants.rdonly">ZipArchive::RDONLY</a></code></strong>
         </p>
        </li>
        <li class="listitem">
         <p class="para">
          <strong><code><a href="zip.constants.php#ziparchive.constants.excl">ZipArchive::EXCL</a></code></strong>
         </p>
        </li>
        <li class="listitem">
         <p class="para">
          <strong><code><a href="zip.constants.php#ziparchive.constants.checkcons">ZipArchive::CHECKCONS</a></code></strong>
         </p>
        </li>
       </ul>
      </p>
     </dd>
    
   </dl>
  </p>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-ziparchive.open-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, <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> ou um dos seguintes códigos de erro em caso de falha:
   <dl>
    
     <dt><strong><code><a href="zip.constants.php#ziparchive.constants.er-exists">ZipArchive::ER_EXISTS</a></code></strong></dt>
     <dd>
      <span class="simpara">Arquivo já existe.</span>
     </dd>
    
    
     <dt><strong><code><a href="zip.constants.php#ziparchive.constants.er-incons">ZipArchive::ER_INCONS</a></code></strong></dt>
     <dd>
      <span class="simpara">Arquivo compactado inconsistente.</span>
     </dd>
    
    
     <dt><strong><code><a href="zip.constants.php#ziparchive.constants.er-inval">ZipArchive::ER_INVAL</a></code></strong></dt>
     <dd>
      <span class="simpara">Argumento inválido.</span>
     </dd>
    
    
     <dt><strong><code><a href="zip.constants.php#ziparchive.constants.er-memory">ZipArchive::ER_MEMORY</a></code></strong></dt>
     <dd>
      <span class="simpara">Falha ao alocar memória.</span>
     </dd>
    
    
     <dt><strong><code><a href="zip.constants.php#ziparchive.constants.er-noent">ZipArchive::ER_NOENT</a></code></strong></dt>
     <dd>
      <span class="simpara">Arquivo não encontrado.</span>
     </dd>
    
    
     <dt><strong><code><a href="zip.constants.php#ziparchive.constants.er-nozip">ZipArchive::ER_NOZIP</a></code></strong></dt>
     <dd>
      <span class="simpara">Não é um arquivo compactado ZIP.</span>
     </dd>
    
    
     <dt><strong><code><a href="zip.constants.php#ziparchive.constants.er-open">ZipArchive::ER_OPEN</a></code></strong></dt>
     <dd>
      <span class="simpara">Não é possível abrir o arquivo.</span>
     </dd>
    
    
     <dt><strong><code><a href="zip.constants.php#ziparchive.constants.er-read">ZipArchive::ER_READ</a></code></strong></dt>
     <dd>
      <span class="simpara">Erro de leitura.</span>
     </dd>
    
    
     <dt><strong><code><a href="zip.constants.php#ziparchive.constants.er-seek">ZipArchive::ER_SEEK</a></code></strong></dt>
     <dd>
      <span class="simpara">Erro de busca.</span>
     </dd>
    
   </dl>
  </p>
 </div>

 <div class="refsect1 examples" id="refsect1-ziparchive.open-examples">
  <h3 class="title">Exemplos</h3>
    <div class="example" id="example-1">
     <p><strong>Exemplo #1 Abrir e extrair</strong></p>
     <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$zip </span><span style="color: #007700">= new </span><span style="color: #0000BB">ZipArchive</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$res </span><span style="color: #007700">= </span><span style="color: #0000BB">$zip</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">open</span><span style="color: #007700">(</span><span style="color: #DD0000">'test.zip'</span><span style="color: #007700">);<br />if (</span><span style="color: #0000BB">$res </span><span style="color: #007700">=== </span><span style="color: #0000BB">TRUE</span><span style="color: #007700">) {<br />    echo </span><span style="color: #DD0000">'ok'</span><span style="color: #007700">;<br />    </span><span style="color: #0000BB">$zip</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">extractTo</span><span style="color: #007700">(</span><span style="color: #DD0000">'test'</span><span style="color: #007700">);<br />    </span><span style="color: #0000BB">$zip</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">close</span><span style="color: #007700">();<br />} else {<br />    echo </span><span style="color: #DD0000">'falha, código:' </span><span style="color: #007700">. </span><span style="color: #0000BB">$res</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
     </div>

    </div>
    <div class="example" id="example-2">
     <p><strong>Exemplo #2 Cria um arquivo</strong></p>
     <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$zip </span><span style="color: #007700">= new </span><span style="color: #0000BB">ZipArchive</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$res </span><span style="color: #007700">= </span><span style="color: #0000BB">$zip</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">open</span><span style="color: #007700">(</span><span style="color: #DD0000">'test.zip'</span><span style="color: #007700">, </span><span style="color: #0000BB">ZipArchive</span><span style="color: #007700">::</span><span style="color: #0000BB">CREATE</span><span style="color: #007700">);<br />if (</span><span style="color: #0000BB">$res </span><span style="color: #007700">=== </span><span style="color: #0000BB">TRUE</span><span style="color: #007700">) {<br />    </span><span style="color: #0000BB">$zip</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">addFromString</span><span style="color: #007700">(</span><span style="color: #DD0000">'test.txt'</span><span style="color: #007700">, </span><span style="color: #DD0000">'o conteúdo do arquivo vai aqui'</span><span style="color: #007700">);<br />    </span><span style="color: #0000BB">$zip</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">addFile</span><span style="color: #007700">(</span><span style="color: #DD0000">'data.txt'</span><span style="color: #007700">, </span><span style="color: #DD0000">'entryname.txt'</span><span style="color: #007700">);<br />    </span><span style="color: #0000BB">$zip</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">close</span><span style="color: #007700">();<br />    echo </span><span style="color: #DD0000">'ok'</span><span style="color: #007700">;<br />} else {<br />    echo </span><span style="color: #DD0000">'falhou'</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
     </div>

    </div>
    <div class="example" id="example-3">
     <p><strong>Exemplo #3 Cria um arquivo temporário</strong></p>
     <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$name </span><span style="color: #007700">= </span><span style="color: #0000BB">tempnam</span><span style="color: #007700">(</span><span style="color: #0000BB">sys_get_temp_dir</span><span style="color: #007700">(), </span><span style="color: #DD0000">"FOO"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$zip </span><span style="color: #007700">= new </span><span style="color: #0000BB">ZipArchive</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$res </span><span style="color: #007700">= </span><span style="color: #0000BB">$zip</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">open</span><span style="color: #007700">(</span><span style="color: #0000BB">$name</span><span style="color: #007700">, </span><span style="color: #0000BB">ZipArchive</span><span style="color: #007700">::</span><span style="color: #0000BB">OVERWRITE</span><span style="color: #007700">); </span><span style="color: #FF8000">/* truncar pois um arquivo vazio não é válido */<br /></span><span style="color: #007700">if (</span><span style="color: #0000BB">$res </span><span style="color: #007700">=== </span><span style="color: #0000BB">TRUE</span><span style="color: #007700">) {<br />    </span><span style="color: #0000BB">$zip</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">addFile</span><span style="color: #007700">(</span><span style="color: #DD0000">'data.txt'</span><span style="color: #007700">, </span><span style="color: #DD0000">'nomedaentrada.txt'</span><span style="color: #007700">);<br />    </span><span style="color: #0000BB">$zip</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">close</span><span style="color: #007700">();<br />    echo </span><span style="color: #DD0000">'ok'</span><span style="color: #007700">;<br />} else {<br />    echo </span><span style="color: #DD0000">'falhou'</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
     </div>

    </div>
   </div>

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