Reader.php 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  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\Annotations;
  20. /**
  21. * Interface for annotation readers.
  22. *
  23. * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  24. */
  25. interface Reader
  26. {
  27. /**
  28. * @param \ReflectionClass $class
  29. * @return mixed
  30. */
  31. function getClassAnnotations(\ReflectionClass $class);
  32. /**
  33. * @param \ReflectionClass $class
  34. * @param string $annotationName
  35. * @return mixed
  36. */
  37. function getClassAnnotation(\ReflectionClass $class, $annotationName);
  38. /**
  39. * @param \ReflectionMethod $method
  40. * @return mixed
  41. */
  42. function getMethodAnnotations(\ReflectionMethod $method);
  43. /**
  44. * @param \ReflectionMethod $method
  45. * @param string $annotationName
  46. * @return mixed
  47. */
  48. function getMethodAnnotation(\ReflectionMethod $method, $annotationName);
  49. /**
  50. * @param \ReflectionProperty $property
  51. * @return mixed
  52. */
  53. function getPropertyAnnotations(\ReflectionProperty $property);
  54. /**
  55. * @param \ReflectionProperty $property
  56. * @param string $annotationName
  57. * @return mixed
  58. */
  59. function getPropertyAnnotation(\ReflectionProperty $property, $annotationName);
  60. }