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-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\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     /**
  28      * @param AdapterInterface                  $adapter
  29      * @param null|string|array|TableIdentifier $table
  30      * @param null|Platform\AbstractPlatform    $sqlPlatform @deprecated since version 3.0
  31      */
  32     public function __construct(AdapterInterface $adapter, $table = null, Platform\AbstractPlatform $sqlPlatform = null)
  33     {
  34         $this->adapter = $adapter;
  35         if ($table) {
  36             $this->setTable($table);
  37         }
  38         $this->sqlPlatform = $sqlPlatform ?: new Platform\Platform($adapter);
  39     }
  40
  41     /**
  42      * @return null|\Zend\Db\Adapter\AdapterInterface
  43      */
  44     public function getAdapter()
  45     {
  46         return $this->adapter;
  47     }
  48
  49     public function hasTable()
  50     {
  51         return ($this->table !== null);
  52     }
  53
  54     public function setTable($table)
  55     {
  56         if (is_string($table) || is_array($table) || $table instanceof TableIdentifier) {
  57             $this->table = $table;
  58         } else {
  59             throw new Exception\InvalidArgumentException('Table must be a string, array or instance of TableIdentifier.');
  60         }
  61         return $this;
  62     }
  63
  64     public function getTable()
  65     {
  66         return $this->table;
  67     }
  68
  69     public function getSqlPlatform()
  70     {
  71         return $this->sqlPlatform;
  72     }
  73
  74     public function select($table = null)
  75     {
  76         if ($this->table !== null && $table !== null) {
  77             throw new Exception\InvalidArgumentException(sprintf(
  78                 'This Sql object is intended to work with only the table "%s" provided at construction time.',
  79                 $this->table
  80             ));
  81         }
  82         return new Select(($table) ?: $this->table);
  83     }
  84
  85     public function insert($table = null)
  86     {
  87         if ($this->table !== null && $table !== null) {
  88             throw new Exception\InvalidArgumentException(sprintf(
  89                 'This Sql object is intended to work with only the table "%s" provided at construction time.',
  90                 $this->table
  91             ));
  92         }
  93         return new Insert(($table) ?: $this->table);
  94     }
  95
  96     public function update($table = null)
  97     {
  98         if ($this->table !== null && $table !== null) {
  99             throw new Exception\InvalidArgumentException(sprintf(
 100                 'This Sql object is intended to work with only the table "%s" provided at construction time.',
 101                 $this->table
 102             ));
 103         }
 104         return new Update(($table) ?: $this->table);
 105     }
 106
 107     public function delete($table = null)
 108     {
 109         if ($this->table !== null && $table !== null) {
 110             throw new Exception\InvalidArgumentException(sprintf(
 111                 'This Sql object is intended to work with only the table "%s" provided at construction time.',
 112                 $this->table
 113             ));
 114         }
 115         return new Delete(($table) ?: $this->table);
 116     }
 117
 118     /**
 119      * @param PreparableSqlInterface $sqlObject
 120      * @param StatementInterface     $statement
 121      * @param AdapterInterface       $adapter
 122      *
 123      * @return StatementInterface
 124      */
 125     public function prepareStatementForSqlObject(PreparableSqlInterface $sqlObject, StatementInterface $statement = null, AdapterInterface $adapter = null)
 126     {
 127         $adapter   = $adapter ?: $this->adapter;
 128         $statement = $statement ?: $adapter->getDriver()->createStatement();
 129
 130         return $this->sqlPlatform->setSubject($sqlObject)->prepareStatement($adapter, $statement);
 131     }
 132
 133     /**
 134      * Get sql string using platform or sql object
 135      *
 136      * @param SqlInterface           $sqlObject
 137      * @param PlatformInterface|null $platform
 138      *
 139      * @return string
 140      *
 141      * @deprecated Deprecated in 2.4. Use buildSqlString() instead
 142      */
 143     public function getSqlStringForSqlObject(SqlInterface $sqlObject, PlatformInterface $platform = null)
 144     {
 145         $platform = ($platform) ?: $this->adapter->getPlatform();
 146         return $this->sqlPlatform->setSubject($sqlObject)->getSqlString($platform);
 147     }
 148
 149     /**
 150      * @param SqlInterface     $sqlObject
 151      * @param AdapterInterface $adapter
 152      *
 153      * @return string
 154      *
 155      * @throws Exception\InvalidArgumentException
 156      */
 157     public function buildSqlString(SqlInterface $sqlObject, AdapterInterface $adapter = null)
 158     {
 159         return $this
 160             ->sqlPlatform
 161             ->setSubject($sqlObject)
 162             ->getSqlString($adapter ? $adapter->getPlatform() : $this->adapter->getPlatform());
 163     }
 164 }