includes/class/Parser.class.php

Show:

inherited

Classes
- \Broker\Parser

Table of Contents

Broker

Package: Broker

\Broker\Parser
jump to top

Package: Broker

Parser json request

Properties

array $__configurations = array()

Configurations

Default valuearray()Details

Type: array

string $brokerRequest = null

Request to broker

Default valuenullDetails

Type: string

\Broker\Cache $cache = null

Cache

Default valuenullDetails

Type: \Broker\Cache

boolean $cacheEnabled = true

Cache enables

Default valuetrueDetails

Type: boolean

\Broker\Collection $collection = null

Collection

Default valuenullDetails

Type: \Broker\Collection

array $collectionIds = array()

Collection ids

Default valuearray()Details

Type: array

object $configuration = null

Configuration

Default valuenullDetails

Type: object

array $errors = array()

Errors

Default valuearray()Details

Type: array

\Broker\ExpansionCache $expansionCache = null

Expansion cache

Default valuenullDetails

Type: \Broker\ExpansionCache

array $responseJoins = null

Response joins

Default valuenullDetails

Type: array

string $solrConfiguration = null

Solr configuration

Default valuenullDetails

Type: string

string $solrRequest = null

Solr request

Default valuenullDetails

Type: string

string $solrRequestAddition = null

Solr request addition

Default valuenullDetails

Type: string

array $solrShards = null

Solr shards

Default valuenullDetails

Type: array

string $solrUrl = null

Url solr

Default valuenullDetails

Type: string

string $statusKey = null

Status key

Default valuenullDetails

Type: string

array $warnings = array()

Warnings

Default valuearray()Details

Type: array

Methods

__construct(object $request, array $configuration, \Broker\Cache $cache, \Broker\Collection $collection, \Broker\ExpansionCache $expansionCache, string $statusKey) : void

Constructor

Parameters

Name	Type	Description
$request	object
$configuration	array
$cache	\Broker\Cache
$collection	\Broker\Collection
$expansionCache	\Broker\ExpansionCache
$statusKey	string

Throws

Exception	Description
\Exception

checkCache(object $object) : object

Check cache in request

Parameters

Name	Type	Description
$object	object

Returns

Type	Description
object

checkCondition(object $object) : object

Check condition

Parameters

Name	Type	Description
$object	object

Returns

Type	Description
object

checkDebug(object $object) : object

Check debug in request

Parameters

Name	Type	Description
$object	object

Returns

Type	Description
object

checkFilter(object $object) : object

Check filter

Parameters

Name	Type	Description
$object	object

Returns

Type	Description
object

checkFilters(object $object) : object

Check filters

Parameters

Name	Type	Description
$object	object

Returns

Type	Description
object

checkMtasStats(object $object, string $prefixMessage = "") : object

Check mtas stats

Parameters

Name	Type	Description
$object	object
$prefixMessage	string

Returns

Type	Description
object

checkMtasStatsFunction(object $object, string $prefixMessage = "") : object

Check mtas stats functions

Parameters

Name	Type	Description
$object	object
$prefixMessage	string

Returns

Type	Description
object

checkPage(object $object, string $prefix) : void

Check page

Parameters

Name	Type	Description
$object	object
$prefix	string	@return object

checkResponse(object $object) : object

Check response in request

Parameters

Name	Type	Description
$object	object

Returns

Type	Description
object

checkResponseDocuments(object $object) : object

Check documents in response

Parameters

Name	Type	Description
$object	object

Returns

Type	Description
object

checkResponseDocumentsJoin(object $object) : object

Check documents join in response

Parameters

Name	Type	Description
$object	object

Returns

Type	Description
object

checkResponseFacetField(object $object, array $keyList) : array

Check facet field

Parameters

Name	Type	Description
$object	object
$keyList	array

Returns

Type	Description
array

checkResponseFacetFieldJoin(object $object) : object

Check join facet field

Parameters

Name	Type	Description
$object	object

Returns

