FieldList

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

You can add extra methods to a class using {@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

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.

Note: This will not remove extensions from parent classes, and must be called directly on the class assigned the extension.

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

Get extra config sources for this 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))

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

This method also provides lazy-population of the extension_instances property.

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

This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.

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

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

Get inherited config value

Gets the uninherited value for the given config option

Update the config value for a given property

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

Note that, unlike the core isset() implementation, this will return true if the property is defined and set to null.

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

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.

Returns true if this list has items

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

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

Return the string-format type for the given field.

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

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

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.

Get an array of XML-escaped values by field name

Find appropriate templates for SSViewer to use to render this object

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

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

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

Hint this list to a specific type

Return the number of items in this list

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

Walks the list using the specified callback

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

Get a sub-range of this dataobjectset as an array

Add this $item into this list

Remove this item from this list

Replaces an item in this list with another item.

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

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

Push a single field onto the end of this FieldList instance.

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

Push a single field onto the beginning of this FieldList instance.

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

Returns the first item in the list

Returns the last item in the list

Returns a map of this list

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

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

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

You can always sort a ArrayList

Reverses an {@link ArrayList}

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

Shuffle the items in this array list

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.

Filter the list to include items with these charactaristics

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

Filter this list to only contain the given Primary IDs

Return the first item with the given ID

Exclude the list to not contain items with these charactaristics

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

Iterate over each field in the current list recursively

Return a flattened list of all fields

Return a sequential set of all fields that have data. This excludes wrapper composite fields as well as heading / help text fields.

Return array of all field names

Add an extra field to a tab within this FieldList.

This is most commonly used when overloading getCMSFields()

Add a number of extra fields to a tab within this FieldList.

This is most commonly used when overloading getCMSFields()

Remove the given field from the given tab in the field.

Removes a number of fields from a Tab/TabSet within this FieldList.

Remove a field or fields from this FieldList by Name.

The field could also be inside a CompositeField.

Replace a single field with another. Ignores dataless fields such as Tabs and TabSets

Rename the title of a particular field name in this set.

Returns the specified tab object, if it exists

Returns the specified tab object, creating it if necessary.

Returns a named field.

You can use dot syntax to get fields from child composite fields

Returns a named field in a sequential set.

Use this if you're using nested FormFields.

Inserts a field before a particular field in a FieldList.

Will traverse CompositeFields depth-first to find the maching $name, and insert before the first match

Inserts a field after a particular field in a FieldList.

Will traverse CompositeFields depth-first to find the maching $name, and insert after the first match

Set the Form instance for this FieldList.

Load the given data into this form.

Return all fields in a form - including fields nested in {@link CompositeFields}.

Useful when doing custom field layouts.

Return all fields except for the hidden fields.

Useful when making your own simplified form layouts.

Transform this FieldList with a given tranform method, e.g. $this->transform(new ReadonlyTransformation())

Returns the root field set that this belongs to

Transforms this FieldList instance to readonly.

Transform the named field into a readonly field.

Change the order of fields in this FieldList by specifying an ordered list of field names.

This works well in conjunction with SilverStripe's scaffolding functions: take the scaffold, and shuffle the fields around to the order that you want.

Please note that any tabs or other dataless fields will be clobbered by this operation.

Find the numerical position of a field within the children collection. Doesn't work recursively.

Default template rendering of a FieldList will concatenate all FieldHolder values.