class ArrayList extends ViewableData implements SS_List, Filterable, Sortable, Limitable (View source)

A list object that wraps around an array of objects or arrays.

Note that (like DataLists), the implementations of the methods from SS_Filterable, SS_Sortable and SS_Limitable return a new instance of ArrayList, rather than modifying the existing instance.

For easy reference, methods that operate in this way are:

  • limit
  • reverse
  • sort
  • filter
  • exclude

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

Properties

static private array $extensions An array of extension names and parameters to be applied to this object upon construction. from  Extensible
static private array $casting An array of objects to cast certain fields to. This is set up as an array in the format: from  ViewableData
static private string $default_cast The default object to cast scalar fields to if casting information is not specified, and casting to an object is required. from  ViewableData

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, bool $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.

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(array $items = [])

No description

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.

ViewableData|null
getFailover()

Get the current failover object if set

bool
hasField(string $field)

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

mixed
getField(string $field)

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

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

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

defineMethods()

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

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.

bool
exists()

Returns true if this list has items

string
__toString()

No description

ViewableData
getCustomisedObj()

No description

setCustomisedObj(ViewableData $object)

No description

string
castingHelper(string $field)

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

string
castingClass(string $field)

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

string
escapeTypeForField(string $field)

Return the string-format type for the given field.

DBHTMLText
renderWith(string|array|SSViewer $template, array $customFields = null)

Render this object into the template, and get the result as a string. You can pass one of the following as the $template parameter: - a template name (e.g. Page) - an array of possible template names - the first valid one will be used - an SSViewer instance

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

array
getViewerTemplates(string $suffix = '')

Find appropriate templates for SSViewer to use to render this object

ViewableData
Me()

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

string
ThemeDir() deprecated

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.

ViewableData_Debugger
Debug()

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

string
dataClass()

Return the class of items in this list, by looking at the first item inside it.

$this
setDataClass(string $class)

Hint this list to a specific type

int
count()

Return the number of items in this list

array
toArray()

Return an array of the actual items that this ArrayList contains.

$this
each(callable $callback)

Walks the list using the specified callback

debug()

No description

array
toNestedArray()

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

limit(int $length, int $offset = 0)

Get a sub-range of this dataobjectset as an array

add(mixed $item)

Add this $item into this list

remove(mixed $item)

Remove this item from this list

void
replace(array|object $item, array|object $with)

Replaces an item in this list with another item.

merge(array|object $with)

Merges with another array or list by pushing all the items in it onto the end of this list.

$this
removeDuplicates(string $field = 'ID')

Removes items from this list which have a duplicate value for a certain field. This is especially useful when combining lists.

push(array|object $item)

Pushes an item onto the end of this list.

array|object
pop()

Pops the last element off the end of the list and returns it.

unshift(array|object $item)

Add an item onto the beginning of the list.

array|object
shift()

Shifts the item off the beginning of the list and returns it.

mixed
first()

Returns the first item in the list

mixed
last()

Returns the last item in the list

Map
map(string $keyfield = 'ID', string $titlefield = 'Title')

Returns a map of this list

mixed
find(string $key, mixed $value)

Find the first item of this list where the given key = value

array
column(string $colName = 'ID')

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

array
columnUnique(string $colName = 'ID')

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

bool
canSortBy(string $by)

You can always sort a ArrayList

Sortable
reverse()

Reverses an {@link ArrayList}

sort()

Sorts this list by one or more fields. You can either pass in a single field name and direction, or a map of field names to sort directions.

$this
shuffle()

Shuffle the items in this array list

bool
canFilterBy(string $by)

Returns true if the given column can be used to filter the records.

Filterable
filter()

Filter the list to include items with these characteristics

filterAny()

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

SS_List
byIDs(array $ids)

Filter this list to only contain the given Primary IDs

mixed
byID(int $id)

Return the first item with the given ID

Filterable
filterByCallback(callable $callback)

No description

Filterable
exclude()

Exclude the list to not contain items with these characteristics

bool
offsetExists(mixed $offset)

Returns whether an item with $key exists

DataObject
offsetGet(mixed $offset)