Type	Description
object

checkResponseFacetFields(array $facetfields, array $keyList) : void

Check facet fields in response

Parameters

Name	Type	Description
$facetfields	array
$keyList	array

checkResponseFacetHeatmap(object $object, array $keyList) : array

Check facet pivot

Parameters

Name	Type	Description
$object	object
$keyList	array

Returns

Type	Description
array

checkResponseFacetHeatmaps(array $facetheatmaps, array $keyList) : array

Check facet heatmaps

Parameters

Name	Type	Description
$facetheatmaps	array
$keyList	array

Returns

Type	Description
array

checkResponseFacetPivot(object $object, array $keyList) : array

Check facet pivot

Parameters

Name	Type	Description
$object	object
$keyList	array

Returns

Type	Description
array

checkResponseFacetPivots(array $facetpivots, array $keyList) : array

Check facet pivots

Parameters

Name	Type	Description
$facetpivots	array
$keyList	array

Returns

Type	Description
array

checkResponseFacetQueries(array $facetqueries, array $keyList) : array

Check facet queries

Parameters

Name	Type	Description
$facetqueries	array
$keyList	array

Returns

Type	Description
array

checkResponseFacetQuery(object $object, array $keyList) : array

Check facet query

Parameters

Name	Type	Description
$object	object
$keyList	array

Returns

Type	Description
array

checkResponseFacetRange(object $object, array $keyList) : array

Check facet range

Parameters

Name	Type	Description
$object	object
$keyList	array

Returns

Type	Description
array

checkResponseFacetRanges(array $facetranges, array $keyList) : array

Check facet ranges

Parameters

Name	Type	Description
$facetranges	array
$keyList	array

Returns

Type	Description
array

checkResponseFacets(object $object) : object

Check facets in response

Parameters

Name	Type	Description
$object	object

Returns

Type	Description
object

checkResponseMtas(object $object) : object

Check mtas in response

Parameters

Name	Type	Description
$object	object

Returns

Type	Description
object

checkResponseMtasBase(object $object, string $prefix) : object

Check mtas base (facets)

Parameters

Name	Type	Description
$object	object
$prefix	string

Returns

Type	Description
object

checkResponseMtasCollection(object $object) : object

Check mtas collection

Parameters

Name	Type	Description
$object	object

Returns

Type	Description
object

checkResponseMtasDistance(object $object, string $prefix) : object

Check mtas distance

Parameters

Name	Type	Description
$object	object
$prefix	string

Returns

Type	Description
object

checkResponseMtasDocument(object $object) : object

Check mtas documents

Parameters

Name	Type	Description
$object	object

Returns

Type	Description
object

checkResponseMtasFacet(object $object) : object

Check mtas facet

Parameters

Name	Type	Description
$object	object

Returns

Type	Description
object

checkResponseMtasFunction(object $object, string $prefix) : object

Check mtas function

Parameters

Name	Type	Description
$object	object
$prefix	string

Returns

Type	Description
object

checkResponseMtasGroup(object $object) : object

Check mtas group

Parameters

Name	Type	Description
$object	object

Returns

Type	Description
object

checkResponseMtasHeatmap(object $object) : object

Check mtas heatmap

Parameters

Name	Type	Description
$object	object

Returns

Type	Description
object

checkResponseMtasKwicAndList(string $type, object $object) : object

Check mtas kwic and list

Parameters

Name	Type	Description
$type	string
$object	object

Returns

Type	Description
object

checkResponseMtasPage(object $object) : object

Check mtas page

Parameters

Name	Type	Description
$object	object

Returns

Type	Description
object

checkResponseMtasPrefix(object $object) : object

Check mtas prefix

Parameters

Name	Type	Description
$object	object

Returns

Type	Description
object

checkResponseMtasQuery(object $object, string $prefix) : object

Check query mtas

Parameters

Name	Type	Description
$object	object
$prefix	string

Returns

Type	Description
object

checkResponseMtasStats(object $object) : object

