abstract class SolrIndex extends SearchIndex (View source)

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
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

copy_fields array

List of copy fields all fulltext fields should be copied into.

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
public static $filterTypeMap
public static $sortTypeMap
protected $analyzerFields
protected $copyFields
protected $extrasPath
protected $templatesPath
protected array $boostedFields

List of boosted fields

protected $service

Methods

public
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

protected
defineMethods()

Adds any methods from Extension instances attached to this object.

protected
registerExtraMethodCallback(string $name, callable $callback)

Register an callback to invoke that defines extra methods

public
bool
hasMethod(string $method)

Return TRUE if a method exists on this object

protected
array
getExtraMethodConfig(string $method)

Get meta-data details on a named method

public
array
allMethodNames(bool $custom = false)

Return the names of all the methods available on this object

protected
array
findMethodsFromExtension(object $extension) 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

No description

protected
defineExtensionMethods()

Adds any methods from Extension instances attached to this object.

public static 
bool
add_extension(string $classOrExtension, string $extension = null)

Add an extension to a specific class.

public static 
remove_extension(string $extension)

Remove an extension from a class.

public static 
array
get_extensions(string $class = null, bool $includeArgumentString = false)

No description

public static 
array|null
get_extra_config_sources(string $class = null)

Get extra config sources for this class

public static 
bool
has_extension(string $classOrExtension, string $requiredExtension = null, bool $strict = false)

Return TRUE if a class has a specified extension.

public
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

public
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

public
Extension|null
getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

public
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.

public
getExtensionInstances()

Get all extension instances for this specific object instance.

public static 
create(mixed ...$args)

An implementation of the factory method, allows you to create an instance of a class

public static 
singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

public static 
config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

public
mixed
stat(string $name) deprecated

Get inherited config value

public
mixed
uninherited(string $name)

Gets the uninherited value for the given config option

public
$this
set_stat(string $name, mixed $value) deprecated

Update the config value for a given property

public
__construct()

No description

public
bool
__isset(string $property)

Check if a field exists on this object or its failover.

public
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.

public
__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.

public
setFailover(ViewableData $failover)

Set a failover object to attempt to get data from if it is not present on this object.

public
getFailover()

Get the current failover object if set

public
bool
hasField(string $field)

Check if a field exists on this object. This should be overloaded in child classes.

public
mixed
getField(string $field)

Get the value of a field on this object. This should be overloaded in child classes.

public
$this
setField(string $field, mixed $value)

Set a field on this object. This should be overloaded in child classes.

public
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.

public
bool
exists()

Return true if this object "exists" i.e. has a sensible value

public
string
__toString()

No description

public
getCustomisedObj()

No description

public
setCustomisedObj(ViewableData $object)

No description

public
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.

public
string
castingClass(string $field)

Get the class name a field on this object will be casted to.

public
string
escapeTypeForField(string $field)

Return the string-format type for the given field.

public
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

public
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.

public
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.

public
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.

public
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.

public
array
getXMLValues(array $fields)

Get an array of XML-escaped values by field name

public
getIterator()

Return a single-item iterator so you can iterate over the fields of a single record.

public
array
getViewerTemplates(string $suffix = '')

Find appropriate templates for SSViewer to use to render this object

public
Me()

When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.

public
string
ThemeDir() deprecated

Return the directory if the current active theme (relative to the site root).

public
string
CSSClasses(string $stopAtClass = self::class)

Get part of the current classes ancestry to be used as a CSS class.

public
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

public
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.

public
addClass(string $class, array $options = array())

Add a DataObject subclass whose instances should be included in this index

public
getClasses()

Get the classes added by addClass

public
addFulltextField(string $field, string $forceType = null, string $extraOptions = array())

Add a field that should be fulltext searchable

public
getFulltextFields()

No description

public
addFilterField(string $field, string $forceType = null, string $extraOptions = array())

Add a field that should be filterable

public
getFilterFields()

No description

public
addSortField(string $field, string $forceType = null, string $extraOptions = array())

Add a field that should be sortable

public
getSortFields()

No description

public
addAllFulltextFields($includeSubclasses = true)

Add all database-backed text fields as fulltext searchable fields.

public
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.

public
excludeVariantState($state)

No description

public
variantStateExcluded($state)

Returns true if some variant state should be ignored

public
buildDependancyList()

