AbstractCoreMatcher extends NodeVisitorAbstract implements CodeScannerInterface
Single "core matcher" classes extend from this.
It brings a set of protected methods to help single matcher classes doing common stuff. This abstract extends the nikic/php-parser NodeVisitorAbstract which implements the main parser interface, and it implements the TYPO3 specific CodeScannerInterface to retrieve matches.
This class is only meant to be used within EXT:install and is not part of the TYPO3 Core API.
Table of Contents
Interfaces
- CodeScannerInterface
- Interface to be implemented by all classes which can search and find code places.
Constants
- NODE_RESOLVED_AS = 'nodeResolvedAs'
Properties
- $currentCodeLine : int
- $flatMatcherDefinitions : array<string|int, mixed>
- Helper property containing an array derived from $this->matcherDefinitions created in __construct() if needed.
- $isCurrentLineIgnored : bool
- $isFullFileIgnored : bool
- $matcherDefinitions : array<string|int, mixed>
- Incoming main configuration array.
- $matches : array<string|int, mixed>
Methods
- getMatches() : array<string|int, mixed>
- Return list of matches after processing
- initializeFlatMatcherDefinitions() : mixed
- Initialize helper lookup array $this->flatMatcherDefinitions.
- isArgumentUnpackingUsed() : bool
- Test if one argument is given as "...$someArray".
- isFileIgnored() : bool
- Return true if the node is ignored since the entire file is ignored.
- isLineIgnored() : bool
- Returns true if a comment before a statement is marked as "@extensionScannerIgnoreLine"
- validateMatcherDefinitionKeys() : void
- validateMatcherDefinitions() : mixed
- Some matcher need specific keys in the array definition to work properly.
Constants
NODE_RESOLVED_AS
public
mixed
NODE_RESOLVED_AS
= 'nodeResolvedAs'
Properties
$currentCodeLine
protected
int
$currentCodeLine
= 0
Helper variable for ignored line detection
$flatMatcherDefinitions
Helper property containing an array derived from $this->matcherDefinitions created in __construct() if needed.
protected
array<string|int, mixed>
$flatMatcherDefinitions
= []
$isCurrentLineIgnored
protected
bool
$isCurrentLineIgnored
= false
True if line with $lastIgnoredLineNumber is ignored
$isFullFileIgnored
protected
bool
$isFullFileIgnored
= false
True if the entire file is ignored due to a @extensionScannerIgnoreFile class comment
$matcherDefinitions
Incoming main configuration array.
protected
array<string|int, mixed>
$matcherDefinitions
= []
$matches
protected
array<string|int, mixed>
$matches
= []
List of accumulated matches
Methods
getMatches()
Return list of matches after processing
public
getMatches() : array<string|int, mixed>
Return values
array<string|int, mixed>initializeFlatMatcherDefinitions()
Initialize helper lookup array $this->flatMatcherDefinitions.
protected
initializeFlatMatcherDefinitions() : mixed
For class\name->foo matcherDefinitions, it creates a helper array containing only the method name as array keys for "weak" matches.
If methods with the same name from different classes are defined, a "candidate" array is created containing details of single possible matches for further analysis.
Tags
isArgumentUnpackingUsed()
Test if one argument is given as "...$someArray".
protected
isArgumentUnpackingUsed([array<string|int, mixed> $arguments = [] ]) : bool
If so, it kinda defeats any "argument count" approach.
Parameters
- $arguments : array<string|int, mixed> = []
-
List of arguments
Return values
boolisFileIgnored()
Return true if the node is ignored since the entire file is ignored.
protected
isFileIgnored(Node $node) : bool
Sets ignore status if a class node is given having the annotation.
Parameters
- $node : Node
Return values
boolisLineIgnored()
Returns true if a comment before a statement is marked as "@extensionScannerIgnoreLine"
protected
isLineIgnored(Node $node) : bool
Parameters
- $node : Node
Return values
boolvalidateMatcherDefinitionKeys()
protected
validateMatcherDefinitionKeys(string $key, array<string|int, mixed> $matcherDefinition[, array<string|int, mixed> $requiredArrayKeys = [] ]) : void
Parameters
- $key : string
- $matcherDefinition : array<string|int, mixed>
- $requiredArrayKeys : array<string|int, mixed> = []
validateMatcherDefinitions()
Some matcher need specific keys in the array definition to work properly.
protected
validateMatcherDefinitions([array<string|int, mixed> $requiredArrayKeys = [] ]) : mixed
This method is called typically in __construct() of a matcher to verify these are given. This method is a measure against broken core configuration. It should be pretty quick and is only called in __construct() once, no kitten should be harmed.
This method works on $this->matcherDefinitions.
Parameters
- $requiredArrayKeys : array<string|int, mixed> = []
-
List of required keys for single matchers