ExtraFields. Дополнительные поля для ресурса (modResource) и пользователя (modUserProfile).

Привет, друзья!
Представляю компонент, который предназначен для добавления новых полей в ресурсе и профиле пользователя. Работает в MODx 2 / 3.

Ресурс (modResource)

При создании поля добавляется соответствующая колонка в таблице site_content (modResource).
При обновлении можно изменить все, кроме название самого поля в таблице.
При удалении удаляется колонка в таблице.

Настройка поля

• Имя поля — название колонки в таблице.
• Название поля — заголовок поля, которое отображается над полем.
• Расположение — место где будет вставлено поле. Главная вкладка ресурса имеет 2 колонки: левая (modx-resource-main-left) и правая (modx-resource-main-right). Вы можете разместить поле в любую колонку или в свою вкладку.
• Индекс — позиция поля по отношению к другим полям. Если 0, то поле будет отображаться в самом вверху, выше всех других полей в этой колонке или вкладке.
• Тип поля — тип отображаемого поля. Это может быть текстовое или числовое поле, может быть чекбокс и т.д. Смотрите в разделе **Поля**.
• Обязательное поле — не дает ресурсу сохраниться, если поле будет не заполнено.
• Включено — показывать поле в ресурсе или нет.

Вкладки ресурса

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

Настройка вкладки

• Название — название вкладки
• Позиция — позиция вкладки по отношению к другим вкладкам. 0 — будет отображено в самом начале, а 99 — в самом конце.
• Включено — показывать вкладку в ресурсе или нет.

Профиль пользователя (modUserProfile)

При создании поля добавляется соответствующая колонка в таблице user_attributes (modUserProfile).

Настройка поля

• Имя поля — название колонки в таблице.
• Название поля — заголовок поля, которое отображается над полем.
• Расположение — место где будет добавлено поле на главной вкладке профиля пользователя.
• Индекс — позиция поля по отношению к другим полям. Если 0, то поле будет отображаться в самом вверху, выше всех других полей в этой колонке или вкладке.
• Тип поля — тип отображаемого поля. Это может быть текстовое или числовое поле, может быть чекбокс и т.д. Смотрите в разделе **Поля**.
• Обязательное поле — не дает пользователю сохраниться, если поле будет не заполнено.
• Включено — показывать поле в профиле или нет.

Поля

Таблица возможных типов полей. Для редактирование нужно перейти в панель администрирования.
Доступные поля:

• textfield
• textarea
• richtext (textarea + editor)
• numberfield
• xcheckbox
• combo-boolean
• datefield
• timefield
• xdatetime (datefield + timefield)
• displayfield
• readonly (textfield + readOnly true)

Также вы можете добавлять свои поля.

Настройка поля

• Название — xtype поле
• dbtype — тип поля в базе данных
• precision — размер поля
• phptype — тип переменной в php
• null — может ли поле иметь значение null или нет.
• default — значение по умолчанию

Совместимость

Компонент совместим с MODx 3 благодаря алиасам. В комментарии файла пишут, что в будущем, в версии 3.3 или 3.4, данный файл не будет автоматически подключаться. Я уверен, что это будущее не наступит в ближайшее пол года, поэтому можно спокойно делать компоненты совместимые с обоими версиями. Но, это чисто мое мнение, авторы сами решают как делать свои компоненты.

Проблемы

А вот с какими проблемами столкнулся я.

1. Карта классов
Все помнят статью Васи Наумкина Расширение любых таблиц MODX

Вот код для MODx 2:

<?php
switch ($modx->event->name) {
	case 'OnMODXInit':
		$modx->loadClass('modResource');
		$modx->map['modResource']['fields']['manager_id'] = 0;
		$modx->map['modResource']['fieldMeta']['manager_id'] = array(
			'dbtype' => 'int',
			'precision' => 10,
			'attributes' => 'unsigned',
			'phptype' => 'integer',
			'null' => true,
			'default' => 0,
		);
		break;
}

Но в MODx 3 такое не работает, из-за того, что $modx->map — это уже не массив, а объект, который реализован через интерфейс ArrayAccess. Спасибо @Сергей Шлоков
Вот сам класс — github.com/modxcms/xpdo/blob/3.x/src/xPDO/xPDOMap.php
Он позволяет работать с объектом как с одномерным массивом, поэтому решение для MODx 3 такое:

<?php

use MODX\Revolution\modResource;

switch ($modx->event->name) {
	case 'OnMODXInit':
                // Сохраняем карту класса в переменную
		$map = $modx->map[modResource:class];
                
                // Теперь работаем с данной переменной
		$map['fields']['manager_id'] = 0;
		$map['fieldMeta']['manager_id'] = array(
			'dbtype' => 'int',
			'precision' => 10,
			'attributes' => 'unsigned',
			'phptype' => 'integer',
			'null' => true,
			'default' => 0,
		);
                
                // Обновляем нашу карту класса.
                $modx->map[modResource:class] = $map;
		break;
}

