Class MenuThemeInterface

Description
Description | Methods (details)

A 

  1. MenuTheme
    2.
is an extension of the generic 
  1. Theme
    2.
interface that adds support for multi-level navigation menus. A 
  1. MenuTheme
    2.
, like a normal </code>Theme</code> has a single 
  1. Component
    2.
; however, it allows the user to surround that component with multi-level navigation menus.

  • version: $Id: MenuTheme.interface.php,v 1.2 2007/09/04 20:25:21 adamfranco Exp $
  • license: GNU General Public License (GPL)
  • copyright: Copyright &copy; 2005, Middlebury College

Located in /harmoni/core/GUIManager/MenuTheme.interface.php (line 19) 


	
			







	
	

		
Method Summary

		

			Description |
												Methods (details)
		

		
			
			

								
				

											void
										addMenu
											(ref $menu, integer $level)
									

								
				

											ref
										getMenu
											(integer $menu, mixed $level)
									

								
				

											integer
										getNumberOfMenus
										()
									

							

		

	
		

	
	
	

		
Methods

		

			Description |
																Methods (details)
						
		

		

			



	
	

		addMenu (line 29)
	
 
	
	

Adds a new menu to this theme.

	
    
				
  • access: public
    • 
			

	
	

		void
		
			addMenu
		
					(ref $menu, integer $level)
			

	
			
    
					
  • 
				ref
				$menu: object menu A 
    1. Menu
      2. 

     object to be added to this theme.    			
    • 
					
  • 
				integer
				$level: level A postivive integer specifying the 
    1. level
      2. 

     of the  menu that is being added. Only one menu can exist at any given level.  Levels cannot be skipped. Levels allow the user to create a hierarchy of menus.    			
    • 
				

		
		
	




	
	

		getMenu (line 42)
	
 
	
	

Returns the menu (if exists) at the given level.

	
    
				
  • return: object The 
    1. Menu
      2. 

     object at the specified level, or 
    1. NULL
      2. 

      if no menu was found.
    • 
				
  • access: public
    • 
			

	
	

		ref
		
			getMenu
		
					(integer $menu, mixed $level)
			

	
			
    
					
  • 
				integer
				$menu: level An integer specifying the 
    1. level
      2. 

     of the  menu that is to be returned. Levels start at 1. Only one menu can exist at any given level.  Levels cannot be skipped. Levels allow the user to create a hierarchy of menus.    			
    • 
				

		
		
	




	
	

		getNumberOfMenus (line 51)
	
 
	
	

Returns the number of menus in this Theme.

	
    
				
  • return: The number of menus.
    • 
				
  • access: public
    • 
			

	
	

		integer
		
			getNumberOfMenus
		
				()
			

	
		
		
	

						
		

	



	

		Documentation generated on Wed, 19 Sep 2007 10:25:04 -0400 by phpDocumentor 1.3.0RC3