Documentation

SubversionPropertiesSniff
in package
implements Sniff

Interfaces, Classes and Traits

Sniff

Table of Contents

$properties  : array<string|int, mixed>
The Subversion properties that should be set.
process()  : void
Processes this test, when one of its tokens is encountered.
register()  : array<string|int, mixed>
Returns an array of tokens this test wants to listen for.
getProperties()  : array<string|int, mixed>
Returns the Subversion properties which are actually set on a path.

Properties

$properties

The Subversion properties that should be set.

protected array<string|int, mixed> $properties = ['svn:keywords' => 'Author Id Revision', 'svn:eol-style' => 'native']

Key of array is the SVN property and the value is the exact value the property should have or NULL if the property should just be set but the value is not fixed.

Methods

process()

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

public process(File $phpcsFile, int $stackPtr) : void
Parameters
$phpcsFile : 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>

getProperties()

Returns the Subversion properties which are actually set on a path.

protected getProperties(string $path) : array<string|int, mixed>

Returns NULL if the file is not under version control.

Parameters
$path : string

The path to return Subversion properties on.

Tags
throws
RuntimeException

If Subversion properties file could not be opened.

Return values
array<string|int, mixed>

Search results