Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/algo13/php-nag
Static analysis tool for PHP source code by PHP.
https://github.com/algo13/php-nag
Last synced: 15 days ago
JSON representation
Static analysis tool for PHP source code by PHP.
- Host: GitHub
- URL: https://github.com/algo13/php-nag
- Owner: algo13
- License: mit
- Created: 2016-04-02T14:17:33.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-02-16T14:57:12.000Z (over 7 years ago)
- Last Synced: 2024-08-02T00:25:57.812Z (4 months ago)
- Language: PHP
- Size: 43.9 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# php-nag
Static analysis tool for PHP source code by PHP.
for running on PHP >= 5.5
for parsing PHP 5.2 to PHP 7.1
(Depend on the [PHP-Parser](https://github.com/nikic/PHP-Parser) version 3)
## Getting Started
[Download phar](https://github.com/algo13/php-nag/releases)
## Usage
~~~sh
php -d "memory_limit=512M" phpnag.phar file.php
~~~
Windows:
~~~sh
> php phpnag.phar src | findstr /V "ORDER DEFAULT_NOTHING"
~~~
Linux:
~~~sh
$ php phpnag.phar src | grep -v 'ORDER|DEFAULT_NOTHING'
~~~
## Summary
- Property/MULTIPLE
~~~php
class C
{
public $a, $b;
}
~~~
- ClassConst/MULTIPLE
~~~php
class C
{
const A = 1, B = 2;
}
~~~
- For/COND_MULTIPLE
~~~php
for (;$a < 2, $b < 3;) {}
~~~
- ErrorSuppress :beginner:
~~~php
@file('test.txt');
~~~
- AssignRef/NEW :bomb:
~~~php
$instance =& new Class();
~~~
- Catch/EMPTY :beginner:
~~~php
try {
func();
} catch (Error $e) {
// empty.
}
~~~
- Goto :beginner:
- Variable/VARIABLE_VARIABLES :beginner:
~~~php
$$value;
~~~
- Variable/DEPRECATED_GLOBALS :bomb:
- ArrayDimFetch/Const :dash:
~~~php
$value[key];
~~~
- Equal/WEAK_COMP_NUM
~~~php
$value = '1abc';
if ($value == 1) {};
~~~
- Equal/WEAK_COMP_FUNC
~~~php
if (strpos($value, 'startswith') == 0) {};
~~~
- BinaryOp/LOGICAL_OPERATOR :beginner:
~~~php
if ($val1 and $val2) {};
~~~
- FuncCall/NON_BEGINNER_FUNC :beginner:
- FuncCall/NON_OCT\[chmod\]
~~~php
chmod($filename, 755);
~~~
- FuncCall/DEFINE_CONST
~~~php
define(STRING, 'value');
~~~
- FuncCall/DEFINED_CONST
~~~php
defined(STRING);
~~~
- FuncCall/DEPRECATED_FUNC_PARAM\[`setlocale`/$category\] :bomb:
~~~php
setlocale('STRING', 0);
~~~
- FuncCall/DEPRECATED_INI_GET\[$directive\] :beginner:
- FuncCall/DEPRECATED_INI_SET\[$directive\] :bomb:
- FuncCall/DEPRECATED_FUNC_PARAM\[`PREG_REPLACE_EVAL`\] :bomb:
~~~php
preg_replace('/pattern/e', 'value', $string);
~~~
- FuncCall/DEPRECATED_FUNC_PARAM_NUM\[`array_push`\] :dash:
~~~php
array_push($array, 'value');
~~~
- FuncCall/WEAK_COMP_FUNC_PARAM\[`in_array`\]
The third argument is not set.
- FuncCall/WEAK_COMP_FUNC_PARAM\[`array_search`\]
The third argument is not set.
- FuncCall/DEPRECATED_FUNC_PARAM_NUM\[`htmlentities` or `htmlspecialchars`\] :smiling_imp:
The $flags argument is not set.
- FuncCall/DEPRECATED_FUNC_PARAM_ENC\[`htmlentities` or `htmlspecialchars`\]
The $encoding argument is not set.
- FuncCall/RECOMMEND_FUNC_PARAM\[`htmlentities` or `htmlspecialchars`\]
It is recommended that you use `ENT_QUOTES` flag.
- FuncCall/DEPRECATED_FUNC_PARAM\[`htmlentities` or `htmlspecialchars`\] :smiling_imp:
Deprecated flag(`ENT_COMPAT`, `ENT_NOQUOTES`, `ENT_IGNORE`)
- FuncCall/DEPRECATED_API\[$funcName\] :bomb:
- List/ASSIGN_ORDER :bomb:
~~~php
list($a[], $a[]);
~~~
- List/EMPTY :bomb:
~~~php
list(,);
~~~
- Print/USER_INPUT\[$\_GET or $\_POST ...\] :smiling_imp:
- Echo/USER_INPUT\[$\_GET or $\_POST ...\] :smiling_imp:
- ClassLike/PHP4CONSTRUCT :bomb:
- ClassLike/MIXED_ORDER\[Method/Property\]
~~~php
class Example {
public $member1;
public function func1(){};
public $member2;
public function func2(){};
}
~~~
- ClassLike/VISIBILITY_MIXED_ORDER
- ClassLike/VISIBILITY_ORDER
`public`, `protected`, `private`
- Unset/Superglobals :boom:
~~~php
unset($_SESSION);
~~~
- Switch/FALL_THROUGH
~~~php
switch ($string) {
case 'one':
$value = 'string';
//break; <= fall through
case 'two':
$value = 'string string';
break;
}
~~~
- Switch/CONTINUE_BREAK
- Switch/DEFAULT_NOTHING
- Switch/DEFAULT_MULTIPLE :bomb:
- Switch/DEFAULT_NON_TAIL :beginner:
- FunctionLike/DUPLICATE_FUNC_PARAM :bomb:
~~~php
function func($a, $a) {}
~~~
- Cond/BITWISE_OPERATOR :beginner:
~~~php
if ($a & $b) {}
~~~
- Cond/ASSIGN_IF (for, while ...)
~~~php
if ($a = func()) {}
~~~
- Cond/WEAK_COMP_IF (for, while ...)