vendor/doctrine/common/lib/Doctrine/Common/Persistence/Mapping/ReflectionService.php

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