phpcr/src/PHPCR/Lock/LockException.php

Show: PublicProtectedPrivateinherited
Table of Contents
This file is part of the PHPCR API and was originally ported from the Java JCR API to PHP by Karsten Dambekalns for the FLOW3 project.

Copyright 2008-2011 Karsten Dambekalns karsten@typo3.org

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

License
Apache Software License 2.0  
Link
http://phpcr.github.com/  

\PHPCR\Lock\LockException

Package: Default
Exception thrown when a lock-related error occurs.

May contain an error message and/or another nested exception.

Parent(s)
\PHPCR\RepositoryException < \RuntimeException
Api
 
Author
Karsten Dambekalns  

Properties

>VPropertyprotectedstring $failureNodePath
Absolute path of the node that caused the error, in normalized, standard form, that is, each path segment must be a JCR name in qualified form, the path must have no trailing slash, no self or parent segments and no [1] indexes.
Details
Type
string

Methods

methodpublic__construct(string $message, integer $code = 0, string $failureNodePath = null) : void

If a path is passed it must be an absolute path in normalized, standard form, that is, each path segment must be a JCR name in qualified form, the path must have no trailing slash, no self or parent segments and no [1] indexes.

Parameters
NameTypeDescription
$messagestring

The exception message

$codeinteger

The exception error code

$failureNodePathstring

the absolute path of the node that caused the error or null if the implementation chooses not to, or cannot, return a path.

Details
Api
 
methodpublicgetFailureNodePath() : string

Returns the absolute path of the node that caused the error or null if the implementation chooses not to, or cannot, return a path.

Returns
TypeDescription
stringpath of the node that caused the error
Details
Api
 
Documentation was generated by phpDocumentor 2.0.0a12.