README

ModelDoc Generator will extend Gii allowing an update to existing models with phpDoc compatible documentation.

Features

Table Fields
- Adds properties for each field.
- Properties are annotated with field comments from the database.
Relations
- Adds a property with a return type for each relation.
CActiveRecord Inheritance
- Adds methods inherited from CActiveRecord including: find(), findByPk(), findByAttributes(), fndBySql(), findAll(), findAllByPk(), findAllByAttributes(), findAllBySql(), with(), together(), cache(), resetScope(), populateRecord() and populateRecords().
Behaviors
- Adds a property with a return type for each behavior.
- Adds methods assigned for behaviors, unless it is defined by the model itself.
- Optionally uses @mixin for behaviors.
Scopes
- Adds a method for each scope.
Full Syntax
- All PHPDoc tags contain full syntax including: method params and return types.
- All returned models have namespace support.

Screenshots

Listing all the models that are going to have phpDocs inserted:

Preview of the model before it gets updated:

Installation

Please download using ONE of the following methods:

Composer Installation

All requirements are automatically downloaded into the correct location when using composer. There is no need to download additional files or set paths to third party files.

Get composer:

curl http://getcomposer.org/installer | php

Install latest release OR development version:

php composer.phar require cornernote/gii-modeldoc-generator:*				// latest release
php composer.phar require cornernote/gii-modeldoc-generator:dev-master	// development version

Add the vendor folder to the aliases in your yii configuration:

Manual Installation

Download the latest release or development version and move the gii-modeldoc-generator folder into your protected/modules folder.

Configuration

Add the path to gii-modeldoc-generator to the generatorPaths in your gii configuration:

return array(
	'modules' => array(
		'gii' => array(
			'class'=>'system.gii.GiiModule',
			'generatorPaths' => array(
				// use this if you installed with composer
				'/path/to/vendor/cornernote/gii-modeldoc-generator/gii',

				// OR, use this if you downloaded into your extensions folder
				//'ext.gii-modeldoc-generator.gii',
			),
		),
	),
);

Usage

Ensure you have --- BEGIN ModelDoc --- and --- END ModelDoc --- in each of your models, for example:

/**
 * Your class description that will not be altered by ModelDoc
 *
 * --- BEGIN ModelDoc ---
 *
 *  this section will be replaced by ModelDoc
 *
 * --- END ModelDoc ---
 */
class MyModel extends CActiveRecord { ... }

Visit index.php?r=gii, then choose ModelDoc from the menu.

Notes

This extension will not create any new model files. You should first create them or generate them with a model generator.

Resources

Support

Does this README need improvement? Go ahead and suggest a change.
Found a bug, or need help using this project? Check the open issues or create an issue.

cornernote / gii-modeldoc-generator

Maintainers

Details