dbrisinajumi/gii-template-collection

Gii Template Collection, Model and CRUD templates with Boostrap UI

gii-template-collection

Fork on github, _(*1)

The gii-template-collection (gtc) contains templates for the Yii Framework Gii module., _(*2)

Features

• relation handling
• YiiBooster integration
• giic prove
• customize inputs with code-providers, detect input-type by model and column
  • date and time pickers
  • checkboxes
  • relation widgets
  • editable grid columns
  • enum fields
  • partial views
• multi languages

Templates

• FullModule
• FullModel
  • default (BaseModel, Model)
  • singlefile (Model)
• FullCrud
  • slim
  • hybrid
  • legacy (original gtc)

NOTE! Relation widgets moved to https://github.com/schmunk42/yii-relation, _(*3)

Requirements

• PHP 5.3 and short_open_tags = On

Notes

• repo uses git-flow naming conventions
• repo follows the guidelines of semantic versioning

Installation

Get it via composer:, _(*4)

composer.phar require phundament/gii-template-collection

or, _(*5)

Download latest release To use it, simply extract the content of the archive into your application extensions/ directory., _(*6)

Setup

1. Configure the templates in the generatorPaths section of the gii configuration inside your application configuration:, _(*7)

   'gii'=>array(
       'class'=>'system.gii.GiiModule',
       'password'=>'<your gii password>',
       'generatorPaths'=>array(
           'vendor.phundament.gii-template-collection',   
       ),
   ),
   

   After that, the new generators of gtc should be available in your Gii index page., _(*8)

2. The last step is to add some gtc components to your import path so they can be found by the application:, _(*9)

   // autoloading model and component classes
   'import'=>array(
       // relation widget and save behavior
       'vendor.phundament.gii-template-collection.components.*', 
   ),
   

Usage

Full Module

• open Gii
• select FullModule
• enter Module ID
• click preview
• click generate

Full Model

• open Gii
• select FullModel
• enter model class
• click preview
• click generate

Full CRUD

Note: Generated templates require clevertech/yiibooster >=1.1.1, _(*10)

• open Gii
• select FullCrud
• enter model class
• click preview
• click generate

Template slim

Requirements: https://github.com/clevertech/yiibooster, schmunk42/yii-relation, _(*11)

Template hybrid

An enhanced hybrid between the default/slim templates and the bootstrap crud generator., _(*12)

Requires x-editable-yii and echosen., _(*13)

Development

Code Providers

The FullCrudCode is able to access providers from a provider-queue to render fields, labels, etc. You can call a provider from your template with, eg.:, _(*14)

$this->provider()->generateColumn($this->modelClass, $column)

FullCrudCode will walk the provider queue until it finds a provider which has the requested method AND which returns not null. This is on of the major differences compared to a behavior., _(*15)

Example

Render a populated dropdown, if the model contains and optsColumnName() method., _(*16)

public function generateActiveField($model, $column)
{
    $func = "opts".str_replace("_","",$column->name);
    if (method_exists($model, $func)) {
        return "echo \$form->dropDownList(\$model,'{$column->name}',{$model}::{$func}());";
    }
}

Coding Standards

GTC is using <?=""?> Bobsled Coding Style., _(*17)

• Write PHP code to be generated wrapped in short-open-echo tags and double quotes

<?=
"<?php 
    ...code... 
?>"
?>

• Use bobsled only for generating PHP code (in the gtc templates), DO NOT use short open tags in outputted code (yet)
• Use brackets {} to insert variables for generated code
• Use a provider to generate fields, labels, relations and columns.
• Follow guidelines for-good schema design from the Yii Wiki
• Use a UNIQUE index over both of your foreign keys in your MANY_MANY tables

Examples

tbd, _(*18)

Known Problems and Limitations

• gtc does not support composite primary keys

Resources

Links

• Yii Framework Extension Page
• GitHub Project Page
• Phundament Package

History

This project has been originally created by thyseus back in 2010., _(*19)

To quote from the original project page:, _(*20)

Please enjoy this extension and let us collect as many Templates as possible for other people to enjoy. (haml, smarty, dwoo, twig, ...), _(*21)

• Project page up to version 0.6

In 2011 schmunk create the currently active fork of the project from revision 186 of the Google Code repository., _(*22)

While there has been much, much, much, … code added over the time. At the end of July 2013 gtc was completely refurbished., _(*23)

Contributors

• Alban Jubert alban.jubert@trinidev.fr
• Anne Datema
• Fredrik Wollsén fredrik@neam.se
• Herbert Maschke thyseus@gmail.com (original creator)
• Igor Santos
• Tobias Munk schmunk@usrbin.de
• Uldis Nelsons uldisnelsons@gmail.com
• leo@finalresort.org
• robregonm rodrigo.coelho@gmail.com
• sealtrip
• thyseus

Active maintainers are written in bold., _(*24)

Contact

Of course, any templates are appreciated and just leave a comment or mail: schmunk@usrbin.de, fredrik@neam.se or thyseus@gmail.com., _(*25)