class PolymorphicHasManyList extends HasManyList (View source)

Represents a has_many list linked against a polymorphic relationship

Properties

static private array $extensions

An array of extension names and parameters to be applied to this object upon construction.

from  SS_Object
string $class from  SS_Object
static private array $casting

An array of objects to cast certain fields to. This is set up as an array in the format:

from  ViewableData
static private string $default_cast

The default object to cast scalar fields to if casting information is not specified, and casting to an object is required.

from  ViewableData

Methods

static Config_ForClass|null
config()

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

static SS_Object
create()

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

static SS_Object
singleton()

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

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

static 
parse_class_spec($classSpec)

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

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

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

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

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.

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

No description

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

No description

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

No description

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

No description

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

No description

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

No description

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

Return TRUE if a class has a specified extension.

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

Add an extension to a specific class.

static 
remove_extension(string $extension)

Remove an extension from a class.

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

No description

static 
get_extra_config_sources($class = null)

No description

__construct(string $dataClass, string $foreignField, string $foreignClass)

Create a new PolymorphicHasManyList relation list.

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

bool
hasMethod(string $method)

Return TRUE if a method exists on this object

array
allMethodNames(bool $custom = false)

Return the names of all the methods available on this object

stat($name, $uncached = false)

No description

set_stat($name, $value)

No description

uninherited($name)

No description

bool
exists()

Returns true if this DataList has items

from  DataList
string
parentClass()

No description

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

string
__toString()

No description

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

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

getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

bool
hasExtension(string $extension)

Returns TRUE if this object instance has a specific extension applied in {@link $extension_instances}. Extension instances are initialized at constructor time, meaning if you use {@link add_extension()} afterwards, the added extension will just be added to new instances of the extended class. Use the static method {@link has_extension()} to check if a class (not an instance) has a specific extension.

array
getExtensionInstances()

Get all extension instances for this specific object instance.

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

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

Clears the cache for the given cacheToFile call

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

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

from  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

from  DataList
string
dataClass()

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

from  DataList
__clone()

When cloning this object, clone the dataQuery object as well

from  DataList
dataQuery()

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

from  DataList
alterDataQuery($callback)

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

from  DataList
setDataQuery(DataQuery $dataQuery)

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

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

Returns a new DataList instance with the specified query parameter assigned

from  DataList
sql(array $parameters = array())

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

from  DataList
where(string|array|SQLConditionGroup $filter)

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

from  DataList
whereAny(string|array|SQLConditionGroup $filter)

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

from  DataList
bool
canSortBy(string $fieldName)

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

from  DataList
bool
canFilterBy(string $fieldName)

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

from  DataList
limit($limit, $offset = 0)

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

from  DataList
distinct(bool $value)

Return a new DataList instance with distinct records or not

from  DataList
sort()

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

from  DataList
filter()

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

from  DataList
addFilter(array $filterArray)

Return a new instance of the list with an added filter

from  DataList
filterAny()

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

from  DataList
filterByCallback($callback)

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

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

from  DataList
exclude()

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

from  DataList
subtract(SS_List $list)

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

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

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

from  DataList
array
toArray()

Return an array of the actual items that this DataList contains at this stage.

from  DataList
array
toNestedArray()

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

from  DataList
mixed
each(callable $callback)

Walks the list using the specified callback

from  DataList
debug()

No description

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

Returns a map of this list

from  DataList
int
count()

Return the number of items in this DataList

from  DataList
mixed
max(string $fieldName)

Return the maximum value of the given field in this DataList

from  DataList
mixed
min(string $fieldName)

Return the minimum value of the given field in this DataList

from  DataList
mixed
avg(string $fieldName)

Return the average value of the given field in this DataList

from  DataList
mixed
sum(string $fieldName)

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

from  DataList
mixed
first()

Returns the first item in this DataList

from  DataList
mixed
last()

Returns the last item in this DataList

from  DataList
mixed
find(string $key, mixed $value)

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

from  DataList
setQueriedColumns(array $queriedColumns)

Restrict the columns to fetch into this DataList

from  DataList
byIDs(array $ids)

Filter this list to only contain the given Primary IDs

from  DataList
byID(int $id)

Return the first DataObject with the given ID

from  DataList
array
column(string $colName = "ID")

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

from  DataList
setByIDList(array $idList)

Sets the ComponentSet to be the given ID list.

from  DataList
array
getIDList()

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

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

from  DataList
dbObject($fieldName)

No description

from  DataList
addMany(array $items)

Add a number of items to the component set.

from  DataList
removeMany(array $idList)

Remove the items from this list with the given IDs

from  DataList
removeByFilter(string $filter)

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

from  DataList
removeAll()

