Download the PHP package wata727/phan-query-plugin without Composer
On this page you can find all versions of the php package wata727/phan-query-plugin. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download wata727/phan-query-plugin
More information about wata727/phan-query-plugin
Files in wata727/phan-query-plugin
Package phan-query-plugin
Short Description A Phan plugin to add a new rule without writing plugins
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package phan-query-plugin
Phan Query Plugin
A Phan plugin to add a new rule without writing plugins. This plugin inspired by Querly.
Installation
You can install this plugin with composer.
After that, Set this plugin path to .phan/config.php.
Quick Start
At first, creates files as follows:
.phan/config.php:
.phan/query.php:
test.php:
Try following command:
You can get the result:
What happened?
This plugin loads .phan/query.php and searches for your code that matches the defined pattern of Query.
In the above example, since the code matching $cat->meow(); existed in line 12, it was emitted as Phan's issue.
The emitted issue has type and message as well as Phan's original issue. These are type and message defined in your Query.
What is the difference with regular expressions?
This plugin uses AST for matching node. For example, $cat->meow($arg1, $arg2); matches all of the following:
$cat->meow($arg1, $arg2);$cat->meow($arg1 , $arg2);$cat->meow($arg1,$arg2);
Query Syntax
What kind of syntax can be written in pattern? This is PHP-like pattern matching syntax, which satisfying the following:
- The pattern expressions must be valid as PHP
- For example, a trailing semicolon is required.
- But the
<Klass>syntax is available in the pattern.
<Klass> Syntax
You can use <Klass> syntax in a pattern of Query. If you use it, the following pattern matches test.php like the above.
This means that the Query checks types of variables when use this pattern. Also, if you specify <any>, it matches all variables.
Testing your Query
You can write a test to make sure the Query works correctly. For example:
The match value is the code that matches pattern, and the unmatch value is the code that not match pattern. You can run the tests with the following command:
