PHP Classes

PHP MySQL Project Documentation: Generate documentation for a MySQL database

Recommend this page to a friend!
     
  Info   Example   View files Files   Install with Composer Install with Composer   Download Download   Reputation   Support forum   Blog    
Ratings Unique User Downloads Download Rankings
StarStarStar 56%Total: 431 This week: 1All time: 6,313 This week: 34Up
Version License PHP version Categories
phpdbdoc 1.0.1Freely Distributable5HTML, PHP 5, Databases
Description 

Author

This class can generate documentation for a MySQL database.

It accesses a given MySQL database and retrieves the informations of all tables.

The class displays a HTML page with a table with the list of tables and other tables with each table field details and foreign keys details.

Innovation Award
PHP Programming Innovation award nominee
February 2017
Number 5


Prize: One downloadable copy of Komodo IDE
MySQL is by far the most popular database used in PHP applications. Part of PHP application documentation is the information of the underlying database schema.

This class makes it simpler to generate documentation about an application database by generating HTML to display the schema of tables, fields and indexes of a MySQL database.

Manuel Lemos
Picture of Rafael Sbrissa
  Performance   Level  
Name: Rafael Sbrissa <contact>
Classes: 1 package by
Country: Brazil Brazil
Age: 33
All time rank: 3448265 in Brazil Brazil
Week rank: 44 Up5 in Brazil Brazil Up
Innovation award
Innovation award
Nominee: 1x

Example

<?php

include('phpdbdoc.php');

$doc = new phpdbdoc();
$doc->setUserdb("root");
$doc->setLinkdb('localhost');
$doc->setPassword('toor');
$doc->setDataBase('gestorfox');
$doc->DBConnect();
$doc->getDoc();
?>


  Files folder image Files (3)  
File Role Description
Accessible without login Plain text file index.php Example Example script
Plain text file phpdbdoc.php Class Class source
Accessible without login Plain text file README.md Doc. Documentation

The PHP Classes site has supported package installation using the Composer tool since 2013, as you may verify by reading this instructions page.
Install with Composer Install with Composer
 Version Control Unique User Downloads Download Rankings  
 100%
Total:431
This week:1
All time:6,313
This week:34Up
User Ratings User Comments (1)
 All time
Utility:83%StarStarStarStarStar
Consistency:87%StarStarStarStarStar
Documentation:-
Examples:62%StarStarStarStar
Tests:-
Videos:-
Overall:56%StarStarStar
Rank:1755