Большой рассказ про pdoTools, часть первая

$pdoTools = $modx->getService('pdoTools');
$pdoFetch = $modx->getService('pdoFetch');

Ведение лога

• addTime(string $message) - добавляет новую запись в лог,

• getTime(bool $string [true]) - добавляет итоговое время и возвращает либо отформатированную строку (по умолчанию), либо массив время => сообщение.

$pdo = $modx->getService('pdoTools');
$pdo->addTime('pdoTools инициализирован');
print_r($pdo->getTime());

0.0000150: pdoTools инициализирован
0.0000272: Total time
1 572 864: Memory usage

Кэширование

• setStore(string $name, mixed $object, string $type ["data"])

• getStore(string $name, string $type ["data"])

foreach ($users as $id) {
    $user = $pdo->getStore($id, 'user')
    if ($user === null) {
        if (!$user = $modx->getObject('modUser', $id)) {
            $user = false;
        }
        $pdo->setStore($id, $user, 'user');
    }
    elseif ($user === false) {
        echo 'Не могу найти юзера с id = ' . $id;
    }
    else {
        echo $user->get('username');
    }
}

• setCache(mixed $data, array $options) - сохраняет данные $data в кэш, генерируя ключ из $options

• getCache(array $options) - выдает данные, согласно $options

$pdo = $modx->getService('pdoTools', array(
    'cache_key' => 'resource',
    'cache_handler' => 'xPDOFileCache',
    'cacheTime' => 10,
));

$pdo = $modx->getService('pdoTools');
$options = array(
    'user' => $modx->user->get('id'),
    'page' => @$_REQUEST['page'],
);
$pdo->addTime('pdoTools загружен');
if (!$data = $pdo->getCache($options)) {
    $pdo->addTime('Кэш не найден, генерируем данные');
    $data = array();
    for ($i = 1; $i <= 100000; $i ++) {
        $data[] = rand();
    }
    $data = md5(implode($data));
    $pdo->setCache($data, $options);
    $pdo->addTime('Данные сохранены в кэш');
}
else {
    $pdo->addTime('Данные загружены из кэша');
}
print_r($data);

0.0000281: pdoTools загружен
0.0004001: No cached data for key "default/e713939a1827e7934ff0242361c06b4b10c53d97"
0.0000079: Кэш не найден, генерируем данные
0.0581820: Saved data to cache "default/e713939a1827e7934ff0242361c06b4b10c53d97"
0.0000181: Данные сохранены в кэш
0.0586412: Total time
1 835 008: Memory usage

0.0000310: pdoTools загружен
0.0007479: Retrieved data from cache "default/e713939a1827e7934ff0242361c06b4b10c53d97"
0.0000081: Данные загружены из кэша
0.0007918: Total time
1 572 864: Memory usage

Утилиты

$data = array(
    'key1' => 'value1',
    'key2' => 'value2',
);

$pls = $pdo->makePlaceholders($data);
print_r($pls);

Array
(
    [pl] => Array
        (
            [key1] => [[+key1]]
            [!key1] => [[!+key1]]
            [key2] => [[+key2]]
            [!key2] => [[!+key2]]
        )

    [vl] => Array
        (
            [key1] => value1
            [!key1] => value1
            [key2] => value2
            [!key2] => value2
        )

)

$html = str_replace($pls['pl'], $pls['vl'], $html);

$pdo = $modx->getService('pdoFetch');
$resources = $pdo->getCollection('modResource');
$tree = $pdo->buildTree($resources);
print_r($tree);

Шаблонизация (работа с чанками)

• [[%tag]] - строка лексикона

• [[~id]] - ссылка

• [[+tag]] - обычные плейсхолдеры

• [[++tag]] - системные плейсхолдеры

• [[*tag]] - плейсхолдеры ресурса

• [[#tag]] - плейсхолдеры FastField

• Выводить поля ресурсов: [[#15.pagetitle]], [[#20.content]]

• Выводить ТВ параметры ресурсов: [[#15.date]], [[#20.some_tv]]

• Выводить поля товаров miniShop2: [[#21.price]], [[#22.article]]

• Выводить массивы ресурсов и товаров: [[#12.properties.somefield]], [[#15.size.1]]

• Выводить глобальные массивы: [[#POST.key]], [[#SESSION.another_key]]

• Распечатывать массивы для отладки: [[#15.colors]], [[#GET]], [[#12.properties]]

• @INLINE, @CODE - чанк создаётся из полученной строки.

• @FILE - чанк получается из файла. Для исключения инъекций, файлы могут быть только с расширением html и tpl, а директория для их выборки задаётся параметром $tplPath=`` в конфиге. По умолчанию, чанки выбираются из MODX_ASSETS_PATH . 'elements/chunks/'.

• @TEMPLATE - чанк создаётся из шаблона сайта, можно указывать его id или имя.

• @CHUNK или просто строка, без @префикса - выборка обычного чанка из БД.

$tpl = '@INLINE <p>[[+param]] - [[+value]]</p>';
$res = '';
for ($i = 1; $i <= 10000; $i++) {
    $pls = array('param' =>$i, 'value' => rand());
    $res .= $pdo->getChunk('test', $pls);;
}
echo '<pre>';
print_r($pdo->getTime());
print_r($res);

1. В чанке должен быть какой-то тег, например [[+tag]].

2. В чанке должен быть специальный html комментарий в таком виде:

<!--pdotools_tag значение, если тег не пуст-->
<!--pdotools_!tag значение, если тег пуст, появилось только в версии 1.9.3, выпущенной сегодня-->

$tpl = '@INLINE
<p>[[+tag]]</p>
<!--pdotools_tag [[+tag]] - значение, если тег не пуст-->
<!--pdotools_!tag значение, если тег пуст, появилось только в версии 1.9.3, выпущенной сегодня-->';

$pls = array('tag' => 1);
echo $pdo->getChunk($tpl, $pls);

$pls = array('tag' => 0);
echo $pdo->getChunk($tpl, $pls);

1 - значение, если тег не пуст

значение, если тег пуст, появилось только в версии 1.9.3, выпущенной сегодня

Заключение