Exponential Basic 2.4.0.1 Exponential Basic CMS — PHP Class Reference

Public Member Functions | List of all members
ezpRestAuthenticationStyleInterface Interface Reference
Inheritance diagram for ezpRestAuthenticationStyleInterface:

## Public Member Functions
| setup (ezcMvcRequest $request)
| authenticate (ezcAuthentication $auth, ezcMvcRequest $request)
| getUser ()
| setUser (eZUser $user)

## Detailed Description

Definition at line 12 of file auth_style.php.

## Member Function Documentation

## ◆ authenticate()

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 ezpRestOauthAuthenticationStyle, ezpRestNoAuthStyle, and ezpRestBasicAuthStyle.

## ◆ getUser()

ezpRestAuthenticationStyleInterface::getUser | ( |  | ) |

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

Returns
  eZUser

## ◆ setup()

ezpRestAuthenticationStyleInterface::setup | ( | ezcMvcRequest | $request | ) |

Setting up the state to allow for later authentcation checks.

Parameters

  ezcMvcRequest | $request |

Returns
  void

Implemented in ezpRestOauthAuthenticationStyle, ezpRestNoAuthStyle, and ezpRestBasicAuthStyle.

## ◆ setUser()

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:

- auth_style.php

Copyright © 1998 – 2026 7x. All rights reserved. Licensed under the GNU GPLv2+.