EventManager/EventDescription.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_EventDescription
    jump to top

    Package: Zend\EventManager

    Representation of an event

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

    Methods

    methodpublicgetName() : string

    Get event name

    Returns
    Type Description
    string
    methodpublicgetParam(string $name, mixed $default = null) : mixed

    Get a single parameter by name

    Parameters
    Name Type Description
    $name string
    $default mixed

    Default value to return if parameter does not exist
    Returns
    Type Description
    mixed
    methodpublicgetParams() : array | \ArrayAccess

    Get parameters passed to the event

    Returns
    Type Description
    array | \ArrayAccess
    methodpublicgetTarget() : null | string | object

    Get target/context from which event was triggered

    Returns
    Type Description
    null | string | object
    methodpublicpropagationIsStopped() : bool

    Has this event indicated event propagation should stop?

    Returns
    Type Description
    bool
    methodpublicsetName(string $name) : void

    Set the event name

    Parameters
    Name Type Description
    $name string
    methodpublicsetParam(string $name, mixed $value) : void

    Set a single parameter by key

    Parameters
    Name Type Description
    $name string
    $value mixed
    methodpublicsetParams(string $params) : void

    Set event parameters

    Parameters
    Name Type Description
    $params string
    methodpublicsetTarget(null | string | object $target) : void

    Set the event target/context

    Parameters
    Name Type Description
    $target null | string | object
    methodpublicstopPropagation(bool $flag = true) : void

    Indicate whether or not the parent EventCollection should stop propagating events

    Parameters
    Name Type Description
    $flag bool
    Documentation was generated by phpDocumentor 2.0.0a8.