Source for file DBMS_FIELD_STATUS_CONFARR_SELECT.phpclass

Documentation is available at DBMS_FIELD_STATUS_CONFARR_SELECT.phpclass

  1. <?php
  2. /**
  3.   * Class file DBMS_FIELD_STATUS_CONFARR_SELECT.phpclass
  4.   *
  5.   * @project    Open CSP-Management
  6.   * @package    dbms_field
  7.   * @category   int
  8.   *
  9.   * @author     Peter Krebs <pitlinz@users.sourceforge.net>
  10.   * @license    http://opensource.org/licenses/gpl-license.php GNU Public License
  11.   *
  12.   * @version $Id:$
  13.   */
  14.  
  15.     pcf_require_class('DBMS_FIELD_GLOBALARRSELECTLIST',"db/frmClasses/");
  16.  
  17.  
  18. /**
  19.   * Class DBMS_FIELD_STATUS_CONFARR_SELECT
  20.   *
  21.   * @project    Open CSP-Management
  22.   * @package    dbms_field
  23.   * @category   int
  24.   *
  25.   * @author     Peter Krebs <pitlinz@users.sourceforge.net>
  26.   * @license    http://opensource.org/licenses/gpl-license.php GNU Public License
  27.   *
  28.   * @since      pk-03-12-16
  29.   *
  30.   * @version    pk-05-08-02
  31.   * @version    $Id:$
  32.   *
  33.   * @todo       only checked when form is shown no check is done for
  34.   *              this::slashedValue() and this::getValue() needs a major
  35.   *              change in the dbms function calls
  36.   *
  37.   ***/
  38. class DBMS_FIELD_STATUS_CONFARR_SELECT extends DBMS_FIELD_GLOBALARRSELECTLIST {
  39.     /**
  40.       * source file of the class
  41.       *
  42.       * @var string $classSrcFile 
  43.       * @since pk-06-07-24
  44.       ***/
  45.     var $classSrcFile=__FILE__;
  46.  
  47.     /**
  48.       * @var string $className 
  49.       ***/
  50.     var $className       = "SelectGlobalStatusArr";
  51.  
  52.     // ###########################################################
  53.     // OBJECT (CONST) VAR DECLARATION
  54.     // ###########################################################
  55.  
  56.     /**
  57.       * @var string $grpKey index to look for the group
  58.       ***/
  59.     var $grpKey          = "GROUP";
  60.     /**
  61.       * @var string $iconKey index to look for the icon
  62.       ***/
  63.     var $iconKey         = "ICON";
  64.     /**
  65.       * @var string $requireValueKey index to look for the required value
  66.       ***/
  67.     var $requireValueKey = "REQVAL";
  68.  
  69.     // ###########################################################
  70.     // FIELD DEFINITION DATA METHODS
  71.     // ###########################################################
  72.  
  73.     /**
  74.       * returns an array of field to bie shown in the edit form
  75.       * by using editTbl_echoForm
  76.       *
  77.       * the array is in the form:
  78.       *
  79.       * <code>
  80.       * [_sectionName_]
  81.       *      [TITLE] -> string
  82.       *      [_rowName_]
  83.       *         [FLDLAB]  (complete html code with <td></td>)
  84.       *         [FLDVAL] (complete html code with <td></td>)
  85.       * </code>
  86.       *
  87.       * @param boolean $debug 
  88.       *
  89.       * @returns array
  90.       *
  91.       * @since pk-06-07-24
  92.       *
  93.       ***/
  94.     function editTbl_getFieldEditArr($debug=FALSE) {
  95.         if ($debug) echoDebugMethod(__FILE__,get_class($this),"DBMS_FIELD_DBSELECTLIST::editTbl_getFieldEditArr","",0);
  96.         $a_ret=parent::editTbl_getFieldEditArr($debug);
  97.  
  98.         unset($a_ret['SELECT']['FLD_LSTVALS']); // unset parent field as it is of no use here
  99.  
  100.         $a_ret['STATUSARR']=array(
  101.             'TITLE'=>"Status Einstellungen/Berechtigungen",
  102.             'ISHIDDEN' => FALSE,
  103.             'FLD_GRPKEY'=>array(
  104.                 'FLDLAB'=>"GROUP INDEX",
  105.                 'FLDVAL'=>"<input name=\"grpKey\" value=\"".$this->grpKey."\" size=\"40\">"
  106.             ),
  107.             'FLD_ICONKEY'=>array(
  108.                 'FLDLAB'=>"REQUIRE VALUE INDEX",
  109.                 'FLDVAL'=>"<input name=\"requireValueKey\" value=\"".$this->requireValueKey."\" size=\"40\">"
  110.             ),
  111.             'FLD_REQUIREDKEY'=>array(
  112.                 'FLDLAB'=>"ICON INDEX",
  113.                 'FLDVAL'=>"<input name=\"iconKey\" value=\"".$this->iconKey."\" size=\"40\">"
  114.             ),
  115.         );
  116.  
  117.         return $a_ret;
  118.     }
  119.  
  120.     /**
  121.       * @return boolean 
  122.       *
  123.       * @version pk-05-08-02
  124.       *
  125.       ***/
  126.     function save() {
  127.         $ret = parent::save();
  128.         $this->grpKey           =$_POST['grpKey'];
  129.         $this->iconKey          =$_POST['iconKey'];
  130.         $this->requireValueKey  =$_POST['requireValueKey'];
  131.  
  132.         return $ret;
  133.     }
  134.  
  135.     ###################################
  136.  
  137.     /**
  138.       * returns if we have to check the array for group and required value
  139.       *
  140.       * @param int $mode 
  141.       *
  142.       * @return boolean; 
  143.       *
  144.       * @since pk-05-08-02
  145.       *
  146.       ***/
  147.     function globalArrIsToCheck($mode,$debug) {
  148.         if ($debug) echo "<p><b>DBMS_FIELD_STATUS_CONFARR_SELECT::globalArrIsToCheck($mode)</b> (".get_class($this).")</p>\n";
  149.         switch($mode) {
  150.             case FRM_MODE_NEW:
  151.             case FRM_MODE_EDIT:
  152.             case FRM_MODE_HIDDEN:
  153.                 return TRUE;            // input fields -> we need to check
  154.             case FRM_MODE_LIST:
  155.             case FRM_MODE_READONLY:
  156.                 return FALSE;           // no need to check for readonly modes
  157.             default:
  158.                 if ($debug) echo "<p>UNKNOWN MODE: $mode</p>";
  159.                 return TRUE;
  160.         }
  161.     }
  162.  
  163.     /**
  164.       * returns if the user is member of the grpKey groups
  165.       *
  166.       * @param array $globalValArr the subarray in the global array
  167.       * @param boolean $debug 
  168.       *
  169.       * @return boolean 
  170.       *
  171.       * @since pk-05-08-02
  172.       * @version pk-06-07-24
  173.       *
  174.       ***/
  175.     function check_globalArrGroup($globalValArr,$debug=FALSE) {
  176.         if ($debug) echo "<p><b>DBMS_FIELD_STATUS_CONFARR_SELECT::check_globalArrGroup(...)</b> (".get_class($this).")</p>";
  177.  
  178.         if (empty($this->grpKey)) return TRUE; // group net set -> no check
  179.  
  180.         if (!isset($globalValArr[$this->grpKey])) {
  181.             // we do not have a group key in the array => return TRUE
  182.             return TRUE;
  183.         }
  184.  
  185.         if (is_array($globalValArr[$this->grpKey])) {
  186.             // we have an array of groups which are allowed
  187.             foreach($globalValArr[$this->grpKey] as $i_GrpId) {
  188.                 if ($GLOBALS['USER']->isGroupMember($i_GrpId)) return TRUE; // user is member
  189.             }
  190.             // still here -> no group found
  191.             return FALSE;
  192.         } else {
  193.             // we have a single value
  194.             // use intval to have public (0) if no group is set
  195.             return $GLOBALS['USER']->isGroupMember(intval($globalValArr[$this->grpKey]));
  196.         }
  197.     }
  198.  
  199.     /**
  200.       * returns if the global array $arrName as the required value
  201.       *
  202.       * @param array $globalValArr 
  203.       * @param string $arrName 
  204.       * @param boolean $debug 
  205.       *
  206.       * @return boolean 
  207.       *
  208.       * @since pk-05-08-02
  209.       * @version pk-06-07-24
  210.       *
  211.       ***/
  212.     function check_globalArrReqValue($globalValArr,$arrName="DBVAL",$debug=FALSE) {
  213.         if ($debug) echo "<p><b>DBMS_FIELD_STATUS_CONFARR_SELECT::check_globalArrReqValue(...)</b> (".get_class($this).")</p>";
  214.  
  215.         if (empty($this->requireValueKey)) return TRUE; // no requireValueKey set -> no check
  216.  
  217.         if (!isset($globalValArr[$this->requireValueKey])) { // <pk-06-07-24>
  218.             // we do not have a require value key in the array => return TRUE
  219.             return TRUE;
  220.         }
  221.  
  222.         global ${$arrName};
  223.  
  224.         if ($debug) echo "<p>Global Array (\$".$arrName."):</p><pre>".print_r(${$arrName}[$this->myName])."</pre>";
  225.         if (is_array($globalValArr[$this->requireValueKey])) {
  226.             foreach($globalValArr[$this->requireValueKey] as $chkVal) {
  227.                 if ($chkVal==${$arrName}[$this->myName]) return TRUE;   // value found
  228.             }
  229.             // still here -> value not found
  230.             return FALSE;
  231.         } else if (!empty($globalValArr[$this->requireValueKey])) {
  232.             if ($globalValArr[$this->requireValueKey]==${$arrName}[$this->myName]) return TRUE;
  233.             else return FALSE;
  234.         } else {
  235.             return TRUE;
  236.         }
  237.     }
  238.  
  239.     /**
  240.       * returns an array of allowed values
  241.       *
  242.       * if mode is FRM_MODE_EDIT, FRM_MODE_NEW or FRM_MODE_HIDDEN
  243.       * for eache array ellement is checkt if
  244.       * the curent user ($GLOBALS['USER'])
  245.       * is member of the group (ID specified by
  246.       * $this::grpKey)
  247.       *
  248.       * @example config include file
  249.       *
  250.       *  Setting fixed Number:
  251.       *  <code>
  252.       *      $GLOBALS['CMS']['PAGESTATE'][0]=array(
  253.       *          ...
  254.       *          'GROUP'=>0):
  255.       *  </code>
  256.       *
  257.       *  Setting to a variable (note the value when the conf file is included is checked
  258.       *  <code>
  259.       *      $GLOBALS['CMS']['PAGESTATE'][1]=array(
  260.       *          ...
  261.       *          'GROUP'=>$GLOBALS['GROUPS']['CMSAUTHOR']);
  262.       *  </code>
  263.       *
  264.       *  you can also reference to a global var
  265.       *  <code>
  266.       *      $GLOBALS['CMS']['PAGESTATE'][1]=array(
  267.       *          ...
  268.       *          'GROUP'=><b>&</b>$GLOBALS['GROUPS']['AKT_PROJADMIN']
  269.       *  </code>
  270.       *
  271.       *  or simply set to an array
  272.       *  <code>
  273.       *      $GLOBALS['CMS']['PAGESTATE'][1]=array(
  274.       *          ...
  275.       *          'GROUP'=>array(1,2));
  276.       *  </code>
  277.       *
  278.       * @param string $arrName 
  279.       * @param bool $debug 
  280.       * @parma int $mode
  281.       *
  282.       * @return array 
  283.       *
  284.       * @version pk-05-08-03
  285.       *
  286.       * @var array $a_globalArr 
  287.       * @var mixed $key 
  288.       * @var array $a_globalValArr 
  289.       * @var boolean $b_SetValue 
  290.       *
  291.       ***/
  292.     function setMyValues($arrName="DBVAL",$debug=FALSE,$mode=FRM_MODE_EDIT) {
  293.         $debug=($debug || $this->fldDebug);
  294.         if ($debug) echoDebugMethod(__FILE__,get_class($this),"DBMS_FIELD_STATUS_CONFARR_SELECT::setMyValues()");
  295.  
  296.         global ${$arrName}; // <pk-05-08-03 />
  297.         
  298.         $this->allowNull = False; // to have the first state selected if no value is submitted    
  299.         $this->myValues     = array();
  300.         
  301.         switch(True)  // <pk-08-12-18>
  302.         {
  303.             case strstr($this->arrName,"CHAPTERSTATE"):
  304.                 pcf_require_class('CMS_CHAPTER_STATE',"cms/chapter/");
  305.                 $arr_states = CMS_CHAPTER_STATE::getAllStates();
  306.                 foreach($arr_states as &$obj_state)
  307.                 {
  308.                     if ($obj_state->curUserIsInGroup(intval(${$arrName}['PROJ_ID'])))
  309.                     {
  310.                            $this->myValues[$obj_state->getId()] = $obj_state->getName();
  311.                        }
  312.                 }
  313.                 break;
  314.             default:
  315.                 if ((!empty($this->subKey)) && ($a_globalArr=$this->getGlobalValArr($debug)) && (is_array($a_globalArr))) {
  316.                     $this->myValues=array(); // <pk-06-10-04 />
  317.                     foreach($a_globalArr as $key => $a_globalValArr) {
  318.                         if ($debug) echo "<p>Checking: ".$a_globalValArr[$this->subKey]." ($key)</p><blockquote>";
  319.                         if (is_array($a_globalValArr)) {
  320.                             $b_SetValue=FALSE;
  321.                             if (isset(${$arrName}[$this->myName]) && (${$arrName}[$this->myName] == $key)) { // <pk-05-08-03 />
  322.                                 // no need to check as we already have this state
  323.                                 $b_SetValue=TRUE;
  324.                             } else if ($this->globalArrIsToCheck($mode,$debug)) {
  325.                                 if ($this->check_globalArrReqValue($a_globalValArr,$arrName,$debug)) {
  326.                                     if ($this->check_globalArrGroup($a_globalValArr,$debug)) {
  327.                                         $b_SetValue=TRUE;
  328.                                     }
  329.                                 }
  330.                             } else {
  331.                                 $b_SetValue=TRUE;
  332.                             }
  333.         
  334.                             if ($b_SetValue) {
  335.                                 if ($debug) echo "<p>Setting Value: ".$a_globalValArr[$this->subKey]." ($key)</p>";
  336.                                 if (($mode==FRM_MODE_LIST) && (!empty($a_globalValArr[$this->iconKey]))) {
  337.                                     if ($debug) {echo "<blockquote>ICON SET<pre>$key ".$this->iconKey."\n";print_r($a_globalValArr);echo "</pre><p>".$a_globalValArr[$this->iconKey]."</blockquote>";}
  338.                                     $this->myValues[$key]="<img src=\"".$a_globalValArr[$this->iconKey]."\" border=\"0\" align=\"middle\" alt=\"".$a_globalValArr[$this->subKey]."\">";
  339.                                 } else {
  340.                                     if (!empty($a_globalValArr[$this->subKey])) {
  341.                                         $this->myValues[$key]=$a_globalValArr[$this->subKey];
  342.                                     } else {
  343.                                         $this->myValues[$key]=$key;
  344.                                     }
  345.                                 }
  346.                             }
  347.                         }
  348.                         if ($debug) echo "</blockquote>";
  349.                     }
  350.                     if ($debug) echo "<blockquote>myValues:<pre>".print_r($this->myValues,TRUE)."</pre><hr /></blockquote>";
  351.                 } else {
  352.                     if ($debug) echo "<p>subKey NOT SET </p>";
  353.                 }
  354.           }            
  355.     }
  356.  
  357.     /**
  358.       * returns a string with the options
  359.       * if
  360.       *
  361.       * calls setMyValues to be sure $this->myValues is set correkt
  362.       *
  363.       * @param array $aValArr   array of selected values
  364.       * @param bool $addNULL    add the null option (for search)
  365.       * @param bool $debug 
  366.       *
  367.       * @return string 
  368.       *
  369.       * @since pk-05-02-17
  370.       *
  371.       ***/
  372.     function getOptionList($aValArr,$addNULL=FALSE,$debug=FALSE) {
  373.        $debug=($debug || $this->fldDebug);
  374.         if ($debug) {
  375.             echo "<p><b>DBMS_FIELD_STATUS_CONFARR_SELECT::getOptionList(\$aValArr,$addNULL,...)</b> (".get_class($this)."/".$this->myName.")</p>";
  376.             echo "<blockquote><p>\$aValArr</p><pre>".print_r($aValArr,TRUE)."</pre></blockquote>";
  377.         }
  378.         $this->setMyValues($this->myDataArrName,$debug);
  379.         $ret="";
  380.  
  381.         if ($addNULL) {
  382.             $ret.="\t<option value=\"\">".$this->nullLabel."</option>\n";
  383.         }
  384.         if ($debug) echo "<pre>".print_r($this->myValues,TRUE)."</pre>";
  385.         if (is_array($this->myValues)) {
  386.             reset($this->myValues);
  387.             while(list($key,$val)=each($this->myValues)) {
  388.                 $ret.="\t<option value=\"$key\"";
  389.                 if ((!empty($key)) && in_array($key,$aValArr)) {
  390.                     $ret .= " selected";
  391.                     unset($aValArr[$key]);
  392.                 }
  393.                 $ret.=">$val</option>\n";
  394.             }
  395.         }
  396.         if ($this->notInLstValues) {
  397.             foreach($aValArr as $s_value) {
  398.                 if (!empty($s_value)) $ret.="<option value=\"$s_value\" selected>$s_value</option>\n";
  399.             }
  400.         }
  401.         return $ret;
  402.     }
  403.  
  404.     /**
  405.       *
  406.       * returns the html code for the readonly field
  407.       *
  408.       * @param mixed $aValue 
  409.       * @param string $arrName 
  410.       * @param boolean $debug 
  411.       *
  412.       * @returns string
  413.       *
  414.       * @version pk-04-09-08
  415.       * @version pk-05-08-02 bugifx
  416.       *
  417.       ***/
  418.     function getScreenValue($aValue,$arrName="DBVAL",$debug=FALSE) {
  419.         $debug=($debug || $this->fldDebug);
  420.         if ($debug) echo "<hr /><p><b>DBMS_FIELD_STATUS_CONFARR_SELECT::getScreenValue($aValue,$arrName,...)</b></p>";
  421.  
  422.         $this->setMyValues($arrName,$debug,FRM_MODE_READONLY);
  423.         return parent::getScreenValue($aValue,$arrName,$debug); // <pk-05-08-02 />
  424.     }
  425.  
  426.     /**
  427.       * returns a html select with all values (distinct) where $aValue
  428.       * is selected
  429.       *
  430.       * NOTE only works on database fields
  431.       *
  432.       * @param mixed $aValue 
  433.       * @param string $arrName 
  434.       * @param string $selTagAdd added into <select ...>
  435.       * @param string $whereCond added to query ($s_query="SELECT ... FROM TABLE ".$whereCond)
  436.       *
  437.       * @return string 
  438.       *
  439.       * @since pk-05-10-20
  440.       *
  441.       * @todo object value tables
  442.       *
  443.       * @var $a_globalValArr 
  444.       ***/
  445.     function getTableValSelect(&$aValue,$arrName="",$selTagAdd="",$whereCond="",$nullLabel="",$debug=FALSE) {
  446.         $debug=($debug || $this->fldDebug);
  447.         if ($debug) echo "<p><b>DBMS_FIELD::getTableValSelect(aValue=".$aValue.",arrName=".$arrName.")</b> (".get_class($this).")</p>\n";
  448.  
  449.         if ((!empty($this->subKey)) && ($a_globalArr=$this->getGlobalValArr($debug)) && (is_array($a_globalArr))) {
  450.             if (!empty($arrName)) {
  451.                 $s_selName=$arrName."[".$this->myName."]";
  452.             } else {
  453.                 $s_selName=$this->myName;
  454.             }
  455.             $ret="\n<select name=\"".$s_selName."\" ".$selTagAdd.">\n";
  456.             if (!empty($nullLabel)) {
  457.                 $ret.="\t<option value=\"\">".$nullLabel."</option>\n";
  458.             } else if ($this->searchGroup_allowAll) {
  459.                 $ret.="\t<option value=\"\">--- ??? ---</option>\n";
  460.             }
  461.             foreach($a_globalArr as $key => $a_globalValArr) {
  462.                 $s_query ="SELECT COUNT(*) FROM ".$this->myTable;
  463.                 if (!empty($whereCond)) {
  464.                     $s_query.=$whereCond;
  465.                     $s_query.=" AND ".$this->myName."=".$GLOBALS['USRDB']->qs_getSlashedValue($key);
  466.                 } else {
  467.                     $s_query.=" WHERE ".$this->myName."=".$GLOBALS['USRDB']->qs_getSlashedValue($key);
  468.                 }
  469.                 if ($debug) echo "<p>".$s_query."</p>";
  470.                 if ($i_nofEntries=intval($GLOBALS['USRDB']->quickQuery($s_query,0))) {
  471.                     $ret.= "\t<option value=\"".$key."\"";
  472.                     if ((empty($nullLabel)) && (!$this->searchGroup_allowAll) && (empty($aValue))) {
  473.                         // no null Label -> we have to set the $aValue called by ref
  474.                         $aValue=$key;
  475.                     }
  476.                     if (strval($aValue)===(strval($key))) {
  477.                         if ($debug) echo " <b>SELECTED</b>";
  478.                         $ret.= " selected";
  479.                     }
  480.  
  481.                     if (!empty($a_globalValArr[$this->subKey])) {
  482.                         $ret.=">".$a_globalValArr[$this->subKey]."</option>";
  483.                     } else {
  484.                         $ret.=">".$key."</option>";
  485.                     }
  486.                 }
  487.             }
  488.             $ret.="\n</select>";
  489.         }
  490.  
  491.         return $ret;
  492.     }
  493.  
  494.  
  495. } // end class DBMS_FIELD_GLOBALARRSELECTLIST
  496. ?>

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