README

Describe is a PHP package that returns information about a table structure from a database.

Installation

Install Describe via Composer:

$ composer require rougin/describe

Basic usage

Describe requires a vendor-specific driver to get a database table's structure:

// index.php

use Rougin\Describe\Driver\MysqlDriver;

$dsn = 'mysql:host=localhost;dbname=test';

$pdo = new PDO($dsn, 'root', '');

$driver = new MysqlDriver($pdo, 'test');

Below are the available drivers for specified vendors:

Alternatively, the DatabaseDriver can also be used to use a vendor-specific driver based on keyword:

use Rougin\Describe\Driver\DatabaseDriver;

$creds = array('password' => '');

$creds['hostname'] = 'localhost';
$creds['database'] = 'test';
$creds['username'] = 'root';

$driver = new DatabaseDriver('mysql', $creds);

After specifying the driver, use the columns method to return a list of columns:

// index.php

/** @var \Rougin\Describe\Column[] */
$columns = $driver->columns('users');

Using Table

The Table class is similar with the DriverInterface with the difference that it can return the primary key from the list of columns:

use Rougin\Describe\Table;

$table = new Table('users', $driver);

/** @var \Rougin\Describe\Column[] */
$columns = $driver->columns();

/** @var \Rougin\Describe\Column */
$primary = $driver->primary();

For more information regarding the Column object, kindly check its code documentation.

Adding a new database driver

Use the DriverInterface for implementing a vendor-specific driver:

namespace Rougin\Describe\Driver;

interface DriverInterface
{
    /**
     * Returns a list of columns from a table.
     *
     * @param string $table
     *
     * @return \Rougin\Describe\Column[]
     */
    public function columns($table);

    /**
     * Returns a list of tables.
     *
     * @return \Rougin\Describe\Table[]
     */
    public function tables();
}

Use-cases

The following projects below uses Describe as a valuable tool:

Combustor

Combustor is a utility package for Codeigniter 3 that generates controllers, models, and views based on the provided database tables. It uses Describe for getting columns from a database table and as the basis for code generation.

Refinery

Refinery is a console-based package of Migrations Class for the Codeigniter 3. It uses Describe for retrieving the database tables for creating database migrations.

Changelog

Please see CHANGELOG for more recent changes.

Development

Includes configuration for code quality, coding style, and unit tests.

Note

The sub-sections below are for those who need to access the package's source code for development, such as creating fixes or new features.

Code quality

Analyze code quality using phpstan:

$ phpstan

Coding style

Enforce coding style using php-cs-fixer:

$ php-cs-fixer fix --config=phpstyle.php

Unit tests

Execute unit tests using phpunit:

$ composer test

Credits

Big thanks to all contributors in this package!

License

This package uses the MIT Licenses (MIT).