class LinkablePlugin implements ModelQueryPlugin (View source)

Traits

Provides extensions to this object to integrate it with standard config API methods.

A class that can be instantiated or replaced via DI

Constants

IDENTIFIER

Config options

single_field_name string
list_field_name string
resolver array

Properties

Methods

public static 
config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

public
mixed
uninherited(string $name)

Gets the uninherited value for the given config option

public static 
create(mixed ...$args)

An implementation of the factory method, allows you to create an instance of a class

public static 
singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

public
string
getIdentifier()

No description

public
void
apply(ModelQuery $query, Schema $schema, array $config = [])

No description

public static 
callable
applyLinkFilter($obj, array $args, array $context, ResolveInfo $info)

No description

Details

static Config_ForClass config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

Return Value

Config_ForClass

mixed uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

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();

Parameters

mixed ...$args

Return Value

Injectable

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).

Parameters

string $class

Optional classname to create, if the called class should not be used

Return Value

Injectable

The singleton instance

string getIdentifier()

No description

Return Value

string

void apply(ModelQuery $query, Schema $schema, array $config = [])

No description

Parameters

ModelQuery $query
Schema $schema
array $config

Return Value

void

static callable applyLinkFilter($obj, array $args, array $context, ResolveInfo $info)

No description

Parameters

$obj
array $args
array $context
ResolveInfo $info

Return Value

callable