phpreflect (1) - Linux Manuals

phpreflect: Reverse-engineer classes, interfaces, functions, constants, namespaces and more

NAME

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

SYNOPSIS

phpreflect [options] command [arguments]

DESCRIPTION

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

OPTIONS

-h, --help

Display this help message.

-q, --quiet

Do not output any message.

-v|vv|v, --verbose

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug.

-V, --version

Display this application version.

--ansi

Force ANSI output.

--no-ansi

Disable ANSI output.

--profile

Display timing and memory usage information.

--progress

Show progress bar.

--output

Write results to file or URL.

--manifest

Show which versions of dependencies are bundled (PHAR version only).

ANALYSER:LIST COMMAND

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

ANALYSER:RUN COMMAND

The phpreflect(1) analyser:run command is used to analyse a data source and display results.

Usage:

phpreflect analyser:run [--alias] [--format[="..."]] [--filter[="..."]] source [analysers1] ... [analysersN]

Where:

source

Identify a data source; may be declared in a json configuration file (see CONF FILES section)

--alias

If set, the source refers to its alias

--format

If set, convert result to a specific format. (default: false)

--filter

Resource that provide a closure to filter results. (default: false)

analysers1 ... analysersN

Identify one or more analyser to execute. See analyser:list command to know what analysers are available. (default: ["structure"])

CONFIG:VALIDATE COMMAND

The phpreflect(1) config:validate command is used to check syntax of your json configuration file

Usage:

phpreflect config:validate [file]

Where:

file

Path to phpreflect.json file (optional)

DIAGNOSE:RUN COMMAND

The phpreflect(1) diagnose:run command is used to identify common errors on a platform.

Usage:

phpreflect diagnose:run [-vv|-vvv]

DIAGRAM:CLASS COMMAND

The phpreflect(1) diagram:class command is used to generate diagram about a user class present in a data source

Usage:

phpreflect diagram:class [--alias] [--engine[="..."]] argument source

Where:

argument

Name of the class to inspect

source

Identify a data source; may be declared in a json configuration file (see CONF FILES section)

--alias

If set, the source refers to its alias

--engine

Graphical syntax. (default: "plantuml")

DIAGRAM:PACKAGE COMMAND

The phpreflect(1) diagram:package command is used to generate diagram about namespaces in a data source

Usage:

phpreflect diagram:package [--alias] [--engine[="..."]] argument source

Where:

argument

Name of the namespace to inspect

source

Identify a data source; may be declared in a json configuration file (see CONF FILES section)

--alias

If set, the source refers to its alias

--engine

Graphical syntax. (default: "plantuml")

PLUGIN:LIST COMMAND

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

REFLECTION:CLASS COMMAND

The phpreflect(1) reflection:class command is used to give information about a user class present in a data source.

Usage:

phpreflect reflection:class [--alias] [--format="..."] argument source

Where:

argument

Name of the class to reflect.

source

Identify a data source; may be declared in a json configuration file (see CONF FILES section)

--alias

If set, the source refers to its alias

--format

To ouput results in other formats. (default: "txt")

REFLECTION:FUNCTION COMMAND

The phpreflect(1) reflection:function command is used to give information about a user function present in a data source.

Usage:

phpreflect reflection:function [--alias] [--format="..."] argument source

Where:

argument

Name of the function to reflect.

source

Identify a data source; may be declared in a json configuration file (see CONF FILES section)

--alias

If set, the source refers to its alias

--format

To ouput results in other formats. (default: "txt")

EXIT STATUS

0

Success

1

Failure (syntax or usage error; configuration error; unexpected error).

CONF FILES

A configuration file contains data sources that can be analysed, but also optional plugins and analysers installed. Require configuration file is loaded in the following order:

1. The CONF_FILE specified by the environment variables BARTLETTRC and BARTLETT_SCAN_DIR.

2. phpreflect.json from the current directory.

3. phpreflect.json from the User $HOME/.config directory.

4. phpreflect.json from the /etc directory.

BUGS

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

AUTHORS

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

COPYRIGHT

Copyright (C) 2011-2015 Laurent Laville.

LICENSE

Free use of this software is granted under the terms of the BSD 3-clause license.