PHPackages                             bulton-fr/methods-header-generator - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. bulton-fr/methods-header-generator

ActiveLibrary[Utility & Helpers](/categories/utility)

bulton-fr/methods-header-generator
==================================

Generate the header of all methods into a PHP classes.

0.1.2(7y ago)00LGPL-3.0PHPPHP >=5.4.0

Since Aug 17Pushed 7y ago1 watchersCompare

[ Source](https://github.com/bulton-fr/methods-header-generator)[ Packagist](https://packagist.org/packages/bulton-fr/methods-header-generator)[ Docs](https://github.com/bulton-fr/methods-header-generator)[ RSS](/packages/bulton-fr-methods-header-generator/feed)WikiDiscussions master Synced today

READMEChangelog (3)Dependencies (2)Versions (5)Used By (0)

methods-header-generator
========================

[](#methods-header-generator)

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

[![Build Status](https://camo.githubusercontent.com/33d0f6db593195e20437b86ed00c2079ce448ce5eed1ee0d95946a40c5459f62/68747470733a2f2f7472617669732d63692e6f72672f62756c746f6e2d66722f6d6574686f64732d6865616465722d67656e657261746f722e7376673f6272616e63683d646576656c6f70)](https://travis-ci.org/bulton-fr/methods-header-generator) [![Scrutinizer Code Quality](https://camo.githubusercontent.com/5ce8b4453d5c8302e2b69a907b3718a5f0f38a67031df2724792c00059a9d166/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f62756c746f6e2d66722f6d6574686f64732d6865616465722d67656e657261746f722f6261646765732f7175616c6974792d73636f72652e706e673f623d646576656c6f70)](https://scrutinizer-ci.com/g/bulton-fr/methods-header-generator/?branch=develop) [![Latest Stable Version](https://camo.githubusercontent.com/1ceebf760384e59c394fc6de2288d12b19509bd2d149a27ecabd7144471c8016/68747470733a2f2f706f7365722e707567782e6f72672f62756c746f6e2d66722f6d6574686f64732d6865616465722d67656e657261746f722f762f737461626c652e737667)](https://packagist.org/packages/bulton-fr/methods-header-generator) [![License](https://camo.githubusercontent.com/aed412cebf149a6a2115dd3888af2598022a8853eacd74b42a83e22668ad8441/68747470733a2f2f706f7365722e707567782e6f72672f62756c746f6e2d66722f6d6574686f64732d6865616465722d67656e657261746f722f6c6963656e73652e737667)](https://packagist.org/packages/bulton-fr/methods-header-generator)

Install
=======

[](#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
======

[](#use-it)

With ProjectParser class
------------------------

[](#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 :

```
$project = new \bultonFr\MethodsHeaderGenerator\ProjectParser('myVendorPath', ['myNamespaceToInspect\\']);
echo $project->run();
```

The constructor take three parameters:

- `$vendorDir` The path to the vendor dir
- `$nsToParse` An array of all namespace to parse
- `$nsToIgnore` An array of all namespace to ignore

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

```