SilverStripe\FullTextSearch\Tests\SolrIndexVersionedTest\SolrVersionedTest_Index
Synopsis
class SolrVersionedTest_Index
extends SolrIndex
{
- // Inherited members from SolrIndex
- public static array $fulltextTypeMap;
- public static array $filterTypeMap;
- public static array $sortTypeMap;
- protected array $analyzerFields;
- protected array $copyFields;
- protected $extrasPath;
- protected $templatesPath;
- protected array $boostedFields;
- protected $service;
- // Inherited members from SearchIndex
- protected array $classes;
- protected array $fulltextFields;
- public array $filterFields;
- protected array $sortFields;
- protected array $excludedVariantStates;
- public array $dependancyList;
- public $derivedFields;
- // methods
- public void init()
- // Inherited methods from SolrIndex
- public String getTemplatesPath()
- public String getExtrasPath()
- public void generateSchema()
- public string getIndexName()
- public void getTypes()
- public void addAnalyzer()
- public string getDefaultField()
- protected array getCopyDestinations()
- public void getFieldDefinitions()
- protected string getCollatedSuggestion()
- protected String getNiceSuggestion()
- protected String getSuggestionQueryString()
- public void addStoredField()
- public void addBoostedField()
- public void fieldData()
- public void setFieldBoosting()
- public array getBoostedFields()
- public array|null getQueryFields()
- protected string getStoredDefault()
- protected String getFieldDefinition()
- protected String toXmlTag()
- public void addCopyField()
- public string getCopyFieldDefinitions()
- protected bool classIs()
- protected void _addField()
- protected void _addAs()
- public void add()
- public void canAdd()
- public void delete()
- public bool clearObsoleteClasses()
- public void commit()
- public ArrayData search()
- protected void applySearchVariants()
- public string sanitiseClassName()
- protected array getQueryComponent()
- protected array getRequireFiltersComponent()
- protected array getExcludeFiltersComponent()
- protected string getCriteriaComponent()
- public array getFiltersComponent()
- public SolrService getService()
- public void setService()
- public void uploadConfig()
- // Inherited methods from SearchIndex
- protected string getSourceName()
- public void __construct()
- public void __toString()
- public void fieldData()
- public void addClass()
- public void getClasses()
- public void addFulltextField()
- public void getFulltextFields()
- public void addFilterField()
- public void getFilterFields()
- public void addSortField()
- public void getSortFields()
- public void addAllFulltextFields()
- public MultipleArrayIterator getFieldsIterator()
- public void excludeVariantState()
- public void variantStateExcluded()
- public void buildDependancyList()
- public void getDerivedFields()
- public string getDocumentIDForState()
- public string getDocumentID()
- protected mixed _getFieldValue()
- public static void warn()
- public array getDirtyIDs()
- public abstract void add()
- public abstract void delete()
- public abstract void commit()
- public abstract void init()
Hierarchy
Members
protected
- $analyzerFields
- $boostedFields
—
array
List of boosted fields -
$classes
Public, but should only be altered by variants - $copyFields
- $excludedVariantStates
- $extrasPath
- $fulltextFields
- $service
- $sortFields
- $templatesPath
public
- $dependancyList
- $derivedFields
- $filterFields
- $filterTypeMap
- $fulltextTypeMap
- $sortTypeMap
Methods
public
Inherited from SilverStripe\FullTextSearch\Solr\SolrIndex
protected
- _addAs()
- _addField()
- applySearchVariants() — With a common set of variants that are relevant to at least one class in the list (from either the query or the current index), allow them to alter the query to add their variant column conditions.
- classIs() — Determine if the given object is one of the given type
- getCollatedSuggestion() — Extract first suggestion text from collated values
- getCopyDestinations() — Get list of fields each text field should be copied into.
- getCriteriaComponent()
- getExcludeFiltersComponent() — Parse all exclude constraints for inclusion in a filter query
- getFieldDefinition()
- getNiceSuggestion() — Extract a human friendly spelling suggestion from a Solr spellcheck collation string.
- getQueryComponent() — Get the query (q) component for this search
- getRequireFiltersComponent() — Parse all require constraints for inclusion in a filter query
- getStoredDefault() — Gets the default 'stored' value for fields in this index
- getSuggestionQueryString() — Extract a query string from a Solr spellcheck collation string.
- toXmlTag() — Convert definition to XML tag
public
- add()
- addAnalyzer() — Index-time analyzer which is applied to a specific field.
- addBoostedField() — Add a fulltext field with a boosted value
- addCopyField()
- addStoredField() — Add a field that should be stored
- canAdd()
- clearObsoleteClasses() — Clear all records which do not match the given classname whitelist.
- commit()
- delete()
- fieldData()
- generateSchema()
- getBoostedFields() — Get all boosted fields
- getCopyFieldDefinitions() — Generate XML for copy field definitions
- getDefaultField() — Get the default text field, normally '_text'
- getExtrasPath()
- getFieldDefinitions()
- getFiltersComponent() — Get all filter conditions for this search
- getIndexName() — Helper for returning the correct index name. Supports prefixing and suffixing
- getQueryFields() — Determine the best default value for the 'qf' parameter
- getService()
- getTemplatesPath()
- getTypes()
- sanitiseClassName() — Solr requires namespaced classes to have double escaped backslashes
- search()
- setFieldBoosting() — Set the default boosting level for a specific field.
- setService()
- uploadConfig() — Upload config for this index to the given store
Inherited from SilverStripe\FullTextSearch\Search\Indexes\SearchIndex
protected
- _getFieldValue() — Given an object and a field definition (as returned by fieldData) get the current value of that field on that object
- getSourceName() — This is used to clean the source name from suffix suffixes are needed to support multiple relations with the same name on different page types
public
- __toString()
- add() — !! These should be implemented by the full text search engine
- addAllFulltextFields() — Add all database-backed text fields as fulltext searchable fields.
- addClass() — Add a DataObject subclass whose instances should be included in this index
- addFilterField() — Add a field that should be filterable
- addFulltextField() — Add a field that should be fulltext searchable
- addSortField() — Add a field that should be sortable
- buildDependancyList()
- commit()
- delete()
- excludeVariantState()
- fieldData() — Examines the classes this index is built on to try and find defined fields in the class hierarchy for those classes.
- getClasses() — Get the classes added by addClass
- getDerivedFields() — Returns an array where each member is all the fields and the classes that are at the end of some specific lookup chain from one of the base classes
- getDirtyIDs() — Given a class, object id, set of stateful ids and a list of changed fields (in a special format), return what statefulids need updating in this index
- getDocumentID() — Get the "document ID" (a database & variant unique id) given some "Base" class and DataObject
- getDocumentIDForState() — Get the "document ID" (a database & variant unique id) given some "Base" class, DataObject ID and state array
- getFieldsIterator() — Returns an interator that will let you interate through all added fields, regardless of whether they were added as fulltext, filter or sort fields.
- getFilterFields()
- getFulltextFields()
- getSortFields()
- init() — Called during construction, this is the method that builds the structure.
- variantStateExcluded() — Returns true if some variant state should be ignored
- warn() — Log non-fatal errors