Chris@0: <?php
Chris@0: /*
Chris@0:  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
Chris@0:  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
Chris@0:  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
Chris@0:  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
Chris@0:  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
Chris@0:  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
Chris@0:  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
Chris@0:  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
Chris@0:  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
Chris@0:  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Chris@0:  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Chris@0:  *
Chris@0:  * This software consists of voluntary contributions made by many individuals
Chris@0:  * and is licensed under the MIT license. For more information, see
Chris@0:  * <http://www.doctrine-project.org>.
Chris@0:  */
Chris@0: 
Chris@0: namespace Doctrine\Common\Annotations;
Chris@0: 
Chris@0: /**
Chris@0:  * Description of AnnotationException
Chris@0:  *
Chris@0:  * @since  2.0
Chris@0:  * @author Benjamin Eberlei <kontakt@beberlei.de>
Chris@0:  * @author Guilherme Blanco <guilhermeblanco@hotmail.com>
Chris@0:  * @author Jonathan Wage <jonwage@gmail.com>
Chris@0:  * @author Roman Borschel <roman@code-factory.org>
Chris@0:  */
Chris@0: class AnnotationException extends \Exception
Chris@0: {
Chris@0:     /**
Chris@0:      * Creates a new AnnotationException describing a Syntax error.
Chris@0:      *
Chris@0:      * @param string $message Exception message
Chris@0:      *
Chris@0:      * @return AnnotationException
Chris@0:      */
Chris@0:     public static function syntaxError($message)
Chris@0:     {
Chris@0:         return new self('[Syntax Error] ' . $message);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Creates a new AnnotationException describing a Semantical error.
Chris@0:      *
Chris@0:      * @param string $message Exception message
Chris@0:      *
Chris@0:      * @return AnnotationException
Chris@0:      */
Chris@0:     public static function semanticalError($message)
Chris@0:     {
Chris@0:         return new self('[Semantical Error] ' . $message);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Creates a new AnnotationException describing an error which occurred during
Chris@0:      * the creation of the annotation.
Chris@0:      *
Chris@0:      * @since 2.2
Chris@0:      *
Chris@0:      * @param string $message
Chris@0:      *
Chris@0:      * @return AnnotationException
Chris@0:      */
Chris@0:     public static function creationError($message)
Chris@0:     {
Chris@0:         return new self('[Creation Error] ' . $message);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Creates a new AnnotationException describing a type error.
Chris@0:      *
Chris@0:      * @since 1.1
Chris@0:      *
Chris@0:      * @param string $message
Chris@0:      *
Chris@0:      * @return AnnotationException
Chris@0:      */
Chris@0:     public static function typeError($message)
Chris@0:     {
Chris@0:         return new self('[Type Error] ' . $message);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Creates a new AnnotationException describing a constant semantical error.
Chris@0:      *
Chris@0:      * @since 2.3
Chris@0:      *
Chris@0:      * @param string $identifier
Chris@0:      * @param string $context
Chris@0:      *
Chris@0:      * @return AnnotationException
Chris@0:      */
Chris@0:     public static function semanticalErrorConstants($identifier, $context = null)
Chris@0:     {
Chris@0:         return self::semanticalError(sprintf(
Chris@0:             "Couldn't find constant %s%s.",
Chris@0:             $identifier,
Chris@0:             $context ? ', ' . $context : ''
Chris@0:         ));
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Creates a new AnnotationException describing an type error of an attribute.
Chris@0:      *
Chris@0:      * @since 2.2
Chris@0:      *
Chris@0:      * @param string $attributeName
Chris@0:      * @param string $annotationName
Chris@0:      * @param string $context
Chris@0:      * @param string $expected
Chris@0:      * @param mixed  $actual
Chris@0:      *
Chris@0:      * @return AnnotationException
Chris@0:      */
Chris@0:     public static function attributeTypeError($attributeName, $annotationName, $context, $expected, $actual)
Chris@0:     {
Chris@0:         return self::typeError(sprintf(
Chris@0:             'Attribute "%s" of @%s declared on %s expects %s, but got %s.',
Chris@0:             $attributeName,
Chris@0:             $annotationName,
Chris@0:             $context,
Chris@0:             $expected,
Chris@0:             is_object($actual) ? 'an instance of ' . get_class($actual) : gettype($actual)
Chris@0:         ));
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Creates a new AnnotationException describing an required error of an attribute.
Chris@0:      *
Chris@0:      * @since 2.2
Chris@0:      *
Chris@0:      * @param string $attributeName
Chris@0:      * @param string $annotationName
Chris@0:      * @param string $context
Chris@0:      * @param string $expected
Chris@0:      *
Chris@0:      * @return AnnotationException
Chris@0:      */
Chris@0:     public static function requiredError($attributeName, $annotationName, $context, $expected)
Chris@0:     {
Chris@0:         return self::typeError(sprintf(
Chris@0:             'Attribute "%s" of @%s declared on %s expects %s. This value should not be null.',
Chris@0:             $attributeName,
Chris@0:             $annotationName,
Chris@0:             $context,
Chris@0:             $expected
Chris@0:         ));
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Creates a new AnnotationException describing a invalid enummerator.
Chris@0:      *
Chris@0:      * @since 2.4
Chris@0:      *
Chris@0:      * @param string $attributeName
Chris@0:      * @param string $annotationName
Chris@0:      * @param string $context
Chris@0:      * @param array  $available
Chris@0:      * @param mixed  $given
Chris@0:      *
Chris@0:      * @return AnnotationException
Chris@0:      */
Chris@0:     public static function enumeratorError($attributeName, $annotationName, $context, $available, $given)
Chris@0:     {
Chris@0:         return new self(sprintf(
Chris@0:             '[Enum Error] Attribute "%s" of @%s declared on %s accept only [%s], but got %s.',
Chris@0:             $attributeName, 
Chris@0:             $annotationName,
Chris@0:             $context,
Chris@0:             implode(', ', $available),
Chris@0:             is_object($given) ? get_class($given) : $given
Chris@0:         ));
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @return AnnotationException
Chris@0:      */
Chris@0:     public static function optimizerPlusSaveComments()
Chris@0:     {
Chris@0:         return new self(
Chris@0:             "You have to enable opcache.save_comments=1 or zend_optimizerplus.save_comments=1."
Chris@0:         );
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @return AnnotationException
Chris@0:      */
Chris@0:     public static function optimizerPlusLoadComments()
Chris@0:     {
Chris@0:         return new self(
Chris@0:             "You have to enable opcache.load_comments=1 or zend_optimizerplus.load_comments=1."
Chris@0:         );
Chris@0:     }
Chris@0: }