vendor/doctrine/orm/lib/Doctrine/ORM/Query/Exec/AbstractSqlExecutor.php

   1 <?php
   2 /*
   3  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   4  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   5  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
   6  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
   7  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   8  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   9  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  10  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  11  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  12  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  13  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14  *
  15  * This software consists of voluntary contributions made by many individuals
  16  * and is licensed under the MIT license. For more information, see
  17  * <http://www.doctrine-project.org>.
  18  */
  19
  20 namespace Doctrine\ORM\Query\Exec;
  21
  22 use Doctrine\DBAL\Connection;
  23 use Doctrine\DBAL\Cache\QueryCacheProfile;
  24
  25 /**
  26  * Base class for SQL statement executors.
  27  *
  28  * @author      Roman Borschel <roman@code-factory.org>
  29  * @license     http://www.opensource.org/licenses/lgpl-license.php LGPL
  30  * @link        http://www.doctrine-project.org
  31  * @since       2.0
  32  * @todo Rename: AbstractSQLExecutor
  33  */
  34 abstract class AbstractSqlExecutor
  35 {
  36     /**
  37      * @var array
  38      */
  39     protected $_sqlStatements;
  40
  41     /**
  42      * @var QueryCacheProfile
  43      */
  44     protected $queryCacheProfile;
  45
  46     /**
  47      * Gets the SQL statements that are executed by the executor.
  48      *
  49      * @return array  All the SQL update statements.
  50      */
  51     public function getSqlStatements()
  52     {
  53         return $this->_sqlStatements;
  54     }
  55
  56     public function setQueryCacheProfile(QueryCacheProfile $qcp)
  57     {
  58         $this->queryCacheProfile = $qcp;
  59     }
  60
  61     /**
  62      * Executes all sql statements.
  63      *
  64      * @param \Doctrine\DBAL\Connection $conn The database connection that is used to execute the queries.
  65      * @param array $params  The parameters.
  66      * @param array $types The parameter types.
  67      * @return \Doctrine\DBAL\Driver\Statement
  68      */
  69     abstract public function execute(Connection $conn, array $params, array $types);
  70 }