phpcr/src/PHPCR/Query/QOM/QueryObjectModelInterface.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\QueryObjectModelInterface
jump to top

Package: Default

A query in the JCR/PHPCR query object model.

The JCR query object model describes the queries that can be evaluated by a JCR repository independent of any particular query language, such as SQL.

A query consists of:

a source. When the query is evaluated, the source evaluates its selectors and the joins between them to produce a (possibly empty) set of node-tuples. This is a set of 1-tuples if the query has one selector (and therefore no joins), a set of 2-tuples if the query has two selectors (and therefore one join), a set of 3-tuples if the query has three selectors (two joins), and so forth.
an optional constraint. When the query is evaluated, the constraint filters the set of node-tuples.
a list of zero or more orderings. The orderings specify the order in which the node-tuples appear in the query results. The relative order of two node-tuples is determined by evaluating the specified orderings, in list order, untilencountering an ordering for which one node-tuple precedes the other. If no orderings are specified, or if for none of the specified orderings does one node-tuple precede the other, then the relative order of the node-tuples is implementation determined (and may be arbitrary).
a list of zero or more columns to include in the tabular view of the query results. If no columns are specified, the columns available in the tabular view are implementation determined, but minimally include, for each selector, a column for each single-valued non-residual property of the selector's node type.

The query object model representation of a query is created by factory methods in the QueryObjectModelFactory.

Parent(s): \PHPCR\Query\QueryInterface
Api

Constants

 
                JCR_JQOM
                = 'JCR-JQOM'

inherited

A string constant representing the JCR-JQOM query language.

Inherited from: \PHPCR\Query\QueryInterface::JCR_JQOM

Api
Inherited_from: \PHPCR\Query\QueryInterface::JCR_JQOM

 
                JCR_SQL2
                = 'JCR-SQL2'

inherited

A string constant representing the JCR-SQL2 query language.

Inherited from: \PHPCR\Query\QueryInterface::JCR_SQL2

Api
Inherited_from: \PHPCR\Query\QueryInterface::JCR_SQL2

 
                XPATH
                = 'xpath'

inherited

A string constant representing the (deprecated in JSR-283) XPATH query language.

Inherited from: \PHPCR\Query\QueryInterface::XPATH

Api
Inherited_from: \PHPCR\Query\QueryInterface::XPATH

 
                SQL
                = 'sql'

inherited

A string constant representing the (deprecated in JSR-283) SQL query language.

Inherited from: \PHPCR\Query\QueryInterface::SQL

Api
Inherited_from: \PHPCR\Query\QueryInterface::SQL

Methods

bindValue(string $varName, mixed $value) : void

inherited

Binds the given value to the variable named $varName.

Inherited from: \PHPCR\Query\QueryInterface::bindValue()

Parameters

Name	Type	Description
$varName	string	name of variable in query
$value	mixed	value to bind

Throws

Exception	Description
\InvalidArgumentException	if $varName is not a valid variable in this query.
\PHPCR\RepositoryException	if an error occurs.

Details

Api

execute() : \PHPCR\Query\QueryResultInterface

inherited

Executes this query and returns a QueryResult object.

Inherited from: \PHPCR\Query\QueryInterface::execute()

Returns

Type	Description
\PHPCR\Query\QueryResultInterface	a QueryResult object

Throws

Exception	Description
\PHPCR\Query\InvalidQueryException	if the query contains an unbound variable.
\PHPCR\RepositoryException	if an error occurs

Details

Api

getBindVariableNames() : array

inherited

Returns the names of the bind variables in this query.

Inherited from: \PHPCR\Query\QueryInterface::getBindVariableNames()

If this query does not contains any bind variables then an empty array is returned.

Returns

Type	Description
array	the names of the bind variables in this query.

Throws

Exception	Description
\PHPCR\RepositoryException	if an error occurs.

Details

Api

getColumns() : array

Gets the columns for this query.

Returns

Type	Description
array	a list of zero or more ColumnInterface; non-null

Details

Api

getConstraint() : \PHPCR\Query\QOM\ConstraintInterface

Gets the constraint for this query.

Returns

Type	Description
\PHPCR\Query\QOM\ConstraintInterface	the constraint, or null if none