Check mtas stats

Parameters

Name	Type	Description
$object	object

Returns

Type	Description
object

checkResponseMtasStatsPositions(object $object) : object

Check mtas stats positions

Parameters

Name	Type	Description
$object	object

Returns

Type	Description
object

checkResponseMtasStatsSpans(object $object) : object

Check mtas stats spans

Parameters

Name	Type	Description
$object	object

Returns

Type	Description
object

checkResponseMtasStatsTokens(object $object) : object

Check mtas stats tokens

Parameters

Name	Type	Description
$object	object

Returns

Type	Description
object

checkResponseMtasTermvector(object $object) : object

Check mtas termvector

Parameters

Name	Type	Description
$object	object

Returns

Type	Description
object

checkResponseMtasVersion(object $object) : object

Check mtas collection

Parameters

Name	Type	Description
$object	object

Returns

Type	Description
object

checkResponseStats(object $object) : object

Check stats in response

Parameters

Name	Type	Description
$object	object

Returns

Type	Description
object

checkResponseStatsField(object $object, array $keyList) : array

Check stats field

Parameters

Name	Type	Description
$object	object
$keyList	array

Returns

Type	Description
array

checkResponseStatsFields(array $statsfields, array $keyList) : array

Check stats fields in response

Parameters

Name	Type	Description
$statsfields	array
$keyList	array

Returns

Type	Description
array

checkSort(object $object) : object

Check sort in request

Parameters

Name	Type	Description
$object	object

Returns

Type	Description
object

checkSortitem(object $object) : object

Check sortItem in sort

Parameters

Name	Type	Description
$object	object

Returns

Type	Description
object

checkTimeAllowed(object $object) : object

Check timeAllowed in request

Parameters

Name	Type	Description
$object	object

Returns

Type	Description
object

checkVariables(object $object, object $fromCondition, string $prefixMessage = "") : object

Check variables

Parameters

Name	Type	Description
$object	object
$fromCondition	object
$prefixMessage	string

Returns

Type	Description
object

computeConfiguration(string $config) : object

Compute configuration

Parameters

Name	Type	Description
$config	string

Returns

Type	Description
object

computeExpansionValues(array | string $value, object $expansion, string $prefixMessage = "") : array

Compute expansions values

Parameters

Name	Type	Description
$value	array \| string
$expansion	object
$prefixMessage	string

Returns

Type	Description
array

createCollectionIdFromJoin(object $object, object $configuration) : string

Create collectionId from join

Parameters

Name	Type	Description
$object	object
$configuration	object

Returns

Type	Description
string

createVariableCombinations(array $variables, array $combinations) : array

Create variable combinations

Parameters

Name	Type	Description
$variables	array
$combinations	array

Returns

Type	Description
array

createVariablesList(array $variables) : array

Create variables list

Parameters

Name	Type	Description
$variables	array

Returns

Type	Description
array

createVariablesString(array $variables) : string

Create variables string

Parameters

Name	Type	Description
$variables	array

Returns

Type	Description
string

finishCollectionIdFromJoin(object $collectionId, object $configuration) : string

Finish collectionId from join

Parameters

Name	Type	Description
$collectionId	object
$configuration	object

Returns

Type	Description
string

getCache() : \Broker\Cache

Get (or create) cache

Returns

Type	Description
\Broker\Cache

getCollection() : \Broker\Collection

Get (or create) collection

Returns

Type	Description
\Broker\Collection

getCollectionIds() : array

Get collection ids

Returns

Type	Description
array

getConfiguration() : array

Get solr configuration

Returns

Type	Description
array

getConfigurationsForField(object $field) : array

Get configurations for field

Parameters

Name	Type	Description
$field	object

Returns

Type	Description
array

getErrors() : array

Get errors

Returns

Type	Description
array

getRequest() : string

Get solr request

Returns

Type	Description
string

getRequestAddition() : string

Get addition solr request

Returns

Type	Description
string

getResponseJoins() : object

