Phly_PubSub/library/Phly/PubSub/Exception.php
Phly_PubSub/library/Phly/PubSub/InvalidCallbackException.php
@@ -44,6 +44,9 @@ class Phly_PubSub_Handle
} else {
$this->_callback = array($context, $handler);
}
+ if (!is_callable($this->_callback)) {
+ throw new Phly_PubSub_InvalidCallbackException();
+ }
}
/**
@@ -70,10 +73,10 @@ class Phly_PubSub_Handle
* Invoke handler
*
* @param array $args Arguments to pass to callback
- * @return void
+ * @return mixed
*/
public function call(array $args)
{
- call_user_func_array($this->getCallback(), $args);
+ return call_user_func_array($this->getCallback(), $args);
}
}
Phly_PubSub/library/Phly/PubSub/Handle.php
@@ -29,19 +29,81 @@ class Phly_PubSub_Provider
* Publish to all handlers for a given topic
*
* @param string $topic
- * @param mixed $args All arguments besides the topic are passed as arguments to the handler
+ * @param mixed $argv All arguments besides the topic are passed as arguments to the handler
* @return void
*/
- public function publish($topic, $args = null)
+ public function publish($topic, $argv = null)
{
if (empty($this->_topics[$topic])) {
return;
}
- $args = func_get_args();
- array_shift($args);
+
+ $return = null;
+ $argv = func_get_args();
+ array_shift($argv);
+ foreach ($this->_topics[$topic] as $handle) {
+ $return = $handle->call($argv);
+ }
+ return $return;
+ }
+
+ /**
+ * Notify subscribers until return value of one causes a callback to
+ * evaluate to true
+ *
+ * Publishes subscribers until the provided callback evaluates the return
+ * value of one as true, or until all subscribers have been executed.
+ *
+ * @param Callable $callback
+ * @param string $topic
+ * @param mixed $argv All arguments besides the topic are passed as arguments to the handler
+ * @return mixed
+ * @throws Phly_PubSub_InvalidCallbackException if invalid callback provided
+ */
+ public function publishUntil($callback, $topic, $argv = null)
+ {
+ if (!is_callable($callback)) {
+ throw new Phly_PubSub_InvalidCallbackException('Invalid filter callback provided');
+ }
+
+ if (empty($this->_topics[$topic])) {
+ return;
+ }
+
+ $return = null;
+ $argv = func_get_args();
+ $argv = array_slice($argv, 2);
+ foreach ($this->_topics[$topic] as $handle) {
+ $return = $handle->call($argv);
+ if (call_user_func($callback, $return)) {
+ break;
+ }
+ }
+ return $return;
+ }
+
+ /**
+ * Filter a value
+ *
+ * Notifies subscribers to the topic and passes the single value provided
+ * as an argument. Each subsequent subscriber is passed the return value
+ * of the previous subscriber, and the value of the last subscriber is
+ * returned.
+ *
+ * @param string $topic
+ * @param mixed $value
+ * @return mixed
+ */
+ public function filter($topic, $value)
+ {
+ if (empty($this->_topics[$topic])) {
+ return;
+ }
+
foreach ($this->_topics[$topic] as $handle) {
- $handle->call($args);
+ $value = $handle->call(array($value));
}
+ return $value;
}
/**
Phly_PubSub/library/Phly/PubSub/Provider.php
@@ -49,20 +49,20 @@ class Phly_PubSub_HandleTest extends PHPUnit_Framework_TestCase
public function testGetTopicShouldReturnTopic()
{
- $handle = new Phly_PubSub_Handle('foo', 'bar');
+ $handle = new Phly_PubSub_Handle('foo', 'rand');
$this->assertEquals('foo', $handle->getTopic());
}
public function testCallbackShouldBeStringIfNoHandlerPassedToConstructor()
{
- $handle = new Phly_PubSub_Handle('foo', 'bar');
- $this->assertSame('bar', $handle->getCallback());
+ $handle = new Phly_PubSub_Handle('foo', 'rand');
+ $this->assertSame('rand', $handle->getCallback());
}
public function testCallbackShouldBeArrayIfHandlerPassedToConstructor()
{
- $handle = new Phly_PubSub_Handle('foo', 'bar', 'baz');
- $this->assertSame(array('bar', 'baz'), $handle->getCallback());
+ $handle = new Phly_PubSub_Handle('foo', 'Phly_PubSub_HandleTest_ObjectCallback', 'test');
+ $this->assertSame(array('Phly_PubSub_HandleTest_ObjectCallback', 'test'), $handle->getCallback());
}
public function testCallShouldInvokeCallbackWithSuppliedArguments()
@@ -73,12 +73,34 @@ class Phly_PubSub_HandleTest extends PHPUnit_Framework_TestCase
$this->assertSame($args, $this->args);
}
+ /**
+ * @expectedException Phly_PubSub_InvalidCallbackException
+ */
+ public function testPassingInvalidCallbackShouldRaiseInvalidCallbackException()
+ {
+ $handle = new Phly_PubSub_Handle('foo', 'boguscallback');
+ }
+
+ public function testCallShouldReturnTheReturnValueOfTheCallback()
+ {
+ $handle = new Phly_PubSub_Handle('foo', 'Phly_PubSub_HandleTest_ObjectCallback', 'test');
+ $this->assertEquals('bar', $handle->call(array()));
+ }
+
public function handleCall()
{
$this->args = func_get_args();
}
}
+class Phly_PubSub_HandleTest_ObjectCallback
+{
+ public static function test()
+ {
+ return 'bar';
+ }
+}
+
// Call Phly_PubSub_HandleTest::main() if this source file is executed directly.
if (PHPUnit_MAIN_METHOD == "Phly_PubSub_HandleTest::main") {
Phly_PubSub_HandleTest::main();
Phly_PubSub/tests/Phly/PubSub/HandleTest.php
@@ -114,10 +114,43 @@ class Phly_PubSub_ProviderTest extends PHPUnit_Framework_TestCase
$this->assertEquals('test message', $this->message);
}
+ public function testPublishShouldReturnTheReturnValueOfTheLastInvokedSubscriber()
+ {
+ $this->provider->subscribe('string.transform', 'trim');
+ $this->provider->subscribe('string.transform', 'str_rot13');
+ $value = $this->provider->publish('string.transform', ' foo ');
+ $this->assertEquals(str_rot13(' foo '), $value);
+ }
+
+ public function testPublishUntilShouldReturnAsSoonAsCallbackReturnsTrue()
+ {
+ $this->provider->subscribe('foo.bar', 'strpos');
+ $this->provider->subscribe('foo.bar', 'strstr');
+ $value = $this->provider->publishUntil(
+ array($this, 'evaluateStringCallback'),
+ 'foo.bar',
+ 'foo', 'f'
+ );
+ $this->assertSame(0, $value);
+ }
+
+ public function testFilterShouldPassReturnValueOfEachSubscriberToNextSubscriber()
+ {
+ $this->provider->subscribe('string.transform', 'trim');
+ $this->provider->subscribe('string.transform', 'str_rot13');
+ $value = $this->provider->filter('string.transform', ' foo ');
+ $this->assertEquals(str_rot13('foo'), $value);
+ }
+
public function handleTestTopic($message)
{
$this->message = $message;
}
+
+ public function evaluateStringCallback($value)
+ {
+ return (!$value);
+ }
}
// Call Phly_PubSub_ProviderTest::main() if this source file is executed directly.
Phly_PubSub/tests/Phly/PubSub/ProviderTest.php
f93f1d88dc29eeafbd8baa6987be85f0f43057e3
Matthew Weier O'Phinney
matthew@zend.com
http://github.com/weierophinney/phly/commit/165faf07eede9173448c95b7310862a19177766f
165faf07eede9173448c95b7310862a19177766f
2009-09-30T07:24:13-07:00
2009-09-30T07:24:13-07:00
New features:
- publish() now returns return value of last subscriber notified
- publishUntil($callback, $topic, ...) notifies subscribers until the callback
provided returns true. The return value of the last notified subscriber is
returned. (Idea borrowed from Symfony 2 event dispatcher.)
- filter($topic, $value) passes the value to subscribers. Each subscriber's
return value is then passed to the next subscriber, and the final return value
returned. (Idea borrowed from Symfony 2 event dispatcher.)
c3af0eaab07e5d77bd29a947df772eab2573b847
Matthew Weier O'Phinney
matthew@zend.com