abstract class AbstractBulkLoader implements Identifiable, ConfigurationApplier (View source)

Provides base functionality to all bulk loaders. Should override the collect() method with computations that parse the include/exclude directives and return a collection of classes.

Traits

A class that can be instantiated or replaced via DI

Methods

static Injectable
create(array ...$args)

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

static Injectable
singleton(string $class = null)

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

__construct(array $include = [], array $exclude = [])

AbstractBulkLoader constructor.

include(array $include)

No description

exclude(array $exclude)

No description

mixed
applyConfig(array $config)

No description

collect(Collection $collection)

No description

static string
getIdentifier()

No description

Details

static Injectable create(array ...$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'); $list = SiteTree::get();

Parameters

array ...$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

__construct(array $include = [], array $exclude = [])

AbstractBulkLoader constructor.

Parameters

array $include
array $exclude

AbstractBulkLoader include(array $include)

Parameters

array $include

Return Value

AbstractBulkLoader

AbstractBulkLoader exclude(array $exclude)

Parameters

array $exclude

Return Value

AbstractBulkLoader

mixed applyConfig(array $config)

Parameters

array $config

Return Value

mixed

Exceptions

SchemaBuilderException

Collection collect(Collection $collection)

Parameters

Collection $collection

Return Value

Collection

abstract static string getIdentifier()

Return Value

string