The Actor Class
This class combines the functionality of a filter with a handler.
The object is presented with various events using notify, but only events that meet the criteria of the filter actually make the handler fire
CHANGELOG
1.0 Created Actor - August 16th, 2013 2.0 Integrated Primus 2 Changed Handler to ObserverInterface - October 14th, 2015 3.0: included set methods removed subject from constructor eliminated destructor reformatted for inclusion in phabstarctic - July 30th, 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 $subject, \Phabstractic\Patterns\Resource\StateInterface $state) : false
Send the object and originator to the observer
Run it past the filter and if we meet success, then fire off the handler
| \Phabstractic\Patterns\Resource\PublisherInterface | $subject | |
| \Phabstractic\Patterns\Resource\StateInterface | $state |
if state doesn't cause a notification
setFilter(\Phabstractic\Event\Resource\FilterInterface $filter)
Set the actor's filter object
| \Phabstractic\Event\Resource\FilterInterface | $filter |
setHandler(\Phabstractic\Event\Handler $handler)
Retrieve the actor's handler
| \Phabstractic\Event\Handler | $handler |
__construct(\Phabstractic\Event\Phabstractic\Event\Filter $filter = null, \Phabstractic\Event\Phabstractic\Event\Handler $handler = null)
The Actor Class Constructor
The actor class IS an observer, so we make sure we got that covered
This is where the filter and handler are generally set
| \Phabstractic\Event\Phabstractic\Event\Filter | $filter | The filter to employ |
| \Phabstractic\Event\Phabstractic\Event\Handler | $handler | The handler to employ |