Примеры работы с API MODX

Как получить массив при запросе к базе через API MODx.

Запрос к базе типа $modx->query($query). В примере получаем список шаблонов.

$sQuery = "SELECT id, templatename FROM ". $modx->getOption('table_prefix') ."site_templates";
$result = $modx->query($sQuery);
$res = $result->fetchAll(PDO::FETCH_ASSOC);
return $res;

$ids = array(3,15,95);
$resources = $this->modx->getCollection('modResource',array('id:IN' => $ids));
foreach($resources as $res){
  $pagetitle = $res->get('pagetitle');
  $res->set('pagetitle', str_replace("Владимир Путин", "Максим Кац", $pagetitle));
  // получить TV полученного ресурса
  $tv_bio =  $res->getTVValue('bio');
  // Установить TV
  $res->setTVValue('bio', 'This is my new bio...');
  $res->save();
}

Еще один способ удалить ресурс — сделать это через процессор:

$id = 3;
$modx->runProcessor('resource/delete', array('id' => $id));

// id текущего ресурса
$id = $modx->resource->get('id'); 

// получить ресурс
$page = $modx->getObject('modResource', 555);
// получить поле полученного ресурса
$pagetitle = $page->get('pagetitle');
// получить TV полученного ресурса
$tv_bio =  $page->getTVValue('bio');
// Установить TV
$page->setTVValue('bio', 'This is my new bio...');
// Сохранить
$page->save();

// Сделать URL для ресурса с id 4
$url = $modx->makeUrl(4);
//перенаправить на страницу
$modx->sendRedirect($url);

//Получить префикс таблицы бд
$modx->getOption('table_prefix')

//Записать в лог:
$modx->log(xPDO::LOG_LEVEL_ERROR, 'There was a problem saving your TV...');

//Получить id (и рне только) пользователя
$user = $modx->getUser();
$user->get('id');
$user->get('username');

//Получить текущий ресурс из плагина
$resource->get('id');

// Вывести чанк (Второй аргумент - массив с параметрами, которые будут доступны через плейсхолдеры в чанке)
$output = $modx->getChunk('ChunkName',array('name' => 'John'));
// Отобразить 404 ошибку
$modx->sendErrorPage();

Как изменить несколько ресурсов. В данном примере помечаем ресурсы как удаленные. Через конструкцию типа $res->set('deleted', 1) вносить изменения в таблицу [prefix]site_content. Ее структуру можно посмотреть в phpMyAdmin. Чтобы получуть значение поля нужно написать $res->get('pagetitle').

[[!+modx.user.id:memberof=`Administrator`:then=`Что-то для админа`:else=`style="display:none;"`]]

Вывести ошибки при тестировании плагина в MODx

В частности для события OnDocFormSave была у меня актуальна проблема — при сохранении ресурса в консоль браузера выбрасывалась ошибка и все, и ничего. Дабы решить эту проблему следует: открыть файл manager/assets/ext3/ext-all.js, найти там false)}}},success:function(b){var a=this.processResponse(b) и добавить туда false)}}},success:function(b){console.log(b);var a=this.processResponse(b)

Получить TV с разделителем

$c = array(
    'tmplvarid' => $tmplvarid,
    'contentid' => $pageid
    );
$tvr = $modx->getObject('modTemplateVarResource', $c);
if ($tvr) {
    $raw_tv = explode('||',$tvr->get('value'));
    return $raw_tv[0]; // первый в списке
}

вызвать снипеет в другом снипеете через API MODx

echo $modx->runSnippet('mFilter2',array(
    'parents' => '0'
    ,'element' => 'msProducts'
    ,'limit' => '10'
    ,'includeThumbs' => '360x270'
    ,'includeTVs' => $inclide_tvs
    ,'filters' => implode(",", $mFilter2_filters)
    ,'where' => $msProducts_where
));
return;

Генерация ссылок

// Сделать URL для ресурса с id 4
$url = $modx->makeUrl(4);
$modx->makeUrl(4, '','', 'full'); // [[~4? &scheme=`full`]]

• [[~[[*id]]]] — Ссылка на текущий ресурс. Пример: api-modx-tips.html
• [[~54]] — Ссылка на какой-то ресурс. Пример: migx-magic.html
• [[~[[*id]]? &scheme=`full`]] — Абсолютная ссылка на ресурс, на основе настройки site_url. Пример: https://webstool.ru/api-modx-tips.html
• {$_modx->makeUrl(10)} — В феном

Запросы $modx->newQuery

Выборка ресурсов

$q = $modx->newQuery('modResource');
$q->where(array(
  'template:IN' => array(1)
  ));
$q->select(array(
  'id'
  ,'menutitle'
));
$q->prepare();
$q->stmt->execute();
$res = $q->stmt->fetchAll(PDO::FETCH_ASSOC);
foreach($res as $v){
  print_r($v);
}

Выборка из одной таблицы с зацепкой значения из другой. А данном случае - выборка ресурсов и доп. полей

$q = $modx->newQuery('modResource');
$q->leftJoin('modTemplateVarResource', 'TV1', 'modResource.id = TV1.contentid AND TV1.tmplvarid = 5');
$q->leftJoin('modTemplateVarResource', 'TV2', 'modResource.id = TV2.contentid AND TV2.tmplvarid = 4');
$q->where(array(
  'modResource.template:IN' => array(2)
));
$q->select(array(
  'modResource.id as id'
  ,'modResource.menutitle as menutitle'
  ,'TV1.value as TV1_value'
  ,'TV2.value as TV2_value'
));
$q->prepare();
$q->stmt->execute();
$res = $q->stmt->fetchAll(PDO::FETCH_ASSOC);
print_r($res);

Подготовить и выполнить безопасный запрос

$statement = $modx->prepare('SELECT * FROM log_404 WHERE uri = :uri');
if ( $statement->execute(array('uri'=>$_GET['q'])) ) {
  $res = $statement->fetchAll(PDO::FETCH_ASSOC);
}