Member_GroupSet
class Member_GroupSet extends ManyManyList (View source)
Represents a set of Groups attached to a member.
Handles the hierarchy logic.
Properties
| public | string | $class | from SS_Object | |
| protected | array | $extension_instances | from SS_Object | |
| protected | $beforeExtendCallbacks | List of callbacks to call prior to extensions having extend called on them, each grouped by methodName. |
from SS_Object | |
| protected | $afterExtendCallbacks | List of callbacks to call after extensions having extend called on them, each grouped by methodName. |
from SS_Object | |
| 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 | string | $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 | DataModel | $model | The DataModel from which this DataList comes. |
from DataList |
| protected | bool | $inAlterDataQueryCall | from DataList | |
| protected | string | $joinTable | from ManyManyList | |
| protected | string | $localKey | from ManyManyList | |
| protected | string | $foreignKey | from ManyManyList | |
| protected | array | $extraFields | from ManyManyList | |
| protected | array | $_compositeExtraFields | from ManyManyList |
Methods
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
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.
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
Create an object from a string representation. It treats it as a PHP constructor without the 'new' keyword. It also manages to construct the object without the use of eval().
Parses a class-spec, such as "Versioned('Stage','Live')", as passed to create_from_string().
Similar to Object::create(), except that classes are only overloaded if you set the $strong parameter to TRUE when using Object::useCustomClass()
This class allows you to overload classes with other classes when they are constructed using the factory method Object::create()
If a class has been overloaded, get the class name it has been overloaded with - otherwise return the class name
Get the value of a static property of a class, even in that property is declared protected (but not private), without any inheritance, merging or parent lookup if it doesn't exist on the given class.
Return TRUE if a class has a specified extension.
Add an extension to a specific class.
No description
No description
Attemps 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 methods from the ViewableData::$failover object, as well as wrapping any methods prefixed with an underscore into a ViewableData::cachedCall().
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 an extra method using raw PHP code passed as a string
Check if this class is an instance of a specific class, or has that class as one of its parents
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.
Cache the results of an instance method in this object to a file, or if it is already cache return the cached results
Clears the cache for the given cacheToFile call
Loads a cache from the filesystem if a valid on is present and within the specified lifetime
Save a piece of cached data to the file system
Strip a file name of special characters so it is suitable for use as a cache file name
Converts a field spec into an object creator. For example: "Int" becomes "new Int($fieldName);" and "Varchar(50)" becomes "new Varchar($fieldName, 50);".
Convert a field schema (e.g. "Varchar(50)") into a casting object creator array that contains both a className and castingHelper constructor code. See castingObjectCreator for more information about the constructor.
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.
Method to facilitate deprecation of underscore-prefixed methods automatically being cached.
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.
Get the class a field on this object would be casted to, as well as the casting helper for casting a field to an object (see ViewableData::castingHelper() for information on casting helpers).
Return the "casting helper" (a piece of PHP code that when evaluated creates a casted value object) for a field on this object.
Get the class name a field on this object will be casted to
Return the string-format type for the given field.
Save the casting cache for this object (including data from any failovers) into a variable
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 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.
Return the value of the field without any escaping being applied.
Return the value of a field in an SQL-safe format.
Return the value of a field in a JavaScript-save format.
Return the value of a field escaped suitable to be inserted into an XML node attribute.
Get an array of XML-escaped values by field name
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).
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 DataQuery object altered
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.
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 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 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.
Translates a Object relation name to a Database name and apply the relation join to the query. Throws an InvalidArgumentException if the $field doesn't correspond to a relation.
Return a copy of this list which does not contain any items with these charactaristics
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
Returns a map of this list
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 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.
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.
This method won't function on DataLists due to the specific query that it represent
This method won't function on DataLists due to the specific query that it represent
This method won't function on DataLists due to the specific query that it represent
This method won't function on DataLists due to the specific query that it represent
This method won't function on DataLists due to the specific query that it represent
This method won't function on DataLists due to the specific query that it represent
Returns a copy of this list with the ManyMany relationship linked to the given foreign ID.
Adds the many_many_extraFields to the select of the underlying DataQuery.
Return a filter expression for the join table when writing to the join table
Find the extra field data for a single row of the relationship join table, given the known child ID.
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.
Details
static Config_ForClass|null
config()
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
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.
static SS_Object
create()
An implementation of the factory method, allows you to create an instance of a class
This method first for strong class overloads (singletons & DB interaction), then custom class overloads. If an overload is found, an instance of this is returned rather than the original class. To overload a class, use Object::useCustomClass()
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 SS_Object
singleton()
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
create_from_string($classSpec, $firstArg = null)
Create an object from a string representation. It treats it as a PHP constructor without the 'new' keyword. It also manages to construct the object without the use of eval().
Construction itself is done with Object::create(), so that Object::useCustomClass() calls are respected.
Object::create_from_string("Versioned('Stage','Live')") will return the result of
Versioned::create('Stage', 'Live);
It is designed for simple, clonable objects. The first time this method is called for a given string it is cached, and clones of that object are returned.
If you pass the $firstArg argument, this will be prepended to the constructor arguments. It's impossible to pass null as the firstArg argument.
Object::create_from_string("Varchar(50)", "MyField") will return the result of
Vachar::create('MyField', '50');
Arguments are always strings, although this is a quirk of the current implementation rather than something that can be relied upon.
static
parse_class_spec($classSpec)
Parses a class-spec, such as "Versioned('Stage','Live')", as passed to create_from_string().
Returns a 2-elemnent array, with classname and arguments
static SS_Object
strong_create()
Similar to Object::create(), except that classes are only overloaded if you set the $strong parameter to TRUE when using Object::useCustomClass()
static
useCustomClass(string $oldClass, string $newClass, bool $strong = false)
This class allows you to overload classes with other classes when they are constructed using the factory method Object::create()
static string
getCustomClass(string $class)
If a class has been overloaded, get the class name it has been overloaded with - otherwise return the class name
static any
static_lookup($class, $name, null $default = null)
Get the value of a static property of a class, even in that property is declared protected (but not private), without any inheritance, merging or parent lookup if it doesn't exist on the given class.
static
get_static($class, $name, $uncached = false)
deprecated
deprecated
No description
static
set_static($class, $name, $value)
deprecated
deprecated
No description
static
uninherited_static($class, $name, $uncached = false)
deprecated
deprecated
No description
static
combined_static($class, $name, $ceiling = false)
deprecated
deprecated
No description
static
addStaticVars($class, $properties, $replace = false)
deprecated
deprecated
No description
static
add_static_var($class, $name, $value, $replace = false)
deprecated
deprecated
No description
static
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))
static
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.
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, bool $includeArgumentString = false)
No description
static
get_extra_config_sources($class = null)
No description
__construct(string $dataClass, $joinTable, $localKey, $foreignKey, $extraFields = array())
No description
mixed
__call(string $method, array $arguments)
Attemps 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()
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
defineMethods()
Add methods from the ViewableData::$failover object, as well as wrapping any methods prefixed with an underscore into a ViewableData::cachedCall().
protected array
findMethodsFromExtension(object $extension)
No description
protected
addMethodsFrom(string $property, string|int $index = null)
Add all the methods from an object property (which is an Extension) to this object.
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
createMethod(string $method, string $code)
Add an extra method using raw PHP code passed as a string
stat($name, $uncached = false)
No description
set_stat($name, $value)
No description
uninherited($name)
No description
bool
exists()
Returns true if this DataList has items
string
parentClass()
No description
bool
is_a(string $class)
Check if this class is an instance of a specific class, or has that class as one of its parents
string
__toString()
No description
mixed
invokeWithExtensions(string $method, mixed $argument = null)
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 $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 __construct()} in {@link defineMethods().
Extension
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(
array
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).
mixed
cacheToFile(string $method, int $lifetime = 3600, string $ID = false, array $arguments = array())
Cache the results of an instance method in this object to a file, or if it is already cache return the cached results
clearCache($method, $ID = false, $arguments = array())
Clears the cache for the given cacheToFile call
protected mixed
loadCache(string $cache, int $lifetime = 3600)
Loads a cache from the filesystem if a valid on is present and within the specified lifetime
protected
saveCache(string $cache, mixed $data)
Save a piece of cached data to the file system
protected string
sanitiseCachename(string $name)
Strip a file name of special characters so it is suitable for use as a cache file name
static string
castingObjectCreator(string $fieldSchema)
Converts a field spec into an object creator. For example: "Int" becomes "new Int($fieldName);" and "Varchar(50)" becomes "new Varchar($fieldName, 50);".
static array
castingObjectCreatorPair(string $fieldSchema)
Convert a field schema (e.g. "Varchar(50)") into a casting object creator array that contains both a className and castingHelper constructor code. See castingObjectCreator for more information about the constructor.
bool
__isset(string $property)
Check if a field exists on this object or its failover.
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.
setField(string $field, mixed $value)
Set a field on this object. This should be overloaded in child classes.
unknown
deprecatedCachedCall($method, $args = null, string $identifier = null)
Method to facilitate deprecation of underscore-prefixed methods automatically being cached.
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.
ViewableData
getCustomisedObj()
No description
setCustomisedObj(ViewableData $object)
No description
array
castingHelperPair(string $field)
Get the class a field on this object would be casted to, as well as the casting helper for casting a field to an object (see ViewableData::castingHelper() for information on casting helpers).
The returned array contains two keys:
- className: the class the field would be casted to (e.g. "Varchar")
- castingHelper: the casting helper for casting the field (e.g. "return new Varchar($fieldName)")
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.
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.
buildCastingCache(reference $cache)
Save the casting cache for this object (including data from any failovers) into a variable
HTMLText
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
objCacheName(string $fieldName, array $arguments)
Generate the cache name for a field
protected mixed
objCacheGet(string $key)
Get a cached value from the field cache
protected
objCacheSet(string $key, mixed $value)
Store a value in the field cache
obj(string $fieldName, array $arguments = null, bool $forceReturnedObject = true, 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.
cachedCall(string $field, array $arguments = null, string $identifier = null)
A simple wrapper around ViewableData::obj() that automatically caches the result so it can be used again without re-running the method.
bool
hasValue(string $field, array $arguments = null, 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.
XML_val($field, $arguments = null, $cache = false)
Get the string value of a field on this object that has been suitable escaped to be inserted directly into a template.
RAW_val($field, $arguments = null, $cache = true)
Return the value of the field without any escaping being applied.
SQL_val($field, $arguments = null, $cache = true)
Return the value of a field in an SQL-safe format.
JS_val($field, $arguments = null, $cache = true)
Return the value of a field in a JavaScript-save format.
ATT_val($field, $arguments = null, $cache = true)
Return the value of a field escaped suitable to be inserted into an XML node attribute.
array
getXMLValues($fields)
Get an array of XML-escaped values by field name
ArrayIterator
getIterator()
Returns an Iterator for this DataList.
This function allows you to use DataLists in foreach loops
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(string $subtheme = false)
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 = 'ViewableData')
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
setDataModel(DataModel $model)
Set the DataModel
string
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
DataList
alterDataQuery($callback)
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
DataList
setDataQuery(DataQuery $dataQuery)
Return a new DataList instance with the underlying DataQuery object changed
DataList
setDataQueryParam(string|array $keyOrArray, mixed $val = null)
Returns a new DataList instance with the specified query parameter assigned
sql(array $parameters = array())
Returns the SQL query that will be used to get this DataList's records. Good for debugging. :-)
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 SQLQuery::addWhere() for syntax examples, although DataList won't expand multiple method arguments as SQLQuery does.
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 SQLQuery::addWhere() for syntax examples, although DataList won't expand multiple method arguments as SQLQuery does.
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.
SS_Limitable
limit($limit, $offset = 0)
Return a new DataList instance with the records returned in this query restricted by a limit clause.
distinct(bool $value)
Return a new DataList instance with distinct records or not
SS_Sortable
sort()
Return a new DataList instance as a copy of this data list with the sort order set.
SS_Filterable
filter()
Return a copy of this list which only includes items with these charactaristics
addFilter(array $filterArray)
Return a new instance of the list with an added filter
DataList
filterAny()
Return a copy of this list which contains items matching any of these charactaristics.
SS_Filterable
filterByCallback($callback)
Note that, in the current implementation, the filtered list will be an ArrayList, but this may change in a future implementation.
string
getRelationName(string $field)
Translates a Object relation name to a Database name and apply the relation join to the query. Throws an InvalidArgumentException if the $field doesn't correspond to a relation.
SS_Filterable
exclude()
Return a copy of this list which does not contain any items with these charactaristics
DataList
subtract(SS_List $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
DataList
innerJoin(string $table, string $onClause, string $alias = null, int $order = 20, array $parameters = array())
Return a new DataList instance with an inner join clause added to this list's query.
DataList
leftJoin(string $table, string $onClause, string $alias = null, int $order = 20, array $parameters = array())
Return a new DataList instance with a left join clause added to this list's query.
array
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
mixed
each(callable $callback)
Walks the list using the specified callback
debug()
No description
array
map(string $keyField = 'ID', string $titleField = 'Title')
Returns a map of this list
protected DataObject
createDataObject(array $row)
Create a DataObject from the given SQL row.
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
mixed
first()
Returns the first item in this DataList
mixed
last()
Returns the last item in this DataList
@return DataObject
mixed
find(string $key, mixed $value)
Find the first DataObject of this DataList where the given key = value
DataList
setQueriedColumns(array $queriedColumns)
Restrict the columns to fetch into this DataList
DataList
byIDs(array $ids)
Filter this list to only contain the given Primary IDs
DataObject
byID(int $id)
Return the first DataObject with the given ID
array
column(string $colName = "ID")
Returns an array of a single field value for all items in the list.
setByIDList(array $idList)
Sets the ComponentSet 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.
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("Group")->relation("Members")
dbObject($fieldName)
No description
DataList
addMany(array $items)
Add a number of items to the component set.
DataList
removeMany(array $idList)
Remove the items from this list with the given IDs
DataList
removeByFilter(string $filter)
Remove every element in this DataList matching the given $filter.
DataList
removeAll()
Remove all items from this many-many join. To remove a subset of items, filter it first.
add(mixed $item, array $extraFields = null)
Add an item to this many_many relationship Does so by adding an entry to the joinTable.
Can also be used to update an already existing joinTable entry
Example:
$manyManyList->add($recordID, array("ExtraField"=>"value"));
newObject($initialFields = null)
Return a new item to add to this DataList.
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.
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
SS_Sortable
reverse()
Reverses a list of items.
push(mixed $item)
This method won't function on DataLists due to the specific query that it represent
insertFirst(mixed $item)
This method won't function on DataLists due to the specific query that it represent
shift()
This method won't function on DataLists due to the specific query that it represent
replace()
This method won't function on DataLists due to the specific query that it represent
merge()
This method won't function on DataLists due to the specific query that it represent
removeDuplicates()
This method won't function on DataLists due to the specific query that it represent
bool
offsetExists(mixed $key)
Returns whether an item with $key exists
DataObject
offsetGet(mixed $key)
Returns item stored in list with index $key
offsetSet(mixed $key, mixed $value)
Set an item with the key in $key
offsetUnset(mixed $key)
Unset an item with the key in $key
string|null
getForeignID()
No description
DataList
forForeignID(int|array $id)
Returns a copy of this list with the ManyMany relationship linked to the given foreign ID.
array
foreignIDFilter(array|int $id = null)
Link this group set to a specific member.
Recursively selects all groups applied to this member, as well as any parent groups of any applied groups
protected
linkJoinTable()
Setup the join between this dataobject and the necessary mapping table
protected void
appendExtraFieldsToQuery()
Adds the many_many_extraFields to the select of the underlying DataQuery.
array
foreignIDWriteFilter(array|int|null $id = null)
Return a filter expression for the join table when writing to the join table
When writing (add, remove, removeByID), we need to filter the join table to just the relevant entries. However some subclasses of ManyManyList (Member_GroupSet) modify foreignIDFilter to include additional calculated entries, so we need different filters when reading and when writing
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.
string
getJoinTable()
Gets the join table used for the relationship.
string
getLocalKey()
Gets the key used to store the ID of the local/parent object.
string
getForeignKey()
Gets the key used to store the ID of the foreign/child object.
array
getExtraFields()
Gets the extra fields included in the relationship.
protected bool
canAddGroups(array $itemIDs)
Determine if the following groups IDs can be added
protected Member
getMember()
Get foreign member record for this relation