Kohana PHP 3.0 (KO3) Tutorial Part 3
Welcome to the third part in this series on how to develop with Kohana PHP V3 (KO3). If you haven’t read the first and/or second parts yet, I would click here and read them before going on. In this tutorial we will be going over how to create a template.
In the last tutorial, we went over views and in this one we are going to extend the Controller classes which will allow us to create a template. A template, you might ask, is nothing more than a view that is more or less your base (X)HTML code. This will allow to keep things “DRY” in the view world. Before we get to putting code into a file, lets create a new directory under “/application/views/” named “templates”. Now open up your favorite IDE and make a new file and put the following into it:
[php]
<!DOCTYPE html PUBLIC “-//W3C//DTD XHTML 1.0 Transitional//EN”
“http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd”>
<html xmlns=”http://www.w3.org/1999/xhtml” xml:lang=”en” lang=”en”>
<head>
<meta http-equiv=”Content-type” content=”text/html; charset=UTF-8″ />
<meta http-equiv=”Content-Language” content=”en-us” />
<title><?php echo $title;?></title>
<meta name=”keywords” content=”<?php echo $meta_keywords;?>” />
<meta name=”description” content=”<?php echo $meta_description;?>” />
<meta name=”copyright” content=”<?php echo $meta_copywrite;?>” />
<?php foreach($styles as $file => $type) { echo HTML::style($file, array(‘media’ => $type)), “n”; }?>
<?php foreach($scripts as $file) { echo HTML::script($file, NULL, TRUE), “n”; }?>
</head>
<body>
<div id=”container”>
<?php echo $header;?>
<?php echo $content;?>
<?php echo $footer;?>
</div>
</body>
</html>
[/php]
Save the above as “default.php” in your “/application/views/templates/” folder.
As you can see the above pretty much looks like a view we have done before, a bit more expanded. I will go over the “foreach” a little bit later. Unlike a view, this will most likely be used by all of your project. Since we will point to this file for our template, or shell, this will reduce the amount of code you have to put in each view, keeping thing separated, easier to maintain, or basically “DRY”.
Now that we have a template, our system isn’t going to do anything with it until well tell it to use it. So lets go back to our IDE and create a new file and put the following into it:
[php]
<?php
defined(‘SYSPATH’) or die(‘No direct script access.’);
class Controller_DefaultTemplate extends Controller_Template
{
public $template = ‘templates/default’;
/**
* Initialize properties before running the controller methods (actions),
* so they are available to our action.
*/
public function before()
{
// Run anything that need ot run before this.
parent::before();
if($this->auto_render)
{
// Initialize empty values
$this->template->title = ”;
$this->template->meta_keywords = ”;
$this->template->meta_description = ”;
$this->template->meta_copywrite = ”;
$this->template->header = ”;
$this->template->content = ”;
$this->template->footer = ”;
$this->template->styles = array();
$this->template->scripts = array();
}
}
/**
* Fill in default values for our properties before rendering the output.
*/
public function after()
{
if($this->auto_render)
{
// Define defaults
$styles = array(‘assets/css/reset.css’ => ‘screen’);
$scripts = array(‘http://ajax.googleapis.com/ajax/libs/jquery/1.3.2/jquery.min.js’);
// Add defaults to template variables.
$this->template->styles = array_reverse(array_merge($this->template->styles, $styles));
$this->template->scripts = array_reverse(array_merge($this->template->scripts, $scripts));
}
// Run anything that needs to run after this.
parent::after();
}
}
[/php]
And save this as “defaulttemplate.php” under your “/application/classes/controller/” folder.
The above code extends the “Controller_Template” class and does three main things, initialize some properties (variables) to be accessable by our methods (actions) and appends default values to them and then gets associates them to our template variables before we render the final output to the screen. This is where the foreach() loop in the template comes into play. The foreach() loop uses a static method for the helper class “HTML” to load CSS style sheets and load JS files. Both of these helper methods will iterate through an array and properly wrap it in the appropriate tag. They can take a path or a URL.
You might be wondering what a “Helper” is, so here is a quick definition from the Kohana PHP 2.x documents:
Helpers are simply “handy” functions that help you with development.
Helpers are similar to library methods, but there is a subtle difference. With a library, you have to create an instance of the library’s class to use its methods. Helpers are declared as static methods of a class, so there is no need to instantiate the class. You can think of them as “global functions”.
As with libraries, the helper classes are automatically loaded by the framework when they are used, so there is no need to load them yourself.
OK, back on course. You might have noticed there is a reference to “assets/css/reset.css”, so lets go ahead and get that in place. In your root create a folder named “assets” and in that folder create one named “css”. For the actual “reset.css” file, I went to Serene Destiny and copied the code from the article titled “Create The Perfect CSS Reset” into a file and saved it as “reset.css” in the “assets/css/” folder. You might want to also set up some other folders within “/assets/”, maybe “images”, “js” and “files”. Basically the assets folder should be used to store and organize static files and such.
At this point, our application still doesn’t know what to do what we have done, so we need to modify our controller. So open “/application/classes/controller/ko3.php”.
We want to change what class we are extending, so change the line:
[php]class Controller_Ko3 extends Controller[/php]
to:
[php]lass Controller_Ko3 extends Controller_DefaultTemplate[/php]
We also need to change up our “index” action (action_index() method) to look like the following:
[php]
public function action_index()
{
$ko3_inner = array();
$ko3 = array();
$this->template->title = ‘Kohana 3.0′;
View::set_global(‘x’, ‘This is a global variable’);
$ko3_inner['content'] = ‘We have more data’;
$ko3['content'] = ‘We have data’;
$ko3['ko3_inner'] = View::factory(‘blocks/ko3_inner’, $ko3_inner)
->render();
$this->template->content = View::factory(‘pages/ko3′, $ko3);
}
[/php]
Save it. Now you might noticed that we now have “$this->template->title = ‘Kohana 3.0′;”, this will assign a value to our templates “title” variable. The next thing you might notice is the absence of the last “render()” method. The “factory()” method actually will “auto render” it to our template’s “content” variable. Pretty simple, yes?
There is something we should probably do before loading up the page, so load up the “ko3.php” view file located in “application/views/pages/”. You might noticed that we have all the “shell” code in our view, so lets remove it. What you should only have in the view file is this:
[php]
<h1>This is my first view</h1>
<?php echo $content;?>
<?php echo $ko3_inner; ?>
<br/><?php echo $x;?>
[/php]
Now if you load it up, you should see that page has a title of “Kohana 3.0″ and the page should pretty much look the same as it did from the last tutorial. If you view the source thou, it would look much different. But you might be wondering about the other variables in the template and what to do with them. OK, let go back and edit our “index” action again. Make it look like:
[php]
public function action_index()
{
$ko3_inner = array();
$ko3 = array();
$this->template->title = ‘Kohana 3.0′;
$this->template->meta_keywords = ‘PHP, Kohana, KO3, Framework’;
$this->template->meta_description = ‘A test of of the KO3 framework’;
$this->template->styles = array(‘assets/css/red.css’ => ‘screen’);
$this->template->scripts = array(‘assets/js/jqtest.js’);
View::set_global(‘x’, ‘This is a global variable’);
$ko3_inner['content'] = ‘We have more data’;
$ko3['content'] = ‘We have data’;
$ko3['ko3_inner'] = View::factory(‘blocks/ko3_inner’, $ko3_inner)
->render();
$this->template->content = View::factory(‘pages/ko3′, $ko3);
}
[/php]
Pretty simple. You will notice I didn’t fill in the header or footer. I’m sure you know what to do there. Hint: Render a view to that variable =). Another thing you might notice is that I have put in “assets/css/red.css” and “assets/css/jqtest.js”. Lets make those two files starting with “/assets/css/red.css”:
[php]
h1
{
color: #FF0000;
}
[/php]
Next “/assets/js/jqtest.js”:
[php]
$(“document”).ready(function()
{
alert(‘Hello Kohana!’);
});
[/php]
Save them and refresh the site. You should see an alert pop up and the first line of text in red.
Today we have created a template file, extended a template controller and our controller use that template file. There is a lot of potential with what you could do with this already. So until next time when I will go over models, happy coding!
Sources used: Unofficial Kohana 3 Wiki, Kohana PHP 2.x Docs
December 31, 2009 at 10:10 am
January 2, 2010 at 2:03 am
January 7, 2010 at 11:33 am
January 7, 2010 at 11:37 am
January 19, 2010 at 1:59 am
January 19, 2010 at 1:59 am
January 19, 2010 at 9:08 am
January 22, 2010 at 9:25 am
January 29, 2010 at 9:27 am
February 1, 2010 at 1:24 pm
February 1, 2010 at 3:38 pm
February 2, 2010 at 8:44 am
February 2, 2010 at 2:05 pm
February 3, 2010 at 7:00 pm
February 4, 2010 at 8:42 am
April 3, 2010 at 6:32 am
April 5, 2010 at 8:14 am
April 21, 2010 at 5:40 am
May 2, 2010 at 1:03 am
May 3, 2010 at 9:35 am
May 12, 2010 at 11:47 am
May 12, 2010 at 12:02 pm
May 13, 2010 at 1:28 am
May 13, 2010 at 7:51 am
April 23, 2012 at 8:52 pm
May 13, 2010 at 10:49 am
May 13, 2010 at 2:48 pm
June 8, 2010 at 10:47 am
June 23, 2010 at 9:42 pm
August 2, 2010 at 9:44 am
August 2, 2010 at 11:46 am
August 17, 2010 at 10:06 pm
August 19, 2010 at 1:45 pm
September 23, 2010 at 11:26 am
November 29, 2010 at 6:07 am
November 29, 2010 at 6:14 am
January 6, 2011 at 7:08 pm
January 14, 2011 at 8:54 am
January 17, 2011 at 9:58 am
January 17, 2011 at 10:25 am
February 2, 2011 at 11:09 pm
March 28, 2011 at 12:44 am
April 18, 2011 at 3:47 pm
April 21, 2012 at 7:22 am
June 26, 2011 at 8:57 pm
July 4, 2011 at 4:58 am
July 28, 2011 at 11:22 am
October 18, 2011 at 3:11 am
December 8, 2011 at 6:13 am
March 12, 2012 at 10:49 am
April 21, 2012 at 9:42 pm
March 14, 2012 at 3:35 am