Get response joins

Returns

Type	Description
object

getShards() : array

Get shards

Returns

Type	Description
array

getStatusKey() : string

Get status key

Returns

Type	Description
string

getUrl() : string

Get solr url

Returns

Type	Description
string

getWarnings() : array

Get warnings

Returns

Type	Description
array

parse() : void

parse

parseCache(object $object) : null

Parse cache

Parameters

Name	Type	Description
$object	object

Returns

Type	Description
null

parseCondition(object $object) : object

Parse condition

Parameters

Name	Type	Description
$object	object

Returns

Type	Description
object

parseDebug(object $object) : string | NULL

Parse debug

Parameters

Name	Type	Description
$object	object

Returns

Type	Description
string \| NULL

parseFilter(object $object, array $requestList, array $facetQueries, array $mtasStats) : array

Parse filter

Parameters

Name	Type	Description
$object	object
$requestList	array
$facetQueries	array
$mtasStats	array

Returns

Type	Description
array

parseFilters(object $object) : array

Parse filters

Parameters

Name	Type	Description
$object	object

Returns

Type	Description
array

parseResponse(object $object, array $facetQueries, array $mtasStats) : object

Parse response

Parameters

Name	Type	Description
$object	object
$facetQueries	array
$mtasStats	array

Returns

Type	Description
object

parseResponseDocuments(object $object) : object

Parse documents in response

Parameters

Name	Type	Description
$object	object

Returns

Type	Description
object

parseResponseDocumentsJoin(object $object) : object

Parse join in documents

Parameters

Name	Type	Description
$object	object

Returns

Type	Description
object

parseResponseFacetField(object $object, \Broker\number $i) : object

Parse facet field

Parameters

Name	Type	Description
$object	object
$i	\Broker\number

Returns

Type	Description
object

parseResponseFacetFieldJoin(object $object, string $key, \Broker\number $i) : object

Parse join facet field

Parameters

Name	Type	Description
$object	object
$key	string
$i	\Broker\number

Returns

Type	Description
object

parseResponseFacetFields(object $object, array $requestList) : array

Parse facet fields

Parameters

Name	Type	Description
$object	object
$requestList	array

Returns

Type	Description
array

parseResponseFacetHeatmap(object $object, \Broker\number $i) : object

Parse facet heatmap

Parameters

Name	Type	Description
$object	object
$i	\Broker\number

Returns

Type	Description
object

parseResponseFacetHeatmaps(object $object, array $requestList) : array

Parse facet heatmaps

Parameters

Name	Type	Description
$object	object
$requestList	array

Returns

Type	Description
array

parseResponseFacetPivot(object $object, \Broker\number $i) : object

Parse facet pivot

Parameters

Name	Type	Description
$object	object
$i	\Broker\number

Returns

Type	Description
object

parseResponseFacetPivots(object $object, array $requestList) : array

Parse facet pivots

Parameters

Name	Type	Description
$object	object
$requestList	array

Returns

Type	Description
array

parseResponseFacetQueries(object $object, array $requestList, array $keyListFacetQueries) : array

Parse facet queries

Parameters

Name	Type	Description
$object	object
$requestList	array
$keyListFacetQueries	array

Returns

Type	Description
array

parseResponseFacetQuery(object $object, array $keyListFacetQueries, \Broker\number $i) : array

Parse facet query

Parameters

Name	Type	Description
$object	object
$keyListFacetQueries	array
$i	\Broker\number

Returns

Type	Description
array

parseResponseFacetRange(object $object, \Broker\number $i) : object

Parse facet range

Parameters

Name	Type	Description
$object	object
$i	\Broker\number

Returns

Type	Description
object

parseResponseFacetRanges(object $object, array $requestList) : array

Parse facet range

Parameters

Name	Type	Description
$object	object
$requestList	array

Returns

Type	Description
array

parseResponseFacets(object $object, object $facetqueries) : object

Parse facets in response

Parameters

