1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Strict//EN">
<html>
<head>
<title>Template::View</title>
<link rel="stylesheet" type="text/css" href="../../css/blue.css" title="Clear Blue">
<link rel="alternate stylesheet" type="text/css" href="../../css/orange.css" title="Clear Orange">
<link rel="alternate stylesheet" type="text/css" href="../../css/green.css" title="Clear Green">
<link rel="alternate stylesheet" type="text/css" href="../../css/purple.css" title="Clear Purple">
<link rel="alternate stylesheet" type="text/css" href="../../css/grey.css" title="Clear Grey">
<link rel="alternate stylesheet" type="text/css" href="../../css/print.css" title="Print">
<!--[if IE 6]>
<link rel="stylesheet" type="text/css" href="../../css/ie6.css" />
<![endif]-->
<!--[if IE 7]>
<link rel="stylesheet" type="text/css" href="../../css/ie7.css" />
<![endif]-->
<link rel="stylesheet" type="text/css" href="../../css/print.css" media="print">
<script type="text/javascript" src="../../js/tt2.js"></script>
<meta http-equiv="Content-Type" content="text/html;charset=utf-8">
<meta name="author" content="Andy Wardley">
</head>
<body id="body">
<div id="layout">
<div id="header">
<a href="../../index.html" id="logo" alt="" title="Click for the Home Page"><span class="alt">TT2 Home Page</span></a>
<ul id="trail">
<li><a href="../../modules/index.html">Modules</a></li>
<li><a href="../../modules/Template/index.html">Template::*</a></li>
<li class="last"><a href="../../modules/Template/View.html">View.pm</a></li>
</ul>
<div class="controls">
<a href="#" class="menu show" onclick="widescreen_off(); return false" title="Show Menu">
<span class="about">Click to view the menu. It's very nice.</span>
</a>
<a href="#" class="menu hide" onclick="widescreen_on(); return false" title="Hide Menu">
<span class="about">Click to hide the menu and go all widescreen!</span>
</a>
<div class="pager">
<a href="../../modules/Template/VMethods.html" title="Template::VMethods" class="go back">Back<span class="about"><h4>Template::VMethods</h4>Virtual methods for variables</span></a>
<a href="../../modules/Template/index.html" title="Template::* Modules" class="go up">Up<span class="about"><h4>Template::* Modules</h4></span></a>
<span class="go next">Next<span class="about">I'm sorry Dave, I can't do that.</span></span>
</div>
</div>
<h1 class="headline">Template::View</h1>
<h2 class="subhead">customised view of a template processing context</h1>
</div>
<div id="page">
<div id="sidebar">
<a href="../../index.html" id="logo"></a>
<div id="menu">
<ul class="menu">
<li class="l0 first"><a href="../../manual/index.html">Manual</a></li>
<li class="l0"><a href="../../modules/index.html" class="warm">Modules</a></li>
<li class="l1"><a href="../../modules/Template.html">Template.pm</a></li>
<li class="l1"><a href="../../modules/Template/index.html" class="warm">Template::*</a></li>
<li class="l2"><a href="../../modules/Template/Base.html">Base.pm</a></li>
<li class="l2"><a href="../../modules/Template/Config.html">Config.pm</a></li>
<li class="l2"><a href="../../modules/Template/Constants.html">Constants.pm</a></li>
<li class="l2"><a href="../../modules/Template/Context.html">Context.pm</a></li>
<li class="l2"><a href="../../modules/Template/Directive.html">Directive.pm</a></li>
<li class="l2"><a href="../../modules/Template/Document.html">Document.pm</a></li>
<li class="l2"><a href="../../modules/Template/Exception.html">Exception.pm</a></li>
<li class="l2"><a href="../../modules/Template/Filters.html">Filters.pm</a></li>
<li class="l2"><a href="../../modules/Template/Grammar.html">Grammar.pm</a></li>
<li class="l2"><a href="../../modules/Template/Iterator.html">Iterator.pm</a></li>
<li class="l2"><a href="../../modules/Template/Namespace/index.html">Namespace::*</a></li>
<li class="l2"><a href="../../modules/Template/Parser.html">Parser.pm</a></li>
<li class="l2"><a href="../../modules/Template/Plugin.html">Plugin.pm</a></li>
<li class="l2"><a href="../../modules/Template/Plugin/index.html">Plugin::*</a></li>
<li class="l2"><a href="../../modules/Template/Plugins.html">Plugins.pm</a></li>
<li class="l2"><a href="../../modules/Template/Provider.html">Provider.pm</a></li>
<li class="l2"><a href="../../modules/Template/Service.html">Service.pm</a></li>
<li class="l2"><a href="../../modules/Template/Stash.html">Stash.pm</a></li>
<li class="l2"><a href="../../modules/Template/Stash/index.html">Stash::*</a></li>
<li class="l2"><a href="../../modules/Template/Test.html">Test.pm</a></li>
<li class="l2"><a href="../../modules/Template/VMethods.html">VMethods.pm</a></li>
<li class="l2"><a href="../../modules/Template/View.html" class="warm">View.pm</a></li>
<li class="l0"><a href="../../tools/index.html">Tools</a></li>
<li class="l0"><a href="../../tutorial/index.html">Tutorial</a></li>
<li class="l0 last"><a href="../../faq/index.html">FAQ</a></li>
</ul>
<div class="foot"></div>
</div>
</div>
<div id="content">
<div class="section">
<div class="head">
<h1 id="contents" onclick="switch_section(this)" title="Click title to show/hide section content.">Contents</h1>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<ul class="toc">
<li class=""><a href="#SYNOPSIS">SYNOPSIS</a></li>
<li class=""><a href="#DESCRIPTION">DESCRIPTION</a></li>
<li class=""><a href="#METHODS">METHODS</a></li>
<li class="sub"><a href="#method_new">new($context, \%config)</a></li>
<li class="sub"><a href="#method_print">print( $obj1, $obj2, ... \%config)</a></li>
<li class="sub"><a href="#method_view">view( $template, \%vars, \%config );</a></li>
<li class=""><a href="#AUTHOR">AUTHOR</a></li>
<li class=""><a href="#COPYRIGHT">COPYRIGHT</a></li>
<li class=""><a href="#SEE_ALSO">SEE ALSO</a></li>
</ul>
</div>
</div>
<div class="pod">
<div class="section">
<div class="head">
<h1 id="SYNOPSIS" onclick="switch_section(this)" title="Click title to show/hide section content.">SYNOPSIS</h1>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<pre># define a view
<span class="tt">[% VIEW view
# some standard args
prefix => 'my_',
suffix => '.tt2',
notfound => 'no_such_file'
...
# any other data
title => 'My View title'
other_item => 'Joe Random Data'
...
%]</span>
# add new data definitions, via 'my' self reference
<span class="tt">[% my.author = "$abw.name <$abw.email>" %]</span>
<span class="tt">[% my.copy = "&copy; Copyright 2000 $my.author" %]</span>
# define a local block
<span class="tt">[% BLOCK header %]</span>
This is the header block, title: <span class="tt">[% title or my.title %]</span>
<span class="tt">[% END %]</span>
<span class="tt">[% END %]</span>
# access data items for view
<span class="tt">[% view.title %]</span>
<span class="tt">[% view.other_item %]</span>
# access blocks directly ('include_naked' option, set by default)
<span class="tt">[% view.header %]</span>
<span class="tt">[% view.header(title => 'New Title') %]</span>
# non-local templates have prefix/suffix attached
<span class="tt">[% view.footer %]</span> # => <span class="tt">[% INCLUDE my_footer.tt2 %]</span>
# more verbose form of block access
<span class="tt">[% view.include( 'header', title => 'The Header Title' ) %]</span>
<span class="tt">[% view.include_header( title => 'The Header Title' ) %]</span>
# very short form of above ('include_naked' option, set by default)
<span class="tt">[% view.header( title => 'The Header Title' ) %]</span>
# non-local templates have prefix/suffix attached
<span class="tt">[% view.footer %]</span> # => <span class="tt">[% INCLUDE my_footer.tt2 %]</span>
# fallback on the 'notfound' template ('my_no_such_file.tt2')
# if template not found
<span class="tt">[% view.include('missing') %]</span>
<span class="tt">[% view.include_missing %]</span>
<span class="tt">[% view.missing %]</span>
# print() includes a template relevant to argument type
<span class="tt">[% view.print("some text") %]</span> # type=TEXT, template='text'
<span class="tt">[% BLOCK my_text.tt2 %]</span> # 'text' with prefix/suffix
Text: <span class="tt">[% item %]</span>
<span class="tt">[% END %]</span>
# now print() a hash ref, mapped to 'hash' template
<span class="tt">[% view.print(some_hash_ref) %]</span> # type=HASH, template='hash'
<span class="tt">[% BLOCK my_hash.tt2 %]</span> # 'hash' with prefix/suffix
hash keys: <span class="tt">[% item.keys.sort.join(', ')
[% END %]</span>
# now print() a list ref, mapped to 'list' template
<span class="tt">[% view.print(my_list_ref) %]</span> # type=ARRAY, template='list'
<span class="tt">[% BLOCK my_list.tt2 %]</span> # 'list' with prefix/suffix
list: <span class="tt">[% item.join(', ') %]</span>
<span class="tt">[% END %]</span>
# print() maps 'My::Object' to 'My_Object'
<span class="tt">[% view.print(myobj) %]</span>
<span class="tt">[% BLOCK my_My_Object.tt2 %]</span>
<span class="tt">[% item.this %]</span>, <span class="tt">[% item.that %]</span>
<span class="tt">[% END %]</span>
# update mapping table
<span class="tt">[% view.map.ARRAY = 'my_list_template' %]</span>
<span class="tt">[% view.map.TEXT = 'my_text_block' %]</span>
# change prefix, suffix, item name, etc.
<span class="tt">[% view.prefix = 'your_' %]</span>
<span class="tt">[% view.default = 'anyobj' %]</span>
...</pre>
</div>
</div>
<div class="section">
<div class="head">
<h1 id="DESCRIPTION" onclick="switch_section(this)" title="Click title to show/hide section content.">DESCRIPTION</h1>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
TODO
</p>
</div>
</div>
<div class="section">
<div class="head">
<h1 id="METHODS" onclick="switch_section(this)" title="Click title to show/hide section content.">METHODS</h1>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<div class="subsection">
<div class="head">
<h2 id="method_new" class="method" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">new($context, \%config)</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
Creates a new Template::View presenting a custom view of the specified
$context object.
</p>
<p>
A reference to a hash array of configuration options may be passed as the
second argument.
</p>
<ul>
<li><b id="item_prefix">prefix</b>
<p>
Prefix added to all template names.
</p>
<pre><span class="tt">[% USE view(prefix => 'my_') %]</span>
<span class="tt">[% view.view('foo', a => 20) %]</span> # => my_foo</pre>
</li>
<li><b id="item_suffix">suffix</b>
<p>
Suffix added to all template names.
</p>
<pre><span class="tt">[% USE view(suffix => '.tt2') %]</span>
<span class="tt">[% view.view('foo', a => 20) %]</span> # => foo.tt2</pre>
</li>
<li><b id="item_map">map</b>
<p>
Hash array mapping reference types to template names. The print() method
uses this to determine which template to use to present any particular
item. The TEXT, HASH and ARRAY items default to 'test', 'hash' and 'list'
appropriately.
</p>
<pre><span class="tt">[% USE view(map => { ARRAY => 'my_list',
HASH => 'your_hash',
My::Foo => 'my_foo', } ) %]</span>
<span class="tt">[% view.print(some_text) %]</span> # => text
<span class="tt">[% view.print(a_list) %]</span> # => my_list
<span class="tt">[% view.print(a_hash) %]</span> # => your_hash
<span class="tt">[% view.print(a_foo) %]</span> # => my_foo
<span class="tt">[% BLOCK text %]</span>
Text: <span class="tt">[% item %]</span>
<span class="tt">[% END %]</span>
<span class="tt">[% BLOCK my_list %]</span>
list: <span class="tt">[% item.join(', ') %]</span>
<span class="tt">[% END %]</span>
<span class="tt">[% BLOCK your_hash %]</span>
hash keys: <span class="tt">[% item.keys.sort.join(', ')
[% END %]</span>
<span class="tt">[% BLOCK my_foo %]</span>
Foo: <span class="tt">[% item.this %]</span>, <span class="tt">[% item.that %]</span>
<span class="tt">[% END %]</span></pre>
</li>
<li><b id="item_method">method</b>
<p>
Name of a method which objects passed to print() may provide for
presenting themselves to the view. If a specific map entry can't be found
for an object reference and it supports the method (default: 'present')
then the method will be called, passing the view as an argument. The
object can then make callbacks against the view to present itself.
</p>
<pre>package Foo;
sub present {
my ($self, $view) = @_;
return "a regular view of a Foo\n";
}
sub debug {
my ($self, $view) = @_;
return "a debug view of a Foo\n";
}</pre>
<p>
In a template:
</p>
<pre><span class="tt">[% USE view %]</span>
<span class="tt">[% view.print(my_foo_object) %]</span> # a regular view of a Foo
<span class="tt">[% USE view(method => 'debug') %]</span>
<span class="tt">[% view.print(my_foo_object) %]</span> # a debug view of a Foo</pre>
</li>
<li><b id="item_default">default</b>
<p>
Default template to use if no specific map entry is found for an item.
</p>
<pre><span class="tt">[% USE view(default => 'my_object') %]</span>
<span class="tt">[% view.print(objref) %]</span> # => my_object</pre>
<p>
If no map entry or default is provided then the view will attempt to
construct a template name from the object class, substituting any
sequence of non-word characters to single underscores, e.g.
</p>
<pre># 'fubar' is an object of class Foo::Bar
<span class="tt">[% view.print(fubar) %]</span> # => Foo_Bar</pre>
<p>
Any current prefix and suffix will be added to both the default template
name and any name constructed from the object class.
</p>
</li>
<li><b id="item_notfound">notfound</b>
<p>
Fallback template to use if any other isn't found.
</p>
</li>
<li><b id="item_item">item</b>
<p>
Name of the template variable to which the print() method assigns the
current item. Defaults to 'item'.
</p>
<pre><span class="tt">[% USE view %]</span>
<span class="tt">[% BLOCK list %]</span>
<span class="tt">[% item.join(', ') %]</span>
<span class="tt">[% END %]</span>
<span class="tt">[% view.print(a_list) %]</span>
<span class="tt">[% USE view(item => 'thing') %]</span>
<span class="tt">[% BLOCK list %]</span>
<span class="tt">[% thing.join(', ') %]</span>
<span class="tt">[% END %]</span>
<span class="tt">[% view.print(a_list) %]</span></pre>
</li>
<li><b id="item_view_prefix">view_prefix</b>
<p>
Prefix of methods which should be mapped to view() by AUTOLOAD. Defaults
to 'view_'.
</p>
<pre><span class="tt">[% USE view %]</span>
<span class="tt">[% view.view_header() %]</span> # => view('header')
<span class="tt">[% USE view(view_prefix => 'show_me_the_' %]</span>
<span class="tt">[% view.show_me_the_header() %]</span> # => view('header')</pre>
</li>
<li><b id="item_view_naked">view_naked</b>
<p>
Flag to indcate if any attempt should be made to map method names to
template names where they don't match the view_prefix. Defaults to 0.
</p>
<pre><span class="tt">[% USE view(view_naked => 1) %]</span>
<span class="tt">[% view.header() %]</span> # => view('header')</pre>
</li>
</ul>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="method_print" class="method" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">print( $obj1, $obj2, ... \%config)</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
TODO
</p>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="method_view" class="method" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">view( $template, \%vars, \%config );</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
TODO
</p>
</div>
</div>
</div>
</div>
<div class="section">
<div class="head">
<h1 id="AUTHOR" onclick="switch_section(this)" title="Click title to show/hide section content.">AUTHOR</h1>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
Andy Wardley <abw@wardley.org> <a
href="http://wardley.org/">http://wardley.org/</a>
</p>
</div>
</div>
<div class="section">
<div class="head">
<h1 id="COPYRIGHT" onclick="switch_section(this)" title="Click title to show/hide section content.">COPYRIGHT</h1>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
Copyright (C) 2000-2007 Andy Wardley. All Rights Reserved.
</p>
<p>
This module is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
</p>
</div>
</div>
<div class="section">
<div class="head">
<h1 id="SEE_ALSO" onclick="switch_section(this)" title="Click title to show/hide section content.">SEE ALSO</h1>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
<a href="../../modules/Template/Plugin.html">Template::Plugin</a>
</p>
</div>
</div>
</div></div>
<br class="clear" />
<div class="pageinfo">
<a href="http://template-toolkit.org/docs/modules/Template/View.html">http://template-toolkit.org/docs/modules/Template/View.html</a>
</div>
</div>
<div id="footer">
<a href="http://opensource.org/" class="osi"></a>
<div class="controls">
<div class="pager">
<a href="../../modules/Template/VMethods.html" title="Template::VMethods" class="go back">Back<span class="about"><h4>Template::VMethods</h4></span></a>
<a href="../../modules/Template/index.html" title="Template::* Modules" class="go up">Up<span class="about"><h4>Template::* Modules</h4></span></a>
<span class="go next">Next<span class="about"></span></span>
</div>
</div>
<div class="copyright">
Copyright © 1996-2012 <a href="http://wardley.org/">Andy Wardley</a>. All Rights Reserved.
</div>
<div class="licence">
The <a href="http://template-toolkit.org/">Template Toolkit</a> is <a href="http://opensource.org/">Open Source</a> software.
You can redistribute and/or modify it under the terms of the <a href="http://www.opensource.org/licenses/gpl-license.php">GNU Public Licence</a>
or the <a href="http://www.opensource.org/licenses/artistic-license.php">Perl Artistic Licence</a>.
</div>
</div>
<div id="palette">
<ul>
<li class="first"><a href="#" class="blue" onclick="set_style('Clear Blue')"></a></li>
<li><a href="#" class="orange" onclick="set_style('Clear Orange')"></a></li>
<li><a href="#" class="green" onclick="set_style('Clear Green')"></a></li>
<li><a href="#" class="purple" onclick="set_style('Clear Purple')"></a></li>
<li><a href="#" class="grey" onclick="set_style('Clear Grey')"></a></li>
</ul>
</div>
</div> </body>
</html>
|
