PHP Class HippoPHP\Hippo\Checks\Naming\EncodingCheck

Inheritance: extends HippoPHP\Hippo\Checks\AbstractCheck, implements HippoPHP\Hippo\Checks\CheckInterface
Show file Open project: hippophp/hippo

Protected Properties

Property Type Description
$bom boolean Are we checking for a BOM too?
$encoding string File encoding to check for.

Public Methods

Method Description
getConfigRoot ( ) : string
setEncodingType ( string $encoding ) Sets the file encoding type to check for.
setWithBOM ( boolean $bom ) Do we want to use BOM?

Protected Methods

Method Description
checkFileInternal ( CheckContext $checkContext, Config $config ) checkFileInternal(): defined by AbstractCheck.

Method Details

checkFileInternal() protected method

checkFileInternal(): defined by AbstractCheck.
See also: AbstractCheck::checkFileInternal()
protected checkFileInternal ( CheckContext $checkContext, Config $config )
$checkContext HippoPHP\Hippo\CheckContext
$config HippoPHP\Hippo\Config\Config

getConfigRoot() public method

public getConfigRoot ( ) : string
return string

setEncodingType() public method

Sets the file encoding type to check for.
public setEncodingType ( string $encoding )
$encoding string

setWithBOM() public method

Do we want to use BOM?
public setWithBOM ( boolean $bom )
$bom boolean

Property Details

$bom protected property

Are we checking for a BOM too?
protected bool $bom
return boolean

$encoding protected property

File encoding to check for.
protected string $encoding
return string