PHP Класс Horde_Lock, horde

Автор: Ben Klang ([email protected])

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство	Тип	Описание
$_logger	Horde_Log_Logger	Logger.
$_params	array	Driver parameters.

Открытые методы

Метод	Описание
__construct ( array $params = [] )	Constructor.
clearLock ( string $lockid ) : boolean	Removes a lock given the lock ID.
getLockInfo ( string $lockid ) : array	Return an array of information about the requested lock.
getLocks ( string $scope = null, string $principal = null, integer $type = null ) : array	Return a list of valid locks with the option to limit the results by principal, scope and/or type.
resetLock ( string $lockid, integer $extend ) : boolean	Extend the valid lifetime of a valid lock to now + $extend.
setLock ( string $requestor, string $scope, string $principal, integer $lifetime = 1, $exclusive = Horde_Lock::TYPE_SHARED ) : mixed	Sets a lock on the requested principal and returns the generated lock ID. NOTE: No security checks are done in the Horde_Lock API. It is expected that the calling application has done all necessary security checks before requesting a lock be granted.

Описание методов

__construct() публичный Метод

Constructor.

public __construct ( array $params = [] )
$params	array	Configuration parameters: 'logger' - (Horde_Log_Logger) A logger instance.

clearLock() абстрактный публичный Метод

NOTE: No security checks are done in the Horde_Lock API. It is expected that the calling application has done all necessary security checks before requesting a lock be cleared.

abstract public clearLock ( string $lockid ) : boolean
$lockid	string	The lock ID as generated by a previous call to setLock()
Результат	boolean	Returns true on success.

getLockInfo() абстрактный публичный Метод

Return an array of information about the requested lock.

abstract public getLockInfo ( string $lockid ) : array
$lockid	string	Lock ID to look up.
Результат	array	Lock information.

getLocks() абстрактный публичный Метод

Return a list of valid locks with the option to limit the results by principal, scope and/or type.

abstract public getLocks ( string $scope = null, string $principal = null, integer $type = null ) : array
$scope	string	The scope of the lock. Typically the name of the application requesting the lock or some other identifier used to group locks together.
$principal	string	Principal for which to check for locks
$type	integer	Only return locks of the given type. Defaults to null, or all locks
Результат	array	Array of locks with the ID as the key and the lock details as the value. If there are no current locks this will return an empty array.

resetLock() абстрактный публичный Метод

Extend the valid lifetime of a valid lock to now + $extend.

abstract public resetLock ( string $lockid, integer $extend ) : boolean
$lockid	string	Lock ID to reset. Must be a valid, non-expired lock.
$extend	integer	Extend lock this many seconds from now.
Результат	boolean	Returns true on success.

setLock() абстрактный публичный Метод

Sets a lock on the requested principal and returns the generated lock ID. NOTE: No security checks are done in the Horde_Lock API. It is expected that the calling application has done all necessary security checks before requesting a lock be granted.

abstract public setLock ( string $requestor, string $scope, string $principal, integer $lifetime = 1, $exclusive = Horde_Lock::TYPE_SHARED ) : mixed
$requestor	string	User ID of the lock requestor.
$scope	string	The scope of the lock. Typically the name of the application requesting the lock or some other identifier used to group locks together.
$principal	string	A principal on which a lock should be granted. The format can be any string but is suggested to be in URI form.
$lifetime	integer	Time (in seconds) for which the lock will be considered valid.
Результат	mixed	A string lock ID.

Описание свойств

$_logger защищенное свойство

Logger.

protected Horde_Log_Logger $_logger
Результат	Horde_Log_Logger

$_params защищенное свойство

Driver parameters.

protected array $_params
Результат	array