Public Member Functions | |
init ($component, $options=array()) | |
getServiceName () | |
getServiceTitle () | |
getServiceType () | |
getJsArguments () | |
setComponent ($component) | |
getComponent () | |
setRedirectUrl ($url) | |
getRedirectUrl () | |
setCancelUrl ($url) | |
getCancelUrl () | |
authenticate () | |
getIsAuthenticated () | |
redirect ($url=null) | |
cancel () | |
getId () | |
getAttributes () | |
getAttribute ($key, $default=null) | |
hasAttribute ($key) | |
getItem () |
Definition at line 14 of file IAuthService.php.
IAuthService::authenticate | ( | ) |
Authenticate the user.
Implemented in EAuthServiceBase, EOAuthService, EmailService, EOAuth2Service, TwitterOAuthService, and EOpenIDService.
IAuthService::cancel | ( | ) |
Redirect to the cancelUrl or simply close the popup window.
Referenced by EOpenIDService\authenticate(), TwitterOAuthService\authenticate(), and EOAuth2Service\authenticate().
IAuthService::getAttribute | ( | $key, | |
$default = null |
|||
) |
Returns the authorization attribute value.
string | $key | the attribute name. |
mixed | $default | the default value. |
Implemented in EAuthServiceBase.
IAuthService::getAttributes | ( | ) |
Returns the array that contains all available authorization attributes.
Implemented in EAuthServiceBase.
IAuthService::getCancelUrl | ( | ) |
Returns the redirect url after unsuccessful authorization (e.g. user canceled).
Implemented in EAuthServiceBase.
IAuthService::getComponent | ( | ) |
Returns the EAuth application component.
Implemented in EAuthServiceBase.
IAuthService::getId | ( | ) |
Returns the user unique id.
Implemented in EAuthServiceBase.
IAuthService::getIsAuthenticated | ( | ) |
Whether user was successfuly authenticated.
Implemented in EAuthServiceBase.
IAuthService::getItem | ( | ) |
Returns an object with a human-readable representation of the current authorization.
Implemented in EAuthServiceBase.
IAuthService::getJsArguments | ( | ) |
Returns arguments for the jQuery.eauth() javascript function.
Implemented in EAuthServiceBase.
IAuthService::getRedirectUrl | ( | ) |
Returns the redirect url after successful authorization.
Implemented in EAuthServiceBase.
IAuthService::getServiceName | ( | ) |
Returns service name(id).
Implemented in EAuthServiceBase.
IAuthService::getServiceTitle | ( | ) |
Returns service title.
Implemented in EAuthServiceBase.
IAuthService::getServiceType | ( | ) |
Returns service type (e.g. OpenID, OAuth).
Implemented in EAuthServiceBase.
IAuthService::hasAttribute | ( | $key | ) |
Whether the authorization attribute exists.
string | $key | the attribute name. |
Implemented in EAuthServiceBase.
IAuthService::init | ( | $component, | |
$options = array() |
|||
) |
Initizlize the component.
EAuth | $component | the component instance. |
array | $options | properties initialization. |
Implemented in EAuthServiceBase, EOAuthService, and EOpenIDService.
IAuthService::redirect | ( | $url = null | ) |
Redirect to the url. If url is null, redirectUrl will be used.
string | $url | url to redirect. |
Implemented in EAuthServiceBase, and EmailService.
IAuthService::setCancelUrl | ( | $url | ) |
Sets redirect url after unsuccessful authorization (e.g. user canceled).
string | url to redirect. |
Implemented in EAuthServiceBase.
IAuthService::setComponent | ( | $component | ) |
Sets EAuth application component
EAuth | $component | the application auth component. |
Implemented in EAuthServiceBase.
IAuthService::setRedirectUrl | ( | $url | ) |
Sets redirect url after successful authorization.
string | url to redirect. |
Implemented in EAuthServiceBase.