eZPublish  4.5
ezpRestAuthenticationStyleInterface Interface Reference

File containing the ezpRestAuthenticationStyleInterface interface. More...

+ Inheritance diagram for ezpRestAuthenticationStyleInterface:

Public Member Functions

 authenticate (ezcAuthentication $auth, ezcMvcRequest $request)
 Method to be run inside the runRequestFilters hook inside MvcTools. More...
 
 getUser ()
 Returns valid eZPublish user that has been authenticated by self::authenticate(). More...
 
 setup (ezcMvcRequest $request)
 Setting up the state to allow for later authentcation checks. More...
 
 setUser (eZUser $user)
 Registers the user that has been authenticated. More...
 

Detailed Description

File containing the ezpRestAuthenticationStyleInterface interface.

Member Function Documentation

ezpRestAuthenticationStyleInterface::authenticate ( ezcAuthentication  $auth,
ezcMvcRequest  $request 
)

Method to be run inside the runRequestFilters hook inside MvcTools.

This method should take care of seting up proper redirections to MvcTools

Returns
eZUser|ezcMvcInternalRedirect

Implemented in ezpRestNoAuthStyle, ezpRestBasicAuthStyle, and ezpRestOauthAuthenticationStyle.

ezpRestAuthenticationStyleInterface::getUser ( )

Returns valid eZPublish user that has been authenticated by self::authenticate().

Returns
eZUser
ezpRestAuthenticationStyleInterface::setup ( ezcMvcRequest  $request)

Setting up the state to allow for later authentcation checks.

Parameters
ezcMvcRequest$request
Returns
void

Implemented in ezpRestNoAuthStyle, ezpRestOauthAuthenticationStyle, and ezpRestBasicAuthStyle.

ezpRestAuthenticationStyleInterface::setUser ( eZUser  $user)

Registers the user that has been authenticated.

Returns
void
Parameters
eZUser$user

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