Глава 17. Файл описания пакета - package.xml

Содержание
Введение

Введение

Файл описания пакета, package.xml, как становится понятно из его имени - это XML-файл, который содержит всю информацию о пакете из PEAR.

В этой главе описываются элементы, которые могут присутствовать в файле описания пакета, а также обсуждаются способы создания такого файла для вашего пакета.

Допустимые элементы

Корневым элементом файла package.xml является элемент <package version="1.0">. Допускаются следующие вложенные элементы:

  • <name>: Имя пакета.

  • <summary>: Краткое описание пакета.

  • <description>: Полное описание пакета.

  • <license>: Лицензия (PHP License, LGPL и т.п.). Более подробная информация о допустимых лицензиях в PEAR содержится в FAQ.

  • <maintainers>: Информация о создателях пакета.

    • <maintainer>: Информация о каждом создателе отдельно (может присутствовать несколько раз, для каждого разработчика).

      • <user>: Имя аккаунта разработчика.

      • <role>: Роль разработчика в процессе создания пакета. Может принимать значения: lead, developer, contributor, helper.)

      • <name>: Настоящее имя разработчика.

      • <email>: Адрес электронной почты.

  • <release>: Информация о текущем релизе.

    • <version>: Номер версии релиза.

    • <state>: Статус релиза. (Может быть alpha, beta, stable, devel или snapshot)

    • <date>: Дата релиза.

    • <notes>: Комментарии к релизу

    • <filelist>

      • <file role="xxx">: Имя файла

      • <dir name="xxx" [role="xxx"]>: Имя поддиректории. Поддиректория, в свою очередь, может содержать другие элементы <file role="xxx">.

    • <deps>: Список зависимостей пакета.

      • <dep type="xxx" rel="yyy" optional="yes">name</dep> : Более подробную информацию о зависимостях можно найти ниже.

  • <changelog>: Changelog(история изменений) пакета.

    • <release>

      • <version>: Версия конкретного релиза.

      • <state>: Статус конкретного релиза.

      • <date>: Дата конкретного релиза.

      • <notes>: Комментарии к релизу.

Создание файла описания пакета

Этот файл package.xml может послужить вам шаблоном, т.к. он уже содержит все необходимые поля. В большинстве случаев, вам нужно будет всего лишь поменять текст между тэгами, чтобы использовать пример в вашем пакете.

В этом примере демонстрируется очень удобный прием: когда в какой-то из ваших директорий содержатся файлы только одного типа, вы можете использовать атрибут "role" у элемента <dir> вместо того, чтобы добавлять его у каждому элементу <file>.

После прочтения данной главы вы уже можете создавать файл описания пакета. Если у вас все еще есть вопросы по этому поводу - задавайте их в листе рассылки.

Определение зависимостей

PEAR Package Manager или менеджер пакетов позволяет задавать различные требования к системе. Вы можете определить зависимости от этих требований с помощью элемента <dep>:

Атрибут rel

Атрибут rel определяет отношение между существующей возможностью и требованием.

Has используется, если не определено других значений. Стоит отметить, что rel обязателен для PEAR 1.4.0 и выше.

    Поддержать сайт на родительском проекте КГБ