Abstract Class JHtmlModules

Description
Description | Methods (details)
  • abstract:
  • since: 1.6

Located in /administrator/components/com_modules/helpers/html/modules.php (line 17) 


	
			







	
	

		
Method Summary

		

			Description |
												Methods (details)
		

		
			
			

											
				

					 
					static 						void
										batchOptions
										()
									

															
				

					 
					static 						array
										positionList
											([integer $clientId = 0])
									

															
				

					 
					static 						string
										positions
											(integer $clientId, [integer $state = 1], [string $selectedPosition = ''])
									

															
				

					 
					static 						string
										state
											(integer $value, integer $i, [boolean $enabled = true], [string $checkbox = 'cb'])
									

															
				

					 
					static 						array
										templates
											([integer $clientId = 0], [string $state = ''])
									

															
				

					 
					static 						array
										templateStates
										()
									

															
				

					 
					static 						array
										types
										()
									

																																																																							

		

	
		

	
	
	

		
Methods

		

			Description |
																Methods (details)
						
		

		

			



	
	

		
		static batchOptions (line 178)
	
 
	
	
	
    
				
  • access: public
    • 
			

	
	

		static void
		
			batchOptions
		
				()
			

	
		
			
	




	
	

		
		static positionList (line 198)
	
 
	
	

Method to get the field options.

	
    
				
  • return: The field option objects.
    • 
				
  • since: 2.5
    • 
				
  • access: public
    • 
			

	
	

		static array
		
			positionList
		
					([integer $clientId = 0])
			

	
			
    
					
  • 
				integer
				$clientId: The client ID			
    • 
				

		
			
	




	
	

		
		static positions (line 137)
	
 
	
	

Display a batch widget for the module position selector.

	
    
				
  • return: The necessary positions for the widget.
    • 
				
  • since: 2.5
    • 
				
  • access: public
    • 
			

	
	

		static string
		
			positions
		
					(integer $clientId, [integer $state = 1], [string $selectedPosition = ''])
			

	
			
    
					
  • 
				integer
				$clientId: The client ID.			
    • 
					
  • 
				integer
				$state: The state of the module (enabled, unenabled, trashed).			
    • 
					
  • 
				string
				$selectedPosition: The currently selected position for the module.			
    • 
				

		
			
	




	
	

		
		static state (line 81)
	
 
	
	

Returns a published state on a grid

	
    
				
  • return: The Html code
    • 
				
  • see: JHtmlJGrid::state
    • 
				
  • since: 1.7.1
    • 
				
  • access: public
    • 
			

	
	

		static string
		
			state
		
					(integer $value, integer $i, [boolean $enabled = true], [string $checkbox = 'cb'])
			

	
			
    
					
  • 
				integer
				$value: The state value.			
    • 
					
  • 
				integer
				$i: The row index			
    • 
					
  • 
				boolean
				$enabled: An optional setting for access control on the action.			
    • 
					
  • 
				string
				$checkbox: An optional prefix for checkboxes.			
    • 
				

		
			
	




	
	

		
		static templates (line 27)
	
 
	
	

Builds an array of template options

	
    
				
  • access: public
    • 
			

	
	

		static array
		
			templates
		
					([integer $clientId = 0], [string $state = ''])
			

	
			
    
					
  • 
				integer
				$clientId: The client id.			
    • 
					
  • 
				string
				$state: The state of the template.			
    • 
				

		
			
	




	
	

		
		static templateStates (line 59)
	
 
	
	

Builds an array of template state options

	
    
				
  • access: public
    • 
			

	
	

		static array
		
			templateStates
		
				()
			

	
		
			
	




	
	

		
		static types (line 45)
	
 
	
	

Builds an array of template type options

	
    
				
  • access: public
    • 
			

	
	

		static array
		
			types
		
				()
			

	
		
			
	

						
		

	


	
	

		Documentation generated on Tue, 19 Nov 2013 15:08:54 +0100 by phpDocumentor 1.4.3