ICanBoogie/Event master
  • Namespace
  • Class

Namespaces

  • ICanBoogie

Classes

  • Event
  • EventCollection
  • EventCollectionProvider
  • EventHook
  • EventHookReflection
  • EventProfiler
  • EventReflection

Functions

  • get_events
 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 
<?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;

/**
 * Provides an {@link EventCollection} instance.
 */
class EventCollectionProvider
{
    /**
     * @var callable {@link EventCollection} provider
     */
    static private $provider;

    /**
     * Alias for {@link define()}
     *
     * @deprecated
     */
    static public function using(callable $provider)
    {
        return self::define($provider);
    }

    /**
     * Defines the {@link EventCollection} provider.
     *
     * @param callable $provider
     *
     * @return callable The previous provider, or `null` if none was defined.
     */
    static public function define(callable $provider)
    {
        $previous = self::$provider;

        self::$provider = $provider;

        return $previous;
    }

    /**
     * Returns the current provider.
     *
     * @return callable|null
     */
    static public function defined()
    {
        return self::$provider;
    }

    /**
     * Undefine the provider.
     */
    static public function undefine()
    {
        self::$provider = null;
    }

    /**
     * Returns a {@link EventCollection} instance using the provider.
     *
     * @return EventCollection
     */
    static public function provide()
    {
        $provider = self::$provider;

        if (!$provider)
        {
            throw new \LogicException("No provider is defined yet. Please define one with `EventCollectionProvider::define(\$provider)`.");
        }

        return $provider();
    }

    /**
     * Alias for {@link undefine()}.
     *
     * @deprecated
     */
    static public function clear()
    {
        self::undefine();
    }
}
ICanBoogie/Event master API documentation generated by ApiGen