No description

public
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

public
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

public
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

public static 
warn(Exception $e)

Log non-fatal errors

public
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

public
add($object)

!! These should be implemented by the full text search engine

public
delete($base, $id, $state)

No description

public
commit()

No description

public
init()

Called during construction, this is the method that builds the structure.

public
string
getTemplatesPath()

No description

public
string
getExtrasPath()

No description

public
generateSchema()

No description

public
string
getIndexName()

Helper for returning the correct index name. Supports prefixing and suffixing

public
getTypes()

No description

public
addAnalyzer(string $field, string $type, array $params)

Index-time analyzer which is applied to a specific field.

public
string
getDefaultField()

Get the default text field, normally '_text'

protected
array
getCopyDestinations()

Get list of fields each text field should be copied into.

public
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.

public
addStoredField(string $field, string $forceType = null, array $extraOptions = array())

Add a field that should be stored

public
addBoostedField(string $field, string $forceType = null, array $extraOptions = array(), float $boost = 2)

Add a fulltext field with a boosted value

public
setFieldBoosting(string $field, float|null $level)

Set the default boosting level for a specific field.

public
array
getBoostedFields()

Get all boosted fields

public
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

public
addCopyField(string $source, string $dest, $extraOptions = array())

No description

public
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

public
canAdd($class)

No description

public
bool
clearObsoleteClasses(array $classes)

Clear all records which do not match the given classname whitelist.

public
search(SearchQuery $query, int $offset = -1, int $limit = -1, array $params = array())

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.

public
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

public
array
getFiltersComponent(SearchQuery $searchQuery)

Get all filter conditions for this search

public
getService()

No description

public
setService(SolrService $service)

No description

public
uploadConfig(SolrConfigStore $store)

Upload config for this index to the given store

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()

Parameters

string $method
array $arguments

Return Value

mixed

Exceptions

BadMethodCallException

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

Parameters

string $name
callable $callback

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

Parameters

string $method

Return Value

bool

protected array getExtraMethodConfig(string $method)

Get meta-data details on a named method

Parameters

string $method

Return Value

array

List of custom method details, if defined for this method

array allMethodNames(bool $custom = false)

Return the names of all the methods available on this object

Parameters

bool $custom

include methods added dynamically at runtime

Return Value

array

protected array findMethodsFromExtension(object $extension) deprecated

deprecated 4.13.0 Will be replaced by findMethodsFrom() in CMS 5

No description

Parameters

object $extension

Return Value

array

protected addMethodsFrom(string $property, string|int $index = null)

Add all the methods from an object property (which is an Extension) to this object.

Parameters

string $property

the property name

string|int $index

an index to use if the property is an array

Exceptions

InvalidArgumentException

protected removeMethodsFrom(string $property, string|int $index = null)

Add all the methods from an object property (which is an Extension) to this object.

Parameters

string $property

the property name

string|int $index

an index to use if the property is an array

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)

Parameters

string $method

the method name to wrap

string $wrap

the method name to wrap to

protected addCallbackMethod(string $method, callable $callback)

Add callback as a method.

Parameters

string $method

Name of method

callable $callback

Callback to invoke. Note: $this is passed as first parameter to this callback and then $args as array

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.

Parameters

string $method

The name of the method to hook into

callable $callback

The callback to execute

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.

Parameters

string $method

The name of the method to hook into

callable $callback

The callback to execute

protected constructExtensions() deprecated

deprecated 4.0.0:5.0.0 Extensions and methods are now lazy-loaded

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()).

Parameters

string $classOrExtension

Class that should be extended - has to be a subclass of Object

string $extension

Subclass of Extension with optional parameters as a string, e.g. "Versioned" or "Translatable('Param')"

Return Value

bool

Flag if the extension was added

See also

http://doc.silverstripe.org/framework/en/trunk/reference/dataextension

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.

Add support for removing extensions with parameters

Parameters

string $extension

class name of an Extension subclass, without parameters

static array get_extensions(string $class = null, bool $includeArgumentString = false)

No description

Parameters

string $class

If omitted, will get extensions for the current class

bool $includeArgumentString

Include the argument string in the return array, FALSE would return array("Versioned"), TRUE returns array("Versioned('Stage','Live')").

Return Value

array

Numeric array of either DataExtension class names, or eval'ed class name strings with constructor arguments.

