Class Wicked

Description
Description | Methods (details)

Wicked Base Class.

$Horde: wicked/lib/Wicked.php,v 1.43.2.4 2010/02/14 17:46:01 jan Exp $

Copyright 2003-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (GPL). If you did not receive this file, see http://www.fsf.org/copyleft/gpl.html.

Located in /lib/Wicked.php (line 66) 


	
			







	
	

		
Method Summary

		

			Description |
												Methods (details)
		

		
			
			

																																																							
				

					 
											string
										getCAPTCHA
											([boolean $new = false])
									

															
				

					 
											void
										getMenu
											([ $returnType = 'object'])
									

															
				

					 
											string
										lockUser
										()
									

															
				

					 
											mixed
										mail
											(string $message, [array $headers = array()])
									

															
				

					 
											string
										url
											(string $page, [boolean $full = false], [integer $append_session = 0])
									

											

		

	
		

	
	
	

		
Methods

		

			Description |
																Methods (details)
						
		

		

			



	
	

		
		getCAPTCHA (line 204)
	
 
	
	

Generate a CAPTCHA string.

	
    
				
  • return: A CAPTCHA string.
    • 
			

	
	

		string
		
			getCAPTCHA
		
					([boolean $new = false])
			

	
			
    
					
  • 
				boolean
				$new: If true, a new CAPTCHA is created and returned.                       The current, to-be-confirmed string otherwise.			
    • 
				

		
			
	




	
	

		
		getMenu (line 94)
	
 
	
	

Build Wicked's list of menu items.

	
	

		void
		
			getMenu
		
					([ $returnType = 'object'])
			

	
			
    
					
  • 
				
				$returnType			
    • 
				

		
			
	




	
	

		
		lockUser (line 221)
	
 
	
	

Returns the user name that is used for locking, either the current user  or the current IP address.

	
    
				
  • return: The user name used for locking.
    • 
			

	
	

		string
		
			lockUser
		
				()
			

	
		
			
	




	
	

		
		mail (line 142)
	
 
	
	

Mails a notification message after encoding the headers and adding the  standard username/time line.

	
    
				
  • return: The result of the send mail call.
    • 
			

	
	

		mixed
		
			mail
		
					(string $message, [array $headers = array()])
			

	
			
    
					
  • 
				string
				$message: The message text to send out.			
    • 
					
  • 
				array
				$headers: Additional headers to add to the email.			
    • 
				

		
			
	




	
	

		
		url (line 78)
	
 
	
	

Puts together the URL to a Wicked page. Uses mod_rewrite or GET  style URLs depending on configuration.

	
    
				
  • return: The URL of $page.
    • 
			

	
	

		string
		
			url
		
					(string $page, [boolean $full = false], [integer $append_session = 0])
			

	
			
    
					
  • 
				string
				$page: The name of the page to target.			
    • 
					
  • 
				boolean
				$full: @see Horde::url()			
    • 
					
  • 
				integer
				$append_session: @see Horde::url()			
    • 
				

		
			
	

						
		

	


	
	

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