ddTools

Library
  • Версия: 0.1
  • Выпущено:
  • Метки: General
Скачать23 скачивания

Описание

Библиотека с различными небольшими инструментами, облегчающими работу. Умеет:

  • Создавать новый документ;
  • Обновлять информацию о существующем документе;
  • Парсить текст (почти как modx->parseChunk, только принимает текст, а не имя чанка);
  • Парсить ресурс (вызывается $modx->parseDocumentSource и $modx->rewriteUrls);
  • Генерировать случайную строку нужной длины.

Список изменений

  • Первая версия.

Документация

Для установки распакуйте архив в корень сайта (файл modx.ddtools.class.php должен находиться в папке assets/snippets/ddTools/). Вообще говоря, библиотека очень проста, так что, если что, посмотрите в исходный код и вы всё поймёте.

Все методы являются публичными, статичными и объявляются в классе «ddTools».

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

Название Описание Допустимые значения Значение по умолчанию

Метод «createDocument»

fields* Массив полей документа (в таблице `site_content`). Ключ — название поля, значение — значение. Обязательно должен присутствовать заголовок нового документа (элемент 'pagetitle'). {array: associative}
groups Индексированный массив id групп, к которым должен принадлежать документ. {array}

Метод «udateDocument»

id* ID документа, который необхоидмо отредактировать. {integer} 0
update* Массив значений полей документа (в таблице `site_content`). Ключ — название поля, значение — значение. {array: associative}
where SQL условие WHERE. {string: sql}

Метод «parseText»

chunk* Строка, которую нужно парсить. {string}
chunkArr* Массив значений. Ключ — имя плэйсхолдера, значение — значение. {array: associative}
prefix Префикс плэйсхолдеров. {string} '[+'
suffix Суффикс плэйсхолдеров. {string} '+]'

Метод «parseSourse»

sourse* Текст для парсинга. {string}

Метод «generateString»

length Размер строки на выходе. {integer} 8
chars Набор символов для генерации {string} 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ123456789'

Примеры

Создание опубликованного документа с шаблоном 36 в корне сайта (+ запомним id созданного документа)

$id = ddTools::createDocument(array('pagetitle' => 'Test document', 'template' => 36, 'published' => 1));

Обновление заголовка документа и заголовка меню у документа

ddTools::udateDocument($id, array('pagetitle' => 'Tested document', 'menutitle' => 'Omg'));

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

ddTools::parseText('<div>[+test1+], [+test2+]</div>', array('test1' => 'Hello', 'test2' => 'world'));