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

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Abstract class for the formatted transformations plugins
   5  *
   6  * @package    PhpMyAdmin-Transformations
   7  * @subpackage Formatted
   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 formatted transformations plugins.
  18  *
  19  * @package PhpMyAdmin
  20  */
  21 abstract class FormattedTransformationsPlugin extends TransformationsPlugin
  22 {
  23     /**
  24      * Gets the transformation description of the specific plugin
  25      *
  26      * @return string
  27      */
  28     public static function getInfo()
  29     {
  30         return __(
  31             'Displays the contents of the column as-is, without running it'
  32             . ' through htmlspecialchars(). That is, the column is assumed'
  33             . ' to contain valid HTML.'
  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         return $buffer;
  49     }
  50
  51     /**
  52      * This method is called when any PluginManager to which the observer
  53      * is attached calls PluginManager::notify()
  54      *
  55      * @param SplSubject $subject The PluginManager notifying the observer
  56      *                            of an update.
  57      *
  58      * @todo implement
  59      * @return void
  60      */
  61     public function update (SplSubject $subject)
  62     {
  63         ;
  64     }
  65
  66
  67     /* ~~~~~~~~~~~~~~~~~~~~ Getters and Setters ~~~~~~~~~~~~~~~~~~~~ */
  68
  69
  70     /**
  71      * Gets the transformation name of the specific plugin
  72      *
  73      * @return string
  74      */
  75     public static function getName()
  76     {
  77         return "Formatted";
  78     }
  79 }
  80 ?>