EventManager/EventCollection.php

Show: inherited
    Table of Contents

    Zend Framework

    LICENSE

    This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to [email protected] so we can send you a copy immediately.

    Category
    Zend  
    Copyright
    Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
    License
    New BSD License  
    Package
    Zend_EventManager  

    \Zend_EventManager_EventCollection
    jump to top

    Package: Zend\EventManager

    Interface for messengers

    Category
    Zend  
    Copyright
    Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
    License
    New BSD License  

    Methods

    methodpublicattach(string $event, callback $callback = null, int $priority = 1) : \Zend_Stdlib_CallbackHandler

    Attach a listener to an event

    Parameters
    Name Type Description
    $event string
    $callback callback
    $priority int

    Priority at which to register listener
    Returns
    Type Description
    \Zend_Stdlib_CallbackHandler
    methodpublicclearListeners(string $event) : void

    Clear all listeners for a given event

    Parameters
    Name Type Description
    $event string
    methodpublicdetach(\Zend_Stdlib_CallbackHandler | \Zend_EventManager_ListenerAggregate $listener) : void

    Detach an event listener

    Parameters
    Name Type Description
    $listener \Zend_Stdlib_CallbackHandler | \Zend_EventManager_ListenerAggregate
    methodpublicgetEvents() : array

    Get a list of events for which this collection has listeners

    Returns
    Type Description
    array
    methodpublicgetListeners(string $event) : array | object

    Retrieve a list of listeners registered to a given event

    Parameters
    Name Type Description
    $event string
    Returns
    Type Description
    array | object
    methodpublictrigger(string $event, object | string $target = null, array | object $argv = array(), null | callback $callback = null) : \Zend_EventManager_ResponseCollection

    Trigger an event

    Should allow handling the following scenarios: - Passing Event object only - Passing event name and Event object only - Passing event name, target, and Event object - Passing event name, target, and array|ArrayAccess of arguments

    Can emulate triggerUntil() if the last argument provided is a callback.

    Parameters
    Name Type Description
    $event string
    $target object | string
    $argv array | object
    $callback null | callback
    Returns
    Type Description
    \Zend_EventManager_ResponseCollection
    methodpublictriggerUntil(string $event, object | string $target, array | object $argv = null, callback $callback = null) : \Zend_EventManager_ResponseCollection

    Trigger an event until the given callback returns a boolean false

    Should allow handling the following scenarios: - Passing Event object and callback only - Passing event name, Event object, and callback only - Passing event name, target, Event object, and callback - Passing event name, target, array|ArrayAccess of arguments, and callback

    Parameters
    Name Type Description
    $event string
    $target object | string
    $argv array | object
    $callback callback
    Returns
    Type Description
    \Zend_EventManager_ResponseCollection
    Documentation was generated by phpDocumentor 2.0.0a8.