phpcr/src/PHPCR/Query/QOM/QueryObjectModelFactoryInterface.php

Show:

inherited

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.

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\Query\QOM\QueryObjectModelFactoryInterface
jump to top

Package: Default

A QueryObjectModelFactory creates instances of the JCR query object model.

Refer to QueryObjectModelInterface for a description of the query object model.

Parent(s): \PHPCR\Query\QOM\QueryObjectModelConstantsInterface
Api

Constants

 
                JCR_JOIN_TYPE_INNER
                = 'jcr.join.type.inner'

inherited

An inner join.

Inherited from: \PHPCR\Query\QOM\QueryObjectModelConstantsInterface::JCR_JOIN_TYPE_INNER

Api
Inherited_from: \PHPCR\Query\QOM\QueryObjectModelConstantsInterface::JCR_JOIN_TYPE_INNER

 
                JCR_JOIN_TYPE_LEFT_OUTER
                = 'jcr.join.type.left.outer'

inherited

A left-outer join.

Inherited from: \PHPCR\Query\QOM\QueryObjectModelConstantsInterface::JCR_JOIN_TYPE_LEFT_OUTER

Api
Inherited_from: \PHPCR\Query\QOM\QueryObjectModelConstantsInterface::JCR_JOIN_TYPE_LEFT_OUTER

 
                JCR_JOIN_TYPE_RIGHT_OUTER
                = 'jcr.join.type.right.outer'

inherited

A right-outer join.

Inherited from: \PHPCR\Query\QOM\QueryObjectModelConstantsInterface::JCR_JOIN_TYPE_RIGHT_OUTER

Api
Inherited_from: \PHPCR\Query\QOM\QueryObjectModelConstantsInterface::JCR_JOIN_TYPE_RIGHT_OUTER

 
                JCR_OPERATOR_EQUAL_TO
                = 'jcr.operator.equal.to'

inherited

The '=' comparison operator.

Inherited from: \PHPCR\Query\QOM\QueryObjectModelConstantsInterface::JCR_OPERATOR_EQUAL_TO

Api
Inherited_from: \PHPCR\Query\QOM\QueryObjectModelConstantsInterface::JCR_OPERATOR_EQUAL_TO

 
                JCR_OPERATOR_NOT_EQUAL_TO
                = 'jcr.operator.not.equal.to'

inherited

The '!=' comparison operator.

Inherited from: \PHPCR\Query\QOM\QueryObjectModelConstantsInterface::JCR_OPERATOR_NOT_EQUAL_TO

Api
Inherited_from: \PHPCR\Query\QOM\QueryObjectModelConstantsInterface::JCR_OPERATOR_NOT_EQUAL_TO

 
                JCR_OPERATOR_LESS_THAN
                = 'jcr.operator.less.than'

inherited

The '<' comparison operator.

Inherited from: \PHPCR\Query\QOM\QueryObjectModelConstantsInterface::JCR_OPERATOR_LESS_THAN

Api
Inherited_from: \PHPCR\Query\QOM\QueryObjectModelConstantsInterface::JCR_OPERATOR_LESS_THAN

 
                JCR_OPERATOR_LESS_THAN_OR_EQUAL_TO
                = 'jcr.operator.less.than.or.equal.to'

inherited

The '<=' comparison operator.

Inherited from: \PHPCR\Query\QOM\QueryObjectModelConstantsInterface::JCR_OPERATOR_LESS_THAN_OR_EQUAL_TO

Api
Inherited_from: \PHPCR\Query\QOM\QueryObjectModelConstantsInterface::JCR_OPERATOR_LESS_THAN_OR_EQUAL_TO

 
                JCR_OPERATOR_GREATER_THAN
                = 'jcr.operator.greater.than'

inherited

The '>' comparison operator.

Inherited from: \PHPCR\Query\QOM\QueryObjectModelConstantsInterface::JCR_OPERATOR_GREATER_THAN

