class BalloonPanelPlugin in CKEditor Balloon Panel 8
Same name and namespace in other branches
- 7 src/Plugin/CKEditorPlugin/BalloonPanelPlugin.php \Drupal\ckeditor_balloonpanel\Plugin\CKEditorPlugin\BalloonPanelPlugin
- 2.0.x src/Plugin/CKEditorPlugin/BalloonPanelPlugin.php \Drupal\ckeditor_balloonpanel\Plugin\CKEditorPlugin\BalloonPanelPlugin
Defines the "balloonpanel" plugin.
Plugin annotation
@CKEditorPlugin(
id = "balloonpanel",
label = @Translation("Balloon Panel Plugin"),
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\ckeditor\CKEditorPluginBase implements CKEditorPluginButtonsInterface, CKEditorPluginInterface
- class \Drupal\ckeditor_balloonpanel\Plugin\CKEditorPlugin\BalloonPanelPlugin
- class \Drupal\ckeditor\CKEditorPluginBase implements CKEditorPluginButtonsInterface, CKEditorPluginInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of BalloonPanelPlugin
File
- src/
Plugin/ CKEditorPlugin/ BalloonPanelPlugin.php, line 16
Namespace
Drupal\ckeditor_balloonpanel\Plugin\CKEditorPluginView source
class BalloonPanelPlugin extends CKEditorPluginBase {
/**
* {@inheritdoc}
*/
public function getFile() {
if ($library_path = $this
->librariesGetPath('balloonpanel')) {
return $library_path . '/plugin.js';
}
}
/**
* {@inheritdoc}
*/
public function getConfig(Editor $editor) {
return [];
}
/**
* {@inheritdoc}
*/
public function getButtons() {
return [];
}
/**
* Gets the path of a library.
*
* @param string $name
* The machine name of a library to return the path for.
* @param string $base_path
* Whether to prefix the resulting path with base_path().
*
* @return string
* The path to the specified library or FALSE if the library wasn't found.
*/
private function librariesGetPath($name, $base_path = FALSE) {
$libraries =& drupal_static(__FUNCTION__);
if (!isset($libraries)) {
$libraries = $this
->getLibraryPaths();
}
$path = $base_path ? base_path() : '';
if (!isset($libraries[$name])) {
return FALSE;
}
else {
$path .= $libraries[$name];
}
return $path;
}
/**
* Returns an array of library directories.
*
* @return str[]
* A list of library directories.
*/
private function getLibraryPaths() {
$searchdir = [];
$config = DrupalKernel::findSitePath(\Drupal::request());
// Similar to 'modules' and 'themes' directories inside an installation
// profile, installation profiles may want to place libraries into a
// 'libraries' directory.
if ($profile = \Drupal::installProfile()) {
$profile_path = drupal_get_path('profile', $profile);
$searchdir[] = "{$profile_path}/libraries";
$searchdir[] = "{$profile_path}/libraries/ckeditor/plugins";
}
// Search sites/all/libraries for backwards-compatibility.
$searchdir[] = 'sites/all/libraries';
$searchdir[] = 'sites/all/libraries/ckeditor/plugins';
// Always search the root 'libraries' directory.
$searchdir[] = 'libraries';
$searchdir[] = 'libraries/ckeditor/plugins';
// Also search sites/<domain>/*.
$searchdir[] = "{$config}/libraries";
$searchdir[] = "{$config}/libraries/ckeditor/plugins";
// Retrieve list of directories.
$directories = [];
$nomask = [
'CVS',
];
foreach ($searchdir as $dir) {
if (is_dir($dir) && ($handle = opendir($dir))) {
while (FALSE !== ($file = readdir($handle))) {
if (!in_array($file, $nomask) && $file[0] != '.') {
if (is_dir("{$dir}/{$file}")) {
$directories[$file] = "{$dir}/{$file}";
}
}
}
closedir($handle);
}
}
return $directories;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
BalloonPanelPlugin:: |
public | function |
Returns the buttons that this plugin provides, along with metadata. Overrides CKEditorPluginButtonsInterface:: |
|
BalloonPanelPlugin:: |
public | function |
Returns the additions to CKEDITOR.config for a specific CKEditor instance. Overrides CKEditorPluginInterface:: |
|
BalloonPanelPlugin:: |
public | function |
Returns the Drupal root-relative file path to the plugin JavaScript file. Overrides CKEditorPluginInterface:: |
|
BalloonPanelPlugin:: |
private | function | Returns an array of library directories. | |
BalloonPanelPlugin:: |
private | function | Gets the path of a library. | |
CKEditorPluginBase:: |
public | function |
Returns a list of plugins this plugin requires. Overrides CKEditorPluginInterface:: |
1 |
CKEditorPluginBase:: |
public | function |
Returns a list of libraries this plugin requires. Overrides CKEditorPluginInterface:: |
4 |
CKEditorPluginBase:: |
public | function |
Indicates if this plugin is part of the optimized CKEditor build. Overrides CKEditorPluginInterface:: |
4 |
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 92 |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |