class PolymorphicHasManyList extends HasManyList

Represents a has_many list linked against a polymorphic relationship

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

Methods

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

bool
hasMethod(string $method)

Return TRUE if a method exists on this object

array
allMethodNames(bool $custom = false)

Return the names of all the methods available on this object

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

Add an extension to a specific class.

static 
remove_extension(string $extension)

Remove an extension from a class.

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

No description

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

Get extra config sources for this class

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

Return TRUE if a class has a specified extension.

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 {@link Extensions}, and then attempts to merge all results into an array

array
extend(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = null)

Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed

Extension|null
getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

bool
hasExtension(string $extension)

Returns TRUE if this object instance has a specific extension applied in {@link $extension_instances}. Extension instances are initialized at constructor time, meaning if you use {@link add_extension()} afterwards, the added extension will just be added to new instances of the extended class. Use the static method {@link has_extension()} to check if a class (not an instance) has a specific extension.

getExtensionInstances()

Get all extension instances for this specific object instance.

static Injectable
create(array $args)

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

static Injectable
singleton(string $class = null)

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

static Config_ForClass
config()

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

mixed
stat(string $name) deprecated

Get inherited config value

mixed
uninherited(string $name)

Gets the uninherited value for the given config option

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

Update the config value for a given property

__construct(string $dataClass, string $foreignField, string $foreignClass)

Create a new PolymorphicHasManyList relation list.

bool
__isset(string $property)

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

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 {@link ViewableData::getField()}, then fall back on a failover object.

__set(string $property, mixed $value)

Set a property/field on this object. This will check for the existence of a method called set{$property}, then use the {@link ViewableData::setField()} method.

setFailover(ViewableData $failover)

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

getFailover()

Get the current failover object if set

bool
hasField(string $field)

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

mixed
getField(string $field)

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

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

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

defineMethods()

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

customise(array|ViewableData $data)

Merge some arbitrary data in with this object. This method returns a {@link ViewableData_Customised} instance with references to both this and the new custom data.

bool
exists()

Returns true if this DataList has items

from DataList
string
__toString()

No description

getCustomisedObj()

No description

setCustomisedObj(ViewableData $object)

No description

string
castingHelper(string $field)

Return the "casting helper" (a piece of PHP code that when evaluated creates a casted value object) for a field on this object. This helper will be a subclass of DBField.

string
castingClass(string $field)

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

string
escapeTypeForField(string $field)

Return the string-format type for the given field.

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

Object|DBField
obj(string $fieldName, array $arguments = [], bool $cache = false, string $cacheName = null)

Get the value of a field on this object, automatically inserting the value into any available casting objects that have been specified.

Object|DBField
cachedCall(string $field, array $arguments = [], string $identifier = null)

A simple wrapper around {@link ViewableData::obj()} that automatically caches the result so it can be used again without re-running the method.

bool
hasValue(string $field, array $arguments = [], bool $cache = true)

Checks if a given method/field has a valid value. If the result is an object, this will return the result of the exists method, otherwise will check if the result is not just an empty paragraph tag.

string
XML_val(string $field, array $arguments = [], bool $cache = false)

Get the string value of a field on this object that has been suitable escaped to be inserted directly into a template.

array
getXMLValues(array $fields)

Get an array of XML-escaped values by field name

getIterator()

Returns an Iterator for this DataList.

from DataList
array
getViewerTemplates(string $suffix = '')

Find appropriate templates for SSViewer to use to render this object

Me()

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

string
ThemeDir() deprecated

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

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

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

Debug()

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

string
dataClass()

Get the dataClass name for this DataList, ie the DataObject ClassName

from DataList
__clone()

When cloning this object, clone the dataQuery object as well

from DataList
dataQuery()

Return a copy of the internal {@link DataQuery} object

from DataList
alterDataQuery(callable $callback)

Return a new DataList instance with the underlying {@link DataQuery} object altered

from DataList
setDataQuery(DataQuery $dataQuery)

Return a new DataList instance with the underlying {@link DataQuery} object changed

