php-censor/docs/en/plugins/phar.md
Dmitry Khomutov 320a249153 Improved docs
2016-07-19 15:22:22 +06:00

25 lines
582 B
Markdown

Plugin Phar
-----------
Allows you to create a [Phar](http://php.net/manual/en/book.phar.php) archive from your project.
Configuration
=============
### Options
* **directory**: `phar` output directory. Default: `%buildpath%`;
* **filename**: `phar` filename inside output directory. Default: `build.phar`;
* **regexp**: regular expression for Phar iterator. Default: `/\.php$/`; and
* **stub**: stub content filename. No default value.
### Examples
```
phar:
directory: /path/to/directory
filename: foobar.phar
regexp: /\.(php|phtml)$/
stub: filestub.php
```