Class Sieve_Comment

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

A Comment.

  • author: Mike Cochrane <mike@graftonhall.co.nz>
  • todo: This and Sieve_If should really extends a Sieve_Block eventually.
  • since: Ingo 0.1

Located in /lib/Script/sieve.php (line 2213) 


	
			






	
	

		
Variable Summary

		

			Description |
						Vars (details)
							| 
									Methods (details)
							
								

		

			

																								

					 
					mixed
					$_comment
				

											

		

	


	
	

		
Method Summary

		

			Description |
																		Vars (details)
				 
				|
						Methods (details)
		

		
			
			

																																															
				

					 
											Sieve_Comment
										Sieve_Comment
											(string $comment)
									

															
				

					 
											boolean|string
										check
										()
									

															
				

					 
											array
										requires
										()
									

															
				

					 
											string
										toCode
										()
									

											

		

	
		

	
	

		
Variables

		

			Description |
										Vars (details)
						
			
										| 
									Methods (details)
							
					

		

			




	

		
		
			mixed
			$_comment
						(line 2215)
		
	


	
	
	
		
		



						
		

	

	
	
	

		
Methods

		

			Description |
															Vars (details)
																	Methods (details)
						
		

		

			



	
	

		
		Constructor Sieve_Comment (line 2222)
	
 
	
	

Constructor.

	
	

		Sieve_Comment
		
			Sieve_Comment
		
					(string $comment)
			

	
			
    
					
  • 
				string
				$comment: The comment text.			
    • 
				

		
			
	




	
	

		
		check (line 2251)
	
 
	
	

Checks if the rule parameters are valid.

	
    
				
  • return: True if this rule is valid, an error message                          otherwise.
    • 
			

	
	

		boolean|string
		
			check
		
				()
			

	
		
			
	




	
	

		
		requires (line 2262)
	
 
	
	

Returns a list of sieve extensions required for this rule and any  sub-rules.

	
    
				
  • return: A Sieve extension list.
    • 
			

	
	

		array
		
			requires
		
				()
			

	
		
			
	




	
	

		
		toCode (line 2232)
	
 
	
	

Returns a script snippet representing this rule and any sub-rules.

	
    
				
  • return: A Sieve script snippet.
    • 
			

	
	

		string
		
			toCode
		
				()
			

	
		
			
	

						
		

	


	
	

		Documentation generated on Sun, 30 Jan 2011 05:29:30 +0000 by phpDocumentor 1.4.3