A class to incorporate UAACS into any new application.
IMPORTANT :- For logging out, a post var named "UAACS_logout" should be used with value "YES".
USAGE :-
$uaacs = new Uaacs_authentication ;
$uaacs->setLandingPage('http://bizydads.com/channa/portman/clientportfolio.php');
$uaacs->setAccessKey('j2ghjlzivj8u');
$uaacs->setSecurityKey('844c1cf009c169d456f5e22f4f3eb737') ;
$uaacs->setAppId(58) ;
$uaacs->setRoleId(456) ;
//Following are optional
$uaacs->setLogoutUrl('http://UAACS.kindersigns.org/API/logout.php');
$uaacs->setLgnCheckUrl('http://UAACS.kindersigns.org/API/loginCheck.php');
$uaacs->authenticate();
$functions = $uaacs->getAllowedFunctions() ; //An array
$myRoles = $uaacs->getAllowedRoles(); //An array
$roleId = $uaacs->getActiveRole();
$data = $uaacs->getUserData(); //simpleXMLObject
da: 28da7d
dev sec key: 85d3c6ee8affbff
ACK : yd064wqrbr9
AS; : eec12d7215ad20eeb1cb4a7eabc9ba47
author |
Channa Dewamitta channa@ekwa.com @created Sep 01, 2013 @modified on @modification @version V2.1.0 |
---|---|
package |
CommonObjects\Uaacs_authentication |
__construct()
Class constructor
access |
public |
---|---|
since | 2.0 |
authenticate() : void
access |
public |
---|
getAccessKey() : string
Gets the accesskey param
access |
public |
---|---|
since | 2.0 |
string
access key of app
getActiveRole() : integer
Gets the active role param
access |
public |
---|---|
since | 2.0 |
integer
the active role ID
getAllowedFunctions() : string
Gets the allowed functions param
access |
public |
---|---|
since | 2.0 |
string
list of allowed functions
getAllowedRoles() : string
Gets the allowed roles param
access |
public |
---|---|
since | 2.0 |
string
list of allowed roles
getAppId() : string
Gets the application ID param
access |
public |
---|---|
since | 2.0 |
string
application ID from UAACS
getLandingPage() : string
Gets the landing page param
access |
public |
---|---|
since | 2.0 |
string
URL of landing page
getLgnCheckUrl() : string
Gets the login check script URL param
access |
public |
---|---|
since | 2.0 |
string
url of login checking script in UAACS
getLogoutUrl() : string
Gets the logout script URL param
access |
public |
---|---|
since | 2.0 |
string
url of logout script in UAACS
getRoleId()
Get the role ID param @@return string role ID from UAACS
access |
public |
---|---|
since | 2.0 |
getSecurityKey() : string
Gets the security key param
access |
public |
---|---|
since | 2.0 |
string
security key of app
getUserData() : array
Gets the user specific data param
access |
public |
---|---|
since | 2.0 |
array
user specific data
setAccessKey(string $aKey) : void
Sets the accesskey param
access |
public |
---|---|
since | 2.0 |
string
access key of app
setAppId(string $appId) : void
Sets the application ID param
access |
public |
---|---|
since | 2.0 |
string
application ID from UAACS
setLandingPage(string $url) : void
Sets the landing page param
access |
public |
---|---|
since | 2.0 |
string
URL of landing page
setLgnCheckUrl(string $lgnCheckUrl) : void
Sets the login check script URL param
access |
public |
---|---|
since | 2.0 |
string
url of login checking script in UAACS
setLoginUrl(string $loginUrl) : void
Sets the login script URL param
access |
public |
---|---|
since | 2.0 |
string
url of login script in UAACS
setLogoutUrl(string $logoutUrl) : void
Sets the logout script URL param
access |
public |
---|---|
since | 2.0 |
string
url of logout script in UAACS
setRoleId(string $roleId) : void
Sets the role ID param
access |
public |
---|---|
since | 2.0 |
string
role ID from UAACS
setSecurityKey(string $sKey) : void
Sets the security key param
access |
public |
---|---|
since | 2.0 |
string
security key of app
landPageUrl :
access |
private protected |
---|---|
since | |
landPage :
access |
private protected |
---|---|
since | |
aKey :
access |
private protected |
---|---|
since | |
sKey :
access |
private protected |
---|---|
since | |
appId :
access |
private protected |
---|---|
since | |
roleId :
access |
private protected |
---|---|
since | |
logoutUrl :
access |
private protected |
---|---|
since | |
loginUrl :
access |
private protected |
---|---|
since | |
lgnCheckUrl :
access |
private protected |
---|---|
since | |
allowedRoles :
access |
private protected |
---|---|
since | |
allowedFunctions :
access |
private protected |
---|---|
since | |
activeRole :
access |
private protected |
---|---|
since | |
userData :
access |
private protected |
---|---|
since | |