phpmyadmin/libraries/plugins/SchemaPlugin.class.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Abstract class for the schema export plugins
   5  *
   6  * @package PhpMyAdmin
   7  */
   8 if (! defined('PHPMYADMIN')) {
   9     exit;
  10 }
  11
  12 /**
  13  * Provides a common interface that will have to be implemented by all of the
  14  * schema export plugins. Some of the plugins will also implement other public
  15  * methods, but those are not declared here, because they are not implemented
  16  * by all export plugins.
  17  *
  18  * @package PhpMyAdmin
  19  */
  20 abstract class SchemaPlugin
  21 {
  22     /**
  23      * SchemaPluginProperties object containing
  24      * the specific schema export plugin type properties
  25      *
  26      * @var SchemaPluginProperties
  27      */
  28     protected $properties;
  29
  30     /**
  31      * Gets the export specific format plugin properties
  32      *
  33      * @return SchemaPluginProperties
  34      */
  35     public function getProperties()
  36     {
  37         return $this->properties;
  38     }
  39
  40     /**
  41      * Sets the export plugins properties and is implemented by
  42      * each schema export plugin
  43      *
  44      * @return void
  45      */
  46     protected abstract function setProperties();
  47
  48     /**
  49      * Exports the schema into the specified format.
  50      *
  51      * @param string $db database name
  52      *
  53      * @return bool Whether it succeeded
  54      */
  55     public abstract function exportSchema($db);
  56
  57     /**
  58      * Adds export options common to all plugins.
  59      *
  60      * @param OptionsPropertyMainGroup $propertyGroup property group
  61      *
  62      * @return void
  63      */
  64     protected function addCommonOptions(OptionsPropertyMainGroup $propertyGroup)
  65     {
  66         $leaf = new BoolPropertyItem();
  67         $leaf->setName('show_color');
  68         $leaf->setText(__('Show color'));
  69         $propertyGroup->addProperty($leaf);
  70         $leaf = new BoolPropertyItem();
  71         $leaf->setName('show_keys');
  72         $leaf->setText(__('Only show keys'));
  73         $propertyGroup->addProperty($leaf);
  74     }
  75 }