phpmyadmin/libraries/plugins/transformations/abstract/AppendTransformationsPlugin.class.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Abstract class for the append transformations plugins
   5  *
   6  * @package    PhpMyAdmin-Transformations
   7  * @subpackage Append
   8  */
   9 if (! defined('PHPMYADMIN')) {
  10     exit;
  11 }
  12
  13 /* Get the transformations interface */
  14 require_once 'libraries/plugins/TransformationsPlugin.class.php';
  15
  16 /**
  17  * Provides common methods for all of the append transformations plugins.
  18  *
  19  * @package    PhpMyAdmin-Transformations
  20  * @subpackage Append
  21  */
  22 abstract class AppendTransformationsPlugin extends TransformationsPlugin
  23 {
  24     /**
  25      * Gets the transformation description of the specific plugin
  26      *
  27      * @return string
  28      */
  29     public static function getInfo()
  30     {
  31         return __(
  32             'Appends text to a string. The only option is the text to be appended'
  33             . ' (enclosed in single quotes, default empty string).'
  34         );
  35     }
  36
  37     /**
  38      * Does the actual work of each specific transformations plugin.
  39      *
  40      * @param string $buffer  text to be transformed
  41      * @param array  $options transformation options
  42      * @param string $meta    meta information
  43      *
  44      * @return void
  45      */
  46     public function applyTransformation($buffer, $options = array(), $meta = '')
  47     {
  48         if (! isset($options[0]) ||  $options[0] == '') {
  49             $options[0] = '';
  50         }
  51         //just append the option to the original text
  52         $newtext = $buffer . htmlspecialchars($options[0]);
  53
  54         return $newtext;
  55     }
  56
  57     /**
  58      * This method is called when any PluginManager to which the observer
  59      * is attached calls PluginManager::notify()
  60      *
  61      * @param SplSubject $subject The PluginManager notifying the observer
  62      *                            of an update.
  63      *
  64      * @todo implement
  65      * @return void
  66      */
  67     public function update (SplSubject $subject)
  68     {
  69         ;
  70     }
  71
  72
  73     /* ~~~~~~~~~~~~~~~~~~~~ Getters and Setters ~~~~~~~~~~~~~~~~~~~~ */
  74
  75
  76     /**
  77      * Gets the transformation name of the specific plugin
  78      *
  79      * @return string
  80      */
  81     public static function getName()
  82     {
  83         return "Append";
  84     }
  85 }
  86 ?>