Bitrix API

TransformerManager implements InterfaceCallback

FinalYes

Table of Contents

Interfaces

InterfaceCallback

Constants

ERROR_CODE_TRANSFORM_FORMATS_FILLED  = 'TRANSFORM_FORMATS_FILLED'
ERROR_CODE_TRANSFORM_FORMATS_PROCESSED  = 'TRANSFORM_FORMATS_PROCESSED'
PATH  = 'documentgenerator_preview'
QUEUE_NAME  = 'documentgenerator_create'

Methods

__construct()  : mixed
addToStack()  : mixed
call()  : bool|string
Function to process results after transformation.
getLastTransformationResult()  : Result|null
getPullTag()  : null|string
transform()  : Result

Constants

ERROR_CODE_TRANSFORM_FORMATS_FILLED

public mixed ERROR_CODE_TRANSFORM_FORMATS_FILLED = 'TRANSFORM_FORMATS_FILLED'

ERROR_CODE_TRANSFORM_FORMATS_PROCESSED

public mixed ERROR_CODE_TRANSFORM_FORMATS_PROCESSED = 'TRANSFORM_FORMATS_PROCESSED'

Methods

__construct()

public __construct(Document $document) : mixed
Parameters
$document : Document

addToStack()

public static addToStack(array<string|int, mixed> $data) : mixed
Parameters
$data : array<string|int, mixed>

call()

Function to process results after transformation.

public static call(int $status, string $command, array<string|int, mixed> $params[, array<string|int, mixed> $result = array() ]) : bool|string
Parameters
$status : int

Status of the command.

$command : string

Name of the command.

$params : array<string|int, mixed>

Input parameters of the command.

$result : array<string|int, mixed> = array()

Result of the command from controller Here keys are identifiers to result information. If result is file it will be in 'files' array. 'files' - array of the files, where key is extension, and value is absolute path to the result file.

This method should return true on success or string on error.

Return values
bool|string

getLastTransformationResult()

public final getLastTransformationResult() : Result|null
Return values
Result|null

getPullTag()

public getPullTag() : null|string
Tags
throws
LoaderException
Return values
null|string

transform()

public transform(array<string|int, mixed> $formats) : Result
Parameters
$formats : array<string|int, mixed>
Return values
Result

        
On this page

Search results