|
29 | 29 |
|
30 | 30 | </dd></dl><h3>Methods</h3><div><a id="\PHPCR\Lock\LockManagerInterface::addLockToken()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">addLockToken</span><span class="nb-faded-text">(string $lockToken)</span> : void</code><div class="description"><p class="short_description">Adds the specified lock token to the current Session.</p></div><div class="code-tabs"><div class="long-description"><p>Holding a lock token makes the current Session the owner of the lock
|
31 | 31 | specified by that particular lock token.</p></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$lockToken</th><td>string</td><td><em><p>A lock token (a string).</p>
|
32 |
| -</em></td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/phpcr.src.PHPCR.Lock.LockException.html#\PHPCR\Lock\LockException">\PHPCR\Lock\LockException</a></td><td><em>if the specified lock token is already |
33 |
| - held by another Session and the implementation does not support |
| 32 | +</em></td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/phpcr.src.PHPCR.Lock.LockException.html#\PHPCR\Lock\LockException">\PHPCR\Lock\LockException</a></td><td><em>if the specified lock token is already held by |
| 33 | + another Session and the implementation does not support |
34 | 34 | simultaneous ownership of open-scoped locks.</em></td></tr><tr><td><a href="../files/phpcr.src.PHPCR.RepositoryException.html#\PHPCR\RepositoryException">\PHPCR\RepositoryException</a></td><td><em>if another error occurs.</em></td></tr></table><strong>Details</strong><dl class="function-info"><dt>Api</dt><dd>
|
35 | 35 |
|
36 | 36 | </dd></dl></div><div class="clear"></div></div><a id="\PHPCR\Lock\LockManagerInterface::createLockInfo()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">createLockInfo</span><span class="nb-faded-text">()</span> : <a href="../files/phpcr.src.PHPCR.Lock.LockInfoInterface.html#\PHPCR\Lock\LockInfoInterface">\PHPCR\Lock\LockInfoInterface</a></code><div class="description"><p class="short_description">Creates a ockInfo object that can then be configured and passed to the
|
|
103 | 103 | by the client; servers are free to ignore this value. If none is
|
104 | 104 | specified, the implementation chooses one (i.e. user name of
|
105 | 105 | current backend authentication credentials)</p>
|
106 |
| -</em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/phpcr.src.PHPCR.Lock.LockInterface.html#\PHPCR\Lock\LockInterface">\PHPCR\Lock\LockInterface</a></td><td>A Lock object containing a lock token.</td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/phpcr.src.PHPCR.Lock.LockException.html#\PHPCR\Lock\LockException">\PHPCR\Lock\LockException</a></td><td><em>if this node is not mix:lockable or |
107 |
| - this node is already locked or isDeep is true and a descendant node |
108 |
| - of this node already holds a lock.</em></td></tr><tr><td><a href="../files/phpcr.src.PHPCR.AccessDeniedException.html#\PHPCR\AccessDeniedException">\PHPCR\AccessDeniedException</a></td><td><em>if this session does not have |
| 106 | +</em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/phpcr.src.PHPCR.Lock.LockInterface.html#\PHPCR\Lock\LockInterface">\PHPCR\Lock\LockInterface</a></td><td>A Lock object containing a lock token.</td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/phpcr.src.PHPCR.Lock.LockException.html#\PHPCR\Lock\LockException">\PHPCR\Lock\LockException</a></td><td><em>if this node is not mix:lockable or this node is |
| 107 | + already locked or isDeep is true and a descendant node of this node |
| 108 | + already holds a lock.</em></td></tr><tr><td><a href="../files/phpcr.src.PHPCR.AccessDeniedException.html#\PHPCR\AccessDeniedException">\PHPCR\AccessDeniedException</a></td><td><em>if this session does not have |
109 | 109 | sufficient access to lock this node.</em></td></tr><tr><td><a href="../files/phpcr.src.PHPCR.InvalidItemStateException.html#\PHPCR\InvalidItemStateException">\PHPCR\InvalidItemStateException</a></td><td><em>if this node has pending
|
110 | 110 | unsaved changes.</em></td></tr><tr><td><a href="../files/phpcr.src.PHPCR.PathNotFoundException.html#\PHPCR\PathNotFoundException">\PHPCR\PathNotFoundException</a></td><td><em>if no node is found at $absPath</em></td></tr><tr><td><a href="../files/phpcr.src.PHPCR.RepositoryException.html#\PHPCR\RepositoryException">\PHPCR\RepositoryException</a></td><td><em>if another error occurs.</em></td></tr></table><strong>Details</strong><dl class="function-info"><dt>Api</dt><dd>
|
111 | 111 |
|
112 | 112 | </dd></dl></div><div class="clear"></div></div><a id="\PHPCR\Lock\LockManagerInterface::lockWithInfo()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">lockWithInfo</span><span class="nb-faded-text">(string $absPath, <a href="../files/phpcr.src.PHPCR.Lock.LockInfoInterface.html#\PHPCR\Lock\LockInfoInterface">\PHPCR\Lock\LockInfoInterface</a> $lockInfo)</span> : <a href="../files/phpcr.src.PHPCR.Lock.LockInterface.html#\PHPCR\Lock\LockInterface">\PHPCR\Lock\LockInterface</a></code><div class="description"><p class="short_description">Alternative method to lock with all the options in one configuration class.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$absPath</th><td>string</td><td><em><p>The absolute path of node to be locked</p></em></td></tr><tr><th>$lockInfo</th><td><a href="../files/phpcr.src.PHPCR.Lock.LockInfoInterface.html#\PHPCR\Lock\LockInfoInterface">\PHPCR\Lock\LockInfoInterface</a></td><td><em><p>configured with the desired
|
113 |
| - characteristics for this lock.</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/phpcr.src.PHPCR.Lock.LockInterface.html#\PHPCR\Lock\LockInterface">\PHPCR\Lock\LockInterface</a></td><td>A Lock object containing a lock token.</td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/phpcr.src.PHPCR.Lock.LockException.html#\PHPCR\Lock\LockException">\PHPCR\Lock\LockException</a></td><td><em>if this node is not mix:lockable or |
114 |
| - this node is already locked or isDeep is true and a descendant node |
115 |
| - of this node already holds a lock.</em></td></tr><tr><td><a href="../files/phpcr.src.PHPCR.AccessDeniedException.html#\PHPCR\AccessDeniedException">\PHPCR\AccessDeniedException</a></td><td><em>if this session does not have |
| 113 | + characteristics for this lock.</p></em></td></tr></table><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td><a href="../files/phpcr.src.PHPCR.Lock.LockInterface.html#\PHPCR\Lock\LockInterface">\PHPCR\Lock\LockInterface</a></td><td>A Lock object containing a lock token.</td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td><a href="../files/phpcr.src.PHPCR.Lock.LockException.html#\PHPCR\Lock\LockException">\PHPCR\Lock\LockException</a></td><td><em>if this node is not mix:lockable or this node is |
| 114 | + already locked or isDeep is true and a descendant node of this node |
| 115 | + already holds a lock.</em></td></tr><tr><td><a href="../files/phpcr.src.PHPCR.AccessDeniedException.html#\PHPCR\AccessDeniedException">\PHPCR\AccessDeniedException</a></td><td><em>if this session does not have |
116 | 116 | sufficient access to lock this node.</em></td></tr><tr><td><a href="../files/phpcr.src.PHPCR.InvalidItemStateException.html#\PHPCR\InvalidItemStateException">\PHPCR\InvalidItemStateException</a></td><td><em>if this node has pending
|
117 | 117 | unsaved changes.</em></td></tr><tr><td><a href="../files/phpcr.src.PHPCR.PathNotFoundException.html#\PHPCR\PathNotFoundException">\PHPCR\PathNotFoundException</a></td><td><em>if no node is found at $absPath</em></td></tr><tr><td><a href="../files/phpcr.src.PHPCR.RepositoryException.html#\PHPCR\RepositoryException">\PHPCR\RepositoryException</a></td><td><em>if another error occurs.</em></td></tr></table></div><div class="clear"></div></div><a id="\PHPCR\Lock\LockManagerInterface::removeLockToken()" class="anchor"></a><div class="method public"><a href="#" class="gripper"><img src="../images/icons/arrow_right.png"></img><img src="../images/icons/arrow_down.png" style="display: none;"></img></a><code class="title"><img src="../images/icons/method.png" alt="method" title="method"></img><img src="../images/icons/visibility_public.png" style="margin-right: 5px" alt="public"></img><span class="highlight">removeLockToken</span><span class="nb-faded-text">(string $lockToken)</span> : void</code><div class="description"><p class="short_description">Removes the specified lock token from this Session.</p></div><div class="code-tabs"><div class="long-description"></div><strong>Parameters</strong><table class="argument-info"><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tr><th>$lockToken</th><td>string</td><td><em><ul>
|
118 | 118 | <li>a lock token (a string)</li>
|
|
0 commit comments