1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
<?php
/**
* A null driver for Horde_Lock.
*
* Copyright 2010-2014 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 <slusarz@horde.org>
* @category Horde
* @package Lock
*/
class Horde_Lock_Null extends Horde_Lock
{
/**
* Return an array of information about the requested lock.
*
* @param string $lockid Lock ID to look up.
*
* @return array Lock information.
* @throws Horde_Lock_Exception
*/
public function getLockInfo($lockid)
{
return array();
}
/**
* Return a list of valid locks with the option to limit the results
* by principal, scope and/or type.
*
* @param string $scope The scope of the lock. Typically the name of
* the application requesting the lock or some
* other identifier used to group locks together.
* @param string $principal Principal for which to check for locks
* @param integer $type 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.
* @throws Horde_Lock_Exception
*/
public function getLocks($scope = null, $principal = null, $type = null)
{
return array();
}
/**
* Extend the valid lifetime of a valid lock to now + $extend.
*
* @param string $lockid Lock ID to reset. Must be a valid, non-expired
* lock.
* @param integer $extend Extend lock this many seconds from now.
*
* @return boolean Returns true on success.
* @throws Horde_Lock_Exception
*/
public function resetLock($lockid, $extend)
{
return true;
}
/**
* 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.
*
* @param string $requestor User ID of the lock requestor.
* @param string $scope The scope of the lock. Typically the name of
* the application requesting the lock or some
* other identifier used to group locks
* together.
* @param string $principal A principal on which a lock should be
* granted. The format can be any string but is
* suggested to be in URI form.
* @param integer $lifetime Time (in seconds) for which the lock will be
* considered valid.
* @param string exclusive One of Horde_Lock::TYPE_SHARED or
* Horde_Lock::TYPE_EXCLUSIVE.
* - An exclusive lock will be enforced strictly
* and must be interpreted to mean that the
* resource can not be modified. Only one
* exclusive lock per principal is allowed.
* - A shared lock is one that notifies other
* potential lock requestors that the resource
* is in use. This lock can be overridden
* (cleared or replaced with a subsequent
* call to setLock()) by other users. Multiple
* users may request (and will be granted) a
* shared lock on a given principal. All locks
* will be considered valid until they are
* cleared or expire.
*
* @return mixed A string lock ID.
* @throws Horde_Lock_Exception
*/
public function setLock($requestor, $scope, $principal, $lifetime = 1,
$exclusive = Horde_Lock::TYPE_SHARED)
{
return strval(new Horde_Support_Uuid());
}
/**
* Removes a lock given the 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 cleared.
*
* @param string $lockid The lock ID as generated by a previous call
* to setLock()
*
* @return boolean Returns true on success.
* @throws Horde_Lock_Exception
*/
public function clearLock($lockid)
{
return true;
}
}
|