Api
Inherited_from: \PHPCR\Query\QOM\QueryObjectModelConstantsInterface::JCR_OPERATOR_GREATER_THAN

 
                JCR_OPERATOR_GREATER_THAN_OR_EQUAL_TO
                = 'jcr.operator.greater.than.or.equal.to'

inherited

The '>=' comparison operator.

Inherited from: \PHPCR\Query\QOM\QueryObjectModelConstantsInterface::JCR_OPERATOR_GREATER_THAN_OR_EQUAL_TO

Api
Inherited_from: \PHPCR\Query\QOM\QueryObjectModelConstantsInterface::JCR_OPERATOR_GREATER_THAN_OR_EQUAL_TO

 
                JCR_OPERATOR_LIKE
                = 'jcr.operator.like'

inherited

The 'like' comparison operator.

Inherited from: \PHPCR\Query\QOM\QueryObjectModelConstantsInterface::JCR_OPERATOR_LIKE

Api
Inherited_from: \PHPCR\Query\QOM\QueryObjectModelConstantsInterface::JCR_OPERATOR_LIKE

 
                JCR_ORDER_ASCENDING
                = 'jcr.order.ascending'

inherited

Ascending order.

Inherited from: \PHPCR\Query\QOM\QueryObjectModelConstantsInterface::JCR_ORDER_ASCENDING

Api
Inherited_from: \PHPCR\Query\QOM\QueryObjectModelConstantsInterface::JCR_ORDER_ASCENDING

 
                JCR_ORDER_DESCENDING
                = 'jcr.order.descending'

inherited

Descending order.

Inherited from: \PHPCR\Query\QOM\QueryObjectModelConstantsInterface::JCR_ORDER_DESCENDING

Api
Inherited_from: \PHPCR\Query\QOM\QueryObjectModelConstantsInterface::JCR_ORDER_DESCENDING

Methods

andConstraint(\PHPCR\Query\QOM\ConstraintInterface $constraint1, \PHPCR\Query\QOM\ConstraintInterface $constraint2) : \PHPCR\Query\QOM\AndInterface

Performs a logical conjunction of two other constraints.

Parameters

Name	Type	Description
$constraint1	\PHPCR\Query\QOM\ConstraintInterface	the first constraint; non-null
$constraint2	\PHPCR\Query\QOM\ConstraintInterface	the second constraint; non-null

Returns

Type	Description
\PHPCR\Query\QOM\AndInterface	the And constraint; non-null

Throws

Exception	Description
\PHPCR\Query\InvalidQueryException	if a particular validity test is possible on this method, the implementation chooses to perform that test (and not leave it until later) on createQuery, and the parameters given fail that test
\PHPCR\RepositoryException	if the operation otherwise fails

Details

Api

ascending(\PHPCR\Query\QOM\DynamicOperandInterface $operand) : \PHPCR\Query\QOM\OrderingInterface

Orders by the value of the specified operand, in ascending order.

The query is invalid if $operand does not evaluate to a scalar value.

Parameters

Name	Type	Description
$operand	\PHPCR\Query\QOM\DynamicOperandInterface	the operand by which to order; non-null

Returns

Type	Description
\PHPCR\Query\QOM\OrderingInterface	the ordering

Throws

Exception	Description
\PHPCR\Query\InvalidQueryException	if the query is invalid
\PHPCR\RepositoryException	if the operation otherwise fails

Details

Api

bindVariable(string $bindVariableName) : \PHPCR\Query\QOM\BindVariableValueInterface

Evaluates to the value of a bind variable.

The query is invalid if $bindVariableName is not a valid JCR prefix.

Parameters

Name	Type	Description
$bindVariableName	string	the bind variable name; non-null

Returns

Type	Description
\PHPCR\Query\QOM\BindVariableValueInterface	the operand; non-null

Throws

