Bitrix API

PreviewManager

FinalYes

Table of Contents

Constants

GET_KEY_TO_SEND_PREVIEW_CONTENT  = 'ibxPreview'
GET_KEY_TO_SHOW_IMAGE  = 'ibxShowImage'
HEADER_TO_CHECK_TRANSFORMATION  = 'BX-Viewer-check-transformation'
HEADER_TO_GET_SOURCE  = 'BX-Viewer-src'
HEADER_TO_RESIZE_IMAGE  = 'BX-Viewer-image'
HEADER_TO_RUN_FORCE_TRANSFORMATION  = 'BX-Viewer-force-transformation'
HEADER_TO_SEND_PREVIEW  = 'BX-Viewer'

Methods

__construct()  : mixed
attachPreviewToFileId()  : Result
disableCatchingViewByUser()  : void
enableCatchingViewByUser()  : void
generatePreview()  : Result|null
getByImage()  : Image|null
getFilePreviewEntryByFileId()  : array<string|int, mixed>|null
getRenderClassByFile()  : string
isDisabledCatchingViewByUser()  : bool
isInternalRequest()  : bool
processViewByUserRequest()  : void
setPreviewImageId()  : Result

Constants

GET_KEY_TO_SEND_PREVIEW_CONTENT

public mixed GET_KEY_TO_SEND_PREVIEW_CONTENT = 'ibxPreview'

GET_KEY_TO_SHOW_IMAGE

public mixed GET_KEY_TO_SHOW_IMAGE = 'ibxShowImage'

HEADER_TO_CHECK_TRANSFORMATION

public mixed HEADER_TO_CHECK_TRANSFORMATION = 'BX-Viewer-check-transformation'

HEADER_TO_GET_SOURCE

public mixed HEADER_TO_GET_SOURCE = 'BX-Viewer-src'

HEADER_TO_RESIZE_IMAGE

public mixed HEADER_TO_RESIZE_IMAGE = 'BX-Viewer-image'

HEADER_TO_RUN_FORCE_TRANSFORMATION

public mixed HEADER_TO_RUN_FORCE_TRANSFORMATION = 'BX-Viewer-force-transformation'

HEADER_TO_SEND_PREVIEW

public mixed HEADER_TO_SEND_PREVIEW = 'BX-Viewer'

Methods

__construct()

public __construct([HttpRequest $httpRequest = null ]) : mixed
Parameters
$httpRequest : HttpRequest = null

attachPreviewToFileId()

public attachPreviewToFileId(int $fileId, int|null $previewId, int|null $previewImageId) : Result
Parameters
$fileId : int
$previewId : int|null
$previewImageId : int|null
Return values
Result

disableCatchingViewByUser()

public static disableCatchingViewByUser() : void

enableCatchingViewByUser()

public static enableCatchingViewByUser() : void

generatePreview()

public generatePreview(mixed $fileId) : Result|null
Parameters
$fileId : mixed
Return values
Result|null

getByImage()

public getByImage(mixed $fileId, Uri $sourceUri) : Image|null
Parameters
$fileId : mixed
$sourceUri : Uri
Return values
Image|null

getFilePreviewEntryByFileId()

public getFilePreviewEntryByFileId(int $fileId) : array<string|int, mixed>|null
Parameters
$fileId : int
Return values
array<string|int, mixed>|null

getRenderClassByFile()

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

isDisabledCatchingViewByUser()

public static isDisabledCatchingViewByUser() : bool
Return values
bool

isInternalRequest()

public isInternalRequest(mixed $file, mixed $options) : bool
Parameters
$file : mixed
$options : mixed
Return values
bool

processViewByUserRequest()

public processViewByUserRequest(mixed $file, mixed $options) : void
Parameters
$file : mixed
$options : mixed

setPreviewImageId()

public setPreviewImageId(int $fileId, int $previewImageId) : Result
Parameters
$fileId : int
$previewImageId : int
Return values
Result 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results