bigace.classes.user
[ class tree: bigace.classes.user ] [ index: bigace.classes.user ] [ all elements ]
Packages:
bigace.classes.administration
bigace.classes.category
bigace.classes.email
bigace.classes.file
bigace.classes.fright
bigace.classes.group
bigace.classes.guestbook
bigace.classes.image
bigace.classes.item
bigace.classes.language
bigace.classes.layout
bigace.classes.logger
bigace.classes.menu
bigace.classes.modul
bigace.classes.parser
bigace.classes.right
bigace.classes.search
bigace.classes.session
bigace.classes.sql
bigace.classes.statistic
bigace.classes.template
bigace.classes.user
bigace.command
bigace.library

Files:
UserAdminService.php
UserAuthenticate.php
UserData.php
UserDataAdminService.php
UserDataService.php
UserEnumeration.php
UserInfo.php
UserService.php

Classes:
UserAdminService
UserAuthenticate
UserData
UserDataAdminService
UserDataService
UserEnumeration
UserInfo
UserService

Class: UserAuthenticate

Source Location: /classes/user/UserAuthenticate.php

Class Overview




This class is only used for logging User into the System.














Variables







Methods
















Inherited Constants





Inherited Variables





Inherited Methods














Class Details



[line 31]

This class is only used for logging User into the System.

You normally do not have to ask for username and password!





[ Top ]







Class Variables



	
	

	
$correct_login = 

	
[line 34]

  
  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$loginInfo = 

	
[line 33]

  
  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]










Class Methods



  

	
	
constructor UserAuthenticate [line 44]

	

    

    

		UserAuthenticate UserAuthenticate(
String
$username, String
$pass)
    

    


	
		Identifies a User in BIGACE by comapring Username/Password against the existing User Data.

This Object will treat the User as a anonymous (all+) User if name or password is empty,  being sure that a User cannot have an empty password.






        
Parameters:

    

    

          

        String  
        $username  
        the Username within BIGACE
      

          

        String  
        $pass  
        the Password for that User
      

        

    


        
[ Top ]

  

  

	
	
method getID [line 136]

	

    

    

		int getID(
)
    

    


	
		Gets the User ID.





Tags:





  

    return:  the User ID in BIGACE
  










        
[ Top ]

  

  

	
	
method getLanguageID [line 146]

	

    

    

		int getLanguageID(
)
    

    


	
		Fetches the users language ID.





Tags:





  

    return:  the language ID
  










        
[ Top ]

  

  

	
	
method isActive [line 115]

	

    

    

		boolean isActive(
)
    

    


	
		Gets the Users status within BIGACE, if false the User will not be able to LOG IN or  handle any other thing in BIGACE. This is useful if you want to keep all Right Information  and personal data but don't let the user work for now.

If User is not known it will return the same as 
  1. isValidUser()
    2. 

.





Tags:





  

    return:  the Users status for BIGACE
  










        
[ Top ]

  

  

	
	
method isAnonymous [line 99]

	

    

    

		boolean isAnonymous(
)
    

    


	
		Gets the Information if user is anonymous.





Tags:





  

    return:  if User is anonymous
  










        
[ Top ]

  

  

	
	
method isValidUser [line 82]

	

    

    

		boolean isValidUser(
)
    

    


	
		Shows if the User is registered within BIGACE.

It returns true even if the Users status is inactive!





Tags:





  

    return:  true if user is known, else false
  










        
[ Top ]

  






        

		    

		    Documentation generated on Tue, 11 Oct 2005 23:02:21 +0200 by phpDocumentor 1.3.0RC2