В наушниках по жизни: документация на русском
40 заметок с тегом

документация на русском

Позднее Ctrl + ↑

События

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

Обзор

События представляют собой скрипты, закреплённые за страницами, которые при срабатывании в определённых условиях, выполняют ряд заданных действий. Встроенный с Symphony редактор позволяет легко и быстро создавать любые события на страницах пользователей, позволяя им тем самым добавлять данные в разделы системы (например, система комментариев это хороший пример для описания). Однако, вы можете содавать свои собственные события посредством API системы (материал готовится к публикации)

К каждому условию может быть прикреплён фильтр, для создания дополнительных условий (например, только автор может вызывать событие) или для выполнения вторичного действия (например, отправка почты при срабатывании события).

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

Доступ к управлению событиями осуществляется через меню компонентов (Blueprints > Components).

После создания новго события, редактор событий покажет инструкции и примеры кода для использования событий на страницах вашего сайта.

Чтобы активировать механизм событий, к необходимой странице необходимо заранее подключить события через панель администратора.

Детали

Редактор событий.

Редактор событий.

События создаются и редактируются с использованием редактора событий Symphony, который представляет собой простую форму с тремя полями:

Параметр Описание Пример
Имя (Name) Любое имя события. Save Comment
Источник (Source) Раздел, в который событие будет добавлять данные. Comments
Фильтры (Filter Rules) Фильтры события, которые влияют на работу события. Send Email

The Big Picture

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

2012   Beginner's Guide   CMS   Events   symphony   документация   документация на русском   перевод   руководство   события

JIT Image Manipulation

JIT Image Manipulation (Just in time image manipulation т. е. работа с изображениями «на лету») представляет собой API для данамического преобразования изображений на основании URL параметров.

Обзор

JIT (Just-in-time) Image Manipulation это расширение, которое помогает динамически преобразовывать изображения на основании параметров переданных через URL. Данное расширение позволяет обрезать и/или изменять размер оригинального изображения (независимо от расположения изображения на вутреннем проекте Symphony или внешнем хостинге), а так же кэшировать изображения и возвращать уже модифицированный вариант.

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

JIT Image Manipulation вызывается при помощи специально сформированного URL. Основанием для такого URL служит http://your-site.com/image/. Дополнительные параметры указываются после базового URL и определяют режим преобразования, опции и расположение файла (описание см. ниже). Вы можете использовать данное расширение в своих шаблонах, указывая специальный URL в атрибуте src элемента img, например:

<img src="http://yoursite.com/image/1/200/0/images/ninja-parade.jpg"/>

Внешние источники изображений

В случае если необходимо преобразовывать изображение с других сайтов, необходимо добавить домен-источник в список «Деверенные сайты (Trusted Sites)» в меню Система > Настройки. Добавлять домены следует по одному на строку в следующем формате:

images.external-site.com*

Детали

Режимы

JIT Image Manipulation имеет четыре разных режима работы, каждый из которых требует разного указания URL параметров. См. таблицу ниже для получения дополнительной информации:

Режим Описание и структура URL
/ image / e / path
По умолчанию: Если режим преобразования не указан, изображение выводится как есть без изменений.
1 / image / 1 / w / h / e / path
Режим 1: Изменение размера размер исходного изображения будет изменён в соответствии с указаными значениями. Если высота или длинна изображения указаны как 0, то данный параметр будет вычислен в соответствии с пропорциями изображения.
2 / image / 2 / w / h / p / e / path
Режим 2: Заполнение холста размер исходного изображения будет изменён в соответствии с указаными значениями. Если высота или длинна изображения указаны как 0, то параметры будут вычислены в соответствии с пропорциями изображения.
3 / image / 3 / w / h / p / b / e / path
Режим 3: Изменение размера холста производится несмотря на исходный размер изображения, основываясь на параметрах высоты, ширины и позиции. Если размер холста меньше исходного изображения в любом измерении, то изображение будет обрезано. В случае если размер холста больше, свободное пространство будет заполнено фоновым цветом.

Параметры

Опции преобразования изображений задаются с помощью параметров:

Параметр Описание
Ширина (Width) Число в пикселях. Если указано значение 0, то обязательно необходимо указать высоту изображения, а ширина будет подобрана автоматически на основании соотношения сторон.
Высота (Height) Число в пикселях. Если указано значение 0, то обязательно необходимо указать ширину изображения, а высота будет подобрана автоматически на основании соотношения сторон.
Позиция (Position) Число от 1 до 9, определяющее регион который будет вырезан или изменён. Смотрите сетку ниже...
Фон (Background Color) Hex значение цвета. Поддерживается CSS-стиль коротких hex строк (ff2233 == f23).
Источник (External) Опционально. 0 или пустое значение для внутренних изображений сайта. 1 для изображений с других сайтов.
Путь (Path) Путь к оригиналу изображения. Если изображение расположено локально, то можно указывать относительный путь к файлу от каталога /workspace. Если изображение находится на стороннем сайте, то следует указывать полный URL путь (без http://) .

Сетка позиционирования

При использовании режимов «Заполнение холста» и «Изменение размера холста» преобразования будут производиться с использованим параметра «Позиция». Изображение показанное ниже, показыват возможные значения, которые может принимать параметр «Позиция».

JIT Positioning Grid
2012   Beginner's Guide   CMS   JIT Image Manipulation   symphony   документация   документация на русском   перевод   руководство

Devkits

Модуль Devkits представляет собой инструментарий разработчика и позволяет производить отладку, профилирование и другие задачи при разработке сайта.

Обзор

Devkits или Набор разработчика Symphony представляет собой расширение которое добавляет специальный интерфейс для фронт-энд системы для авторизованых авторов. Модуль devkits состоит из двух частей — «отладчик» и «профиль», оба предоставляют доступ к служебной информации о страницах, включая данные в виде XML, шаблоны страниц, утилиты и доступные параметры, а так же выводят параметры отображения страницы, такие как, время выполнения и загрузки страницы и пр.

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

Доступ к модулю осуществляется с помощью специального GET параметра через URL. Напримрер, набрав в адресной строке yoursite.com/?debug или yoursite.com/?profile вы получите доступ к странице отладки или профилю, соответственно.

Будьте внимательны, для работы с модулем devkit, вам необходимо чтобы модуль был установлен и включен в системных настройках.

Детали

Интерфейс devkit содержит ссылки на редатор страницы и дополнительные ссылки для доступа к функциям devkit. По умолчанию в ядро Symphony включено два модуля devkit:

Модуль отладки

Итерфейс отладки Symphony, предоставляемый модулем Debug Devkit.

Доступ к модулю отладки осуществляется путём добавления параметра ?debug к URL страницы и предоставлется следующая информация:

  • текущий пул параметров
  • источник данных в виде XML
  • каждый используемый XSLT шаблон (шаблон страницы и все используемые утилиты)
  • результирующий вывод

Профиль
Доступ к модулю профиля осуществляется путём добавления параметра ?profile к URL страницы и предоставлется следующая информация:

  1. Основное:
    • Версия движка
    • Время начала генерации страницы
    • время XML вывода
    • результаты генерации XML
    • информация о построении страницы
    • информация о XSLT преобразованиях
    • время генерации страницы
  2. Время формирования и выполнения запросов к источникам данных
  3. Полная статистика формирования страницы
    • Общее количество запросов
    • Запросы (> 0.09с)
    • Общее время потраченое на запросы
    • Время обработки всех событий
    • Время выполнения всех источников данных
    • Функция генерации XML
    • Генерация XSLT
    • Время генерации выходных данных
    • Использованное количество памяти
  4. Использование памяти
2012   Beginner's Guide   CMS   Devkits   symphony   документация   документация на русском   перевод   руководство

Github

Все официальные дистрибутивы и расширения расположены на хосте Github.

Обзор

Github это вебсайт, который предоставляет услуги хостинга и совместной работы с Git репозиториями. Официальный дистрибутив Symphony и большинства расширений Symphony расположены на Github.

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

Для получения дополнительной информации по работе с Github смотрите руководство сайта Github: http://help.github.com/

2012   Beginner's Guide   CMS   Github   symphony   документация   документация на русском   перевод   руководство

Git

Система контроля версий Git используется для управления обновлениями и дистрибутивами Symphony.

Обзор

Git является распределённой системой контроля версий и используется для хранения кода Symphony и большинства раширений для Symphony. Система позволяет легко скачивать и обновлять дистрибутивы Symphony и расширений.

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

Смотрите руководство пользователя Git для получения дополнительной информации по работе с Git: http://www.kernel.org/pub/software/scm/git/docs/user-manual.html

2012   Beginner's Guide   CMS   Git   symphony   документация   документация на русском   перевод   руководство
Ранее Ctrl + ↓