PHP Classes

File: src/webfan/hps/EmitterInterface.php

Recommend this page to a friend!
  Classes of Till Wehowski  >  Lazy PHP Event Handler  >  src/webfan/hps/EmitterInterface.php  >  Download  
File: src/webfan/hps/EmitterInterface.php
Role: Class source
Content type: text/plain
Description: Class source
Class: Lazy PHP Event Handler
Register event handlers to be loaded dynamically
Author: By
Last change:
Date: 7 months ago
Size: 2,736 bytes
 

Contents

Class file image Download
<?php
namespace webfan\hps;

interface
EmitterInterface
{
   
/**
     * Add a listener for an event.
     *
     * The first parameter should be the event name, and the second should be
     * the event listener. It may implement the League\Event\ListenerInterface
     * or simply be "callable".
     *
     * @param string $event
     * @param ListenerInterface|callable $listener
     *
     * @return $this
     */
   
public function addListener($event, $callback, $obj = null);

   
/**
     * Add a one time listener for an event.
     *
     * The first parameter should be the event name, and the second should be
     * the event listener. It may implement the League\Event\ListenerInterface
     * or simply be "callable".
     *
     * @param string $event
     * @param ListenerInterface|callable $listener
     *
     * @return $this
     */
  // public function addOneTimeListener($event, $listener);
    
public function once($event, $callback, $obj = null);
   
/**
     * Remove a specific listener for an event.
     *
     * The first parameter should be the event name, and the second should be
     * the event listener. It may implement the League\Event\ListenerInterface
     * or simply be "callable".
     *
     * @param string $event
     * @param ListenerInterface|callable $listener
     *
     * @return $this
     */
   
public function removeListener($event, $callback, $obj = null);

   
/**
     * Remove all listeners for an event.
     *
     * The first parameter should be the event name. All event listeners will
     * be removed.
     *
     * @param string $event
     *
     * @return $this
     */
   
public function removeAllListeners($event);

   
/**
     * Check weather an event has listeners.
     *
     * The first parameter should be the event name. We'll return true if the
     * event has one or more registered even listeners, and false otherwise.
     *
     * @param string $event
     *
     * @return bool
     */
   
public function hasListeners($event);

   
/**
     * Get all the listeners for an event.
     *
     * The first parameter should be the event name. We'll return an array of
     * all the registered even listeners, or an empty array if there are none.
     *
     * @param string $event
     *
     * @return array
     */
   
public function getListeners($event);

   
/**
     * Emit an event.
     *
     * @param string|AbstractEvent $event
     *
     * @return AbstractEvent
     */
   
public function emit($event, $data);

   
/**
     * Emit a batch of events.
     *
     * @param array $events
     *
     * @return array
     */
   // public function emitBatch(array $events);
}

For more information send a message to info at phpclasses dot org.