Download the PHP package jhofm/ph-puml without Composer

On this page you can find all versions of the php package jhofm/ph-puml. 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 jhofm/ph-puml

Informations about the package ph-puml

PhPuml

Packagist Packagist Packagist CI Workflow

About PhPuml

PhPuml generates PlantUML class diagrams from PHP code.

Here's a class diagram of the tool, created by itself:

Features

Installation

The easiest way to install PhPuml is as a composer project.

A phar version of the tool is created a part of the build process, but currently not reliably downloadable. However with the project already installed, you can create the phar yourself using clue/phar-composer.

Quick Start

The ph-puml script will output PlantUML syntax describing all PHP files found in the current folder when run without any parameters.

You can specify a relative or absolute path to a target directory or file as the first argument.

The second optional argument is the output path. The console's standard output will be used if none is specified.

The following two commands produce the same result:

Advanced features

Output formats

PhPuml generates PlantUML puml file syntax by default, but you can also export most output formats supported by PlantUML directly.

Currently, these are:

This requires a Java Runtime Environment on the machine running PhPuml. See the PlantUML guide for more information. You also need to either:

Path filters

If the input path is a directory, PhPuml will determine the code files to analyze using a set of inclusion and exclusion rules. By default, files in the directory tree with the file extension .php are included, as long as none of their parent folders are called vendor.

You can override the filter rules with command line options. All rules are regular expressions. You can use several at the same time. For example the following command will NOT skip files from vendor folders, and analyze files in the includes folder with the file extension .inc as well.

The command will fail when attempting to parse files that do not contain valid PHP code.

Namespaces

Namespaced classes, interfaces and traits are rendered with fully qualified names by default, while property and method argument types are not. This behaviour can be customized using the namespaced-types/t option.

Relations to external types

Relations to types that have not been analyzed are not rendered by default to reduce clutter in the generated diagram. This included built-in Types like \Exception etc. Add the following option to include these relations.

Help

PhPuml uses symfony/command, so a help page including all supported arguments and options is available.

Omitting namespaces for classes, interfaces or traits may cause relations to be drawn wrong if unqualified type names are repeated in the analyzed sources.

Limitations

Troubleshooting

Acknowledgements

This would have been exponentially more difficult to do without Nikita Popov's PHP-Parser, so many thanks for that. Symfony helped a lot, too. Basically every dependency i use is maintained by kings, queens and total legends. <3

All versions of ph-puml with dependencies

PHP Build Version
Package Version
Requires php Version ^7.4
composer-plugin-api Version ^2.0
ext-json Version *
symfony/console Version ^5.2
nikic/php-parser Version ^4.10
symfony/dependency-injection Version ^5.2
symfony/process Version ^5.2
symfony/finder Version ^5.2
league/flysystem Version ^2.0
symfony/config Version ^5.2
symfony/yaml Version ^5.2
mockery/mockery Version ^1.4
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 jhofm/ph-puml contains the following files

Loading the files please wait ....