CwpSearchIndex
abstract class CwpSearchIndex extends SolrIndex (View source)
Abstract wrapper for all cwp-core features
Can be extended by user indexes to include these features. {\CWP\Search\CwpSolrIndex} for an example
Traits
Allows an object to have extensions applied to it.
A class that can be instantiated or replaced via DI
Provides extensions to this object to integrate it with standard config API methods.
Allows an object to declare a set of custom methods
Config options
| extensions | array | An array of extension names and parameters to be applied to this object upon construction. |
from Extensible |
| unextendable_classes | array | Classes that cannot be extended |
from Extensible |
| casting | from SolrIndex | ||
| default_cast | string | The default object to cast scalar fields to if casting information is not specified, and casting to an object is required. |
from ViewableData |
| casting_cache | array | from ViewableData | |
| hide_ancestor | string | Allows this index to hide a parent index. Specifies the name of a parent index to disable |
from SearchIndex |
| class_delimiter | string | Used to separate class name and relation name in the sources array this string must not be present in class name |
from SearchIndex |
| default_field | string | Name of default field |
from SolrIndex |
| copy_fields | array | Copy all fields into both search and spellcheck data source |
|
| dictionary | string | Default dictionary to use. This will overwrite the 'spellcheck.dictionary' option for searches given, unless set to empty. |
Properties
| protected static | array | $extra_methods | Custom method sources |
from CustomMethods |
| protected | array | $extra_method_registers | Name of methods to invoke by defineMethods for this instance |
from CustomMethods |
| protected static | array | $built_in_methods | Non-custom methods |
from CustomMethods |
| protected | Extension[] | $extension_instances | from Extensible | |
| protected | callable[][] | $beforeExtendCallbacks | List of callbacks to call prior to extensions having extend called on them, each grouped by methodName. |
from Extensible |
| protected | callable[][] | $afterExtendCallbacks | List of callbacks to call after extensions having extend called on them, each grouped by methodName. |
from Extensible |
| protected | ViewableData | $failover | A failover object to attempt to get data from if it is not present on this object. |
from ViewableData |
| protected | ViewableData | $customisedObject | from ViewableData | |
| protected | $classes | Public, but should only be altered by variants |
from SearchIndex | |
| protected | $fulltextFields | from SearchIndex | ||
| public | $filterFields | from SearchIndex | ||
| protected | $sortFields | from SearchIndex | ||
| protected | $excludedVariantStates | from SearchIndex | ||
| public | $dependancyList | from SearchIndex | ||
| public | $derivedFields | from SearchIndex | ||
| public static | $fulltextTypeMap | from SolrIndex | ||
| public static | $filterTypeMap | from SolrIndex | ||
| public static | $sortTypeMap | from SolrIndex | ||
| protected | $analyzerFields | from SolrIndex | ||
| protected | $copyFields | from SolrIndex | ||
| protected | $extrasPath | from SolrIndex | ||
| protected | $templatesPath | from SolrIndex | ||
| protected | array | $boostedFields | List of boosted fields |
from SolrIndex |
| protected | $service | from SolrIndex |
Methods
Attempts to locate and call a method dynamically added to a class at runtime if a default cannot be located
Adds any methods from Extension instances attached to this object.
Register an callback to invoke that defines extra methods
Return TRUE if a method exists on this object
Get meta-data details on a named method
Return the names of all the methods available on this object
Add all the methods from an object property (which is an Extension) to this object.
Add all the methods from an object property (which is an Extension) to this object.
Add a wrapper method - a method which points to another method with a different name. For example, Thumbnail(x) can be wrapped to generateThumbnail(x)
Add callback as a method.
Allows user code to hook into Object::extend prior to control being delegated to extensions. Each callback will be reset once called.
Allows user code to hook into Object::extend after control being delegated to extensions. Each callback will be reset once called.
Adds any methods from Extension instances attached to this object.
Add an extension to a specific class.
No description
Get extra config sources for this class
Return TRUE if a class has a specified extension.
Calls a method if available on both this object and all applied Extensions, and then attempts to merge all results into an array
Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed
Get an extension instance attached to this object by name.
Returns TRUE if this object instance has a specific extension applied in $extension_instances. Extension instances are initialized at constructor time, meaning if you use add_extension() afterwards, the added extension will just be added to new instances of the extended class. Use the static method has_extension() to check if a class (not an instance) has a specific extension.
Get all extension instances for this specific object instance.
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
Gets the uninherited value for the given config option
Check if a field exists on this object or its failover.
Get the value of a property/field on this object. This will check if a method called get{$property} exists, then check if a field is available using ViewableData::getField(), then fall back on a failover object.
Set a property/field on this object. This will check for the existence of a method called set{$property}, then use the ViewableData::setField() method.
Set a failover object to attempt to get data from if it is not present on this object.
Check if a field exists on this object. This should be overloaded in child classes.
Get the value of a field on this object. This should be overloaded in child classes.
Set a field on this object. This should be overloaded in child classes.
Merge some arbitrary data in with this object. This method returns a ViewableData_Customised instance with references to both this and the new custom data.
Return true if this object "exists" i.e. has a sensible value
Return the "casting helper" (a piece of PHP code that when evaluated creates a casted value object) for a field on this object. This helper will be a subclass of DBField.
Get the class name a field on this object will be casted to.
Return the string-format type for the given field.
Render this object into the template, and get the result as a string. You can pass one of the following as the $template parameter:
- a template name (e.g. Page)
- an array of possible template names - the first valid one will be used
- an SSViewer instance
Generate the cache name for a field
Store a value in the field cache
Get the value of a field on this object, automatically inserting the value into any available casting objects that have been specified.
A simple wrapper around ViewableData::obj() that automatically caches the result so it can be used again without re-running the method.
Checks if a given method/field has a valid value. If the result is an object, this will return the result of the exists method, otherwise will check if the result is not just an empty paragraph tag.
Get the string value of a field on this object that has been suitable escaped to be inserted directly into a template.
Get an array of XML-escaped values by field name
Return a single-item iterator so you can iterate over the fields of a single record.
Find appropriate templates for SSViewer to use to render this object
When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.
Get part of the current classes ancestry to be used as a CSS class.
Return debug information about this object that can be rendered into a template
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
Examines the classes this index is built on to try and find defined fields in the class hierarchy for those classes.
Add a DataObject subclass whose instances should be included in this index
Add a field that should be fulltext searchable
Add a field that should be filterable
Add a field that should be sortable
Add all database-backed text fields as fulltext searchable fields.
Returns an interator that will let you interate through all added fields, regardless of whether they were added as fulltext, filter or sort fields.
Returns true if some variant state should be ignored
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
Get the "document ID" (a database & variant unique id) given some "Base" class, DataObject ID and state array
Get the "document ID" (a database & variant unique id) given some "Base" class and DataObject
Given an object and a field definition (as returned by fieldData) get the current value of that field on that object
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
Helper for returning the correct index name. Supports prefixing and suffixing
Index-time analyzer which is applied to a specific field.
Get list of fields each text field should be copied into.
Extract first suggestion text from collated values
Extract a human friendly spelling suggestion from a Solr spellcheck collation string.
Extract a query string from a Solr spellcheck collation string.
Add a field that should be stored
Add a fulltext field with a boosted value
Set the default boosting level for a specific field.
Determine the best default value for the 'qf' parameter
Gets the default 'stored' value for fields in this index
No description
Convert definition to XML tag
No description
Determine if the given object is one of the given type
Clear all records which do not match the given classname whitelist.
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.
Solr requires namespaced classes to have double escaped backslashes
Get the query (q) component for this search
Parse all require constraints for inclusion in a filter query
Parse all exclude constraints for inclusion in a filter query
Details
mixed
__call(string $method, array $arguments)
Attempts to locate and call a method dynamically added to a class at runtime if a default cannot be located
You can add extra methods to a class using Extensions}, {@link Object::createMethod() or Object::addWrapperMethod()
protected
defineMethods()
Adds any methods from Extension instances attached to this object.
All these methods can then be called directly on the instance (transparently mapped through __call()}), or called explicitly through {@link extend().
protected
registerExtraMethodCallback(string $name, callable $callback)
Register an callback to invoke that defines extra methods
bool
hasMethod(string $method)
Return TRUE if a method exists on this object
This should be used rather than PHP's inbuild method_exists() as it takes into account methods added via extensions
protected array
getExtraMethodConfig(string $method)
Get meta-data details on a named method
array
allMethodNames(bool $custom = false)
Return the names of all the methods available on this object
protected array
findMethodsFromExtension(object $extension)
deprecated
deprecated
No description
protected
addMethodsFrom(string $property, string|int $index = null)
Add all the methods from an object property (which is an Extension) to this object.
protected
removeMethodsFrom(string $property, string|int $index = null)
Add all the methods from an object property (which is an Extension) to this object.
protected
addWrapperMethod(string $method, string $wrap)
Add a wrapper method - a method which points to another method with a different name. For example, Thumbnail(x) can be wrapped to generateThumbnail(x)
protected
addCallbackMethod(string $method, callable $callback)
Add callback as a method.
protected
beforeExtending(string $method, callable $callback)
Allows user code to hook into Object::extend prior to control being delegated to extensions. Each callback will be reset once called.
protected
afterExtending(string $method, callable $callback)
Allows user code to hook into Object::extend after control being delegated to extensions. Each callback will be reset once called.
protected
constructExtensions()
deprecated
deprecated
No description
protected
defineExtensionMethods()
Adds any methods from Extension instances attached to this object.
All these methods can then be called directly on the instance (transparently mapped through __call()}), or called explicitly through {@link extend().
static bool
add_extension(string $classOrExtension, string $extension = null)
Add an extension to a specific class.
The preferred method for adding extensions is through YAML config, since it avoids autoloading the class, and is easier to override in more specific configurations.
As an alternative, extensions can be added to a specific class directly in the Object::$extensions array. See SiteTree::$extensions for examples. Keep in mind that the extension will only be applied to new instances, not existing ones (including all instances created through singleton()).
static
remove_extension(string $extension)
Remove an extension from a class.
Note: This will not remove extensions from parent classes, and must be called directly on the class assigned the extension.
Keep in mind that this won't revert any datamodel additions of the extension at runtime, unless its used before the schema building kicks in (in your _config.php). Doesn't remove the extension from any Object instances which are already created, but will have an effect on new extensions. Clears any previously created singletons through singleton() to avoid side-effects from stale extension information.
static array
get_extensions(string $class = null, bool $includeArgumentString = false)
No description
static array|null
get_extra_config_sources(string $class = null)
Get extra config sources for this class
static bool
has_extension(string $classOrExtension, string $requiredExtension = null, bool $strict = false)
Return TRUE if a class has a specified extension.
This supports backwards-compatible format (static Object::has_extension($requiredExtension)) and new format ($object->has_extension($class, $requiredExtension))
array
invokeWithExtensions(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = null)
Calls a method if available on both this object and all applied Extensions, and then attempts to merge all results into an array
array
extend(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = null)
Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed
Currently returns an array, with an index resulting every time the function is called. Only adds returns if they're not NULL, to avoid bogus results from methods just defined on the parent extension. This is important for permission-checks through extend, as they use min() to determine if any of the returns is FALSE. As min() doesn't do type checking, an included NULL return would fail the permission checks.
The extension methods are defined during __construct()} in {@link defineMethods().
Extension|null
getExtensionInstance(string $extension)
Get an extension instance attached to this object by name.
bool
hasExtension(string $extension)
Returns TRUE if this object instance has a specific extension applied in $extension_instances. Extension instances are initialized at constructor time, meaning if you use add_extension() afterwards, the added extension will just be added to new instances of the extended class. Use the static method has_extension() to check if a class (not an instance) has a specific extension.
Caution: Don't use singleton(
Extension[]
getExtensionInstances()
Get all extension instances for this specific object instance.
See get_extensions() to get all applied extension classes for this class (not the instance).
This method also provides lazy-population of the extension_instances property.
static Injectable
create(mixed ...$args)
An implementation of the factory method, allows you to create an instance of a class
This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.
This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create(SiteTree::class); $list = SiteTree::get();
static Injectable
singleton(string $class = null)
Creates a class instance by the "singleton" design pattern.
It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).
static Config_ForClass
config()
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
mixed
stat(string $name)
deprecated
deprecated
Get inherited config value
mixed
uninherited(string $name)
Gets the uninherited value for the given config option
$this
set_stat(string $name, mixed $value)
deprecated
deprecated
Update the config value for a given property
__construct()
No description
bool
__isset(string $property)
Check if a field exists on this object or its failover.
Note that, unlike the core isset() implementation, this will return true if the property is defined and set to null.
mixed
__get(string $property)
Get the value of a property/field on this object. This will check if a method called get{$property} exists, then check if a field is available using ViewableData::getField(), then fall back on a failover object.
__set(string $property, mixed $value)
Set a property/field on this object. This will check for the existence of a method called set{$property}, then use the ViewableData::setField() method.
setFailover(ViewableData $failover)
Set a failover object to attempt to get data from if it is not present on this object.
ViewableData|null
getFailover()
Get the current failover object if set
bool
hasField(string $field)
Check if a field exists on this object. This should be overloaded in child classes.
mixed
getField(string $field)
Get the value of a field on this object. This should be overloaded in child classes.
$this
setField(string $field, mixed $value)
Set a field on this object. This should be overloaded in child classes.
ViewableData_Customised
customise(array|ViewableData $data)
Merge some arbitrary data in with this object. This method returns a ViewableData_Customised instance with references to both this and the new custom data.
Note that any fields you specify will take precedence over the fields on this object.
bool
exists()
Return true if this object "exists" i.e. has a sensible value
This method should be overridden in subclasses to provide more context about the classes state. For example, a DataObject class could return false when it is deleted from the database
string
__toString()
No description
ViewableData
getCustomisedObj()
No description
setCustomisedObj(ViewableData $object)
No description
string
castingHelper(string $field)
Return the "casting helper" (a piece of PHP code that when evaluated creates a casted value object) for a field on this object. This helper will be a subclass of DBField.
string
castingClass(string $field)
Get the class name a field on this object will be casted to.
string
escapeTypeForField(string $field)
Return the string-format type for the given field.
DBHTMLText
renderWith(string|array|SSViewer $template, array $customFields = null)
Render this object into the template, and get the result as a string. You can pass one of the following as the $template parameter:
- a template name (e.g. Page)
- an array of possible template names - the first valid one will be used
- an SSViewer instance
protected string
objCacheName(string $fieldName, array $arguments)
Generate the cache name for a field
protected mixed
objCacheGet(string $key)
Get a cached value from the field cache
protected $this
objCacheSet(string $key, mixed $value)
Store a value in the field cache
protected $this
objCacheClear()
Clear object cache
object|DBField
obj(string $fieldName, array $arguments = [], bool $cache = false, string $cacheName = null)
Get the value of a field on this object, automatically inserting the value into any available casting objects that have been specified.
object|DBField
cachedCall(string $field, array $arguments = [], string $identifier = null)
A simple wrapper around ViewableData::obj() that automatically caches the result so it can be used again without re-running the method.
bool
hasValue(string $field, array $arguments = [], bool $cache = true)
Checks if a given method/field has a valid value. If the result is an object, this will return the result of the exists method, otherwise will check if the result is not just an empty paragraph tag.
string
XML_val(string $field, array $arguments = [], bool $cache = false)
Get the string value of a field on this object that has been suitable escaped to be inserted directly into a template.
array
getXMLValues(array $fields)
Get an array of XML-escaped values by field name
ArrayIterator
getIterator()
Return a single-item iterator so you can iterate over the fields of a single record.
This is useful so you can use a single record inside a <% control %> block in a template - and then use to access individual fields on this object.
array
getViewerTemplates(string $suffix = '')
Find appropriate templates for SSViewer to use to render this object
ViewableData
Me()
When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.
string
ThemeDir()
deprecated
deprecated
Return the directory if the current active theme (relative to the site root).
This method is useful for things such as accessing theme images from your template without hardcoding the theme
page - e.g. 
.
This method should only be used when a theme is currently active. However, it will fall over to the current project directory.
string
CSSClasses(string $stopAtClass = self::class)
Get part of the current classes ancestry to be used as a CSS class.
This method returns an escaped string of CSS classes representing the current classes ancestry until it hits a stop point - e.g. "Page DataObject ViewableData".
ViewableData_Debugger
Debug()
Return debug information about this object that can be rendered into a template
protected string
getSourceName(string $source)
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
fieldData($field, $forceType = null, $extraOptions = array())
Examines the classes this index is built on to try and find defined fields in the class hierarchy for those classes.
Looks for db and viewable-data fields, although can't necessarily find type for viewable-data fields. If multiple classes have a relation with the same name all of these will be included in the search index Note that only classes that have the relations uninherited (defined in them) will be listed this is because inherited relations do not need to be processed by index explicitly
addClass(string $class, array $options = array())
Add a DataObject subclass whose instances should be included in this index
Can only be called when addFulltextField, addFilterField, addSortField and addAllFulltextFields have not yet been called for this index instance
getClasses()
Get the classes added by addClass
addFulltextField(string $field, string $forceType = null, string $extraOptions = array())
Add a field that should be fulltext searchable
getFulltextFields()
No description
addFilterField(string $field, string $forceType = null, string $extraOptions = array())
Add a field that should be filterable
getFilterFields()
No description
addSortField(string $field, string $forceType = null, string $extraOptions = array())
Add a field that should be sortable
getSortFields()
No description
addAllFulltextFields($includeSubclasses = true)
Add all database-backed text fields as fulltext searchable fields.
For every class included in the index, examines those classes and all subclasses looking for "Text" database fields (Varchar, Text, HTMLText, etc) and adds them all as fulltext searchable fields.
MultipleArrayIterator
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.
excludeVariantState($state)
No description
variantStateExcluded($state)
Returns true if some variant state should be ignored
buildDependancyList()
No description
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
string
getDocumentIDForState(string $base, int $id, array $state)
Get the "document ID" (a database & variant unique id) given some "Base" class, DataObject ID and state array
string
getDocumentID(DataObject $object, string $base, bool $includesubs)
Get the "document ID" (a database & variant unique id) given some "Base" class and DataObject
protected mixed
_getFieldValue(DataObject $object, array $field)
Given an object and a field definition (as returned by fieldData) get the current value of that field on that object
static
warn(Exception $e)
Log non-fatal errors
array
getDirtyIDs(string $class, int $id, array $statefulids, array $fields)
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
Internal function used by SearchUpdater.
add($object)
!! These should be implemented by the full text search engine
delete($base, $id, $state)
No description
commit()
No description
init()
Called during construction, this is the method that builds the structure.
Used instead of overriding __construct as we have specific execution order - code that has to be run before and/or after this.
string
getTemplatesPath()
No description
string
getExtrasPath()
No description
generateSchema()
No description
string
getIndexName()
Helper for returning the correct index name. Supports prefixing and suffixing
getTypes()
No description
addAnalyzer(string $field, string $type, array $params)
Index-time analyzer which is applied to a specific field.
Can be used to remove HTML tags, apply stemming, etc.
string
getDefaultField()
Get the default text field, normally '_text'
protected array
getCopyDestinations()
Get list of fields each text field should be copied into.
This will fallback to the default field if omitted.
getFieldDefinitions()
No description
protected string
getCollatedSuggestion(mixed $collation = '')
Extract first suggestion text from collated values
protected string
getNiceSuggestion(string $collation = '')
Extract a human friendly spelling suggestion from a Solr spellcheck collation string.
protected string
getSuggestionQueryString(string $collation = '')
Extract a query string from a Solr spellcheck collation string.
Useful for constructing 'Did you mean?' links, for example: $SuggestionNice
addStoredField(string $field, string $forceType = null, array $extraOptions = array())
Add a field that should be stored
addBoostedField(string $field, string $forceType = null, array $extraOptions = array(), float $boost = 2)
Add a fulltext field with a boosted value
setFieldBoosting(string $field, float|null $level)
Set the default boosting level for a specific field.
Will control the default value for qf param (Query Fields), but will not override a query-specific value.
Fields must be added before having a field boosting specified
array
getBoostedFields()
Get all boosted fields
array|null
getQueryFields()
Determine the best default value for the 'qf' parameter
protected string
getStoredDefault()
Gets the default 'stored' value for fields in this index
protected string
getFieldDefinition(string $name, array $spec, array $typeMap = null)
No description
protected string
toXmlTag(string $tag, string[] $attrs, string $content = null)
Convert definition to XML tag
addCopyField(string $source, string $dest, $extraOptions = array())
No description
string
getCopyFieldDefinitions()
Generate XML for copy field definitions
protected bool
classIs(string $class, array|string $base)
Determine if the given object is one of the given type
protected
_addField($doc, $object, $field)
No description
protected
_addAs($object, $base, $options)
No description
canAdd($class)
No description
bool
clearObsoleteClasses(array $classes)
Clear all records which do not match the given classname whitelist.
Can also be used to trim an index when reducing to a narrower set of classes.
Ignores current state / variant.
ArrayData
search(SearchQuery $query, int $offset = -1, int $limit = -1, array $params = [])
No description
protected
applySearchVariants(SearchQuery $query)
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.
string
sanitiseClassName(string $className, string $replaceWith = '\\\\')
Solr requires namespaced classes to have double escaped backslashes
protected array
getQueryComponent(SearchQuery $searchQuery, array $hlq = array())
Get the query (q) component for this search
protected array
getRequireFiltersComponent(SearchQuery $searchQuery)
Parse all require constraints for inclusion in a filter query
protected array
getExcludeFiltersComponent(SearchQuery $searchQuery)
Parse all exclude constraints for inclusion in a filter query
protected string
getCriteriaComponent(SearchQuery $searchQuery)
No description
array
getFiltersComponent(SearchQuery $searchQuery)
Get all filter conditions for this search
SolrService
getService()
No description
setService(SolrService $service)
No description
uploadConfig(SolrConfigStore $store)
Upload config for this index to the given store