Phormium Model Generator

Model class generator for Phormium., _(*1)

ModGen generates classes which extend Phormium\Model from existing database tables. Currently supports MySQL, PostgreSQL, SQLite and Informix., _(*2)

, _(*3)

Installation

PHAR

The simplest way to use ModGen is to download the latest version as a PHAR archive from the releases page on GitHub., _(*4)

You can now run ModGen:, _(*5)

php modgen.phar

This is abbreviated to modgen in the usage examples., _(*6)

Packagist

You can also install from Packagist using using Composer., _(*7)

Create a file called composer.json with the following contents:, _(*8)

{
    "require": {
        "phormium/modgen": "0.*"
    }
}

Download composer and run:, _(*9)

php composer.phar install

The script for running modgen will be vendor/bin/modgen for *nix and Mac and vendor\bin\modgen.bat for Windows users. This is abbreviated to modgen in the usage examples., _(*10)

Creating the PHAR

To compile ModGen into a PHAR, clone the project from GitHub:, _(*11)

git clone https://github.com/ihabunek/phormium-modgen.git

Install the dependencies using Composer:, _(*12)

php composer.phar install

Run the compilation script:, _(*13)

php bin\compile

modgen.phar will be generated in your working directory., _(*14)

Usage

Before starting, you need to have a Phormium configuration file which defines the database from which you want to generate models. If a config file is not specified, modgen will look for a file named "config.json" in the working directory., _(*15)

Generate models for all tables in a database:, _(*16)

modgen generate [options] <database>

Generate models for specified tables in a database:, _(*17)

modgen generate [options] <database> [table1] ... [tableN]

Options:, _(*18)

--config - Path to the config file. (default: "config.json")
--target - Target folder where the model will be generated (defaults to current working directory)
--namespace - The PHP namespace used for the model classes. (default: "")
--help (-h) - Display the help message.