<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.phar.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ru',
  ),
  'this' => 
  array (
    0 => 'phar.setmetadata.php',
    1 => 'Phar::setMetadata',
    2 => 'Установить метаданные phar-архива',
  ),
  'up' => 
  array (
    0 => 'class.phar.php',
    1 => 'Phar',
  ),
  'prev' => 
  array (
    0 => 'phar.setdefaultstub.php',
    1 => 'Phar::setDefaultStub',
  ),
  'next' => 
  array (
    0 => 'phar.setsignaturealgorithm.php',
    1 => 'Phar::setSignatureAlgorithm',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ru',
    'path' => 'reference/phar/Phar/setMetadata.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="phar.setmetadata" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">Phar::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">Phar::setMetadata</span> &mdash; <span class="dc-title">Установить метаданные phar-архива</span></p>

 </div>


 <div class="refsect1 description" id="refsect1-phar.setmetadata-description">
  <h3 class="title">Описание</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>Phar::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>

  <blockquote class="note"><p><strong class="note">Замечание</strong>: <p class="para">Для корректной работы с объектами <span class="classname"><a href="class.phar.php" class="classname">Phar</a></span>
этому методу необходима установка значения <var class="filename">php.ini</var> <code class="literal">phar.readonly</code> в <code class="literal">0</code>.
В противном случае, будет выброшено исключение <span class="classname"><a href="class.pharexception.php" class="classname">PharException</a></span>.</p></p></blockquote>

  <p class="para">
   Функция <span class="function"><strong>Phar::setMetadata()</strong></span> используется для сохранения
   данных, характеризующих phar-архив в целом.
   <span class="function"><a href="pharfileinfo.setmetadata.php" class="function">PharFileInfo::setMetadata()</a></span> используется для установки метаданных
   для конкретного файла. Если метаданных будет много, то это может снизить
   скорость загрузки phar-архива.
  </p>
  <p class="para">
   Метаданные можно использовать, например, для указания, какой файл должен
   исполняться при загрузке, или для указания местоположения манифеста,
   типа package.xml для модуля <a href="https://pear.php.net/" class="link external">&raquo;&nbsp;PEAR</a>.
   В общем, любые полезные в контексте phar-архива данные.
  </p>

 </div>


 <div class="refsect1 parameters" id="refsect1-phar.setmetadata-parameters">
  <h3 class="title">Список параметров</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">metadata</code></dt>
     <dd>
      <p class="para">
       Любая переменная PHP, содержащая необходимую информацию
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-phar.setmetadata-returnvalues">
  <h3 class="title">Возвращаемые значения</h3>
  <p class="para">
   Функция не возвращает значения после выполнения.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-phar.setmetadata-examples">
  <h3 class="title">Примеры</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Пример #1 Пример использования <span class="function"><strong>Phar::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">// удалим, на всякий случай<br /></span><span style="color: #007700">@</span><span style="color: #0000BB">unlink</span><span style="color: #007700">(</span><span style="color: #DD0000">'brandnewphar.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">'/brandnewphar.phar'</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #DD0000">'brandnewphar.phar'</span><span style="color: #007700">);<br />    </span><span style="color: #0000BB">$p</span><span style="color: #007700">[</span><span style="color: #DD0000">'file.php'</span><span style="color: #007700">] = </span><span style="color: #DD0000">'&lt;?php echo "привет"'</span><span style="color: #007700">;<br />    </span><span style="color: #0000BB">$p</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">setMetadata</span><span style="color: #007700">(array(</span><span style="color: #DD0000">'bootstrap' </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">'file.php'</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">-&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">'Не могу создать/изменить 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>
 Результат выполнения приведённого примера:
</p></div>

    <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">array(1) {
  [&quot;bootstrap&quot;]=&gt;
  string(8) &quot;file.php&quot;
}</pre>
</div>
    </div>
   </div>
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-phar.setmetadata-seealso">
  <h3 class="title">Смотрите также</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="phar.getmetadata.php" class="function" rel="rdfs-seeAlso">Phar::getMetadata()</a> - Извлечь метаданные phar-архива</span></li>
    <li><span class="function"><a href="phar.delmetadata.php" class="function" rel="rdfs-seeAlso">Phar::delMetadata()</a> - Удаляет глобальные метаданные в phar-архиве</span></li>
    <li><span class="function"><a href="phar.hasmetadata.php" class="function" rel="rdfs-seeAlso">Phar::hasMetadata()</a> - Проверить, содержит ли phar-архив глобальные метаданные</span></li>
   </ul>
  </p>
 </div>


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