kernel/private/rest/classes/auth/auth_style.php

Show:

inherited

Table of Contents

\ezpRestAuthenticationStyleInterface
jump to top

Package: Default

File containing the ezpRestAuthenticationStyleInterface interface.

Children: \ezpRestBasicAuthStyle; \ezpRestNoAuthStyle; \ezpRestOauthAuthenticationStyle
Copyright: Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
License: eZ Proprietary Use License v1.0

authenticate(
           $auth,  $request
          )
        
        :
          \eZUser | \ezcMvcInternalRedirect

Method to be run inside the runRequestFilters hook inside MvcTools.

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

Parameters

Name	Type	Description
$auth
$request

Returns

Type	Description
\eZUser \| \ezcMvcInternalRedirect

getUser(
          
          )
        
        :
          \eZUser

Returns valid eZPublish user that has been authenticated by {@link self::authenticate()}

Returns

Type	Description
\eZUser

setUser(
          \eZUser $user
          )
        
        :
          void

Registers the user that has been authenticated

Parameters

Name	Type	Description
$user	\eZUser

setup(
          \ezcMvcRequest $request
          )
        
        :
          void

Setting up the state to allow for later authentcation checks.

Parameters

Name	Type	Description
$request	\ezcMvcRequest