ManyManyThroughQueryManipulator
class ManyManyThroughQueryManipulator implements DataQueryManipulator (View source)
Injected into DataQuery to augment getFinalisedQuery() with a join table
Traits
A class that can be instantiated or replaced via DI
Properties
| protected | string | $joinClass | DataObject that backs the joining table |
|
| protected | string | $localKey | Key that joins to the data class |
|
| protected | string | $foreignKey | Key that joins to the parent class |
|
| protected | string | $foreignClass | Foreign class 'from' property. Normally not needed unless polymorphic. |
|
| protected | string | $parentClass | Class name of instance that owns this list |
Methods
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
Build query manipulator for a given join table. Additional parameters (foreign key, etc) will be inferred at evaluation from query parameters set via the ManyManyThroughList
Gets Class key name for foreign key component (or null if none)
Get has_many relationship between parent and join table (for a given DataQuery)
Calculate the query parameters that should be inherited from the base many_many to the nested has_many list.
Invoked prior to getFinalisedQuery()
Invoked after getFinalisedQuery()
Details
static Injectable
create(mixed ...$args)
An implementation of the factory method, allows you to create an instance of a class
This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.
This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create(SiteTree::class); $list = SiteTree::get();
static Injectable
singleton(string $class = null)
Creates a class instance by the "singleton" design pattern.
It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).
__construct(string $joinClass, string $localKey, string $foreignKey, string $foreignClass = null, string $parentClass = null)
Build query manipulator for a given join table. Additional parameters (foreign key, etc) will be inferred at evaluation from query parameters set via the ManyManyThroughList
string
getJoinClass()
No description
$this
setJoinClass(mixed $joinClass)
No description
string
getLocalKey()
No description
$this
setLocalKey(string $localKey)
No description
string
getForeignKey()
No description
string
getForeignIDKey()
Gets ID key name for foreign key component
string|null
getForeignClassKey()
Gets Class key name for foreign key component (or null if none)
$this
setForeignKey(string $foreignKey)
No description
HasManyList
getParentRelationship(DataQuery $query)
Get has_many relationship between parent and join table (for a given DataQuery)
mixed
extractInheritableQueryParameters(DataQuery $query)
Calculate the query parameters that should be inherited from the base many_many to the nested has_many list.
string
getJoinAlias()
Get name of join table alias for use in queries.
beforeGetFinalisedQuery(DataQuery $dataQuery, array $queriedColumns, SQLSelect $sqlSelect)
Invoked prior to getFinalisedQuery()
afterGetFinalisedQuery(DataQuery $dataQuery, array $queriedColumns, SQLSelect $sqlQuery)
Invoked after getFinalisedQuery()
string
getForeignClass()
No description
$this
setForeignClass(string $foreignClass)
No description
string
getParentClass()
No description
ManyManyThroughQueryManipulator
setParentClass(string $parentClass)
No description