phpDocumentor ZNF
Action
[ class tree: ZNF ] [ index: ZNF ] [ all elements ]
ZNF
Packages:
ZNF

Source for file Action.php

Documentation is available at Action.php

  1. <?php
  2. /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
  3. /**
  4.  * PHP version 5
  5.  *
  6.  * This source file is subject to version 2.1 of the GNU Lesser General Public
  7.  * License, that is bundled with this package in the file COPYING, available
  8.  * through the world wide web at the following URI:
  9.  * http://www.gnu.org/copyleft/lesser.html.
  10.  *
  11.  * @package    ZNF
  12.  * @subpackage Action
  13.  * @author     Alessandro Rossini <http://www.alessandrorossini.org>
  14.  * @author     Graziano Liberati <http://www.liberati.org>
  15.  * @copyright  2004-2007 The ZNF Development Team
  16.  * @license    LGPL License 2.1 <http://www.gnu.org/copyleft/lesser.html>
  17.  * @version    SVN $Id: Action.php 43 2007-06-26 23:36:35Z aronnax $
  18.  * @since      Release 0.5.0
  19.  * @link       http://www.zeronotice.org
  20.  */
  21.  
  22. /**
  23.  * <i>ZNF_Action_Action</i> is an adapter between the contents of an incoming HTTP request and the corresponding business logic.
  24.  *
  25.  * <i>ZNF_Action_Action</i> should be executed to process the request. The
  26.  * controller <i>ZNF_Action_RequestProcessor</i> selects an appropriate
  27.  * <i>ZNF_Action_Action</i> for each request, creates an instance and calls the
  28.  * <i>ZNF_Action_Action->execute()</i> method.
  29.  *
  30.  * When a <i>ZNF_Action_Action</i> is created the controller requires all the
  31.  * classes for the action requested. Subclasses must override the
  32.  * <i>ZNF_Action_Action->execute()</i> method to implement the dispatching
  33.  * mechanism for the action.
  34.  *
  35.  * @access     public
  36.  * @package    ZNF
  37.  * @subpackage Action
  38.  * @author     Alessandro Rossini <http://www.alessandrorossini.org>
  39.  * @author     Graziano Liberati <http://www.liberati.org>
  40.  * @copyright  2004-2007 The ZNF Development Team
  41.  * @license    LGPL License 2.1 <http://www.gnu.org/copyleft/lesser.html>
  42.  * @version    SVN $Id: Action.php 43 2007-06-26 23:36:35Z aronnax $
  43.  * @since      Release 0.5.0
  44.  * @link       http://www.zeronotice.org
  45.  */
  46. class ZNF_Action_Action
  47. {
  48.  
  49.     /**
  50.      * Constructs a new <i>ZNF_Action_Action</i> object.
  51.      *
  52.      * @access public
  53.      */
  54.     public function __construct()
  55.     {
  56.     }
  57.  
  58.     /**
  59.      * Code to execute the action, must be implemented by subclasses.
  60.      *
  61.      * By default this method returns <i>null</i>, so no error or warning are
  62.      * displayed if the subclass doesn't implement it.
  63.      *
  64.      * @access public
  65.      * @param ZNF_Action_ActionForm $form 
  66.      * @param ZNF_Action_ActionMapping $mapping 
  67.      * @return ZNF_Action_ActionForward 
  68.      */
  69.     public function execute($form, $mapping)
  70.     {
  71.         return null;
  72.     }
  73.  
  74.     /**
  75.      * Destroys the <i>ZNF_Action_Action</i> object.
  76.      *
  77.      * @access public
  78.      */
  79.     public function __destruct()
  80.     {
  81.     }
  82.  
  83. }
  84.  
  85. /**
  86.  * <i>ZNF_Action_ActionException</i> is the exception type for the <i>ZNF_Action_Action</i> class.
  87.  *
  88.  * <i>ZNF_Action_ActionException</i> extends the <i>Exception</i> class of PHP5.
  89.  *
  90.  * @access     public
  91.  * @package    ZNF
  92.  * @subpackage Action
  93.  * @author     Alessandro Rossini <http://www.alessandrorossini.org>
  94.  * @author     Graziano Liberati <http://www.liberati.org>
  95.  * @copyright  2004-2007 The ZNF Development Team
  96.  * @license    LGPL License 2.1 <http://www.gnu.org/copyleft/lesser.html>
  97.  * @version    SVN $Id: Action.php 43 2007-06-26 23:36:35Z aronnax $
  98.  * @since      Release 0.5.0
  99.  * @link       http://www.zeronotice.org
  100.  */
  101. class ZNF_Action_ActionException extends Exception
  102. {
  103. }
  104.  
  105. ?>
Documentation generated on Wed, 14 Nov 2007 23:47:32 +0100 by phpDocumentor 1.4.0