If you’re going to be developing a multi-language site, then when you’re setting up your CMS, from the beginning be sure to go for a CodeIgniter CMS like CI-CMS or Pyro CMS in order to minimize languages issues down the road. {The Zend framework, with its strong partial rendering, may seem like a better option in a pinch, but CodeIgniter trumps Zend in other crucial areas, so it’s worth sticking with.}

With CodeIgniter it makes great sense to build in modular separation (you can find the library here), though at first glace I’ll agree it looks like a tough implementation.

As you scan the library article, the lines to put most emphasis on will naturally deal with switching languages.

For example, you’ll find in the Notes section of the above library site:

<?php

anchor($this->lang->switch_uri('fr'),'Display current page in French');
$lang['about.gender'] = "Je suis un homme";

?>

Plug the lines below into your route.php and config.php files.

In config/route.php :

<?php

$route['^fr/(.+)$'] = "$1";

$route['^en/(.+)$'] = "$1";

// '/en' and '/fr' URIs -> use default controller

$route['^fr$'] = $route['default_controller'];

$route['^en$'] = $route['default_controller'];

?>

In config/config.php,

$config['base_url']  must correspond to your configuration. For example,

<?php

$config['index_page'] = "";

?>

Creating the language file in system/application/language/english/about_lang.php was already clear to you.

<?php

$lang['about.gender'] = "I'm a man";
$lang['about.gender'] = "Je suis un homme";

?>

The controller part at

system/application/controllers/about.php should also be clear to you.

In the index function

<?php

$this->load->helper('language');

$this->load->helper('url');

// load language file‚

$this->lang->load('about');

$this->load->view('about');

?>

Once you’re done with these, browse to the welcome module on your local machine at http://localhost/ci/fr/welcome/test.
You should find the language lines show up as expected.

Be sure to hit the CodeIgniter resource site for some really useful, ready made down loadable translation files in zip format. This’ll save you heaps of time and work. Once you’ve extracted these zip archives, you’ll find files named as in the about_lang.php as above.

Next, while looking into partial rendering, we come across this site, which brings us more clarity.

<?php

$this->view->layout = 'master_layout_file'; // or leave this empty to render partials only

//Add a partial file and (optional) $data‚

$header = $this->view->load('header','header_file',$data);

// subheader‚

$header->load('sub_header','sub_header_file',$data);

$header->set($data);

$this->view->render();

?>

Now let’s render the partials in our master template:

<?php $header->render();?>;

And that’s about it. Pretty simple, right?

Before closing, just a brief note: PyroCMS is a multilingual CodeIgniter CMS with built-in language configuration options you can tailor to your site. You can find language settings inside the admin panel, and while the implementation will be similar to the approach we’ve outlined above it may not be an exact match.

Well, that’s it!  Thanks for reading, and I hope this helps.  If you have any questions about this specific tutorial or any other issues re: web development with CodeIgniter, Zend, or whatever else, drop us a line any time from our contact page!

Prakash R. Mohanty

Senior Software Engineer
Sourcebits Technologies

Setup

Install and do some basic configuration (URL, database settings) of Code Igniter. If you don’t know how to do this, read here. Autoload the database library and url helper as we will be using them.

The user will be able to post new items and delete current items and the app itself will be made up of:

• One Controller – todo.php
• One Model – todo_model.php
• One View – todo_index.php

PHP4 Compatibility

Because Code Igniter supports both PHP4 and PHP5, you are forced to use PHP4 style OOP. Your constructor must be the same name as the class, and it needs to contain parent::Controller(); or parent::Model();
The naming conventions for controllers and models are very strict. The name of both class and constructor must be the same as the file name, but capitalized. In our case of our controller, the file name is todo.php and the name of the class and constructor is called Todo.

Model

The model in Code Igniter is a place where you write your application’s SQL queries (It doesn’t map your schema like in Django/RoR). In our application we specify 3 methods, which can then be called upon in the controller. You will notice we are using the Code Igniter database class but not Code Igniter’s full ORM. This is just personal preference. In get_all_todo_items() we call $q->result_array() . Think of it as an equivalent to mysql_fetch_array().

class Todo_model extends Model {

    function Todo_model()

    {

        parent::Model();

    }

	function new_todo($content)

	{
		$date = date('l jS \of F Y h:i:s A');

		$q = $this->db->query("INSERT INTO items (date,content) VALUES ('$date','$content')");

	}

	function get_all_todo_items()
	{
		$q = $this->db->query("SELECT id,date,content FROM items");
		return $q->result_array();
	}

	function delete_todo_item($id)
	{
		$q = $this->db->query("DELETE FROM items WHERE id = '$id'");
	}

}

Controller

/system/application/controllers/todo.php

You can also see in the Controller that we are loading the form helper and todo_model model. Notice there are no file extensions being used. In Code Igniter URLs are structured like: www.foo.com/ci/index.php/controller/method/. If no method is specified then Code Igniter will automatically run the index() method.

index_page()
We assign the results of get_all_todo_items() to $info['item'] . We then pass the $info array (which contains all of our todo items) to our view which we’ll create soon.
add_item()
Rather than using $_POST['content'] to access a property, you should use $this->input->post(‘content’). This utilises Code Igniter’s input class which automatically filters out SQL injections and XSS attacks (line 266 /application/config/config.php)
We then pass the result from that to our new_todo() method in our model and redirect the user back to the index page.
delete_item()
We can use the segment() method in the uri class to grab bits of information from the URL. Because our URI will be /todo/delete_item/id/, by grabbing the 3rd segment we get the id. We can then feed that do our delete_todo_item() method we defined in the model and redirect the user to the main page.

