ViolationFormats
in package
implements
ViolationReporter
FinalYes
Passes each violation on to the format chosen with the "violation-format" setting, out of all formats registered with the tag "phpdoc.guides.violation_format".
Table of Contents
Interfaces
- ViolationReporter
- Reports the violations found in the documentation source, each implementation in its own way.
Properties
- $formats : ServiceProviderInterface
- $settingsManager : SettingsManager
Methods
- __construct() : mixed
- getChosenFormat() : ViolationFormat|null
- report() : void
Properties
$formats read-only
private
ServiceProviderInterface
$formats
$settingsManager read-only
private
SettingsManager
$settingsManager
Methods
__construct()
public
__construct(ServiceProviderInterface<string|int, ViolationFormat> $formats, SettingsManager $settingsManager) : mixed
Parameters
- $formats : ServiceProviderInterface<string|int, ViolationFormat>
-
The formats, by the name in their "format" attribute
- $settingsManager : SettingsManager
getChosenFormat()
public
getChosenFormat() : ViolationFormat|null
Tags
Return values
ViolationFormat|nullreport()
public
report(Violation $violation) : void
Parameters
- $violation : Violation