SubversionPropertiesSniff
in package
implements
Sniff
Table of Contents
Interfaces
Constants
- REQUIRED_PROPERTIES = ['svn:keywords' => 'Author Id Revision', 'svn:eol-style' => 'native']
- The Subversion properties that should be set.
Properties
- $properties : array<string, string>
- The Subversion properties that should be set.
Methods
- process() : int
- Processes this test, when one of its tokens is encountered.
- register() : array<string|int, int|string>
- Returns an array of tokens this test wants to listen for.
- getProperties() : array<string|int, mixed>|null
- Returns the Subversion properties which are actually set on a path.
Constants
REQUIRED_PROPERTIES
The Subversion properties that should be set.
protected
array<string, string>
REQUIRED_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.
Properties
$properties
The Subversion properties that should be set.
Use the SubversionPropertiesSniff::REQUIRED_PROPERTIES constant instead.
protected
array<string, string>
$properties
= self::REQUIRED_PROPERTIES
Methods
process()
Processes this test, when one of its tokens is encountered.
public
process(File $phpcsFile, int $stackPtr) : int
Parameters
- $phpcsFile : File
-
The file being scanned.
- $stackPtr : int
-
The position of the current token in the stack passed in $tokens.
Return values
intregister()
Returns an array of tokens this test wants to listen for.
public
register() : array<string|int, int|string>
Return values
array<string|int, int|string>getProperties()
Returns the Subversion properties which are actually set on a path.
protected
getProperties(string $path) : array<string|int, mixed>|null
Returns NULL if the file is not under version control.
Parameters
- $path : string
-
The path to return Subversion properties on.