Download the PHP package bulton-fr/doc-struct-generator without Composer

On this page you can find all versions of the php package bulton-fr/doc-struct-generator. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of bulton-fr/doc-struct-generator

Informations about the package doc-struct-generator

methods-header-generator

Generate methods struct for all classes of a project. Can be used like help to write documentation.

Build Status Scrutinizer Code Quality Latest Stable Version License

Install

With composer composer require bulton-fr/methods-header-generator

Because dependency phpdocumentor/reflection-common in 2.0.0-beta1, you should have PHP >= 7.1

I will see if I can doing anything to allow PHP 5.x versions.

Use it

With ProjectParser class

This class will take all classes declared into your composer project, and inspect her. The other function of this class is to save all class already parsed to avoid to re-parse it again if another class extend it (for exemple).

About composer, it should have the classmap generated. So you should use the option -o when you install or update your composer project.

Exemple : composer update -o

To use ProjectParser :

The constructor take three parameters:

Exemple with my BFW project: I create the file : /docs/parser.php

I ask to ProjectParse to generate the structure for classes with a namespace started by \BFW\, but to ignore all classes with a namespace who started by \BFW\Test to not have my unit test classes inspected.

Without ProjectParser class

Without ProjectParser, you will loop on all your classes manually. For each class, you will instantiate ClassParser and take him the class name you want to inspect, with the namespace.

Exemple:

What is returned ?

If I use ClassParser on the class ProjectParser, it will return :

All versions of doc-struct-generator with dependencies

PHP Build Version
Package Version
Requires php Version >=5.4.0
phpdocumentor/reflection-docblock Version ^5.0
phpdocumentor/type-resolver Version ^0.6
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package bulton-fr/doc-struct-generator contains the following files

Loading the files please wait ....