Source for file INFA_CMS_MENU_NODE.phpclass

Documentation is available at INFA_CMS_MENU_NODE.phpclass

  1. <?php
  2. /**
  3.   * openCSP interface file INFA_CMS_MENU_NODE.phpclass
  4.   *
  5.   * @project Open CSP-Management
  6.   * @package cms
  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-13.06.2008
  12.   * @version $Id: INFA_CMS_MENU_NODE.phpclass,v 1.12 2008/12/03 09:47:56 pitlinz Exp $
  13.   */
  14.  
  15. // ---------------------------------------------------------
  16. // requirements
  17. // ---------------------------------------------------------
  18.  
  19. pcf_require_interface('INFA_DBMS_TABLEOBJ',__OCSP_PHPINCPATH__ . "db/INFA_DBMS_TABLEOBJ.phpclass");
  20.  
  21. /**
  22.   * openCSP interface INFA_CMS_MENU_NODE
  23.   *
  24.   * @project Open CSP-Management
  25.   * @package cms
  26.   *
  27.   * @author Peter Krebs <pitlinz@users.sourceforge.net>
  28.   * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  29.   *
  30.   * @since pk-13.06.2008
  31.   * @version $Id: INFA_CMS_MENU_NODE.phpclass,v 1.12 2008/12/03 09:47:56 pitlinz Exp $
  32.   */
  33. interface INFA_CMS_MENU_NODE
  34. {
  35.     // ---------------------------------------------------------------------------
  36.     // constants
  37.     // ---------------------------------------------------------------------------
  38.     
  39.     // ---------------------------------------------------------------------------
  40.     // class (static)
  41.     // ---------------------------------------------------------------------------
  42.     
  43.     /*** class vars ------------------------------------------------------ */
  44.     
  45.     /*** class methods --------------------------------------------------- */
  46.     
  47.     // ---------------------------------------------------------------------------
  48.     // object vars
  49.     // ---------------------------------------------------------------------------
  50.     
  51.     /*** compostion --------------------------------------------------- */
  52.     
  53.     /*** attributes  -------------------------------------------------- */
  54.         
  55.     // ---------------------------------------------------------------------------
  56.     // factory / construct
  57.     // ---------------------------------------------------------------------------
  58.     
  59.     // ---------------------------------------------------------------------------
  60.     // getter / setter
  61.     // ---------------------------------------------------------------------------
  62.         
  63.     /**
  64.      * returns the menu key
  65.      * 
  66.      * the menu key is a '-' seperated string
  67.      * where the 1st part is the ocsp MEN_ID
  68.      * 
  69.      * @return string 
  70.      */
  71.     public function getKey();
  72.     
  73.     /**
  74.      * returns the menu id
  75.      *
  76.      * @return int 
  77.      */
  78.     public function getId();
  79.     
  80.     /**
  81.      * @param int $langId 
  82.      * @param boolean $debug 
  83.      *
  84.      * @return string 
  85.      *
  86.      */
  87.     public function getTitle($langId=0,$debug=False);    
  88.     
  89.     /**
  90.       * returns the orderNr
  91.       *
  92.       * @return int 
  93.       *
  94.       ***/
  95.     public function getOrderNr();
  96.     
  97.     /**
  98.       * sets the OrderNr
  99.       *
  100.       * @param int $aOrderNr 
  101.       *
  102.       ***/
  103.     public function setOrderNr($aOrderNr);    
  104.     
  105.     // ---------------------------------------------------------------------------
  106.     // navigation / output methods
  107.     // ---------------------------------------------------------------------------
  108.  
  109.     /**
  110.       * returns the link url
  111.       *
  112.       * @param array $valArr 
  113.       * @param boolean $debug 
  114.       *
  115.       * @return string 
  116.       *
  117.       */
  118.     public function getLinkUrl($valArr=array(),$debug=False);
  119.     
  120.     // ---------------------------------------------------------------------------
  121.     // tree methods
  122.     // ---------------------------------------------------------------------------
  123.         
  124.     /**
  125.       * returns myTree object
  126.       *
  127.       * @param boolean $useCache 
  128.       * @param boolean $debug 
  129.       * @param boolean $checkParent (if false $this->getParentObj is not called)
  130.       *
  131.       * @return CMS_MENU 
  132.       *
  133.       */
  134.     function &getTree($useCache=True,$debug=False,$checkParent=True);    
  135.     
  136.     /**
  137.       * sets the tree object
  138.       *
  139.       * @param CMS_MENU $aTree 
  140.       *
  141.       */
  142.     function setTreeObj(&$aTree);    
  143.     
  144.      /**
  145.       * returns the parent object or null if parent is root
  146.       *
  147.       * @param boolean $useCache 
  148.       * @param boolean $debug 
  149.       *
  150.       * @return CMS_MENU_NODE 
  151.       *
  152.       */
  153.     function &getParentObj($useCache=True,$debug=False); 
  154.         
  155.     /**
  156.      * sets the parent object
  157.      * @param CMS_MENU_NODE $aParent 
  158.      */
  159.     function setParentObj(&$aParent);
  160.     
  161.     /**
  162.       * returns a array back to the root
  163.       *
  164.       * @param boolean $useCache 
  165.       * @param boolean $debug 
  166.       *
  167.       * @return array 
  168.       */
  169.     function getRootPath($useCache=True,$debug=False);    
  170.     
  171.     // ---------------------------------------------------------------------------
  172.     // child nodes 
  173.     // ---------------------------------------------------------------------------    
  174.     
  175.     /**
  176.       * returns if the node has children
  177.       *
  178.       * @param boolean $debug 
  179.       *
  180.       * @return boolean 
  181.       */    
  182.     public function hasChildren($debug=False);    
  183.     
  184.     /**
  185.       * returns a array of pointers to the child objects
  186.       *
  187.       * if filtered $this->myFilterArr is used to check the child
  188.       *
  189.       * @param boolean $useCache 
  190.       * @param boolean $debug 
  191.       * @param boolean $filtered 
  192.       *
  193.       * @global array $OCSP_VAL 
  194.       *
  195.       * @return array 
  196.       *
  197.       */
  198.     function getChildrenList($useCache=True,$debug=False,$filtered=False); 
  199.     
  200.     
  201.     // ---------------------------------------------------------------------------
  202.     // cms project methods
  203.     // ---------------------------------------------------------------------------
  204.       
  205.     /**
  206.       * returns the Project Object
  207.       *
  208.       * @param boolean $debug 
  209.       * @param boolean $forceObj (if false no new object will be instanciated)
  210.       * @param boolean $setAsCurrent (if true call $this->setAsCurrent())
  211.       *
  212.       * @return CMS_PROJECT 
  213.       *
  214.       */
  215.     function &getMyProject($debug=False,$forceObj=True,$setAsCurrent=False);     
  216.  
  217.     // ---------------------------------------------------------------------------
  218.     // cms menu methods
  219.     // ---------------------------------------------------------------------------
  220.     
  221.     /**
  222.       * checks if the menu is to show from date
  223.       *
  224.       * return values are:
  225.       *
  226.       * - 1: yes
  227.       * - 0: showtill is outdate
  228.       * - -2: showfrom is not reached
  229.       *
  230.       * @return int 
  231.       *
  232.       */
  233.     function checkShowDate($debug=False);
  234.     
  235.     /**
  236.       * checks if the node is on
  237.       *
  238.       * @param boolean $checkDate 
  239.       * @param boolean $checkGroup 
  240.       * @param boolean $debug 
  241.       * @param boolean $checkShow 
  242.       *
  243.       * @return bool 
  244.       */
  245.     function isToShow($checkDate=True,$checkGroup=True,$debug=False,$checkShow=True);
  246.         
  247.     /**
  248.       * returns if the object is to echo in the tree when creating the html-code
  249.       * or only children are to show instead of the node
  250.       *
  251.       * @param boolean $debug 
  252.       *
  253.       * @return boolean 
  254.       *
  255.       */
  256.     function isToEcho($debug=False);    
  257.     
  258.     /**
  259.       * checks if the menu is the current menu
  260.       *
  261.       * @param boolean $debug 
  262.       *
  263.       * @return boolean 
  264.       *
  265.       */
  266.     function isCurrent($debug=False);    
  267.     
  268.     /**
  269.       * sets the node as current menu node
  270.       * @param boolean $debug 
  271.       */
  272.     function setAsCurrent($debug=False);
  273.     
  274.     /**
  275.      * returns if the node is editable
  276.      *
  277.      * @param boolean $debug 
  278.      * @return boolean 
  279.      */
  280.     public function isEditable($debug=False);    
  281.     
  282.     /**
  283.      * return if the menu type can have editable pages
  284.      * 
  285.      * if not the menu generates it's page object himself
  286.      * users are not able to add pages to the menu
  287.      *
  288.      * @param boolean $debug 
  289.      * 
  290.      * @return boolean 
  291.      * 
  292.      * @since pk-08-12-03
  293.      */
  294.     public function hasEditablePages($debug=False);    
  295.     
  296.     // ---------------------------------------------------------------------------
  297.     // cms page methods
  298.     // ---------------------------------------------------------------------------
  299.     
  300.     /**
  301.       * returns the current Page
  302.       * this is the first page found and the user has rights to show
  303.       *
  304.       * @param boolean $goDown (check children if the node has no page to show)
  305.       * @param boolean $online (check if the page is online if false all pages are returned)
  306.       * @param array $xtraConditions (array of columns to check to)
  307.       * @param boolean $debug 
  308.       *
  309.       * @return CMS_PAGE 
  310.       *
  311.       */
  312.     function &getCurrentPage($goDown=False,$online=True,$xtraConditions=Null,$debug=False);
  313.     
  314.     /**
  315.      * returns the template id set in menu or project
  316.      *
  317.      * @param boolean $debug 
  318.      * 
  319.      * @return int 
  320.      * 
  321.      * @since pk-08-06-16
  322.      */
  323.     public function getTemplateId($debug=False);    
  324.     
  325.     // ---------------------------------------------------------------------------
  326.     // user / rights
  327.     // ---------------------------------------------------------------------------
  328.     
  329.     /**
  330.       * returns if the current user can open the menu
  331.       *
  332.       * @param boolean $debug 
  333.       *
  334.       * @return boolean 
  335.       *
  336.       */
  337.     function curUserCanOpen($debug=False);
  338.     
  339.     /**
  340.       * returns if the current user can add a childmenu
  341.       *
  342.       * @param boolean $debug 
  343.       *
  344.       * @return boolean 
  345.       *
  346.       */
  347.     function curUserCanAddChild($debug=False);    
  348.     
  349.     /**
  350.       * returns if the current user can add a page
  351.       *
  352.       * @param boolean $debug 
  353.       *
  354.       * @return boolean 
  355.       *
  356.       */
  357.     function curUserCanAddPage($debug=False);  
  358.  
  359.     /**
  360.       * returns if the current user can delete the menu
  361.       *
  362.       * @param boolean $debug 
  363.       *
  364.       * @return boolean 
  365.       *
  366.       */
  367.     function curUserCanDelete($debug=False);
  368.  
  369.     /**
  370.       * returns if the current user can edit the menu
  371.       *
  372.       * @param boolean $debug 
  373.       *
  374.       * @return boolean 
  375.       *
  376.       * @since pk-06-11-06
  377.       *
  378.       ***/
  379.     function curUserCanEdit($debug=False);  
  380.  
  381. }
  382.  
  383. ?>

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