Merge pull request #30 from zf2timo/feature/dispatch-interface

Proposal: DispatcherInterface

src/Application.php

@@ -35,7 +35,7 @@ class Application
     protected $debug = false;
 
     /**
-     * @var Dispatcher
+     * @var DispatcherInterface
      */
     protected $dispatcher;
 
@@ -84,14 +84,14 @@ class Application
      * @param string $version Application version
      * @param array|Traversable $routes Routes/route specifications to use for the application
      * @param Console $console Console adapter to use within the application
-     * @param Dispatcher $dispatcher Configured dispatcher mapping routes to callables
+     * @param DispatcherInterface $dispatcher Configured dispatcher mapping routes to callables
      */
     public function __construct(
         $name,
         $version,
         $routes,
         Console $console = null,
-        Dispatcher $dispatcher = null
+        DispatcherInterface $dispatcher = null
     ) {
         if (! is_array($routes) && ! $routes instanceof Traversable) {
             throw new InvalidArgumentException('Routes must be provided as an array or Traversable object');
@@ -131,7 +131,7 @@ public function __construct(
     }
 
     /**
-     * @return Dispatcher
+     * @return DispatcherInterface
      */
     public function getDispatcher()
     {
@@ -465,9 +465,9 @@ public function isBannerDisabledForUserCommands()
      * Creates the route, and maps the command.
      *
      * @param RouteCollection $routeCollection
-     * @param Dispatcher $dispatcher
+     * @param DispatcherInterface $dispatcher
      */
-    protected function setupHelpCommand(RouteCollection $routeCollection, Dispatcher $dispatcher)
+    protected function setupHelpCommand(RouteCollection $routeCollection, DispatcherInterface $dispatcher)
     {
         $help = new HelpCommand($this);
         $routeCollection->addRouteSpec([
@@ -503,9 +503,9 @@ protected function setupHelpCommand(RouteCollection $routeCollection, Dispatcher
      * Creates the route, and maps the command.
      *
      * @param RouteCollection $routeCollection
-     * @param Dispatcher $dispatcher
+     * @param DispatcherInterface $dispatcher
      */
-    protected function setupVersionCommand(RouteCollection $routeCollection, Dispatcher $dispatcher)
+    protected function setupVersionCommand(RouteCollection $routeCollection, DispatcherInterface $dispatcher)
     {
         $routeCollection->addRouteSpec([
             'name' => 'version',
@@ -531,9 +531,9 @@ protected function setupVersionCommand(RouteCollection $routeCollection, Dispatc
      * Creates the route, and maps the command.
      *
      * @param RouteCollection $routeCollection
-     * @param Dispatcher $dispatcher
+     * @param DispatcherInterface $dispatcher
      */
-    protected function setupAutocompleteCommand(RouteCollection $routeCollection, Dispatcher $dispatcher)
+    protected function setupAutocompleteCommand(RouteCollection $routeCollection, DispatcherInterface $dispatcher)
     {
         $routeCollection->addRouteSpec([
                 'name' => 'autocomplete',

src/Dispatcher.php

@@ -12,7 +12,7 @@
 use Zend\Console\Adapter\AdapterInterface as ConsoleAdapter;
 use Zend\Console\ColorInterface as Color;
 
-class Dispatcher
+class Dispatcher implements DispatcherInterface
 {
     protected $commandMap = [];
 

src/DispatcherInterface.php

@@ -0,0 +1,24 @@
+<?php
+/**
+ * @license   http://opensource.org/licenses/BSD-3-Clause BSD-3-Clause
+ * @copyright Copyright (c) 2014 Zend Technologies USA Inc. (http://www.zend.com)
+ */
+
+namespace ZF\Console;
+
+use Zend\Console\Adapter\AdapterInterface as ConsoleAdapter;
+
+interface DispatcherInterface
+{
+    public function map($command, $callable);
+
+    /**
+     * Does the dispatcher have a handler for the given command?
+     *
+     * @param string $command
+     * @return bool
+     */
+    public function has($command);
+
+    public function dispatch(Route $route, ConsoleAdapter $console);
+}