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

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Abstract class for the link transformations plugins
   5  *
   6  * @package    PhpMyAdmin-Transformations
   7  * @subpackage Link
   8  */
   9 if (! defined('PHPMYADMIN')) {
  10     exit;
  11 }
  12
  13 /* Get the transformations interface */
  14 require_once 'libraries/plugins/TransformationsPlugin.class.php';
  15 /* For PMA_transformation_global_html_replace */
  16 require_once 'libraries/transformations.lib.php';
  17
  18 /**
  19  * Provides common methods for all of the link transformations plugins.
  20  *
  21  * @package PhpMyAdmin
  22  */
  23 abstract class TextLinkTransformationsPlugin extends TransformationsPlugin
  24 {
  25     /**
  26      * Gets the transformation description of the specific plugin
  27      *
  28      * @return string
  29      */
  30     public static function getInfo()
  31     {
  32         return __(
  33             'Displays a link; the column contains the filename. The first option'
  34             . ' is a URL prefix like "http://www.example.com/". The second option'
  35             . ' is a title for the link.'
  36         );
  37     }
  38
  39     /**
  40      * Does the actual work of each specific transformations plugin.
  41      *
  42      * @param string $buffer  text to be transformed
  43      * @param array  $options transformation options
  44      * @param string $meta    meta information
  45      *
  46      * @return void
  47      */
  48     public function applyTransformation($buffer, $options = array(), $meta = '')
  49     {
  50
  51         $append_part = (isset($options[2]) && $options[2]) ? '' : $buffer;
  52
  53         $transform_options = array (
  54             'string' => '<a href="'
  55                 . PMA_linkURL((isset($options[0]) ? $options[0] : '') . $append_part)
  56                 . '" title="' . (isset($options[1]) ? $options[1] : '')
  57                 . '" target="_new">' . (isset($options[1]) ? $options[1] : $buffer)
  58                 . '</a>'
  59         );
  60
  61         $buffer = PMA_transformation_global_html_replace(
  62             $buffer,
  63             $transform_options
  64         );
  65
  66         return $buffer;
  67     }
  68
  69     /**
  70      * This method is called when any PluginManager to which the observer
  71      * is attached calls PluginManager::notify()
  72      *
  73      * @param SplSubject $subject The PluginManager notifying the observer
  74      *                            of an update.
  75      *
  76      * @todo implement
  77      * @return void
  78      */
  79     public function update (SplSubject $subject)
  80     {
  81         ;
  82     }
  83
  84
  85     /* ~~~~~~~~~~~~~~~~~~~~ Getters and Setters ~~~~~~~~~~~~~~~~~~~~ */
  86
  87
  88     /**
  89      * Gets the transformation name of the specific plugin
  90      *
  91      * @return string
  92      */
  93     public static function getName()
  94     {
  95         return "Link";
  96     }
  97 }
  98 ?>