phossa2/event

<?php
/**
 * Phossa Project
 *
 * PHP version 5.4
 *
 * @category  Library
 * @package   Phossa2\Event
 * @copyright Copyright (c) 2016 phossa.com
 * @license   http://mit-license.org/ MIT License
 * @link      http://www.phossa.com/
 */
/*# declare(strict_types=1); */

namespace Phossa2\Event\Interfaces;

use Phossa2\Shared\Shareable\ShareableInterface;

/**
 * SharedManagerInterface
 *
 * Support for shared event manager for different 'scope'. Default scope
 * is global which is ''. Common usage is to use class name or interface
 * name as scope.
 *
 * @package Phossa2\Event
 * @author  Hong Zhang <phossa@126.com>
 * @version 2.1.0
 * @since   2.0.0 added
 * @since   2.1.0 changed priority default value
 */
interface SharedManagerInterface extends ShareableInterface, EventManagerInterface
{
    /**
     * Bind a callable to event name in scope $scope
     *
     * ```php
     * eventDispatcher::onEvent(
     *     'Phossa2\\Mvc\\MvcInterface',
     *     'mvc.onRoute',
     *     function ($evt) {
     *         // ...
     *     }
     * );
     * ```
     *
     * @param  string|string[] $scope
     * @param  string $eventName
     * @param  callable $callable
     * @param  int $priority
     * @return bool true on success false on failure
     * @access public
     * @static
     * @api
     */
    public static function onEvent(
        $scope,
        /*# string */ $eventName,
        callable $callable,
        /*# int */ $priority = 0
    )/*# : bool */;

    /**
     * Unbind a callable from a specific eventName in $scope
     *
     * @param  string|string[] $scope
     * @param  string $eventName
     * @param  callable $callable
     * @return bool true on success false on failure
     * @access public
     * @static
     * @api
     */
    public static function offEvent(
        $scope,
        /*# string */ $eventName = '',
        callable $callable = null
    )/*# : bool */;

    /**
     * Bind a callable to event name in the global scope
     *
     * Alias of `::onEvent('', $eventName, $callable, $priority)`
     *
     * @param  string $eventName
     * @param  callable $callable
     * @param  int $priority
     * @return bool true on success false on failure
     * @access public
     * @static
     * @api
     */
    public static function onGlobalEvent(
        /*# string */ $eventName,
        callable $callable,
        /*# int */ $priority = 0
    )/*# : bool */;

    /**
     * Unbind a callable from a specific eventName in the global scope
     *
     * Alias of `::offEvent('', $eventName, $callable)`
     *
     * @param  string $eventName
     * @param  callable $callable
     * @return bool true on success false on failure
     * @access public
     * @static
     * @api
     */
    public static function offGlobalEvent(
        /*# string */ $eventName = '',
        callable $callable = null
    )/*# : bool */;
}