phpmyadmin/libraries/plugins/TransformationsPlugin.class.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Abstract class for the transformations plugins
   5  *
   6  * @package PhpMyAdmin
   7  */
   8 if (! defined('PHPMYADMIN')) {
   9     exit;
  10 }
  11
  12 /* It extends the PluginObserver abstract class */
  13 require_once 'PluginObserver.class.php';
  14 /* It also implements the transformations interface */
  15 require_once 'TransformationsInterface.int.php';
  16
  17 /**
  18  * Extends PluginObserver and provides a common interface that will have to
  19  * be implemented by all of the transformations plugins.
  20  *
  21  * @package PhpMyAdmin
  22  */
  23 abstract class TransformationsPlugin extends PluginObserver
  24     implements TransformationsInterface
  25 {
  26     /**
  27      * Does the actual work of each specific transformations plugin.
  28      *
  29      * @param array $options transformation options
  30      *
  31      * @return void
  32      */
  33     public function applyTransformationNoWrap($options = array())
  34     {
  35         ;
  36     }
  37
  38     /**
  39      * Does the actual work of each specific transformations plugin.
  40      *
  41      * @param string $buffer  text to be transformed
  42      * @param array  $options transformation options
  43      * @param string $meta    meta information
  44      *
  45      * @return void
  46      */
  47     abstract public function applyTransformation($buffer, $options = array(), $meta = '');
  48 }
  49 ?>