class LeftAndMainPageIconsExtension extends Extension implements Flushable (View source)

deprecated 5.4.0 Will be renamed to SilverStripe\CMS\Controllers\LeftAndMainRecordIconsExtension

Extension to include custom page icons

Properties

protected T $owner

The object this extension is applied to.

from  Extension

Methods

public
__construct()

No description

public static 
add_to_class(string $class, string $extensionClass, mixed $args = null)

Called when this extension is added to a particular class

public
setOwner(object $owner)

Set the owner of this extension.

public
mixed
withOwner(mixed $owner, callable $callback, array $args = [])

Temporarily modify the owner. The original owner is ensured to be restored

public
clearOwner()

Clear the current owner, and restore extension to the state prior to the last setOwner()

public
T
getOwner()

Returns the owner of this extension.

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

public
mixed
invokeExtension(object $owner, string $method, array ...$arguments)

Invoke extension point. This will prefer explicit extend prefixed methods.

public
init()

No description

public static 
flush()

Just broadly clears the cache on flush

public
string
generatePageIconsCss() deprecated

Include CSS for page icons. We're not using the JSTree 'types' option because it causes too much performance overhead just to add some icons.

public
string
generateRecordIconsCss()

Include CSS for page icons. We're not using the JSTree 'types' option because it causes too much performance overhead just to add some icons.

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

Parameters

string $class
string $extensionClass
mixed $args

setOwner(object $owner)

Set the owner of this extension.

Parameters

object $owner

The owner object

mixed withOwner(mixed $owner, callable $callback, array $args = [])

Temporarily modify the owner. The original owner is ensured to be restored

Parameters

mixed $owner

Owner to set

callable $callback

Callback to invoke

array $args

Args to pass to callback

Return Value

mixed

clearOwner()

Clear the current owner, and restore extension to the state prior to the last setOwner()

T getOwner()

Returns the owner of this extension.

Return Value

T

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

Parameters

string $extensionStr

E.g. "Versioned('Stage','Live')"

Return Value

string

Extension classname, e.g. "Versioned"

mixed invokeExtension(object $owner, string $method, array ...$arguments)

Invoke extension point. This will prefer explicit extend prefixed methods.

Parameters

object $owner
string $method
array ...$arguments

Return Value

mixed

init()

No description

Exceptions

InvalidArgumentException
ReflectionException

static flush()

Just broadly clears the cache on flush

string generatePageIconsCss() deprecated

deprecated 5.4.0 Use generateRecordIconsCss() instead.

Include CSS for page icons. We're not using the JSTree 'types' option because it causes too much performance overhead just to add some icons.

Return Value

string CSS

Exceptions

InvalidArgumentException
ReflectionException

string generateRecordIconsCss()

Include CSS for page icons. We're not using the JSTree 'types' option because it causes too much performance overhead just to add some icons.

Return Value

string

Exceptions

InvalidArgumentException
ReflectionException