RelationList

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

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().

Register an callback to invoke that defines extra methods

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

Get meta-data details on a named method

Return the names of all the methods available on this object

No description

Add all the methods from an object property (which is an Extension) to this object.

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.

No description

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().

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()).

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.

Add support for removing extensions with parameters

No description

Get extra config sources for this class

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

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

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().

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.

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

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.

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();

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

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

Get inherited config value

Gets the uninherited value for the given config option

Update the config value for a given property

Create a new DataList.

No querying is done on construction, but the initial query schema is set up.

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.

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.

Get the current failover object if set

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.

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.

Returns true if this DataList has items

No description

No description

No description

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

Generate the cache name for a field

Get a cached value from the field cache

Store a value in the field cache

Clear object 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.

Get an array of XML-escaped values by field name

Returns an Iterator for this DataList.

This function allows you to use DataLists in foreach loops

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.

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.

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

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

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

When cloning this object, clone the dataQuery object as well

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 a new DataList instance with the underlying 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

Return a new DataList instance with the underlying 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.

Supports parameterised queries. See SQLSelect::addWhere() for syntax examples, although DataList won't expand multiple method arguments as SQLSelect does.

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.

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 with distinct records or not

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 characteristics

extract the sql from $customQuery into a SQLGenerator class

Return a new instance of the list with an added filter

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

extract the sql from this method into a SQLGenerator class

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.

Unlike getRelationName, this is immutable and will fallback to the quoted field name if not a relation.

Example use (simple WHERE condition on data sitting in a related table):

 $columnName = null;
 $list = Page::get()
   ->applyRelation('TaxonomyTerms.ID', $columnName)
   ->where([$columnName => 'my value']);

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

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

Return a copy of this list which does not contain any items that match all params

extract the sql from this method into a SQLGenerator class

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

The $list passed needs to contain the same dataclass as $this

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.

This is when the query is actually executed.

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

Walks the list using the specified callback

Returns a generator for this DataList

No description

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.

Get query parameters for this list.

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

Return the number of items in this DataList

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

Returns the first item in this DataList (instanceof DataObject)

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

Returns the last item in this DataList (instanceof DataObject)

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

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

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

Restrict the columns to fetch into this DataList

Filter this list to only contain the given Primary IDs

Return the first DataObject with the given ID

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

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.

Sets the ComponentSet to be the given ID list.

Records will be added and deleted as appropriate.

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.

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

No description

Add a number of items to the component set.

Remove the items from this list with the given IDs

Remove every element in this DataList matching the given $filter.

Shuffle the datalist using a random function provided by the SQL engine

Remove every element in 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.

This doesn't factor in filters.

Remove this item by deleting it

Allow for amendment of this behaviour - for example, we can remove an item from an "ActiveItems" DataList by changing the status to inactive.

Remove an item from this DataList by ID

Reverses a list of items.

Returns whether an item with $key exists

Returns item stored in list with index $key

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

Set an item with the key in $key

Unset an item with the key in $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.

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

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

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

Any number of foreign keys to apply to this list

Returns a copy of this list with the ManyMany relationship linked to the given foreign ID.

Returns a where clause that filters the members of this relationship to just the related items.