class DataList extends ViewableData implements SS_List, SS_Filterable, SS_Sortable, SS_Limitable

Implements a "lazy loading" DataObjectSet.

Uses {@link 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.

Properties

string $class from Object
protected array $extension_instances from Object
protected array[callable] $beforeExtendCallbacks List of callbacks to call prior to extensions having extend called on them, each grouped by methodName. from Object
protected array[callable] $afterExtendCallbacks List of callbacks to call after extensions having extend called on them, each grouped by methodName. from Object
protected ViewableData $failover A failover object to attempt to get data from if it is not present on this object. from ViewableData
protected ViewableData $customisedObject from ViewableData
protected string $dataClass The DataObject class name that this data list is querying
protected DataQuery $dataQuery The {@link DataQuery} object responsible for getting this DataList's records
protected DataModel $model The DataModel from which this DataList comes.
protected bool $inAlterDataQueryCall

Methods

static Config_ForClass|null
config()

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

from Object
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.

from Object
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.

from Object
static Object
create()

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

from Object
static Object
singleton()

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

from Object
static 
create_from_string($classSpec, $firstArg = null)

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

from Object
static 
parse_class_spec($classSpec)

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

from Object
static Object
strong_create()

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

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

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

from Object
static string
getCustomClass(string $class)

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

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

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

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

Return TRUE if a class has a specified extension.

from Object
static 
add_extension(string $classOrExtension, string $extension = null)

Add an extension to a specific class.

from Object
static 
remove_extension(string $extension)

Remove an extension from a class.

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

No description

from Object
static 
get_extra_config_sources($class = null)

No description

from Object
__construct(string $dataClass)

Create a new DataList.

mixed
__call(string $method, array $arguments)

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

from Object
bool
hasMethod(string $method)

Return TRUE if a method exists on this object

from Object
array
allMethodNames(bool $custom = false)

Return the names of all the methods available on this object

from Object
defineMethods()

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

array
findMethodsFromExtension(object $extension)

No description

from Object
addMethodsFrom(string $property, string|int $index = null)

Add all the methods from an object property (which is an {@link Extension}) to this object.

from Object
removeMethodsFrom(string $property, string|int $index = null)

Add all the methods from an object property (which is an {@link Extension}) to this object.

from Object
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)

from Object
createMethod(string $method, string $code)

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

from Object
stat($name, $uncached = false)

No description

from Object
set_stat($name, $value)

No description

from Object
uninherited($name)

No description

from Object
bool
exists()

Returns true if this DataList has items

string
parentClass()

No description

from Object
bool
is_a(string $class)

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

from Object
string
__toString()

No description

