• Home
• EAuthServiceBase

PHP Class EAuthServiceBase

Show file Open project: nodge/yii-eauth Class Usage Examples

Protected Properties

Property	Type	Description
$attributes		authorization attributes.
$authenticated		whether user was successfuly authenticated.
$jsArguments		arguments for the jQuery.eauth() javascript function.
$name		the service name.
$title		the service title to display in views.
$type		the service type (e.g. OpenID, OAuth).

Public Methods

Method	Description
__get ( string $name ) : mixed	PHP getter magic method.
__isset ( string $name ) : boolean	Checks if a attribute value is null.
authenticate ( ) : boolean	Authenticate the user.
cancel ( $url = null )	Redirect to the {@link cancelUrl} or simply close the popup window.
getAttribute ( string $key, mixed $default = null ) : mixed	Returns the authorization attribute value.
getAttributes ( ) : array	Returns the array that contains all available authorization attributes.
getCancelUrl ( ) : string	Returns the redirect url after unsuccessful authorization (e.g. user canceled).
getComponent ( ) : EAuth	Returns the {@link EAuth} application component.
getId ( ) : mixed	Returns the user unique id.
getIsAuthenticated ( ) : boolean	Whether user was successfuly authenticated.
getItem ( ) : stdClass	Returns the object with a human-readable representation of the current authorization.
getItemAttributes ( ) : array	Returns the array that contains all available authorization attributes.
getJsArguments ( ) : array	Returns arguments for the jQuery.eauth() javascript function.
getRedirectUrl ( ) : string	Returns the redirect url after successful authorization.
getServiceName ( ) : string	Returns service name(id).
getServiceTitle ( ) : string	Returns service title.
getServiceType ( ) : string	Returns service type (e.g. OpenID, OAuth).
hasAttribute ( string $key ) : boolean	Whether the authorization attribute exists.
init ( EAuth $component, array $options = [] )	Initialize the component.
redirect ( string $url = null, array $params = [] )	Redirect to the url. If url is null, {@link redirectUrl} will be used.
setCancelUrl ( $url )	Sets redirect url after unsuccessful authorization (e.g. user canceled).
setComponent ( EAuth $component )	Sets {@link EAuth} application component
setRedirectUrl ( $url )	Sets redirect url after successful authorization.

Protected Methods

Method	Description
_fetchAttributes ( )	Fetch attributes array.
fetchAttributes ( ) : boolean	Fetch attributes array.
fetchJsonError ( stdClass $json ) : array	Returns the error info from json.
getState ( string $key, mixed $defaultValue = null ) : mixed	Returns the value of a variable that is stored in eauth session.
getStateKeyPrefix ( ) : string
hasState ( string $key ) : boolean	Returns a value indicating whether there is a state of the specified name.
initRequest ( string $url, array $options = [] ) : cURL	Initializes a new session and return a cURL handle.
makeRequest ( string $url, array $options = [], boolean $parseJson = true ) : stdClass	Makes the curl request to the url.
parseJson ( string $response ) : object	Parse response from {@link makeRequest} in json format and check OAuth errors.
setState ( string $key, mixed $value, mixed $defaultValue = null )	Stores a variable in eauth session.

Method Details

Property Details