[ Index ]

PHP Cross Reference of phpBB-3.2.11-deutsch

title

Body

[close]

/vendor/zendframework/zend-eventmanager/src/ -> EventManagerInterface.php (summary)

Zend Framework (http://framework.zend.com/)

Copyright: Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
License: http://framework.zend.com/license/new-bsd New BSD License
File Size: 144 lines (4 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

EventManagerInterface:: (13 methods):
  trigger()
  triggerUntil()
  attach()
  detach()
  getEvents()
  getListeners()
  clearListeners()
  setEventClass()
  getIdentifiers()
  setIdentifiers()
  addIdentifiers()
  attachAggregate()
  detachAggregate()


Interface: EventManagerInterface  - X-Ref

Interface for messengers

trigger($event, $target = null, $argv = array()   X-Ref
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
- Passing event name, target, array|ArrayAccess of arguments, and callback

param: string|EventInterface $event
param: object|string $target
param: array|object $argv
param: null|callable $callback
return: ResponseCollection

triggerUntil($event, $target, $argv = null, $callback = null)   X-Ref
Trigger an event until the given callback returns a boolean true

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

param: string|EventInterface $event
param: object|string $target
param: array|object $argv
param: callable $callback
return: ResponseCollection

attach($event, $callback = null, $priority = 1)   X-Ref
Attach a listener to an event

param: string $event
param: callable $callback
param: int $priority Priority at which to register listener
return: CallbackHandler

detach($listener)   X-Ref
Detach an event listener

param: CallbackHandler|ListenerAggregateInterface $listener
return: bool

getEvents()   X-Ref
Get a list of events for which this collection has listeners

return: array

getListeners($event)   X-Ref
Retrieve a list of listeners registered to a given event

param: string $event
return: array|object

clearListeners($event)   X-Ref
Clear all listeners for a given event

param: string $event
return: void

setEventClass($class)   X-Ref
Set the event class to utilize

param: string $class
return: EventManagerInterface

getIdentifiers()   X-Ref
Get the identifier(s) for this EventManager

return: array

setIdentifiers($identifiers)   X-Ref
Set the identifiers (overrides any currently set identifiers)

param: string|int|array|Traversable $identifiers
return: EventManagerInterface

addIdentifiers($identifiers)   X-Ref
Add some identifier(s) (appends to any currently set identifiers)

param: string|int|array|Traversable $identifiers
return: EventManagerInterface

attachAggregate(ListenerAggregateInterface $aggregate, $priority = 1)   X-Ref
Attach a listener aggregate

param: ListenerAggregateInterface $aggregate
param: int $priority If provided, a suggested priority for the aggregate to use
return: mixed return value of {@link ListenerAggregateInterface::attach()}

detachAggregate(ListenerAggregateInterface $aggregate)   X-Ref
Detach a listener aggregate

param: ListenerAggregateInterface $aggregate
return: mixed return value of {@link ListenerAggregateInterface::detach()}



Generated: Wed Nov 11 20:33:01 2020 Cross-referenced by PHPXref 0.7.1