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

Source for file ActionMapping.php

Documentation is available at ActionMapping.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: ActionMapping.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_ActionMapping</i> represents the informations that the controller <i>ZNF_Action_RequestProcessor</i> knows about the mapping.
  24.  *
  25.  * The mapping is considered from a particular request to an instance of a
  26.  * particular <i>ZNF_Action_Action</i> class.
  27.  *
  28.  * The <i>ZNF_Action_ActionMapping</i> instance used to select a particular
  29.  * <i>ZNF_Action_Action</i> is passed on to that <i>ZNF_Action_Action</i>,
  30.  * thereby providing access to any custom configuration taken from the
  31.  * module configuration file and included in the <i>ZNF_Action_ActionMapping</i>
  32.  * object.
  33.  *
  34.  * @access     public
  35.  * @package    ZNF
  36.  * @subpackage Action
  37.  * @author     Alessandro Rossini <http://www.alessandrorossini.org>
  38.  * @author     Graziano Liberati <http://www.liberati.org>
  39.  * @copyright  2004-2007 The ZNF Development Team
  40.  * @license    LGPL License 2.1 <http://www.gnu.org/copyleft/lesser.html>
  41.  * @version    SVN $Id: ActionMapping.php 43 2007-06-26 23:36:35Z aronnax $
  42.  * @since      Release 0.5.0
  43.  * @link       http://www.zeronotice.org
  44.  */
  45. class ZNF_Action_ActionMapping
  46. {
  47.  
  48.     /**
  49.      * The <i>forward</i> attribute of the <i>action</i> element.
  50.      *
  51.      * @access protected
  52.      * @var string $_forward 
  53.      */
  54.     protected $_forward = null;
  55.  
  56.     /**
  57.      * The <i>include</i> attribute of the <i>action</i> element.
  58.      *
  59.      * @access protected
  60.      * @var string $_include 
  61.      */
  62.     protected $_include = null;
  63.  
  64.     /**
  65.      * The <i>input</i> attribute of the <i>action</i> element.
  66.      *
  67.      * @access protected
  68.      * @var string $_input 
  69.      */
  70.     protected $_input = null;
  71.  
  72.     /**
  73.      * The <i>name</i> attribute of the <i>action</i> element.
  74.      *
  75.      * @access protected
  76.      * @var string $_name 
  77.      */
  78.     protected $_name = null;
  79.  
  80.     /**
  81.      * The <i>nextPath</i> attribute of the <i>action</i> element.
  82.      *
  83.      * @access protected
  84.      * @var string $_nextPath 
  85.      */
  86.     protected $_nextPath = null;
  87.  
  88.     /**
  89.      * The <i>parameter</i> attribute of the <i>action</i> element.
  90.      *
  91.      * @access protected
  92.      * @var string $_parameter 
  93.      */
  94.     protected $_parameter = null;
  95.  
  96.     /**
  97.      * The <i>parameterValue</i> attribute of the <i>action</i> element.
  98.      *
  99.      * @access protected
  100.      * @var string $_parameterValue 
  101.      */
  102.     protected $_parameterValue = null;
  103.  
  104.     /**
  105.      * The <i>path</i> attribute of the <i>action</i> element.
  106.      *
  107.      * @access protected
  108.      * @var string $_path 
  109.      */
  110.     protected $_path = null;
  111.  
  112.     /**
  113.      * The <i>roles</i> attribute of the <i>action</i> element.
  114.      *
  115.      * @access protected
  116.      * @var string $_roles 
  117.      */
  118.     protected $_roles = null;
  119.  
  120.     /**
  121.      * The <i>scope</i> attribute of the <i>action</i> element.
  122.      *
  123.      * @access protected
  124.      * @var string $_scope 
  125.      */
  126.     protected $_scope = null;
  127.  
  128.     /**
  129.      * The <i>type</i> attribute of the <i>action</i> element.
  130.      *
  131.      * @access protected
  132.      * @var string $_type 
  133.      */
  134.     protected $_type = null;
  135.  
  136.     /**
  137.      * The <i>validate</i> attribute of the <i>action</i> element.
  138.      *
  139.      * @access protected
  140.      * @var string $_validate 
  141.      */
  142.     protected $_validate = null;
  143.  
  144.     /**
  145.      * The <i>forward</i> elements of the <i>global-forwards</i> element.
  146.      *
  147.      * @access protected
  148.      * @var array $_globalForwardsConfig 
  149.      */
  150.     protected $_globalForwardsConfig = null;
  151.  
  152.     /**
  153.      * The <i>forward</i> elements of the <i>action</i> element.
  154.      *
  155.      * @access protected
  156.      * @var array $_forwardsConfig 
  157.      */
  158.     protected $_forwardsConfig = null;
  159.  
  160.     /**
  161.      * Constructs a new <i>ZNF_Action_ActionMapping</i> object.
  162.      *
  163.      * @access public
  164.      * @param array $actionConfig 
  165.      * @param array $globalForwardsConfig 
  166.      */
  167.     public function __construct($actionConfig, $globalForwardsConfig)
  168.     {
  169.         $this->setForward($actionConfig['forward']);
  170.         $this->setInclude($actionConfig['include']);
  171.         $this->setInput($actionConfig['input']);
  172.         $this->setName($actionConfig['name']);
  173.         $this->setNextPath($actionConfig['nextPath']);
  174.         $this->setParameter($actionConfig['parameter']);
  175.         $this->setParameterValue($actionConfig['parameterValue']);
  176.         $this->setPath($actionConfig['path']);
  177.         $this->setRoles($actionConfig['roles']);
  178.         $this->setScope($actionConfig['scope']);
  179.         $this->setType($actionConfig['type']);
  180.         $this->setValidate($actionConfig['validate']);
  181.  
  182.         if (isset($actionConfig['forwards-config'])) {
  183.             $this->addForwardsConfig($actionConfig['forwards-config']);
  184.         }
  185.  
  186.         $this->addGlobalForwardsConfig($globalForwardsConfig);
  187.     }
  188.  
  189.     /**
  190.      * Returns the value of the <i>forward</i> property.
  191.      *
  192.      * @access public
  193.      * @return string 
  194.      */
  195.     public function getForward()
  196.     {
  197.         return $this->_forward;
  198.     }
  199.  
  200.     /**
  201.      * Sets the value of the <i>forward</i> property.
  202.      *
  203.      * @access public
  204.      * @param string $value 
  205.      */
  206.     public function setForward($value)
  207.     {
  208.         $this->_forward = $value;
  209.     }
  210.  
  211.     /**
  212.      * Returns the value of the <i>include</i> property.
  213.      *
  214.      * @access public
  215.      * @return string 
  216.      */
  217.     public function getInclude()
  218.     {
  219.         return $this->_include;
  220.     }
  221.  
  222.     /**
  223.      * Sets the value of the <i>include</i> property.
  224.      *
  225.      * @access public
  226.      * @param string $value 
  227.      */
  228.     public function setInclude($value)
  229.     {
  230.         $this->_include = $value;
  231.     }
  232.  
  233.     /**
  234.      * Returns the value of the <i>input</i> property.
  235.      *
  236.      * @access public
  237.      * @return string 
  238.      */
  239.     public function getInput()
  240.     {
  241.         return $this->_input;
  242.     }
  243.  
  244.     /**
  245.      * Sets the value of the <i>input</i> property.
  246.      *
  247.      * @access public
  248.      * @param string $value 
  249.      */
  250.     public function setInput($value)
  251.     {
  252.         $this->_input = $value;
  253.     }
  254.  
  255.     /**
  256.      * Returns the value of the <i>name</i> property.
  257.      *
  258.      * @access public
  259.      * @return string 
  260.      */
  261.     public function getName()
  262.     {
  263.         return $this->_name;
  264.     }
  265.  
  266.     /**
  267.      * Sets the value of the <i>name</i> property.
  268.      *
  269.      * @access public
  270.      * @param string $value 
  271.      */
  272.     public function setName($value)
  273.     {
  274.         $this->_name = $value;
  275.     }
  276.  
  277.     /**
  278.      * Returns the value of the <i>nextPath</i> property.
  279.      *
  280.      * @access public
  281.      * @return string 
  282.      */
  283.     public function getNextPath()
  284.     {
  285.         return $this->_nextPath;
  286.     }
  287.  
  288.     /**
  289.      * Sets the value of the <i>nextPath</i> property.
  290.      *
  291.      * @access public
  292.      * @param string $value 
  293.      */
  294.     public function setNextPath($value)
  295.     {
  296.         $this->_nextPath = $value;
  297.     }
  298.  
  299.     /**
  300.      * Returns the value of the <i>parameter</i> property.
  301.      *
  302.      * @access public
  303.      * @return string 
  304.      */
  305.     public function getParameter()
  306.     {
  307.         return $this->_parameter;
  308.     }
  309.  
  310.     /**
  311.      * Sets the value of the <i>parameter</i> property.
  312.      *
  313.      * @access public
  314.      * @param string $value 
  315.      */
  316.     public function setParameter($value)
  317.     {
  318.         $this->_parameter = $value;
  319.     }
  320.  
  321.     /**
  322.      * Returns the value of the <i>parameterValue</i> property.
  323.      *
  324.      * @access public
  325.      * @return string 
  326.      */
  327.     public function getParameterValue()
  328.     {
  329.         return $this->_parameterValue;
  330.     }
  331.  
  332.     /**
  333.      * Sets the value of the <i>parameterValue</i> property.
  334.      *
  335.      * @access public
  336.      * @param string $value 
  337.      */
  338.     public function setParameterValue($value)
  339.     {
  340.         $this->_parameterValue = $value;
  341.     }
  342.  
  343.     /**
  344.      * Returns the value of the <i>path</i> property.
  345.      *
  346.      * @access public
  347.      * @return string 
  348.      */
  349.     public function getPath()
  350.     {
  351.         return $this->_path;
  352.     }
  353.  
  354.     /**
  355.      * Sets the value of the <i>path</i> property.
  356.      *
  357.      * @access public
  358.      * @param string $value 
  359.      */
  360.     public function setPath($value)
  361.     {
  362.         $this->_path = $value;
  363.     }
  364.  
  365.     /**
  366.      * Returns the value of the <i>roles</i> property.
  367.      *
  368.      * @access public
  369.      * @return string 
  370.      */
  371.     public function getRoles()
  372.     {
  373.         return $this->_roles;
  374.     }
  375.  
  376.     /**
  377.      * Sets the value of the <i>roles</i> property.
  378.      *
  379.      * @access public
  380.      * @param string $value 
  381.      */
  382.     public function setRoles($value)
  383.     {
  384.         $this->_roles = $value;
  385.     }
  386.  
  387.     /**
  388.      * Returns the value of the <i>scope</i> property.
  389.      *
  390.      * @access public
  391.      * @return string 
  392.      */
  393.     public function getScope()
  394.     {
  395.         return $this->_scope;
  396.     }
  397.  
  398.     /**
  399.      * Sets the value of the <i>scope</i> property.
  400.      *
  401.      * @access public
  402.      * @param string $value 
  403.      */
  404.     public function setScope($value)
  405.     {
  406.         $this->_scope = $value;
  407.     }
  408.  
  409.     /**
  410.      * Returns the value of the <i>type</i> property.
  411.      *
  412.      * @access public
  413.      * @return string 
  414.      */
  415.     public function getType()
  416.     {
  417.         return $this->_type;
  418.     }
  419.  
  420.     /**
  421.      * Sets the value of the <i>type</i> property.
  422.      *
  423.      * @access public
  424.      * @param string $value 
  425.      */
  426.     public function setType($value)
  427.     {
  428.         $this->_type = $value;
  429.     }
  430.  
  431.     /**
  432.      * Returns the value of the <i>validate</i> property.
  433.      *
  434.      * @access public
  435.      * @return string 
  436.      */
  437.     public function getValidate()
  438.     {
  439.         return $this->_validate;
  440.     }
  441.  
  442.     /**
  443.      * Sets the value of the <i>validate</i> property.
  444.      *
  445.      * @access public
  446.      * @param string $value 
  447.      */
  448.     public function setValidate($value)
  449.     {
  450.         $this->_validate = $value;
  451.     }
  452.  
  453.     /**
  454.      * Adds the global forwards configuration.
  455.      *
  456.      * @access protected
  457.      * @param array $value 
  458.      */
  459.     protected function addGlobalForwardsConfig($value)
  460.     {
  461.         $this->_globalForwardsConfig = $value;
  462.     }
  463.  
  464.     /**
  465.      * Adds the forwards configuration.
  466.      *
  467.      * @access protected
  468.      * @param array $value 
  469.      */
  470.     protected function addForwardsConfig($value)
  471.     {
  472.         $this->_forwardsConfig = $value;
  473.     }
  474.  
  475.     /**
  476.      * Returns the <i>ZNF_Action_ActionForward</i> object defining how forwarding to the specified logical name should be handled.
  477.      *
  478.      * This is performed by checking the application configuration for the
  479.      * specified forwarding configuration. If no forwarding configuration can
  480.      * be found returns <i>null</i>.
  481.      *
  482.      * @access public
  483.      * @param string $name The result of the <i>ZNF_Action_Action->execute()</i> method
  484.      * @return ZNF_Action_ActionForward 
  485.      */
  486.     public function findForward($name)
  487.     {
  488.         if ($name && is_array($this->_forwardsConfig) && array_key_exists($name, $this->_forwardsConfig)) {
  489.             return new ZNF_Action_ActionForward($this->_forwardsConfig[$name]);
  490.         }
  491.  
  492.         if ($name && is_array($this->_globalForwardsConfig) && array_key_exists($name, $this->_globalForwardsConfig)) {
  493.             return new ZNF_Action_ActionForward($this->_globalForwardsConfig[$name]);
  494.         }
  495.  
  496.         return null;
  497.     }
  498.  
  499.     /**
  500.      * Destroys the <i>ZNF_Action_ActionMapping</i> object.
  501.      *
  502.      * @access public
  503.      */
  504.     public function __destruct()
  505.     {
  506.     }
  507.  
  508. }
  509.  
  510. /**
  511.  * <i>ZNF_Action_ActionMappingException</i> is the exception type for the <i>ZNF_Action_ActionMapping</i> class.
  512.  *
  513.  * <i>ZNF_Action_ActionMappingException</i> extends the <i>Exception</i> class of PHP5.
  514.  *
  515.  * @access     public
  516.  * @package    ZNF
  517.  * @subpackage Action
  518.  * @author     Alessandro Rossini <http://www.alessandrorossini.org>
  519.  * @author     Graziano Liberati <http://www.liberati.org>
  520.  * @copyright  2004-2007 The ZNF Development Team
  521.  * @license    LGPL License 2.1 <http://www.gnu.org/copyleft/lesser.html>
  522.  * @version    SVN $Id: ActionMapping.php 43 2007-06-26 23:36:35Z aronnax $
  523.  * @since      Release 0.5.0
  524.  * @link       http://www.zeronotice.org
  525.  */
  526. class ZNF_Action_ActionMappingException extends Exception
  527. {
  528. }
  529.  
  530. ?>
Documentation generated on Wed, 14 Nov 2007 23:47:34 +0100 by phpDocumentor 1.4.0