Виджеты

Синтаксис: mm_ddMaxLength($fields, $roles, $templates, $length)

Описание параметров:

Пример: Подключение виджета для TV «Slogan», ограничив количество вводимых символов до 140

mm_ddMaxLength('Slogan', '', '', 140);

Синтаксис: mm_ddNumericFields($tvs, $roles, $templates, $allowFloat, $decimals)

Описание параметров:

Пример: Сделать возможным ввод только цифр с точностью в 2 знака после запятой в TV «price» для шаблонов c id, равным 15 или 16 и всех ролей

mm_ddNumericFields('price', '', '15,16', 1, 2);

Синтаксис: mm_hideTemplates($tplIds, $roles, $templates)

Описание параметров:

Пример: Скрыть шаблоны с id = 0 и 4 из списка во всех документах для пользователей с id роли = 1

mm_hideTemplates('0,4', '1');

Синтаксис: mm_hideFields($fields, $roles, $templates)

Описание параметров:

Пример: Скрыть поле «псевдоним» у документов с id шаблона = 3 для пользователей с id роли = 1

mm_hideFields('alias', '1', '3');

Синтаксис: mm_ddReadonly($fields, $roles, $templates)

Описание параметров: Значения отображаются при редактировании, но их невозможно изменить.

Довольно редко, но иногда бывают случаи, когда мы храним какую-то информацию о документе в его TV (например, количество просмотров или скачиваний, рейтинг и т.д.). Такая информация обновляется автоматически (какой-нибудь сниппет/плагин просто сохраняет значение в TV соответствующего документа). И вот Петя вдруг решил отредактировать текст документа: открыл, начал писать, его отвлекли по работе, потом позвонили, потом срочно пришлось уехать, два часа ездил, вернулся, продолжил редактировать. Всё это время документ у него был открыт, данные о количестве скачиваний уже 100 раз успели поменяться (было 3, а стало 33), но у Пети до сих пор отображается 3. Петя закончил свою работу, нажимает «Сохранить» и… количество скачиваний перезаписывается на 3! Неприятная ситуация. Что можно сделать? Вариант 1: можно сделать какую-нибудь супер-системную группу и выставить её для тех TV, значения которых не должны редактироваться пользователями. Неплохой вариант, но не надёжный (может найтись кто-то, кто поставит себе эту группу и обязательно что-то испортит) и не подходит, если хочется видеть эти данные при редактировании документа. Именно для таких случаев и предназначен этот виджет.

Работа виджета делится на 3 части:

Перед сохранением документа OnBeforeDocFormSave) получаются и запоминаются актуальные значения необходимых полей (из базы).

После сохранения (OnDocFormSave) записываются обратно.

JS делает поля визуально не редактируемыми.

Пример: Сделать поле TV «myVar» доступным только для чтения для пользователей с id роли = 2

mm_ddReadonly('myVar', '2');

Синтаксис: mm_requireFields($fields, $roles, $templates)

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

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

mm_requireFields('pagetitle,pub_date');

Синтаксис: mm_inherit($fields, $roles, $templates)

Описание параметров:

Пример: Выставлять всем новым документам заголовок как у родителя для пользователей с id ролью = 0 или 1

mm_inherit('pagetitle', '0,1');

Синтаксис: mm_default($fields, $value, $roles, $templates, $eval)

Описание параметров: Сейчас TV задаются как «tvN», где N – id TV.

Пример: Автоматически выставлять дату отмены публикации спустя 4 недели от текущей для документов с id шаблона = 4

mm_default('unpub_date', 'return date("d-m-Y H:i:s", now()+(60*60*24*28));', '', '4', true);

Синтаксис: mm_ddSetFieldValue($fields, $value, $roles, $templates)

Описание параметров: Похож на mm_default, но выставляет всегда.

Пример: У документов с шаблонами id = 1 и 3 выставить значение TV «someTv» в 'this is some' для редакторов (роль с id = 2)

mm_ddSetFieldValue('someTv', 'this is some', '2', '1,3');

Синтаксис: mm_synch_fields($fields, $roles, $templates)

Описание параметров: Например: чтобы заголовок и пункт меню документа были одинакомыми, – особенно удобно, когда одно из полей скрыто. Работает только с текстовыми полями (input, textarea).

Пример: Сделать значения этих полей всегда одинаковыми (для всех пользователей и документов)

