Codeigniter - making my controllers more DRY

Question

In my codeigniter controller function I am using the following code to generate my view and insert all the necessary content:

        $left_column = $this->load->view('widgets/sub_navigation', $subnav_data, true);
        $left_column .= $this->load->view('widgets/search_box', '', true); //Set data to be loaded into columns
        $left_column_base = $this->load->view('widgets/assist_navigation', '', true);
        $center_column = 'this is center column';
        $right_column = $this->load->view('widgets/ask_us_a_question', '', true);
        $right_column .= $this->load->view('widgets/newsletter', '', true);
        $right_column .= $this->load->view('widgets/latest_news', '', true);

        $this->template->inject_partial('left_column', $left_column); //Inject data into the partial columns
        $this->template->inject_partial('left_column_base', $left_column_base);
        $this->template->inject_partial('center_column', $center_column);
        $this->template->inject_partial('right_column', $right_column);
        $this->template->build('template',$data);

I am using a three column layout and the code above dictates what is shown in each of the columns. It works in a very modular way allowing me to customize each page quickly.

Is there a way of simplifying the above code, using arrays maybe, to cut down on repetetive code, making things more DRY??

I've never heard the term "DRY" before can someone elaborate? — David Nguyen, Dec 01 '11 at 16:40
@DavidNguyen Are you serious? In that case, http://en.wikipedia.org/wiki/Don't_repeat_yourself — Damien Pirsy, Dec 01 '11 at 16:44
@DavidNguyen, it means Don't Repeat Yourself, a pattern where you avoid copypasta spaghetti. — Esailija, Dec 01 '11 at 16:44
Repeated (and then slightly modified) code is normally called spaghetti code. Or the [Big Ball Of Mud antipattern](http://www.laputan.org/mud/). — hakre, Dec 01 '11 at 16:57

Esailija · Answer 1 · 2011-12-01T16:41:19.793

You need to create base controllers that extend the CI_Controller. Then all your controllers extend a certain base controller you created, depending on what needs to be done in all cases that controller is called.

In application/core create a file called MY_controller.php (the prefix can be changed in config):

class MY_Controller extends CI_Controller {


    function __construct()
    {

        parent::__construct();


            /* Widgets are only prepared -- they will be fetched and rendered once layout->render is called.
               This saves the overhead of reading the files on requests where layout isn't rendered.
            */                  


        $this->layout->prepare_widget( "widgets/navigation", "navigation_widget" );
        $this->layout->prepare_widget( "widgets/footer", "footer_widget"  );
        $this->layout->prepare_widget( "widgets/twitter", "twitter_widget" );

    }


}


class Public_Controller extends MY_Controller {

    function __construct()
    {
        parent::__construct();
    }

}

class Admin_Controller extends MY_Controller {

    function __construct()
    {
        parent::__construct();

            if( !$this->user->has_permissions( PERMISSION_ADMIN ) )
            {
                redirect( base_url(), "location", 303 );    
                die();
            }
    }

}

class Member_Controller extends MY_Controller {

    function __construct()
    {
        parent::__construct();


            if( !$this->user->has_permissions( PERMISSION_REGISTERED ) )
            {
                redirect( base_url(), "location", 303 );
                die();
            }
    }

}

As you can see, all sub controllers have the widgets automatically because they extend either public, admin or member. A sub controller extending an admin controller has automatically the permissions checked so you don't need to do that ever again. You can apply this concept to your app.

A sub-controller: (placed in the normal application/controllers)

class Articles extends Member_controller {

    ...

}

Will have automatically ensured that the user is logged in, and the widgets are prepared without doing anything because the parent of parent class already prepared them. All you need to do in articles is to call $this->layout->render if the logic needs layout rendering at the end.

hakre · Accepted Answer · 2011-12-01T16:55:12.180

1

Codeigniter controllers are designed after the transaction script pattern, it's known that controller tend to get large and "not DRY" when you application grows.

To prevent such, you can re-implement the view to handle a two-step compound view pattern supporting layouts. Look for a layout view IIRC there are some on the codeigniter site.

edited Dec 01 '11 at 16:55

answered Dec 01 '11 at 16:32

hakre

193,403
52
435
836

score 0 · Answer 3 · answered Dec 07 '11 at 23:26

I wrote a blog post explaining my design philosophy on organizing CodeIgniter controllers to make them more DRY. I like to have the index function of my controller serve as a common entry/exit point to avoid repeating operations that are common to all controller methods.

http://caseyflynn.com/2011/10/26/codeigniter-php-framework-how-to-organize-controllers-to-achieve-dry-principles/

Codeigniter - making my controllers more DRY

3 Answers3