Exception	Description
\PHPCR\Query\InvalidQueryException	if a particular validity test is possible on this method, the implementation chooses to perform that test (and not leave it until later) on createQuery, and the parameters given fail that test
\PHPCR\RepositoryException	if the operation otherwise fails

Details

Api

childNode(string $path, string $selectorName = null) : \PHPCR\Query\QOM\ChildNodeInterface

Tests whether a node in the specified or default selector is a child of a node reachable by a specified absolute path.

The query is invalid if:

$selectorName is not the name of a selector in the query
$path is not a syntactically valid absolute path Note: however, that if the path is syntactically valid but does not identify a node in the repository (or the node is not visible to this session, because of access control constraints), the query is valid but the constraint is not satisfied.

Parameters

Name	Type	Description
$path	string	an absolute path; non-null
$selectorName	string	the selector name; non-null

Returns

Type	Description
\PHPCR\Query\QOM\ChildNodeInterface	the constraint; non-null

Throws

Exception	Description
\PHPCR\Query\InvalidQueryException	if a particular validity test is possible on this method, the implementation chooses to perform that test (and not leave it until later) on createQuery, and the parameters given fail that test
\PHPCR\RepositoryException	if the operation otherwise fails

Details

Api

childNodeJoinCondition(string $childSelectorName, string $parentSelectorName) : \PHPCR\Query\QOM\ChildNodeJoinConditionInterface

Tests whether a first selector's node is a child of a second selector's node.

The query is invalid if:

$childSelector is not the name of a selector in the query
$parentSelector is not the name of a selector in the query
$childSelector is the same as $parentSelector

Parameters

Name	Type	Description
$childSelectorName	string	the name of the child selector; non-null
$parentSelectorName	string	the name of the parent selector; non-null

Returns

Type	Description
\PHPCR\Query\QOM\ChildNodeJoinConditionInterface	the constraint; non-null

Throws

Exception	Description
\PHPCR\Query\InvalidQueryException	if a particular validity test is possible on this method, the implementation chooses to perform that test (and not leave it until later) on createQuery, and the parameters given fail that test
\PHPCR\RepositoryException	if the operation otherwise fails

Details

Api

column(string $propertyName, string $columnName = null, string $selectorName = null) : \PHPCR\Query\QOM\ColumnInterface

Identifies a property in the specified or default selector to include in the tabular view of query results.

The column name is the property name if not given.

The query is invalid if:

$selectorName is not the name of a selector in the query
$propertyName is specified but it is not a syntactically valid JCR name
$propertyName is specified but does not evaluate to a scalar value
$propertyName is specified but $columnName is omitted
$propertyName is omitted but $columnName is specified
the columns in the tabular view are not uniquely named, whether those column names are specified by $columnName (if $propertyName is specified) or generated as described above (if $propertyName is omitted).

If $propertyName is specified but, for a node-tuple, the selector node does not have a property named $propertyName, the query is valid and the column has null value.

Parameters

Name	Type	Description
$propertyName	string	the property name, or null to include a column for each single-value non-residual property of the selector's node type
$columnName	string	the column name; must be null if propertyName is null
$selectorName	string	the selector name; non-null

Returns

Type	Description
\PHPCR\Query\QOM\ColumnInterface	the column; non-null

Throws

Exception	Description
\PHPCR\Query\InvalidQueryException	if the query has no default selector or is otherwise invalid
\PHPCR\RepositoryException	if the operation otherwise fails

Details

Api

comparison(\PHPCR\Query\QOM\DynamicOperandInterface $operand1, string $operator, \PHPCR\Query\QOM\StaticOperandInterface $operand2) : \PHPCR\Query\QOM\ComparisonInterface

Filters node-tuples based on the outcome of a binary operation.

Parameters

Name	Type	Description
$operand1	\PHPCR\Query\QOM\DynamicOperandInterface	the first operand; non-null
$operator	string	the operator; one of QueryObjectModelConstants.JCR_OPERATOR_*
$operand2	\PHPCR\Query\QOM\StaticOperandInterface	the second operand; non-null