from Object
mixed
invokeWithExtensions(string $method, mixed $argument = 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

from Object
array
extend($method, $a1 = null, $a2 = null, $a3 = null, $a4 = null, $a5 = null, $a6 = null, $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

from Object
getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

from Object
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.

from Object
array
getExtensionInstances()

Get all extension instances for this specific object instance.

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

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

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

Clears the cache for the given cacheToFile call

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

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

from Object
saveCache(string $cache, mixed $data)

Save a piece of cached data to the file system

from Object
string
sanitiseCachename(string $name)

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

from Object
static string
castingObjectCreator(string $fieldSchema)

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

static array
castingObjectCreatorPair(string $fieldSchema)

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

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.

setField(string $field, mixed $value)

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

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

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

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.

getCustomisedObj()

No description

setCustomisedObj(ViewableData $object)

No description

array
castingHelperPair(string $field)

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

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.

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.

buildCastingCache(reference $cache)

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

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

objCacheName(string $fieldName, array $arguments)

Generate the cache name for a field

mixed
objCacheGet(string $key)

Get a cached value from the field cache

objCacheSet(string $key, mixed $value)

Store a value in the field cache

obj(string $fieldName, array $arguments = null, bool $forceReturnedObject = true, bool $cache = false, string $cacheName = null)

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

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

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

XML_val($field, $arguments = null, $cache = false)

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

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

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

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

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

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

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

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

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

array
getXMLValues($fields)

Get an array of XML-escaped values by field name

getIterator()

Returns an Iterator for this DataList.

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

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

string
CSSClasses(string $stopAtClass = 'ViewableData')

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

setDataModel(DataModel $model)

Set the DataModel

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

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

alterDataQuery($callback)

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

setDataQuery(DataQuery $dataQuery)

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

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

Returns a new DataList instance with the specified query parameter assigned

sql($parameters = array())

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

where(string|array|SQLConditionGroup $filter)

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

whereAny(string|array|SQLConditionGroup $filter)

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

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.

limit($limit, $offset)

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

distinct(bool $value)

Return a new DataList instance with distinct records or not

sort()

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

filter()

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

addFilter(array $filterArray)

Return a new instance of the list with an added filter

filterAny()

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

filterByCallback($callback)

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

string
getRelationName(string $field)

Translates a {@link Object} relation name to a Database name and apply the relation join to the query. Throws an InvalidArgumentException if the $field doesn't correspond to a relation.

exclude()

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

subtract(SS_List $list)

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

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

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

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

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.

array
toNestedArray()

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

mixed
each(callable $callback)

Walks the list using the specified callback

debug()

No description

array
map(string $keyField = 'ID', string $titleField = 'Title')

Returns a map of this list

createDataObject(array $row)

Create a DataObject from the given SQL row

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

mixed
last()

Returns the last item in this DataList

mixed
find(string $key, mixed $value)

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

setQueriedColumns(array $queriedColumns)

Restrict the columns to fetch into this DataList

byIDs(array $ids)

Filter this list to only contain the given Primary IDs

byID(int $id)

Return the first DataObject with the given ID

array
column(string $colName = "ID")

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

setByIDList(array $idList)

Sets the ComponentSet to be the given ID list.

array
getIDList()

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

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.

dbObject($fieldName)

No description

addMany(array $items)

Add a number of items to the component set.

removeMany(array $idList)

Remove the items from this list with the given IDs

removeByFilter(string $filter)

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

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

newObject($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

reverse()

Reverses a list of items.

push(mixed $item)

This method won't function on DataLists due to the specific query that it represent

insertFirst(mixed $item)

This method won't function on DataLists due to the specific query that it represent

shift()

This method won't function on DataLists due to the specific query that it represent

replace()

This method won't function on DataLists due to the specific query that it represent

merge()

This method won't function on DataLists due to the specific query that it represent

removeDuplicates()

This method won't function on DataLists due to the specific query that it represent

bool
offsetExists(mixed $key)

Returns whether an item with $key exists

offsetGet(mixed $key)

Returns item stored in list with index $key

offsetSet(mixed $key, mixed $value)

Set an item with the key in $key

offsetUnset(mixed $key)

Unset an item with the key in $key

Details

in Object at line 60
static Config_ForClass|null config()

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

....).

Return Value

Config_ForClass|null

in Object at line 85
protected beforeExtending(string $method, callable $callback)

Allows user code to hook into Object::extend prior to control being delegated to extensions. Each callback will be reset once called.

Parameters

string $method The name of the method to hook into
callable $callback The callback to execute

in Object at line 108
protected afterExtending(string $method, callable $callback)

Allows user code to hook into Object::extend after control being delegated to extensions. Each callback will be reset once called.

Parameters

string $method The name of the method to hook into
callable $callback The callback to execute

in Object at line 132
static Object create()

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

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

This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create('SiteTree'); $list = SiteTree::get();

Return Value

Object

in Object at line 155
static Object singleton()

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

It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).

Return Value

Object The singleton instance

in Object at line 190
static create_from_string($classSpec, $firstArg = null)

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

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

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

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

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

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

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

Parameters

$classSpec
$firstArg

in Object at line 215
static parse_class_spec($classSpec)

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

Returns a 2-elemnent array, with classname and arguments

Parameters

$classSpec

in Object at line 341
static Object strong_create()

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

Return Value

Object

in Object at line 361
static useCustomClass(string $oldClass, string $newClass, bool $strong = false)

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

Parameters

string $oldClass the class to replace
string $newClass the class to replace it with
bool $strong allows you to enforce a certain class replacement under all circumstances. This is used in singletons and DB interaction classes

in Object at line 375
static string getCustomClass(string $class)

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

Parameters

string $class the class to check

Return Value

string the class that would be created if you called {@link Object::create()} with the class

in Object at line 396
static any static_lookup($class, $name, null $default = null)

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

Parameters

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

Return Value

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

in Object at line 436
static get_static($class, $name, $uncached = false) deprecated

deprecated

Parameters

$class
$name
$uncached

in Object at line 444
static set_static($class, $name, $value) deprecated

deprecated

Parameters

$class
$name
$value

in Object at line 452
static uninherited_static($class, $name, $uncached = false) deprecated

deprecated

Parameters

$class
$name
$uncached

in Object at line 460
static combined_static($class, $name, $ceiling = false) deprecated

deprecated

Parameters

$class
$name
$ceiling

in Object at line 470
static addStaticVars($class, $properties, $replace = false) deprecated

deprecated

Parameters

$class
$properties
$replace

in Object at line 478
static add_static_var($class, $name, $value, $replace = false) deprecated

deprecated

Parameters

$class
$name
$value
$replace

in Object at line 494
static 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 if 1 argument supplied, the class name of the extension to check for; if 2 supplied, the class name to test
string $requiredExtension used only if 2 arguments supplied
boolean $strict if the extension has to match the required extension and not be a subclass

in Object at line 536
static add_extension(string $classOrExtension, string $extension = null)

Add an extension to a specific class.

The preferred method for adding extensions is through YAML config, since it avoids autoloading the class, and is easier to override in more specific configurations.

As an alternative, extensions can be added to a specific class directly in the {@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')"

See also

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

in Object at line 601
static remove_extension(string $extension)

Remove an extension from a class.

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

in Object at line 640
static array get_extensions(string $class, bool $includeArgumentString = false)

Parameters

string $class
bool $includeArgumentString Include the argument string in the return array, FALSE would return array("Versioned"), TRUE returns array("Versioned('Stage','Live')").

Return Value

array Numeric array of either {@link DataExtension} classnames, or eval'ed classname strings with constructor arguments.

in Object at line 658
static get_extra_config_sources($class = null)

Parameters

$class

at line 53
__construct(string $dataClass)

Create a new DataList.

No querying is done on construction, but the initial query schema is set up.

Parameters

string $dataClass
  • The DataObject class to query.

in Object at line 728
mixed __call(string $method, array $arguments)

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

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

Parameters

string $method
array $arguments

Return Value

mixed

in Object at line 795
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 Object at line 805
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 ViewableData at line 206
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 Object at line 846
protected array findMethodsFromExtension(object $extension)

Parameters

object $extension

Return Value

array

in Object at line 867
protected addMethodsFrom(string $property, string|int $index = null)

Add all the methods from an object property (which is an {@link Extension}) to this object.

Parameters

string $property the property name
string|int $index an index to use if the property is an array

in Object at line 902
protected removeMethodsFrom(string $property, string|int $index = null)

Add all the methods from an object property (which is an {@link Extension}) to this object.

Parameters

string $property the property name
string|int $index an index to use if the property is an array

in Object at line 934
protected addWrapperMethod(string $method, string $wrap)

Add a wrapper method - a method which points to another method with a different name. For example, Thumbnail(x) can be wrapped to generateThumbnail(x)

Parameters

string $method the method name to wrap
string $wrap the method name to wrap to

in Object at line 949
protected createMethod(string $method, string $code)

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

Parameters

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

in Object at line 962
stat($name, $uncached = false)

Parameters

$name
$uncached

See also

Object::get_static()

in Object at line 969
set_stat($name, $value)

Parameters

$name
$value

See also

Object::set_static()

in Object at line 976
uninherited($name)

Parameters

$name

See also

Object::uninherited_static()

at line 840
bool exists()

Returns true if this DataList has items

Return Value

bool

in Object at line 997
string parentClass()

Return Value

string this classes parent class

in Object at line 1007
bool is_a(string $class)

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

Parameters

string $class

Return Value

bool

in Object at line 1014
string __toString()

Return Value

string the class name

in Object at line 1029
mixed invokeWithExtensions(string $method, mixed $argument = 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 $argument a single argument to pass

Return Value

mixed

in Object at line 1051
array extend($method, $a1 = null, $a2 = null, $a3 = null, $a4 = null, $a5 = null, $a6 = null, $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

$method
$a1
$a2
$a3
$a4
$a5
$a6
$a7

Return Value

array

in Object at line 1090
Extension getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

Parameters

string $extension

Return Value

Extension

in Object at line 1108
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 Object at line 1119
array 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).

Return Value

array Map of {@link DataExtension} instances, keyed by classname.

in Object at line 1135
mixed cacheToFile(string $method, int $lifetime = 3600, string $ID = false, array $arguments = array())

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

Parameters

string $method the method name to cache
int $lifetime the cache lifetime in seconds
string $ID custom cache ID to use
array $arguments an optional array of arguments

Return Value

mixed the cached data

in Object at line 1164
clearCache($method, $ID = false, $arguments = array())

Clears the cache for the given cacheToFile call

Parameters

$method
$ID
$arguments

in Object at line 1183
protected mixed loadCache(string $cache, int $lifetime = 3600)

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

Parameters

string $cache the cache name
int $lifetime the lifetime (in seconds) of the cache before it is invalid

Return Value

mixed

in Object at line 1201
protected saveCache(string $cache, mixed $data)

Save a piece of cached data to the file system

Parameters

string $cache the cache name
mixed $data data to save (must be serializable)

in Object at line 1212
protected string sanitiseCachename(string $name)

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

Parameters

string $name

Return Value

string the name with all special cahracters replaced with underscores

in ViewableData at line 72
static string castingObjectCreator(string $fieldSchema)

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

Parameters

string $fieldSchema The field spec

Return Value

string

in ViewableData at line 83
static array castingObjectCreatorPair(string $fieldSchema)

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

Parameters

string $fieldSchema

Return Value

array

in ViewableData at line 95
bool __isset(string $property)

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

Parameters

string $property

Return Value

bool

in ViewableData at line 117
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 138
__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 151
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 166
ViewableData|null getFailover()

Get the current failover object if set

Return Value

ViewableData|null

in ViewableData at line 176
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 186
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 196
setField(string $field, mixed $value)

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

Parameters

string $field
mixed $value

in ViewableData at line 236
unknown deprecatedCachedCall($method, $args = null, $identifier = null)

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

Parameters

$method
$args
$identifier

Return Value

unknown

in ViewableData at line 255
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 ViewableData at line 272
ViewableData getCustomisedObj()

Return Value

ViewableData

in ViewableData at line 279
setCustomisedObj(ViewableData $object)

Parameters

ViewableData $object

in ViewableData at line 296
array castingHelperPair(string $field)

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

The returned array contains two keys: - className: the class the field would be casted to (e.g. "Varchar") - castingHelper: the casting helper for casting the field (e.g. "return new Varchar($fieldName)")

Parameters

string $field

Return Value

array

in ViewableData at line 308
string castingHelper(string $field)

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

Parameters

string $field

Return Value

string

in ViewableData at line 331
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 346
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 357
buildCastingCache(reference $cache)

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

Parameters

reference $cache

in ViewableData at line 394
HTMLText renderWith(string|array|SSViewer $template, array $customFields = null)

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

Parameters

string|array|SSViewer $template the template to render into
array $customFields fields to customise() the object with before rendering

Return Value

HTMLText

in ViewableData at line 419
protected objCacheName(string $fieldName, array $arguments)

Generate the cache name for a field

Parameters

string $fieldName Name of field
array $arguments List of optional arguments given

in ViewableData at line 431
protected mixed objCacheGet(string $key)

Get a cached value from the field cache

Parameters

string $key Cache key

Return Value

mixed

in ViewableData at line 441
protected objCacheSet(string $key, mixed $value)

Store a value in the field cache

Parameters

string $key Cache key
mixed $value

in ViewableData at line 456
obj(string $fieldName, array $arguments = null, bool $forceReturnedObject = true, bool $cache = false, string $cacheName = null)

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

Parameters

string $fieldName
array $arguments
bool $forceReturnedObject if TRUE, the value will ALWAYS be casted to an object before being returned, even if there is no explicit casting information
bool $cache Cache this object
string $cacheName a custom cache name

in ViewableData at line 503
cachedCall(string $field, array $arguments = null, 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

in ViewableData at line 516
bool hasValue(string $field, array $arguments = null, bool $cache = true)

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

Parameters

string $field
array $arguments
bool $cache

Return Value

bool

in ViewableData at line 538
XML_val($field, $arguments = null, $cache = false)

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

Parameters

$field
$arguments
$cache

in ViewableData at line 546
RAW_val($field, $arguments = null, $cache = true)

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

Parameters

$field
$arguments
$cache

in ViewableData at line 553
SQL_val($field, $arguments = null, $cache = true)

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

Parameters

$field
$arguments
$cache

in ViewableData at line 560
JS_val($field, $arguments = null, $cache = true)

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

Parameters

$field
$arguments
$cache

in ViewableData at line 567
ATT_val($field, $arguments = null, $cache = true)

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

Parameters

$field
$arguments
$cache

in ViewableData at line 579
array getXMLValues($fields)

Get an array of XML-escaped values by field name

Parameters

$fields

Return Value

array

at line 759
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 611
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 627
string ThemeDir(string $subtheme = false)

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

This method is useful for things such as accessing theme images from your template without hardcoding the theme page - e.g. .

This method should only be used when a theme is currently active. However, it will fall over to the current project directory.

Parameters

string $subtheme the subtheme path to get

Return Value

string

in ViewableData at line 648
string CSSClasses(string $stopAtClass = 'ViewableData')

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

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

Parameters

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

Return Value

string

in ViewableData at line 671
ViewableData_Debugger Debug()

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

Return Value

ViewableData_Debugger

at line 65
setDataModel(DataModel $model)

Set the DataModel

Parameters

DataModel $model

at line 74
string dataClass()

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

Return Value

string

at line 81
__clone()

When cloning this object, clone the dataQuery object as well

at line 93
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

at line 117
DataList alterDataQuery($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

$callback

Return Value

DataList

at line 150
DataList setDataQuery(DataQuery $dataQuery)

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

Parameters

DataQuery $dataQuery

Return Value

DataList

at line 163
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

at line 184
sql($parameters = array())

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

Parameters

$parameters

at line 199
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 SQLQuery::addWhere() for syntax examples, although DataList won't expand multiple method arguments as SQLQuery does.

Parameters

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

Return Value

DataList

at line 217
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 SQLQuery::addWhere() for syntax examples, although DataList won't expand multiple method arguments as SQLQuery does.

Parameters

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

Return Value

DataList

at line 231
bool canSortBy(string $fieldName)

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

Parameters

string $fieldName

Return Value

bool

at line 241
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

at line 266
SS_Limitable limit($limit, $offset)

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

Parameters

$limit
$offset

Return Value

SS_Limitable

at line 277
distinct(bool $value)

Return a new DataList instance with distinct records or not

Parameters

bool $value

at line 297
SS_Sortable sort()

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

Return Value

SS_Sortable

See also

SS_List::sort()
SQLQuery::orderby

at line 372
SS_Filterable filter()

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

Return Value

SS_Filterable

See also

SS_List::filter()

at line 390
addFilter(array $filterArray)

Return a new instance of the list with an added filter

Parameters

array $filterArray

at line 428
DataList filterAny()

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

Return Value

DataList

at line 475
SS_Filterable filterByCallback($callback)

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

Parameters

$callback

Return Value

SS_Filterable

See also

SS_Filterable::filterByCallback()

at line 499
string getRelationName(string $field)

Translates a {@link Object} relation name to a Database name and apply the relation join to the query. Throws an InvalidArgumentException if the $field doesn't correspond to a relation.

Parameters

string $field

Return Value

string

Exceptions

InvalidArgumentException

at line 565
SS_Filterable exclude()

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

Return Value

SS_Filterable

See also

SS_List::exclude()

at line 612
DataList subtract(SS_List $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

SS_List $list

Return Value

DataList

Exceptions

BadMethodCallException

at line 634
DataList innerJoin(string $table, string $onClause, string $alias = null, int $order = 20, array $parameters = array())

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

at line 652
DataList leftJoin(string $table, string $onClause, string $alias = null, int $order = 20, array $parameters = array())

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

at line 664
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

at line 681
array toNestedArray()

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

Return Value

array

at line 697
mixed each(callable $callback)

Walks the list using the specified callback

Parameters

callable $callback

Return Value

mixed

at line 705
debug()

at line 722
array 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

array

at line 732
protected DataObject createDataObject(array $row)

Create a DataObject from the given SQL row

Parameters

array $row

Return Value

DataObject

at line 768
int count()

Return the number of items in this DataList

Return Value

int

at line 778
mixed max(string $fieldName)

Return the maximum value of the given field in this DataList

Parameters

string $fieldName

Return Value

mixed

at line 788
mixed min(string $fieldName)

Return the minimum value of the given field in this DataList

Parameters

string $fieldName

Return Value

mixed

at line 798
mixed avg(string $fieldName)

Return the average value of the given field in this DataList

Parameters

string $fieldName

Return Value

mixed

at line 808
mixed sum(string $fieldName)

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

Parameters

string $fieldName

Return Value

mixed

at line 818
mixed first()

Returns the first item in this DataList

Return Value

mixed

at line 829
mixed last()

Returns the last item in this DataList

@return DataObject

Return Value

mixed

at line 851
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

at line 861
DataList setQueriedColumns(array $queriedColumns)

Restrict the columns to fetch into this DataList

Parameters

array $queriedColumns

Return Value

DataList

at line 873
DataList byIDs(array $ids)

Filter this list to only contain the given Primary IDs

Parameters

array $ids Array of integers

Return Value

DataList

at line 883
DataObject byID(int $id)

Return the first DataObject with the given ID

Parameters

int $id

Return Value

DataObject

at line 893
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

at line 905
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.

at line 935
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

at line 952
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("Group")->relation("Members")

Parameters

string $relationName

Return Value

HasManyList|ManyManyList

at line 957
dbObject($fieldName)

Parameters

$fieldName

at line 967
DataList 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

DataList

at line 980
DataList removeMany(array $idList)

Remove the items from this list with the given IDs

Parameters

array $idList

Return Value

DataList

at line 993
DataList removeByFilter(string $filter)

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

Parameters

string $filter
  • a sql type where filter

Return Value

DataList

at line 1005
DataList removeAll()

Remove every element in this DataList.

Return Value

DataList

at line 1018
add(mixed $item)

This method are overloaded by HasManyList and ManyMany list to perform more sophisticated list manipulation

Parameters

mixed $item

at line 1028
newObject($initialFields = null)

Return a new item to add to this DataList.

Parameters

$initialFields

at line 1040
remove(mixed $item)

Remove this item by deleting it

Parameters

mixed $item

at line 1050
removeByID(int $itemID)

Remove an item from this DataList by ID

Parameters

int $itemID
  • The primary ID

at line 1063
SS_Sortable reverse()

Reverses a list of items.

Return Value

SS_Sortable

at line 1074
push(mixed $item)

This method won't function on DataLists due to the specific query that it represent

Parameters

mixed $item

at line 1083
insertFirst(mixed $item)

This method won't function on DataLists due to the specific query that it represent

Parameters

mixed $item

at line 1091
shift()

This method won't function on DataLists due to the specific query that it represent

at line 1099
replace()

This method won't function on DataLists due to the specific query that it represent

at line 1107
merge()

This method won't function on DataLists due to the specific query that it represent

at line 1115
removeDuplicates()

This method won't function on DataLists due to the specific query that it represent

at line 1126
bool offsetExists(mixed $key)

Returns whether an item with $key exists

Parameters

mixed $key

Return Value

bool

at line 1136
DataObject offsetGet(mixed $key)

Returns item stored in list with index $key

Parameters

mixed $key

Return Value

DataObject

at line 1146
offsetSet(mixed $key, mixed $value)

Set an item with the key in $key

Parameters

mixed $key
mixed $value

at line 1155
offsetUnset(mixed $key)

Unset an item with the key in $key

Parameters

mixed $key