phpmyadmin/libraries/properties/plugins/ExportPluginProperties.class.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Properties class for the export plug-in
   5  *
   6  * @package PhpMyAdmin
   7  */
   8 if (! defined('PHPMYADMIN')) {
   9     exit;
  10 }
  11
  12 /* This class extends the PluginPropertyItem class */
  13 require_once 'PluginPropertyItem.class.php';
  14
  15 /**
  16  * Defines possible options and getters and setters for them.
  17  *
  18  * @todo modify descriptions if needed, when the plug-in properties are integrated
  19  * @package PhpMyAdmin
  20  */
  21 class ExportPluginProperties extends PluginPropertyItem
  22 {
  23     /**
  24      * Text
  25      *
  26      * @var string
  27      */
  28     private $_text;
  29
  30     /**
  31      * Extension
  32      *
  33      * @var string
  34      */
  35     private $_extension;
  36
  37     /**
  38      * Options
  39      *
  40      * @var OptionsPropertyRootGroup
  41      */
  42     private $_options;
  43
  44     /**
  45      * Options text
  46      *
  47      * @var string
  48      */
  49     private $_optionsText;
  50
  51     /**
  52      * MIME Type
  53      *
  54      * @var string
  55      */
  56     private $_mimeType;
  57
  58     /**
  59      * Whether to force or not
  60      *
  61      * @var bool
  62      */
  63     private $_forceFile;
  64
  65
  66     /* ~~~~~~~~~~~~~~~~~~~~ Getters and Setters ~~~~~~~~~~~~~~~~~~~~ */
  67
  68
  69     /**
  70      * Returns the property item type of either an instance of
  71      *  - OptionsPropertyOneItem ( f.e. "bool", "text", "radio", etc ) or
  72      *  - OptionsPropertyGroup   ( "root", "main" or "subgroup" )
  73      *  - PluginPropertyItem     ( "export", "import", "transformations" )
  74      *
  75      * @return string
  76      */
  77     public function getItemType()
  78     {
  79         return "export";
  80     }
  81
  82     /**
  83      * Gets the text
  84      *
  85      * @return string
  86      */
  87     public function getText()
  88     {
  89         return $this->_text;
  90     }
  91
  92     /**
  93      * Sets the text
  94      *
  95      * @param string $text text
  96      *
  97      * @return void
  98      */
  99     public function setText($text)
 100     {
 101         $this->_text = $text;
 102     }
 103
 104     /**
 105      * Gets the extension
 106      *
 107      * @return string
 108      */
 109     public function getExtension()
 110     {
 111         return $this->_extension;
 112     }
 113
 114     /**
 115      * Sets the extension
 116      *
 117      * @param string $extension extension
 118      *
 119      * @return void
 120      */
 121     public function setExtension($extension)
 122     {
 123         $this->_extension = $extension;
 124     }
 125
 126     /**
 127      * Gets the options
 128      *
 129      * @return OptionsPropertyRootGroup
 130      */
 131     public function getOptions()
 132     {
 133         return $this->_options;
 134     }
 135
 136     /**
 137      * Sets the options
 138      *
 139      * @param OptionsPropertyRootGroup $options options
 140      *
 141      * @return void
 142      */
 143     public function setOptions($options)
 144     {
 145         $this->_options = $options;
 146     }
 147
 148     /**
 149      * Gets the options text
 150      *
 151      * @return string
 152      */
 153     public function getOptionsText()
 154     {
 155         return $this->_optionsText;
 156     }
 157
 158     /**
 159      * Sets the options text
 160      *
 161      * @param string $optionsText optionsText
 162      *
 163      * @return void
 164      */
 165     public function setOptionsText($optionsText)
 166     {
 167         $this->_optionsText = $optionsText;
 168     }
 169
 170     /**
 171      * Gets the MIME type
 172      *
 173      * @return string
 174      */
 175     public function getMimeType()
 176     {
 177         return $this->_mimeType;
 178     }
 179
 180     /**
 181      * Sets the MIME type
 182      *
 183      * @param string $mimeType MIME type
 184      *
 185      * @return void
 186      */
 187     public function setMimeType($mimeType)
 188     {
 189         $this->_mimeType = $mimeType;
 190     }
 191
 192     /**
 193      * Gets the force file parameter
 194      *
 195      * @return bool
 196      */
 197     public function getForceFile()
 198     {
 199         return $this->_forceFile;
 200     }
 201
 202     /**
 203      * Sets the force file parameter
 204      *
 205      * @param bool $forceFile the force file parameter
 206      *
 207      * @return void
 208      */
 209     public function setForceFile($forceFile)
 210     {
 211         $this->_forceFile = $forceFile;
 212     }
 213 }
 214 ?>