diff options
Diffstat (limited to 'user_guide/libraries/parser.html')
| -rw-r--r-- | user_guide/libraries/parser.html | 414 |
1 files changed, 207 insertions, 207 deletions
diff --git a/user_guide/libraries/parser.html b/user_guide/libraries/parser.html index 7d6b2afa5..8151eb127 100644 --- a/user_guide/libraries/parser.html +++ b/user_guide/libraries/parser.html @@ -1,208 +1,208 @@ -<!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" />
-<title>Template Parser Class : CodeIgniter User Guide</title>
-
-<style type='text/css' media='all'>@import url('../userguide.css');</style>
-<link rel='stylesheet' type='text/css' media='all' href='../userguide.css' />
-
-<script type="text/javascript" src="../nav/nav.js"></script>
-<script type="text/javascript" src="../nav/prototype.lite.js"></script>
-<script type="text/javascript" src="../nav/moo.fx.js"></script>
-<script type="text/javascript" src="../nav/user_guide_menu.js"></script>
-
-<meta http-equiv='expires' content='-1' />
-<meta http-equiv= 'pragma' content='no-cache' />
-<meta name='robots' content='all' />
-<meta name='author' content='ExpressionEngine Dev Team' />
-<meta name='description' content='CodeIgniter User Guide' />
-
-</head>
-<body>
-
-<!-- START NAVIGATION -->
-<div id="nav"><div id="nav_inner"><script type="text/javascript">create_menu('../');</script></div></div>
-<div id="nav2"><a name="top"></a><a href="javascript:void(0);" onclick="myHeight.toggle();"><img src="../images/nav_toggle_darker.jpg" width="154" height="43" border="0" title="Toggle Table of Contents" alt="Toggle Table of Contents" /></a></div>
-<div id="masthead">
-<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
-<tr>
-<td><h1>CodeIgniter User Guide Version 1.7</h1></td>
-<td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td>
-</tr>
-</table>
-</div>
-<!-- END NAVIGATION -->
-
-
-<!-- START BREADCRUMB -->
-<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
-<tr>
-<td id="breadcrumb">
-<a href="http://codeigniter.com/">CodeIgniter Home</a> ›
-<a href="../index.html">User Guide Home</a> ›
-Template Parser Class
-</td>
-<td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="codeigniter.com/user_guide/" />Search User Guide <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" /> <input type="submit" class="submit" name="sa" value="Go" /></form></td>
-</tr>
-</table>
-<!-- END BREADCRUMB -->
-
-<br clear="all" />
-
-
-<!-- START CONTENT -->
-<div id="content">
-
-
-
-
-<h1>Template Parser Class</h1>
-
-<p>The Template Parser Class enables you to parse pseudo-variables contained within your view files. It can parse simple
-variables or variable tag pairs. If you've never used a template engine, pseudo-variables look like this:</p>
-
-<code><html><br />
-<head><br />
-<title><kbd>{blog_title}</kbd></title><br />
-</head><br />
-<body><br />
-<br />
-<h3><kbd>{blog_heading}</kbd></h3><br />
-<br />
-<kbd>{blog_entries}</kbd><br />
-<h5><kbd>{title}</kbd></h5><br />
-<p><kbd>{body}</kbd></p><br />
-<kbd>{/blog_entries}</kbd><br />
-
-</body><br />
-</html></code>
-
-<p>These variables are not actual PHP variables, but rather plain text representations that allow you to eliminate
-PHP from your templates (view files).</p>
-
-<p class="important"><strong>Note:</strong> CodeIgniter does <strong>not</strong> require you to use this class
-since using pure PHP in your view pages lets them run a little faster. However, some developers prefer to use a template engine if
-they work with designers who they feel would find some confusion working with PHP.</p>
-
-<p><strong>Also Note:</strong> The Template Parser Class is <strong>not</strong> a
-full-blown template parsing solution. We've kept it very lean on purpose in order to maintain maximum performance.</p>
-
-
-<h2>Initializing the Class</h2>
-
-<p>Like most other classes in CodeIgniter, the Parser class is initialized in your controller using the <dfn>$this->load->library</dfn> function:</p>
-
-<code>$this->load->library('parser');</code>
-<p>Once loaded, the Parser library object will be available using: <dfn>$this->parser</dfn></p>
-
-
-<p>The following functions are available in this library:</p>
-
-<h2>$this->parser->parse()</h2>
-
-<p>This method accepts a template name and data array as input, and it generates a parsed version. Example:</p>
-
-<code>$this->load->library('parser');<br />
-<br />
-$data = array(<br />
- 'blog_title' => 'My Blog Title',<br />
- 'blog_heading' => 'My Blog Heading'<br />
- );<br />
-<br />
-$this->parser->parse('blog_template', $data);</code>
-
-<p>The first parameter contains the name of the <a href="../general/views.html">view file</a> (in this example the file would be called blog_template.php),
-and the second parameter contains an associative array of data to be replaced in the template. In the above example, the
-template would contain two variables: {blog_title} and {blog_heading}</p>
-
-<p>There is no need to "echo" or do something with the data returned by <dfn>$this->parser->parse()</dfn>. It is automatically
-passed to the output class to be sent to the browser. However, if you do want the data returned instead of sent to the output class you can
-pass TRUE (boolean) to the third parameter:</p>
-
-<code>$string = $this->parser->parse('blog_template', $data, TRUE);</code>
-
-
-<h2>Variable Pairs</h2>
-
-<p>The above example code allows simple variables to be replaced. What if you would like an entire block of variables to be
-repeated, with each iteration containing new values? Consider the template example we showed at the top of the page:</p>
-
-<code><html><br />
-<head><br />
-<title><kbd>{blog_title}</kbd></title><br />
-</head><br />
-<body><br />
-<br />
-<h3><kbd>{blog_heading}</kbd></h3><br />
-<br />
-<kbd>{blog_entries}</kbd><br />
-<h5><kbd>{title}</kbd></h5><br />
-<p><kbd>{body}</kbd></p><br />
-<kbd>{/blog_entries}</kbd><br />
-
-</body><br />
-</html></code>
-
-<p>In the above code you'll notice a pair of variables: <kbd>{blog_entries}</kbd> data... <kbd>{/blog_entries}</kbd>.
-In a case like this, the entire chunk of data between these pairs would be repeated multiple times, corresponding
-to the number of rows in a result.</p>
-
-<p>Parsing variable pairs is done using the identical code shown above to parse single variables,
-except, you will add a multi-dimensional array corresponding to your variable pair data.
-Consider this example:</p>
-
-
-<code>$this->load->library('parser');<br />
-<br />
-$data = array(<br />
- 'blog_title' => 'My Blog Title',<br />
- 'blog_heading' => 'My Blog Heading',<br />
- 'blog_entries' => array(<br />
- array('title' => 'Title 1', 'body' => 'Body 1'),<br />
- array('title' => 'Title 2', 'body' => 'Body 2'),<br />
- array('title' => 'Title 3', 'body' => 'Body 3'),<br />
- array('title' => 'Title 4', 'body' => 'Body 4'),<br />
- array('title' => 'Title 5', 'body' => 'Body 5')<br />
- )<br />
- );<br />
-<br />
-$this->parser->parse('blog_template', $data);</code>
-
-<p>If your "pair" data is coming from a database result, which is already a multi-dimensional array, you can simply
-use the database result_array() function:</p>
-
-<code>
-$query = $this->db->query("SELECT * FROM blog");<br />
-<br />
-$this->load->library('parser');<br />
-<br />
-$data = array(<br />
- 'blog_title' => 'My Blog Title',<br />
- 'blog_heading' => 'My Blog Heading',<br />
- 'blog_entries' => $query->result_array()<br />
- );<br />
-<br />
-$this->parser->parse('blog_template', $data);</code>
-
-
-
-
-</div>
-<!-- END CONTENT -->
-
-
-<div id="footer">
-<p>
-Previous Topic: <a href="trackback.html">Trackback Class</a>
- ·
-<a href="#top">Top of Page</a> ·
-<a href="../index.html">User Guide Home</a> ·
-Next Topic: <a href="typography.html">Typography</a>
-</p>
-<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006-2008 · <a href="http://ellislab.com/">Ellislab, Inc.</a></p>
-</div>
-
-</body>
+<!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" /> +<title>Template Parser Class : CodeIgniter User Guide</title> + +<style type='text/css' media='all'>@import url('../userguide.css');</style> +<link rel='stylesheet' type='text/css' media='all' href='../userguide.css' /> + +<script type="text/javascript" src="../nav/nav.js"></script> +<script type="text/javascript" src="../nav/prototype.lite.js"></script> +<script type="text/javascript" src="../nav/moo.fx.js"></script> +<script type="text/javascript" src="../nav/user_guide_menu.js"></script> + +<meta http-equiv='expires' content='-1' /> +<meta http-equiv= 'pragma' content='no-cache' /> +<meta name='robots' content='all' /> +<meta name='author' content='ExpressionEngine Dev Team' /> +<meta name='description' content='CodeIgniter User Guide' /> + +</head> +<body> + +<!-- START NAVIGATION --> +<div id="nav"><div id="nav_inner"><script type="text/javascript">create_menu('../');</script></div></div> +<div id="nav2"><a name="top"></a><a href="javascript:void(0);" onclick="myHeight.toggle();"><img src="../images/nav_toggle_darker.jpg" width="154" height="43" border="0" title="Toggle Table of Contents" alt="Toggle Table of Contents" /></a></div> +<div id="masthead"> +<table cellpadding="0" cellspacing="0" border="0" style="width:100%"> +<tr> +<td><h1>CodeIgniter User Guide Version 1.7</h1></td> +<td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td> +</tr> +</table> +</div> +<!-- END NAVIGATION --> + + +<!-- START BREADCRUMB --> +<table cellpadding="0" cellspacing="0" border="0" style="width:100%"> +<tr> +<td id="breadcrumb"> +<a href="http://codeigniter.com/">CodeIgniter Home</a> › +<a href="../index.html">User Guide Home</a> › +Template Parser Class +</td> +<td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="codeigniter.com/user_guide/" />Search User Guide <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" /> <input type="submit" class="submit" name="sa" value="Go" /></form></td> +</tr> +</table> +<!-- END BREADCRUMB --> + +<br clear="all" /> + + +<!-- START CONTENT --> +<div id="content"> + + + + +<h1>Template Parser Class</h1> + +<p>The Template Parser Class enables you to parse pseudo-variables contained within your view files. It can parse simple +variables or variable tag pairs. If you've never used a template engine, pseudo-variables look like this:</p> + +<code><html><br /> +<head><br /> +<title><kbd>{blog_title}</kbd></title><br /> +</head><br /> +<body><br /> +<br /> +<h3><kbd>{blog_heading}</kbd></h3><br /> +<br /> +<kbd>{blog_entries}</kbd><br /> +<h5><kbd>{title}</kbd></h5><br /> +<p><kbd>{body}</kbd></p><br /> +<kbd>{/blog_entries}</kbd><br /> + +</body><br /> +</html></code> + +<p>These variables are not actual PHP variables, but rather plain text representations that allow you to eliminate +PHP from your templates (view files).</p> + +<p class="important"><strong>Note:</strong> CodeIgniter does <strong>not</strong> require you to use this class +since using pure PHP in your view pages lets them run a little faster. However, some developers prefer to use a template engine if +they work with designers who they feel would find some confusion working with PHP.</p> + +<p><strong>Also Note:</strong> The Template Parser Class is <strong>not</strong> a +full-blown template parsing solution. We've kept it very lean on purpose in order to maintain maximum performance.</p> + + +<h2>Initializing the Class</h2> + +<p>Like most other classes in CodeIgniter, the Parser class is initialized in your controller using the <dfn>$this->load->library</dfn> function:</p> + +<code>$this->load->library('parser');</code> +<p>Once loaded, the Parser library object will be available using: <dfn>$this->parser</dfn></p> + + +<p>The following functions are available in this library:</p> + +<h2>$this->parser->parse()</h2> + +<p>This method accepts a template name and data array as input, and it generates a parsed version. Example:</p> + +<code>$this->load->library('parser');<br /> +<br /> +$data = array(<br /> + 'blog_title' => 'My Blog Title',<br /> + 'blog_heading' => 'My Blog Heading'<br /> + );<br /> +<br /> +$this->parser->parse('blog_template', $data);</code> + +<p>The first parameter contains the name of the <a href="../general/views.html">view file</a> (in this example the file would be called blog_template.php), +and the second parameter contains an associative array of data to be replaced in the template. In the above example, the +template would contain two variables: {blog_title} and {blog_heading}</p> + +<p>There is no need to "echo" or do something with the data returned by <dfn>$this->parser->parse()</dfn>. It is automatically +passed to the output class to be sent to the browser. However, if you do want the data returned instead of sent to the output class you can +pass TRUE (boolean) to the third parameter:</p> + +<code>$string = $this->parser->parse('blog_template', $data, TRUE);</code> + + +<h2>Variable Pairs</h2> + +<p>The above example code allows simple variables to be replaced. What if you would like an entire block of variables to be +repeated, with each iteration containing new values? Consider the template example we showed at the top of the page:</p> + +<code><html><br /> +<head><br /> +<title><kbd>{blog_title}</kbd></title><br /> +</head><br /> +<body><br /> +<br /> +<h3><kbd>{blog_heading}</kbd></h3><br /> +<br /> +<kbd>{blog_entries}</kbd><br /> +<h5><kbd>{title}</kbd></h5><br /> +<p><kbd>{body}</kbd></p><br /> +<kbd>{/blog_entries}</kbd><br /> + +</body><br /> +</html></code> + +<p>In the above code you'll notice a pair of variables: <kbd>{blog_entries}</kbd> data... <kbd>{/blog_entries}</kbd>. +In a case like this, the entire chunk of data between these pairs would be repeated multiple times, corresponding +to the number of rows in a result.</p> + +<p>Parsing variable pairs is done using the identical code shown above to parse single variables, +except, you will add a multi-dimensional array corresponding to your variable pair data. +Consider this example:</p> + + +<code>$this->load->library('parser');<br /> +<br /> +$data = array(<br /> + 'blog_title' => 'My Blog Title',<br /> + 'blog_heading' => 'My Blog Heading',<br /> + 'blog_entries' => array(<br /> + array('title' => 'Title 1', 'body' => 'Body 1'),<br /> + array('title' => 'Title 2', 'body' => 'Body 2'),<br /> + array('title' => 'Title 3', 'body' => 'Body 3'),<br /> + array('title' => 'Title 4', 'body' => 'Body 4'),<br /> + array('title' => 'Title 5', 'body' => 'Body 5')<br /> + )<br /> + );<br /> +<br /> +$this->parser->parse('blog_template', $data);</code> + +<p>If your "pair" data is coming from a database result, which is already a multi-dimensional array, you can simply +use the database result_array() function:</p> + +<code> +$query = $this->db->query("SELECT * FROM blog");<br /> +<br /> +$this->load->library('parser');<br /> +<br /> +$data = array(<br /> + 'blog_title' => 'My Blog Title',<br /> + 'blog_heading' => 'My Blog Heading',<br /> + 'blog_entries' => $query->result_array()<br /> + );<br /> +<br /> +$this->parser->parse('blog_template', $data);</code> + + + + +</div> +<!-- END CONTENT --> + + +<div id="footer"> +<p> +Previous Topic: <a href="trackback.html">Trackback Class</a> + · +<a href="#top">Top of Page</a> · +<a href="../index.html">User Guide Home</a> · +Next Topic: <a href="typography.html">Typography</a> +</p> +<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006-2008 · <a href="http://ellislab.com/">Ellislab, Inc.</a></p> +</div> + +</body> </html>
\ No newline at end of file |