mm_synch_fields('pagetitle,menutitle,longtitle');

Синтаксис: mm_renameField($fields, $newlabel, $roles, $templates, $newhelp)

Описание параметров:

Пример: Переименовать поле «заголовок» у документов с id шаблона = 3 для всех пользователей

mm_renameField('longtitle', 'ФИО', '', '3');

Синтаксис: mm_changeFieldHelp($field, $helptext, $roles, $templates)

Описание параметров:

Пример: Изменить подсказку для поля «псевдоним» у всех документов для пользователей с id роли = 3

mm_changeFieldHelp('alias', 'Это последний фрагмент адреса страницы', '3');

Синтаксис: mm_ddMultipleFields($tvs, $roles, $templates, $columns, $columnsTitle, $templates, $colWidth, $splY, $splX, $imgW, $imgH, $minRow, $maxRow, $columnsData)

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

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

Задание нескольких колонок разных типов (или одинаковых), например: изображения и подписи к ним (параметр «coloumns»).

Вывод заголовков колонок (параметр «coloumnsTitle»).

Количество значений (строк) может быть как фиксированным, динамичным, так и в определённых диапазонах (параметры «minRow» и «maxRow»).

Сортировка (перетаскивание) строк между собой.

Генерация уникального идентификатора каждой строки (параметр «coloumns»).

Вывод предопределённых списков значений (параметры «coloumns» и «coloumnsData»). Внимание, это пока в бете!

Для вывода данных используйте сниппет ddGetMultipleField.

Пример: Возможность добавления контактов сотрудников, но не более 5 и не меньше 2, с разными размерами колонок (для текстовой tv «employees»)

mm_ddMultipleFields('employees', '', '', 'text,text,text', 'Имя,Телефон,Должность', '250,100,100', '||', '::', 300, 100, 2, 5);

Синтаксис: mm_ddSelectDocuments($tvs, $roles, $templates, $parentIds, $depth, $filter, $max, $labelMask)

Описание параметров:

Пример:

mm_ddSelectDocuments();

Синтаксис: mm_widget_tags($fields, $delimiter, $source, $display_count, $roles, $templates)

Описание параметров: Для нужной TV автоматически формируется «список» выбора со всеми тегами, при этом, новые теги просто вписываются через разделитель здесь же) на странице редактирования документа. TV должна быть текстового типа.

Пример: Сделать для TV «docTags» виджет тегов с отображением количества документов, использующих каждый тег рядом с ним у документов с id шаблона = 2 для всех ролей

mm_widget_tags('docTags', ',', '', '1', '', '2');

Синтаксис: mm_widget_colors($fields, $default, $roles, $templates)

Описание параметров: Выбранный цвет сохраняется в TV в hex формате. TV должна быть текстового типа.

Пример: Добавить палитру выбора цветов для TV «bgcolor» у документов с id шаблона = 2 для пользователей с id роли = 1 и выставить чёрный цвет по умолчанию

mm_widget_colors('bgcolor', '#000000', '1', '2');

Синтаксис: mm_ddCreateSection($title, $id, $tabId, $roles, $templates)

Описание параметров:

Пример: Создать секцию с заголовком «Категории» в основной вкладке у всех документов для всех пользователей

mm_ddCreateSection('Категории', 'mycats');

Синтаксис: mm_ddMoveFieldsToSection($fields, $sectionId, $roles, $templates)

Описание параметров: К сожалению, невозможно переместить следующие поля: keywords, metatags, which_editor, show_in_menu, menuindex.

Пример: Переместить TV «profilePhoto» в секцию «images» для всех пользователей и шаблонов

mm_ddMoveFieldsToSection('profilePhoto', 'images');

Синтаксис: mm_hideSections($sections, $roles, $templates)

Описание параметров: «Секции» – это такие области на странице редактирования документа, например: «Содержимое ресурса» или «Параметры (TV)».

Пример: Скрыть секции «Содержимое ресурса» и «Параметры (TV)» у документов с id шаблона = 3 для пользователей с id роли = 1

mm_hideSections('content,tvs', '1', '3');

Синтаксис: mm_renameSection($section, $newlabel, $roles, $templates)

Описание параметров: «Секции» – это такие области на странице редактирования документа, например: «Содержимое ресурса» или «Параметры (TV)».

Пример: Переименовать секцию контента документа для пользователей с id роли = 2

mm_renameSection('content', 'Текстик (отображается на страничке)', '2');

