class FieldList extends ArrayList (View source)

A list designed to hold form field instances.

Traits

Allows an object to have extensions applied to it.

A class that can be instantiated or replaced via DI

Provides extensions to this object to integrate it with standard config API methods.

Allows an object to declare a set of custom methods

Config options

extensions array

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

from  Extensible
unextendable_classes array

Classes that cannot be extended

from  Extensible
casting array

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

from  ViewableData
default_cast string

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

from  ViewableData
casting_cache array from  ViewableData

Properties

protected static array $extra_methods

Custom method sources

from  CustomMethods
protected array $extra_method_registers

Name of methods to invoke by defineMethods for this instance

from  CustomMethods
protected static array $built_in_methods

Non-custom methods

from  CustomMethods
protected Extension[] $extension_instances from  Extensible
protected callable[][] $beforeExtendCallbacks

List of callbacks to call prior to extensions having extend called on them, each grouped by methodName.

from  Extensible
protected callable[][] $afterExtendCallbacks

List of callbacks to call after extensions having extend called on them, each grouped by methodName.

from  Extensible
protected ViewableData $failover

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

from  ViewableData
protected ViewableData $customisedObject from  ViewableData
protected array $items

Holds the items in the list

from  ArrayList
protected string $dataClass

Underlying type class for this list

from  ArrayList
protected FormField[] $sequentialSet

Cached flat representation of all fields in this set, including fields nested in CompositeFields.

protected FormField[] $sequentialSaveableSet
protected CompositeField $containerField

If this fieldlist is owned by a parent field (e.g. CompositeField) this is the parent field.

Methods

public
mixed
__call(string $method, array $arguments)

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

protected
defineMethods()

Adds any methods from Extension instances attached to this object.

protected
registerExtraMethodCallback(string $name, callable $callback)

Register an callback to invoke that defines extra methods

public
bool
hasMethod(string $method)

Return TRUE if a method exists on this object

protected
array
getExtraMethodConfig(string $method)

Get meta-data details on a named method

public
array
allMethodNames(bool $custom = false)

Return the names of all the methods available on this object

protected
array
findMethodsFromExtension(object $extension) deprecated

No description

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

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

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

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

protected
addWrapperMethod(string $method, string $wrap)

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

protected
addCallbackMethod(string $method, callable $callback)

Add callback as a method.

protected
beforeExtending(string $method, callable $callback)

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

protected
afterExtending(string $method, callable $callback)

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

protected
constructExtensions() deprecated

No description

protected
defineExtensionMethods()

Adds any methods from Extension instances attached to this object.

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

Add an extension to a specific class.

public static 
remove_extension(string $extension)

Remove an extension from a class.

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

No description

public static 
array|null
get_extra_config_sources(string $class = null)

Get extra config sources for this class

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

Return TRUE if a class has a specified extension.

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

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

public
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

public
Extension|null
getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

public
bool
hasExtension(string $extension)

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

public
getExtensionInstances()

Get all extension instances for this specific object instance.

public static 
create(mixed ...$args)

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

public static 
singleton(string $class = null)

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

public static 
config()

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

public
mixed
stat(string $name) deprecated

Get inherited config value

public
mixed
uninherited(string $name)

Gets the uninherited value for the given config option

public
$this
set_stat(string $name, mixed $value) deprecated

Update the config value for a given property

public
__construct(array $items = [])

No description

public
bool
__isset(string $property)

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

public
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 ViewableData::getField(), then fall back on a failover object.

public
__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 ViewableData::setField() method.

public
setFailover(ViewableData $failover)

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

public
getFailover()

Get the current failover object if set

public
bool
hasField(string $field)

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

public
mixed
getField(string $field)

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

public
$this
setField(string $field, mixed $value)

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

public
customise(array|ViewableData $data)

Merge some arbitrary data in with this object. This method returns a ViewableData_Customised instance with references to both this and the new custom data.

public
bool
exists()

Returns true if this list has items

public
string
__toString()

No description

public
getCustomisedObj()

No description

public
setCustomisedObj(ViewableData $object)

No description

public
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. This helper will be a subclass of DBField.

public
string
castingClass(string $field)

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

public
string
escapeTypeForField(string $field)

Return the string-format type for the given field.

public
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

