interface/modules/zend_modules/library/Zend/Db/Sql/Sql.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;
  11
  12 use Zend\Db\Adapter\AdapterInterface;
  13 use Zend\Db\Adapter\Driver\StatementInterface;
  14 use Zend\Db\Adapter\Platform\PlatformInterface;
  15
  16 class Sql
  17 {
  18     /** @var AdapterInterface */
  19     protected $adapter = null;
  20
  21     /** @var string|array|TableIdentifier */
  22     protected $table = null;
  23
  24     /** @var Platform\Platform */
  25     protected $sqlPlatform = null;
  26
  27     public function __construct(AdapterInterface $adapter, $table = null, Platform\AbstractPlatform $sqlPlatform = null)
  28     {
  29         $this->adapter = $adapter;
  30         if ($table) {
  31             $this->setTable($table);
  32         }
  33         $this->sqlPlatform = ($sqlPlatform) ?: new Platform\Platform($adapter);
  34     }
  35
  36     /**
  37      * @return null|\Zend\Db\Adapter\AdapterInterface
  38      */
  39     public function getAdapter()
  40     {
  41         return $this->adapter;
  42     }
  43
  44     public function hasTable()
  45     {
  46         return ($this->table != null);
  47     }
  48
  49     public function setTable($table)
  50     {
  51         if (is_string($table) || is_array($table) || $table instanceof TableIdentifier) {
  52             $this->table = $table;
  53         } else {
  54             throw new Exception\InvalidArgumentException('Table must be a string, array or instance of TableIdentifier.');
  55         }
  56         return $this;
  57     }
  58
  59     public function getTable()
  60     {
  61         return $this->table;
  62     }
  63
  64     public function getSqlPlatform()
  65     {
  66         return $this->sqlPlatform;
  67     }
  68
  69     public function select($table = null)
  70     {
  71         if ($this->table !== null && $table !== null) {
  72             throw new Exception\InvalidArgumentException(sprintf(
  73                 'This Sql object is intended to work with only the table "%s" provided at construction time.',
  74                 $this->table
  75             ));
  76         }
  77         return new Select(($table) ?: $this->table);
  78     }
  79
  80     public function insert($table = null)
  81     {
  82         if ($this->table !== null && $table !== null) {
  83             throw new Exception\InvalidArgumentException(sprintf(
  84                 'This Sql object is intended to work with only the table "%s" provided at construction time.',
  85                 $this->table
  86             ));
  87         }
  88         return new Insert(($table) ?: $this->table);
  89     }
  90
  91     public function update($table = null)
  92     {
  93         if ($this->table !== null && $table !== null) {
  94             throw new Exception\InvalidArgumentException(sprintf(
  95                 'This Sql object is intended to work with only the table "%s" provided at construction time.',
  96                 $this->table
  97             ));
  98         }
  99         return new Update(($table) ?: $this->table);
 100     }
 101
 102     public function delete($table = null)
 103     {
 104         if ($this->table !== null && $table !== null) {
 105             throw new Exception\InvalidArgumentException(sprintf(
 106                 'This Sql object is intended to work with only the table "%s" provided at construction time.',
 107                 $this->table
 108             ));
 109         }
 110         return new Delete(($table) ?: $this->table);
 111     }
 112
 113     /**
 114      * @param PreparableSqlInterface $sqlObject
 115      * @param StatementInterface|null $statement
 116      * @return StatementInterface
 117      */
 118     public function prepareStatementForSqlObject(PreparableSqlInterface $sqlObject, StatementInterface $statement = null)
 119     {
 120         $statement = ($statement) ?: $this->adapter->getDriver()->createStatement();
 121
 122         if ($this->sqlPlatform) {
 123             $this->sqlPlatform->setSubject($sqlObject);
 124             $this->sqlPlatform->prepareStatement($this->adapter, $statement);
 125         } else {
 126             $sqlObject->prepareStatement($this->adapter, $statement);
 127         }
 128
 129         return $statement;
 130     }
 131
 132     public function getSqlStringForSqlObject(SqlInterface $sqlObject, PlatformInterface $platform = null)
 133     {
 134         $platform = ($platform) ?: $this->adapter->getPlatform();
 135
 136         if ($this->sqlPlatform) {
 137             $this->sqlPlatform->setSubject($sqlObject);
 138             $sqlString = $this->sqlPlatform->getSqlString($platform);
 139         } else {
 140             $sqlString = $sqlObject->getSqlString($platform);
 141         }
 142
 143         return $sqlString;
 144     }
 145 }