В наушниках по жизни: заметки с тегом CMS

Немного о Symphony CMS

Mon, 21 Oct 2013 14:22:54 +0500

Предисловие

Уже больше года в своей работе для создания небольших сайтов и внутри корпоративных порталов я использую Symphony CMS. Самое странное, что при такой большой конкуренции среди бесплатных CMS, данная система управления сайтами остаётся практически незамеченной российскими разработчиками и не попадает в рейтинги CMS вроде «CMS Magazine» и напрасно, как мне кажется.

Symphony CMS

Symphony CMS элегантный и миниатюрный open source движок, написанный на PHP + MySQL, который в своей основе использует XML и XSLT.

На первый взгляд Symphony очень похож ExpressionEngine, Textpattern, WordPress или Drupal. На Symphony, безусловно, можно сделать стандартный веб сайт или блог, но благодаря концептуальной элегантности в работе со структурами данных и источниками данных он находится в уникальном положении между обычными CMS и полноценными веб приложениями, такими, как Django или Ruby on Rails.

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

Мощь и сила

Вся мощь и сила Symphony CMS состоит в том, что разработчики могут создавать любые структуры данных. Создание чем-то напоминает работу с классами в модели ООП. Сначала вы создаёте некий класс, предположим, раздел статей сайта. Раздел должен содержать некоторые характерные поля: заголовок статьи, автор, текст статьи (полный и краткий), дата публикации, отметку выводить статью на сайте или нет и многое другое. Таким образом, мы создаём раздел, некий «класс» объектов для сайта, после чего, мы сразу же можем приступать к созданию экземпляров класса, т. е. писать статьи.

Ещё одним большим плюсом системы, является то, что любые структуры данных можно изменять уже после начала их заполнения. Например, есть у вас раздел для создания статей, и в нём уже есть пара десятков статей. И вот у вас возникла необходимость добавить новое поле, к примеру, поле для ввода тегов. Система позволит вам это сделать совершенно без проблем, при этом никакие, уже имеющиеся данные, не потеряются.

После создания разделов, разработчики создают так называемые «Источники данных». Суть их проста, выборка данных из имеющихся разделов. Напрмер, есть у меня раздел статей, из которого мне надо выбрать только статьи, которые помечены, как опубликованные и только за текущий месяц. Для этого потребуется создать простой источник данных, задать раздел из которого необходимо сделать выборку данных и установить условия выборки. И всё. Источник готов к работе.

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

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

На этом собственно и основана работа в backend.

Далее дело за разработчиками fronend.

Все данные, получаемые от источников данных, поступают на страницы в виде XML. Сами же страницы создаются при помощи XSLT, HTML, CSS, JS и любых других технологий. Тут я думаю подробно описывать ничего не надо, но вся суть заключается в том, что в уже имеющийся готовый шаблон выводятся данные полученные от источников данных путём вывода определённых ветвей XML. И разработчики получают все плюсы и минусы работы с XSLT и XML.

Расширяемость

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

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

Так же на сайте движка разработчики могут найти так называемые XSLT утилиты, это небольшие XSL файлы, с шаблонами обработки определённых данных или создания определённых частей интерфейса. Например, шаблон большого календаря, ячейки которого унифицированы и каждую из них вы можете заполнить любыми данными, не прибегая к изменению самого шаблона.

Или, например, XSLT модуль для типографики текста. Т. е. вы просто применяете шаблон к тексту и всё. Модуль автоматически заменит и подставит правильные двойные кавычки, заменит короткое тире на длинное и пр.

Банк утилит постоянно обновляет и пополняется. Сообщество разработчиков ведёт довольно активную деятельность. Любой желающий может написать и выложить свой модуль или расширение прямо на сайте Sуmphony или на Symphony Extensions.

Кстати, вот страница с моими расширениями.

Первым моим самостоятельным расширением было «Language: Russian», это локализация ядра самого движка.

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

