Violation
in package
FinalYes
A problem in the documentation source, like markup that is ignored or a directive used incorrectly.
Table of Contents
Properties
- $context : array
- $identifier : string
- $message : string
- $severity : Severity
Methods
- error() : self
- warning() : self
- __construct() : mixed
Properties
$context read-only
public
array
$context
$identifier read-only
public
string
$identifier
$message read-only
public
string
$message
$severity read-only
public
Severity
$severity
Methods
error()
public
static error(string $identifier, string $message[, array<string, mixed> $context = [] ]) : self
Parameters
- $identifier : string
- $message : string
- $context : array<string, mixed> = []
Return values
selfwarning()
public
static warning(string $identifier, string $message[, array<string, mixed> $context = [] ]) : self
Parameters
- $identifier : string
- $message : string
- $context : array<string, mixed> = []
Return values
self__construct()
private
__construct(string $identifier, string $message, Severity $severity, array<string, mixed> $context) : mixed
Parameters
- $identifier : string
-
Stable name of the check, like "rst.code-block.empty", to tell violations apart independent of their message
- $message : string
- $severity : Severity
- $context : array<string, mixed>
-
Source location and other details, as for a PSR-3 log message