1. class
  2. SilverStripe
  3. \
  4. ORM
  5. \
  6. GroupedList

GroupedList

class GroupedList extends ListDecorator

A list decorator that allows a list to be grouped into sub-lists by common values of a field.

Traits

Extensible
Allows an object to have extensions applied to it.
Injectable
A class that can be instantiated or replaced via DI
Configurable
Provides extensions to this object to integrate it with standard config API methods.
CustomMethods
Allows an object to declare a set of custom methods

Methods

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

from CustomMethods
bool
hasMethod(string $method)

Return TRUE if a method exists on this object

from CustomMethods
array
allMethodNames(bool $custom = false)

Return the names of all the methods available on this object

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

Add an extension to a specific class.

from Extensible
static 
remove_extension(string $extension)

Remove an extension from a class.

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

No description

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

Get extra config sources for this class

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

Return TRUE if a class has a specified extension.

from Extensible
array
invokeWithExtensions(string $method, mixed $arguments)

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

from Extensible
array
extend(string $method, mixed $arguments)

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

from Extensible
Extension|null
getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

from Extensible
bool
hasExtension(string $extension)

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

from Extensible
Extension[]
getExtensionInstances()

Get all extension instances for this specific object instance.

from Extensible
static Injectable
create(array $args)

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

from Injectable
static Injectable
singleton(string $class = null)

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

from Injectable
static Config_ForClass
config()

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

from Configurable
mixed
stat(string $name) deprecated

Get inherited config value

from Configurable
mixed
uninherited(string $name)

Gets the uninherited value for the given config option

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

Update the config value for a given property

from Configurable
__construct(SS_List $list)

No description

from ListDecorator
bool
__isset(string $property)

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

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

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

from ViewableData
setFailover(ViewableData $failover)

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

from ViewableData
ViewableData|null
getFailover()

Get the current failover object if set

from ViewableData
bool
hasField(string $field)

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

from ViewableData
mixed
getField(string $field)

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

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

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

from ViewableData
defineMethods()

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

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

from ViewableData
bool
exists()

Return true if this object "exists" i.e. has a sensible value

from ListDecorator
string
__toString()

No description

from ViewableData
ViewableData
getCustomisedObj()

No description

from ViewableData
setCustomisedObj(ViewableData $object)

No description

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

from ViewableData
string
castingClass(string $field)

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

from ViewableData
string
escapeTypeForField(string $field)

Return the string-format type for the given field.

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

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

