Umicms - Вклад участника [ru]

Поиск с панелью предложений

2012-09-05T12:17:03Z

Kalexey:

[[category:Вопросы и уроки разработки сайтов на UMI.CMS]]

'''Задача''':
<p>
Реализовать автодополнение при наборе текста в текстовых полях.
</p>
'''Решение''':
<p>
Одно из решений для реализации данной возможности - применение плагина [http://jqueryui.com/demos/autocomplete/ jQuery UI Autocomplete] (client side) и использование кастомного макроса, который будет "вытаскивать" массив проиндексированных слов (server side).
</p>
<p>
Поскольку Autocomplete уже входит в состав UMI.CMS (файл "/js/jquery/jquery-ui.js"), нам остаётся только описать стиль для данного виджета.
<table align="center" width="100%">
<tr>
<td style="border: 1px dotted black; padding: 20px;">
'''Совет'''.
<br />
<p>
Удобнее всего скачать уже готовый стиль (тему) с официального сайта jQuery UI по ссылке: [http://jqueryui.com/download http://jqueryui.com/download]. Нас интересует только Autocomplete, поэтому можно убрать все флажки кроме "Autocomplete" в разделе "Widgets". Из скачанного архива нам понадобится только файл вида "jquery-ui-[версия].custom.css" в папке "/css/[название_темы]/" (по-умолчанию используется тема "ui-lightness"). Его необходимо скопировать в папку "/css". В дальнейшем в данном файле можно подредактировать стиль вручную (настроить шрифт, цвет, добавить скроллбар для выпадающего списка и т.д.).
</p>
</td>
</tr>
</table>
</p>
<p>
Пишем кастомный макрос, который будет возвращать массив проиндексированных слов из базы данных (подробнее про написание кастомных макросов Вы можете прочитать в [http://api.umi-cms.ru/ документации]):
</p>
<source lang="php">
public function wordsArray() {
$config = mainConfiguration::getInstance();
$host = $config->get('connections', 'core.host');
$login = $config->get('connections', 'core.login');
$password = $config->get('connections', 'core.password');
$dbname = $config->get('connections', 'core.dbname');

$pool = ConnectionPool::getInstance();
$pool->addConnection('core', $host, $login, $password, $dbname);
$pool->init();

$connection = $pool->getConnection('core');
$sql = "SELECT word FROM cms3_search_index_words";
$query = $connection->query($sql, true);
$pool->closeConnection('core');

for($i = 0, $numrows = mysql_num_rows($query); $i < $numrows; $i++) {
$row = mysql_fetch_assoc($query);
$words[$i] = strval($row['word']);
}

return json_encode($words);
}
</source>
<p>
Текст макроса размещаем в файле "/classes/modules/search/__custom.php", сразу после строчки "//TODO: Write your macroses here". Также нужно задать разрешения для макроса. Создаём в той же папке файл "permissions.custom.php" и в нём настраиваем разрешения:
<source lang="php">
<?php
$permissions = Array(
'search' => Array('wordsArray')
);
?>
</source>
</p>
<p>
Для подключения плагина и стиля необходимо написать следующий код в '''основном''' шаблоне:
<source lang="html4strict">
<link href="/css/jquery-ui-1.8.20.custom.css" type="text/css" rel="stylesheet" />
<script src="/js/jquery/jquery-ui.js" type="text/javascript"></script>
<script type="text/javascript">
$(document).ready(function() {
$('#search').autocomplete({ source: %search wordsArray()% });
});
</script>
</source>
</p>
<p>
В данном случае мы подключаем Autocomplete для текстового поля с идентификатором "search". Можно подключать Autocomplete к конкретным полям через их идентификатор, либо воспользоваться специальным классом для таких полей:
<source lang="html4strict">
<script type="text/javascript">
$(document).ready(function() {
$('.autocomplete').autocomplete({ source: %search wordsArray()% });
});
</script>
</source>
</p>
<p>
Подключаем Autocomplete для всех полей с классом "autocomplete".
</p>
<p>
Про настройки для Autocomplete можно прочитать в [http://jqueryui.com/demos/autocomplete/ официальной документации] виджета (вкладка "Options").
</p>
<table align="center" width="100%">
<tr>
<td style="border: 1px dotted black; padding: 20px;">
'''Важно'''.
<br />
<p>
Для сайтов с большим количеством контента необходимо применять опцию "minLength". Она позволяет настроить минимальное число символов для активации Autocomplete. Иначе скрипт может "подвисать" на достаточно большое время.
</p>
<p>
В данной статье механизм тестировался на сайте с числом уникальных проиндексированных слов ~50000 и параметром "minLength" равным 3.
</p>
</td>
</tr>
</table>
<source lang="html4strict">
<script type="text/javascript">
$(document).ready(function() {
$('.autocomplete').autocomplete({
source: %search wordsArray()%,
minLength: 3
});
});
</script>
</source>
<p>
Пример использования параметра "minLength".
</p>
<p>
Также хорошо бы добавить скроллбар для виджета, так как количество элементов может быть довольно большим. Для этого нам нужно подправить стиль "ui-autocomplete" в файле "jquery-ui-[версия].custom.css" (либо в Вашем собственном файле стилей):
<source lang="css">
.ui-autocomplete {
position: absolute;
cursor: default;
max-height: 250px;
overflow-x: hidden;
overflow-y: auto;
}
</source>
</p>
<p>
Ограничиваем максимальную высоту виджета в 250 пикселей, скрываем горизонтальный скроллбар и настраиваем отображение вертикального скроллбара по необходимости.
</p>
<br />
<table align="center">
<tr>
<td style="border: 1px solid black; padding: 5px;">
[[Файл:autocomplete.png]]
</td>
</tr>
<tr>
<td style="font-color: darkblue; font-weight: bold; text-align: center;">
Пример работы Autocomplete
</td>
</tr>
</table>

Поиск с панелью предложений

2012-09-05T11:21:23Z

Kalexey:

[[category:Вопросы и уроки разработки сайтов на UMI.CMS]]

'''Задача''':
<p>
Реализовать автодополнение при наборе текста в текстовых полях.
</p>
'''Решение''':
<p>
Одно из решений для реализации данной возможности - применение плагина [http://jqueryui.com/demos/autocomplete/ jQuery UI Autocomplete] (client side) и использование кастомного макроса, который будет "вытаскивать" массив проиндексированных слов (server side).
</p>
<p>
Поскольку Autocomplete уже входит в состав UMI.CMS (файл "/js/jquery/jquery-ui.js"), нам остаётся только описать стиль для данного виджета.
<table align="center" width="100%">
<tr>
<td style="border: 1px dotted black; padding: 20px;">
'''Совет'''.
<br />
<p>
Удобнее всего скачать уже готовый стиль (тему) с официального сайта jQuery UI по ссылке: [http://jqueryui.com/download http://jqueryui.com/download]. Нас интересует только Autocomplete, поэтому можно убрать все флажки кроме "Autocomplete" в разделе "Widgets". Из скачанного архива нам понадобится только файл вида "jquery-ui-[версия].custom.css" в папке "/css/[название_темы]/" (по-умолчанию используется тема "ui-lightness"). Его необходимо скопировать в папку "/css". В дальнейшем в данном файле можно подредактировать стиль вручную (настроить шрифт, цвет, добавить скроллбар для выпадающего списка и т.д.).
</p>
</td>
</tr>
</table>
</p>
<p>
Пишем кастомный макрос, который будет возвращать массив проиндексированных слов из базы данных (подробнее про написание кастомных макросов Вы можете прочитать в [http://api.umi-cms.ru/ документации]):
</p>
<source lang="php">
public function wordsArray() {
$config = mainConfiguration::getInstance();
$host = $config->get('connections', 'core.host');
$login = $config->get('connections', 'core.login');
$password = $config->get('connections', 'core.password');
$dbname = $config->get('connections', 'core.dbname');

$pool = ConnectionPool::getInstance();
$pool->addConnection('core', $host, $login, $password, $dbname);
$pool->init();

$connection = $pool->getConnection('core');
$sql = "SELECT word FROM cms3_search_index_words";
$query = $connection->query($sql, true);

for($i = 0, $numrows = mysql_num_rows($query); $i < $numrows; $i++) {
$row = mysql_fetch_assoc($query);
$words[$i] = strval($row['word']);
}

return json_encode($words);
}
</source>
<p>
Текст макроса размещаем в файле "/classes/modules/search/__custom.php", сразу после строчки "//TODO: Write your macroses here". Также нужно задать разрешения для макроса. Создаём в той же папке файл "permissions.custom.php" и в нём настраиваем разрешения:
<source lang="php">
<?php
$permissions = Array(
'search' => Array('wordsArray')
);
?>
</source>
</p>
<p>
Для подключения плагина и стиля необходимо написать следующий код в '''основном''' шаблоне:
<source lang="html4strict">
<link href="/css/jquery-ui-1.8.20.custom.css" type="text/css" rel="stylesheet" />
<script src="/js/jquery/jquery-ui.js" type="text/javascript"></script>
<script type="text/javascript">
$(document).ready(function() {
$('#search').autocomplete({ source: %search wordsArray()% });
});
</script>
</source>
</p>
<p>
В данном случае мы подключаем Autocomplete для текстового поля с идентификатором "search". Можно подключать Autocomplete к конкретным полям через их идентификатор, либо воспользоваться специальным классом для таких полей:
<source lang="html4strict">
<script type="text/javascript">
$(document).ready(function() {
$('.autocomplete').autocomplete({ source: %search wordsArray()% });
});
</script>
</source>
</p>
<p>
Подключаем Autocomplete для всех полей с классом "autocomplete".
</p>
<p>
Про настройки для Autocomplete можно прочитать в [http://jqueryui.com/demos/autocomplete/ официальной документации] виджета (вкладка "Options").
</p>
<table align="center" width="100%">
<tr>
<td style="border: 1px dotted black; padding: 20px;">
'''Важно'''.
<br />
<p>
Для сайтов с большим количеством контента необходимо применять опцию "minLength". Она позволяет настроить минимальное число символов для активации Autocomplete. Иначе скрипт может "подвисать" на достаточно большое время.
</p>
<p>
В данной статье механизм тестировался на сайте с числом уникальных проиндексированных слов ~50000 и параметром "minLength" равным 3.
</p>
</td>
</tr>
</table>
<source lang="html4strict">
<script type="text/javascript">
$(document).ready(function() {
$('.autocomplete').autocomplete({
source: %search wordsArray()%,
minLength: 3
});
});
</script>
</source>
<p>
Пример использования параметра "minLength".
</p>
<p>
Также хорошо бы добавить скроллбар для виджета, так как количество элементов может быть довольно большим. Для этого нам нужно подправить стиль "ui-autocomplete" в файле "jquery-ui-[версия].custom.css" (либо в Вашем собственном файле стилей):
<source lang="css">
.ui-autocomplete {
position: absolute;
cursor: default;
max-height: 250px;
overflow-x: hidden;
overflow-y: auto;
}
</source>
</p>
<p>
Ограничиваем максимальную высоту виджета в 250 пикселей, скрываем горизонтальный скроллбар и настраиваем отображение вертикального скроллбара по необходимости.
</p>
<br />
<table align="center">
<tr>
<td style="border: 1px solid black; padding: 5px;">
[[Файл:autocomplete.png]]
</td>
</tr>
<tr>
<td style="font-color: darkblue; font-weight: bold; text-align: center;">
Пример работы Autocomplete
</td>
</tr>
</table>

Универсальный метод для кэширования xml-данных в XSLT

2012-08-15T11:14:36Z

Kalexey:

Некоторая информация по кэшированию xml-данных была представлена в данной статье:
[[Кэширование результата работы метода getCreateForm в XSL-шаблоне]]

Универсальный метод, который необходимо добавить в файл '''classes/modules/cutom.php''', может быть представлен в следующем виде:
<source lang="php">
public function xsltCache($expire = 3600, $stream){
$params_temp = array_slice(func_get_args(), 2);
$params = array();
foreach($params_temp as $param){
$params[] = (strpos($param, '/') !== FALSE) ? "(" . $param . ")" : $param;
}

$params_str = implode('/', $params);
$url = $stream . "://" . $params_str;
$folder = CURRENT_WORKING_DIR . '/sys-temp/udatacache/';
$path = $folder . md5($url) . '.xml';
if(!is_dir($folder)) mkdir($folder, 0777, true);
if(is_file($path)) $mtime = filemtime($path);

if(!is_file($path) || time() > ($mtime + $expire)) {
$data = file_get_contents($url);
file_put_contents($path, $data);
return array('plain:result' => $data);
}else{
$result = file_get_contents($path);
return array('plain:result' => $result);
}
}
</source>

а сам вызов в XSL-шаблоне будет следующим:
<pre>
udata://custom/xsltCache/3600/custom/lidersCustom/20
</pre>

<pre>
где 3600 - время кэширования xml-данных в секундах,
custom - модуль
lidersCustom - метод
20 - один из параметров, их может быть больше одного
</pre>
[[Категория:Верстка в XSLT]]

Универсальный метод для кэширования html-данных в XSLT

2012-08-15T11:14:17Z

Kalexey:

В одной из статей уже был рассмотрен способ кэширования html-кода в XSLT,
это была статья [[Блочное кэширование html-кода в XSLT]]

В данной статьей будет показан пример универсального кастомного метода,
в который можно передавать основной вызов: модуль, метод, параметры и также
путь к шаблону для трансформации xml данных. Кастомный метод необходимо
добавить в файл '''classes/modules/custom.php''':
<source lang="php">
public function xsltHtmlCache($expire = 3600, $module, $method){
$xslFilePath = getRequest('xsl');
// $filePath - путь к xsl-шаблону трансформации.
$filePath = CURRENT_WORKING_DIR . '/xsltTpls/' . $xslFilePath;
if(!is_file($filePath)) return;

$args = func_get_args();
$params = array_slice($args, 3);
$params_str = implode('/', $params);
$url = "udata://" . $module . '/' . $method . '/' . $params_str;

$folder = CURRENT_WORKING_DIR . '/sys-temp/udatacache/';
$path = $folder . md5($url . $filePath) . '.xml';
if(!is_dir($folder)) mkdir($folder, 0777, true);
if(is_file($path)) $mtime = filemtime($path);

if(!is_file($path) || time() > ($mtime + $expire)) {

$xsltDom = new DomDocument;
$xsltDom->resolveExternals = true;
$xsltDom->substituteEntities = true;

$xsltDom->load($filePath, DOM_LOAD_OPTIONS);

$xslt = new xsltProcessor;
$xslt->registerPHPFunctions();
$xslt->importStyleSheet($xsltDom);
$page_id = cmsController::getInstance()->getCurrentElementId();
$parent_id = "";
$active = "";

if($page_id){
$page = umiHierarchy::getInstance()->getElement($page_id);
$parent_id = $page->getParentId();
$active = (int) $page->getIsDefault();
}

// Добавляем необходимые глобальные переменные, которые можно будет использовать в xsl-шаблоне
$xslt->setParameter("", 'parent-id', $parent_id);
$xslt->setParameter("", 'document-page-id', $page_id);
$xslt->setParameter("", 'active', $active);

$dom_new = new DOMDocument("1.0", "utf-8");
// $xml - xml-данные для трансформации.
$xml = file_get_contents($url);
$dom_new->loadXML($xml);

//производим трансформацию
$result = $xslt->transformToXML($dom_new);
//html-данные необходимо включить в CDATA и в какой либо корневой узел.
$result = "<udata mode=\"cache\"><![CDATA[" . $result . "]]></udata>";
// данный принцип возвращения данных отключает xslt-трансформацию системой UMI.CMS
return array('plain:result' => $result);

}else{
$result = file_get_contents($path);
return array('plain:result' => $result);
}
}
</source>

Вызов может быть следующим:
<source lang="xml">
<xsl:value-of select="document('udata://custom/xsltHtmlCache/3600/catalog/getCategoryList//8//1?xsl=modules/catalog/category-cache.xsl')/udata"
disable-output-escaping="yes" />
</source>

Обратите внимание в кастомном методе на блок:
<source lang="php">
// page_id текущей страницы сайта
$page_id = cmsController::getInstance()->getCurrentElementId();
$parent_id = "";
$active = "";

if($page_id){
$page = umiHierarchy::getInstance()->getElement($page_id);
$parent_id = $page->getParentId();
$active = (int) $page->getIsDefault();
}

// Добавляем необходимые глобальные переменные, которые можно будет использовать в xsl-шаблоне
$xslt->setParameter("", 'parent-id', $parent_id);
$xslt->setParameter("", 'document-page-id', $page_id);
$xslt->setParameter("", 'active', $active);

</source>
[[Категория: Верстка в XSLT]]

Универсальный метод для кэширования xml-данных в XSLT

2012-08-15T06:48:13Z

Kalexey:

Некоторая информация по кешированию xml-данных была представлена в данной статье:
[[Кэширование результата работы метода getCreateForm в XSL-шаблоне]]

Универсальный метод, который необходимо добавить в файл '''classes/modules/cutom.php''', может быть представлен в следующем виде:
<source lang="php">
public function xsltCache($expire = 3600, $stream){
$params_temp = array_slice(func_get_args(), 2);
$params = array();
foreach($params_temp as $param){
$params[] = (strpos($param, '/') !== FALSE) ? "(" . $param . ")" : $param;
}

$params_str = implode('/', $params);
$url = $stream . "://" . $params_str;
$folder = CURRENT_WORKING_DIR . '/sys-temp/udatacache/';
$path = $folder . md5($url) . '.xml';
if(!is_dir($folder)) mkdir($folder, 0777, true);
if(is_file($path)) $mtime = filemtime($path);

if(!is_file($path) || time() > ($mtime + $expire)) {
$data = file_get_contents($url);
file_put_contents($path, $data);
return array('plain:result' => $data);
}else{
$result = file_get_contents($path);
return array('plain:result' => $result);
}
}
</source>

а сам вызов в XSL-шаблоне будет следующим:
<pre>
udata://custom/xsltCache/3600/custom/lidersCustom/20
</pre>

<pre>
где 3600 - время кеширования xml-данных в секундах,
custom - модуль
lidersCustom - метод
20 - один из параметров, их может быть больше одного
</pre>
[[Категория:Верстка в XSLT]]

Участник:VITL'

2012-08-15T06:40:15Z

Kalexey:

==Декабрь==
*[[Универсальный метод для кэширования xml-данных в XSLT]]
*[[Универсальный метод для кэширования html-данных в XSLT]]
==Ноябрь==
*[[Отображение третьего столбца для поля типа Составное]]
*[[Белый экран вместо редиректа]]
*[[Изменение расположения доменов зарегистрированных в системе]]
*[[Отладка кастомных методов]]
*[[Установка и удаление модуля]]
*[[Как нельзя делать определение максимальной и минимальной цен товара в разделе]]
*[[Важное отличие между полным получением данных через upage и частичным используя upage.page id.field name]]
*[[Кэширование списка акционных товаров, для выбора одного случайного товара из кэша]]
*[[Использование статичных данных, вместо динамических]]
*[[Особенности импорта и экспорта CSV в модуле Обмен данными]]
==Октябрь==
*[[Отключение вывода блока Права доступа в режиме редактирования страницы]]
*[[Добавление обработчиков событий в ваш кастомный модуль ]]
*[[Использование модуля GeoIP в TPL-шаблонизаторе]]
*[[Импортирование Единицы измерения номенклатурной позиции]]
*[[Форматирование чисел средствами XSLT]]
*[[Изменение формирования номера следующего заказа и имени заказа]]
*[[Кэширование динамического многоуровнего меню]]
*[[Работа с подписчиками средствами API UMI.CMS]]
*[[Удаление страниц через клиентскую часть]]
*[[Заказ черновик или временная корзина]]
==Сентябрь==
*[[Блочное кэширование html-кода в TPL]]
*[[Запрет выполнения метода в XSLT при вызове его через браузер]]
*[[Обновление объектов созданных вручную данными из 1С]]
*[[Смена contentType с html на xml в кастом методе]]
*[[Подключение нужного xsl-файла в зависимости от типа страницы]]
*[[Изменение шаблонов страниц, после того как данные уже импортированы из 1С]]
*[[Процесс формирования заказов для 1С]]
*[[Проверка активности раздела каталога при использовании макроса getCategoryList]]
*[[Отключение экспорта виртуальных копий в YML]]
*[[Добавление кастомных настроек в модуле каталог]]
==Август==
*[[Расширение функционала метода emarket basket]]
*[[Отключение складывания скидок на заказ и товар]]
*[[Особенность добавления прав на модули для пользователей]]
*[[Оформление заказа в один шаг – tpl шаблонизатор]]
*[[Оформление заказа в один шаг – xslt шаблонизатор]]
*[[Определение страницы с которой была сделана виртуальная копия]]
*[[Почему не сохраняется положение структуры и панель с модулями]]
*[[Дополнительные параметры фильтрации в адресной строке]]
*[[Общий принцип подключения новой платежной системы]]
*[[Логика работы макроса content в tpl-шаблонах]]
==Июль==
*[[Структура шаблонов модуля Каталог, демо-сайт Современный]]
*[[Скидка на товар в зависимости от количества этого товара в корзине]]
*[[Подключение к второй базе данных в кастомном методе]]
*[[Добавление нового правила валидации поля (restriction)]]
*[[Корректное отображение полей в первой группе нового типа данных]]
*[[Использование ajax модуля Обмен данными для выполнения определенных операций]]
*[[Блочное кэширование html-кода в XSLT]]
*[[Назначение методов getEditLink и getObjectEditLink в модуле системы]]
*[[Назначение метода getDatasetConfiguration в модуле системы]]
*[[Пример административного шаблона для объектов]]
==Июнь==
*[[Замена метода go_to для подсчета переходов по баннеру]]
*[[Подсчет количества объектов каталога в разделе через События]]
==Май==
*[[Добавление Doctype в XSLT]]
*[[Максимальное и минимальное значение цен среди объектов каталога]]
==Апрель==
*[[Повторение ранее совершенного заказа]]
*[[Передача значений на кириллице в кастомный метод]]
*[[Мультиязычность - локализация сайта на tpl-шаблонах]]
*[[Получение доступа к значениям php массивов $ REQUEST и $ SERVER]]
*[[Отображение индекса последней страницы при постраничном выводе, tpl-шаблоны]]
*[[Смена вкладки модуля, открываемой по умолчанию]]
*[[События - подсчет количества комментариев для страницы]]
*[[Кэширование результата работы метода getCreateForm в XSL-шаблоне]]
*[[События - подписка на рассылки при регистрации пользователя]]
*[[Динамическое изменение количества отображаемых товаров на странице, tpl-шаблоны]]
==Март==
*[[Импорт объектов каталога сразу в несколько разделов]]
*[[Получение настроек системы в кастомном методе]]
*[[Добавление вкладок в кастомный модуль]]
*[[События – отслеживание изменения цены товаров в административной части]]
*[[Экспорт в YML списка объектов каталога]]
*[[Указание статуса 404 Not Found]]
*[[Использование выпадающего списка с множественным выбором]]
*[[Redirect в системе, перенос сайта на umi.cms, ч.2]]
*[[Сортировка элементов справочника средствами XSLT]]
*[[Captcha и ее смена при каждом обновлении страницы, отправке сообщения]]
==Февраль==
*[[Использование кастомных макросов в XSLT]]
*[[Добавление нового правила скидки]]
*[[Смена шагов оформления заказа на этапе delivery]]
*[[Подключение дополнительных шаблонов для административного интерфейса]]
*[[Вывод простых данных кастомного модуля в административной части]]
*[[Добавление нового сплиттера для импорта данных]]
*[[Подключение поддерживаемых платежных систем]]
*[[Кастомизация макроса catalog getObjectsList для ускорения формирования страницы]]
*[[Кастомизация getCreateForm и getEditForm для гибкой верстки полей]]
*[[Модификация способа вывода объектов каталога (TPL)]]
==Январь==
*[[Selector - протокол выборки данных]] *
*[[Голосование за страницы]]
*[[Динамическое изменение количества объектов на странице]]
*[[Протокол ulang и ENTITY, мультиязычность]]
*[[Определение позиции объекта в списке данных, первый – последний, четный – нечетный]]
*[[Использование макроса system makeThumbnail с учетом ориентации изображения, TPL-шаблоны]]
*[[Поиск страниц с другого домена используя протокол usel или API]]
*[[Редактирование страниц с клиентской части сайта]]
*[[Механизм работы кэша в umi]]
*[[Рекомендации по ускорению работы сайта]]
*[[Трансформация xml-даннных в кастомном php макросе]]

==Декабрь==
*[[Округление значения стоимости заказа]]
*[[Добавление нового формата экспорта данных]]
*[[Ссылка на платежную квитанцию в личном кабинете]]
*[[Подключение редиректа]]
*[[Добавление товара в корзину с указанием Количества]]
*[[Сброс информации о текущем покупателе, обнуление cookie]]
*[[Добавление комментария при оформлении заказа]]
*[[Кастомизация административной части на примере модуля emarket]]
*[[Функционал импорта и экспорта в csv для какого-либо модуля]]
*[[Создание скидки для emarket-а с помощью API]]
==Ноябрь==
*[[Captcha – изменение настроек (2.8)]]
*[[Настройка rss ленты]]
*[[Визуальное оформление недавно добавленных товаров]]
*[[Изменение значений полей h1 и title при обновлении данных]]
*[[Получение ссылки на страницу с использованием параметра object id]]
*[[Автоматическая индексация страниц при интеграции с 1С]]
*[[Получение object id страницы зная element id (tpl-шаблоны)]]
*[[Redirect в системе, перенос сайта на umi.cms]]
*[[Создание кастомного метода для вывода отфильтрованного выпадающего списка]]
*[[Изменение имени заказа при оформлении покупки]]
*[[Редактирование объектов каталога определенного типа при табличном отображении]]
==Октябрь==
*[[Мультидоменность – замена макроса content (tpl)]]
*[[Мультиязычность - перевод выпадающих списков]]
*[[Получение доступа к методом модулей]]
*[[Ошибки при интеграции с 1С]]
*[[Формирование YML файла для разных доменов в системе]]
*[[Управление адресами доставки в настройках пользователя (tpl)]]
*[[Удаление адреса доставки]]
==Сентябрь==
*[[Другой вариант платежной квитанции]]
*[[Интеграция с 1С на хостингах Sweb и RU-center (nic.ru)]]
*[[Отправка писем менеджерам в зависимости от домена]]
*[[Настройка экспорта в YML (Яндекс-маркет)]]
*[[Автоматическая установка значений по умолчанию]]
*[[Переключатель (radio) вместо выпадающего списка]]
*[[Robots.txt на каждый домен (2.8)]]
*[[Настройка верстки для каждого поля при использовании webforms add]]
*[[Импорт товаров в систему 1С]]
*[[События – автоматическое наследование meta keywords и meta descriptions]]
==Август==
*[[Возможности extended-pack]]
*[[Единственный тип данных Объект каталога, при импорте из 1С]]
*[[Импорт всех типов Цен]]
*[[Импорт нескольких изображений для одного товара]]
*[[Перемещение элементов при импорте их из 1С]]
*[[Сохранение типов полей из 1С]]
*[[Суть интеграции с 1С]]
*[[Техническая сторона импорта данных из 1С]]
*[[Удаление элементов или снятие активности при импорте данных из 1С]]
*[[Использование нескольких Цен для одного товара]]
==Июль==
*[[Создание собственного модуля (страницы)]]
*[[Отображение цены товара на сайте в другой валюте (2.8)]]
*[[Экспорт данных в формат UmiDump2.0 при нехватке memory limit на хостинге]]
*[[Вложенные комментарии]]
*[[Уведомление менеджеру о заказе, со всем необходимыми данными (emarket)]]
*[[Использование метода setValue при сохранении строки типа HTML-текст]]
*[[Использование Событий для подсчета Фотографий в Фотоальбоме]]
==Июнь==
*[[Добавление счетчика liveinternet]]
*[[Форматирование значения цены товара (вставка пробелов)]]
==Май==
*[[Добавление страниц через клиентскую часть]]
*[[Фильтрация объектов каталога по всем разделам]]
*[[Переиндексация сайта при нехватке производительности сервера]]
*[[Примеры использования макроса data doSelection]]
*[[Экспорт в YML при нехватке производительности сервера (umi 2.8.1)]]
*[[Работа с опционными свойствами (umi 2.8, tpl шаблоны)]]
*[[Создание кастомного макроса на основе существующего (data getObjectList)]]
==Апрель==
*[[Обновленный макрос doSelection, который принимает GET параметры (Фильтрация данных)]]
*[[Отображение значения скидки в процентах tpl 2.8)]]
*[[Где прячутся тэги?]]
*[[Экспорт в YML при нехватке оперативной памяти под php скрипты (версия 2.7.4 и ниже)]]
*[[Смена изображения при наведении на него курсора мыши]]
*[[Подключение кастомных макросов и событий для модулей]]
*[[Вывод значения поля для случайной страницы]]
*[[Добавление новых (кастомных) полей для модуля Блоги 2.0]]
*[[Экспорт определенных полей в csv файл]]
*[[Архитектура базы данных системы]]
== Март ==
*[[Пример создания сложной фильтрации по каталогу (кастомный макрос)]]
*[[Вывод страницы в карте сайте с отключением вывода в меню]]
*[[Ограничение вывода тэгов при использовании макроса tagsDomainEfficiencyCloud]]
*[[Дополнительный параметр для поиска (search branches)]]
*[[Карта сайта без каких-либо настроек страниц]]
*[[Недокументированный макрос news calendar() для Гостей]]
*[[Добавление новых (кастомных) полей для модуля Комментарии]]
*[[Вывод общей стоимости заказа без скидки (umi 2.8 и выше)]]
*[[Вывод значений полей группы в виде таблицы]]
*[[Получение значений полей у родительских страниц любого уровня]]
== Февраль ==
*[[Обновленный макрос system order_by (двойная сортировка по одной ссылке)]]
*[[Экспорт в YML (vendor.model)]]
*[[Вывод значения цены без скидки]]
*[[Отображение цены товара в другой валюте]]
*[[Как удалить всех подписчиков на рассылку?]]
*[[Вывод даты последней модификации страницы (API)]]
*[[Вывод автора страницы]]
*[[Вывод аватара пользователя]]
*[[Автоматический перевод полей страниц для сайтов En-Ru + подключение нужных шаблонов]]
*[[Вызов шаблона, макроса в зависимоcти от значения]]

В phpinfo.php видно, что eaccelerator установлен, однако, в списке кэширующих механизмов его нет

2012-08-15T06:29:56Z

Kalexey: переименовал «В phpinfo.php видно, что eaccelerator установлен, однако, в списке кеширующих механизмов его нет» в «[[В phpinfo.php видно, что eaccelerator устано�

Eaccelerator должен быть скомпилирован с опцией --with-eaccelerator-shared-memory. Обратитесь к хостинг-провайдеру с просьбой пересобрать этот модуль.

[[Категория:Решение проблем и ошибок]]
[[Категория:Кеширование]]
[[Категория:e-accelerator]]

В phpinfo.php видно, что eaccelerator установлен, однако, в списке кеширующих механизмов его нет

2012-08-15T06:29:56Z

#перенаправление [[В phpinfo.php видно, что eaccelerator установлен, однако, в списке кэширующих механизмов его нет]]

Кэширование списка акционных товаров, для выбора одного случайного товара из кеша

2012-08-15T05:54:53Z

Kalexey: переименовал «Кэширование списка акционных товаров, для выбора одного случайного товара из кеша» в «[[Кэширование списка акционных това

#перенаправление [[Кэширование списка акционных товаров, для выбора одного случайного товара из кэша]]

Кэширование списка акционных товаров, для выбора одного случайного товара из кэша

2012-08-15T05:54:53Z

Не редким случаем является тот вариант, когда необходимо на сайте выводить один или несколько акционных товаров, и чтобы при обновлении страницы, из определенного списка эти товары выбирались случайным образом.
Если сайт небольшой, мало данных, небольшая посещаемость, то можно конечно используя протокол '''usel''' , написать шаблон, по которому в разделе каталога будет случайным образом выбираться один элемент каталога отмеченный чекбоксом Акция.
В случае TPL-шаблонизатора, необходимо будет еще использовать макрос '''%data doSelection()%'''.

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

Для решения данного вопроса, без лишней нагрузки на сервер, можно использовать кэширование данных. Из общего списка товаров, которые подходят по нужным условиям, делается [http://ru.php.net/manual/ru/function.serialize.php сериализованный] массив и сохраняется в кэш, можно просто в файл. Кэш можно настроить так, чтобы он обновлялся один раз в час. Данные из Кэша (или из файла) считываются, потом с помощью php-функции [http://ru.php.net/manual/ru/function.array-rand.php array_rand] из массива можно выбрать случайное значение (id товара):
<source lang="php">
$arr_serialize = file_get_contents("…");
$arr_id = unserialize($arr_serialize);
if(!is_array($arr_id) || !sizeof($arr_id)) return "";
$rand_key = array_rand($arr_id);
$page_id = $arr_id[$rand_key];
</source>

Так как четкий алгоритм для выборки только id страниц с помощью протокола '''Selector''' еще не опреден, то лучше использовать [http://api.umi-cms.ru/ umiSelection]. Примеры кэширования данных можно посмотреть в этом же разделе, что и эта статья.
[[Категория: Верстка в XSLT ]] [[Категория: Верстка в TPL]]

Кэширование списка акционных товаров, для выбора одного случайного товара из кэша

2012-08-15T05:54:45Z

Kalexey:

Кэширование списка акционных товаров, для выбора одного случайного товара из кэша

2012-08-15T05:54:23Z

Kalexey: переименовал «Кеширование списка акционных товаров, для выбора одного случайного товара из кеша» в «[[Кэширование списка акционных това

Не редким случаем является тот вариант, когда необходимо на сайте выводить один или несколько акционных товаров, и чтобы при обновлении страницы, из определенного списка эти товары выбирались случайным образом.
Если сайт небольшой, мало данных, небольшая посещаемость, то можно конечно используя протокол '''usel''' , написать шаблон, по которому в разделе каталога будет случайным образом выбираться один элемент каталога отмеченный чекбоксом Акция.
В случае TPL-шаблонизатора, необходимо будет еще использовать макрос '''%data doSelection()%'''.

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

Для решения данного вопроса, без лишней нагрузки на сервер, можно использовать кеширование данных. Из общего списка товаров, которые подходят по нужным условиям, делается [http://ru.php.net/manual/ru/function.serialize.php сериализованный] массив и сохраняется в кеш, можно просто в файл. Кеш можно настроить так, чтобы он обновлялся один раз в час. Данные из Кеша (или из файла) считываются, потом с помощью php-функции [http://ru.php.net/manual/ru/function.array-rand.php array_rand] из массива можно выбрать случайное значение (id товара):
<source lang="php">
$arr_serialize = file_get_contents("…");
$arr_id = unserialize($arr_serialize);
if(!is_array($arr_id) || !sizeof($arr_id)) return "";
$rand_key = array_rand($arr_id);
$page_id = $arr_id[$rand_key];
</source>

Так как четкий алгоритм для выборки только id страниц с помощью протокола '''Selector''' еще не опреден, то лучше использовать [http://api.umi-cms.ru/ umiSelection]. Примеры кеширования данных можно посмотреть в этом же разделе, что и эта статья.
[[Категория: Верстка в XSLT ]] [[Категория: Верстка в TPL]]

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

2012-08-15T05:54:23Z

#перенаправление [[Кэширование списка акционных товаров, для выбора одного случайного товара из кеша]]

Кэширование динамического многоуровнего меню

2012-08-15T05:54:11Z

Kalexey:

В данной статье будет рассмотрен пример кэширования динамического многоуровнего меню разделов каталога,
при использовании TPL-шаблонизатора. Логика для XSLT-будет аналогичная. В данном случае,
динамическим меню называется то меню, которое изменяется в зависимости от того в каком разделе каталога мы находимся,
т.е. определенная ветка меню раскрыта, другие свернуты. Логика кэша заключается в том, что должен быть
кэш-файл на каждый раздел каталога. Будет подключаться тот кэш-файл, который связан с текущим "Разделом
каталога". Если посетитель находится на странице "Объекта каталога", то проверяется к какому разделу каталога принадлежит
данный объект, и потом берется кэш связанный с этим разделом каталога. Также, должен быть еще один кэш для случая
когда пользователь находится на странице, которая не является ни разделом каталога, ни объектом каталога.
Для реализации данной задачи добавим дополнительный кастомный php-метод в файл classes/modules/custom.php:
<source lang="php">
public function menuLeftCustom(){
// время жизни кэш-файла
$expire = 86400;
$folder = CURRENT_WORKING_DIR . '/sys-temp/tplcache/';
if(!is_dir($folder)) mkdir($folder, 0777, true);
$controller = cmsController::getInstance();
$current_page_id = $controller->getCurrentElementId();
if($current_page_id){
$element = umiHierarchy::getInstance()->getElement($current_page_id);
$type_id = $element->getTypeId();
// 5 - раздел каталога, 6 - объект каталога
if($type_id == 5 || $type_id == 6){
$rel_id = ($type_id == 6) ? $element->getParentId() : $current_page_id;
$data_path = $folder . 'menuLeft_rel_' . $rel_id . '.html';
if(is_file($data_path)){
$mtime = filemtime($data_path);
if(time() < ($mtime + $expire)) {
return file_get_contents($data_path);
}
}
$ini = $controller->getModule('content');
$result = $ini->menu('menu_left', '2', 1533);
file_put_contents($data_path, $result);
return $result;

}
}
$data_path = $folder . 'menuLeft_all.html';

if(is_file($data_path)){
$mtime = filemtime($data_path);
if(time() < ($mtime + $expire)) {
return file_get_contents($data_path);
}
}
$ini = $controller->getModule('content');
$result = $ini->menu('menu_left', '2', 1533);
file_put_contents($data_path, $result);
return $result;

}
</source>
Стандартный вызов макрос в шаблоне был бы:
<pre>
%content menu('menu_left', '2', 1533)%
</pre>
При использовании кастомного метода, вызов должен быть:
<pre>
%custom menuLeftCustom()%
</pre>
В методе используются иерархические типы данных Раздела каталога и Объекта каталога (5 - раздел каталога, 6 - объект каталога), для вашего сайта вы их должны определить в настройках модуля Шаблоны данных, в режиме xml:
<pre>
/admin/data/config/.xml
</pre>
также, в кастомном методе,в двух местах пропишите вызов метода '''menu''' с вашими параметрами:
<pre>
$result = $ini->menu('menu_left', '2', 1533);
</pre>

[[Категория: Верстка в TPL]]

Кэширование динамического многоуровнего меню

2012-08-15T05:53:40Z

Kalexey: переименовал «Кеширование динамического многоуровнего меню» в «Кэширование динамического многоуровнего меню»

В данной статье будет рассмотрен пример кеширования динамического многоуровнего меню разделов каталога,
при использовании TPL-шаблонизатора. Логика для XSLT-будет аналогичная. В данном случае,
динамическим меню называется то меню, которое изменяется в зависимости от того в каком разделе каталога мы находимся,
т.е. определенная ветка меню раскрыта, другие свернуты. Логика кеша заключается в том, что должен быть
кеш-файл на каждый раздел каталога. Будет подключаться тот кеш файл, который связан с текущим "Разделом
каталога". Если посетитель находится на странице "Объекта каталога", то проверяется к какому разделу каталога принадлежит
данный объект, и потом берется кеш связанный с этим разделом каталога. Также, должен быть еще один кеш для случая
когда пользователь находится на странице, которая не является ни разделом каталога, ни объектом каталога.
Для реализации данной задачи добавим дополнительный кастомный php-метод в файл classes/modules/custom.php:
<source lang="php">
public function menuLeftCustom(){
// время жизни кеш-файла
$expire = 86400;
$folder = CURRENT_WORKING_DIR . '/sys-temp/tplcache/';
if(!is_dir($folder)) mkdir($folder, 0777, true);
$controller = cmsController::getInstance();
$current_page_id = $controller->getCurrentElementId();
if($current_page_id){
$element = umiHierarchy::getInstance()->getElement($current_page_id);
$type_id = $element->getTypeId();
// 5 - раздел каталога, 6 - объект каталога
if($type_id == 5 || $type_id == 6){
$rel_id = ($type_id == 6) ? $element->getParentId() : $current_page_id;
$data_path = $folder . 'menuLeft_rel_' . $rel_id . '.html';
if(is_file($data_path)){
$mtime = filemtime($data_path);
if(time() < ($mtime + $expire)) {
return file_get_contents($data_path);
}
}
$ini = $controller->getModule('content');
$result = $ini->menu('menu_left', '2', 1533);
file_put_contents($data_path, $result);
return $result;

}
}
$data_path = $folder . 'menuLeft_all.html';

if(is_file($data_path)){
$mtime = filemtime($data_path);
if(time() < ($mtime + $expire)) {
return file_get_contents($data_path);
}
}
$ini = $controller->getModule('content');
$result = $ini->menu('menu_left', '2', 1533);
file_put_contents($data_path, $result);
return $result;

}
</source>
Стандартный вызов макрос в шаблоне был бы:
<pre>
%content menu('menu_left', '2', 1533)%
</pre>
При использовании кастомного метода, вызов должен быть:
<pre>
%custom menuLeftCustom()%
</pre>
В методе используются иерархические типы данных Раздела каталога и Объекта каталога (5 - раздел каталога, 6 - объект каталога), для вашего сайта вы их должны определить в настройках модуля Шаблоны данных, в режиме xml:
<pre>
/admin/data/config/.xml
</pre>
также, в кастомном методе,в двух местах пропишите вызов метода '''menu''' с вашими параметрами:
<pre>
$result = $ini->menu('menu_left', '2', 1533);
</pre>

[[Категория: Верстка в TPL]]

Кеширование динамического многоуровнего меню

2012-08-15T05:53:40Z

#перенаправление [[Кэширование динамического многоуровнего меню]]

Блочное кэширование html-кода в TPL

2012-08-15T05:53:28Z

Kalexey:

В данной статье представлен пример кастомного php-метода, с помощью которого можно сохранить результат выполнения tpl-макроса в кэш, на указанное время. Метод необходимо добавить в файл '''classes/modules/custom.php''':
<source lang="php">
public function tplcache($expire = 0, $module = '', $method = '') {
$expire = (int) $expire;

$macrosArr = array();
$macrosArr['module'] = htmlspecialchars($module);
$macrosArr['method'] = htmlspecialchars($method);

$args = func_get_args();
$params = array_slice($args, 3);
$macrosArr['args'] = $params;

$params_path = '';
foreach($params as $arg){
if($params_path) $params_path .= ", '" . $arg . "'";
else $params_path .= "'" . $arg . "'";
}
// ключ для кэша
$path = $macrosArr['module'] . ' ' . $macrosArr['method'] . '('. $params_path . ')';
$templater = templater::getInstance();
$cacheFrontend = cacheFrontend::getInstance();
// проверка на активность поддерживаемого кэша, apc, eaccelerator, memcached и т.п.
if($cacheFrontend->getCurrentCacheEngineName()){
// загрузка данных из кэша, промежуточный ключ $path
if($data = $cacheFrontend->loadData($path)) {
return $data;
}
// выполнение метода, с указанными параметрами
$result = $templater->executeMacros($macrosArr);

if($expire > 0) {
// сохранение данных в кэш
$cacheFrontend->saveData($path, $result, $expire);
}
}else{
// использование файлового кэша, данные хранятся в html-файле
$cmsController = cmsController::getInstance();

$folder = CURRENT_WORKING_DIR . '/sys-temp/tplcache/';
if(!is_dir($folder)) mkdir($folder, 0777, true);
static $lang_id, $domain_id;
if(!isset($lang_id)) $lang_id = $cmsController->getCurrentLang()->getId();
if(!isset($domain_id)) $domain_id = $cmsController->getCurrentDomain()->getId();
$key_path = $path . '_' . $lang_id . '_' . $domain_id;
$key = sha1($key_path . SYS_CACHE_SALT);
$data_path = $folder . $key . '.html';
// проверка даты создания файла и времени жизни кэша (expire)
if(is_file($data_path)){
$mtime = filemtime($data_path);
if(time() < ($mtime + $expire)) {
return file_get_contents($data_path);
}
}
$result = $templater->executeMacros($macrosArr);
file_put_contents($data_path, $result);
}
return $result;
}
</source>
В методе стоит проверка на то, включен ли один из стандартных кэширующих механизмов, в случае если кэш включен, то он и используется, в ином случае используется файловый кэш. Данные файлового кэша сохраняются в папке '''/sys-temp/tplcache/'''.

Пример стандартного вызова tpl-макроса:
<pre>
%news lastlist('/vse_novosti/politicheskie_novosti/ /vse_novosti/novosti_ekonomiki/', 'home', 2)%
</pre>
Пример вызова макроса через кастомный метод '''tplcache''':
<pre>
%custom tplcache(600, 'news', 'lastlist', '/vse_novosti/politicheskie_novosti/ /vse_novosti/novosti_ekonomiki/', 'home', 2)%
</pre>
600 - время хранения кэша; news - модуль; lastlist - метод модуля; далее параметры метода в стандартном порядке, как в
[http://help-dev.umi-cms.ru/news.lastlist.html документации]
[[Категория:Верстка в TPL]]

Блочное кэширование html-кода в TPL

2012-08-15T05:52:54Z

Kalexey: переименовал «Блочное кеширование html-кода в TPL» в «Блочное кэширование html-кода в TPL»

В данной статье представлен пример кастомного php-метода, с помощью которого можно сохранить результат выполнения tpl-макроса в кеш, на указанное время. Метод необходимо добавить в файл '''classes/modules/custom.php''':
<source lang="php">
public function tplcache($expire = 0, $module = '', $method = '') {
$expire = (int) $expire;

$macrosArr = array();
$macrosArr['module'] = htmlspecialchars($module);
$macrosArr['method'] = htmlspecialchars($method);

$args = func_get_args();
$params = array_slice($args, 3);
$macrosArr['args'] = $params;

$params_path = '';
foreach($params as $arg){
if($params_path) $params_path .= ", '" . $arg . "'";
else $params_path .= "'" . $arg . "'";
}
// ключ для кеша
$path = $macrosArr['module'] . ' ' . $macrosArr['method'] . '('. $params_path . ')';
$templater = templater::getInstance();
$cacheFrontend = cacheFrontend::getInstance();
// проверка на активность поддерживаемого кеша, apc, eaccelerator, memcached и т.п.
if($cacheFrontend->getCurrentCacheEngineName()){
// загрузка данных из кеша, промежуточный ключ $path
if($data = $cacheFrontend->loadData($path)) {
return $data;
}
// выполнение метода, с указанными параметрами
$result = $templater->executeMacros($macrosArr);

if($expire > 0) {
// сохранение данных в кеш
$cacheFrontend->saveData($path, $result, $expire);
}
}else{
// использование файлового кеша, данные хранятся в html-файле
$cmsController = cmsController::getInstance();

$folder = CURRENT_WORKING_DIR . '/sys-temp/tplcache/';
if(!is_dir($folder)) mkdir($folder, 0777, true);
static $lang_id, $domain_id;
if(!isset($lang_id)) $lang_id = $cmsController->getCurrentLang()->getId();
if(!isset($domain_id)) $domain_id = $cmsController->getCurrentDomain()->getId();
$key_path = $path . '_' . $lang_id . '_' . $domain_id;
$key = sha1($key_path . SYS_CACHE_SALT);
$data_path = $folder . $key . '.html';
// проверка даты создания файла и времени жизни кеша (expire)
if(is_file($data_path)){
$mtime = filemtime($data_path);
if(time() < ($mtime + $expire)) {
return file_get_contents($data_path);
}
}
$result = $templater->executeMacros($macrosArr);
file_put_contents($data_path, $result);
}
return $result;
}
</source>
В методе стоит проверка на то, включен ли один из стандартных кеширующих механизмов, в случае если кеш включен, то он и используется, в ином случае используется файловый кеш. Данные файлового кеша сохраняются в папке '''/sys-temp/tplcache/'''.

Пример стандартного вызова tpl-макроса:
<pre>
%news lastlist('/vse_novosti/politicheskie_novosti/ /vse_novosti/novosti_ekonomiki/', 'home', 2)%
</pre>
Пример вызова макроса через кастомный метод '''tplcache''':
<pre>
%custom tplcache(600, 'news', 'lastlist', '/vse_novosti/politicheskie_novosti/ /vse_novosti/novosti_ekonomiki/', 'home', 2)%
</pre>
600 - время хранения кеша; news - модуль; lastlist - метод модуля; далее параметры метода в стандартном порядке, как в
[http://help-dev.umi-cms.ru/news.lastlist.html документации]
[[Категория:Верстка в TPL]]

Блочное кеширование html-кода в TPL

2012-08-15T05:52:54Z

Kalexey: переименовал «Блочное кеширование html-кода в TPL» в «Блочное кэширование html-кода в TPL»

#перенаправление [[Блочное кэширование html-кода в TPL]]

Блочное кэширование html-кода в XSLT

2012-08-15T05:52:42Z

Kalexey:

В данной статье будет приведен пример небольшого кастомного php-макроса, с помощью которого можно закэшировать определенный html-блок сайта, допустим список разделов каталога. В стандартном xsl шаблоне происходит начальный вызов, xsl:apply-templates, потом полученные xml-данные обрабатываются, далее происходят дополнительные вызовы для получения необходимых данных. Для очень высоко нагруженного сайта, одним из идеальных вариантов было бы кэширование не xml-данных, которые потом еще надо обработать, а итогового html-кода, одного из блоков страницы сайта.
Рассмотрим пример метода для реализации нашей задачи:
<source lang="php">
public function categoryCache(){

$xsltDom = new DomDocument;
$xsltDom->resolveExternals = true;
$xsltDom->substituteEntities = true;
// $filePath - путь к xsl-шаблону трансформации.
$filePath = CURRENT_WORKING_DIR . '/xsltTpls/leftCache.xsl';
$xsltDom->load($filePath, DOM_LOAD_OPTIONS);

$xslt = new xsltProcessor;
$xslt->registerPHPFunctions();
$xslt->importStyleSheet($xsltDom);

$dom_new = new DOMDocument("1.0", "utf-8");
// $xml - xml-данные для трансформации.
$xml = file_get_contents('udata://catalog/getCategoryList/void/shop/');
$dom_new->loadXML($xml);

//производим трансформацию
$result = $xslt->transformToXML($dom_new);
//html-данные необходимо включить в CDATA и в какой либо корневой узел.
$result = '<udata><![CDATA[' . $result . ']]></udata>';

// данный принцип возвращения данных отключает xslt-трансформацию системой UMI.CMS
return array('plain:result' => $result);

}
</source>

Метод можно добавить в файл '''classes/modules/custom.php''', тогда вызов в xsl-шаблоне будет следующим:
<source lang="xml">
<xsl:value-of select="document('udata://custom/categoryCache?expire=36000')/udata" disable-output-escaping="yes" />
</source>

Полученный html-код будет закэширован на час, если на сайте включен кэш. В случае необходимости, можно настроить сохранение кэша в текстовый файл на сервере, как это было сделано в данной статье [[Кэширование результата работы метода getCreateForm в XSL-шаблоне]] . Пример метода, для кэширования данных в html-файл:
<source lang="php">
public function getCategoryListCustom(){
$folder = CURRENT_WORKING_DIR . '/sys-temp/udatacache/';
$path = $folder . 'left-columnCache.xml';
if(!is_dir($folder)) mkdir($folder, 0777, true);
if(is_file($path)) $mtime = filemtime($path);
$expire = 86400;

if(!is_file($path) || time() > ($mtime + $expire)) {
$xsltDom = new DomDocument;
$xsltDom->resolveExternals = true;
$xsltDom->substituteEntities = true;
// $filePath - путь к xsl-шаблону трансформации.
$filePath = CURRENT_WORKING_DIR . '/xsltTpls/modules/catalog/leftCache.xsl';
$xsltDom->load($filePath, DOM_LOAD_OPTIONS);

$xslt = new xsltProcessor;
$xslt->registerPHPFunctions();
$xslt->importStyleSheet($xsltDom);

$dom_new = new DOMDocument("1.0", "utf-8");
// $xml - xml-данные для трансформации.
$xml = file_get_contents('udata://catalog/getCategoryList/void/shop/');
$dom_new->loadXML($xml);

//производим трансформацию
$result = $xslt->transformToXML($dom_new);
//html-данные необходимо включить в CDATA и в какой либо корневой узел.
$result = "<udata mode=\"cache\"><![CDATA[" . $result . "]]></udata>";
file_put_contents($path, $result);

// данный принцип возвращения данных отключает xslt-трансформацию системой UMI.CMS
return array('plain:result' => $result);
}else{
$result = file_get_contents($path);
return array('plain:result' => $result);
}
}
</source>

Пример шаблона '''leftCache.xsl''':
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE xsl:stylesheet SYSTEM "ulang://i18n/constants.dtd:file">

<xsl:stylesheet version="1.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:xlink="http://www.w3.org/TR/xlink"
xmlns="http://www.w3.org/1999/xhtml"
xmlns:umi="http://www.umi-cms.ru/TR/umi">

<xsl:output encoding="utf-8" method="html" indent="yes"/>

<xsl:template match="/">
<xsl:apply-templates select="." mode="left-column" />
</xsl:template>

<xsl:template match="udata[@method = 'getCategoryList']" mode="left-column">
<ul class="catalog_menu" umi:button-position="bottom left" umi:element-id="{@category-id}" umi:region="list" umi:module="catalog" umi:sortable="sortable">
<xsl:apply-templates select="//item" mode="left-column" />
</ul>
</xsl:template>

<xsl:template match="udata[@method = 'getCategoryList']//item" mode="left-column">
<li umi:element-id="{@id}" umi:region="row">
<span>
<a href="{@link}" umi:field-name="name" umi:delete="delete" umi:empty="&empty-section-name;">
<xsl:value-of select="." />
</a>
</span>
<xsl:apply-templates select="document(concat('udatacache://catalog/getCategoryList/void/', @id))/udata"/>
</li>
</xsl:template>

<xsl:template match="udata[@method = 'getCategoryList']">
<ul umi:element-id="{@category-id}" umi:region="list" umi:module="catalog" umi:sortable="sortable" umi:button-position="top right">
<xsl:apply-templates select="//item" />
</ul>
</xsl:template>

<xsl:template match="udata[@method = 'getCategoryList']//item">
<li umi:element-id="{@id}" umi:region="row">
<a href="{@link}" umi:field-name="name" umi:delete="delete" umi:empty="&empty-section-name;">
<xsl:value-of select="." />
</a>
</li>
</xsl:template>

</xsl:stylesheet>
</source>
[[Категория:Шаблонизаторы]][[Категория:Верстка в XSLT]]

Блочное кэширование html-кода в XSLT

2012-08-15T05:52:17Z

Kalexey: переименовал «Блочное кеширование html-кода в XSLT» в «Блочное кэширование html-кода в XSLT»

В данной статье будет приведен пример небольшого кастомного php-макроса, с помощью которого можно закешировать определенный html-блок сайта, допустим список разделов каталога. В стандартном xsl шаблоне происходит начальный вызов, xsl:apply-templates, потом полученные xml-данные обрабатываются, далее происходят дополнительные вызовы для получения необходимых данных. Для очень высоко нагруженного сайта, одним из идеальных вариантов было бы кеширование не xml-данных, которые потом еще надо обработать, а итогового html-кода, одного из блоков страницы сайта.
Рассмотрим пример метода для реализации нашей задачи:
<source lang="php">
public function categoryCache(){

$xsltDom = new DomDocument;
$xsltDom->resolveExternals = true;
$xsltDom->substituteEntities = true;
// $filePath - путь к xsl-шаблону трансформации.
$filePath = CURRENT_WORKING_DIR . '/xsltTpls/leftCache.xsl';
$xsltDom->load($filePath, DOM_LOAD_OPTIONS);

$xslt = new xsltProcessor;
$xslt->registerPHPFunctions();
$xslt->importStyleSheet($xsltDom);

$dom_new = new DOMDocument("1.0", "utf-8");
// $xml - xml-данные для трансформации.
$xml = file_get_contents('udata://catalog/getCategoryList/void/shop/');
$dom_new->loadXML($xml);

//производим трансформацию
$result = $xslt->transformToXML($dom_new);
//html-данные необходимо включить в CDATA и в какой либо корневой узел.
$result = '<udata><![CDATA[' . $result . ']]></udata>';

// данный принцип возвращения данных отключает xslt-трансформацию системой UMI.CMS
return array('plain:result' => $result);

}
</source>

Метод можно добавить в файл '''classes/modules/custom.php''', тогда вызов в xsl-шаблоне будет следующим:
<source lang="xml">
<xsl:value-of select="document('udata://custom/categoryCache?expire=36000')/udata" disable-output-escaping="yes" />
</source>

Полученный html-код будет закеширован на час, если на сайте включен кеш. В случае необходимости, можно настроить сохранение кеша в текстовый файл на сервере, как это было сделано в данной статье [[Кеширование результата работы метода getCreateForm в XSL-шаблоне]] . Пример метода, для кеширования данных в html-файл:
<source lang="php">
public function getCategoryListCustom(){
$folder = CURRENT_WORKING_DIR . '/sys-temp/udatacache/';
$path = $folder . 'left-columnCache.xml';
if(!is_dir($folder)) mkdir($folder, 0777, true);
if(is_file($path)) $mtime = filemtime($path);
$expire = 86400;

if(!is_file($path) || time() > ($mtime + $expire)) {
$xsltDom = new DomDocument;
$xsltDom->resolveExternals = true;
$xsltDom->substituteEntities = true;
// $filePath - путь к xsl-шаблону трансформации.
$filePath = CURRENT_WORKING_DIR . '/xsltTpls/modules/catalog/leftCache.xsl';
$xsltDom->load($filePath, DOM_LOAD_OPTIONS);

$xslt = new xsltProcessor;
$xslt->registerPHPFunctions();
$xslt->importStyleSheet($xsltDom);

$dom_new = new DOMDocument("1.0", "utf-8");
// $xml - xml-данные для трансформации.
$xml = file_get_contents('udata://catalog/getCategoryList/void/shop/');
$dom_new->loadXML($xml);

//производим трансформацию
$result = $xslt->transformToXML($dom_new);
//html-данные необходимо включить в CDATA и в какой либо корневой узел.
$result = "<udata mode=\"cache\"><![CDATA[" . $result . "]]></udata>";
file_put_contents($path, $result);

// данный принцип возвращения данных отключает xslt-трансформацию системой UMI.CMS
return array('plain:result' => $result);
}else{
$result = file_get_contents($path);
return array('plain:result' => $result);
}
}
</source>

Пример шаблона '''leftCache.xsl''':
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE xsl:stylesheet SYSTEM "ulang://i18n/constants.dtd:file">

<xsl:stylesheet version="1.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:xlink="http://www.w3.org/TR/xlink"
xmlns="http://www.w3.org/1999/xhtml"
xmlns:umi="http://www.umi-cms.ru/TR/umi">

<xsl:output encoding="utf-8" method="html" indent="yes"/>

<xsl:template match="/">
<xsl:apply-templates select="." mode="left-column" />
</xsl:template>

<xsl:template match="udata[@method = 'getCategoryList']" mode="left-column">
<ul class="catalog_menu" umi:button-position="bottom left" umi:element-id="{@category-id}" umi:region="list" umi:module="catalog" umi:sortable="sortable">
<xsl:apply-templates select="//item" mode="left-column" />
</ul>
</xsl:template>

<xsl:template match="udata[@method = 'getCategoryList']//item" mode="left-column">
<li umi:element-id="{@id}" umi:region="row">
<span>
<a href="{@link}" umi:field-name="name" umi:delete="delete" umi:empty="&empty-section-name;">
<xsl:value-of select="." />
</a>
</span>
<xsl:apply-templates select="document(concat('udatacache://catalog/getCategoryList/void/', @id))/udata"/>
</li>
</xsl:template>

<xsl:template match="udata[@method = 'getCategoryList']">
<ul umi:element-id="{@category-id}" umi:region="list" umi:module="catalog" umi:sortable="sortable" umi:button-position="top right">
<xsl:apply-templates select="//item" />
</ul>
</xsl:template>

<xsl:template match="udata[@method = 'getCategoryList']//item">
<li umi:element-id="{@id}" umi:region="row">
<a href="{@link}" umi:field-name="name" umi:delete="delete" umi:empty="&empty-section-name;">
<xsl:value-of select="." />
</a>
</li>
</xsl:template>

</xsl:stylesheet>
</source>
[[Категория:Шаблонизаторы]][[Категория:Верстка в XSLT]]

Блочное кеширование html-кода в XSLT

2012-08-15T05:52:17Z

Kalexey: переименовал «Блочное кеширование html-кода в XSLT» в «Блочное кэширование html-кода в XSLT»

#перенаправление [[Блочное кэширование html-кода в XSLT]]

Кэширование результата работы метода getCreateForm в XSL-шаблоне

2012-08-15T05:52:07Z

Kalexey:

В некоторых ситуациях, в XSL-шаблоне вызывается метод, который долго выполняется и отдает результат, который меняется очень редко. Таким методом может быть data getCreateForm(). В данной статье рассмотрим пример кэширования результата работы макроса getCreateForm() на один час.
Сначала в папке '''/sys-temp/''' создадим папку '''/udatacache/''' . Далее в папке '''classes/modules/data/''' добавим '''permissions.custom.php'''
следующего содержания:
<source lang="php">
<?php
$permissions = Array('main' => Array('getCreateFormCustom'));
?>
</source>

А в файл '''__custom.php''' добавим новый метод '''getCreateFormCustom''':
<source lang="php">
public function getCreateFormCustom($typ_id){
$typ_id = (int) $typ_id;
$path = CURRENT_WORKING_DIR . '/sys-temp/udatacache/getCreateForm' . $typ_id . '.xml';
if(is_file($path) == false){
$uri = "udata://data/getCreateForm/{$typ_id}";
$data = file_get_contents($uri);
file_put_contents($path, $data);
return array('plain:result' => $data);
}

$mtime = filemtime($path);
$data = file_get_contents($path);
$expire = 3600;

if(time() > ($mtime + $expire)) {
$uri = "udata://data/getCreateForm/{$typ_id}";
$data = file_get_contents($uri);
file_put_contents($path, $data);
return array('plain:result' => $data);
}else return array('plain:result' => $data);
}
</source>

В самом XSL-шаблоне необходимо будет использовать метод '''getCreateFormCustom''', вместо '''getCreateForm'''. Метод '''getCreateFormCustom''' сохраняет результат работы оригинального метода '''getCreateForm''' в файл, данные сохраняются в xml-формате. Из кэша данные берутся в течении часа (3600 секунд), потом кэш обновляется.
[[Категория:Шаблонизаторы]][[Категория:Верстка в XSLT]]

Кэширование результата работы метода getCreateForm в XSL-шаблоне

2012-08-15T05:51:54Z

Kalexey: переименовал «Кеширование результата работы метода getCreateForm в XSL-шаблоне» в «Кэширование результата работы метода getCreateForm в XSL-шаблоне»

В некоторых ситуациях, в XSL-шаблоне вызывается метод, который долго выполняется и отдает результат, который меняется очень редко. Таким методом может быть data getCreateForm(). В данной статье рассмотрим пример кеширования результата работы макроса getCreateForm() на один час.
Сначала в папке '''/sys-temp/''' создадим папку '''/udatacache/''' . Далее в папке '''classes/modules/data/''' добавим '''permissions.custom.php'''
следующего содержания:
<source lang="php">
<?php
$permissions = Array('main' => Array('getCreateFormCustom'));
?>
</source>

А в файл '''__custom.php''' добавим новый метод '''getCreateFormCustom''':
<source lang="php">
public function getCreateFormCustom($typ_id){
$typ_id = (int) $typ_id;
$path = CURRENT_WORKING_DIR . '/sys-temp/udatacache/getCreateForm' . $typ_id . '.xml';
if(is_file($path) == false){
$uri = "udata://data/getCreateForm/{$typ_id}";
$data = file_get_contents($uri);
file_put_contents($path, $data);
return array('plain:result' => $data);
}

$mtime = filemtime($path);
$data = file_get_contents($path);
$expire = 3600;

if(time() > ($mtime + $expire)) {
$uri = "udata://data/getCreateForm/{$typ_id}";
$data = file_get_contents($uri);
file_put_contents($path, $data);
return array('plain:result' => $data);
}else return array('plain:result' => $data);
}
</source>

В самом XSL-шаблоне необходимо будет использовать метод '''getCreateFormCustom''', вместо '''getCreateForm'''. Метод '''getCreateFormCustom''' сохраняет результат работы оригинального метода '''getCreateForm''' в файл, данные сохраняются в xml-формате. Из кеша данные берутся в течении часа (3600 секунд), потом кеш обновляется.
[[Категория:Шаблонизаторы]][[Категория:Верстка в XSLT]]

Кеширование результата работы метода getCreateForm в XSL-шаблоне

2012-08-15T05:51:54Z

#перенаправление [[Кэширование результата работы метода getCreateForm в XSL-шаблоне]]

Механизм работы кэша в umi

2012-08-15T05:51:42Z

Kalexey:

[[category:Архитектура UMI.CMS]]

Umi.cms поддерживает различные кэширующие механизмы, допустим apc, eaccelerator. В данной статье будет описан принцип работы кэша APC, все остальные типы действуют по аналогичной схеме. Основной php класс, который выполняет функции управления кэшем находится в файле:
'''/classes/system/subsystems/cache/cacheFrontend.php'''.
Если на хостинге подключен один из поддерживаемых системой кэширующих механизмов:
* apc
* eaccelerator
* xcache
* memcached

тогда в модуле "Конфигурация", вкладка "Производительность" будет доступен для выбора кэш, подключенный на хостинге. Допустим мы включили кэш APC. Если вы уже просматривали код системы, то в очень многих системных классах:
<pre>
\classes\system\subsystems\models\data\
\classes\system\subsystems\models\hierarchy\
\classes\system\subsystems\streams\
</pre>

происходит вызов методов из класса '''cacheFrontend''', допустим:
<source lang="php">
$cacheFrontend = cacheFrontend::getInstance();
$cacheFrontend->save($element, "element");
</source>

метод getElement() в классе umiHierarchy.

В классе cacheFrontend, определяется текующий тип кэша, при вызове метода save() класса cacheFrontend, и включенном АРС, происходит вызов метода saveObjectData() в классе apcCacheEngine, файл:
<pre>
\classes\system\subsystems\cache\engines\apc.php
</pre>

В классе '''apcCacheEngine''' используются стандартные функции APC по сохранению данных, чтению, удалению и очистки всего кэша:
* apc_store
* apc_fetch
* apc_delete
* apc_clear_cache

Боле подробно ознакомиться с данными функциями и настройками APC можно на официальном сайте [http://ru.php.net/manual/en/book.apc.php php.net]

Umi.cms кэширует объекты, элементы, типы данных, значения полей и не только. В зависимости от типа сохраняемого значения формируется название ключа, по которому потом можно будет получить данные. Возможны примерно следующие варианты ключей:
<pre>
27612_object__3e53ea3115e961f8b4a2c2125a4dfcca8f45efde
50_element__3e53ea3115e961f8b4a2c2125a4dfcca8f45efde
8873_field__3e53ea3115e961f8b4a2c2125a4dfcca8f45efde
27607.32_property__3e53ea3115e961f8b4a2c2125a4dfcca8f45efde
697_object_type__3e53ea3115e961f8b4a2c2125a4dfcca8f45efde
</pre>

'''27612_object''' – начальная информация об объекте с $object_id = 27612, в самой umi, в базе данных это таблица cms3_objects.

'''50_element''' – данные о страницы с $page_id = 50, таблица cms3_hierarchy.

'''8873_field''' – информация о поле c id=8873, таблица cms3_object_fields.

'''27607.32_property''' – объект с $object_id = 27607, 32 – id поля, таблица в БД cms3_object_content.

'''697_object_type''' – тип данных с $type_id = 697, таблица cms3_object_types

Информация по архитектуре базы данных: [[Архитектура базы данных системы]]

Как вы уже заметили, в самом конце названий ключей используется одно и тоже значение длиной в 40 символов, при получении данного значения используется переменная salt, в конфигурационном файле, config.ini. salt'a генерируется автоматически при установке системы.

Возможны также следующие префиксы для ключей:
*'''1_domain''' – домен системы, таблица cms3_domains
*'''1_lang''' – язык системы, таблица cms3_langs
*'''2_template''' – шаблон системы (XSL или TPL), таблица cms3_templates
*'''7_field_type''' – тип поля, таблица cms3_object_field_types
*'''24_element_type''' – иерархический тип объекта, таблица cms3_hierarchy_types

При редактировании данных в административной части или через edit-in-place, происходит обнуление данных в кэше, соответственно обнуление только необходимых данных, а не всего кэша.

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

В том же классе '''umiHierarchy''', в файле''' \classes\system\subsystems\models\hierarchy\umiHierarchy.php''', в методе '''getElement()''', происходит загрузка данных из кша:
<source lang="php">
$cacheFrontend = cacheFrontend::getInstance();
$element = $cacheFrontend->load($element_id, "element");
</source>

сначала запускается метод load() класса cacheFrontend, а потом запускается метод loadObjectData($key) текущего класса кэша, для apc: '''/engines/apc.php'''

Механизм работы кэша в umi

2012-08-15T05:50:55Z

Kalexey: «Механизм работы кеша в umi» переименована в «Механизм работы кэша в umi» поверх перенаправления

[[category:Архитектура UMI.CMS]]

Umi.cms поддерживает различные кеширующие механизмы, допустим apc, eaccelerator. В данной статье будет описан принцип работы кеша APC, все остальные типы действуют по аналогичной схеме. Основной php класс, который выполняет функции управления кешем находится в файле:
'''/classes/system/subsystems/cache/cacheFrontend.php'''.
Если на хостинге подключен один из поддерживаемых системой кеширующих механизмов:
* apc
* eaccelerator
* xcache
* memcached

тогда в модуле "Конфигурация", вкладка "Производительность" будет доступен для выбора кеш, подключенный на хостинге. Допустим мы включили кеш APC. Если вы уже просматривали код системы, то в очень многих системных классах:
<pre>
\classes\system\subsystems\models\data\
\classes\system\subsystems\models\hierarchy\
\classes\system\subsystems\streams\
</pre>

происходит вызов методов из класса '''cacheFrontend''', допустим:
<source lang="php">
$cacheFrontend = cacheFrontend::getInstance();
$cacheFrontend->save($element, "element");
</source>

метод getElement() в классе umiHierarchy.

В классе cacheFrontend, определяется текующий тип кеша, при вызове метода save() класса cacheFrontend, и включенном АРС, происходит вызов метода saveObjectData() в классе apcCacheEngine, файл:
<pre>
\classes\system\subsystems\cache\engines\apc.php
</pre>

В классе '''apcCacheEngine''' используются стандартные функции APC по сохранению данных, чтению, удалению и очистки всего кеша:
* apc_store
* apc_fetch
* apc_delete
* apc_clear_cache

Боле подробно ознакомиться с данными функциями и настройками APC можно на официальном сайте [http://ru.php.net/manual/en/book.apc.php php.net]

Umi.cms кеширует объекты, элементы, типы данных, значения полей и не только. В зависимости от типа сохраняемого значения формируется название ключа, по которому потом можно будет получить данные. Возможны примерно следующие варианты ключей:
<pre>
27612_object__3e53ea3115e961f8b4a2c2125a4dfcca8f45efde
50_element__3e53ea3115e961f8b4a2c2125a4dfcca8f45efde
8873_field__3e53ea3115e961f8b4a2c2125a4dfcca8f45efde
27607.32_property__3e53ea3115e961f8b4a2c2125a4dfcca8f45efde
697_object_type__3e53ea3115e961f8b4a2c2125a4dfcca8f45efde
</pre>

'''27612_object''' – начальная информация об объекте с $object_id = 27612, в самой umi, в базе данных это таблица cms3_objects.

'''50_element''' – данные о страницы с $page_id = 50, таблица cms3_hierarchy.

'''8873_field''' – информация о поле c id=8873, таблица cms3_object_fields.

'''27607.32_property''' – объект с $object_id = 27607, 32 – id поля, таблица в БД cms3_object_content.

'''697_object_type''' – тип данных с $type_id = 697, таблица cms3_object_types

Информация по архитектуре базы данных: [[Архитектура базы данных системы]]

Как вы уже заметили, в самом конце названий ключей используется одно и тоже значение длиной в 40 символов, при получении данного значения используется переменная salt, в конфигурационном файле, config.ini. salt'a генерируется автоматически при установке системы.

Возможны также следующие префиксы для ключей:
*'''1_domain''' – домен системы, таблица cms3_domains
*'''1_lang''' – язык системы, таблица cms3_langs
*'''2_template''' – шаблон системы (XSL или TPL), таблица cms3_templates
*'''7_field_type''' – тип поля, таблица cms3_object_field_types
*'''24_element_type''' – иерархический тип объекта, таблица cms3_hierarchy_types

При редактировании данных в административной части или через edit-in-place, происходит обнуление данных в кеше, соответственно обнуление только необходимых данных, а не всего кеша.

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

В том же классе '''umiHierarchy''', в файле''' \classes\system\subsystems\models\hierarchy\umiHierarchy.php''', в методе '''getElement()''', происходит загрузка данных из кеша:
<source lang="php">
$cacheFrontend = cacheFrontend::getInstance();
$element = $cacheFrontend->load($element_id, "element");
</source>

сначала запускается метод load() класса cacheFrontend, а потом запускается метод loadObjectData($key) текущего класса кеша, для apc: '''/engines/apc.php'''

Механизм работы кеша в umi

2012-08-15T05:50:55Z

Kalexey: «Механизм работы кеша в umi» переименована в «Механизм работы кэша в umi» поверх перенаправления

#перенаправление [[Механизм работы кэша в umi]]

Файл настроек config.ini

2012-08-15T05:50:37Z

Kalexey:

== Описание ==

Начиная с версии 2.8.х появился основной файл настройки системы '''config.ini''', который располагается в корневой директории DOCUMENT_ROOT и содержит большинство настроек системы. Туда переехали почти все константы, многие настройки из реестра и появились совершенно новые. [http://help-dev.umi-cms.ru/part.Config.syntax.html Синтаксис config.ini]

== Пример ==
<source lang="ini">
; Основные системные настройки
[system]
; Текущий драйвер БД системы. На данный момент поддерживается 2 значения: "mysql" и "xml"
db-driver = mysql

; Язык сайта по умолчанию
default-lang = ru

; Скин административного интерфейса по умолчанию
default-skin = mac

; Язык административного интерфейса по умолчанию
default-interface-lang = ru

; Список скинов, доступных в системе
skins[] = mac
skins[] = full
skins[] = simple
skins[] = prototype

; Список доступных языковых версий
interface-langs[] = "ru"
interface-langs[] = "en"

; Время жизни сесси в минутах
session-lifetime = 60

; Формат вывода даты по умолчанию
default-date-format = "Y-m-d H:i:s"

; Код валюты по умолчанию
default-currency = 'RUR'

; Настройки ядра системы
[kernel]
; Выводить содержимое текстовых полей well-formed xml'ом при доступе из через внутренние протоколы.
property-value-mode = 'xml'

; Выводить меню одним деревом при работе с xslt-шаблонами
xslt-nested-menu = 1

; Отключить оптимизацию получения свойств из базы данных.
; Оптимизация подразумевает выборку всех св-в объекта одним запросом.
; При выключенной оптимизации на каждое свойство будет выполняться отдельный запрос
disable-getvalue-optimization = 0

; Отключить вычисление количество записей через CALC_FOUND_ROWS при выборках через umiSelection
selection-calc-found-rows-disable = 0

; Установить максимальное количество join-таблиц в запросе, после которого нужно отключить оптимизатор запросов mysql'а
selection-max-joins = 10 ; MAX_SELECTION_TABLE_JOINS = 10

; Включить коррекцию кэша при работе системы в кластере (1 db-server, > 2 app-server)
cluster-cache-correction = 0

; Ключевое слово для выборки всех элементов в макросах
grab-all-keyword = "mode=all"

; Использовать расширение reflection для вызова подключаемых библиотек
use-reflection-extension = 0

; Игнорировать совпадение адресов страниц и названий модулей.
; По умолчанию система исправляет название страницы, чтобы избежать коллизий.
ignore-module-names-overrite = 0

; Автоматически индексировать изменения страниц
pages-auto-index = 1

; Включить предварительную авторизацию
enable-pre-auth = 0

; Форматировать выводимый xml-документы
xml-format-output = 0

; Разрешить перехват вызываемых адресов umap'ом
matches-enabled = 1

; Настройки режима отладки
[debug]
; Включить режим отладки
enabled = 1

; Список адресов, для которых будет включен режим отладки.
; Если ни один адрес не задан, то он будет включен для всех пользователей.
;filter.ip[] = "127.0.0.1"

; Настройка подключения к базе данных. Соединение совершается on-demand
; Помимо core-соединения, планируется поддержка разбиения бд для крупных проектов на подсистемы: поиск, кэш, бекап и т.д..
[connections]
; Тип подключения
core.type = mysql

; Хост
core.host = "localhost"

; Логин
core.login = "root"

; Пароль
core.password = ""

; Имя базы данных
core.dbname = "dbname"

; Порт
core.port =

; Постоянное соединение
core.persistent = 1

; Использовать сжатие при передачи данных между БД и системой
core.compression = 0

; Настройки rest-протоколов
[streams]
; Список доступных системе протоколов
enable[] = 'udata'
enable[] = 'utype'
enable[] = 'upage'
enable[] = 'uobject'
enable[] = 'ufs'
enable[] = 'usel'
enable[] = 'umap'
enable[] = 'uhttp'
enable[] = 'ulang'
enable[] = 'umess'

; Разрешения на доступ к протоколам через HTTP
udata.http.allow = 1
uobject.http.allow = 1
upage.http.allow = 1
umess.http.allow = 1
ufs.http.allow = 1

; Выставление прав доступа на вызов протокола через HTTP
; Можно выбрать:
; 'all' - доступно всем (по умолчанию)
; 'admin' - доступно только администраторам сайта
; 'sv' - доступно только супервайзерам
; 'auth' - доступно только авторизованным ползователям
; Так же можно перечислить через запятую только список id групп пользователей и пользователей,
; для которых будет доступен протокол через HTTP
uobject.http.permissions = 'sv'

; Заголовок "User Agent", который будет отправлять система при доступе к внешним данным
user-agent = 'UMI.CMS libxml agent'

; Список путей, используемых системой.
; С их помощью можно значительно преобразовать стр-ру файловой системы
[includes]
; Ядро системы
system.kernel = "~/classes/system/"

; Классы внутренних протоколов
system.kernel.streams = "~/classes/system/subsystems/streams/"

; Собранный в 1 файл ядра (компилируется файлов compile.php)
system.kernel.assebled = "~/sys-temp/kernel.php"

; Класс базового модуля
system.default-module = "~/classes/modules/"

; Классы модулей
system.modules = "~/classes/modules/"

; Классы виртуальных модулей
system.virtual-modules = "~/classes/modules/"

; Библиотечные файлы (в данный момент поддерживается только частично)
system.libs = "~/libs/"

; Временные файлы системы
system.runtime-cache = "~/sys-temp/runtime-cache/"

; Страницы ошибок
system.error = "~/errors/"

; Страница-заглушка
system.stub = "~/errors/stub.php"

; Скины
templates.skins = "~/styles/skins/{skin}/"

; Tpl-шаблоны (в пути можно указывать макросы {lang} и {domain})
templates.tpl = "~/tpls/"

; Xslt-шаблоны (в пути можно указывать макросы {lang} и {domain})
templates.xsl = "~/xsltTpls/"

; Настройки кэширования системы
[cache]
; Текущий кэширующий механизм.
; На текущий момент доступны: apc, eaccelerator, xcache, fs, memcache
engine = 'none'

; Включение/выключение статического кэширования
static.enabled = 0

; Режим работы статического кэширования
static.mode = 0
; Отключить сбор статистики при выдаче страниц из статического кэша

static.ignore-stat = 0

; Настройки страницы-заглушки
[stub]
; Включить заглушку
enabled = 0

; Не показывать заглушку для списка ip:
;filter.ip[] = "127.0.0.1"

; Seo-настройки
[seo]
; Не реализовано
;url-extension = ".html"

; Не реализовано
;folder-redirect = 1

; Вычислять last-modified заголовок страниц.
; Обратите внимание, что для системных страниц (корзина товаров, страница авторизации и т.д.) эта опция может игнорироваться.
; Для всех "настоящих" страниц будет осуществлен корректный расчет времени последней модификации.
calculate-last-modified = 0

; Вычислять e-tag заголовок всех страниц
calculate-e-tag = 0

; Следить за историей изменений адресов страниц (переименования, перемещения)
; При включенной опции ведется статистика изменений, при попадании пользователя на перемещенную страницу,
; система будет осуществлять seo-корректное перенаправление на новый адрес страницы
watch-redirects-history = 1

; Значение crawl-delay в robots.txt
crawl-delay = 3

; Переадресовывать на основной домен, если пользователь зашел на зеркало
primary-domain-redirect = 0

; Настройки капчи
[captcha]
; Класс отрисовки изображений (можно заменить стандартную отрисовку0
drawer = "default"

; Настройки подсистемы внутренних сообщений
[messages]
; Перехватывать и логгировать системные события (сохранять в системный журнал событий)
catch-system-events = 0

; Индивидуальные настройки модулей
[modules]
; Класс для расчета номера следующего заказа в интернет-магазине
emarket.numbers = 'default'
</source>

Универсальный метод для кэширования xml-данных в XSLT

2012-08-15T05:43:45Z

Kalexey: переименовал «Универсальный метод для кеширования xml-данных в XSLT» в «Универсальный метод для кэширования xml-данных в XSLT»

Некоторая информация по кешированию xml-данных была представлена в данной статье:
[[Кеширование результата работы метода getCreateForm в XSL-шаблоне]]

Универсальный метод, который необходимо добавить в файл '''classes/modules/cutom.php''', может быть представлен в следующем виде:
<source lang="php">
public function xsltCache($expire = 3600, $stream){
$params_temp = array_slice(func_get_args(), 2);
$params = array();
foreach($params_temp as $param){
$params[] = (strpos($param, '/') !== FALSE) ? "(" . $param . ")" : $param;
}

$params_str = implode('/', $params);
$url = $stream . "://" . $params_str;
$folder = CURRENT_WORKING_DIR . '/sys-temp/udatacache/';
$path = $folder . md5($url) . '.xml';
if(!is_dir($folder)) mkdir($folder, 0777, true);
if(is_file($path)) $mtime = filemtime($path);

if(!is_file($path) || time() > ($mtime + $expire)) {
$data = file_get_contents($url);
file_put_contents($path, $data);
return array('plain:result' => $data);
}else{
$result = file_get_contents($path);
return array('plain:result' => $result);
}
}
</source>

а сам вызов в XSL-шаблоне будет следующим:
<pre>
udata://custom/xsltCache/3600/custom/lidersCustom/20
</pre>

<pre>
где 3600 - время кеширования xml-данных в секундах,
custom - модуль
lidersCustom - метод
20 - один из параметров, их может быть больше одного
</pre>
[[Категория:Верстка в XSLT]]

Универсальный метод для кеширования xml-данных в XSLT

2012-08-15T05:43:45Z

#перенаправление [[Универсальный метод для кэширования xml-данных в XSLT]]

Универсальный метод для кеширования html-данных в XSLT

2012-08-15T05:43:23Z

Kalexey: переименовал «Универсальный метод для кеширования html-данных в XSLT» в «Универсальный метод для кэширования html-данных в XSLT»

#перенаправление [[Универсальный метод для кэширования html-данных в XSLT]]

Универсальный метод для кэширования html-данных в XSLT

2012-08-15T05:43:22Z

В одной из статей уже был рассмотрен способ кеширования html-кода в XSLT,
это была статья [[Блочное кеширование html-кода в XSLT]]

В данной статьей будет показан пример универсального кастомного метода,
в который можно передавать основной вызов: модуль, метод, параметры и также
путь к шаблону для трансформации xml данных. Кастомный метод необходимо
добавить в файл '''classes/modules/custom.php''':
<source lang="php">
public function xsltHtmlCache($expire = 3600, $module, $method){
$xslFilePath = getRequest('xsl');
// $filePath - путь к xsl-шаблону трансформации.
$filePath = CURRENT_WORKING_DIR . '/xsltTpls/' . $xslFilePath;
if(!is_file($filePath)) return;

$args = func_get_args();
$params = array_slice($args, 3);
$params_str = implode('/', $params);
$url = "udata://" . $module . '/' . $method . '/' . $params_str;

$folder = CURRENT_WORKING_DIR . '/sys-temp/udatacache/';
$path = $folder . md5($url . $filePath) . '.xml';
if(!is_dir($folder)) mkdir($folder, 0777, true);
if(is_file($path)) $mtime = filemtime($path);

if(!is_file($path) || time() > ($mtime + $expire)) {

$xsltDom = new DomDocument;
$xsltDom->resolveExternals = true;
$xsltDom->substituteEntities = true;

$xsltDom->load($filePath, DOM_LOAD_OPTIONS);

$xslt = new xsltProcessor;
$xslt->registerPHPFunctions();
$xslt->importStyleSheet($xsltDom);
$page_id = cmsController::getInstance()->getCurrentElementId();
$parent_id = "";
$active = "";

if($page_id){
$page = umiHierarchy::getInstance()->getElement($page_id);
$parent_id = $page->getParentId();
$active = (int) $page->getIsDefault();
}

// Добавляем необходимые глобальные переменные, которые можно будет использовать в xsl-шаблоне
$xslt->setParameter("", 'parent-id', $parent_id);
$xslt->setParameter("", 'document-page-id', $page_id);
$xslt->setParameter("", 'active', $active);

$dom_new = new DOMDocument("1.0", "utf-8");
// $xml - xml-данные для трансформации.
$xml = file_get_contents($url);
$dom_new->loadXML($xml);

//производим трансформацию
$result = $xslt->transformToXML($dom_new);
//html-данные необходимо включить в CDATA и в какой либо корневой узел.
$result = "<udata mode=\"cache\"><![CDATA[" . $result . "]]></udata>";
// данный принцип возвращения данных отключает xslt-трансформацию системой UMI.CMS
return array('plain:result' => $result);

}else{
$result = file_get_contents($path);
return array('plain:result' => $result);
}
}
</source>

Вызов может быть следующим:
<source lang="xml">
<xsl:value-of select="document('udata://custom/xsltHtmlCache/3600/catalog/getCategoryList//8//1?xsl=modules/catalog/category-cache.xsl')/udata"
disable-output-escaping="yes" />
</source>

Обратите внимание в кастомном методе на блок:
<source lang="php">
// page_id текущей страницы сайта
$page_id = cmsController::getInstance()->getCurrentElementId();
$parent_id = "";
$active = "";

if($page_id){
$page = umiHierarchy::getInstance()->getElement($page_id);
$parent_id = $page->getParentId();
$active = (int) $page->getIsDefault();
}

// Добавляем необходимые глобальные переменные, которые можно будет использовать в xsl-шаблоне
$xslt->setParameter("", 'parent-id', $parent_id);
$xslt->setParameter("", 'document-page-id', $page_id);
$xslt->setParameter("", 'active', $active);

</source>
[[Категория: Верстка в XSLT]]

Предупреждение при посещении сайта

2012-08-10T09:04:47Z

Kalexey:

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

В JavaScript сущестуют события позволяющее вывести для пользователя всплывающее окно и получить от него информацию.
Таких событий всего 3: ''Alert'' (выводит сообщение с кнопкой OK), ''Confirm'' (позволяет либо согласиться либо отказаться с каким-то сообщением) и ''Prompt'' (позволяет получить от пользователя какую-либо текстовую информацию).

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

В JavaScript также имеются возможности по работе с cookies. Комбинируя работу с диалоговыми окнами и с cookies мы можем успешно решить поставленную задачу.

Для работы с cookies, воспользуемся готовым решением, а именно скриптом jquery.cookie.js написанным на JQuery. Данный скрипт подключается системой по умолчанию из директории /js/.

Функция, котороя позволяет установить куку в браузер пользователя:
$.cookie('myage', 'iam18');
где, 'myage' - имя куки,
'iam18' - значение куки

Функция, которая позволяет получить куку из браузера пользователя:
$.cookie('myage');
Функция, которая позволяет удалить куку из браузера пользователя:
$.cookie('myage', null);

Теперь осталось написать свою функцию по проверке куки и ответа от пользователя:
<source lang="php">
<script type="text/javascript">
function checkCookie()
{
if ($.cookie('myage') == null || $.cookie('myage') == ''){
answer=confirm("Внимание!\nВы заходите на ресурс для взрослых (18+).\nВы подтверждаете и гарантируете, что вам
исполнилось не менее 18 лет?\nЕсли \"Да\", то нажмите на кнопку \"ОК\", если \"Нет\", то нажмите на кнопку \"Отмена\".");
if (answer==true){
$.cookie('myage', 'iam18');
} else {
$.cookie('myage', null);
alert("Вы отказались от просмотра нашего сайта!");
window.location.replace('http://ya.ru');
}
}
}
</script>
</source>
Функция не получает никаких параметров. В ней мы проверяем наличие в браузере пользователя куки с нашим значением (мы проверяем это на значения ''null'' и ''пустую строку'').
Если у пользователя нет нашей куки , то мы показываем пользователю вопрос о желании посещения ресурса, результат ответа записываем в переменную ''answer''. Далее мы проверяем, если пользователь согласился на посещение ресурса (''answer==true''), то устанавливаем в его браузер куку с именем ''"myage"'' и значением ''"yes18"'':
''$.cookie('myage', 'iam18');''
Если пользователь отказался от посещения сайта, то сообщаем ему об этом и переадресовываем на другой адрес (например, на поисковую систему).

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

Разместим данный скрипт в шаблоне шапки страницы (header), между тегами ''<head> </head>''.
Там же найдем тег ''<body>'', он нам будет нужен, чтобы запустить скрипт до загрузки страницы.
У тега ''<body>'' имеется событие ''onload=""'', передадим ему нашу функцию по проверке куки:
<body onload="checkCookie()">

Всё, функционал уже должен работать.

Возможна ситуация, когда у пользователя отключен JavaScript, чтобы в этом случае затруднить пользователю просмотр ресурса, воспользуемся тегами ''<noscript> </noscript>''. Данный элемент должен быть написан сразу после тега <body>.
Внутрь элемента ''<noscript>'' мы разместим css-заглушку с предупреждением:
<source lang="php">
<noscript>
<div style="background-color: #FFFBCC;
border: 1px solid #888888;
border-radius: 25px 25px 25px 25px;
box-shadow: 5px 5px 5px #544A35;
font-size: 2em;
line-height: 100px;
left: 40%;
margin-left: -275px;
padding: 20px;
position: absolute;
top: 100px;
width: 750px;
height: 350px;
z-index: 9999999;">
В вашем браузере отключен JavaScript.
<br />
Пожалуйста, включите его в настройках вашего браузера,
<br />
если желаете работать с нашим сайтом.
</div>
</noscript>
</source>

Версия системы: 2.8.5.2

Участник:Kalexey

2012-08-01T06:42:19Z

Kalexey:

== Июль ==
<ul>
<li>[[Вставка статуса ICQ и Skype на сайт]]</li>
<li>[[Взаимодействие с Twitter (XML API)]]</li>
<li>[[Система рэйтинга]]</li>
<li>[[Комментарии ВКонтакте и Facebook (TPL)]]</li>
<li>[[Плагин "Spoiler" для TinyMCE]]</li>
<li>[[Получение текущего шаблона в кастомном методе]]</li>
<li>[[Макрос укорачивания URL]]</li>
</ul>

== Июнь ==
<ul>
<li>[[Вывод случайного изображения из папки]]</li>
<li>[[Наложение водяной подписи на изображение]]</li>
<li>[[Минимизация CSS и JavaScript]]</li>
<li>[[Вывод списка тегов всех постов блогов]]</li>
<li>[[Расширяем функциональность TinyMCE]]</li>
</ul>

== Май ==
<ul>
<li>[[Расширяем возможности макроса content redirect]]</li>
<li>[[Подключаем кастомный WYSIWYG-редактор для административной панели]]</li>
<li>[[Поиск с панелью предложений]]</li>
</ul>

== Апрель ==

<ul>
<li>[[Добавляем QR-коды для ссылок на сайте]]</li>
<li>[[Организуем интерфейс для слабовидящих пользователей]]</li>
</ul>

Макрос укорачивания URL

2012-08-01T06:42:06Z

Kalexey: переименовал «Укорачивание URL» в «Макрос укорачивания URL»

[[category:Написание кастомных макросов]]
[[category:Верстка в XSLT]]
[[category:Верстка в TPL]]
<p>
Данный макрос будет укорачивать переданный ему URL с помощью сервиса [http://www.tinyurl.com tinyurl.com]. Этот сервис не делает самый короткий URL, но его плюсом является то, что он не требует регистрации.
</p>
<p>
Тело макроса нужно будет разместить в файле "/classes/modules/content/__custom.php" после строки "//TODO: Write here your own macroses".
</p>
<p style="text-align: right">
'''Листинг 1. Код макроса'''
</p>
<source lang="php">
/*
@param String
$url - URL для укорачивания
*/
public function getTinyUrl($url) {
if($url)
return file_get_contents("http://tinyurl.com/api-create.php?url=".$url);
}
</source>
<p>
После того, как код макроса написан, необходимо добавить для него резрешение. Для этого создаём файл "permissions.custom.php" в той же папке, где находится "__custom.php", и пишем в нём следующий текст:
</p>
<p style="text-align: right">
'''Листинг 2. Добавление разрешения'''
</p>
<source lang="php">
<?php
$permissions = Array(
'content' =>
Array('getTinyUrl')
);
?>
</source>
<p>
Теперь можно использовать макрос. Вот примеры его использования в TPL и XSLT шаблонизаторах:
</p>
<p style="text-align: right">
'''Листинг 3. Использование макроса в TPL'''
</p>
<source lang="php">
%content getTinyUrl('http://www.umi-cms.ru/product/system/usability/')%
</source>
<p style="text-align: right">
'''Листинг 4. Использование макроса в XSLT'''
</p>
<source lang="html4strict">
<a>
<xsl:attribute name="href">
<xsl:select-of select="document('udata://content/getTinyUrl/(http://www.umi-cms.ru/product/system/usability/)')/udata" />
</xsl:attribute>
<xsl:text>
UMI.CMS Usability
</xsl:text>
</a>
</source>
<table align="center" width="100%">
<tr>
<td style="border: 1px dotted black; padding: 20px;">
'''Примечание'''.
<br />
<p>
Данный функционал был проверен на работоспособность в версии системы 2.8.5.1.
</p>
</td>
</tr>
</table>

Укорачивание URL

2012-08-01T06:42:06Z

Kalexey: переименовал «Укорачивание URL» в «Макрос укорачивания URL»

#перенаправление [[Макрос укорачивания URL]]

Участник:Kalexey

2012-08-01T05:02:46Z

Kalexey: /* Июль */

== Июль ==
<ul>
<li>[[Вставка статуса ICQ и Skype на сайт]]</li>
<li>[[Взаимодействие с Twitter (XML API)]]</li>
<li>[[Система рэйтинга]]</li>
<li>[[Комментарии ВКонтакте и Facebook (TPL)]]</li>
<li>[[Плагин "Spoiler" для TinyMCE]]</li>
<li>[[Получение текущего шаблона в кастомном методе]]</li>
<li>[[Укорачивание URL]]</li>
</ul>

== Июнь ==
<ul>
<li>[[Вывод случайного изображения из папки]]</li>
<li>[[Наложение водяной подписи на изображение]]</li>
<li>[[Минимизация CSS и JavaScript]]</li>
<li>[[Вывод списка тегов всех постов блогов]]</li>
<li>[[Расширяем функциональность TinyMCE]]</li>
</ul>

== Май ==
<ul>
<li>[[Расширяем возможности макроса content redirect]]</li>
<li>[[Подключаем кастомный WYSIWYG-редактор для административной панели]]</li>
<li>[[Поиск с панелью предложений]]</li>
</ul>

== Апрель ==

<ul>
<li>[[Добавляем QR-коды для ссылок на сайте]]</li>
<li>[[Организуем интерфейс для слабовидящих пользователей]]</li>
</ul>

Участник:Kalexey

2012-08-01T04:58:25Z

Kalexey: /* Июль */

== Июль ==
<ul>
<li>[[Статус ICQ и Skype]]</li>
<li>[[Взаимодействие с Twitter (XML API)]]</li>
<li>[[Система рэйтинга]]</li>
<li>[[Комментарии ВКонтакте и Facebook (TPL)]]</li>
<li>[[Плагин "Spoiler" для TinyMCE]]</li>
<li>[[Получение текущего шаблона в кастомном методе]]</li>
<li>[[Укорачивание URL]]</li>
</ul>

== Июнь ==
<ul>
<li>[[Вывод случайного изображения из папки]]</li>
<li>[[Наложение водяной подписи на изображение]]</li>
<li>[[Минимизация CSS и JavaScript]]</li>
<li>[[Вывод списка тегов всех постов блогов]]</li>
<li>[[Расширяем функциональность TinyMCE]]</li>
</ul>

== Май ==
<ul>
<li>[[Расширяем возможности макроса content redirect]]</li>
<li>[[Подключаем кастомный WYSIWYG-редактор для административной панели]]</li>
<li>[[Поиск с панелью предложений]]</li>
</ul>

== Апрель ==

<ul>
<li>[[Добавляем QR-коды для ссылок на сайте]]</li>
<li>[[Организуем интерфейс для слабовидящих пользователей]]</li>
</ul>

Взаимодействие с Twitter (XML API)

2012-08-01T04:24:34Z

Kalexey:

[[category:Написание кастомных макросов]]
[[category:Вопросы и уроки разработки сайтов на UMI.CMS]]
<p>
В данной статье будут представлены макросы, для взаимодействия с сервисом Twitter через Twitter XML API. Макрос для получения информации о пользователе и макрос получения ленты твитов.
</p>
<p>
Для незарегистрированных пользователей количество запросов к XML API ограничено. В час можно произвести только 150 запросов. Чтобы обойти данное ограничение, будут использоваться два вспомогательных макроса, для организации своего рода кэша. Макрос "writeCache" будет записывать полученные данные во временный файл, а макрос "readCache" считывать их. В последствии, чтобы каждый раз при обращение к странице, где будут использоваться макросы получения информации о пользователе или ленты твитов, не производился запрос к серверу Twitter, данные будут браться из временных файлов.
</p>
<p>
Все макросы необходимо разместить в файле "/classes/modules/custom.php", сразу после строки "//TODO: Write your macroses here". Для удобства написания и чтения кода воспользуемся константами, их нужно будет разместить после текста "<?php". В результате, файл "custom.php" будет выглядеть примерно следующим образом:
</p>
<p style="text-align: right;">
'''Листинг 1. Файл "custom.php"'''
</p>
<source lang="php">
<?php

// Константы для макросов взаимодействия с Twitter
define('CACHE_PATH', './sys-temp/twitter/', true); // Директория для файлов кэша
define('SCREEN_LINK', 'http://twitter.com/users/show.xml?screen_name=', true); // URL для получения информации о пользователе
define('TIMELINE_LINK', 'http://twitter.com/statuses/user_timeline/', true); // URL для получения ленты твитов

class custom extends def_module {
public function cms_callMethod($method_name, $args) {
return call_user_func_array(Array($this, $method_name), $args);
}

public function __call($method, $args) {
throw new publicException("Method " . get_class($this) . "::" . $method . " doesn't exists");
}
//TODO: Write your own macroses here

// + Twitter

/*
@title
Макрос записи данных в кэш
@param String
$filename - имя файла
@param String
$content - содержание файла
*/
private function writeCache($filename, $content) {
if(!file_exists(CACHE_PATH))
mkdir(CACHE_PATH);

try {
$fp = fopen(CACHE_PATH.$filename, 'w');
flock($fp, LOCK_EX);
fwrite($fp, $content);
flock($fp, LOCK_UN);
fclose($fp);
} catch(Exception $e) {
echo $e->getMessage();
}
}

/*
@title
Макрос чтения данных из кэша
@param String
$filename - имя файла
@param Integer
$expiry - время в миллисекундах (необходимо для вычисления актуальности данных)
*/
private function readCache($filename, $expiry) {
$cache_filename = CACHE_PATH.$filename;
if(file_exists($cache_filename)) {
if((time() - $expiry) > filemtime($cache_filename))
return false;

return simplexml_load_file($cache_filename);
}

return false;
}

/*
@title
Макрос получения информации о пользователе
@param String
$id - идентификатор пользователя
@param String
$template - шаблон вывода в TPL
*/
public function twitterScreen($id, $template = 'default') {
if(!isset($template))
$template = 'default';

list($widget_block, $error_block) =
self::loadTemplates('twitter/user/'.$template, 'widget_block', 'error_block');

if(!isset($id))
return $error_block;

$user_cache_filename = $id.'.user.cache';
if(!($user = $this->readCache($user_cache_filename, 1800))) {
$user = simplexml_load_file(SCREEN_LINK.$id);
$this->writeCache($user_cache_filename, $user->asXML());
}

if(!$user)
return $error_block;

$block_arr = array();
$block_arr['id'] = (string)$user[0]->id;
$block_arr['name'] = (string)$user[0]->name;
$block_arr['screen_name'] = (string)$user[0]->screen_name;
$block_arr['location'] = (string)$user[0]->location;
$block_arr['description'] = (string)$user[0]->description;
$block_arr['profile_image_url'] = (string)$user[0]->profile_image_url;
$block_arr['url'] = (string)$user[0]->url;
$block_arr['followers_count'] = (string)$user[0]->followers_count;
$block_arr['statuses_count'] = (string)$user[0]->statuses_count;
$block_arr['lang'] = (string)$user[0]->lang;
$block_arr['status'] = (string)$user[0]->status->text;

return self::parseTemplate($widget_block, $block_arr);
}

/*
@title
Макрос получения ленты твитов
@param String
$id - идентификатор пользователя
@param Integer
$count - количество выводимых твитов
@param String
$template - шаблон вывода в TPL
*/
public function twitterTimeline($id, $count = 3, $template = 'default') {
if(!isset($template))
$template = 'default';

list($timeline_block, $lines_block, $error_block) =
self::loadTemplates('twitter/timeline/'.$template, 'timeline_block', 'lines_block', 'error_block');

if(!isset($id))
return $error_block;

$user_cache_filename = $id.'.user.cache';
if(!($user = $this->readCache($user_cache_filename, 1800))) {
$user = simplexml_load_file(SCREEN_LINK.$id);
$this->writeCache($user_cache_filename, $user->asXML());
}

if(!$user)
return $error_block;

$timeline_cache_filename = $id.'.timeline.cache';
if(!($timeline = $this->readCache($timeline_cache_filename, 1800))) {
$timeline = simplexml_load_file(TIMELINE_LINK.$id.'.rss');
$this->writeCache($timeline_cache_filename, $timeline->asXML());
}

if(!$timeline)
return $error_block;

if($count < 1)
$count = 1;

$length = count($timeline->channel->item);
if($count > $length)
$count = $length;

$lines = array();
for($i = 0; $i < $count; $i++) {
$line_arr = array();
$line_arr['date'] = (string)date('d.m.Y G:i', strtotime($timeline->channel->item[$i]->pubDate));
$line_arr['title'] = (string)$timeline->channel->item[$i]->title;
$line_arr['link'] = (string)$timeline->channel->item[$i]->link;
$lines[] = self::parseTemplate($lines_block, $line_arr);
}

$block_arr = array();
$block_arr['id'] = (string)$user[0]->id;
$block_arr['name'] = (string)$user[0]->name;
$block_arr['screen_name'] = (string)$user[0]->screen_name;
$block_arr['count'] = (integer)$count;
$block_arr['subnodes:lines'] = (array)$lines;

return self::parseTemplate($timeline_block, $block_arr);
}

// - Twitter
};
?>
</source>
<p>
Макросы "writeCache" и "readCache" имеют модификаторы "private". Это сделано для того, чтобы они были недоступны для пользователей на прямую.
</p>
<p>
Теперь можно посмотреть ответ UData, к примеру, макроса "twitterScreen". Для этого наберите в адресной сроке браузера текст: "domain.ru/udata/custom/twitterScreen/umi_cms/notemplate". В результате будет получен ответ UData:
</p>
<source lang="xml">
<udata xmlns:xlink="http://www.w3.org/TR/xlink" module="custom" method="twitterScreen" generation-time="0.707462">
<id>63716372</id>
<name>UMI</name>
<screen_name>umi_cms</screen_name>
<description>UMI.CMS среди лидеров рынка CMS в России. Каждый третий разработчик Рунета использует UMI.CMS для создания сайтов.</description>
<profile_image_url>http://a0.twimg.com/profile_images/1850324360/vert1_normal.png</profile_image_url>
<url>http://www.umi-cms.ru</url>
<followers_count>469</followers_count>
<statuses_count>905</statuses_count>
<lang>ru</lang>
<status>RT @fullspace_: Внедрили поддержку @umi_cms в настройки Nginx. Ускоряем сайты как никто! :) http://t.co/2N3Sbo2l</status>
</udata>
</source>
<p>
При использовании XSLT-шаблонизатора макросы готовы к работе. Если Вы используете TPL-шаблонизатор, необходимо организовать шаблоны вывода информации. Создайте файл "/tpls/twitter/user/default.tpl" - шаблон вывода информации о пользователе. Его содержание будет следующим:
</p>
<p style="text-align: right;">
'''Листинг 2. Шаблон вывода информации о пользователе'''
</p>
<source lang="php">
<?php
$FORMS = Array();

$FORMS['widget_block'] = <<<END

<p>%id%</p>
<p>%description%</p>
<img src="%profile_image_url%" alt="" />

END;

$FORMS['error_block'] = <<<END

<p>Ошибка!</p>

END;
?>
</source>
<p>
Далее нужно создать файл "/tpls/twitter/timeline/default.tpl" - шаблон вывода ленты твитов. Содержание данного файла будет таким:
</p>
<p style="text-align: right;">
'''Листинг 3. Шаблон вывода ленты твитов'''
</p>
<source lang="php">
<?php
$FORMS = Array();

$FORMS['timeline_block'] = <<<END

<p>Последние <strong>%count%</strong> твитов пользователя
<strong>%name%</strong> (%id%)</p><br />
<div>%lines%</div>

END;

$FORMS['lines_block'] = <<<END

<p><strong>%date%</strong></p>
<p><em>%title%.</em></p>
<p><a href="%link%">Twitter</a></p>
<br />

END;

$FORMS['error_block'] = <<<END

<p>Ошибка!</p>

END;

?>
</source>
<p>
После создания шаблонов вывода, макросы готовы к использованию и в TPL-шаблонизаторе.
</p>
<p>
Для примера, выведем последние 3 твита пользователя "umi_cms" в TPL-шаблон "Интернет-магазин" (Хомячки). Откройте файл "/tpls/content/index.tpl" и пропишите макрос "custom twitterTimeline" в блоке "<div class="column">":
</p>
<source lang="html4strict">
<div class="column">
%search insert_form('home')%

%custom twitterTimeline('umi_cms')%
</div>
</source>
<table align="center">
<tr>
<td style="border: 1px solid black; padding: 5px;">
[[Файл:Twitter_screen.png]]
</td>
</tr>
<tr>
<td style="font-color: darkblue; font-weight: bold; text-align: center;">
Последние 3 твита пользователя "umi_cms"
</td>
</tr>
</table>
<table align="center" width="100%">
<tr>
<td style="border: 1px dotted black; padding: 20px;">
'''Примечание'''.
<br />
<p>
Данный функционал был проверен на работоспособность в версии системы 2.8.5.1.
</p>
</td>
</tr>
</table>

Взаимодействие с Twitter (XML API)

2012-08-01T04:23:19Z

Kalexey:

[[category:Написание кастомных макросов]]
[[category:Вопросы и уроки разработки сайтов на UMI.CMS]]
<p>
В данной статье будут представлены макросы, для взаимодействия с сервисом Twitter через Twitter XML API. Макрос для получения информации о пользователе и макрос получения ленты твитов.
</p>
<p>
Для незарегистрированных пользователей количество запросов к XML API ограничено. В час можно произвести только 150 запросов. Чтобы обойти данное ограничение, будут использоваться два вспомогательных макроса, для организации своего рода кэша. Макрос "writeCache" будет записывать полученные данные во временный файл, а макрос "readCache" считывать их. В последствии, чтобы каждый раз при обращение к странице, где будут использоваться макросы получения информации о пользователе или ленты твитов, не производился запрос к серверу Twitter, данные будут браться из временных файлов.
</p>
<p>
Все макросы необходимо разместить в файле "/classes/modules/custom.php", сразу после строки "//TODO: Write your macroses here". Для удобства написания и чтения кода воспользуемся константами, их нужно будет разместить после текста "<?php". В результате, файл "custom.php" будет выглядеть примерно следующим образом:
</p>
<p style="text-align: right;">
'''Листинг 1. Файл "custom.php"'''
</p>
<source lang="php">
<?php

// Константы для макросов взаимодействия с Twitter
define('CACHE_PATH', './sys-temp/twitter/', true); // Директория для файлов кэша
define('SCREEN_LINK', 'http://twitter.com/users/show.xml?screen_name=', true); // URL для получения информации о пользователе
define('TIMELINE_LINK', 'http://twitter.com/statuses/user_timeline/', true); // URL для получения ленты твитов

class custom extends def_module {
public function cms_callMethod($method_name, $args) {
return call_user_func_array(Array($this, $method_name), $args);
}

public function __call($method, $args) {
throw new publicException("Method " . get_class($this) . "::" . $method . " doesn't exists");
}
//TODO: Write your own macroses here

// + Twitter

/*
@title
Макрос записи данных в кэш
@param String
$filename - имя файла
@param String
$content - содержание файла
*/
private function writeCache($filename, $content) {
if(!file_exists(CACHE_PATH))
mkdir(CACHE_PATH);

try {
$fp = fopen(CACHE_PATH.$filename, 'w');
flock($fp, LOCK_EX);
fwrite($fp, $content);
flock($fp, LOCK_UN);
fclose($fp);
} catch(Exception $e) {
echo $e->getMessage();
}
}

/*
@title
Макрос чтения данных из кэша
@param String
$filename - имя файла
@param Integer
$expiry - время в миллисекундах (необходимо для вычисления актуальности данных)
*/
private function readCache($filename, $expiry) {
$cache_filename = CACHE_PATH.$filename;
if(file_exists($cache_filename)) {
if((time() - $expiry) > filemtime($cache_filename))
return false;

return simplexml_load_file($cache_filename);
}

return false;
}

/*
@title
Макрос получения информации о пользователе
@param String
$id - идентификатор пользователя
@param String
$template - шаблон вывода в TPL
*/
public function twitterScreen($id, $template = 'default') {
if(!isset($template))
$template = 'default';

list($widget_block, $error_block) =
self::loadTemplates('twitter/user/'.$template, 'widget_block', 'error_block');

if(!isset($id))
return $error_block;

$user_cache_filename = $id.'.user.cache';
if(!($user = $this->readCache($user_cache_filename, 1800))) {
$user = simplexml_load_file(SCREEN_LINK.$id);
$this->writeCache($user_cache_filename, $user->asXML());
}

if(!$user)
return $error_block;

$block_arr = array();
$block_arr['id'] = (string)$user[0]->id;
$block_arr['name'] = (string)$user[0]->name;
$block_arr['screen_name'] = (string)$user[0]->screen_name;
$block_arr['location'] = (string)$user[0]->location;
$block_arr['description'] = (string)$user[0]->description;
$block_arr['profile_image_url'] = (string)$user[0]->profile_image_url;
$block_arr['url'] = (string)$user[0]->url;
$block_arr['followers_count'] = (string)$user[0]->followers_count;
$block_arr['statuses_count'] = (string)$user[0]->statuses_count;
$block_arr['lang'] = (string)$user[0]->lang;
$block_arr['status'] = (string)$user[0]->status->text;

return self::parseTemplate($widget_block, $block_arr);
}

/*
@title
Макрос получения ленты твитов
@param String
$id - идентификатор пользователя
@param Integer
$count - количество выводимых твитов
@param String
$template - шаблон вывода в TPL
*/
public function twitterTimeline($id, $count = 3, $template = 'default') {
if(!isset($template))
$template = 'default';

list($timeline_block, $lines_block, $error_block) =
self::loadTemplates('twitter/timeline/'.$template, 'timeline_block', 'lines_block', 'error_block');

if(!isset($id))
return $error_block;

$user_cache_filename = $id.'.user.cache';
if(!($user = $this->readCache($user_cache_filename, 1800))) {
$user = simplexml_load_file(SCREEN_LINK.$id);
$this->writeCache($user_cache_filename, $user->asXML());
}

if(!$user)
return $error_block;

$timeline_cache_filename = $id.'.timeline.cache';
if(!($timeline = $this->readCache($timeline_cache_filename, 1800))) {
$timeline = simplexml_load_file(TIMELINE_LINK.$id.'.rss');
$this->writeCache($timeline_cache_filename, $timeline->asXML());
}

if(!$timeline)
return $error_block;

if($count < 1)
$count = 1;

$length = count($timeline->channel->item);
if($count > $length)
$count = $length;

$lines = array();
for($i = 0; $i < $count; $i++) {
$line_arr = array();
$line_arr['date'] = (string)date('d.m.Y G:i', strtotime($timeline->channel->item[$i]->pubDate));
$line_arr['title'] = (string)$timeline->channel->item[$i]->title;
$line_arr['link'] = (string)$timeline->channel->item[$i]->link;
$lines[] = self::parseTemplate($lines_block, $line_arr);
}

$block_arr = array();
$block_arr['id'] = (string)$user[0]->id;
$block_arr['name'] = (string)$user[0]->name;
$block_arr['screen_name'] = (string)$user[0]->screen_name;
$block_arr['count'] = (integer)$count;
$block_arr['subnodes:lines'] = (array)$lines;

return self::parseTemplate($timeline_block, $block_arr);
}

// - Twitter
};
?>
</source>
<p>
Макросы "writeCache" и "readCache" имеют модификаторы "private". Это сделано для того, чтобы они были недоступны для пользователей на прямую.
</p>
<p>
Теперь можно посмотреть ответ UData, к примеру, макроса "twitterScreen". Для этого наберите в адресной сроке браузера текст: "domain.ru/udata/custom/twitterScreen/umi_cms/notemplate". В результате будет получен ответ UData:
</p>
<source lang="xml">
<udata xmlns:xlink="http://www.w3.org/TR/xlink" module="custom" method="twitterScreen" generation-time="0.707462">
<id>63716372</id>
<name>UMI</name>
<screen_name>umi_cms</screen_name>
<description>UMI.CMS среди лидеров рынка CMS в России. Каждый третий разработчик Рунета использует UMI.CMS для создания сайтов.</description>
<profile_image_url>http://a0.twimg.com/profile_images/1850324360/vert1_normal.png</profile_image_url>
<url>http://www.umi-cms.ru</url>
<followers_count>469</followers_count>
<statuses_count>905</statuses_count>
<lang>ru</lang>
<status>RT @fullspace_: Внедрили поддержку @umi_cms в настройки Nginx. Ускоряем сайты как никто! :) http://t.co/2N3Sbo2l</status>
</udata>
</source>
<p>
При использовании XSLT-шаблонизатора макросы готовы к работе. Если Вы используете TPL-шаблонизатор, необходимо организовать шаблоны вывода информации. Создайте файл "/tpls/twitter/user/default.tpl" - шаблон вывода информации о пользователе. Его содержание будет следующим:
</p>
<p style="text-align: right;">
'''Листинг 2. Шаблон вывода информации о пользователе'''
</p>
<source lang="php">
<?php
$FORMS = Array();

$FORMS['widget_block'] = <<<END

<p>%id%</p>
<p>%description%</p>
<img src="%profile_image_url%" alt="" />

END;

$FORMS['error_block'] = <<<END

<p>Ошибка!</p>

END;
?>
</source>
<p>
Далее нужно создать файл "/tpls/twitter/timeline/default.tpl" - шаблон вывода ленты твитов. Содержание данного файла будет таким:
</p>
<p style="text-align: right;">
'''Листинг 3. Шаблон вывода ленты твитов'''
</p>
<source lang="php">
<?php
$FORMS = Array();

$FORMS['timeline_block'] = <<<END

<p>Последние <strong>%count%</strong> твитов пользователя
<strong>%name%</strong> (%id%)</p><br />
<div>%lines%</div>

END;

$FORMS['lines_block'] = <<<END

<p><strong>%date%</strong></p>
<p><em>%title%.</em></p>
<p><a href="%link%">Twitter</a></p>
<br />

END;

$FORMS['error_block'] = <<<END

<p>Ошибка!</p>

END;

?>
</source>
<p>
После создания шаблонов вывода, макросы готовы к использованию и в TPL-шаблонизаторе.
</p>
<p>
Для примера, выведем информацию о пользователе "umi_cms" в TPL-шаблон "Интернет-магазин" (Хомячки). Откройте файл "/tpls/content/index.tpl" и пропишите макрос "custom twitterScreen" в блоке "<div class="column">":
</p>
<source lang="html4strict">
<div class="column">
%search insert_form('home')%

%custom twitterTimeline('umi_cms')%
</div>
</source>
<table align="center">
<tr>
<td style="border: 1px solid black; padding: 5px;">
[[Файл:Twitter_screen.png]]
</td>
</tr>
<tr>
<td style="font-color: darkblue; font-weight: bold; text-align: center;">
Последние 3 твита пользователя "umi_cms"
</td>
</tr>
</table>
<table align="center" width="100%">
<tr>
<td style="border: 1px dotted black; padding: 20px;">
'''Примечание'''.
<br />
<p>
Данный функционал был проверен на работоспособность в версии системы 2.8.5.1.
</p>
</td>
</tr>
</table>

Взаимодействие с Twitter (XML API)

2012-07-31T08:46:03Z

Kalexey:

[[category:Написание кастомных макросов]]
<p>
В данной статье будут представлены макросы, для взаимодействия с сервисом Twitter через Twitter XML API. Макрос для получения информации о пользователе и макрос получения ленты твитов.
</p>
<p>
Для незарегистрированных пользователей количество запросов к XML API ограничено. В час можно произвести только 150 запросов. Чтобы обойти данное ограничение, будут использоваться два вспомогательных макроса, для организации своего рода кэша. Макрос "writeCache" будет записывать полученные данные во временный файл, а макрос "readCache" считывать их. В последствии, чтобы каждый раз при обращение к странице, где будут использоваться макросы получения информации о пользователе или ленты твитов, не производился запрос к серверу Twitter, данные будут браться из временных файлов.
</p>
<p>
Все макросы необходимо разместить в файле "/classes/modules/custom.php", сразу после строки "//TODO: Write your macroses here". Для удобства написания и чтения кода воспользуемся константами, их нужно будет разместить после текста "<?php". В результате, файл "custom.php" будет выглядеть примерно следующим образом:
</p>
<p style="text-align: right;">
'''Листинг 1. Файл "custom.php"'''
</p>
<source lang="php">
<?php

// Константы для макросов взаимодействия с Twitter
define('CACHE_PATH', './sys-temp/twitter/', true); // Директория для файлов кэша
define('SCREEN_LINK', 'http://twitter.com/users/show.xml?screen_name=', true); // URL для получения информации о пользователе
define('TIMELINE_LINK', 'http://twitter.com/statuses/user_timeline/', true); // URL для получения ленты твитов

class custom extends def_module {
public function cms_callMethod($method_name, $args) {
return call_user_func_array(Array($this, $method_name), $args);
}

public function __call($method, $args) {
throw new publicException("Method " . get_class($this) . "::" . $method . " doesn't exists");
}
//TODO: Write your own macroses here

// + Twitter

/*
@title
Макрос записи данных в кэш
@param String
$filename - имя файла
@param String
$content - содержание файла
*/
private function writeCache($filename, $content) {
if(!file_exists(CACHE_PATH))
mkdir(CACHE_PATH);

try {
$fp = fopen(CACHE_PATH.$filename, 'w');
flock($fp, LOCK_EX);
fwrite($fp, $content);
flock($fp, LOCK_UN);
fclose($fp);
} catch(Exception $e) {
echo $e->getMessage();
}
}

/*
@title
Макрос чтения данных из кэша
@param String
$filename - имя файла
@param Integer
$expiry - время в миллисекундах (необходимо для вычисления актуальности данных)
*/
private function readCache($filename, $expiry) {
$cache_filename = CACHE_PATH.$filename;
if(file_exists($cache_filename)) {
if((time() - $expiry) > filemtime($cache_filename))
return false;

return simplexml_load_file($cache_filename);
}

return false;
}

/*
@title
Макрос получения информации о пользователе
@param String
$id - идентификатор пользователя
@param String
$template - шаблон вывода в TPL
*/
public function twitterScreen($id, $template = 'default') {
if(!isset($template))
$template = 'default';

list($widget_block, $error_block) =
self::loadTemplates('twitter/user/'.$template, 'widget_block', 'error_block');

if(!isset($id))
return $error_block;

$user_cache_filename = $id.'.user.cache';
if(!($user = $this->readCache($user_cache_filename, 1800))) {
$user = simplexml_load_file(SCREEN_LINK.$id);
$this->writeCache($user_cache_filename, $user->asXML());
}

if(!$user)
return $error_block;

$block_arr = array();
$block_arr['id'] = (string)$user[0]->id;
$block_arr['name'] = (string)$user[0]->name;
$block_arr['screen_name'] = (string)$user[0]->screen_name;
$block_arr['location'] = (string)$user[0]->location;
$block_arr['description'] = (string)$user[0]->description;
$block_arr['profile_image_url'] = (string)$user[0]->profile_image_url;
$block_arr['url'] = (string)$user[0]->url;
$block_arr['followers_count'] = (string)$user[0]->followers_count;
$block_arr['statuses_count'] = (string)$user[0]->statuses_count;
$block_arr['lang'] = (string)$user[0]->lang;
$block_arr['status'] = (string)$user[0]->status->text;

return self::parseTemplate($widget_block, $block_arr);
}

/*
@title
Макрос получения ленты твитов
@param String
$id - идентификатор пользователя
@param Integer
$count - количество выводимых твитов
@param String
$template - шаблон вывода в TPL
*/
public function twitterTimeline($id, $count = 3, $template = 'default') {
if(!isset($template))
$template = 'default';

list($timeline_block, $lines_block, $error_block) =
self::loadTemplates('twitter/timeline/'.$template, 'timeline_block', 'lines_block', 'error_block');

if(!isset($id))
return $error_block;

$user_cache_filename = $id.'.user.cache';
if(!($user = $this->readCache($user_cache_filename, 1800))) {
$user = simplexml_load_file(SCREEN_LINK.$id);
$this->writeCache($user_cache_filename, $user->asXML());
}

if(!$user)
return $error_block;

$timeline_cache_filename = $id.'.timeline.cache';
if(!($timeline = $this->readCache($timeline_cache_filename, 1800))) {
$timeline = simplexml_load_file(TIMELINE_LINK.$id.'.rss');
$this->writeCache($timeline_cache_filename, $timeline->asXML());
}

if(!$timeline)
return $error_block;

if($count < 1)
$count = 1;

$length = count($timeline->channel->item);
if($count > $length)
$count = $length;

$lines = array();
for($i = 0; $i < $count; $i++) {
$line_arr = array();
$line_arr['date'] = (string)date('d.m.Y G:i', strtotime($timeline->channel->item[$i]->pubDate));
$line_arr['title'] = (string)$timeline->channel->item[$i]->title;
$line_arr['link'] = (string)$timeline->channel->item[$i]->link;
$lines[] = self::parseTemplate($lines_block, $line_arr);
}

$block_arr = array();
$block_arr['id'] = (string)$user[0]->id;
$block_arr['name'] = (string)$user[0]->name;
$block_arr['screen_name'] = (string)$user[0]->screen_name;
$block_arr['count'] = (integer)$count;
$block_arr['subnodes:lines'] = (array)$lines;

return self::parseTemplate($timeline_block, $block_arr);
}

// - Twitter
};
?>
</source>
<p>
Макросы "writeCache" и "readCache" имеют модификаторы "private". Это сделано для того, чтобы они были недоступны для пользователей на прямую.
</p>
<p>
Теперь можно посмотреть ответ UData, к примеру, макроса "twitterScreen". Для этого наберите в адресной сроке браузера текст: "domain.ru/udata/custom/twitterScreen/umi_cms/notemplate". В результате будет получен ответ UData:
</p>
<source lang="xml">
<udata xmlns:xlink="http://www.w3.org/TR/xlink" module="custom" method="twitterScreen" generation-time="0.707462">
<id>63716372</id>
<name>UMI</name>
<screen_name>umi_cms</screen_name>
<description>UMI.CMS среди лидеров рынка CMS в России. Каждый третий разработчик Рунета использует UMI.CMS для создания сайтов.</description>
<profile_image_url>http://a0.twimg.com/profile_images/1850324360/vert1_normal.png</profile_image_url>
<url>http://www.umi-cms.ru</url>
<followers_count>469</followers_count>
<statuses_count>905</statuses_count>
<lang>ru</lang>
<status>RT @fullspace_: Внедрили поддержку @umi_cms в настройки Nginx. Ускоряем сайты как никто! :) http://t.co/2N3Sbo2l</status>
</udata>
</source>
<p>
При использовании XSLT-шаблонизатора макросы готовы к работе. Если Вы используете TPL-шаблонизатор, необходимо организовать шаблоны вывода информации. Создайте файл "/tpls/twitter/user/default.tpl" - шаблон вывода информации о пользователе. Его содержание будет следующим:
</p>
<p style="text-align: right;">
'''Листинг 2. Шаблон вывода информации о пользователе'''
</p>
<source lang="php">
<?php
$FORMS = Array();

$FORMS['widget_block'] = <<<END

<p>%id%</p>
<p>%description%</p>
<img src="%profile_image_url%" alt="" />

END;

$FORMS['error_block'] = <<<END

<p>Ошибка!</p>

END;
?>
</source>
<p>
Далее нужно создать файл "/tpls/twitter/timeline/default.tpl" - шаблон вывода ленты твитов. Содержание данного файла будет таким:
</p>
<p style="text-align: right;">
'''Листинг 3. Шаблон вывода ленты твитов'''
</p>
<source lang="php">
<?php
$FORMS = Array();

$FORMS['timeline_block'] = <<<END

<p>Последние <strong>%count%</strong> твитов пользователя
<strong>%name%</strong> (%id%)</p><br />
<div>%lines%</div>

END;

$FORMS['lines_block'] = <<<END

<p><strong>%date%</strong></p>
<p><em>%title%.</em></p>
<p><a href="%link%">Twitter</a></p>
<br />

END;

$FORMS['error_block'] = <<<END

<p>Ошибка!</p>

END;

?>
</source>
<p>
После создания шаблонов вывода, макросы готовы к использованию и в TPL-шаблонизаторе.
</p>
<p>
Для примера, выведем информацию о пользователе "umi_cms" в TPL-шаблон "Интернет-магазин" (Хомячки). Откройте файл "/tpls/content/index.tpl" и пропишите макрос "custom twitterScreen" в блоке "<div class="column">":
</p>
<source lang="html4strict">
<div class="column">
%search insert_form('home')%

%custom twitterTimeline('umi_cms')%
</div>
</source>
<table align="center">
<tr>
<td style="border: 1px solid black; padding: 5px;">
[[Файл:Twitter_screen.png]]
</td>
</tr>
<tr>
<td style="font-color: darkblue; font-weight: bold; text-align: center;">
Последние 3 твита пользователя "umi_cms"
</td>
</tr>
</table>
<table align="center" width="100%">
<tr>
<td style="border: 1px dotted black; padding: 20px;">
'''Примечание'''.
<br />
<p>
Данный функционал был проверен на работоспособность в версии системы 2.8.5.1.
</p>
</td>
</tr>
</table>

Участник:Kalexey

2012-07-31T08:02:20Z

Kalexey: /* Июль */

== Июль ==
<ul>
<li>[[Взаимодействие с Twitter (XML API)]]</li>
<li>[[Система рэйтинга]]</li>
<li>[[Комментарии ВКонтакте и Facebook (TPL)]]</li>
<li>[[Плагин "Spoiler" для TinyMCE]]</li>
<li>[[Получение текущего шаблона в кастомном методе]]</li>
<li>[[Укорачивание URL]]</li>
</ul>

== Июнь ==
<ul>
<li>[[Вывод случайного изображения из папки]]</li>
<li>[[Наложение водяной подписи на изображение]]</li>
<li>[[Минимизация CSS и JavaScript]]</li>
<li>[[Вывод списка тегов всех постов блогов]]</li>
<li>[[Расширяем функциональность TinyMCE]]</li>
</ul>

== Май ==
<ul>
<li>[[Расширяем возможности макроса content redirect]]</li>
<li>[[Подключаем кастомный WYSIWYG-редактор для административной панели]]</li>
<li>[[Поиск с панелью предложений]]</li>
</ul>

== Апрель ==

<ul>
<li>[[Добавляем QR-коды для ссылок на сайте]]</li>
<li>[[Организуем интерфейс для слабовидящих пользователей]]</li>
</ul>

Взаимодействие с Twitter (XML API)

2012-07-31T08:01:57Z

Kalexey: Новая страница: « category:Написание кастомных макросов <p> В данной статье будут представлены макросы, для вз…»

[[category:Написание кастомных макросов]]
<p>
В данной статье будут представлены макросы, для взаимодействия с сервисом Twitter через Twitter XML API. Макрос для получения информации о пользователе и макрос получения ленты твитов.
</p>
<p>
Для незарегистрированных пользователей количество запросов к XML API ограничено. В час можно произвести только 150 запросов. Чтобы обойти данное ограничение, будут использоваться два вспомогательных макроса, для организации своего рода кэша. Макрос "writeCache" будет записывать полученные данные во временный файл, а макрос "readCache" считывать их. В последствии, чтобы каждый раз при обращение к странице, где будут использоваться макросы получения информации о пользователе или ленты твитов, не производился запрос к серверу Twitter, данные будут браться из временных файлов.
</p>
<p>
Все макросы необходимо разместить в файле "/classes/modules/custom.php", сразу после строки "//TODO: Write your macroses here". Для удобства написания и чтения кода воспользуемся константами, их нужно будет разместить после текста "<?php". В результате, файл "custom.php" будет выглядеть примерно следующим образом:
</p>
<p style="text-align: right;">
'''Листинг 1. Файл "custom.php"'''
</p>
<source lang="php">
<?php

// Константы для макросов взаимодействия с Twitter
define('CACHE_PATH', './sys-temp/twitter/', true); // Директория для файлов кэша
define('SCREEN_LINK', 'http://twitter.com/users/show.xml?screen_name=', true); // URL для получения информации о пользователе
define('TIMELINE_LINK', 'http://twitter.com/statuses/user_timeline/', true); // URL для получения ленты твитов

class custom extends def_module {
public function cms_callMethod($method_name, $args) {
return call_user_func_array(Array($this, $method_name), $args);
}

public function __call($method, $args) {
throw new publicException("Method " . get_class($this) . "::" . $method . " doesn't exists");
}
//TODO: Write your own macroses here

// + Twitter

/*
@title
Макрос записи данных в кэш
@param String
$filename - имя файла
@param String
$content - содержание файла
*/
private function writeCache($filename, $content) {
if(!file_exists(CACHE_PATH))
mkdir(CACHE_PATH);

try {
$fp = fopen(CACHE_PATH.$filename, 'w');
flock($fp, LOCK_EX);
fwrite($fp, $content);
flock($fp, LOCK_UN);
fclose($fp);
} catch(Exception $e) {
echo $e->getMessage();
}
}

/*
@title
Макрос чтения данных из кэша
@param String
$filename - имя файла
@param Integer
$expiry - время в миллисекундах (необходимо для вычисления актуальности данных)
*/
private function readCache($filename, $expiry) {
$cache_filename = CACHE_PATH.$filename;
if(file_exists($cache_filename)) {
if((time() - $expiry) > filemtime($cache_filename))
return false;

return simplexml_load_file($cache_filename);
}

return false;
}

/*
@title
Макрос получения информации о пользователе
@param String
$id - идентификатор пользователя
@param String
$template - шаблон вывода в TPL
*/
public function twitterScreen($id, $template = 'default') {
if(!isset($template))
$template = 'default';

list($widget_block, $error_block) =
self::loadTemplates('twitter/user/'.$template, 'widget_block', 'error_block');

if(!isset($id))
return $error_block;

$user_cache_filename = $id.'.user.cache';
if(!($user = $this->readCache($user_cache_filename, 1800))) {
$user = simplexml_load_file(SCREEN_LINK.$id);
$this->writeCache($user_cache_filename, $user->asXML());
}

if(!$user)
return $error_block;

$block_arr = array();
$block_arr['id'] = (string)$user[0]->id;
$block_arr['name'] = (string)$user[0]->name;
$block_arr['screen_name'] = (string)$user[0]->screen_name;
$block_arr['location'] = (string)$user[0]->location;
$block_arr['description'] = (string)$user[0]->description;
$block_arr['profile_image_url'] = (string)$user[0]->profile_image_url;
$block_arr['url'] = (string)$user[0]->url;
$block_arr['followers_count'] = (string)$user[0]->followers_count;
$block_arr['statuses_count'] = (string)$user[0]->statuses_count;
$block_arr['lang'] = (string)$user[0]->lang;
$block_arr['status'] = (string)$user[0]->status->text;

return self::parseTemplate($widget_block, $block_arr);
}

/*
@title
Макрос получения ленты твитов
@param String
$id - идентификатор пользователя
@param Integer
$count - количество выводимых твитов
@param String
$template - шаблон вывода в TPL
*/
public function twitterTimeline($id, $count = 3, $template = 'default') {
if(!isset($template))
$template = 'default';

list($timeline_block, $lines_block, $error_block) =
self::loadTemplates('twitter/timeline/'.$template, 'timeline_block', 'lines_block', 'error_block');

if(!isset($id))
return $error_block;

$user_cache_filename = $id.'.user.cache';
if(!($user = $this->readCache($user_cache_filename, 1800))) {
$user = simplexml_load_file(SCREEN_LINK.$id);
$this->writeCache($user_cache_filename, $user->asXML());
}

if(!$user)
return $error_block;

$timeline_cache_filename = $id.'.timeline.cache';
if(!($timeline = $this->readCache($timeline_cache_filename, 1800))) {
$timeline = simplexml_load_file(TIMELINE_LINK.$id.'.rss');
$this->writeCache($timeline_cache_filename, $timeline->asXML());
}

if(!$timeline)
return $error_block;

if($count < 1)
$count = 1;

$length = count($timeline->channel->item);
if($count > $length)
$count = $length;

$lines = array();
for($i = 0; $i < $count; $i++) {
$line_arr = array();
$line_arr['date'] = (string)date('d.m.Y G:i', strtotime($timeline->channel->item[$i]->pubDate));
$line_arr['title'] = (string)$timeline->channel->item[$i]->title;
$line_arr['link'] = (string)$timeline->channel->item[$i]->link;
$lines[] = self::parseTemplate($lines_block, $line_arr);
}

$block_arr = array();
$block_arr['id'] = (string)$user[0]->id;
$block_arr['name'] = (string)$user[0]->name;
$block_arr['screen_name'] = (string)$user[0]->screen_name;
$block_arr['count'] = (integer)$count;
$block_arr['subnodes:lines'] = (array)$lines;

return self::parseTemplate($timeline_block, $block_arr);
}

// - Twitter
};
?>
</source>
<p>
Макросы "writeCache" и "readCache" имеют модификаторы "private". Это сделано для того, чтобы они были недоступны для пользователей на прямую.
</p>
<p>
Теперь можно посмотреть ответ UData, к примеру, макроса "twitterScreen". Для этого наберите в адресной сроке браузера текст: "domain.ru/udata/custom/twitterScreen/umi_cms/notemplate".
</p>
<source lang="xml">
<udata xmlns:xlink="http://www.w3.org/TR/xlink" module="custom" method="twitterScreen" generation-time="0.707462">
<id>63716372</id>
<name>UMI</name>
<screen_name>umi_cms</screen_name>
<description>UMI.CMS среди лидеров рынка CMS в России. Каждый третий разработчик Рунета использует UMI.CMS для создания сайтов.</description>
<profile_image_url>http://a0.twimg.com/profile_images/1850324360/vert1_normal.png</profile_image_url>
<url>http://www.umi-cms.ru</url>
<followers_count>469</followers_count>
<statuses_count>905</statuses_count>
<lang>ru</lang>
<status>RT @fullspace_: Внедрили поддержку @umi_cms в настройки Nginx. Ускоряем сайты как никто! :) http://t.co/2N3Sbo2l</status>
</udata>
</source>
<p>
При использовании XSLT-шаблонизатора макросы готовы к работе. Если Вы используете TPL-шаблонизатор, необходимо организовать шаблоны вывода информации. Создайте файл "/tpls/twitter/user/default.tpl" - шаблон вывода информации о пользователе. Его содержание будет следующим:
</p>
<p style="text-align: right;">
'''Листинг 2. Шаблон вывода информации о пользователе'''
</p>
<source lang="php">
<?php
$FORMS = Array();

$FORMS['widget_block'] = <<<END

<p>%id%</p>
<p>%description%</p>
<img src="%profile_image_url%" alt="" />

END;

$FORMS['error_block'] = <<<END

<p>Ошибка!</p>

END;
?>
</source>
<p>
Далее нужно создать файл "/tpls/twitter/timeline/default.tpl" - шаблон вывода ленты твитов. Содержание данного файла будет таким:
</p>
<p style="text-align: right;">
'''Листинг 3. Шаблон вывода ленты твитов'''
</p>
<source lang="php">
<?php
$FORMS = Array();

$FORMS['timeline_block'] = <<<END

<p>Последние <strong>%count%</strong> твитов пользователя
<strong>%name%</strong> (%id%)</p><br />
<div>%lines%</div>

END;

$FORMS['lines_block'] = <<<END

<p><strong>%date%</strong></p>
<p><em>%title%.</em></p>
<p><a href="%link%">Twitter</a></p>
<br />

END;

$FORMS['error_block'] = <<<END

<p>Ошибка!</p>

END;

?>
</source>
<p>
После создания шаблонов вывода, макросы готовы к использованию и в TPL-шаблонизаторе.
</p>
<p>
Для примера, выведем информацию о пользователе "umi_cms" в TPL-шаблон "Интернет-магазин" (Хомячки). Откройте файл "/tpls/content/index.tpl" и пропишите макрос "custom twitterScreen" в блоке "<div class="column">":
</p>
<source lang="html4strict">
<div class="column">
%search insert_form('home')%

%custom twitterTimeline('umi_cms')%
</div>
</source>
<table align="center">
<tr>
<td style="border: 1px solid black; padding: 5px;">
[[Файл:Twitter_screen.png]]
</td>
</tr>
<tr>
<td style="font-color: darkblue; font-weight: bold; text-align: center;">
Последние 3 твита пользователя "umi_cms"
</td>
</tr>
</table>
<table align="center" width="100%">
<tr>
<td style="border: 1px dotted black; padding: 20px;">
'''Примечание'''.
<br />
<p>
Данный функционал был проверен на работоспособность в версии системы 2.8.5.1.
</p>
</td>
</tr>
</table>

Файл:Twitter screen.png

2012-07-31T07:57:53Z

Kalexey:

Система рейтинга

2012-07-30T05:36:09Z

Kalexey:

[[category:Вопросы и уроки разработки сайтов на UMI.CMS]]
[[category:Написание кастомных макросов]]
<p>
'''Задача''':
</p>
<p>
Организовать систему рейтинга для объектов UMI.CMS.
</p>
<p>
'''Решение''':
</p>
<p>
Организуем рейтинг с использованием jQuery и Ajax на примере объектов каталога. В начале, необходимо отредактировать тип данных "Объект каталога": зайдите в модуль "Шаблоны данных", найдите тип данных "Объект каталога" и откройте его для редактирования. Нажмите кнопку "Добавить группу" и задайте имя группы, например - "Рейтинг". В созданной группе добавьте два поля типа "Число":
<ul>
<li>"Хороший" (good);</li>
<li>"Плохой" (bad).</li>
</ul>
</p>
<table align="center">
<tr>
<td style="border: 1px solid black; padding: 5px;">
[[Файл:Rate_fields.png]]
</td>
</tr>
<tr>
<td style="font-color: darkblue; font-weight: bold; text-align: center;">
Группа полей "Рейтинг"
</td>
</tr>
</table>
<p>
Теперь необходимо написать макросы, которые будут работать с данными полями. Откройте файл "/classes/modules/vote/__custom.php" и добавьте код макросов сразу же после строки "//TODO: Write your macroses here".
</p>
<p style="text-align: right;">
'''Листинг 1. Код макросов установки и получения рейтинга'''
</p>
<source lang="php">
/*
@title
Установка рейтинга объекта
*/
public function setRate() {
$id = (int)getRequest('id');
if(!isset($id) || !is_numeric($id))
throw new publicException('Invalid object ID');

$type = (string)getRequest('type');
if(!isset($type))
throw new publicException('Invalid rate type');

$hierarchy = umiHierarchy::getInstance();
$element = $hierarchy->getElement($id);
$rate = $element->getValue($type) + 1;
$element->setValue($type, $rate);
$element->commit();

echo $rate;
}

/*
@title
Получение рейтинга объекта
@param Integer
$id - идентификатор объекта
@param String
$type - тип рейтинга (good/bad)
*/
public function getRate($id, $type) {
if(!isset($id) || !is_numeric($id))
throw new publicException('Invalid object ID');

if(!isset($type))
throw new publicException('Invalid rate type');

$hierarchy = umiHierarchy::getInstance();
$element = $hierarchy->getElement($id);
$rate = $element->getValue($type);

return (int)($rate ? $rate : 0);
}
</source>
<p>
После этого, нужно добавить разрешения для макросов. Создайте файл "/classes/modules/vote/permissions.custom.php" с таким содержимым:
</p>
<p style="text-align: right;">
'''Листинг 2. Разрешения для макросов'''
</p>
<source lang="php">
<?php
$permissions = array(
'post' => array('setRate', 'getRate')
);
?>
</source>
<p>
Далее необходимо повесить обработчик на событие "click" для ссылок, которые будут устанавливать значение рейтинга. Для этого создайте файл "/js/rate.js" и напишите в него следующий код:
</p>
<p style="text-align: right;">
'''Листинг 3. Файл "rate.js"'''
</p>
<source lang="javascript">
jQuery(document).ready(function() {

jQuery('.vote').click(function() {
var cid = 'vote' + jQuery(this).attr('id');
if(jQuery.cookie(cid)) {
window.alert('Вы уже голосовали!');
return false;
}

var self = jQuery(this);
var parent = jQuery(this).parent();

var id = jQuery(this).attr('id');
var type = jQuery(this).attr('name');
var req = 'id=' + id + '&type=' + type;
var e = '.rate .' + type;

parent.animate({'opacity': 0.3}, 200);
jQuery.ajax({
type: 'POST',
url: '/udata/vote/setRate',
data: req,
cache: false,
})
.success(function(data) {
self.html(data);
parent.animate({'opacity': 1}, 200);
jQuery.cookie(cid, 'true', {'expires': new Date().getTime() - 1});
})
.error(function() {
window.alert('Ошибка! К сожалению, Ваш голос не будет учтён.');
jQuery(e).animate({'opacity': 1}, 200);
});
});

jQuery('.rate .good').hover(
function() {
jQuery(this).css('background-color', '#88D135');
},
function() {
jQuery(this).css('background-color', '#4AA735');
}
);

jQuery('.rate .bad').hover(
function() {
jQuery(this).css('background-color', '#FF7A32');
},
function() {
jQuery(this).css('background-color', '#FF2926');
}
);

});
</source>
<p>
Событие "click" будет обрабатываться у ссылок с классом "vote". Также в данном коде присутствует обработчики события "hover". Он срабатывает при наведении курсора мыши и меняет цвет кнопки рейтинга. По желанию, этот функционал можно удалить.
</p>
<p>
Осталось задать стиль панели рейтинга. Создайте файл "/css/rate.css" со следующим содержимым:
</p>
<p style="text-align: right;">
'''Листинг 4. Файл "rate.css"'''
</p>
<source lang="css">
.rate,
.good,
.bad
{
float: left;
}

.rate span
{
float: left;
margin: 2px 12px 4px 20px;
color: #4A89BA;
font-size: 12px;
font-weight: bold;
}

.good,
.bad
{
padding: 4px 12px;
text-align: center;
margin: 0 2px;
border-radius: 5px;
-moz-border-radius: 5px;
-webkit-border-radius: 5px;
}

.good a,
.bad a
{
color: #000;
font-weight: bold;
font-size: 15px;
text-decoration: none;
}

.good
{
background-color: #4AA735;
}

.bad
{
background-color: #FF2926;
}
</source>
<p>
Для примера, подключим панель рейтинга в стандартный XSLT-шаблон UMI.CMS "Интернер-магазин современный" (DemoDizzi). Откройте файл "/xsltTpls/layouts/default.xsl" и подключите созданные файлы "rate.js" и "rate.css" в секции "head" следующим образом:
</p>
<p style="text-align: right;">
'''Листинг 5. Подключение файлов "rate.js" и "rate.css"'''
</p>
<source lang="html4strict">

<script type="text/javascript" src="/js/rate.js"></script>
<link rel="stylesheet" type="text/css" href="/css/rate.css" />
</source>
<p>
После того, как файлы будут подключены, останется отредактировать шаблон вывода информации об объекте каталога. Откройте файл "/xsltTpls/modules/catalog/object-view.xsl" и разместите следующий код после блока "price", чтобы получилось примерно так:
</p>
<p style="text-align: right;">
'''Листинг 6. Размещение панели рейтинга в шаблоне'''
</p>
<source lang="html4strict">


<div class="price">
<span umi:element-id="{page/@id}" umi:field-name="price">
<xsl:apply-templates select="document(concat('udata://emarket/price/', page/@id))" />
</span>
</div>


<div class="rate">
<div class="good">
<a class="vote" id="{page/@id}" name="good" title="Хороший" href="javascript: void(0);">
<xsl:value-of select="document(concat('udata://vote/getRate/', page/@id, '/good/'))/udata" />
</a>
</div>
<div class="bad">
<a class="vote" id="{page/@id}" name="bad" title="Плохой" href="javascript: void(0);">
<xsl:value-of select="document(concat('udata://vote/getRate/', page/@id, '/bad/'))/udata" />
</a>
</div>
</div>
</source>
<table align="center">
<tr>
<td style="border: 1px solid black; padding: 5px;">
[[Файл:Rate-panel.png]]
</td>
</tr>
<tr>
<td style="font-color: darkblue; font-weight: bold; text-align: center;">
Панель рейтинга
</td>
</tr>
</table>
<table align="center" width="100%">
<tr>
<td style="border: 1px dotted black; padding: 20px;">
'''Важно'''.
<br />
<p>
Для работы представленной системы рейтинга в шаблон должны быть подключены библиотека jQuery и плагин jQuery Cookie. Если в шаблоне вызывается макрос includeQuickEditJs, то jQuery и jQuery Cookie подключатся автоматически.
</p>
</td>
</tr>
</table>
<table align="center" width="100%">
<tr>
<td style="border: 1px dotted black; padding: 20px;">
'''Примечание'''.
<br />
<p>
Данный функционал был проверен на работоспособность в версии системы 2.8.5.1.
</p>
</td>
</tr>
</table>

Файл:Rate-panel.png

2012-07-30T05:35:48Z

Kalexey:

Система рейтинга

2012-07-30T05:30:47Z

Kalexey:

[[category:Вопросы и уроки разработки сайтов на UMI.CMS]]
[[category:Написание кастомных макросов]]
<p>
'''Задача''':
</p>
<p>
Организовать систему рейтинга для объектов UMI.CMS.
</p>
<p>
'''Решение''':
</p>
<p>
Организуем рейтинг с использованием jQuery и Ajax на примере объектов каталога. В начале, необходимо отредактировать тип данных "Объект каталога": зайдите в модуль "Шаблоны данных", найдите тип данных "Объект каталога" и откройте его для редактирования. Нажмите кнопку "Добавить группу" и задайте имя группы, например - "Рейтинг". В созданной группе добавьте два поля типа "Число":
<ul>
<li>"Хороший" (good);</li>
<li>"Плохой" (bad).</li>
</ul>
</p>
<table align="center">
<tr>
<td style="border: 1px solid black; padding: 5px;">
[[Файл:Rate_fields.png]]
</td>
</tr>
<tr>
<td style="font-color: darkblue; font-weight: bold; text-align: center;">
Группа полей "Рейтинг"
</td>
</tr>
</table>
<p>
Теперь необходимо написать макросы, которые будут работать с данными полями. Откройте файл "/classes/modules/vote/__custom.php" и добавьте код макросов сразу же после строки "//TODO: Write your macroses here".
</p>
<p style="text-align: right;">
'''Листинг 1. Код макросов установки и получения рейтинга'''
</p>
<source lang="php">
/*
@title
Установка рейтинга объекта
*/
public function setRate() {
$id = (int)getRequest('id');
if(!isset($id) || !is_numeric($id))
throw new publicException('Invalid object ID');

$type = (string)getRequest('type');
if(!isset($type))
throw new publicException('Invalid rate type');

$hierarchy = umiHierarchy::getInstance();
$element = $hierarchy->getElement($id);
$rate = $element->getValue($type) + 1;
$element->setValue($type, $rate);
$element->commit();

echo $rate;
}

/*
@title
Получение рейтинга объекта
@param Integer
$id - идентификатор объекта
@param String
$type - тип рейтинга (good/bad)
*/
public function getRate($id, $type) {
if(!isset($id) || !is_numeric($id))
throw new publicException('Invalid object ID');

if(!isset($type))
throw new publicException('Invalid rate type');

$hierarchy = umiHierarchy::getInstance();
$element = $hierarchy->getElement($id);
$rate = $element->getValue($type);

return (int)($rate ? $rate : 0);
}
</source>
<p>
После этого, нужно добавить разрешения для макросов. Создайте файл "/classes/modules/vote/permissions.custom.php" с таким содержимым:
</p>
<p style="text-align: right;">
'''Листинг 2. Разрешения для макросов'''
</p>
<source lang="php">
<?php
$permissions = array(
'post' => array('setRate', 'getRate')
);
?>
</source>
<p>
Далее необходимо повесить обработчик на событие "click" для ссылок, которые будут устанавливать значение рейтинга. Для этого создайте файл "/js/rate.js" и напишите в него следующий код:
</p>
<p style="text-align: right;">
'''Листинг 3. Файл "rate.js"'''
</p>
<source lang="javascript">
jQuery(document).ready(function() {

jQuery('.vote').click(function() {
var cid = 'vote' + jQuery(this).attr('id');
if(jQuery.cookie(cid)) {
window.alert('Вы уже голосовали!');
return false;
}

var self = jQuery(this);
var parent = jQuery(this).parent();

var id = jQuery(this).attr('id');
var type = jQuery(this).attr('name');
var req = 'id=' + id + '&type=' + type;
var e = '.rate .' + type;

parent.animate({'opacity': 0.3}, 200);
jQuery.ajax({
type: 'POST',
url: '/udata/vote/setRate',
data: req,
cache: false,
})
.success(function(data) {
self.html(data);
parent.animate({'opacity': 1}, 200);
jQuery.cookie(cid, 'true', {'expires': new Date().getTime() - 1});
})
.error(function() {
window.alert('Ошибка! К сожалению, Ваш голос не будет учтён.');
jQuery(e).animate({'opacity': 1}, 200);
});
});

jQuery('.rate .good').hover(
function() {
jQuery(this).css('background-color', '#88D135');
},
function() {
jQuery(this).css('background-color', '#4AA735');
}
);

jQuery('.rate .bad').hover(
function() {
jQuery(this).css('background-color', '#FF7A32');
},
function() {
jQuery(this).css('background-color', '#FF2926');
}
);

});
</source>
<p>
Событие "click" будет обрабатываться у ссылок с классом "vote". Также в данном коде присутствует обработчики события "hover". Он срабатывает при наведении курсора мыши и меняет цвет кнопки рейтинга. По желанию, этот функционал можно удалить.
</p>
<p>
Осталось задать стиль панели рейтинга. Создайте файл "/css/rate.css" со следующим содержимым:
</p>
<p style="text-align: right;">
'''Листинг 4. Файл "rate.css"'''
</p>
<source lang="css">
.rate,
.good,
.bad
{
float: left;
}

.rate span
{
float: left;
margin: 2px 12px 4px 20px;
color: #4A89BA;
font-size: 12px;
font-weight: bold;
}

.good,
.bad
{
padding: 4px 12px;
text-align: center;
margin: 0 2px;
border-radius: 5px;
-moz-border-radius: 5px;
-webkit-border-radius: 5px;
}

.good a,
.bad a
{
color: #000;
font-weight: bold;
font-size: 15px;
text-decoration: none;
}

.good
{
background-color: #4AA735;
}

.bad
{
background-color: #FF2926;
}
</source>
<p>
Для примера, подключим панель рейтинга в стандартный XSLT-шаблон UMI.CMS "Интернер-магазин современный" (DemoDizzi). Откройте файл "/xsltTpls/layouts/default.xsl" и подключите созданные файлы "rate.js" и "rate.css" в секции "head" следующим образом:
</p>
<p style="text-align: right;">
'''Листинг 5. Подключение файлов "rate.js" и "rate.css"'''
</p>
<source lang="html4strict">

<script type="text/javascript" src="/js/rate.js"></script>
<link rel="stylesheet" type="text/css" href="/css/rate.css" />
</source>
<p>
После того, как файлы будут подключены, останется отредактировать шаблон вывода информации об объекте каталога. Откройте файл "/xsltTpls/modules/catalog/object-view.xsl" и разместите следующий код после блока "price", чтобы получилось примерно так:
</p>
<p style="text-align: right;">
'''Листинг 6. Размещение панели рейтинга в шаблоне'''
</p>
<source lang="html4strict">


<div class="price">
<span umi:element-id="{page/@id}" umi:field-name="price">
<xsl:apply-templates select="document(concat('udata://emarket/price/', page/@id))" />
</span>
</div>


<div class="rate">
<div class="good">
<a class="vote" id="{page/@id}" name="good" title="Хороший" href="javascript: void(0);">
<xsl:value-of select="document(concat('udata://vote/getRate/', page/@id, '/good/'))/udata" />
</a>
</div>
<div class="bad">
<a class="vote" id="{page/@id}" name="bad" title="Плохой" href="javascript: void(0);">
<xsl:value-of select="document(concat('udata://vote/getRate/', page/@id, '/bad/'))/udata" />
</a>
</div>
</div>
</source>
<table align="center">
<tr>
<td style="border: 1px solid black; padding: 5px;">
[[Файл:Rate_panel.png]]
</td>
</tr>
<tr>
<td style="font-color: darkblue; font-weight: bold; text-align: center;">
Панель рейтинга
</td>
</tr>
</table>
<table align="center" width="100%">
<tr>
<td style="border: 1px dotted black; padding: 20px;">
'''Важно'''.
<br />
<p>
Для работы представленной системы рейтинга в шаблон должны быть подключены библиотека jQuery и плагин jQuery Cookie. Если в шаблоне вызывается макрос includeQuickEditJs, то jQuery и jQuery Cookie подключатся автоматически.
</p>
</td>
</tr>
</table>
<table align="center" width="100%">
<tr>
<td style="border: 1px dotted black; padding: 20px;">
'''Примечание'''.
<br />
<p>
Данный функционал был проверен на работоспособность в версии системы 2.8.5.1.
</p>
</td>
</tr>
</table>

Макрос укорачивания URL

2012-07-30T04:56:44Z

Kalexey:

Макрос укорачивания URL

2012-07-30T04:48:46Z

Kalexey:

[[category:Написание кастомных макросов]]
[[category:Верстка в XSLT]]
[[category:Верстка в TPL]]
<p>
Данный макрос будет укорачивать переданный ему URL с помощью сервиса [http://www.tinyurl.com tinyurl.com]. Этот сервис не делает самый короткий URL, но его плюсом является то, что он не требует регистрации.
</p>
<p>
Тело макроса нужно будет разместить в файле "/classes/modules/content/__custom.php" после строки "//TODO: Write here your own macroses".
</p>
<p style="text-align: right">
'''Листинг 1. Код макроса'''
</p>
<source lang="php">
/*
@param String
$url - URL для укорачивания
*/
public function getTinyUrl($url) {
if($url)
return file_get_contents("http://tinyurl.com/api-create.php?url=".$url);
}
</source>
<p>
После того, как код макроса написан, необходимо добавить для него резрешение. Для этого создаём файл "permissions.custom.php" в той же папке, где находится "__custom.php", и пишем в нём следующий текст:
</p>
<p style="text-align: right">
'''Листинг 2. Добавление разрешения'''
</p>
<source lang="php">
<?php
$permissions = Array(
'content' =>
Array('getTinyUrl')
);
?>
</source>
<p>
Теперь можно использовать макрос. Вот примеры его использования в TPL и XSLT шаблонизаторах:
</p>
<p style="text-align: right">
'''Листинг 3. Использование макроса в TPL'''
</p>
<source lang="php">
%content getTinyUrl('http://www.umi-cms.ru/product/system/usability/')%
</source>
<p style="text-align: right">
'''Листинг 4. Использование макроса в XSLT'''
</p>
<source lang="html4strict">
<xsl:variable name="tinyurl"
select="document('udata://content/getTinyUrl/(http://www.umi-cms.ru/product/system/usability/)/)/udata" />
<a href="{$tinyurl}">UMI.CMS Usability</a>
</source>
<table align="center" width="100%">
<tr>
<td style="border: 1px dotted black; padding: 20px;">
'''Примечание'''.
<br />
<p>
Данный функционал был проверен на работоспособность в версии системы 2.8.5.1.
</p>
</td>
</tr>
</table>