Процессоры в MODX

В MODX есть файлы-процессоры, это php скрипты, которые выполняют определенные функции. Загляните в /core/model/modx/processors, и вы увидите, как их много.

Работать с процессорами можно из любого сниппета или плагина при помощи метода runProcessor:

$response = $modx->runProcessor('action/path/to/processor',$arrayOfProperties,$otherOptions);

В ответ мы получаем объект modProcessorResponse, со всеми его методами.

Стандартные процессоры

К примеру, в директории security есть процессоры login и logout, которые управляют авторизацией юзеров. Вот как мы можем авторизовать юзера:

$username = 'bezumkin';
$password = '*********';
$data = array(
    'username' => $username,
    'password' => $password,
    'rememberme' => 1,
    'login_context' => 'web',
);    
$response = $modx->runProcessor('/security/login', $data);
if ($response->isError()) {
    $modx->log(modX::LOG_LEVEL_ERROR, 'login error. Username: '.$username.', Message: '.$response->getMessage());
}

Выход с сайта и того проще:

$response = $modx->runProcessor('/security/logout');
if ($response->isError()) {
    $modx->log(modX::LOG_LEVEL_ERROR, 'Logout error. Username: '.$modx->user->get('username').', uid: '.$modx->user->get('id').'. Message: '.$response->getMessage());
}

Именно так и сделана авторизация в моем компоненте Loginza.
Это очень удобно и гарантирует, что компонент будет работать во всех версиях MODX. Поэтому, если возможно, всегда нужно использовать стандартные процессоры.

Конечно, стандартные процессоры не умеют работать с вашими расширениями.

Собственные процессоры

Использование своих процессоров отличается от стандартных только тем, что нужно указать директорию, откуда их брать. Смотрим пример из miniShop:

// Массив, который мы передадим в процессор, там его ловить в $scriptProperties
$processorProps = array(
    'id' => 55
);
// Массив опций для метода runProcessor
$otherProps = array(
    // Здесь указываем где лежат наши процессоры
    'processors_path' => $modx->getOption('core_path') . 'components/minishop/processors/'
);
// Запускаем
$response = $modx->runProcessor('web/orders/getlist', $processorProps, $otherProps);
// И возвращаем ответ от процессора
return $response->response;

Это чуть измененный пример из сниппета miniShop, где он обрабатывает запросы личного кабинета.

Как вы видите, процессор для запуска указывается без расширения, путем от директории процессоров. Если мы не указываем свою директорию, то это будет /core/model/modx/processors/, по умолчанию. В моем примере — мы ее меняем на директории внутри компонента miniShop.

Стандартный процессор внутри собственного

Вот и сладкое! Смотрим пример:

$response = $modx->runProcessor('resource/create', $_POST);
if ($response->isError()) {
    return $modx->error->failure($response->getMessage());
}

$id = $response->response['object']['id'];

В этом примере мы создаем стандартным процессором новый ресурс из присланных данных, и получаем из ответа id этого ресурса, для дальнейшей работы. Потом уже мой процессор добавляет свойства товара к этому ресурсу.
Вот исходный код всего процессора miniShop для создания нового товара.

При таком подходе, опять же, мы гарантируем, что независимо от будущих изменений в MODX наш процессор будет работать во всех версиях. И, что очень важно, будет работать плагины, которые должны работать при создании новых ресурсов. Также будет сгенерирован alias (если вы их используете), причем как это указано в настройках, через транслитерацию, или нет.
Таким же образом работает и обновление товаров, а другой мой компонент mSearch, ловит событие OnDocFormSave и индексирует этот ресурс.

Конечно, можно не использовать в таких случаях runProcessor, а работать через newObject — но тогда нужно самостоятельно генерировать события для плагинов, определять незаданные поля нового ресурса, генерировать alias и еще много чего.
Зачем, если авторы MODX все для нас уже предусмотрели?

Заключение

Процессоры — отличная вещь и нужно использовать их по-максимуму, везде, во всех своих сниппетах. Если вы хотите сделать что-то с ресурсом или другим элементом — посмотрите, нет ли для этого готового процессора в системе?
Если есть — используйте его. Это оградит вас от лишней головной боли, и позволит другим расширениям и плагинам взаимодействовать с вашим кодом. Кстати, так и писать выходит меньше — запустил runProcessor, получил ответ и делай, что хочешь.

$this->modx->request->registerLogging($_POST);

public function prepareQueryBeforeCount(xPDOQuery $c)
    {
        $resource_id = intval($this->getProperty('resource_id'));
        $c->where(array('id' => $resource_id));
        return $c;
    }

<?php
class MyCompCreateProcessor extends modObjectCreateProcessor
{
    public $objectType = 'MyComp';
    public $classKey = 'MyComp';
    public $languageTopics = array('myc');
    //public $permission = 'create';



    /**
     * @return bool
     */
    public function beforeSet()
    {
        $name = trim($this->getProperty('name'));
        if (empty($name)) {
            $this->modx->error->addField('name', $this->modx->lexicon('myc_err_name'));
        } elseif ($this->modx->getCount($this->classKey, array('name' => $name))) {
            $this->modx->error->addField('name', $this->modx->lexicon('myc_err_ae'));
        }

        return parent::beforeSet();
    }

    $response = $modx->runProcessor('browser/file/upload', $_FILES);
    if ($response->isError()) {
    return $modx->error->failure($response->getMessage());
    }

}

return 'MyCompCreateProcessor';