kernel/private/rest/classes/status/oauth_required.php

Show: inherited
Table of Contents

\ezpOauthRequired

Package: Default

This result type is used to signal a HTTP basic auth header

Parent(s)
?\ezcMvcResultStatusObject

Constants

Constant  DEFAULT_REALM = 'eZ Publish REST'

Properties

Propertypublicstring  $errorMessage= ''

An optional human-readable error message.

Details
Type
string
Propertypublicstring  $errorType= ''

The error type identifier as defined per section 5.2.1 of oauth2.0 #10

Details
Type
string
Propertypublicstring  $realm= ''

The realm is the unique ID to identify a login area

Details
Type
string

Methods

methodpublic__construct(  $realm,  $errorType = null,  $errorMessage = null ) : void

Parameters
Name Type Description
$realm
$errorType
$errorMessage
methodprotectedcreateErrorString( ) : string

Creates for use in authentcation challenge header

Returns
Type Description
string
methodpublicprocess( \ezcMvcResponseWriter $writer ) : void

Uses the passed in $writer to set the HTTP authentication header.

Parameters
Name Type Description
$writer \ezcMvcResponseWriter
Documentation was generated by DocBlox 0.18.1.