PHP Class Jackalope\Query\Query

This can never be legally created if the transport does not implement QueryInterface.

Inheritance: implements PHPCR\Query\QueryInterface

Show file Open project: jackalope/jackalope Class Usage Examples

Protected Properties

Property	Type	Description
$factory	Jackalope\FactoryInterface	The factory to instantiate objects
$limit	integer	Limit for the query
$objectManager	Jackalope\ObjectManager	The object manager to execute the query with.
$offset	integer	Offset to start results from
$path	string	If this is a stored query, the path to the node that stores this query.
$statement	string	The query statement

Public Methods

Method	Description
__construct ( Jackalope\FactoryInterface $factory, string $statement, ObjectManager $objectManager = null, string $path = null )	Create a new query instance
bindValue ( $varName, $value )	{@inheritDoc}
cancel ( )	{@inheritDoc}
execute ( )	{@inheritDoc}
getBindVariableNames ( )	{@inheritDoc}
getLimit ( ) : integer	Access the limit from the transport layer
getOffset ( ) : integer	Access the offset from the transport layer
getStatement ( )	{@inheritDoc}
getStoredQueryPath ( )	{@inheritDoc}
setLimit ( $limit )	{@inheritDoc}
setOffset ( $offset )	{@inheritDoc}
storeAsNode ( $absPath )	{@inheritDoc}

Method Details

__construct() public method

Create a new query instance

public __construct ( Jackalope\FactoryInterface $factory, string $statement, ObjectManager $objectManager = null, string $path = null )
$factory	Jackalope\FactoryInterface	the object factory
$statement	string	The statement for this query
$objectManager	Jackalope\ObjectManager	(can be omitted if you do not want to execute the query but just use it with a parser)
$path	string	If this query is loaded from workspace with QueryManager::getQuery(), path has to be provided here

bindValue() public method

{@inheritDoc}

public bindValue ( $varName, $value )

cancel() public method

{@inheritDoc}

public cancel ( )

execute() public method

{@inheritDoc}

public execute ( )

getBindVariableNames() public method

{@inheritDoc}

public getBindVariableNames ( )

getLimit() public method

Access the limit from the transport layer

public getLimit ( ) : integer
return	integer	the limit set with setLimit

getOffset() public method

Access the offset from the transport layer

public getOffset ( ) : integer
return	integer	the offset set with setOffset

getStatement() public method

{@inheritDoc}

public getStatement ( )

getStoredQueryPath() public method

{@inheritDoc}

public getStoredQueryPath ( )

setLimit() public method

{@inheritDoc}

public setLimit ( $limit )

setOffset() public method

{@inheritDoc}

public setOffset ( $offset )

storeAsNode() public method

{@inheritDoc}

public storeAsNode ( $absPath )

Property Details

$factory protected property

The factory to instantiate objects

protected FactoryInterface,Jackalope $factory
return	Jackalope\FactoryInterface

$limit protected property

Limit for the query

protected int $limit
return	integer

$objectManager protected property

The object manager to execute the query with.

protected ObjectManager,Jackalope $objectManager
return	Jackalope\ObjectManager

$offset protected property

Offset to start results from

protected int $offset
return	integer

$path protected property

If this is a stored query, the path to the node that stores this query.

protected string $path
return	string

$statement protected property

The query statement

protected string $statement
return	string