Interface IUserManager

Description
Description | Methods (details)

IUserManager interface

IUserManager specifies the interface that must be implemented by a user manager class if it is to be used together with TAuthManager and TUser.

  • since: 3.0
  • version: $Id: IUserManager.php 1398 2006-09-08 19:31:03Z xue $
  • author: Qiang Xue <qiang.xue@gmail.com>

Located in /Security/IUserManager.php (line 25) 


	
			







	
	

		
Method Summary

		

			Description |
												Methods (details)
		

		
			
			

								
				

											string
										getGuestName
										()
									

								
				

											TUser
										getUser
											([string $username = null])
									

								
				

											boolean
										validateUser
											(string $username, string $password)
									

							

		

	
		

	
	
	

		
Methods

		

			Description |
																Methods (details)
						
		

		

			



	
	

		getGuestName (line 30)
	
 
	
	
	
    
				
  • return: name for a guest user.
    • 
				
  • access: public
    • 
			

	
	

		string
		
			getGuestName
		
				()
			

	
		
		
	




	
	

		getUser (line 36)
	
 
	
	

Returns a user instance given the user name.

	
    
				
  • return: the user instance, null if the specified username is not in the user database.
    • 
				
  • access: public
    • 
			

	
	

		TUser
		
			getUser
		
					([string $username = null])
			

	
			
    
					
  • 
				string
				$username: user name, null if it is a guest.			
    • 
				

		
		
	




	
	

		validateUser (line 43)
	
 
	
	

Validates if the username and password are correct.

	
    
				
  • return: true if validation is successful, false otherwise.
    • 
				
  • access: public
    • 
			

	
	

		boolean
		
			validateUser
		
					(string $username, string $password)
			

	
			
    
					
  • 
				string
				$username: user name			
    • 
					
  • 
				string
				$password: password			
    • 
				

		
		
	

						
		

	



	

		Documentation generated on Sun, 14 Jan 2007 21:40:29 -0500 by phpDocumentor 1.3.0RC4