Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\ckeditor;
Chris@0: 
Chris@0: use Drupal\Component\Plugin\PluginInspectionInterface;
Chris@0: use Drupal\editor\Entity\Editor;
Chris@0: 
Chris@0: /**
Chris@0:  * Defines an interface for (loading of) CKEditor plugins.
Chris@0:  *
Chris@0:  * This is the most basic CKEditor plugin interface; it provides the bare
Chris@0:  * minimum information. Solely implementing this interface is not sufficient to
Chris@0:  * be able to enable the plugin though — a CKEditor plugin can either be enabled
Chris@0:  * automatically when a button it provides is present in the toolbar, or when
Chris@0:  * some programmatically defined condition is true. In the former case,
Chris@0:  * implement the CKEditorPluginButtonsInterface interface, in the latter case,
Chris@0:  * implement the CKEditorPluginContextualInterface interface. It is also
Chris@0:  * possible to implement both, for advanced use cases.
Chris@0:  *
Chris@0:  * Finally, if your plugin must be configurable, you can also implement the
Chris@0:  * CKEditorPluginConfigurableInterface interface.
Chris@0:  *
Chris@0:  * @see \Drupal\ckeditor\CKEditorPluginButtonsInterface
Chris@0:  * @see \Drupal\ckeditor\CKEditorPluginContextualInterface
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 CKEditorPluginInterface extends PluginInspectionInterface {
Chris@0: 
Chris@0:   /**
Chris@0:    * Indicates if this plugin is part of the optimized CKEditor build.
Chris@0:    *
Chris@0:    * Plugins marked as internal are implicitly loaded as part of CKEditor.
Chris@0:    *
Chris@0:    * @return bool
Chris@0:    */
Chris@0:   public function isInternal();
Chris@0: 
Chris@0:   /**
Chris@0:    * Returns a list of plugins this plugin requires.
Chris@0:    *
Chris@0:    * @param \Drupal\editor\Entity\Editor $editor
Chris@0:    *   A configured text editor object.
Chris@0:    * @return array
Chris@0:    *   An unindexed array of plugin names this plugin requires. Each plugin is
Chris@0:    *   is identified by its annotated ID.
Chris@0:    */
Chris@0:   public function getDependencies(Editor $editor);
Chris@0: 
Chris@0:   /**
Chris@0:    * Returns a list of libraries this plugin requires.
Chris@0:    *
Chris@0:    * These libraries will be attached to the text_format element on which the
Chris@0:    * editor is being loaded.
Chris@0:    *
Chris@0:    * @param \Drupal\editor\Entity\Editor $editor
Chris@0:    *   A configured text editor object.
Chris@0:    * @return array
Chris@0:    *   An array of libraries suitable for usage in a render API #attached
Chris@0:    *   property.
Chris@0:    */
Chris@0:   public function getLibraries(Editor $editor);
Chris@0: 
Chris@0:   /**
Chris@0:    * Returns the Drupal root-relative file path to the plugin JavaScript file.
Chris@0:    *
Chris@0:    * Note: this does not use a Drupal library because this uses CKEditor's API,
Chris@0:    * see http://docs.cksource.com/ckeditor_api/symbols/CKEDITOR.resourceManager.html#addExternal.
Chris@0:    *
Chris@0:    * @return string|false
Chris@0:    *   The Drupal root-relative path to the file, FALSE if an internal plugin.
Chris@0:    */
Chris@0:   public function getFile();
Chris@0: 
Chris@0:   /**
Chris@0:    * Returns the additions to CKEDITOR.config for a specific CKEditor instance.
Chris@0:    *
Chris@0:    * The editor's settings can be retrieved via $editor->getSettings(), but be
Chris@0:    * aware that it may not yet contain plugin-specific settings, because the
Chris@0:    * user may not yet have configured the form.
Chris@0:    * If there are plugin-specific settings (verify with isset()), they can be
Chris@0:    * found at
Chris@0:    * @code
Chris@0:    * $settings = $editor->getSettings();
Chris@0:    * $plugin_specific_settings = $settings['plugins'][$plugin_id];
Chris@0:    * @endcode
Chris@0:    *
Chris@0:    * @param \Drupal\editor\Entity\Editor $editor
Chris@0:    *   A configured text editor object.
Chris@0:    * @return array
Chris@0:    *   A keyed array, whose keys will end up as keys under CKEDITOR.config.
Chris@0:    */
Chris@0:   public function getConfig(Editor $editor);
Chris@0: 
Chris@0: }