Source for file Exception.php

Documentation is available at Exception.php

  1. <?php
  2. /*
  3.  *  $Id: Exception.php 1344 2007-05-12 23:27:16Z zYne $
  4.  *
  5.  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  6.  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  7.  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  8.  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  9.  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  10.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  11.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  12.  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  13.  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  14.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  15.  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  16.  *
  17.  * This software consists of voluntary contributions made by many individuals
  18.  * and is licensed under the LGPL. For more information, see
  19.  * <http://www.phpdoctrine.com>.
  20.  */
  21. /**
  22.  * Doctrine_Exception
  23.  *
  24.  * @package     Doctrine
  25.  * @license     http://www.opensource.org/licenses/lgpl-license.php LGPL
  26.  * @category    Object Relational Mapping
  27.  * @link        www.phpdoctrine.com
  28.  * @since       1.0
  29.  * @version     $Revision: 1344 $
  30.  * @author      Konsta Vesterinen <kvesteri@cc.hut.fi>
  31.  */
  32. class Doctrine_Exception extends Exception
  33. { 
  34.     /**
  35.      * @var array $_errorMessages       an array of error messages
  36.      */
  37.     protected static $_errorMessages = array(
  38.                 Doctrine::ERR                    => 'unknown error',
  39.                 Doctrine::ERR_ALREADY_EXISTS     => 'already exists',
  40.                 Doctrine::ERR_CANNOT_CREATE      => 'can not create',
  41.                 Doctrine::ERR_CANNOT_ALTER       => 'can not alter',
  42.                 Doctrine::ERR_CANNOT_REPLACE     => 'can not replace',
  43.                 Doctrine::ERR_CANNOT_DELETE      => 'can not delete',
  44.                 Doctrine::ERR_CANNOT_DROP        => 'can not drop',
  45.                 Doctrine::ERR_CONSTRAINT         => 'constraint violation',
  46.                 Doctrine::ERR_CONSTRAINT_NOT_NULL=> 'null value violates not-null constraint',
  47.                 Doctrine::ERR_DIVZERO            => 'division by zero',
  48.                 Doctrine::ERR_INVALID            => 'invalid',
  49.                 Doctrine::ERR_INVALID_DATE       => 'invalid date or time',
  50.                 Doctrine::ERR_INVALID_NUMBER     => 'invalid number',
  51.                 Doctrine::ERR_MISMATCH           => 'mismatch',
  52.                 Doctrine::ERR_NODBSELECTED       => 'no database selected',
  53.                 Doctrine::ERR_NOSUCHFIELD        => 'no such field',
  54.                 Doctrine::ERR_NOSUCHTABLE        => 'no such table',
  55.                 Doctrine::ERR_NOT_CAPABLE        => 'Doctrine backend not capable',
  56.                 Doctrine::ERR_NOT_FOUND          => 'not found',
  57.                 Doctrine::ERR_NOT_LOCKED         => 'not locked',
  58.                 Doctrine::ERR_SYNTAX             => 'syntax error',
  59.                 Doctrine::ERR_UNSUPPORTED        => 'not supported',
  60.                 Doctrine::ERR_VALUE_COUNT_ON_ROW => 'value count on row',
  61.                 Doctrine::ERR_INVALID_DSN        => 'invalid DSN',
  62.                 Doctrine::ERR_CONNECT_FAILED     => 'connect failed',
  63.                 Doctrine::ERR_NEED_MORE_DATA     => 'insufficient data supplied',
  64.                 Doctrine::ERR_EXTENSION_NOT_FOUND=> 'extension not found',
  65.                 Doctrine::ERR_NOSUCHDB           => 'no such database',
  66.                 Doctrine::ERR_ACCESS_VIOLATION   => 'insufficient permissions',
  67.                 Doctrine::ERR_LOADMODULE         => 'error while including on demand module',
  68.                 Doctrine::ERR_TRUNCATED          => 'truncated',
  69.                 Doctrine::ERR_DEADLOCK           => 'deadlock detected',
  70.             );
  71.     /**
  72.      * Return a textual error message for a Doctrine error code
  73.      *
  74.      * @param   int|array  integer error code,
  75.      *                            null to get the current error code-message map,
  76.      *                            or an array with a new error code-message map
  77.      *
  78.      * @return  string  error message
  79.      */
  80.     public function errorMessage($value = null)
  81.     {
  82.         if (is_null($value)) {
  83.             return self::$_errorMessages;
  84.         }
  85.  
  86.         return isset(self::$_errorMessages[$value]) ?
  87.            self::$_errorMessages[$value] : self::$_errorMessages[Doctrine::ERR];
  88.     }
  89.  
  90. }