Returns

Type	Description
\PHPCR\Query\QOM\ComparisonInterface	the constraint; non-null

Throws

Exception	Description
\PHPCR\Query\InvalidQueryException	if a particular validity test is possible on this method, the implementation chooses to perform that test (and not leave it until later) on createQuery, and the parameters given fail that test
\PHPCR\RepositoryException	if the operation otherwise fails

Details

Api

createQuery(\PHPCR\Query\QOM\SourceInterface $source, \PHPCR\Query\QOM\ConstraintInterface $constraint = null, array $orderings = array(), array $columns = array()) : \PHPCR\Query\QOM\QueryObjectModelInterface

Creates a query with one or more selectors.

If source is a selector, that selector is the default selector of the query. Otherwise the query does not have a default selector.

If the query is invalid, this method throws an InvalidQueryException. See the individual QOM factory methods for the validity criteria of each query element.

Parameters

Name	Type	Description
$source	\PHPCR\Query\QOM\SourceInterface	the Selector or the node-tuple Source; non-null
$constraint	\PHPCR\Query\QOM\ConstraintInterface	the constraint, or null if none
$orderings	array	zero (empty array) or more instances of Ordering
$columns	array	the array of Column definitions to return in the result. empty array is equivalent to the in SQL2, meaning some fields.*

Returns

Type	Description
\PHPCR\Query\QOM\QueryObjectModelInterface	the query; non-null

Throws

Exception	Description
\PHPCR\Query\InvalidQueryException	if a particular validity test is possible on this method, the implementation chooses to perform that test and the parameters given fail that test. See the individual QOM factory methods for the validity criteria of each query element.
\PHPCR\RepositoryException	if another error occurs.

Details

Api

descendantNode(string $path, string $selectorName = null) : \PHPCR\Query\QOM\DescendantNodeInterface

Tests whether a node in the specified or default selector is a descendant of a node reachable by a specified absolute path.

The query is invalid if:

$selectorName is not the name of a selector in the query
$path is not a syntactically valid absolute path Note: however, that if the path is syntactically valid but does not identify a node in the repository (or the node is not visible to this session, because of access control constraints), the query is valid but the constraint is not satisfied.

Parameters

Name	Type	Description
$path	string	an absolute path; non-null
$selectorName	string	the selector name; non-null

Returns

Type	Description
\PHPCR\Query\QOM\DescendantNodeInterface	the constraint; non-null

Throws

Exception	Description
\PHPCR\Query\InvalidQueryException	if a particular validity test is possible on this method, the implementation chooses to perform that test (and not leave it until later) on createQuery, and the parameters given fail that test
\PHPCR\RepositoryException	if the operation otherwise fails

Details

Api

descendantNodeJoinCondition(string $descendantSelectorName, string $ancestorSelectorName) : \PHPCR\Query\QOM\DescendantNodeJoinConditionInterface

Tests whether a first selector's node is a descendant of a second selector's node.

The query is invalid if:

$descendantSelector is not the name of a selector in the query
$ancestorSelector is not the name of a selector in the query
$descendantSelector is the same as $ancestorSelector

Parameters

Name	Type	Description
$descendantSelectorName	string	the name of the descendant selector; non-null
$ancestorSelectorName	string	the name of the ancestor selector; non-null

Returns

Type	Description
\PHPCR\Query\QOM\DescendantNodeJoinConditionInterface	the constraint; non-null

Throws

Exception	Description
\PHPCR\Query\InvalidQueryException	if a particular validity test is possible on this method, the implementation chooses to perform that test (and not leave it until later) on createQuery, and the parameters given fail that test
\PHPCR\RepositoryException	if the operation otherwise fails

Details

Api

descending(\PHPCR\Query\QOM\DynamicOperandInterface $operand) : \PHPCR\Query\QOM\OrderingInterface

