kernel/private/rest/classes/status/oauth_required.php
Show:
inherited
inherited
Classes
File containing the ezpOauthRequired class.
- Copyright
- Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
- License
- eZ Business Use License Agreement Version 2.0
- Package
- kernel
- Version
- 4.6.0
\ezpOauthRequired
Package: Default
This result type is used to signal a HTTP basic auth header
- Parent(s)
- ?\ezcMvcResultStatusObject
Constants
Properties
string
$errorMessage= ''
An optional human-readable error message.
Details
- Type
- string
string
$errorType= ''
The error type identifier as defined per section 5.2.1 of oauth2.0 #10
Details
- Type
- string
string
$realm= ''
The realm is the unique ID to identify a login area
Details
- Type
- string
Methods
__construct(
$realm, $errorType
=
null, $errorMessage
=
null
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $realm | ||
| $errorType | ||
| $errorMessage |
createErrorString(
)
:
stringCreates for use in authentcation challenge header
Returns
| Type | Description |
|---|---|
| string |
process(
\ezcMvcResponseWriter $writer
)
:
voidUses the passed in $writer to set the HTTP authentication header.
Parameters
| Name | Type | Description |
|---|---|---|
| $writer | \ezcMvcResponseWriter |