interface/modules/zend_modules/library/Zend/Db/RowGateway/AbstractRowGateway.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\RowGateway;
  11
  12 use ArrayAccess;
  13 use Countable;
  14 use Zend\Db\Sql\Sql;
  15 use Zend\Db\Sql\TableIdentifier;
  16
  17 abstract class AbstractRowGateway implements ArrayAccess, Countable, RowGatewayInterface
  18 {
  19
  20     /**
  21      * @var bool
  22      */
  23     protected $isInitialized = false;
  24
  25     /**
  26      * @var string|TableIdentifier
  27      */
  28     protected $table = null;
  29
  30     /**
  31      * @var array
  32      */
  33     protected $primaryKeyColumn = null;
  34
  35     /**
  36      * @var array
  37      */
  38     protected $primaryKeyData = null;
  39
  40     /**
  41      * @var array
  42      */
  43     protected $data = array();
  44
  45     /**
  46      * @var Sql
  47      */
  48     protected $sql = null;
  49
  50     /**
  51      * @var Feature\FeatureSet
  52      */
  53     protected $featureSet = null;
  54
  55     /**
  56      * initialize()
  57      */
  58     public function initialize()
  59     {
  60         if ($this->isInitialized) {
  61             return;
  62         }
  63
  64         if (!$this->featureSet instanceof Feature\FeatureSet) {
  65             $this->featureSet = new Feature\FeatureSet;
  66         }
  67
  68         $this->featureSet->setRowGateway($this);
  69         $this->featureSet->apply('preInitialize', array());
  70
  71         if (!is_string($this->table) && !$this->table instanceof TableIdentifier) {
  72             throw new Exception\RuntimeException('This row object does not have a valid table set.');
  73         }
  74
  75         if ($this->primaryKeyColumn == null) {
  76             throw new Exception\RuntimeException('This row object does not have a primary key column set.');
  77         } elseif (is_string($this->primaryKeyColumn)) {
  78             $this->primaryKeyColumn = (array) $this->primaryKeyColumn;
  79         }
  80
  81         if (!$this->sql instanceof Sql) {
  82             throw new Exception\RuntimeException('This row object does not have a Sql object set.');
  83         }
  84
  85         $this->featureSet->apply('postInitialize', array());
  86
  87         $this->isInitialized = true;
  88     }
  89
  90     /**
  91      * Populate Data
  92      *
  93      * @param  array $rowData
  94      * @param  bool  $rowExistsInDatabase
  95      * @return AbstractRowGateway
  96      */
  97     public function populate(array $rowData, $rowExistsInDatabase = false)
  98     {
  99         $this->initialize();
 100
 101         $this->data = $rowData;
 102         if ($rowExistsInDatabase == true) {
 103             $this->processPrimaryKeyData();
 104         } else {
 105             $this->primaryKeyData = null;
 106         }
 107
 108         return $this;
 109     }
 110
 111     /**
 112      * @param mixed $array
 113      * @return array|void
 114      */
 115     public function exchangeArray($array)
 116     {
 117         return $this->populate($array, true);
 118     }
 119
 120     /**
 121      * Save
 122      *
 123      * @return int
 124      */
 125     public function save()
 126     {
 127         $this->initialize();
 128
 129         if ($this->rowExistsInDatabase()) {
 130
 131             // UPDATE
 132
 133             $data = $this->data;
 134             $where = array();
 135
 136             // primary key is always an array even if its a single column
 137             foreach ($this->primaryKeyColumn as $pkColumn) {
 138                 $where[$pkColumn] = $this->primaryKeyData[$pkColumn];
 139                 if ($data[$pkColumn] == $this->primaryKeyData[$pkColumn]) {
 140                     unset($data[$pkColumn]);
 141                 }
 142             }
 143
 144             $statement = $this->sql->prepareStatementForSqlObject($this->sql->update()->set($data)->where($where));
 145             $result = $statement->execute();
 146             $rowsAffected = $result->getAffectedRows();
 147             unset($statement, $result); // cleanup
 148
 149         } else {
 150
 151             // INSERT
 152             $insert = $this->sql->insert();
 153             $insert->values($this->data);
 154
 155             $statement = $this->sql->prepareStatementForSqlObject($insert);
 156
 157             $result = $statement->execute();
 158             if (($primaryKeyValue = $result->getGeneratedValue()) && count($this->primaryKeyColumn) == 1) {
 159                 $this->primaryKeyData = array($this->primaryKeyColumn[0] => $primaryKeyValue);
 160             } else {
 161                 // make primary key data available so that $where can be complete
 162                 $this->processPrimaryKeyData();
 163             }
 164             $rowsAffected = $result->getAffectedRows();
 165             unset($statement, $result); // cleanup
 166
 167             $where = array();
 168             // primary key is always an array even if its a single column
 169             foreach ($this->primaryKeyColumn as $pkColumn) {
 170                 $where[$pkColumn] = $this->primaryKeyData[$pkColumn];
 171             }
 172
 173         }
 174
 175         // refresh data
 176         $statement = $this->sql->prepareStatementForSqlObject($this->sql->select()->where($where));
 177         $result = $statement->execute();
 178         $rowData = $result->current();
 179         unset($statement, $result); // cleanup
 180
 181         // make sure data and original data are in sync after save
 182         $this->populate($rowData, true);
 183
 184         // return rows affected
 185         return $rowsAffected;
 186     }
 187
 188     /**
 189      * Delete
 190      *
 191      * @return int
 192      */
 193     public function delete()
 194     {
 195         $this->initialize();
 196
 197         $where = array();
 198         // primary key is always an array even if its a single column
 199         foreach ($this->primaryKeyColumn as $pkColumn) {
 200             $where[$pkColumn] = $this->primaryKeyData[$pkColumn];
 201         }
 202
 203         // @todo determine if we need to do a select to ensure 1 row will be affected
 204
 205         $statement = $this->sql->prepareStatementForSqlObject($this->sql->delete()->where($where));
 206         $result = $statement->execute();
 207
 208         $affectedRows = $result->getAffectedRows();
 209         if ($affectedRows == 1) {
 210             // detach from database
 211             $this->primaryKeyData = null;
 212         }
 213
 214         return $affectedRows;
 215     }
 216
 217     /**
 218      * Offset Exists
 219      *
 220      * @param  string $offset
 221      * @return bool
 222      */
 223     public function offsetExists($offset)
 224     {
 225         return array_key_exists($offset, $this->data);
 226     }
 227
 228     /**
 229      * Offset get
 230      *
 231      * @param  string $offset
 232      * @return mixed
 233      */
 234     public function offsetGet($offset)
 235     {
 236         return $this->data[$offset];
 237     }
 238
 239     /**
 240      * Offset set
 241      *
 242      * @param  string $offset
 243      * @param  mixed $value
 244      * @return RowGateway
 245      */
 246     public function offsetSet($offset, $value)
 247     {
 248         $this->data[$offset] = $value;
 249         return $this;
 250     }
 251
 252     /**
 253      * Offset unset
 254      *
 255      * @param  string $offset
 256      * @return AbstractRowGateway
 257      */
 258     public function offsetUnset($offset)
 259     {
 260         $this->data[$offset] = null;
 261         return $this;
 262     }
 263
 264     /**
 265      * @return int
 266      */
 267     public function count()
 268     {
 269         return count($this->data);
 270     }
 271
 272     /**
 273      * To array
 274      *
 275      * @return array
 276      */
 277     public function toArray()
 278     {
 279         return $this->data;
 280     }
 281
 282     /**
 283      * __get
 284      *
 285      * @param  string $name
 286      * @throws Exception\InvalidArgumentException
 287      * @return mixed
 288      */
 289     public function __get($name)
 290     {
 291         if (array_key_exists($name, $this->data)) {
 292             return $this->data[$name];
 293         } else {
 294             throw new Exception\InvalidArgumentException('Not a valid column in this row: ' . $name);
 295         }
 296     }
 297
 298     /**
 299      * __set
 300      *
 301      * @param  string $name
 302      * @param  mixed $value
 303      * @return void
 304      */
 305     public function __set($name, $value)
 306     {
 307         $this->offsetSet($name, $value);
 308     }
 309
 310     /**
 311      * __isset
 312      *
 313      * @param  string $name
 314      * @return bool
 315      */
 316     public function __isset($name)
 317     {
 318         return $this->offsetExists($name);
 319     }
 320
 321     /**
 322      * __unset
 323      *
 324      * @param  string $name
 325      * @return void
 326      */
 327     public function __unset($name)
 328     {
 329         $this->offsetUnset($name);
 330     }
 331
 332     /**
 333      * @return bool
 334      */
 335     public function rowExistsInDatabase()
 336     {
 337         return ($this->primaryKeyData !== null);
 338     }
 339
 340     /**
 341      * @throws Exception\RuntimeException
 342      */
 343     protected function processPrimaryKeyData()
 344     {
 345         $this->primaryKeyData = array();
 346         foreach ($this->primaryKeyColumn as $column) {
 347             if (!isset($this->data[$column])) {
 348                 throw new Exception\RuntimeException('While processing primary key data, a known key ' . $column . ' was not found in the data array');
 349             }
 350             $this->primaryKeyData[$column] = $this->data[$column];
 351         }
 352     }
 353 }