Class Savant3_Filter

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

Abstract Savant3_Filter class.

You have to extend this class for it to be useful; e.g., "class Savant3_Filter_example extends Savant3_Filter".

Located in /Savant3/Filter.php (line 30) 


	
			




	
	

		
Direct descendents

		

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

		

			

				

					Class
					Description
				

								

					Savant3_Filter_trimwhitespace
					
											Filter to remove extra white space within the text.
										
				

							

		

	



	
	

		
Variable Summary

		

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

		

			

																								

					object
					$Savant
				

											

		

	


	
	

		
Method Summary

		

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

		
			
			

																				

					static 						string
										filter
											(string $text)
									

								
												

											void
										__construct
											([array $conf = null])
									

																

		

	
		

	
	

		
Variables

		

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

		

			



	

		
			object
			$Savant
			 =  null			(line 43)
		
	


	

Optional reference to the calling Savant object.

	
    
				
  • access: protected
    • 
			

	
	
		
		



						
		

	

	
	
	

		
Methods

		

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

		

			



	
	

		static method filter (line 80)
	
 
	
	

Stub method for extended behaviors.

	
    
				
  • return: The text buffer after it has been filtered.
    • 
				
  • access: public
    • 
			

	
	

	    static
		string
		
			filter
		
					(string $text)
			

	
			
    
					
  • 
				string
				$text: The text buffer to filter.			
    • 
				

		
			
			

		
Redefined in descendants as:

		
	





	
	

		Constructor __construct (line 59)
	
 
	
	

Constructor.

	
    
				
  • access: public
    • 
			

	
	

		void
		
			__construct
		
					([array $conf = null])
			

	
			
    
					
  • 
				array
				$conf: An array of configuration keys and values for  this filter.			
    • 
				

		
			
	

						
		

	



	

		Documentation generated on Tue, 31 Mar 2009 16:24:42 -0500 by phpDocumentor 1.4.2