summaryrefslogtreecommitdiff
path: root/hugo/libraries/plugins/transformations/abstract/AppendTransformationsPlugin.class.php
diff options
context:
space:
mode:
Diffstat (limited to 'hugo/libraries/plugins/transformations/abstract/AppendTransformationsPlugin.class.php')
-rw-r--r--hugo/libraries/plugins/transformations/abstract/AppendTransformationsPlugin.class.php86
1 files changed, 86 insertions, 0 deletions
diff --git a/hugo/libraries/plugins/transformations/abstract/AppendTransformationsPlugin.class.php b/hugo/libraries/plugins/transformations/abstract/AppendTransformationsPlugin.class.php
new file mode 100644
index 0000000..0fc3b4d
--- /dev/null
+++ b/hugo/libraries/plugins/transformations/abstract/AppendTransformationsPlugin.class.php
@@ -0,0 +1,86 @@
+<?php
+/* vim: set expandtab sw=4 ts=4 sts=4: */
+/**
+ * Abstract class for the append transformations plugins
+ *
+ * @package PhpMyAdmin-Transformations
+ * @subpackage Append
+ */
+if (! defined('PHPMYADMIN')) {
+ exit;
+}
+
+/* Get the transformations interface */
+require_once 'libraries/plugins/TransformationsPlugin.class.php';
+
+/**
+ * Provides common methods for all of the append transformations plugins.
+ *
+ * @package PhpMyAdmin-Transformations
+ * @subpackage Append
+ */
+abstract class AppendTransformationsPlugin extends TransformationsPlugin
+{
+ /**
+ * Gets the transformation description of the specific plugin
+ *
+ * @return string
+ */
+ public static function getInfo()
+ {
+ return __(
+ 'Appends text to a string. The only option is the text to be appended'
+ . ' (enclosed in single quotes, default empty string).'
+ );
+ }
+
+ /**
+ * Does the actual work of each specific transformations plugin.
+ *
+ * @param string $buffer text to be transformed
+ * @param array $options transformation options
+ * @param string $meta meta information
+ *
+ * @return void
+ */
+ public function applyTransformation($buffer, $options = array(), $meta = '')
+ {
+ if (! isset($options[0]) || $options[0] == '') {
+ $options[0] = '';
+ }
+ //just append the option to the original text
+ $newtext = $buffer . htmlspecialchars($options[0]);
+
+ return $newtext;
+ }
+
+ /**
+ * This method is called when any PluginManager to which the observer
+ * is attached calls PluginManager::notify()
+ *
+ * @param SplSubject $subject The PluginManager notifying the observer
+ * of an update.
+ *
+ * @todo implement
+ * @return void
+ */
+ public function update (SplSubject $subject)
+ {
+ ;
+ }
+
+
+ /* ~~~~~~~~~~~~~~~~~~~~ Getters and Setters ~~~~~~~~~~~~~~~~~~~~ */
+
+
+ /**
+ * Gets the transformation name of the specific plugin
+ *
+ * @return string
+ */
+ public static function getName()
+ {
+ return "Append";
+ }
+}
+?> \ No newline at end of file