Chris@13: <?php
Chris@13: 
Chris@13: /*
Chris@13:  * This file is part of Psy Shell.
Chris@13:  *
Chris@13:  * (c) 2012-2018 Justin Hileman
Chris@13:  *
Chris@13:  * For the full copyright and license information, please view the LICENSE
Chris@13:  * file that was distributed with this source code.
Chris@13:  */
Chris@13: 
Chris@13: namespace Psy\Util;
Chris@13: 
Chris@13: use Psy\Exception\RuntimeException;
Chris@16: use Psy\Reflection\ReflectionClassConstant;
Chris@16: use Psy\Reflection\ReflectionConstant_;
Chris@13: 
Chris@13: /**
Chris@13:  * A utility class for getting Reflectors.
Chris@13:  */
Chris@13: class Mirror
Chris@13: {
Chris@13:     const CONSTANT        = 1;
Chris@13:     const METHOD          = 2;
Chris@13:     const STATIC_PROPERTY = 4;
Chris@13:     const PROPERTY        = 8;
Chris@13: 
Chris@13:     /**
Chris@13:      * Get a Reflector for a function, class or instance, constant, method or property.
Chris@13:      *
Chris@13:      * Optionally, pass a $filter param to restrict the types of members checked. For example, to only Reflectors for
Chris@13:      * static properties and constants, pass:
Chris@13:      *
Chris@13:      *    $filter = Mirror::CONSTANT | Mirror::STATIC_PROPERTY
Chris@13:      *
Chris@13:      * @throws \Psy\Exception\RuntimeException when a $member specified but not present on $value
Chris@13:      * @throws \InvalidArgumentException       if $value is something other than an object or class/function name
Chris@13:      *
Chris@13:      * @param mixed  $value  Class or function name, or variable instance
Chris@13:      * @param string $member Optional: property, constant or method name (default: null)
Chris@13:      * @param int    $filter (default: CONSTANT | METHOD | PROPERTY | STATIC_PROPERTY)
Chris@13:      *
Chris@13:      * @return \Reflector
Chris@13:      */
Chris@13:     public static function get($value, $member = null, $filter = 15)
Chris@13:     {
Chris@17:         if ($member === null && \is_string($value)) {
Chris@17:             if (\function_exists($value)) {
Chris@16:                 return new \ReflectionFunction($value);
Chris@17:             } elseif (\defined($value) || ReflectionConstant_::isMagicConstant($value)) {
Chris@16:                 return new ReflectionConstant_($value);
Chris@16:             }
Chris@13:         }
Chris@13: 
Chris@13:         $class = self::getClass($value);
Chris@13: 
Chris@13:         if ($member === null) {
Chris@13:             return $class;
Chris@13:         } elseif ($filter & self::CONSTANT && $class->hasConstant($member)) {
Chris@16:             return ReflectionClassConstant::create($value, $member);
Chris@13:         } elseif ($filter & self::METHOD && $class->hasMethod($member)) {
Chris@13:             return $class->getMethod($member);
Chris@13:         } elseif ($filter & self::PROPERTY && $class->hasProperty($member)) {
Chris@13:             return $class->getProperty($member);
Chris@13:         } elseif ($filter & self::STATIC_PROPERTY && $class->hasProperty($member) && $class->getProperty($member)->isStatic()) {
Chris@13:             return $class->getProperty($member);
Chris@13:         } else {
Chris@17:             throw new RuntimeException(\sprintf(
Chris@13:                 'Unknown member %s on class %s',
Chris@13:                 $member,
Chris@17:                 \is_object($value) ? \get_class($value) : $value
Chris@13:             ));
Chris@13:         }
Chris@13:     }
Chris@13: 
Chris@13:     /**
Chris@13:      * Get a ReflectionClass (or ReflectionObject) if possible.
Chris@13:      *
Chris@13:      * @throws \InvalidArgumentException if $value is not a class name or instance
Chris@13:      *
Chris@13:      * @param mixed $value
Chris@13:      *
Chris@13:      * @return \ReflectionClass
Chris@13:      */
Chris@13:     private static function getClass($value)
Chris@13:     {
Chris@17:         if (\is_object($value)) {
Chris@13:             return new \ReflectionObject($value);
Chris@13:         }
Chris@13: 
Chris@17:         if (!\is_string($value)) {
Chris@13:             throw new \InvalidArgumentException('Mirror expects an object or class');
Chris@17:         } elseif (!\class_exists($value) && !\interface_exists($value) && !\trait_exists($value)) {
Chris@13:             throw new \InvalidArgumentException('Unknown class or function: ' . $value);
Chris@13:         }
Chris@13: 
Chris@13:         return new \ReflectionClass($value);
Chris@13:     }
Chris@13: }