phpmyadmin/libraries/properties/options/OptionsPropertyOneItem.class.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Superclass for the single Property Item classes.
   5  *
   6  * @package PhpMyAdmin
   7  */
   8 if (! defined('PHPMYADMIN')) {
   9     exit;
  10 }
  11
  12 /* This class extends the OptionsPropertyItem class */
  13 require_once 'OptionsPropertyItem.class.php';
  14
  15 /**
  16  * Parents only single property items (not groups).
  17  * Defines possible options and getters and setters for them.
  18  *
  19  * @package PhpMyAdmin
  20  */
  21 abstract class OptionsPropertyOneItem extends OptionsPropertyItem
  22 {
  23     /**
  24      * Whether to force or not
  25      *
  26      * @var bool
  27      */
  28     private $_force;
  29
  30     /**
  31      * Values
  32      *
  33      * @var array
  34      */
  35     private $_values;
  36
  37     /**
  38      * Doc
  39      *
  40      * @var string
  41      */
  42     private $_doc;
  43
  44     /**
  45      * Length
  46      *
  47      * @var int
  48      */
  49     private $_len;
  50
  51     /**
  52      * Size
  53      *
  54      * @var int
  55      */
  56     private $_size;
  57
  58
  59     /* ~~~~~~~~~~~~~~~~~~~~ Getters and Setters ~~~~~~~~~~~~~~~~~~~~ */
  60
  61
  62     /**
  63      * Gets the force parameter
  64      *
  65      * @return string
  66      */
  67     public function getForce()
  68     {
  69         return $this->_force;
  70     }
  71
  72     /**
  73      * Sets the force parameter
  74      *
  75      * @param bool $force force parameter
  76      *
  77      * @return void
  78      */
  79     public function setForce($force)
  80     {
  81         $this->_force = $force;
  82     }
  83
  84     /**
  85      * Gets the values
  86      *
  87      * @return string
  88      */
  89     public function getValues()
  90     {
  91         return $this->_values;
  92     }
  93
  94     /**
  95      * Sets the values
  96      *
  97      * @param array $values values
  98      *
  99      * @return void
 100      */
 101     public function setValues($values)
 102     {
 103         $this->_values = $values;
 104     }
 105
 106     /**
 107      * Gets the type of the newline character
 108      *
 109      * @return string
 110      */
 111     public function getDoc()
 112     {
 113         return $this->_doc;
 114     }
 115
 116     /**
 117      * Sets the doc
 118      *
 119      * @param string $doc doc
 120      *
 121      * @return void
 122      */
 123     public function setDoc($doc)
 124     {
 125         $this->_doc = $doc;
 126     }
 127
 128     /**
 129      * Gets the length
 130      *
 131      * @return int
 132      */
 133     public function getLen()
 134     {
 135         return $this->_len;
 136     }
 137
 138     /**
 139      * Sets the length
 140      *
 141      * @param int $len length
 142      *
 143      * @return void
 144      */
 145     public function setLen($len)
 146     {
 147         $this->_len = $len;
 148     }
 149
 150     /**
 151      * Gets the size
 152      *
 153      * @return int
 154      */
 155     public function getSize()
 156     {
 157         return $this->_size;
 158     }
 159
 160     /**
 161      * Sets the size
 162      *
 163      * @param int $size size
 164      *
 165      * @return void
 166      */
 167     public function setSize($size)
 168     {
 169         $this->_size = $size;
 170     }
 171 }
 172 ?>