class AuditHookMemberGroupSet extends Member_GroupSet (View source)

AuditHookMemberGroupSet is meant to override Member_GroupSet. When a Group is removed from a Member, it logs the event.

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

Whether to use placeholders for integer IDs on Primary and Foriegn keys during a WHERE IN query It is significantly faster to not use placeholders

from  DataList

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 public 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 T> $dataClass

The DataObject class name that this data list is querying

from  DataList
protected DataQuery $dataQuery

The DataQuery object responsible for getting this DataList's records

from  DataList
protected Query $finalisedQuery

A cached Query to save repeated database calls. {DataList::getTemplateIteratorCount()}

from  DataList
protected bool $inAlterDataQueryCall from  DataList
protected CallbackList|null $addCallbacks from  RelationList
protected CallbackList|null $removeCallbacks from  RelationList
protected string $joinTable from  ManyManyList
protected string $localKey from  ManyManyList
protected string $foreignKey from  ManyManyList
protected array $extraFields from  ManyManyList
protected array $_compositeExtraFields from  ManyManyList

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
bool
hasCustomMethod($method)

Determines if a custom method with this name is defined.

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 static 
array
findBuiltInMethods(string|object $class = null)

Get all public built in methods for this class

protected
array
findMethodsFrom(object $object)

Find all methods on the given object.

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

Add all the methods from an object property.

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

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

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
uninherited(string $name)

Gets the uninherited value for the given config option

public
__construct(T> $dataClass, string $joinTable, string $localKey, string $foreignKey, array $extraFields = [])

Create a new ManyManyList object.

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
mixed
getDynamicData(string $field)

No description

public
setDynamicData(string $field, mixed $value)

No description

public
bool
hasDynamicData(string $field)

No description

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 DataList has items

from  DataList
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 $fieldName, 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

public
getIterator()

Returns an Iterator for this DataList.

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

protected
createSearchFilter(string $filter, mixed $value)

Given a filter expression and value construct a {SearchFilter} instance

public
T>
dataClass()

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

from  DataList
public
__clone()

When cloning this object, clone the dataQuery object as well

from  DataList
public
dataQuery()

Return a copy of the internal DataQuery object

from  DataList
public
alterDataQuery($callback)

No description

from  DataList
public
setDataQuery(DataQuery $dataQuery)

No description

from  DataList
public
setDataQueryParam($keyOrArray, $val = null)

No description

from  DataList
public
string
sql(array $parameters = [])

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

from  DataList
public
where($filter)

No description

from  DataList
public
whereAny($filter)

No description

from  DataList
public
bool
canSortBy(string $fieldName)

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

from  DataList
public
bool
canFilterBy(string $fieldName)

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

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

No description

from  DataList
public
distinct($value)

No description

from  DataList
public
sort(...$args)

No description

from  DataList
public
orderBy(string $orderBy)

No description

from  DataList
public
filter()

No description

from  DataList
public
addFilter($filterArray)

No description

from  DataList
public
filterAny()

No description

from  DataList
public
T>
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  DataList
public
applyRelation($field, $columnName = null, $linearOnly = false)

No description

from  DataList
protected
bool
isValidRelationName(string $field)

Check if the given field specification could be interpreted as an unquoted relation name

from  DataList
public
exclude()

No description

from  DataList
public
excludeAny()

No description

from  DataList
public
subtract(DataList $list)

No description

from  DataList
public
innerJoin($table, $onClause, $alias = null, $order = 20, $parameters = [])

No description

from  DataList
public
leftJoin($table, $onClause, $alias = null, $order = 20, $parameters = [])

No description

from  DataList
public
rightJoin($table, $onClause, $alias = null, $order = 20, $parameters = [])

No description

from  DataList
public
T[]
toArray()

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

from  DataList
public
array
toNestedArray()

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

from  DataList
public
each($callback)

No description

from  DataList
public
debug()

No description

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

Returns a map of this list

from  DataList
public
T
createDataObject(array $row)

Create a DataObject from the given SQL row If called without $row['ID'] set, then a new object will be created rather than rehydrated.

public
array
getQueryParams()

Get query parameters for this list.

public
eagerLoad(...$relationChains)

No description

from  DataList
public
int
count()

Return the number of items in this DataList

from  DataList
public
mixed
max(string $fieldName)

Return the maximum value of the given field in this DataList

from  DataList
public
mixed
min(string $fieldName)

Return the minimum value of the given field in this DataList

from  DataList
public
mixed
avg(string $fieldName)

