includes/class/Configuration.class.phpView Source

Show: PublicProtectedPrivateinherited
Table of Contents
Broker
Package
Broker  

\Broker\Configuration

Package: Broker
Configuration

Properties

>VPropertypublicarray $config
Configuration
Details
Type
array
>VPropertyprivate\Broker\number $configTimestamp
Timestamp configuration file
Details
Type
\Broker\number
>VPropertyprivatestring $filename
Filename configuration
Details
Type
string
>VPropertypublicarray $solr
Solr configuration
Details
Type
array
>VPropertyprivate\Broker\number $solrTimestamp
Timestamp solr configuration
Details
Type
\Broker\number

Methods

methodpublic__construct(string $file) : void

Constructor

Parameters
NameTypeDescription
$filestring

configuration file

methodprivate_checkField(string $field, array $configuration, string $type = null, boolean $indexed = null, boolean $required = null, boolean $stored = null, boolean $multivalued = null, boolean $mtas = null) : void

Check field

Parameters
NameTypeDescription
$fieldstring
$configurationarray
$typestring
$indexedboolean
$requiredboolean
$storedboolean
$multivaluedboolean
$mtasboolean
methodprivate_findExample(string $configSuggestion, array $configValuesSuggestion, array $configuration, array $solrConfiguration, array $hints = null, string $type = null, boolean $indexed = null, boolean $required = null, boolean $stored = null, boolean $multivalued = null, boolean $mtas = null) : void

Find example

Parameters
NameTypeDescription
$configSuggestionstring
$configValuesSuggestionarray
$configurationarray
$solrConfigurationarray
$hintsarray
$typestring
$indexedboolean
$requiredboolean
$storedboolean
$multivaluedboolean
$mtasboolean
methodprivate_findMtasExamples(string $configSuggestion, array $configuration, array $solrConfiguration, array $hints) : void

Find Mtas examples

Parameters
NameTypeDescription
$configSuggestionstring
$configurationarray
$solrConfigurationarray
$hintsarray
methodprivate_findMtasExamplesTermvector(array $solrConfiguration, string $field, array $shards, string $prefix, integer $number) : array

Find Mtas examples termvector

Parameters
NameTypeDescription
$solrConfigurationarray
$fieldstring
$shardsarray
$prefixstring
$numberinteger
Returns
TypeDescription
array
methodprivate_processSolrConfiguration(array $item, array $fieldTypes, array $configuration) : object

Process solr configuration

Parameters
NameTypeDescription
$itemarray
$fieldTypesarray
$configurationarray
Returns
TypeDescription
object
methodprivate_sortLevenshtein(array $items, array $list) : void

Sort items by levenshtein distance

Parameters
NameTypeDescription
$itemsarray
$listarray
methodpublicgetConfig(string $name) : object

Get configuration item

Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
object
methodpublicgetConfigTimestamp() : NULL | \Broker\number

Get timestamp configuration file

Returns
TypeDescription
NULL | \Broker\number
methodpublicgetExpansions() : array

Get expansions

Returns
TypeDescription
array
methodpublicgetSolrConfig(object $name) : void

Get solr configuration item

Parameters
NameTypeDescription
$nameobject
methodprivategetSolrConfiguration(string $md5hash, \Broker\number $filetime) : void

Create solr configuration if necessary

Parameters
NameTypeDescription
$md5hashstring
$filetime\Broker\number
methodpublicgetSolrTimestamp() : object

Get timestamp automatic solr configuration

Returns
TypeDescription
object
methodpublicinstalled() : boolean

Check if configuration is found and processed

Returns
TypeDescription
boolean
methodprivateload(string $file) : void

Load configuration from file

Parameters
NameTypeDescription
$filestring
methodpublicreset() : void

Reset configuration

methodpublicurl(NULL | string $operation = null, NULL | string $suboperation = null, NULL | string $subsuboperation = null) : string

Create url based on optional operation and suboperation

Parameters
NameTypeDescription
$operationNULL | string
$suboperationNULL | string
$subsuboperationNULL | string
Returns
TypeDescription
string
methodpublicvalidate() : void
static

Validate, check existence directories

methodprivatevalidatePath(string $name, string $path, boolean $writeable, boolean $autocreate) : void
static

Validate, check existence

Parameters
NameTypeDescription
$namestring
$pathstring
$writeableboolean
$autocreateboolean
Documentation was generated by phpDocumentor 2.8.5.