kernel/private/rest/classes/auth/styles/oauth.php
Show:
inherited
inherited
Classes
\ezpRestOauthAuthenticationStyle
Package: Default
Parameters
File containing ezpRestOauthAuthenticationStyle
- Parent(s)
- \ezpRestAuthenticationStyleInterface
- Copyright
- Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
- License
- eZ Proprietary Use License v1.0
Properties
string
$prefix= ''
inherited
Current prefix for REST requests, to be used in case of internal redirects
Inherited from: \ezpRestAuthenticationStyle::$$prefix
Details
- Type
- string
- Inherited_from
- \ezpRestAuthenticationStyle::$$prefix
Methods
authenticate(
$auth, $request
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $auth | ||
| $request |
processLoginRequired(
$res, \array(string) $reasons, \array(string=>array(int=>string) $errorMap
=
null
)
:
voidMethod extracted from MvcAuthenticationTiein
Checks the status from the authentication run and adds the reasons as variable to the $result.
This method uses the information that is set by the runAuthRequiredFilter() filter to generate an user-readable text of the found $reasons and sets these as the variable ezcAuth_reasons in the $result. You can supply your own mapping from status codes to messages, but a default is provided. Please refer to the Authentication tutorial for information about status codes.
| Name | Type | Description |
|---|---|---|
| $res | ||
| $reasons | \array(string) | |
| $errorMap | \array(string=>array(int=>string) |
setUser(
$user
)
:
void
inherited
Inherited from:
\ezpRestAuthenticationStyle::setUser()
Parameters
Details
| Name | Type | Description |
|---|---|---|
| $user |
setup(
$request
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $request |