File Source for DBMS_FIELD_PAGESELECT.phpclass

<?php
/**
* Class file DBMS_FIELD_PAGESELECT.phpclass
*
* @project Open CSP-Management
* @package dbms_field
* @category int
*
* @author Peter Krebs (pk)<pitlinz@users.sourceforge.net>
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
*
* @version pk-03-10-19
* @version pk-05-02-19
* @version $Id: DBMS_FIELD_PAGESELECT.phpclass,v 1.6 2008/08/12 08:22:38 pitlinz Exp $
*/
// --------------------------------------------------------
// requirements
// --------------------------------------------------------
pcf_require_class("DBMS_FIELD_FOREIGNKEY",dirname(__FILE__) . "/");
pcf_require_class("CMS_PROJECT","cms/");
pcf_require_class("CMS_MENU_NODE","cms/menu/");
pcf_require_class("CMS_PAGE","cms/page/");
/**
* handels fields which are foreign keys to a page
*
* shows a select box to select pages
*
* @project Open CSP-Management
* @package dbms_field
* @category int
*
* @author Peter Krebs (pk)<pitlinz@users.sourceforge.net>
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
*
* @version pk-03-10-19
* @version pk-05-02-19
* @version $Id: DBMS_FIELD_PAGESELECT.phpclass,v 1.6 2008/08/12 08:22:38 pitlinz Exp $
*
*/
class DBMS_FIELD_PAGESELECT extends DBMS_FIELD_FOREIGNKEY
{
// ---------------------------------------------------------------------------
// constants
// ---------------------------------------------------------------------------
/**
* @constant string CLASS_SRC_FILE
*/
const CLASS_SRC_FILE = __FILE__;
// ---------------------------------------------------------------------------
// class (static)
// ---------------------------------------------------------------------------
/*** class vars ------------------------------------------------------ */
/**
* @staticvar array $ps_sprojSelectModes PRIVATE project select modes
***/
protected static $ps_sprojSelectModes=array(
'1' => array(
'LABEL' => "NUR IM PROJEKT (\${\$arrName})",
'WITHPROJ' => FALSE
),
'2' => array(
'LABEL' => "NUR GET PROJEKT (\$_GET['PROJ_ID'])",
'WITHPROJ' => FALSE
),
'3' => array(
'LABEL' => "ALLE PROJEKTE",
'WITHPROJ' => TRUE
)
);
/*** class methods --------------------------------------------------- */
// ---------------------------------------------------------------------------
// object vars
// ---------------------------------------------------------------------------
/*** compostion --------------------------------------------------- */
/**
* the current selected page
*
* @var CMS_PAGE
*/
protected $mySelectedPage = Null;
/*** attributes --------------------------------------------------- */
/**
* source file of the class
*
* @var string $classSrcFile
* @since pk-05-01-11
***/
protected $classSrcFile=__FILE__;
/**
* @staticvar string $lookupTable
***/
protected $lookupTable = "T_CMS_PAGE p LEFT OUTER JOIN T_CMS_MENU m USING(MEN_ID)";
/**
* @staticvar string $$lookupShowField
***/
protected $lookupShowField = "CONCAT(IFNULL(PAG_TITLE,'NO TITLE'),' (',PAG_ID,')')";
/**
* @staticvar string $lookupField
***/
protected $lookupField = "PAG_ID";
/**
* @staticvar string $lookupSort
***/
protected $lookupSort = "PAG_SORTORDER";
/**
* @staticvar string $nullLabel
***/
protected $nullLabel = "STARTPAGE";
/**
* @staticvar string $whereAnd
***/
protected $whereAnd = "";
/**
* @var int $myProjSelectMode add the project to the select list
***/
protected $myProjSelectMode = 1;
/**
* @var bool $showExpired show expired pages
***/
protected $showExpiredPages = FALSE;
/**
* @var boolean $showSysDefault
* @since pk-05-09-05
***/
protected $showSysDefault=TRUE;
// ---------------------------------------------------------------------------
// factory / construct
// ---------------------------------------------------------------------------
// ---------------------------------------------------------------------------
// init
// ---------------------------------------------------------------------------
// ---------------------------------------------------------------------------
// getter/setter
// ---------------------------------------------------------------------------
/**
* returns the DOM id of the menu select
*
* @return string
*/
public function getMenuSelectId()
{
return "MENSEL_" . $this->getDOMId();
}
// ---------------------------------------------------------------------------
// dbms admin backoffice
// ---------------------------------------------------------------------------
/**
* returns an array of field to bie shown in the edit form
* by using editTbl_echoForm
*
* the array is in the form:
*
* <code>
* [_sectionName_]
* [TITLE] -> string
* [_rowName_]
* [FLDLAB] (complete html code with <td></td>)
* [FLDVAL] (complete html code with <td></td>)
* </code>
*
* @param boolean $debug
*
* @returns array
*
* @since pk-07-01-07
*
* @version pk-07-02-16
* @version pk-08-08-11
*
*/
function editTbl_getFieldEditArr($debug=FALSE) {
if ($debug) echoDebugMethod(__FILE__,get_class($this),"DBMS_FIELD_PAGESELECT::editTbl_getFieldEditArr","",0);
// <pk-07-02-16> set some default values
if (empty($this->nullLabel)) $this->nullLabel= "STARTPAGE";
$a_ret=parent::editTbl_getFieldEditArr($debug);
$this->whereAnd=str_replace("m.MEN_ID=p.MEN_ID","",$this->whereAnd); // remove old values eventually stored in the db
unset($a_ret['SELECT']['FLD_MULTISEL']);
$a_ret['DBLOOKUP']['FLD_LUTBL']['FLDVAL']=$this->lookupTable;
$a_ret['DBLOOKUP']['FLD_VALFLD']['FLDVAL']=$this->lookupField;
$a_ret['DBLOOKUP']['FLD_SHOWLSTSORT']['FLDVAL']="ORDER BY m.MEN_ID, PAG_SORTORDER,<input name=\"sortAdd\" value=\"".htmlspecialchars($this->sortAdd)."\" size=\"40\">";
unset($a_ret['DBLOOKUP']['PARENTFIELD']);
unset($a_ret['DBLOOKUP']['IDENTFIELD']);
$a_ret['DBLOOKUP']['FLD_PROJECTSEL']['FLDLAB']="Projektanzeige: ";
$a_ret['DBLOOKUP']['FLD_PROJECTSEL']['FLDVAL']="<select name=\"myProjSelectMode\" size=\"1\">\n";
foreach(self::$ps_sprojSelectModes as $key => $val) {
$a_ret['DBLOOKUP']['FLD_PROJECTSEL']['FLDVAL'].="\t<option value=\"$key\"";
if ($key == $this->myProjSelectMode) $a_ret['DBLOOKUP']['FLD_PROJECTSEL']['FLDVAL'].="selected ";
$a_ret['DBLOOKUP']['FLD_PROJECTSEL']['FLDVAL'].=">".t_admin($val['LABEL'])."</option>\n";
}
$a_ret['DBLOOKUP']['FLD_PROJECTSEL']['FLDVAL'].="</select>\n";
$a_ret['DBLOOKUP']['FLD_OUTDATEDPAGES']=array(
'FLDLAB'=>"Abgelaufene Seiten:",
'FLDVAL'=>"<input type=\"checkbox\" name=\"showExpiredPages\" value=\"1\" ".(($this->showExpiredPages) ? "checked" : "")." >Seiten mit Anzeigen bis < jetzt nicht anzeigen"
);
unset($a_ret['FTBL_POPUPS']);
return $a_ret;
}
/**
* save the filed definition form
*
* @return bool <code>parent::save()</code>
*
* @version pk-03-10-22
* @version pk-07-02-16 allow set of some values
*
***/
function save()
{
$ret = parent::save();
$this->lookupTable = "T_CMS_PAGE";
$this->lookupShowField = "CONCAT(IFNULL(PAG_TITLE,'NO TITLE'),' (',PAG_ID,')')";
$this->lookupField = "PAG_ID";
if (!empty($this->sortAdd)) $this->lookupSort.=",".$this->sortAdd;
/* <pk-03-10-19> */
$this->myProjSelectMode = intval($_POST['myProjSelectMode']);
$this->showExpiredPages = ((isset($_POST['showExpiredPages']) && intval($_POST['showExpiredPages'])) ? TRUE : FALSE );
$this->showSysDefault = ((isset($_POST['showSysDefault']) && intval($_POST['showSysDefault'])) ? TRUE: FALSE);
/* </pk-03-10-19> */
$this->allowNullSelect = $this->allowNull; /* <pk-03-10-22 /> */
return $ret;
}
// -------------------------------------------------
// field value methods
// -------------------------------------------------
/**
* returns the field value
*
* @param string $aValue the value
* @param array $err error array
* @param string $arrName global data array name used for global ${$arrName}
* @param bool $debug
*
* @return string
*
* @since pk-03-12-13
* @version pk-03-12-13
* @version pk-08-08-11
*
* @requires CMS_PAGE
*/
function getValue($aValue,&$err,$arrName="DBVAL",$debug=FALSE) {
if ($debug) echoDebugMethod(__FILE__,get_class($this),"DBMS_FIELD_PAGESELECT::getValue($aValue) [".$this->getKey()."])");
if (intval($aValue))
{
if ($this->mySelectedPage = CMS_PAGE::getInstance(intval($aValue)))
{
if (!$this->showExpiredPages)
{
if ($this->mySelectedPage->isExpired())
{
if ($debug) echoDebugLine(__FILE__,__LINE__,"Page is expired");
$err['ERROR']=True;
$err[$this->myName]['MSG']=t_admin("Die Seite ist nicht mehr verfügbar");
$err[$this->myName]['LABEL']=$this->label;
return False;
}
}
return $this->mySelectedPage->getId();
}
}
if ($this->allowNullSelect) {
$ret="0";
} else {
$err['ERROR']=True;
$err[$this->myName]['MSG']=(empty($this->nullErrMsg) ? $this->label.": NULL_NOT_ALLOWED" : $this->nullErrMsg);;
$err[$this->myName]['LABEL']=$this->label;
return False;
}
}
// -------------------------------------------------
// html rendering methods
// -------------------------------------------------
/**
* returns one page option
*
* @param int $aValue
* @param CMS_PAGE $pagObj
* @param boolean $debug
*
* @return string (html)
*/
protected function getPageOption($aValue,$pagObj,$debug)
{
$str_ret = "<option value=\"" . $pagObj->getId() . "\"";
if ($pagObj->getId() == intval($aValue))
{
$str_ret .= " selected=\"selected\"";
}
$str_ret .= ">";
$str_ret .= $pagObj->getTitle() . " (" . $pagObj->getId() . ")";
$str_ret .= "</option>";
return $str_ret;
}
/**
* returns the page option list for a menu node
*
* @param CMS_MENU $menObj
* @param boolean $debug
*
* @return string (html)
*
*/
protected function addPageOptList($aValue,$menObj,$debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"DBMS_FIELD_PAGESELECT::addPageObtList()");
$str_ret = "";
if (method_exists($menObj,'getPageList'))
{
if ($menObj->getId())
{
$str_ret .= "<optgroup label=\"M: " . $menObj->getTitle() . "\">";
}
if ($arr_pages = $menObj->getPageList(False,False,$debug))
{
foreach($arr_pages as $obj_page)
{
if (!$this->showExpiredPages)
{
$str_ret .= $this->getPageOption($aValue,$obj_page,$debug);
} else if ($obj_page->getId() == intval($aValue)) {
$str_ret .= $this->getPageOption($aValue,$obj_page,$debug);
} else if (!$obj_page->isExpired()){
$str_ret .= $this->getPageOption($aValue,$obj_page,$debug);
}
}
}
if ($arr_children = $menObj->getChildrenList())
{
foreach($arr_children as $obj_node)
{
$str_ret .= $this->addPageOptList($aValue,$obj_node,$debug);
}
}
if ($menObj->getId())
{
$str_ret .= "</optgroup>";
}
}
return $str_ret;
}
/**
* returns the html code for the <select&gt field
*
* @param mixed $aValue
* @param boolean $debug
*/
protected function getFormFieldSelect($aValue,$debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"DBMS_FIELD_PAGESELECT::getFormFieldSelect");
$arr_attributes = $this->getFormFieldSelectAttributes($debug);
if ($debug) echoDebugMethod(__FILE__,get_class($this),"DBMS_FIELD_PAGESELECT::getMenuSelect()");
switch($this->myProjSelectMode)
{
case 1:
global ${$this->myDataArrName};
$arr_proj = array(CMS_PROJECT::getInstance(intval(${$this->myDataArrName}['PROJ_ID'])));
break;
case 2:
if (isset($_POST['PROJ_ID']) && intval($_POST['PROJ_ID']))
{
$arr_proj = array(CMS_PROJECT::getInstance(intval($_POST['PROJ_ID'])));
} else if (isset($_GET['PROJ_ID']) && intval($_GET['PROJ_ID'])) {
$arr_proj = array(CMS_PROJECT::getInstance(intval($_GET['PROJ_ID'])));
} else {
$arr_proj = array(CMS_PROJECT::factoryFromId(0,True));
}
break;
case 3:
$arr_projRows = OCSP_OBJ::defaultReadDBObj()->getArray('T_CMS_PROJECT',array(),0,0,'PROJ_SORTORDER');
$arr_proj = array();
if (is_array($arr_projRows))
{
foreach($arr_projRows as $arr_row)
{
if (!CMS_PROJECT::isInstanced(intval($arr_row['PROJ_ID'])))
{
CMS_PROJECT::setInstance(CMS_PROJECT::factoryFromDBRow($arr_row,$debug),$debug);
}
$arr_proj[] = CMS_PROJECT::getInstance(intval($arr_row['PROJ_ID']));
}
}
break;
}
$str_tag = "<select name=\"" . $this->getInputName() ."\" id=\"" . $this->getDOMId() . "\"";
if (is_array($arr_attributes))
{
foreach($arr_attributes as $str_att => $str_val)
{
$str_tag .= " " . $str_att . "=" . $str_val;
}
}
$str_tag .= ">";
foreach($arr_proj as &$obj_proj)
{
//$debug=True;
if ($debug) echoDebugLine(__FILE__,__LINE__,"<pre>" . print_r($obj_proj->getDBVal(),True) . "</pre>");
if (self::$ps_sprojSelectModes[$this->myProjSelectMode]['WITHPROJ'])
{
$str_tag .= "<optgroup label=\"" . t_admin('Projekt') . ": " . $obj_proj->getName() ."\" title=\"" . $obj_proj->getTitle() . " Id: " . $obj_proj->getId() . "\">";
}
if ($obj_tree = $obj_proj->getMenuTree(True,$debug))
{
$obj_rootNode = $obj_tree->getNode(0,True);
$obj_rootNode->setMyProject($obj_proj);
$str_tag .= $this->addPageOptList($aValue,$obj_rootNode,$debug);
}
if (self::$ps_sprojSelectModes[$this->myProjSelectMode]['WITHPROJ'])
{
$str_tag .= "</optgroup>";
}
}
return $str_tag;
}
} // end of DMBS_FIELD_PAGESELECT
?>

Source for file DBMS_FIELD_PAGESELECT.phpclass