interface/modules/zend_modules/library/Zend/Db/Sql/Ddl/Constraint/ForeignKey.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\Sql\Ddl\Constraint;
  11
  12 class ForeignKey extends AbstractConstraint
  13 {
  14     /**
  15      * @var string
  16      */
  17     protected $name;
  18
  19     /**
  20      * @var string
  21      */
  22     protected $onDeleteRule = 'NO ACTION';
  23
  24     /**
  25      * @var string
  26      */
  27     protected $onUpdateRule = 'NO ACTION';
  28
  29     /**
  30      * @var string
  31      */
  32     protected $referenceColumn;
  33
  34     /**
  35      * @var string
  36      */
  37     protected $referenceTable;
  38
  39     /**
  40      * @var string
  41      */
  42     protected $specification = 'CONSTRAINT %1$s FOREIGN KEY (%2$s) REFERENCES %3$s (%4$s) ON DELETE %5$s ON UPDATE %6$s';
  43
  44     /**
  45      * @param array|null|string $name
  46      * @param string            $column
  47      * @param string            $referenceTable
  48      * @param string            $referenceColumn
  49      * @param null|string       $onDeleteRule
  50      * @param null|string       $onUpdateRule
  51      */
  52     public function __construct($name, $column, $referenceTable, $referenceColumn, $onDeleteRule = null, $onUpdateRule = null)
  53     {
  54         $this->setName($name);
  55         $this->setColumns($column);
  56         $this->setReferenceTable($referenceTable);
  57         $this->setReferenceColumn($referenceColumn);
  58         (!$onDeleteRule) ?: $this->setOnDeleteRule($onDeleteRule);
  59         (!$onUpdateRule) ?: $this->setOnUpdateRule($onUpdateRule);
  60     }
  61
  62     /**
  63      * @param  string $name
  64      * @return self
  65      */
  66     public function setName($name)
  67     {
  68         $this->name = $name;
  69         return $this;
  70     }
  71
  72     /**
  73      * @return string
  74      */
  75     public function getName()
  76     {
  77         return $this->name;
  78     }
  79
  80     /**
  81      * @param  string $referenceTable
  82      * @return self
  83      */
  84     public function setReferenceTable($referenceTable)
  85     {
  86         $this->referenceTable = $referenceTable;
  87         return $this;
  88     }
  89
  90     /**
  91      * @return string
  92      */
  93     public function getReferenceTable()
  94     {
  95         return $this->referenceTable;
  96     }
  97
  98     /**
  99      * @param  string $referenceColumn
 100      * @return self
 101      */
 102     public function setReferenceColumn($referenceColumn)
 103     {
 104         $this->referenceColumn = $referenceColumn;
 105         return $this;
 106     }
 107
 108     /**
 109      * @return string
 110      */
 111     public function getReferenceColumn()
 112     {
 113         return $this->referenceColumn;
 114     }
 115
 116     /**
 117      * @param  string $onDeleteRule
 118      * @return self
 119      */
 120     public function setOnDeleteRule($onDeleteRule)
 121     {
 122         $this->onDeleteRule = $onDeleteRule;
 123         return $this;
 124     }
 125
 126     /**
 127      * @return string
 128      */
 129     public function getOnDeleteRule()
 130     {
 131         return $this->onDeleteRule;
 132     }
 133
 134     /**
 135      * @param  string $onUpdateRule
 136      * @return self
 137      */
 138     public function setOnUpdateRule($onUpdateRule)
 139     {
 140         $this->onUpdateRule = $onUpdateRule;
 141         return $this;
 142     }
 143
 144     /**
 145      * @return string
 146      */
 147     public function getOnUpdateRule()
 148     {
 149         return $this->onUpdateRule;
 150     }
 151
 152     /**
 153      * @return array
 154      */
 155     public function getExpressionData()
 156     {
 157         return array(array(
 158             $this->specification,
 159             array(
 160                 $this->name,
 161                 $this->columns[0],
 162                 $this->referenceTable,
 163                 $this->referenceColumn,
 164                 $this->onDeleteRule,
 165                 $this->onUpdateRule,
 166             ),
 167             array(
 168                 self::TYPE_IDENTIFIER,
 169                 self::TYPE_IDENTIFIER,
 170                 self::TYPE_IDENTIFIER,
 171                 self::TYPE_IDENTIFIER,
 172                 self::TYPE_LITERAL,
 173                 self::TYPE_LITERAL,
 174             ),
 175         ));
 176     }
 177 }