static array|null get_extra_config_sources(string $class = null)

Get extra config sources for this class

Parameters

string $class

Name of class. If left null will return for the current class

Return Value

array|null

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))

Parameters

string $classOrExtension

Class to check extension for, or the extension name to check if the second argument is null.

string $requiredExtension

If the first argument is the parent class, this is the extension to check. If left null, the first parameter will be treated as the extension.

bool $strict

if the extension has to match the required extension and not be a subclass

Return Value

bool

Flag if the extension exists

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

Parameters

string $method

the method name to call

mixed $a1
mixed $a2
mixed $a3
mixed $a4
mixed $a5
mixed $a6
mixed $a7

Return Value

array

List of results with nulls filtered out

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().

Parameters

string $method

the name of the method to call on each extension

mixed $a1
mixed $a2
mixed $a3
mixed $a4
mixed $a5
mixed $a6
mixed $a7

Return Value

array

Extension|null getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

Parameters

string $extension

Return Value

Extension|null

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()->hasExtension() as it will give you inconsistent results based on when the singleton was first accessed.

Parameters

string $extension

Classname of an Extension subclass without parameters

Return Value

bool

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.

Return Value

Extension[]

Map of DataExtension instances, keyed by classname.

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();

Parameters

mixed ...$args

Return Value

Injectable

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).

Parameters

string $class

Optional classname to create, if the called class should not be used

Return Value

Injectable

The singleton instance

static Config_ForClass config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

Return Value

Config_ForClass

mixed stat(string $name) deprecated

deprecated 5.0 Use ->config()->get() instead

Get inherited config value

Parameters

string $name

Return Value

mixed

mixed uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

$this set_stat(string $name, mixed $value) deprecated

deprecated 5.0 Use ->config()->set() instead

Update the config value for a given property

Parameters

string $name
mixed $value

Return Value

$this

__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.

Parameters

string $property

Return Value

bool

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.

Parameters

string $property

Return Value

mixed

__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.

Parameters

string $property
mixed $value

setFailover(ViewableData $failover)

Set a failover object to attempt to get data from if it is not present on this object.

Parameters

ViewableData $failover

ViewableData|null getFailover()

Get the current failover object if set

Return Value

ViewableData|null

bool hasField(string $field)

Check if a field exists on this object. This should be overloaded in child classes.

Parameters

string $field

Return Value

bool

mixed getField(string $field)

Get the value of a field on this object. This should be overloaded in child classes.

Parameters

string $field

Return Value

mixed

$this setField(string $field, mixed $value)

Set a field on this object. This should be overloaded in child classes.

Parameters

string $field
mixed $value

Return Value

$this

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.

Parameters

array|ViewableData $data

Return Value

ViewableData_Customised

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

Return Value

bool

string __toString()

No description

Return Value

string

the class name

ViewableData getCustomisedObj()

No description

Return Value

ViewableData

setCustomisedObj(ViewableData $object)

No description

Parameters

ViewableData $object

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.

Parameters

string $field

Return Value

string

Casting helper As a constructor pattern, and may include arguments.

Exceptions

Exception

string castingClass(string $field)

Get the class name a field on this object will be casted to.

Parameters

string $field

Return Value

string

string escapeTypeForField(string $field)

Return the string-format type for the given field.

Parameters

string $field

Return Value

string 'xml'|'raw'

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

Parameters

string|array|SSViewer $template

the template to render into

array $customFields

fields to customise() the object with before rendering

Return Value

DBHTMLText

protected string objCacheName(string $fieldName, array $arguments)

Generate the cache name for a field

Parameters

string $fieldName

Name of field

array $arguments

List of optional arguments given

Return Value

string

protected mixed objCacheGet(string $key)

Get a cached value from the field cache

Parameters

string $key

Cache key

Return Value

mixed

protected $this objCacheSet(string $key, mixed $value)

Store a value in the field cache

Parameters

string $key

Cache key

mixed $value

Return Value

$this

protected $this objCacheClear()

Clear object cache

Return Value

$this

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.

Parameters

string $fieldName
array $arguments
bool $cache

Cache this object

string $cacheName

a custom cache name

Return Value

object|DBField

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.

Parameters

string $field
array $arguments
string $identifier

an optional custom cache identifier

Return Value

object|DBField

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.

Parameters

