Mercurial > pub > Impl
annotate Lib/IMPL/Web/View/TTLoader.pm @ 343:9bdccdf1f50b
Added a templates context
| author | cin |
|---|---|
| date | Fri, 13 Sep 2013 12:53:15 +0400 |
| parents | 86336d451b82 |
| children | 72799d1211c5 |
| rev | line source |
|---|---|
| 181 | 1 package IMPL::Web::View::TTLoader; |
| 2 use strict; | |
| 3 | |
| 4 use Template::Constants qw(:status); | |
| 5 | |
| 336 | 6 use File::Spec(); |
| 265 | 7 use IMPL::Const qw(:prop); |
| 8 use IMPL::declare { | |
| 9 require => { | |
| 10 Provider => 'Template::Provider', | |
| 343 | 11 Context => 'IMPL::Web::View::TTContext', |
| 309 | 12 TTRegistry => 'IMPL::Web::View::TTRegistry', |
| 308 | 13 TTFactory => 'IMPL::Web::View::TTFactory', |
| 309 | 14 TTDocument => '-IMPL::Web::View::TTDocument', |
| 265 | 15 Exception => 'IMPL::Exception', |
| 16 ArgumentException => '-IMPL::InvalidArgumentException', | |
| 17 KeyNotFoundException => '-IMPL::KeyNotFoundException' | |
| 18 }, | |
| 19 base => [ | |
| 20 'IMPL::Object' => undef, | |
| 21 'IMPL::Object::Serializable' => undef | |
| 22 ], | |
| 23 props => [ | |
| 24 options => PROP_RO, | |
| 25 provider => PROP_RO, | |
| 26 context => PROP_RO, | |
| 27 ext => PROP_RO, | |
| 28 layoutBase => PROP_RO, | |
| 29 isInitialized => PROP_RO, | |
| 30 initializer => PROP_RO, | |
| 31 _globals => PROP_RW | |
| 32 ] | |
| 33 }; | |
| 181 | 34 |
| 196 | 35 sub save { |
| 36 my ($this,$context) = @_; | |
| 37 | |
| 38 $context->AddVar($_, $this->$_()) for qw(options provider context ext layoutBase); | |
| 39 } | |
| 40 | |
| 41 sub restore { | |
| 42 my ($class,$data,$surrogate) = @_; | |
| 43 | |
| 44 my %params = @$data; | |
| 45 | |
| 46 my $refOpts = delete $params{options}; | |
| 47 | |
| 48 if ($surrogate){ | |
| 49 $surrogate->callCTOR($refOpts,%params); | |
| 50 } else { | |
| 51 $surrogate = $class->new($refOpts,%params); | |
| 52 } | |
| 206 | 53 return $surrogate; |
| 196 | 54 } |
| 55 | |
| 181 | 56 sub CTOR { |
| 194 | 57 my ($this,$refOpts,%args) = @_; |
| 58 | |
| 59 $refOpts ||= {}; | |
| 60 | |
| 61 $this->ext($args{ext}) if $args{ext}; | |
| 62 $this->initializer($args{initializer}) if $args{initializer}; | |
| 63 $this->_globals(ref $args{globals} eq 'HASH' ? $args{globals} : {}); | |
| 64 | |
| 65 $this->options($refOpts); | |
|
195
7a920771fd8e
IMPL::Web::View changed document layout handling, docs, examples
cin
parents:
194
diff
changeset
|
66 $this->layoutBase($args{layoutBase}) if $args{layoutBase}; |
| 194 | 67 |
| 68 # to aviod cyclic references we need to do a copy of $refOpts | |
| 265 | 69 $refOpts->{LOAD_TEMPLATES} = $this->provider(Provider->new( { %$refOpts } )); |
| 194 | 70 |
| 265 | 71 $this->context(Context->new($refOpts)); |
| 181 | 72 } |
| 73 | |
| 74 sub document { | |
| 194 | 75 my ($this,$name,$vars) = @_; |
| 76 | |
| 309 | 77 $vars ||= {}; |
| 308 | 78 |
| 194 | 79 my $tt = $this->template($name); |
| 80 | |
| 81 $this->_init(); | |
| 82 | |
| 83 my $opts = { %{ $this->options } }; | |
| 84 | |
| 343 | 85 my $ctx = $this->context->clone(); |
| 194 | 86 |
| 311 | 87 $ctx->stash->update($vars); |
| 88 | |
| 309 | 89 my $registry = TTRegistry->new($this, $ctx); |
| 90 | |
| 91 my $factory = TTFactory->new($tt->class || TTDocument, $tt, $ctx, $name, $registry); | |
| 308 | 92 |
| 309 | 93 $vars->{registry} = $registry; |
|
310
0a9d51cf6dfd
*TTView: refactoring, document supports custom classes, layouts are become controls
sergey
parents:
309
diff
changeset
|
94 $vars->{layoutBase} = $this->layoutBase; |
| 309 | 95 |
| 311 | 96 return $factory->new( $vars ); |
| 181 | 97 } |
| 98 | |
| 308 | 99 |
| 181 | 100 sub template { |
| 194 | 101 my ($this,$name) = @_; |
| 102 | |
| 103 $name =~ s/^\s+|\s+$//g; | |
| 104 | |
| 265 | 105 die ArgumentException->new("A valid template name is required") unless length $name; |
| 194 | 106 |
| 107 $name = $this->_appendExt($name); | |
| 108 | |
| 109 my ($tt,$error) = $this->provider->fetch($name); | |
| 110 | |
| 111 if (defined $error and $error == STATUS_DECLINED) { | |
|
285
546957c50a36
*IMPL::Web::Handler::TTView Reworked template selection mechanism
cin
parents:
265
diff
changeset
|
112 die KeyNotFoundException->new($name); |
| 194 | 113 } elsif (defined $error and $error == STATUS_ERROR) { |
| 265 | 114 die Exception->new("Failed to load a template", $name, $tt); |
| 194 | 115 } |
| 116 | |
| 117 return $tt; | |
| 181 | 118 } |
| 119 | |
| 336 | 120 sub ResolveFileName { |
| 121 my ($this,$fname) = @_; | |
| 122 | |
| 123 $fname = $this->_appendExt($fname); | |
| 124 | |
| 125 my @files = grep -f , map File::Spec->catfile($_,$fname), @{$this->provider->paths()}; | |
| 126 return shift @files; | |
| 127 } | |
| 128 | |
| 181 | 129 sub _appendExt { |
| 194 | 130 my ($this,$name) = @_; |
| 131 | |
| 132 return $name unless $this->ext; | |
| 133 | |
| 134 if (length $this->ext and substr( $name, -length($this->ext) ) eq $this->ext) { | |
| 135 return $name; | |
| 136 } else { | |
| 137 return $name . $this->ext; | |
| 138 } | |
| 181 | 139 } |
| 140 | |
| 141 sub _init { | |
| 194 | 142 my ($this) = @_; |
| 143 | |
| 144 if (!$this->isInitialized) { | |
| 145 my $initializer = $this->initializer || sub {}; | |
| 146 | |
| 147 eval { | |
| 148 $this->context->process($initializer,$this->_globals); | |
| 149 }; | |
| 150 if (my $e = $@) { | |
| 265 | 151 die Exception->new("Failed to process an initializer", $this->initializer, $e); |
| 194 | 152 } |
| 153 | |
| 154 $this->isInitialized(1); | |
| 155 } | |
| 181 | 156 } |
| 157 | |
| 158 1; | |
| 159 | |
| 160 __END__ | |
| 161 | |
| 162 =pod | |
| 163 | |
| 164 =head1 NAME | |
| 165 | |
| 166 C<IMPL::Web::View::TTLoader> - предоставляет глобальный контекст для загрузки шаблонов | |
| 167 | |
| 168 =head1 SYNOPSIS | |
| 169 | |
| 170 =begin code | |
| 171 | |
| 172 use IMPL::Web::View::TTLoader(); | |
| 173 | |
| 174 my $loader = new IMPL::Web::View::TTLoader( | |
| 194 | 175 { |
| 176 INCLUDE_PATH => [ | |
| 177 '/my/app/tt', | |
| 178 '/my/app/tt/lib' | |
| 179 ] | |
| 180 }, | |
| 181 ext => '.tt', | |
| 182 initializer => 'shared/global' | |
| 183 | |
| 181 | 184 ); |
| 185 | |
| 186 my $doc = $loader->document('index'); | |
| 187 | |
| 188 my $html = $doc->Render(); | |
| 189 | |
| 190 =end code | |
| 191 | |
| 192 =head1 DESCRIPTION | |
| 193 | |
| 265 | 194 Провайдер для загрузки шаблонов и документов. Имеет собственное пространство |
| 195 имен, контекст выполнения шаблонов. Контект загрузчика инициализируется | |
| 196 шаблоном, в котором определяются глобальные переменные, которые будут доступны | |
| 197 в документах, однако их изменения будут локализованы. | |
| 198 | |
| 199 Инициализация контекста провайдера происходит при первой загрузке любого | |
| 200 документа. | |
| 201 | |
| 182 | 202 =head1 MEMBERS |
| 203 | |
| 265 | 204 =head2 C<CTOR($options,%args)> |
| 205 | |
| 206 =over | |
| 207 | |
| 208 =item * C<$options> | |
| 209 | |
| 210 Параметры контекста загрузчика, контексты документов и элементов управления | |
| 211 также унаследуют эти свойства. Напрямую передаются в конструктор | |
| 212 C<Template::Context>. | |
| 213 | |
| 214 =item * C<%args> | |
| 215 | |
| 216 Именованные параметы загрузчика. | |
| 217 | |
| 218 =over | |
| 219 | |
| 220 =item * C<ext> | |
| 221 | |
| 222 Расширение, которое будет добавляться к именам шаблонов и документов (если оно | |
| 223 не будет указано явно). | |
| 224 | |
| 225 =item * C<initializer> | |
| 226 | |
| 227 Имя шаблона, который будет использован для инициализации контекста. | |
| 228 | |
| 229 =item * C<globals> | |
| 230 | |
| 231 Глобальные переменнын, которые будут переданы в контекст. | |
| 232 | |
| 233 =item * C<layoutBase> | |
| 234 | |
| 235 Путь к шаблонам для оформления документов. Каждый документ может задавать свой | |
| 236 C<layout> указанный в его C<META> блоке или конструкторе. | |
| 237 См. C<IMPL::View::TTDocument>. | |
| 238 | |
| 239 =back | |
| 240 | |
| 241 =back | |
| 242 | |
| 182 | 243 =head2 C<document($docName)> |
| 244 | |
| 265 | 245 Загружает документ с именем C<$docName>. При необходимости к нему будет |
| 246 добавлено расширение, указанное в свойстве C<ext>. Это единственно полезный | |
| 247 метод провайдера. | |
| 248 | |
| 181 | 249 =cut |
| 250 |