abstract class SolrIndex extends SearchIndex (View source)

Properties

public string $class from  SS_Object
protected array $extension_instances from  SS_Object
protected $beforeExtendCallbacks

List of callbacks to call prior to extensions having extend called on them, each grouped by methodName.

from  SS_Object
protected $afterExtendCallbacks

List of callbacks to call after extensions having extend called on them, each grouped by methodName.

from  SS_Object
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 static 
config()

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

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.

public static 
create()

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

public static 
singleton()

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

public static 
create_from_string($classSpec, $firstArg = null)

Create an object from a string representation. It treats it as a PHP constructor without the 'new' keyword. It also manages to construct the object without the use of eval().

public static 
parse_class_spec($classSpec)

Parses a class-spec, such as "Versioned('Stage','Live')", as passed to create_from_string().

public static 
strong_create()

Similar to Object::create(), except that classes are only overloaded if you set the $strong parameter to TRUE when using Object::useCustomClass()

public static 
useCustomClass(string $oldClass, string $newClass, bool $strong = false)

This class allows you to overload classes with other classes when they are constructed using the factory method Object::create()

public static 
string
getCustomClass(string $class)

If a class has been overloaded, get the class name it has been overloaded with - otherwise return the class name

public static 
any
static_lookup($class, $name, null $default = null)

Get the value of a static property of a class, even in that property is declared protected (but not private), without any inheritance, merging or parent lookup if it doesn't exist on the given class.

public static 
get_static($class, $name, $uncached = false) deprecated

No description

public static 
set_static($class, $name, $value) deprecated

No description

public static 
uninherited_static($class, $name, $uncached = false) deprecated

No description

public static 
combined_static($class, $name, $ceiling = false) deprecated

No description

public static 
addStaticVars($class, $properties, $replace = false) deprecated

No description

public static 
add_static_var($class, $name, $value, $replace = false) deprecated

No description

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

Return TRUE if a class has a specified extension.

public static 
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, bool $includeArgumentString = false)

No description

public static 
get_extra_config_sources($class = null)

No description

public
__construct()

No description

public
mixed
__call(string $method, array $arguments)

Attemps to locate and call a method dynamically added to a class at runtime if a default cannot be located

public
bool
hasMethod(string $method)

Return TRUE if a method exists on this object

public
array
allMethodNames(bool $custom = false)

Return the names of all the methods available on this object

public
defineMethods()

Add methods from the ViewableData::$failover object, as well as wrapping any methods prefixed with an underscore into a ViewableData::cachedCall().

protected
array
findMethodsFromExtension(object $extension)

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
createMethod(string $method, string $code)

Add an extra method using raw PHP code passed as a string

public
stat($name, $uncached = false)

No description

public
set_stat($name, $value)

No description

public
uninherited($name)

No description

public
bool
exists()

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

public
string
parentClass()

No description

public
bool
is_a(string $class)

Check if this class is an instance of a specific class, or has that class as one of its parents

public
string
__toString()

No description

