Экспорт ресурсов

Для экспорта достаточно выбрать родительский ресурс в дереве, конфигурацию (нажав кнопку рядом, можно открыть файл конфигурации и отредактировать его), тип файла и нажать "Экспорт". Ссылка на созданный файл будет выведена тут же.

Импорт ресурсов

Для импорта необходимо выбрать родительский ресурс, конфигурацию (также можно отредактировать), загрузить и/или выбрать файл для импорта из списка (можно удалить файлы при необходимости) а также выбрать режим обработки галереи miniShop3, предварительно загрузив изображения в указанную в $impex_config['content_row'] директорию-источник:

• Не обрабатывать — скрипт не будет учитывать изображения в файле.
• Загружать только новые — для новых товаров будут загружены новые изображения, для существующих товаров оставлены старые и добавлены новые, если они есть в файле и директории-источнике.
• Обновить всё — для новых товаров будут загружены новые изображения, у существующих галерея сперва будет очищена, а потом загружены новые, указанные в файле, изображения.

Все операции производятся стандартными процессорами miniShop3 gallery/upload и gallery/removeall. Данные процессы достаточно ресурсоёмки, поэтому используйте обработку галереи в соответствии с мощностью вашего сервера.

После успешной обработки галереи все указанные в файле импорта исходники из директории-источника удаляются.

Дополнительно можно отметить опции:

Восстановление из резервной копии

На вкладке можно выбрать нужную резервную копию и восстановить данные из неё. Данный процесс необратим, так что будьте внимательны.

Конфигурации импорта/экспорта представляют собой php-файлы в директории {core_url}components/impex/config/ (примеры идут в комплекте) такого вида:

<?php
$impex_config['content_row'] = [
    ['Категории', 5, 'categories'],
    ['Наименование', 'pagetitle', 'resource'],
    ['Артикул', 'article', 'ms'],
    ['Расширенный заголовок', 'longtitle', 'resource'],
    ['Краткое описание', 'introtext', 'resource'],
    ['Содержимое', 'content', 'resource'],
    ['Цена', 'price', 'ms'],
    ['Производитель', 'vendor', 'ms'],
    ['Новинка', 'new', 'ms'],
    ['Теги', 'tags', 'ms'],
    ['Цвет', 'color', 'ms'],
    ['Материал', 'material', 'msoption'],
    ['На складе', 1, 'tv'],
    ['Галерея', 'images/import/', 'msgallery'],
    ['Дополнительные категории', '', 'mscats'],
];
        
//значения по умолчанию при импорте или проверка при экспорте
$impex_config['content_default'] = [
    ['template', 2],
];
        
// класс товаров (msProduct / modResource)
$impex_config['resource_class'] = 'msProduct';
    
// класс категорий (msCategory / modResource / CollectionContainer)
$impex_config['category_class'] = 'msCategory';
        
// поле идентификации категории (если указывается напрямую, а не цепочкой)
$impex_config['category_id_field'] = '';
        
// по какому полю проверять соответствие товара при обновлении. 
$impex_config['chk_field'] = array('pagetitle','resource');
        
// пропускать несуществующие ресурсы (только обновление, без создания). 
$impex_config['skip_new'] = false;
        
// первая строка - названия полей
$impex_config['include_captions'] = true;
        
// разделители для MIGX-полей в файле array('между элементами', 'между полями внутри элемента')
$impex_config['migx_separators'] = array('||','--');
        
// количество ресурсов, импортируемых за один проход. 0 - не ограничивать.
$impex_config['batch_import'] = 100;
        
// на основании какого поля генерировать псевдоним (alias) при импорте (оставьте пустым, если alias указан в файле)
$impex_config['alias_field'] = 'pagetitle';

В файле должен присутствовать массив $impex_config со следующими ключами и значениями:

$impex_config['content_row']

Настройка колонок в файле и их связь с полями и типом, где данные указываются в виде:

array('Название колонки', 'ID или имя поля в базе', 'Тип данных', array('поля MIGX')),

Поддерживаемые типы данных

array('Характеристики','chars', 'migx', array('title','value')),

Материал = Хлопок
Цвет = Зелёный
Размер = XL

[
    {"MIGX_id":0,"title":"Материал","value":"Хлопок"},
    {"MIGX_id":1,"title":"Цвет","value":"Зелёный"},
    {"MIGX_id":2,"title":"Размер","value":"XL"}
]

image01.jpg||image02.jpg||image03.jpg||image04.jpg||image05.jpg||image06.jpg

array('Галерея','images/import/','msgallery'),

array('Галерея','','msgallery'),

assets
  images
    products
      25
        small/
        webp/
        01.jpg
        02.jpg
        03.jpg

images
  import
    25
      01.jpg
      02.jpg
      03.jpg

array('Галерея','images/import/','msgallery'),

array('Дополнительные категории','|','mscats'),

Другие настройки

$impex_config['content_default']

Значения по умолчанию при импорте и экспорте:

$impex_config['content_default'] = [
    [ 'template',6 ], // ID шаблона ресурса
    [ 'published',1 ], // Опубликован
    [ 'show_in_tree',1 ], // Виден в дереве
];

