vendor/doctrine/common/lib/Doctrine/Common/Annotations/AnnotationException.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\Common\Annotations;
  21
  22 /**
  23  * Description of AnnotationException
  24  *
  25  * @since   2.0
  26  * @author  Benjamin Eberlei <kontakt@beberlei.de>
  27  * @author  Guilherme Blanco <guilhermeblanco@hotmail.com>
  28  * @author  Jonathan Wage <jonwage@gmail.com>
  29  * @author  Roman Borschel <roman@code-factory.org>
  30  */
  31 class AnnotationException extends \Exception
  32 {
  33     /**
  34      * Creates a new AnnotationException describing a Syntax error.
  35      *
  36      * @param string $message Exception message
  37      * @return AnnotationException
  38      */
  39     public static function syntaxError($message)
  40     {
  41         return new self('[Syntax Error] ' . $message);
  42     }
  43
  44     /**
  45      * Creates a new AnnotationException describing a Semantical error.
  46      *
  47      * @param string $message Exception message
  48      * @return AnnotationException
  49      */
  50     public static function semanticalError($message)
  51     {
  52         return new self('[Semantical Error] ' . $message);
  53     }
  54
  55     /**
  56      * Creates a new AnnotationException describing a constant semantical error.
  57      *
  58      * @since 2.3
  59      * @param string $identifier
  60      * @param string $context
  61      * @return AnnotationException
  62      */
  63     public static function semanticalErrorConstants($identifier, $context = null)
  64     {
  65         return self::semanticalError(sprintf(
  66             "Couldn't find constant %s%s", $identifier,
  67             $context ? ", $context." : "."
  68         ));
  69     }
  70
  71     /**
  72      * Creates a new AnnotationException describing an error which occurred during
  73      * the creation of the annotation.
  74      *
  75      * @since 2.2
  76      * @param string $message
  77      * @return AnnotationException
  78      */
  79     public static function creationError($message)
  80     {
  81         return new self('[Creation Error] ' . $message);
  82     }
  83
  84     /**
  85      * Creates a new AnnotationException describing an type error of an attribute.
  86      *
  87      * @since 2.2
  88      * @param string $attributeName
  89      * @param string $annotationName
  90      * @param string $context
  91      * @param string $expected
  92      * @param mixed $actual
  93      * @return AnnotationException
  94      */
  95     public static function typeError($attributeName, $annotationName, $context, $expected, $actual)
  96     {
  97         return new self(sprintf(
  98             '[Type Error] Attribute "%s" of @%s declared on %s expects %s, but got %s.',
  99             $attributeName,
 100             $annotationName,
 101             $context,
 102             $expected,
 103             is_object($actual) ? 'an instance of '.get_class($actual) : gettype($actual)
 104         ));
 105     }
 106
 107     /**
 108      * Creates a new AnnotationException describing an required error of an attribute.
 109      *
 110      * @since 2.2
 111      * @param string $attributeName
 112      * @param string $annotationName
 113      * @param string $context
 114      * @param string $expected
 115      * @return AnnotationException
 116      */
 117     public static function requiredError($attributeName, $annotationName, $context, $expected)
 118     {
 119         return new self(sprintf(
 120             '[Type Error] Attribute "%s" of @%s declared on %s expects %s. This value should not be null.',
 121             $attributeName,
 122             $annotationName,
 123             $context,
 124             $expected
 125         ));
 126     }
 127 }