Documentation

PermissionDenied extends HordeException
in package
implements PermissionDeniedThrowable

Exception thrown if any access without sufficient permissions occured.

Consuming code should check against the PermissionDeniedThrowable, not this class

Tags
author

Jan Schneider jan@horde.org

category

Horde

copyright

2008-2021 Horde LLC

license

http://www.horde.org/licenses/lgpl21 LGPL

Interfaces, Classes, Traits and Enums

PermissionDeniedThrowable
The root interface from which all Horde Exceptions must descend

Table of Contents

$details  : string
Error details that should not be part of the main exception message, e.g. any additional debugging information.
$logged  : bool
Has this exception been logged?
$_logLevel  : int
The log level to use. A Horde_Log constant.
$extraDetails  : string
$isLogged  : bool
__construct()  : mixed
Constructor.
getDetails()  : string
Get additional details separated from the exception's message
getLogLevel()  : int
Get the log level.
isLogged()  : bool
Check if this exception has been logged.
markAsLogged()  : void
Mark this exception as already logged. This cannot be undone.
setDetails()  : void
Set additional details separated from the exception's message
setLogLevel()  : void
Sets the log level.

Properties

$details

Error details that should not be part of the main exception message, e.g. any additional debugging information.

public string $details
Tags
deprecated
3.0.0

use setDetails() and getDetails() instead.

$logged

Has this exception been logged?

public bool $logged = false
Tags
deprecated
3.0.0

Use isLogged() and markAsLogged() instead.

$_logLevel

The log level to use. A Horde_Log constant.

protected int $_logLevel = 0

Name and protected status for legacy reasons. Should rather be private.

$isLogged

private bool $isLogged = false

Methods

__construct()

Constructor.

public __construct([string|PEAR_Error|Exception $message = '' ], int $code[, Throwable $previous = null ]) : mixed
Parameters
$message : string|PEAR_Error|Exception = ''

The exception message, a PEAR_Error object, or an Exception object.

$code : int

A numeric error code.

$previous : Throwable = null

A previous Throwable

Tags
see
Horde_Exception::__construct()
Return values
mixed

getDetails()

Get additional details separated from the exception's message

public getDetails() : string
Return values
string

getLogLevel()

Get the log level.

public final getLogLevel() : int
Return values
int

The Horde_Log constant for the log level.

isLogged()

Check if this exception has been logged.

public final isLogged() : bool
Return values
bool

markAsLogged()

Mark this exception as already logged. This cannot be undone.

public final markAsLogged() : void
Return values
void

setDetails()

Set additional details separated from the exception's message

public setDetails(string $details) : void
Parameters
$details : string
Return values
void

setLogLevel()

Sets the log level.

public final setLogLevel(int|string $level) : void
Parameters
$level : int|string

The log level.

Return values
void

Search results