includes/class/Parser.class.phpView Source

Show: PublicProtectedPrivateinherited
Table of Contents
Broker
Package
Broker  

\Broker\Parser

Package: Broker
Parser json request

Properties

>VPropertyprivatearray $__configurations = array()
Configurations
Default valuearray()Details
Type
array
>VPropertyprivatestring $brokerRequest = null
Request to broker
Default valuenullDetails
Type
string
>VPropertyprivate\Broker\Cache $cache = null
Cache
Default valuenullDetails
Type
\Broker\Cache
>VPropertyprivateboolean $cacheEnabled = true
Cache enables
Default valuetrueDetails
Type
boolean
>VPropertyprivate\Broker\Collection $collection = null
Collection
Default valuenullDetails
Type
\Broker\Collection
>VPropertyprivatearray $collectionIds = array()
Collection ids
Default valuearray()Details
Type
array
>VPropertyprivate\Broker\unknown $configuration = null
Configuration
Default valuenullDetails
Type
\Broker\unknown
>VPropertyprivate\Broker\errors $errors = array()
Errors
Default valuearray()Details
Type
\Broker\errors
>VPropertyprivate\Broker\ExpansionCache $expansionCache = null
Expansion cache
Default valuenullDetails
Type
\Broker\ExpansionCache
>VPropertyprivatearray $responseJoins = null
Response joins
Default valuenullDetails
Type
array
>VPropertyprivatestring $solrConfiguration = null
Solr configuration
Default valuenullDetails
Type
string
>VPropertyprivatestring $solrRequest = null
Solr request
Default valuenullDetails
Type
string
>VPropertyprivatestring $solrRequestAddition = null
Solr request addition
Default valuenullDetails
Type
string
>VPropertyprivatearray $solrShards = null
Solr shards
Default valuenullDetails
Type
array
>VPropertyprivatestring $solrUrl = null
Url solr
Default valuenullDetails
Type
string
>VPropertyprivatestring $statusKey = null
Status key
Default valuenullDetails
Type
string
>VPropertyprivatearray $warnings = array()
Warnings
Default valuearray()Details
Type
array

Methods

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

Constructor

Parameters
NameTypeDescription
$request\Broker\unknown
$configurationarray
$cache\Broker\Cache
$collection\Broker\Collection
$expansionCache\Broker\ExpansionCache
$statusKeystring
Throws
ExceptionDescription
\Exception
methodprivatecheckCache(\Broker\unknown $object) : \Broker\unknown

Check cache in request

Parameters
NameTypeDescription
$object\Broker\unknown
Returns
TypeDescription
\Broker\unknown
methodprivatecheckCondition(\Broker\unknown $object) : \Broker\unknown

Check condition

Parameters
NameTypeDescription
$object\Broker\unknown
Returns
TypeDescription
\Broker\unknown
methodprivatecheckDebug(\Broker\unknown $object) : \Broker\unknown

Check debug in request

Parameters
NameTypeDescription
$object\Broker\unknown
Returns
TypeDescription
\Broker\unknown
methodprivatecheckFilter(\Broker\unknown $object) : \Broker\unknown

Check filter

Parameters
NameTypeDescription
$object\Broker\unknown
Returns
TypeDescription
\Broker\unknown
methodprivatecheckFilters(\Broker\unknown $object) : \Broker\unknown

Check filters

Parameters
NameTypeDescription
$object\Broker\unknown
Returns
TypeDescription
\Broker\unknown
methodprivatecheckMtasStats(\Broker\unknown $object, string $prefixMessage = "") : \Broker\unknown

Check mtas stats

Parameters
NameTypeDescription
$object\Broker\unknown
$prefixMessagestring
Returns
TypeDescription
\Broker\unknown
methodprivatecheckMtasStatsFunction(\Broker\unknown $object, string $prefixMessage = "") : \Broker\unknown

Check mtas stats functions

Parameters
NameTypeDescription
$object\Broker\unknown
$prefixMessagestring
Returns
TypeDescription
\Broker\unknown
methodprivatecheckResponse(\Broker\unknown $object) : \Broker\unknown

Check response in request

Parameters
NameTypeDescription
$object\Broker\unknown
Returns
TypeDescription
\Broker\unknown
methodprivatecheckResponseDocuments(\Broker\unknown $object) : \Broker\unknown

Check documents in response

Parameters
NameTypeDescription
$object\Broker\unknown
Returns
TypeDescription
\Broker\unknown
methodprivatecheckResponseDocumentsJoin(\Broker\unknown $object) : \Broker\unknown

Check documents join in response

Parameters
NameTypeDescription
$object\Broker\unknown
Returns
TypeDescription
\Broker\unknown
methodprivatecheckResponseFacetField(\Broker\unknown $object, array $keyList) : array

Check facet field

Parameters
NameTypeDescription
$object\Broker\unknown
$keyListarray
Returns
TypeDescription
array
methodprivatecheckResponseFacetFieldJoin(\Broker\unknown $object) : \Broker\unknown

Check join facet field

Parameters
NameTypeDescription
$object\Broker\unknown
Returns
TypeDescription
\Broker\unknown
methodprivatecheckResponseFacetFields(array $facetfields, array $keyList) : void

Check facet fields in response

Parameters
NameTypeDescription
$facetfieldsarray
$keyListarray
methodprivatecheckResponseFacetPivot(\Broker\unknown $object, array $keyList) : array

Check facet pivot

Parameters
NameTypeDescription
$object\Broker\unknown
$keyListarray
Returns
TypeDescription
array
methodprivatecheckResponseFacetPivots(array $facetpivots, array $keyList) : array

Check facet pivots

Parameters
NameTypeDescription
$facetpivotsarray
$keyListarray
Returns
TypeDescription
array
methodprivatecheckResponseFacetQueries(array $facetqueries, array $keyList) : array

Check facet queries

Parameters
NameTypeDescription
$facetqueriesarray
$keyListarray
Returns
TypeDescription
array
methodprivatecheckResponseFacetQuery(\Broker\unknown $object, array $keyList) : array

Check facet query

Parameters
NameTypeDescription
$object\Broker\unknown
$keyListarray
Returns
TypeDescription
array
methodprivatecheckResponseFacetRange(\Broker\unknown $object, array $keyList) : array

Check facet range

Parameters
NameTypeDescription
$object\Broker\unknown
$keyListarray
Returns
TypeDescription
array
methodprivatecheckResponseFacetRanges(array $facetranges, array $keyList) : array

Check facet ranges

Parameters
NameTypeDescription
$facetrangesarray
$keyListarray
Returns
TypeDescription
array
methodprivatecheckResponseFacets(\Broker\unknown $object) : \Broker\unknown

Check facets in response

Parameters
NameTypeDescription
$object\Broker\unknown
Returns
TypeDescription
\Broker\unknown
methodprivatecheckResponseMtas(\Broker\unknown $object) : \Broker\unknown

Check mtas in response

Parameters
NameTypeDescription
$object\Broker\unknown
Returns
TypeDescription
\Broker\unknown
methodprivatecheckResponseMtasBase(\Broker\unknown $object, string $prefix) : \Broker\unknown

Check mtas base (facets)

Parameters
NameTypeDescription
$object\Broker\unknown
$prefixstring
Returns
TypeDescription
\Broker\unknown
methodprivatecheckResponseMtasCollection(\Broker\unknown $object) : \Broker\unknown

Check mtas collection

Parameters
NameTypeDescription
$object\Broker\unknown
Returns
TypeDescription
\Broker\unknown
methodprivatecheckResponseMtasDistance(\Broker\unknown $object, string $prefix) : \Broker\unknown

Check mtas distance

Parameters
NameTypeDescription
$object\Broker\unknown
$prefixstring
Returns
TypeDescription
\Broker\unknown
methodprivatecheckResponseMtasDocument(\Broker\unknown $object) : \Broker\unknown

Check mtas documents

Parameters
NameTypeDescription
$object\Broker\unknown
Returns
TypeDescription
\Broker\unknown
methodprivatecheckResponseMtasFacet(\Broker\unknown $object) : \Broker\unknown

Check mtas facet

Parameters
NameTypeDescription
$object\Broker\unknown
Returns
TypeDescription
\Broker\unknown
methodprivatecheckResponseMtasFunction(\Broker\unknown $object, string $prefix) : \Broker\unknown

Check mtas function

Parameters
NameTypeDescription
$object\Broker\unknown
$prefixstring
Returns
TypeDescription
\Broker\unknown
methodprivatecheckResponseMtasGroup(\Broker\unknown $object) : \Broker\unknown

Check mtas group

Parameters
NameTypeDescription
$object\Broker\unknown
Returns
TypeDescription
\Broker\unknown
methodprivatecheckResponseMtasKwicAndList(string $type, \Broker\unknown $object) : \Broker\unknown

Check mtas kwic and list

Parameters
NameTypeDescription
$typestring
$object\Broker\unknown
Returns
TypeDescription
\Broker\unknown
methodprivatecheckResponseMtasPrefix(\Broker\unknown $object) : \Broker\unknown

Check mtas prefix

Parameters
NameTypeDescription
$object\Broker\unknown
Returns
TypeDescription
\Broker\unknown
methodprivatecheckResponseMtasQuery(\Broker\unknown $object, string $prefix) : \Broker\unknown

Check query mtas

Parameters
NameTypeDescription
$object\Broker\unknown
$prefixstring
Returns
TypeDescription
\Broker\unknown
methodprivatecheckResponseMtasStats(\Broker\unknown $object) : \Broker\unknown

Check mtas stats

Parameters
NameTypeDescription
$object\Broker\unknown
Returns
TypeDescription
\Broker\unknown
methodprivatecheckResponseMtasStatsPositions(\Broker\unknown $object) : \Broker\unknown

Check mtas stats positions

Parameters
NameTypeDescription
$object\Broker\unknown
Returns
TypeDescription
\Broker\unknown
methodprivatecheckResponseMtasStatsSpans(\Broker\unknown $object) : \Broker\unknown

Check mtas stats spans

Parameters
NameTypeDescription
$object\Broker\unknown
Returns
TypeDescription
\Broker\unknown
methodprivatecheckResponseMtasStatsTokens(\Broker\unknown $object) : \Broker\unknown

Check mtas stats tokens

Parameters
NameTypeDescription
$object\Broker\unknown
Returns
TypeDescription
\Broker\unknown
methodprivatecheckResponseMtasTermvector(\Broker\unknown $object) : \Broker\unknown

Check mtas termvector

Parameters
NameTypeDescription
$object\Broker\unknown
Returns
TypeDescription
\Broker\unknown
methodprivatecheckResponseStats(\Broker\unknown $object) : \Broker\unknown

Check stats in response

Parameters
NameTypeDescription
$object\Broker\unknown
Returns
TypeDescription
\Broker\unknown
methodprivatecheckResponseStatsField(\Broker\unknown $object, array $keyList) : array

Check stats field

Parameters
NameTypeDescription
$object\Broker\unknown
$keyListarray
Returns
TypeDescription
array
methodprivatecheckResponseStatsFields(array $statsfields, array $keyList) : array

Check stats fields in response

Parameters
NameTypeDescription
$statsfieldsarray
$keyListarray
Returns
TypeDescription
array
methodprivatecheckSort(\Broker\unknown $object) : \Broker\unknown

Check sort in request

Parameters
NameTypeDescription
$object\Broker\unknown
Returns
TypeDescription
\Broker\unknown
methodprivatecheckSortitem(\Broker\unknown $object) : \Broker\unknown

Check sortItem in sort

Parameters
NameTypeDescription
$object\Broker\unknown
Returns
TypeDescription
\Broker\unknown
methodprivatecheckVariables(\Broker\unknown $object, \Broker\unknown $fromCondition, string $prefixMessage = "") : \Broker\unknown

Check variables

Parameters
NameTypeDescription
$object\Broker\unknown
$fromCondition\Broker\unknown
$prefixMessagestring
Returns
TypeDescription
\Broker\unknown
methodprivatecomputeConfiguration(string $config) : \Broker\unknown

Compute configuration

Parameters
NameTypeDescription
$configstring
Returns
TypeDescription
\Broker\unknown
methodprivatecomputeExpansionValues(array | string $value, \Broker\unknown $expansion, string $prefixMessage = "") : array

Compute expansions values

Parameters
NameTypeDescription
$valuearray | string
$expansion\Broker\unknown
$prefixMessagestring
Returns
TypeDescription
array
methodprivatecreateCollectionIdFromJoin(\Broker\unknown $object, \Broker\unknown $configuration) : string

Create collectionId from join

Parameters
NameTypeDescription
$object\Broker\unknown
$configuration\Broker\unknown
Returns
TypeDescription
string
methodprivatecreateVariableCombinations(array $variables, array $combinations) : array

Create variable combinations

Parameters
NameTypeDescription
$variablesarray
$combinationsarray
Returns
TypeDescription
array
methodprivatecreateVariablesString(array $variables) : string

Create variables string

Parameters
NameTypeDescription
$variablesarray
Returns
TypeDescription
string
methodprivatefinishCollectionIdFromJoin(\Broker\unknown $collectionId, \Broker\unknown $configuration) : string

Finish collectionId from join

Parameters
NameTypeDescription
$collectionId\Broker\unknown
$configuration\Broker\unknown
Returns
TypeDescription
string
methodpublicgetCache() : \Broker\Cache

Get (or create) cache

Returns
TypeDescription
\Broker\Cache
methodpublicgetCollection() : \Broker\Collection

Get (or create) collection

Returns
TypeDescription
\Broker\Collection
methodpublicgetCollectionIds() : array

Get collection ids

Returns
TypeDescription
array
methodpublicgetConfiguration() : array

Get solr configuration

Returns
TypeDescription
array
methodprivategetConfigurationsForField(\Broker\unknown $field) : array

Get configurations for field

Parameters
NameTypeDescription
$field\Broker\unknown
Returns
TypeDescription
array
methodpublicgetErrors() : array

Get errors

Returns
TypeDescription
array
methodpublicgetRequest() : string

Get solr request

Returns
TypeDescription
string
methodpublicgetRequestAddition() : string

Get addition solr request

Returns
TypeDescription
string
methodpublicgetResponseJoins() : \Broker\unknown

Get response joins

Returns
TypeDescription
\Broker\unknown
methodpublicgetShards() : array

Get shards

Returns
TypeDescription
array
methodpublicgetStatusKey() : string

Get status key

Returns
TypeDescription
string
methodpublicgetUrl() : string

Get solr url

Returns
TypeDescription
string
methodpublicgetWarnings() : array

Get warnings

Returns
TypeDescription
array
methodprivateparse() : void

parse

methodprivateparseCache(\Broker\unknown $object) : null

Parse cache

Parameters
NameTypeDescription
$object\Broker\unknown
Returns
TypeDescription
null
methodprivateparseCondition(\Broker\unknown $object) : \Broker\unknown

Parse condition

Parameters
NameTypeDescription
$object\Broker\unknown
Returns
TypeDescription
\Broker\unknown
methodprivateparseDebug(\Broker\unknown $object) : string | NULL

Parse debug

Parameters
NameTypeDescription
$object\Broker\unknown
Returns
TypeDescription
string | NULL
methodprivateparseFilter(\Broker\unknown $object, array $requestList, array $facetQueries, array $mtasStats) : array

Parse filter

Parameters
NameTypeDescription
$object\Broker\unknown
$requestListarray
$facetQueriesarray
$mtasStatsarray
Returns
TypeDescription
array
methodprivateparseFilters(\Broker\unknown $object) : array

Parse filters

Parameters
NameTypeDescription
$object\Broker\unknown
Returns
TypeDescription
array
methodprivateparseResponse(\Broker\unknown $object, array $facetQueries, array $mtasStats) : \Broker\unknown

Parse response

Parameters
NameTypeDescription
$object\Broker\unknown
$facetQueriesarray
$mtasStatsarray
Returns
TypeDescription
\Broker\unknown
methodprivateparseResponseDocuments(\Broker\unknown $object) : \Broker\unknown

Parse documents in response

Parameters
NameTypeDescription
$object\Broker\unknown
Returns
TypeDescription
\Broker\unknown
methodprivateparseResponseDocumentsJoin(\Broker\unknown $object) : \Broker\unknown

Parse join in documents

Parameters
NameTypeDescription
$object\Broker\unknown
Returns
TypeDescription
\Broker\unknown
methodprivateparseResponseFacetField(\Broker\unknown $object, \Broker\number $i) : \Broker\unknown

Parse facet field

Parameters
NameTypeDescription
$object\Broker\unknown
$i\Broker\number
Returns
TypeDescription
\Broker\unknown
methodprivateparseResponseFacetFieldJoin(\Broker\unknown $object, string $key, \Broker\number $i) : \Broker\unknown

Parse join facet field

Parameters
NameTypeDescription
$object\Broker\unknown
$keystring
$i\Broker\number
Returns
TypeDescription
\Broker\unknown
methodprivateparseResponseFacetFields(\Broker\unknown $object, array $requestList) : array

Parse facet fields

Parameters
NameTypeDescription
$object\Broker\unknown
$requestListarray
Returns
TypeDescription
array
methodprivateparseResponseFacetPivot(\Broker\unknown $object, \Broker\number $i) : \Broker\unknown

Parse facet pivot

Parameters
NameTypeDescription
$object\Broker\unknown
$i\Broker\number
Returns
TypeDescription
\Broker\unknown
methodprivateparseResponseFacetPivots(\Broker\unknown $object, array $requestList) : array

Parse facet pivots

Parameters
NameTypeDescription
$object\Broker\unknown
$requestListarray
Returns
TypeDescription
array
methodprivateparseResponseFacetQueries(\Broker\unknown $object, array $requestList, array $keyListFacetQueries) : array

Parse facet queries

Parameters
NameTypeDescription
$object\Broker\unknown
$requestListarray
$keyListFacetQueriesarray
Returns
TypeDescription
array
methodprivateparseResponseFacetQuery(\Broker\unknown $object, array $keyListFacetQueries, \Broker\number $i) : array

Parse facet query

Parameters
NameTypeDescription
$object\Broker\unknown
$keyListFacetQueriesarray
$i\Broker\number
Returns
TypeDescription
array
methodprivateparseResponseFacetRange(\Broker\unknown $object, \Broker\number $i) : \Broker\unknown

Parse facet range

Parameters
NameTypeDescription
$object\Broker\unknown
$i\Broker\number
Returns
TypeDescription
\Broker\unknown
methodprivateparseResponseFacetRanges(\Broker\unknown $object, array $requestList) : array

Parse facet range

Parameters
NameTypeDescription
$object\Broker\unknown
$requestListarray
Returns
TypeDescription
array
methodprivateparseResponseFacets(\Broker\unknown $object, \Broker\unknown $facetqueries) : \Broker\unknown

Parse facets in response

Parameters
NameTypeDescription
$object\Broker\unknown
$facetqueries\Broker\unknown
Returns
TypeDescription
\Broker\unknown
methodprivateparseResponseMtas(\Broker\unknown $object, array $mtasStats) : \Broker\unknown

Parse mtas in response

Parameters
NameTypeDescription
$object\Broker\unknown
$mtasStatsarray
Returns
TypeDescription
\Broker\unknown
methodprivateparseResponseMtasCollection(\Broker\unknown $object, \Broker\number $i) : \Broker\unknown

Parse mtas collection

Parameters
NameTypeDescription
$object\Broker\unknown
$i\Broker\number
Returns
TypeDescription
\Broker\unknown
methodprivateparseResponseMtasDocument(\Broker\unknown $object, \Broker\number $i) : \Broker\unknown

Parse mtas documents

Parameters
NameTypeDescription
$object\Broker\unknown
$i\Broker\number
Returns
TypeDescription
\Broker\unknown
methodprivateparseResponseMtasFacet(\Broker\unknown $object, \Broker\number $i) : \Broker\unknown

Parse mtas facet

Parameters
NameTypeDescription
$object\Broker\unknown
$i\Broker\number
Returns
TypeDescription
\Broker\unknown
methodprivateparseResponseMtasGroup(\Broker\unknown $object, \Broker\number $i) : \Broker\unknown

Parse mtas group

Parameters
NameTypeDescription
$object\Broker\unknown
$i\Broker\number
Returns
TypeDescription
\Broker\unknown
methodprivateparseResponseMtasKwicAndList(string $type, \Broker\unknown $object, \Broker\number $i) : \Broker\unknown

Parse mtas kwic and list

Parameters
NameTypeDescription
$typestring
$object\Broker\unknown
$i\Broker\number
Returns
TypeDescription
\Broker\unknown
methodprivateparseResponseMtasPrefix(\Broker\unknown $object, \Broker\number $i) : \Broker\unknown

Parse mtas prefix

Parameters
NameTypeDescription
$object\Broker\unknown
$i\Broker\number
Returns
TypeDescription
\Broker\unknown
methodprivateparseResponseMtasStats(\Broker\unknown $object, array $mtasStats) : \Broker\unknown

Parse mtas stats

Parameters
NameTypeDescription
$object\Broker\unknown
$mtasStatsarray
Returns
TypeDescription
\Broker\unknown
methodprivateparseResponseMtasStatsPositions(\Broker\unknown $object, \Broker\number $i) : \Broker\unknown

Parse mtas stats positions

Parameters
NameTypeDescription
$object\Broker\unknown
$i\Broker\number
Returns
TypeDescription
\Broker\unknown
methodprivateparseResponseMtasStatsSpans(\Broker\unknown $object, \Broker\number $i) : \Broker\unknown

Parse mtas stats spans

Parameters
NameTypeDescription
$object\Broker\unknown
$i\Broker\number
Returns
TypeDescription
\Broker\unknown
methodprivateparseResponseMtasStatsTokens(\Broker\unknown $object, \Broker\number $i) : \Broker\unknown

Parse mtas stats tokens

Parameters
NameTypeDescription
$object\Broker\unknown
$i\Broker\number
Returns
TypeDescription
\Broker\unknown
methodprivateparseResponseMtasTermvector(\Broker\unknown $object, \Broker\number $i) : \Broker\unknown

Parse mtas termvector

Parameters
NameTypeDescription
$object\Broker\unknown
$i\Broker\number
Returns
TypeDescription
\Broker\unknown
methodprivateparseResponseStats(\Broker\unknown $object) : void

Parse stats in response

Parameters
NameTypeDescription
$object\Broker\unknown

return unknown

methodprivateparseResponseStatsField(\Broker\unknown $object, \Broker\number $i) : \Broker\unknown

Parse stats field

Parameters
NameTypeDescription
$object\Broker\unknown
$i\Broker\number
Returns
TypeDescription
\Broker\unknown
methodprivateparseResponseStatsFields(\Broker\unknown $object, array $requestList) : array

Parse stats fields

Parameters
NameTypeDescription
$object\Broker\unknown
$requestListarray
Returns
TypeDescription
array
methodprivateparseSort(\Broker\unknown $object) : string | NULL

parse Sort

Parameters
NameTypeDescription
$object\Broker\unknown
Returns
TypeDescription
string | NULL
methodprivatesolrEncode(\Broker\unknown $value, string $type = null) : string

Solr encode

Parameters
NameTypeDescription
$value\Broker\unknown
$typestring
Returns
TypeDescription
string
Documentation was generated by phpDocumentor 2.8.5.