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

Class: ExactMatch

Source Location: /PHP_CodeSniffer-3.1.1/src/Filters/ExactMatch.php

Class Overview

\
   |
   --Filter
      |
      --ExactMatch

An abstract filter class for checking files and folders against exact matches.


Author(s):

Copyright:

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

Methods


Child classes:

GitModified
A filter to only include files that have been modified or added in a Git repository.

Inherited Variables

Inherited Methods

Class: Filter

Filter::__construct()
Constructs a filter.
Filter::accept()
Check whether the current element of the iterator is acceptable.
Filter::getChildren()
Returns an iterator for the current entry.
Filter::shouldIgnorePath()
Checks filtering rules to see if a path should be ignored.
Filter::shouldProcessFile()
Checks filtering rules to see if a file should be checked.

Class Details

[line 16]
An abstract filter class for checking files and folders against exact matches.

Supports both whitelists and blacklists.



[ Top ]


Method Detail

accept   [line 43]

bool accept( )

Check whether the current element of the iterator is acceptable.

If a file is both blacklisted and whitelisted, it will be deemed unacceptable.

  • Access: public

Overrides Filter::accept() (Check whether the current element of the iterator is acceptable.)
[ Top ]

getBlacklist   [line 97]

array getBlacklist( )

Get a list of blacklisted file paths.
  • Abstract:
  • Access: protected

Overridden in child classes as:

GitModified::getBlacklist()
Get a list of blacklisted file paths.

[ Top ]

getChildren   [line 82]

\RecursiveIterator getChildren( )

Returns an iterator for the current entry.

Ensures that the blacklist and whitelist are preserved so they don't have to be generated each time.

  • Access: public

Overrides Filter::getChildren() (Returns an iterator for the current entry.)
[ Top ]

getWhitelist   [line 105]

array getWhitelist( )

Get a list of whitelisted file paths.
  • Abstract:
  • Access: protected

Overridden in child classes as:

GitModified::getWhitelist()
Get a list of whitelisted file paths.

[ Top ]


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