PHP Class Horde_Lock_Null, horde

Copyright 2010-2016 Horde LLC (http://www.horde.org/) See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
Author: Michael Slusarz ([email protected])
Inheritance: extends Horde_Lock
Show file Open project: horde/horde

Public Methods

Method Description
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.

Method Details

clearLock() public method

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.
public clearLock ( string $lockid ) : boolean
$lockid string The lock ID as generated by a previous call to setLock()
return boolean Returns true on success.

getLockInfo() public method

Return an array of information about the requested lock.
public getLockInfo ( string $lockid ) : array
$lockid string Lock ID to look up.
return array Lock information.

getLocks() public method

Return a list of valid locks with the option to limit the results by principal, scope and/or type.
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
return 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() public method

Extend the valid lifetime of a valid lock to now + $extend.
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.
return boolean Returns true on success.

setLock() public method

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.
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.
return mixed A string lock ID.