Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\ckeditor;
Chris@0: 
Chris@0: use Drupal\editor\Entity\Editor;
Chris@0: 
Chris@0: /**
Chris@0:  * Defines an interface for contextually enabled CKEditor plugins.
Chris@0:  *
Chris@0:  * Contextually enabled CKEditor plugins can be enabled via an explicit setting,
Chris@0:  * or enable themselves based on the configuration of another setting, such as
Chris@0:  * enabling based on a particular button being present in the toolbar.
Chris@0:  *
Chris@0:  * If a contextually enabled CKEditor plugin must also be configurable (for
Chris@0:  * instance, in the case where it must be enabled based on an explicit setting),
Chris@0:  * then one must also implement the CKEditorPluginConfigurableInterface
Chris@0:  * interface.
Chris@0:  *
Chris@0:  * @see \Drupal\ckeditor\CKEditorPluginInterface
Chris@0:  * @see \Drupal\ckeditor\CKEditorPluginButtonsInterface
Chris@0:  * @see \Drupal\ckeditor\CKEditorPluginConfigurableInterface
Chris@0:  * @see \Drupal\ckeditor\CKEditorPluginCssInterface
Chris@0:  * @see \Drupal\ckeditor\CKEditorPluginBase
Chris@0:  * @see \Drupal\ckeditor\CKEditorPluginManager
Chris@0:  * @see \Drupal\ckeditor\Annotation\CKEditorPlugin
Chris@0:  * @see plugin_api
Chris@0:  */
Chris@0: interface CKEditorPluginContextualInterface extends CKEditorPluginInterface {
Chris@0: 
Chris@0:   /**
Chris@0:    * Checks if this plugin should be enabled based on the editor configuration.
Chris@0:    *
Chris@0:    * The editor's settings can be retrieved via $editor->getSettings().
Chris@0:    *
Chris@0:    * @param \Drupal\editor\Entity\Editor $editor
Chris@0:    *   A configured text editor object.
Chris@0:    *
Chris@0:    * @return bool
Chris@0:    */
Chris@0:   public function isEnabled(Editor $editor);
Chris@0: 
Chris@0: }