class TinyMCECombinedGenerator implements TinyMCEScriptGenerator, Flushable (View source)

Generates tinymce config using a combined file generated via a standard SilverStripe GeneratedAssetHandler

Traits

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

A class that can be instantiated or replaced via DI

Config options

filename_base string

Named config

Properties

protected GeneratedAssetHandler $assetHandler

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
$this
setAssetHandler(GeneratedAssetHandler $assetHandler)

Assign backend store for generated assets

public
getAssetHandler()

Get backend for assets

public
string
getScriptURL(TinyMCEConfig $config)

Generate a script URL for the given config

public
string
generateContent(TinyMCEConfig $config)

Build raw config for tinymce

protected
string
getFileContents(string|ModuleResource $file)

Returns the contents of the script file if it exists and removes the UTF-8 BOM header if it exists.

protected
string
checkName(TinyMCEConfig $config)

Check if this config is registered under a given key

public
mixed
generateFilename(TinyMCEConfig $config)

Get filename to use for this config

public static 
flush()

This function is triggered early in the request if the "flush" query parameter has been set. Each class that implements Flushable implements this function which looks after it's own specific flushing functionality.

protected
resolveRelativeResource(ModuleResource|string $base, string $resource)

Get relative resource for a given base and string

protected
bool
resourceExists(string|ModuleResource $resource)

Check if the given resource exists

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

$this setAssetHandler(GeneratedAssetHandler $assetHandler)

Assign backend store for generated assets

Parameters

GeneratedAssetHandler $assetHandler

Return Value

$this

GeneratedAssetHandler getAssetHandler()

Get backend for assets

Return Value

GeneratedAssetHandler

string getScriptURL(TinyMCEConfig $config)

Generate a script URL for the given config

Parameters

TinyMCEConfig $config

Return Value

string

string generateContent(TinyMCEConfig $config)

Build raw config for tinymce

Parameters

TinyMCEConfig $config

Return Value

string

protected string getFileContents(string|ModuleResource $file)

Returns the contents of the script file if it exists and removes the UTF-8 BOM header if it exists.

Parameters

string|ModuleResource $file

File to load.

Return Value

string

File contents or empty string if it doesn't exist.

protected string checkName(TinyMCEConfig $config)

Check if this config is registered under a given key

Parameters

TinyMCEConfig $config

Return Value

string

mixed generateFilename(TinyMCEConfig $config)

Get filename to use for this config

Parameters

TinyMCEConfig $config

Return Value

mixed

static flush()

This function is triggered early in the request if the "flush" query parameter has been set. Each class that implements Flushable implements this function which looks after it's own specific flushing functionality.

See also

FlushMiddleware

protected ModuleResource|string resolveRelativeResource(ModuleResource|string $base, string $resource)

Get relative resource for a given base and string

Parameters

ModuleResource|string $base
string $resource

Return Value

ModuleResource|string

protected bool resourceExists(string|ModuleResource $resource)

Check if the given resource exists

Parameters

string|ModuleResource $resource

Return Value

bool