apidoc
[ class tree: apidoc ] [ index: apidoc ] [ all elements ]

Class: SubversionPropertiesSniff

Source Location: /PHP_CodeSniffer-3.1.1/src/Standards/Generic/Sniffs/VersionControl/SubversionPropertiesSniff.php

Class Overview


Tests that the correct Subversion properties are set.


Author(s):

Copyright:

  • 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 16]
Tests that the correct Subversion properties are set.


[ Top ]


Class Variables

$properties = array(
                             'svn:keywords'  => 'Author Id Revision',
                             'svn:eol-style' => 'native',
                            )

[line 28]

The Subversion properties that should be set.

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.

  • Access: protected

Type:   array


[ Top ]



Method Detail

getProperties   [line 122]

array getProperties( string $path)

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

Returns NULL if the file is not under version control.

  • Throws: \PHP_CodeSniffer\Exceptions\RuntimeException If Subversion properties file could not be opened.
  • Access: protected

Parameters:

string   $path   —  The path to return Subversion properties on.

[ Top ]

process   [line 55]

void process( File $phpcsFile, int $stackPtr)

Processes this test, when one of its tokens is encountered.
  • Access: public

Parameters:

\PHP_CodeSniffer\Files\File   $phpcsFile   —  The file being scanned.
int   $stackPtr   —  The position of the current token in the stack passed in $tokens.

[ Top ]

register   [line 39]

array register( )

Returns an array of tokens this test wants to listen for.
  • Access: public

[ Top ]


Documentation generated on Mon, 11 Mar 2019 15:27:47 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.