Download the PHP package wongdoody/php-uml-crafter without Composer
On this page you can find all versions of the php package wongdoody/php-uml-crafter. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download wongdoody/php-uml-crafter
More information about wongdoody/php-uml-crafter
Files in wongdoody/php-uml-crafter
Package php-uml-crafter
Short Description This package generates uml from php code
License GPL-3.0
Homepage https://github.com/oddity-agency/php-uml-crafter
Informations about the package php-uml-crafter
Php Uml Crafter
This package generates uml from php code. PlantUML is required to see the diagram, you can either install the plugin in your code editor or use a online tool visualize it.
Installation
You can install the package via composer:
Usage in Laravel projects
You can publish the config file with:
This is the content of the published config file for Laravel projects:
Scan classes command
Generate a PlantUML file command
It is also possible to pass the following options in the command:
--project-path
: Path to the root directory of your PHP framework project as string.
--exclude-directories
: Directories to exclude from the scanning process, if any in comma separated list.
--exclude-files
: Files to exclude from the scanning process, if any comma separated list.
--save-path
: Path to save the generated UML diagrams as string.
--include-traits
: --include-traits=true scan traits and interfaces
Usage in other PHP Frameworks
For other PHP frameworks, you can still utilize the UML Crafter package to scan classes and generate UML diagrams. Below is a generic command that can be adjusted to fit the structure and requirements of different frameworks:
Scan classes
Replace the placeholders (your_project_directory, directory_to_exclude, file_to_exclude, path_to_save_diagrams) with appropriate values according to your PHP framework's directory structure and preferences.
--project-path
: Path to the root directory of your PHP framework project as string.
--exclude-directories
: Directories to exclude from the scanning process, if any comma separated list.
--exclude-files
: Files to exclude from the scanning process, if any comma separated list.
--save-path
: Path to save the generated UML diagrams as string.
Make sure to adjust the command parameters to match your specific PHP framework's structure and requirements.
Styling
For the uml-crafter:generate command there is also an option to change style to light mode (as default is dark mode set). Add flag below to the command:
--light-mode
: Change style to light mode
Example: php artisan uml-crafter:generate --light-mode=true
Credits
License
GNU GENERAL PUBLIC LICENSE (GPL-3).