Source for file OCSP_FRMCONTR_AJAXFORM.phpclass

Documentation is available at OCSP_FRMCONTR_AJAXFORM.phpclass

  1. <?php
  2. /**
  3.   * Class file OCSP_FRMCONTR_AJAXFORM.phpclass
  4.   *
  5.   *
  6.   * @project    Open CSP-Management
  7.   * @package    forms
  8.   * @category   dbms_form
  9.   *
  10.   * @author     Peter Krebs (pk) <pitlinz@users.sourceforge.net>
  11.   * @license    http://opensource.org/licenses/gpl-license.php GNU Public License
  12.   *
  13.   * @since  pk-07-07-02
  14.   *
  15.   ***/
  16.  
  17. require_once dirname(__FILE__)."/OCSP_FRMCONTR_FORM.phpclass";
  18.  
  19.  
  20. /**
  21.   * class OCSP_FRMCONTR_AJAXFORM
  22.   *
  23.   * @project    Open CSP-Management
  24.   * @package    forms
  25.   * @category   dbms_form
  26.   *
  27.   * @author     Peter Krebs (pk) <pitlinz@users.sourceforge.net>
  28.   * @license    http://opensource.org/licenses/gpl-license.php GNU Public License
  29.   *
  30.   * @since  pk-07-07-02
  31.   *
  32.   */
  33. class OCSP_FRMCONTR_AJAXFORM extends OCSP_FRMCONTR_FORM
  34. {
  35.  
  36.     /*** Aggregations: */
  37.  
  38.  
  39.     /*** Compositions: */
  40.  
  41.  
  42.     /*** Attributes: */
  43.  
  44.     /**
  45.       * @protected OCSP_AJAX $myAjaxObj
  46.       */
  47.     protected $myAjaxObj=NULL;
  48.  
  49.  
  50.     /**
  51.       * @protected OCSP_AJAX_FUNCTION $mySubmitFunction
  52.       */
  53.     protected $mySubmitFunction=NULL;
  54.     
  55.     // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  56.     // init methods
  57.     // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  58.  
  59.  
  60.     // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  61.     // getter/setter methods
  62.     // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  63.  
  64.     /**
  65.       * if $this->myAjaxObj is null it is set to the functions ajax object
  66.       *
  67.       * @param OCSP_AJAX_FUNCTION $aFuncObj 
  68.       * @param string $method (get or post)
  69.       * @param boolean $debug 
  70.       */
  71.     function setMySubmitFunction(&$aFuncObj,$method="",$debug=FALSE)
  72.     {
  73.         if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_FRMCONTR_AJAXFORM::setMySubmitFunction()");
  74.         
  75.         $this->mySubmitFunction=&$aFuncObj;
  76.         if (!pcf_is_instance_of($this->myAjaxObj,'OCSP_AJAX'))
  77.         {
  78.             $this->myAjaxObj=$this->mySubmitFunction->getAjaxObj();
  79.         }
  80.         if (strtolower($method)=="get")
  81.         {
  82.             $this->myMethod="get";
  83.         } else {
  84.             $this->myMethod="post";
  85.         }
  86.     }
  87.       
  88.  
  89.     /**
  90.       * returns the first set value of:
  91.       * - $this->myAction or
  92.       * - $this->mySubmitFunction->getRequestUri() or
  93.       * - $this->myAjaxObj->getActionUri() or
  94.       * - $_SERVER['REQUEST_URI']
  95.       * and sets to $this->myAction
  96.       *
  97.       * @return string 
  98.       */
  99.     function getAction()
  100.     {
  101.         if (!empty($this->myAction)) return $this->myAction;
  102.  
  103.         if (pcf_is_instance_of($this->mySubmitFunction,'OCSP_AJAX_FUNCTION'))
  104.         {
  105.             $this->myAction=$this->mySubmitFunction->getRequestUri();
  106.         }
  107.         if (!empty($this->myAction)) return $this->myAction;
  108.         
  109.         if (pcf_is_instance_of($this->myAjaxObj,'OCSP_AJAX'))
  110.         {
  111.             $this->myAction=$this->myAjaxObj->getActionUri();
  112.         }
  113.         if (!empty($this->myAction)) return $this->myAction;
  114.         
  115.         $this->myAction=$_SERVER['REQUEST_URI'];
  116.         return $this->myAction;
  117.     }
  118.     
  119.     // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  120.     // form db methods
  121.     // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  122.  
  123.  
  124.     // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  125.     // controll elementes
  126.     // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  127.  
  128.     // form tag <form ...>
  129.  
  130.  
  131.  
  132.     /**
  133.       * @param boolean $debug 
  134.       * @return string 
  135.       * @access public
  136.       */
  137.     function getFormEvents($aMode=FRM_MODE_READONLY,$debug=FALSE)
  138.     {
  139.         if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_FRMCONTR_AJAXFORM::getFormEvents()");
  140.         $str_ret="";
  141.         
  142.         $this->myMode=$aMode;
  143.         
  144.         if (!empty($this->myMethod))
  145.         {
  146.             $str_ret.=" method=\"".$this->myMethod."\"";
  147.         } else {
  148.             $str_ret.=" method=\"post\"";
  149.         }
  150.  
  151.         $str_ret.=" onsubmit=\"return ocspAjax_submitForm(this,'".$this->mySubmitFunction->getFuncName()."');\"";
  152.  
  153.         $str_ret.=" action=\"".$this->getAction()."\"";
  154.         
  155.         return $str_ret;
  156.     }
  157.  
  158.     /**
  159.       * @param boolean $debug 
  160.       * @access public
  161.       */
  162.     function getFormCmdButtons($debug=FALSE)
  163.     {
  164.         if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_FRMCONTR_FORM::getFormCmdButtons()");
  165.         switch($this->myMode)
  166.         {
  167.             case FRM_MODE_NEW:
  168.             case FRM_MODE_EDIT:
  169.             case FRM_MODE_COPY:
  170.                 if (!isset($this->myCommands['_FORM_']['SAVE']))
  171.                 {
  172.                     $this->myCommands['_FORM_']['SAVE']=array(
  173.                         'TYPE'=>_OCSP_FRMCMDTYPE_BTNJS_,
  174.                         'CODE'=>"ocspAjax_submitForm(document.forms['".$this->getFormHTMLId()."'],'".$this->mySubmitFunction->getFuncName()."');"
  175.                         );
  176.                 }
  177.                 break;
  178.         }
  179.         return parent::getFormCmdButtons($debug);
  180.     }
  181.  
  182.     // footer
  183.  
  184. } // end of OCSP_FRMCONTR_FORM
  185. ?>

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