MappingException.php 2.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586
  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.phpdoctrine.org>.
  18. */
  19. namespace Doctrine\Common\Persistence\Mapping;
  20. /**
  21. * A MappingException indicates that something is wrong with the mapping setup.
  22. *
  23. * @since 2.2
  24. */
  25. class MappingException extends \Exception
  26. {
  27. /**
  28. *
  29. * @param string $className
  30. * @param array $namespaces
  31. *
  32. * @return MappingException
  33. */
  34. public static function classNotFoundInNamespaces($className, $namespaces)
  35. {
  36. return new self("The class '" . $className . "' was not found in the ".
  37. "chain configured namespaces " . implode(", ", $namespaces));
  38. }
  39. /**
  40. * @return MappingException
  41. */
  42. public static function pathRequired()
  43. {
  44. return new self("Specifying the paths to your entities is required ".
  45. "in the AnnotationDriver to retrieve all class names.");
  46. }
  47. /**
  48. * @param string|null $path
  49. * @return MappingException
  50. */
  51. public static function fileMappingDriversRequireConfiguredDirectoryPath($path = null)
  52. {
  53. if ( ! empty($path)) {
  54. $path = '[' . $path . ']';
  55. }
  56. return new self(
  57. 'File mapping drivers must have a valid directory path, ' .
  58. 'however the given path ' . $path . ' seems to be incorrect!'
  59. );
  60. }
  61. /**
  62. * @param string $entityName
  63. * @param string $fileName
  64. * @return MappingException
  65. */
  66. public static function mappingFileNotFound($entityName, $fileName)
  67. {
  68. return new self("No mapping file found named '$fileName' for class '$entityName'.");
  69. }
  70. /**
  71. * @param string $entityName
  72. * @param string $fileName
  73. * @return MappingException
  74. */
  75. public static function invalidMappingFile($entityName, $fileName)
  76. {
  77. return new self("Invalid mapping file '$fileName' for class '$entityName'.");
  78. }
  79. }