Remove every element in this DataList.

from  DataList
add(mixed $item)

Adds the item to this relation.

newObject($initialFields = null)

Return a new item to add to this DataList.

from  DataList
remove(mixed $item)

Remove an item from this relation.

removeByID(int $itemID)

Remove an item from this relation.

reverse()

Reverses a list of items.

from  DataList
push(mixed $item)

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

from  DataList
insertFirst(mixed $item)

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

from  DataList
shift()

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

from  DataList
replace()

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

from  DataList
merge()

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

from  DataList
removeDuplicates()

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

from  DataList
bool
offsetExists(mixed $key)

Returns whether an item with $key exists

from  DataList
offsetGet(mixed $key)

Returns item stored in list with index $key

from  DataList
offsetSet(mixed $key, mixed $value)

Set an item with the key in $key

from  DataList
offsetUnset(mixed $key)

Unset an item with the key in $key

from  DataList
string|null
getForeignID()

No description

forForeignID(int|array $id)

Returns a copy of this list with the ManyMany relationship linked to the given foreign ID.

string
getForeignKey()

Gets the field name which holds the related object ID.

string
getForeignClass()

Retrieve the name of the class this relation is filtered by

Details

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

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

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

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

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

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

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

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

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

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

deprecated

Parameters

$class
$name
$uncached

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

deprecated

Parameters

$class
$name
$value

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

deprecated

Parameters

$class
$name
$uncached

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

deprecated

Parameters

$class
$name
$ceiling

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

deprecated

Parameters

$class
$properties
$replace

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

deprecated

Parameters

$class
$name
$value
$replace

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

Return TRUE if a class has a specified extension.

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

Parameters

string $classOrExtension

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

bool $strict

if the extension has to match the required extension and not be a subclass

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

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

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.

static get_extra_config_sources($class = null)

Parameters

$class

__construct(string $dataClass, string $foreignField, string $foreignClass)

Create a new PolymorphicHasManyList relation list.

Parameters

string $dataClass
  • The DataObject class to query.
string $foreignField

The name of the composite foreign relation field. Used to generate the ID and Class foreign keys.

string $foreignClass

Name of the class filter this relation is filtered against

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

bool hasMethod(string $method)

Return TRUE if a method exists on this object

This should be used rather than PHP's inbuild method_exists() as it takes into account methods added via extensions

Parameters

string $method

Return Value

bool

array allMethodNames(bool $custom = false)

Return the names of all the methods available on this object

Parameters

bool $custom

include methods added dynamically at runtime

Return Value

array

stat($name, $uncached = false)

Parameters

$name
$uncached

See also

SS_Object::get_static

set_stat($name, $value)

Parameters

$name
$value

See also

SS_Object::set_static

uninherited($name)

Parameters

$name

See also

SS_Object::uninherited_static

bool exists()

Returns true if this DataList has items

Return Value

bool

string parentClass()

Return Value

string

this classes parent class

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

string __toString()

Return Value

string

the class name

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

array extend(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = null)

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

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

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

Parameters

string $method

the name of the method to call on each extension

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

Return Value

array

Extension getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

Parameters

string $extension

Return Value

Extension

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

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.

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

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

Clears the cache for the given cacheToFile call

Parameters

$method
$ID
$arguments

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

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

bool __isset(string $property)

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

Parameters

string $property

Return Value

bool

mixed __get(string $property)

Get the value of a property/field on this object. This will check if a method called get{$property} exists, then check if a field is available using {@link ViewableData::getField()}, then fall back on a failover object.

Parameters

string $property

Return Value

mixed

__set(string $property, mixed $value)

Set a property/field on this object. This will check for the existence of a method called set{$property}, then use the {@link ViewableData::setField()} method.

Parameters

string $property
mixed $value

setFailover(ViewableData $failover)

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

Parameters

ViewableData $failover

ViewableData|null getFailover()

Get the current failover object if set

Return Value

ViewableData|null

bool hasField(string $field)

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

Parameters

string $field

Return Value

bool

mixed getField(string $field)

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

Parameters

string $field

Return Value

mixed

setField(string $field, mixed $value)

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

Parameters

string $field
mixed $value

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, string $identifier = null)

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

Parameters

$method
$args
string $identifier

an optional custom cache identifier

Return Value

unknown

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

ViewableData getCustomisedObj()

Return Value

ViewableData

setCustomisedObj(ViewableData $object)

Parameters

ViewableData $object

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

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

string castingClass(string $field)

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

Parameters

string $field

Return Value

string

string escapeTypeForField(string $field)

Return the string-format type for the given field.

Parameters

string $field

Return Value

string

'xml'|'raw'

buildCastingCache(reference $cache)

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

