Documentation

Generic_Sniffs_CodeAnalysis_UnusedFunctionParameterSniff
in package
implements PHP_CodeSniffer_Sniff

Checks the for unused function parameters.

This sniff checks that all function parameters are used in the function body. One exception is made for empty function bodies or function bodies that only contain comments. This could be useful for the classes that implement an interface that defines multiple methods but the implementation only needs some of them.

Tags
category

PHP

author

Manuel Pichler mapi@manuel-pichler.de

author

Greg Sherwood gsherwood@squiz.net

copyright

2007-2014 Manuel Pichler. All rights reserved.

license

http://www.opensource.org/licenses/bsd-license.php BSD License

version

Release: @package_version@

link
http://pear.php.net/package/PHP_CodeSniffer

Interfaces, Classes and Traits

PHP_CodeSniffer_Sniff
Represents a PHP_CodeSniffer sniff for sniffing coding standards.

Table of Contents

process()  : void
Processes this test, when one of its tokens is encountered.
register()  : array<string|int, mixed>
Returns an array of tokens this test wants to listen for.

Methods

process()

Processes this test, when one of its tokens is encountered.

public process(PHP_CodeSniffer_File $phpcsFile, int $stackPtr) : void
Parameters
$phpcsFile : PHP_CodeSniffer_File

The file being scanned.

$stackPtr : int

The position of the current token in the stack passed in $tokens.

Return values
void

register()

Returns an array of tokens this test wants to listen for.

public register() : array<string|int, mixed>
Return values
array<string|int, mixed>

Search results