phpmyadmin/libraries/plugins/IOTransformationsPlugin.class.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Abstract class for the I/O transformations plugins
   5  *
   6  * @package PhpMyAdmin
   7  */
   8 if (! defined('PHPMYADMIN')) {
   9     exit;
  10 }
  11
  12 /* It extends the transformations plugin class */
  13 require_once 'TransformationsPlugin.class.php';
  14
  15 /**
  16  * Provides a common interface that will have to be implemented
  17  * by all of the Input/Output transformations plugins.
  18  *
  19  * @package PhpMyAdmin
  20  */
  21 abstract class IOTransformationsPlugin extends TransformationsPlugin
  22 {
  23
  24     // specifies whether transformation was successful or not
  25     protected $success = true;
  26
  27     // to store the error message in case of failed transformations
  28     protected $error = '';
  29
  30     /**
  31      * Returns the html for input field to override default textarea.
  32      * Note: Return empty string if default textarea is required.
  33      *
  34      * @param array  $column               column details
  35      * @param int    $row_id               row number
  36      * @param string $column_name_appendix the name attribute
  37      * @param array  $options              transformation options
  38      * @param string $value                Current field value
  39      * @param string $text_dir             text direction
  40      * @param int    $tabindex             tab index
  41      * @param int    $tabindex_for_value   offset for the values tabindex
  42      * @param int    $idindex              id index
  43      *
  44      * @return string the html for input field
  45      */
  46     public function getInputHtml(
  47         $column, $row_id, $column_name_appendix, $options, $value, $text_dir,
  48         $tabindex, $tabindex_for_value, $idindex
  49     ) {
  50         return '';
  51     }
  52
  53     /**
  54      * Returns the array of scripts (filename) required for plugin
  55      * initialization and handling
  56      *
  57      * @return array javascripts to be included
  58      */
  59     public function getScripts()
  60     {
  61         return array();
  62     }
  63
  64     /**
  65      * Returns the error message
  66      *
  67      * @return string error
  68      */
  69     public function getError()
  70     {
  71         return $this->error;
  72     }
  73
  74     /**
  75      * Returns the success status
  76      *
  77      * @return bool
  78      */
  79     public function isSuccess()
  80     {
  81         return $this->success;
  82     }
  83
  84     /**
  85      * Resets the object properties
  86      *
  87      * @return void
  88      */
  89     public function reset()
  90     {
  91         $this->success = true;
  92         $this->error = '';
  93     }
  94 }