UnsavedRelationList
class UnsavedRelationList extends ArrayList implements Relation (View source)
An {@link ArrayList} that represents an unsaved relation.
has_many and many_many relations cannot be saved until after the DataObject they're on has been written. This List pretends to be a RelationList and stores the related objects in memory.
It can store both saved objects (as IDs) or unsaved objects (as instances of $dataClass). Unsaved objects are then written when the list is saved into an instance of {@link RelationList}.
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
Properties
| static private array | $extensions | An array of extension names and parameters to be applied to this object upon construction. |
from Extensible |
| static private array | $casting | An array of objects to cast certain fields to. This is set up as an array in the format: |
from ViewableData |
| static private string | $default_cast | The default object to cast scalar fields to if casting information is not specified, and casting to an object is required. |
from ViewableData |
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 UnsavedRelationList
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
Returns an Iterator for this relation.
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 relation, ie the DataObject ClassName
Return an array of the actual items that this relation contains at this stage.
Return this list as an array and every object it as an sub array as well
Get a sub-range of this dataobjectset as an array
Add an item to this relationship
Replaces an item in this list with another item.
Merges with another array or list by pushing all the items in it onto the end of this list.
Removes items from this list which are equal.
Pushes an item onto the end of this list.
Returns the first item in the list
Returns the last item in the list
Returns a map of this list
Find the first item of this list 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.
Sorts this list by one or more fields. You can either pass in a single field name and direction, or a map of field names to sort directions.
Returns true if the given column can be used to filter the records.
Return a copy of this list which contains items matching any of these charactaristics.
Add a number of items to the relation.
Remove all items from this relation.
Remove the items from this list with the given IDs
Sets the Relation to be the given ID list.
Returns an array with both the keys and values set to the IDs of the records in this list.
Returns a copy of this list with the relationship linked to the given foreign ID.
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 {@link Extensions}, {@link Object::createMethod()} or {@link Object::addWrapperMethod()}
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
array
allMethodNames(bool $custom = false)
Return the names of all the methods available on this object
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()}).
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.
static array
get_extensions(string $class = null, bool $includeArgumentString = false)
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 {@link 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 {@link __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 {@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(
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.
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();
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
stat(string $name)
deprecated
deprecated
Get inherited config value
mixed
uninherited(string $name)
Gets the uninherited value for the given config option
$this
set_stat(string $name, mixed $value)
deprecated
deprecated
Update the config value for a given property
__construct(string $baseClass, string $relationName, string $dataClass)
Create a new UnsavedRelationList
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 {@link 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 {@link 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.
defineMethods()
Add methods from the {@link ViewableData::$failover} object, as well as wrapping any methods prefixed with an underscore into a {@link ViewableData::cachedCall()}.
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.
bool
exists()
Returns true if this list has items
string
__toString()
ViewableData
getCustomisedObj()
setCustomisedObj(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.
string
castingClass(string $field)
Get the class name a field on this object will be casted to.
string
escapeTypeForField(string $field)
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
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 $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.
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)
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)
Get an array of XML-escaped values by field name
ArrayIterator
getIterator()
Returns an Iterator for this relation.
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
ThemeDir()
deprecated
deprecated
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.
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".
ViewableData_Debugger
Debug()
Return debug information about this object that can be rendered into a template
string
dataClass()
Get the dataClass name for this relation, ie the DataObject ClassName
$this
setDataClass(string $class)
Hint this list to a specific type
int
count()
Return the number of items in this list
array
toArray()
Return an array of the actual items that this relation contains at this stage.
This is when the query is actually executed.
$this
each(callable $callback)
Walks the list using the specified callback
debug()
array
toNestedArray()
Return this list as an array and every object it as an sub array as well
Limitable
limit(int $length, int $offset = 0)
Get a sub-range of this dataobjectset as an array
add(mixed $item, array $extraFields = null)
Add an item to this relationship
remove(mixed $item)
Remove this item from this list
replace(array|object $item, array|object $with)
Replaces an item in this list with another item.
merge(array|object $with)
Merges with another array or list by pushing all the items in it onto the end of this list.
$this
removeDuplicates(string $field = 'ID')
Removes items from this list which are equal.
push(array|object $item, array $extraFields = null)
Pushes an item onto the end of this list.
array|object
pop()
Pops the last element off the end of the list and returns it.
unshift(array|object $item)
Add an item onto the beginning of the list.
array|object
shift()
Shifts the item off the beginning of the list and returns it.
mixed
first()
Returns the first item in the list
mixed
last()
Returns the last item in the list
Map
map(string $keyfield = 'ID', string $titlefield = 'Title')
Returns a map of this list
mixed
find(string $key, mixed $value)
Find the first item of this list where the given key = value
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.
bool
canSortBy(string $by)
You can always sort a ArrayList
Sortable
reverse()
Reverses an {@link ArrayList}
Sortable
sort()
Sorts this list by one or more fields. You can either pass in a single field name and direction, or a map of field names to sort directions.
Note that columns may be double quoted as per ANSI sql standard
$this
shuffle()
Shuffle the items in this array list
bool
canFilterBy(string $by)
Returns true if the given column can be used to filter the records.
It works by checking the fields available in the first record of the list.
Filterable
filter()
Filter the list to include items with these charactaristics
Filterable
filterAny()
Return a copy of this list which contains items matching any of these charactaristics.
SS_List
byIDs(array $ids)
Filter this list to only contain the given Primary IDs
mixed
byID(int $id)
Return the first item with the given ID
Filterable
filterByCallback(callable $callback)
Filterable
exclude()
Exclude the list to not contain items with these charactaristics
bool
offsetExists(mixed $offset)
Returns whether an item with $key exists
DataObject
offsetGet(mixed $offset)
Returns item stored in list with index $key
offsetSet(mixed $offset, mixed $value)
Set an item with the key in $key
offsetUnset(mixed $offset)
Unset an item with the key in $key
changeToList(RelationList $list)
Save all the items in this list into the RelationList
$this
addMany(array $items)
Add a number of items to the relation.
removeAll()
Remove all items from this relation.
$this
removeMany(array $items)
Remove the items from this list with the given IDs
setByIDList(array $idList)
Sets the Relation to be the given ID list.
Records will be added and deleted as appropriate.
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. Does not return the IDs for unsaved DataObjects.
Relation
forForeignID(mixed $id)
Returns a copy of this list with the relationship linked to the given foreign ID.
Relation
relation(mixed $relationName)
DBField
dbObject(string $fieldName)
Return the DBField object that represents the given field on the related class.