Mercurial > pub > Impl
annotate Lib/IMPL/Web/Application/ControllerUnit.pm @ 128:08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
A complete documentation for a IMPL::Web::Application::ControllerUnit
| author | wizard |
|---|---|
| date | Tue, 15 Jun 2010 02:41:07 +0400 |
| parents | 0dce0470a3d8 |
| children | 42fbb38d4a48 |
| rev | line source |
|---|---|
| 110 | 1 package IMPL::Web::Application::ControllerUnit; |
| 112 | 2 use strict; |
| 110 | 3 use base qw(IMPL::Object); |
| 4 | |
| 5 use IMPL::Class::Property; | |
| 112 | 6 use IMPL::DOM::Transform::PostToDOM; |
| 7 use IMPL::DOM::Schema; | |
| 113 | 8 use Class::Inspector; |
| 9 use File::Spec; | |
| 112 | 10 |
| 11 use constant { | |
| 12 CONTROLLER_METHODS => 'controller_methods', | |
| 13 STATE_CORRECT => 'correct', | |
| 14 STATE_NEW => 'new', | |
| 15 STATE_INVALID => 'invalid' | |
| 16 }; | |
| 110 | 17 |
| 18 BEGIN { | |
| 19 public property action => prop_get | owner_set; | |
| 20 public property application => prop_get | owner_set; | |
| 21 public property query => prop_get | owner_set; | |
| 111 | 22 public property formData => prop_get | owner_set; |
| 23 public property formSchema => prop_get | owner_set; | |
| 24 public property formErrors => prop_get | owner_set; | |
| 110 | 25 } |
| 26 | |
| 113 | 27 __PACKAGE__->class_data(CONTROLLER_METHODS,{}); |
| 28 | |
| 110 | 29 sub CTOR { |
| 112 | 30 my ($this,$action,$args) = @_; |
| 110 | 31 |
| 32 $this->action($action); | |
| 33 $this->application($action->application); | |
| 34 $this->query($action->query); | |
| 112 | 35 |
| 36 $this->$_($args->{$_}) foreach qw(formData formSchema formErrors); | |
| 37 } | |
| 38 | |
| 39 sub forms { | |
| 40 my ($self,%forms) = @_; | |
| 41 | |
| 42 while ( my ($method,$info) = each %forms ) { | |
| 43 die new IMPL::Exception("A method doesn't exists in the controller",$self,$method) unless $self->can($method); | |
| 44 if ( not ref $info ) { | |
| 45 $self->class_data(CONTROLLER_METHODS)->{$method} = { | |
| 46 wrapper => 'FormWrapper', | |
| 47 schema => $info | |
| 48 }; | |
| 49 } elsif (ref $info eq 'HASH') { | |
| 50 die new IMPL::Exception("A schema must be specified",$self,$method) unless $info->{schema}; | |
| 51 | |
| 52 $self->class_data(CONTROLLER_METHODS)->{$method} = { | |
| 53 wrapper => 'FormWrapper', | |
| 54 schema => $info->{schema} | |
| 55 }; | |
| 56 } else { | |
| 57 die new IMPL::Exception("Unsupported method information",$self,$method); | |
| 58 } | |
| 59 } | |
| 60 } | |
| 61 | |
| 62 sub transactions { | |
| 113 | 63 my ($self,@names) = @_; |
| 112 | 64 |
| 113 | 65 $self->class_data(CONTROLLER_METHODS)->{$_} = {} foreach @names; |
| 110 | 66 } |
| 67 | |
| 68 sub InvokeAction { | |
| 69 my ($self,$method,$action) = @_; | |
| 70 | |
| 112 | 71 if (my $methodInfo = $self->class_data(CONTROLLER_METHODS)->{$method}) { |
| 72 if (my $wrapper = $methodInfo->{wrapper}) { | |
| 73 return $self->$wrapper($method,$action,$methodInfo); | |
| 74 } else { | |
| 75 return $self->TransactionWrapper($method,$action,$methodInfo); | |
| 76 } | |
| 110 | 77 } else { |
| 78 die new IMPL::InvalidOperationException("Invalid method call",$self,$method); | |
| 79 } | |
| 111 | 80 } |
| 81 | |
| 112 | 82 sub TransactionWrapper { |
| 83 my ($self,$method,$action,$methodInfo) = @_; | |
| 84 | |
| 85 my $unit = $self->new($action); | |
| 86 return $unit->$method(); | |
| 87 } | |
| 88 | |
| 89 sub FormWrapper { | |
| 113 | 90 my ($self,$method,$action,$methodInfo) = @_; |
| 91 | |
| 92 my $schema = $self->loadSchema($methodInfo->{schema}); | |
| 93 | |
| 94 my $process = $action->query->param('process') || 0; | |
| 95 my $form = $methodInfo->{form} | |
| 96 || $action->query->param('form') | |
| 97 || $schema->selectSingleNode('ComplexNode')->name | |
| 98 or die new IMPL::Exception('No situable form name could be determined',$self,$method); | |
| 112 | 99 |
| 113 | 100 my %result; |
| 112 | 101 |
| 113 | 102 my $transform = IMPL::DOM::Transform::PostToDOM->new( |
| 103 undef, | |
| 104 $schema, | |
| 105 $form | |
| 106 ); | |
| 107 | |
| 108 $result{formSchema} = $schema; | |
| 126 | 109 $result{formData} = $transform->Transform($action->query); |
| 110 | |
| 112 | 111 |
| 113 | 112 if ($process) { |
| 113 $result{formErrors} = $transform->Errors->as_list; | |
| 114 if ($transform->Errors->Count) { | |
| 115 $result{state} = STATE_INVALID; | |
| 116 } else { | |
| 117 $result{state} = STATE_CORRECT; | |
| 118 my $unit = $self->new($action,\%result); | |
|
127
0dce0470a3d8
In the IMPL::Web::ControllerUnit added the ability to notify a form about a wrong data from a transaction
wizard
parents:
126
diff
changeset
|
119 |
|
0dce0470a3d8
In the IMPL::Web::ControllerUnit added the ability to notify a form about a wrong data from a transaction
wizard
parents:
126
diff
changeset
|
120 eval { |
|
0dce0470a3d8
In the IMPL::Web::ControllerUnit added the ability to notify a form about a wrong data from a transaction
wizard
parents:
126
diff
changeset
|
121 $result{result} = $unit->$method(); |
|
0dce0470a3d8
In the IMPL::Web::ControllerUnit added the ability to notify a form about a wrong data from a transaction
wizard
parents:
126
diff
changeset
|
122 }; |
|
0dce0470a3d8
In the IMPL::Web::ControllerUnit added the ability to notify a form about a wrong data from a transaction
wizard
parents:
126
diff
changeset
|
123 if (my $err = $@) { |
|
0dce0470a3d8
In the IMPL::Web::ControllerUnit added the ability to notify a form about a wrong data from a transaction
wizard
parents:
126
diff
changeset
|
124 $result{state} = STATE_INVALID; |
|
0dce0470a3d8
In the IMPL::Web::ControllerUnit added the ability to notify a form about a wrong data from a transaction
wizard
parents:
126
diff
changeset
|
125 if (eval { $err->isa(typeof IMPL::WrongDataException) } ) { |
|
0dce0470a3d8
In the IMPL::Web::ControllerUnit added the ability to notify a form about a wrong data from a transaction
wizard
parents:
126
diff
changeset
|
126 $result{formErrors} = $err->Args; |
|
0dce0470a3d8
In the IMPL::Web::ControllerUnit added the ability to notify a form about a wrong data from a transaction
wizard
parents:
126
diff
changeset
|
127 } else { |
|
0dce0470a3d8
In the IMPL::Web::ControllerUnit added the ability to notify a form about a wrong data from a transaction
wizard
parents:
126
diff
changeset
|
128 die $err; |
|
0dce0470a3d8
In the IMPL::Web::ControllerUnit added the ability to notify a form about a wrong data from a transaction
wizard
parents:
126
diff
changeset
|
129 } |
|
0dce0470a3d8
In the IMPL::Web::ControllerUnit added the ability to notify a form about a wrong data from a transaction
wizard
parents:
126
diff
changeset
|
130 } |
| 113 | 131 } |
| 132 } else { | |
| 133 $result{state} = STATE_NEW; | |
| 134 } | |
| 112 | 135 |
| 113 | 136 return \%result; |
| 137 } | |
| 138 | |
| 139 sub loadSchema { | |
| 140 my ($self,$name) = @_; | |
| 141 | |
| 126 | 142 if (-f $name) { |
| 143 return IMPL::DOM::Schema->LoadSchema($name); | |
| 144 } else { | |
| 145 my ($vol,$dir,$file) = File::Spec->splitpath( Class::Inspector->resolved_filename(ref $self || $self) ); | |
| 146 | |
| 147 return IMPL::DOM::Schema->LoadSchema(File::Spec->catfile($vol,$dir,$name)); | |
| 148 } | |
| 112 | 149 } |
| 150 | |
| 111 | 151 1; |
| 152 | |
| 153 __END__ | |
| 154 | |
| 155 =pod | |
| 156 | |
| 157 =head1 NAME | |
| 158 | |
| 159 C<IMPL::Web::Application::ControllerUnit> - базовый класс для обработчика транзакций в модели контроллера. | |
| 160 | |
| 161 =head1 DESCRIPTION | |
| 162 | |
| 113 | 163 Классы, наследуемые от данного класса называется пакетом транзакций. Часть методов в таком классе |
| 164 объявляются как транзакции при помощи методов C<transaction>, C<form>. | |
| 111 | 165 |
| 166 Перед выполнением транзакции создается экземпляр объекта, в рамках которого будет выполнена транзакция. | |
| 167 Для этого вызывается метод C<InvokeAction($method,$action)>, который создает/восстанавливает контекст | |
| 168 транзакции. | |
| 169 | |
|
128
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
170 Транзакции на данный момент делятся на простые и формы. Различные типы транзакций выполняются при помощи |
|
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
171 различных оберток (C<TransactionWrapper> и C<FormWrapper>). Каждая обертка отвечает за конструирование |
|
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
172 экземпляра объекта и вызов метода для выполнения транзакции, а также за возврат результата выполнения. |
| 111 | 173 |
| 174 =head2 Простые транзакции | |
| 175 | |
| 176 Простые транзакции получаю только запрос, без предварительной обработки, и возвращенный результат напрямую | |
| 177 передается пользователю. | |
| 178 | |
| 179 =head2 Формы | |
| 180 | |
| 181 При использовании форм запрос предварительно обрабатывается, для получения DOM документа с данными формы. | |
| 182 Для постороенния DOM документа используется схема. При этом становятся доступны дополнительные свойства | |
| 183 C<formData>, C<formSchema>, C<formErrors>. | |
| 184 | |
|
128
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
185 Результат выполнения транзакции не возвращается наверх напрямую, а включается в структуру, которая |
| 111 | 186 выглядит следующим образом |
| 187 | |
| 188 =begin code | |
| 189 | |
| 190 { | |
| 191 state => '{ new | correct | invalid }', | |
| 192 result => $transactionResult, | |
| 193 formData => $formDOM, | |
| 194 formSchema => $formSchema, | |
| 195 formErrors => @errors | |
| 196 } | |
| 197 | |
| 198 =end code | |
| 199 | |
| 200 =over | |
| 201 | |
| 202 =item C<state> | |
| 203 | |
| 204 Состояние верификации формы. | |
| 205 | |
| 206 =over | |
| 207 | |
| 208 =item C<new> | |
| 209 | |
| 210 Первоначальное содержимое формы, оно может быть некорректным, но это нормально. | |
| 211 В данном состоянии транзакция обычно не выполняется. | |
| 212 | |
| 213 =item C<correct> | |
| 214 | |
| 215 Данные формы корректны, транзакция выполнена, и ее результат доступен через поле C<result> | |
| 216 | |
| 217 =item C<invalid> | |
| 218 | |
| 219 Содержимое формы не прошло верификацию, ошибки доступны через поле C<formErrors>. Транзакция | |
| 220 не выполнялась. | |
| 221 | |
| 222 =back | |
| 223 | |
| 224 =item C<result> | |
| 225 | |
| 226 Результат выполнения транзакции, если конечно таковая выполнялась. | |
| 227 | |
| 228 =item C<formData> | |
| 229 | |
| 230 ДОМ документ с данными формами. Документ существует всегда, не зависимо от его корректности, | |
| 231 может быть использован для построения формы, уже заполненную параметрами. | |
| 232 | |
| 233 =item C<formSchema> | |
| 234 | |
| 235 Схема данных формы, может использоваться для построения динамических форм. | |
| 236 | |
| 237 =item C<formErrors> | |
| 238 | |
|
128
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
239 Ссылка на массив с ошибками при проверки формы. |
| 111 | 240 |
| 241 =back | |
| 242 | |
| 243 =head1 MEMBERS | |
| 244 | |
| 245 =over | |
| 246 | |
| 247 =item C<[get] application> | |
| 248 | |
|
128
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
249 Объект приложения, которое обрабатывает запрос. |
|
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
250 |
| 111 | 251 =item C<[get] query> |
| 252 | |
|
128
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
253 Текущий запрос. |
|
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
254 |
| 111 | 255 =item C<[get] response> |
| 256 | |
|
128
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
257 Текущий ответ. |
|
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
258 |
| 111 | 259 =item C<[get] formData> |
| 260 | |
|
128
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
261 C<IMPL::DOM::Document> документ с данныим, если данный запрос является формой. |
|
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
262 |
| 111 | 263 =item C<[get] formSchema> |
| 264 | |
|
128
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
265 C<IMPL::DOM::Schema> документ со схемой формы данного запроса. |
|
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
266 |
| 111 | 267 =item C<[get] formErrors> |
| 268 | |
|
128
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
269 Ошибки верификации данных, если таковые были. Обычно при наличии ошибок в форме, транзакция |
|
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
270 не выполняется, а эти ошибки передаются в ответ. |
|
08753833173d
Fixed a error handling issue in JSON output: errors are correctly transfered
wizard
parents:
127
diff
changeset
|
271 |
| 111 | 272 =item C<InvokeAction($method,$action)> |
| 273 | |
| 274 Конструирует контекст выполнения транзакции, может быть переопределен для конструирования контекста по | |
| 112 | 275 своим правилам. |
| 276 | |
| 277 =item C<TransactionWrapper($method,$action,$methodInfo)> | |
| 278 | |
| 279 Обертка для конструирования простых транзакций, может быть переопределен для конструирования контекста по | |
| 280 своим правилам. | |
| 281 | |
| 282 =item C<FormWrapper($method,$action,$methodInfo)> | |
| 283 | |
| 284 Обертка для конструирования форм, может быть переопределен для конструирования контекста по | |
| 285 своим правилам. | |
| 111 | 286 |
| 287 =back | |
| 288 | |
| 289 =head1 EXAMPLE | |
| 290 | |
| 291 =begin code | |
| 292 | |
| 293 package MyBooksUnit; | |
| 294 use strict; | |
| 295 use base qw(IMPL::Web::Application::ControllerUnit); | |
| 296 | |
| 297 __PACKAGE__->PassThroughArgs; | |
| 298 | |
| 299 __PACKAGE__->transactions(qw( | |
| 300 find | |
| 301 info | |
| 302 )); | |
| 303 __PACKAGE__->forms( | |
| 304 create => 'books.create.xml' | |
| 305 ); | |
| 306 | |
| 307 sub find { | |
| 308 my ($this) = @_; | |
| 309 | |
| 310 return $this->application->dataSource->resultset('Books')->find({author => $this->query->param('author')}); | |
| 311 } | |
| 312 | |
| 313 sub info { | |
| 314 my ($this) = @_; | |
| 315 | |
| 316 return $this->application->dataSource->resultset('Books')->find({id => $this->query->param('id')}); | |
| 317 } | |
| 318 | |
| 319 sub create { | |
| 320 my ($this) = @_; | |
| 321 | |
| 322 my %book = map { | |
| 323 $_ => $this->formData->selectSingleNode($_)->nodeValue | |
| 324 } qw(author_id title year ISBN); | |
| 325 | |
| 326 return $this->application->datasource->resultset('Books')->create(\%book); | |
| 327 } | |
| 328 | |
| 329 =end code | |
| 330 | |
| 331 =cut |