ClassInterface Zend_Search_Lucene_Search_Highlighter_Interface

Description
Description | Methods (details)
  • copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  • license: New BSD License

Located in /Search/Lucene/Search/Highlighter/Interface.php (line 31) 


	
			







	
	

		
Method Summary

		

			Description |
												Methods (details)
		

		
			
			

																																							
				

					 
											Zend_Search_Lucene_Document_Html
										getDocument
										()
									

															
				

					 
											void
										highlight
											(string|array $words)
									

															
				

					 
											void
										setDocument
											(Zend_Search_Lucene_Document_Html $document)
									

											

		

	
		

	
	
	

		
Methods

		

			Description |
																Methods (details)
						
		

		

			



	
	

		
		getDocument (line 45)
	
 
	
	

Get document for highlighting.

	
    
				
  • access: public
    • 
			

	
	

		Zend_Search_Lucene_Document_Html
		
			getDocument
		
				()
			

	
		
			
	




	
	

		
		highlight (line 52)
	
 
	
	

Highlight specified words (method is invoked once per subquery)

	
    
				
  • access: public
    • 
			

	
	

		void
		
			highlight
		
					(string|array $words)
			

	
			
    
					
  • 
				string|array
				$words: Words to highlight. They could be organized using the array or string.			
    • 
				

		
			
	




	
	

		
		setDocument (line 38)
	
 
	
	

Set document for highlighting.

	
    
				
  • access: public
    • 
			

	
	

		void
		
			setDocument
		
					(Zend_Search_Lucene_Document_Html $document)
			

	
			
		
			
	

						
		

	


	
	

		Documentation generated on Mon, 21 Jun 2010 15:29:43 -0400 by phpDocumentor 1.4.3