Orders by the value of the specified operand, in descending order.

The query is invalid if $operand does not evaluate to a scalar value.

Parameters

Name	Type	Description
$operand	\PHPCR\Query\QOM\DynamicOperandInterface	the operand by which to order; non-null

Returns

Type	Description
\PHPCR\Query\QOM\OrderingInterface	the ordering

Throws

Exception	Description
\PHPCR\Query\InvalidQueryException	if the query is invalid
\PHPCR\RepositoryException	if the operation otherwise fails

Details

Api

equiJoinCondition(string $selector1Name, string $property1Name, string $selector2Name, string $property2Name) : \PHPCR\Query\QOM\EquiJoinConditionInterface

Tests whether the value of a property in a first selector is equal to the value of a property in a second selector.

The query is invalid if:

$selector1 is not the name of a selector in the query, or
$selector2 is not the name of a selector in the query, or
$selector1 is the same as $selector2, or
$property1 is not a syntactically valid JCR name, or
$property2 is not a syntactically valid JCR name, or
the value of $property1 is not the same property type as the value of $property2, or
$property1 is a multi-valued property, or
$property2 is a multi-valued property, or
$property1 is a BINARY property, or
$property2 is a BINARY property.

Parameters

Name	Type	Description
$selector1Name	string	the name of the first selector; non-null
$property1Name	string	the property name in the first selector; non-null
$selector2Name	string	the name of the second selector; non-null
$property2Name	string	the property name in the second selector; non-null

Returns

Type	Description
\PHPCR\Query\QOM\EquiJoinConditionInterface	the constraint; non-null

Throws

Exception	Description
\PHPCR\Query\InvalidQueryException	if a particular validity test is possible on this method, the implementation chooses to perform that test (and not leave it until later) on createQuery, and the parameters given fail that test
\PHPCR\RepositoryException	if the operation otherwise fails

Details

Api

fullTextSearch(string $propertyName, string $fullTextSearchExpression, string $selectorName = null) : \PHPCR\Query\QOM\FullTextSearchInterface

Performs a full-text search against the specified or default selector.

The query is invalid if:

$selectorName is not the name of a selector in the query
$propertyName is specified but is not a syntactically valid JCR name
$fullTextSearchExpression does not conform to the full text search grammar

If $propertyName is specified but, for a node-tuple, the selector node does not have a property named $propertyName, the query is valid but the constraint is not satisfied.

Parameters

Name	Type	Description
$propertyName	string	the property name, or null to search all full-text indexed properties of the node (or node subgraph, in some implementations);
$fullTextSearchExpression	string	the full-text search expression; non-null
$selectorName	string	the selector name; non-null

Returns

Type	Description
\PHPCR\Query\QOM\FullTextSearchInterface	the constraint; non-null

Throws

Exception	Description
\PHPCR\Query\InvalidQueryException	if a particular validity test is possible on this method, the implementation chooses to perform that test (and not leave it until later) on createQuery, and the parameters given fail that test
\PHPCR\RepositoryException	if the operation otherwise fails

Details

Api

fullTextSearchScore(string $selectorName = null) : \PHPCR\Query\QOM\FullTextSearchScoreInterface

Evaluates to a DOUBLE value equal to the full-text search score of a node in the specified or default selector.

The query is invalid if $selectorName is not the name of a selector in the query.

Parameters

Name	Type	Description
$selectorName	string	the selector name; non-null

Returns

Type	Description
\PHPCR\Query\QOM\FullTextSearchScoreInterface	the operand; non-null

Throws

Exception	Description
\PHPCR\Query\InvalidQueryException	if a particular validity test is possible on this method, the implementation chooses to perform that test (and not leave it until later) on createQuery, and the parameters given fail that test
\PHPCR\RepositoryException	if the operation otherwise fails

Details

Api

