Server : ApacheSystem : Linux host.digitalbabaji.in 4.18.0-513.11.1.el8_9.x86_64 #1 SMP Wed Jan 17 02:00:40 EST 2024 x86_64 User : addictionfreeind ( 1003) PHP Version : 7.2.34 Disable Function : exec,passthru,shell_exec,system Directory : /home/addictionfreeind/public_html/admin1/vendor/phpro/grumphp/doc/tasks/ |
Upload File : |
# Phan
The Phan task will run your automated PHP tasks.
***Composer***
```
composer require --dev phan/phan
```
***Config***
The task lives under the `phan` namespace and has following configurable parameters.
```yaml
# grumphp.yml
grumphp:
tasks:
phan:
config_file: .phan/config.php
output_mode: text
output: null
triggered_by: [php]
```
**config_file**
*Default: .phan/config.php*
If your config.php file is located at an exotic location, you can specify your custom build file location with this option.
This option is set to `.phan/config.php` by default.
This means that `.phan/config.php` is automatically loaded if the file exists in the current directory.
**output_mode**
*Default: text*
This option sets the output mode. Valid output modes are 'text', 'json', 'csv', 'codeclimate', 'checkstyle', or 'pylint'.
This option is set to `text` by default.
**output**
*Default: null*
It's possible to save the output to a file, you can specify the file name with this option.
This option is set to `null` by default.
**triggered_by**
*Default: [php]*
This option will specify which file extensions will trigger the phan task.
By default, Phan will be triggered by altering a PHP file.
You can overwrite this option to whatever file you want to use!