Bitrix API

FileAttributes extends ItemAttributes

FinalYes

Table of Contents

Constants

ATTRIBUTE_ATTACHED_OBJECT_ID  = 'data-attached-object-id'
ATTRIBUTE_OBJECT_ID  = 'data-object-id'
ATTRIBUTE_SEPARATE_ITEM  = 'data-viewer-separate-item'
ATTRIBUTE_VERSION_ID  = 'data-version-id'
JS_TYPE  = 'cloud-document'
JS_TYPE_CLASS_BOARD  = 'BX.Disk.Viewer.BoardItem'
JS_TYPE_CLASS_CLOUD_DOCUMENT  = 'BX.Disk.Viewer.DocumentItem'
JS_TYPE_CLASS_ONLYOFFICE  = 'BX.Disk.Viewer.OnlyOfficeItem'

Methods

__toString()  : string
addAction()  : $this
buildAsUnknownType()  : static
buildByFileData()  : static
buildByFileId()  : static
clearActions()  : self
getActions()  : array<string|int, mixed>
getAttribute()  : mixed|null
getAttributes()  : array<string|int, mixed>
getExtension()  : string|null
getGroupBy()  : string|null
getTypeClass()  : mixed
getViewerType()  : mixed|null
issetAttribute()  : bool
setAsSeparateItem()  : mixed
setAttachedObjectId()  : mixed
setAttribute()  : $this
setExtension()  : ItemAttributes
setGroupBy()  : $this
setObjectId()  : mixed
setTitle()  : $this
setTypeClass()  : mixed
setVersionId()  : mixed
setViewerType()  : self
toDataSet()  : array<string|int, mixed>
Convert structure to array which we can use in js (node.dataset).
toString()  : string
tryBuildByFileData()  : mixed
tryBuildByFileId()  : mixed
unsetAttribute()  : $this
unsetGroupBy()  : $this

Constants

ATTRIBUTE_ATTACHED_OBJECT_ID

public mixed ATTRIBUTE_ATTACHED_OBJECT_ID = 'data-attached-object-id'

ATTRIBUTE_OBJECT_ID

public mixed ATTRIBUTE_OBJECT_ID = 'data-object-id'

ATTRIBUTE_SEPARATE_ITEM

public mixed ATTRIBUTE_SEPARATE_ITEM = 'data-viewer-separate-item'

ATTRIBUTE_VERSION_ID

public mixed ATTRIBUTE_VERSION_ID = 'data-version-id'

JS_TYPE_CLASS_BOARD

public mixed JS_TYPE_CLASS_BOARD = 'BX.Disk.Viewer.BoardItem'

JS_TYPE_CLASS_CLOUD_DOCUMENT

public mixed JS_TYPE_CLASS_CLOUD_DOCUMENT = 'BX.Disk.Viewer.DocumentItem'

JS_TYPE_CLASS_ONLYOFFICE

public mixed JS_TYPE_CLASS_ONLYOFFICE = 'BX.Disk.Viewer.OnlyOfficeItem'

Methods

addAction()

public addAction(array<string|int, mixed> $action) : $this
Parameters
$action : array<string|int, mixed>
Return values
$this

buildAsUnknownType()

public static buildAsUnknownType(mixed $sourceUri) : static
Parameters
$sourceUri : mixed
Return values
static

buildByFileData()

public static buildByFileData(array<string|int, mixed> $fileData, mixed $sourceUri) : static
Parameters
$fileData : array<string|int, mixed>
$sourceUri : mixed
Tags
throws
ArgumentException
Return values
static

buildByFileId()

public static buildByFileId(mixed $fileId, mixed $sourceUri) : static
Parameters
$fileId : mixed
$sourceUri : mixed
Tags
throws
ArgumentException
Return values
static

getActions()

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

getAttribute()

public getAttribute(mixed $name) : mixed|null
Parameters
$name : mixed
Return values
mixed|null

getAttributes()

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

getExtension()

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

getGroupBy()

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

getViewerType()

public getViewerType() : mixed|null
Return values
mixed|null

issetAttribute()

public issetAttribute(mixed $name) : bool
Parameters
$name : mixed
Return values
bool

setAttachedObjectId()

public setAttachedObjectId(mixed $attachedObjectId) : mixed
Parameters
$attachedObjectId : mixed

setAttribute()

public setAttribute(mixed $name[, mixed $value = null ]) : $this
Parameters
$name : mixed
$value : mixed = null
Return values
$this

setGroupBy()

public setGroupBy(mixed $id) : $this
Parameters
$id : mixed
Return values
$this

setObjectId()

public setObjectId(mixed $objectId) : mixed
Parameters
$objectId : mixed

setTitle()

public setTitle(mixed $title) : $this
Parameters
$title : mixed
Return values
$this

setTypeClass()

public setTypeClass(string $class) : mixed
Parameters
$class : string

setVersionId()

public setVersionId(mixed $versionId) : mixed
Parameters
$versionId : mixed

setViewerType()

public setViewerType(string $type) : self
Parameters
$type : string
Return values
self

toDataSet()

Convert structure to array which we can use in js (node.dataset).

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

tryBuildByFileData()

public static tryBuildByFileData(array<string|int, mixed> $fileData, mixed $sourceUri) : mixed
Parameters
$fileData : array<string|int, mixed>
$sourceUri : mixed

tryBuildByFileId()

public static tryBuildByFileId(mixed $fileId, mixed $sourceUri) : mixed
Parameters
$fileId : mixed
$sourceUri : mixed

unsetAttribute()

public unsetAttribute(mixed $name) : $this
Parameters
$name : mixed
Return values
$this

unsetGroupBy()

public unsetGroupBy() : $this
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results