join(\PHPCR\Query\QOM\SourceInterface $left, \PHPCR\Query\QOM\SourceInterface $right, string $joinType, \PHPCR\Query\QOM\JoinConditionInterface $joinCondition) : \PHPCR\Query\QOM\JoinInterface

Performs a join between two node-tuple sources.

The query is invalid if $left is the same source as $right.

Parameters

Name	Type	Description
$left	\PHPCR\Query\QOM\SourceInterface	the left node-tuple source; non-null
$right	\PHPCR\Query\QOM\SourceInterface	the right node-tuple source; non-null
$joinType	string	one of QueryObjectModelConstants.JCR_JOIN_TYPE_*
$joinCondition	\PHPCR\Query\QOM\JoinConditionInterface	the join condition; non-null

Returns

Type	Description
\PHPCR\Query\QOM\JoinInterface	the join; non-null

Throws

Exception	Description
\PHPCR\Query\InvalidQueryException	if a particular validity test is possible on this method, the implementation chooses to perform that test (and not leave it until later) on createQuery, and the parameters given fail that test
\PHPCR\RepositoryException	if the operation otherwise fails

Details

Api

length(\PHPCR\Query\QOM\PropertyValueInterface $propertyValue) : \PHPCR\Query\QOM\LengthInterface

Evaluates to the length (or lengths, if multi-valued) of a property.

Parameters

Name	Type	Description
$propertyValue	\PHPCR\Query\QOM\PropertyValueInterface	the property value for which to compute the length; non-null

Returns

Type	Description
\PHPCR\Query\QOM\LengthInterface	the operand; non-null

Throws

Exception	Description
\PHPCR\Query\InvalidQueryException	if a particular validity test is possible on this method, the implementation chooses to perform that test (and not leave it until later) on createQuery, and the parameters given fail that test
\PHPCR\RepositoryException	if the operation otherwise fails

Details

Api

literal(mixed $literalValue) : mixed

Evaluates to a literal value.

The query is invalid if no value is bound to $literalValue.

Parameters

Name	Type	Description
$literalValue	mixed	the value

Returns

Type	Description
mixed	the operand; non-null

Throws

Exception	Description
\PHPCR\Query\InvalidQueryException	if a particular validity test is possible on this method, the implementation chooses to perform that test (and not leave it until later) on createQuery, and the parameters given fail that test
\PHPCR\RepositoryException	if the operation otherwise fails

Details

Api

lowerCase(\PHPCR\Query\QOM\DynamicOperandInterface $operand) : \PHPCR\Query\QOM\LowerCaseInterface

Evaluates to the lower-case string value (or values, if multi-valued) of an operand.

Parameters

Name	Type	Description
$operand	\PHPCR\Query\QOM\DynamicOperandInterface	the operand whose value is converted to a lower-case string; non-null

Returns

Type	Description
\PHPCR\Query\QOM\LowerCaseInterface	the operand; non-null

Throws

Exception	Description
\PHPCR\Query\InvalidQueryException	if a particular validity test is possible on this method, the implementation chooses to perform that test (and not leave it until later) on createQuery, and the parameters given fail that test
\PHPCR\RepositoryException	if the operation otherwise fails

Details

Api

nodeLocalName(string $selectorName = null) : \PHPCR\Query\QOM\NodeLocalNameInterface

Evaluates to a NAME value equal to the local (unprefixed) name of a node in the specified or default selector.

The query is invalid if $selectorName is not the name of a selector in the query.

Parameters

Name	Type	Description
$selectorName	string	the selector name; non-null

Returns

Type	Description
\PHPCR\Query\QOM\NodeLocalNameInterface	the operand; non-null

Throws

Exception	Description
\PHPCR\Query\InvalidQueryException	if the query is invalid
\PHPCR\RepositoryException	if the operation otherwise fails

Details

Api

nodeName(string $selectorName = null) : \PHPCR\Query\QOM\NodeNameInterface

