121 lines
5.1 KiB
Markdown
121 lines
5.1 KiB
Markdown
|
# Using Views
|
||
|
|
|
||
|
|
Views are files that contain the display information for your application. This is most commonly HTML, CSS and Javascript but can be anything you require such as XML or JSON for AJAX output. The purpose of views is to keep this information separate from your application logic for easy reusability and cleaner code.
|
||
|
|
|
||
|
|
While this is true, views themselves can contain code used for displaying the data you pass into them. For example, looping through an array of product information and display each one on a new table row. Views are still PHP files so you can use any code you normally would.
|
||
|
|
|
||
|
|
# Creating View Files
|
||
|
|
|
||
|
|
View files are stored in the `views` directory of the [filesystem](about.filesystem). You can also create sub-directories within the `views` directory to organize your files. All of the following examples are reasonable view files:
|
||
|
|
|
||
|
|
APPPATH/views/home.php
|
||
|
|
APPPATH/views/pages/about.php
|
||
|
|
APPPATH/views/products/details.php
|
||
|
|
MODPATH/error/views/errors/404.php
|
||
|
|
MODPATH/common/views/template.php
|
||
|
|
|
||
|
|
## Loading Views
|
||
|
|
|
||
|
|
[View] objects will typically be created inside a [Controller] using the [View::factory] method. Typically the view is then assigned as the [Request::$response] property or to another view.
|
||
|
|
|
||
|
|
public function action_about()
|
||
|
|
{
|
||
|
|
$this->request->response = View::factory('pages/about');
|
||
|
|
}
|
||
|
|
|
||
|
|
When a view is assigned as the [Request::$response], as in the example above, it will automatically be rendered when necessary. To get the rendered result of a view you can call the [View::render] method or just type cast it to a string. When a view is rendered, the view file is loaded and HTML is generated.
|
||
|
|
|
||
|
|
public function action_index()
|
||
|
|
{
|
||
|
|
$view = View::factory('pages/about');
|
||
|
|
|
||
|
|
// Render the view
|
||
|
|
$about_page = $view->render();
|
||
|
|
|
||
|
|
// Or just type cast it to a string
|
||
|
|
$about_page = (string) $view;
|
||
|
|
|
||
|
|
$this->request->response = $about_page;
|
||
|
|
}
|
||
|
|
|
||
|
|
## Variables in Views
|
||
|
|
|
||
|
|
Once view has been loaded, variables can be assigned to it using the [View::set] and [View::bind] methods.
|
||
|
|
|
||
|
|
public function action_roadtrip()
|
||
|
|
{
|
||
|
|
$view = View::factory('user/roadtrip')
|
||
|
|
->set('places', array('Rome', 'Paris', 'London', 'New York', 'Tokyo'));
|
||
|
|
->bind('user', $this->user);
|
||
|
|
|
||
|
|
// The view will have $places and $user variables
|
||
|
|
$this->request->response = $view;
|
||
|
|
}
|
||
|
|
|
||
|
|
[!!] The only difference between `set()` and `bind()` is that `bind()` assigns the variable by reference. If you `bind()` a variable before it has been defined, the variable will be created as `NULL`.
|
||
|
|
|
||
|
|
### Global Variables
|
||
|
|
|
||
|
|
An application may several view files that need access to the same variables. For example, to display a page title in both the header of your template and in the body of the page content. You can create variables that are accessible in any view using the [View::set_global] and [View::bind_global] methods.
|
||
|
|
|
||
|
|
// Assign $page_title to all views
|
||
|
|
View::bind_global('page_title', $page_title);
|
||
|
|
|
||
|
|
If the application has three views that are rendered for the home page: `template`, `template/sidebar`, and `pages/home`. First, an abstract controller to create the template will be created:
|
||
|
|
|
||
|
|
abstract class Controller_Website extends Controller_Template {
|
||
|
|
|
||
|
|
public $page_title;
|
||
|
|
|
||
|
|
public function before()
|
||
|
|
{
|
||
|
|
parent::before();
|
||
|
|
|
||
|
|
// Make $page_title available to all views
|
||
|
|
View::bind_global('page_title', $this->page_title);
|
||
|
|
|
||
|
|
// Load $sidebar into the template as a view
|
||
|
|
$this->template->sidebar = View::factory('template/sidebar');
|
||
|
|
}
|
||
|
|
|
||
|
|
}
|
||
|
|
|
||
|
|
Next, the home controller will extend `Controller_Website`:
|
||
|
|
|
||
|
|
class Controller_Home extends Controller_Website {
|
||
|
|
|
||
|
|
public function action_index()
|
||
|
|
{
|
||
|
|
$this->page_title = 'Home';
|
||
|
|
|
||
|
|
$this->template->content = View::factory('pages/home');
|
||
|
|
}
|
||
|
|
|
||
|
|
}
|
||
|
|
|
||
|
|
## Views Within Views
|
||
|
|
|
||
|
|
If you want to include another view within a view, there are two choices. By calling [View::factory] you can sandbox the included view. This means that you will have to provide all of the variables to the view using [View::set] or [View::bind]:
|
||
|
|
|
||
|
|
// Only the $user variable will be available in "views/user/login.php"
|
||
|
|
<?php echo View::factory('user/login')->bind('user', $user) ?>
|
||
|
|
|
||
|
|
The other option is to include the view directly, which makes all of the current variables available to the included view:
|
||
|
|
|
||
|
|
// Any variable defined in this view will be included in "views/message.php"
|
||
|
|
<?php include Kohana::find_file('views', 'user/login') ?>
|
||
|
|
|
||
|
|
Of course, you can also load an entire [Request] within a view:
|
||
|
|
|
||
|
|
<?php echo Request::factory('user/login')->execute() ?>
|
||
|
|
|
||
|
|
This is an example of [HMVC](about.mvc), which makes it possible to create and read calls to other URLs within your application.
|
||
|
|
|
||
|
|
# Upgrading From v2.x
|
||
|
|
|
||
|
|
Unlike version 2.x of Kohana, the view is not loaded within the context of
|
||
|
|
the [Controller], so you will not be able to access `$this` as the controller
|
||
|
|
that loaded the view. Passing the controller to the view must be done explictly:
|
||
|
|
|
||
|
|
$view->bind('controller', $this);
|