Download the PHP package dlid/cdbyuml without Composer
On this page you can find all versions of the php package dlid/cdbyuml. 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 cdbyuml
CDbYuml
CDbYuml will create class diagrams from your PDO sqlite or mysql datasource using yuml.me.
- Flexible so you can use your favorite datasbase access layer
- Easy to use with an existing PDO connection (see example below)
CDbYuml can be used with many other database librariees due to the fact that you will define how the queries are executed:
- CDbYuml will use your callback function to query database for metadata
- CDbYuml will then generate the Yuml string based on the dataase metadata
- The Yuml string is posted to yuml.me and the generated diagram is downloaded
Version
0.2
Tech
CDbYuml has the following requirements:
Note about complex diagrams
For very large and/or databases this may not be the library you are looking for. It has been tested with simple database structures with a few foreign keys of different kinds.
If the diagram is not generated like you want, you can always send me the generated text and I can try to figure out how to make it compatible.
Options
Methods
- setOptions ( $options ) - Configure the library. See option above
- outputImage ( [$force = true] ) - generate diagram and output the image to the browser
- outputText ( [$force = true] ) - output a HTML page with debug information
- __construct ( $options ) - Configure the library. Same parameters as setOptions
Sample usage
In the following example a sqlite database is created with a number of tables.
CDbYuml is then used to generate the diagram of the table.
Alternative ways to do it
Passing the PDO object as a query
You can also pass your PDO object as the first parameter. Other options can then be set using the second parameter.
Note: Using the method above you can not pass in the 'query' option in the second parameter. The internal function for retreiving data will then be used
Using the constructor instead of setOptions
Finally you can also use the constructor in the very same way as setOptions:
Caching
I recommend using caching for your diagrams. If you do not, then CDbYuml will query your database for it's structure and download a new diagram from yuml.me every time. Please cache and everyone will be so, so happy!
In the above examle, if you specify cachepath and cachetime two things will happend:
- The yuml text will be saved to the file /somepath/db_diagram.cache
- The downloaded image will be saved to the file /somepath/db_diagram.png
The cache will be invalidated if:
- you change the 'style' parameter
- you change the 'scale' parameter
- the cachetime has expired (five minutes since last .cache-file was written)
If 'style' or 'scale' changes, the database structure will be extracted again and a new diagram will be downloaded.
If the cachetime expires then the database will be queried again for it's structure and:
- if the structure has changed, then a new diagram will be downloaded
- otherwise the /somepath/db_diagram.png image will be used
Composer
You can add dlid/cdbyuml to your composer.json file like this.
License
MIT
