class Collection (View source)

Defines a collection of class names paired with file paths

Traits

A class that can be instantiated or replaced via DI

Methods

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
__construct(array $manifest = [])

Collection constructor.

public
setManifest(array $manifest)

No description

public
removeClass(string $class)

No description

public
removeFile(string $path)

No description

public
array
getClasses()

No description

public
array
getFiles()

No description

public
array
getManifest()

No description

public static 
createFromClassList(array $classList)

No description

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

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

__construct(array $manifest = [])

Collection constructor.

Parameters

array $manifest

An array of classname keys to filepath values ['My\Class' => '/path/to/Class.php']

Exceptions

Exception

Collection setManifest(array $manifest)

No description

Parameters

array $manifest

Return Value

Collection

Exceptions

Exception

Collection removeClass(string $class)

No description

Parameters

string $class

Return Value

Collection

Collection removeFile(string $path)

No description

Parameters

string $path

Return Value

Collection

array getClasses()

No description

Return Value

array

array getFiles()

No description

Return Value

array

array getManifest()

No description

Return Value

array

static Collection createFromClassList(array $classList)

No description

Parameters

array $classList

Return Value

Collection

Exceptions

ReflectionException
Exception