getting-started.asciidoc

Getting Started

Download

We distribute a PHP Archive (PHAR) that contains all required dependencies of PHP Reflect bundled in a single file.

Download the latest version

Make it executable, and put it into your $PATH.

$ chmod +x phpreflect-3.1.0.phar
$ mv phpreflect-3.1.0.phar /usr/local/bin/phpreflect

$ phpreflect --version

You can also immediately use the PHAR after you have downloaded it.

$ wget http://bartlett.laurent-laville.org/get/phpreflect-3.1.0.phar
$ php phpreflect-3.1.0.phar --version

With both methods then you have this output :

phpReflect version 3.1.0

Other alternative installations are possible. Please refer to the documentation for details on how to do this.

Configuration

With the minimalist JSON file phpreflect.json

{
    "source-providers": [
        {
            "in": ". as current",
            "name": "/\\.(php|inc|phtml)$/"
        }
    ],
    "plugins": [
    ],
    "analysers": [
    ],
    "services": [
    ]
}

Put it in your project’s folder. Alternative locations are possible. Please refer to the documentation for details on how to do this.

Note	The JSON configuration file is no more required for basic usage. Reserved to advanced users.

Structure

source-providers

this entry provide list of your data sources to parse.

plugins

this entry list all plugins added to the core base code of PHP Reflect.

analysers

this entry list all analysers that may be used with the analyser:run command.

services

this entry list all services that may be used with this application.

Execution

With the Reflect source code, invoke the following command :

$ phpreflect analyser:run .

and you should obtain something like this :

link:structure_analysis.out.asciidoc[role=include]

Another analyser (loc) is also available, and can be combined or not with structure the default analyser.

With the Reflect source code, invoke the following command :

$ phpreflect analyser:run . loc

and you should obtain something like this :

link:loc_analysis.out.asciidoc[role=include]

Summary

Let’s review what we’ve done :

• downloaded the latest stable PHAR version.

• prepared a minimalist JSON configuration file that is OPTIONAL to run Reflect commands.

• executed your first parse on the Reflect data source.

Next

Choose your way depending of your skill level.

Read more

• Want to learn more about the command line interpreter (CLI) version, interface that do Reflect an easy tool without to write a line of PHP code, have a look on user’s guide

• Want to learn more about Reflect architecture and /or you want to extends it to match your needs, have a look on developer’s guide

• You are a user of previous version 1.9 that is really different, and want to upgrade to the new major version 2, and keep your old environment still running, have a look on migration’s guide