Skip to content

Commit c890351

Browse files
committed
update with latest changes
1 parent 106514d commit c890351

27 files changed

+2621
-2909
lines changed

doc/html-all/content.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
<body>
1313
<div class="introduction">
1414
<h1>PHP Content Repository</h1>
15-
<p>This is the API documentation of the PHP Content Repository API based on the Java Content Repository specification (<a href="http://java.net/projects/jsr-283/">JSR-283</a>). If you know JCR, get the <a href="https://raw.github.com/phpcr/phpcr/master/doc/JCR_TO_PHPCR.txt">differences between PHPCR and JCR at a glance</a>. To learn PHPCR, please have a look at our <a href="https://github.com/phpcr/phpcr/blob/master/doc/Tutorial.md">tutorial</a>.</p>
15+
<p>This is the API documentation of the PHP Content Repository API based on the Java Content Repository specification (<a href="http://java.net/projects/jsr-283/" target="_top">JSR-283</a>). If you know JCR, get the <a target="_top" href="https://raw.github.com/phpcr/phpcr/master/doc/JCR_TO_PHPCR.txt">differences between PHPCR and JCR at a glance</a>. To learn PHPCR, please have a look at our <a href="https://github.com/phpcr/phpcr-docs/blob/master/tutorial/Tutorial.md" target="_top">tutorial</a>.</p>
1616
<p>For general information on PHPCR see <a href="http://phpcr.github.com/">phpcr.github.com</a></p>
1717
<h2>Basic Workflow</h2>
1818
<img src="images/PHPCR.png" alt="" title="PHPCR API model diagram" style="float:left; padding-right: 12px; width: 300px;" />
@@ -40,7 +40,7 @@ <h2>Basic Workflow</h2>
4040
<h2>License</h2>
4141
<p>
4242
PHPCR and this documentation are available under the
43-
<a href="http://www.apache.org/licenses/LICENSE-2.0">Apache Software License 2.0</a>.
43+
<a href="http://www.apache.org/licenses/LICENSE-2.0" target="_top">Apache Software License 2.0</a>.
4444
</p>
4545
</div>
4646
</body>

doc/html-all/files/phpcr.src.PHPCR.Lock.LockInterface.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@
6363
originally represented still exists. For example, a timeout or explicit
6464
unlock will remove a lock from a node but the Lock object
6565
corresponding to that lock may still exist, and in that case its isLive
66-
method will return false.</p></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>boolean</td><td>True, if the lock still counts, else false.</td></tr></table><strong>Throws</strong><table class="argument-info"><thead><tr><th>Exception</th><th>Description</th></tr></thead><tr><td>\PHPCR\Lock\RepositoryException</td><td><em>if an error occurs</em></td></tr></table><strong>Details</strong><dl class="function-info"><dt>Api</dt><dd>
66+
method will return false.</p></div><strong>Returns</strong><table class="argument-info"><thead><tr><th>Type</th><th>Description</th></tr></thead><tr><td>boolean</td><td>True, if the lock still counts, else false.</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.RepositoryException.html#\PHPCR\RepositoryException">\PHPCR\RepositoryException</a></td><td><em>if an error occurs</em></td></tr></table><strong>Details</strong><dl class="function-info"><dt>Api</dt><dd>
6767

6868
</dd></dl></div><div class="clear"></div></div><a id="\PHPCR\Lock\LockInterface::isLockOwningSession()" 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">isLockOwningSession</span><span class="nb-faded-text">()</span> : boolean</code><div class="description"><p class="short_description">Determines if the current session owns this lock.</p></div><div class="code-tabs"><div class="long-description"><p>Returns true if the current session is the owner of this lock, either
6969
because it is session-scoped and bound to this session or open-scoped
@@ -76,8 +76,8 @@
7676

7777
</dd></dl></div><div class="clear"></div></div><a id="\PHPCR\Lock\LockInterface::refresh()" 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">refresh</span><span class="nb-faded-text">()</span> : void</code><div class="description"><p class="short_description">If this lock's time-to-live is governed by a timer, this method resets
7878
that timer so that the lock does not timeout and expire.</p></div><div class="code-tabs"><div class="long-description"><p>If this lock's time-to-live is not governed by a timer, then this method
79-
has no effect.</p></div><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 Session does not hold the
80-
correct lock token for this lock.</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>
79+
has no effect.</p></div><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 Session does not hold the correct lock
80+
token for this lock.</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>
8181

8282
</dd></dl></div><div class="clear"></div></div></div></div></div><small class="footer">
8383
Documentation was generated by

doc/html-all/files/phpcr.src.PHPCR.Lock.LockManagerInterface.html

+8-8
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@
2929

3030
</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
3131
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
3434
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>
3535

3636
</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,16 +103,16 @@
103103
by the client; servers are free to ignore this value. If none is
104104
specified, the implementation chooses one (i.e. user name of
105105
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
109109
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
110110
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>
111111

112112
</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
116116
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
117117
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>
118118
<li>a lock token (a string)</li>

0 commit comments

Comments
 (0)