from ViewableData
Object|DBField
cachedCall(string $field, array $arguments = [], 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.

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

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

from ViewableData
array
getXMLValues(array $fields)

Get an array of XML-escaped values by field name

from ViewableData
ArrayIterator
getIterator()

Return a single-item iterator so you can iterate over the fields of a single record.

from ListDecorator
array
getViewerTemplates(string $suffix = '')

Find appropriate templates for SSViewer to use to render this object

from ViewableData
ViewableData
Me()

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

from ViewableData
string
ThemeDir() deprecated

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

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

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

from ViewableData
ViewableData_Debugger
Debug()

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

from ViewableData
SS_List
getList()

Returns the list this decorator wraps around.

from ListDecorator
SS_List
setList($list)

Set the list this decorator wraps around.

from ListDecorator
offsetExists($key)

No description

from ListDecorator
offsetGet($key)

No description

from ListDecorator
offsetSet($key, $value)

No description

from ListDecorator
offsetUnset($key)

No description

from ListDecorator
array
toArray()

Returns all the items in the list in an array.

from ListDecorator
array
toNestedArray()

Returns the contents of the list as an array of maps.

from ListDecorator
add(mixed $item)

Adds an item to the list, making no guarantees about where it will appear.

from ListDecorator
remove($itemObject)

Removes an item from the list.

from ListDecorator
mixed
first()

Returns the first item in the list.

from ListDecorator
mixed
last()

Returns the last item in the list.

from ListDecorator
TotalItems()

No description

from ListDecorator
Count()

No description

from ListDecorator
forTemplate()

No description

from ListDecorator
Map
map($index = 'ID', $titleField = 'Title')

Returns a map of a key field to a value field of all the items in the list.

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

Returns the first item in the list where the key field is equal to the value.

from ListDecorator
array
column($value = 'ID')

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

from ListDecorator
columnUnique($value = "ID")

No description

from ListDecorator
$this
each(callable $callback)

Walks the list using the specified callback

from ListDecorator
bool
canSortBy(string $by)

Returns TRUE if the list can be sorted by a field.

from ListDecorator
Sortable
reverse()

Return a new instance of this list based on reversing the current sort.

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

from ListDecorator
bool
canFilterBy(string $by)

Returns TRUE if the list can be filtered by a given field expression.

from ListDecorator
Filterable
filter()

Filter the list to include items with these charactaristics

from ListDecorator
Filterable
filterAny()

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

from ListDecorator
Filterable
filterByCallback(callable $callback)

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

from ListDecorator
Limitable
limit(int $limit, int $offset)

Returns a new instance of this list where no more than $limit records are included.

from ListDecorator
mixed
byID(int $id)

Return the first item with the given ID

from ListDecorator
SS_List
byIDs(array $ids)

Filter this list to only contain the given Primary IDs

from ListDecorator
Filterable
exclude()

Exclude the list to not contain items with these charactaristics

from ListDecorator
debug()

No description

from ListDecorator
array
groupBy(string $index)

No description

ArrayList
GroupedBy(string $index, string $children = 'Children')

Similar to {@link groupBy()}, but returns the data in a format which is suitable for usage in templates.

Details

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

Parameters

string $method
array $arguments

Return Value

mixed

Exceptions

BadMethodCallException

in CustomMethods at line 144
bool hasMethod(string $method)

Return TRUE if a method exists on this object

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

Parameters

string $method

Return Value

bool

in CustomMethods at line 172
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 Map of method names with lowercase keys

in Extensible at line 163
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 {@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')"

Return Value

bool Flag if the extension was added

See also

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

in Extensible at line 224
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 {@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 class name of an {@link Extension} subclass, without parameters

in Extensible at line 264
static array get_extensions(string $class = null, bool $includeArgumentString = false)

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 {@link DataExtension} class names, or eval'ed class name strings with constructor arguments.

in Extensible at line 298
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

in Extensible at line 359
static bool has_extension(string $classOrExtension, string $requiredExtension = null, boolean $strict = false)

Return TRUE if a class has a specified extension.

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

Parameters

string $classOrExtension 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.
boolean $strict if the extension has to match the required extension and not be a subclass

Return Value

bool Flag if the extension exists

in Extensible at line 395
array invokeWithExtensions(string $method, mixed $arguments)

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 $arguments List of arguments

Return Value

array List of results with nulls filtered out

in Extensible at line 424
array extend(string $method, mixed $arguments)

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 $arguments &...$arguments

Return Value

array

in Extensible at line 465
Extension|null getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

Parameters

string $extension

Return Value

Extension|null

in Extensible at line 494
bool hasExtension(string $extension)

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

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

Parameters

string $extension Classname of an {@link Extension} subclass without parameters

Return Value

bool

in Extensible at line 508
Extension[] 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).

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

Return Value

Extension[] Map of {@link DataExtension} instances, keyed by classname.

in Injectable at line 26
static Injectable create(array $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'); $list = SiteTree::get();

Parameters

array $args

Return Value

Injectable

in Injectable at line 43
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

in Configurable at line 20
static Config_ForClass config()

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

....).

Return Value

Config_ForClass

in Configurable at line 32
mixed stat(string $name) deprecated

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

Get inherited config value

Parameters

string $name

Return Value

mixed

in Configurable at line 44
mixed uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

in Configurable at line 57
$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

in ListDecorator at line 21
__construct(SS_List $list)

Parameters

SS_List $list

in ViewableData at line 106
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

in ViewableData at line 129
mixed __get(string $property)

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

Parameters

string $property

Return Value

mixed

in ViewableData at line 152
__set(string $property, mixed $value)

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

Parameters

string $property
mixed $value

in ViewableData at line 167
setFailover(ViewableData $failover)

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

Parameters

ViewableData $failover

in ViewableData at line 183
ViewableData|null getFailover()

Get the current failover object if set

Return Value

ViewableData|null

in ViewableData at line 194
bool hasField(string $field)

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

Parameters

string $field

Return Value

bool

in ViewableData at line 205
mixed getField(string $field)

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

Parameters

string $field

Return Value

mixed

in ViewableData at line 217
$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

in ViewableData at line 232
defineMethods()

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

Exceptions

LogicException

in ViewableData at line 258
ViewableData_Customised customise(array|ViewableData $data)

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

Note that any fields you specify will take precedence over the fields on this object.

Parameters

array|ViewableData $data

Return Value

ViewableData_Customised

in ListDecorator at line 100
bool exists()

Return true if this object "exists" i.e. has a sensible value

This method should be overriden in subclasses to provide more context about the classes state. For example, a {@link DataObject} class could return false when it is deleted from the database

Return Value

bool

in ViewableData at line 289
string __toString()

Return Value

string the class name

in ViewableData at line 297
ViewableData getCustomisedObj()

Return Value

ViewableData

in ViewableData at line 305
setCustomisedObj(ViewableData $object)

Parameters

ViewableData $object

in ViewableData at line 320
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

in ViewableData at line 352
string castingClass(string $field)

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

Parameters

string $field

Return Value

string

in ViewableData at line 365
string escapeTypeForField(string $field)

Return the string-format type for the given field.

Parameters

string $field

Return Value

string 'xml'|'raw'

in ViewableData at line 389
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

in ViewableData at line 471
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

in ViewableData at line 516
Object|DBField cachedCall(string $field, array $arguments = [], 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

Return Value

Object|DBField

in ViewableData at line 530
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

in ViewableData at line 545
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

in ViewableData at line 558
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

in ListDecorator at line 95
ArrayIterator getIterator()

Return a single-item iterator so you can iterate over the fields of a single record.

This is useful so you can use a single record inside a <% control %> block in a template - and then use to access individual fields on this object.

Return Value

ArrayIterator

in ViewableData at line 592
array getViewerTemplates(string $suffix = '')

Find appropriate templates for SSViewer to use to render this object

Parameters

string $suffix

Return Value

array

in ViewableData at line 603
ViewableData Me()

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

Return Value

ViewableData

in ViewableData at line 620
string ThemeDir() deprecated

deprecated 4.0.0:5.0.0 Use $resourcePath or $resourceURL template helpers 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

in ViewableData at line 647
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

in ViewableData at line 676
ViewableData_Debugger Debug()

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

Return Value

ViewableData_Debugger

in ListDecorator at line 33
SS_List getList()

Returns the list this decorator wraps around.

Return Value

SS_List

in ListDecorator at line 46
SS_List setList($list)

Set the list this decorator wraps around.

Useful for keeping a decorator/paginated list configuration intact while modifying the underlying list.

Parameters

$list

Return Value

SS_List

in ListDecorator at line 55
offsetExists($key)

Parameters

$key

in ListDecorator at line 60
offsetGet($key)

Parameters

$key

in ListDecorator at line 65
offsetSet($key, $value)

Parameters

$key
$value

in ListDecorator at line 70
offsetUnset($key)

Parameters

$key

in ListDecorator at line 75
array toArray()

Returns all the items in the list in an array.

Return Value

array

in ListDecorator at line 80
array toNestedArray()

Returns the contents of the list as an array of maps.

Return Value

array

in ListDecorator at line 85
add(mixed $item)

Adds an item to the list, making no guarantees about where it will appear.

Parameters

mixed $item

in ListDecorator at line 90
remove($itemObject)

Removes an item from the list.

Parameters

$itemObject

in ListDecorator at line 105
mixed first()

Returns the first item in the list.

Return Value

mixed

in ListDecorator at line 110
mixed last()

Returns the last item in the list.

Return Value

mixed

in ListDecorator at line 115
TotalItems()

in ListDecorator at line 120
Count()

in ListDecorator at line 125
forTemplate()

in ListDecorator at line 130
Map map($index = 'ID', $titleField = 'Title')

Returns a map of a key field to a value field of all the items in the list.

Parameters

$index
$titleField

Return Value

Map

in ListDecorator at line 135
mixed find(string $key, mixed $value)

Returns the first item in the list where the key field is equal to the value.

Parameters

string $key
mixed $value

Return Value

mixed

in ListDecorator at line 140
array column($value = 'ID')

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

Parameters

$value

Return Value

array

in ListDecorator at line 145
columnUnique($value = "ID")

Parameters

$value

in ListDecorator at line 150
$this each(callable $callback)

Walks the list using the specified callback

Parameters

callable $callback

Return Value

$this

in ListDecorator at line 155
bool canSortBy(string $by)

Returns TRUE if the list can be sorted by a field.

Parameters

string $by

Return Value

bool

in ListDecorator at line 160
Sortable reverse()

Return a new instance of this list based on reversing the current sort.

Return Value

Sortable

in ListDecorator at line 174
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.

Return Value

Sortable

in ListDecorator at line 179
bool canFilterBy(string $by)

Returns TRUE if the list can be filtered by a given field expression.

Parameters

string $by

Return Value

bool

in ListDecorator at line 192
Filterable filter()

Filter the list to include items with these charactaristics

Return Value

Filterable

in ListDecorator at line 219
Filterable filterAny()

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

Return Value

Filterable

in ListDecorator at line 233
Filterable filterByCallback(callable $callback)

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

Parameters

callable $callback

Return Value

Filterable

See also

Filterable::filterByCallback()

in ListDecorator at line 250
Limitable limit(int $limit, int $offset)

Returns a new instance of this list where no more than $limit records are included.

If $offset is specified, then that many records at the beginning of the list will be skipped. This matches the behaviour of the SQL LIMIT clause.

Parameters

int $limit
int $offset

Return Value

Limitable

in ListDecorator at line 261
mixed byID(int $id)

Return the first item with the given ID

Parameters

int $id

Return Value

mixed

in ListDecorator at line 272
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

in ListDecorator at line 285
Filterable exclude()

Exclude the list to not contain items with these charactaristics

Return Value

Filterable

in ListDecorator at line 290
debug()

at line 18
array groupBy(string $index)

Parameters

string $index

Return Value

array

at line 45
ArrayList GroupedBy(string $index, string $children = 'Children')

Similar to {@link groupBy()}, but returns the data in a format which is suitable for usage in templates.

Parameters

string $index
string $children Name of the control under which children can be iterated on

Return Value

ArrayList