The Handler Class
This class takes an object, a function, and a namespace. It uses these to encapsulate a callable that can be triggered. It's the action part of an event, when triggered it does something. It can be paired with a filter to enable proper hooks and such. Without a paired filter, (an object external to this class) it acts when notified by any event.
NOTE: The filter is separate from the handler so that one filter can be used for multiple handlers ala conduit.
IMPORTANT! - To pass a closure to handler pass it as the function parameter
CHANGELOG
1.0: Created Handler - August 16th, 2013 1.1: Updated getDestination to handle function names - October 7th, 2013 2.0: Integrated with Primus 2 in mind - October 13th, 2015 3.0: integrated observer trait decoupled from priority modified constructor to default arguments set funcitons now determine if exists on call reformatted for inclusion in phabstractic - July 29th, 2016
$observedSubjects : \Phabstractic\Patterns\Phabstractic\Patterns\Resource\PublisherInterface
The subjects that this observer is listening to
For an observer that listens to multiple publishers with some added functionality see Phabstractic\Event\Aggregator
detachPublisher(\Phabstractic\Patterns\Resource\PublisherInterface $publisher)
This detaches the observer from its subject
Reciprocal methods exist in the publisher
| \Phabstractic\Patterns\Resource\PublisherInterface | $publisher |
attachPublisher(\Phabstractic\Patterns\Resource\PublisherInterface $publisher)
Attach this observer to a new publisher
This also acts like a 'set' function, and null is an acceptable value to be passed
| \Phabstractic\Patterns\Resource\PublisherInterface | $publisher |
notifyObserver(\Phabstractic\Patterns\Resource\PublisherInterface $target, \Phabstractic\Patterns\Resource\StateInterface $state) : boolean
Notify the object of an event
This causes the object to 'fire' on any event passed to it.
Don't subclass this class to build a filter in this area, use a filter object instead. (See above)
| \Phabstractic\Patterns\Resource\PublisherInterface | $target | |
| \Phabstractic\Patterns\Resource\StateInterface | $state |
Return true if handled (instanceof AbstractEvent)
__construct(object $object = null, string $function = null, string $namespace = null)
The Handler Constructor
This takes a destination (presumably an object, where our code is going to GO [forward]), a function/method name and some options
| object | $object | The destination object |
| string | $function | The function/method name to be called |
| string | $namespace | The namespace definition of the destination |
handle(\Phabstractic\Event\Resource\AbstractEvent $e) : mixed
Handle the event
This method takes care of the details of getting an event ($e) to whatever needs to be called. The function/method/class is called passing the event along.
This works with instance methods, class methods (static), and normal defined functions, even closures, as long as they accept an AbstractEvent $e.
NOTE: To use a class method (static), $this->object must be a string
| \Phabstractic\Event\Resource\AbstractEvent | $e |
The result of the given function