ObjectNameService
FinalYes
Class ObjectNameService Helps to prepare unique name for object in folder in concurrent environment.
Table of Contents
Constants
- ERROR_LOCK_UNIQUE_NAME = 'DISK_ONS_22001'
- ERROR_NON_UNIQUE_NAME = \Bitrix\Disk\BaseObject::ERROR_NON_UNIQUE_NAME
- TYPE_FILE = \Bitrix\Disk\Internals\ObjectTable::TYPE_FILE
- TYPE_FOLDER = \Bitrix\Disk\Internals\ObjectTable::TYPE_FOLDER
Methods
- __construct() : mixed
- excludeId() : void
- isUniqueName() : Result
- prepareName() : Result
- requireOpponentId() : void
- requireUniqueName() : void
- reserveName() : bool
Constants
ERROR_LOCK_UNIQUE_NAME
public
mixed
ERROR_LOCK_UNIQUE_NAME
= 'DISK_ONS_22001'
ERROR_NON_UNIQUE_NAME
public
mixed
ERROR_NON_UNIQUE_NAME
= \Bitrix\Disk\BaseObject::ERROR_NON_UNIQUE_NAME
TYPE_FILE
public
mixed
TYPE_FILE
= \Bitrix\Disk\Internals\ObjectTable::TYPE_FILE
TYPE_FOLDER
public
mixed
TYPE_FOLDER
= \Bitrix\Disk\Internals\ObjectTable::TYPE_FOLDER
Methods
__construct()
public
__construct(string $desiredName, int|null $underObjectId[, int $objectType = self::TYPE_FILE ]) : mixed
Parameters
- $desiredName : string
- $underObjectId : int|null
- $objectType : int = self::TYPE_FILE
excludeId()
public
excludeId(int $id) : void
Parameters
- $id : int
isUniqueName()
public
isUniqueName([int|null $excludeId = null ][, bool $returnOpponentId = false ]) : Result
Parameters
- $excludeId : int|null = null
- $returnOpponentId : bool = false
Return values
ResultprepareName()
public
prepareName() : Result
Return values
ResultrequireOpponentId()
public
requireOpponentId() : void
requireUniqueName()
public
requireUniqueName() : void
reserveName()
public
reserveName() : bool