Skip to content

necromant2005/phpsa

 
 

Repository files navigation

PHPSA - Static Analysis for PHP

Latest Stable Version Build Status License

Awesome tool for awesome PHP developers

P.S This software is currently in early alpha state

Goals

What is needed or planned as future.

Unused

  • Import
  • Local variable
  • Parameter
  • Private field
  • Private method

Undefined

  • Class
  • Class constant
  • Class property
  • Class method
  • Callback
  • Constant
  • Function
  • Namespace
  • Variable
  • Callback

PHPDockblock

  • Missing doc block
  • Missing @return

Control flow

  • Loop which does not loop
  • Ternary operator simplification
  • Elvis operator can be used
  • Not optimal if conditions
  • Infinity loop
  • Unreachable statement
  • Stupid cast
  • Not implemented class methods

Probable bugs

  • Division by zero {expr}/0
  • Division from zero 0/{expr}
  • Missing 'break' statement
  • Void function result used

General

  • Language level
  • Syntax error

Installation

Composer

The recommended way to install phpsa is via composer.

  1. If you do not have composer installed, download the composer.phar executable or use the installer.
$ curl -sS https://getcomposer.org/installer | php
  1. Run php composer.phar require ovr/phpsa or add requirement in composer.json.
{
  "require": {
    "ovr/phpsa": "*"
  }
}
  1. Run php composer.phar update

How to use

$ ./bin/phpsa
PHP Static Analyzer version 0.1-dev #fbdf4d4

Usage:
  command [options] [arguments]

Options:
  -h, --help            Display this help message
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi            Force ANSI output
      --no-ansi         Disable ANSI output
  -n, --no-interaction  Do not ask any interactive question
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Available commands:
  check  SPA
  help   Displays help for a command
  list   Lists commands

Example output:

$ ./bin/phpsa check ./tests/

It is highly recommended to disable the XDebug extension before invoking this command.
Scanning directory ./tests/simple
found 10 files

Syntax error:  Syntax error, unexpected '}' on line 8 in ./tests/simple/syntax-error/1.php

Notice:  Unused variable $a in method test() in ./tests/simple/unused-variable/1.php  [unused-variable]

Notice:  Property a is not exists on this scope in ./tests/simple/undefined/Property.php on 9 [undefined-property]

	 return $this->a;

Notice:  Constant BBBB is not exists on self scope in ./tests/simple/undefined/Const.php on 14 [undefined-const]

	 return self::BBBB;

Notice:  Method b() is not exists on this scope in ./tests/simple/undefined/MCall.php on 7 [undefined-mcall]

	 return $this->b();

Notice:  You trying to use undefined variable $unusedVariable in ./tests/simple/undefined/MCall.php on 23 [undefined-variable]

	 return $unusedVariable->b();

Notice:  Function undefinedFunction() is not exists in ./tests/simple/undefined/FCall.php on 7 [undefined-fcall]

	 undefinedFunction();

Notice:  You trying to use undefined variable $b in ./tests/simple/undefined/LocalVariable.php on 8 [undefined-variable]

	 return $a + $b;

Notice:  Static method b() is not exists on self scope in ./tests/simple/undefined/SCall.php on 7 [undefined-scall]

	 return self::b();

Notice:  You trying to use division on {expr}/0 in ./tests/simple/devision-by-zero/1.php on 7 [division-zero]

	 return 1000 / 0;

Notice:  You trying to use division on {expr}/0 in ./tests/simple/devision-by-zero/1.php on 12 [division-zero]

	 return 1000 / (100-100);

Notice:  You trying to use division on {expr}/0 in ./tests/simple/devision-by-zero/1.php on 17 [division-zero]

	 return 1000 / ((50+50)-100);

Notice:  You trying to use division on {expr}/0 in ./tests/simple/devision-by-zero/1.php on 22 [division-zero]

	 return 1000 / ((5*5)-25);

Notice:  You trying to use division on {expr}/0 in ./tests/simple/devision-by-zero/1.php on 27 [division-zero]

	 return 1000 / ((-25) + (5*5));

Notice:  You trying to use division on {expr}/0 in ./tests/simple/devision-by-zero/1.php on 32 [division-zero]

	 return 1000 / ((-4) + (5^1));

Notice:  You trying to use division from 0/{expr} in ./tests/simple/devision-by-zero/1.php on 37 [division-zero]

	 return 0 / 1000;

Memory usage: 4.97 (peak: 5.25) MB

Requirements

  • PHP >= 5.3 (compatible up to version 7.0 && hhvm)

LICENSE

MIT, Have fun

About

Static Analysis for PHP :bowtie:

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • PHP 100.0%