README

Scans code for usage of deprecated and or changed code.

This is a library component that can be used to build tools that scan PHP files for broken or deprecated code.

Tools using this library:

standalone TYPO3 scanner

TYPO3 publishes breaking changes and deprecations since version 7.

This library uses the PHP parser written by Nikita Popov. The parser transforms the PHP code from a file into an Abstract Syntax Tree (AST). This can then be easily analysed using 'Matchers' and accompanying 'Rules'.

Matchers

ArrayDimensionMatcher

Matches arrays like $GLOBALS['foo']['bar']

ArrayGlobalMatcher

Match access to a one dimensional $GLOBAL array Example: $GLOBALS['TYPO3_DB']

ArrayMatcher (only for TYPO3 7)

Find usages of dropped TCA configuration values and other nested array structures. You can specify the matchOnValues parameter to pass in an array of values to match.

ClassConstantMatcher (only for TYPO3 7)

Find usages of class constants. Test for Class\Name::THE_CONSTANT, matches are considered "strong"

ClassNameMatcher

Find usages of class / interface names which are entirely deprecated or removed

ClassNamePatternMatcher (only for TYPO3 7)

Find usages of class / interface names which are entirely deprecated or removed by specifying regex patterns

ConstantMatcher

Find usages of class constants. Test for THE_CONSTANT, matches are considered "strong"

FunctionCallMatcher

Find usages of global function calls which were removed / deprecated. This is a strong match.

AbstractMethodImplementationMatcher (since TYPO3 13)

Find usages of defined methods within a class that are deprecated/removed. The inspected class must extend a deprecated/removed TYPO3 API class or abstract, otherwise it is not considered API usage and not scanned. Since the class name is known, this is a "strong" match.

The rule keys distinguish Abstract::staticMethod (static method implementations) from Abstract->localMethod (non-static method implementations), so matches are reported with the correct definition type. Example: A Fluid ViewHelper extending TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper and still defining renderStatic().

GlobalMatcher (only for TYPO3 7)

Match access to a one dimensional $GLOBALS array Example: $TT

InterfaceMethodChangedMatcher

Matches interface method arguments which have been dropped. This does not test if a class implements an interface. The scanner only looks for:

Class method names not having specified number of arguments
Method calls with given method name not having this number of arguments

MethodAnnotationMatcher

Find usages of method annotations

MethodArgumentDroppedMatcher

Find usages of method calls which changed signature and dropped arguments, but are called with more arguments. This is a "weak" match since we're just testing for method name but not connected class.

MethodArgumentDroppedStaticMatcher (since TYPO3 8)

Find usages of static method calls which were removed / deprecated. This is a "strong" match if class name is given and "weak" if not.

MethodArgumentRequiredMatcher

Find usages of method calls which changed signature and added required arguments. This is a "weak" match since we're just testing for method name but not connected class.

MethodArgumentRequiredStaticMatcher

Find usages of static method calls which gained new mandatory arguments. This is a "strong" match if class name is given and "weak" if not.

MethodArgumentUnusedMatcher

Match method usages where arguments "in between" are unused but not given as "null": public function foo($arg1, $unsused1 = null, $unused2 = null, $arg4) but called with: ->foo('arg1', 'notNull', null, 'arg4');

MethodArgumentUnusedStaticMatcher

Match static method usages where arguments "in between" are unused but not given as "null": public function foo($arg1, $unsused1 = null, $unused2 = null, $arg4) but called with: ->foo('arg1', 'notNull', null, 'arg4'); This is a "strong" match if class name is given and "weak" if not.

MethodCallMatcher

Find usages of method calls which were removed / deprecated. This is a "weak" match since we're just testing for method name but not connected class.

MethodCallStaticMatcher

Find usages of static method calls which were removed / deprecated.

This match is performed either is case of a direct foo\bar::aMethod() call as "strong" match, or as only ::aMethod() as "weak" match.

As additional indicator, the number of required, mandatory arguments is recognized: If calling a static method as $foo::aMethod($arg1), but the method needs two arguments, this is not considered a match. This would have raised a fatal PHP error anyway and this is nothing we test here.

PropertyAnnotationMatcher

Find usages of property annotations

PropertyExistsStaticMatcher

Find usages of properties which have been deprecated or removed. Useful if abstract classes remove properties.

PropertyProtectedMatcher

Find usages of properties which have been made protected and are not called in $this context.

PropertyPublicMatcher

Find usages of properties which were removed / deprecated.

ScalarStringMatcher (since TYPO3 12)

Find usages of special "magic" strings like 'TYPO3_MODE', so that usage scenarios like defined('TYPO3_MODE') || die(); are scanned, where the actual constant is NOT used. The comparison is an exact string match (no trimming or substring matching). This is a "weak" match since the string may not necessarily refer to the functionality being matched.

Rules

There are rulesets for each matcher in: config/Matcher.

Test

When you write a new matcher or extend an existing one, please also write the needed tests.

You can run the tests with:

vendor/bin/phpunit

simonschaufi / typo3-cms-scanner

Package info

Security

Fund package maintenance!

Statistics