Abstract Class JModuleHelper

Description
Description | Methods (details)

Module helper class

  • abstract:
  • since: 1.5

Located in /libraries/cms/module/helper.php (line 19) 


	
			







	
	

		
Method Summary

		

			Description |
												Methods (details)
		

		
			
			

											
				

					 
					static 						string
										getLayoutPath
											(string $module, [string $layout = 'default'])
									

															
				

					 
					static 						object The
										&getModule
											(string $name, [string $title = null])
									

															
				

					 
					static 						array
										&getModules
											(string $position)
									

															
				

					 
					static 						boolean
										isEnabled
											(string $module)
									

															
				

					 
					static 						array
										&load
										()
									

															
				

					 
					static 						string
										moduleCache
											(object $module, object $moduleparams, object $cacheparams)
									

															
				

					 
					static 						string
										renderModule
											(object $module, [array $attribs = array()])
									

															
				

					 
					static 						array
										&_load
										()
									

																																																																															

		

	
		

	
	
	

		
Methods

		

			Description |
																Methods (details)
						
		

		

			



	
	

		
		static getLayoutPath (line 257)
	
 
	
	

Get the path to a layout for a module

	
    
				
  • return: The path to the module layout
    • 
				
  • since: 1.5
    • 
				
  • access: public
    • 
			

	
	

		static string
		
			getLayoutPath
		
					(string $module, [string $layout = 'default'])
			

	
			
    
					
  • 
				string
				$module: The name of the module			
    • 
					
  • 
				string
				$layout: The name of the module layout. If alternative layout, in the form template:filename.			
    • 
				

		
			
	




	
	

		
		static getModule (line 31)
	
 
	
	

Get module by name (real, eg 'Breadcrumbs' or folder, eg 'mod_breadcrumbs')

	
    
				
  • return: Module object
    • 
				
  • since: 1.5
    • 
				
  • access: public
    • 
			

	
	

		static object The
		
			&getModule
		
					(string $name, [string $title = null])
			

	
			
    
					
  • 
				string
				$name: The name of the module			
    • 
					
  • 
				string
				$title: The title of the module, optional			
    • 
				

		
			
	




	
	

		
		static getModules (line 78)
	
 
	
	

Get modules by position

	
    
				
  • return: An array of module objects
    • 
				
  • since: 1.5
    • 
				
  • access: public
    • 
			

	
	

		static array
		
			&getModules
		
					(string $position)
			

	
			
    
					
  • 
				string
				$position: The position of the module			
    • 
				

		
			
	




	
	

		
		static isEnabled (line 121)
	
 
	
	

Checks if a module is enabled. A given module will only be returned  if it meets the following criteria: it is enabled, it is assigned to  the current menu item or all items, and the user meets the access level  requirements.

	
    
				
  • return: See description for conditions.
    • 
				
  • since: 1.5
    • 
				
  • access: public
    • 
			

	
	

		static boolean
		
			isEnabled
		
					(string $module)
			

	
			
    
					
  • 
				string
				$module: The module name			
    • 
				

		
			
	




	
	

		
		static load (line 311)
	
 
	
	

Load published modules.

	
    
				
  • since: 3.2
    • 
				
  • access: protected
    • 
			

	
	

		static array
		
			&load
		
				()
			

	
		
			
	




	
	

		
		static moduleCache (line 432)
	
 
	
	

Module cache helper


Caching modes:  To be set in XML:  'static'      One cache file for all pages with the same module parameters  'oldstatic'   1.5 definition of module caching, one cache file for all pages                with the same module id and user aid,  'itemid'      Changes on itemid change, to be called from inside the module:  'safeuri'     Id created from $cacheparams->modeparams array,  'id'          Module sets own cache id's

	
	
	

		static string
		
			moduleCache
		
					(object $module, object $moduleparams, object $cacheparams)
			

	
			
    
					
  • 
				object
				$module: Module object			
    • 
					
  • 
				object
				$moduleparams: Module parameters			
    • 
					
  • 
				object
				$cacheparams: Module cache parameters - id or url parameters, depending on the module cache mode			
    • 
				

		
			
	




	
	

		
		static renderModule (line 138)
	
 
	
	

Render the module.

	
    
				
  • return: The HTML content of the module output.
    • 
				
  • since: 1.5
    • 
				
  • access: public
    • 
			

	
	

		static string
		
			renderModule
		
					(object $module, [array $attribs = array()])
			

	
			
    
					
  • 
				object
				$module: A module object.			
    • 
					
  • 
				array
				$attribs: An array of attributes for the module (probably from the XML).			
    • 
				

		
			
	




	
	

		
		static _load (line 299)
	
 
	
	

Load published modules.

	
    
				
  • deprecated: 4.0  Use JModuleHelper::load() instead
    • 
				
  • since: 1.5
    • 
				
  • access: protected
    • 
			

	
	

		static array
		
			&_load
		
				()
			

	
		
			
	

						
		

	


	
	

		Documentation generated on Tue, 19 Nov 2013 15:04:40 +0100 by phpDocumentor 1.4.3