HasManyList
class HasManyList extends RelationList
Subclass of {@link DataList} representing a has_many relation.
Properties
| string | $class | from SS_Object |
Methods
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .
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 {@link Object::create()}, except that classes are only overloaded if you set the $strong parameter to TRUE when using {@link Object::useCustomClass()}
This class allows you to overload classes with other classes when they are constructed using the factory method {@link 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
Create a new HasManyList object.
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
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 {@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.
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
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 {@link 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 {@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()}.
Method to facilitate deprecation of underscore-prefixed methods automatically being cached.
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.
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 {@link 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
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.
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.
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 {@link DataQuery} object altered
Return a new DataList instance with the underlying {@link DataQuery} object changed
Returns a new DataList instance with the specified query parameter assigned
Returns the SQL query that will be used to get this DataList's records. Good for debugging. :-)
Return a new DataList instance with a WHERE clause added to this list's query.
Return a new DataList instance with a WHERE clause added to this list's query.
Returns true if this DataList can be sorted by the given field.
Returns true if this DataList can be filtered by the given field.
Return a new DataList instance with the records returned in this query restricted by a limit clause.
Return a new DataList instance as a copy of this data list with the sort order set.
Return a copy of this list which only includes items with these charactaristics
Return a 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 {@link 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
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.
Adds the item to this relation.
Remove an item from this relation.
Remove an item from this relation.
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.
Gets the field name which holds the related object ID.
Details
in SS_Object at line 60
static Config_ForClass|null
config()
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .
....).
in SS_Object at line 132
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 {@link 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();
in SS_Object at line 155
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).
in SS_Object at line 190
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.
in SS_Object at line 215
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
in SS_Object at line 341
static SS_Object
strong_create()
Similar to {@link Object::create()}, except that classes are only overloaded if you set the $strong parameter to TRUE when using {@link Object::useCustomClass()}
in SS_Object at line 361
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 {@link Object::create()}
in SS_Object at line 375
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
in SS_Object at line 396
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.
in SS_Object at line 436
static
get_static($class, $name, $uncached = false)
deprecated
deprecated
in SS_Object at line 444
static
set_static($class, $name, $value)
deprecated
deprecated
in SS_Object at line 452
static
uninherited_static($class, $name, $uncached = false)
deprecated
deprecated
in SS_Object at line 460
static
combined_static($class, $name, $ceiling = false)
deprecated
deprecated
in SS_Object at line 470
static
addStaticVars($class, $properties, $replace = false)
deprecated
deprecated
in SS_Object at line 478
static
add_static_var($class, $name, $value, $replace = false)
deprecated
deprecated
in SS_Object at line 494
static
has_extension(string $classOrExtension, string $requiredExtension = null, boolean $strict = false)
Return TRUE if a class has a specified extension.
This supports backwards-compatible format (static Object::has_extension($requiredExtension)) and new format ($object->has_extension($class, $requiredExtension))
in SS_Object at line 536
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 {@link Object::$extensions} array. See {@link SiteTree::$extensions} for examples. Keep in mind that the extension will only be applied to new instances, not existing ones (including all instances created through {@link singleton()}).
in SS_Object at line 594
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 {@link Object} instances which are already created, but will have an effect on new extensions. Clears any previously created singletons through {@link singleton()} to avoid side-effects from stale extension information.
in SS_Object at line 633
static array
get_extensions(string $class, bool $includeArgumentString = false)
in SS_Object at line 655
static
get_extra_config_sources($class = null)
at line 25
__construct(string $dataClass, string $foreignKey)
Create a new HasManyList object.
Generation of the appropriate record set is left up to the caller, using the normal {@link DataList} methods. Addition arguments are used to support {@@link add()} and {@link remove()} methods.
in SS_Object at line 725
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 {@link Extensions}, {@link Object::createMethod()} or {@link Object::addWrapperMethod()}
in SS_Object at line 792
bool
hasMethod(string $method)
Return TRUE if a method exists on this object
This should be used rather than PHP's inbuild method_exists() as it takes into account methods added via extensions
in SS_Object at line 802
array
allMethodNames(bool $custom = false)
Return the names of all the methods available on this object
in SS_Object at line 963
stat($name, $uncached = false)
in SS_Object at line 970
set_stat($name, $value)
in SS_Object at line 977
uninherited($name)
in DataList at line 840
bool
exists()
Returns true if this DataList has items
in SS_Object at line 998
string
parentClass()
in SS_Object at line 1008
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
in SS_Object at line 1015
string
__toString()
in SS_Object at line 1030
mixed
invokeWithExtensions(string $method, mixed $argument = null)
Calls a method if available on both this object and all applied {@link Extensions}, and then attempts to merge all results into an array
in SS_Object at line 1058
array
extend(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = null)
Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed
Currently returns an array, with an index resulting every time the function is called. Only adds returns if they're not NULL, to avoid bogus results from methods just defined on the parent extension. This is important for permission-checks through extend, as they use min() to determine if any of the returns is FALSE. As min() doesn't do type checking, an included NULL return would fail the permission checks.
The extension methods are defined during {@link __construct()} in {@link defineMethods()}.
in SS_Object at line 1097
Extension
getExtensionInstance(string $extension)
Get an extension instance attached to this object by name.
in SS_Object at line 1115
bool
hasExtension(string $extension)
Returns TRUE if this object instance has a specific extension applied in {@link $extension_instances}. Extension instances are initialized at constructor time, meaning if you use {@link add_extension()} afterwards, the added extension will just be added to new instances of the extended class. Use the static method {@link has_extension()} to check if a class (not an instance) has a specific extension.
Caution: Don't use singleton(
in SS_Object at line 1126
array
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).
in SS_Object at line 1142
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
in SS_Object at line 1171
clearCache($method, $ID = false, $arguments = array())
Clears the cache for the given cacheToFile call
in ViewableData at line 72
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);".
in ViewableData at line 83
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 {@link castingObjectCreator} for more information about the constructor.
in ViewableData at line 95
bool
__isset(string $property)
Check if a field exists on this object or its failover.
in ViewableData at line 117
mixed
__get(string $property)
Get the value of a property/field on this object. This will check if a method called get{$property} exists, then check if a field is available using {@link ViewableData::getField()}, then fall back on a failover object.
in ViewableData at line 138
__set(string $property, mixed $value)
Set a property/field on this object. This will check for the existence of a method called set{$property}, then use the {@link ViewableData::setField()} method.
in ViewableData at line 151
setFailover(ViewableData $failover)
Set a failover object to attempt to get data from if it is not present on this object.
in ViewableData at line 166
ViewableData|null
getFailover()
Get the current failover object if set
in ViewableData at line 176
bool
hasField(string $field)
Check if a field exists on this object. This should be overloaded in child classes.
in ViewableData at line 186
mixed
getField(string $field)
Get the value of a field on this object. This should be overloaded in child classes.
in ViewableData at line 196
setField(string $field, mixed $value)
Set a field on this object. This should be overloaded in child classes.
in ViewableData at line 206
defineMethods()
Add methods from the {@link ViewableData::$failover} object, as well as wrapping any methods prefixed with an underscore into a {@link ViewableData::cachedCall()}.
in ViewableData at line 236
unknown
deprecatedCachedCall($method, $args = null, $identifier = null)
Method to facilitate deprecation of underscore-prefixed methods automatically being cached.
in ViewableData at line 255
ViewableData_Customised
customise(array|ViewableData $data)
Merge some arbitrary data in with this object. This method returns a {@link ViewableData_Customised} instance with references to both this and the new custom data.
Note that any fields you specify will take precedence over the fields on this object.
in ViewableData at line 272
ViewableData
getCustomisedObj()
in ViewableData at line 279
setCustomisedObj(ViewableData $object)
in ViewableData at line 296
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 {@link 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)")
in ViewableData at line 308
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.
in ViewableData at line 331
string
castingClass(string $field)
Get the class name a field on this object will be casted to
in ViewableData at line 346
string
escapeTypeForField(string $field)
Return the string-format type for the given field.
in ViewableData at line 357
buildCastingCache(reference $cache)
Save the casting cache for this object (including data from any failovers) into a variable
in ViewableData at line 394
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
in ViewableData at line 456
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.
in ViewableData at line 503
cachedCall(string $field, array $arguments = null, string $identifier = null)
A simple wrapper around {@link ViewableData::obj()} that automatically caches the result so it can be used again without re-running the method.
in ViewableData at line 516
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.
in ViewableData at line 538
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.
in ViewableData at line 546
RAW_val($field, $arguments = null, $cache = true)
Return the value of the field without any escaping being applied.
in ViewableData at line 553
SQL_val($field, $arguments = null, $cache = true)
Return the value of a field in an SQL-safe format.
in ViewableData at line 560
JS_val($field, $arguments = null, $cache = true)
Return the value of a field in a JavaScript-save format.
in ViewableData at line 567
ATT_val($field, $arguments = null, $cache = true)
Return the value of a field escaped suitable to be inserted into an XML node attribute.
in ViewableData at line 579
array
getXMLValues($fields)
Get an array of XML-escaped values by field name
in DataList at line 759
ArrayIterator
getIterator()
Returns an Iterator for this DataList.
This function allows you to use DataLists in foreach loops
in ViewableData at line 611
ViewableData
Me()
When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.
in ViewableData at line 627
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.
in ViewableData at line 648
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".
in ViewableData at line 671
ViewableData_Debugger
Debug()
Return debug information about this object that can be rendered into a template
in DataList at line 74
string
dataClass()
Get the dataClass name for this DataList, ie the DataObject ClassName
in DataList at line 81
__clone()
When cloning this object, clone the dataQuery object as well
in DataList at line 93
DataQuery
dataQuery()
Return a copy of the internal {@link DataQuery} object
Because the returned value is a copy, modifying it won't affect this list's contents. If you want to alter the data query directly, use the alterDataQuery method
in DataList at line 117
DataList
alterDataQuery($callback)
Return a new DataList instance with the underlying {@link DataQuery} object altered
If you want to alter the underlying dataQuery for this list, this wrapper method will ensure that you can do so without mutating the existing List object.
It clones this list, calls the passed callback function with the dataQuery of the new list as it's first parameter (and the list as it's second), then returns the list
Note that this function is re-entrant - it's safe to call this inside a callback passed to alterDataQuery
in DataList at line 150
DataList
setDataQuery(DataQuery $dataQuery)
Return a new DataList instance with the underlying {@link DataQuery} object changed
in DataList at line 163
DataList
setDataQueryParam(string|array $keyOrArray, mixed $val = null)
Returns a new DataList instance with the specified query parameter assigned
in DataList at line 184
sql($parameters = array())
Returns the SQL query that will be used to get this DataList's records. Good for debugging. :-)
in DataList at line 199
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.
in DataList at line 217
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.
in DataList at line 231
bool
canSortBy(string $fieldName)
Returns true if this DataList can be sorted by the given field.
in DataList at line 241
bool
canFilterBy(string $fieldName)
Returns true if this DataList can be filtered by the given field.
in DataList at line 266
SS_Limitable
limit($limit, $offset)
Return a new DataList instance with the records returned in this query restricted by a limit clause.
in DataList at line 277
distinct(bool $value)
Return a new DataList instance with distinct records or not
in DataList at line 297
SS_Sortable
sort()
Return a new DataList instance as a copy of this data list with the sort order set.
in DataList at line 372
SS_Filterable
filter()
Return a copy of this list which only includes items with these charactaristics
in DataList at line 390
addFilter(array $filterArray)
Return a new instance of the list with an added filter
in DataList at line 428
DataList
filterAny()
Return a copy of this list which contains items matching any of these charactaristics.
in DataList at line 475
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.
in DataList at line 499
string
getRelationName(string $field)
Translates a {@link 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.
in DataList at line 565
SS_Filterable
exclude()
Return a copy of this list which does not contain any items with these charactaristics
in DataList at line 612
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
in DataList at line 634
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.
in DataList at line 652
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.
in DataList at line 664
array
toArray()
Return an array of the actual items that this DataList contains at this stage.
This is when the query is actually executed.
in DataList at line 681
array
toNestedArray()
Return this list as an array and every object it as an sub array as well
in DataList at line 697
mixed
each(callable $callback)
Walks the list using the specified callback
in DataList at line 705
debug()
in DataList at line 722
array
map(string $keyField = 'ID', string $titleField = 'Title')
Returns a map of this list
in DataList at line 768
int
count()
Return the number of items in this DataList
in DataList at line 778
mixed
max(string $fieldName)
Return the maximum value of the given field in this DataList
in DataList at line 788
mixed
min(string $fieldName)
Return the minimum value of the given field in this DataList
in DataList at line 798
mixed
avg(string $fieldName)
Return the average value of the given field in this DataList
in DataList at line 808
mixed
sum(string $fieldName)
Return the sum of the values of the given field in this DataList
in DataList at line 818
mixed
first()
Returns the first item in this DataList
in DataList at line 829
mixed
last()
Returns the last item in this DataList
@return DataObject
in DataList at line 851
mixed
find(string $key, mixed $value)
Find the first DataObject of this DataList where the given key = value
in DataList at line 861
DataList
setQueriedColumns(array $queriedColumns)
Restrict the columns to fetch into this DataList
in DataList at line 873
DataList
byIDs(array $ids)
Filter this list to only contain the given Primary IDs
in DataList at line 883
DataObject
byID(int $id)
Return the first DataObject with the given ID
in DataList at line 893
array
column(string $colName = "ID")
Returns an array of a single field value for all items in the list.
in DataList at line 905
setByIDList(array $idList)
Sets the ComponentSet to be the given ID list.
Records will be added and deleted as appropriate.
in DataList at line 935
array
getIDList()
Returns an array with both the keys and values set to the IDs of the records in this list.
Does not respect sort order. Use ->column("ID") to get an ID list with the current sort.
in DataList at line 952
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")
in DataList at line 957
dbObject($fieldName)
in DataList at line 980
DataList
removeMany(array $idList)
Remove the items from this list with the given IDs
in DataList at line 993
DataList
removeByFilter(string $filter)
Remove every element in this DataList matching the given $filter.
at line 69
add(mixed $item)
Adds the item to this relation.
It does so by setting the relationFilters.
in DataList at line 1028
newObject($initialFields = null)
Return a new item to add to this DataList.
at line 114
remove(mixed $item)
Remove an item from this relation.
Doesn't actually remove the item, it just clears the foreign key value.
at line 101
removeByID(int $itemID)
Remove an item from this relation.
Doesn't actually remove the item, it just clears the foreign key value.
in DataList at line 1063
SS_Sortable
reverse()
Reverses a list of items.
in DataList at line 1074
push(mixed $item)
This method won't function on DataLists due to the specific query that it represent
in DataList at line 1083
insertFirst(mixed $item)
This method won't function on DataLists due to the specific query that it represent
in DataList at line 1091
shift()
This method won't function on DataLists due to the specific query that it represent
in DataList at line 1099
replace()
This method won't function on DataLists due to the specific query that it represent
in DataList at line 1107
merge()
This method won't function on DataLists due to the specific query that it represent
in DataList at line 1115
removeDuplicates()
This method won't function on DataLists due to the specific query that it represent
in DataList at line 1126
bool
offsetExists(mixed $key)
Returns whether an item with $key exists
in DataList at line 1136
DataObject
offsetGet(mixed $key)
Returns item stored in list with index $key
in DataList at line 1146
offsetSet(mixed $key, mixed $value)
Set an item with the key in $key
in DataList at line 1155
offsetUnset(mixed $key)
Unset an item with the key in $key
in RelationList at line 16
string|null
getForeignID()
in RelationList at line 28
DataList
forForeignID(int|array $id)
Returns a copy of this list with the ManyMany relationship linked to the given foreign ID.
at line 36
string
getForeignKey()
Gets the field name which holds the related object ID.