DataList
class DataList extends ViewableData implements SS_List, Filterable, Sortable, Limitable (View source)
Implements a "lazy loading" DataObjectSet.
Uses DataQuery to do the actual query generation.
DataLists are immutable as far as the query they represent is concerned. When you call a method that alters the query, a new DataList instance is returned, rather than modifying the existing instance
When you add or remove an element to the list the query remains the same, but because you have modified the underlying data the contents of the list changes. These are some of those methods:
- add
- addMany
- remove
- removeMany
- removeByID
- removeByFilter
- removeAll
Subclasses of DataList may add other methods that have the same effect.
Traits
Allows an object to have extensions applied to it.
A class that can be instantiated or replaced via DI
Provides extensions to this object to integrate it with standard config API methods.
Allows an object to declare a set of custom methods
Config options
| extensions | array | An array of extension names and parameters to be applied to this object upon construction. |
from Extensible |
| unextendable_classes | array | Classes that cannot be extended |
from Extensible |
| casting | array | An array of objects to cast certain fields to. This is set up as an array in the format: |
from ViewableData |
| default_cast | string | The default object to cast scalar fields to if casting information is not specified, and casting to an object is required. |
from ViewableData |
| casting_cache | array | from ViewableData |
Properties
| protected static | array | $extra_methods | Custom method sources |
from CustomMethods |
| protected | array | $extra_method_registers | Name of methods to invoke by defineMethods for this instance |
from CustomMethods |
| protected static | array | $built_in_methods | Non-custom methods |
from CustomMethods |
| protected | Extension[] | $extension_instances | from Extensible | |
| protected | callable[][] | $beforeExtendCallbacks | List of callbacks to call prior to extensions having extend called on them, each grouped by methodName. |
from Extensible |
| protected | callable[][] | $afterExtendCallbacks | List of callbacks to call after extensions having extend called on them, each grouped by methodName. |
from Extensible |
| protected | ViewableData | $failover | A failover object to attempt to get data from if it is not present on this object. |
from ViewableData |
| protected | ViewableData | $customisedObject | from ViewableData | |
| protected | string | $dataClass | The DataObject class name that this data list is querying |
|
| protected | DataQuery | $dataQuery | The DataQuery object responsible for getting this DataList's records |
|
| protected | bool | $inAlterDataQueryCall |
Methods
Attempts to locate and call a method dynamically added to a class at runtime if a default cannot be located
Adds any methods from Extension instances attached to this object.
Register an callback to invoke that defines extra methods
Return TRUE if a method exists on this object
Get meta-data details on a named method
Return the names of all the methods available on this object
Add all the methods from an object property (which is an Extension) to this object.
Add all the methods from an object property (which is an Extension) to this object.
Add a wrapper method - a method which points to another method with a different name. For example, Thumbnail(x) can be wrapped to generateThumbnail(x)
Add callback as a method.
Allows user code to hook into Object::extend prior to control being delegated to extensions. Each callback will be reset once called.
Allows user code to hook into Object::extend after control being delegated to extensions. Each callback will be reset once called.
Adds any methods from Extension instances attached to 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 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 $extension_instances. Extension instances are initialized at constructor time, meaning if you use add_extension() afterwards, the added extension will just be added to new instances of the extended class. Use the static method has_extension() to check if a class (not an instance) has a specific extension.
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
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 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 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.
Merge some arbitrary data in with this object. This method returns a ViewableData_Customised instance with references to both this and the new custom data.
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
Generate the cache name for a field
Store a value in the field cache
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 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
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 a new DataList instance with the underlying DataQuery object altered
Return a new DataList instance with the underlying DataQuery object changed
Returns a new DataList instance with the specified query parameter assigned
Returns the SQL query that will be used to get this DataList's records. Good for debugging. :-)
Return a new DataList instance with a WHERE clause added to this list's query.
Return a new DataList instance with a WHERE clause added to this list's query.
Returns true if this DataList can be sorted by the given field.
Returns true if this DataList can be filtered by the given field.
Return a new DataList instance with the records returned in this query restricted by a limit clause.
Return a new DataList instance as a copy of this data list with the sort order set.
Return a copy of this list which only includes items with these characteristics
Return a copy of this list which contains items matching any of these characteristics.
Note that, in the current implementation, the filtered list will be an ArrayList, but this may change in a future implementation.
Given a field or relation name, apply it safely to this datalist.
Check if the given field specification could be interpreted as an unquoted relation name
Given a filter expression and value construct a {SearchFilter} instance
Return a copy of this list which does not contain any items that match all params
Return a copy of this list which does not contain any items with any of these params
Return a new DataList instance with an inner join clause added to this list's query.
Return a new DataList instance with a left join clause added to this list's query.
Return an array of the actual items that this DataList contains at this stage.
Return this list as an array and every object it as an sub array as well
Create a DataObject from the given SQL row If called without $row['ID'] set, then a new object will be created rather than rehydrated.
Return the sum of the values of the given field in this DataList
Find the first DataObject of this DataList where the given key = value
Restrict the columns to fetch into this DataList
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 items in the list.
Returns an array with both the keys and values set to the IDs of the records in this list.
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.
Remove every element in this DataList matching the given $filter.
This method are overloaded by HasManyList and ManyMany list to perform more sophisticated list manipulation
Iterate over this DataList in "chunks". This will break the query in smaller subsets and avoid loading the entire result set in memory at once. Beware not to perform any operations on the results that might alter the return order. Otherwise, you might break subsequent chunks.
Details
mixed
__call(string $method, array $arguments)
Attempts to locate and call a method dynamically added to a class at runtime if a default cannot be located
You can add extra methods to a class using Extensions}, {@link Object::createMethod() or Object::addWrapperMethod()
protected
defineMethods()
Adds any methods from Extension instances attached to this object.
All these methods can then be called directly on the instance (transparently mapped through __call()}), or called explicitly through {@link extend().
protected
registerExtraMethodCallback(string $name, callable $callback)
Register an callback to invoke that defines extra methods
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
protected array
getExtraMethodConfig(string $method)
Get meta-data details on a named method
array
allMethodNames(bool $custom = false)
Return the names of all the methods available on this object
protected array
findMethodsFromExtension(object $extension)
deprecated
deprecated
No description
protected
addMethodsFrom(string $property, string|int $index = null)
Add all the methods from an object property (which is an Extension) to this object.
protected
removeMethodsFrom(string $property, string|int $index = null)
Add all the methods from an object property (which is an Extension) to this object.
protected
addWrapperMethod(string $method, string $wrap)
Add a wrapper method - a method which points to another method with a different name. For example, Thumbnail(x) can be wrapped to generateThumbnail(x)
protected
addCallbackMethod(string $method, callable $callback)
Add callback as a method.
protected
beforeExtending(string $method, callable $callback)
Allows user code to hook into Object::extend prior to control being delegated to extensions. Each callback will be reset once called.
protected
afterExtending(string $method, callable $callback)
Allows user code to hook into Object::extend after control being delegated to extensions. Each callback will be reset once called.
protected
constructExtensions()
deprecated
deprecated
No description
protected
defineExtensionMethods()
Adds any methods from Extension instances attached to this object.
All these methods can then be called directly on the instance (transparently mapped through __call()}), or called explicitly through {@link extend().
static bool
add_extension(string $classOrExtension, string $extension = null)
Add an extension to a specific class.
The preferred method for adding extensions is through YAML config, since it avoids autoloading the class, and is easier to override in more specific configurations.
As an alternative, extensions can be added to a specific class directly in the Object::$extensions array. See SiteTree::$extensions for examples. Keep in mind that the extension will only be applied to new instances, not existing ones (including all instances created through singleton()).
static
remove_extension(string $extension)
Remove an extension from a class.
Note: This will not remove extensions from parent classes, and must be called directly on the class assigned the extension.
Keep in mind that this won't revert any datamodel additions of the extension at runtime, unless its used before the schema building kicks in (in your _config.php). Doesn't remove the extension from any Object instances which are already created, but will have an effect on new extensions. Clears any previously created singletons through singleton() to avoid side-effects from stale extension information.
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.
This supports backwards-compatible format (static Object::has_extension($requiredExtension)) and new format ($object->has_extension($class, $requiredExtension))
array
invokeWithExtensions(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = null)
Calls a method if available on both this object and all applied Extensions, and then attempts to merge all results into an array
array
extend(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = null)
Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed
Currently returns an array, with an index resulting every time the function is called. Only adds returns if they're not NULL, to avoid bogus results from methods just defined on the parent extension. This is important for permission-checks through extend, as they use min() to determine if any of the returns is FALSE. As min() doesn't do type checking, an included NULL return would fail the permission checks.
The extension methods are defined during __construct()} in {@link defineMethods().
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 $extension_instances. Extension instances are initialized at constructor time, meaning if you use add_extension() afterwards, the added extension will just be added to new instances of the extended class. Use the static method has_extension() to check if a class (not an instance) has a specific extension.
Caution: Don't use singleton(
Extension[]
getExtensionInstances()
Get all extension instances for this specific object instance.
See get_extensions() to get all applied extension classes for this class (not the instance).
This method also provides lazy-population of the extension_instances property.
static Injectable
create(mixed ...$args)
An implementation of the factory method, allows you to create an instance of a class
This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.
This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create(SiteTree::class); $list = SiteTree::get();
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).
static Config_ForClass
config()
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
mixed
stat(string $name)
deprecated
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
deprecated
Update the config value for a given property
__construct(string $dataClass)
Create a new DataList.
No querying is done on construction, but the initial query schema is set up.
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.
mixed
__get(string $property)
Get the value of a property/field on this object. This will check if a method called get{$property} exists, then check if a field is available using ViewableData::getField(), then fall back on a failover object.
__set(string $property, mixed $value)
Set a property/field on this object. This will check for the existence of a method called set{$property}, then use the ViewableData::setField() method.
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.
ViewableData_Customised
customise(array|ViewableData $data)
Merge some arbitrary data in with this object. This method returns a ViewableData_Customised instance with references to both this and the new custom data.
Note that any fields you specify will take precedence over the fields on this object.
bool
exists()
Returns true if this DataList 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
protected string
objCacheName(string $fieldName, array $arguments)
Generate the cache name for a field
protected mixed
objCacheGet(string $key)
Get a cached value from the field cache
protected $this
objCacheSet(string $key, mixed $value)
Store a value in the field cache
protected $this
objCacheClear()
Clear object cache
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 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
ArrayIterator
getIterator()
Returns an Iterator for this DataList.
This function allows you to use DataLists in foreach loops
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
deprecated
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.
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".
ViewableData_Debugger
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
__clone()
When cloning this object, clone the dataQuery object as well
DataQuery
dataQuery()
Return a copy of the internal 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
DataList
alterDataQuery(callable $callback)
Return a new DataList instance with the underlying 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
DataList
setDataQuery(DataQuery $dataQuery)
Return a new DataList instance with the underlying DataQuery object changed
DataList
setDataQueryParam(string|array $keyOrArray, mixed $val = null)
Returns a new DataList instance with the specified query parameter assigned
string
sql(array $parameters = [])
Returns the SQL query that will be used to get this DataList's records. Good for debugging. :-)
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.
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.
bool
canSortBy(string $fieldName)
Returns true if this DataList can be sorted by the given field.
bool
canFilterBy(string $fieldName)
Returns true if this DataList can be filtered by the given field.
Limitable
limit(int $limit, int $offset = 0)
Return a new DataList instance with the records returned in this query restricted by a limit clause.
DataList
distinct(bool $value)
Return a new DataList instance with distinct records or not
Sortable
sort()
Return a new DataList instance as a copy of this data list with the sort order set.
Filterable
filter()
Return a copy of this list which only includes items with these characteristics
$this
addFilter(array $filterArray)
Return a new instance of the list with an added filter
Filterable
filterAny()
Return a copy of this list which contains items matching any of these characteristics.
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.
$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.
Example use (simple WHERE condition on data sitting in a related table):
$columnName = null;
$list = Page::get()
->applyRelation('TaxonomyTerms.ID', $columnName)
->where([$columnName => 'my value']);
protected bool
isValidRelationName(string $field)
Check if the given field specification could be interpreted as an unquoted relation name
protected SearchFilter
createSearchFilter(string $filter, mixed $value)
Given a filter expression and value construct a {SearchFilter} instance
Filterable
exclude()
Return a copy of this list which does not contain any items that match all params
$this
excludeAny()
Return a copy of this list which does not contain any items with any of these params
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
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.
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.
array
toArray()
Return an array of the actual items that this DataList contains at this stage.
This is when the query is actually executed.
array
toNestedArray()
Return this list as an array and every object it as an sub array as well
$this
each(callable $callback)
Walks the list using the specified callback
Generator&DataObject
getGenerator()
deprecated
deprecated
Returns a generator for this DataList
debug()
No description
Map
map(string $keyField = 'ID', string $titleField = 'Title')
Returns a map of this list
DataObject
createDataObject(array $row)
Create a DataObject from the given SQL row If called without $row['ID'] set, then a new object will be created rather than rehydrated.
array
getQueryParams()
Get query parameters for this list.
These values will be assigned as query parameters to newly created objects from this list.
int
count()
Return the number of items in this DataList
mixed
max(string $fieldName)
Return the maximum value of the given field in this DataList
mixed
min(string $fieldName)
Return the minimum value of the given field in this DataList
mixed
avg(string $fieldName)
Return the average value of the given field in this DataList
mixed
sum(string $fieldName)
Return the sum of the values of the given field in this DataList
mixed
first()
Returns the first item in this DataList (instanceof DataObject)
The object returned is not cached, unlike DataObject::get_one()
mixed
last()
Returns the last item in this DataList (instanceof DataObject)
The object returned is not cached, unlike DataObject::get_one()
mixed
find(string $key, mixed $value)
Find the first DataObject of this DataList where the given key = value
The object returned is not cached, unlike DataObject::get_one()
DataList
setQueriedColumns(array $queriedColumns)
Restrict the columns to fetch into this DataList
SS_List
byIDs(array $ids)
Filter this list to only contain the given Primary IDs
mixed
byID(int $id)
Return the first DataObject with the given ID
The object returned is not cached, unlike DataObject::get_by_id()
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 items in the list.
setByIDList(array $idList)
Sets the ComponentSet to be the given ID list.
Records will be added and deleted as appropriate.
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.
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")
dbObject($fieldName)
No description
$this
addMany(array $items)
Add a number of items to the component set.
$this
removeMany(array $idList)
Remove the items from this list with the given IDs
$this
removeByFilter(string|array $filter)
Remove every element in this DataList matching the given $filter.
$this
shuffle()
Shuffle the datalist using a random function provided by the SQL engine
$this
removeAll()
Remove every element in this DataList.
add(mixed $item)
This method are overloaded by HasManyList and ManyMany list to perform more sophisticated list manipulation
DataObject
newObject(array $initialFields = null)
Return a new item to add to this DataList.
remove(mixed $item)
Remove this item by deleting it
removeByID(int $itemID)
Remove an item from this DataList by ID
Sortable
reverse()
Reverses a list of items.
bool
offsetExists(mixed $key)
Returns whether an item with $key exists
DataObject
offsetGet(mixed $key)
Returns item stored in list with index $key
The object returned is not cached, unlike DataObject::get_one()
offsetSet(mixed $key, mixed $value)
Set an item with the key in $key
offsetUnset(mixed $key)
Unset an item with the key in $key
iterable
chunkedFetch(int $chunkSize = 1000)
Iterate over this DataList in "chunks". This will break the query in smaller subsets and avoid loading the entire result set in memory at once. Beware not to perform any operations on the results that might alter the return order. Otherwise, you might break subsequent chunks.
You also can not define a custom limit or offset when using the chunk method.