Return the average value of the given field in this DataList

from  DataList
public
mixed
sum(string $fieldName)

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

from  DataList
public
T|null
first()

Returns the first item in this DataList

from  DataList
public
T|null
last()

Returns the last item in this DataList

from  DataList
public
T|null
find(string $key, mixed $value)

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

from  DataList
public
setQueriedColumns($queriedColumns)

No description

from  DataList
public
byIDs($ids)

No description

from  DataList
public
T|null
byID(int $id)

Return the first DataObject with the given ID

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

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

from  DataList
public
array
columnUnique(string $colName = "ID")

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

from  DataList
public
setByIDList(int[] $idList)

Sets the ComponentSet to be the given ID list.

from  DataList
public
int[]
getIDList()

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

from  DataList
public
relation(string $relationName)

Returns a HasManyList or ManyMany list representing the querying of a relation across all objects in this data list. For it to work, the relation must be defined on the data class that you used to create this DataList.

from  DataList
public
dbObject($fieldName)

No description

from  DataList
public
addMany($items)

No description

from  DataList
public
removeMany($idList)

No description

from  DataList
public
removeByFilter($filter)

No description

from  DataList
public
shuffle()

No description

from  DataList
public
removeAll()

Remove all items from this many-many join. To remove a subset of items, filter it first.

public
add(mixed $item, array $extraFields = null)

Add an item to this many_many relationship Does so by adding an entry to the joinTable.

public
T
newObject(array $initialFields = null)

Return a new item to add to this DataList.

from  DataList
public
remove(mixed $item)

Remove the given item from this list.

public
removeByID(int $itemID)

Overload ManyManyList::removeByID() so we can log when a Member is removed from a Group.

public
reverse()

No description

from  DataList
public
bool
offsetExists(mixed $key)

Returns whether an item with $key exists

from  DataList
public
DataObject|null
offsetGet(mixed $key)

Returns item stored in list with index $key

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

Set an item with the key in $key

from  DataList
public
void
offsetUnset(mixed $key)

Unset an item with the key in $key

from  DataList
public
iterable
chunkedFetch(int $chunkSize = 1000)

Iterate over this DataList in "chunks". This will break the query in smaller subsets and avoid loading the entire result set in memory at once. Beware not to perform any operations on the results that might alter the return order. Otherwise, you might break subsequent chunks.

from  DataList
public
CallbackList
addCallbacks()

Manage callbacks which are called after the add() action is completed.

public
CallbackList
removeCallbacks()

Manage callbacks which are called after the remove() action is completed.

public
string|array|null
getForeignID()

Any number of foreign keys to apply to this list

public
forForeignID(mixed $id)

No description

public
array
foreignIDFilter(array|int $id = null)

Link this group set to a specific member.

protected
string
prepareForeignIDsForWhereInClause(array $ids)

Prepare an array of IDs for a 'WHERE IN` clause deciding if we should use placeholders Current rules are to use not use placeholders, unless:

  • SilverStripe\ORM\DataList.use_placeholders_for_integer_ids is set to false, or
  • Any of the IDs values being filtered are not integers or valid integer strings

protected
linkJoinTable()

Setup the join between this dataobject and the necessary mapping table

protected
void
appendExtraFieldsToQuery()

Adds the many_many_extraFields to the select of the underlying DataQuery.

public
array
foreignIDWriteFilter(array|int|null $id = null)

Return a filter expression for the join table when writing to the join table

public
void
setExtraData(int $itemID, array $data)

Set the extra field data for a single row of the relationship join table, given the known child ID.

public
array
getExtraData(string $componentName, int $itemID)

Find the extra field data for a single row of the relationship join table, given the known child ID.

public
string
getJoinTable()

Gets the join table used for the relationship.

public
string
getLocalKey()

Gets the key used to store the ID of the local/parent object.

public
string
getForeignKey()

Gets the key used to store the ID of the foreign/child object.

public
array
getExtraFields()

Gets the extra fields included in the relationship.

protected
bool
canAddGroups(array $itemIDs)

Determine if the following groups IDs can be added

protected
getMember()

Get foreign member record for this relation

protected
getAuditLogger()

No description

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 bool hasCustomMethod($method)

Determines if a custom method with this name is defined.

Parameters

$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

Map of method names with lowercase keys

static protected array findBuiltInMethods(string|object $class = null)

Get all public built in methods for this class

Parameters

string|object $class

Class or instance to query methods from (defaults to static::class)

Return Value

array

Map of methods with lowercase key name

protected array findMethodsFrom(object $object)

Find all methods on the given object.

Parameters

object $object

Return Value

array

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

Add all the methods from an object property.

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

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.

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

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

List of arguments

Return Value

array

List of results with nulls filtered out

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 __construct()} in {@link defineMethods().

Parameters

string $method

the name of the method to call on each extension

mixed ...$arguments

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 uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

__construct(T> $dataClass, string $joinTable, string $localKey, string $foreignKey, array $extraFields = [])

Create a new ManyManyList object.

A ManyManyList object represents a list of DataObject records that correspond to a many-many relationship.

Generation of the appropriate record set is left up to the caller, using the normal DataList methods. Addition arguments are used to support add()} and {@link remove() methods.

Parameters

T> $dataClass
  • The DataObject class to query.
string $joinTable

The name of the table whose entries define the content of this many_many relation.

string $localKey

The key in the join table that maps to the dataClass' PK.

string $foreignKey

The key in the join table that maps to joined class' PK.

array $extraFields

A map of field => fieldtype of extra fields on the join table.

Examples

new ManyManyList('Group','Group_Members', 'GroupID', 'MemberID');

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

mixed getDynamicData(string $field)

No description

Parameters

string $field

Return Value

mixed

ViewableData setDynamicData(string $field, mixed $value)

No description

Parameters

string $field
mixed $value

Return Value

ViewableData

bool hasDynamicData(string $field)

No description

Parameters

string $field

Return Value

bool

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 DataList 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 $fieldName, 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 $fieldName
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

Traversable getIterator()

Returns an Iterator for this DataList.

This function allows you to use DataLists in foreach loops

Return Value

Traversable

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

protected SearchFilter createSearchFilter(string $filter, mixed $value)

Given a filter expression and value construct a {SearchFilter} instance

Parameters

string $filter

E.g. Name:ExactMatch:not, Name:ExactMatch, Name:not, Name

mixed $value

Value of the filter

Return Value

SearchFilter

T> dataClass()

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

Return Value

T>

__clone()

When cloning this object, clone the dataQuery object as well

DataQuery dataQuery()

Return a copy of the internal DataQuery object

Because the returned value is a copy, modifying it won't affect this list's contents. If you want to alter the data query directly, use the alterDataQuery method

Return Value

DataQuery

alterDataQuery($callback)

No description

Parameters

$callback

setDataQuery(DataQuery $dataQuery)

No description

Parameters

DataQuery $dataQuery

setDataQueryParam($keyOrArray, $val = null)

No description

Parameters

$keyOrArray
$val

string sql(array $parameters = [])

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

Parameters

array $parameters

Out variable for parameters required for this query

Return Value

string

The resulting SQL query (may be parameterised)

where($filter)

No description

Parameters

$filter

whereAny($filter)

No description

Parameters

$filter

bool canSortBy(string $fieldName)

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

Parameters

string $fieldName

Return Value

bool

bool canFilterBy(string $fieldName)

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

Parameters

string $fieldName

(May be a related field in dot notation like Member.FirstName)

Return Value

bool

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

No description

Parameters

int|null $length
int $offset

Return Value

Limitable

distinct($value)

No description

Parameters

$value

sort(...$args)

No description

Parameters

...$args

DataList orderBy(string $orderBy)

No description

Parameters

string $orderBy

Return Value

DataList

filter()

No description

addFilter($filterArray)

No description

Parameters

$filterArray

filterAny()

No description

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

T>

See also

Filterable::filterByCallback

Examples

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

applyRelation($field, $columnName = null, $linearOnly = false)

No description

Parameters

$field
$columnName
$linearOnly

protected bool isValidRelationName(string $field)

Check if the given field specification could be interpreted as an unquoted relation name

Parameters

string $field

Return Value

bool

exclude()

No description

excludeAny()

No description

subtract(DataList $list)

No description

Parameters

DataList $list

innerJoin($table, $onClause, $alias = null, $order = 20, $parameters = [])

No description

Parameters

$table
$onClause
$alias
$order
$parameters

leftJoin($table, $onClause, $alias = null, $order = 20, $parameters = [])

No description

Parameters

$table
$onClause
$alias
$order
$parameters

rightJoin($table, $onClause, $alias = null, $order = 20, $parameters = [])

No description

Parameters

$table
$onClause
$alias
$order
$parameters

T[] toArray()

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

This is when the query is actually executed.

Return Value

T[]

array toNestedArray()

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

Return Value

array

each($callback)

No description

Parameters

$callback

debug()

No description

Map map(string $keyField = 'ID', string $titleField = 'Title')

Returns a map of this list

Parameters

string $keyField
  • the 'key' field of the result array
string $titleField
  • the value field of the result array

Return Value

Map

T createDataObject(array $row)

Create a DataObject from the given SQL row If called without $row['ID'] set, then a new object will be created rather than rehydrated.

Parameters

array $row

Return Value

T

array getQueryParams()

Get query parameters for this list.

These values will be assigned as query parameters to newly created objects from this list.

Return Value

array

DataList eagerLoad(...$relationChains)

No description

Parameters

...$relationChains

Return Value

DataList

int count()

Return the number of items in this DataList

Return Value

int

mixed max(string $fieldName)

Return the maximum value of the given field in this DataList

Parameters

string $fieldName

Return Value

mixed

mixed min(string $fieldName)

Return the minimum value of the given field in this DataList

Parameters

string $fieldName

Return Value

mixed

mixed avg(string $fieldName)

Return the average value of the given field in this DataList

Parameters

string $fieldName

Return Value

mixed

mixed sum(string $fieldName)

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

Parameters

string $fieldName

Return Value

mixed

T|null first()

Returns the first item in this DataList

The object returned is not cached, unlike DataObject::get_one()

Return Value

T|null

T|null last()

Returns the last item in this DataList

The object returned is not cached, unlike DataObject::get_one()

Return Value

T|null

T|null find(string $key, mixed $value)

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

The object returned is not cached, unlike DataObject::get_one()

Parameters

string $key
mixed $value

Return Value

T|null

setQueriedColumns($queriedColumns)

No description

Parameters

$queriedColumns

byIDs($ids)

No description

Parameters

$ids

T|null byID(int $id)

Return the first DataObject with the given ID

The object returned is not cached, unlike DataObject::get_by_id()

Parameters

int $id

Return Value

T|null

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 items in the list.

Parameters

string $colName

Return Value

array

setByIDList(int[] $idList)

Sets the ComponentSet to be the given ID list.

Records will be added and deleted as appropriate.

Parameters

int[] $idList

List of IDs.

int[] getIDList()

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

Does not respect sort order. Use ->column("ID") to get an ID list with the current sort.

Return Value

int[]

RelationList relation(string $relationName)

Returns a HasManyList or ManyMany list representing the querying of a relation across all objects in this data list. For it to work, the relation must be defined on the data class that you used to create this DataList.

Example: Get members from all Groups:

DataList::Create(\SilverStripe\Security\Group::class)->relation("Members")

Parameters

string $relationName

Return Value

RelationList

dbObject($fieldName)

No description

Parameters

$fieldName

addMany($items)

No description

Parameters

$items

removeMany($idList)

No description

Parameters

$idList

removeByFilter($filter)

No description

Parameters

$filter

shuffle()

No description

removeAll()

Remove all items from this many-many join. To remove a subset of items, filter it first.

add(mixed $item, array $extraFields = null)

Add an item to this many_many relationship Does so by adding an entry to the joinTable.

Can also be used to update an already existing joinTable entry:

$manyManyList->add($recordID,["ExtraField" => "value"]);

Parameters

mixed $item
array $extraFields

A map of additional columns to insert into the joinTable. Column names should be ANSI quoted.

Exceptions

InvalidArgumentException
Exception
Exception

T newObject(array $initialFields = null)

Return a new item to add to this DataList.

Parameters

array $initialFields

Return Value

T

remove(mixed $item)

Remove the given item from this list.

Note that for a ManyManyList, the item is never actually deleted, only the join table is affected.

Parameters

mixed $item

removeByID(int $itemID)

Overload ManyManyList::removeByID() so we can log when a Member is removed from a Group.

Parameters

int $itemID

The primary ID

reverse()

No description

bool offsetExists(mixed $key)

Returns whether an item with $key exists

Parameters

mixed $key

Return Value

bool

DataObject|null offsetGet(mixed $key)

Returns item stored in list with index $key

The object returned is not cached, unlike DataObject::get_one()

Parameters

mixed $key

Return Value

DataObject|null

void offsetSet(mixed $key, mixed $value)

Set an item with the key in $key

Parameters

mixed $key
mixed $value

Return Value

void

Exceptions

BadMethodCallException

void offsetUnset(mixed $key)

Unset an item with the key in $key

Parameters

mixed $key

Return Value

void

Exceptions

BadMethodCallException

iterable chunkedFetch(int $chunkSize = 1000)

Iterate over this DataList in "chunks". This will break the query in smaller subsets and avoid loading the entire result set in memory at once. Beware not to perform any operations on the results that might alter the return order. Otherwise, you might break subsequent chunks.

You also can not define a custom limit or offset when using the chunk method.

Parameters

int $chunkSize

Return Value

iterable

Exceptions

InvalidArgumentException

CallbackList addCallbacks()

Manage callbacks which are called after the add() action is completed.

Each callback will be passed (RelationList $this, DataObject|int $item, array $extraFields). If a relation methods is manually defined, this can be called to adjust the behaviour when adding records to this list.

Needs to be defined through an overloaded relationship getter to ensure it is set consistently. These getters return a new object every time they're called.

Note that subclasses of RelationList must implement the callback for it to function

Return Value

CallbackList

CallbackList removeCallbacks()

Manage callbacks which are called after the remove() action is completed.

Each Callback will be passed (RelationList $this, [int] $removedIds).

Needs to be defined through an overloaded relationship getter to ensure it is set consistently. These getters return a new object every time they're called. Example:

class MyObject extends DataObject()
{
  private static $many_many = [
    'MyRelationship' => '...',
  ];
  public function MyRelationship()
  {
    $list = $this->getManyManyComponents('MyRelationship');
    $list->removeCallbacks()->add(function ($removedIds) {
      // ...
    });
    return $list;
  }
}

If a relation methods is manually defined, this can be called to adjust the behaviour when adding records to this list.

Subclasses of RelationList must implement the callback for it to function

Return Value

CallbackList

string|array|null getForeignID()

Any number of foreign keys to apply to this list

Return Value

string|array|null

Relation forForeignID(mixed $id)

No description

Parameters

mixed $id

Return Value

Relation

array foreignIDFilter(array|int $id = null)

Link this group set to a specific member.

Recursively selects all groups applied to this member, as well as any parent groups of any applied groups

Parameters

array|int $id

(optional) An ID or an array of IDs - if not provided, will use the current ids as per getForeignID

Return Value

array

Condition In array(SQL => parameters format)

protected string prepareForeignIDsForWhereInClause(array $ids)

Prepare an array of IDs for a 'WHERE IN` clause deciding if we should use placeholders Current rules are to use not use placeholders, unless:

  • SilverStripe\ORM\DataList.use_placeholders_for_integer_ids is set to false, or
  • Any of the IDs values being filtered are not integers or valid integer strings

Putting IDs directly into a where clause instead of using placeholders was measured to be significantly faster when querying a large number of IDs e.g. over 1000

Parameters

array $ids

Return Value

string

protected linkJoinTable()

Setup the join between this dataobject and the necessary mapping table

protected void appendExtraFieldsToQuery()

Adds the many_many_extraFields to the select of the underlying DataQuery.

Return Value

void

array foreignIDWriteFilter(array|int|null $id = null)

Return a filter expression for the join table when writing to the join table

When writing (add, remove, removeByID), we need to filter the join table to just the relevant entries. However some subclasses of ManyManyList (Member_GroupSet) modify foreignIDFilter to include additional calculated entries, so we need different filters when reading and when writing

Parameters

array|int|null $id

(optional) An ID or an array of IDs - if not provided, will use the current ids as per getForeignID

Return Value

array

Condition In array(SQL => parameters format)

void setExtraData(int $itemID, array $data)

Set the extra field data for a single row of the relationship join table, given the known child ID.

Parameters

int $itemID

The ID of the child for the relationship

array $data

The data to set, with field names as keys and values as values

Return Value

void

Exceptions

InvalidArgumentException

array getExtraData(string $componentName, int $itemID)

Find the extra field data for a single row of the relationship join table, given the known child ID.

Parameters

string $componentName

The name of the component

int $itemID

The ID of the child for the relationship

Return Value

array

Map of fieldName => fieldValue

string getJoinTable()

Gets the join table used for the relationship.

Return Value

string

the name of the table

string getLocalKey()

Gets the key used to store the ID of the local/parent object.

Return Value

string

the field name

string getForeignKey()

Gets the key used to store the ID of the foreign/child object.

Return Value

string

the field name

array getExtraFields()

Gets the extra fields included in the relationship.

Return Value

array

a map of field names to types

protected bool canAddGroups(array $itemIDs)

Determine if the following groups IDs can be added

Parameters

array $itemIDs

Return Value

bool

protected Member getMember()

Get foreign member record for this relation

Return Value

Member

protected getAuditLogger()

No description