ForwardFW
[ class tree: ForwardFW ] [ index: ForwardFW ] [ all elements ]
Packages:
ForwardFW

Source for file Callback.php

Documentation is available at Callback.php

  1. <?php
  2. declare(encoding = "utf-8");
  3. /**
  4.  * This file is part of ForwardFW a web application framework.
  5.  *
  6.  * This library is free software; you can redistribute it and/or
  7.  * modify it under the terms of the GNU General Public
  8.  * License as published by the Free Software Foundation; either
  9.  * version 2.1 of the License, or (at your option) any later version.
  10.  *
  11.  * This library is distributed in the hope that it will be useful,
  12.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14.  * General Public License for more details.
  15.  *
  16.  * You should have received a copy of the GNU General Public
  17.  * License along with this library; if not, write to the Free Software
  18.  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19.  *
  20.  * PHP version 5
  21.  *
  22.  * @category   Cache
  23.  * @package    ForwardFW
  24.  * @subpackage Main
  25.  * @author     Alexander Opitz <opitz.alexander@primacom.net>
  26.  * @copyright  2009,2010 The Authors
  27.  * @license    http://www.gnu.org/copyleft/gpl.html GNU General Public License
  28.  * @version    SVN: $Id: $
  29.  * @link       http://forwardfw.sourceforge.net
  30.  * @since      File available since Release 0.0.8
  31.  */
  32.  
  33. require_once 'ForwardFW/Exception/Callback.php';
  34.  
  35. /**
  36.  * Config for a Cache.
  37.  *
  38.  * @category   Config
  39.  * @package    ForwardFW
  40.  * @subpackage Main
  41.  * @author     Alexander Opitz <opitz.alexander@primacom.net>
  42.  * @license    http://www.gnu.org/copyleft/gpl.html GNU General Public License
  43.  * @link       http://forwardfw.sourceforge.net
  44.  */
  45. class ForwardFW_Callback
  46. {
  47.     /**
  48.      * @var Callback The callback function configuration
  49.      */
  50.     public $callback = null;
  51.  
  52.     /**
  53.      * @var array Array with the parameters for function call.
  54.      */
  55.     public $arParameters = null;
  56.  
  57.     /**
  58.      * Constructor with validation of $callback
  59.      *
  60.      * @param Callback $callback     The callback function.
  61.      * @param array    $arParameters Parameters for function call.
  62.      *
  63.      * @return void 
  64.      * @throws ForwardFW_Exception_Callback
  65.      */
  66.     public function __construct($callback, array $arParameters = null)
  67.     {
  68.         if (is_callable($callback, true)) {
  69.             $this->callback = $callback;
  70.             $this->setParameters($arParameters);
  71.         } else {
  72.             throw new ForwardFW_Exception_Callback('This is no callback function');
  73.         }
  74.     }
  75.  
  76.     /**
  77.      * Sets the parameters array for callback.
  78.      *
  79.      * @param array $arParameters Parameters for function call.
  80.      *
  81.      * @return ForwrdFW_Callback 
  82.      */
  83.     public function setParameters(array $arParameters = null)
  84.     {
  85.         $this->arParameters = $arParameters;
  86.  
  87.         return $this;
  88.     }
  89.  
  90.  
  91.     /**
  92. /**
  93.      * Gets the parameters array for callback.
  94.      *
  95.      * @return array|nullThe parameters.
  96.      */
  97.     public function getParameters()
  98.     {
  99.         return $this->arParameters;
  100.     }
  101.  
  102.     /**
  103.      * Do the callback
  104.      *
  105.      * @return mixed Depends on function call.
  106.      */
  107.     public function doCallback()
  108.     {
  109.         if (is_null($this->arParameters)) {
  110.             return call_user_func($this->callback);
  111.         } else {
  112.             return call_user_func_array($this->callback, $this->arParameters);
  113.         }
  114.     }
  115. }
  116. ?>
Documentation generated on Sun, 30 Jan 2011 20:46:38 +0100 by phpDocumentor 1.4.3