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