Commit | Line | Data |
---|---|---|
10760fa1 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
10760fa1 | 5 | +--------------------------------------------------------------------+ |
6b83d5bd | 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
10760fa1 TO |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
10 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
11 | | under the terms of the GNU Affero General Public License | | |
12 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
13 | | | | |
14 | | CiviCRM is distributed in the hope that it will be useful, but | | |
15 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
16 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
17 | | See the GNU Affero General Public License for more details. | | |
18 | | | | |
19 | | You should have received a copy of the GNU Affero General Public | | |
20 | | License and the CiviCRM Licensing Exception along | | |
21 | | with this program; if not, contact CiviCRM LLC | | |
22 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
23 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
24 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
25 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | namespace Civi\Core\Lock; | |
28 | ||
29 | /** | |
30 | * | |
31 | * @package CRM | |
6b83d5bd | 32 | * @copyright CiviCRM LLC (c) 2004-2019 |
10760fa1 TO |
33 | */ |
34 | class NullLock implements LockInterface { | |
35 | ||
36 | private $hasLock = FALSE; | |
37 | ||
38 | /** | |
b8c71ffa | 39 | * Create lock. |
40 | * | |
10760fa1 | 41 | * @param string $name |
b8c71ffa | 42 | * |
10760fa1 TO |
43 | * @return static |
44 | */ | |
45 | public static function create($name) { | |
46 | return new static(); | |
47 | } | |
48 | ||
49 | /** | |
b8c71ffa | 50 | * Acquire lock. |
51 | * | |
e97c66ff | 52 | * @param int|null $timeout |
10760fa1 TO |
53 | * The number of seconds to wait to get the lock. |
54 | * For a default value, use NULL. | |
b8c71ffa | 55 | * |
10760fa1 TO |
56 | * @return bool |
57 | */ | |
58 | public function acquire($timeout = NULL) { | |
59 | $this->hasLock = TRUE; | |
60 | return TRUE; | |
61 | } | |
62 | ||
63 | /** | |
b8c71ffa | 64 | * Release lock. |
65 | * | |
10760fa1 TO |
66 | * @return bool|null|string |
67 | * Trueish/falsish. | |
68 | */ | |
69 | public function release() { | |
70 | $this->hasLock = FALSE; | |
71 | return TRUE; | |
72 | } | |
73 | ||
74 | /** | |
75 | * @return bool|null|string | |
76 | * Trueish/falsish. | |
77 | * @deprecated | |
78 | * Not supported by some locking strategies. If you need to poll, better | |
79 | * to use acquire(0). | |
80 | */ | |
81 | public function isFree() { | |
82 | return !$this->hasLock; | |
83 | } | |
84 | ||
85 | /** | |
86 | * @return bool | |
87 | */ | |
88 | public function isAcquired() { | |
89 | return $this->hasLock; | |
90 | } | |
91 | ||
92 | } |