Download the PHP package lordsimal/cakephp-dbml without Composer
On this page you can find all versions of the php package lordsimal/cakephp-dbml. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
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 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.
Informations about the package cakephp-dbml
CakePHP 4 DBML plugin
This plugin generates a DBML file from your current present CakePHP table files including plugin ones.
See https://www.dbml.org/, https://dbdiagram.io and https://dbdocs.io/ to get more information about DBML.
Installation
The recommended way to install this plugin via composer is:
Then execute
or add this to your src/Application.php manually
How to use
After installing the plugin you now have a new command available to you:
After executing that you should have a new file in your applications root folder called dbml-export.dbml
This text file can then be copy-pasted into e.g. https://dbdiagram.io where you can very easily drag&drop your tables into a structure which is more visually appealing
Possible warning messages
It is possible that you get warning messages like these:
This means that you current database schema doesn't have that table but your code (or in this case the plugin "Tools") contains a table file which has been detected.
Configuration
All default config-keys can be seen in this plugins config/config.php file
Dbml.path=> The path where the generated file will be placedDbml.filename=> The filenameDbml.blacklistedPlugins=> Array of plugins which should be skippedDbml.blacklistedTables=> Array of table names which should be skipped
You can extend any of these values just by adding the following to your config/app_local.php
How does it work?
Executing the command from above will look through all your table files (in your app as well as all installed plugins) and load their schema data including relations.
By default it does exclude the plugins DebugKit as well as Migrations which are present in new CakePHP applications
If you want to have more information on which tables and which associations are being detected execute the command like so
After gathering all the table and association data they get formatted into a structure which is more easily written to the DBML file.
Acknowledgement
Big shoutout to @dereuromark and especially his https://github.com/dereuromark/cakephp-model-graph plugin which definitely inspired and helped me create this plugin!