from DataList
setDataQueryParam(string|array $keyOrArray, mixed $val = null)

Returns a new DataList instance with the specified query parameter assigned

from DataList
string
sql(array $parameters = [])

Returns the SQL query that will be used to get this DataList's records. Good for debugging. :-)

from DataList
where(string|array|SQLConditionGroup $filter)

Return a new DataList instance with a WHERE clause added to this list's query.

from DataList
whereAny(string|array|SQLConditionGroup $filter)

Return a new DataList instance with a WHERE clause added to this list's query.

from DataList
bool
canSortBy(string $fieldName)

Returns true if this DataList can be sorted by the given field.

from DataList
bool
canFilterBy(string $fieldName)

Returns true if this DataList can be filtered by the given field.

from DataList
limit(int $limit, int $offset)

Return a new DataList instance with the records returned in this query restricted by a limit clause.

from DataList
distinct(bool $value)

Return a new DataList instance with distinct records or not

from DataList
sort()

Return a new DataList instance as a copy of this data list with the sort order set.

from DataList
filter()

Return a copy of this list which only includes items with these charactaristics

from DataList
$this
addFilter(array $filterArray)

Return a new instance of the list with an added filter

from DataList
filterAny()

Return a copy of this list which contains items matching any of these charactaristics.

from DataList
filterByCallback(callable $callback)

Note that, in the current implementation, the filtered list will be an ArrayList, but this may change in a future implementation.

from DataList
$this
applyRelation(string $field, string $columnName = null, bool $linearOnly = false)

Given a field or relation name, apply it safely to this datalist.

from DataList
exclude()

Return a copy of this list which does not contain any items that match all params

from DataList
$this
excludeAny()

Return a copy of this list which does not contain any items with any of these params

from DataList
subtract(DataList $list)

This method returns a copy of this list that does not contain any DataObjects that exists in $list

from DataList
innerJoin(string $table, string $onClause, string $alias = null, int $order = 20, array $parameters = [])

Return a new DataList instance with an inner join clause added to this list's query.

from DataList
leftJoin(string $table, string $onClause, string $alias = null, int $order = 20, array $parameters = [])

Return a new DataList instance with a left join clause added to this list's query.

from DataList
array
toArray()

Return an array of the actual items that this DataList contains at this stage.

from DataList
array
toNestedArray()

Return this list as an array and every object it as an sub array as well

from DataList
$this
each(callable $callback)

Walks the list using the specified callback

from DataList
Generator&DataObject[]
getGenerator()

Returns a generator for this DataList

from DataList
debug()

No description

from DataList
Map
map(string $keyField = 'ID', string $titleField = 'Title')

Returns a map of this list

from DataList
createDataObject(array $row)

Create a DataObject from the given SQL row

from DataList
array
getQueryParams()

Get query parameters for this list.

int
count()

Return the number of items in this DataList

from DataList
mixed
max(string $fieldName)

Return the maximum value of the given field in this DataList

from DataList
mixed
min(string $fieldName)

Return the minimum value of the given field in this DataList

from DataList
mixed
avg(string $fieldName)

Return the average value of the given field in this DataList

from DataList
mixed
sum(string $fieldName)

Return the sum of the values of the given field in this DataList

from DataList
mixed
first()

Returns the first item in this DataList

from DataList
mixed
last()

Returns the last item in this DataList

from DataList
mixed
find(string $key, mixed $value)

Find the first DataObject of this DataList where the given key = value

from DataList
setQueriedColumns(array $queriedColumns)

Restrict the columns to fetch into this DataList

from DataList
byIDs(array $ids)

Filter this list to only contain the given Primary IDs

from DataList
mixed
byID(int $id)

Return the first DataObject with the given ID

from DataList
array
column(string $colName = "ID")

Returns an array of a single field value for all items in the list.

from DataList
array
columnUnique(string $colName = "ID")

Returns a unque array of a single field value for all items in the list.

from DataList
setByIDList(array $idList)