protected
string
objCacheName(string $fieldName, array $arguments)

Generate the cache name for a field

protected
mixed
objCacheGet(string $key)

Get a cached value from the field cache

protected
$this
objCacheSet(string $key, mixed $value)

Store a value in the field cache

protected
$this
objCacheClear()

Clear object cache

public
object|DBField
obj(string $fieldName, array $arguments = [], 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.

public
object|DBField
cachedCall(string $field, array $arguments = [], string $identifier = null)

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

public
bool
hasValue(string $field, array $arguments = [], 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.

public
string
XML_val(string $field, array $arguments = [], bool $cache = false)

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

public
array
getXMLValues(array $fields)

Get an array of XML-escaped values by field name

FormField[]
getIterator()

No description

public
array
getViewerTemplates(string $suffix = '')

Find appropriate templates for SSViewer to use to render this object

public
Me()

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

public
string
ThemeDir() deprecated

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

public
string
CSSClasses(string $stopAtClass = self::class)

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

public
Debug()

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

public
string
dataClass()

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

public
$this
setDataClass(string $class)

Hint this list to a specific type

public
int
count()

Return the number of items in this list

public
array
toArray()

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

public
$this
each(callable $callback)

Walks the list using the specified callback

public
debug()

No description

public
array
toNestedArray()

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

public
limit(int|null $length, int $offset = 0)

Get a sub-range of this dataobjectset as an array Pass null to "remove the limit" - this is for consistency with DataList::limit(null) which itself will call SQLSelect::setLimit(null)

public
add(mixed $item)

Add this $item into this list

public
remove(mixed $item)

Remove this item from this list

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

Replaces an item in this list with another item.

public
merge(array|object $with)

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

public
$this
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.

public
push(array|object $item)

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

public
array|object
pop()

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

public
unshift(array|object $item)

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

public
array|object
shift()

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

public
mixed
first()

Returns the first item in the list

public
mixed
last()

Returns the last item in the list

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

Returns a map of this list

public
mixed
find(string $key, mixed $value)

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

public
array
column(string $colName = 'ID')

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

public
array
columnUnique(string $colName = 'ID')

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

public
bool
canSortBy(string $by)

You can always sort a ArrayList

public
reverse()

Reverses an ArrayList

protected
array
parseSortColumn(string $column, mixed $direction = null)

Parses a specified column into a sort field and direction

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

public
$this
shuffle()

Shuffle the items in this array list

public
bool
canFilterBy(string $by)

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

public
filter()

Filter the list to include items with these characteristics

public
filterAny()

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

protected
array
normaliseFilterArgs($column, $value = null)

Take the "standard" arguments that the filter/exclude functions take and return a single array with 'colum' => 'value'

public
byIDs(array $ids)

Filter this list to only contain the given Primary IDs

public
mixed
byID(int $id)

Return the first item with the given ID

public
filterByCallback(callable $callback)

No description

public
exclude()

Exclude the list to not contain items with these characteristics

protected
shouldExclude($item, $args)

No description

public
bool
offsetExists(mixed $offset)

Returns whether an item with $key exists

public
offsetGet(mixed $offset)

Returns item stored in list with index $key

public
offsetSet(mixed $offset, mixed $value)

Set an item with the key in $key

public
offsetUnset(mixed $offset)

Unset an item with the key in $key

protected
mixed
extractValue(array|object $item, string $key)

Extracts a value from an item in the list, where the item is either an object or array.

public
__clone()

No description

public
recursiveWalk(callable $callback)

Iterate over each field in the current list recursively

public
flattenFields()

Return a flattened list of all fields

public
dataFields()

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

public
saveableFields()

No description

public
array
dataFieldNames()

Return array of all field names

protected
fieldNameError(FormField $field, $functionName)

Trigger an error for duplicate field names

protected
flushFieldsCache()

No description

protected
collateDataFields($list, bool $saveableOnly = false) deprecated

No description

public
$this
addFieldToTab(string $tabName, FormField $field, string $insertBefore = null)

Add an extra field to a tab within this FieldList.

public
$this
addFieldsToTab(string $tabName, array $fields, string $insertBefore = null)

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

public
$this
removeFieldFromTab(string $tabName, string $fieldName)

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

public
$this
removeFieldsFromTab(string $tabName, array $fields)

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

public
$this
removeByName(string|array $fieldName, bool $dataFieldOnly = false)

Remove a field or fields from this FieldList by Name.

public
bool
replaceField(string $fieldName, FormField $newField, bool $dataFieldOnly = true)

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

public
bool
renameField(string $fieldName, string $newFieldTitle)

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

public
bool
hasTabSet()

No description

public
Tab|null
findTab(string $tabName)

Returns the specified tab object, if it exists

public
Tab
findOrMakeTab(string $tabName, string $title = null)

Returns the specified tab object, creating it if necessary.

public
FormField|null
fieldByName(string $name)

Returns a named field.

public
FormField|null
dataFieldByName(string $name)

Returns a named field in a sequential set.

public
FormField|false
insertBefore(string $name, FormField $item, bool $appendIfMissing = true)

Inserts a field before a particular field in a FieldList.

public
FormField|false
insertAfter(string $name, FormField $item, bool $appendIfMissing = true)

Inserts a field after a particular field in a FieldList.

protected
onBeforeInsert(FormField $item)

Handler method called before the FieldList is going to be manipulated.

public
$this
setForm(Form $form)

Set the Form instance for this FieldList.

public
$this
setValues(array $data)

Load the given data into this form.

public
HiddenFields()

Return all fields in a form - including fields nested in CompositeFields.

public
VisibleFields()

Return all fields except for the hidden fields.

public
transform(FormTransformation $trans)

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

public
rootFieldList()

Returns the root field set that this belongs to

public
getContainerField()

No description

public
$this
setContainerField(CompositeField|null $field)

No description

public
makeReadonly()

Transforms this FieldList instance to readonly.

public
makeFieldReadonly(string|array|FormField $field)

Transform the named field into a readonly field.

public
changeFieldOrder(array $fieldNames)

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

public
int
fieldPosition(string|FormField $field)

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

public
forTemplate()

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

Details

mixed __call(string $method, array $arguments)

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 Extensions}, {@link Object::createMethod() or Object::addWrapperMethod()

Parameters

string $method
array $arguments

Return Value

mixed

Exceptions

BadMethodCallException

protected defineMethods()

Adds any methods from Extension instances attached to this object.

All these methods can then be called directly on the instance (transparently mapped through __call()}), or called explicitly through {@link extend().

protected registerExtraMethodCallback(string $name, callable $callback)

Register an callback to invoke that defines extra methods

Parameters

string $name
callable $callback

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

protected array getExtraMethodConfig(string $method)

Get meta-data details on a named method

Parameters

string $method

Return Value

array

List of custom method details, if defined for this method

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

protected array findMethodsFromExtension(object $extension) deprecated

deprecated 4.13.0 Will be replaced by findMethodsFrom() in CMS 5

No description

Parameters

object $extension

Return Value

array

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

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

Parameters

string $property

the property name

string|int $index

an index to use if the property is an array

Exceptions

InvalidArgumentException

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

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

Parameters

string $property

the property name

string|int $index

an index to use if the property is an array

protected addWrapperMethod(string $method, string $wrap)

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

Parameters

string $method

the method name to wrap

string $wrap

the method name to wrap to

protected addCallbackMethod(string $method, callable $callback)

Add callback as a method.

Parameters

string $method

Name of method

callable $callback

Callback to invoke. Note: $this is passed as first parameter to this callback and then $args as array

protected beforeExtending(string $method, callable $callback)

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

Parameters

string $method

The name of the method to hook into

callable $callback

The callback to execute

protected afterExtending(string $method, callable $callback)

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

Parameters

string $method

The name of the method to hook into

callable $callback

The callback to execute

protected constructExtensions() deprecated

deprecated 4.0.0:5.0.0 Extensions and methods are now lazy-loaded

No description

protected defineExtensionMethods()

Adds any methods from Extension instances attached to this object.

All these methods can then be called directly on the instance (transparently mapped through __call()}), or called explicitly through {@link extend().

static bool 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 Object::$extensions array. See 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 singleton()).

Parameters

string $classOrExtension

Class that should be extended - has to be a subclass of Object

string $extension

Subclass of Extension with optional parameters as a string, e.g. "Versioned" or "Translatable('Param')"

Return Value

bool

Flag if the extension was added

See also

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

static remove_extension(string $extension)

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 Object instances which are already created, but will have an effect on new extensions. Clears any previously created singletons through singleton() to avoid side-effects from stale extension information.

Add support for removing extensions with parameters

Parameters

string $extension

class name of an Extension subclass, without parameters

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

No description

Parameters

string $class

If omitted, will get extensions for the current 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 DataExtension class names, or eval'ed class name strings with constructor arguments.

static array|null get_extra_config_sources(string $class = null)

Get extra config sources for this class

Parameters

string $class

Name of class. If left null will return for the current class

Return Value

array|null

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

Class to check extension for, or the extension name to check if the second argument is null.

string $requiredExtension

If the first argument is the parent class, this is the extension to check. If left null, the first parameter will be treated as the extension.

bool $strict

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

Return Value

bool

Flag if the extension exists

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

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

Parameters

string $method

the method name to call

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

Return Value

array

List of results with nulls filtered out

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 __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|null getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

Parameters

string $extension

Return Value

Extension|null

bool hasExtension(string $extension)

Returns TRUE if this object instance has a specific extension applied in $extension_instances. Extension instances are initialized at constructor time, meaning if you use add_extension() afterwards, the added extension will just be added to new instances of the extended class. Use the static method 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 Extension subclass without parameters

Return Value

bool

Extension[] getExtensionInstances()

Get all extension instances for this specific object instance.

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

Return Value

Extension[]

Map of DataExtension instances, keyed by classname.

static Injectable create(mixed ...$args)

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::class); $list = SiteTree::get();

