Source for file OCSP_AJAX_FLDEVENT.phpclass

Documentation is available at OCSP_AJAX_FLDEVENT.phpclass

  1. <?php
  2. /**
  3.   * Class file OCSP_AJAX_FLDEVENT.phpclass
  4.   *
  5.   * @project    Open CSP-Management
  6.   * @package    cms
  7.   * @category   chapter
  8.   *
  9.   * @author     Peter Krebs (pk) <pitlinz@users.sourceforge.net>
  10.   * @license    http://opensource.org/licenses/gpl-license.php GNU Public License
  11.   *
  12.   * @since pk-07-02-21
  13.   *
  14.   ***/
  15.  
  16. require_once __OCSP_PHPINCPATH__."common" . _OCSP_DIRSEP_ . "pcf_directory.phpinc";
  17. require_once dirname(__FILE__). _OCSP_DIRSEP_ . "OCSP_AJAX_FUNCTION.phpclass";
  18.  
  19. /**
  20.   * Class OCSP_AJAX_FLDEVENT
  21.   *
  22.   * this class is designed to handle ajex functions
  23.   *
  24.   * @project    Open CSP-Management
  25.   * @package    cms
  26.   * @category   chapter
  27.   *
  28.   * @author     Peter Krebs (pk) <pitlinz@users.sourceforge.net>
  29.   * @license    http://opensource.org/licenses/gpl-license.php GNU Public License
  30.   *
  31.   * @since pk-07-02-21
  32.   *
  33.   ***/
  34. class OCSP_AJAX_FLDEVENT extends OCSP_AJAX_FUNCTION {
  35.  
  36.     /** Aggregations: */
  37.  
  38.     /** Compositions: */
  39.  
  40.     /**
  41.       * @var DBMS_FLD $myField 
  42.       * @access protected
  43.       ***/
  44.     protected $myField=NULL;
  45.  
  46.  
  47.     /** Attributes: **/
  48.  
  49.     /**
  50.       * @var string $myEventMethode 
  51.       * @access protected
  52.       ***/
  53.     protected $myEventMethode=NULL;
  54.  
  55.     /**
  56.       * @var string $myFieldName 
  57.       * @access protected
  58.       ***/
  59.     protected $myFieldName=NULL;
  60.  
  61.     // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  62.     // init methods
  63.     // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  64.     /**
  65.       * cunstruct
  66.       *
  67.       * @param string $funcName 
  68.       * @param string $funcInc the include file containing the php function
  69.       * @param string $funcMethode the methode of the ajax request
  70.       * @param array $funcArgs 
  71.       * @param string $funcMethode 
  72.       *
  73.       * @access public
  74.       *
  75.       ***/
  76.     function OCSP_AJAX_FLDEVENT(&$ajaxObj,&$aFldObj,$aEventMethode,$funcArgs=NULL,$funcMethode=AJAX_RQMODE_GET) {
  77.         $this->setFuncName("fldEventFunc");
  78.  
  79.         $this->myAjaxObj        =$ajaxObj;
  80.         $this->myField          =$aFldObj;
  81.         $this->myEventMethode   =$aEventMethode;
  82.         $this->myFuncInc        =NULL;
  83.         $this->myFuncMethod     =$funcMethode;
  84.         $this->myFuncArgs       =$funcArgs;
  85.     }
  86.  
  87.  
  88.     /**
  89.       * @returns string
  90.       * @access public
  91.       ***/
  92.     function getFuncName() {
  93.         return "fldEventFunc";
  94.     }
  95.  
  96.     /**
  97.       * @retruns string
  98.       * @access public
  99.       ***/
  100.     function getTargetId() {
  101.         return "";
  102.     }
  103.  
  104.     /**
  105.       * @param string $targetId 
  106.       * @access public
  107.       ***/
  108.     function setTargetId($targetId) {
  109.         // do nothing
  110.     }
  111.  
  112.     /**
  113.       * @param DBMS_FLD $aField 
  114.       * @access public
  115.       ***/
  116.     function setFldObj(&$aField) {
  117.         $this->myField=$aField;
  118.     }
  119.  
  120.     /**
  121.       * @param string $aEventMethode 
  122.       * @access public
  123.       ***/
  124.     function setEventMethode($aEventMethode) {
  125.         $this->myEventMethode=$aEventMethode;
  126.     }
  127.  
  128.     /**
  129.       * @param string $aFieldName 
  130.       * @access public
  131.       ***/
  132.     function setFieldName($aFieldName) {
  133.         $this->myFieldName=$aFieldName;
  134.     }
  135.  
  136.     /**
  137.       * if $this->myFieldName is empty "$dataArrname[$fld->name]" is returned
  138.       * @return string 
  139.       * @access public
  140.       ***/
  141.     function getFieldName() {
  142.         if (empty($this->myFieldName)) {
  143.             if (pcf_is_instance_of($this->myField,'DBMS_FIELD')) {
  144.                 return $this->myField->getDataArrName()."[".$this->myField->getName()."]";
  145.             } else {
  146.                 return "";
  147.             }
  148.         } else {
  149.             return $this->myFieldName;
  150.         }
  151.     }
  152.  
  153.     // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  154.     // function methods
  155.     // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  156.  
  157.  
  158.     // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  159.     // js methods
  160.     // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  161.  
  162.     /**
  163.       * returns the javascript function name
  164.       *
  165.       * @returns string
  166.       *
  167.       * @access public
  168.       *
  169.       ***/
  170.     function js_getFuncName() {
  171.         return "oax_fld_".preg_replace("/[^a-zA-Z0-9]/","_",$this->myField->getFrmId()."_".$this->myField->getKey().'_'.$this->myEventMethode);
  172.     }
  173.  
  174.  
  175.     /**
  176.       * returns the javascript representation of the function
  177.       *
  178.       * @param boolean $debug 
  179.       *
  180.       * @returns string
  181.       *
  182.       * @access public
  183.       *
  184.       ***/
  185.     function js_getFunction($debug=FALSE) {
  186.         if ($debug) echoDebugMethod(__FILE__." L:".__LINE__,get_class($this),__CLASS__."::".__METHODE__."()");
  187.  
  188.         $s_ret="
  189.             /**
  190.               * wrapper for field ".$this->myField->getKey()."
  191.               **/
  192.             if (!ocspAjax_get_funcObj('".$this->getFuncName()."')) {
  193.                ".$this->js_getRegisterFunction()."
  194.             }
  195.             function ".$this->js_getFuncName()."(fldValue) {
  196.                 args = new Array();
  197.                 args[args.length]=new ocspAjax_funcArg('axFRM',".$this->myField->getFrmId().");
  198.                 args[args.length]=new ocspAjax_funcArg('axFLD','".$this->myField->getKey()."');
  199.                 args[args.length]=new ocspAjax_funcArg('axFLDNAME','".$this->getFieldName()."');
  200.                 args[args.length]=new ocspAjax_funcArg('axMETH','".$this->myEventMethode."');
  201.                 args[args.length]=new ocspAjax_funcArg('axARRNAME','".$this->myField->getDataArrName()."');
  202.                 args[args.length]=new ocspAjax_funcArg('axCURVAL',fldValue);
  203.                 ocspAjax_debug(\"Value: \" + fldValue);
  204.                 ocspAjax_do_call('".$this->getFuncName()."', args);
  205.             }
  206.  
  207.             ";
  208.         return $s_ret;
  209.     }
  210.  
  211.     // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  212.     // cache methods
  213.     // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  214.  
  215.     /**
  216.       * returns the cache values
  217.       *
  218.       * @param boolean $debug 
  219.       *
  220.       * @returns array
  221.       *
  222.       * @access protected
  223.       *
  224.       ***/
  225.  
  226. }

Documentation generated on Thu, 08 Jan 2009 17:45:08 +0100 by phpDocumentor 1.4.0a2