Sets the ComponentSet to be the given ID list.

from DataList
array
getIDList()

Returns an array with both the keys and values set to the IDs of the records in this list.

from DataList
relation(string $relationName)

Returns a HasManyList or ManyMany list representing the querying of a relation across all objects in this data list. For it to work, the relation must be defined on the data class that you used to create this DataList.

from DataList
dbObject($fieldName)

No description

from DataList
$this
addMany(array $items)

Add a number of items to the component set.

from DataList
$this
removeMany(array $idList)

Remove the items from this list with the given IDs

from DataList
$this
removeByFilter(string|array $filter)

Remove every element in this DataList matching the given $filter.

from DataList
$this
shuffle()

Shuffle the datalist using a random function provided by the SQL engine

from DataList
$this
removeAll()

Remove every element in this DataList.

from DataList
add(mixed $item)

Adds the item to this relation.

newObject(array $initialFields = null)

Return a new item to add to this DataList.

from DataList
remove(mixed $item)

Remove an item from this relation.

removeByID(int $itemID)

Remove an item from this relation.

reverse()

Reverses a list of items.

from DataList
bool
offsetExists(mixed $key)

Returns whether an item with $key exists

from DataList
offsetGet(mixed $key)

Returns item stored in list with index $key

from DataList
offsetSet(mixed $key, mixed $value)

Set an item with the key in $key

from DataList
offsetUnset(mixed $key)

Unset an item with the key in $key

from DataList
string|array|null
getForeignID()

Any number of foreign keys to apply to this list

Relation
forForeignID($id)

Returns a copy of this list with the ManyMany relationship linked to the given foreign ID.

string
getForeignKey()

Gets the field name which holds the related object ID.

string
getForeignClass()

Retrieve the name of the class this relation is filtered by

Details

in CustomMethods at line 47
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 {@link Extensions}, {@link Object::createMethod()} or {@link Object::addWrapperMethod()}

Parameters

string $method
array $arguments

Return Value

mixed

Exceptions

BadMethodCallException

in CustomMethods at line 146
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

in CustomMethods at line 176
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

in Extensible at line 172
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 {@link Object::$extensions} array. See {@link 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 {@link singleton()}).

Parameters

