RelationList
abstract class RelationList extends DataList implements Relation (View source)
A DataList that represents a relation.
Adds the notion of a foreign ID that can be optionally set.
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 | |
| require_sudo_mode | bool | Config of whether the model requires sudo mode to be active in order to be modified in admin Sudo mode is a security feature that requires the user to re-enter their password before making changes to the database. |
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 | ||
| protected | CallbackList|null | $removeCallbacks |
Methods
Attempts to locate and call a method dynamically added to a class at runtime if a default cannot be located
Adds any methods from Extension instances attached to this object.
Register an callback to invoke that defines extra methods
Return TRUE if a method exists on this object
Determines if a custom method with this name is defined.
Get meta-data details on a named method
Return the names of all the methods available on this object
Get all public built in methods for this class
Find all methods on the given object.
Add all the methods from an object property.
Add all the methods from an object property (which is an Extension) to this object.
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)
Add callback as a method.
Allows user code to hook into Object::extend prior to control being delegated to extensions. Each callback will be reset once called.
Allows user code to hook into Object::extend after control being delegated to extensions. Each callback will be reset once called.
Adds any methods from Extension instances attached to 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 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 $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.
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
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 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 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.
Whether the model requires sudo mode to be active in order to be modified in admin
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.
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.
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
Store a value in the field cache
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 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.
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
Given a filter expression and value construct a {SearchFilter} instance
Get the dataClass name for this DataList, ie the DataObject ClassName
Returns the SQL query that will be used to get this DataList's records. Good for debugging. :-)
Returns true if this DataList can be sorted by the given field.
Returns true if this DataList can be filtered by the given field.
Note that, in the current implementation, the filtered list will be an ArrayList, but this may change in a future implementation.
Check if the given field specification could be interpreted as an unquoted relation name
No description
No description
No description
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
Returns a map of this list
Create a DataObject from the given SQL row If called without $row['ID'] set, then a new object will be created rather than rehydrated.
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
Returns an array of a single field value for all items in the list.
Returns a unique array of a single field value for all 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.
This method are overloaded by HasManyList and ManyMany list to perform more sophisticated list manipulation
Return a new item to add to this DataList.
Returns item stored in list with index $key
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.
Manage callbacks which are called after the add() action is completed.
Manage callbacks which are called after the remove() action is completed.
Returns a where clause that filters the members of this relationship to just the related items.
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
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()
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
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
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
array
allMethodNames(bool $custom = false)
Return the names of all the methods available on this object
static protected 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.
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()).
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.
static array
get_extensions(string $class = null, bool $includeArgumentString = false)
No description
static array|null
get_extra_config_sources(string $class = null)
Get extra config sources for this class
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))
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
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().
Extension|null
getExtensionInstance(string $extension)
Get an extension instance attached to this object by name.
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(
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.
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();
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).
static Config_ForClass
config()
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
mixed
uninherited(string $name)
Gets the uninherited value for the given config option
__construct(T> $dataClass)
Create a new DataList.
No querying is done on construction, but the initial query schema is set up.
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.
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.
__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.
setFailover(ViewableData $failover)
Set a failover object to attempt to get data from if it is not present on this object.
ViewableData|null
getFailover()
Get the current failover object if set
bool
hasField(string $field)
Check if a field exists on this object. This should be overloaded in child classes.
mixed
getField(string $field)
Get the value of a field on this object. This should be overloaded in child classes.
$this
setField(string $field, mixed $value)
Set a field on this object. This should be overloaded in child classes.
mixed
getDynamicData(string $field)
No description
ViewableData
setDynamicData(string $field, mixed $value)
No description
bool
hasDynamicData(string $field)
No description
bool
getRequireSudoMode()
Whether the model requires sudo mode to be active in order to be modified in admin
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.
bool
exists()
Returns true if this DataList has items
string
__toString()
No description
ViewableData
getCustomisedObj()
No description
setCustomisedObj(ViewableData $object)
No description
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.
string
castingClass(string $field)
deprecated
deprecated 5.4.0 Will be removed without equivalent functionality to replace it.
Get the class name a field on this object will be casted to.
string
escapeTypeForField(string $field)
deprecated
deprecated 5.4.0 Will be removed without equivalent functionality to replace it.
Return the string-format type for the given field.
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
protected string
objCacheName(string $fieldName, array $arguments)
deprecated
deprecated 5.4.0 Will be made private
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
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.
object|DBField
cachedCall(string $fieldName, array $arguments = [], string $identifier = null)
deprecated
deprecated 5.4.0 use obj() instead
A simple wrapper around ViewableData::obj() that automatically caches the result so it can be used again without re-running the method.
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.
string
XML_val(string $field, array $arguments = [], bool $cache = false)
deprecated
deprecated 5.4.0 Will be removed without equivalent functionality to replace it
Get the string value of a field on this object that has been suitable escaped to be inserted directly into a template.
array
getXMLValues(array $fields)
deprecated
deprecated 5.4.0 Will be removed without equivalent functionality to replace it
Get an array of XML-escaped values by field name
Traversable
getIterator()
Returns an Iterator for this DataList.
This function allows you to use DataLists in foreach loops
array
getViewerTemplates(string $suffix = '')
Find appropriate templates for SSViewer to use to render this object
ViewableData
Me()
When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.
string
CSSClasses(string $stopAtClass = ViewableData::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".
ViewableData_Debugger
Debug()
Return debug information about this object that can be rendered into a template
protected SearchFilter
createSearchFilter(string $filter, mixed $value)
Given a filter expression and value construct a {SearchFilter} instance
T>
dataClass()
Get the dataClass name for this DataList, ie the DataObject ClassName
__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
alterDataQuery($callback)
No description
setDataQuery(DataQuery $dataQuery)
No description
setDataQueryParam($keyOrArray, $val = null)
No description
string
sql(array $parameters = [])
Returns the SQL query that will be used to get this DataList's records. Good for debugging. :-)
where($filter)
No description
whereAny($filter)
No description
bool
canSortBy(string $fieldName)
Returns true if this DataList can be sorted by the given field.
bool
canFilterBy(string $fieldName)
Returns true if this DataList can be filtered by the given field.
Limitable
limit(int|null $length, int $offset = 0)
No description
distinct($value)
No description
sort(...$args)
No description
DataList
orderBy(string $orderBy)
No description
filter()
No description
addFilter($filterArray)
No description
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.
applyRelation($field, $columnName = null, $linearOnly = false)
No description
protected bool
isValidRelationName(string $field)
Check if the given field specification could be interpreted as an unquoted relation name
exclude()
No description
excludeAny()
No description
subtract(DataList $list)
No description
innerJoin($table, $onClause, $alias = null, $order = 20, $parameters = [])
No description
leftJoin($table, $onClause, $alias = null, $order = 20, $parameters = [])
No description
rightJoin($table, $onClause, $alias = null, $order = 20, $parameters = [])
No description
T[]
toArray()
Return an array of the actual items that this DataList contains at this stage.
This is when the query is actually executed.
array
toNestedArray()
Return this list as an array and every object it as an sub array as well
each($callback)
No description
debug()
No description
Map
map(string $keyField = 'ID', string $titleField = 'Title')
Returns a map of this list
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.
array
getQueryParams()
Get query parameters for this list.
These values will be assigned as query parameters to newly created objects from this list.
DataList
eagerLoad(...$relationChains)
No description
int
count()
Return the number of items in this DataList
mixed
max(string $fieldName)
Return the maximum value of the given field in this DataList
mixed
min(string $fieldName)
Return the minimum value of the given field in this DataList
mixed
avg(string $fieldName)
Return the average value of the given field in this DataList
mixed
sum(string $fieldName)
Return the sum of the values of the given field in this DataList
T|null
first()
Returns the first item in this DataList
The object returned is not cached, unlike DataObject::get_one()
T|null
last()
Returns the last item in this DataList
The object returned is not cached, unlike DataObject::get_one()
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()
setQueriedColumns($queriedColumns)
No description
byIDs($ids)
No description
T|null
byID(int $id)
Return the first DataObject with the given ID
The object returned is not cached, unlike DataObject::get_by_id()
array
column(string $colName = "ID")
Returns an array of a single field value for all items in the list.
array
columnUnique(string $colName = "ID")
Returns a unique array of a single field value for all items in the list.
setByIDList(int[] $idList)
Sets the ComponentSet to be the given ID list.
Records will be added and deleted as appropriate.
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.
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")
dbObject($fieldName)
No description
addMany($items)
No description
removeMany($idList)
No description
removeByFilter($filter)
No description
shuffle()
No description
removeAll()
No description
add(mixed $item)
This method are overloaded by HasManyList and ManyMany list to perform more sophisticated list manipulation
T
newObject(array $initialFields = null)
Return a new item to add to this DataList.
remove(mixed $item)
Remove this item by deleting it
removeByID(int $itemID)
Remove an item from this DataList by ID
reverse()
No description
bool
offsetExists(mixed $key)
Returns whether an item with $key exists
DataObject|null
offsetGet(mixed $key)
Returns item stored in list with index $key
The object returned is not cached, unlike DataObject::get_one()
void
offsetSet(mixed $key, mixed $value)
Set an item with the key in $key
void
offsetUnset(mixed $key)
Unset an item with the key in $key
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.
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
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
string|array|null
getForeignID()
Any number of foreign keys to apply to this list
Relation
forForeignID(mixed $id)
No description
abstract protected array
foreignIDFilter(array|int $id = null)
Returns a where clause that filters the members of this relationship to just the related items.
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