Understanding the view rendering flow

  1. Introduction
  2. The common questions and causes of confusion we will address:
  3. Diving in the source code
  4. Time for answers

Introduction

There is a lot of confusion surrounding what is happening behind the scenes when you render a view.

If we take a look at the blog demo we have 3 major parts of our view rendering. They are:

1) The layouts/column1 and column2 (column1.php and column2.php):

<?php $this->beginContent('/layouts/main'); ?>
<div class="container">
	<div id="content">
		<?php echo $content; ?>
	</div><!-- content -->
</div>
<?php $this->endContent(); ?>

2) We have layouts/main

<!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 name="language" content="en" />

	<!-- blueprint CSS framework -->
	<link rel="stylesheet" type="text/css" href="<?php echo Yii::app()->request->baseUrl; ?>/css/screen.css" media="screen, projection" />
	
       <!-- some more headers... -->
	<title><?php echo CHtml::encode($this->pageTitle); ?></title>
</head>

<body>

<!-- ... -->

	<?php $this->widget('zii.widgets.CBreadcrumbs', array(
		'links'=>$this->breadcrumbs,
	)); ?><!-- breadcrumbs -->

	<?php echo $content; ?>

</body>
</html>

3) and the view that we render, for example site/contact

<?php
$this->pageTitle=Yii::app()->name . ' - Contact Us';
$this->breadcrumbs=array(
	'Contact',
);
?>

<h1>Contact Us</h1>
<!-- ... -->

The call to the view rendering in the contact looks like the following:

/**
	 * Displays the contact page
	 */
	public function actionContact()
	{
		$model=new ContactForm;
		//some form code was here...
		$this->render('contact',array('model'=>$model));
	}

The common questions and causes of confusion we will address:

1) Why, if I pass contact.php some $test variable like $this->render('contact',array('model'=>$model,'test' => 123)); and I echo it in the layout with echo $test, do I get error 500 undefind variable error?

2) I didn't pass any $content variable so what is

<?php echo $content; ?>

doing inside the beginContent tags of column1.php ?

3) What is $content in layouts/main.php?

<?php echo $content; ?>

I didn't set this variable...

4) Why do both column1.php and main.php echo $content?

5) Why does setting the title inside contact.php change the value of $this->title in main.php?

<title><?php echo CHtml::encode($this->pageTitle); ?></title>
/* in contact.php $this->pageTitle=Yii::app()->name . ' - Contact Us'; */
And the main confusion:

6) What is called before what? What the heck is going on there? ;-)

Diving in the source code

You have two options:
1) You can accept the rules and follow them without understanding
2) You can understand and follow the rules...

If you choose number 1, tutorial is over for you ;-) But if you really want to learn and understand, let's dive together...

Every good IDE has the ability to go directly to the function by pressing ctrl and the function name...

So lets go to SiteController.php, to the actionContact and press the render word at this line:

$this->render('contact',array('model'=>$model));

After pressing you will find yourself inside yii/web/CController.php on line 775

public function render($view,$data=null,$return=false)
	{
		if($this->beforeRender($view))
		{
			$output=$this->renderPartial($view,$data,true);
			if(($layoutFile=$this->getLayoutFile($this->layout))!==false)
				$output=$this->renderFile($layoutFile,array('content'=>$output),true);

			$this->afterRender($view,$output);

			$output=$this->processOutput($output);

			if($return)
				return $output;
			else
				echo $output;
		}
	}

The rendering is starting with a call to beforeRender, This is a preprocessing, if we are talking about the blog demo, no preprocessing there, so it just returns true...

protected function beforeRender($view)
	{
		return true;
	}

After we got true, we can continue ...

We have,

$output=$this->renderPartial($view,$data,true);

So our 'contact' view is rendered partially, with third parameter as true, this means that the result is not echoed to the page, it is captured and passed to the $output variable...

At this stage the contact page is rendered, all the $data it got (the variable array) is passed to the view was processed

After this, if a layout is defined

if(($layoutFile=$this->getLayoutFile($this->layout))!==false)				$output=$this->renderFile($layoutFile,array('content'=>$output),true);

We pass the $output we captured from the contact.php file, and pass it as $content to our layout file column1.php

Also this time the third parameter is true, meaning we done echo the output, we capture it and pass to $output variable (at this point the view output is overwritten, we don't need it any more cause we passed it to the view and it processed).

After this the afterRender called, and the processOutput, it's role is to insert all the javascript css etc. we registered as client scripts etc.

Time for answers

After we followed all the life cycle of the render method, we can answer to all the questions...

1) why if I pass to the contact some $test variable like $this->render('contact',array('model'=>$model,'test' => 123)); And I echo it in the layout with echo $test, I get error 500 undefind variable error?

Answer: Because the parameters we pass to the $this->render method, are processed in the view file , in this example contact.php, and then we pass to the layout the generated view, and the variable $test is out of the scope for hte layout. What to do if you need it? you can use the Yii registry(params), or you can define some class field, or consider creating widget ... (depends on the task)

2) I dont passed any $content variable so what is

<?php echo $content; ?>

Inside the beginContent tags inside column1.php ?

Answer: the captured view is passed to the layout as content parameter

3) Why the layouts/main.php has

<?php echo $content; ?>

Don't passed such variable...

Answer:

<?php
$this->beginContent('//layouts/main');
//...
$this->endContent(); 

All what between beginContent and endContent, is captured and passed to the layouts/main as content variable...

4) Why both column1.php and main.php echo the $content ?

Answer: If you understood answers to 1-3, you know the answer for this one... they are not the same, and don't have the same value

5) Why, if I make a change to the title inside contact.php, does it changes the value of $this->title in main.php?

<title><?php echo CHtml::encode($this->pageTitle); ?></title>
/* in contact.php $this->pageTitle=Yii::app()->name . ' - Contact Us'; */

Answer:

As we saw, the contact.php is rendered before the layout, so every field (aka class parameters), you change from the view file (contact.php) will effect the layout because it's rendered afterwards.

And the main confusion:

6) What is called before what? What the heck is going on there ? ;-)

contact.php (passed as content)-> column1.php (passed as content)-> main.php 6c07cda81e332dba19bd59a812abc121.png That's it, you are now pro at layouts ;-)
55 1
55 followers
Viewed: 205 786 times
Version: 1.1
Category: FAQs
Written by: dckurushin
Last updated by: Jorgee
Created on: Oct 7, 2011
Last updated: 5 years ago
Update Article

Revisions

View all history

Related Articles