PHP Manual
PharData
Установить метаданные phar-архива

PharData::setMetadata

(No version information available, might only be in Git)

PharData::setMetadata — Установить метаданные phar-архива

Описание

public PharData::setMetadata ( mixed $metadata ) : void

Замечание:
Для корректной работы с объектами Phar этому методу необходима установка значения php.ini phar.readonly в 0. В противном случае, будет выброшено исключение PharException.

Функция Phar::setMetadata() используется для сохранения данных, характеризующих phar-архив в целом. PharFileInfo::setMetadata() используется для установки метаданных для конкретного файла. Если метаданных будет много, то это может снизить скорость загрузки phar-архива.

Метаданные можно использовать, например, для указания, какой файл должен исполняться при загрузке, или для указания местоположения манифеста, типа package.xml для модуля » PEAR. В общем, любые полезные в контексте phar-архива данные.

Список параметров

metadata: Любая переменная PHP, содержащая необходимую информацию

Возвращаемые значения

Эта функция не возвращает значения после выполнения.

Примеры

Пример #1 Пример использования Phar::setMetadata()


<?php
// удаляем, на всякий случай
@unlink('brandnewphar.phar');
try {
    $p = new Phar(dirname(__FILE__) . '/brandnewphar.phar', 0, 'brandnewphar.phar');
    $p['file.php'] = '<?php echo "hello"';
    $p->setMetadata(array('bootstrap' => 'file.php'));
    var_dump($p->getMetadata());
} catch (Exception $e) {
    echo 'Не удалось создать и/или изменить phar:', $e;
}
?>

Результат выполнения данного примера:

array(1) {
  ["bootstrap"]=>
  string(8) "file.php"
}

Смотрите также

Phar::getMetadata() - Извлечь метаданные phar-архива
Phar::delMetadata() - Удалить глобальные метаданные в архиве phar
Phar::hasMetadata() - Проверить, содержит ли phar-архив глобальные метаданные