Evaluates to a NAME value equal to the prefix-qualified name of a node in the specified or default selector.

The query is invalid if $selectorName is not the name of a selector in the query.

Parameters

Name	Type	Description
$selectorName	string	the selector name; non-null

Returns

Type	Description
\PHPCR\Query\QOM\NodeNameInterface	the operand; non-null

Throws

Exception	Description
\PHPCR\Query\InvalidQueryException	if a particular validity test is possible on this method, the implementation chooses to perform that test (and not leave it until later) on createQuery, and the parameters given fail that test
\PHPCR\RepositoryException	if the operation otherwise fails

Details

Api

notConstraint(\PHPCR\Query\QOM\ConstraintInterface $constraint) : \PHPCR\Query\QOM\NotInterface

Performs a logical negation of another constraint.

Parameters

Name	Type	Description
$constraint	\PHPCR\Query\QOM\ConstraintInterface	the constraint to be negated; non-null

Returns

Type	Description
\PHPCR\Query\QOM\NotInterface	the Not constraint; non-null

Throws

Exception	Description
\PHPCR\Query\InvalidQueryException	if a particular validity test is possible on this method, the implementation chooses to perform that test (and not leave it until later) on createQuery, and the parameters given fail that test
\PHPCR\RepositoryException	if the operation otherwise fails

Details

Api

orConstraint(\PHPCR\Query\QOM\ConstraintInterface $constraint1, \PHPCR\Query\QOM\ConstraintInterface $constraint2) : \PHPCR\Query\QOM\OrInterface

Performs a logical disjunction of two other constraints.

Parameters

Name	Type	Description
$constraint1	\PHPCR\Query\QOM\ConstraintInterface	the first constraint; non-null
$constraint2	\PHPCR\Query\QOM\ConstraintInterface	the second constraint; non-null

Returns

Type	Description
\PHPCR\Query\QOM\OrInterface	the Or constraint; non-null

Throws

Exception	Description
\PHPCR\Query\InvalidQueryException	if a particular validity test is possible on this method, the implementation chooses to perform that test (and not leave it until later) on createQuery, and the parameters given fail that test
\PHPCR\RepositoryException	if the operation otherwise fails

Details

Api

propertyExistence(string $propertyName, string $selectorName = null) : \PHPCR\Query\QOM\PropertyExistenceInterface

Tests the existence of a property in the specified or default selector.

The query is invalid if:

$propertyName is not a syntactically valid JCR name
$selectorName is not the name of a selector in the query

Parameters

Name	Type	Description
$propertyName	string	the property name; non-null
$selectorName	string	the selector name; non-null

Returns

Type	Description
\PHPCR\Query\QOM\PropertyExistenceInterface	the constraint; non-null

Throws

Exception	Description
\PHPCR\Query\InvalidQueryException	if a particular validity test is possible on this method, the implementation chooses to perform that test (and not leave it until later) on createQuery, and the parameters given fail that test
\PHPCR\RepositoryException	if the operation otherwise fails

Details

Api

propertyValue(string $propertyName, string $selectorName = null) : \PHPCR\Query\QOM\PropertyValueInterface

Evaluates to the value (or values, if multi-valued) of a property in the specified or default selector.

The query is invalid if: - $selectorName is not the name of a selector in the query - $propertyName is not a syntactically valid JCR name

Parameters

Name	Type	Description
$propertyName	string	the property name; non-null
$selectorName	string	the selector name; non-null

Returns

Type	Description
\PHPCR\Query\QOM\PropertyValueInterface	the operand; non-null

Throws

Exception	Description
\PHPCR\Query\InvalidQueryException	if the query is invalid
\PHPCR\RepositoryException	if the operation otherwise fails

Details

Api

sameNode(string $path, string $selectorName = null) : \PHPCR\Query\QOM\SameNodeInterface

Tests whether a node in the specified or default selector is reachable by a specified absolute path.

