Blame - user_guide/libraries/parser.html - code-igniter-v3-giggi

<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>

48

</tr>

49

</table>

50

<h1>Template Parser Class</h1>

62

63

<p>The Template Parser Class enables you to parse pseudo-variables contained within your view files. It can parse simple

64

variables or variable tag pairs. If you've never used a template engine, pseudo-variables look like this:</p>

<title><kbd>{blog_title}</kbd></title><br />

</head><br />

<br />

<h3><kbd>{blog_heading}</kbd></h3><br />

73

<br />

74

<kbd>{blog_entries}</kbd><br />

75

<h5><kbd>{title}</kbd></h5><br />

76

77

<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

83

PHP from your templates (view files).</p>

84

85

<p class="important"><strong>Note:</strong> CodeIgniter does <strong>not</strong> require you to use this class

86

since using pure PHP in your view pages lets them run a little faster. However, some developers prefer to use a template engine if

87

they work with designers who they feel would find some confusion working with PHP.</p>

88

89

<p><strong>Also Note:</strong> The Template Parser Class is <strong>not</strong> a

90

full-blown template parsing solution. We've kept it very lean on purpose in order to maintain maximum performance.</p>

91

92

93

<h2>Initializing the Class</h2>

94

95

<p>Like most other classes in CodeIgniter, the Parser class is initialized in your controller using the <dfn>$this->load->library</dfn> function:</p>

96

97

<code>$this->load->library('parser');</code>

98

<p>Once loaded, the Parser library object will be available using: <dfn>$this->parser</dfn></p>

99

100

101

<p>The following functions are available in this library:</p>

102

103

<h2>$this->parser->parse()</h2>

104

105

<p>This method accepts a template name and data array as input, and it generates a parsed version. Example:</p>

106

107

<code>$this->load->library('parser');<br />

108

<br />

109

$data = array(<br />

110

            'blog_title' => 'My Blog Title',<br />

111

            'blog_heading' => 'My Blog Heading'<br />

112

            );<br />

113

<br />

114

$this->parser->parse('blog_template', $data);</code>

115

116

<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),

117

and the second parameter contains an associative array of data to be replaced in the template. In the above example, the

118

template would contain two variables: {blog_title} and {blog_heading}</p>

119

120

<p>There is no need to "echo" or do something with the data returned by <dfn>$this->parser->parse()</dfn>. It is automatically

121

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

122

pass TRUE (boolean) to the third parameter:</p>

123

124

<code>$string = $this->parser->parse('blog_template', $data, TRUE);</code>

125

Derek Allard

a7b2e45

2010-01-14 14:35:04 +0000

[diff] [blame]

126

<h2>$this->parser->parse_string()</h2>

127

128

<p>This method works exactly like parse(), only accepts a string as the first parameter in place of a view file.</p>

129

Derek Allard

2067d1a

2008-11-13 22:59:24 +0000

[diff] [blame]

130

131

<h2>Variable Pairs</h2>

132

133

<p>The above example code allows simple variables to be replaced. What if you would like an entire block of variables to be

134

repeated, with each iteration containing new values? Consider the template example we showed at the top of the page:</p>

<title><kbd>{blog_title}</kbd></title><br />

</head><br />

<br />

<h3><kbd>{blog_heading}</kbd></h3><br />

143

<br />

144

<kbd>{blog_entries}</kbd><br />

145

<h5><kbd>{title}</kbd></h5><br />

146

147

<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>.

153

In a case like this, the entire chunk of data between these pairs would be repeated multiple times, corresponding

154

to the number of rows in a result.</p>

155

156

<p>Parsing variable pairs is done using the identical code shown above to parse single variables,

157

except, you will add a multi-dimensional array corresponding to your variable pair data.

158

Consider this example:</p>

159

160

161

<code>$this->load->library('parser');<br />

162

<br />

163

$data = array(<br />

164

              'blog_title'   => 'My Blog Title',<br />

165

              'blog_heading' => 'My Blog Heading',<br />

166

              'blog_entries' => array(<br />

167

                                      array('title' => 'Title 1', 'body' => 'Body 1'),<br />

168

                                      array('title' => 'Title 2', 'body' => 'Body 2'),<br />

169

                                      array('title' => 'Title 3', 'body' => 'Body 3'),<br />

170

                                      array('title' => 'Title 4', 'body' => 'Body 4'),<br />

171

                                      array('title' => 'Title 5', 'body' => 'Body 5')<br />

172

                                      )<br />

173

            );<br />

174

<br />

175

$this->parser->parse('blog_template', $data);</code>

176

177

<p>If your "pair" data is coming from a database result, which is already a multi-dimensional array, you can simply

178

use the database result_array() function:</p>

179

180

<code>

181

$query = $this->db->query("SELECT * FROM blog");<br />

182

<br />

183

$this->load->library('parser');<br />

184

<br />

185

$data = array(<br />

186

              'blog_title'   => 'My Blog Title',<br />

187

              'blog_heading' => 'My Blog Heading',<br />

188

              'blog_entries' => $query->result_array()<br />

189

            );<br />

190

<br />

191

$this->parser->parse('blog_template', $data);</code>

</div>

<p>

Previous Topic:  <a href="trackback.html">Trackback Class</a>

203

   ·  

204

<a href="#top">Top of Page</a>   ·  

205

<a href="../index.html">User Guide Home</a>   ·  

206

Next Topic:  <a href="typography.html">Typography</a>

207

</p>

Derek Jones

d6d70e3

2010-03-29 10:10:27 -0500

[diff] [blame^]

208

Derek Allard

2067d1a

2008-11-13 22:59:24 +0000

[diff] [blame]

209

</div>

210

211

</body>

admin

b0dd10f

2006-08-25 17:25:49 +0000

[diff] [blame]

212

</html>