Class jMessage

Description
Description | Vars (details) | Methods (details)

Utility class to log some message in session in order to be displayed in a template

Located in /utils/jMessage.class.php (line 17) 


	
			






	
	

		
Variable Summary

		

			Description |
						Vars (details)
							| 
									Methods (details)
							
								

		

			

												

					static mixed
					$session_name
				

																							

		

	


	
	

		
Method Summary

		

			Description |
																		Vars (details)
				 
				|
						Methods (details)
		

		
			
			

										
				

					static 						void
										add
											(string $message, [string $type = 'default'])
									

														
				

					static 						void
										clear
											([string $type = 'default'])
									

														
				

					static 						void
										clearAll
										()
									

														
				

					static 						mixed
										get
											([string $type = 'default'])
									

														
				

					static 						mixed
										getAll
										()
									

																																																							

		

	
		

	
	

		
Variables

		

			Description |
										Vars (details)
						
			
										| 
									Methods (details)
							
					

		

			



	

		
			static mixed
			$session_name
			 =  'JELIX_MESSAGE'			(line 19)
		
	


	
	
    
				
  • access: protected
    • 
			

	
	
		
		




						
		

	

	
	
	

		
Methods

		

			Description |
															Vars (details)
																	Methods (details)
						
		

		

			



	
	

		static add (line 27)
	
 
	
	

Add a message

	
    
				
  • access: public
    • 
			

	
	

		static void
		
			add
		
					(string $message, [string $type = 'default'])
			

	
			
    
					
  • 
				string
				$message: the message			
    • 
					
  • 
				string
				$type: the message type ('default' by default)			
    • 
				

		
			
	




	
	

		static clear (line 35)
	
 
	
	

Clear messages for the given type

	
    
				
  • access: public
    • 
			

	
	

		static void
		
			clear
		
					([string $type = 'default'])
			

	
			
    
					
  • 
				string
				$type: the message type ('default' by default)			
    • 
				

		
			
	




	
	

		static clearAll (line 42)
	
 
	
	

Clear all messages

	
    
				
  • access: public
    • 
			

	
	

		static void
		
			clearAll
		
				()
			

	
		
			
	




	
	

		static get (line 51)
	
 
	
	

Get messages for the given type

	
    
				
  • return: array/null
    • 
				
  • access: public
    • 
			

	
	

		static mixed
		
			get
		
					([string $type = 'default'])
			

	
			
    
					
  • 
				string
				$type: the message type ('default' by default)			
    • 
				

		
			
	




	
	

		static getAll (line 63)
	
 
	
	

Get all messages

	
    
				
  • return: array/null
    • 
				
  • access: public
    • 
			

	
	

		static mixed
		
			getAll
		
				()
			

	
		
			
	

						
		

	



	

		Documentation generated on Mon, 19 Sep 2011 14:13:17 +0200 by phpDocumentor 1.4.3