Name	Type	Description
$object	object
$facetqueries	object

Returns

Type	Description
object

parseResponseMtas(object $object, array $mtasStats) : object

Parse mtas in response

Parameters

Name	Type	Description
$object	object
$mtasStats	array

Returns

Type	Description
object

parseResponseMtasCollection(object $object, \Broker\number $i) : object

Parse mtas collection

Parameters

Name	Type	Description
$object	object
$i	\Broker\number

Returns

Type	Description
object

parseResponseMtasDocument(object $object, \Broker\number $i) : object

Parse mtas documents

Parameters

Name	Type	Description
$object	object
$i	\Broker\number

Returns

Type	Description
object

parseResponseMtasFacet(object $object, \Broker\number $i) : object

Parse mtas facet

Parameters

Name	Type	Description
$object	object
$i	\Broker\number

Returns

Type	Description
object

parseResponseMtasGroup(object $object, \Broker\number $i) : object

Parse mtas group

Parameters

Name	Type	Description
$object	object
$i	\Broker\number

Returns

Type	Description
object

parseResponseMtasHeatmap(object $object, \Broker\number $i) : object

Parse mtas heatmap

Parameters

Name	Type	Description
$object	object
$i	\Broker\number

Returns

Type	Description
object

parseResponseMtasKwicAndList(string $type, object $object, \Broker\number $i) : object

Parse mtas kwic and list

Parameters

Name	Type	Description
$type	string
$object	object
$i	\Broker\number

Returns

Type	Description
object

parseResponseMtasPage(object $object, \Broker\number $i) : object

Parse mtas page

Parameters

Name	Type	Description
$object	object
$i	\Broker\number

Returns

Type	Description
object

parseResponseMtasPrefix(object $object, \Broker\number $i) : object

Parse mtas prefix

Parameters

Name	Type	Description
$object	object
$i	\Broker\number

Returns

Type	Description
object

parseResponseMtasStats(object $object, array $mtasStats) : object

Parse mtas stats

Parameters

Name	Type	Description
$object	object
$mtasStats	array

Returns

Type	Description
object

parseResponseMtasStatsPositions(object $object, \Broker\number $i) : object

Parse mtas stats positions

Parameters

Name	Type	Description
$object	object
$i	\Broker\number

Returns

Type	Description
object

parseResponseMtasStatsSpans(object $object, \Broker\number $i) : object

Parse mtas stats spans

Parameters

Name	Type	Description
$object	object
$i	\Broker\number

Returns

Type	Description
object

parseResponseMtasStatsTokens(object $object, \Broker\number $i) : object

Parse mtas stats tokens

Parameters

Name	Type	Description
$object	object
$i	\Broker\number

Returns

Type	Description
object

parseResponseMtasTermvector(object $object, \Broker\number $i) : object

Parse mtas termvector

Parameters

Name	Type	Description
$object	object
$i	\Broker\number

Returns

Type	Description
object

parseResponseStats(object $object) : void

Parse stats in response

Parameters

Name	Type	Description
$object	object	return unknown

parseResponseStatsField(object $object, \Broker\number $i) : object

Parse stats field

Parameters

Name	Type	Description
$object	object
$i	\Broker\number

Returns

Type	Description
object

parseResponseStatsFields(object $object, array $requestList) : array

Parse stats fields

Parameters

Name	Type	Description
$object	object
$requestList	array

Returns

Type	Description
array

parseSort(object $object) : string | NULL

parse Sort

Parameters

Name	Type	Description
$object	object

Returns

Type	Description
string \| NULL

parseTimeAllowed(object $object) : null

Parse timeAllowed

Parameters

Name	Type	Description
$object	object

Returns

Type	Description
null

solrEncode(object $value, string $type = null) : string

Solr encode

Parameters

Name	Type	Description
$value	object
$type	string

Returns

Type	Description
string

includes/class/Parser.class.php

\Broker\Parserjump to top

Properties

Methods

\Broker\Parser
jump to top