API

Data Source Identification

Basic or Complex Strategy to identify the Data Source.

Now, and for the following chapters, we will not mention how you load the classes. Depending of the install strategy you’ve adopted, Composer or other, don’t forget to load your autoloader.

Compare to version 2, Reflect 3 offers two simple strategies to identify the data source.

First, is to give the relative or absolute path to file or directory to parse (without limitation).

Second, is to specify options to customize parsing process, to the Symfony Finder Component.

Basic Strategy

With all SAPI, no JSON config file is required (as it was for Reflect 2). You have just to give the relative or absolute path to file or directory to parse.

It’s also possible to specify any archive (phar, zip, tar, tgz, gz, rar) as file source.

Example with a simple file or directory (absolute path)

$ phpreflect analyser:run /absolute/path/to/source

Example with a simple file or directory (relative path)

$ phpreflect analyser:run ./relative/path/to/source

Complex Strategy

Still as it was with Reflect 2, you will need to configure your data source in a JSON file.

Syntax is closed to the Symfony Finder Component that is used to limit data source contents to parse.

Example to parse an archive

{
    "source-providers": [
        {
            "in": "phar:///var/dist/owncloud-7.0.2.tar as owncloud7",
            "name": "*.php",
            "exclude": ["3rdparty"]
        }
    ],
    "plugins": [
    ],
    "analysers" : [
    ]
}

Do not forget the phar:// protocol in front of archive identification.

Use alias named here owncloud7 to identify data source entry in the JSON config file, rather than the full path phar:///var/dist/owncloud-7.0.2.tar.

Example to parse a directory

{
    "source-providers": [
        {
            "in": "/home/github/phing/ as phing2",
            "path": ["bin", "classes"],
            "exclude": ["test"],
            "name": "*.php"
        }
    ],
    "plugins": [
    ],
    "analysers" : [
    ]
}

Learn more about source providers.

Whatever SAPI you use, all metrics (for each analysers asked) are available at end of parse, in the same format.

With CLI, and Reflect source code, to get a structure report, you have to invoke the following command :

$ phpreflect analyser:run /home/github/php-reflect/src

With others SAPI, use example https://raw.githubusercontent.com/llaville/php-reflect/master/examples/api_analyser_run.php

and you should obtain something like this :

Data Source Analysed

Directories                                         22
Files                                               77

Structure
  Namespaces                                        22
  Interfaces                                        10
  Traits                                             0
  Classes                                           67
    Abstract Classes                                 8 (11.94%)
    Concrete Classes                                59 (88.06%)
  Methods                                          312
    Scope
      Non-Static Methods                           299 (95.83%)
      Static Methods                                13 (4.17%)
    Visibility
      Public Method                                268 (85.90%)
      Protected Method                              35 (11.22%)
      Private Method                                 9 (2.88%)
  Functions                                         11
    Named Functions                                  0 (0.00%)
    Anonymous Functions                             11 (100.00%)
  Constants                                         21
    Global Constants                                 0 (0.00%)
    Magic Constants                                  3 (14.29%)
    Class Constants                                 18 (85.71%)
  Tests
    Classes                                          0
    Methods                                          0

This is the default render. But, if you want to compare with other SAPI, activate the debug verbose mode (-vvv) to get the raw response. You should obtain something like this :

First entry in array is the list of parsed files
Second entry in array is the structure analyser result

Each analyser as its own data structure and results, but you will always get the fully qualified class name that identify origin of analyser used.

Example with two analysers (structure and loc)

$ phpreflect analyser:run /home/github/php-reflect/src structure loc

API

Source Provider

Data Source Identification

Basic Strategy

Complex Strategy

Handle Results