ArrayList
class ArrayList extends ViewableData implements SS_List, Filterable, Sortable, Limitable
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
Methods
Attempts to locate and call a method dynamically added to a class at runtime if a default cannot be located
Return the names of all the methods available on this object
Add an extension to a specific class.
No description
Get extra config sources for this class
Return TRUE if a class has a specified extension.
Calls a method if available on both this object and all applied {@link Extensions}, and then attempts to merge all results into an array
Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed
Get an extension instance attached to this object by name.
Returns TRUE if this object instance has a specific extension applied in {@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.
Get all extension instances for this specific object instance.
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .
Gets the uninherited value for the given config option
No description
Check if a field exists on this object or its failover.
Get the value of a property/field on this object. This will check if a method called get{$property} exists, then check if a field is available using {@link ViewableData::getField()}, then fall back on a failover object.
Set a property/field on this object. This will check for the existence of a method called set{$property}, then use the {@link ViewableData::setField()} method.
Set a failover object to attempt to get data from if it is not present on this object.
Check if a field exists on this object. This should be overloaded in child classes.
Get the value of a field on this object. This should be overloaded in child classes.
Set a field on this object. This should be overloaded in child classes.
Add methods from the {@link ViewableData::$failover} object, as well as wrapping any methods prefixed with an underscore into a {@link ViewableData::cachedCall()}.
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.
Returns true if this list has items
Return the "casting helper" (a piece of PHP code that when evaluated creates a casted value object) for a field on this object. This helper will be a subclass of DBField.
Get the class name a field on this object will be casted to.
Return the string-format type for the given field.
Render this object into the template, and get the result as a string. You can pass one of the following as the $template parameter: - a template name (e.g. Page) - an array of possible template names - the first valid one will be used - an SSViewer instance
Get the value of a field on this object, automatically inserting the value into any available casting objects that have been specified.
A simple wrapper around {@link ViewableData::obj()} that automatically caches the result so it can be used again without re-running the method.
Checks if a given method/field has a valid value. If the result is an object, this will return the result of the exists method, otherwise will check if the result is not just an empty paragraph tag.
Get the string value of a field on this object that has been suitable escaped to be inserted directly into a template.
Get an array of XML-escaped values by field name
Returns an Iterator for this ArrayList.
Find appropriate templates for SSViewer to use to render this object
When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.
Get part of the current classes ancestry to be used as a CSS class.
Return debug information about this object that can be rendered into a template
Return the class of items in this list, by looking at the first item inside it.
Hint this list to a specific type
Return the number of items in this list
Return an array of the actual items that this ArrayList contains.
Walks the list using the specified callback
No description
Return this list as an array and every object it as an sub array as well
Add this $item into this list
Remove this item from this list
Replaces an item in this list with another item.
Merges with another array or list by pushing all the items in it onto the end of this list.
Removes items from this list which have a duplicate value for a certain field. This is especially useful when combining lists.
Pushes an item onto the end of this list.
Pops the last element off the end of the list and returns it.
Add an item onto the beginning of the list.
Shifts the item off the beginning of the list and returns it.
Returns the first item in the list
Returns the last item in the list
Find the first item of this list where the given key = value
Returns an array of a single field value for all items in the list.
Returns a unique array of a single field value for all the items in the list
You can always sort a ArrayList
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.
Shuffle the items in this array list
Returns true if the given column can be used to filter the records.
Filter the list to include items with these charactaristics
Return a copy of this list which contains items matching any of these charactaristics.
Return the first item with the given ID
No description
Exclude the list to not contain items with these charactaristics
Returns whether an item with $key exists
Returns item stored in list with index $key
Set an item with the key in $key
Unset an item with the key in $key
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()}
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
in CustomMethods at line 176
array
allMethodNames(bool $custom = false)
Return the names of all the methods available on this object
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()}).
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.
in Extensible at line 278
static array
get_extensions(string $class = null, bool $includeArgumentString = false)
in Extensible at line 312
static array|null
get_extra_config_sources(string $class = null)
Get extra config sources for this class
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))
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
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()}.
in Extensible at line 497
Extension|null
getExtensionInstance(string $extension)
Get an extension instance attached to this object by name.
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(
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.
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();
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).
in Configurable at line 20
static Config_ForClass
config()
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .
....).
in Configurable at line 32
mixed
stat(string $name)
deprecated
deprecated 5.0 Use ->config()->get() instead
Get inherited config value
in Configurable at line 44
mixed
uninherited(string $name)
Gets the uninherited value for the given config option
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
at line 41
__construct(array $items = [])
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.
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.
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.
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.
in ViewableData at line 183
ViewableData|null
getFailover()
Get the current failover object if set
in ViewableData at line 194
bool
hasField(string $field)
Check if a field exists on this object. This should be overloaded in child classes.
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.
in ViewableData at line 217
$this
setField(string $field, mixed $value)
Set a field on this object. This should be overloaded in child classes.
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()}.
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.
at line 97
bool
exists()
Returns true if this list has items
in ViewableData at line 289
string
__toString()
in ViewableData at line 297
ViewableData
getCustomisedObj()
in ViewableData at line 305
setCustomisedObj(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.
in ViewableData at line 352
string
castingClass(string $field)
Get the class name a field on this object will be casted to.
in ViewableData at line 365
string
escapeTypeForField(string $field)
Return the string-format type for the given field.
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
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.
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.
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.
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.
in ViewableData at line 558
array
getXMLValues(array $fields)
Get an array of XML-escaped values by field name
at line 108
ArrayIterator
getIterator()
Returns an Iterator for this ArrayList.
This function allows you to use ArrayList in foreach loops
in ViewableData at line 592
array
getViewerTemplates(string $suffix = '')
Find appropriate templates for SSViewer to use to render this object
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.
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.
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".
in ViewableData at line 676
ViewableData_Debugger
Debug()
Return debug information about this object that can be rendered into a template
at line 59
string
dataClass()
Return the class of items in this list, by looking at the first item inside it.
at line 76
$this
setDataClass(string $class)
Hint this list to a specific type
at line 87
int
count()
Return the number of items in this list
at line 124
array
toArray()
Return an array of the actual items that this ArrayList contains.
at line 135
$this
each(callable $callback)
Walks the list using the specified callback
at line 143
debug()
at line 158
array
toNestedArray()
Return this list as an array and every object it as an sub array as well
at line 184
Limitable
limit(int $length, int $offset)
Get a sub-range of this dataobjectset as an array
at line 223
add(mixed $item)
Add this $item into this list
at line 233
remove(mixed $item)
Remove this item from this list
at line 254
void;
replace(array|object $item, array|object $with)
Replaces an item in this list with another item.
at line 270
merge(array|object $with)
Merges with another array or list by pushing all the items in it onto the end of this list.
at line 284
$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.
at line 312
push(array|object $item)
Pushes an item onto the end of this list.
at line 322
array|object
pop()
Pops the last element off the end of the list and returns it.
at line 332
unshift(array|object $item)
Add an item onto the beginning of the list.
at line 342
array|object
shift()
Shifts the item off the beginning of the list and returns it.
at line 352
mixed
first()
Returns the first item in the list
at line 366
mixed
last()
Returns the last item in the list
at line 382
Map
map(string $keyfield = 'ID', string $titlefield = 'Title')
Returns a map of this list
at line 395
mixed
find(string $key, mixed $value)
Find the first item of this list where the given key = value
at line 411
array
column(string $colName = 'ID')
Returns an array of a single field value for all items in the list.
at line 428
array
columnUnique(string $colName = 'ID')
Returns a unique array of a single field value for all the items in the list
at line 439
bool
canSortBy(string $by)
You can always sort a ArrayList
at line 449
Sortable
reverse()
Reverses an {@link ArrayList}
at line 508
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
at line 580
$this
shuffle()
Shuffle the items in this array list
at line 595
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.
at line 618
Filterable
filter()
Filter the list to include items with these charactaristics
at line 661
Filterable
filterAny()
Return a copy of this list which contains items matching any of these charactaristics.
at line 723
SS_List
byIDs(array $ids)
Filter this list to only contain the given Primary IDs
at line 729
mixed
byID(int $id)
Return the first item with the given ID
at line 747
Filterable
filterByCallback(callable $callback)
at line 779
Filterable
exclude()
Exclude the list to not contain items with these charactaristics
at line 820
bool
offsetExists(mixed $offset)
Returns whether an item with $key exists
at line 831
DataObject
offsetGet(mixed $offset)
Returns item stored in list with index $key
at line 845
offsetSet(mixed $offset, mixed $value)
Set an item with the key in $key
at line 859
offsetUnset(mixed $offset)
Unset an item with the key in $key