PHP Class HippoPHP\Hippo\Violation

Author: James Brooks ([email protected])
Show file Open project: hippophp/hippo Class Usage Examples

Protected Properties

Property Type Description
$column integer The column that the violation occurred on.
$file File The file that the violation was made on.
$line integer The line number that the violation was made on.
$message string The violation text.
$severity integer The severity of the error.

Public Methods

Method Description
__construct ( File $file, integer $line, integer $column, integer $severity, string $message ) Creates a new violation.
getColumn ( ) : integer Returns the column number of the violation.
getFile ( ) : File Returns the file of the violation.
getLine ( ) : integer Returns the line number of the violation.
getMessage ( ) : string Returns the violations message.
getSeverities ( ) : int[] Violation severities, in order from most deadly to most peaceful.
getSeverity ( ) : integer Returns the severity of the violation.
getSeverityFromString ( string $severityName ) : integer Get a severity level from a severity name.
getSeverityName ( ) : string Returns the named value of the severity.

Private Methods

Method Description
getSeverityNames ( ) : array Array of severity levels to the severity name.

Method Details

__construct() public method

Creates a new violation.
public __construct ( File $file, integer $line, integer $column, integer $severity, string $message )
$file File
$line integer
$column integer
$severity integer
$message string

getColumn() public method

Returns the column number of the violation.
public getColumn ( ) : integer
return integer

getFile() public method

Returns the file of the violation.
public getFile ( ) : File
return File

getLine() public method

Returns the line number of the violation.
public getLine ( ) : integer
return integer

getMessage() public method

Returns the violations message.
public getMessage ( ) : string
return string

getSeverities() public static method

Violation severities, in order from most deadly to most peaceful.
public static getSeverities ( ) : int[]
return int[]

getSeverity() public method

Returns the severity of the violation.
public getSeverity ( ) : integer
return integer

getSeverityFromString() public static method

Get a severity level from a severity name.
public static getSeverityFromString ( string $severityName ) : integer
$severityName string
return integer

getSeverityName() public method

Returns the named value of the severity.
public getSeverityName ( ) : string
return string

Property Details

$column protected property

The column that the violation occurred on.
protected int $column
return integer

$file protected property

The file that the violation was made on.
protected File,HippoPHP\Hippo $file
return File

$line protected property

The line number that the violation was made on.
protected int $line
return integer

$message protected property

The violation text.
protected string $message
return string

$severity protected property

The severity of the error.
protected int $severity
return integer