string $field
array $arguments
bool $cache

Return Value

bool

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.

Parameters

string $field
array $arguments
bool $cache

Return Value

string

array getXMLValues(array $fields)

Get an array of XML-escaped values by field name

Parameters

array $fields

an array of field names

Return Value

array

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.

Return Value

ArrayIterator

array getViewerTemplates(string $suffix = '')

Find appropriate templates for SSViewer to use to render this object

Parameters

string $suffix

Return Value

array

ViewableData Me()

When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.

Return Value

ViewableData

string ThemeDir() deprecated

deprecated 4.0.1 Use ModuleResourceLoader::resourcePath() or ModuleResourceLoader::resourceURL() instead

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.

Return Value

string

URL to the current theme

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".

Parameters

string $stopAtClass

the class to stop at (default: ViewableData)

Return Value

string

ViewableData_Debugger Debug()

Return debug information about this object that can be rendered into a template

Return Value

ViewableData_Debugger

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

Parameters

string $source

Return Value

string

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

Parameters

$field
$forceType
$extraOptions

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

Parameters

string $class
  • The class to include
array $options
  • TODO: Remove

Exceptions

Exception

getClasses()

Get the classes added by addClass

addFulltextField(string $field, string $forceType = null, string $extraOptions = array())

Add a field that should be fulltext searchable

Parameters

string $field
  • The field to add
string $forceType
  • The type to force this field as (required in some cases, when not detectable from metadata)
string $extraOptions
  • Dependent on search implementation

getFulltextFields()

No description

addFilterField(string $field, string $forceType = null, string $extraOptions = array())

Add a field that should be filterable

Parameters

string $field
  • The field to add
string $forceType
  • The type to force this field as (required in some cases, when not detectable from metadata)
string $extraOptions
  • Dependent on search implementation

getFilterFields()

No description

addSortField(string $field, string $forceType = null, string $extraOptions = array())

Add a field that should be sortable

Parameters

string $field
  • The field to add
string $forceType
  • The type to force this field as (required in some cases, when not detectable from metadata)
string $extraOptions
  • Dependent on search implementation

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.

Parameters

$includeSubclasses

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.

Return Value

MultipleArrayIterator

excludeVariantState($state)

No description

Parameters

$state

variantStateExcluded($state)

Returns true if some variant state should be ignored

Parameters

$state

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

Parameters

string $base
  • The base class of the object
int $id
  • The ID of the object
array $state
  • The variant state of the object

Return Value

string
  • The document ID as a string

string getDocumentID(DataObject $object, string $base, bool $includesubs)

Get the "document ID" (a database & variant unique id) given some "Base" class and DataObject

Parameters

DataObject $object
  • The object
string $base
  • The base class of the object
bool $includesubs
  • TODO: Probably going away

Return Value

string
  • The document ID as a string

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

Parameters

DataObject $object
  • The object to get the value from
array $field
  • The field definition to use

Return Value

mixed
  • The value of the field, or null if we couldn't look it up for some reason

static warn(Exception $e)

Log non-fatal errors

Parameters

Exception $e

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.

Parameters

string $class
int $id
array $statefulids
array $fields

Return Value

array

add($object)

!! These should be implemented by the full text search engine

Parameters

$object

delete($base, $id, $state)

No description

Parameters

$base
$id
$state

commit()

No description

abstract 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

Return Value

string

Absolute path to the folder containing templates which are used for generating the schema and field definitions.

string getExtrasPath()

No description

Return Value

string

Absolute path to the configuration default files, e.g. solrconfig.xml.

generateSchema()

No description

string getIndexName()

Helper for returning the correct index name. Supports prefixing and suffixing

Return Value

string

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.

Parameters

string $field
string $type
array $params

parameters for the analyzer, usually at least a "class"

See also

http://wiki.apache.org/solr/AnalyzersTokenizersTokenFilters#solr.WhitespaceTokenizerFactory

string getDefaultField()

Get the default text field, normally '_text'

Return Value

string

protected array getCopyDestinations()

Get list of fields each text field should be copied into.

This will fallback to the default field if omitted.

Return Value

array

getFieldDefinitions()

No description

protected string getCollatedSuggestion(mixed $collation = '')

Extract first suggestion text from collated values

Parameters

mixed $collation

Return Value

string

protected string getNiceSuggestion(string $collation = '')

