TinyMCEConfig

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

Gets the uninherited value for the given config option

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

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

Get the HTMLEditorConfig object for the given identifier. This is a correct way to get an HTMLEditorConfig instance - do not call 'new'

Assign a new config, or clear existing, for the given identifier

Gets the current themes, if it is not set this will fallback to config

Sets the current theme

Set the currently active configuration object. Note that the existing active config will not be renamed to the new identifier.

Get the currently active configuration identifier. Will fall back to default_config if unassigned.

Get the currently active configuration object

Assigns the currently active config an explicit instance

Get the available configurations as a map of friendly_name to configuration name.

Get the current value of an option

Set the value of one option

Set multiple options. This does not merge recursively, but only at the top level.

Associative array of data-attributes to apply to the underlying text-area

Initialise the editor on the client side

Provide additional schema data for the field this object configures

No description

Get the theme

Set the theme name

Get all settings

Enable one or several plugins. Will maintain unique list if already enabled plugin is re-passed. If passed in as a map of plugin-name to path, the plugin will be loaded by tinymce.PluginManager.load() instead of through tinyMCE.init().

Keep in mind that these externals plugins require a dash-prefix in their name.

Enable one or several plugins. Will properly handle being passed a plugin that is already disabled

Gets the list of all enabled plugins as an associative array.

Array keys are the plugin names, and values are potentially the plugin location, or ModuleResource object

Get list of plugins without custom locations, which is the set of plugins which can be loaded via the standard plugin path, and could potentially be minified

Get all button rows, skipping empty rows

Totally re-set the buttons on a given line

Add buttons to the end of a line

Internal function for adding and removing buttons related to another button

Insert buttons before the first occurrence of another button

Insert buttons after the first occurrence of another button

Remove the first occurrence of buttons

Generate the JavaScript that will set TinyMCE's configuration:

• Parse all configurations into JSON objects to be used in JavaScript
• Includes TinyMCE and configurations using the Requirements system

Get location of all editor.css files.

All resource specifiers are resolved to urls.

Get list of resource paths to css files.

Will default to editor_css config, as well as any themed editor.css files. Use setContentCSS() to override.

Set explicit set of CSS resources to use for content_css option.

Note: If merging with default paths, you should call getContentCSS() and merge prior to assignment.

Generate gzipped TinyMCE configuration including plugins and languages.

This ends up "pre-loading" TinyMCE bundled with the required plugins so that multiple HTTP requests on the client don't need to be made.

Get the current tinyMCE language

Get the URL for the language pack of the current language

Returns the full filesystem path to TinyMCE resources (which could be different from the original tinymce location in the module).

Path will be absolute.

Get front-end url to tinymce resources

Get resource root for TinyMCE, either as a string or ModuleResource instance Path will be relative to BASE_PATH if string.

Sets the upload folder name used by the insert media dialog

Returns the list of provided translations for this object.

Note: Pluralised forms are always returned in array format.

Example usage:

class MyTestClass implements i18nEntityProvider
{
  public function provideI18nEntities()
  {
    $entities = [];
    foreach($this->config()->get('my_static_array') as $key => $value) {
      $entities["MyTestClass.my_static_array_{$key}"] = $value;
    }
    $entities["MyTestClass.PLURALS"] = [
      'one' => 'A test class',
      'other' => '{count} test classes',
    ]
    return $entities;
  }
}

Example usage in DataObject->provideI18nEntities().

You can ask textcollector to add the provided entity to a different module. Simply wrap the returned value for any item in an array with the format: [ 'default' => $defaultValue, 'module' => $module ]

class MyTestClass implements i18nEntityProvider
{
  public function provideI18nEntities()
  {
    $entities = [
      'MyOtherModuleClass.MYENTITY' => [
        'default' => $value,
        'module' => 'myothermodule',
      ]
    ];
  }
  return $entities;
}