class ArrayList extends ViewableData implements SS_List, SS_Filterable, SS_Sortable, SS_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

Properties

string $class from SS_Object

Methods

static Config_ForClass|null
config()

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

from SS_Object
static SS_Object
create()

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

from SS_Object
static SS_Object
singleton()

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

from SS_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 SS_Object
static 
parse_class_spec($classSpec)

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

from SS_Object
static SS_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 SS_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 SS_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 SS_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 SS_Object
static 
get_static($class, $name, $uncached = false) deprecated

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

Return TRUE if a class has a specified extension.

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

Add an extension to a specific class.

from SS_Object
static 
remove_extension(string $extension)

Remove an extension from a class.

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

No description

from SS_Object
static 
get_extra_config_sources($class = null)

No description

from SS_Object
__construct(array $items = array())

No description

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 SS_Object
bool
hasMethod(string $method)

Return TRUE if a method exists on this object

from SS_Object
array
allMethodNames(bool $custom = false)

Return the names of all the methods available on this object

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

No description

from SS_Object
set_stat($name, $value)

No description

from SS_Object
uninherited($name)

No description

from SS_Object
bool
exists()

Returns true if this list has items

string
parentClass()

No description

from SS_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 SS_Object
string
__toString()

No description

from SS_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 SS_Object
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

from SS_Object
getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

from SS_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 SS_Object
array
getExtensionInstances()

Get all extension instances for this specific object instance.

from SS_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 SS_Object
clearCache($method, $ID = false, $arguments = array())

Clears the cache for the given cacheToFile call

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

defineMethods()

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

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

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

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

dataClass()

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

int
count()

Return the number of items in this list

array
toArray()

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

mixed
each(callable $callback)

Walks the list using the specified callback

debug()

No description

array
toNestedArray()

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

limit($length, $offset)

Get a sub-range of this dataobjectset as an array

add(mixed $item)

Add this $item into this list

remove(mixed $item)

Remove this item from this list

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

Replaces an item in this list with another item.

merge(array|object $with)

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

removeDuplicates(string $field = 'ID')

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

push(array|object $item)

Pushes an item onto the end of this list.

array|object
pop()

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

unshift(array|object $item)

Add an item onto the beginning of the list.

array|object
shift()

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

mixed
first()

Returns the first item in the list

mixed
last()

Returns the last item in the list

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

Returns a map of this list

mixed
find(string $key, mixed $value)

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

array
column(string $colName = 'ID')

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

bool
canSortBy(string $by)

You can always sort a ArrayList

reverse()

Reverses an {@link ArrayList}

sort()

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

bool
canFilterBy(string $by)

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

filter()

Filter the list to include items with these charactaristics

filterAny()

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

byIDs(array $ids)

Filter this list to only contain the given Primary IDs

byID($id)

No description

filterByCallback($callback)

No description

exclude()

Exclude the list to not contain items with these charactaristics

bool
offsetExists($offset)

Returns whether an item with $key exists

offsetGet($offset)

Returns item stored in list with index $key

offsetSet($offset, $value)

Set an item with the key in $key

offsetUnset($offset)

Unset an item with the key in $key

Details

in SS_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 SS_Object at line 132
static SS_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

SS_Object

in SS_Object at line 155
static SS_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

SS_Object The singleton instance

in SS_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 SS_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 SS_Object at line 341
static SS_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

SS_Object

in SS_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 SS_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 SS_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 SS_Object at line 436
static get_static($class, $name, $uncached = false) deprecated

deprecated

Parameters

$class
$name
$uncached

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

deprecated

Parameters

$class
$name
$value

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

deprecated

Parameters

$class
$name
$uncached

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

deprecated

Parameters

$class
$name
$ceiling

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

deprecated

Parameters

$class
$properties
$replace

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

deprecated

Parameters

$class
$name
$value
$replace

in SS_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 SS_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 SS_Object at line 594
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 SS_Object at line 633
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 SS_Object at line 655
static get_extra_config_sources($class = null)

Parameters

$class

at line 32
__construct(array $items = array())

Parameters

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

in SS_Object at line 725
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 SS_Object at line 792
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 SS_Object at line 802
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 SS_Object at line 959
stat($name, $uncached = false)

Parameters

$name
$uncached

See also

SS_Object::get_static()

in SS_Object at line 966
set_stat($name, $value)

Parameters

$name
$value

See also

SS_Object::set_static()

in SS_Object at line 973
uninherited($name)

Parameters

$name

See also

SS_Object::uninherited_static()

at line 58
bool exists()

Returns true if this list has items

Return Value

bool

in SS_Object at line 994
string parentClass()

Return Value

string this classes parent class