Если значения не указаны ни тут, ни в основной разбивке колонок (а их, естественно, можно добавить в $impex_config['content_row'] напрямую: array('Публиковать','published','resource'), скрипт проверит наличие системных настроек и настроек miniShop3 для товаров (шаблон товара, публикацию, видимость в дереве).

$impex_config['resource_class']

Класс ресурса. Для товаров miniShop3 используйте msProduct, для стандартных ресурсов MODX — modResource.

$impex_config['category_class']

Класс категории. Для категорий miniShop3 используйте msCategory, для стандартных ресурсов MODX — modResource и CollectionContainer для коллекций, если установлен компонент Collections.

$impex_config['category_id_field']

Поле, по которому ищется родитель (категория) при импорте.
Используется, если категории указываются не цепочкой, а напрямую.

$impex_config['chk_field']

Поле, по которому ищется ресурс при импорте. Указывается в формате:

 array('название поля', 'тип поля');

Если тип ms или tv, поиск идёт просто по значению (соответственно, они должны быть уникальными). Если используете resource (например, pagetitle), то ещё учитывается родитель.

Например, для товаров miniShop3 можно использовать артикул:

$impex_config['chk_field'] = array('article','ms');

$impex_config['skip_new']

Пропускать ли несуществующие ресурсы. Если true скрипт не будет создавать новые ресурсы, а только обновлять существующие.

$impex_config['include_captions']

Идут ли первой строкой в файле названия полей true/false.

$impex_config['migx_separators']

Разделители для MIGX-полей.
Первый элемент массива — разделитель между элементами, второй — между полями внутри элемента:

$impex_config['migx_separators'] = array('||','--');

Тут MIGX-TV, содержащее элементы, состоящие из полей image, title, text и link:..

array('Преимущества','benefits','migx',array('image','title','text','link')),

...запишется в файл в виде:

icons/icon01.svg--Низкие цены--Мы держим низкие цены--[[~5]]||icons/icon02.svg--Богатый опыт--У нас большой опыт--[[~6]]

$impex_config['batch_import']

Количество товаров, обрабатываемых при импорте за один проход (0 — без ограничений).
Уменьшите, если сервер не успевает обрабатывать указанное кол-во товаров за раз (актуально при включенной обработке галереи miniShop3).

$impex_config['alias_field']

Какое поле использовать для генерации псевдонима при создании нового ресурса.

Если оставить пустым, псевдоним не генерируется (например, если в $impex_config['content_row'] прямо указываете alias:

array('Псевдоним','alias','resource'),

При установке пакета создаются следующие системные события:

$config_name - имя файла конфигурации
$id - ID ресурса
$field - имя поля
$type - тип поля
$value - значение

switch ($modx->event->name){
    case 'OnImpexBeforeResourceExport':
        if($field == 'pagetitle') $value = $value.'-'.$id;
        $modx->event->returnedValues['value'] = $value;
    break;
}

$config_name - имя файла конфигурации
$config - массив полей из конфигурации
$data - массив данных ресурса из файла

switch ($modx->event->name){
    case 'OnImpexBeforeResourceExport':
        if($data[1] == 'Продукт1'){
                $config[] = ['Вес без упаковки', 3 , 'tv'];
                $data[] = '125';
            }
            $output = [
                'config' => $config,
                'data' => $data
            ];
            $modx->event->returnedValues['output'] = $output;
    break;
}

$config_name - имя файла конфигурации
$category - строка категорий из файла
$category_id_field - значение параметра конфигурации category_id_field (идентификатор для определения категории)

switch ($modx->event->name){
    case 'OnImpexBeforeSetParentProduct':
        if($category_id_field != ''){
            $categories = 'Категория1||Категория2||Категория3';
            $modx->event->returnedValues['categories'] = $categories;
        }
    break;
}

$config_name - имя файла конфигурации
$id - ID ресурса
$field - имя поля
$type - тип поля
$value - значение

$config_name - имя файла конфигурации.
$id - ID импортированного ресурса.
$data - поля/значения импортированного ресурса.

switch ($modx->event->name){
    case 'OnImpexAfterResourceImport':
        if($resource = $modx->getObject('modResource', $id)){
            $resource->set('alias', 'resource-'.$id);
            $resource->save();
        }
    break;
}

$config_name - имя файла конфигурации.
$ids - массив ID всех импортированных ресурсов.

switch ($modx->event->name){
    case 'OnImpexAterAllImport':
        foreach($ids as $id){
            if($resource = $modx->getObject('modResource', $id)){
                $resource->set('published', 1);
                $resource->save();
            }
        }
    break;
}

Запуск удобнее осуществлять посредством CronManager или Scheduler.

CronManager

Для работы через CronManager на сервере нужно добавить CRON-задание для запуска скрипта {assets_url}components/cronmanager/cron.php (подробности в документации).

При создании новой задачи в CronManager, выберите сниппет ImpexCRON, который идёт в комплекте с Impex, настройте расписание и укажите параметры запуска:

parent: 25
config: resource
file: import.xlsx
gallery: new

В данном случае в качестве родителя будет выбран ресурс с ID = 25, конфигурация resource.php, файл import.xlsx, который нужно предварительно загрузить в директорию {assets_url}/components/impex3/files/ и режим обработки галереи miniShop3 (new - только новые, refresh - перезапись, если параметр не указывать, галерея не обрабатывается).

Scheduler

Для запуска через Scheduler также нужно на сервере создать CRON-задание на запуск скрипта {assets_url}components/scheduler/run.php и далее настроить задания в приложении: