Class AuthenticationToken

Description
Description | Methods (details)

A authentication token

Holds the data associated with a token and will be stored serialized in some storage location.

Located in /phpsatk-lib/global/org.eenterphace.sat.auth.token/authentication.token.php (line 39) 


	
			







	
	

		
Method Summary

		

			Description |
												Methods (details)
		

		
			
			

								
				

											AuthenticationToken
										__construct
											(string $tokid, string $user, [int $lifetime = null], string $pass)
									

								
				

											void
										destroy
										()
									

								
				

											string
										getPassword
										()
									

								
				

											string
										getUsername
										()
									

								
				

											boolean
										isValid
										()
									

							

		

	
		

	
	
	

		
Methods

		

			Description |
																Methods (details)
						
		

		

			



	
	

		Constructor __construct (line 71)
	
 
	
	

Initializes a token

	
    
				
  • access: public
    • 
			

	
	

		AuthenticationToken
		
			__construct
		
					(string $tokid, string $user, [int $lifetime = null], string $pass)
			

	
			
    
					
  • 
				string
				$tokid: My Token ID			
    • 
					
  • 
				string
				$user: Username to authenticate with			
    • 
					
  • 
				string
				$pass: Password to authenticate with			
    • 
					
  • 
				int
				$lifetime: Time this token is valid (in seconds)			
    • 
				

		
		
	




	
	

		destroy (line 122)
	
 
	
	

Destroys/revokes this token

	
    
				
  • access: public
    • 
			

	
	

		void
		
			destroy
		
				()
			

	
		
		
	




	
	

		getPassword (line 114)
	
 
	
	

Gets the password to authenticate with when this token is used

	
    
				
  • access: public
    • 
			

	
	

		string
		
			getPassword
		
				()
			

	
		
		
	




	
	

		getUsername (line 105)
	
 
	
	

Gets the username to authenticate with when this token is used

	
    
				
  • access: public
    • 
			

	
	

		string
		
			getUsername
		
				()
			

	
		
		
	




	
	

		isValid (line 89)
	
 
	
	

Checks whether this token is valid


A token becomes invalid when it's lifetime expires

	
    
				
  • access: public
    • 
			

	
	

		boolean
		
			isValid
		
				()
			

	
		
		
	

						
		

	



	

		Documentation generated on Mon, 21 May 2007 10:34:43 +0200 by phpDocumentor 1.3.0RC5