ManyManyList
class ManyManyList extends RelationList
Subclass of {@link DataList} representing a many_many relation.
Traits
Methods
Attempts to locate and call a method dynamically added to a class at runtime if a default cannot be located
Return the names of all the methods available on this object
Add an extension to a specific class.
No description
Get extra config sources for this class
Return TRUE if a class has a specified extension.
Calls a method if available on both this object and all applied {@link Extensions}, and then attempts to merge all results into an array
Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed
Get an extension instance attached to this object by name.
Returns TRUE if this object instance has a specific extension applied in {@link $extension_instances}. Extension instances are initialized at constructor time, meaning if you use {@link add_extension()} afterwards, the added extension will just be added to new instances of the extended class. Use the static method {@link has_extension()} to check if a class (not an instance) has a specific extension.
Get all extension instances for this specific object instance.
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .
Gets the uninherited value for the given config option
Create a new ManyManyList object.
Check if a field exists on this object or its failover.
Get the value of a property/field on this object. This will check if a method called get{$property} exists, then check if a field is available using {@link ViewableData::getField()}, then fall back on a failover object.
Set a property/field on this object. This will check for the existence of a method called set{$property}, then use the {@link ViewableData::setField()} method.
Set a failover object to attempt to get data from if it is not present on this object.
Check if a field exists on this object. This should be overloaded in child classes.
Get the value of a field on this object. This should be overloaded in child classes.
Set a field on this object. This should be overloaded in child classes.
Add methods from the {@link ViewableData::$failover} object, as well as wrapping any methods prefixed with an underscore into a {@link ViewableData::cachedCall()}.
Merge some arbitrary data in with this object. This method returns a {@link ViewableData_Customised} instance with references to both this and the new custom data.
Return the "casting helper" (a piece of PHP code that when evaluated creates a casted value object) for a field on this object. This helper will be a subclass of DBField.
Get the class name a field on this object will be casted to.
Return the string-format type for the given field.
Render this object into the template, and get the result as a string. You can pass one of the following as the $template parameter: - a template name (e.g. Page) - an array of possible template names - the first valid one will be used - an SSViewer instance
Get the value of a field on this object, automatically inserting the value into any available casting objects that have been specified.
A simple wrapper around {@link ViewableData::obj()} that automatically caches the result so it can be used again without re-running the method.
Checks if a given method/field has a valid value. If the result is an object, this will return the result of the exists method, otherwise will check if the result is not just an empty paragraph tag.
Get the string value of a field on this object that has been suitable escaped to be inserted directly into a template.
Get an array of XML-escaped values by field name
Find appropriate templates for SSViewer to use to render this object
When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.
Get part of the current classes ancestry to be used as a CSS class.
Return debug information about this object that can be rendered into a template
Get the dataClass name for this DataList, ie the DataObject ClassName
Return a new DataList instance with the underlying {@link DataQuery} object altered
Return a new DataList instance with the underlying {@link DataQuery} object changed
Returns a new DataList instance with the specified query parameter assigned
Returns the SQL query that will be used to get this DataList's records. Good for debugging. :-)
Return a new DataList instance with a WHERE clause added to this list's query.
Return a new DataList instance with a WHERE clause added to this list's query.
Returns true if this DataList can be sorted by the given field.
Returns true if this DataList can be filtered by the given field.
Return a new DataList instance with the records returned in this query restricted by a limit clause.
Return a new DataList instance as a copy of this data list with the sort order set.
Return a copy of this list which only includes items with these charactaristics
Return a new instance of the list with an added filter
Return a copy of this list which contains items matching any of these charactaristics.
Note that, in the current implementation, the filtered list will be an ArrayList, but this may change in a future implementation.
Given a field or relation name, apply it safely to this datalist.
Return a copy of this list which does not contain any items that match all params
Return a copy of this list which does not contain any items with any of these params
This method returns a copy of this list that does not contain any DataObjects that exists in $list
Return a new DataList instance with an inner join clause added to this list's query.
Return a new DataList instance with a left join clause added to this list's query.
Return an array of the actual items that this DataList contains at this stage.
Return this list as an array and every object it as an sub array as well
Create a DataObject from the given SQL row.
Return the maximum value of the given field in this DataList
Return the minimum value of the given field in this DataList
Return the average value of the given field in this DataList
Return the sum of the values of the given field in this DataList
Find the first DataObject of this DataList where the given key = value
Restrict the columns to fetch into this DataList
Returns an array of a single field value for all items in the list.
Returns a unque array of a single field value for all items in the list.
Returns an array with both the keys and values set to the IDs of the records in this list.
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.
Remove every element in this DataList matching the given $filter.
Shuffle the datalist using a random function provided by the SQL engine
Remove all items from this many-many join. To remove a subset of items, filter it first.
Add an item to this many_many relationship Does so by adding an entry to the joinTable.
Remove the given item from this list.
Remove the given item from this list.
Returns a copy of this list with the ManyMany relationship linked to the given foreign ID.
Find the extra field data for a single row of the relationship join table, given the known child ID.
Gets the join table used for the relationship.
Gets the key used to store the ID of the local/parent object.
Gets the key used to store the ID of the foreign/child object.
Gets the extra fields included in the relationship.
Details
in CustomMethods at line 47
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()}
in CustomMethods at line 146
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
in CustomMethods at line 176
array
allMethodNames(bool $custom = false)
Return the names of all the methods available on this object
in Extensible at line 172
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()}).
in Extensible at line 236
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.
in Extensible at line 278
static array
get_extensions(string $class = null, bool $includeArgumentString = false)
in Extensible at line 312
static array|null
get_extra_config_sources(string $class = null)
Get extra config sources for this class
in Extensible at line 373
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))
in Extensible at line 415
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 {@link Extensions}, and then attempts to merge all results into an array
in Extensible at line 450
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 {@link __construct()} in {@link defineMethods()}.
in Extensible at line 497
Extension|null
getExtensionInstance(string $extension)
Get an extension instance attached to this object by name.
in Extensible at line 526
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(
in Extensible at line 540
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.
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();
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).
in Configurable at line 20
static Config_ForClass
config()
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .
....).
in Configurable at line 32
mixed
stat(string $name)
deprecated
deprecated 5.0 Use ->config()->get() instead
Get inherited config value
in Configurable at line 44
mixed
uninherited(string $name)
Gets the uninherited value for the given config option
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
at line 62
__construct(string $dataClass, string $joinTable, string $localKey, string $foreignKey, array $extraFields = [])
Create a new ManyManyList object.
A ManyManyList object represents a list of {@link DataObject} records that correspond to a many-many relationship.
Generation of the appropriate record set is left up to the caller, using the normal {@link DataList} methods. Addition arguments are used to support {@@link add()} and {@link remove()} methods.
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.
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.
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.
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.
in ViewableData at line 183
ViewableData|null
getFailover()
Get the current failover object if set
in ViewableData at line 194
bool
hasField(string $field)
Check if a field exists on this object. This should be overloaded in child classes.
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.
in ViewableData at line 217
$this
setField(string $field, mixed $value)
Set a field on this object. This should be overloaded in child classes.
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()}.
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.
in DataList at line 947
bool
exists()
Returns true if this DataList has items
in ViewableData at line 289
string
__toString()
in ViewableData at line 297
ViewableData
getCustomisedObj()
in ViewableData at line 305
setCustomisedObj(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.
in ViewableData at line 352
string
castingClass(string $field)
Get the class name a field on this object will be casted to.
in ViewableData at line 365
string
escapeTypeForField(string $field)
Return the string-format type for the given field.
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
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.
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.
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.
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.
in ViewableData at line 558
array
getXMLValues(array $fields)
Get an array of XML-escaped values by field name
in DataList at line 856
ArrayIterator
getIterator()
Returns an Iterator for this DataList.
This function allows you to use DataLists in foreach loops
in ViewableData at line 592
array
getViewerTemplates(string $suffix = '')
Find appropriate templates for SSViewer to use to render this object
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.
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.
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".
in ViewableData at line 676
ViewableData_Debugger
Debug()
Return debug information about this object that can be rendered into a template
in DataList at line 71
string
dataClass()
Get the dataClass name for this DataList, ie the DataObject ClassName
in DataList at line 79
__clone()
When cloning this object, clone the dataQuery object as well
in DataList at line 92
DataQuery
dataQuery()
Return a copy of the internal {@link DataQuery} object
Because the returned value is a copy, modifying it won't affect this list's contents. If you want to alter the data query directly, use the alterDataQuery method
in DataList at line 118
DataList
alterDataQuery(callable $callback)
Return a new DataList instance with the underlying {@link DataQuery} object altered
If you want to alter the underlying dataQuery for this list, this wrapper method will ensure that you can do so without mutating the existing List object.
It clones this list, calls the passed callback function with the dataQuery of the new list as it's first parameter (and the list as it's second), then returns the list
Note that this function is re-entrant - it's safe to call this inside a callback passed to alterDataQuery
in DataList at line 154
DataList
setDataQuery(DataQuery $dataQuery)
Return a new DataList instance with the underlying {@link DataQuery} object changed
in DataList at line 168
DataList
setDataQueryParam(string|array $keyOrArray, mixed $val = null)
Returns a new DataList instance with the specified query parameter assigned
in DataList at line 189
string
sql(array $parameters = [])
Returns the SQL query that will be used to get this DataList's records. Good for debugging. :-)
in DataList at line 205
DataList
where(string|array|SQLConditionGroup $filter)
Return a new DataList instance with a WHERE clause added to this list's query.
Supports parameterised queries. See SQLSelect::addWhere() for syntax examples, although DataList won't expand multiple method arguments as SQLSelect does.
in DataList at line 224
DataList
whereAny(string|array|SQLConditionGroup $filter)
Return a new DataList instance with a WHERE clause added to this list's query.
All conditions provided in the filter will be joined with an OR
Supports parameterised queries. See SQLSelect::addWhere() for syntax examples, although DataList won't expand multiple method arguments as SQLSelect does.
in DataList at line 239
bool
canSortBy(string $fieldName)
Returns true if this DataList can be sorted by the given field.
in DataList at line 250
bool
canFilterBy(string $fieldName)
Returns true if this DataList can be filtered by the given field.
in DataList at line 281
Limitable
limit(int $limit, int $offset)
Return a new DataList instance with the records returned in this query restricted by a limit clause.
in DataList at line 294
DataList
distinct(bool $value)
Return a new DataList instance with distinct records or not
in DataList at line 315
Sortable
sort()
Return a new DataList instance as a copy of this data list with the sort order set.
in DataList at line 386
Filterable
filter()
Return a copy of this list which only includes items with these charactaristics
in DataList at line 412
$this
addFilter(array $filterArray)
Return a new instance of the list with an added filter
in DataList at line 448
Filterable
filterAny()
Return a copy of this list which contains items matching any of these charactaristics.
in DataList at line 480
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.
in DataList at line 510
$this
applyRelation(string $field, string $columnName = null, bool $linearOnly = false)
Given a field or relation name, apply it safely to this datalist.
Unlike getRelationName, this is immutable and will fallback to the quoted field name if not a relation.
in DataList at line 606
Filterable
exclude()
Return a copy of this list which does not contain any items that match all params
in DataList at line 644
$this
excludeAny()
Return a copy of this list which does not contain any items with any of these params
in DataList at line 675
DataList
subtract(DataList $list)
This method returns a copy of this list that does not contain any DataObjects that exists in $list
The $list passed needs to contain the same dataclass as $this
in DataList at line 698
DataList
innerJoin(string $table, string $onClause, string $alias = null, int $order = 20, array $parameters = [])
Return a new DataList instance with an inner join clause added to this list's query.
in DataList at line 717
DataList
leftJoin(string $table, string $onClause, string $alias = null, int $order = 20, array $parameters = [])
Return a new DataList instance with a left join clause added to this list's query.
in DataList at line 730
array
toArray()
Return an array of the actual items that this DataList contains at this stage.
This is when the query is actually executed.
in DataList at line 748
array
toNestedArray()
Return this list as an array and every object it as an sub array as well
in DataList at line 765
$this
each(callable $callback)
Walks the list using the specified callback
in DataList at line 779
Generator&DataObject[]
getGenerator()
Returns a generator for this DataList
in DataList at line 788
debug()
in DataList at line 805
Map
map(string $keyField = 'ID', string $titleField = 'Title')
Returns a map of this list
at line 130
DataObject
createDataObject(array $row)
Create a DataObject from the given SQL row.
in RelationList at line 25
array
getQueryParams()
Get query parameters for this list.
These values will be assigned as query parameters to newly created objects from this list.
in DataList at line 866
int
count()
Return the number of items in this DataList
in DataList at line 877
mixed
max(string $fieldName)
Return the maximum value of the given field in this DataList
in DataList at line 888
mixed
min(string $fieldName)
Return the minimum value of the given field in this DataList
in DataList at line 899
mixed
avg(string $fieldName)
Return the average value of the given field in this DataList
in DataList at line 910
mixed
sum(string $fieldName)
Return the sum of the values of the given field in this DataList
in DataList at line 921
mixed
first()
Returns the first item in this DataList
in DataList at line 934
mixed
last()
Returns the last item in this DataList
@return DataObject
in DataList at line 959
mixed
find(string $key, mixed $value)
Find the first DataObject of this DataList where the given key = value
in DataList at line 970
DataList
setQueriedColumns(array $queriedColumns)
Restrict the columns to fetch into this DataList
in DataList at line 983
SS_List
byIDs(array $ids)
Filter this list to only contain the given Primary IDs
in DataList at line 994
mixed
byID(int $id)
Return the first DataObject with the given ID
in DataList at line 1005
array
column(string $colName = "ID")
Returns an array of a single field value for all items in the list.
in DataList at line 1016
array
columnUnique(string $colName = "ID")
Returns a unque array of a single field value for all items in the list.
in DataList at line 1029
setByIDList(array $idList)
Sets the ComponentSet to be the given ID list.
Records will be added and deleted as appropriate.
in DataList at line 1062
array
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.
in DataList at line 1080
HasManyList|ManyManyList
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")
in DataList at line 1089
dbObject($fieldName)
in DataList at line 1100
$this
addMany(array $items)
Add a number of items to the component set.
in DataList at line 1114
$this
removeMany(array $idList)
Remove the items from this list with the given IDs
in DataList at line 1128
$this
removeByFilter(string|array $filter)
Remove every element in this DataList matching the given $filter.
in DataList at line 1141
$this
shuffle()
Shuffle the datalist using a random function provided by the SQL engine
at line 378
$this
removeAll()
Remove all items from this many-many join. To remove a subset of items, filter it first.
at line 221
add(mixed $item, array $extraFields = [])
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"]);
in DataList at line 1178
DataObject
newObject(array $initialFields = null)
Return a new item to add to this DataList.
at line 335
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.
at line 352
removeByID(int $itemID)
Remove the given item from this list.
Note that for a ManyManyList, the item is never actually deleted, only the join table is affected
in DataList at line 1229
bool
offsetExists(mixed $key)
Returns whether an item with $key exists
in DataList at line 1240
DataObject
offsetGet(mixed $key)
Returns item stored in list with index $key
in DataList at line 1251
offsetSet(mixed $key, mixed $value)
Set an item with the key in $key
in DataList at line 1261
offsetUnset(mixed $key)
Unset an item with the key in $key
in RelationList at line 20
string|array|null
getForeignID()
Any number of foreign keys to apply to this list
in RelationList at line 48
Relation
forForeignID($id)
Returns a copy of this list with the ManyMany relationship linked to the given foreign ID.
at line 418
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.
at line 460
string
getJoinTable()
Gets the join table used for the relationship.
at line 470
string
getLocalKey()
Gets the key used to store the ID of the local/parent object.
at line 480
string
getForeignKey()
Gets the key used to store the ID of the foreign/child object.
at line 490
array
getExtraFields()
Gets the extra fields included in the relationship.