ReflectionService.php 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687
  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. namespace Doctrine\Common\Persistence\Mapping;
  20. /**
  21. * Very simple reflection service abstraction.
  22. *
  23. * This is required inside metadata layers that may require either
  24. * static or runtime reflection.
  25. *
  26. * @author Benjamin Eberlei <kontakt@beberlei.de>
  27. */
  28. interface ReflectionService
  29. {
  30. /**
  31. * Returns an array of the parent classes (not interfaces) for the given class.
  32. *
  33. * @param string $class
  34. *
  35. * @throws \Doctrine\Common\Persistence\Mapping\MappingException
  36. *
  37. * @return array
  38. */
  39. public function getParentClasses($class);
  40. /**
  41. * Returns the shortname of a class.
  42. *
  43. * @param string $class
  44. *
  45. * @return string
  46. */
  47. public function getClassShortName($class);
  48. /**
  49. * @param string $class
  50. *
  51. * @return string
  52. */
  53. public function getClassNamespace($class);
  54. /**
  55. * Returns a reflection class instance or null.
  56. *
  57. * @param string $class
  58. *
  59. * @return \ReflectionClass|null
  60. */
  61. public function getClass($class);
  62. /**
  63. * Returns an accessible property (setAccessible(true)) or null.
  64. *
  65. * @param string $class
  66. * @param string $property
  67. *
  68. * @return \ReflectionProperty|null
  69. */
  70. public function getAccessibleProperty($class, $property);
  71. /**
  72. * Checks if the class have a public method with the given name.
  73. *
  74. * @param mixed $class
  75. * @param mixed $method
  76. *
  77. * @return bool
  78. */
  79. public function hasPublicMethod($class, $method);
  80. }