1PHPREFLECT(1)                                                    PHPREFLECT(1)
2
3
4

NAME

6       phpreflect - Reverse-engineer classes, interfaces, functions,
7       constants, namespaces and more
8

SYNOPSIS

10       phpreflect [options] command [arguments]
11

DESCRIPTION

13       The phpreflect(1) command parse any data source, to find out elements,
14       such as classes, interfaces, functions, constants, namespaces.
15

OPTIONS

17       -h, --help
18           Display this help message.
19
20       -q, --quiet
21           Do not output any message.
22
23       -v|vv|v, --verbose
24           Increase the verbosity of messages: 1 for normal output, 2 for more
25           verbose output and 3 for debug.
26
27       -V, --version
28           Display this application version.
29
30       --ansi
31           Force ANSI output.
32
33       --no-ansi
34           Disable ANSI output.
35
36       --profile
37           Display timing and memory usage information.
38
39       --progress
40           Show progress bar.
41
42       --output
43           Write results to file or URL.
44
45       --manifest
46           Show which versions of dependencies are bundled (PHAR version
47           only).
48

ANALYSER:LIST COMMAND

50       The phpreflect(1) analyser:list command is used to show what analysers
51       are installed (see CONF FILES section).
52

ANALYSER:RUN COMMAND

54       The phpreflect(1) analyser:run command is used to analyse a data source
55       and display results.
56
57       Usage:
58
59           phpreflect analyser:run [--alias] [--format[="..."]] [--filter[="..."]] source [analysers1] ... [analysersN]
60
61       Where:
62
63       source
64           Identify a data source; may be declared in a json configuration
65           file (see CONF FILES section)
66
67       --alias
68           If set, the source refers to its alias
69
70       --format
71           If set, convert result to a specific format. (default: false)
72
73       --filter
74           Resource that provide a closure to filter results. (default: false)
75
76       analysers1 ... analysersN
77           Identify one or more analyser to execute. See analyser:list command
78           to know what analysers are available. (default: ["structure"])
79

CONFIG:VALIDATE COMMAND

81       The phpreflect(1) config:validate command is used to check syntax of
82       your json configuration file
83
84       Usage:
85
86           phpreflect config:validate [file]
87
88       Where:
89
90       file
91           Path to phpreflect.json file (optional)
92

DIAGNOSE:RUN COMMAND

94       The phpreflect(1) diagnose:run command is used to identify common
95       errors on a platform.
96
97       Usage:
98
99           phpreflect diagnose:run [-vv|-vvv]
100

DIAGRAM:CLASS COMMAND

102       The phpreflect(1) diagram:class command is used to generate diagram
103       about a user class present in a data source
104
105       Usage:
106
107           phpreflect diagram:class [--alias] [--engine[="..."]] argument source
108
109       Where:
110
111       argument
112           Name of the class to inspect
113
114       source
115           Identify a data source; may be declared in a json configuration
116           file (see CONF FILES section)
117
118       --alias
119           If set, the source refers to its alias
120
121       --engine
122           Graphical syntax. (default: "plantuml")
123

DIAGRAM:PACKAGE COMMAND

125       The phpreflect(1) diagram:package command is used to generate diagram
126       about namespaces in a data source
127
128       Usage:
129
130           phpreflect diagram:package [--alias] [--engine[="..."]] argument source
131
132       Where:
133
134       argument
135           Name of the namespace to inspect
136
137       source
138           Identify a data source; may be declared in a json configuration
139           file (see CONF FILES section)
140
141       --alias
142           If set, the source refers to its alias
143
144       --engine
145           Graphical syntax. (default: "plantuml")
146

PLUGIN:LIST COMMAND

148       The phpreflect(1) plugin:list command is used to show what plugins are
149       installed (see CONF FILES section).
150

REFLECTION:CLASS COMMAND

152       The phpreflect(1) reflection:class command is used to give information
153       about a user class present in a data source.
154
155       Usage:
156
157           phpreflect reflection:class [--alias] [--format="..."] argument source
158
159       Where:
160
161       argument
162           Name of the class to reflect.
163
164       source
165           Identify a data source; may be declared in a json configuration
166           file (see CONF FILES section)
167
168       --alias
169           If set, the source refers to its alias
170
171       --format
172           To ouput results in other formats. (default: "txt")
173

REFLECTION:FUNCTION COMMAND

175       The phpreflect(1) reflection:function command is used to give
176       information about a user function present in a data source.
177
178       Usage:
179
180           phpreflect reflection:function [--alias] [--format="..."] argument source
181
182       Where:
183
184       argument
185           Name of the function to reflect.
186
187       source
188           Identify a data source; may be declared in a json configuration
189           file (see CONF FILES section)
190
191       --alias
192           If set, the source refers to its alias
193
194       --format
195           To ouput results in other formats. (default: "txt")
196

EXIT STATUS

198       0
199           Success
200
201       1
202           Failure (syntax or usage error; configuration error; unexpected
203           error).
204

CONF FILES

206       A configuration file contains data sources that can be analysed, but
207       also optional plugins and analysers installed. Require configuration
208       file is loaded in the following order:
209
210        1. The CONF_FILE specified by the environment variables BARTLETTRC and
211           BARTLETT_SCAN_DIR.
212
213        2. phpreflect.json from the current directory.
214
215        3. phpreflect.json from the User $HOME/.config directory.
216
217        4. phpreflect.json from the /etc directory.
218

BUGS

220       Report any issue at https://github.com/llaville/php-reflect/issues
221

AUTHORS

223       The Command-Line Interface (CLI) version was introduced in version 2.0
224       and is written by Laurent Laville.
225

SEE ALSO

227       Main web site: http://php5.laurent-laville.org/reflect/
228
230       Copyright (C) 2011-2015 Laurent Laville.
231

LICENSE

233       Free use of this software is granted under the terms of the BSD
234       3-clause license.
235
236
237
238  3.1.0                           2015-05-11                     PHPREFLECT(1)
Impressum