Bitrix API

FileItem implements RestEntity, PopupDataAggregatable uses ContextCustomer

Table of Contents

Interfaces

RestEntity
PopupDataAggregatable
An interface for classes that have entities within them that should be taken to the top level of a REST response.

Methods

__construct()  : mixed
copyTo()  : Result<string|int, FileItem>
getChatId()  : int|null
getContentType()  : string
Method for getting file type like in old api
getContext()  : Context
Returns the local or global context for the action.
getCopyToChat()  : self|null
getDiskFile()  : File|null
getDiskFileId()  : int
getDiskFileIdsFromBbCodesInText()  : array<string|int, mixed>
getId()  : int|null
Returns the id of the entity
getMessageOut()  : string
getPopupData()  : PopupData
Returns the data to be raised to the top of the REST response. Works on the principle of the composite pattern.
getRestEntityName()  : string
Returns the name of the entity that will be used in the rest response
initByDiskFileId()  : self|null
markAsFile()  : self
removeDiskBbCodesFromText()  : string
setChatId()  : self
setContentType()  : self
setContext()  : self
Sets new context for operations.
setContextUser()  : self
setDiskFile()  : self
toRestFormat()  : array<string|int, mixed>|null
Returns an array in JSON like format to return the entity as a rest response.
withContext()  : static
Provides local context for the action.
withContextUser()  : static
Provides local context for the action.

Methods

__construct()

public __construct(int|File $diskFile[, int|null $chatId = null ]) : mixed
Parameters
$diskFile : int|File
$chatId : int|null = null

getChatId()

public getChatId() : int|null
Return values
int|null

getContentType()

Method for getting file type like in old api

public getContentType() : string
Tags
see
CIMDisk::GetFileParams
Return values
string

getCopyToChat()

public getCopyToChat(Chat $chat) : self|null
Parameters
$chat : Chat
Return values
self|null

getDiskFile()

public getDiskFile() : File|null
Return values
File|null

getDiskFileId()

public getDiskFileId() : int
Return values
int

getDiskFileIdsFromBbCodesInText()

public static getDiskFileIdsFromBbCodesInText(string $text) : array<string|int, mixed>
Parameters
$text : string
Return values
array<string|int, mixed>

getId()

Returns the id of the entity

public getId() : int|null
Return values
int|null

getMessageOut()

public getMessageOut() : string
Return values
string

getPopupData()

Returns the data to be raised to the top of the REST response. Works on the principle of the composite pattern.

public getPopupData([array<string|int, mixed> $excludedList = [] ]) : PopupData
Parameters
$excludedList : array<string|int, mixed> = []
Return values
PopupData

getRestEntityName()

Returns the name of the entity that will be used in the rest response

public static getRestEntityName() : string
Return values
string

initByDiskFileId()

public static initByDiskFileId(int $diskFileId[, int|null $chatId = null ]) : self|null
Parameters
$diskFileId : int
$chatId : int|null = null
Return values
self|null

markAsFile()

public markAsFile() : self
Return values
self

removeDiskBbCodesFromText()

public static removeDiskBbCodesFromText(string $text) : string
Parameters
$text : string
Return values
string

setChatId()

public setChatId(int|null $chatId) : self
Parameters
$chatId : int|null
Return values
self

setContentType()

public setContentType(string $contentType) : self
Parameters
$contentType : string
Return values
self

setContext()

Sets new context for operations.

public setContext(Context|null $context) : self
Parameters
$context : Context|null
Return values
self

setContextUser()

public setContextUser(mixed $user) : self
Parameters
$user : mixed
Return values
self

setDiskFile()

public setDiskFile(File $diskFile) : self
Parameters
$diskFile : File
Return values
self

toRestFormat()

Returns an array in JSON like format to return the entity as a rest response.

public toRestFormat([array<string|int, mixed> $option = [] ]) : array<string|int, mixed>|null
Parameters
$option : array<string|int, mixed> = []
Return values
array<string|int, mixed>|null

withContext()

Provides local context for the action.

public withContext(Context|null $context) : static
Parameters
$context : Context|null
Return values
static

withContextUser()

Provides local context for the action.

public withContextUser(int|User|User $user) : static
Parameters
$user : int|User|User
Return values
static 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results