Documentation

Generic_Sniffs_Files_ByteOrderMarkSniff
in package
implements PHP_CodeSniffer_Sniff

Generic_Sniffs_Files_ByteOrderMarkSniff.

A simple sniff for detecting BOMs that may corrupt application work.

Tags
category

PHP

author

Piotr Karas office@mediaself.pl

author

Greg Sherwood gsherwood@squiz.net

copyright

2010-2014 mediaSELF Sp. z o.o.

license

https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence

version

Release: @package_version@

link
http://pear.php.net/package/PHP_CodeSniffer
see
http://en.wikipedia.org/wiki/Byte_order_mark

Interfaces, Classes and Traits

PHP_CodeSniffer_Sniff
Represents a PHP_CodeSniffer sniff for sniffing coding standards.

Table of Contents

$bomDefinitions  : array<string|int, mixed>
List of supported BOM definitions.
process()  : void
Processes this sniff, when one of its tokens is encountered.
register()  : array<string|int, mixed>
Returns an array of tokens this test wants to listen for.

Properties

$bomDefinitions

List of supported BOM definitions.

protected array<string|int, mixed> $bomDefinitions = array('UTF-8' => 'efbbbf', 'UTF-16 (BE)' => 'feff', 'UTF-16 (LE)' => 'fffe')

Use encoding names as keys and hex BOM representations as values.

Methods

process()

Processes this sniff, when one of its tokens is encountered.

public process(PHP_CodeSniffer_File $phpcsFile, int $stackPtr) : void
Parameters
$phpcsFile : PHP_CodeSniffer_File

The file being scanned.

$stackPtr : int

The position of the current token in the stack passed in $tokens.

Return values
void

register()

Returns an array of tokens this test wants to listen for.

public register() : array<string|int, mixed>
Return values
array<string|int, mixed>

Search results