Details

Api

getLanguage() : string

inherited

Returns the language set for this query.

Inherited from: \PHPCR\Query\QueryInterface::getLanguage()

This will be one of the query language constants returned by QueryManagerInterface::getSupportedQueryLanguages().

Returns

Type	Description
string	The query language.

Details

Api

getOrderings() : array

Gets the orderings for this query.

Returns

Type	Description
array	a list of zero or more OrderingInterface; non-null

Details

Api

getSource() : \PHPCR\Query\QOM\SourceInterface

Gets the node-tuple source for this query.

Returns

Type	Description
\PHPCR\Query\QOM\SourceInterface	the node-tuple source; non-null

Details

Api

getStatement() : string

inherited

Returns the statement defined for this query.

Inherited from: \PHPCR\Query\QueryInterface::getStatement()

If the language of this query is string-based (like JCR-SQL2), this method will return the statement that was used to create this query.

If the language of this query is JCR-JQOM, this method will return the JCR-SQL2 equivalent of the JCR-JQOM object tree.

This is the standard serialization of JCR-JQOM and is also the string stored in the jcr:statement property if the query is persisted. See storeAsNode($absPath).

Returns

Type	Description
string	The query statement.

Details

Api

getStoredQueryPath() : string

inherited

Fetches the path of the node representing this query.

Inherited from: \PHPCR\Query\QueryInterface::getStoredQueryPath()

If this is a Query object that has been stored using QueryInterface::storeAsNode() (regardless of whether it has been saved yet) or retrieved using QueryManagerInterface::getQuery()), then this method returns the path of the nt:query node that stores the query.

Returns

Type	Description
string	Path of the node representing this query.

Throws

Exception	Description
\PHPCR\ItemNotFoundException	if this query is not a stored query.
\PHPCR\RepositoryException	if another error occurs.

Details

Api

setLimit(integer $limit) : void

inherited

Sets the maximum size of the result set to limit.

Inherited from: \PHPCR\Query\QueryInterface::setLimit()

Parameters

Name	Type	Description
$limit	integer	The amount of result items to be fetched.

Details

Api

setOffset(integer $offset) : void

inherited

Sets the start offset of the result set to offset.

Inherited from: \PHPCR\Query\QueryInterface::setOffset()

Parameters

Name	Type	Description
$offset	integer	The start point of the result set from when the item shall be fetched.

Details

Api

storeAsNode(string $absPath) : \PHPCR\NodeInterface

inherited

Creates a node of type nt:query holding this query at $absPath and returns that node.

Inherited from: \PHPCR\Query\QueryInterface::storeAsNode()

This is a session-write method and therefore requires a SessionInterface::save() to dispatch the change.

The $absPath provided must not have an index on its final element. If ordering is supported by the node type of the parent node then the new node is appended to the end of the child node list.

Parameters

Name	Type	Description
$absPath	string	absolute path the query should be stored at

Returns

Type	Description
\PHPCR\NodeInterface	the newly created node.

Throws

Exception	Description
\PHPCR\ItemExistsException	if an item at the specified path already exists, same-name siblings are not allowed and this implementation performs this validation immediately.
\PHPCR\PathNotFoundException	if the specified path implies intermediary Nodes that do not exist or the last element of relPath has an index, and this implementation performs this validation immediately.
\PHPCR\NodeType\ConstraintViolationException	if a node type or implementation-specific constraint is violated or if an attempt is made to add a node as the child of a property and this implementation performs this validation immediately.
\PHPCR\Version\VersionException	if the node to which the new child is being added is read-only due to a checked-in node and this implementation performs this validation immediately.
\PHPCR\Lock\LockException	if a lock prevents the addition of the node and this implementation performs this validation immediately instead of waiting until save.
\PHPCR\UnsupportedRepositoryOperationException	in a level 1 implementation.
\PHPCR\RepositoryException	if another error occurs or if the absPath provided has an index on its final element.

Details

Api

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

\PHPCR\Query\QOM\QueryObjectModelInterfacejump to top

Constants

Methods

\PHPCR\Query\QOM\QueryObjectModelInterface
jump to top