class Todo extends Controller {

	function Todo()
	{
		parent::Controller();
                $this->load->helper('url');
		$this->load->helper('form');
		$this->load->model('todo_model');
	}

	function index()
	{
		$this->index_page();
	}

	function index_page()
	{
		$info['item'] = $this->todo_model->get_all_todo_items();
		$this->load->view('todo_index.php', $info);
	}

	function add_item()
	{
		$content = $this->input->post('content');
		$this->todo_model->new_todo($content);

		redirect('');
	}

	function delete_item()
	{
		$this->todo_model->delete_todo_item($this->uri->segment(3));

		redirect('');
	}
}

Finally we need to write our view.

/system/application/views/todo_index.php

On line 5 you can see the form_open() function being used. This creates our opening form tag. The action attribute is specified by the parameter that we passed. Code Igniter automatically prepends your site URL to this parameter it ends up as action=”http://path_to_site.com/URI_passed”. This is useful because if we move the site to another domain name, the form will continue to post to the correct URL. Between lines 12 and 17 we are iterating through the todo items posted.

<h1>Todo List</h1>

<hr />

<?php echo form_open('todo/add_item'); ?>

	<textarea cols="40" rows="10" name="content"></textarea>
	<input type="submit" value="Add new item" />
</form>

<ul>
<?php
for($i = 0; $i < sizeof($item); ++$i)
{
    echo '<li>' . $item[$i]['content'] . ' - <i>' . $item[$i]['date'] . '</i> - <a href="' . site_url() . '/todo/delete_item/' . $item[$i]['id'] . '">Delete</a></li>';
}
?>
</ul>

<hr />
<p>Created by <a href="http://www.query7.com">Query7</a></p>

Feel free to post any questions or comments you have.

Code Igniter is a PHP web framework which assists in creating complex websites. Unlike other web frameworks, Code Igniter doesn’t force you to use all of it’s components. You select and load them as you require. The only feature you have to use is the URL structuring (/controller/method/) which is very helpful anyway.

Code Igniter follows the Model, View, Controller (MVC) principle. All of your database queries are stored in models, HTML/XML output in Views and the logic code in Controllers. You aren’t forced to do this, however it does keep your code organized and reusable.

Helpers and Libraries

Like most frameworks, Code Igniter comes with many classes that help assist development. They are split into Libraries (AKA Classes) and Helpers. Libraries contain code that you could use on every page of your application – Database ORM, Image Manipulation, Pagination and Benchmarking. Helpers are things like Relative URLs, Forms and Email.

Using helpers and libraries is very easy. If you want it included throughout the site see below (autoloads). If you want it included for every method in a Controller, then you can add it to that Controller’s constructor. If you just want it included in one method, add the code inside the method.

$this->load->helper('helper_name');
$this->load->library('library_name');

Installation

Installing Code Igniter is alot easier than installing other PHP web frameworks. There is no need for command line access, nor the need to write your database schema in XML. You only need to edit a few configuration files.

Download and Install the latest version off the Code Igniter download page. Extract it and upload it to your web server. You may notice the directory /user_guide/ . This only contains documentation so it can be deleted safely. Up to date documentation can always be found at www.codeigniter.com/user_guide/.

Now that Code Igniter has been ‘installed’ we need to configure our settings. Open..

/system/application/config/config.php

On line 14 we need to set the path to our website. Make sure it has a trailing slash.

$config['base_url']	= "http://www.website.com/path/to/codeigniter/";

I also put global XSS filtering on. By default it is not active. Replace line 267 with..

$config['global_xss_filtering'] = TRUE;

If your application uses a database, now is a good time to set it up. Open..

/system/application/config/database.php

$db['default']['hostname'] = "localhost"; //usually localhost
$db['default']['username'] = "usernamet";  //database username
$db['default']['password'] = "password";  //password to user set above
$db['default']['database'] = "database";  //database name
$db['default']['dbdriver'] = "mysql";  //database driver - mysql/postgre/sqlite etc..
$db['default']['dbprefix'] = "";
$db['default']['pconnect'] = FALSE;
$db['default']['db_debug'] = TRUE;
$db['default']['cache_on'] = FALSE;
$db['default']['cachedir'] = "";
$db['default']['char_set'] = "utf8";
$db['default']['dbcollat'] = "utf8_general_ci";

When you call the database class, Code Igniter will connect to the database with the information you set in $db['default'] array.

$this->load->database();

You can then interact with the database through

$this->db->method();

If your application uses more than one database, you can set another array in the same database.php file but call it a seperate name. eg $db['remote'] (copy and paste the $db['default'] array and change where necessary). You can then connect that database with..

$remote_db = $this->load->database('remote', TRUE);

And execute database methods through..

$remote_db->method();

I also recommend you set up autoloads..

/system/application/config/autoload.php

Here you can specify classes and helpers that will be available in every file throughout your project. This is useful because you won’t need to call them every time you make a new controller. I recommend autoloading the database class and the URL helper. You will find the URL helper very useful in your Views, being able to use relative URLs instead of hard coding full http://www.website.com/path/to/codeigniter/ URLs is very useful. You just need to add the name of the library/helper in the appropriate array..

$autoload['libraries'] = array('database');
$autoload['helper'] = array('url');

Thats it.. Feel free to ask any questions.
In the next couple of weeks I’ll be writing a tutorial showing how to get a fully featured authentication system up and running with Code Igniter.