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

Source for file ActionErrors.php

Documentation is available at ActionErrors.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: ActionErrors.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_ActionErrors</i> class encapsulates the error messages being reported by the <i>ZNF_Action_ActionForm->validate()</i> method.
  24.  *
  25.  * Each individual error is described by a key and a relative message.
  26.  *
  27.  * @access     public
  28.  * @package    ZNF
  29.  * @subpackage Action
  30.  * @author     Alessandro Rossini <http://www.alessandrorossini.org>
  31.  * @author     Graziano Liberati <http://www.liberati.org>
  32.  * @copyright  2004-2007 The ZNF Development Team
  33.  * @license    LGPL License 2.1 <http://www.gnu.org/copyleft/lesser.html>
  34.  * @version    SVN $Id: ActionErrors.php 43 2007-06-26 23:36:35Z aronnax $
  35.  * @since      Release 0.5.0
  36.  * @link       http://www.zeronotice.org
  37.  */
  38. class ZNF_Action_ActionErrors
  39. {
  40.  
  41.     /**
  42.      * Array where the set of errors are stored.
  43.      *
  44.      * @access protected
  45.      * @var array $_errors 
  46.      */
  47.     protected $_errors = array();
  48.  
  49.     /**
  50.      * Constructs a new <i>ZNF_Action_ActionErrors</i> object.
  51.      *
  52.      * @access public
  53.      */
  54.     public function __construct()
  55.     {
  56.     }
  57.  
  58.     /**
  59.      * Adds an error message to the set of errors.
  60.      *
  61.      * @access public
  62.      * @param int $key 
  63.      * @param string $value 
  64.      */
  65.     public function addError($key, $value)
  66.     {
  67.         if ($key) {
  68.             $this->_errors[$key] = $value;
  69.         }
  70.     }
  71.  
  72.     /**
  73.      * Returns the set of errors.
  74.      *
  75.      * @access public
  76.      * @return array 
  77.      */
  78.     public function getErrors()
  79.     {
  80.         return $this->_errors;
  81.     }
  82.  
  83.     /**
  84.      * Returns number of errors.
  85.      *
  86.      * @access public
  87.      * @return int 
  88.      */
  89.     public function getNumErrors()
  90.     {
  91.         return count($this->_errors);
  92.     }
  93.  
  94.     /**
  95.      * Returns an error by the key.
  96.      *
  97.      * @access public
  98.      * @param int $key 
  99.      * @return string 
  100.      */
  101.     public function findError($key)
  102.     {
  103.         if (array_key_exists($key, $this->_errors)) {
  104.             return $this->_errors[$key];
  105.         } else {
  106.             return null;
  107.         }
  108.     }
  109.  
  110.     /**
  111.      * Destroys the <i>ZNF_Action_ActionErrors</i> object.
  112.      *
  113.      * @access public
  114.      */
  115.     public function __destruct()
  116.     {
  117.     }
  118.  
  119. }
  120.  
  121. /**
  122.  * <i>ZNF_Action_ActionErrorsException</i> is the exception type for the <i>ZNF_Action_ActionErrors</i> class.
  123.  *
  124.  * <i>ZNF_Action_ActionErrorsException</i> extends the <i>Exception</i> class of PHP5.
  125.  *
  126.  * @access     public
  127.  * @package    ZNF
  128.  * @subpackage Action
  129.  * @author     Alessandro Rossini <http://www.alessandrorossini.org>
  130.  * @author     Graziano Liberati <http://www.liberati.org>
  131.  * @copyright  2004-2007 The ZNF Development Team
  132.  * @license    LGPL License 2.1 <http://www.gnu.org/copyleft/lesser.html>
  133.  * @version    SVN $Id: ActionErrors.php 43 2007-06-26 23:36:35Z aronnax $
  134.  * @since      Release 0.5.0
  135.  * @link       http://www.zeronotice.org
  136.  */
  137. class ZNF_Action_ActionErrorsException extends Exception
  138. {
  139. }
  140.  
  141. ?>
Documentation generated on Wed, 14 Nov 2007 23:47:33 +0100 by phpDocumentor 1.4.0