class StylesCombo
Same name in other branches
- 8.9.x core/modules/ckeditor/src/Plugin/CKEditorPlugin/StylesCombo.php \Drupal\ckeditor\Plugin\CKEditorPlugin\StylesCombo
Defines the "stylescombo" plugin.
Plugin annotation
@CKEditorPlugin(
id = "stylescombo",
label = @Translation("Styles dropdown")
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\ckeditor\CKEditorPluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\ckeditor\CKEditorPluginInterface, \Drupal\ckeditor\CKEditorPluginButtonsInterface
- class \Drupal\ckeditor\Plugin\CKEditorPlugin\StylesCombo extends \Drupal\ckeditor\CKEditorPluginBase implements \Drupal\ckeditor\CKEditorPluginConfigurableInterface
- class \Drupal\ckeditor\CKEditorPluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\ckeditor\CKEditorPluginInterface, \Drupal\ckeditor\CKEditorPluginButtonsInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of StylesCombo
5 string references to 'StylesCombo'
- CKEditorPluginManagerTest::testEnabledPlugins in core/
modules/ ckeditor/ tests/ src/ Kernel/ CKEditorPluginManagerTest.php - Tests the enabling of plugins.
- CKEditorTest::testStylesComboGetConfig in core/
modules/ ckeditor/ tests/ src/ Kernel/ CKEditorTest.php - Tests StylesCombo::getConfig().
- CKEditorUpdateOmitDisabledPluginSettings::testUpdateUpdateOmitDisabledSettingsEntitySave in core/
modules/ ckeditor/ tests/ src/ Functional/ Update/ CKEditorUpdateOmitDisabledPluginSettings.php - Ensure settings for disabled CKEditor 4 plugins are omitted on entity save.
- CKEditorUpdateOmitDisabledPluginSettings::testUpdateUpdateOmitDisabledSettingsPostUpdate in core/
modules/ ckeditor/ tests/ src/ Functional/ Update/ CKEditorUpdateOmitDisabledPluginSettings.php - Ensure settings for disabled CKEditor 4 plugins are omitted on post update.
- Core::mapCKEditor4SettingsToCKEditor5Configuration in core/
modules/ ckeditor5/ src/ Plugin/ CKEditor4To5Upgrade/ Core.php - Maps CKEditor 4 settings to the CKEditor 5 equivalent, if needed.
File
-
core/
modules/ ckeditor/ src/ Plugin/ CKEditorPlugin/ StylesCombo.php, line 18
Namespace
Drupal\ckeditor\Plugin\CKEditorPluginView source
class StylesCombo extends CKEditorPluginBase implements CKEditorPluginConfigurableInterface {
/**
* {@inheritdoc}
*/
public function isInternal() {
return TRUE;
}
/**
* {@inheritdoc}
*/
public function getFile() {
// This plugin is already part of Drupal core's CKEditor build.
return FALSE;
}
/**
* {@inheritdoc}
*/
public function getConfig(Editor $editor) {
$config = [];
$settings = $editor->getSettings();
if (!isset($settings['plugins']['stylescombo']['styles'])) {
return $config;
}
$styles = $settings['plugins']['stylescombo']['styles'];
$config['stylesSet'] = $this->generateStylesSetSetting($styles);
return $config;
}
/**
* {@inheritdoc}
*/
public function getButtons() {
return [
'Styles' => [
'label' => $this->t('Font style'),
'image_alternative' => [
'#type' => 'inline_template',
'#template' => '<a href="#" role="button" aria-label="{{ styles_text }}"><span class="ckeditor-button-dropdown">{{ styles_text }}<span class="ckeditor-button-arrow"></span></span></a>',
'#context' => [
'styles_text' => $this->t('Styles'),
],
],
],
];
}
/**
* {@inheritdoc}
*/
public function settingsForm(array $form, FormStateInterface $form_state, Editor $editor) {
// Defaults.
$config = [
'styles' => '',
];
$settings = $editor->getSettings();
if (isset($settings['plugins']['stylescombo'])) {
$config = $settings['plugins']['stylescombo'];
}
$form['styles'] = [
'#title' => $this->t('Styles'),
'#title_display' => 'invisible',
'#type' => 'textarea',
'#default_value' => $config['styles'],
'#description' => $this->t('A list of classes that will be provided in the "Styles" dropdown. Enter one or more classes on each line in the format: element.classA.classB|Label. Example: h1.title|Title. Advanced example: h1.fancy.title|Fancy title.<br />These styles should be available in your theme\'s CSS file.'),
'#attached' => [
'library' => [
'ckeditor/drupal.ckeditor.stylescombo.admin',
],
],
'#element_validate' => [
[
$this,
'validateStylesValue',
],
],
];
return $form;
}
/**
* #element_validate handler for the "styles" element in settingsForm().
*/
public function validateStylesValue(array $element, FormStateInterface $form_state) {
$styles_setting = $this->generateStylesSetSetting($element['#value']);
if ($styles_setting === FALSE) {
$form_state->setError($element, $this->t('The provided list of styles is syntactically incorrect.'));
}
else {
$style_names = array_map(function ($style) {
return $style['name'];
}, $styles_setting);
if (count($style_names) !== count(array_unique($style_names))) {
$form_state->setError($element, $this->t('Each style must have a unique label.'));
}
}
}
/**
* Builds the "stylesSet" configuration part of the CKEditor JS settings.
*
* @see getConfig()
*
* @param string $styles
* The "styles" setting.
*
* @return array|false
* An array containing the "stylesSet" configuration, or FALSE when the
* syntax is invalid.
*/
protected function generateStylesSetSetting($styles) {
$styles_set = [];
// Early-return when empty.
$styles = trim($styles);
if (empty($styles)) {
return $styles_set;
}
$styles = str_replace([
"\r\n",
"\r",
], "\n", $styles);
foreach (explode("\n", $styles) as $style) {
$style = trim($style);
// Ignore empty lines in between non-empty lines.
if (empty($style)) {
continue;
}
// Validate syntax: element[.class...]|label pattern expected.
if (!preg_match('@^ *[a-zA-Z0-9-]+ *(\\.[a-zA-Z0-9_-]+ *)*\\| *.+ *$@', $style)) {
return FALSE;
}
// Parse.
[
$selector,
$label,
] = explode('|', $style);
$classes = explode('.', $selector);
$element = array_shift($classes);
// Build the data structure CKEditor's stylescombo plugin expects.
// @see https://ckeditor.com/docs/ckeditor4/latest/guide/dev_howtos_styles.html
$configured_style = [
'name' => trim($label),
'element' => trim($element),
];
if (!empty($classes)) {
$configured_style['attributes'] = [
'class' => implode(' ', array_map('trim', $classes)),
];
}
$styles_set[] = $configured_style;
}
return $styles_set;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
CKEditorPluginBase::$moduleList | protected | property | The module list service. | ||
CKEditorPluginBase::getDependencies | public | function | Returns a list of plugins this plugin requires. | Overrides CKEditorPluginInterface::getDependencies | 1 |
CKEditorPluginBase::getLibraries | public | function | Returns a list of libraries this plugin requires. | Overrides CKEditorPluginInterface::getLibraries | 4 |
CKEditorPluginBase::getModuleList | protected | function | Gets the module list service. | ||
CKEditorPluginBase::getModulePath | protected | function | Gets the Drupal-root relative installation directory of a module. | ||
PluginInspectionInterface::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | 6 | |
PluginInspectionInterface::getPluginId | public | function | Gets the plugin_id of the plugin instance. | 2 | |
StylesCombo::generateStylesSetSetting | protected | function | Builds the "stylesSet" configuration part of the CKEditor JS settings. | ||
StylesCombo::getButtons | public | function | Returns the buttons that this plugin provides, along with metadata. | Overrides CKEditorPluginButtonsInterface::getButtons | |
StylesCombo::getConfig | public | function | Returns the additions to CKEDITOR.config for a specific CKEditor instance. | Overrides CKEditorPluginInterface::getConfig | |
StylesCombo::getFile | public | function | Returns the Drupal root-relative file path to the plugin JavaScript file. | Overrides CKEditorPluginInterface::getFile | |
StylesCombo::isInternal | public | function | Indicates if this plugin is part of the optimized CKEditor build. | Overrides CKEditorPluginBase::isInternal | |
StylesCombo::settingsForm | public | function | Returns a settings form to configure this CKEditor plugin. | Overrides CKEditorPluginConfigurableInterface::settingsForm | |
StylesCombo::validateStylesValue | public | function | #element_validate handler for the "styles" element in settingsForm(). |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.