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: UserInfo

Source Location: /classes/user/UserInfo.php

Class Overview




This represents a User.














Variables







Methods
















Inherited Constants





Inherited Variables





Inherited Methods














Class Details



[line 30]

This represents a User.





[ Top ]







Class Variables



	
	

	
$userx = 

	
[line 32]

  
  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$valid =  true

	
[line 33]

  
  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]










Class Methods



  

	
	
constructor UserInfo [line 40]

	

    

    

		UserInfo UserInfo(
int
$id)
    

    


	
		Initializes the Object with the User by the given ID






        
Parameters:

    

    

          

        int  
        $id  
        the User ID
      

        

    


        
[ Top ]

  

  

	
	
method getActiveStatusID [line 111]

	

    

    

		int getActiveStatusID(
)
    

    


	
		Gets the Status ID as it is hold in the DB





Tags:





  

    return:  the Status ID for the initialized User
  










        
[ Top ]

  

  

	
	
method getGroup [line 197]

	

    

    

		void getGroup(
)
    

    


	
		Returns the Group this User belongs to.






        
[ Top ]

  

  

	
	
method getGroupID [line 190]

	

    

    

		void getGroupID(
)
    

    


	
		Returns the Group ID for this User.






        
[ Top ]

  

  

	
	
method getID [line 128]

	

    

    

		void getID(
)
    

    


	
		Wrapper for getUserID()






        
[ Top ]

  

  

	
	
method getLanguageID [line 146]

	

    

    

		int getLanguageID(
)
    

    


	
		Gets the Language ID for this User.





Tags:





  

    return:  the language ID
  










        
[ Top ]

  

  

	
	
method getName [line 137]

	

    

    

		String getName(
)
    

    


	
		Gets the User name.





Tags:





  

    return:  the Username in BIGACE
  










        
[ Top ]

  

  

	
	
method getUserConsumerID [line 163]

	

    

    

		int getUserConsumerID(
)
    

    


	
		Fetches the users consumer ID.





Tags:





  

    return:  the consumer ID
  










        
[ Top ]

  

  

	
	
method getUserData [line 183]

	

    

    

		Object getUserData(
)
    

    


	
		Returns the UserData belonging to the current User





Tags:





  

    return:  the UserData Object belonging to the curretn User
  










        
[ Top ]

  

  

	
	
method getUserID [line 121]

	

    

    

		int getUserID(
)
    

    


	
		Gets the Users ID





Tags:





  

    return:  the Users ID
  










        
[ Top ]

  

  

	
	
method getUserLanguage [line 173]

	

    

    

		Object getUserLanguage(
)
    

    


	
		This gets the name of the Users language.





Tags:





  

    return:  the Users Language
  










        
[ Top ]

  

  

	
	
method getUserLanguageID [line 153]

	

    

    

		void getUserLanguageID(
)
    

    


	
		Wrapper for getLanguageID()






        
[ Top ]

  

  

	
	
method isActive [line 95]

	

    

    

		boolean isActive(
)
    

    


	
		Gets the Users status within BIGACE.

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





Tags:





  

    return:  value for the Users status.
  










        
[ Top ]

  

  

	
	
method isAnonymous [line 74]

	

    

    

		boolean isAnonymous(
)
    

    


	
		Gets the Information if user is anonymous.





Tags:





  

    return:  if User is anonymous
  










        
[ Top ]

  

  

	
	
method isSuperUser [line 81]

	

    

    

		void isSuperUser(
)
    

    


	
		




        
[ Top ]

  

  

	
	
method isValidUser [line 64]

	

    

    

		boolean isValidUser(
)
    

    


	
		This 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
  










        
[ Top ]

  






        

		    

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