PHP Класс Bolt\Storage\Query\ContentQueryParser

@author Ross Riley
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$contentTypes array
$directiveHandlers callable[]
$directives array
$em Bolt\Storage\EntityManager
$handlers callable[]
$identifier string
$operation string
$operations array
$params array
$query string
$services Bolt\Storage\Query\QueryInterface[]

Открытые методы

Метод Описание
__construct ( EntityManager $em, Bolt\Storage\Query\QueryInterface $queryHandler = null ) Constructor.
addDirectiveHandler ( string $key, callable $callback = null ) Adds a handler for the named directive.
addHandler ( string $operation, callable $callback ) Adds a handler AND operation for the named operation.
addOperation ( string $operation ) Adds a new operation to the list supported.
addService ( string $operation, Bolt\Storage\Query\QueryInterface $service ) Adds a service for the named operation.
fetch ( ) : QueryResultset Runs the query and fetches the results.
getContentTypes ( ) : array Returns the parsed content types.
getDirective ( string $key ) : string Returns a directive from the parsed list.
getDirectiveHandler ( string $check ) : callable Returns the handler for the named directive.
getEntityManager ( ) : EntityManager Gets the object EntityManager
getHandler ( string $operation ) : callable Returns a handler for the named operation.
getIdentifier ( ) : string Returns the parsed identifier.
getOperation ( ) : string Returns the parsed operation.
getOperations ( ) : array Getter to return the currently registered operations.
getParameter ( string $param ) : array Returns a single named parameter.
getParameters ( ) : array Returns the current parameters.
getService ( string $operation ) : Bolt\Storage\Query\QueryInterface Returns a service for the named operation.
hasDirectiveHandler ( string $check ) : boolean Returns boolean for existence of handler.
parse ( ) Parse a query.
removeOperation ( string $operation ) Removes an operation from the list supported.
runDirectives ( Bolt\Storage\Query\QueryInterface $query, array $skipDirective = [] ) This runs the callbacks attached to each directive command.
setDirective ( string $key, mixed $value ) Sets a directive for the named key.
setParameter ( string $param, mixed $value ) Sets a single input parameter.
setParameters ( array $params ) Sets the input parameters to handle.
setQuery ( string $query ) Sets the input query.

Защищенные методы

Метод Описание
parseContent ( ) Parses the content area of the querystring.
parseDirectives ( ) Directives are all of the other parameters supported by Bolt that do not relate to an actual filter query. Some examples include 'printquery', 'limit', 'order' or 'returnsingle'.
parseOperation ( ) Internal method that takes the 'query' part of the input and parses it into one of the various operations supported.
setupDefaults ( ) Internal method to initialise the default handlers.

Описание методов

__construct() публичный Метод

Constructor.
public __construct ( EntityManager $em, Bolt\Storage\Query\QueryInterface $queryHandler = null )
$em Bolt\Storage\EntityManager
$queryHandler Bolt\Storage\Query\QueryInterface

addDirectiveHandler() публичный Метод

Adds a handler for the named directive.
public addDirectiveHandler ( string $key, callable $callback = null )
$key string
$callback callable

addHandler() публичный Метод

Adds a handler AND operation for the named operation.
public addHandler ( string $operation, callable $callback )
$operation string
$callback callable

addOperation() публичный Метод

Adds a new operation to the list supported.
public addOperation ( string $operation )
$operation string name of operation to parse for

addService() публичный Метод

Adds a service for the named operation.
public addService ( string $operation, Bolt\Storage\Query\QueryInterface $service )
$operation string
$service Bolt\Storage\Query\QueryInterface

fetch() публичный Метод

Runs the query and fetches the results.
public fetch ( ) : QueryResultset
Результат QueryResultset

getContentTypes() публичный Метод

Returns the parsed content types.
public getContentTypes ( ) : array
Результат array

getDirective() публичный Метод

Returns a directive from the parsed list.
public getDirective ( string $key ) : string
$key string
Результат string

getDirectiveHandler() публичный Метод

Returns the handler for the named directive.
public getDirectiveHandler ( string $check ) : callable
$check string
Результат callable

getEntityManager() публичный Метод

Gets the object EntityManager
public getEntityManager ( ) : EntityManager
Результат Bolt\Storage\EntityManager

getHandler() публичный Метод

Returns a handler for the named operation.
public getHandler ( string $operation ) : callable
$operation string
Результат callable

getIdentifier() публичный Метод

Returns the parsed identifier.
public getIdentifier ( ) : string
Результат string

getOperation() публичный Метод

Returns the parsed operation.
public getOperation ( ) : string
Результат string

getOperations() публичный Метод

Getter to return the currently registered operations.
public getOperations ( ) : array
Результат array

getParameter() публичный Метод

Returns a single named parameter.
public getParameter ( string $param ) : array
$param string
Результат array

getParameters() публичный Метод

Returns the current parameters.
public getParameters ( ) : array
Результат array

getService() публичный Метод

Returns a service for the named operation.
public getService ( string $operation ) : Bolt\Storage\Query\QueryInterface
$operation string
Результат Bolt\Storage\Query\QueryInterface

hasDirectiveHandler() публичный Метод

Returns boolean for existence of handler.
public hasDirectiveHandler ( string $check ) : boolean
$check string
Результат boolean

parse() публичный Метод

Parse a query.
public parse ( )

parseContent() защищенный Метод

Parses the content area of the querystring.
protected parseContent ( )

parseDirectives() защищенный Метод

All these need to parsed and taken out of the params that are sent to the query.
protected parseDirectives ( )

parseOperation() защищенный Метод

A simple select operation will just contain the ContentType eg 'pages' but additional operations can be triggered using the '/' separator.
protected parseOperation ( )

removeOperation() публичный Метод

Removes an operation from the list supported.
public removeOperation ( string $operation )
$operation string name of operation to remove

runDirectives() публичный Метод

This runs the callbacks attached to each directive command.
public runDirectives ( Bolt\Storage\Query\QueryInterface $query, array $skipDirective = [] )
$query Bolt\Storage\Query\QueryInterface
$skipDirective array

setDirective() публичный Метод

Sets a directive for the named key.
public setDirective ( string $key, mixed $value )
$key string
$value mixed

setParameter() публичный Метод

Sets a single input parameter.
public setParameter ( string $param, mixed $value )
$param string
$value mixed

setParameters() публичный Метод

Sets the input parameters to handle.
public setParameters ( array $params )
$params array

setQuery() публичный Метод

Sets the input query.
public setQuery ( string $query )
$query string

setupDefaults() защищенный Метод

Internal method to initialise the default handlers.
protected setupDefaults ( )

Описание свойств

$contentTypes защищенное свойство

protected array $contentTypes
Результат array

$directiveHandlers защищенное свойство

protected callable[] $directiveHandlers
Результат callable[]

$directives защищенное свойство

protected array $directives
Результат array

$em защищенное свойство

protected EntityManager,Bolt\Storage $em
Результат Bolt\Storage\EntityManager

$handlers защищенное свойство

protected callable[] $handlers
Результат callable[]

$identifier защищенное свойство

protected string $identifier
Результат string

$operation защищенное свойство

protected string $operation
Результат string

$operations защищенное свойство

protected array $operations
Результат array

$params защищенное свойство

protected array $params
Результат array

$query защищенное свойство

protected string $query
Результат string

$services защищенное свойство

protected QueryInterface[],Bolt\Storage\Query $services
Результат Bolt\Storage\Query\QueryInterface[]