interface/modules/zend_modules/library/Zend/Db/Metadata/Object/ColumnObject.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Db\Metadata\Object;
  11
  12 class ColumnObject
  13 {
  14     /**
  15      *
  16      * @var string
  17      */
  18     protected $name = null;
  19
  20     /**
  21      *
  22      * @var string
  23      */
  24     protected $tableName = null;
  25
  26     /**
  27      *
  28      * @var string
  29      */
  30     protected $schemaName = null;
  31
  32     /**
  33      *
  34      * @var
  35      */
  36     protected $ordinalPosition = null;
  37
  38     /**
  39      *
  40      * @var string
  41      */
  42     protected $columnDefault = null;
  43
  44     /**
  45      *
  46      * @var bool
  47      */
  48     protected $isNullable = null;
  49
  50     /**
  51      *
  52      * @var string
  53      */
  54     protected $dataType = null;
  55
  56     /**
  57      *
  58      * @var int
  59      */
  60     protected $characterMaximumLength = null;
  61
  62     /**
  63      *
  64      * @var int
  65      */
  66     protected $characterOctetLength = null;
  67
  68     /**
  69      *
  70      * @var int
  71      */
  72     protected $numericPrecision = null;
  73
  74     /**
  75      *
  76      * @var int
  77      */
  78     protected $numericScale = null;
  79
  80     /**
  81      *
  82      * @var bool
  83      */
  84     protected $numericUnsigned = null;
  85
  86     /**
  87      *
  88      * @var array
  89      */
  90     protected $errata = array();
  91
  92     /**
  93      * Constructor
  94      *
  95      * @param string $name
  96      * @param string $tableName
  97      * @param string $schemaName
  98      */
  99     public function __construct($name, $tableName, $schemaName = null)
 100     {
 101         $this->setName($name);
 102         $this->setTableName($tableName);
 103         $this->setSchemaName($schemaName);
 104     }
 105
 106     /**
 107      * Set name
 108      *
 109      * @param string $name
 110      */
 111     public function setName($name)
 112     {
 113         $this->name = $name;
 114     }
 115
 116     /**
 117      * Get name
 118      *
 119      * @return string
 120      */
 121     public function getName()
 122     {
 123         return $this->name;
 124     }
 125
 126     /**
 127      * Get table name
 128      *
 129      * @return string
 130      */
 131     public function getTableName()
 132     {
 133         return $this->tableName;
 134     }
 135
 136     /**
 137      * Set table name
 138      *
 139      * @param string $tableName
 140      * @return ColumnObject
 141      */
 142     public function setTableName($tableName)
 143     {
 144         $this->tableName = $tableName;
 145         return $this;
 146     }
 147
 148     /**
 149      * Set schema name
 150      *
 151      * @param string $schemaName
 152      */
 153     public function setSchemaName($schemaName)
 154     {
 155         $this->schemaName = $schemaName;
 156     }
 157
 158     /**
 159      * Get schema name
 160      *
 161      * @return string
 162      */
 163     public function getSchemaName()
 164     {
 165         return $this->schemaName;
 166     }
 167
 168     /**
 169      * @return int $ordinalPosition
 170      */
 171     public function getOrdinalPosition()
 172     {
 173         return $this->ordinalPosition;
 174     }
 175
 176     /**
 177      * @param int $ordinalPosition to set
 178      * @return ColumnObject
 179      */
 180     public function setOrdinalPosition($ordinalPosition)
 181     {
 182         $this->ordinalPosition = $ordinalPosition;
 183         return $this;
 184     }
 185
 186     /**
 187      * @return null|string the $columnDefault
 188      */
 189     public function getColumnDefault()
 190     {
 191         return $this->columnDefault;
 192     }
 193
 194     /**
 195      * @param mixed $columnDefault to set
 196      * @return ColumnObject
 197      */
 198     public function setColumnDefault($columnDefault)
 199     {
 200         $this->columnDefault = $columnDefault;
 201         return $this;
 202     }
 203
 204     /**
 205      * @return bool $isNullable
 206      */
 207     public function getIsNullable()
 208     {
 209         return $this->isNullable;
 210     }
 211
 212     /**
 213      * @param bool $isNullable to set
 214      * @return ColumnObject
 215      */
 216     public function setIsNullable($isNullable)
 217     {
 218         $this->isNullable = $isNullable;
 219         return $this;
 220     }
 221
 222     /**
 223      * @return bool $isNullable
 224      */
 225     public function isNullable()
 226     {
 227         return $this->isNullable;
 228     }
 229
 230     /**
 231      * @return null|string the $dataType
 232      */
 233     public function getDataType()
 234     {
 235         return $this->dataType;
 236     }
 237
 238     /**
 239      * @param string $dataType the $dataType to set
 240      * @return ColumnObject
 241      */
 242     public function setDataType($dataType)
 243     {
 244         $this->dataType = $dataType;
 245         return $this;
 246     }
 247
 248     /**
 249      * @return int|null the $characterMaximumLength
 250      */
 251     public function getCharacterMaximumLength()
 252     {
 253         return $this->characterMaximumLength;
 254     }
 255
 256     /**
 257      * @param int $characterMaximumLength the $characterMaximumLength to set
 258      * @return ColumnObject
 259      */
 260     public function setCharacterMaximumLength($characterMaximumLength)
 261     {
 262         $this->characterMaximumLength = $characterMaximumLength;
 263         return $this;
 264     }
 265
 266     /**
 267      * @return int|null the $characterOctetLength
 268      */
 269     public function getCharacterOctetLength()
 270     {
 271         return $this->characterOctetLength;
 272     }
 273
 274     /**
 275      * @param int $characterOctetLength the $characterOctetLength to set
 276      * @return ColumnObject
 277      */
 278     public function setCharacterOctetLength($characterOctetLength)
 279     {
 280         $this->characterOctetLength = $characterOctetLength;
 281         return $this;
 282     }
 283
 284     /**
 285      * @return int the $numericPrecision
 286      */
 287     public function getNumericPrecision()
 288     {
 289         return $this->numericPrecision;
 290     }
 291
 292     /**
 293      * @param int $numericPrecision the $numericPrevision to set
 294      * @return ColumnObject
 295      */
 296     public function setNumericPrecision($numericPrecision)
 297     {
 298         $this->numericPrecision = $numericPrecision;
 299         return $this;
 300     }
 301
 302     /**
 303      * @return int the $numericScale
 304      */
 305     public function getNumericScale()
 306     {
 307         return $this->numericScale;
 308     }
 309
 310     /**
 311      * @param int $numericScale the $numericScale to set
 312      * @return ColumnObject
 313      */
 314     public function setNumericScale($numericScale)
 315     {
 316         $this->numericScale = $numericScale;
 317         return $this;
 318     }
 319
 320     /**
 321      * @return bool
 322      */
 323     public function getNumericUnsigned()
 324     {
 325         return $this->numericUnsigned;
 326     }
 327
 328     /**
 329      * @param  bool $numericUnsigned
 330      * @return ColumnObject
 331      */
 332     public function setNumericUnsigned($numericUnsigned)
 333     {
 334         $this->numericUnsigned = $numericUnsigned;
 335         return $this;
 336     }
 337
 338     /**
 339      * @return bool
 340      */
 341     public function isNumericUnsigned()
 342     {
 343         return $this->numericUnsigned;
 344     }
 345
 346     /**
 347      * @return array the $errata
 348      */
 349     public function getErratas()
 350     {
 351         return $this->errata;
 352     }
 353
 354     /**
 355      * @param array $erratas
 356      * @return ColumnObject
 357      */
 358     public function setErratas(array $erratas)
 359     {
 360         foreach ($erratas as $name => $value) {
 361             $this->setErrata($name, $value);
 362         }
 363         return $this;
 364     }
 365
 366     /**
 367      * @param string $errataName
 368      * @return mixed
 369      */
 370     public function getErrata($errataName)
 371     {
 372         if (array_key_exists($errataName, $this->errata)) {
 373             return $this->errata[$errataName];
 374         }
 375         return;
 376     }
 377
 378     /**
 379      * @param string $errataName
 380      * @param mixed $errataValue
 381      * @return ColumnObject
 382      */
 383     public function setErrata($errataName, $errataValue)
 384     {
 385         $this->errata[$errataName] = $errataValue;
 386         return $this;
 387     }
 388 }