phundament/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)

For a Yii 2 port of this project, please visit giiant., _(*3)

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

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
  • partial views
  • enum fields
• multi languages

Templates

FullModule

FullModel

default

Model Classes in two files BaseModel, Model, _(*5)

singlefile

Standard Model Class Model, _(*6)

FullCrud

slim

Bootstrap UI with relations, _(*7)

hybrid

Bootstrap UI with relations and grids, _(*8)

slim_editable

Screenshots:, _(*9)

, _(*10)

, _(*11)

legacy

Original gtc CRUDs, _(*12)

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:, _(*13)

composer.phar require phundament/gii-template-collection

or, _(*14)

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

Setup

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

   '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., _(*17)

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

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

3. For Debugging Information plz add the log under yours config console, _(*19)

   'components' => array(
       'log'      => array(
           'class'  => 'CLogRouter',
           'routes' => array(
               // file logging
               array(
                   'class'   => 'CFileLogRoute',
                   'logFile' => 'console.log',
                   'levels'  => 'error, warning, info, trace',
                   'enabled' => true,
               ),
           ),
       ),
   ),
   

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 Note: slim_editable require vitalets/x-editable-yii dev * open Gii * select FullCrud * enter model class * click preview * click generate, _(*20)

AuthItems

Controller actions and UI buttons follow these checkAccess rules:, _(*21)

• Controller.*
• Controller.View
• Controller.Delete
• ...

From 0.13.0 on the a Controller.SimpleUi item was added by default, which hides UI elements, when this item is assigned to the current user., _(*22)

Note: An admin (superuser) always sees the full UI., _(*23)

Template slim

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

Template slim editable

Requirements: - https://github.com/clevertech/yiibooster, - schmunk42/yii-relation, - x-editable-yii - php composer.phar require dbrisinajumi/x-editable-yii dev-german-translations, _(*25)

Template hybrid

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

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

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.:, _(*28)

$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., _(*29)

Example

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

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., _(*31)

• 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, _(*32)

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., _(*33)

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

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

• 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., _(*36)

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

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., _(*38)

Contact

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