interface/modules/zend_modules/library/Zend/Db/Metadata/Object/ConstraintObject.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-2013 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 ConstraintObject
  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      * One of "PRIMARY KEY", "UNIQUE", "FOREIGN KEY", or "CHECK"
  34      *
  35      * @var string
  36      */
  37     protected $type = null;
  38
  39     /**
  40      *
  41      *
  42      * @var string[]
  43      */
  44     protected $columns = array();
  45
  46     /**
  47      *
  48      *
  49      * @var string
  50      */
  51     protected $referencedTableSchema;
  52
  53     /**
  54      *
  55      *
  56      * @var string
  57      */
  58     protected $referencedTableName;
  59
  60     /**
  61      *
  62      *
  63      * @var string[]
  64      */
  65     protected $referencedColumns;
  66
  67     /**
  68      *
  69      *
  70      * @var string
  71      */
  72     protected $matchOption;
  73
  74     /**
  75      *
  76      *
  77      * @var string
  78      */
  79     protected $updateRule;
  80
  81     /**
  82      *
  83      *
  84      * @var string
  85      */
  86     protected $deleteRule;
  87
  88     /**
  89      *
  90      *
  91      * @var string
  92      */
  93     protected $checkClause;
  94
  95     /**
  96      * Constructor
  97      *
  98      * @param string $name
  99      * @param string $tableName
 100      * @param string $schemaName
 101      */
 102     public function __construct($name, $tableName, $schemaName = null)
 103     {
 104         $this->setName($name);
 105         $this->setTableName($tableName);
 106         $this->setSchemaName($schemaName);
 107     }
 108
 109     /**
 110      * Set name
 111      *
 112      * @param string $name
 113      */
 114     public function setName($name)
 115     {
 116         $this->name = $name;
 117     }
 118
 119     /**
 120      * Get name
 121      *
 122      * @return string
 123      */
 124     public function getName()
 125     {
 126         return $this->name;
 127     }
 128
 129     /**
 130      * Set schema name
 131      *
 132      * @param string $schemaName
 133      */
 134     public function setSchemaName($schemaName)
 135     {
 136         $this->schemaName = $schemaName;
 137     }
 138
 139     /**
 140      * Get schema name
 141      *
 142      * @return string
 143      */
 144     public function getSchemaName()
 145     {
 146         return $this->schemaName;
 147     }
 148
 149     /**
 150      * Get table name
 151      *
 152      * @return string
 153      */
 154     public function getTableName()
 155     {
 156         return $this->tableName;
 157     }
 158
 159     /**
 160      * Set table name
 161      *
 162      * @param  string $tableName
 163      * @return ConstraintObject
 164      */
 165     public function setTableName($tableName)
 166     {
 167         $this->tableName = $tableName;
 168         return $this;
 169     }
 170
 171     /**
 172      * Set type
 173      *
 174      * @param string $type
 175      */
 176     public function setType($type)
 177     {
 178         $this->type = $type;
 179     }
 180
 181     /**
 182      * Get type
 183      *
 184      * @return string
 185      */
 186     public function getType()
 187     {
 188         return $this->type;
 189     }
 190
 191     public function hasColumns()
 192     {
 193         return (!empty($this->columns));
 194     }
 195
 196     /**
 197      * Get Columns.
 198      *
 199      * @return string[]
 200      */
 201     public function getColumns()
 202     {
 203         return $this->columns;
 204     }
 205
 206     /**
 207      * Set Columns.
 208      *
 209      * @param string[] $columns
 210      * @return ConstraintObject
 211      */
 212     public function setColumns(array $columns)
 213     {
 214         $this->columns = $columns;
 215         return $this;
 216     }
 217
 218     /**
 219      * Get Referenced Table Schema.
 220      *
 221      * @return string
 222      */
 223     public function getReferencedTableSchema()
 224     {
 225         return $this->referencedTableSchema;
 226     }
 227
 228     /**
 229      * Set Referenced Table Schema.
 230      *
 231      * @param string $referencedTableSchema
 232      * @return ConstraintObject
 233      */
 234     public function setReferencedTableSchema($referencedTableSchema)
 235     {
 236         $this->referencedTableSchema = $referencedTableSchema;
 237         return $this;
 238     }
 239
 240     /**
 241      * Get Referenced Table Name.
 242      *
 243      * @return string
 244      */
 245     public function getReferencedTableName()
 246     {
 247         return $this->referencedTableName;
 248     }
 249
 250     /**
 251      * Set Referenced Table Name.
 252      *
 253      * @param string $referencedTableName
 254      * @return ConstraintObject
 255      */
 256     public function setReferencedTableName($referencedTableName)
 257     {
 258         $this->referencedTableName = $referencedTableName;
 259         return $this;
 260     }
 261
 262     /**
 263      * Get Referenced Columns.
 264      *
 265      * @return string[]
 266      */
 267     public function getReferencedColumns()
 268     {
 269         return $this->referencedColumns;
 270     }
 271
 272     /**
 273      * Set Referenced Columns.
 274      *
 275      * @param string[] $referencedColumns
 276      * @return ConstraintObject
 277      */
 278     public function setReferencedColumns(array $referencedColumns)
 279     {
 280         $this->referencedColumns = $referencedColumns;
 281         return $this;
 282     }
 283
 284     /**
 285      * Get Match Option.
 286      *
 287      * @return string
 288      */
 289     public function getMatchOption()
 290     {
 291         return $this->matchOption;
 292     }
 293
 294     /**
 295      * Set Match Option.
 296      *
 297      * @param string $matchOption
 298      * @return ConstraintObject
 299      */
 300     public function setMatchOption($matchOption)
 301     {
 302         $this->matchOption = $matchOption;
 303         return $this;
 304     }
 305
 306     /**
 307      * Get Update Rule.
 308      *
 309      * @return string
 310      */
 311     public function getUpdateRule()
 312     {
 313         return $this->updateRule;
 314     }
 315
 316     /**
 317      * Set Update Rule.
 318      *
 319      * @param string $updateRule
 320      * @return ConstraintObject
 321      */
 322     public function setUpdateRule($updateRule)
 323     {
 324         $this->updateRule = $updateRule;
 325         return $this;
 326     }
 327
 328     /**
 329      * Get Delete Rule.
 330      *
 331      * @return string
 332      */
 333     public function getDeleteRule()
 334     {
 335         return $this->deleteRule;
 336     }
 337
 338     /**
 339      * Set Delete Rule.
 340      *
 341      * @param string $deleteRule
 342      * @return ConstraintObject
 343      */
 344     public function setDeleteRule($deleteRule)
 345     {
 346         $this->deleteRule = $deleteRule;
 347         return $this;
 348     }
 349
 350     /**
 351      * Get Check Clause.
 352      *
 353      * @return string
 354      */
 355     public function getCheckClause()
 356     {
 357         return $this->checkClause;
 358     }
 359
 360     /**
 361      * Set Check Clause.
 362      *
 363      * @param string $checkClause
 364      * @return ConstraintObject
 365      */
 366     public function setCheckClause($checkClause)
 367     {
 368         $this->checkClause = $checkClause;
 369         return $this;
 370     }
 371
 372     /**
 373      * Is primary key
 374      *
 375      * @return bool
 376      */
 377     public function isPrimaryKey()
 378     {
 379         return ('PRIMARY KEY' == $this->type);
 380     }
 381
 382     /**
 383      * Is unique key
 384      *
 385      * @return bool
 386      */
 387     public function isUnique()
 388     {
 389         return ('UNIQUE' == $this->type);
 390     }
 391
 392     /**
 393      * Is foreign key
 394      *
 395      * @return bool
 396      */
 397     public function isForeignKey()
 398     {
 399         return ('FOREIGN KEY' == $this->type);
 400     }
 401
 402     /**
 403      * Is foreign key
 404      *
 405      * @return bool
 406      */
 407     public function isCheck()
 408     {
 409         return ('CHECK' == $this->type);
 410     }
 411 }