1 заметка с тегом: Extension File Structure
Здесь я пишу свои идеи, мысли, описываю события своей жизни и просто делаю личные и рабочие заметки. «А Вы что, собираетесь жить вечно?»
1 заметка с тегом

Extension File Structure

Структура файлов расширения

25 сентября 2012, 20:56

Строгая структуризация файлов расширений позволяет Symphony автоматически определять и загружать расширения.

Обзор

Структура файлов расширения создаёт определённый макет расположения и именования файлов, позволяя тем самым системе автоматически определять и загружать расширения.

Использование

При создании расширения просто следуйте конвенции описанной ниже.

Детали

Обзор

Расширения должны быть структурированы следующим образом. Обратите внимание, что обязательным файлом является лишь extension.driver.php. Остальный файлы могут быть добавлены по мере необходимости.


    yourextension/
        assets/
            sample.js
            sample.css
        content/
            content.index.php
            content.sample.php
        data-sources/
            datasource.sample.php
        events/
            event.sample.php
        fields/
            field.sample.php
        lang/
            lang.de.php
            lang.es.php
        lib/
            yourphplibs.php
        text-formatters/
            formatter.sample.php
        extension.driver.php
        license
        README


assets/

Хотя фактически каталог не используется для автоматического подключения файлов, но в него помещаются CSS файлы, JavaScript и изображения.

content/

Файлы в данном каталоге автоматически подключаются и используются для генерации страниц в панели управления. Файл content.sample.php будет доступен по адресу /symphony/extension/yourextension/sample, а файл content.index.php по адресу /symphony/extension/yourextension

data-sources/

Любые источники данных, которые будут предоставлены расширением, должны быть размещены здесь для автоматического подключения.

events/

Любые события, которые будут предоставлены расширением, должны быть размещены здесь для автоматического подключения.

fields/

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

lang/

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

lib/

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

text-formatters/

Любые парсеры текста, которые будут предоставлены расширением, должны быть размещены здесь для автоматического подключения.

extension.driver.php

Файл extension.driver.php используется для инициализации, включения, удаления и обновления расширения, а так же для подписывания на делегаты. Данный файл является обязательным.

license or licence

Текстовый файл описывающий лицензию использования расширения.

README or README.markdown

README файл для расширения. Обычно данный файл содержит основную информацию (имя расширения, версию и дату релиза), информацию разработчика (имя, email и адрес веб-сайта) и информацию о установке и использовании расширения.

The Big Picture

Структура файла расширения это важная часть API расширений Symphony (документация находиться в разработке).