Widget plugin (intelligent view partials)

[eluser]wiredesignz[/eluser]
Widget PHP5 only version is available on page 2 of this thread

Add some intelligence to your view partials. Thanks to the Yii framework for this idea.

Code:

<?php if (!defined('BASEPATH')) exit('No direct script access allowed');
/**
* Widget Plugin
*
* Install this file as application/plugins/widget_pi.php
*
* @version:     0.1
* $copyright     Copyright (c) Wiredesignz 2009-03-24
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
class Widget
{
    function Widget() {
        $this->_assign_libraries();
    }
    
    function run($name) {        
        $args = func_get_args();
        
        require_once APPPATH.'widgets/'.$name.EXT;
        $name = ucfirst($name);
        
        $widget =& new $name();
        return call_user_func_array(array(&$widget, 'run'), array_slice($args, 1));    
    }
    
    function render($view, $data = array()) {
        extract($data);
        include APPPATH.'widgets/views/'.$view.EXT;
    }

    function load($object) {
        $this->$object =& load_class(ucfirst($object));
    }

    function _assign_libraries() {
        $ci =& get_instance();
        foreach (get_object_vars($ci) as $key => $object) {
            $this->$key =& $ci->$key;
        }
    }
}

Autoload the plugin, $autoload['plugin'] = array('widget');

Create your widgets in a new application/widgets directory, and add a views subdirectory.

Widgets have access to the CI core and can load libraries themselves.

In your view call the static "run" method on the widget class:

Code:

<?php widget::run('user_login', (bool) $this->user->is_guest); ?>

[eluser]wiredesignz[/eluser]
An example widget class, application/widgets/user_login.php

Code:

class User_login extends Widget
{
    function run($visible = FALSE) {
        
        if ($post = $this->input->post('loginform')) {
            if ($post['username'] == 'admin') {
                $query = $this->db->query("SELECT uid FROM user WHERE username='admin'");
                $result = $query->row();
                
                set_cookie('ci_user', $result->uid, 86500);
                redirect();
            }
        }
        
        if ($visible) $this->render('user_login');
    }
}

and its view, application/widgets/views/user_login.php

Code:

<div class="widget">
<div class="header">Login</div>
<div class="content">
&lt;form action="" method="post"&gt;
<div class="row">
<label for="loginform_username">Username</label><br/>
&lt;input name="loginform[username]" id="loginform_username" type="text" value="" /&gt;&lt;/div>
<div class="row">
<label for="loginform_password">Password</label><br/>
&lt;input name="loginform[password]" id="loginform_password" type="password" value="" /&gt;&lt;/div>
<div class="row">
&lt;input type="hidden" value="0" name="loginform[rememberme]" /&gt;&lt;input name="loginform[rememberme]" id="loginform_rememberme" value="1" type="checkbox" /><label for="loginform_rememberme">Remember me next time</label></div>
<div class="row">
&lt;input type="submit" value="Login" /&gt;&lt;/div>
&lt;/form&gt;
</div></div>

[eluser]Colin Williams[/eluser]
Looks nice and elegant. Good stuff.

[eluser]wiredesignz[/eluser]
Thanks.

I'm porting the Yii blog demo to CodeIgniter just to see how different the development process is between the two frameworks and use this widget plugin.

[eluser]xwero[/eluser]
Isn't this just another way of creating modules?

[eluser]wiredesignz[/eluser]
Modules were supposed to be self contained mini applications.

These Widgets allow you to create intelligent view partials.

See the difference?

[eluser]xwero[/eluser]
tomato, tomato. hey that doesn't work in writing. film, movie then

[eluser]wiredesignz[/eluser]
Thanks for the intelligent reply xwero.

[eluser]davidbehler[/eluser]
Thanks alot!
I was gonna do something similar for my new project, but I guess I'll be using this one instead!

[eluser]xwero[/eluser]
Sometimes i have to express myself

A change i would make is to create a widgets directory in the views directory if you really consider the widgets to be partials. Containing the views to the widgets directory gave me the module feel.

And where are the models of the widgets going to be located? Your widget example suggests the database library is loaded.