Extract a human friendly spelling suggestion from a Solr spellcheck collation string.

Parameters

string $collation

Return Value

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

Parameters

string $collation

Return Value

string

addStoredField(string $field, string $forceType = null, array $extraOptions = array())

Add a field that should be stored

Parameters

string $field

The field to add

string $forceType

The type to force this field as (required in some cases, when not detectable from metadata)

array $extraOptions

Dependent on search implementation

addBoostedField(string $field, string $forceType = null, array $extraOptions = array(), float $boost = 2)

Add a fulltext field with a boosted value

Parameters

string $field

The field to add

string $forceType

The type to force this field as (required in some cases, when not detectable from metadata)

array $extraOptions

Dependent on search implementation

float $boost

Numeric boosting value (defaults to 2)

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

Parameters

string $field

Full field key (Model_Field)

float|null $level

Numeric boosting value. Set to null to clear boost

array getBoostedFields()

Get all boosted fields

Return Value

array

array|null getQueryFields()

Determine the best default value for the 'qf' parameter

Return Value

array|null

List of query fields, or null if not specified

protected string getStoredDefault()

Gets the default 'stored' value for fields in this index

Return Value

string

A default value for the 'stored' field option, either 'true' or 'false'

protected string getFieldDefinition(string $name, array $spec, array $typeMap = null)

No description

Parameters

string $name
array $spec
array $typeMap

Return Value

string XML

protected string toXmlTag(string $tag, string[] $attrs, string $content = null)

Convert definition to XML tag

Parameters

string $tag
string[] $attrs

Map of attributes

string $content

Inner content

Return Value

string

XML tag

addCopyField(string $source, string $dest, $extraOptions = array())

No description

Parameters

string $source

Composite field name (_)

string $dest
$extraOptions

string getCopyFieldDefinitions()

Generate XML for copy field definitions

Return Value

string

protected bool classIs(string $class, array|string $base)

Determine if the given object is one of the given type

Parameters

string $class
array|string $base

Class or list of base classes

Return Value

bool

protected _addField($doc, $object, $field)

No description

Parameters

$doc
$object
$field

protected _addAs($object, $base, $options)

No description

Parameters

$object
$base
$options

canAdd($class)

No description

Parameters

$class

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.

Parameters

array $classes

List of non-obsolete classes in the same format as SolrIndex::getClasses()

Return Value

bool

Flag if successful

Exceptions

Apache_Solr_HttpTransportException

No description

Parameters

SearchQuery $query
int $offset
int $limit
array $params

Extra request parameters passed through to Solr

Return Value

ArrayData

Map with the following keys:

  • 'Matches': ArrayList of the matched object instances

Exceptions

Apache_Solr_HttpTransportException
Apache_Solr_InvalidArgumentException

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.

Parameters

SearchQuery $query

string sanitiseClassName(string $className, string $replaceWith = '\\\\')

Solr requires namespaced classes to have double escaped backslashes

Parameters

string $className

E.g. My\Object\Here

string $replaceWith

The replacement character(s) to use

Return Value

string

E.g. My\Object\Here

protected array getQueryComponent(SearchQuery $searchQuery, array $hlq = array())

Get the query (q) component for this search

Parameters

SearchQuery $searchQuery
array $hlq

Highlight query returned by reference

Return Value

array

protected array getRequireFiltersComponent(SearchQuery $searchQuery)

Parse all require constraints for inclusion in a filter query

Parameters

SearchQuery $searchQuery

Return Value

array

List of parsed string values for each require

protected array getExcludeFiltersComponent(SearchQuery $searchQuery)

Parse all exclude constraints for inclusion in a filter query

Parameters

SearchQuery $searchQuery

Return Value

array

List of parsed string values for each exclusion

protected string getCriteriaComponent(SearchQuery $searchQuery)

No description

Parameters

SearchQuery $searchQuery

Return Value

string

Exceptions

Exception

array getFiltersComponent(SearchQuery $searchQuery)

Get all filter conditions for this search

Parameters

SearchQuery $searchQuery

Return Value

array

Exceptions

Exception

SolrService getService()

No description

Return Value

SolrService

setService(SolrService $service)

No description

Parameters

SolrService $service

uploadConfig(SolrConfigStore $store)

Upload config for this index to the given store

Parameters

SolrConfigStore $store