File Source for OCSP_AJAX.phpclass

<?php
/**
* Class file OCSP_AJAX.phpclass
*
* thanx to the SAJAX project
*
* @project Open CSP-Management
* @package common
* @subpackage ajax
* @category class
*
*
* @author Peter Krebs (pk) <pitlinz@users.sourceforge.net>
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
*
* @since pk-07-04-19
*
***/
/**
* constant definitions
*/
define('OCSP_AJAX_RQMODE_GET',"get");
define('OCSP_AJAX_RQMODE_POST',"post");
/**
* constant requires
*/
require_once dirname(__FILE__)._OCSP_DIRSEP_."OCSP_AJAX_FUNCTION.phpclass";
require_once __OCSP_PHPINCPATH__."common"._OCSP_DIRSEP_."pcf_directory.phpinc";
require_once __OCSP_PHPINCPATH__."common"._OCSP_DIRSEP_."OCSP_OBJ.phpclass";
if (!function_exists('jOCSP_registerError'))
{
require_once dirname(__FILE__) . _OCSP_DIRSEP_ . "jOCSP_functions.phpinc";
}
/**
* Class OCSP_AJAX
*
* this class is designed to handle ajex requests
*
* @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 extends OCSP_OBJ {
/*** class constants --------------------------------------------- */
/**
* @constant string CLASS_SRC_FILE
*/
const CLASS_SRC_FILE = __FILE__;
/*** class variables --------------------------------------------- */
/*** class methods --------------------------------------------- */
public static function isAjaxCall()
{
return (isset($_SERVER['HTTP_X_REQUESTED_WITH']) && ($_SERVER['HTTP_X_REQUESTED_WITH'] == 'XMLHttpRequest'));
}
public static function isjOCSPLoad()
{
if (self::isAjaxCall())
{
return (isset($_GET['inToDiv']) && !empty($_GET['inToDiv']));
}
return False;
}
/** Aggregations: */
/** Compositions: */
/**
* @var array $functionLst the functions available (registered)
* @access protected
***/
protected $functionLst=array();
/** Attributes: **/
/**
* @var array $done_funcLst the functions available (registered)
* @access protected
***/
protected $done_funcLst=array();
/**
* @var string $objId the id of the ajax object
* @access protected
***/
protected $objId="";
/**
* @var array $valueLst values the functions uses
* @access protected
***/
protected $valueLst=array();
/**
* @var string $jsAction the action used
* @access protected
***/
protected $jsAction="";
/**
* @var string $jsCode aditional code to include in on the page
* @access protected
* @since pk-07-09-18
*/
protected $jsCode="";
/**
* @var string $myClassSrcFile
* @access protected
***/
protected $myClassSrcFile=__FILE__;
/**
* @var boolean $isCachable
* @access protected
***/
protected $isCachable=FALSE;
/**
* where to cache the object
* possible settings are:
* - session (cache the object data to the session)
*
* @var string $myCacheType
* @access protected
* @since pk-07-03-18
*/
protected $myCacheType='session';
/**
* array of cached objects
* @var array $myCacheObjects
* @access protected
* @since pk-07-03-18
*/
protected $myCacheObjects=array();
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// init methods
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
function OCSP_AJAX($aId="",$funcInc="",$debug=FALSE) {
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_AJAX::OCSP_AJAX()");
$this->jsAction = OCSP_CONF::getInstance('OCSP')->getValue('SYSTEMURL') . "ajax.php";
if (!empty($aId)) {
$this->objId=$aId;
} else {
$this->get_objId($debug);
}
}
/**
* returns the object ID
* if $this->objId is empty $_SERVER['UNIQUE
*
* if you use a special class to handle the ajax requests overwrite this methode
*
* @param boolean $debug
*
* @returns string
*
* @access public
*
***/
function get_objId($debug=FALSE) {
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_AJAX::get_objId()");
if (empty($this->objId)) {
$this->objId=session_id()."__".md5($_SERVER['REQUEST_URI']);
if ($debug) echoDebug(__FILE__,"Generating objId: ".$this->objId."\n");
}
return $this->objId;
}
/**
* @param string $aId
* @access public
*/
function set_objId($aId)
{
$this->objId=$aId;
}
/**
* @returns string
* @access public
***/
function getActionUri() {
return $this->jsAction;
}
/**
* sets the action uri (where the request is sent)
*
* @param string $rqUrl
* @access public
* @since pk-07-04-19
*/
function setActionUri($rqUrl)
{
$this->jsAction=$rqUrl;
}
/**
* @param string $aCode
* @access public
* @since pk-07-09-18
*/
function addJsCode($aCode)
{
$this->jsCode.=$aCode."\n";
}
/**
* @return string (js)
* @access public
* @since pk-07-09-18
*/
function getJsCode()
{
return $this->jsCode;
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// function methods
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* retuns a registered function or an pointer to an empty function in $this::functionLst
*
* @param string $func_name
*
* @returns OCSP_AJAX_FUNCTION
*
* @access public
*
***/
function &getFunction($func_name) {
return $this->functionLst[$func_name];
}
/**
* register a function
*
* @param string $func_name name of the php function to call
* @param string $func_include include file containing the $func_name
* @param array $func_args argument array to submit too
* @param string $rq_methode request methode (GET|POST)
* @param boolean $debug
*
* @returns OCSP_AJAX_FUNCTION
*
* @access public
*
***/
function &registerFunction($func_name,$func_include="",$func_args=NULL,$rq_methode=OCSP_AJAX_RQMODE_GET,$debug=FALSE) {
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_AJAX::registerFunction($func_name)");
$this->functionLst[$func_name]=new OCSP_AJAX_FUNCTION($this,$func_name,$func_include,$func_args,$rq_methode);
return $this->functionLst[$func_name];
}
/**
* register a form submit
*
* @param string $func_name name of the php function to call
* @param string $frmName name of the formular (document.forms['$frmName'])
* @param string $func_include include file containing the $func_name
* @param array $func_args argument array to submit too
* @param string $rq_methode request methode (GET|POST)
* @param boolean $debug
*
* @returns OCSP_AJAX_FUNC_FRMSUBMIT
*
* @access public
*
***/
function &registerFormSubmit($func_name,$frmName,$func_include,$func_args=NULL,$rq_methode=OCSP_AJAX_RQMODE_POST,$debug=FALSE) {
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_AJAX::registerFormSubmit()");
require_once dirname(__FILE__)."/OCSP_AJAX_FUNC_FRMSUBMIT.phpclass";
$this->functionLst[$func_name]=new OCSP_AJAX_FUNC_FRMSUBMIT($this,$func_name,$frmName,$func_include,$func_args,$rq_methode);
return $this->functionLst[$func_name];
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// js methods
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* javascript escape a value
*
* @param string $val
*
* @returns string
*
***/
function js_esc($val) {
return pcf_js_escape($val);
}
/**
* returns the js code for the function List
*
* @param boolean $debug
*
* @return string (javascript code)
*
* @since pk-07-08-20
*/
function js_getFunctionCode($debug=FALSE)
{
if ($debug) echoDebugMethod(__FILE__,pcf_object_id($this),"OCSP_AJAX::js_getFunctionCode()");
$s_ret="";
foreach($this->functionLst as $s_funcName => &$o_function) {
if (!isset($this->done_funcLst[$s_funcName]) || (!$this->done_funcLst[$s_funcName])) {
$this->done_funcLst[$s_funcName]=TRUE;
if (is_object($o_function))
{
if (method_exists($o_function,"js_getFunction"))
{
$s_ret.=$o_function->js_getFunction();
}
if ($this->isCachable && method_exists($o_function,"getMyCacheValues"))
{
$this->myCacheObjects[$func_name]=$o_function->getMyCacheValues();
}
}
}
}
if ($this->isCachable)
{
$this->writeCache();
}
return $s_ret;
}
/**
* returns the javascript for the object
*
* @param boolean $debug
*
* @access public
*
***/
function js_getScript($debug=FALSE) {
if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_AJAX::js_getScript()");
$s_ret="";
$s_ret.="<script language=\"JavaScript\" type=\"text/javascript\">\n<!--\n";
$s_ret.="// ajax js_getScript\n";
$s_ret.=$this->js_getFunctionCode($debug);
$s_ret.=$this->getJsCode();
$s_ret.="// -->\n</script>\n";
return $s_ret;
}
/**
* returns the javascript code for an ajax function argument
*
* @param string $varName
* @param mixed $value
*
* @return string
*/
function js_getNewFuncArg($varName,$value)
{
$str_ret="new ocspAjax_funcArg('MEN_ID',";
if (intval($value)) {
$str_ret.=$value;
} else {
$str_ret.="'".$this->js_esc($value)."'";
}
return $str_ret.")";
}
/**
* returns the javascript code for an ajax function argument list
*
* @param array $argList (array(varName => value))
*
* @return string
*/
function js_getFuncArgList($argList)
{
$str_ret="new Array(";
$char_sep='';
if (is_array($argList))
{
foreach($argList as $str_name => $str_val)
{
$str_ret.=$char_sep.$this->js_getNewFuncArg($str_name,$str_val);
}
}
return $str_ret.")";
}
/**
* sets the http header for the ajax return
*
* @param string $contentType
* @param string $charset
*
*/
function setHTTPheader($contentType="text/javascript",$charset="UTF-8")
{
header ("Expires: Mon, 26 Feb 2007 00:00:00 GMT"); // Date in the past
header ("Last-Modified: " . gmdate("D, d M Y H:i:s") . " GMT");
header ("Cache-Control: no-cache, must-revalidate"); // HTTP/1.1
header ("Pragma: no-cache"); // HTTP/1.0
if (!empty($contentType) && !empty($charset))
{
header ("Content-Type: ".$contentType."; charset=".$charset);
}
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// cache methods
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* enables the object caching
*
* @param string cacheType
* @access public
* @since pk-07-03-18
*/
function enableCache($cacheType='session')
{
switch($cacheType) // check the type
{
case "session":
$this->enableCache=TRUE;
$this->myCacheType='session';
break;
default:
echo "Cachetype: $cacheType NOT IMPLEMENTED ".__FILE__." Line: ".__LINE__." (".__CLASS__."::".__METHOD__.")\n";
}
}
/**
* writes the cache
* @param boolean $debug
* @access public
* @since pk-07-03-18
* @todo OCSP_AJAX::cacheStore() use ocsp session
*/
function cacheStore($debug=FALSE)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),__CLASS__."::cacheStore()");
switch($this->myCacheType) {
case "session":
if (!is_array($_SESSION)) // session not startet -> start it
{
session_start();
}
$_SESSION['OCSP_AJAX'][$this->get_objId()]['CVAL']=$this->myCacheObjects;
break;
default:
echo "Cachetype: $cacheType NOT IMPLEMENTED ".__FILE__." Line: ".__LINE__." (".__CLASS__."::".__METHOD__.")\n";
}
}
/**
* loads the cached data
*
* @param string $cacheType
* @param boolean $debug
*
* @returns boolean
* @access public
* @since pk-07-03-18
* @todo OCSP_AJAX::cacheLoad() use ocsp session
*/
function cacheLoad($cacheType='session',$debug=FALSE)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),__CLASS__."::cacheLoad()");
switch($this->myCacheType) {
case "session":
if (!is_array($_SESSION)) // session not startet -> start it
{
session_start();
}
$this->myCacheObjects=$_SESSION['OCSP_AJAX'][$this->get_objId()]['CVAL'];
break;
default:
echo "Cachetype: $cacheType NOT IMPLEMENTED ".__FILE__." Line: ".__LINE__." (".__CLASS__."::".__METHOD__.")\n";
}
}
}

Source for file OCSP_AJAX.phpclass