https://github.com/janalis/doctrineviz

Render a graphical representation of a Doctrine2 mapped database.
https://github.com/janalis/doctrineviz

doctrine entity-relationship graphviz symfony-bundle

Last synced: 3 months ago
JSON representation

Render a graphical representation of a Doctrine2 mapped database.

• Host: GitHub
• URL: https://github.com/janalis/doctrineviz
• Owner: janalis
• License: other
• Created: 2017-01-21T14:09:39.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-02-26T12:50:48.000Z (over 2 years ago)
• Last Synced: 2025-12-14T12:03:00.937Z (6 months ago)
• Topics: doctrine, entity-relationship, graphviz, symfony-bundle
• Language: PHP
• Size: 341 KB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# doctrineviz

[![Build Status](https://travis-ci.org/janalis/doctrineviz.svg?branch=master)](https://travis-ci.org/janalis/doctrineviz)

[![Coverage Status](https://coveralls.io/repos/github/janalis/doctrineviz/badge.svg?branch=master)](https://coveralls.io/github/janalis/doctrineviz?branch=master)

[![SensioLabs Insight](https://img.shields.io/sensiolabs/i/dc69f3e1-060d-4ac8-9fb2-94ced25992f2.svg)](https://insight.sensiolabs.com/projects/dc69f3e1-060d-4ac8-9fb2-94ced25992f2)

[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/janalis/doctrineviz/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/janalis/doctrineviz/?branch=master)

[![Style CI](https://styleci.io/repos/79649553/shield?style=flat)](https://styleci.io/repos/79649553)

Render a graphical representation of a Doctrine2 mapped database.

## Example

![Example](example.png)

## Installation

Require package through composer:

```bash

$ composer require --dev janalis/doctrineviz

```

Then, enable the bundle by adding the following line in the `app/AppKernel.php` file of your project:

```php

// app/AppKernel.php

class AppKernel extends Kernel

{

    public function registerBundles()

    {

        //...

        if (in_array($this->getEnvironment(), ['dev', 'test'])) {

            // ...

            // Because the vendor code could be not present, you should check if the bundle is here before using it.

            new Janalis\Doctrineviz\DoctrinevizBundle(),

        }

        // ...

    }

    // ...

}

```

In order to be able to use the graph drawing feature you'll have to install GraphViz (dot executable).

### Mac OS

```bash

$ brew install graphviz

```

### Ubuntu

```bash

$ sudo apt install -y graphviz

```

### Windows

Windows users may [download GraphViZ for Windows](http://www.graphviz.org/Download_windows.php).

## Usage

Into your symfony project:

```bash

$ php app/console doctrine:generate:viz --help

```

## Credits

- [globalcitizen/mysqlviz](https://github.com/globalcitizen/mysqlviz)

- [graphp/graphviz](https://github.com/graphp/graphviz)