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

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Abstract class for the image link transformations plugins
   5  *
   6  * @package    PhpMyAdmin-Transformations
   7  * @subpackage ImageLink
   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 image link transformations plugins.
  20  *
  21  * @package PhpMyAdmin
  22  */
  23 abstract class TextImageLinkTransformationsPlugin 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 an image and a link; the column contains the filename. The'
  34             . ' first option is a URL prefix like "http://www.example.com/". The'
  35             . ' second and third options are the width and the height in pixels.'
  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         $transform_options = array (
  51             'string' => '<a href="' . (isset($options[0]) ? $options[0] : '')
  52                 . $buffer . '" target="_blank"><img src="'
  53                 . (isset($options[0]) ? $options[0] : '') . $buffer
  54                 . '" border="0" width="' . (isset($options[1]) ? $options[1] : 100)
  55                 . '" height="' . (isset($options[2]) ? $options[2] : 50) . '" />'
  56                 . $buffer . '</a>'
  57         );
  58
  59         $buffer = PMA_transformation_global_html_replace(
  60             $buffer,
  61             $transform_options
  62         );
  63
  64         return $buffer;
  65     }
  66
  67     /**
  68      * This method is called when any PluginManager to which the observer
  69      * is attached calls PluginManager::notify()
  70      *
  71      * @param SplSubject $subject The PluginManager notifying the observer
  72      *                            of an update.
  73      *
  74      * @todo implement
  75      * @return void
  76      */
  77     public function update (SplSubject $subject)
  78     {
  79         ;
  80     }
  81
  82
  83     /* ~~~~~~~~~~~~~~~~~~~~ Getters and Setters ~~~~~~~~~~~~~~~~~~~~ */
  84
  85
  86     /**
  87      * Gets the transformation name of the specific plugin
  88      *
  89      * @return string
  90      */
  91     public static function getName()
  92     {
  93         return "Image Link";
  94     }
  95 }
  96 ?>