API Documentation
\

\Horde_Dav_Locks

A locking backend.

Summary

Methods
Properties
Constants
__construct()
getLocks()
lock()
unlock()
No public properties found
No constants found
No protected methods found
$_registry
$_lock
N/A
No private methods found
No private properties found
N/A

Properties

$_registry

$_registry : \Horde_Registry

A registry object.

Type

\Horde_Registry

$_lock

$_lock : \Horde_Lock

A lock handler

Type

\Horde_Lock

Methods

__construct()

__construct(\Horde_Registry  $registry, \Horde_Lock  $lock)

Constructor.

Parameters

\Horde_Registry $registry

A registry object.
\Horde_Lock $lock

A lock object.

getLocks()

getLocks(string  $uri, boolean  $returnChildLocks) : array

Returns a list of Sabre\DAV\Locks\LockInfo objects

This method should return all the locks for a particular uri, including locks that might be set on a parent uri.

If returnChildLocks is set to true, this method should also look for any locks in the subtree of the uri for locks.

Parameters

string $uri
boolean $returnChildLocks

Returns

array

lock()

lock(string  $uri, \Sabre\DAV\Locks\LockInfo  $lockInfo) : boolean

Locks a uri

Parameters

string $uri
\Sabre\DAV\Locks\LockInfo $lockInfo

Returns

boolean

unlock()

unlock(string  $uri, \Sabre\DAV\Locks\LockInfo  $lockInfo) : boolean

Removes a lock from a uri

Parameters

string $uri
\Sabre\DAV\Locks\LockInfo $lockInfo

Returns

boolean