Gentics Portal.Node PHP API
 All Classes Namespaces Functions Variables Pages
Public Member Functions | List of all members
IAuthService Interface Reference
Inheritance diagram for IAuthService:
EAuthServiceBase EmailService EOAuth2Service EOAuthService EOpenIDService EmailService EOAuth2Service EOAuthService EOpenIDService FacebookOAuthService GoogleOAuthService MailruOAuthService MoikrugOAuthService OdnoklassnikiOAuthService VKontakteOAuthService TwitterOAuthService GoogleOpenIDService YandexOpenIDService

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 ()

Detailed Description

Definition at line 14 of file IAuthService.php.

Member Function Documentation

IAuthService::authenticate ( )
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.

Parameters
string$keythe attribute name.
mixed$defaultthe 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.

Parameters
string$keythe attribute name.

Implemented in EAuthServiceBase.

IAuthService::init (   $component,
  $options = array() 
)

Initizlize the component.

Parameters
EAuth$componentthe component instance.
array$optionsproperties initialization.

Implemented in EAuthServiceBase, EOAuthService, and EOpenIDService.

IAuthService::redirect (   $url = null)

Redirect to the url. If url is null, redirectUrl will be used.

Parameters
string$urlurl to redirect.

Implemented in EAuthServiceBase, and EmailService.

IAuthService::setCancelUrl (   $url)

Sets redirect url after unsuccessful authorization (e.g. user canceled).

Parameters
stringurl to redirect.

Implemented in EAuthServiceBase.

IAuthService::setComponent (   $component)

Sets EAuth application component

Parameters
EAuth$componentthe application auth component.

Implemented in EAuthServiceBase.

IAuthService::setRedirectUrl (   $url)

Sets redirect url after successful authorization.

Parameters
stringurl to redirect.

Implemented in EAuthServiceBase.


The documentation for this interface was generated from the following file: