bug doc ext nae site разработка

Информация для разработчиков плагинов

Если вы собираетесь создавать плагина для neutrino, то эта информация для вас!

Файловая структура относительно корня блога(/):

  1. ext/extension/
  2. ext/extension/index.php
  3. ext/extension/extension.ini.php
  4. ext/extension/extension.php
  5. ext/extension/readme.txt
, где extension - имя вашего расширения.

Теперь по пунктам:

  1. Имя каталога плагина должно совпадать с именем php-файла плагина, и файлом настроек ( *.ini.php )
  2. index.php - этот файл include-ится во все страницы блога, если плагин включен. Внутри этого файла рекомендуется создавать функции, которые после будут использоваться. Обратите внимание, что если в index.php объявляются переменные, то могут возникнуть сложности с областью видимости переменных, поэтому настоятельно рекомендуется использовать именно функции, хотя бы формата
    function ext_test(){return 'any text or other data';} Наличие этого файла не обязательно, и используется только если нужно выполнять какой-либо код на всех страницах.
  3. extension.ini.php - это ini-файл, сформатированный специальным образом. Первую(;<? /*), и последнюю(;*/ ?>) строку рекомендуется оставлять без изменений. Между ними идет содержимое в стандартном ini-формате. Обязательными являются поля author, version, description.

    Пример(файл blocks.ini.php):

    ;<? /*
    author=Bolzamo
    version=1.0
    description=Пользовательские блоки на сайте
    ;*/ ?>
    Вы также можете использовать свои параметры, а внутри скриптов получать к ним доступ стандартной php-функцией $ext_ini=parse_ini_file('ext/extension/extension.ini.php'), где var - имя параметра в ini-файле. Таким образом, имя автора тега будет здесь: $ext_ini['author'], версия - здесь: $ext_ini['version'], и т.д.
  4. extension.php основной файл плагина. Это тот скрипт, который обрабатывается при переходе пользователем на страницу ?ext=extension, где extension - имя нашего расширения.
    Здесь не стесняйтесь использовать print/echo :)
  5. readme.txt - Этот файл содержит в себе описание плагина и инструкцию к применению. К оформлению не предъявляется никаких требований кроме информативности и удобочитаемости. Файл доступен через администраторский интерфейс на странице ?action=ext&readme=extension , где extension - имя нашего расширения.
  6. Рекомендации к использованию пространства имен:

    Используйте оригинальные, но понятные и информативные названия плагинов. Само собой, название плагина может содержать в себе только латинские буквы, цифры, тире(-), точку(.) и символы подчеркивания(_). Если писать в имя расширения русские буквы и спецсимволы, возникнут сложности.

    Не возбраняется создавать свои служебные каталоги в директории data. При этом рекомендуется использовать имя файла такого формата: data/ext_extension/ , где extension - имя нашего расширения.

    В index.php объявляются специальные функции для плагинов, и чтобы имена не пересекались, создавайте функции, начинающиеся с "ext_extension", например ext_blocks_php();

    Удачи! :)

страницы
Друзья блога: Huze http://avvdesign.info/blog Mosquito, Neutrino Forum Bolzamo: PHP-programmer


найди: