GetSetSchemaFactoryTrait
Trait GetSetSchemaFactoryTrait
Getters and setters for the schema factory
Table of Contents
Properties
- $index : BaseIndex
- Index to generate the schema for
- $store : bool
- Store the value in Solr
- $template : string
- ABSOLUTE Path to template
- $typesTemplate : string
- ABSOLUTE Path to types.ss template
Methods
- getClassID() : string
- Get the Identifier Field for Solr
- getDefaultField() : string|array<string|int, mixed>
- Get the default field to generate df components for
- getIDField() : string
- Get the Identifier Field for Solr
- getIndex() : BaseIndex
- Get the Index that's being used
- getIndexName() : string
- Get the name of the index being used
- getTemplate() : string
- Get the base template for the schema xml
- getTypesTemplate() : string
- Get the types template if defined
- setIndex() : SchemaFactory
- Set the index that's being used and add the introspection for it
- setStore() : void
- Set the store value
- setTemplate() : SchemaFactory
- Set a custom template for schema xml
- setTypesTemplate() : SchemaFactory
- Set custom types template
Properties
$index
Index to generate the schema for
protected
BaseIndex
$index
$store
Store the value in Solr
protected
bool
$store
= false
$template
ABSOLUTE Path to template
protected
string
$template
$typesTemplate
ABSOLUTE Path to types.ss template
protected
string
$typesTemplate
Methods
getClassID()
Get the Identifier Field for Solr
public
getClassID() : string
Return values
stringgetDefaultField()
Get the default field to generate df components for
public
getDefaultField() : string|array<string|int, mixed>
Return values
string|array<string|int, mixed>getIDField()
Get the Identifier Field for Solr
public
getIDField() : string
Return values
stringgetIndex()
Get the Index that's being used
public
getIndex() : BaseIndex
Return values
BaseIndexgetIndexName()
Get the name of the index being used
public
getIndexName() : string
Return values
stringgetTemplate()
Get the base template for the schema xml
public
getTemplate() : string
Return values
stringgetTypesTemplate()
Get the types template if defined
public
getTypesTemplate() : string
Return values
stringsetIndex()
Set the index that's being used and add the introspection for it
public
setIndex(BaseIndex $index) : SchemaFactory
Parameters
- $index : BaseIndex
Return values
SchemaFactorysetStore()
Set the store value
public
setStore(bool $store) : void
Parameters
- $store : bool
setTemplate()
Set a custom template for schema xml
public
setTemplate(string $template) : SchemaFactory
Parameters
- $template : string
Return values
SchemaFactorysetTypesTemplate()
Set custom types template
public
setTypesTemplate(string $typesTemplate) : SchemaFactory
Parameters
- $typesTemplate : string