И последнее, написанное мной расширение, это «SMS Pilot Sender». Расширение, которое при возникновении какого-либо события отправляет СМС через сервис SMS Pilot. Подробно работу расширения я описал в предыдущем посте «Плагин SMS Pilot Sender для Symphony CMS».

Переносимость

Помимо невероятной гибкости и расширяемости самой системы, ещё одной невероятно полезной отличительной особенностью движка является система экспорта сборки или в оригинальном варианте «Export Ensemble». Это крайне полезная функция для разработчиков, которые постоянно занимаются разработкой однотипных систем.

Предположим, перед нами стоит задача создания двух идентичных новостных сайтов, у которых идентично всё, кроме дизайна. Экспорт сборки, позволит создать архив не только движка, но и всех расширений, данных, настроек и пр. При этом архив содержит не просто файлы, а готовый к установке движок. Т. е. достаточно в одном месте сделать выгрузку сборки, распаковать её на другой площадке и просто произвести процесс установки. После чего, мы получим совершенно готовый к работе сайт. Нам останется лишь изменить дизайн, при этом системная часть не потребует внесения изменений.

Заключение

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

Плагин SMS Pilot Sender для Symphony CMS

Sun, 20 Oct 2013 21:56:40 +0500

На выходных задался целью написания одного небольшого, но крайне полезного плагина для движка Symphony CMS. Данным движком я пользуюсь уже больше года, и он отлично себя зарекомендовал. Описание данного движка достойно отдельной статьи, поэтому в данном посте я опишу лишь написанный мной плагин.

SMS Pilot Sender

Данный плагин добавляет новый фильтр событий для отправки СМС сообщений через сервис SMSPilot.

Установка плагина SMS Pilot Sender

Скачиваем плагин на Github.
Создаём каталог «sms_pilot_sender» в каталоге расширений движка и копируем в него файлы плагина.
Теперь в разделе управления расширениями движка находим и включаем плагин «SMS Pilot Sender».

Настройка плагина SMS Pilot Sender

После установки плагина, заходим в раздел настроек для дальнейшей конфигурации. Для работы с сервисом SMS Pilot необходимо скопировать ваш уникальный API ключ в личном кабинете и вставить его в соответствующее поле в разделе настроек.

После ввода API ключа и сохранения настроек, в разделе появятся дополнительные поля конфигурирования, но только в том случае, если указан валидный API ключ.

На основании введенного API ключа, система делает запрос через API сервиса SMS Pilot и получает список допустимых имён отправителей. Имена отправителей задаётся в личном кабинете сервиса. Поле «Отправитель» отвечает за подпись отправителя СМС, именно от этого имени абонент получит СМС.

В поле «Номера телефонов» перечисляют номера телефонов абонентов, которые должны получить СМС при срабатывании события в системе.

Поле «Текст сообщения» служит для ввода текста сообщения, которое будет отправлено абонентам, чьи номера указаны в поле «Номера телефонов».

Использование плагина SMS Pilot Sender

После того, как все настройки плагина произведены, вы можете добавить появившийся фильтр SMS Pilot: Отправка СМС к любому из имеющихся в системе событий.

После того, как система инициирует данное событие, и данные будут успешно обработаны, сработает фильтр отправки СМС сообщения.

Проверка

Вот такой вот первый небольшой плагин для движка Symphony CMS.

P.S. Если вы знакомы с работой системы Событий и Фильтров в Symphony CMS, то вы без проблем сможете разобраться в работе данного плагина.

CKEditor для Symphony

Sat, 22 Dec 2012 22:29:36 +0500

Т. к. я стал активно использовать движок Symphony CMS, который работает с XML и кодировкой UTF-8, то довольно часто приходится сталкиваться с проблемами кодировки и кодирования информации.
Одним из самых удобных редакторов текста для Symphony, на мой взгляд, является CKEditor, который устанавливается в систему в качестве плагина. Но по умолчанию плагин кодирует информацию в виде HTML символов, переводя все русские символы в коды. Это в свою очередь делает невозможным, работу поиска, так как индексирование текста становиться невозможным. А так же невозможно нормально просматривать получившийся исходный код.

