Bitrix API

NewDiskStorage extends DiskStorage

Table of Contents

Constants

ERROR_CREATE_FORK_FILE  = 'DS_F_22001'
LOCK_PREFIX_IN_SELECT  = 'LOCK_'
MAX_COUNT_LINKS_FOR_CYCLE  = 5
SNAPSHOT_PAGE_SIZE  = 200

Methods

__construct()  : mixed
addDirectory()  : array<string|int, mixed>|bool
addFile()  : array<string|int, mixed>
addShutdownTask()  : DiskStorage
checkOpportunityToSkipRights()  : mixed
clearErrors()  : mixed
compareVersion()  : int
convertFromExternalVersion()  : mixed
convertToExternalVersion()  : mixed
deleteDirectory()  : mixed
deleteFile()  : mixed
finalize()  : mixed
generateId()  : string
getDirectory()  : array<string|int, mixed>|bool
getErrors()  : mixed
getFile()  : array<string|int, mixed>|bool
getPath()  : mixed
getPublicLink()  : mixed
getSnapshot()  : array<string|int, mixed>
getStorageClassName()  : string
getStorageExtra()  : array<string|int, mixed>|null
getStorageId()  : array<string|int, mixed>|null|string
getStringStorageId()  : string
getUserStorage()  : Storage
getVersionDelete()  : mixed
isCorrectName()  : mixed
isUnique()  : mixed
loadTree()  : void
lockFile()  : mixed
parseElementExtra()  : mixed
parseStorageExtra()  : mixed
renameDirectory()  : mixed
renameFile()  : mixed
sendFile()  : bool|void
setStorageExtra()  : $this
setStorageId()  : $this
unlockFile()  : mixed
updateFile()  : array<string|int, mixed>|bool

Constants

ERROR_CREATE_FORK_FILE

public mixed ERROR_CREATE_FORK_FILE = 'DS_F_22001'

LOCK_PREFIX_IN_SELECT

public mixed LOCK_PREFIX_IN_SELECT = 'LOCK_'

MAX_COUNT_LINKS_FOR_CYCLE

public mixed MAX_COUNT_LINKS_FOR_CYCLE = 5

Methods

__construct()

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

addDirectory()

public 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()
Tags
throws
AccessDeniedException
Return values
array<string|int, mixed>|bool

addFile()

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

checkOpportunityToSkipRights()

public checkOpportunityToSkipRights() : mixed

compareVersion()

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

(1, -1, 0)

convertFromExternalVersion()

public convertFromExternalVersion(mixed $version) : mixed
Parameters
$version : mixed

convertToExternalVersion()

public convertToExternalVersion(mixed $version) : mixed
Parameters
$version : mixed

deleteDirectory()

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

deleteFile()

public deleteFile(mixed $fileArray) : mixed
Parameters
$fileArray : mixed

generateId()

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

getDirectory()

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

getFile()

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

getPath()

public getPath(mixed $id[, mixed $getDirectPathIfPossible = false ]) : mixed
Parameters
$id : mixed
$getDirectPathIfPossible : mixed = false

getPublicLink()

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

getSnapshot()

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

getStorageClassName()

public 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

getUserStorage()

public getUserStorage() : Storage
Return values
Storage

getVersionDelete()

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

isCorrectName()

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

isUnique()

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

lockFile()

public lockFile(array<string|int, mixed> $file) : mixed
Parameters
$file : array<string|int, mixed>

parseElementExtra()

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

parseStorageExtra()

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

renameDirectory()

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

renameFile()

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

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

unlockFile()

public unlockFile(array<string|int, mixed> $file) : mixed
Parameters
$file : array<string|int, mixed>

updateFile()

public 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()
Tags
throws
AccessDeniedException
Return values
array<string|int, mixed>|bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results