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\Persistence\Mapping;
Chris@0: 
Chris@0: /**
Chris@0:  * A MappingException indicates that something is wrong with the mapping setup.
Chris@0:  *
Chris@0:  * @since 2.2
Chris@0:  */
Chris@0: class MappingException extends \Exception
Chris@0: {
Chris@0:     /**
Chris@0:      * @param string $className
Chris@0:      * @param array  $namespaces
Chris@0:      *
Chris@0:      * @return self
Chris@0:      */
Chris@0:     public static function classNotFoundInNamespaces($className, $namespaces)
Chris@0:     {
Chris@0:         return new self("The class '" . $className . "' was not found in the ".
Chris@0:             "chain configured namespaces " . implode(", ", $namespaces));
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @return self
Chris@0:      */
Chris@0:     public static function pathRequired()
Chris@0:     {
Chris@0:         return new self("Specifying the paths to your entities is required ".
Chris@0:             "in the AnnotationDriver to retrieve all class names.");
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @param string|null $path
Chris@0:      *
Chris@0:      * @return self
Chris@0:      */
Chris@0:     public static function fileMappingDriversRequireConfiguredDirectoryPath($path = null)
Chris@0:     {
Chris@0:         if ( ! empty($path)) {
Chris@0:             $path = '[' . $path . ']';
Chris@0:         }
Chris@0: 
Chris@0:         return new self(
Chris@0:             'File mapping drivers must have a valid directory path, ' .
Chris@0:             'however the given path ' . $path . ' seems to be incorrect!'
Chris@0:         );
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @param string $entityName
Chris@0:      * @param string $fileName
Chris@0:      *
Chris@0:      * @return self
Chris@0:      */
Chris@0:     public static function mappingFileNotFound($entityName, $fileName)
Chris@0:     {
Chris@0:         return new self("No mapping file found named '$fileName' for class '$entityName'.");
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @param string $entityName
Chris@0:      * @param string $fileName
Chris@0:      *
Chris@0:      * @return self
Chris@0:      */
Chris@0:     public static function invalidMappingFile($entityName, $fileName)
Chris@0:     {
Chris@0:         return new self("Invalid mapping file '$fileName' for class '$entityName'.");
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * @param string $className
Chris@0:      *
Chris@0:      * @return self
Chris@0:      */
Chris@0:     public static function nonExistingClass($className)
Chris@0:     {
Chris@0:         return new self("Class '$className' does not exist");
Chris@0:     }
Chris@0: }