Mercurial > pub > Impl

comparison Lib/IMPL/Web/View/TTLoader.pm @ 265:6b6d4b2275a1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
improved documentation
author cin
date Thu, 10 Jan 2013 03:25:02 +0400
parents 5c82eec23bb6
children 546957c50a36
comparison
equal deleted inserted replaced
264:c9c2ec29793f 265:6b6d4b2275a1
1 package IMPL::Web::View::TTLoader; 1 package IMPL::Web::View::TTLoader;
2 use strict; 2 use strict;
3 3
4 use IMPL::lang qw(:declare);
5
6 use Template::Provider();
7 use Template::Context();
8 use Template::Constants qw(:status); 4 use Template::Constants qw(:status);
9 5
10 use IMPL::Web::View::TTDocument(); 6 use IMPL::Const qw(:prop);
11 7 use IMPL::declare {
12 use parent qw( 8 require => {
13 IMPL::Object 9 Provider => 'Template::Provider',
14 IMPL::Object::Serializable 10 Context => 'Template::Context',
15 ); 11 TTDocument => 'IMPL::Web::View::TTDocument',
16 12 Exception => 'IMPL::Exception',
17 BEGIN { 13 ArgumentException => '-IMPL::InvalidArgumentException',
18 public property options => PROP_ALL; 14 KeyNotFoundException => '-IMPL::KeyNotFoundException'
19 public property provider => PROP_GET | PROP_OWNERSET; 15 },
20 public property context => PROP_GET | PROP_OWNERSET; 16 base => [
21 public property ext => PROP_ALL; 17 'IMPL::Object' => undef,
22 public property layoutBase => PROP_GET | PROP_OWNERSET; 18 'IMPL::Object::Serializable' => undef
23 19 ],
24 public property isInitialized => PROP_GET | PROP_OWNERSET; 20 props => [
25 public property initializer => PROP_GET | PROP_OWNERSET; 21 options => PROP_RO,
26 22 provider => PROP_RO,
27 private property _globals => PROP_ALL; 23 context => PROP_RO,
28 } 24 ext => PROP_RO,
25 layoutBase => PROP_RO,
26 isInitialized => PROP_RO,
27 initializer => PROP_RO,
28 _globals => PROP_RW
29 ]
30 };
29 31
30 sub save { 32 sub save {
31 my ($this,$context) = @_; 33 my ($this,$context) = @_;
32 34
33 $context->AddVar($_, $this->$_()) for qw(options provider context ext layoutBase); 35 $context->AddVar($_, $this->$_()) for qw(options provider context ext layoutBase);
59 61
60 $this->options($refOpts); 62 $this->options($refOpts);
61 $this->layoutBase($args{layoutBase}) if $args{layoutBase}; 63 $this->layoutBase($args{layoutBase}) if $args{layoutBase};
62 64
63 # to aviod cyclic references we need to do a copy of $refOpts 65 # to aviod cyclic references we need to do a copy of $refOpts
64 $refOpts->{LOAD_TEMPLATES} = $this->provider(new Template::Provider( { %$refOpts } )); 66 $refOpts->{LOAD_TEMPLATES} = $this->provider(Provider->new( { %$refOpts } ));
65 67
66 $this->context(new Template::Context($refOpts)); 68 $this->context(Context->new($refOpts));
67 } 69 }
68 70
69 sub document { 71 sub document {
70 my ($this,$name,$vars) = @_; 72 my ($this,$name,$vars) = @_;
71 73
76 my $opts = { %{ $this->options } }; 78 my $opts = { %{ $this->options } };
77 79
78 $opts->{STASH} = $this->context->stash->clone(); 80 $opts->{STASH} = $this->context->stash->clone();
79 $opts->{LOAD_TEMPLATES} = $this->provider; 81 $opts->{LOAD_TEMPLATES} = $this->provider;
80 82
81 return new IMPL::Web::View::TTDocument( $tt, $opts, $this, $vars ); 83 return TTDocument->new( $tt, $opts, $this, $vars );
82 } 84 }
83 85
84 sub template { 86 sub template {
85 my ($this,$name) = @_; 87 my ($this,$name) = @_;
86 88
87 $name =~ s/^\s+|\s+$//g; 89 $name =~ s/^\s+|\s+$//g;
88 90
89 die new IMPL::InvalidArgumentException("A valid template name is required") unless length $name; 91 die ArgumentException->new("A valid template name is required") unless length $name;
90 92
91 $name = $this->_appendExt($name); 93 $name = $this->_appendExt($name);
92 94
93 my ($tt,$error) = $this->provider->fetch($name); 95 my ($tt,$error) = $this->provider->fetch($name);
94 96
95 if (defined $error and $error == STATUS_DECLINED) { 97 if (defined $error and $error == STATUS_DECLINED) {
96 die new IMPL::KeyNotFoundException($name); 98 die KeyNotFoundException->($name);
97 } elsif (defined $error and $error == STATUS_ERROR) { 99 } elsif (defined $error and $error == STATUS_ERROR) {
98 die new IMPL::Exception("Failed to load a template", $name, $tt); 100 die Exception->new("Failed to load a template", $name, $tt);
99 } 101 }
100 102
101 return $tt; 103 return $tt;
102 } 104 }
103 105
134 136
135 eval { 137 eval {
136 $this->context->process($initializer,$this->_globals); 138 $this->context->process($initializer,$this->_globals);
137 }; 139 };
138 if (my $e = $@) { 140 if (my $e = $@) {
139 die new IMPL::Exception("Failed to process an initializer", $this->initializer, $e); 141 die Exception->new("Failed to process an initializer", $this->initializer, $e);
140 } 142 }
141 143
142 $this->isInitialized(1); 144 $this->isInitialized(1);
143 } 145 }
144 } 146 }
177 179
178 =end code 180 =end code
179 181
180 =head1 DESCRIPTION 182 =head1 DESCRIPTION
181 183
184 Провайдер для загрузки шаблонов и документов. Имеет собственное пространство
185 имен, контекст выполнения шаблонов. Контект загрузчика инициализируется
186 шаблоном, в котором определяются глобальные переменные, которые будут доступны
187 в документах, однако их изменения будут локализованы.
188
189 Инициализация контекста провайдера происходит при первой загрузке любого
190 документа.
191
182 =head1 MEMBERS 192 =head1 MEMBERS
183 193
194 =head2 C<CTOR($options,%args)>
195
196 =over
197
198 =item * C<$options>
199
200 Параметры контекста загрузчика, контексты документов и элементов управления
201 также унаследуют эти свойства. Напрямую передаются в конструктор
202 C<Template::Context>.
203
204 =item * C<%args>
205
206 Именованные параметы загрузчика.
207
208 =over
209
210 =item * C<ext>
211
212 Расширение, которое будет добавляться к именам шаблонов и документов (если оно
213 не будет указано явно).
214
215 =item * C<initializer>
216
217 Имя шаблона, который будет использован для инициализации контекста.
218
219 =item * C<globals>
220
221 Глобальные переменнын, которые будут переданы в контекст.
222
223 =item * C<layoutBase>
224
225 Путь к шаблонам для оформления документов. Каждый документ может задавать свой
226 C<layout> указанный в его C<META> блоке или конструкторе.
227 См. C<IMPL::View::TTDocument>.
228
229 =back
230
231 =back
232
184 =head2 C<document($docName)> 233 =head2 C<document($docName)>
185 234
235 Загружает документ с именем C<$docName>. При необходимости к нему будет
236 добавлено расширение, указанное в свойстве C<ext>. Это единственно полезный
237 метод провайдера.
238
186 =cut 239 =cut
187 240