string $classOrExtension Class that should be extended - has to be a subclass of {@link Object}
string $extension Subclass of {@link 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

in Extensible at line 236
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 {@link Object} instances which are already created, but will have an effect on new extensions. Clears any previously created singletons through {@link singleton()} to avoid side-effects from stale extension information.

Parameters

string $extension class name of an {@link Extension} subclass, without parameters

in Extensible at line 278
static array get_extensions(string $class = null, bool $includeArgumentString = false)

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 {@link DataExtension} class names, or eval'ed class name strings with constructor arguments.

in Extensible at line 312
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

in Extensible at line 373
static bool has_extension(string $classOrExtension, string $requiredExtension = null, boolean $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.
boolean $strict if the extension has to match the required extension and not be a subclass

Return Value

bool Flag if the extension exists

in Extensible at line 415
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 {@link 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

in Extensible at line 450
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 {@link __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

in Extensible at line 497
Extension|null getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

Parameters

string $extension

Return Value

Extension|null

in Extensible at line 526
bool hasExtension(string $extension)

Returns TRUE if this object instance has a specific extension applied in {@link $extension_instances}. Extension instances are initialized at constructor time, meaning if you use {@link add_extension()} afterwards, the added extension will just be added to new instances of the extended class. Use the static method {@link 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 {@link Extension} subclass without parameters

Return Value

bool

in Extensible at line 540
Extension[] getExtensionInstances()

Get all extension instances for this specific object instance.

See {@link 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 {@link DataExtension} instances, keyed by classname.

in Injectable at line 26
static Injectable create(array $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'); $list = SiteTree::get();

Parameters

array $args

Return Value

Injectable

in Injectable at line 43
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

in Configurable at line 20
static Config_ForClass config()

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

....).

Return Value

Config_ForClass

in Configurable at line 32
mixed stat(string $name) deprecated

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

Get inherited config value

Parameters

string $name

Return Value

mixed

in Configurable at line 44
mixed uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

in Configurable at line 57
$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

at line 40
__construct(string $dataClass, string $foreignField, string $foreignClass)

Create a new PolymorphicHasManyList relation list.

Parameters

string $dataClass
  • The DataObject class to query.
string $foreignField The name of the composite foreign relation field. Used to generate the ID and Class foreign keys.
string $foreignClass Name of the class filter this relation is filtered against

in ViewableData at line 106
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

in ViewableData at line 129
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 {@link ViewableData::getField()}, then fall back on a failover object.

Parameters

string $property

Return Value

mixed

in ViewableData at line 152
__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 {@link ViewableData::setField()} method.

Parameters

string $property
mixed $value

in ViewableData at line 167
setFailover(ViewableData $failover)

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

Parameters

ViewableData $failover

in ViewableData at line 183
ViewableData|null getFailover()

Get the current failover object if set

Return Value

ViewableData|null

in ViewableData at line 194
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

in ViewableData at line 205
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

in ViewableData at line 217
$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

in ViewableData at line 232
defineMethods()

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

Exceptions

LogicException

in ViewableData at line 258
ViewableData_Customised customise(array|ViewableData $data)

Merge some arbitrary data in with this object. This method returns a {@link 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

in DataList at line 947
bool exists()

Returns true if this DataList has items

Return Value

bool

in ViewableData at line 289
string __toString()

Return Value

string the class name

in ViewableData at line 297
ViewableData getCustomisedObj()

Return Value

ViewableData

in ViewableData at line 305
setCustomisedObj(ViewableData $object)

Parameters

ViewableData $object

in ViewableData at line 320
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

in ViewableData at line 352
string castingClass(string $field)

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

Parameters

string $field

Return Value

string

in ViewableData at line 365
string escapeTypeForField(string $field)

Return the string-format type for the given field.

Parameters

string $field

Return Value

string 'xml'|'raw'

in ViewableData at line 389
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

in ViewableData at line 471
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

in ViewableData at line 516
Object|DBField cachedCall(string $field, array $arguments = [], string $identifier = null)

A simple wrapper around {@link 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

in ViewableData at line 530
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

in ViewableData at line 545
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

in ViewableData at line 558
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

in DataList at line 856
ArrayIterator getIterator()

Returns an Iterator for this DataList.

This function allows you to use DataLists in foreach loops

Return Value

ArrayIterator

in ViewableData at line 592
array getViewerTemplates(string $suffix = '')

Find appropriate templates for SSViewer to use to render this object

Parameters

string $suffix

Return Value

array

in ViewableData at line 603
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

in ViewableData at line 620
string ThemeDir() deprecated

deprecated 4.0.0:5.0.0 Use $resourcePath or $resourceURL template helpers 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

in ViewableData at line 647
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

in ViewableData at line 676
ViewableData_Debugger Debug()

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

Return Value

ViewableData_Debugger

in DataList at line 71
string dataClass()

Get the dataClass name for this DataList, ie the DataObject ClassName

Return Value

string

in DataList at line 79
__clone()

When cloning this object, clone the dataQuery object as well

in DataList at line 92
DataQuery dataQuery()

Return a copy of the internal {@link DataQuery} object

Because the returned value is a copy, modifying it won't affect this list's contents. If you want to alter the data query directly, use the alterDataQuery method

Return Value

DataQuery

in DataList at line 118
DataList alterDataQuery(callable $callback)

Return a new DataList instance with the underlying {@link DataQuery} object altered

If you want to alter the underlying dataQuery for this list, this wrapper method will ensure that you can do so without mutating the existing List object.

It clones this list, calls the passed callback function with the dataQuery of the new list as it's first parameter (and the list as it's second), then returns the list

Note that this function is re-entrant - it's safe to call this inside a callback passed to alterDataQuery

Parameters

callable $callback

Return Value

DataList

Exceptions

Exception

in DataList at line 154
DataList setDataQuery(DataQuery $dataQuery)

Return a new DataList instance with the underlying {@link DataQuery} object changed

Parameters

DataQuery $dataQuery

Return Value

DataList

in DataList at line 168
DataList setDataQueryParam(string|array $keyOrArray, mixed $val = null)

Returns a new DataList instance with the specified query parameter assigned

Parameters

string|array $keyOrArray Either the single key to set, or an array of key value pairs to set
mixed $val If $keyOrArray is not an array, this is the value to set

Return Value

DataList

in DataList at line 189
string sql(array $parameters = [])

Returns the SQL query that will be used to get this DataList's records. Good for debugging. :-)

Parameters

array $parameters Out variable for parameters required for this query

Return Value

string The resulting SQL query (may be paramaterised)

in DataList at line 205
DataList where(string|array|SQLConditionGroup $filter)

Return a new DataList instance with a WHERE clause added to this list's query.

Supports parameterised queries. See SQLSelect::addWhere() for syntax examples, although DataList won't expand multiple method arguments as SQLSelect does.

Parameters

string|array|SQLConditionGroup $filter Predicate(s) to set, as escaped SQL statements or paramaterised queries

Return Value

DataList

in DataList at line 224
DataList whereAny(string|array|SQLConditionGroup $filter)

Return a new DataList instance with a WHERE clause added to this list's query.

All conditions provided in the filter will be joined with an OR

Supports parameterised queries. See SQLSelect::addWhere() for syntax examples, although DataList won't expand multiple method arguments as SQLSelect does.

Parameters

string|array|SQLConditionGroup $filter Predicate(s) to set, as escaped SQL statements or paramaterised queries

Return Value

DataList

in DataList at line 239
bool canSortBy(string $fieldName)

Returns true if this DataList can be sorted by the given field.

Parameters

string $fieldName

Return Value

bool

in DataList at line 250
bool canFilterBy(string $fieldName)

Returns true if this DataList can be filtered by the given field.

Parameters

string $fieldName (May be a related field in dot notation like Member.FirstName)

Return Value

bool

in DataList at line 281
Limitable limit(int $limit, int $offset)

Return a new DataList instance with the records returned in this query restricted by a limit clause.

Parameters

int $limit
int $offset

Return Value

Limitable

in DataList at line 294
DataList distinct(bool $value)

Return a new DataList instance with distinct records or not

Parameters

bool $value

Return Value

DataList

in DataList at line 315
Sortable sort()

Return a new DataList instance as a copy of this data list with the sort order set.

Return Value

Sortable

See also

SS_List::sort()
SQLSelect::orderby

in DataList at line 386
Filterable filter()

Return a copy of this list which only includes items with these charactaristics

Return Value

Filterable

See also

SS_List::filter()

in DataList at line 412
$this addFilter(array $filterArray)

Return a new instance of the list with an added filter

Parameters

array $filterArray

Return Value

$this

in DataList at line 448
Filterable filterAny()

Return a copy of this list which contains items matching any of these charactaristics.

Return Value

Filterable

in DataList at line 480
Filterable filterByCallback(callable $callback)

Note that, in the current implementation, the filtered list will be an ArrayList, but this may change in a future implementation.

Parameters

callable $callback

Return Value

Filterable

See also

Filterable::filterByCallback()

in DataList at line 510
$this applyRelation(string $field, string $columnName = null, bool $linearOnly = false)

Given a field or relation name, apply it safely to this datalist.

Unlike getRelationName, this is immutable and will fallback to the quoted field name if not a relation.

Parameters

string $field Name of field or relation to apply
string $columnName &$columnName Quoted column name
bool $linearOnly Set to true to restrict to linear relations only. Set this if this relation will be used for sorting, and should not include duplicate rows.

Return Value

$this DataList with this relation applied

in DataList at line 606
Filterable exclude()

Return a copy of this list which does not contain any items that match all params

Return Value

Filterable

in DataList at line 644
$this excludeAny()

Return a copy of this list which does not contain any items with any of these params

Return Value

$this

in DataList at line 675
DataList subtract(DataList $list)

This method returns a copy of this list that does not contain any DataObjects that exists in $list

The $list passed needs to contain the same dataclass as $this

Parameters

DataList $list

Return Value

DataList

Exceptions

InvalidArgumentException

in DataList at line 698
DataList innerJoin(string $table, string $onClause, string $alias = null, int $order = 20, array $parameters = [])

Return a new DataList instance with an inner join clause added to this list's query.

Parameters

string $table Table name (unquoted and as escaped SQL)
string $onClause Escaped SQL statement, e.g. '"Table1"."ID" = "Table2"."ID"'
string $alias
  • if you want this table to be aliased under another name
int $order A numerical index to control the order that joins are added to the query; lower order values will cause the query to appear first. The default is 20, and joins created automatically by the ORM have a value of 10.
array $parameters Any additional parameters if the join is a parameterised subquery

Return Value

DataList

in DataList at line 717
DataList leftJoin(string $table, string $onClause, string $alias = null, int $order = 20, array $parameters = [])

Return a new DataList instance with a left join clause added to this list's query.

Parameters

string $table Table name (unquoted and as escaped SQL)
string $onClause Escaped SQL statement, e.g. '"Table1"."ID" = "Table2"."ID"'
string $alias
  • if you want this table to be aliased under another name
int $order A numerical index to control the order that joins are added to the query; lower order values will cause the query to appear first. The default is 20, and joins created automatically by the ORM have a value of 10.
array $parameters Any additional parameters if the join is a parameterised subquery

Return Value

DataList

in DataList at line 730
array toArray()

Return an array of the actual items that this DataList contains at this stage.

This is when the query is actually executed.

Return Value

array

in DataList at line 748
array toNestedArray()

Return this list as an array and every object it as an sub array as well

Return Value

array

in DataList at line 765
$this each(callable $callback)

Walks the list using the specified callback

Parameters

callable $callback

Return Value

$this

in DataList at line 779
Generator&DataObject[] getGenerator()

Returns a generator for this DataList

Return Value

Generator&DataObject[]

in DataList at line 788
debug()

in DataList at line 805
Map map(string $keyField = 'ID', string $titleField = 'Title')

Returns a map of this list

Parameters

string $keyField
  • the 'key' field of the result array
string $titleField
  • the value field of the result array

Return Value

Map

in DataList at line 816
DataObject createDataObject(array $row)

Create a DataObject from the given SQL row

Parameters

array $row

Return Value

DataObject

in RelationList at line 25
array getQueryParams()

Get query parameters for this list.

These values will be assigned as query parameters to newly created objects from this list.

Return Value

array

in DataList at line 866
int count()

Return the number of items in this DataList

Return Value

int

in DataList at line 877
mixed max(string $fieldName)

Return the maximum value of the given field in this DataList

Parameters

string $fieldName

Return Value

mixed

in DataList at line 888
mixed min(string $fieldName)

Return the minimum value of the given field in this DataList

Parameters

string $fieldName

Return Value

mixed

in DataList at line 899
mixed avg(string $fieldName)

Return the average value of the given field in this DataList

Parameters

string $fieldName

Return Value

mixed

in DataList at line 910
mixed sum(string $fieldName)

Return the sum of the values of the given field in this DataList

Parameters

string $fieldName

Return Value

mixed

in DataList at line 921
mixed first()

Returns the first item in this DataList

Return Value

mixed

in DataList at line 934
mixed last()

Returns the last item in this DataList

@return DataObject

Return Value

mixed

in DataList at line 959
mixed find(string $key, mixed $value)

Find the first DataObject of this DataList where the given key = value

Parameters

string $key
mixed $value

Return Value

mixed

in DataList at line 970
DataList setQueriedColumns(array $queriedColumns)

Restrict the columns to fetch into this DataList

Parameters

array $queriedColumns

Return Value

DataList

in DataList at line 983
SS_List byIDs(array $ids)

Filter this list to only contain the given Primary IDs

Parameters

array $ids Array of integers

Return Value

SS_List

in DataList at line 994
mixed byID(int $id)

Return the first DataObject with the given ID

Parameters

int $id

Return Value

mixed

in DataList at line 1005
array column(string $colName = "ID")

Returns an array of a single field value for all items in the list.

Parameters

string $colName

Return Value

array

in DataList at line 1016
array columnUnique(string $colName = "ID")

Returns a unque array of a single field value for all items in the list.

Parameters

string $colName

Return Value

array

in DataList at line 1029
setByIDList(array $idList)

Sets the ComponentSet to be the given ID list.

Records will be added and deleted as appropriate.

Parameters

array $idList List of IDs.

in DataList at line 1062
array getIDList()

Returns an array with both the keys and values set to the IDs of the records in this list.

Does not respect sort order. Use ->column("ID") to get an ID list with the current sort.

Return Value

array

in DataList at line 1080
HasManyList|ManyManyList relation(string $relationName)

Returns a HasManyList or ManyMany list representing the querying of a relation across all objects in this data list. For it to work, the relation must be defined on the data class that you used to create this DataList.

Example: Get members from all Groups:

DataList::Create(\SilverStripe\Security\Group::class)->relation("Members")

Parameters

string $relationName

Return Value

HasManyList|ManyManyList

in DataList at line 1089
dbObject($fieldName)

Parameters

$fieldName

in DataList at line 1100
$this addMany(array $items)

Add a number of items to the component set.

Parameters

array $items Items to add, as either DataObjects or IDs.

Return Value

$this

in DataList at line 1114
$this removeMany(array $idList)

Remove the items from this list with the given IDs

Parameters

array $idList

Return Value

$this

in DataList at line 1128
$this removeByFilter(string|array $filter)

Remove every element in this DataList matching the given $filter.

Parameters

string|array $filter
  • a sql type where filter

Return Value

$this

in DataList at line 1141
$this shuffle()

Shuffle the datalist using a random function provided by the SQL engine

Return Value

$this

in DataList at line 1151
$this removeAll()

Remove every element in this DataList.

Return Value

$this

at line 65
add(mixed $item)

Adds the item to this relation.

It does so by setting the relationFilters.

Parameters

mixed $item

in DataList at line 1178
DataObject newObject(array $initialFields = null)

Return a new item to add to this DataList.

Parameters

array $initialFields

Return Value

DataObject

at line 108
remove(mixed $item)

Remove an item from this relation.

Doesn't actually remove the item, it just clears the foreign key value.

Parameters

mixed $item

in HasManyList at line 105
removeByID(int $itemID)

Remove an item from this relation.

Doesn't actually remove the item, it just clears the foreign key value.

Parameters

int $itemID The primary ID

in DataList at line 1216
Sortable reverse()

Reverses a list of items.

Return Value

Sortable

in DataList at line 1229
bool offsetExists(mixed $key)

Returns whether an item with $key exists

Parameters

mixed $key

Return Value

bool

in DataList at line 1240
DataObject offsetGet(mixed $key)

Returns item stored in list with index $key

Parameters

mixed $key

Return Value

DataObject

in DataList at line 1251
offsetSet(mixed $key, mixed $value)

Set an item with the key in $key

Parameters

mixed $key
mixed $value

in DataList at line 1261
offsetUnset(mixed $key)

Unset an item with the key in $key

Parameters

mixed $key

in RelationList at line 20
string|array|null getForeignID()

Any number of foreign keys to apply to this list

Return Value

string|array|null

in RelationList at line 48
Relation forForeignID($id)

Returns a copy of this list with the ManyMany relationship linked to the given foreign ID.

Parameters

$id

Return Value

Relation

in HasManyList at line 39
string getForeignKey()

Gets the field name which holds the related object ID.

Return Value

string

at line 27
string getForeignClass()

Retrieve the name of the class this relation is filtered by

Return Value

string