Bitrix API

FileInfo extends FileData implements JsonSerializable

Table of Contents

Interfaces

JsonSerializable

Methods

__construct()  : mixed
createFromBFile()  : FileInfo|null
createFromTempFile()  : FileInfo|null
getContentType()  : string
getCustomData()  : Dictionary
getDownloadUrl()  : string|null
getFileId()  : int
getHeight()  : int
getId()  : int|string
getName()  : string
getPreviewHeight()  : int
getPreviewUrl()  : string|null
getPreviewWidth()  : int
getSize()  : int
getWidth()  : int
isImage()  : bool
isVideo()  : bool
jsonSerialize()  : array<string|int, mixed>
setCustomData()  : self
setDownloadUrl()  : void
setFileId()  : void
setHeight()  : void
setId()  : void
setName()  : void
setPreviewUrl()  : void
setTreatImageAsFile()  : void
setWidth()  : void
shouldTreatImageAsFile()  : bool

Methods

__construct()

public __construct(mixed $id, string $name, string $contentType, int $size) : mixed
Parameters
$id : mixed
$name : string
$contentType : string
$size : int

createFromBFile()

public static createFromBFile(int $id) : FileInfo|null
Parameters
$id : int
Return values
FileInfo|null

createFromTempFile()

public static createFromTempFile(string $tempFileId) : FileInfo|null
Parameters
$tempFileId : string
Return values
FileInfo|null

getContentType()

public getContentType() : string
Return values
string

getDownloadUrl()

public getDownloadUrl() : string|null
Return values
string|null

getFileId()

public getFileId() : int
Return values
int

getHeight()

public getHeight() : int
Return values
int

getId()

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

getName()

public getName() : string
Return values
string

getPreviewHeight()

public getPreviewHeight() : int
Return values
int

getPreviewUrl()

public getPreviewUrl() : string|null
Return values
string|null

getPreviewWidth()

public getPreviewWidth() : int
Return values
int

getSize()

public getSize() : int
Return values
int

getWidth()

public getWidth() : int
Return values
int

isImage()

public isImage() : bool
Return values
bool

isVideo()

public isVideo() : bool
Return values
bool

jsonSerialize()

public jsonSerialize() : array<string|int, mixed>
Return values
array<string|int, mixed>

setCustomData()

public setCustomData(array<string|int, mixed> $customData) : self
Parameters
$customData : array<string|int, mixed>
Return values
self

setDownloadUrl()

public setDownloadUrl(string $downloadUrl) : void
Parameters
$downloadUrl : string

setFileId()

public setFileId(int $fileId) : void
Parameters
$fileId : int

setHeight()

public setHeight(int $height) : void
Parameters
$height : int

setId()

public setId(mixed $id) : void
Parameters
$id : mixed

setName()

public setName(string $name) : void
Parameters
$name : string

setPreviewUrl()

public setPreviewUrl(string $previewUrl, int $previewWidth, int $previewHeight) : void
Parameters
$previewUrl : string
$previewWidth : int
$previewHeight : int

setTreatImageAsFile()

public setTreatImageAsFile(bool $flag) : void
Parameters
$flag : bool

setWidth()

public setWidth(int $width) : void
Parameters
$width : int

shouldTreatImageAsFile()

public shouldTreatImageAsFile() : bool
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results