Returns item stored in list with index $key

offsetSet(mixed $offset, mixed $value)

Set an item with the key in $key

offsetUnset(mixed $offset)

Unset an item with the key in $key

Details

mixed __call(string $method, array $arguments)

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

You can add extra methods to a class using {@link Extensions}, {@link Object::createMethod()} or {@link Object::addWrapperMethod()}

Parameters

string $method
array $arguments

Return Value

mixed

Exceptions

BadMethodCallException

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

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

See also

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

static remove_extension(string $extension)

Remove an extension from a class.

Note: This will not remove extensions from parent classes, and must be called directly on the class assigned the extension.

Keep in mind that this won't revert any datamodel additions of the extension at runtime, unless its used before the schema building kicks in (in your _config.php). Doesn't remove the extension from any {@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

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

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

Get extra config sources for this class

Parameters

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

Return Value

array|null

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

Return TRUE if a class has a specified extension.

This supports backwards-compatible format (static Object::has_extension($requiredExtension)) and new format ($object->has_extension($class, $requiredExtension))

Parameters

string $classOrExtension Class to check extension for, or the extension name to check if the second argument is null.
string $requiredExtension If the first argument is the parent class, this is the extension to check. If left null, the first parameter will be treated as the extension.
bool $strict if the extension has to match the required extension and not be a subclass

Return Value

bool

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

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

Extension|null getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

Parameters

string $extension

Return Value

Extension|null

bool hasExtension(string $extension)

Returns TRUE if this object instance has a specific extension applied in {@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

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

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

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

static Config_ForClass config()

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

....).

Return Value

Config_ForClass

mixed stat(string $name) deprecated

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

Get inherited config value

Parameters

string $name

Return Value

mixed

mixed uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

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

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

Update the config value for a given property

Parameters

string $name
mixed $value

Return Value

$this

__construct(array $items = [])

Parameters

array $items
  • an initial array to fill this object with

bool __isset(string $property)

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

Note that, unlike the core isset() implementation, this will return true if the property is defined and set to null.

Parameters

string $property

Return Value

bool

mixed __get(string $property)

Get the value of a property/field on this object. This will check if a method called get{$property} exists, then check if a field is available using {@link 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 {@link ViewableData::setField()} method.

Parameters

string $property
mixed $value

setFailover(ViewableData $failover)

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

Parameters

ViewableData $failover

ViewableData|null getFailover()

Get the current failover object if set

Return Value

ViewableData|null

bool hasField(string $field)

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

Parameters

string $field

Return Value

bool

mixed getField(string $field)

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

Parameters

string $field

Return Value

mixed

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

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

Parameters

string $field
mixed $value

Return Value

$this

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

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

bool exists()

Returns true if this list has items

Return Value

bool

string __toString()

Return Value

string

ViewableData getCustomisedObj()

Return Value

ViewableData

setCustomisedObj(ViewableData $object)

Parameters

ViewableData $object

string castingHelper(string $field)

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

Parameters

string $field

Return Value

string

Exceptions

Exception

string castingClass(string $field)

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

Parameters

string $field

Return Value

string

string escapeTypeForField(string $field)

Return the string-format type for the given field.

Parameters

string $field

Return Value

string

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

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

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

Parameters

string $fieldName
array $arguments
bool $cache Cache this object
string $cacheName a custom cache name

Return Value

object|DBField

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

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

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

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

Parameters

string $field
array $arguments
bool $cache

Return Value

bool

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

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

Parameters

string $field
array $arguments
bool $cache

Return Value

string

array getXMLValues(array $fields)

Get an array of XML-escaped values by field name

Parameters

array $fields an array of field names

Return Value

array

ArrayIterator getIterator()

Returns an Iterator for this ArrayList.

This function allows you to use ArrayList in foreach loops

Return Value

ArrayIterator

array getViewerTemplates(string $suffix = '')

Find appropriate templates for SSViewer to use to render this object

Parameters

string $suffix

Return Value

array

ViewableData Me()

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

Return Value

ViewableData

string ThemeDir() deprecated

deprecated 4.0.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

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

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

This method returns an escaped string of CSS classes representing the current classes ancestry until it hits a stop point - e.g. "Page DataObject ViewableData".

Parameters

string $stopAtClass the class to stop at (default: ViewableData)

Return Value

string

ViewableData_Debugger Debug()

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

Return Value

ViewableData_Debugger

string dataClass()

Return the class of items in this list, by looking at the first item inside it.

Return Value

string

$this setDataClass(string $class)

Hint this list to a specific type

Parameters

string $class

Return Value

$this

int count()

Return the number of items in this list

Return Value

int

array toArray()

Return an array of the actual items that this ArrayList contains.

Return Value

array

$this each(callable $callback)

Walks the list using the specified callback

Parameters

callable $callback

Return Value

$this

debug()

array toNestedArray()

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

Return Value

array

Limitable limit(int $length, int $offset = 0)

Get a sub-range of this dataobjectset as an array

Parameters

int $length
int $offset

Return Value

Limitable

add(mixed $item)

Add this $item into this list

Parameters

mixed $item

remove(mixed $item)

Remove this item from this list

Parameters

mixed $item

void replace(array|object $item, array|object $with)

Replaces an item in this list with another item.

Parameters

array|object $item
array|object $with

Return Value

void

merge(array|object $with)

Merges with another array or list by pushing all the items in it onto the end of this list.

Parameters

array|object $with

$this removeDuplicates(string $field = 'ID')

Removes items from this list which have a duplicate value for a certain field. This is especially useful when combining lists.

Parameters

string $field

Return Value

$this

push(array|object $item)

Pushes an item onto the end of this list.

Parameters

array|object $item

array|object pop()

Pops the last element off the end of the list and returns it.

Return Value

array|object

unshift(array|object $item)

Add an item onto the beginning of the list.

Parameters

array|object $item

array|object shift()

Shifts the item off the beginning of the list and returns it.

Return Value

array|object

mixed first()

Returns the first item in the list

Return Value

mixed

mixed last()

Returns the last item in the list

Return Value

mixed

Map map(string $keyfield = 'ID', string $titlefield = 'Title')

Returns a map of this list

Parameters

string $keyfield
string $titlefield

Return Value

Map

mixed find(string $key, mixed $value)

Find the first item of this list where the given key = value

Parameters

string $key
mixed $value

Return Value

mixed

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

array columnUnique(string $colName = 'ID')

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

Parameters

string $colName

Return Value

array

bool canSortBy(string $by)

You can always sort a ArrayList

Parameters

string $by

Return Value

bool

Sortable reverse()

Reverses an {@link ArrayList}

Return Value

Sortable

Sortable sort()

Sorts this list by one or more fields. You can either pass in a single field name and direction, or a map of field names to sort directions.

Note that columns may be double quoted as per ANSI sql standard

Return Value

Sortable

See also

\SS_List::sort()

$this shuffle()

Shuffle the items in this array list

Return Value

$this

bool canFilterBy(string $by)

Returns true if the given column can be used to filter the records.

It works by checking the fields available in the first record of the list.

Parameters

string $by

Return Value

bool

Filterable filter()

Filter the list to include items with these characteristics

Return Value

Filterable

See also

\Filterable::filter()

Filterable filterAny()

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

Return Value

Filterable

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

mixed byID(int $id)

Return the first item with the given ID

Parameters

int $id

Return Value

mixed

Filterable filterByCallback(callable $callback)

Parameters

callable $callback

Return Value

Filterable

See also

\Filterable::filterByCallback()

Filterable exclude()

Exclude the list to not contain items with these characteristics

Return Value

Filterable

See also

\SS_List::exclude()

bool offsetExists(mixed $offset)

Returns whether an item with $key exists

Parameters

mixed $offset

Return Value

bool

DataObject offsetGet(mixed $offset)

Returns item stored in list with index $key

Parameters

mixed $offset

Return Value

DataObject

offsetSet(mixed $offset, mixed $value)

Set an item with the key in $key

Parameters

mixed $offset
mixed $value

offsetUnset(mixed $offset)

Unset an item with the key in $key

Parameters

mixed $offset