phpmyadmin/libraries/plugins/ExportPlugin.class.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Abstract class for the export plugins
   5  *
   6  * @package PhpMyAdmin
   7  */
   8 if (! defined('PHPMYADMIN')) {
   9     exit;
  10 }
  11
  12 /* This class extends the PluginObserver class */
  13 require_once 'PluginObserver.class.php';
  14
  15 /**
  16  * Provides a common interface that will have to be implemented by all of the
  17  * export plugins. Some of the plugins will also implement other public
  18  * methods, but those are not declared here, because they are not implemented
  19  * by all export plugins.
  20  *
  21  * @package PhpMyAdmin
  22  */
  23 abstract class ExportPlugin extends PluginObserver
  24 {
  25     /**
  26      * Array containing the specific export plugin type properties
  27      *
  28      * @var array
  29      */
  30     protected $properties;
  31
  32     /**
  33      * Common methods, must be overwritten by all export plugins
  34      */
  35
  36
  37     /**
  38      * Outputs export header
  39      *
  40      * @return bool Whether it succeeded
  41      */
  42     abstract public function exportHeader ();
  43
  44     /**
  45      * Outputs export footer
  46      *
  47      * @return bool Whether it succeeded
  48      */
  49     abstract public function exportFooter ();
  50
  51     /**
  52      * Outputs database header
  53      *
  54      * @param string $db Database name
  55      *
  56      * @return bool Whether it succeeded
  57      */
  58     abstract public function exportDBHeader ($db);
  59
  60     /**
  61      * Outputs database footer
  62      *
  63      * @param string $db Database name
  64      *
  65      * @return bool Whether it succeeded
  66      */
  67     abstract public function exportDBFooter ($db);
  68
  69     /**
  70      * Outputs CREATE DATABASE statement
  71      *
  72      * @param string $db Database name
  73      *
  74      * @return bool Whether it succeeded
  75      */
  76     abstract public function exportDBCreate($db);
  77
  78      /**
  79      * Outputs the content of a table
  80      *
  81      * @param string $db        database name
  82      * @param string $table     table name
  83      * @param string $crlf      the end of line sequence
  84      * @param string $error_url the url to go back in case of error
  85      * @param string $sql_query SQL query for obtaining data
  86      *
  87      * @return bool Whether it succeeded
  88      */
  89     abstract public function exportData ($db, $table, $crlf, $error_url, $sql_query);
  90
  91
  92     /**
  93      * The following methods are used in export.php or in db_operations.php,
  94      * but they are not implemented by all export plugins
  95      */
  96
  97
  98     /**
  99      * Exports routines (procedures and functions)
 100      *
 101      * @param string $db Database
 102      *
 103      * @return bool Whether it succeeded
 104      */
 105     public function exportRoutines($db)
 106     {
 107         ;
 108     }
 109
 110     /**
 111      * Outputs table's structure
 112      *
 113      * @param string $db          database name
 114      * @param string $table       table name
 115      * @param string $crlf        the end of line sequence
 116      * @param string $error_url   the url to go back in case of error
 117      * @param string $export_mode 'create_table','triggers','create_view',
 118      *                            'stand_in'
 119      * @param string $export_type 'server', 'database', 'table'
 120      * @param bool   $relation    whether to include relation comments
 121      * @param bool   $comments    whether to include the pmadb-style column comments
 122      *                            as comments in the structure; this is deprecated
 123      *                            but the parameter is left here because export.php
 124      *                            calls exportStructure() also for other export
 125      *                            types which use this parameter
 126      * @param bool   $mime        whether to include mime comments
 127      * @param bool   $dates       whether to include creation/update/check dates
 128      *
 129      * @return bool Whether it succeeded
 130      */
 131     public function exportStructure(
 132         $db,
 133         $table,
 134         $crlf,
 135         $error_url,
 136         $export_mode,
 137         $export_type,
 138         $relation = false,
 139         $comments = false,
 140         $mime = false,
 141         $dates = false
 142     ) {
 143         ;
 144     }
 145
 146     /**
 147      * Returns a stand-in CREATE definition to resolve view dependencies
 148      *
 149      * @param string $db   the database name
 150      * @param string $view the view name
 151      * @param string $crlf the end of line sequence
 152      *
 153      * @return string resulting definition
 154      */
 155     public function getTableDefStandIn($db, $view, $crlf)
 156     {
 157         ;
 158     }
 159
 160     /**
 161      * Outputs triggers
 162      *
 163      * @param string $db    database name
 164      * @param string $table table name
 165      *
 166      * @return string Formatted triggers list
 167      */
 168     protected function getTriggers($db, $table)
 169     {
 170         ;
 171     }
 172
 173     /**
 174      * Initialize the specific variables for each export plugin
 175      *
 176      * @return void
 177      */
 178     protected function initSpecificVariables()
 179     {
 180         ;
 181     }
 182
 183
 184     /* ~~~~~~~~~~~~~~~~~~~~ Getters and Setters ~~~~~~~~~~~~~~~~~~~~ */
 185
 186
 187     /**
 188      * Gets the export specific format plugin properties
 189      *
 190      * @return array
 191      */
 192     public function getProperties()
 193     {
 194         return $this->properties;
 195     }
 196
 197     /**
 198      * Sets the export plugins properties and is implemented by each export
 199      * plugin
 200      *
 201      * @return void
 202      */
 203     abstract protected function setProperties();
 204 }
 205 ?>