in SS_Object at line 1004
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 SS_Object at line 1011
string __toString()

Return Value

string the class name

in SS_Object at line 1026
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 SS_Object at line 1054
array extend(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = null)

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

Currently returns an array, with an index resulting every time the function is called. Only adds returns if they're not NULL, to avoid bogus results from methods just defined on the parent extension. This is important for permission-checks through extend, as they use min() to determine if any of the returns is FALSE. As min() doesn't do type checking, an included NULL return would fail the permission checks.

The extension methods are defined during {@link __construct()} in {@link defineMethods()}.

Parameters

string $method the name of the method to call on each extension
mixed $a1
mixed $a2
mixed $a3
mixed $a4
mixed $a5
mixed $a6
mixed $a7

Return Value

array

in SS_Object at line 1093
Extension getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

Parameters

string $extension

Return Value

Extension

in SS_Object at line 1111
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 SS_Object at line 1122
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 SS_Object at line 1138
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 SS_Object at line 1167
clearCache($method, $ID = false, $arguments = array())

Clears the cache for the given cacheToFile call

Parameters

$method
$ID
$arguments

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 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 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 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 68
ArrayIterator getIterator()

Returns an Iterator for this ArrayList.

This function allows you to use ArrayList 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 40
dataClass()

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

at line 49
int count()

Return the number of items in this list

Return Value

int

at line 80
array toArray()

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

Return Value

array

at line 90
mixed each(callable $callback)

Walks the list using the specified callback

Parameters

callable $callback

Return Value

mixed

at line 96
debug()

at line 110
array toNestedArray()

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

Return Value

array

at line 135
SS_Limitable limit($length, $offset)

Get a sub-range of this dataobjectset as an array

Parameters

$length
$offset

Return Value

SS_Limitable

at line 151
add(mixed $item)

Add this $item into this list

Parameters

mixed $item

at line 160
remove(mixed $item)

Remove this item from this list

Parameters

mixed $item

at line 178
void; replace(array|object $item, array|object $with)

Replaces an item in this list with another item.

Parameters

array|object $item
array|object $with

Return Value

void;

at line 193
merge(array|object $with)

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

Parameters

array|object $with

at line 203
removeDuplicates(string $field = 'ID')

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

Parameters

string $field

at line 226
push(array|object $item)

Pushes an item onto the end of this list.

Parameters

array|object $item

at line 235
array|object pop()

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

Return Value

array|object

at line 244
unshift(array|object $item)

Add an item onto the beginning of the list.

Parameters

array|object $item

at line 253
array|object shift()

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

Return Value

array|object

at line 262
mixed first()

Returns the first item in the list

Return Value

mixed

at line 271
mixed last()

Returns the last item in the list

Return Value

mixed

at line 282
array map(string $keyfield = 'ID', string $titlefield = 'Title')

Returns a map of this list

Parameters

string $keyfield
string $titlefield

Return Value

array

at line 302
mixed find(string $key, mixed $value)

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

Parameters

string $key
mixed $value

Return Value

mixed

at line 316
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 332
bool canSortBy(string $by)

You can always sort a ArrayList

Parameters

string $by

Return Value

bool

at line 341
SS_Sortable reverse()

Reverses an {@link ArrayList}

Return Value

SS_Sortable

at line 398
SS_Sortable sort()

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

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

Return Value

SS_Sortable

See also

SS_List::sort()

at line 471
bool canFilterBy(string $by)

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

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

Parameters

string $by

Return Value

bool

at line 493
SS_Filterable filter()

Filter the list to include items with these charactaristics

Return Value

SS_Filterable

See also

SS_List::filter()

at line 535
DataList filterAny()

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

Return Value

DataList

at line 595
ArrayList byIDs(array $ids)

Filter this list to only contain the given Primary IDs

Parameters

array $ids Array of integers, will be automatically cast/escaped.

Return Value

ArrayList

at line 600
byID($id)

Parameters

$id

at line 617
SS_Filterable filterByCallback($callback)

Parameters

$callback

Return Value

SS_Filterable

See also

SS_Filterable::filterByCallback()

at line 646
SS_Filterable exclude()

Exclude the list to not contain items with these charactaristics

Return Value

SS_Filterable

See also

SS_List::exclude()

at line 687
bool offsetExists($offset)

Returns whether an item with $key exists

Parameters

$offset

Return Value

bool

at line 697
DataObject offsetGet($offset)

Returns item stored in list with index $key

Parameters

$offset

Return Value

DataObject

at line 707
offsetSet($offset, $value)

Set an item with the key in $key

Parameters

$offset
$value

at line 720
offsetUnset($offset)

Unset an item with the key in $key

Parameters

$offset