Синтаксис: mm_createTab($name, $id, $roles, $templates, $intro, $width)

Описание параметров:

Пример: Создать новую вкладку шириной 450px с описанием у документов с id шаблона = 3 или 4

mm_createTab('SEO', 'seoTab', '', '3,4', '  Здесь вы можете отредактировать всё, что касается поисковой оптимизации. ', '450');

Синтаксис: mm_moveFieldsToTab($fields, $tabId, $roles, $templates)

Описание параметров: К сожалению, невозможно переместить следующие поля: keywords, metatags, which_editor, show_in_menu, menuindex.

Пример: Переместить дату публикации документа в основную вкладку для пользователей с id роли = 2

mm_moveFieldsToTab('pub_date', 'general', '2');

Синтаксис: mm_hideTabs($tabs, $roles, $templates)

Описание параметров:

Пример: Скрыть вкладку «Права доступа» у документов с id шаблона = 3 для пользователей с id роли = 1

mm_hideTabs('access', '1', '3');

Синтаксис: mm_renameTab($tab, $newlabel, $roles, $templates)

Описание параметров:

Пример: Переименовать вкладку «Общие» для пользователей с id роли = 2

mm_renameTab('general', 'Основное', '2');

Синтаксис: mm_ddGMap($tvs, $roles, $templates, $w, $h, $hideField)

Описание параметров: Начальная позиция карты задаётся очень просто: достаточно указать необходимые координаты в качестве «значения по умолчанию» соответствующей TV.

Пример: Подключение виджета Google Maps для TV «LatLng»

mm_ddGMap('LatLng');

Синтаксис: mm_ddYMap($tvs, $roles, $templates, $w, $h, $hideField)

Описание параметров: Для простого вывода карты на страницу используйте сниппет ddYMap. Начальная позиция карты задаётся очень просто: достаточно указать необходимые координаты в качестве «значения по умолчанию» соответствующей TV.

Пример: Подключение виджета Yandex Maps для TV «LngLat»

mm_ddYMap('LngLat');

Синтаксис: mm_widget_showimagetvs($fields, $maxWidth, $maxHeight, $thumbnailerUrl, $roles, $templates)

Описание параметров: Аналогичен плагину ShowImageTVs, который не совместим с ManagerManager.

Пример: Показать превью для TV «mypic» у документов с id шаблона = 2 и отправить за одно на генерацию в phpThumb для получения превьюшек размером 300×200 px

mm_widget_showimagetvs('mypic', '300', '200', '/assets/snippets/phpthumb/phpThumb.php', '', '2');

Синтаксис: mm_ddResizeImage($tvs, $roles, $templates, $width, $height, $cropping, $suffix, $replaceFieldVal, $background, $multipleField, $colNum, $splY, $splX, $num, $allowEnlargement)

Описание параметров: Виджет срабатывает только в момент сохранения документов (событие «OnBeforeDocFormSave») и не создаёт изображений повторно, что обеспечивает минимальный расход ресурсов сервера.

Пример: Создать для изображений, выставленных в TV «imageTV», уменьшенные копии, перезаписывая значения в TV

mm_ddResizeImage('imageTV', '', '', 200, 100, 'crop_resized', '_ddthumb', 1);

Синтаксис: mm_ddAutoFolders($roles, $templates, $yearsParents, $dateSource, $yearFields, $monthFields, $yearPublished, $monthPublished, $numericMonth)

Описание параметров:

Пример:

mm_ddAutoFolders();

Синтаксис: mm_ddFillMenuindex($parent)

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

Пример:

mm_ddFillMenuindex();

Синтаксис: mm_widget_accessdenied($ids, $default, $roles)

Описание параметров: Например, в родительском документе вызвыается сниппет «Ditto», и вы не хотите, чтобы пользователи редактировали этот документ, но хотите, чтобы пользователи могли создавать и редактировать дочерние документы.

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

Пример: Запретить доступ к документам с id = 1 и 15 пользователям с id роли = 2 и отобразить произвольное сообщение о запрете доступа

mm_widget_accessdenied('1,15', 'Этот документ запрещено редактировать. Давай, до свидания!' '2');

Синтаксис: mm_ddHTMLCleaner($fields, $roles, $templates, $validAttrsForAllTags, $validStyles, $validAttrs)

Описание параметров:

Пример:

mm_ddHTMLCleaner();