File Source for CMS_PAGE.phpclass

<?php
/**
* openCSP class file
*
* @project Open CSP-Management
* @package cms
*
* @author Peter Krebs <pitlinz@users.sourceforge.net>
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
*
* @since pk-16.06.2008
* @version $Id: CMS_PAGE.phpclass,v 1.25 2008/12/17 16:28:51 peterkrebs Exp $
*/
// ---------------------------------------------------------
// requirements
// ---------------------------------------------------------
pcf_require_interface('INFA_CMS_PAGE',dirname(__FILE__) . "/INFA_CMS_PAGE.phpclass");
pcf_require_class('CMS_TABLEOBJ',__OCSP_PHPINCPATH__ . "cms/CMS_TABLEOBJ.phpclass");
pcf_require_class('CMS_PAGE_TEMPLATE',__OCSP_PHPINCPATH__ . "cms/template/page/CMS_PAGE_TEMPLATE.phpclass");
/**
* openCSP class file
*
* @project Open CSP-Management
* @package cms
*
* @author Peter Krebs <pitlinz@users.sourceforge.net>
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
*
* @since pk-16.06.2008
* @version $Id: CMS_PAGE.phpclass,v 1.25 2008/12/17 16:28:51 peterkrebs Exp $
*/
class CMS_PAGE extends CMS_TABLEOBJ implements INFA_CMS_PAGE
{
// ---------------------------------------------------------------------------
// constants
// ---------------------------------------------------------------------------
/**
* @constant string CLASS_SRC_FILE
*
* @abstract
*/
const CLASS_SRC_FILE = __FILE__;
// ---------------------------------------------------------------------------
// class (static)
// ---------------------------------------------------------------------------
/*** class vars ------------------------------------------------------ */
/**
* array of loaded pages can be used as unit of work
* together with the getInstanceXxxx functions
*
* @staticvar array $loadedPages
*
* @since pk-08-08-08
*/
protected static $loadedPages = array();
/*** class methods --------------------------------------------------- */
/**
* requires the class source file for $str_class
*
* @param string $str_class
* @param boolean $debug
*
* @return string
*
* @version pk-08-03-31
*/
public static function requirePageClass($str_class,$debug=False)
{
if ($debug) echoDebugMethod(__FILE__,"static","CMS_PAGE::requirePageClass({$str_class});");
if (class_exists($str_class))
{
return $str_class;
}
if (!CMS_TABLEOBJ::pageType_requireClass($str_class))
{
if (file_exists(dirname(__FILE__) . _OCSP_DIRSEP_ . $str_class . ".phpclass"))
{
require_once dirname(__FILE__) . _OCSP_DIRSEP_ . $str_class . ".phpclass";
} else {
throw new Exception(_OCSP_EXCEP_CLASSNOTFOUND_ . ":" . $str_class);
}
}
if (!class_exists($str_class))
{
throw new Exception(_OCSP_EXCEP_CLASSNOTFOUND_ . ":" . $str_class);
}
return $str_class;
}
// ------ unit of work -----
/**
* returns an unit of work instance
*
* @param int $aId
* @param boolean $debug
*
* @return CMS_PAGE
*/
public static function &getInstance($aId,$debug=False)
{
if ($debug) echoDebugMethod(__FILE__,"static","CMS_PAGE::getInstance({$aId})");
if (!isset(self::$loadedPages[intval($aId)]) || !(self::$loadedPages[intval($aId)]))
{
self::$loadedPages[intval($aId)] = self::factoryFromId($aId,False,$debug);
}
return self::$loadedPages[intval($aId)];
}
/**
* sets an unit of work instance
*
* @param int $aId
* @param CMS_PAGE $aPage
* @param boolean $debug
*
*/
public static function setInstance(&$aPage,$debug=False)
{
if (method_exists($aPage,'getId'))
{
self::$loadedPages[$aPage->getId()]=$aPage;
}
}
/**
* returns if a page is instanciated
*
* @param int $aId
*
* @return boolean
*/
public static function isInstanced($aId)
{
return (isset(self::$loadedPages[intval($aId)]) && (self::$loadedPages[intval($aId)]));
}
// ---------------------------------------------------------------------------
// object vars
// ---------------------------------------------------------------------------
/*** compostion --------------------------------------------------- */
/**
* @var CMS_PAGE_TEMPLATE $myTemplate
*/
protected $myTemplate = Null;
/**
* @var CMS_HTML_PAGE $myHTMLPage
* @access protected
*/
protected $myHTMLPage = Null;
/**
* sorted array of chpater
*
* myChapterList[CHA_SHOWMODE][CHA_SORTORDER] = CMS_CHAPTER
*
* @var array of chapters
*/
protected $myChapterList = array();
/*** attributes -------------------------------------------------- */
/**
* @var string $myTable name of the table holding the data
*/
protected $myTable = "T_CMS_PAGE";
/**
* Id of the template to use if PTMP_ID is not used
* @var int $myTemplateId
*/
protected $myTemplateId = 0;
/**
* did we get the contents?
*
* if no OCSP_CMS_HTMLPAGE will set Templatevar PAGECONTENT
* @var boolean $contentWasCalled
*/
protected $contentWasCalled = False;
/**
* timestamp the myChapterList has been populated
*
* @var double $chapterListPopulated
*/
protected $chapterListPopulated = 0;
// ---------------------------------------------------------------------------
// factory / construct
// ---------------------------------------------------------------------------
/**
* factory a new page object form $_GET
*
* @param boolean $force (always return a page object even if no id is set)
* @param boolean $debug
*
* @return CMS_PAGE
*/
public static function factoryFromQueryString($force=false,$debug=false)
{
if ($debug) echoDebugMethod(__FILE__,'(static)','CMS_PAGE::factoryFromQueryString()');
if (isset($_GET[CMS_TABLEOBJ::getPageIdGetName()]) && intval($_GET[CMS_TABLEOBJ::getPageIdGetName()]))
{
return self::factoryFromId(intval($_GET[CMS_TABLEOBJ::getPageIdGetName()]),$force,$debug);
} else if ((isset($_GET[CMS_TABLEOBJ::getPageIdColName()]) && intval($_GET[CMS_TABLEOBJ::getPageIdColName()]))) {
return self::factoryFromId(intval($_GET[CMS_TABLEOBJ::getPageIdColName()]),$force,$debug);
}
$int_projId = (isset($_GET[CMS_TABLEOBJ::getProjIdGetName()]) ? intval($_GET[CMS_TABLEOBJ::getProjIdGetName()]) : (isset($_GET[CMS_TABLEOBJ::getProjIdColName()]) ? intval($_GET[CMS_TABLEOBJ::getProjIdColName()]) : 0));
$int_menId = (isset($_GET[CMS_TABLEOBJ::getMenuIdGetName()]) ? intval($_GET[CMS_TABLEOBJ::getMenuIdGetName()]) : (isset($_GET[CMS_TABLEOBJ::getMenuIdColName()]) ? intval($_GET[CMS_TABLEOBJ::getMenuIdColName()]) : 0));
$obj_db = OCSP_OBJ::defaultReadDBObj();
$arr_filter = array(
CMS_TABLEOBJ::getProjIdColName() => $int_projId,
CMS_TABLEOBJ::getMenuIdColName() => $int_menId
);
if ($arr_pages = $obj_db->getArray(CMS_TABLEOBJ::getPageTable(),$arr_filter,0,0,CMS_TABLEOBJ::getPageSortColName(),$debug))
{
if ($debug) echoDebugLine(__FILE__,__LINE__,"Pages: <pre>" . print_r($arr_pages,True) . "</pre>");
if ((sizeof($arr_pages) == 1) || $force)
{
return CMS_PAGE::factoryFromDBRow($arr_pages[0],$debug);
}
}
if ($force)
{
$obj_ret = new CMS_PAGE();
$obj_ret->setProjId($int_projId);
$obj_ret->setMenId($int_menId);
} else {
return NULL;
}
}
/**
* factory a page object from an id
*
* @param int $aId
* @param boolean $force (always return a page object eaven if not found)
* @param boolean $debug
*
* @return CMS_PAGE | Null
*
*/
public static function factoryFromId($aId,$force=false,$debug=false)
{
if ($debug) echoDebugMethod(__FILE__,'(static)',"CMS_PAGE::factoryFromId();");
if (intval($aId))
{
if ($arr_row = OCSP_CMS_CACHE::getInstance()->getPageRow($aId))
{
if ($debug) echoDebugLine(__FILE__,__LINE__,"using cached value");
return self::factoryFromDBRow($arr_row,$debug);
} else if ($arr_row = OCSP_OBJ::defaultReadDBObj()->getRow('T_CMS_PAGE',array('PAG_ID'=>intval($aId)))) {
if ($debug) echoDebugLine(__FILE__,__LINE__,"using db value");
return self::factoryFromDBRow($arr_row,$debug);
}
}
if ($force)
{
$obj_ret = new CMS_PAGE();
$obj_ret->setId($aId);
return $obj_ret;
}
return Null;
}
/**
* factories a page and sets the project ?????
*
* @param CMS_PROJECT $aProj
* @param int $aId
* @param boolean $force
* @param boolean $debug
*
* @return CMS_PAGE
*/
public static function factoryProjectPage(&$aProj,$aId,$force=False,$debug=False)
{
if ($obj_ret = self::factoryFromId($aId,False,$debug))
{
if (is_object($aProj))
{
if ($obj_ret->getProjId() == $aProj->getId())
{
$obj_ret->setMyProject($aProj);
return $obj_ret;
}
}
}
}
/**
* faktories the page object form the db row
*
* @param array $dbRow
* @param boolean $debug
*
* @return CMS_PAGE
*
* @todo CMS_PAGE_V2 is used
*/
public static function factoryFromDBRow($dbRow,$debug=False)
{
if ($debug) echoDebugMethod(__FILE__,"(static)","CMS_PAGE::factoryFromDBRow()",print_r($dbRow,True));
if (!isset($dbRow['PAG_OBJCLASS']) || ($dbRow['PAG_OBJCLASS']=='CMS_PAGE'))
{
$dbRow['PAG_OBJCLASS'] = "CMS_PAGE_V2";
}
if (!CMS_TABLEOBJ::pageType_requireClass($dbRow['PAG_OBJCLASS'],$debug))
{
throw new Exception(_OCSP_EXCEP_NOINCLUDE_ . ":" . $dbRow['PAG_OBJCLASS'] . "<pre>" . print_r($dbRow,True) . "</pre>");
}
$obj_ret = new $dbRow['PAG_OBJCLASS']();
$obj_ret->setDBRow($dbRow,True);
return $obj_ret;
}
/*** getter / setter ---------------------------------------------- */
/**
* returns the page id
*
* @return int
*/
public function getId()
{
return intval($this->getDBField('PAG_ID'));
}
/**
* sets the page id
*
* @param int $aId
*/
public function setId($aId)
{
$this->setDBField('PAG_ID',intval($aId));
}
/**
* returns the page title
*
* @returns string
*
*
*/
public function getTitle($debug=False)
{
$str_ret = OCSP_CONF::getInstance('CMS')->getValue('PAGETITLE_PREPEND');
$str_title=$this->getDBField('PAG_TITLE');
if (empty($str_title)) {
$this->getMyMenuNode();
$str_title=$this->myMenuNode->getTitle();
}
$str_ret.=$str_title;
$str_ret .= OCSP_CONF::getInstance('CMS')->getValue('PAGETITLE_APPEND');
return $str_ret;
}
/**
* returns the page state id
*
* @returns int
*/
public function getStateId()
{
return intval($this->getDBField('PAG_STATE'));
}
/**
* has the method getContent been called?
*
* @return boolean
*/
public function getContentCalled()
{
return $this->contentWasCalled;
}
/**
* sets contentWasCalled
*
* @param boolean $called
*/
public function setContentCalled($called='True')
{
$this->contentWasCalled=$called;
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// db methods
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* returns a array of variables used by the page object
*
* array[varName]=array(
* [TYPE] datatype
* [FLDCLASS] name of DBMS_FIELD* class
* [CLASSVALS] array of values of [FLDCLASS]
*
* @returns array
*
* @abstract
*/
protected function getObjVarDef($debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CMS_PAGE::getObjVarDef");
$arr_ret = array();
return $arr_ret;
}
/**
* returns a field => value array
*
* make sure to not include some special values
* and object columns are serialised
*
* @param boolean $withoutNull null values are not added to the array
* @param boolean $debug show debug info?
* @param boolean $withoutOV
* @param boolean $fldAutoPopulate
*
* @returns array
*
*/
public function getDBRow($withoutNull=True,$debug=False,$withoutOV=False,$fldAutoPopulate=True)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CMS_PAGE::getDBRow(".($withoutNull ? "without NULL" : "with NULL").")");
$arr_ret=parent::getDBRow($withoutNull,$debug,$withoutOV,$fldAutoPopulate);
if (($arr_objVars=$this->getObjVarDef()) && is_array($arr_objVars)) {
$arr_vars=array();
foreach($arr_objVars as $key => $descArr)
{
if ($debug) echo "Setting Key: $key";
if (isset($this->{$key}))
{
$arr_vars[$key]=$this->{$key};
}
}
$arr_ret['PAG_OBJECTVARS']=serialize($arr_vars);
}
return $arr_ret;
}
/**
* sets a database row to the object fields
*
* sets each key (=columname) value
*
* @param array $row the row form a select * from DBMS_TABLEOBJ::myTable
* @param bool $asPopulated set populateTS as if the object has been populated
* @param bool $debug
*
* @returns boolean
*
*/
public function setDBRow($row,$asPopulated=True,$debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CMS_PAGE::setDBRow()");
if (parent::setDBRow($row,$asPopulated,$debug))
{
$arr_objVarVals=@unserialize($row['PAG_OBJECTVARS']);
if (is_array($arr_objVarVals)) {
foreach($arr_objVarVals as $key => $val) {
$this->{$key}=$val;
}
} else {
if ($debug) ocsp_logError(__FILE__,__LINE__,"unserialize of <pre>--\n{$row['PAG_OBJECTVARS']}\n--</pre> failed",E_NOTICE);
}
return True;
} else {
return False;
}
}
/**
* sets all fields of an array to the objcet
*
* @param array $valArr
* @param boolean $debug
*
* @return boolean
*
*/
public function setDBVal($valArr,$debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CMS_PAGE::setDBVal()",print_r($valArr,True));
$arr_objVar=$this->getObjVarDef();
if (is_array($arr_objVar)) {
if ($debug) echoDebugLine(__FILE__,__LINE__,"setting PageObjVals");
foreach($arr_objVar as $key => $descArr) {
if ($debug) echoDebugLine(__FILE__,__LINE__,"setting PageObjVal $key to: ".htmlspecialchars($valArr[$key]));
$this->{$key}=$valArr[$key];
unset($valArr[$key]);
}
}
return parent::setDBVal($valArr,$debug);
}
/**
* returns a field => value array for dbms
*
* use this in cms and dbms elements to get
* $DBVAL array
*
* overwrite this and add some special values
* for objects if needed
*
* @see dbms
*
* @param bool $setFIELDS if true $ret['_DBMS_FIELDS'] is filled
* @param bool $debug show debug info?
*
* @returns array
*
*/
public function getDBVal($setFIELDS=False,$debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CMS_PAGE_V2::getDBVal()",($setFIELDS ? "SET FIELDS" : ""));
$arr_ret=parent::getDBVal($setFIELDS,$debug);
$arr_objVar=$this->getObjVarDef();
if (is_array($arr_objVar)) {
$c_sep=(sizeof($arr_ret) ? ',' : '');
foreach($arr_objVar as $key => $descArr)
{
if (isset($this->{$key})) {
$arr_ret[$key]=$this->{$key};
} else {
$arr_ret[$key]=Null;
}
}
}
if (!isset($arr_ret['PAG_OBJCLASS']) || empty($arr_ret['PAG_OBJCLASS']))
{
$arr_ret['PAG_OBJCLASS']=get_class($this);
}
return $arr_ret;
}
/**
*
* @param boolean $debug show debug info
* @param boolean $ignorPopulated
*
* @returns boolean
*
*/
function dbReplace($debug=false,$ignorPopulated=false) {
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CMS_PAGE::dbReplace(...)");
$this->setDBField('PAG_LASTCHANGE_BY',OCSP_OBJ::currentUser()->getId());
$this->setDBField('PAG_LASTCHANGE',"CURRENT_TIMESTAMP");
$str_storedClass=$this->getDBField('PAG_OBJCLASS');
if (empty($str_storedClass))
{
if (CMS_TABLEOBJ::pageType_getClassSrc(get_class($this)))
{
$this->setDBField('PAG_OBJCLASS',get_class($this));
} else {
$this->setDBField('PAG_OBJCLASS',"CMS_PAGE");
}
} else if (!$str_storedClass == get_class($this)) {
if (!(CMS_TABLEOBJ::pageType_getClassSrc(get_class($this))))
{
throw new Exception(_OCSP_EXCEP_NOINCLUDE_.":".get_class($this));
}
}
OCSP_CMS_CACHE::getInstance()->clearPageCache($this,$debug);
return parent::dbReplace($debug,$ignorPopulated);
}
/*** form / editing ----------------------------------------------- */
/**
* returns the page form name
*
* @return string
*/
public function getFormName()
{
return "PAGEFORM_".strtoupper(get_class($this));
}
/**
* returns the form for the page
*
* @param int $mode (form mode)
* @param string $frmName
* @param string $frmClass
* @param boolean $debug
*
* @return CMS_PAGE_FORM
*
* @requires CMS_PAGE_FORM
*
* @version pk-08-08-11
*/
public function &getForm($mode=FRM_MODE_READONLY,$frmName='',$frmClass='CMS_PAGE_FORM',$debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CMS_PAGE::getForm(".$frmName.")");
if (empty($frmClass) || ($frmClass == 'CMS_PAGE_FORM'))
{
$frmClass='CMS_PAGE_FORM';
pcf_require_class('CMS_PAGE_FORM',dirname(__FILE__)._OCSP_DIRSEP_."CMS_PAGE_FORM.phpclass");
}
if (!class_exists($frmClass))
{
throw new Exception(_OCSP_EXCEP_CLASSNOTFOUND_ . ":" . $frmClass);
}
if (empty($frmName))
{
$frmName=$this->getFormName();
}
$obj_form=OCSP_FORM::factory_from_Name($frmName,$frmClass,$debug);
if (!intval($obj_form->getId()))
{
if ($debug) echoDebugLine(__FILE__,__LINE__,"generating new form");
if ($obj_form = parent::getForm($mode,Null,$frmClass,$debug))
{
$obj_form->setId(0);
$obj_form->setName($frmName);
} else {
throw new Exception(_OCSP_EXCEP_NOFORM_ . ":" . $frmName);
}
$b_toSave = True;
} else {
$b_toSave = False;
}
$arr_objVars=$this->getObjVarDef();
if ($debug) echoDebugLine(__FILE__,__LINE__,"\$objVars: (".get_class($this).")<pre>".print_r($arr_objVars,True)."</pre>");
foreach($arr_objVars as $str_key => $arr_descArr)
{
if (!($obj_form->getField("PAGEOBJVAL.".$str_key,$debug)))
{
$arr_fldValues=$arr_descArr['CLASSVALS'];
if (!isset($arr_fldValues['myTable'])) $arr_fldValues['myTable']='PAGEOBJVAL';
if (!isset($arr_fldValues['myTableAlias'])) $arr_fldValues['myTableAlias']='PAGEOBJVAL';
$arr_dbDesc=array(
'TYPE' => $arr_descArr['TYPE'],
'NULL' => False,
'TABLE' => $arr_fldValues['myTable'] // <pk-08-06-17 />
);
if ($obj_field=$obj_form->factory_field($str_key,$arr_descArr['FLDCLASS'],$arr_dbDesc,$arr_fldValues,$debug))
{
$obj_block=$obj_form->getBlock(0);
$obj_block->addFieldObj($obj_field,$debug);
if ($debug) echoDebugLine(__FILE__,__LINE__,"Field ".$obj_field->getKey()." generated");
$b_toSave=True;
} else {
ocsp_logError(__FILE__,__LINE__,"opjVar Field: $str_key not in form: ".$obj_form->getName()."<pre>".print_r($arr_descArr,True)."</pre>");
}
}
}
if ($b_toSave)
{
$obj_form->storeToDb($debug);
}
$obj_form->setMyTblObj($this);
$str_classSrc = $this->get_mySourceFile();
if (!empty($str_classSrc) && strstr($str_classSrc,get_class($this)))
{
$obj_form->setTblObjInc($str_classSrc);
$obj_form->setTblObjClass(get_class($this));
} else if (!empty($this->myClassSrcFile)) {
$obj_form->setTblObjInc($this->myClassSrcFile);
$obj_form->setTblObjClass(get_class($this));
} else {
ocsp_logError(__FILE__,__LINE__,"no source file for " . get_class($this) . " (" . $str_classSrc . ");",E_WARNING);
}
$obj_form->setMyTblObj($this);
$str_classSrc = $this->get_mySourceFile();
if (!empty($str_classSrc) && strstr($str_classSrc,get_class($this)))
{
$obj_form->setTblObjInc($str_classSrc);
$obj_form->setTblObjClass(get_class($this));
} else if (!empty($this->myClassSrcFile)) {
$obj_form->setTblObjInc($this->myClassSrcFile);
$obj_form->setTblObjClass(get_class($this));
} else {
ocsp_logError(__FILE__,__LINE__,"no source file for " . get_class($this) . " (" . $str_classSrc . ");",E_WARNING);
}
$obj_form->setFrmMode($mode);
return $obj_form;
}
/* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ */
/* chapter methods */
/* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ */
/**
* returns a new chapter object
*
* @param int $tmplId
*
* @return CMS_CHAPTER
*
* @since pk-08-01-14
*
*/
function getNewChapter($tmplId,$debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CMS_PAGE::getNewChapter()");
$obj_chapter = $this->getTemplate()->getChapterTemplate($tmplId,$debug)->getChaObj(0,$debug);
$obj_chapter->setMyPageObj($this);
$obj_chapter->setProjId($this->getProjId());
$obj_chapter->setMenId($this->getMenId());
$obj_chapter->setPageId($this->getId());
return $obj_chapter;
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// rights and state
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* returns if the page is the current page
*
* @param boolean $debug
* @return boolean
*
* @since pk-08-07-25
*/
public function isCurrent($debug=False)
{
if (($obj_page=CMS_TABLEOBJ::get_currentPage()) && ($obj_page->getId() == $this->getId()))
{
return True;
}
return False;
}
/**
* returns if the current page is online
*
* @param boolean $debug
*
* @global array $OCSP_CONF
*
* @return boolean
* @access public
* @since pk-07-06-07
* @version pk-08-07-25
*/
public function isOnline($debug=False)
{
if ($arr_states = OCSP_CMS_CONF::getInstance()->getValue('PAGESTATE'))
{
$int_stateId = $this->getStateId();
if (isset($arr_states[$int_stateId]))
{
$arr_myState = $arr_states[$int_stateId];
if (!($bol_chkShow = $arr_myState['SHOW']))
{
$bol_chkShow = ($this->isCurrent() && $arr_myState['DIRECTSHOW']);
}
if (!$bol_chkShow)
{
if ($debug) echoDebugLine(__FILE__,__LINE__,'page is not in online state');
return False;
}
pcf_require_class('OCSP_DATE','common/');
$obj_date = new OCSP_DATE();
$obj_date->setDbString($this->getDBField('PAG_SHOWFROM'));
if ($obj_date->isInFutur())
{
if ($debug) echoDebugLine(__FILE__,__LINE__,"page will come in future");
return False;
}
if ($this->isExpired())
{
if ($debug) echoDebugLine(__FILE__,__LINE__,"page is expired");
return False;
}
$str_showQuery = $this->getDBField('CHA_SHOWQUERY');
if (!empty($str_showQuery))
{
$mix_ret = OCSP_OBJ::defaultReadDBObj()->getOne("SELECT " . $str_showQuery);
if (empty($mix_ret))
{
if ($debug) echoDebugLine(__FILE__,__LINE__,"Show Query: SELECT " . $str_showQuery . " failed");
return False;
}
}
return True;
}
} else {
throw new Exception(_OCSP_EXCEP_NOTCONFIGURED_.":PAGESTATE");
}
return False;
}
/**
* returns if the page is expired
* (PAG_SHOWTILL < NOW())
*
* @param boolean $debug
*
* @return boolean
*/
public function isExpired($debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CMS_PAGE::isExpired()");
pcf_require_class('OCSP_DATE','common/');
$obj_date = new OCSP_DATE();
$obj_date->setDbString($this->getDBField('PAG_SHOWTILL'));
if ($obj_date->isInPast())
{
if ($debug) echoDebugLine(__FILE__,__LINE__,"page is out of date");
return True;
} else {
return False;
}
}
/**
* returns if the current user can open the page
*
* @param boolean $debug
*
* @return boolean
*
* @since pk-06-11-12
*
***/
function curUserCanOpen($debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CMS_PAGE_V2::curUserCanOpen()");
$this->getMyMenuNode(); // ensure $this->myMenuNode is up to date;
if ($this->myMenuNode->curUserCanOpen($debug)) {
if (!intval($this->getDBField('PAG_SHOWGROUP'))) {
// the page is public
return True;
} else {
if (OCSP_OBJ::currentUser()->isGroupMember($this->getDBField('PAG_SHOWGROUP')))
{
return True;
}
return $this->curUserCanEdit();
}
} else {
return False;
}
}
/**
* returns if the user can edit the page
*
* @param boolean $debug
*
* @return boolean
*
* @since pk-05-09-01
* @version pk-07-05-07
*
***/
function curUserCanEdit($debug=False) {
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CMS_PAGE::curUserCanEdit()");
if (OCSP_OBJ::currentUser()->isPublic()) return False;
if (OCSP_OBJ::currentUser()->isGroupMember(_OCSP_GROUP_CMSADMIN_)) return True;
$this->getMyMenuNode($debug);
if ($this->isOnline())
{
if (intval($this->getDBField("PAG_EDITORGRP"))
&& OCSP_OBJ::currentUser()->isGroupMember($this->getDBField("PAG_EDITORGRP")))
{
return True;
}
return $this->myMenuNode->curUserCanEdit($debug);
} else {
if (intval($this->getDBField("PAG_EDITORGRP"))
&& OCSP_OBJ::currentUser()->isGroupMember($this->getDBField("PAG_EDITORGRP")))
{
return True;
}
return $this->myMenuNode->curUserCanEdit($debug);
}
return False;
}
/**
* returns if the user can insert a new page
*
* @param boolean $debug
*
* @return boolean
* @access public
*
* @since pk-07-05-07
*/
function curUserCanInsert($debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CMS_PAGE::curUserCanInsert()");
$this->getMyMenuNode($debug);
if (!intval($this->myMenuNode->getId()))
{
var_dump($this->getMyProject());
}
if ($this->myMenuNode->curUserCanAddPage())
{
return True;
} else {
return False;
}
}
/**
* returns if the current user can delete the page
*
* @param boolean $debug
*
* @return boolean
*/
function curUserCanDelete($debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),curUserCanDelete());
if ($this->curUserCanEdit($debug))
{
return $this->getMyMenuNode()->curUserCanAddPage($debug);
}
return False;
}
// ---------------------------------------------------------------------------
// navigation
// ---------------------------------------------------------------------------
/*** preview / editing ----------------------------------------------- */
/**
* returns the preview uri
*
* @return string
*
*/
public function getPreviewUri()
{
$str_ret = "";
if (file_exists($_SERVER['DOCUMENT_ROOT']."/index.php")) {
$str_ret .= "/index.php";
} else if (file_exists($_SERVER['DOCUMENT_ROOT']."/content.php")) {
$str_ret .= "/content.php";
} else {
$str_ret .= "/cms/page.php";
}
$str_ret .= "?" . $this->myProjIdCol . "=" . $this->getProjId();
$str_ret .= "&" . $this->myMenuIdCol . "=" . $this->getMenId();
$str_ret .= "&" . $this->myPageIdCol . "=" . $this->getId();
$str_ret .= "&PREVIEWMODE=1";
$str_ret .= "&RL=" . time() . "-" . rand(100,900);
return $str_ret;
}
/**
* returns the link to the page without additional get params
*
* @param boolean $debug
*
* @returns string
*
* @since pk-05-03-16
* @version pk-05-11-30 $GLOBALS['OCSP_CMS']['PAGLINKTMPL'] if $GLOBALS['OCSP_CMS']['REWRITE']
* @version pk-07-02-16 just ask the menu
* @version pk-08-10-01 $arr_tmplVals for PAGLINKTMPL
*
*/
function getMyLink($debug=False) {
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CMS_PAGE_V2::getMyLink()");
if (!empty($GLOBALS['OCSP_CMS']['PAGLINKTMPL'])) {
// we have a template for a page set use this
$arr_tmplVals = $this->getDBVal(False);
$arr_tmplVals['MEN_ID'] = $this->getMyMenuNode()->getKey();
if ($debug) echoDebugLIne(__FILE__,__LINE__,"using \$GLOBALS['OCSP_CMS']['PAGLINKTMPL']: " . htmlspecialchars($GLOBALS['OCSP_CMS']['PAGLINKTMPL']) . "<pre>" . print_r($arr_tmplVals,True) . "</pre>");
pcf_require_class('OCSP_TEMPLATE',"common/");
return OCSP_TEMPLATE::parse($GLOBALS['OCSP_CMS']['PAGLINKTMPL'],$arr_tmplVals);
}
$a_getVals=$_GET;
$a_getVals['PROJ_ID']=$this->getProjId();
$a_getVals['MEN_ID'] =$this->getMyMenuNode()->getKey();
$a_getVals['PAG_ID'] =$this->getId();
if ($o_myMenu=$this->getMyMenuNode()) {
return $o_myMenu->getLinkUrl($a_getVals,$debug);
} else {
$s_link="/";
foreach($a_getVals as $s_key => $s_val) {
$s_link=pcf_HTML_changeURI_GetValue($s_link,$s_key,$s_val);
}
return $s_link;
}
}
// ---------------------------------------------------------------------------
// output
// ---------------------------------------------------------------------------
/**
* executes a prepend script before the page output starts
*
* @param boolean $debug
*/
function execPrependCmds($debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"abstract CMS_PHPINC_PAGE::execPrependCmds()");
}
/*** HTML_PAGE --------------------------------------------------- */
/**
* @param CMS_HTML_PAGE $aHTMLPage
*/
function setMyHTMLPage(&$aHTMLPage)
{
$this->myHTMLPage=$aHTMLPage;
}
/**
* @return CMS_HTML_PAGE
*/
function getMyHTMLPage()
{
return $this->myHTMLPage;
}
/*** templates ---------------------------------------------------- */
/**
* returns the template id
*
* if col PTMP_ID is 0 the menu is asked for a template id
*
* @param boolean $debug
*
* @return int
* @access public
*
* @since pk-07-06-07
*/
public function getTemplateId($debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CMS_PAGE::getTemplateId()");
if (pcf_class_implements($this->myTemplate,'INFA_CMS_PAGE_TEMPLATE'))
{
return $this->myTemplate->getId();
}
if (intval($this->getDBField('PTMP_ID')))
{
return $this->getDBField('PTMP_ID');
} else {
return $this->getMyMenuNode()->getTemplateId($debug);
}
}
/**
* returns the template object
*
* @param boolean $debug
*
* @return CMS_PAGE_TEMPLATE
*/
public function &getTemplate($debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CMS_PAGE::getTemplate()");
if (!pcf_class_implements($this->myTemplate,'INFA_CMS_PAGE_TEMPLATE'))
{
$this->myTemplate = CMS_PAGE_TEMPLATE::getInstance($this->getTemplateId(),$debug);
}
if (!is_object($this->myTemplate))
{
//echoDebugLine(__FILE__,__LINE__,"no template set <pre>" . print_r($this->getDBRow(),True) . "</pre>");
$this->myTemplate = new CMS_PAGE_TEMPLATE();
}
return $this->myTemplate;
}
/**
* returns an array of chapter template names with chapter template ID as index
* returns false if the page does not support chapter input
*
* @param bool $debug
* @param boolean $getAll
*
* @returns array
*
*/
public function getChaTemplates($debug=False,$getAll=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CMS_PAGE::getChaTemplates()");
if ($this->getTemplate())
{
return $this->myTemplate->getChaTemplateNames($getAll,$debug);
}
}
/*** chapters ---------------------------------------------------- */
/**
* returns a comma seperated list of chapter states to show
*
* @returns array
*
* @since pk-03-12-18
*
* @version pk-07-09-11
* @version pk-08-07-25
*
*/
function getChapOnlineStates() {
$arr_ret=array();
$arr_chaStates = OCSP_CMS_CONF::getInstance()->getValue('CHAPTERSTATE');
if (is_array($arr_chaStates))
{
foreach($arr_chaStates as $int_state => $arr_settings)
{
if ($arr_settings['SHOW'])
{
$arr_ret[] = $int_state;
}
}
}
return $arr_ret;
}
/**
* populates $this->myChapterlist as sorted array
*
* $this->my
*
* @param unknown_type $debug
*/
protected function populateChapterArr($debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CMS_PAGE::populateChapterArr()");
$str_query = "SELECT * FROM T_CMS_CHAPTER";
$str_query.= " WHERE PAG_ID = " . $this->getId();
$str_query.= " ORDER BY CHA_SHOWMODE,CHA_SORTORDER";
$this->myChapterList = array();
if ($obj_cursor = OCSP_OBJ::defaultReadDBObj()->query($str_query))
{
$obj_pageTmpl = $this->getTemplate($debug);
while($arr_row = $obj_cursor->fetchArrayFld())
{
if ($debug) echoDebugLine(__FILE__,__LINE__,"<pre>" . print_r($arr_row,True) . "</pre>");
$int_sortOrder = intval($arr_row['CHA_SORTORDER']);
while(isset($this->myChapterList[$arr_row['CHA_SHOWMODE']][$int_sortOrder]))
{
$int_sortOrder++;
}
$this->myChapterList[$arr_row['CHA_SHOWMODE']][$int_sortOrder] = $obj_pageTmpl->getChapterTemplate($arr_row['CTMP_ID'])->getChaObjFromRow($arr_row);
$this->myChapterList[$arr_row['CHA_SHOWMODE']][$int_sortOrder]->setOrderNr($int_sortOrder);
}
}
$this->chapterListPopulated = time();
}
/**
* returns an array with the chapters
*
* @param int $showMode
* @param boolean $onlineOnly
* @param int $langId
* @param boolean $debug
*
* @return array
*/
public function getChapterArr($showMode=0,$onlineOnly=True,$langId=0,$debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),'CMS_PAGE::getChapterArr');
if ($this->chapterListPopulated < (time() - ini_get('max_execution_time')))
{
$this->populateChapterArr($debug);
}
if (intval($showMode))
{
return $this->myChapterList[$showMode];
} else {
// flatten the array
$arr_ret = array();
foreach($this->myChapterList as $int_showMode => $arr_chapters)
{
if (is_array($arr_chapters))
{
foreach($arr_chapters as $int_sort => &$obj_chapter)
{
$arr_ret[$int_showMode . "_" . $int_sort] = $obj_chapter;
}
}
}
return $arr_ret;
}
}
/*** rendering ---------------------------------------------------- */
/**
* returns the headline HTML tags
*
* @param boolean $debug
* @return string
* @access public
*
* @todo pageing
*/
function getHeadlineTag($debug=False) {
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CMS_PAGE::getHeadLineTag()");
/*
if (!intval($this->prevId)) {
$this->prevId=$this->getPreviousPage($debug);
}
if (!intval($this->nextId)) {
$this->nextId=$this->getNextPage($debug);
}
if (!is_object($this->myTemplate)) {
$this->loadTemplate($debug);
}
*/
$txt = $this->getTemplate()->getHeadLineTag()."\n";
$txt .=$this->getDBField("PAG_HEADER");
/*
if ($this->prevId) $txt=str_replace("\$*PREVPAGE\$",$this->prevId,$txt);
if ($this->nextId) $txt=str_replace("\$*NEXTPAGE\$",$this->nextId,$txt);
*/
return $txt;
}
/**
* returns the feeter tag
*
* @param boolean $debug
*
* @return string
*
* @todo pageing
*/
function getFeeterTag($debug=False) {
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CMS_PAGE::getFeeterTag()");
$str_ret = $this->getTemplate()->getFeeterTag();
/*
if ($this->prevId) $str_ret=str_replace("\$*PREVPAGE\$",$this->prevId,$txt);
if ($this->nextId) $str_ret=str_replace("\$*NEXTPAGE\$",$this->nextId,$txt);
*/
return $str_ret;
}
/**
* returns all chapter with $mode
*
*
* @param int $mode
* @param boolean $debug
*
* @returns string
*
* @version pk-05-04-01
* @version pk-05-11-10
*
* @version pk-08-07-25
*
*/
function renderChapters($mode=0,$debug=FALSE)
{
if ($debug) echoDebugMethod(__FILE__,__LINE__,"CMS_PAGE::getChapterTags({$mode})");
$str_ret = "";
if ($mode == 0)
{
$str_ret .= $this->renderChapters(CHAPTER_SHOWMODE_ALLWAYS_TOP,$debug);
$str_ret .= $this->renderChapters(CHAPTER_SHOWMODE_ALLWAYS_BOTTOM,$debug);
return $str_ret;
}
if ($this->chapterListPopulated < (time() - ini_get('max_execution_time')))
{
$this->populateChapterArr($debug);
}
if (isset($this->myChapterList[$mode]) && is_array($this->myChapterList[$mode]))
{
foreach($this->myChapterList[$mode] as &$obj_chap)
{
if ($obj_chap->isOnline($debug))
{
if ($obj_chap->curUserCanShow($debug))
{
if ($debug) echoDebugLine(__FILE__,__LINE__,"SHOW CHAPTER " . $obj_chap->getId() . "");
$str_ret .= "\n\n";
$str_ret .= $obj_chap->render($debug);
$str_ret .= "\n\n\n";
}
}
}
}
return $str_ret;
/*
if ($debug) echo "CMS_PAGE_V2::getChapter($mode,...) (".get_class($this).")";
$GLOBALS['CHAMODE_COUNTER']=1; // <pk-06-02-21
require_once __OCSP_PHPINCPATH__."common/OCSP_DATE.phpclass";
if (!$this->isConnected(TRUE))
{
ocsp_logError(__FILE__,__LINE__,"no database connection",E_ERROR);
return "";
}
$query ="SELECT * FROM ".$this->cTable;
$query.=" WHERE ".$this->colPrevix."ID=".intval($this->getId());
$query.=" AND ".$this->myProjIdCol."=".intval($this->getProjId());
$query.=" AND LANG_ID=".intval($this->getLangId());
$query.=" AND ".$this->chapPrevix."STATE IN (".implode(",",$this->getChapOnlineStates()).")";
if ($debug) echo $query;
if (!intval($mode)) $query.=" AND ".$this->chapPrevix."SHOWMODE < 4";
else $query.=" AND ".$this->chapPrevix."SHOWMODE = $mode";
$query.=" ORDER BY ".$this->chapPrevix."SORTORDER";
$ret="";
if ($cursor=$this->myDBObj->query($query)) {
while($row=$cursor->fetchArray()) {
if ($debug) echo "<pre>".print_r($row,TRUE)."</pre>";
// <pk-04-09-08>
$show=FALSE;
switch(intval($row[$this->chapPrevix.'SHOWGROUP'])) {
case 0:
$show=TRUE;
break;
case -2: // only not logged in
if ((!is_object($GLOBALS['OCSP_OBJ']['USER'])) || (!$GLOBALS['OCSP_OBJ']['USER']->getId())) $show=TRUE;
break;
case -1: // logged in user
if ($GLOBALS['OCSP_OBJ']['USER']->getId()) $show=TRUE;
break;
default:
$show=$GLOBALS['OCSP_OBJ']['USER']->isGroupMember(intval($row[$this->chapPrevix.'SHOWGROUP']));
}
// <pk-05-10-11>
if ($show && (!empty($row[$this->chapPrevix.'SHOWFROM']))) {
$o_ShowDate=new OCSP_DATE();
$o_ShowDate->setDateStr($row[$this->chapPrevix.'SHOWFROM']);
if ($o_ShowDate->isInFutur()) $show=FALSE;
if ($debug) echo "SHOWFROM: ".$row[$this->chapPrevix.'SHOWFROM']." ".($show ? "OK" : "NOT OK")."";
}
if ($show && (!empty($row[$this->chapPrevix.'SHOWTILL']))) {
$o_ShowDate=new OCSP_DATE();
$o_ShowDate->setDateStr($row[$this->chapPrevix.'SHOWTILL']);
if ($o_ShowDate->isInPast()) $show=FALSE;
if ($debug) echo "SHOWTILL: ".$row[$this->chapPrevix.'SHOWTILL']." ".($show ? "OK" : "NOT OK")."";
}
// </pk-05-10-11>
// <pk-05-04-01 >
if (($show) && (!empty($row[$this->chapPrevix.'SHOWQUERY']))) {
require_once __OCSP_PHPINCPATH__."common/pcf_templates.phpinc";
$cmd=pcf_tmpl_parse($row[$this->chapPrevix.'SHOWQUERY'],$row,$debug);
$query = "SELECT ".$cmd;
// $debug=TRUE; echo "<tr><td>"; foreach($_SESSION as $key => $val) echo "<li>$key = $val</li>"; echo "</td></tr>";
if ($debug) echo "checkShowChapter(".$row[$this->chapPrevix.'ID'].") SHOWQUERY: \n$query";
$show=intval($GLOBALS[$this->gDBIDX]->quickQuery($query,0));
}
// </ pk-05-04-01 >
if ($show) {
} else if (($this->curUserCanEdit()) && (intval($_GET['PREVIEWMODE']))) { // <pk-05-11-10>
$ret.="\n<div style=\"background-color: #AE3E2E; color:#FFFFFF\">\n";
$ret.="\n>>>>>   OFFLINE ID: ".$row[$this->colPrevix."ID"]."";
$ret.="\n</div>\n";
$ret.=$this->getChapterTag($row);
$GLOBALS['CHAMODE_COUNTER']++; // <pk-06-02-21>
$ret.="\n<div style=\"background-color: #AE3E2E; color:#FFFFFF\">\n";
$ret.="\n OFFLINE ID: ".$row[$this->colPrevix."ID"]."     <<<<<";
$ret.="\n</div>\n";
}
// </pk-04-09-08>
}
}
return $ret;
*/
}
/**
* returns the content
*
* @param int $chaShowMode
* @param boolean $debug
*
* @return string
*
* @sice pk-07-08-18
*/
function getContent($chaShowMode=0,$debug=False)
{
$debug=($debug || (isset($_GET['CONTENTDEBUG']) && intval($_GET['CONTENTDEBUG']) && ($this->curUserCanEdit())));
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CMS_PAGE::content($chaShowMode)");
if (($chaShowMode == 0) && $this->getContentCalled())
{
throw new Exception('content called twice');
}
$str_ret="";
if ($chaShowMode==0)
{
if (method_exists($this,'getHeadlineTag'))
{
$str_ret.= $this->getHeadlineTag($debug);
}
}
ob_start();
$str_ret.=$this->renderChapters($chaShowMode,$debug);
$str_ret.=ob_get_contents();
ob_end_clean();
if ($chaShowMode==0)
{
$str_ret.= $this->getFeeterTag($debug);
$this->setContentCalled(True);
}
return $str_ret;
}
}
?>

Source for file CMS_PAGE.phpclass