Bitrix API

Cleaner

FinalYes

Table of Contents

Constants

DELETE_TYPE_PORTION  = 2
DELETE_TYPE_TIME  = 3

Methods

className()  : string
Returns the fully qualified name of this class.
deleteByTtl()  : string
Deletes files which have to die by ttl.
deleteRightSetupSession()  : string
Deletes old right setup sessions.
deleteShowSession()  : string
Deletes show session and connected files from cloud.
deleteTrashCanEmptyFolderByTtl()  : void
deleteTrashCanEmptyFolderByTtlAgent()  : string
deleteTrashCanFilesByTtl()  : void
deleteTrashCanFilesByTtlAgent()  : string
deleteUnnecessaryFiles()  : string
Deletes unnecessary files, which don't relate to version or object.
deleteUnregisteredVersionFiles()  : string
Deletes files that were left after version merge.
deleteVersionsByTtl()  : void
deleteVersionsByTtlAgent()  : string
emptyOldDeletedLogEntries()  : mixed
releaseObjectLocks()  : void
Releases object locks which are expired by module settings.
releaseObjectLocksAgent()  : string
restoreMissingRootFolder()  : string
Restores storages's missing root folder.

Constants

DELETE_TYPE_PORTION

public mixed DELETE_TYPE_PORTION = 2

DELETE_TYPE_TIME

public mixed DELETE_TYPE_TIME = 3

Methods

className()

Returns the fully qualified name of this class.

public static className() : string
Return values
string

deleteByTtl()

Deletes files which have to die by ttl.

public static deleteByTtl([int $type = self::DELETE_TYPE_PORTION ][, int $limit = 10 ]) : string
Parameters
$type : int = self::DELETE_TYPE_PORTION

Deleting type. You can choose delete files by portion or by time.

$limit : int = 10

Limit which will be used for deleting files by portion or by time. So, count of files which we want to delete or maximum duration of the removal process.

Return values
string

deleteRightSetupSession()

Deletes old right setup sessions.

public static deleteRightSetupSession() : string
Return values
string

deleteShowSession()

Deletes show session and connected files from cloud.

public static deleteShowSession([int $type = self::DELETE_TYPE_PORTION ][, int $limit = 10 ]) : string
Parameters
$type : int = self::DELETE_TYPE_PORTION

Deleting type. You can choose delete files by portion or by time.

$limit : int = 10

Limit which will be used for deleting files by portion or by time. So, count of files which we want to delete or maximum duration of the removal process.

Return values
string

deleteTrashCanEmptyFolderByTtl()

public static deleteTrashCanEmptyFolderByTtl([mixed $type = self::DELETE_TYPE_PORTION ][, mixed $limit = 10 ]) : void
Parameters
$type : mixed = self::DELETE_TYPE_PORTION
$limit : mixed = 10

deleteTrashCanEmptyFolderByTtlAgent()

public static deleteTrashCanEmptyFolderByTtlAgent([mixed $type = self::DELETE_TYPE_PORTION ][, mixed $limit = 10 ]) : string
Parameters
$type : mixed = self::DELETE_TYPE_PORTION
$limit : mixed = 10
Return values
string

deleteTrashCanFilesByTtl()

public static deleteTrashCanFilesByTtl([mixed $type = self::DELETE_TYPE_PORTION ][, mixed $limit = 10 ]) : void
Parameters
$type : mixed = self::DELETE_TYPE_PORTION
$limit : mixed = 10

deleteTrashCanFilesByTtlAgent()

public static deleteTrashCanFilesByTtlAgent([mixed $type = self::DELETE_TYPE_PORTION ][, mixed $limit = 10 ]) : string
Parameters
$type : mixed = self::DELETE_TYPE_PORTION
$limit : mixed = 10
Return values
string

deleteUnnecessaryFiles()

Deletes unnecessary files, which don't relate to version or object.

public static deleteUnnecessaryFiles([int $type = self::DELETE_TYPE_PORTION ][, int $limit = 10 ]) : string
Parameters
$type : int = self::DELETE_TYPE_PORTION

Deleting type. You can choose delete files by portion or by time.

$limit : int = 10

Limit which will be used for deleting files by portion or by time. So, count of files which we want to delete or maximum duration of the removal process.

Return values
string

deleteUnregisteredVersionFiles()

Deletes files that were left after version merge.

public static deleteUnregisteredVersionFiles([int $limit = 100 ][, string $fromDate = '' ][, int $timeLimit = 20 ]) : string
Parameters
$limit : int = 100

Limit which will be used for deleting files by portion or by time.

$fromDate : string = ''

Starting date.

$timeLimit : int = 20

Agent life time limit.

Return values
string

deleteVersionsByTtl()

public static deleteVersionsByTtl([mixed $type = self::DELETE_TYPE_PORTION ][, mixed $limit = 10 ]) : void
Parameters
$type : mixed = self::DELETE_TYPE_PORTION
$limit : mixed = 10

deleteVersionsByTtlAgent()

public static deleteVersionsByTtlAgent([mixed $type = self::DELETE_TYPE_PORTION ][, mixed $limit = 10 ]) : string
Parameters
$type : mixed = self::DELETE_TYPE_PORTION
$limit : mixed = 10
Return values
string

emptyOldDeletedLogEntries()

public static emptyOldDeletedLogEntries() : mixed

releaseObjectLocks()

Releases object locks which are expired by module settings.

public static releaseObjectLocks() : void

releaseObjectLocksAgent()

public static releaseObjectLocksAgent() : string
Return values
string

restoreMissingRootFolder()

Restores storages's missing root folder.

public static restoreMissingRootFolder() : string
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results