Jens Segers on Jan 04 2012

# CodeIginter HMVC Modules

This extension for CodeIgniter enables the use of the Hierarchical Model View Controller(HMVC) pattern and makes your application modular. This allows easy distribution of independent components (MVC) in a single directory across other CodeIgniter applications. All modules are grouped in their own folder and can have their own controller, model, view, library, config, helper and language files.

I used to use the 'Modular Extensions - HMVC' by wiredesignz, but when the original author changed something I did not like, I took matters in own hands. I actually found an easier way to enable HMVC support unlike the original code. Since the introduction of CodeIgniter 2.0 there has been support for packages built right inside CodeIgniter. This extension utilizes this but adds the extra functionality you need for full HMVC support. Therefore it was not needed to change the main CodeIgniter core files, but only wrap them with package functions. This is a real advantage over the original code that did change a lot of core files.

## Installation

Download the file from github and pace them into their corresponding folders in the application directory.

Note: to use the HMVC functionality, make sure the Controller and Router you use extend their HMVC class.

Next, add the location of your modules directory to the main config.php file:

/*
|-------------------------------------
| Modules locations
|-------------------------------------
|
| These are the folders where your modules are located. You may define an
| absolute path to the location or a relative path starting from the root
| directory.
|
*/
$config['modules_locations'] = array(APPPATH . "modules/"); ## Functionallity This is the basic structure of a HMVC module: # /modules # /module # /controllers # /config # /helpers # /language # /libraries # /models From within a module you can load its own resources just like you always do. If on the other hand, you want to load resources from another module you can do this by adding the module's name like a directory structure: class Hello extends MY_Controller { public function index() { // load a model from the current module$this->load->model("local_model");

// load a model from another module
$this->load->model("other_module/model"); // HMVC example$this->load->controller("module/controller/method");
}
}

Because of the modified router, the module's controllers are accessible like a directory structure. Controllers may be loaded from the application/controllers sub-directories or the module/controllers sub-directories:

# /module/hello -> /module/controllers/hello.php (index method)
# /module/hello -> /module/controllers/hello/hello.php (index method)
# /module/hello -> /module/controllers/hello/(default_controller).php (hello)
# /module/hello -> /module/controllers/module.php (hello method)
# /module/hello -> /module/controllers/(default_controller).php (hello method)

If the requested module contains a routes.php config file it will automatically be added to the main routes.

## Hierarchical controllers

To load hierarchical controllers you use the $this->load->controller() method. This method works similar to loading views with CodeIgniter, this method accepts the following parameters: • URI: a URI string pointing to the requested controller (and method). This function uses the same locating technique as explained above. • Parameters: an array containing the arguments for the requested method. • Return : a boolean indicating whether the output should be returned or show on the screen (default). For example, this is our main controller where we pass the request to a sub-controller in the same module: class Specials extends MY_Controller { public function index() {$this->load->controller('blogs/random', array('specials'));
}

}

And the sub-controller contains the real method:

class Blogs extends MY_Controller {

public function random($type) { ... } } You can also capture the output generated by the sub-controller by using the third$return parameter

$this->load->controller('blogs/random', array('specials'), TRUE); More about HMVC: #### Comments ### Name user 7 years ago Thanks.It works great. ### Name user 7 years ago If I use a "function index()" and another, "_gerenate()" in my controller and I remember the function generate in index function, it does not work. ex: [code]public function index(){if(blabalbala) // some code here …else$this->_generate();}public function _generate(){ return $this->superstar_model->………;}[/code]so I reorganize differently. ### Name user 7 years ago It's me again :sWhen using$this->load->controller('xxx/yyy'), MY_Controller is called twices?i'm using this in MY_Controller: $this->load->library('profiler');$this->output->enable_profiler(TRUE); Console::log('MY_Controller Initialized @ '.time());and in my log i can see :log MY_Controller Initialized @ 1331883581

                        log                         MY_Controller Initialized @ 1331883581There is a solution to this?tks.

### Jens Segers 7 years ago

This is because both controllers extend MY_Controller. When another controller method is called it needs to create the object, so the constructor is called twice. I don't see any way around this at this moment.

### Jens Segers 7 years ago

I don't understand your question, could you clarify your problem a bit more?

### Name user 7 years ago

Ok, thank you for the information. I will charge the data another way. Anyway thank you very much, it works better than Wiredesignz !

### Jaume MK 7 years ago

Hi, i apreciate the simplicity of this third party modular/HMVC, as i'm just now getting familiar with CI.I was wondering, if its possible to load/run a module/controller (or module/model) from the main CI controllers folder.—application——controllers———home.php (run hello controller from here)——modules———hello————controllers—————hello.phpIs this possible?Thanks for ur code! it will help me a lot on my CI Apps

### Jaume MK 7 years ago

ok... forget that 'stupid' question... xDDD sorryjust get that thing working fine... misspelling some characters!!!thank u again!

No problem :)

### Vikrantsharma 7 years ago

Hi jenssegers, does this library work with any of the templates library available for CI? Please confirm.

### Jens Segers 7 years ago

There are no changes to the original CI code, so I would not see any problems with template libraries.

### Vikrantsharma 7 years ago

Thanks for answering. Actually the HMVC by wiredesignz does not work with most of the template libraries. This is the reason I asked this question. I will try yours and hope that it works.

### Jens Segers 7 years ago

Let me know if you run into any problems!

### Jaume MK 7 years ago

hi, it's me again!I've been doing some more tests on this HMVC...I've tried to put another 'modules' folder inside a module... like this:—application——controllers——modules———hello————controllers————modules—————bye——————controllers———————bye.phpI'm trying to access 'bye'... would be that possible?localhost/index.php/hello/bye does not work... :S