Download the PHP package cornernote/gii-modeldoc-generator without Composer
On this page you can find all versions of the php package cornernote/gii-modeldoc-generator. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download cornernote/gii-modeldoc-generator
More information about cornernote/gii-modeldoc-generator
Files in cornernote/gii-modeldoc-generator
Package gii-modeldoc-generator
Short Description Gii ModelDoc Generator for Yii framework
License BSD-3-Clause
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package gii-modeldoc-generator
Gii ModelDoc Generator for Yii
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:
Install latest release OR 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:
Usage
Ensure you have --- BEGIN ModelDoc --- and --- END ModelDoc --- in each of your models, for example:
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.
License
BSD-3-Clause, Copyright © 2013-2014 Mr PHP