2. getService
Решил это, думал, что уже все, но нет! @Павел Бигель написал в телеграмм чате, что метод getService будет удален в версии 3.1, а это уже не за горами. Поэтому пришлось переделывать, подключать автозагрузку класса и заменить

вот это

$extrafields = $modx->getService('extrafields', 'ExtraFields', MODX_CORE_PATH . 'components/extrafields/model/');

на это:

if ($modx->services instanceof Psr\Http\Client\ClientInterface) {
    $extrafields = $modx->services->get('extrafields');
} else {
    $extrafields = $modx->getService('extrafields', 'ExtraFields', MODX_CORE_PATH . 'components/extrafields/model/');
}

Таким образом, для MODx 3 мы используем контейнер зависимости, а во 2 версии метод getService.

3. Текстовый редактор.
Следующая проблема была с текстовым редактором, дело в том, что если добавить данное поле (richtext) в ресурс то при сохранении ресурса будет ошибка связана с экранированием символов, хотя все поля будут сохранены.
Начинаем изучать код процессора update для ресурса и видим, что проблема в этом:

$returnArray = $this->object->get(array_diff(array_keys($this->object->_fields), array('content','ta','introtext','description','link_attributes','pagetitle','longtitle','menutitle', 'properties', 'resource_groups')));
foreach ($returnArray as $k => $v) {
  if (strpos($k,'tv') === 0) {
        unset($returnArray[$k]);
    }
}

...
return $this->success('',$returnArray);

То есть все стандартные поля и TV вырезаются, поэтому TV c типом richtext работает без ошибок. Этот метод вызывается после сохранения объекта, значит нужно чтобы эти поля не участвовали в формирование массива $returnArray.
Первое что в голову пришло, это очистить новые поля с типом richtext после сохранения ресурса:

if ($modx->event->name == 'OnDocFormSave') {
    $resource->set('customfield', '');
}

И да, это сработало! Но, если указать парный тег в простом поле, то снова получим ошибку((
Тогда, посмотрев внимательно, нашел решение:

if ($modx->event->name == 'OnDocFormSave') {
    unset($resource->_fields['customfield']);
}

Вот и все, проблема решена. Если у кого-то есть другое решение, то пишите в комментарии.

Buy me a coffee

Компонент можно скачать бесплатно с официального репозитория или модстора.
Если компонент был вам полезен, то вы можете угостить меня чашечкой кофе.

Uncaught TypeError: Cannot read properties of null (reading 'match')
    at a.$detectNewLine (ace.min.js?v=2.9.3-pl:1:120718)
    at a.insert (ace.min.js?v=2.9.3-pl:1:122464)
    at a.setValue (ace.min.js?v=2.9.3-pl:1:120356)
    at p.setValue (ace.min.js?v=2.9.3-pl:1:153026)
    at S.setValue (modx.texteditor.js?v=2.9.3-pl:185:38)
    at constructor.setValues (ext-all.js:21:603600)
    at miniShop2.panel.UpdateCategory.setup (modx.panel.resource.js?v=2.9.3-pl:57:28)
    at h.Event.fire (ext-all.js:21:3699)
    at miniShop2.panel.UpdateCategory.fireEvent (ext-all.js:21:687)
    at MODx.FormPanel [as constructor] (modx.panel.js:62:14)

No foreign key definition for parentClass: efFieldAbs using relation alias: Tab

2024/09/03 14:28:11 [error] 1762146#1762146: *32171 FastCGI sent in stderr: "PHP message: PHP Fatal error:  Uncaught Error: Call to undefined method ExtraFields::getTableFields() in /var/www/site_user/data/www/site.ru/core/cache/includes/elements/modplugin/53.include.cache.php:44
Stack trace:
#0 /var/www/site_user/data/www/site.ru/core/model/modx/modscript.class.php(76): include()
#1 /var/www/site_user/data/www/site.ru/core/model/modx/modx.class.php(1674): modScript->process(NULL)
#2 /var/www/site_user/data/www/site.ru/core/model/modx/modx.class.php(570): modX->invokeEvent('OnMODXInit', Array)
#3 /var/www/site_user/data/www/site.ru/manager/index.php(53): modX->initialize('mgr')
#4 {main}
  thrown in /var/www/site_user/data/www/site.ru/core/cache/includes/elements/modplugin/53.include.cache.php on line 44" while reading response header from upstream, client: 10.10.10.10, server: site.ru, request: "GET /manager/?a=workspaces HTTP/2.0", upstream: "fastcgi://unix:/var/run/site.ru.sock:", host: "site.ru", referrer: "https://site.ru/manager/?"

Error 42S22 executing statement:
INSERT INTO `modx_ef_fields` (`class_name`, `field_name`, `field_type`, `field_null`, `field_index`, `field_default`, `menuindex`, `active`) VALUES ('modUserProfile', 'agreed', 'xcheckbox', 0, 0, '0', 0, 1)
Array
(
    [0] => 42S22
    [1] => 1054
    [2] => Unknown column 'field_index' in 'field list'
)