File EventHookReflection.php | ICanBoogie/Event master

  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216

<?php

/*
 * This file is part of the ICanBoogie package.
 *
 * (c) Olivier Laviale <olivier.laviale@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace ICanBoogie;

use ICanBoogie\Accessor\AccessorTrait;

/**
 * Reflection of an event hook.
 *
 * @property \ReflectionFunction|\ReflectionMethod $reflection
 * @property string $type The event type resolved from the event hook parameters.
 */
class EventHookReflection
{
    use AccessorTrait;

    /**
     * @var EventHookReflection[]
     */
    static private $instances = [];

    /**
     * Creates instance from an event hook.
     *
     * @param callable $hook
     *
     * @return EventHookReflection
     *
     * @throws \InvalidArgumentException if `$hook` is not a valid event hook.
     */
    static public function from($hook)
    {
        self::assert_valid($hook);

        $key = self::make_key($hook);

        if (isset(self::$instances[$key]))
        {
            return self::$instances[$key];
        }

        return self::$instances[$key] = new self(self::resolve_reflection($hook));
    }

    /**
     * Makes key from event hook.
     *
     * @param callable $hook
     *
     * @return string
     */
    static private function make_key($hook)
    {
        if (is_array($hook))
        {
            return implode('#', $hook);
        }

        if ($hook instanceof \Closure)
        {
            $reflection = new \ReflectionFunction($hook);

            return $reflection->getFileName() . '#'. $reflection->getStartLine() . '#'. $reflection->getEndLine();
        }

        if (is_object($hook))
        {
            /* @var $hook object */

            return spl_object_hash($hook);
        }

        /* @var $hook string */

        return $hook;
    }

    /**
     * Asserts that the event hook is valid.
     *
     * @param callable $hook
     *
     * @throws \InvalidArgumentException if `$hook` is not a valid event hook.
     */
    static public function assert_valid($hook)
    {
        if (!is_callable($hook))
        {
            throw new \InvalidArgumentException(format
            (
                'The event hook must be a callable, %type given: :hook', [

                    'type' => gettype($hook),
                    'hook' => $hook

                ]
            ));
        }
    }

    /**
     * Asserts that the number of parameters is valid.
     *
     * @param \ReflectionParameter[] $parameters
     */
    static public function assert_valid_parameters_number(array $parameters)
    {
        $n = count($parameters);

        if ($n !== 2)
        {
            throw new \LogicException("Invalid number of parameters, expected 2 got $n.");
        }
    }

    /**
     * Resolves hook reflection.
     *
     * @param callable $hook
     *
     * @return \ReflectionFunction|\ReflectionMethod
     */
    static private function resolve_reflection($hook)
    {
        if (is_object($hook))
        {
            return new \ReflectionMethod($hook, '__invoke');
        }

        if (is_array($hook))
        {
            return new \ReflectionMethod($hook[0], $hook[1]);
        }

        if (is_string($hook) && strpos($hook, '::'))
        {
            list($class, $method) = explode('::', $hook);

            return new \ReflectionMethod($class, $method);
        }

        return new \ReflectionFunction($hook);
    }

    /**
     * Returns the class of a parameter reflection.
     *
     * Contrary of the {@link ReflectionParameter::getClass()} method, the class does not need to
     * be available to be successfully retrieved.
     *
     * @param \ReflectionParameter $param
     *
     * @return string|null
     */
    static private function resolve_parameter_class(\ReflectionParameter $param)
    {
        if (!preg_match('/([\w\\\]+)\s\$/', $param, $matches))
        {
            throw new \LogicException("The parameter `{$param->name}` is not typed.");
        }

        return $matches[1];
    }

    /**
     * Resolves event type from its class.
     *
     * @param string $class
     *
     * @return string
     */
    static private function resolve_type_from_class($class)
    {
        $base = basename('/' . strtr($class, '\\', '/'));

        $type = substr($base, 0, -5);
        $type = strpos($base, 'Before') === 0
            ? hyphenate(substr($type, 6)) . ':before'
            : hyphenate($type);

        return strtr($type, '-', '_');
    }

    private $reflection;

    /**
     * Returns the event type resolved from the event hook parameters.
     *
     * @return string
     */
    protected function get_type()
    {
        $parameters = $this->reflection->getParameters();

        self::assert_valid_parameters_number($parameters);

        list($event, $target) = $parameters;

        return self::resolve_parameter_class($target) . '::' . self::resolve_type_from_class(self::resolve_parameter_class($event));
    }

    private function __construct($reflection)
    {
        $this->reflection = $reflection;
    }
}

Namespaces

Classes

Functions