Interface Inx_Api_UserContext

Description

The Inx_Api_UserContext allows to check the rights of the currently logged in user and gives access to the Inx_Api_user object.

The Inx_Api_UserContext allows to check the rights of the currently logged in user and gives access to the Inx_Api_user object.

  • version: $Revision: 9497 $ $Date: 2007-12-19 17:03:25 +0200 (Tr, 19 Grd 2007) $ $Author: aurimas $

Located in /Api/UserContext.php (line 13)


	
			
Method Summary
boolean hasUserRight (string $sUserRight)
void refresh ()
Methods
getLastRefresh (line 38)

Returns the timestamp from the last refresh.

Returns the timestamp from the last refresh.

  • return: the timestamp from the last refresh.
  • access: public
int getLastRefresh ()
hasUserRight (line 23)

Checks if the currently logged in user has the specified user right.

Checks if the currently logged in user has the specified user right.

  • return: true, if the user has the right; false, otherwise.
  • see: Inx_Api_UserRights
  • access: public
boolean hasUserRight (string $sUserRight)
  • string $sUserRight: the user right (Inx_Api_UserRights) to be checked.
refresh (line 30)

Refreshes this Inx_Api_UserContext.

Refreshes this Inx_Api_UserContext. Reloads the newest user rights from the server.

  • access: public
void refresh ()
whoAmI (line 46)

Returns the currently logged in Inx_Api_User.

Returns the currently logged in Inx_Api_User.

  • return: the currently logged in Inx_Api_User.
  • since: API 1.7.0
  • access: public
Inx_Api_User whoAmI ()

Documentation generated on Thu, 17 Sep 2015 14:27:34 +0200 by phpDocumentor 1.3.2