File Source for CMS_CHAPTER.phpclass

<?php
/**
* openCSP class file CMS_CHAPTER.phpclass
*
* @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-19.06.2008
* @version $Id: CMS_CHAPTER.phpclass,v 1.9 2008/12/17 16:28:51 peterkrebs Exp $
*/
// ---------------------------------------------------------
// requirements
// ---------------------------------------------------------
pcf_require_interface('INFA_CMS_CHAPTER',"cms/chapter/");
pcf_require_class('CMS_TABLEOBJ',"cms/");
pcf_require_class('TMPL_CHAPTER',"cms/template/chapter/");
pcf_require_class('CMS_CHAPTER_STATE',"cms/chapter/");
/**
* openCSP class CMS_CHAPTER
*
* @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-19.06.2008
* @version $Id: CMS_CHAPTER.phpclass,v 1.9 2008/12/17 16:28:51 peterkrebs Exp $
*/
class CMS_CHAPTER extends CMS_TABLEOBJ implements INFA_CMS_CHAPTER
{
// ---------------------------------------------------------------------------
// constants
// ---------------------------------------------------------------------------
/**
* @constant string CLASS_SRC_FILE
*/
const CLASS_SRC_FILE = __FILE__;
// ---------------------------------------------------------------------------
// class (static)
// ---------------------------------------------------------------------------
/*** class vars ------------------------------------------------------ */
/**
* unit of work chapters
*
* @staticvar array $loadedChapters
*/
protected static $loadedChapters = array();
/*** class methods --------------------------------------------------- */
/**
* uses self::$loadedChapters as unit of work and returns
* the chapter with $aId
*
* @param int $aId
* @param boolean $debug
*
* @return CMS_CHAPTER
*/
public static function &getInstance($aId,$debug=False)
{
if ($debug) echoDebugMethod(__FILE__,"static","CMS_CHAPTER::getInstance({$aId});");
if (!isset(self::$loadedChapters[intval($aId)]) || !pcf_class_implements(self::$loadedChapters[intval($aId)],'INFA_CMS_CHAPTER'))
{
self::$loadedChapters[intval($aId)] = self::factoryFromId($aId,$debug);
}
return self::$loadedChapters[intval($aId)];
}
/**
* returns if we already have an instance of $aId
*
* @param int $aId
* @return boolean
*/
public static function isInstanced($aId)
{
if (isset(self::$loadedChapters[$aId]))
{
return pcf_class_implements(self::$loadedChapters[$aId],'INFA_CMS_CHAPTER');
}
return False;
}
/**
* adds a newsletter to the unit of work
*
* @param NWL_CHAPTER $aLetter
*/
public static function setInstance(&$aChapter)
{
if (pcf_class_implements($aChapter,'INFA_CMS_CHAPTER'))
{
if (intval($aChapter->getId()))
{
self::$loadedChapters[$aChapter->getId()] = $aChapter;
}
}
}
// ---------------------------------------------------------------------------
// object vars
// ---------------------------------------------------------------------------
/*** compostion --------------------------------------------------- */
/**
* @var TMPL_CHAPTER $myTemplate
*/
protected $myTemplate = Null;
/*** attributes -------------------------------------------------- */
/**
* @var string $myTable
*/
protected $myTable = "T_CMS_CHAPTER";
// ---------------------------------------------------------------------------
// factory / construct
// ---------------------------------------------------------------------------
/**
* factories a chapter object
*
* @param int $aId
* @param boolean $debug
*
* @todo add chapter types
*
* @return CMS_CHAPTER
*/
public static function &factoryFromId($aId,$debug=False)
{
if ($debug) echoDebugMethod(__FILE__,"static","CMS_CHAPTER::factoryFromId({$aId})");
$obj_ret = new CMS_CHAPTER();
$obj_ret->populateFromKeys(array('CHA_ID'=>intval($aId)));
return $obj_ret;
}
// ---------------------------------------------------------------------------
// getter / setter
// ---------------------------------------------------------------------------
/**
* @return int
***/
public function getId() {
return intval($this->getDBField('CHA_ID'));
}
/**
* returns the order number
*
* @return int
*/
public function getOrderNr()
{
return intval($this->getDBField('CHA_SORTORDER'));
}
/**
* sets the sort order number
*
* @param int $aOrderNr
*/
public function setOrderNr($aOrderNr)
{
$this->setDBField('CHA_SORTORDER',intval($aOrderNr));
}
/**
* returns the chapter state object
*
* @return CMS_CHAPTER_STATE
*/
public function &getState()
{
return CMS_CHAPTER_STATE::getInstance($this->getDBField('CHA_STATE'));
}
// ---------------------------------------------------------------------------
// db methods
// ---------------------------------------------------------------------------
/**
* inserts a new row to the table
*
* @param boolean $debug show debug info
*
* @return int returns the autoIncFld ID if exists or True on success
*
*/
public function dbInsert($debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CMS_CHAPTER::dbInsert()");
$this->setDBField('CHA_LASTCHANGE_AT',"CURRENT_TIMESTAMP");
$this->setDBField('CHA_LASTCHANGE_BY',OCSP_OBJ::currentUser()->getId());
$this->setDBField('CHA_CREATE_AT',"CURRENT_TIMESTAMP");
$this->setDBField('CHA_CREATE_BY',OCSP_OBJ::currentUser()->getId());
$this->setDBField('PROJ_ID',$this->getMyPageObj()->getProjId());
$this->setDBField('PTMP_ID',$this->getMyTemplate()->getPageTemplateId());
$this->setDBField('CHA_OBJCLASS',get_class($this));
$str_objInc = $this->get_mySourceFile();
$str_objInc = str_replace(__OCSP_PHPINCPATH__,"",$str_objInc);
$str_objInc = str_replace(__OCSP_PROJECTPATH__,"",$str_objInc);
$this->setDBField('CHA_OBJINC',dirname($str_objInc) . _OCSP_DIRSEP_);
if (intval($this->getOrderNr()) < 1)
{
$str_query = "SELECT MAX(CHA_SORTORDER)+1 FROM T_CMS_CHAPTER";
$str_query.= " WHERE PAG_ID=" . $this->getPageId();
$this->setOrderNr(intval($this->getDBObj("r")->getOne($str_query)));
} else {
$this->sort_check($debug);
}
return parent::dbInsert($debug);
}
/**
* replaces a row in the table
*
* if the object has not been populated (!$this->populateTS)
* False is returned
*
* @param boolean $debug show debug info
* @param boolean $ignorPopulated (if False the table MUST have been populated)
*
* @return boolean
*
*/
public function dbReplace($debug=False,$ignorPopulated=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CMS_CHAPTER::dbReplace()");
$this->setDBField('CHA_LASTCHANGE_AT',"CURRENT_TIMESTAMP");
$this->setDBField('CHA_LASTCHANGE_BY',OCSP_OBJ::currentUser()->getId());
$this->setDBField('PROJ_ID',$this->getMyPageObj()->getProjId());
$this->setDBField('PTMP_ID',$this->getMyTemplate()->getPageTemplateId());
$this->setDBField('CHA_OBJCLASS',get_class($this));
$str_objInc = $this->get_mySourceFile();
$str_objInc = str_replace(__OCSP_PHPINCPATH__,"",$str_objInc);
$str_objInc = str_replace(__OCSP_PROJECTPATH__,"",$str_objInc);
$this->setDBField('CHA_OBJINC',dirname($str_objInc) . _OCSP_DIRSEP_);
$this->sort_check($debug);
return parent::dbReplace($debug,$ignorPopulated);
}
public function sort_check($debug)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CMS_CHAPTER::sort_check()");
$str_query = "SELECT * FROM T_CMS_CHAPTER";
$str_query.= " WHERE PAG_ID=" . $this->getPageId();
$str_query.= " AND CHA_SORTORDER = " . $this->getOrderNr();
$str_query.= " AND CHA_ID <> " . $this->getId();
$str_query.= " ORDER BY CHA_SORTORDER";
if ($arr_row = $this->getDBObj("r")->quickQuery($str_query))
{
$this->sort_move(0,$this->getOrderNr());
}
}
/**
* moves the chapter (sortorder)
*
* NOTE this method does save other chapters but not itself
*
* @param int $moveDir (-1 down +1 up, 0 pos)
* @param int $movePos
* @param boolean $debug
*
* @since pk-08-12-17
*/
public function sort_move($moveDir,$movePos,$debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CMS_CHAPTER::sort_move({$moveDir},{$movePos});");
switch(true)
{
case ($moveDir < 0):
if ($this->getOrderNr() > 1)
{
$str_query = "SELECT * FROM T_CMS_CHAPTER";
$str_query.= " WHERE PAG_ID=" . $this->getPageId();
$str_query.= " AND CHA_SORTORDER < " . $this->getOrderNr();
$str_query.= " ORDER BY CHA_SORTORDER DESC";
if ($arr_row = $this->getDBObj("r")->quickQuery($str_query))
{
$obj_chapter = CMS_CHAPTER::getInstance($arr_row['CHA_ID']);
$obj_chapter->setOrderNr($this->getOrderNr());
$obj_chapter->dbSave();
$this->setOrderNr($arr_row['CHA_SORTORDER']);
$this->dbSave();
} else {
$this->setOrderNr(1);
$this->dbSave();
}
}
break;
case ($moveDir > 0):
$str_query = "SELECT * FROM T_CMS_CHAPTER";
$str_query.= " WHERE PAG_ID=" . $this->getPageId();
$str_query.= " AND CHA_SORTORDER >= " . $this->getOrderNr();
$str_query.= " AND CHA_ID <> " . $this->getId();
$str_query.= " ORDER BY CHA_SORTORDER";
if ($arr_row = $this->getDBObj("r")->quickQuery($str_query))
{
if ($this->getOrderNr() == $arr_row['CHA_SORTORDER'])
{
$str_cmd = "UPDATE T_CMS_CHAPTER SET CHA_SORTORDER=CHA_SORTORDER+1";
$str_cmd.= " WHERE PAG_ID=" . $this->getPageId();
$str_cmd.= " AND CHA_SORTORDER >= " . $this->getOrderNr();
$str_cmd.= " AND CHA_ID <> " . $this->getId();
$this->getDBObj("w")->executeCmd($str_cmd);
$arr_row['CHA_SORTORDER'] = intval($arr_row['CHA_SORTORDER']) + 1;
}
$obj_chapter = CMS_CHAPTER::getInstance($arr_row['CHA_ID']);
$obj_chapter->setOrderNr($this->getOrderNr());
$obj_chapter->dbSave();
$this->setOrderNr($arr_row['CHA_SORTORDER']);
}
break;
default:
$arr_chapters = $this->getMyPageObj()->getChapterArr(0,False);
$this->setOrderNr($movePos);
$int_curPos = 1;
foreach($arr_chapters as &$obj_chapter)
{
if ($obj_chapter->getId() != $this->getId())
{
if ($this->getOrderNr() == $int_curPos) $int_curPos++;
if ($obj_chapter->getOrderNr() != $int_curPos)
{
$obj_chapter->setOrderNr($int_curPos);
$obj_chapter->dbSave();
}
$int_curPos++;
}
}
if (($this->getOrderNr < 1) || ($this->getOrderNr() > $int_curPos))
{
$this->setOrderNr($int_curPos);
}
}
}
// ---------------------------------------------------------------------------
// online methods
// ---------------------------------------------------------------------------
/**
* returns if the template is online
*
* - check state
* - check show dates
*
* @param boolean $debug
*
* @return boolean
*/
public function isOnline($debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CMS_CHAPTER::isOnline()");
if (!$this->getMyPageObj($debug)->isOnline())
{
if ($debug) echoDebugMethod(__FILE__,__LINE__,"Page is offline");
return False;
}
if (!$this->getState()->isOnline())
{
if ($debug) echoDebugLine(__FILE__,__LINE__,"chapter has an offline state");
return False;
}
pcf_require_class('OCSP_DATE','common/');
$obj_date = new OCSP_DATE();
$obj_date->setDbString($this->getDBField('CHA_SHOWFROM'));
if ($obj_date->isInFutur())
{
if ($debug) echoDebugLine(__FILE__,__LINE__,"chapter will come in future");
return False;
}
$obj_date->setDbString($this->getDBField('CHA_SHOWTILL'));
if ($obj_date->isInPast())
{
if ($debug) echoDebugLine(__FILE__,__LINE__,"chapter is out of date");
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: <br />SELECT " . $str_showQuery . "<br /> failed");
return False;
}
}
return True;
}
// ---------------------------------------------------------------------------
// user rights
// ---------------------------------------------------------------------------
/**
* returns if a user can show the chapter
*
* NOTE does not check if the chapter is online
*
* @todo allow editors to ?
*
* @param boolean $debug
*
* @return boolean
*/
public function curUserCanShow($debug=False)
{
if ($this->getMyPageObj($debug)->curUserCanOpen($debug))
{
if (OCSP_OBJ::currentUser()->isGroupMember($this->getDBField('CHA_SHOWGROUP')))
{
return True;
}
} else {
echoDebugLine(__FILE__,__LINE__,"user can not open page");
return False;
}
return False;
}
public function curUserCanEdit($debug=False)
{
if ($this->getMyPageObj()->curUserCanEdit())
{
$int_grpId = $this->getState()->getEditGroup();
switch(TRUE)
{
case (_OCSP_GROUP_PROJ_ADMINGRP_ == $int_grpId):
return $this->getMyProject()->curUserIsAdmin();
case (_OCSP_GROUP_PROJ_EDITOR_GRP_ == $int_grpId):
return $this->getMyProject()->curUserIsEditor();
case (_OCSP_GROUP_PROJ_AUTHOR_GRP_ == $int_grpId):
return $this->getMyProject()->curUserIsAuthor();
default:
return OCSP_OBJ::currentUser(True)->isGroupMember($int_grpId);
}
}
}
// ---------------------------------------------------------------------------
// templates
// ---------------------------------------------------------------------------
/**
* returns the chapter template id
*
* @return int
*/
public function getTemplateId()
{
return intval($this->getDBField('CTMP_ID'));
}
/**
* returns the chapter template
*
* @param boolean $debug
* @return TMPL_CHAPTER
*/
public function getMyTemplate($debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CMS_CHAPTER::getTemplate()");
if (!pcf_is_instance_of($this->myTemplate,'TMPL_CHAPTER'))
{
$this->myTemplate = TMPL_CHAPTER::getInstance($this->getTemplateId());
}
return $this->myTemplate;
}
/**
* sets the template object AND column CTMP_ID
*
* @param TMPL_CHPATER $aTemplate
*
*/
public function setMyTemplate(&$aTemplate)
{
$this->myTemplate = $aTemplate;
$this->setDBField('CTMP_ID',$this->myTemplate->getId());
}
/**
* replaces dbGetForm and returns a OCSP_FORM
*
* @param int $mode
* @param mixed $form (string) form name (int) form id
* @param boolean $debug
*
* @return OCSP_FORM
*
* @requires CMS_CHAPTER_FORM.phpclass
*
* @since pk-08-01-14
*
* @todo $frmClass require check
*/
public function &getForm($mode=FRM_MODE_READONLY,$form='',$frmClass='CMS_CHAPTER_FORM',$debug=FALSE)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CMS_CHAPTER::getForm()");
if (!$this->getMyTemplate($debug))
{
if ($debug) echoDebugLine(__FILE__,__LINE__,"no template found");
if (!class_exists('CMS_CHAPTER_FORM'))
{
require_once dirname(__FILE__)._OCSP_DIRSEP_."CMS_CHAPTER_FORM.phpclass";
}
$obj_form=parent::getForm($mode,$form,'CMS_CHAPTER_FORM',$debug);
} else {
if ($debug) echoDebugLine(__FILE__,__LINE__,"template found: " . $this->myTemplate->getId());
$this->myTemplate->setConttable($this->myTable);
$obj_form=$this->myTemplate->getChapterForm($form,$frmClass,$debug);
$obj_form->setFrmMode($mode);
}
if (!pcf_class_implements($obj_form,'INFA_OCSP_FORM'))
{
throw new Exception(_OCSP_EXCEP_NOFORM_);
}
if ($debug) echoDebugLine(__FILE__,__LINE__,"Form loaded");
$obj_form->setMyTblObj($this);
if (!empty($this->myClassSrcFile))
{
$obj_form->setTblObjInc($this->getClassInclude());
$obj_form->setTblObjClass(get_class($this));
}
return $obj_form;
}
// ---------------------------------------------------------------------------
// rendering
// ---------------------------------------------------------------------------
/**
* renders the html content of the chapter
*
* @param boolean $debug
*
* @return string (html)
*/
public function render($debug=False)
{
if ($debug) echoDebugMethod(__FILE__,get_class($this),"CMS_CHAPTER::render()");
if ($this->myObjValsPopulateTS < (time() - ini_get('max_execution_time')))
{
$this->populateObjVals();
}
$arr_vals = array();
if ($this->myProjObj)
{
$arr_vals = array_merge($arr_vals,$this->myProjObj->getDBVal());
}
$arr_vals = array_merge($arr_vals,$this->getMyMenuNode()->getDBVal());
$arr_vals = array_merge($arr_vals,$this->getMyPageObj()->getDBVal());
$arr_vals = array_merge($arr_vals,$this->getDBVal());
if ($debug) echoDebugLine(__FILE__,__LINE__,"Chapter Template Values: <pre>" . print_r($arr_vals,True) . "</pre>" );
return $this->getMyTemplate($debug)->renderToHtml($arr_vals,$debug);
}
}
?>

Source for file CMS_CHAPTER.phpclass