@@ -47,6 +47,7 @@ A CLI tool that parses the PHP source directory and outputs PlantUML class diagr
4747
4848OPTIONS
4949 -h, --help show this help page.
50+ -v, --version show version.
5051 --class-diagram output class diagram script. (default)
5152 --package-diagram output package diagram script.
5253 --jig-diagram output class diagram and package diagram script.
@@ -58,6 +59,8 @@ OPTIONS
5859 --php7 parse php source file as php7.
5960 --php8 parse php source file as php8. (not suppoted)
6061 --header=' header string' additional header string. You can specify multiple header values.
62+ --include=' wildcard' include target file pattern. (default: ` * .php` ) You can specify multiple include patterns.
63+ --exclude=' wildcard' exclude target file pattern. You can specify multiple exclude patterns.
6164```
6265
6366## How to execute
@@ -135,6 +138,30 @@ Use PlnatUML to convert the PlantUML script to an image.
135138! [PlantUML output image.](output.png)
136139
137140
141+ # ### option `header`
142+
143+ You can specify the string to be output to the PlantUML header.
144+
145+ ` ` ` bash
146+ $ vendor/bin/php-class-diagram --header='title "This is the class diagram"' test/fixtures/no-namespace
147+ ` ` `
148+
149+ # ### option `include`
150+
151+ You can add patterns to find target files to process.
152+
153+ ` ` ` bash
154+ $ vendor/bin/php-class-diagram --include='*.php' --include='*.php4' test/fixtures/no-namespace
155+ ` ` `
156+
157+ # ### option `exclude`
158+
159+ You can specify patterns to exclude files from being processed.
160+
161+ ` ` ` bash
162+ $ vendor/bin/php-class-diagram --exclude='test' --include='*Exception.php' test/fixtures/no-namespace
163+ ` ` `
164+
138165# ## Package Diagram
139166
140167You can visualize package dependencies by creating a package relationship diagram with php-class-diagram.
0 commit comments