Source for file OCSP_FRMVIEW.phpclass

Documentation is available at OCSP_FRMVIEW.phpclass

  1. <?php
  2. /**
  3.   * Class file OCSP_FRMVIEW.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-06-30
  14.   *
  15.   ***/
  16.  
  17. require_once dirname(__FILE__)."/languages/de.phpinc";
  18.  
  19. /**
  20.   * class OCSP_FRMVIEW
  21.   *
  22.   * @project    Open CSP-Management
  23.   * @package    forms
  24.   * @category   dbms_form
  25.   *
  26.   * @author     Peter Krebs (pk) <pitlinz@users.sourceforge.net>
  27.   * @license    http://opensource.org/licenses/gpl-license.php GNU Public License
  28.   *
  29.   * @since  pk-07-06-30
  30.   *
  31.   */
  32. class OCSP_FRMVIEW
  33. {
  34.  
  35.     /*** Aggregations: */
  36.  
  37.  
  38.     /*** Compositions: */
  39.  
  40.     /**
  41.       * @var OCSP_FORM $myForm 
  42.       * @access protected
  43.       */
  44.     protected $myForm=NULL;
  45.  
  46.     /**
  47.       * @var array $myBlocks 
  48.       * @access protected
  49.       */
  50.     protected $myBlocks=array();
  51.  
  52.     /**
  53.       * @var array $myFields 
  54.       * @access protected
  55.       */
  56.     protected $myFields=array();
  57.  
  58.  
  59.     /*** Attributes: */
  60.  
  61.     /**
  62.       * an array of tags to show
  63.       * $btnTags[CMDNAME]=TAGTMPL
  64.       * @var array $btnTags 
  65.       * @access protected
  66.       */
  67.     protected $btnTags=array();
  68.     
  69.     /**
  70.      * array with button positions
  71.      * 
  72.      * - <0: left
  73.      * - >0: rigth
  74.      * 
  75.      * @var array $btnPos 
  76.      * @access protected
  77.      * 
  78.      * @since pk-08-06-02
  79.      */
  80.     protected $btnPos = array();
  81.  
  82.     /**
  83.       * the default icon size
  84.       * is used to select the icon dir
  85.       * @var string 
  86.       * @access proteced
  87.       */
  88.     protected $btnIconSize="22x22";
  89.  
  90.  
  91.  
  92.     /*** Association */
  93.  
  94.     /**
  95.       * @var OCSP_FRMCONTR $myControl 
  96.       * @access protected
  97.       */
  98.     protected $myControl;
  99.  
  100.     // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  101.     // init methods
  102.     // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  103.  
  104.     /**
  105.       * @param OCSP_FORM $aForm 
  106.       * @param boolean $debug 
  107.       */
  108.     function OCSP_FRMVIEW(&$aForm,$debug=FALSE)
  109.     {
  110.         $this->setMyForm($aForm);
  111.     }
  112.  
  113.  
  114.     // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  115.     // getter/setter methods
  116.     // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  117.  
  118.     /**
  119.       * @return OCSP_FORM 
  120.       */
  121.     function &getMyForm()
  122.     {
  123.         return $this->myForm;
  124.     }
  125.  
  126.     /**
  127.       * @param OCSP_FORM $aForm 
  128.       */
  129.     function setMyForm(&$aForm)
  130.     {
  131.         $this->myForm=&$aForm;
  132.     }
  133.  
  134.     /**
  135.      * alias for setControl
  136.      * 
  137.      * @param OCSP_FRMCONTR $aControll 
  138.      * 
  139.      * @deprecated since pk-08-12-03
  140.      */
  141.     public function setControll(&$aControl)
  142.     {
  143.         $this->setControl($aControl);
  144.     }
  145.  
  146.     /**
  147.      * sets the control object
  148.      *
  149.      * @param OCSP_FRMCONTR $aControl 
  150.      */
  151.     public function setControl(&$aControl)
  152.     {
  153.         $this->myControl=&$aControl;
  154.     }
  155.     
  156.     /**
  157.      * returns the control object
  158.      *
  159.      * @return OCSP_FRMCONTR 
  160.      */
  161.     public function getControl()
  162.     {
  163.         if (!pcf_is_instance_of($this->myControl,"OCSP_FRMCONTR"))
  164.         {
  165.             $this->myControl = $this->getMyForm()->getControl();
  166.         }
  167.         return $this->myControl;
  168.     }
  169.     
  170.     /**
  171.       * @returns int
  172.       * @since pk-05-11-04
  173.       ***/
  174.     function getFrmMode() {
  175.         return $this->myForm->getFrmMode();
  176.     }
  177.  
  178.     /**
  179.       * @param int $mode 
  180.       * @since pk-05-11-04
  181.       ***/
  182.     function setFrmMode($mode) {
  183.         $this->myForm->setFrmMode($mode);
  184.     }
  185.  
  186.  
  187.     // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  188.     // db methods
  189.     // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  190.  
  191.     /**
  192.       * returns the db object from the form
  193.       *
  194.       * @param boolean $debug 
  195.       * @return OCSP_DB 
  196.       */
  197.     function &getDBObj($debug=FALSE)
  198.     {
  199.         if (!pcf_is_instance($this->myForm,'OCSP_FORM'))
  200.         {
  201.             $obj_ret=NULL;
  202.             return $obj_ret;
  203.         } else {
  204.             return $this->myForm->getDBObj($debug);
  205.         }
  206.     }
  207.  
  208.     // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  209.     // block methods
  210.     // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  211.  
  212.     /**
  213.       * unsets $this->myBlocks
  214.       */
  215.     function unsetBlocks()
  216.     {
  217.         $this->myBlocks=array();
  218.         $this->myFields=array();
  219.     }
  220.  
  221.     /**
  222.       * @param int $aMode 
  223.       * @param boolean $debug 
  224.       * @return array 
  225.       */
  226.     function getBlocksMode($aMode,$debug=FALSE)
  227.     {
  228.         if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_FRMVIEW::getBlocksMode($aMode)");
  229.         if (sizeof($this->myBlocks))
  230.         {
  231.             if ($debug) echoDebugLine(__FILE__,__LINE__,"returning stored blocks");
  232.             return $this->myBlocks;
  233.         }
  234.         $arr_blocks=$this->myForm->getBlocks($debug);
  235.         $arr_ret=array();
  236.         foreach($arr_blocks as &$obj_block)
  237.         {
  238.             if ($obj_block->isToShow($aMode,$debug))
  239.             {
  240.                 $this->myBlocks[$obj_block->getId()]=&$obj_block;
  241.             }
  242.         }
  243.         return $this->myBlocks;
  244.     }
  245.  
  246.     // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  247.     // fields methods
  248.     // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  249.  
  250.     /**
  251.       * @param int $aMode 
  252.       * @param boolean $debug 
  253.       *
  254.       * @return array of DBMS_FIELDS
  255.       */
  256.     function getFieldsMode($aMode,$debug=FALSE)
  257.     {
  258.         if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_FRMVIEW::getFieldsMode($aMode)");
  259.         if (sizeof($this->myFields))
  260.         {
  261.             if ($debug) echoDebugLine(__FILE__,__LINE__,"returning stored fields");
  262.             return $this->myFields;
  263.         }
  264.  
  265.         if ($this->getBlocksMode($aMode,$debug))
  266.         {
  267.             foreach($this->myBlocks as &$obj_block)
  268.             {
  269.                 $arr_flds=$obj_block->getFields($aMode,$debug);
  270.                 //echoDebugLine(__FILE__,__LINE__,"\$arr_flds: <pre>".print_r($arr_flds,TRUE)."</pre>");
  271.                 foreach($arr_flds as &$obj_fld)
  272.                 {
  273.                     $obj_fld->setView($this);
  274.                     $this->myFields[]=&$obj_fld;
  275.                 }
  276.             }
  277.             return $this->myFields;
  278.         } else {
  279.             ocsp_logError(__FILE__,__LINE__,"could not load field blocks for mode $aMode");
  280.             return array();
  281.         }
  282.     }
  283.  
  284.     // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  285.     // button methods
  286.     // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  287.  
  288.     /**
  289.       * sets the button icon size
  290.       * NOTE this is used to get icon path in sysimages
  291.       * @param string $aSize (example "16x16")
  292.       */
  293.     function setButtonIconSize($aSize)
  294.     {
  295.         $this->btnIconSize=$aSize;
  296.     }
  297.  
  298.     /**
  299.      * alias for setButtonImageTag
  300.      * @param string $aCmd 
  301.      * @param string $imgTag 
  302.      * 
  303.      * @deprecated since pk-08-11-24
  304.      */
  305.     function setButtonTag($aCmd,$imgTag)
  306.     {
  307.         $this->setButtonImageTag($aCmd,$imgTag);
  308.     }
  309.     
  310.     /**
  311.      * sets the button tag
  312.      * 
  313.      * buttons are enclosed by an <a>-tag which does the function.
  314.      *
  315.      * @param string $aCmd 
  316.      * @param string $imgTag 
  317.      * 
  318.      * @since pk-08-11-24
  319.      */
  320.     public function setButtonImageTag($aCmd,$imgTag)
  321.     {
  322.         $this->btnTags[$aCmd]=$imgTag;
  323.     }
  324.     
  325.     /**
  326.      * @param string $aCmd 
  327.      * @param int $pos 
  328.      * 
  329.      * @version pk-08-06-02
  330.      */
  331.     function setButtonPos($aCmd,$pos)
  332.     {
  333.         if (intval($pos) < 0)
  334.         {
  335.             $this->btnPos[-1][] = $aCmd;
  336.         } else {
  337.             $this->btnPos[1][] = $aCmd;
  338.         }
  339.     }
  340.     
  341.     /**
  342.      * returns the button commands on pos
  343.      * 
  344.      * @param int $pos 
  345.      * 
  346.      * @return array 
  347.      */
  348.     public function getPosButtons($pos)
  349.     {
  350.         $arr_ret = array();
  351.         if (intval($pos) == 0)
  352.         {
  353.             if (isset($this->btnPos[-1]) && is_array($this->btnPos[-1]))
  354.             {
  355.                 $arr_ret = $this->btnPos[-1];
  356.             }
  357.             
  358.             if (isset($this->btnPos[1]) && is_array($this->btnPos[1]))
  359.             {
  360.                 foreach($this->btnPos[1] as $str_cmd)
  361.                 {
  362.                     $arr_ret[] = $str_cmd;
  363.                 }
  364.             }
  365.         } else if (intval($pos) < 0) {
  366.             if (isset($this->btnPos[-1]) && is_array($this->btnPos[-1]))
  367.             {
  368.                 $arr_ret = $this->btnPos[-1];
  369.             }
  370.         } else {
  371.             if (isset($this->btnPos[1]) && is_array($this->btnPos[1]))
  372.             {
  373.                 $arr_ret = $this->btnPos[1];
  374.             }
  375.         }
  376.         
  377.         return $arr_ret;
  378.     }
  379.  
  380.     /**
  381.       * returns the buttion image tag
  382.       * @param string $aCmd 
  383.       * @param boolean $debug 
  384.       *
  385.       * @global array $OCSP_CONF 
  386.       *
  387.       * @return string 
  388.       *
  389.       */
  390.     function getButtonImgTag($aCmd,$debug=FALSE)
  391.     {
  392.         if ($debug) echoDebugMethod(__FILE__,get_class($this),"OCSP_FRMVIEW::getButtonImgTag($aCmd)");
  393.         if (isset($this->btnTags[$aCmd]))
  394.         {
  395.             return $this->myControl->parseRowTmpl($this->btnTags[$aCmd],$debug);
  396.         } else {
  397.             $str_iconPath=OCSP_CONF::getInstance()->getValue('HTSYSTEMPATH')."system"._OCSP_DIRSEP_."sysimages"._OCSP_DIRSEP_."icons-".$this->btnIconSize._OCSP_DIRSEP_;
  398.             if ($debug) echoDebugLine(__FILE__,__LINE__,"IconPath: $str_iconPath");
  399.             $str_img="";
  400.             if (file_exists($str_iconPath.strtolower($aCmd).".gif"))
  401.             {
  402.                 $str_img=strtolower($aCmd).".gif";
  403.             } else if (file_exists($str_iconPath.strtolower($aCmd).".png")) {
  404.                 $str_img=strtolower($aCmd).".png";
  405.             } else if (file_exists($str_iconPath.strtolower($aCmd).".jpg")) {
  406.                 $str_img=strtolower($aCmd).".jpg";
  407.             }
  408.             if (!empty($str_img))
  409.             {
  410.                 return "<img src=\"" . OCSP_CONF::getInstance()->getValue('SYSIMGURL') . "icons-".$this->btnIconSize."/$str_img\" alt=\"$aCmd\" border=\"0\" class=\"button\">";
  411.             } else {
  412.                 switch(strtolower($aCmd))
  413.                 {
  414.                     case "delete":
  415.                         return "<img src=\"" . OCSP_CONF::getInstance()->getValue('SYSIMGURL') . "icons-".$this->btnIconSize."/edittrash.gif\" alt=\"$aCmd\" border=\"0\" class=\"button\">";
  416.                     default:
  417.                         return $aCmd;
  418.                 }
  419.                 
  420.             }
  421.         }
  422.     }
  423.  
  424.  
  425.  
  426. } // end of OCSP_FRMVIEW
  427. ?>

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