1PHPCOMPATINFO(1) PHPCOMPATINFO(1)
2
6 phpcompatinfo - PHP library that parse any data source to find out the
7 minimum version and extensions required for it to run.
8
10 phpcompatinfo [options] command [arguments]
11
13 The phpcompatinfo(1) command parse any data source, defined in a json
14 configuration file, to find out elements, such as classes, interfaces,
15 functions, constants, namespaces.
16
18 -h, --help
19 Display this help message.
20 -q, --quiet
22 Do not output any message.
23 -v|vv|v, --verbose
25 Increase the verbosity of messages: 1 for normal output, 2 for more
26 verbose output and 3 for debug.
27 -V, --version
29 Display this application version.
30 --ansi
32 Force ANSI output.
33 --no-ansi
35 Disable ANSI output.
36 --profile
38 Display timing and memory usage information.
39 --progress
41 Show progress bar.
42 --output
44 Write results to file or URL.
45 --manifest
47 Show which versions of dependencies are bundled (PHAR version
48 only).
49
51 The phpcompatinfo(1) analyser:list command is used to show what
52 analysers are installed (see CONF FILES section).
53
55 The phpcompatinfo(1) analyser:run command is used to analyse a data
56 source and display results.
57 Usage:
59 phpcompatinfo analyser:run [--alias] [--format[="..."]] [--filter[="..."]] source [analysers1] ... [analysersN]
61 Where:
63 --alias
65 If set, the source refers to its alias
66 --format
68 If set, convert result to a specific format. (default: false)
69 --filter
71 Resource that provide a closure to filter results. (default: false)
72 source
74 Identify a data source; may be declared in a json configuration
75 file (see CONF FILES section)
76 analysers1 ... analysersN
78 Identify one or more analyser to execute. See analyser:list command
79 to know what analysers are available. (default: ["compatibility"])
80
82 The phpcompatinfo(1) config:validate command is used to check syntax of
83 your json configuration file
84 Usage:
86 phpcompatinfo config:validate [file]
88 Where:
90 file
92 Path to phpcompatinfo.json file (optional)
93
95 The phpcompatinfo(1) diagnose:run command is used to identify common
96 errors on a platform.
97 Usage:
99 phpcompatinfo diagnose:run [-vv|-vvv]
101
103 The phpcompatinfo(1) diagram:class command is used to generate diagram
104 about a user class present in a data source
105 Usage:
107 phpcompatinfo diagram:class [--alias] [--engine[="..."]] argument source
109 Where:
111 argument
113 Name of the class to inspect
114 source
116 Identify a data source; may be declared in a json configuration
117 file (see CONF FILES section)
118 --alias
120 If set, the source refers to its alias
121 --engine
123 Graphical syntax. (default: "plantuml")
124
126 The phpcompatinfo(1) diagram:package command is used to generate
127 diagram about namespaces in a data source
128 Usage:
130 phpcompatinfo diagram:package [--alias] [--engine[="..."]] source
132 Where:
134 source
136 Identify a data source; may be declared in a json configuration
137 file (see CONF FILES section)
138 --alias
140 If set, the source refers to its alias
141 --engine
143 Graphical syntax. (default: "plantuml")
144
146 The phpcompatinfo(1) plugin:list command is used to show what plugins
147 are installed (see CONF FILES section).
148
150 The phpcompatinfo(1) reference:list command is used to list all
151 references supported.
152 Usage:
154 phpcompatinfo reference:list
156
158 The phpcompatinfo(1) reference:show command is used to introspect a
159 reference.
160 Usage:
162 phpcompatinfo reference:show [--filter[="..."]] [--releases] [--ini] [--constants] [--functions] [--interfaces] [--classes] name
164 Where:
166 name
168 Introspection of a reference (case insensitive)
169 --filter
171 Resource that provide a closure to filter results (default: false)
172 --releases
174 Show releases
175 --ini
177 Show ini Entries
178 --constants
180 Show constants
181 --functions
183 Show functions
184 --interfaces
186 Show interfaces
187 --classes
189 Show classes
190
192 The phpcompatinfo(1) reflection:class command is used to give
193 information about a user class present in a data source.
194 Usage:
196 phpcompatinfo reflection:class [--alias] [--return="..."] argument source
198 Where:
200 argument
202 Name of the class to reflect.
203 source
205 Identify a data source; may be declared in a json configuration
206 file (see CONF FILES section)
207 --alias
209 If set, the source refers to its alias
210 --format
212 Format of result to return. False when raw text. (default: false)
213
215 The phpcompatinfo(1) reflection:function command is used to give
216 information about a user function present in a data source.
217 Usage:
219 phpcompatinfo reflection:function [--alias] [--return="..."] argument source
221 Where:
223 argument
225 Name of the function to reflect.
226 source
228 Identify a data source; may be declared in a json configuration
229 file (see CONF FILES section)
230 --alias
232 If set, the source refers to its alias
233 --format
235 Format of result to return. False when raw text. (default: false)
236
238 0
239 Success
240 1
242 Failure (syntax or usage error; configuration error; unexpected
243 error).
244
246 A configuration file contains data sources that can be analysed, but
247 also optional plugins and analysers installed. Require configuration
248 file is loaded in the following order:
249 1. The CONF_FILE specified by the environment variables BARTLETTRC and
251 BARTLETT_SCAN_DIR.
252 2. phpcompatinfo.json from the current directory.
254 3. phpcompatinfo.json from the User $HOME/.config directory.
256 4. phpcompatinfo.json from the /etc directory.
258
260 Report any issue at https://github.com/llaville/php-compat-info/issues
261
263 PHP_CompatInfo was originally written by Davey Shafik in 2004.
264 Remi Collet, contributor of many extensions reference and unit tests,
266 joined the project since version 2.0.0RC2
267 The Command-Line Interface (CLI) version was introduced in version 2.0
269 and is written by Laurent Laville.
270
272 Main web site: http://php5.laurent-laville.org/compatinfo/
273
275 Copyright (C) 2010-2015 Laurent Laville.
276
278 Free use of this software is granted under the terms of the BSD
279 3-clause license.
280 4.2.0 2015-05-19 PHPCOMPATINFO(1)