File Source for OCSP_AJAX_FUNCTION.phpclass

<?php
/**
* Class file OCSP_AJAX_FUNCTION.phpclass
*
* @project Open CSP-Management
* @package cms
* @category chapter
*
* @author Peter Krebs (pk) <p.krebs@amicas.at>
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
*
* @since pk-07-02-21
*
***/
/**
* requirements ---------------------------------------------------------
*/
require_once __OCSP_PHPINCPATH__."common/pcf_directory.phpinc";
require_once dirname(__FILE__)._OCSP_DIRSEP_."OCSP_AJAX.phpclass";
/**
* Class OCSP_AJAX_FUNCTION
*
* this class is designed to handle ajex functions
*
* @project Open CSP-Management
* @package cms
* @category chapter
*
* @author Peter Krebs (pk) <p.krebs@amicas.at>
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
*
* @since pk-07-02-21
*
***/
class OCSP_AJAX_FUNCTION {
/** Aggregations: */
/**
* @var OCSP_AJAX myAjaxObj
* @access protected
***/
protected $myAjaxObj=NULL;
/** Compositions: */
/** Attributes: **/
/**
* @var string $myFuncName
* @access protected
*/
protected $myFuncName=NULL;
/**
* @var string $myFuncInc
* @access protected
*/
protected $myFuncInc=NULL;
/**
* @var string $myRQMethod
* @access protected
*/
protected $myRQMethod=NULL;
/**
* @var array $myFuncArgs
* @access protected
*/
protected $myFuncArgs=array();
/**
* @var string $myFuncInc
* @access protected
*/
protected $myTargetId=NULL;
/**
* @var string $myRQUri
* @access protected
*/
protected $myRQUri=NULL;
/**
* @var string $myCacheValues
* @access protected
*/
protected $myCacheValues=array();
/**
* @var string $mySourceFile
* @access private
*/
private $mySourceFile=__FILE__;
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// init methods
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* cunstruct
*
* @param AJAX $ajaxObj
* @param string $funcName
* @param string $funcInc the include file containing the php function
* @param array $funcArgs (array with NAME => VALUE paires for arguments)
* @param string $rqMethode the methode of the ajax request
*
* @access public
*
***/
function OCSP_AJAX_FUNCTION(&$ajaxObj,$funcName,$funcInc="",$funcArgs=NULL,$rqMethode=OCSP_AJAX_RQMODE_GET) {
$this->myAjaxObj =$ajaxObj;
$this->setFuncName(trim($funcName));
$this->myFuncInc =$funcInc;
$this->myFuncArgs =$funcArgs;
$this->myRQMethod =$rqMethode;
}
/**
* @returns string
* @access public
***/
function getFuncName() {
return $this->myFuncName;
}
/**
* @param string $funcName
* @access public
***/
function setFuncName($funcName) {
$this->myFuncName=$funcName;
}
/**
* @returns string
* @access public
***/
function getTargetId() {
return $this->myTargetId;
}
/**
* @param string $targetId
* @access public
***/
function setTargetId($targetId) {
$this->myTargetId=$targetId;
}
/**
* @param string $aUri
* @access public
***/
function setRequestUri($aUri) {
$this->myRQUri=$aUri;
}
/**
* @return string
*/
function getRequestUri()
{
if (!empty($this->myRQUri))
{
return $this->myRQUri;
} else {
$this->myAjaxObj->getActionUri();
}
}
/**
* @return string
* @access public
*/
function getClassSrc() {
return $this->mySourceFile;
}
/**
* @return OCSP_AJAX
*/
function &getAjaxObj()
{
return $this->myAjaxObj;
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// function methods
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// js methods
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* returns the javascript function name
*
* @returns string
*
* @access public
*
***/
function js_getFuncName() {
return "oax_".preg_replace("/[^a-zA-Z0-9]/","_",$this->getFuncName());
}
/**
* returns the javascript code to register the function
*
* @returns string
*
* @access public
*
***/
function js_getRegisterFunction() {
$s_ret ="var cur_oaxFunc=ocspAjax_register_function(";
$s_ret.="'".$this->myAjaxObj->get_objId()."',";
$s_ret.="'".$this->getFuncName()."',";
$s_ret.="'".$this->getTargetId()."',";
$s_ret.="'".$this->myAjaxObj->getActionUri()."'";
$s_ret.=");\n";
if (is_array($this->myFuncArgs)) {
foreach($this->myFuncArgs as $s_key => $s_val) {
$s_ret.="\tcur_oaxFunc.setFuncArg('".$s_key."','".$s_val."');\n";
}
}
if (!empty($this->myRQUri)) {
$s_ret.="cur_oaxFunc.setRequestUri('".$this->myRQUri."');\n";
}
return $s_ret;
}
/**
* returns the javascript representation of the function
*
* @param boolean $debug
*
* @returns string
*
* @access public
*
***/
function js_getFunction($debug=FALSE)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_AJAX_FUNCTION::js_getFunction()");
$s_ret ="\n/** wrapper for ".$this->getFuncName()." Class: ".get_class($this)." **/\n";
$s_ret.=$this->js_getRegisterFunction();
$s_ret.="\tfunction ".$this->js_getFuncName()."(args) {ocspAjax_do_call('".$this->getFuncName()."', args);}\n\n";
return $s_ret;
}
/**
* returns the js ajax call
*
* @param array $args
* @param boolean $debug
*
* @return string
*
* @since pk-07-04-28
*
* @access public
*/
function js_getAjaxCall($args=NULL,$debug=FALSE)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_AJAX_FUNCTION::js_getAjaxCall()",print_r($args,TRUE));
if (is_array($args) && sizeof($args))
{
$str_jsArg ="new Array(";
foreach($args as $str_key => $str_value)
{
$str_jsArg.="new ocspAjax_funcArg('".$str_key."','".$str_value."'),";
}
$str_jsArg=substr($str_jsArg,0,-1).")";
} else {
$str_jsArg="";
}
return $this->js_getFuncName()."(".$str_jsArg.");";
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// cache methods
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* returns the values to add to the cache
*
* @param boolean $debug
*
* @returns array
*
* @access public
***/
function getMyCacheValues() {
return $this->myCacheValues;
}
}

Source for file OCSP_AJAX_FUNCTION.phpclass