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
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Strict//EN">
<html>
<head>
<title>Template::Provider</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/Provider.html">Provider.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/Plugins.html" title="Template::Plugins" class="go back">Back<span class="about"><h4>Template::Plugins</h4>Plugin provider module</span></a>
<a href="../../modules/Template/index.html" title="Template::* Modules" class="go up">Up<span class="about"><h4>Template::* Modules</h4></span></a>
<a href="../../modules/Template/Service.html" title="Template::Service" class="go next">Next<span class="about"><h4>Template::Service</h4>General purpose template processing service</span></a>
</div>
</div>
<h1 class="headline">Template::Provider</h1>
<h2 class="subhead">Provider module for loading/compiling templates</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" class="warm">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">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="#PUBLIC_METHODS">PUBLIC METHODS</a></li>
<li class="sub"><a href="#method_new">new(\%options)</a></li>
<li class="sub"><a href="#method_fetch">fetch($name)</a></li>
<li class="sub"><a href="#method_load">load($name)</a></li>
<li class="sub"><a href="#method_store">store($name, $template)</a></li>
<li class="sub"><a href="#method_include_path">include_path(\@newpath)</a></li>
<li class="sub"><a href="#method_paths">paths()</a></li>
<li class=""><a href="#CONFIGURATION_OPTIONS">CONFIGURATION OPTIONS</a></li>
<li class="sub"><a href="#section_INCLUDE_PATH">INCLUDE_PATH</a></li>
<li class="sub"><a href="#section_ABSOLUTE">ABSOLUTE</a></li>
<li class="sub"><a href="#section_RELATIVE">RELATIVE</a></li>
<li class="sub"><a href="#section_DEFAULT">DEFAULT</a></li>
<li class="sub"><a href="#section_ENCODING">ENCODING</a></li>
<li class="sub"><a href="#section_CACHE_SIZE">CACHE_SIZE</a></li>
<li class="sub"><a href="#section_STAT_TTL">STAT_TTL</a></li>
<li class="sub"><a href="#section_COMPILE_EXT">COMPILE_EXT</a></li>
<li class="sub"><a href="#section_COMPILE_DIR">COMPILE_DIR</a></li>
<li class="sub"><a href="#section_TOLERANT">TOLERANT</a></li>
<li class="sub"><a href="#section_PARSER">PARSER</a></li>
<li class="sub"><a href="#section_DEBUG">DEBUG</a></li>
<li class=""><a href="#SUBCLASSING">SUBCLASSING</a></li>
<li class="sub"><a href="#method__template_modified">_template_modified($path)</a></li>
<li class="sub"><a href="#method__template_content">_template_content($path)</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>$provider = Template::Provider->new(\%options);
($template, $error) = $provider->fetch($name);</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>
The <a href="../../modules/Template/Provider.html">Template::Provider</a> is used to load, parse, compile and cache
template documents. This object may be sub-classed to provide more
specific facilities for loading, or otherwise providing access to
templates.
</p>
<p>
The <a href="../../modules/Template/Context.html">Template::Context</a> objects maintain a list of <a href="../../modules/Template/Provider.html">Template::Provider</a> objects which
are polled in turn (via <a href="../../modules/Template/Context.html#method_fetch">fetch()</a>) to return a requested template. Each may
return a compiled template, raise an error, or decline to serve the
request, giving subsequent providers a chance to do so.
</p>
<p>
The <a href="../../modules/Template/Provider.html">Template::Provider</a> can also be subclassed to provide templates
from a different source, e.g. a database. See <a
href="#section_SUBCLASSING">SUBCLASSING</a> below.
</p>
<p>
This documentation needs work.
</p>
</div>
</div>
<div class="section">
<div class="head">
<h1 id="PUBLIC_METHODS" onclick="switch_section(this)" title="Click title to show/hide section content.">PUBLIC 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(\%options)</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
Constructor method which instantiates and returns a new
<code>Template::Provider</code> object. A reference to a hash array of
configuration options may be passed.
</p>
<p>
See <a href="#CONFIGURATION_OPTIONS">CONFIGURATION OPTIONS</a> below for
a summary of configuration options and <a href="../../manual/Config.html">Template::Manual::Config</a>
for full details.
</p>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="method_fetch" class="method" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">fetch($name)</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
Returns a compiled template for the name specified. If the template
cannot be found then <code>(undef, STATUS_DECLINED)</code> is returned.
If an error occurs (e.g. read error, parse error) then <code>($error,
STATUS_ERROR)</code> is returned, where <code>$error</code> is the error
message generated. If the <a href="#section_TOLERANT">TOLERANT</a> option
is set the the method returns <code>(undef, STATUS_DECLINED)</code>
instead of returning an error.
</p>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="method_load" class="method" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">load($name)</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
Loads a template without parsing or compiling it. This is used by the the
<a href="../../manual/Directives.html#section_INSERT">INSERT</a> directive.
</p>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="method_store" class="method" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">store($name, $template)</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
Stores the compiled template, <code>$template</code>, in the cache under
the name, <code>$name</code>. Susbequent calls to
<code>fetch($name)</code> will return this template in preference to any
disk-based file.
</p>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="method_include_path" class="method" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">include_path(\@newpath)</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
Accessor method for the <code>INCLUDE_PATH</code> setting. If called with
an argument, this method will replace the existing
<code>INCLUDE_PATH</code> with the new value.
</p>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="method_paths" class="method" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">paths()</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
This method generates a copy of the <code>INCLUDE_PATH</code> list. Any
elements in the list which are dynamic generators (e.g. references to
subroutines or objects implementing a <code>paths()</code> method) will
be called and the list of directories returned merged into the output
list.
</p>
<p>
It is possible to provide a generator which returns itself, thus sending
this method into an infinite loop. To detect and prevent this from
happening, the <code>$MAX_DIRS</code> package variable, set to
<code>64</code> by default, limits the maximum number of paths that can
be added to, or generated for the output list. If this number is exceeded
then the method will immediately return an error reporting as much.
</p>
</div>
</div>
</div>
</div>
<div class="section">
<div class="head">
<h1 id="CONFIGURATION_OPTIONS" onclick="switch_section(this)" title="Click title to show/hide section content.">CONFIGURATION OPTIONS</h1>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
The following list summarises the configuration options that can be
provided to the <code>Template::Provider</code> <a
href="#method_new">new()</a> constructor. Please consult <a href="../../manual/Config.html">Template::Manual::Config</a>
for further details and examples of each configuration option in use.
</p>
<div class="subsection">
<div class="head">
<h2 id="section_INCLUDE_PATH" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">INCLUDE_PATH</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
The <a href="../../manual/Config.html#section_INCLUDE_PATH">INCLUDE_PATH</a> option is used to specify one
or more directories in which template files are located.
</p>
<pre># single path
my $provider = Template::Provider->new({
INCLUDE_PATH => '/usr/local/templates',
});
# multiple paths
my $provider = Template::Provider->new({
INCLUDE_PATH => [ '/usr/local/templates',
'/tmp/my/templates' ],
});</pre>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_ABSOLUTE" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">ABSOLUTE</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
The <a href="../../manual/Config.html#section_ABSOLUTE">ABSOLUTE</a> flag is used to indicate if templates
specified with absolute filenames (e.g. '<code>/foo/bar</code>') should
be processed. It is disabled by default and any attempt to load a
template by such a name will cause a '<code>file</code>' exception to be
raised.
</p>
<pre>my $provider = Template::Provider->new({
ABSOLUTE => 1,
});</pre>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_RELATIVE" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">RELATIVE</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
The <a href="../../manual/Config.html#section_RELATIVE">RELATIVE</a> flag is used to indicate if templates
specified with filenames relative to the current directory (e.g.
<code>./foo/bar</code> or <code>../../some/where/else</code>) should be
loaded. It is also disabled by default, and will raise a
<code>file</code> error if such template names are encountered.
</p>
<pre>my $provider = Template::Provider->new({
RELATIVE => 1,
});</pre>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_DEFAULT" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">DEFAULT</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
The <a href="../../manual/Config.html#section_DEFAULT">DEFAULT</a> option can be used to specify a default
template which should be used whenever a specified template can't be
found in the <a href="#section_INCLUDE_PATH">INCLUDE_PATH</a>.
</p>
<pre>my $provider = Template::Provider->new({
DEFAULT => 'notfound.html',
});</pre>
<p>
If a non-existant template is requested through the <a href="../../modules/Template.html">Template</a> <a href="../../modules/Template.html#method_process">process()</a> method, or by an
<code>INCLUDE</code>, <code>PROCESS</code> or <code>WRAPPER</code>
directive, then the <code>DEFAULT</code> template will instead be
processed, if defined. Note that the <code>DEFAULT</code> template is not
used when templates are specified with absolute or relative filenames, or
as a reference to a input file handle or text string.
</p>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_ENCODING" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">ENCODING</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
The Template Toolkit will automatically decode Unicode templates that
have a Byte Order Marker (BOM) at the start of the file. This option can
be used to set the default encoding for templates that don't define a
BOM.
</p>
<pre>my $provider = Template::Provider->new({
ENCODING => 'utf8',
});</pre>
<p>
See <a href="#section_Encode">Encode</a> for further information.
</p>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_CACHE_SIZE" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">CACHE_SIZE</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
The <a href="../../manual/Config.html#section_CACHE_SIZE">CACHE_SIZE</a> option can be used to limit the
number of compiled templates that the module should cache. By default,
the <a href="../../manual/Config.html#section_CACHE_SIZE">CACHE_SIZE</a> is undefined and all compiled
templates are cached.
</p>
<pre>my $provider = Template::Provider->new({
CACHE_SIZE => 64, # only cache 64 compiled templates
});</pre>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_STAT_TTL" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">STAT_TTL</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
The <a href="../../manual/Config.html#section_STAT_TTL">STAT_TTL</a> value can be set to control how long
the <code>Template::Provider</code> will keep a template cached in memory
before checking to see if the source template has changed.
</p>
<pre>my $provider = Template::Provider->new({
STAT_TTL => 60, # one minute
});</pre>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_COMPILE_EXT" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">COMPILE_EXT</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
The <a href="../../manual/Config.html#section_COMPILE_EXT">COMPILE_EXT</a> option can be provided to
specify a filename extension for compiled template files. It is undefined
by default and no attempt will be made to read or write any compiled
template files.
</p>
<pre>my $provider = Template::Provider->new({
COMPILE_EXT => '.ttc',
});</pre>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_COMPILE_DIR" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">COMPILE_DIR</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
The <a href="../../manual/Config.html#section_COMPILE_DIR">COMPILE_DIR</a> option is used to specify an
alternate directory root under which compiled template files should be
saved.
</p>
<pre>my $provider = Template::Provider->new({
COMPILE_DIR => '/tmp/ttc',
});</pre>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_TOLERANT" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">TOLERANT</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
The <a href="../../manual/Config.html#section_TOLERANT">TOLERANT</a> flag can be set to indicate that the
<code>Template::Provider</code> module should ignore any errors
encountered while loading a template and instead return
<code>STATUS_DECLINED</code>.
</p>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_PARSER" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">PARSER</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
The <a href="../../manual/Config.html#section_PARSER">PARSER</a> option can be used to define a parser
module other than the default of <a href="../../modules/Template/Parser.html">Template::Parser</a>.
</p>
<pre>my $provider = Template::Provider->new({
PARSER => MyOrg::Template::Parser->new({ ... }),
});</pre>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="section_DEBUG" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">DEBUG</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
The <a href="../../manual/Config.html#section_DEBUG">DEBUG</a> option can be used to enable debugging
messages from the <a href="../../modules/Template/Provider.html">Template::Provider</a> module by setting it to include the
<code>DEBUG_PROVIDER</code> value.
</p>
<pre>use Template::Constants qw( :debug );
my $template = Template->new({
DEBUG => DEBUG_PROVIDER,
});</pre>
</div>
</div>
</div>
</div>
<div class="section">
<div class="head">
<h1 id="SUBCLASSING" onclick="switch_section(this)" title="Click title to show/hide section content.">SUBCLASSING</h1>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
The <code>Template::Provider</code> module can be subclassed to provide
templates from a different source (e.g. a database). In most cases you'll
just need to provide custom implementations of the
<code>_template_modified()</code> and <code>_template_content()</code>
methods. If your provider requires and custom initialisation then you'll
also need to implement a new <code>_init()</code> method.
</p>
<p>
Caching in memory and on disk will still be applied (if enabled) when
overriding these methods.
</p>
<div class="subsection">
<div class="head">
<h2 id="method__template_modified" class="method" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">_template_modified($path)</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
Returns a timestamp of the <code>$path</code> passed in by calling
<code>stat()</code>. This can be overridden, for example, to return a
last modified value from a database. The value returned should be a
timestamp value (as returned by <code>time()</code>, although a sequence
number should work as well.
</p>
</div>
</div> <div class="subsection">
<div class="head">
<h2 id="method__template_content" class="method" onclick="switch_subsection(this)" title="Click title to show/hide sub-section content.">_template_content($path)</h2>
<a href="#body" class="top" title="Back up to the top of the page" >Top</a>
</div>
<div class="body">
<p>
This method returns the content of the template for all
<code>INCLUDE</code>, <code>PROCESS</code>, and <code>INSERT</code>
directives.
</p>
<p>
When called in scalar context, the method returns the content of the
template located at <code>$path</code>, or <code>undef</code> if
<code>$path</code> is not found.
</p>
<p>
When called in list context it returns <code>($content, $error,
$mtime)</code>, where <code>$content</code> is the template content,
<code>$error</code> is an error string (e.g. "<code>$path: File not
found</code>"), and <code>$mtime</code> is the template modification
time.
</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) 1996-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.html">Template</a>, <a href="../../modules/Template/Parser.html">Template::Parser</a>, <a href="../../modules/Template/Context.html">Template::Context</a>
</p>
</div>
</div>
</div></div>
<br class="clear" />
<div class="pageinfo">
<a href="http://template-toolkit.org/docs/modules/Template/Provider.html">http://template-toolkit.org/docs/modules/Template/Provider.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/Plugins.html" title="Template::Plugins" class="go back">Back<span class="about"><h4>Template::Plugins</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>
<a href="../../modules/Template/Service.html" title="Template::Service" class="go next">Next<span class="about"><h4>Template::Service</h4></span></a>
</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>
|
