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

Source for file DispatchAction.php

Documentation is available at DispatchAction.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 Actions
  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: DispatchAction.php 43 2007-06-26 23:36:35Z aronnax $
  18.  * @since      Release 0.7.0
  19.  * @link       http://www.zeronotice.org
  20.  */
  21.  
  22. /**
  23.  * <i>ZNF_Actions_DispatchAction</i> is an abstract <i>ZNF_Action_Action</i> that dispatches to a public method that is named by the request parameter whose name is specified by the <i>parameter</i> property of the corresponding <i>ZNF_Action_ActionMapping</i>.
  24.  *
  25.  * This <i>action</i> is useful for developers who prefer to combine many
  26.  * similar actions into a single <i>ZNF_Actions_DispatchAction</i> class, in
  27.  * order to simplify their application design.
  28.  *
  29.  * There are several way the configure this action in your module configuration
  30.  * file.
  31.  *
  32.  * - Usage of the <i>parameter</i> attribute
  33.  *
  34.  * <i>
  35.  *   &lt;action path="customAction"
  36.  *     type="Package_Action_CustomDispatchAction"
  37.  *     parameter="method@location"/&gt;
  38.  * </i>
  39.  *
  40.  * This action will use the value of the request parameter named <i>method</i>
  41.  * to pick the appropriate <i>execute</i> method, which must have the same
  42.  * signature (other than method name) of the standard
  43.  * <i>ZNF_Actions_DispatchAction->execute()</i> method. For example, you might
  44.  * have the following three methods in the same action class:
  45.  * <ul>
  46.  *   <li>public function create($form, $mapping)</li>
  47.  *   <li>public function update($form, $mapping)</li>
  48.  *   <li>public function delete($form, $mapping)</li>
  49.  * </ul>
  50.  * And call one of them with a URL like this:
  51.  * <i>
  52.  *   http://&lt;yourhost&gt;/&lT;yourapp&gt;/znf/action?method=update
  53.  * </i>
  54.  *
  55.  * The second part of the parameter attribute (@location) is optional and it is
  56.  * used to specify where to find the requested parameter, possible values are:
  57.  * 'GET', 'POST', 'REQUEST' and 'SESSION'.
  58.  * Considering the example above it should be replaced by 'GET', anyway if not
  59.  * specified it will be assumed the 'GET' value anyway.
  60.  *
  61.  * - Usage of the <i>parameterValue</i> attribute
  62.  *
  63.  * <i>
  64.  *   &lt;action path="customAction"
  65.  *     type="Package_Action_CustomDispatchAction"
  66.  *     parameterValue="update"/&gt;
  67.  * </i>
  68.  *
  69.  * The <i>parameterValue</i> attribute is used to specify directly the name of
  70.  * the method that it will be called, considering the configuration above it
  71.  * will becalled the <i>update</i> method of the
  72.  * <i>ZNF_Actions_CustomDispatchAction</i> class.
  73.  *
  74.  * <p><strong>NOTE</strong> - <i>parameter</i> and <i>parameterValues</i>
  75.  * attribute are exclusive and if any of them is specified or the result value
  76.  * is <i>empty</i> or <i>execute</i>, a method named <i>unspecified</i> is called.
  77.  * The default action is to throw an exception. You can override the
  78.  * <i>unspecified</i> method in your subclass.
  79.  *
  80.  * @access     public
  81.  * @package    ZNF
  82.  * @subpackage Actions
  83.  * @author     Alessandro Rossini <http://www.alessandrorossini.org>
  84.  * @author     Graziano Liberati <http://www.liberati.org>
  85.  * @copyright  2004-2007 The ZNF Development Team
  86.  * @license    LGPL License 2.1 <http://www.gnu.org/copyleft/lesser.html>
  87.  * @version    SVN $Id: DispatchAction.php 43 2007-06-26 23:36:35Z aronnax $
  88.  * @since      Release 0.7.0
  89.  * @link       http://www.zeronotice.org
  90.  */
  91. abstract class ZNF_Actions_DispatchAction
  92. {
  93.  
  94.     /**
  95.      * Constructs a new <i>ZNF_Actions_DispatchAction</i> object.
  96.      *
  97.      * @access public
  98.      */
  99.     public function __construct()
  100.     {
  101.     }
  102.  
  103.     /**
  104.      * Code to check and execute the action, subclasses must implement the method requested.
  105.      *
  106.      * If the method required is not implemented by the subclass the
  107.      * <i>unspecified</i> method is called.
  108.      *
  109.      * @access public
  110.      * @param ZNF_Action_ActionForm $form 
  111.      * @param ZNF_Action_ActionMapping $mapping 
  112.      * @return ZNF_Action_ActionForward 
  113.      */
  114.     public function execute($form, $mapping)
  115.     {
  116.         $method = false;
  117.  
  118.         $parameterValue = $mapping->getParameterValue();
  119.  
  120.         if (!$parameterValue) {
  121.             $parameter = $mapping->getParameter();
  122.  
  123.             $location = '';
  124.  
  125.             if (ereg('@', $parameter)) {
  126.                 $parameterArray = explode('@', $parameter);
  127.                 $parameter = $parameterArray[0];
  128.                 $location = $parameterArray[1];
  129.             }
  130.  
  131.             switch ($location) {
  132.                 case 'GET':
  133.                     if (isset($_GET[$parameter])) {
  134.                         $method = $_GET[$parameter];
  135.                     }
  136.                 break;
  137.  
  138.                 case 'POST':
  139.                     if (isset($_POST[$parameter])) {
  140.                         $method = $_POST[$parameter];
  141.                     }
  142.                 break;
  143.  
  144.                 case 'REQUEST':
  145.                     if (isset($_REQUEST[$parameter])) {
  146.                         $method = $_REQUEST[$parameter];
  147.                     }
  148.                 break;
  149.  
  150.                 case 'SESSION':
  151.                     if (isset($_SESSION[$parameter])) {
  152.                         $method = $_SESSION[$parameter];
  153.                     }
  154.                 break;
  155.  
  156.                 default:
  157.                     if (isset($_GET[$parameter])) {
  158.                         $method = $_GET[$parameter];
  159.                     }
  160.                 break;
  161.             }
  162.         } else {
  163.             $method = $parameterValue;
  164.         }
  165.  
  166.         if (!$method || $method == "execute" || !method_exists($this, $method)) {
  167.             return $this->unspecified($form, $mapping);
  168.         }
  169.  
  170.         return $this->$method($form, $mapping);
  171.     }
  172.  
  173.     /**
  174.      * Default method to execute if the requested method is not found or the <i>parameter</i> attibute in the configuration file is not specified.
  175.      *
  176.      * Subclasses can override this method to customize the error.
  177.      *
  178.      * @access public
  179.      * @param ZNF_Action_ActionForm $form 
  180.      * @param ZNF_Action_ActionMapping $mapping 
  181.      */
  182.     public function unspecified($form, $mapping)
  183.     {
  184.         $translation = new ZNF_Presentation_Translation('ZNF', $_SESSION['znf']['lang']);
  185.         throw new ZNF_Actions_DispatchActionException($translation->get('errorMethodNotValid'));
  186.     }
  187.  
  188.     /**
  189.      * Destroys the <i>ZNF_Actions_DispatchAction</i> object.
  190.      *
  191.      * @access public
  192.      */
  193.     public function __destruct()
  194.     {
  195.     }
  196.  
  197. }
  198.  
  199. /**
  200.  * <i>ZNF_Actions_DispatchActionException</i> is the exception type for the <i>ZNF_Actions_DispatchAction</i> class.
  201.  *
  202.  * <i>ZNF_Actions_DispatchActionException</i> extends the <i>Exception</i> class of PHP5.
  203.  *
  204.  * @access     public
  205.  * @package    ZNF
  206.  * @subpackage Actions
  207.  * @author     Alessandro Rossini <http://www.alessandrorossini.org>
  208.  * @author     Graziano Liberati <http://www.liberati.org>
  209.  * @copyright  2004-2007 The ZNF Development Team
  210.  * @license    LGPL License 2.1 <http://www.gnu.org/copyleft/lesser.html>
  211.  * @version    SVN $Id: DispatchAction.php 43 2007-06-26 23:36:35Z aronnax $
  212.  * @since      Release 0.7.0
  213.  * @link       http://www.zeronotice.org
  214.  */
  215. class ZNF_Actions_DispatchActionException extends Exception
  216. {
  217. }
  218.  
  219. ?>
Documentation generated on Wed, 14 Nov 2007 23:47:36 +0100 by phpDocumentor 1.4.0