GregSong / generator-phalcon

Yeoman generator for Phalcon php multi-module applications.

generator-phalcon

A generator for Yeoman. Let Yeoman generate a multi module Phalcon PHP Framework application.

Getting Started

Since this is a Yeoman generator you have to install him first:

$ npm install -g yo

Phalcon Generator

To install generator-phalcon from npm, run:

$ npm install -g generator-phalcon

Finally, initiate the generator:

$ yo phalcon

You will be asked some questions about your application. You can specify the main namespace where all generated classes will live in. This will also be used to generate the project name. You can specify the folder name this project lives in (if it differs from the project name). Finally you have a working multi-module application set up:

I welcome you to the Phalcon project generator.
                                                                                                   
I will create a new Phalcon multi module application
Please answer some questions first:
                                                                                                   
[?] How would you like to call the new Project? (Enter the global namespace of the project, eg. MyApplication)
[?] How would you like to name the main module? (Enter the namespace of the default module, eg. MyMainModule)
[?] Please enter the name of the folder this project lives in (defaults to the slugified project name).
                                                                                                   

Module Subgenerator

If you would like to add another module to your project, just issue the module subgenerator like this:

$ yo phalcon:module

This will kickstart the module generator which will include a new module in your project. This works for every project created by the generator-phalcon generator.

The subgenerator will ask you about the project namespace and the namespace of the new module:

I will create a new Phalcon module for your application.
                                                                                                   
Please answer these simple questions:
                                                                                                   
[?] What is the namespace of the project this module should belong to? (Enter the global namespace of the project, eg. MyApplication) 
[?] How would you like to name your module? (Enter the namespace of your new module, eg. MyNewModule)

Controller Subgenerator

If you would like to add another controller to your project, just issue the module subgenerator like this:

$ yo phalcon:controller

This will kickstart the controller generator which will include a new controller in one of your projects modules.

The subgenerator will ask you about the project namespace, the namespace of the new module and the controller name:

I will create a new Phalcon controller for your application.

Please answer these simple questions:

[?] What is the namespace of the project this controller should belong to? (Enter the global namespace of the project, eg. MyApplication)
[?] How is the namespace of the module your controller should belong to? (Enter the namespace of your new module, eg. MyNewModule)
[?] What is the name of your controller (Without "Controller" suffix)? (Enter the simple controller name, eg. Auth)

Build the project

By now the project can be build with Ant. The build directory contains some PHP specific configurations for PHP MessDetector, PHPDox and CodeSniffer.

About the generated project

As every Yeoman generator, this generator is opinionated about how you should manage your application, be it directory structure, class inheritance or every other detail of your application. As Phalcon is a very flexible framework feel free to adjust the project to your needs. The project generated with the generator-phalcon generator will have the following structure:

.
├── bower.json
├── build
│   ├── phpcs.xml
│   ├── phpdox.xml
│   └── phpmd.xml
├── build.xml
├── composer.json
├── package.json
├── private
│   ├── common
│   │   └── lib
│   │       └── application
│   │           ├── ApplicationModule.php
│   │           ├── Application.php
│   │           ├── controllers
│   │           │   ├── ApplicationApiController.php
│   │           │   └── ApplicationController.php
│   │           ├── models
│   │           │   └── ApplicationModel.php
│   │           ├── RoutedModule.php
│   │           └── router
│   │               └── ApplicationRouter.php
│   ├── config
│   │   ├── config.php
│   │   └── modules.php
│   └── modules
│       └── mainmodule
│           ├── config
│           │   └── config.php
│           ├── controllers
│           │   ├── api
│           │   │   └── IndexController.php
│           │   ├── ModuleApiController.php
│           │   └── ModuleController.php
│           ├── lib
│           ├── models
│           │   └── ModuleModel.php
│           ├── Module.php
│           └── ModuleRoutes.php
├── public
│   ├── assets
│   ├── common
│   ├── index.php
│   ├── src
│   │   └── app
│   │       ├── layouts
│   │       │   └── main.html
│   │       ├── modules
│   │       │   └── mainmodule
│   │       │       └── views
│   │       │           └── index
│   │       │               └── index.html
│   │       └── partials
│   │           └── index.html
│   └── styles
└── test
    ├── application
    │   ├── ApplicationTest.php
    │   └── phpunit.xml
    ├── helpers
    │   ├── TestHelper.php
    │   └── UnitTestCase.php
    ├── modules
    │   └── mainmodule
    │       ├── helpers
    │       │   ├── ModuleTestHelper.php
    │       │   └── ModuleUnitTestCase.php
    │       ├── IndexControllerTest.php
    │       ├── ModuleTest.php
    │       └── phpunit.xml
    └── phalcon
        ├── FunctionalTestCase.php
        ├── ModelTestCase.php
        └── UnitTestCase.php

Todo

• Documentation
• Subgenerators for models, routes
• Generators for client side scripts

Getting To Know Yeoman

Yeoman has a heart of gold. He's a person with feelings and opinions, but he's very easy to work with. If you think he's too opinionated, he can be easily convinced.

If you'd like to get to know Yeoman better and meet some of his friends, Grunt and Bower, check out the complete Getting Started Guide.

License

MIT License