QueryRecorderExtension
class QueryRecorderExtension extends Extension (View source)
Attaches itself to {DataQuery} and records any classes that are queried within a closure context.
Allows code to measure and detect affected classes within any operation. E.g. for caching.
Traits
A class that can be instantiated or replaced via DI
Properties
| protected | T | $owner | The object this extension is applied to. |
from Extension |
| protected | string[][] | $levels | List of scopes, each of which contains a list of classes mapped from lowercase class name to cased class name |
Methods
Called when this extension is added to a particular class
Temporarily modify the owner. The original owner is ensured to be restored
Clear the current owner, and restore extension to the state prior to the last setOwner()
Helper method to strip eval'ed arguments from a string that's passed to DataObject::$extensions or Object::add_extension().
Invoke extension point. This will prefer explicit extend prefixed
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.
Create a new nesting level, record all classes queried during the callback, and unnest.
Details
__construct()
No description
static
add_to_class(string $class, string $extensionClass, mixed $args = null)
Called when this extension is added to a particular class
setOwner(object $owner)
Set the owner of this extension.
mixed
withOwner(mixed $owner, callable $callback, array $args = [])
Temporarily modify the owner. The original owner is ensured to be restored
clearOwner()
Clear the current owner, and restore extension to the state prior to the last setOwner()
T
getOwner()
Returns the owner of this extension.
static string
get_classname_without_arguments(string $extensionStr)
Helper method to strip eval'ed arguments from a string that's passed to DataObject::$extensions or Object::add_extension().
mixed
invokeExtension(object $owner, string $method, array ...$arguments)
Invoke extension point. This will prefer explicit extend prefixed
methods.
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).
protected void
augmentDataQueryCreation(SQLSelect $select, DataQuery $query)
Record query against a given class.
array
recordClasses(callable $callback)
Create a new nesting level, record all classes queried during the callback, and unnest.
Returns an array containing [ $listOfClasses, $resultOfCallback ]