Author: jpic
Date: Tue Feb 19 13:33:59 2008
New Revision: 7413

Log:
- Added methods definitions for interfaces.

Modified:
    experimental/MvcTools/design/design.txt

Modified: experimental/MvcTools/design/design.txt
==============================================================================
--- experimental/MvcTools/design/design.txt [iso-8859-1] (original)
+++ experimental/MvcTools/design/design.txt [iso-8859-1] Tue Feb 19 13:33:59 
2008
@@ -73,6 +73,13 @@
 The ezcMvcRequestParser interface has to be implemented by classes that will
 parse a request and create an ezcMvcInput object.
 
+Methods::
+
+  /**
+   * Parses the request and creates an input object.
+   */
+  ezcMvcInput public function createInput()
+
 ezcMvcInput
 -----------
 
@@ -89,7 +96,6 @@
 This object encapsulates the result of a controller, abstracting from the
 actual response protocol. The output object will be modelled similar to the
 input variant, described above.
-
 
 ezcMvcRouter
 ------------
@@ -100,6 +106,26 @@
 implementation of ezcMvcViewManager, instantiate it and submit the collected
 responses to be handled by it.
 
+Methods::
+
+  /**
+   * Instanciate a router, parses input and selects the controllers and
+   * view-manager.
+   */
+  ezcMvcRouter public function __construct( $input )
+
+  /**
+   * Returns the list of controllers.
+   *
+   * @see Encapsulate controller multiplicity ?
+   */
+  ? public function getControllers()
+
+  /**
+   * Returns the view-manager.
+   */
+  ezcMvcViewManager public function getViewManager()
+
 ezcMvcViewManager
 -----------------
 
@@ -107,6 +133,32 @@
 coordinating the rendering of ezcMvcOutput instances into a format acceptable
 for the response protocol. The rendering itself is done by instances of
 ezcViewHandler.
+
+Methods::
+
+  /**
+   * This method should use the list of controllers, run it, select the view
+   * handlers and send the response to the client.
+   *
+   * @param $controllers array|object Array of controllers or an object
+   *                                  wrapping them ?
+   * @see Encapsulate controller multiplicity ?
+   */
+  void public function handle( ? $controllers )
+
+  /**
+   * Create and return the response string.
+   *
+   * Returns a string or an ezcMvcResponseBody ?
+   */
+  ? public function createResponseBody( ? $controllers )
+
+  /**
+   * Create and return the response header variables.
+   *
+   * Return an array of key=>values or an ezcMvcResponseHeaders ?
+   */
+  ? public function createResponseHeader( ? $controllers )
 
 ezcMvcViewHandler
 -----------------
@@ -117,6 +169,22 @@
 different view handlers and to merge their output to a consistent response
 string.
 
+Methods::
+
+  /**
+   * Create and return the response string.
+   *
+   * Returns a string or an ezcMvcResponseBody ?
+   */
+  ? public function createResponseBody( ? $controllers )
+
+  /**
+   * Create and return the response header variables.
+   *
+   * Return an array of key=>values or an ezcMvcResponseHeaders ?
+   */
+  ? public function createResponseHeader( ? $controllers )
+
 ezcMvcController
 ----------------
 
@@ -151,7 +219,7 @@
     $parser = new ezcMvcUrlUserInputRequestParser();
 
     // The parser returns an instance of ezcMvcInput.
-    $input  = $parser->getInput();
+    $input  = $parser->createInput();
 
     // ezcMvcUrlUserInputRouter implements ezcMvcRouter
        $router = new ezcMvcUrlUserInputRouter( $input );


-- 
svn-components mailing list
svn-components@lists.ez.no
http://lists.ez.no/mailman/listinfo/svn-components

Reply via email to