class ListStylePlugin in CKEditor List Style 8

Defines the "List Style" plugin.

Plugin annotation

@CKEditorPlugin(
  id = "liststyle",
  label = @Translation("List Style")
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\ckeditor_liststyle\Plugin\CKEditorPlugin\ListStylePlugin implements CKEditorPluginContextualInterface, CKEditorPluginInterface

File

src/Plugin/CKEditorPlugin/ListStylePlugin.php, line 18

Namespace

Drupal\ckeditor_liststyle\Plugin\CKEditorPlugin

class ListStylePlugin extends PluginBase implements CKEditorPluginInterface, CKEditorPluginContextualInterface {

  /**
   * {@inheritdoc}
   */
  public function getButtons() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function isEnabled(Editor $editor) {
    $enabled = FALSE;
    $settings = $editor
      ->getSettings();
    foreach ($settings['toolbar']['rows'] as $row) {
      foreach ($row as $group) {
        foreach ($group['items'] as $button) {
          if ($button === 'BulletedList' || $button === 'NumberedList') {
            $enabled = TRUE;
          }
        }
      }
    }
    return $enabled;
  }

  /**
   * {@inheritdoc}
   */
  public function isInternal() {
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function getDependencies(Editor $editor) {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function getLibraries(Editor $editor) {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function getFile() {
    $plugin_paths = [
      'libraries/liststyle/plugin.js',
      'libraries/ckeditor/plugins/liststyle/plugin.js',
      'libraries/ckeditor_liststyle/plugin.js',
    ];
    $plugin = FALSE;
    foreach ($plugin_paths as $plugin_path) {
      if (file_exists(DRUPAL_ROOT . '/' . $plugin_path)) {
        $plugin = $plugin_path;
        break;
      }
    }
    return $plugin;
  }

  /**
   * {@inheritdoc}
   */
  public function getConfig(Editor $editor) {
    return [];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ListStylePlugin::getButtons	public	function
ListStylePlugin::getConfig	public	function	Returns the additions to CKEDITOR.config for a specific CKEditor instance. Overrides CKEditorPluginInterface::getConfig
ListStylePlugin::getDependencies	public	function	Returns a list of plugins this plugin requires. Overrides CKEditorPluginInterface::getDependencies
ListStylePlugin::getFile	public	function	Returns the Drupal root-relative file path to the plugin JavaScript file. Overrides CKEditorPluginInterface::getFile
ListStylePlugin::getLibraries	public	function	Returns a list of libraries this plugin requires. Overrides CKEditorPluginInterface::getLibraries
ListStylePlugin::isEnabled	public	function	Checks if this plugin should be enabled based on the editor configuration. Overrides CKEditorPluginContextualInterface::isEnabled
ListStylePlugin::isInternal	public	function	Indicates if this plugin is part of the optimized CKEditor build. Overrides CKEditorPluginInterface::isInternal
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92