Bitrix API

AbstractStorage

AbstractYes

Table of Contents

Methods

addDirectory()  : array<string|int, mixed>|bool
addFile()  : array<string|int, mixed>|bool
compareVersion()  : int
deleteDirectory()  : mixed
deleteFile()  : mixed
generateId()  : string
getDirectory()  : array<string|int, mixed>|bool
getFile()  : array<string|int, mixed>|bool
getPublicLink()  : mixed
getSnapshot()  : array<string|int, mixed>
getStorageClassName()  : string
getStorageExtra()  : array<string|int, mixed>|null
getStorageId()  : array<string|int, mixed>|null|string
getStringStorageId()  : string
getVersionDelete()  : mixed
isCorrectName()  : mixed
isUnique()  : mixed
parseElementExtra()  : mixed
parseStorageExtra()  : mixed
renameDirectory()  : mixed
renameFile()  : mixed
sendFile()  : bool
setStorageExtra()  : $this
setStorageId()  : $this
updateFile()  : array<string|int, mixed>|bool

Methods

addDirectory()

public abstract addDirectory(mixed $name, mixed $parentDirectoryId[, array<string|int, mixed> $data = array() ]) : array<string|int, mixed>|bool
Parameters
$name : mixed
$parentDirectoryId : mixed
$data : array<string|int, mixed> = array()
Return values
array<string|int, mixed>|bool

addFile()

public abstract addFile(mixed $name, mixed $targetDirectoryId, TmpFile $tmpFile[, array<string|int, mixed> $data = array() ]) : array<string|int, mixed>|bool
Parameters
$name : mixed
$targetDirectoryId : mixed
$tmpFile : TmpFile
$data : array<string|int, mixed> = array()
Return values
array<string|int, mixed>|bool

compareVersion()

public compareVersion(mixed $a, mixed $b) : int
Parameters
$a : mixed
$b : mixed
Return values
int —

(1, -1, 0)

deleteDirectory()

public abstract deleteDirectory(mixed $directory) : mixed
Parameters
$directory : mixed

deleteFile()

public abstract deleteFile(mixed $file) : mixed
Parameters
$file : mixed

generateId()

public abstract generateId(array<string|int, mixed> $element) : string
Parameters
$element : array<string|int, mixed>
Return values
string

getDirectory()

public abstract getDirectory(mixed $id, array<string|int, mixed> $extra[, bool $skipCheckId = false ]) : array<string|int, mixed>|bool
Parameters
$id : mixed
$extra : array<string|int, mixed>
$skipCheckId : bool = false
Return values
array<string|int, mixed>|bool

getFile()

public abstract getFile(mixed $id, array<string|int, mixed> $extra[, bool $skipCheckId = false ]) : array<string|int, mixed>|bool
Parameters
$id : mixed
$extra : array<string|int, mixed>
$skipCheckId : bool = false
Return values
array<string|int, mixed>|bool

getPublicLink()

public abstract getPublicLink(array<string|int, mixed> $objectData) : mixed
Parameters
$objectData : array<string|int, mixed>

getSnapshot()

public abstract getSnapshot([int $version = 0 ][, PageState|null $pageState = null ][, PageState &$nextPageState = null ]) : array<string|int, mixed>
Parameters
$version : int = 0
$pageState : PageState|null = null
$nextPageState : PageState = null
Return values
array<string|int, mixed>

getStorageClassName()

public abstract getStorageClassName() : string
Return values
string

getStorageExtra()

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

getStorageId()

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

getStringStorageId()

public getStringStorageId() : string
Return values
string

getVersionDelete()

public abstract getVersionDelete(mixed $element) : mixed
Parameters
$element : mixed

isCorrectName()

public abstract isCorrectName(mixed $name, mixed &$msg) : mixed
Parameters
$name : mixed
$msg : mixed

isUnique()

public abstract isUnique(mixed $name, mixed $targetDirectoryId[, mixed &$opponentId = null ]) : mixed
Parameters
$name : mixed
$targetDirectoryId : mixed
$opponentId : mixed = null

parseElementExtra()

public abstract parseElementExtra(array<string|int, mixed> $source) : mixed
Parameters
$source : array<string|int, mixed>

parseStorageExtra()

public abstract parseStorageExtra(array<string|int, mixed> $source) : mixed
Parameters
$source : array<string|int, mixed>

renameDirectory()

public abstract renameDirectory(mixed $name, mixed $targetDirectoryId, mixed $parentDirectoryId) : mixed
Parameters
$name : mixed
$targetDirectoryId : mixed
$parentDirectoryId : mixed

renameFile()

public abstract renameFile(mixed $name, mixed $targetElementId, mixed $parentDirectoryId) : mixed
Parameters
$name : mixed
$targetElementId : mixed
$parentDirectoryId : mixed

sendFile()

public abstract sendFile(mixed $file) : bool
Parameters
$file : mixed
Return values
bool

setStorageExtra()

public setStorageExtra(array<string|int, mixed>|null $storageExtra) : $this
Parameters
$storageExtra : array<string|int, mixed>|null
Return values
$this

setStorageId()

public setStorageId(mixed $storageId) : $this
Parameters
$storageId : mixed
Return values
$this

updateFile()

public abstract updateFile(mixed $name, mixed $targetElementId, TmpFile $tmpFile[, array<string|int, mixed> $data = array() ]) : array<string|int, mixed>|bool
Parameters
$name : mixed
$targetElementId : mixed
$tmpFile : TmpFile
$data : array<string|int, mixed> = array()
Return values
array<string|int, mixed>|bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results