AnnotationDetails
in package
FinalYes
Where a violation is found and what it says, as code review tools show it on the lines of a change.
Table of Contents
Properties
Methods
- __construct() : mixed
- getFile() : string|null
- The path of the source file from the root of the repository, which is the working directory of a CI job.
- getInputDirectory() : string
- The input directory, as the closest place for violations that are not found in a particular file.
- getLine() : int|null
- getMessage() : string
- The message with placeholders like "{file}" replaced by the value from the context, as a PSR-3 logger would.
- fromWorkingDirectory() : string
Properties
$settingsManager read-only
private
SettingsManager
$settingsManager
Methods
__construct()
public
__construct(SettingsManager $settingsManager) : mixed
Parameters
- $settingsManager : SettingsManager
getFile()
The path of the source file from the root of the repository, which is the working directory of a CI job.
public
getFile(Violation $violation) : string|null
Parameters
- $violation : Violation
Return values
string|nullgetInputDirectory()
The input directory, as the closest place for violations that are not found in a particular file.
public
getInputDirectory() : string
Return values
stringgetLine()
public
getLine(Violation $violation) : int|null
Parameters
- $violation : Violation
Return values
int|nullgetMessage()
The message with placeholders like "{file}" replaced by the value from the context, as a PSR-3 logger would.
public
getMessage(Violation $violation) : string
Parameters
- $violation : Violation
Return values
stringfromWorkingDirectory()
private
static fromWorkingDirectory(string $path) : string
Parameters
- $path : string