Generates wrapper classes based on existing MySQL tables.

Usage

generator.php [-d<database>] -t<table> [--classname=<classname>]
        [--has-many=<referent-class>] [--scaffold] [--scaffold-only]

If a database is not specified, the value set in dbConstants.class.php will be used.

The generator makes a number of assumptions. First, names of tables are pluralized. Animals, monsters, and users, not animal, monster, and user.

Second, it expects all tables to have at least the following three rows:

• id, int auto_increment primary key
• created, datetime
• updated, datetime

Third, the use of __callStatic() and other features necessitates PHP >= 5.3.

Fourth, database column names must also be valid PHP variable names: family_2 is valid, family(2) is not.

Inflector.class.php is a subset of the Ruby Inflector class.

---

Example

Assuming the schema for a database "zoo" is

create table `cages` (
    `id`        int auto_increment primary key,
    `created`   datetime,
    `updated`   datetime,
    `name`      varchar(50)
);

create table `animals` (
    `id`        int auto_increment primary key,
    `created`   datetime,
    `updated`   datetime,
    `kingdom`   varchar(128),
    `phylum`    varchar(128),
    `class`     varchar(128),
    `order`     varchar(128),
    `family`    varchar(128),
    `subfamily` varchar(128),
    `genus`     varchar(128),
    `species`   varchar(128),
    `cage_id`   int,
    constraint foreign key (`cage_id`) references `cages`(`id`)
);

Generate Models

./generator.php -d=zoo -t=animals
./generator.php -d=zoo -t=cages --has-many=animals

CRUD

require_once('Animals.class.php');

# create a new record
$dodo = new Animal();

$dodo->kingdom   = 'Animalia';
$dodo->phylum    = 'Chordata';
$dodo->class     = 'Aves';
$dodo->order     = 'Columbiformes';
$dodo->family    = 'Columbidae';
$dodo->subfamily = 'Raphinae';
$dodo->genus     = 'Raphus';
$dodo->species   = 'R. cucullatus';

$dodo->save();   # record is created in database
$dodo->delete(); # record is removed from database
$dodo->save();   # record is recreated in database (with new id)

# new records can also be created by passing in an array
$brontosaurus = new Animal(array(
    'kingdom'   => 'Animalia',
    'phylum'    => 'Chordata',
    'class'     => 'Reptilia',
    'order'     => 'Saurischia',
    'family'    => 'Diplodocidae',
    'subfamily' => 'Apatosaurinae',
    'genus'     => 'Apatosaurus',
    'species'   => 'A. excelsus'
));

Search

# find the first mammal (default order by created asc)
$mammal = Animal::find_by_class('mammalia');

# find all the vertebrates sorted by family in descending order
$mammals = Animal::find_all_by_phylum('chordata', array('order' => 'family desc'));

# get all the records from animals
$animals = Animal::find();

# use find() to get all carnivorans in cage 12 ordered by genus, reverse alphabetical
$mammals = Animal::find(
    'all',
    array(
        'conditions' => array(
            '`order` = ? and `cage_id` = ?', # wrap keywords as in raw SQL
            'carnivora', # follow the conditions clause with an ordered list
            12           # of values to replace the ? with
        ),
        'order' => 'genus desc'
    )
);

# get the last animal in the database
$last = Animal::find('first', array('order' => 'created desc'));

Paging

# get the third page of reptiles, 25 records per page
$reptiles = Animal::find_all_by_class(
    'reptilia',
    array(
        'page'     => 3,
        'per_page' => 25
    )
);

# find the total number of starfish
$starfish_count = Animal::count_by_class('asteroidea');

Relationships

$cage = new Cage(1); # get cage with id = 1

# get the number of weasels in the cage
echo $cage->animals()->count(array('family'=>'mustilidae'));

Scaffold Generation

A basic CRUD page can be created by supplying the --scaffold switch when calling generator.php. The page will contain a form for adding records as well as a table listing all existing records with the ability to edit or delete a specific record. Basic paging is included limiting the number of records on a single page to 25.

You can alternately generate the scaffold page with --scaffold-only to avoid overwriting an existing class file.