Mercurial > pub > Impl
annotate Lib/IMPL/Web/View/TTDocument.pm @ 194:4d0e1962161c
Replaced tabs with spaces
IMPL::Web::View - fixed document model, new features (control classes, document constructor parameters)
| author | cin |
|---|---|
| date | Tue, 10 Apr 2012 20:08:29 +0400 |
| parents | 8e8401c0aea4 |
| children | 7a920771fd8e |
| rev | line source |
|---|---|
| 181 | 1 package IMPL::Web::View::TTDocument; |
| 2 use strict; | |
| 3 | |
| 4 use IMPL::lang qw(:declare :constants); | |
| 5 use IMPL::DOM::Property qw(_dom); | |
| 6 use IMPL::Web::View::TTFactory(); | |
| 7 use IMPL::Web::View::TTControl(); | |
| 8 | |
|
190
cd1ff7029a63
IMLP::Web::View refactored, added new method 'require' which is available inside templates. Changed document rendering.
cin
parents:
189
diff
changeset
|
9 use Scalar::Util qw(weaken); |
|
cd1ff7029a63
IMLP::Web::View refactored, added new method 'require' which is available inside templates. Changed document rendering.
cin
parents:
189
diff
changeset
|
10 |
| 181 | 11 |
| 12 use parent qw( | |
| 194 | 13 IMPL::DOM::Document |
| 14 IMPL::Web::View::TTControl | |
| 181 | 15 ); |
| 16 | |
| 17 BEGIN { | |
| 194 | 18 public _dom property layout => PROP_ALL; |
| 19 public property opts => PROP_GET | PROP_OWNERSET; | |
| 20 public property loader => PROP_ALL; | |
| 21 public property controls => PROP_GET | PROP_OWNERSET; | |
| 22 | |
| 23 # store the stash separately to make require() method to work correctly | |
| 24 # even when a stash of the context is modified during the processing | |
| 25 public property stash => PROP_GET | PROP_OWNERSET; | |
| 181 | 26 } |
| 27 | |
| 28 sub CTOR { | |
| 194 | 29 my ($this,$template,$refOpts,$loader,$vars) = @_; |
| 30 | |
| 31 $this->controls({}); | |
| 32 $this->loader($loader) if $loader; | |
| 33 | |
| 34 $this->layout( $template->layout ) unless $this->layout; | |
| 35 | |
| 36 $this->opts($refOpts); | |
| 37 $this->stash($this->context->stash); | |
| 38 | |
| 39 my $self = $this; | |
| 40 weaken($self); | |
| 41 | |
| 42 $this->templateVars('require', sub { | |
| 43 my $doc = $self; | |
| 44 die new IMPL::Exception("A document is destroyed or invalid") unless $doc; | |
| 45 $doc->require(@_); | |
| 46 }); | |
| 47 | |
| 48 $this->templateVars('document', sub { $self } ); | |
| 49 $this->InitInstance($vars); | |
| 181 | 50 } |
| 51 | |
| 52 our %CTOR = ( | |
| 194 | 53 'IMPL::Web::View::TTControl' => sub { |
| 54 my ($template,$contextOpts) = @_; | |
| 55 'document', | |
| 56 $_[0], # template | |
| 57 new Template::Context($_[1]) # context | |
| 58 }, | |
| 59 'IMPL::DOM::Document' => sub { | |
| 60 nodeName => 'document' | |
| 61 } | |
| 181 | 62 ); |
| 63 | |
| 189 | 64 sub templateVars { |
| 194 | 65 my $this = shift; |
| 66 my $name = shift; | |
| 67 | |
| 68 if (@_) { | |
| 69 return $this->stash->set($name, shift); | |
| 70 } else { | |
| 71 return $this->stash->get($name); | |
| 72 } | |
| 189 | 73 } |
| 74 | |
| 181 | 75 sub require { |
| 194 | 76 my ($this, $control, $nodeProps) = @_; |
| 77 | |
| 78 $nodeProps ||= {}; | |
| 79 $nodeProps->{document} = $this; | |
| 80 | |
| 81 if (my $factory = $this->controls->{$control}) { | |
| 82 return $factory; | |
| 83 } else { | |
| 84 | |
| 85 my $path = $control; | |
| 86 if ( my $template = $this->loader->template($path) ) { | |
| 87 my $opts = { %{$this->opts} }; | |
| 189 | 88 |
| 194 | 89 # avoid propagation of local variables |
| 90 $opts->{STASH} = $this->stash->clone(); | |
| 188 | 91 |
| 194 | 92 my $ctx = new Template::Context($opts); |
| 93 | |
| 94 $factory = new IMPL::Web::View::TTFactory( | |
| 95 $template->class || typeof IMPL::Web::View::TTControl, | |
| 96 $template, | |
| 97 $ctx, | |
| 98 $opts | |
| 99 ); | |
| 100 | |
| 101 my @parts = split(/\/+/,$control); | |
| 102 | |
| 103 $this->controls->{$control} = $factory; | |
| 104 | |
| 105 return $factory; | |
| 188 | 106 |
| 194 | 107 } else { |
| 108 die new IMPL::KeyNotFoundException($control); | |
| 109 } | |
| 110 } | |
| 181 | 111 } |
| 112 | |
| 113 sub Render { | |
| 194 | 114 my ($this,$args) = @_; |
| 115 | |
| 116 my $output; | |
| 117 | |
| 118 if ($this->layout) { | |
| 119 $output = $this->context->include( | |
| 120 $this->loader->template($this->layout), | |
| 121 { | |
| 122 content => sub { $output ||= $this->RenderContent($args); }, | |
| 123 this => $this, | |
| 124 template => $this->template | |
| 125 } | |
| 126 ); | |
| 127 } else { | |
| 128 return $this->RenderContent($args); | |
| 129 } | |
| 130 | |
| 131 return $output; | |
| 181 | 132 } |
| 133 | |
|
190
cd1ff7029a63
IMLP::Web::View refactored, added new method 'require' which is available inside templates. Changed document rendering.
cin
parents:
189
diff
changeset
|
134 sub RenderContent { |
| 194 | 135 my $this = shift; |
| 136 return $this->SUPER::Render(@_); | |
|
190
cd1ff7029a63
IMLP::Web::View refactored, added new method 'require' which is available inside templates. Changed document rendering.
cin
parents:
189
diff
changeset
|
137 } |
|
cd1ff7029a63
IMLP::Web::View refactored, added new method 'require' which is available inside templates. Changed document rendering.
cin
parents:
189
diff
changeset
|
138 |
| 181 | 139 |
| 140 1; | |
| 141 | |
| 142 __END__ | |
| 143 | |
| 144 =pod | |
| 145 | |
| 146 =head1 NAME | |
| 147 | |
| 148 C<IMPL::Web::View::TTDocument> - документ для построения HTML страницы на основе шаблонов TT. | |
| 149 | |
| 150 =head1 SYNOPSIS | |
| 151 | |
| 152 =begin code | |
| 153 | |
| 154 use IMPL::Web::View::TTDocument(); | |
| 155 | |
| 156 my $doc = new IMPL::Wbe::View::TTDocument($template,$ttOptions); | |
| 157 | |
| 158 return $doc->Render(); | |
| 159 | |
| 160 =end code | |
| 161 | |
| 162 Однако, более предпочтительный способ использовать C<IMPL::Web::View::TTLoader>. | |
| 163 | |
| 164 =head1 DESCRIPTION | |
| 165 | |
| 166 Документ для представления данных. Документы представляют собой иерархически организованные данные, | |
| 167 элементами данного документа являются данные для отображения, такие как | |
| 168 | |
| 169 =over | |
| 170 | |
| 171 =item * Объекты из БД | |
| 172 | |
| 173 =item * Навигационные цепочки | |
| 174 | |
| 175 =item * Меню и т.п. | |
| 176 | |
| 177 =back | |
| 178 | |
| 179 Скприт шаблона формирует структуру документа, затем сформированная структура форматируется в готовый документ. | |
| 192 | 180 Процесс форматирования объектной модели в готовый документ может быть выполнена как вручную, так и при помощи |
| 189 | 181 вспомогательного шаблона - обертки. Если у шаблона документа указан C<layout> в метаданных, то он будет |
| 181 | 182 использован как шаблон для форматирования объектной модели, вывод самого шаблона будет проигнорирован. Если |
| 183 обертка не задана, то результатом будет вывод самого скрипта шаблона. | |
| 184 | |
| 192 | 185 Использование объектной модели документа позволяет решить задачи по созданию элементов управления |
| 186 контейнеров, у которых может быть сложное содежимое. Примером таких элементов могут быть формы, | |
| 187 внутри форм элементы управления могут группироваться. | |
| 188 | |
| 193 | 189 =head2 Элементы управления (компоненты) |
| 190 | |
| 191 Документ состоит из узлов, часть которых наследуется от C<IMPL::Web::View::TTControl>, такие узлы называются | |
| 192 элементами управления. Каждый элемент управления имеет собственный контекст, который наследуется от контекста | |
| 193 документа. | |
| 194 | |
| 195 =head2 Фабрика элементов управления | |
| 196 | |
| 197 Для создания элементов управления используются фабрики. Каждый элемен управления имеет свой шаблон для | |
| 198 форматиорвания содержимого, фабрика связывает шаблон и класс элемента управления, для чего при загрузке | |
| 199 шаблона используется свойство C<type> из метаданных. Фабрика загружается в документ при том только один | |
| 200 раз, повторные загрузки фабрики возвращают уже загруженную. Для загрузки фабрики используется метод | |
| 201 C<require()>. | |
| 202 | |
|
190
cd1ff7029a63
IMLP::Web::View refactored, added new method 'require' which is available inside templates. Changed document rendering.
cin
parents:
189
diff
changeset
|
203 |
| 185 | 204 =head2 Порядок обработки документа |
| 205 | |
| 206 =over | |
| 207 | |
| 208 =item 1 Создается документ при помощи метода C<TTLoader::document()> | |
| 209 | |
| 210 =item 1 При создании документа (в конструкторе), происходит выполнение блока C<CTOR> | |
| 211 | |
| 212 =item 1 При вызове метода C<TTDocument::Render()> устанавливаются переменные C<this>, C<document> | |
| 213 и шаблон обрабатывается при помощи метода C<process()> контекста документа. | |
| 214 | |
| 215 =back | |
| 181 | 216 |
| 217 =head2 Загрузка элемента управления | |
| 218 | |
| 219 =over | |
| 220 | |
| 194 | 221 =item 1 C<TInput = require('my/org/input')> |
| 181 | 222 |
| 223 =item 1 Загружает шаблон C<my/org/input.tt> | |
| 224 | |
| 189 | 225 =item 1 Создает фабрику элементов управления с собственным контекстом, унаследованным от контекст документа. |
| 181 | 226 |
| 189 | 227 =item 1 Выполняет шаблон в пространстве имен фабрики |
| 181 | 228 |
| 229 =back | |
| 230 | |
| 231 =head2 Создание элемента управления | |
| 232 | |
| 233 =over | |
| 234 | |
| 194 | 235 =item 1 C<< TInput.new('login') >> |
| 181 | 236 |
| 237 =item 1 Если это первый элемент управления, то выполняетя статический конструктор в контексте фабрики | |
| 238 | |
| 239 =item 1 Создается новый дочерний контекст к контексту фабрики | |
| 240 | |
| 241 =item 1 Создается экземпляр элемента управления | |
| 242 | |
| 243 =item 1 Выполняется блок конструктора в контексте элемента управления, параметр C<this> имеет значение | |
| 244 нового экземпляра элемента управления | |
| 245 | |
| 246 =back | |
| 247 | |
| 248 =head1 MEMBERS | |
| 249 | |
| 250 =over | |
| 251 | |
| 252 =item C<CTOR($template, %options)> | |
| 253 | |
| 254 Создает экземпляр документа с указанным шаблоном и параметрами, параметры | |
| 255 | |
| 256 =back | |
| 257 | |
| 258 =cut |