RelationList

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

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

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

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.

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

Returns a 2-elemnent array, with classname and arguments

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

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

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

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.

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

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

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.

Create a new DataList.

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

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

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

Return the names of all the methods available on this object

Returns true if this DataList has items

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

Calls a method if available on both this object and all applied {@link Extensions}, and then attempts to merge all results into an array

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

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

Get an extension instance attached to this object by name.

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

Caution: Don't use singleton()->hasExtension() as it will give you inconsistent results based on when the singleton was first accessed.

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

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

Clears the cache for the given cacheToFile call

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

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.

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

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

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

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

Get the current failover object if set

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

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

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

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

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

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.

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

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

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

Return the string-format type for the given field.

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

Render this object into the template, and get the result as a string. You can pass one of the following as the $template parameter:

• a template name (e.g. Page)
• an array of possible template names - the first valid one will be used
• an SSViewer instance

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

A simple wrapper around {@link ViewableData::obj()} that automatically caches the result so it can be used again without re-running the method.

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

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

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

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

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

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

Get an array of XML-escaped values by field name

Returns an Iterator for this DataList.

This function allows you to use DataLists in foreach loops

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

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.

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

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

Set the DataModel

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

When cloning this object, clone the dataQuery object as well

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

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

Returns a new DataList instance with the specified query parameter assigned

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

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

Supports parameterised queries. See SQLQuery::addWhere() for syntax examples, although DataList won't expand multiple method arguments as SQLQuery does.

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.

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

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

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

Return a new DataList instance with distinct records or not

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

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

Return a new instance of the list with an added filter

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

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

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.

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

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

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

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

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

This is when the query is actually executed.

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

Walks the list using the specified callback

Returns a map of this list

Return the number of items in this DataList

Return the maximum value of the given field in this DataList

Return the minimum value of the given field in this DataList

Return the average value of the given field in this DataList

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

Returns the first item in this DataList

Returns the last item in this DataList

@return DataObject

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

Restrict the columns to fetch into this DataList

Filter this list to only contain the given Primary IDs

Return the first DataObject with the given ID

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

Sets the ComponentSet to be the given ID list.

Records will be added and deleted as appropriate.

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.

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

Add a number of items to the component set.

Remove the items from this list with the given IDs

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

Remove every element in this DataList.

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

Return a new item to add to this DataList.

Remove this item by deleting it

Remove an item from this DataList by ID

Reverses a list of items.

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

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

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

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

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

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

Returns whether an item with $key exists

Returns item stored in list with index $key

Set an item with the key in $key

Unset an item with the key in $key

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