Bitrix API

TransformerManager implements InterfaceCallback

Table of Contents

Interfaces

InterfaceCallback

Constants

COMMAND_STATUS_ERROR  = 1000
MODULE_ID  = 'disk'
PATH  = 'disk_preview'
PULL_TAG  = 'DISKTRANSFORMATION'
QUEUE_NAME  = 'disk_on_load'

Methods

call()  : bool|string
Function to process results after transformation.
checkTransformationAttempts()  : bool
Returns true if file had been sent to transform at least once.
className()  : string
Returns name of this class.
getBlogPostIds()  : array<string|int, mixed>
Returns array of BlogPost IDs to set limited rights
getSocNetLogIds()  : array<string|int, mixed>
Returns array of SocNetLog IDs to set limited rights
resetCacheInUfAfterTransformation()  : mixed
subscribe()  : bool|string
transformToView()  : bool
Fill parameters to call FileTransformer::transform().

Constants

Methods

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 returns true on success or string on error.

Return values
bool|string

checkTransformationAttempts()

Returns true if file had been sent to transform at least once.

public static checkTransformationAttempts(File $file) : bool
Parameters
$file : File
Return values
bool

className()

Returns name of this class.

public static className() : string
Return values
string

getBlogPostIds()

Returns array of BlogPost IDs to set limited rights

public static getBlogPostIds(File $file) : array<string|int, mixed>
Parameters
$file : File
Return values
array<string|int, mixed>

getSocNetLogIds()

Returns array of SocNetLog IDs to set limited rights

public static getSocNetLogIds(File $file) : array<string|int, mixed>
Parameters
$file : File
Return values
array<string|int, mixed>

resetCacheInUfAfterTransformation()

public static resetCacheInUfAfterTransformation(Event $event) : mixed
Parameters
$event : Event

subscribe()

public static subscribe(mixed $fileId, mixed $userId) : bool|string
Parameters
$fileId : mixed
$userId : mixed
Tags
throws
LoaderException
Return values
bool|string

transformToView()

Fill parameters to call FileTransformer::transform().

public static transformToView(File $file) : bool
Parameters
$file : File
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results