<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.pharfileinfo.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'pharfileinfo.setmetadata.php',
    1 => 'PharFileInfo::setMetadata',
    2 => 'Define metadados espec&iacute;ficos de arquivo salvos com um arquivo',
  ),
  'up' => 
  array (
    0 => 'class.pharfileinfo.php',
    1 => 'PharFileInfo',
  ),
  'prev' => 
  array (
    0 => 'pharfileinfo.iscompressed.php',
    1 => 'PharFileInfo::isCompressed',
  ),
  'next' => 
  array (
    0 => 'class.pharexception.php',
    1 => 'PharException',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'pt_BR',
    'path' => 'reference/phar/PharFileInfo/setMetadata.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="pharfileinfo.setmetadata" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">PharFileInfo::setMetadata</h1>
  <p class="verinfo">(PHP 5 &gt;= 5.3.0, PHP 7, PHP 8, PECL phar &gt;= 1.0.0)</p><p class="refpurpose"><span class="refname">PharFileInfo::setMetadata</span> &mdash; <span class="dc-title">Define metadados específicos de arquivo salvos com um arquivo</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-pharfileinfo.setmetadata-description">
  <h3 class="title">Descrição</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>PharFileInfo::setMetadata</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span> <code class="parameter">$metadata</code></span>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>


  <p class="para rdfs-comment">
   <span class="function"><strong>PharFileInfo::setMetadata()</strong></span> deve ser usado apenas para armazenar dados personalizados
   que não podem ser representados com informações existentes armazenadas em um arquivo.
   Metadados podem reduzir significativamente o desempenho do carregamento de um arquivo phar
   se os dados forem grandes ou se houver muitos arquivos contendo metadados.
   É importante observar que as permissões de arquivo são suportadas nativamente dentro de um
   phar; é possível defini-las com o método
   <span class="function"><a href="pharfileinfo.chmod.php" class="function">PharFileInfo::chmod()</a></span>. Assim como acontece com todas as funcionalidades que modificam o conteúdo de
   um phar, a variável INI <a href="phar.configuration.php#ini.phar.readonly" class="link">phar.readonly</a>
   deve estar desativada para funcionar se o arquivo estiver dentro de um arquivo <span class="classname"><a href="class.phar.php" class="classname">Phar</a></span>.
   Arquivos dentro de arquivos <span class="classname"><a href="class.phardata.php" class="classname">PharData</a></span> não têm
   essa restrição.
  </p>
  <p class="para">
   Alguns usos possíveis para metadados incluem a passagem de um usuário/grupo que deve ser definido
   quando um arquivo é extraído do PHAR para o disco. Outros usos podem incluir
   a especificação explícita de um tipo MIME a ser retornado. No entanto, quaisquer dados úteis que
   descrevam um arquivo, mas que não devam estar contidos nele, podem ser armazenados.
  </p>

 </div>


 <div class="refsect1 parameters" id="refsect1-pharfileinfo.setmetadata-parameters">
  <h3 class="title">Parâmetros</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">metadata</code></dt>
     <dd>
      <p class="para">
       Qualquer variável PHP contendo informações para armazenar junto com um arquivo
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-pharfileinfo.setmetadata-returnvalues">
  <h3 class="title">Valor Retornado</h3>
  <p class="para">
   Nenhum valor é retornado.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-pharfileinfo.setmetadata-examples">
  <h3 class="title">Exemplos</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Exemplo #1 Um exemplo de <span class="function"><strong>PharFileInfo::setMetadata()</strong></span></strong></p>
    <div class="example-contents"><p>
    </p></div>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /></span><span style="color: #FF8000">// garantindo que o arquivo não existe<br /></span><span style="color: #007700">@</span><span style="color: #0000BB">unlink</span><span style="color: #007700">(</span><span style="color: #DD0000">'novophar.phar'</span><span style="color: #007700">);<br />try {<br />    </span><span style="color: #0000BB">$p </span><span style="color: #007700">= new </span><span style="color: #0000BB">Phar</span><span style="color: #007700">(</span><span style="color: #0000BB">dirname</span><span style="color: #007700">(</span><span style="color: #0000BB">__FILE__</span><span style="color: #007700">) . </span><span style="color: #DD0000">'/novophar.phar'</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #DD0000">'novophar.phar'</span><span style="color: #007700">);<br />    </span><span style="color: #0000BB">$p</span><span style="color: #007700">[</span><span style="color: #DD0000">'arquivo.txt'</span><span style="color: #007700">] = </span><span style="color: #DD0000">'olá'</span><span style="color: #007700">;<br />    </span><span style="color: #0000BB">$p</span><span style="color: #007700">[</span><span style="color: #DD0000">'arquivo.txt'</span><span style="color: #007700">]-&gt;</span><span style="color: #0000BB">setMetadata</span><span style="color: #007700">(array(</span><span style="color: #DD0000">'usuario' </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">'igor'</span><span style="color: #007700">, </span><span style="color: #DD0000">'mime-type' </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">'text/plain'</span><span style="color: #007700">));<br />    </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$p</span><span style="color: #007700">[</span><span style="color: #DD0000">'arquivo.txt'</span><span style="color: #007700">]-&gt;</span><span style="color: #0000BB">getMetaData</span><span style="color: #007700">());<br />} catch (</span><span style="color: #0000BB">Exception $e</span><span style="color: #007700">) {<br />    echo </span><span style="color: #DD0000">'Não foi possível criar/modificar o phar: '</span><span style="color: #007700">, </span><span style="color: #0000BB">$e</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

    <div class="example-contents"><p>O exemplo acima produzirá:</p></div>
    <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">array(2) {
  [&quot;usuario&quot;]=&gt;
  string(4) &quot;igor&quot;
  [&quot;mime-type&quot;]=&gt;
  string(10) &quot;text/plain&quot;
}</pre>
</div>
    </div>
   </div>
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-pharfileinfo.setmetadata-seealso">
  <h3 class="title">Veja Também</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="pharfileinfo.hasmetadata.php" class="function" rel="rdfs-seeAlso">PharFileInfo::hasMetadata()</a> - Retorna os metadados da entrada</span></li>
    <li><span class="function"><a href="pharfileinfo.getmetadata.php" class="function" rel="rdfs-seeAlso">PharFileInfo::getMetadata()</a> - Retorna metadados espec&iacute;ficos do arquivo salvos com um arquivo</span></li>
    <li><span class="function"><a href="pharfileinfo.delmetadata.php" class="function" rel="rdfs-seeAlso">PharFileInfo::delMetadata()</a> - Exclui os metadados da entrada</span></li>
    <li><span class="function"><a href="phar.setmetadata.php" class="function" rel="rdfs-seeAlso">Phar::setMetadata()</a> - Define metadados do arquivo phar</span></li>
    <li><span class="function"><a href="phar.hasmetadata.php" class="function" rel="rdfs-seeAlso">Phar::hasMetadata()</a> - Informa se o phar tem metadados globais</span></li>
    <li><span class="function"><a href="phar.getmetadata.php" class="function" rel="rdfs-seeAlso">Phar::getMetadata()</a> - Retorna metadados do arquivo phar</span></li>
   </ul>
  </p>
 </div>


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