tests/PHPUnit/Extensions/Database/Operation/Exception.php

   1 <?php
   2 /**
   3  * PHPUnit
   4  *
   5  * Copyright (c) 2002-2009, Sebastian Bergmann <sb@sebastian-bergmann.de>.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  *   * Redistributions of source code must retain the above copyright
  13  *     notice, this list of conditions and the following disclaimer.
  14  *
  15  *   * Redistributions in binary form must reproduce the above copyright
  16  *     notice, this list of conditions and the following disclaimer in
  17  *     the documentation and/or other materials provided with the
  18  *     distribution.
  19  *
  20  *   * Neither the name of Sebastian Bergmann nor the names of his
  21  *     contributors may be used to endorse or promote products derived
  22  *     from this software without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  25  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  26  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  27  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  28  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  29  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  30  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  31  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  32  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  34  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35  * POSSIBILITY OF SUCH DAMAGE.
  36  *
  37  * @category   Testing
  38  * @package    PHPUnit
  39  * @author     Mike Lively <m@digitalsandwich.com>
  40  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  41  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  42
  43  * @link       http://www.phpunit.de/
  44  * @since      File available since Release 3.2.0
  45  */
  46
  47 require_once 'PHPUnit/Framework.php';
  48 require_once 'PHPUnit/Util/Filter.php';
  49
  50 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  51
  52 /**
  53  * Thrown for exceptions encountered with database operations. Provides
  54  * information regarding which operations failed and the query (if any) it
  55  * failed on.
  56  *
  57  * @category   Testing
  58  * @package    PHPUnit
  59  * @author     Mike Lively <m@digitalsandwich.com>
  60  * @copyright  2009 Mike Lively <m@digitalsandwich.com>
  61  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  62  * @version    Release: 3.3.17
  63  * @link       http://www.phpunit.de/
  64  * @since      Class available since Release 3.2.0
  65  */
  66 class PHPUnit_Extensions_Database_Operation_Exception extends RuntimeException
  67 {
  68
  69     /**
  70      * @var string
  71      */
  72     protected $operation;
  73
  74     /**
  75      * @var string
  76      */
  77     protected $preparedQuery;
  78
  79     /**
  80      * @var array
  81      */
  82     protected $preparedArgs;
  83
  84     /**
  85      * @var PHPUnit_Extensions_Database_DataSet_ITable
  86      */
  87     protected $table;
  88
  89     /**
  90      * @var string
  91      */
  92     protected $error;
  93
  94     /**
  95      * Creates a new dbunit operation exception
  96      *
  97      * @param string $operation
  98      * @param string $current_query
  99      * @param PHPUnit_Extensions_Database_DataSet_ITable $current_table
 100      * @param string $error
 101      */
 102     public function __construct($operation, $current_query, $current_args, $current_table, $error)
 103     {
 104         parent::__construct("{$operation} operation failed on query: {$current_query} using args: " . print_r($current_args, TRUE) . " [{$error}]");
 105         $this->operation = $operation;
 106         $this->preparedQuery = $current_query;
 107         $this->preparedArgs = $current_args;
 108         $this->table = $current_table;
 109         $this->error = $error;
 110     }
 111
 112     public function getOperation()
 113     {
 114         return $this->operation;
 115     }
 116
 117     public function getQuery()
 118     {
 119         return $this->preparedQuery;
 120     }
 121
 122     public function getTable()
 123     {
 124         return $this->table;
 125     }
 126
 127     public function getArgs()
 128     {
 129         return $this->preparedArgs;
 130     }
 131
 132     public function getError()
 133     {
 134         return $this->error;
 135     }
 136 }
 137 ?>