https://github.com/davidepastore/paris-model-generator

Paris model generator from database
https://github.com/davidepastore/paris-model-generator

database model paris php

Last synced: about 1 month ago
JSON representation

Paris model generator from database

• Host: GitHub
• URL: https://github.com/davidepastore/paris-model-generator
• Owner: DavidePastore
• License: mit
• Created: 2015-02-13T08:48:02.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2015-02-13T15:18:34.000Z (almost 10 years ago)
• Last Synced: 2024-04-04T13:12:48.040Z (8 months ago)
• Topics: database, model, paris, php
• Language: PHP
• Size: 141 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# paris-model-generator

[Paris](https://github.com/j4mie/paris) model generator from database.

## Installation

### Using command line

```sh

$ composer require davidepastore/paris-model-generator:0.1.*

```

### Editing composer.json

Require this generator:

```json

"require": {

  "davidepastore/paris-model-generator": "0.1.*"

}

```

## Setup

You have to setup your application to be sure that the generated classes will be in the right place and with the right

namespace. 

**paris-model-generator** uses `composer.json` `extra` property to put its configuration:

```json

"extra": {

  "paris-model-generator": {

    "namespace": "VendorName\\MyProject\\Models",

    "destination-folder": "src\\"

	}

}

```

### namespace

It is the namespace in which all classes will be generated. It will be also used to create the folder structure to be PSR-4 compliant.

### destination-folder

It is the folder in which all files (and folder structure) will be generated.

## Usage

Be sure to be in the base directory of the project (where you have your `composer.json` file) and run:

```sh

$ vendor/bin/paris-generator models [--force]

```

The generator will ask you information about the database, to be sure to connect to it and to retrieve the list of tables.

The list of the supported drivers could be found [here](http://docs.doctrine-project.org/projects/doctrine-dbal/en/latest/reference/configuration.html#connection-details).

### force option

The `--force` option will not ask you confirmation to overwrite existing files.

## Include generated files

You have two chances:

* psr-4 autoload;

* classmap autoload.

### PSR-4 autoload

If your namespace property is set you can use `psr-4` composer autoload:

```json

"autoload" : {

  "psr-4" : {

    "" : "your-destination-folder/"

  }

}

```

Don't forget to set `Model::$auto_prefix_models` to be sure that your model is recognized properly when you use 

`Model::factory` method:

```php

Model::$auto_prefix_models = 'YourAmazing\\Namespace\\';

```

### Classmap autoload

If your namespace property is empty or not set, you have to autoload using:

```json

"autoload": {

  "classmap" : [

    "your-destination-folder/"

  ]

}

```

## Issues

If you have issues, just open one [here](https://github.com/DavidePastore/paris-model-generator/issues).