The query is invalid if:

$selectorName is not the name of a selector in the query
$path is not a syntactically valid absolute path. Note: however, that if the path is syntactically valid but does not identify a node in the repository (or the node is not visible to this session, because of access control constraints), the query is valid but the constraint is not satisfied.

Parameters

Name	Type	Description
$path	string	an absolute path; non-null
$selectorName	string	the selector name; non-null

Returns

Type	Description
\PHPCR\Query\QOM\SameNodeInterface	the constraint; non-null

Throws

Exception	Description
\PHPCR\Query\InvalidQueryException	if the query is invalid
\PHPCR\RepositoryException	if the operation otherwise fails

Details

Api

sameNodeJoinCondition(string $selector1Name, string $selector2Name, string $selector2Path = null) : \PHPCR\Query\QOM\SameNodeJoinConditionInterface

Tests whether a first selector's node is the same as a node identified by relative path from a second selector's node.

The query is invalid if:

$selector1 is not the name of a selector in the query, or
$selector2 is not the name of a selector in the query, or
$selector1 is the same as $selector2, or
$selector2Path is not a syntactically valid relative path. Note: however, that if the path is syntactically valid but does not identify a node visible to the current session, the query is valid but the constraint is not satisfied.

Parameters

Name	Type	Description
$selector1Name	string	the name of the first selector; non-null
$selector2Name	string	the name of the second selector; non-null
$selector2Path	string	the path relative to the second selector; non-null

Returns

Type	Description
\PHPCR\Query\QOM\SameNodeJoinConditionInterface	the constraint; non-null

Throws

Exception	Description
\PHPCR\Query\InvalidQueryException	if a particular validity test is possible on this method, the implementation chooses to perform that test (and not leave it until later) on createQuery, and the parameters given fail that test
\PHPCR\RepositoryException	if the operation otherwise fails

Details

Api

selector(string $nodeTypeName, string $selectorName = null) : \PHPCR\Query\QOM\SelectorInterface

Selects a subset of the nodes in the repository based on node type.

The query is invalid if $nodeTypeName or $selectorName is not a syntactically valid JCR name.

The query is invalid if $selectorName is identical to the name of another selector in the query.

If $nodeTypeName is a valid JCR name but not the name of a node type available in the repository, the query is valid but the selector selects no nodes.

Parameters

Name	Type	Description
$nodeTypeName	string	the name of the required node type; non-null
$selectorName	string	the selector name; non-null

Returns

Type	Description
\PHPCR\Query\QOM\SelectorInterface	the selector; non-null

Throws

Exception	Description
\PHPCR\Query\InvalidQueryException	if a particular validity test is possible on this method, the implementation chooses to perform that test (and not leave it until later) on createQuery, and the parameters given fail that test
\PHPCR\RepositoryException	if the operation otherwise fails

Details

Api

upperCase(\PHPCR\Query\QOM\DynamicOperandInterface $operand) : \PHPCR\Query\QOM\UpperCaseInterface

Evaluates to the upper-case string value (or values, if multi-valued) of an operand.

Parameters

Name	Type	Description
$operand	\PHPCR\Query\QOM\DynamicOperandInterface	the operand whose value is converted to a upper-case string; non-null

Returns

Type	Description
\PHPCR\Query\QOM\UpperCaseInterface	the operand; non-null

Throws

Exception	Description
\PHPCR\Query\InvalidQueryException	if a particular validity test is possible on this method, the implementation chooses to perform that test (and not leave it until later) on createQuery, and the parameters given fail that test
\PHPCR\RepositoryException	if the operation otherwise fails

Details

Api

phpcr/src/PHPCR/Query/QOM/QueryObjectModelFactoryInterface.php

\PHPCR\Query\QOM\QueryObjectModelFactoryInterfacejump to top

Constants

Methods

\PHPCR\Query\QOM\QueryObjectModelFactoryInterface
jump to top