Source for file INFA_MOD_CMS_MENU_NODE.phpclass

Documentation is available at INFA_MOD_CMS_MENU_NODE.phpclass

  1. <?php
  2. /**
  3.   * openCSP interface file INFA_CMS_MENU_NODE.phpclass
  4.   *
  5.   * @project Open CSP-Management
  6.   * @package modules
  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-15.06.2008
  12.   * @version $Id: INFA_MOD_CMS_MENU_NODE.phpclass,v 1.6 2008/07/08 11:39:02 pitlinz Exp $
  13.   */
  14.  
  15.  
  16. pcf_require_interface('INFA_CMS_MENU_NODE',__OCSP_PHPINCPATH__ ."/cms/menu/INFA_CMS_MENU_NODE.phpclass");
  17.  
  18.  
  19. /**
  20.   * openCSP interface INFA_CMS_MENU_NODE
  21.   *
  22.   * @project Open CSP-Management
  23.   * @package modules
  24.   *
  25.   * @author Peter Krebs <pitlinz@users.sourceforge.net>
  26.   * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  27.   *
  28.   * @since pk-15.06.2008
  29.   * @version $Id: INFA_MOD_CMS_MENU_NODE.phpclass,v 1.6 2008/07/08 11:39:02 pitlinz Exp $
  30.   */
  31. interface INFA_MOD_CMS_MENU_NODE extends INFA_CMS_MENU_NODE
  32. {
  33.     /*** class constants  --------------------------------------------- */
  34.  
  35.     /*** compostion --------------------------------------------------- */
  36.     
  37.     /*** attributes  -------------------------------------------------- */
  38.     
  39.     /*** factory / construct  ----------------------------------------- */
  40.     
  41.     /*** getter / setter ---------------------------------------------- */
  42.     
  43.     /**
  44.       * returns the cms menu id
  45.       *
  46.       * @return int 
  47.       */
  48.     public function getMenId(); 
  49.     
  50.     /**
  51.       * returns the class source file (absolute path)
  52.       * 
  53.       * you can use __FILE__ if the class is final
  54.       * else ensure this returns the absolute path
  55.       * to the source file needed to be included
  56.       * if the class does not exists
  57.       * 
  58.       * @param boolean $debug 
  59.       * 
  60.       * @return string 
  61.       * 
  62.       */
  63.     public function getClassInclude($debug=False);
  64.  
  65.     /*** ocsp module methods   ----------------------------------- */
  66.     
  67.     /**
  68.      * returns the module the menu belongs to
  69.      * 
  70.      * @param boolean $debug 
  71.      * 
  72.      * @return OCSP_MODULE 
  73.      */
  74.     public function &getMyModule($debug=False);
  75.     
  76.  
  77.     /*** child nodes   ------------------------------------------ */
  78.     
  79.     /**
  80.      * factory of a child node
  81.      *
  82.      * @param array $childKeys 
  83.      * @param boolean $debug 
  84.      * 
  85.      * @return CMS_MENU_NODE 
  86.      */
  87.     public function &factoryChildNode($childKeys,$debug=False);
  88.     
  89. }
  90.  
  91. ?>

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