crisu83/yii-caviar

Next generation code generation for Yii.

0.15.0 2014-05-22 10:23 UTC

Requires

• php: >=5.4.0

Requires (Dev)

• codeception/codeception: ~1.8.5
• yiisoft/yii: >=1.1.14

BSD-3-Clause

• Christoffer Niska

• template
• code
• command
• generation
• scaffold
• yii

README

Code generation with logic-less templates for Yii.

Caviar vs Gii

You might be wondering why you should use Caviar instead of Gii, so let us take a look at how they differ from each other.

The main disadvantage with Gii is that it is troublesome to write templates for it. Have you ever looked at one of its templates? If you have you know that they are quite hard to read. Compare the following template in Gii to the corresponding template in Caviar.

Caviar uses plain text (.txt files) templates, which are compiled into php files to apply separation of concerns. This means that all logic must be contained in the generator and that only strings can be passed to the template. Instead of doing logical operations within the template we do them in the generator when we create the data for the template. You can take a look at the model generator for an example on this.

Convinced? Follow the instructions below to install Caviar.

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist crisu83/yii-caviar "*"

or add

"crisu83/yii-caviar": "*"

to the require section of your composer.json file.

Usage

Add the a command to your console application configuration:

return array(
  ...
  'commandMap' => array(
    'generate' => array(
      'class' => '\crisu83\yii_caviar\Command',
      'basePath' => '<path-to-project-root>',
    ),
    ...
  ),
);

When that is done you can use it to generate code:

yiic generate generator [context:]subject [options]

Where generator is the name of the generator, context is the name of your application (e.g. app) and subject is a name for the item that will be generated.

You can view the command help by running the following command:

yiic generate help

Or the help for a particular generator by appending -t (or --help) to your command:

yiic generate component --help

Disable namespaces

Caviar uses namespaces by default, mainly because it has a proven to be a good practice in large scale applications, but it also allows you to easily disable namespaces for all generators.

Disabling namespaces for all generators can easily be done by adding the following to your configuration:

'generate' => array(
  ...
  'defaultTemplate' => 'noNamespaces',
  'enableNamespaces' => false,
  'templates' => array(
    'noNamespaces' => '<path-to-caviar>/templates/no-namespaces',
  ),
)

Fancy UI

Caviar has a fancy UI, here are a few screenshots showing the UI.

• https://www.dropbox.com/s/x29drr6ldkku7ft/Screenshot%202014-03-20%2017.32.20.png
• https://www.dropbox.com/s/vrr0vj709xtxba4/Screenshot%202014-03-20%2017.36.31.png
• https://www.dropbox.com/s/0mm2x6g1ad7d5fz/Screenshot%202014-03-20%2017.39.26.png

Generators

The following generators are already supported:

• component
• config
• controller
• layout
• model
• view
• webapp

The following generators are planned to be included in the first release:

• action
• crud
• widget