From 0bcf2ee9ee8ca99733c5b4e0574d5c641e065687 Mon Sep 17 00:00:00 2001
From: Florian Bogner <f.bogner@pcsg.de>
Date: Mon, 8 May 2017 14:57:18 +0200
Subject: [PATCH] style: Codestyle and documentation
---
ajax/activatePlugin.php | 7 ++
ajax/deactivatePlugin.php | 7 ++
ajax/getPluginData.php | 13 ++++
ajax/getPlugins.php | 4 ++
ajax/installPlugin.php | 9 ---
ajax/uninstallPlugin.php | 9 ---
bin/Editor.js | 107 ++-----------------------------
bin/controls/settings/Plugins.js | 26 +++++++-
8 files changed, 60 insertions(+), 122 deletions(-)
delete mode 100644 ajax/installPlugin.php
delete mode 100644 ajax/uninstallPlugin.php
diff --git a/ajax/activatePlugin.php b/ajax/activatePlugin.php
index 5e507b9..5331160 100644
--- a/ajax/activatePlugin.php
+++ b/ajax/activatePlugin.php
@@ -1,5 +1,12 @@
<?php
+/**
+ * Activates the plugin
+ *
+ * @param pluginName
+ *
+ */
+
QUI::$Ajax->registerFunction(
'package_quiqqer_ckeditor4_ajax_activatePlugin',
function ($pluginName) {
diff --git a/ajax/deactivatePlugin.php b/ajax/deactivatePlugin.php
index e0b76e6..15bf481 100644
--- a/ajax/deactivatePlugin.php
+++ b/ajax/deactivatePlugin.php
@@ -1,5 +1,12 @@
<?php
+/**
+ * Deactivates the plugin
+ *
+ * @param pluginName
+ *
+ */
+
QUI::$Ajax->registerFunction(
'package_quiqqer_ckeditor4_ajax_deactivatePlugin',
function ($pluginName) {
diff --git a/ajax/getPluginData.php b/ajax/getPluginData.php
index 48c20d0..11ac15c 100644
--- a/ajax/getPluginData.php
+++ b/ajax/getPluginData.php
@@ -1,5 +1,18 @@
<?php
+/**
+ * Retrieves data about the active plugins
+ *
+ * Returnformat:
+ * array(
+ * 'plugins' => array('plugin1','plugin2','plugin3'...),
+ * 'pluginpath' => 'path/to/plugins'
+ * )
+ *
+ * @param pluginName
+ *
+ */
+
QUI::$Ajax->registerFunction(
'package_quiqqer_ckeditor4_ajax_getPluginData',
function () {
diff --git a/ajax/getPlugins.php b/ajax/getPlugins.php
index e5c8b33..13407aa 100644
--- a/ajax/getPlugins.php
+++ b/ajax/getPlugins.php
@@ -1,5 +1,9 @@
<?php
+/**
+ * Gets all plugins and their state
+ */
+
QUI::$Ajax->registerFunction(
'package_quiqqer_ckeditor4_ajax_getPlugins',
function () {
diff --git a/ajax/installPlugin.php b/ajax/installPlugin.php
deleted file mode 100644
index e3bdfca..0000000
--- a/ajax/installPlugin.php
+++ /dev/null
@@ -1,9 +0,0 @@
-<?php
-
-QUI::$Ajax->registerFunction(
- 'package_quiqqer_ckeditor4_ajax_installPlugin',
- function ($pluginName) {
- $PluginManager = new \QUI\Ckeditor4\Plugins\Manager();
- },
- array('pluginName')
-);
diff --git a/ajax/uninstallPlugin.php b/ajax/uninstallPlugin.php
deleted file mode 100644
index 2d70792..0000000
--- a/ajax/uninstallPlugin.php
+++ /dev/null
@@ -1,9 +0,0 @@
-<?php
-
-QUI::$Ajax->registerFunction(
- 'package_quiqqer_ckeditor4_ajax_uninstallPlugin',
- function ($pluginName) {
- $PluginManager = new \QUI\Ckeditor4\Plugins\Manager();
- },
- array('pluginName')
-);
diff --git a/bin/Editor.js b/bin/Editor.js
index 1c7786c..175510f 100644
--- a/bin/Editor.js
+++ b/bin/Editor.js
@@ -46,6 +46,11 @@ define('package/quiqqer/ckeditor4/bin/Editor', [
'$onInstanceReadyListener'
],
+ /**
+ * Control Constructor
+ * @param Manager
+ * @param options
+ */
initialize: function (Manager, options) {
this.parent(Manager, options);
@@ -447,108 +452,6 @@ define('package/quiqqer/ckeditor4/bin/Editor', [
}
},
- // /**
- // * Generate the extra plugins option in dependence of the toolbar
- // * @param toolbar
- // */
- // $parseToolbarToPlugins: function (toolbar) {
- // var extra = [],
- // buttonList = [];
- //
- // if (typeOf(toolbar) == 'array') {
- // buttonList = toolbar.flatten();
- // }
- //
- // for (var i = 0, len = buttonList.length; i < len; i++) {
- // switch (buttonList[i]) {
- // case 'Templates':
- // extra.push('templates');
- // break;
- //
- // case 'Find':
- // case 'Replace':
- // extra.push('find');
- // break;
- //
- // case 'SelectAll':
- // extra.push('selectall');
- // break;
- //
- // case 'Form':
- // case 'Checkbox':
- // case 'Radio':
- // case 'TextField':
- // case 'Textarea':
- // case 'Select':
- // case 'Button':
- // case 'ImageButton':
- // case 'HiddenField':
- // extra.push('forms');
- // break;
- //
- // case 'CreateDiv':
- // extra.push('div');
- // break;
- //
- // case 'JustifyLeft':
- // case 'JustifyCenter':
- // case 'JustifyRight':
- // case 'JustifyBlock':
- // extra.push('justify');
- // break;
- //
- // case 'BidiLtr':
- // case 'BidiRtl':
- // extra.push('bidi');
- // break;
- //
- // case 'Language':
- // extra.push('language');
- // break;
- //
- // case 'Link':
- // case 'Unlink':
- // case 'Anchor':
- // extra.push('link');
- // break;
- //
- // case 'Flash':
- // extra.push('flash');
- // break;
- //
- // case 'Smiley':
- // extra.push('smiley');
- // break;
- //
- // case 'PageBreak':
- // extra.push('pagebreak');
- // break;
- //
- // case 'Iframe':
- // extra.push('iframe');
- // break;
- //
- // case 'Font':
- // case 'FontSize':
- // extra.push('font');
- // break;
- //
- // case 'BGColor':
- // case 'TextColor':
- // extra.push('colorbutton');
- // break;
- // }
- // }
- //
- // //extra.push('wordcount');
- //
- // extra = extra.unique();
- //
- //
- // return extra.join(',');
- // }
- // ,
-
/**
* edit the image dialog
*
diff --git a/bin/controls/settings/Plugins.js b/bin/controls/settings/Plugins.js
index f131dce..bd9176b 100644
--- a/bin/controls/settings/Plugins.js
+++ b/bin/controls/settings/Plugins.js
@@ -21,6 +21,10 @@ define('package/quiqqer/ckeditor4/bin/controls/settings/Plugins', [
options: {},
+ /**
+ * Control constructor
+ * @param options
+ */
initialize: function (options) {
this.parent(options);
@@ -38,7 +42,9 @@ define('package/quiqqer/ckeditor4/bin/controls/settings/Plugins', [
});
},
-
+ /**
+ * Eventhandler onCreate
+ */
$onCreate: function () {
var self = this;
@@ -149,6 +155,9 @@ define('package/quiqqer/ckeditor4/bin/controls/settings/Plugins', [
this.$Grid.resize();
},
+ /**
+ * Refreshes the plugin table
+ */
refresh: function () {
var self = this;
@@ -183,6 +192,10 @@ define('package/quiqqer/ckeditor4/bin/controls/settings/Plugins', [
});
},
+ /**
+ * Toggles the state of the selected plugin
+ * @returns {*}
+ */
$toggleState: function () {
var self = this;
return new Promise(function (resolve) {
@@ -229,6 +242,11 @@ define('package/quiqqer/ckeditor4/bin/controls/settings/Plugins', [
});
},
+ /**
+ * Disable the plugin with the given name
+ * @param name
+ * @returns {*}
+ */
$disablePlugin: function (name) {
return new Promise(function (resolve, reject) {
@@ -240,6 +258,11 @@ define('package/quiqqer/ckeditor4/bin/controls/settings/Plugins', [
});
},
+ /**
+ * Enable the plugin with the given name
+ * @param name
+ * @returns {*}
+ */
$enablePlugin: function (name) {
return new Promise(function (resolve, reject) {
QUIAjax.post("package_quiqqer_ckeditor4_ajax_activatePlugin", resolve, {
@@ -250,7 +273,6 @@ define('package/quiqqer/ckeditor4/bin/controls/settings/Plugins', [
});
}
-
}
);
});
\ No newline at end of file
--
GitLab