Кодирование русских символов к воды вносит ещё один большой недостаток, 1 символ превращается в 6, тем самым увеличивая объём данных в 6 раз и может сильно замедлить работу движка и обработки XSLT.

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

Итак, скачиваем плагин CKEditor с сайта плагинов движка.

Открываем файл /ckeditor/assets/symphony.ckeditor.js, находим строку:

ck_configurationData.skin = ’chris’;

И добавляем после неё 2 строки отключения обработки символов:

ck_configurationData.htmlEncodeOutput = false;
ck_configurationData.entities = false;

После чего устанавливаем плагин в систему и наслаждаемся работой системы.

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

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

Tue, 25 Sep 2012 19:56:33 +0500

Строгая структуризация файлов расширений позволяет 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 (документация находиться в разработке).

Делегаты

Tue, 25 Sep 2012 14:15:43 +0500

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

Обзор

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

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

Расширения могут подписываться на делегаты системы при помощи объявления функции getSubscribedDelegates() в файле extension.driver.php, как показано ниже:

   public function getSubscribedDelegates(){
        return array(
            array(
                ’page’ => ’/delegatepage/’,
                ’delegate’ => ’DelegateName’,
                ’callback’ => ’extensionFunction’
            ),
        );
    }

Функция getSubscribedDelegates() должна вернуть массив подписки, каждый массив представляет собой три пары ключ/значение: страница, делегат и обратный вызов. Первые два значения определяются сам делегат (см. список ниже). Последнее значение является именем функции обратного вызова, предоставляемой расширением.

Для получения дополнительной информации о делегатах смотрите документацию.

Расширения

Tue, 25 Sep 2012 11:45:07 +0500

Расширения добавляют в проекты Symphony дополнительный функционал.

Обзор

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

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

Все расширения следует копировать к каталог extensions/.

Управление расширениями осуществляется через панель управления в меню Система > Расширения. Индивидуальное или групповое управление осуществляется при помощи выпадающего меню в самом низу страницы управления расширениями. Вы можете включать, отключать или удалять расширения.

Детали

Ниже представлено описание семи основных расширений системы:

Расширение	Описание
Debug Devkit	Представляет собой инструментарий разработчика и позволяет производить отладку, профилирование и другие задачи при разработке сайта.
Экспорт сборки	Расширение для создания сборок через панель управления администратора.
Select Box Link	Дополнительный типа полей, позволяющий создавть связи между разделами.
JIT Image Manipulation	Расширение позволяющее изменять изобращения на лету с помощью специально сформированного URL адреса.
Режим обслуживания	Позволяет закрывать сайт на время проведения работ.
Markdown Text Formatter	Расширение, которое добавлят парсер текста Markdown и применяет его к текстовым полямы.
Profile Devkit	Дополняет инструментарий разработчика и позволяет производить отладку, профилирование и другие задачи при разработке сайта.

The Big Picture

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

Сборки (Ансамбли)

Tue, 25 Sep 2012 09:30:03 +0500

Сборки (Ensembles) Symphony представляют собой проекты, включающие в себя все рабочие файты, базы данных и установочные файлы.

Обзор

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

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

Создание сборок осуществляется в панели управления в разделе Система > Настроки, нажатием на кнопку «Создать сборку». Примечание: необходимо, чтобы на серверы был установлен PHP модуль для работы с ZIP.

Установка сборки осуществляется так же, как и обычная установка движка (см. «Установка Symphony»)

Обратите внимание, что при создании сборки, все сторонние таблицы дополнительных модулей не копируются. Если вам необходимо перенести эти данные, то вам следует самому позаботиться о SQL бэкапах этих данных. Полное копирование всех данных будет реализовано в следующих релизах Symphony.

Детали

