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

Source for file ActionForward.php

Documentation is available at ActionForward.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: ActionForward.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_ActionForward</i> represents the destination to which the controller <i>ZNF_Action_RequestProcessor</i> might be directed.
  24.  *
  25.  * The redirect is a result of processing activities of a
  26.  * <i>ZNF_Action_Action</i> class.
  27.  *
  28.  * @access     public
  29.  * @package    ZNF
  30.  * @subpackage Action
  31.  * @author     Alessandro Rossini <http://www.alessandrorossini.org>
  32.  * @author     Graziano Liberati <http://www.liberati.org>
  33.  * @copyright  2004-2007 The ZNF Development Team
  34.  * @license    LGPL License 2.1 <http://www.gnu.org/copyleft/lesser.html>
  35.  * @version    SVN $Id: ActionForward.php 43 2007-06-26 23:36:35Z aronnax $
  36.  * @since      Release 0.5.0
  37.  * @link       http://www.zeronotice.org
  38.  */
  39. class ZNF_Action_ActionForward
  40. {
  41.  
  42.     /**
  43.      * The <i>name</i> attribute of the <i>forward</i> element.
  44.      *
  45.      * @access protected
  46.      * @var string $_name 
  47.      */
  48.     protected $_name = null;
  49.  
  50.     /**
  51.      * The <i>path</i> attribute of the <i>forward</i> element.
  52.      *
  53.      * @access protected
  54.      * @var string $_path 
  55.      */
  56.     protected $_path = null;
  57.  
  58.     /**
  59.      * The <i>redirect</i> attribute of the <i>forward</i> element.
  60.      *
  61.      * @access protected
  62.      * @var boolean $_redirect 
  63.      */
  64.     protected $_redirect = false;
  65.  
  66.     /**
  67.      * Construct a new <i>ZNF_Action_ActionForward</i> object.
  68.      *
  69.      * @access public
  70.      * @param array $forward 
  71.      */
  72.     public function __construct($forward)
  73.     {
  74.         $this->setName($forward['name']);
  75.         $this->setPath($forward['path']);
  76.         $this->setRedirect($forward['redirect']);
  77.     }
  78.  
  79.     /**
  80.      * Returns the value of the <i>name</i> property.
  81.      *
  82.      * @access public
  83.      * @return string 
  84.      */
  85.     public function getName()
  86.     {
  87.         return $this->_name;
  88.     }
  89.  
  90.     /**
  91.      * Sets the value of the <i>name</i> property.
  92.      *
  93.      * @access public
  94.      * @param string $value 
  95.      */
  96.     public function setName($value)
  97.     {
  98.         $this->_name = $value;
  99.     }
  100.  
  101.     /**
  102.      * Returns the value of the <i>path</i> property.
  103.      *
  104.      * @access public
  105.      * @return string 
  106.      */
  107.     public function getPath()
  108.     {
  109.         return $this->_path;
  110.     }
  111.  
  112.     /**
  113.      * Sets the value of the <i>path</i> property.
  114.      *
  115.      * @access public
  116.      * @param string $value 
  117.      */
  118.     public function setPath($value)
  119.     {
  120.         $this->_path = $value;
  121.     }
  122.  
  123.     /**
  124.      * Returns the value of the <i>redirect</i> property.
  125.      *
  126.      * @access public
  127.      * @return boolean 
  128.      */
  129.     public function getRedirect()
  130.     {
  131.         return $this->_redirect;
  132.     }
  133.  
  134.     /**
  135.      * Sets the value of the <i>redirect</i> property.
  136.      *
  137.      * @access public
  138.      * @param boolean $value 
  139.      */
  140.     public function setRedirect($value)
  141.     {
  142.         $this->_redirect = $value;
  143.     }
  144.  
  145.     /**
  146.      * Destroys the <i>ZNF_Action_ActionForward</i> object.
  147.      *
  148.      * @access public
  149.      */
  150.     public function __destruct()
  151.     {
  152.     }
  153.  
  154. }
  155.  
  156. /**
  157.  * <i>ZNF_Action_ActionForwardException</i> is the exception type for the <i>ZNF_Action_ActionForward</i> class.
  158.  *
  159.  * <i>ZNF_Action_ActionForwardException</i> extends the <i>Exception</i> class of PHP5.
  160.  *
  161.  * @access     public
  162.  * @package    ZNF
  163.  * @subpackage Action
  164.  * @author     Alessandro Rossini <http://www.alessandrorossini.org>
  165.  * @author     Graziano Liberati <http://www.liberati.org>
  166.  * @copyright  2004-2007 The ZNF Development Team
  167.  * @license    LGPL License 2.1 <http://www.gnu.org/copyleft/lesser.html>
  168.  * @version    SVN $Id: ActionForward.php 43 2007-06-26 23:36:35Z aronnax $
  169.  * @since      Release 0.5.0
  170.  * @link       http://www.zeronotice.org
  171.  */
  172. class ZNF_Action_ActionForwardException extends Exception
  173. {
  174. }
  175.  
  176. ?>
Documentation generated on Wed, 14 Nov 2007 23:47:33 +0100 by phpDocumentor 1.4.0