Parameters

reference $cache

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

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

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

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

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

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

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

Parameters

$field
$arguments
$cache

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

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

Parameters

$field
$arguments
$cache

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

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

Parameters

$field
$arguments
$cache

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

array getXMLValues($fields)

Get an array of XML-escaped values by field name

Parameters

$fields

Return Value

array

ArrayIterator getIterator()

Returns an Iterator for this DataList.

This function allows you to use DataLists in foreach loops

Return Value

ArrayIterator

ViewableData Me()

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

Return Value

ViewableData

string ThemeDir(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

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

ViewableData_Debugger Debug()

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

Return Value

ViewableData_Debugger

setDataModel(DataModel $model)

Set the DataModel

Parameters

DataModel $model

string dataClass()

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

Return Value

string

__clone()

When cloning this object, clone the dataQuery object as well

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

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

DataList setDataQuery(DataQuery $dataQuery)

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

Parameters

DataQuery $dataQuery

Return Value

DataList

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

sql(array $parameters = array())

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

Parameters

array $parameters

Out variable for parameters required for this query

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

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

bool canSortBy(string $fieldName)

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

Parameters

string $fieldName

Return Value

bool

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

SS_Limitable limit($limit, $offset = 0)

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

Parameters

$limit
$offset

Return Value

SS_Limitable

distinct(bool $value)

Return a new DataList instance with distinct records or not

Parameters

bool $value

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

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

addFilter(array $filterArray)

Return a new instance of the list with an added filter

Parameters

array $filterArray

DataList filterAny()

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

Return Value

DataList

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

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

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

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

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

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

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

array toNestedArray()

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

Return Value

array

mixed each(callable $callback)

Walks the list using the specified callback

Parameters

callable $callback

Return Value

mixed

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

int count()

Return the number of items in this DataList

Return Value

int

mixed max(string $fieldName)

Return the maximum value of the given field in this DataList

Parameters

string $fieldName

Return Value

mixed

mixed min(string $fieldName)

Return the minimum value of the given field in this DataList

Parameters

string $fieldName

Return Value

mixed

mixed avg(string $fieldName)

Return the average value of the given field in this DataList

Parameters

string $fieldName

Return Value

mixed

mixed sum(string $fieldName)

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

Parameters

string $fieldName

Return Value

mixed

mixed first()

Returns the first item in this DataList

Return Value

mixed

mixed last()

Returns the last item in this DataList

@return DataObject

Return Value

mixed

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

DataList setQueriedColumns(array $queriedColumns)

Restrict the columns to fetch into this DataList

Parameters

array $queriedColumns

Return Value

DataList

DataList byIDs(array $ids)

Filter this list to only contain the given Primary IDs

Parameters

array $ids

Array of integers

Return Value

DataList

DataObject byID(int $id)

Return the first DataObject with the given ID

Parameters

int $id

Return Value

DataObject

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

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.

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

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

dbObject($fieldName)

Parameters

$fieldName

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

DataList removeMany(array $idList)

Remove the items from this list with the given IDs

Parameters

array $idList

Return Value

DataList

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

DataList removeAll()

Remove every element in this DataList.

Return Value

DataList

add(mixed $item)

Adds the item to this relation.

It does so by setting the relationFilters.

Parameters

mixed $item

newObject($initialFields = null)

Return a new item to add to this DataList.

Parameters

$initialFields

remove(mixed $item)

Remove an item from this relation.

Doesn't actually remove the item, it just clears the foreign key value.

Parameters

mixed $item

removeByID(int $itemID)

Remove an item from this relation.

Doesn't actually remove the item, it just clears the foreign key value.

Parameters

int $itemID
  • The primary ID

SS_Sortable reverse()

Reverses a list of items.

Return Value

SS_Sortable

push(mixed $item)

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

Parameters

mixed $item

insertFirst(mixed $item)

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

Parameters

mixed $item

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

Parameters

mixed $key

Return Value

bool

DataObject offsetGet(mixed $key)

Returns item stored in list with index $key

Parameters

mixed $key

Return Value

DataObject

offsetSet(mixed $key, mixed $value)

Set an item with the key in $key

Parameters

mixed $key
mixed $value

offsetUnset(mixed $key)

Unset an item with the key in $key

Parameters

mixed $key

string|null getForeignID()

Return Value

string|null

DataList forForeignID(int|array $id)

Returns a copy of this list with the ManyMany relationship linked to the given foreign ID.

Parameters

int|array $id

An ID or an array of IDs.

Return Value

DataList

string getForeignKey()

Gets the field name which holds the related object ID.

Return Value

string

string getForeignClass()

Retrieve the name of the class this relation is filtered by

Return Value

string