Сборки по своей сути представляют копию проекта Symphony с его структурой и внешним видом.

The Big Picture

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

Фильтры событий

Tue, 25 Sep 2012 09:05:37 +0500

Фильтры событий устанавливают дополнительные условия для срабатывания событий.

Обзор

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

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

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

Детали

Описание трёх основных фильтров, доступных в Symphony по умолчанию:

Фильтр	Функция
Только для администратора (Admin Only)	Событие может быть вызвано только авторизованым администратором системы.
Отправка уведомления (Send Email)	При выполнении события, система отправляет письмо администратору.
Множественные изменения (Allow Multiple)	Разрешает изменение нескольких записей.

События

Mon, 24 Sep 2012 16:13:30 +0500

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

Обзор

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

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

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

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

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

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

Детали

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

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

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

The Big Picture

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

JIT Image Manipulation

Tue, 18 Sep 2012 21:30:43 +0500

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://) .

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

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

Devkits

Thu, 30 Aug 2012 23:04:31 +0500

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

Обзор

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

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

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

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

Детали

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

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

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

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

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

Основное:
- Версия движка
- Время начала генерации страницы
- время XML вывода
- результаты генерации XML
- информация о построении страницы
- информация о XSLT преобразованиях
- время генерации страницы
Время формирования и выполнения запросов к источникам данных
Полная статистика формирования страницы
- Общее количество запросов
- Запросы (> 0.09с)
- Общее время потраченое на запросы
- Время обработки всех событий
- Время выполнения всех источников данных
- Функция генерации XML
- Генерация XSLT
- Время генерации выходных данных
- Использованное количество памяти
Использование памяти

Github

Wed, 15 Aug 2012 15:31:34 +0500

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

Обзор

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

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

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

Git

Wed, 15 Aug 2012 15:22:48 +0500

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

Обзор

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

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

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

XPath

Wed, 15 Aug 2012 14:55:09 +0500

XPath используется XSLT для работы с узлами XML документа и выполнения основных операций преобразования XML документов.

Обзор

Синтаксис XPath используется в XSLT для выбора узлов XML документа. XPath обеспечивает дополнительный уровень функциональности в шаблонную систему Symphony, что позволяет использовать сложные схемы согласования и фильтрации, а так же выполнять расчеты и другие функции. Таким образом в проектах Symphony организована модель MVC и отделение представления данных в систему шаблонов.

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

XPath используется Symphony при создании XSLT таблиц стилей — шаблонов страниц и утилит.

Детали

Для получения дополнительной информации об XPath смотрите: http://www.w3.org/TR/xpath.

The Big Picture

XPath является широко используемым открытым стандартом, рекомундуемым W3C.

XSLT

Wed, 15 Aug 2012 14:40:32 +0500

XSLT используется в шаблонах страниц Symphony и утилитах для преобразования вида вывода данных.

Обзор

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

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

XSLT используется для создания шаблонов страниц и утилит в Symphony.

Детали

Для получения дополнительной информации об XSLT смотрите ссылку: http://www.w3schools.com/xsl/xsl_w3celementref.asp

The Big Picture

XSLT использует XPath для выборки узлов XML данных, проведения сложных вычислений и преобразований.

XSLT является широко используемым открытым стандартом, рекомундуемым W3C.

Дополнительная информация

Symphony использует расширения PHP libxslt для работы с XSLT. В настоящее время библиотека libxslt поддерживает только стандарт XSLT версии 1.0.

XML

Wed, 15 Aug 2012 14:23:30 +0500

XML используется движком Symphony для структуризации и вывода данных.

Обзор

XML язык разметки, который используется Symphony для вывода данных и их дальнейшего представление пользователям при помощи XSLT. Использование XML, родного для Symphony, упрощается задача работы с RSS лентами, API и другими данными представленными в виде XML и обеспечивает чистый валидный код.

Страницы Symphony преобразуют XML данные при помощи шаблонов страниц (и утилит) к любому нобходимому виду.

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