Parameters

mixed ...$args

Return Value

Injectable

static Injectable singleton(string $class = null)

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

Parameters

string $class

Optional classname to create, if the called class should not be used

Return Value

Injectable

The singleton instance

static Config_ForClass config()

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

Return Value

Config_ForClass

mixed stat(string $name) deprecated

deprecated 5.0 Use ->config()->get() instead

Get inherited config value

Parameters

string $name

Return Value

mixed

mixed uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

$this set_stat(string $name, mixed $value) deprecated

deprecated 5.0 Use ->config()->set() instead

Update the config value for a given property

Parameters

string $name
mixed $value

Return Value

$this

__construct(array $items = [])

No description

Parameters

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

bool __isset(string $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.

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

$this setField(string $field, mixed $value)

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

Parameters

string $field
mixed $value

Return Value

$this

ViewableData_Customised customise(array|ViewableData $data)

Merge some arbitrary data in with this object. This method returns a 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

bool exists()

Returns true if this list has items

Return Value

bool

string __toString()

No description

Return Value

string

the class name

ViewableData getCustomisedObj()

No description

Return Value

ViewableData

setCustomisedObj(ViewableData $object)

No description

Parameters

ViewableData $object

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. This helper will be a subclass of DBField.

Parameters

string $field

Return Value

string

Casting helper As a constructor pattern, and may include arguments.

Exceptions

Exception

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'

DBHTMLText 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

DBHTMLText

protected string objCacheName(string $fieldName, array $arguments)

Generate the cache name for a field

Parameters

string $fieldName

Name of field

array $arguments

List of optional arguments given

Return Value

string

protected mixed objCacheGet(string $key)

Get a cached value from the field cache

Parameters

string $key

Cache key

Return Value

mixed

protected $this objCacheSet(string $key, mixed $value)

Store a value in the field cache

Parameters

string $key

Cache key

mixed $value

Return Value

$this

protected $this objCacheClear()

Clear object cache

Return Value

$this

object|DBField obj(string $fieldName, array $arguments = [], 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 $cache

Cache this object

string $cacheName

a custom cache name

Return Value

object|DBField

object|DBField cachedCall(string $field, array $arguments = [], string $identifier = null)

A simple wrapper around 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

Return Value

object|DBField

bool hasValue(string $field, array $arguments = [], 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

string XML_val(string $field, array $arguments = [], bool $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

string $field
array $arguments
bool $cache

Return Value

string

array getXMLValues(array $fields)

Get an array of XML-escaped values by field name

Parameters

array $fields

an array of field names

Return Value

array

FormField[] getIterator()

No description

Return Value

FormField[]

array getViewerTemplates(string $suffix = '')

Find appropriate templates for SSViewer to use to render this object

Parameters

string $suffix

Return Value

array

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

deprecated 4.0.1 Use ModuleResourceLoader::resourcePath() or ModuleResourceLoader::resourceURL() instead

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.

Return Value

string

URL to the current theme

string CSSClasses(string $stopAtClass = self::class)

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

string dataClass()

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

Return Value

string

$this setDataClass(string $class)

Hint this list to a specific type

Parameters

string $class

Return Value

$this

int count()

Return the number of items in this list

Return Value

int

array toArray()

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

Return Value

array

$this each(callable $callback)

Walks the list using the specified callback

Parameters

callable $callback

Return Value

$this

debug()

No description

array toNestedArray()

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

Return Value

array

Limitable limit(int|null $length, int $offset = 0)

Get a sub-range of this dataobjectset as an array Pass null to "remove the limit" - this is for consistency with DataList::limit(null) which itself will call SQLSelect::setLimit(null)

Parameters

int|null $length
int $offset

Return Value

Limitable

add(mixed $item)

Add this $item into this list

Parameters

mixed $item

remove(mixed $item)

Remove this item from this list

Parameters

mixed $item

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

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

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

Return Value

$this

push(array|object $item)

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

Parameters

array|object $item

array|object pop()

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

Return Value

array|object

unshift(array|object $item)

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

Parameters

array|object $item

array|object shift()

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

Return Value

array|object

mixed first()

Returns the first item in the list

Return Value

mixed

mixed last()

Returns the last item in the list

Return Value

mixed

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

Returns a map of this list

Parameters

string $keyfield
string $titlefield

Return Value

Map

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

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

array columnUnique(string $colName = 'ID')

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

Parameters

string $colName

Return Value

array

bool canSortBy(string $by)

You can always sort a ArrayList

Parameters

string $by

Return Value

bool

Sortable reverse()

Reverses an ArrayList

Return Value

Sortable

protected array parseSortColumn(string $column, mixed $direction = null)

Parses a specified column into a sort field and direction

Parameters

string $column

String to parse containing the column name

mixed $direction

Optional Additional argument which may contain the direction

Return Value

array

Sort specification in the form array("Column", SORT_ASC).

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

Sortable

See also

\SilverStripe\ORM\SS_List::sort()

Examples

$list->sort('Name'); // default ASC sorting
$list->sort('Name DESC'); // DESC sorting
$list->sort('Name', 'ASC');
$list->sort(array('Name'=>'ASC,'Age'=>'DESC'));

$this shuffle()

Shuffle the items in this array list

Return Value

$this

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

Filterable filter()

Filter the list to include items with these characteristics

Return Value

Filterable

See also

Filterable::filter

Examples

$list->filter('Name', 'bob'); // only bob in the list
$list->filter('Name', array('aziz', 'bob'); // aziz and bob in list
$list->filter(array('Name'=>'bob, 'Age'=>21)); // bob with the Age 21 in list
$list->filter(array('Name'=>'bob, 'Age'=>array(21, 43))); // bob with the Age 21 or 43
$list->filter(array('Name'=>array('aziz','bob'), 'Age'=>array(21, 43)));
// aziz with the age 21 or 43 and bob with the Age 21 or 43

Filterable filterAny()

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

Return Value

Filterable

Examples

// only bob in the list
$list = $list->filterAny('Name', 'bob');
// azis or bob in the list
$list = $list->filterAny('Name', array('aziz', 'bob');
// bob or anyone aged 21 in the list
$list = $list->filterAny(array('Name'=>'bob, 'Age'=>21));
// bob or anyone aged 21 or 43 in the list
$list = $list->filterAny(array('Name'=>'bob, 'Age'=>array(21, 43)));
// all bobs, phils or anyone aged 21 or 43 in the list
$list = $list->filterAny(array('Name'=>array('bob','phil'), 'Age'=>array(21, 43)));

protected array normaliseFilterArgs($column, $value = null)

Take the "standard" arguments that the filter/exclude functions take and return a single array with 'colum' => 'value'

Parameters

$column

array|string The column name to filter OR an assosicative array of column => value

$value

array|string|null The values to filter the $column against

Return Value

array

The normalised keyed array

SS_List byIDs(array $ids)

Filter this list to only contain the given Primary IDs

Parameters

array $ids

Array of integers

Return Value

SS_List

mixed byID(int $id)

Return the first item with the given ID

Parameters

int $id

Return Value

mixed

Filterable filterByCallback(callable $callback)

No description

Parameters

callable $callback

Return Value

Filterable

See also

Filterable::filterByCallback

Examples

$list = $list->filterByCallback(function($item, $list) { return $item->Age == 9; })

Filterable exclude()

Exclude the list to not contain items with these characteristics

Return Value

Filterable

See also

\SilverStripe\ORM\SS_List::exclude()

Examples

$list->exclude('Name', 'bob'); // exclude bob from list
$list->exclude('Name', array('aziz', 'bob'); // exclude aziz and bob from list
$list->exclude(array('Name'=>'bob, 'Age'=>21)); // exclude bob that has Age 21
$list->exclude(array('Name'=>'bob, 'Age'=>array(21, 43))); // exclude bob with Age 21 or 43
$list->exclude(array('Name'=>array('bob','phil'), 'Age'=>array(21, 43)));
// bob age 21 or 43, phil age 21 or 43 would be excluded

protected shouldExclude($item, $args)

No description

Parameters

$item
$args

bool offsetExists(mixed $offset)

Returns whether an item with $key exists

Parameters

mixed $offset

Return Value

bool

DataObject offsetGet(mixed $offset)

Returns item stored in list with index $key

Parameters

mixed $offset

Return Value

DataObject

offsetSet(mixed $offset, mixed $value)

Set an item with the key in $key

Parameters

mixed $offset
mixed $value

offsetUnset(mixed $offset)

Unset an item with the key in $key

Parameters

mixed $offset

protected mixed extractValue(array|object $item, string $key)

Extracts a value from an item in the list, where the item is either an object or array.

Parameters

array|object $item
string $key

Return Value

mixed

__clone()

No description

recursiveWalk(callable $callback)

Iterate over each field in the current list recursively

Parameters

callable $callback

FieldList flattenFields()

Return a flattened list of all fields

Return Value

FieldList

FormField[] dataFields()

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

Return Value

FormField[]

FormField[] saveableFields()

No description

Return Value

FormField[]

array dataFieldNames()

Return array of all field names

Return Value

array

protected fieldNameError(FormField $field, $functionName)

Trigger an error for duplicate field names

Parameters

FormField $field
$functionName

protected flushFieldsCache()

No description

protected collateDataFields($list, bool $saveableOnly = false) deprecated

deprecated 4.1.0 Please use dataFields or saveableFields instead

No description

Parameters

$list
bool $saveableOnly

$this addFieldToTab(string $tabName, FormField $field, string $insertBefore = null)

Add an extra field to a tab within this FieldList.

This is most commonly used when overloading getCMSFields()

Parameters

string $tabName

The name of the tab or tabset. Subtabs can be referred to as TabSet.Tab or TabSet.Tab.Subtab. This function will create any missing tabs.

FormField $field

The FormField object to add to the end of that tab.

string $insertBefore

The name of the field to insert before. Optional.

Return Value

$this

$this addFieldsToTab(string $tabName, array $fields, string $insertBefore = null)

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

This is most commonly used when overloading getCMSFields()

Parameters

string $tabName

The name of the tab or tabset. Subtabs can be referred to as TabSet.Tab or TabSet.Tab.Subtab. This function will create any missing tabs.

array $fields

An array of FormField objects.

string $insertBefore

Name of field to insert before

Return Value

$this

$this removeFieldFromTab(string $tabName, string $fieldName)

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

Parameters

string $tabName

The name of the tab

string $fieldName

The name of the field

Return Value

$this

$this removeFieldsFromTab(string $tabName, array $fields)

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

Parameters

string $tabName

The name of the Tab or TabSet field

array $fields

A list of fields, e.g. array('Name', 'Email')

Return Value

$this

$this removeByName(string|array $fieldName, bool $dataFieldOnly = false)

Remove a field or fields from this FieldList by Name.

The field could also be inside a CompositeField.

Parameters

string|array $fieldName

The name of, or an array with the field(s) or tab(s)

bool $dataFieldOnly

If this is true, then a field will only be removed if it's a data field. Dataless fields, such as tabs, will be left as-is.

Return Value

$this

bool replaceField(string $fieldName, FormField $newField, bool $dataFieldOnly = true)

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

Parameters

string $fieldName

The name of the field to replace

FormField $newField

The field object to replace with

bool $dataFieldOnly

If this is true, then a field will only be replaced if it's a data field. Dataless fields, such as tabs, will be not be considered for replacement.

Return Value

bool

TRUE field was successfully replaced FALSE field wasn't found, nothing changed

bool renameField(string $fieldName, string $newFieldTitle)

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

Parameters

string $fieldName

Name of field to rename title of

string $newFieldTitle

New title of field

Return Value

bool

bool hasTabSet()

No description

Return Value

bool

Tab|null findTab(string $tabName)

Returns the specified tab object, if it exists

Parameters

string $tabName

The tab to return, in the form "Tab.Subtab.Subsubtab".

Return Value

Tab|null

The found or null

Tab findOrMakeTab(string $tabName, string $title = null)

Returns the specified tab object, creating it if necessary.

Support recursive creation of TabSets

Parameters

string $tabName

The tab to return, in the form "Tab.Subtab.Subsubtab". Caution: Does not recursively create TabSet instances, you need to make sure everything up until the last tab in the chain exists.

string $title

Natural language title of the tab. If $tabName is passed in dot notation, the title parameter will only apply to the innermost referenced tab. The title is only changed if the tab doesn't exist already.

Return Value

Tab

The found or newly created Tab instance

FormField|null fieldByName(string $name)

Returns a named field.

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

Implement similarly to dataFieldByName() to support nested sets - or merge with dataFields()

Parameters

string $name

Return Value

FormField|null

FormField|null dataFieldByName(string $name)

Returns a named field in a sequential set.

Use this if you're using nested FormFields.

Parameters

string $name

The name of the field to return

Return Value

FormField|null

FormField|false insertBefore(string $name, FormField $item, bool $appendIfMissing = true)

Inserts a field before a particular field in a FieldList.

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

Parameters

string $name

Name of the field to insert before

FormField $item

The form field to insert

bool $appendIfMissing

Append to the end of the list if $name isn't found

Return Value

FormField|false

Field if it was successfully inserted, false if not inserted

FormField|false insertAfter(string $name, FormField $item, bool $appendIfMissing = true)

Inserts a field after a particular field in a FieldList.

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

Parameters

string $name

Name of the field to insert after

FormField $item

The form field to insert

bool $appendIfMissing

Append to the end of the list if $name isn't found

Return Value

FormField|false

Field if it was successfully inserted, false if not inserted

protected onBeforeInsert(FormField $item)

Handler method called before the FieldList is going to be manipulated.

Parameters

FormField $item

$this setForm(Form $form)

Set the Form instance for this FieldList.

Parameters

Form $form

The form to set this FieldList to

Return Value

$this

$this setValues(array $data)

Load the given data into this form.

Parameters

array $data

An map of data to load into the FieldList

Return Value

$this

FieldList HiddenFields()

Return all fields in a form - including fields nested in CompositeFields.

Useful when doing custom field layouts.

Return Value

FieldList

VisibleFields()

Return all fields except for the hidden fields.

Useful when making your own simplified form layouts.

FieldList transform(FormTransformation $trans)

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

Parameters

FormTransformation $trans

Return Value

FieldList

FieldList|FormField rootFieldList()

Returns the root field set that this belongs to

Return Value

FieldList|FormField

CompositeField|null getContainerField()

No description

Return Value

CompositeField|null

$this setContainerField(CompositeField|null $field)

No description

Parameters

CompositeField|null $field

Return Value

$this

FieldList makeReadonly()

Transforms this FieldList instance to readonly.

Return Value

FieldList

makeFieldReadonly(string|array|FormField $field)

Transform the named field into a readonly field.

Parameters

string|array|FormField $field

changeFieldOrder(array $fieldNames)

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.

Parameters

array $fieldNames

Field names can be given as an array, or just as a list of arguments.

int fieldPosition(string|FormField $field)

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

Parameters

string|FormField $field

Return Value

int

Position in children collection (first position starts with 0). Returns FALSE if the field can't be found.

forTemplate()

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