www.aleph1.co.uk Git - yaffs-website/blob - 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      * Returns an array of the parent classes (not interfaces) for the given class.
  34      *
  35      * @param string $class
  36      *
  37      * @throws \Doctrine\Common\Persistence\Mapping\MappingException
  38      *
  39      * @return array
  40      */
  41     public function getParentClasses($class);
  42
  43     /**
  44      * Returns the shortname of a class.
  45      *
  46      * @param string $class
  47      *
  48      * @return string
  49      */
  50     public function getClassShortName($class);
  51
  52     /**
  53      * @param string $class
  54      *
  55      * @return string
  56      */
  57     public function getClassNamespace($class);
  58
  59     /**
  60      * Returns a reflection class instance or null.
  61      *
  62      * @param string $class
  63      *
  64      * @return \ReflectionClass|null
  65      */
  66     public function getClass($class);
  67
  68     /**
  69      * Returns an accessible property (setAccessible(true)) or null.
  70      *
  71      * @param string $class
  72      * @param string $property
  73      *
  74      * @return \ReflectionProperty|null
  75      */
  76     public function getAccessibleProperty($class, $property);
  77
  78     /**
  79      * Checks if the class have a public method with the given name.
  80      *
  81      * @param mixed $class
  82      * @param mixed $method
  83      *
  84      * @return bool
  85      */
  86     public function hasPublicMethod($class, $method);
  87 }