<?php
/**
* CallableFunction.php - Jaxon user function plugin
*
* This class registers user defined functions, generates client side javascript code,
* and calls them on user request
*
* @package jaxon-core
* @author Jared White
* @author J. Max Wilson
* @author Joseph Woolley
* @author Steffen Konerow
* @author Thierry Feuzeu <[email protected]>
* @copyright Copyright (c) 2005-2007 by Jared White & J. Max Wilson
* @copyright Copyright (c) 2008-2010 by Joseph Woolley, Steffen Konerow, Jared White & J. Max Wilson
* @copyright 2016 Thierry Feuzeu <[email protected]>
* @license https://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License
* @link https://github.com/jaxon-php/jaxon-core
*/
namespace Jaxon\Request\Plugin;
use Jaxon\Jaxon;
use Jaxon\Plugin\Request as RequestPlugin;
use Jaxon\Request\Target;
class CallableFunction extends RequestPlugin
{
use \Jaxon\Features\Validator;
use \Jaxon\Features\Translator;
/**
* The registered user functions names
*
* @var array
*/
protected $aFunctions = [];
/**
* The name of the function that is being requested (during the request processing phase)
*
* @var string
*/
protected $sRequestedFunction = null;
/**
* The constructor
*/
public function __construct()
{
if(isset($_GET['jxnfun']))
{
$this->sRequestedFunction = $_GET['jxnfun'];
}
if(isset($_POST['jxnfun']))
{
$this->sRequestedFunction = $_POST['jxnfun'];
}
}
/**
* @inheritDoc
*/
public function getName()
{
return Jaxon::CALLABLE_FUNCTION;
}
/**
* @inheritDoc
*/
public function getTarget()
{
if(!$this->sRequestedFunction)
{
return null;
}
return Target::makeFunction($this->sRequestedFunction);
}
/**
* Register a user defined function
*
* @param string $sType The type of request handler being registered
* @param string $sCallableFunction The name of the function being registered
* @param array|string $aOptions The associated options
*
* @return boolean
*/
public function register($sType, $sCallableFunction, $aOptions)
{
$sType = trim($sType);
if($sType != $this->getName())
{
return false;
}
if(!is_string($sCallableFunction))
{
throw new \Jaxon\Exception\Error($this->trans('errors.functions.invalid-declaration'));
}
if(is_string($aOptions))
{
$aOptions = ['include' => $aOptions];
}
if(!is_array($aOptions))
{
throw new \Jaxon\Exception\Error($this->trans('errors.functions.invalid-declaration'));
}
$sCallableFunction = trim($sCallableFunction);
// Check if an alias is defined
$sFunctionName = $sCallableFunction;
foreach($aOptions as $sName => $sValue)
{
if($sName == 'alias')
{
$sFunctionName = $sValue;
break;
}
}
$this->aFunctions[$sFunctionName] = $aOptions;
jaxon()->di()->set($sFunctionName, function() use ($sFunctionName, $sCallableFunction) {
$xCallableFunction = new \Jaxon\Request\Support\CallableFunction($sCallableFunction);
$aOptions = $this->aFunctions[$sFunctionName];
foreach($aOptions as $sName => $sValue)
{
$xCallableFunction->configure($sName, $sValue);
}
return $xCallableFunction;
});
return true;
}
/**
* @inheritDoc
*/
public function getHash()
{
return md5(implode('', array_keys($this->aFunctions)));
}
/**
* @inheritDoc
*/
public function getScript()
{
$di = jaxon()->di();
$code = '';
foreach(array_keys($this->aFunctions) as $sName)
{
$xFunction = $di->get($sName);
$code .= $xFunction->getScript();
}
return $code;
}
/**
* @inheritDoc
*/
public function canProcessRequest()
{
// Check the validity of the function name
if(($this->sRequestedFunction) && !$this->validateFunction($this->sRequestedFunction))
{
$this->sRequestedFunction = null;
}
return ($this->sRequestedFunction != null);
}
/**
* @inheritDoc
*/
public function processRequest()
{
if(!$this->canProcessRequest())
{
return false;
}
// Security check: make sure the requested function was registered.
if(!key_exists($this->sRequestedFunction, $this->aFunctions))
{
// Unable to find the requested function
throw new \Jaxon\Exception\Error($this->trans('errors.functions.invalid',
['name' => $this->sRequestedFunction]));
}
$di = jaxon()->di();
$xFunction = $di->get($this->sRequestedFunction);
$aArgs = $di->getRequestHandler()->processArguments();
$xResponse = $xFunction->call($aArgs);
if(($xResponse))
{
$di->getResponseManager()->append($xResponse);
}
return true;
}
}
|
Download