public
mixed
invokeWithExtensions(string $method, mixed $argument = 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
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
array
getExtensionInstances()

Get all extension instances for this specific object instance.

public
mixed
cacheToFile(string $method, int $lifetime = 3600, string $ID = false, array $arguments = array())

Cache the results of an instance method in this object to a file, or if it is already cache return the cached results

public
clearCache($method, $ID = false, $arguments = array())

Clears the cache for the given cacheToFile call

protected
mixed
loadCache(string $cache, int $lifetime = 3600)

Loads a cache from the filesystem if a valid on is present and within the specified lifetime

protected
saveCache(string $cache, mixed $data)

Save a piece of cached data to the file system

protected
string
sanitiseCachename(string $name)

Strip a file name of special characters so it is suitable for use as a cache file name

public static 
string
castingObjectCreator(string $fieldSchema)

Converts a field spec into an object creator. For example: "Int" becomes "new Int($fieldName);" and "Varchar(50)" becomes "new Varchar($fieldName, 50);".

public static 
array
castingObjectCreatorPair(string $fieldSchema)

Convert a field schema (e.g. "Varchar(50)") into a casting object creator array that contains both a className and castingHelper constructor code. See castingObjectCreator for more information about the constructor.

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
setField(string $field, mixed $value)

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

public
unknown
deprecatedCachedCall($method, $args = null, string $identifier = null)

Method to facilitate deprecation of underscore-prefixed methods automatically being cached.

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

No description

public
setCustomisedObj(ViewableData $object)

No description

public
array
castingHelperPair(string $field)

Get the class a field on this object would be casted to, as well as the casting helper for casting a field to an object (see ViewableData::castingHelper() for information on casting helpers).

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.

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
buildCastingCache(reference $cache)

Save the casting cache for this object (including data from any failovers) into a variable

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
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
objCacheSet(string $key, mixed $value)

Store a value in the field cache

public
obj(string $fieldName, array $arguments = null, bool $forceReturnedObject = true, 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
cachedCall(string $field, array $arguments = null, 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 = null, 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
XML_val($field, $arguments = null, $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
RAW_val($field, $arguments = null, $cache = true)

Return the value of the field without any escaping being applied.

public
SQL_val($field, $arguments = null, $cache = true)

Return the value of a field in an SQL-safe format.

public
JS_val($field, $arguments = null, $cache = true)

Return the value of a field in a JavaScript-save format.

public
ATT_val($field, $arguments = null, $cache = true)

Return the value of a field escaped suitable to be inserted into an XML node attribute.

public
array
getXMLValues($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
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(string $subtheme = false)

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

public
string
CSSClasses(string $stopAtClass = 'ViewableData')

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($class, $id, $statefulids, $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
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

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

static Config_ForClass|null config()

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

Return Value

Config_ForClass|null

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

static SS_Object create()

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

This method first for strong class overloads (singletons & DB interaction), then custom class overloads. If an overload is found, an instance of this is returned rather than the original class. To overload a class, use Object::useCustomClass()

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'); $list = SiteTree::get();

Return Value

SS_Object

static SS_Object singleton()

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

Return Value

SS_Object

The singleton instance

static create_from_string($classSpec, $firstArg = null)

Create an object from a string representation. It treats it as a PHP constructor without the 'new' keyword. It also manages to construct the object without the use of eval().

Construction itself is done with Object::create(), so that Object::useCustomClass() calls are respected.

Object::create_from_string("Versioned('Stage','Live')") will return the result of Versioned::create('Stage', 'Live);

It is designed for simple, clonable objects. The first time this method is called for a given string it is cached, and clones of that object are returned.

If you pass the $firstArg argument, this will be prepended to the constructor arguments. It's impossible to pass null as the firstArg argument.

Object::create_from_string("Varchar(50)", "MyField") will return the result of Vachar::create('MyField', '50');

Arguments are always strings, although this is a quirk of the current implementation rather than something that can be relied upon.

Parameters

$classSpec
$firstArg

static parse_class_spec($classSpec)

Parses a class-spec, such as "Versioned('Stage','Live')", as passed to create_from_string().

Returns a 2-elemnent array, with classname and arguments

Parameters

$classSpec

static SS_Object strong_create()

Similar to Object::create(), except that classes are only overloaded if you set the $strong parameter to TRUE when using Object::useCustomClass()

Return Value

SS_Object

static useCustomClass(string $oldClass, string $newClass, bool $strong = false)

This class allows you to overload classes with other classes when they are constructed using the factory method Object::create()

Parameters

string $oldClass

the class to replace

string $newClass

the class to replace it with

bool $strong

allows you to enforce a certain class replacement under all circumstances. This is used in singletons and DB interaction classes

static string getCustomClass(string $class)

If a class has been overloaded, get the class name it has been overloaded with - otherwise return the class name

Parameters

string $class

the class to check

Return Value

string

the class that would be created if you called Object::create() with the class

static any static_lookup($class, $name, null $default = null)

Get the value of a static property of a class, even in that property is declared protected (but not private), without any inheritance, merging or parent lookup if it doesn't exist on the given class.

Parameters

$class
  • The class to get the static from
$name
  • The property to get from the class
null $default
  • The value to return if property doesn't exist on class

Return Value

any
  • The value of the static property $name on class $class, or $default if that property is not defined

static get_static($class, $name, $uncached = false) deprecated

deprecated

No description

Parameters

$class
$name
$uncached

static set_static($class, $name, $value) deprecated

deprecated

No description

Parameters

$class
$name
$value

static uninherited_static($class, $name, $uncached = false) deprecated

deprecated

No description

Parameters

$class
$name
$uncached

static combined_static($class, $name, $ceiling = false) deprecated

deprecated

No description

Parameters

$class
$name
$ceiling

static addStaticVars($class, $properties, $replace = false) deprecated

deprecated

No description

Parameters

$class
$properties
$replace

static add_static_var($class, $name, $value, $replace = false) deprecated

deprecated

No description

Parameters

$class
$name
$value
$replace

static 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

if 1 argument supplied, the class name of the extension to check for; if 2 supplied, the class name to test

string $requiredExtension

used only if 2 arguments supplied

bool $strict

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

static 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')"

See also

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

static remove_extension(string $extension)

Remove an extension from a class.

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

Classname of an Extension subclass, without parameters

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

No description

Parameters

string $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 classnames, or eval'ed classname strings with constructor arguments.

static get_extra_config_sources($class = null)

No description

Parameters

$class

__construct()

No description

mixed __call(string $method, array $arguments)

Attemps 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

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

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

defineMethods()

Add methods from the ViewableData::$failover object, as well as wrapping any methods prefixed with an underscore into a ViewableData::cachedCall().

protected array findMethodsFromExtension(object $extension)

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

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 createMethod(string $method, string $code)

Add an extra method using raw PHP code passed as a string

Parameters

string $method

the method name

string $code

the PHP code - arguments will be in an array called $args, while you can access this object by using $obj. Note that you cannot call protected methods, as the method is actually an external function

stat($name, $uncached = false)

No description

Parameters

$name
$uncached

See also

SS_Object::get_static

set_stat($name, $value)

No description

Parameters

$name
$value

See also

SS_Object::set_static

uninherited($name)

No description

Parameters

$name

See also

SS_Object::uninherited_static

bool exists()

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

This method should be overriden 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 parentClass()

No description

Return Value

string

this classes parent class

bool is_a(string $class)

Check if this class is an instance of a specific class, or has that class as one of its parents

Parameters

string $class

Return Value

bool

string __toString()

No description

Return Value

string

the class name

mixed invokeWithExtensions(string $method, mixed $argument = null)

Calls a method if available on both this object and all applied Extensions, and then attempts to merge all results into an array

integrate inheritance rules

Parameters

string $method

the method name to call

mixed $argument

a single argument to pass

Return Value

mixed

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 getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

Parameters

string $extension

Return Value

Extension

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

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

Return Value

array

Map of DataExtension instances, keyed by classname.

mixed cacheToFile(string $method, int $lifetime = 3600, string $ID = false, array $arguments = array())

Cache the results of an instance method in this object to a file, or if it is already cache return the cached results

Parameters

string $method

the method name to cache

int $lifetime

the cache lifetime in seconds

string $ID

custom cache ID to use

array $arguments

an optional array of arguments

Return Value

mixed

the cached data

clearCache($method, $ID = false, $arguments = array())

Clears the cache for the given cacheToFile call

Parameters

$method
$ID
$arguments

protected mixed loadCache(string $cache, int $lifetime = 3600)

Loads a cache from the filesystem if a valid on is present and within the specified lifetime

Parameters

string $cache

the cache name

int $lifetime

the lifetime (in seconds) of the cache before it is invalid

Return Value

mixed

protected saveCache(string $cache, mixed $data)

Save a piece of cached data to the file system

Parameters

string $cache

the cache name

mixed $data

data to save (must be serializable)

protected string sanitiseCachename(string $name)

Strip a file name of special characters so it is suitable for use as a cache file name

Parameters

string $name

Return Value

string

the name with all special cahracters replaced with underscores

static string castingObjectCreator(string $fieldSchema)

Converts a field spec into an object creator. For example: "Int" becomes "new Int($fieldName);" and "Varchar(50)" becomes "new Varchar($fieldName, 50);".

Parameters

string $fieldSchema

The field spec

Return Value

string

static array castingObjectCreatorPair(string $fieldSchema)

Convert a field schema (e.g. "Varchar(50)") into a casting object creator array that contains both a className and castingHelper constructor code. See castingObjectCreator for more information about the constructor.

Parameters

string $fieldSchema

Return Value

array

bool __isset(string $property)

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

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

setField(string $field, mixed $value)

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

Parameters

string $field
mixed $value

unknown deprecatedCachedCall($method, $args = null, string $identifier = null)

Method to facilitate deprecation of underscore-prefixed methods automatically being cached.

Parameters

$method
$args
string $identifier

an optional custom cache identifier

Return Value

unknown

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

ViewableData getCustomisedObj()

No description

Return Value

ViewableData

setCustomisedObj(ViewableData $object)

No description

Parameters

ViewableData $object

array castingHelperPair(string $field)

Get the class a field on this object would be casted to, as well as the casting helper for casting a field to an object (see ViewableData::castingHelper() for information on casting helpers).

The returned array contains two keys:

  • className: the class the field would be casted to (e.g. "Varchar")
  • castingHelper: the casting helper for casting the field (e.g. "return new Varchar($fieldName)")

Parameters

string $field

Return Value

array

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.

Parameters

string $field

Return Value

string

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'

buildCastingCache(reference $cache)

Save the casting cache for this object (including data from any failovers) into a variable

Parameters

reference $cache

HTMLText 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

HTMLText

protected 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

protected mixed objCacheGet(string $key)

Get a cached value from the field cache

Parameters

string $key

Cache key

Return Value

mixed

protected objCacheSet(string $key, mixed $value)

Store a value in the field cache

Parameters

string $key

Cache key

mixed $value

obj(string $fieldName, array $arguments = null, bool $forceReturnedObject = true, 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 $forceReturnedObject

if TRUE, the value will ALWAYS be casted to an object before being returned, even if there is no explicit casting information

bool $cache

Cache this object

string $cacheName

a custom cache name

cachedCall(string $field, array $arguments = null, 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

bool hasValue(string $field, array $arguments = null, 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

XML_val($field, $arguments = null, $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

$field
$arguments
$cache

RAW_val($field, $arguments = null, $cache = true)

Return the value of the field without any escaping being applied.

Parameters

$field
$arguments
$cache

SQL_val($field, $arguments = null, $cache = true)

Return the value of a field in an SQL-safe format.

Parameters

$field
$arguments
$cache

JS_val($field, $arguments = null, $cache = true)

Return the value of a field in a JavaScript-save format.

Parameters

$field
$arguments
$cache

ATT_val($field, $arguments = null, $cache = true)

Return the value of a field escaped suitable to be inserted into an XML node attribute.

Parameters

$field
$arguments
$cache

array getXMLValues($fields)

Get an array of XML-escaped values by field name

Parameters

$fields

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

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(string $subtheme = false)

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.

Parameters

string $subtheme

the subtheme path to get

Return Value

string

string CSSClasses(string $stopAtClass = 'ViewableData')

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

Exceptions

Exception

array getDirtyIDs($class, $id, $statefulids, $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

$class
$id
$statefulids
$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

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

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

array getFiltersComponent(SearchQuery $searchQuery)

Get all filter conditions for this search

Parameters

SearchQuery $searchQuery

Return Value

array

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