DataQuery

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

Determines if a custom method with this name is defined.

Get meta-data details on a named method

Return the names of all the methods available on this object

Get all public built in methods for this class

Find all methods on the given object.

Add all the methods from an object property.

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.

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.

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.

Create a new DataQuery.

Clone this object

Return the DataObject class that is being queried.

Return the SQLSelect object that represents the current query; note that it will be a clone of the object.

Remove a filter from the query

Set up the simplest initial query

No description

Ensure that the query is ready to execute.

Ensure that if a query has an order by clause, those columns are present in the select.

Execute the query and return the result as SS_Query object.

Return this query's SQL

Return the number of records in this query.

Note that this will issue a separate SELECT COUNT() query.

Return whether this dataquery will have records. This will use EXISTS statements in SQL which are more performant - especially when used in combination with indexed columns (that you're filtering on)

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

Runs a raw aggregate expression. Please handle escaping yourself

Return the first row that would be returned by this full DataQuery Note that this will issue a separate SELECT ... LIMIT 1 query.

Return the last row that would be returned by this full DataQuery Note that this will issue a separate SELECT ... LIMIT query.

Update the SELECT clause of the query with the columns from the given table

Append a GROUP BY clause to this query.

Append a HAVING clause to this query.

Add a query to UNION with.

Create a disjunctive subgroup.

That is a subgroup joined by OR

Create a conjunctive subgroup

That is a subgroup joined by AND

Adds a Common Table Expression (CTE), aka WITH clause.

Use of this method should usually be within a conditional check against DB::get_conn()->supportsCteQueries().

Adds a WHERE clause.

Append a WHERE with OR.

Set the ORDER BY clause of this query

Note: while the similarly named DataList::sort() does not allow raw SQL, DataQuery::sort() does allow it

Raw SQL can be vulnerable to SQL injection attacks if used incorrectly, so it's preferable not to use it

Reverse order by clause

Set the limit of this query.

Set whether this query should be distinct or not.

Add an INNER JOIN clause to this query.

Add a LEFT JOIN clause to this query.

Add a RIGHT JOIN clause to this query.

Prefix of all joined table aliases. E.g. ->filter('Banner.Image.Title)' Will join the Banner, and then Image relations $relationPrefx will be banner_image_ Each table in the Image chain will be suffixed to this prefix. E.g.

banner_image_File and banner_image_Image

This will be null if no relation is joined. E.g. ->filter('Title')

Traverse the relationship fields, and add the table mappings to the query object state. This has to be called in any overloaded SearchFilter->apply() methods manually.

Note, that in order to filter against the joined relation user code must use {\SilverStripe\ORM\tablePrefix()} to get the table alias used for this relation.

Join the given has_many relation to this query.

Also works with belongs_to

Join the given class to this query with the given key

Join table via many_many relationship

Removes the result of query from this query.

Select the only given fields from the given table.

Add the given fields from the given table to the select statement.

Query the given field column from the database and return as an array.

querying DB columns of related tables is supported but you need to make sure that the related table is already available in join

No description

Select the given field expressions.

Set an arbitrary query parameter, that can be used by decorators to add additional meta-data to the query.

It's expected that the $key will be namespaced, e.g, 'Versioned.stage' instead of just 'stage'.

Set an arbitrary query parameter, that can be used by decorators to add additional meta-data to the query.

Returns all query parameters

Get query manipulators

Assign callback to be invoked in getFinalisedQuery()

Get whether field statements aliased as columns are allowed when that column is already being selected

Set whether field statements aliased as columns are allowed when that column is already being selected