Страница XML данных состоит из фрагментов данных извлечённых из источников данных и событий. Для добавления данных на страницу необходимо создать источник данных и присоединить его к странице.

Детали

Корневым элементом страницы XML данных всегда является <data>. Все фрагменты источников данных или событий являются его потомками.

Для получения дополнительной информации об XML можно получить на странице: http://www.w3schools.com/xml/xml_whatis.asp

The Big Picture

XML является широко используемым открытым стандартом, рекомундуемым W3C.

Workspace

Tue, 14 Aug 2012 16:02:49 +0500

Каталог Workspace содержит такие файлы проекта, как источники данных, страницы, утилиты и загрузки.

Обзор

Каталог Workspace содержит все файлы проекта Symphony. По умолчанию там сохраняются источники данных, события, страницы, утилиты и файлы загружаемые пользователями. Часто разработкичи используют данный каталог для хранения различных вспомогательных файлов, таких как CSS и JavaScript или картинок шаблонов.

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

Пользователи могут создавать любую структуру подкаталогов в каталоге workspace.

URL адрес каталога workspace включён в системные параметры Symphony.

Детали

По умолчанию система создаёт и использует четыре подкаталога в каталоге workspace:

/data-sources
/events
/pages
/utilities

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

При необходимости могут быть созданы дополнительные подкаталоги. На практике довольно часто создаются вспомогательные каталоги (такие, как /styles, /images и /scripts) и /uploads для хранения загружаемого пользовательского контента.

The Big Picture

Каждый проект Symphony содержит в каталоге workspace файлы, делающие его уникальным и отличным от других сборок Symphony. «Чистая» Symphony CMS после установки имеет пустой каталог workspace. При создании своей сборки (ensemble), каталог workspace будет включён в сборку.

Поля для загрузки файлов должны использовать для загрузки файлов именно каталог workspace/ или его подкаталоги.

Системные ID

Tue, 14 Aug 2012 14:51:29 +0500

Системыне ID представляют собой идентификационные номера для всех записей проектов Symphony.

Обзор

Системыне ID это уникальные автоинкрементные поля с числовыми значениями, которые генерируются автоматически для всех записей в проектах Symphony. Системные ID представляет собой скрытое системное поле, недоступное при создании и редактировании записей, но доступное для фильтрации источников данных, сортировки и вывода.

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

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

Системные ID доступные для фильтрации источников данных, сортировки и вывода в выходных параметрах источников данных.

Детали

Всякий раз при выводе записей из источников данных, системный ID записи выводится в качестве атрибута в XML.

The Big Picture

Типы полей, которые используются для создания связей, такие как Select Box Link, используют системные ID для управления ассоциациями. Раздел с названием «Потомок» может использовать поле Select Box Link для указания раздела «Родителя». Поле будет хранить системный ID родителя, содержание может при этом изменяться, а свзь сохранит свою целостность.

Системные даты

Tue, 14 Aug 2012 13:56:29 +0500

Системные даты это отметки времени для отдельных записей в проектах Symphony.

Обзор

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

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

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

В отличие от системных ID, системные даты не могут быть использованы при фильтрации источников данных и данные о дате не выводятся в результирующий вывод XML. Они могут быть указаны в качестве выходных параметров для источников данных и используются, как правило, для сортировки записей.

Выходные параметры источников данных

Tue, 14 Aug 2012 12:17:16 +0500

Выходные параметры источников данных используются для связывания с другими источниками данных.

Обзор

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

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

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

Для получения дополнительной информации о выходных параметрах и связывани источников данных вы можете прочитать в разделе «Связывание источников данных».

Детали

Важно понимать, как работать с разными типами полей Symphony при выполнении связывания и сортировки на основании выходных параметров. Некоторые параметры будут использовать свои обработчики для выполнения выборки, другие же, такие как «Select Box Link» для выборки используют ID записей на которые они ссылаются.