Source for file CMS_CHAPTER_STATE.phpclass

Documentation is available at CMS_CHAPTER_STATE.phpclass

  1. <?php
  2. /**
  3.   * openCSP class file CMS_CHAPTER_STATE.phpclass
  4.   *
  5.   * @project Open CSP-Management
  6.   * @package default
  7.   *
  8.   * @author Peter Krebs <pitlinz@users.sourceforge.net>
  9.   * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  10.   *
  11.   * @since pk-17.10.2008
  12.   * @version $Id: INFA_CMS_CHAPTER.phpclass,v 1.2 2008/12/17 16:28:51 peterkrebs Exp $
  13.   */
  14.  
  15.     // ---------------------------------------------------------
  16.     // requirements
  17.     // ---------------------------------------------------------
  18.     
  19.     if (!defined('__OCSP_CMS_PHPINCPATH__')) 
  20.     {
  21.         require_once __OCSP_DEFAULTCONFPATH__ . "cms.conf.phpinc";
  22.     }
  23.  
  24. /**
  25.   * openCSP class CMS_CHAPTER_STATE
  26.   *
  27.   * @project Open CSP-Management
  28.   * @package default
  29.   *
  30.   * @author Peter Krebs <pitlinz@users.sourceforge.net>
  31.   * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  32.   *
  33.   * @since pk-18.12.2008
  34.   * @version $Id: CMS_CHAPTER_STATE.phpclass,v 1.2 2008/12/17 16:28:51 peterkrebs Exp $
  35.   */
  36. class CMS_CHAPTER_STATE
  37. {
  38.     // ---------------------------------------------------------------------------
  39.     // constants
  40.     // ---------------------------------------------------------------------------
  41.     
  42.  
  43.     // ---------------------------------------------------------------------------
  44.     // class (static)
  45.     // ---------------------------------------------------------------------------
  46.     
  47.     /*** class vars ------------------------------------------------------ */
  48.     
  49.     protected static $myStateInstances = array();
  50.     
  51.     /*** class methods --------------------------------------------------- */
  52.     
  53.     /**
  54.      * returns the state instance with ID $aId
  55.      * 
  56.      * @param int $aId 
  57.      * 
  58.      * @return CMS_CHAPTER_STATE 
  59.      */
  60.     public static function &getInstance($aId)
  61.     {
  62.         if (!isset(self::$myStateInstances[intval($aId)]))
  63.         {
  64.             self::$myStateInstances[intval($aId)] = new CMS_CHAPTER_STATE(intval($aId));
  65.         }
  66.         return self::$myStateInstances[intval($aId)];
  67.     }
  68.     
  69.     /**
  70.      * returns an array with all state instances
  71.      * 
  72.      * @return array 
  73.      */
  74.     public static function getAllStates()
  75.     {
  76.         if ($arr_states = OCSP_CONF::getInstance('OCSP_CMS')->getValue('CHAPTERSTATE'))
  77.         {
  78.             foreach($arr_states as $int_id => $arr_desc)
  79.             {
  80.                 if (!isset(self::$myStateInstances[$int_id]))
  81.                 {
  82.                     self::$myStateInstances[$int_id] = new CMS_CHAPTER_STATE($int_id,$arr_desc);
  83.                 }
  84.             }
  85.         }
  86.         
  87.         return self::$myStateInstances;
  88.     }
  89.     
  90.     // ---------------------------------------------------------------------------
  91.     // object vars
  92.     // ---------------------------------------------------------------------------
  93.     
  94.     /*** compostion --------------------------------------------------- */
  95.     
  96.     /*** attributes  -------------------------------------------------- */
  97.     
  98.     /**
  99.      * @var int $myid 
  100.      */
  101.     protected $myId = 0;
  102.     
  103.     /**
  104.      * array with state description
  105.      *
  106.      * - NAME
  107.      * - SHOW  (chapter is online by state)
  108.      * - ICON  (path)
  109.      * - GROUP (members can change state)
  110.      * 
  111.      * @var array $myDesc 
  112.      */
  113.     protected $myDesc = array();
  114.     
  115.     // ---------------------------------------------------------------------------
  116.     // factory / construct
  117.     // ---------------------------------------------------------------------------
  118.     
  119.     /**
  120.      * constructor
  121.      * 
  122.      * if no description array is passed in $aDesc the description is taken from  OCSP_CONF::getInstance('OCSP_CMS')
  123.      * 
  124.      * @param int $aId 
  125.      * @param array $aDesc 
  126.      * 
  127.      */
  128.     protected function __construct($aId,$aDesc=Null)
  129.     {
  130.         $this->myId = intval($aId);
  131.         if (!is_array($aDesc))
  132.         {
  133.             if ($arr_all = OCSP_CONF::getInstance('OCSP_CMS')->getValue('CHAPTERSTATE'))
  134.             {
  135.                 $this->myDesc = $arr_all[$this->myId];
  136.             }
  137.         } else {
  138.             $this->myDesc = $aDesc;        
  139.         }
  140.     }
  141.     
  142.     // ---------------------------------------------------------------------------
  143.     // getter / setter
  144.     // ---------------------------------------------------------------------------
  145.  
  146.     /**
  147.      * returns the state id
  148.      */
  149.     public function getId()
  150.     {
  151.         return $this->myId;
  152.     }
  153.         
  154.     /**
  155.      * returns the state name
  156.      *
  157.      * @return string 
  158.      */
  159.     public function getName()
  160.     {
  161.         return $this->myDesc['NAME'];
  162.     }
  163.     
  164.     /**
  165.      * returns the icon URL
  166.      * 
  167.      * @return string 
  168.      */
  169.     public function getIconUrl()
  170.     {
  171.         return $this->myDesc['ICON'];
  172.     }
  173.     
  174.     /**
  175.      * returns if the state is online
  176.      * 
  177.      * @return boolean 
  178.      */
  179.     public function isOnline()
  180.     {
  181.         return $this->myDesc['SHOW'];
  182.     }
  183.     
  184.     /**
  185.      * returns the group which can edit the chapter
  186.      * 
  187.      * @return int 
  188.      */
  189.     public function getEditGroup()
  190.     {
  191.         return (isset($this->myDesc['GROUP']) ? intval($this->myDesc['GROUP']) : _OCSP_GROUP_PROJ_ADMINGRP_);        
  192.     }
  193.     
  194.     // ---------------------------------------------------------------------------
  195.     // rights
  196.     // ---------------------------------------------------------------------------
  197.     
  198.     /**
  199.      * returns if the current user is in the state group
  200.      * 
  201.      * @param int $aProjId 
  202.      * 
  203.      * @return boolean 
  204.      */
  205.     public function curUserIsInGroup($aProjId)
  206.     {
  207.         $int_grpId = $this->getEditGroup();
  208.         if ($int_grpId >= _OCSP_GROUP_LOGGEDIN_)                    
  209.         {
  210.             return OCSP_OBJ::currentUser(True)->isGroupMember($int_grpId);
  211.         } else {
  212.             // check project groups
  213.             pcf_require_class('CMS_PROJECT',"cms/");
  214.             if ($obj_project = CMS_PROJECT::getInstance(intval($aProjId)))
  215.             {
  216.                 switch($int_grpId)
  217.                 {
  218.                     case _OCSP_GROUP_PROJ_AUTHOR_GRP_:
  219.                         return $obj_project->curUserIsAuthor();
  220.                     case _OCSP_GROUP_PROJ_EDITOR_GRP_:
  221.                         return $obj_project->curUserIsEditor();
  222.                     default:    
  223.                         return $obj_project->curUserIsAdmin();
  224.                 }
  225.             }                            
  226.         }        
  227.         return False;
  228.     }
  229.     
  230. }
  231.  
  232.  
  233. ?>

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