method
public
DocumentTransformer::transform()
Сигнатура
public transform(int|string $file, array<string|int, mixed> $formats, string|array<string|int, mixed> $module, string|array<string|int, mixed> $callback[, array<string|int, mixed> $params = [] ]) : ResultОписание
Выполняет преобразование файла
Параметры
$file
int|string
ID из b_file или путь к файлу.
$formats
array<string|int, mixed>
Что делать с файлом.
$module
string|array<string|int, mixed>
Имя модуля (одно или несколько). Эти модули будут подключены перед функцией обратного вызова.
$callback
string|array<string|int, mixed>
Функция(и) обратного вызова для вызова с результатами.
$params
array<string|int, mixed>
= []
Дополнительные параметры.
Возвращаемое значение
Result
Как применяется в DocumentTransformer
DocumentTransformer::transform() — метод класса \Bitrix\Transformer\DocumentTransformer модуля «Конвертер файлов». DocumentTransformer: Класс Document
Высокоуровневая логика для работы с командами для документов.
Метод объекта: сначала нужен экземпляр DocumentTransformer.
use Bitrix\Main\Loader;
use Bitrix\Transformer\DocumentTransformer;
Loader::includeModule('transformer');
/** @var DocumentTransformer $object */
$file = 1;
$formats = [];
$module = '';
$callback = '';
$result = $object->transform($file, $formats, $module, $callback);
// $result: ResultДругие методы DocumentTransformer
call()Пример функции обратного вызова, которая будет вызвана после преобразования для обработки результатов.clearInfoCache()Очищает кеш информации о команде по $file.getTransformationInfoByFile()Получает информацию о последней команде преобразования файла.getTransformerCommandName()
transform() есть и у других классов модуля «Конвертер файлов»: FileTransformer, VideoTransformer.
Исходный файл: source/transformer/lib/documenttransformer.php:40
