Mercurial > pub > Impl

diff Lib/IMPL/Web/Application/ControllerUnit.pm @ 180:d1676be8afcc

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Перекодировка в utf-8
author sourcer
date Fri, 30 Dec 2011 23:40:00 +0300
parents aaab45153411
children 4d0e1962161c
line wrap: on
line diff
--- a/Lib/IMPL/Web/Application/ControllerUnit.pm	Tue Dec 20 23:00:30 2011 +0300
+++ b/Lib/IMPL/Web/Application/ControllerUnit.pm	Fri Dec 30 23:40:00 2011 +0300
@@ -267,34 +267,34 @@
 
 =head1 NAME
 
-C<IMPL::Web::Application::ControllerUnit> -        .
+C<IMPL::Web::Application::ControllerUnit> - базовый класс для обработчика транзакций в модели контроллера.
 
 =head1 DESCRIPTION
 
-,       .     
-      C<transaction>, C<form>.
+Классы, наследуемые от данного класса называется пакетом транзакций. Часть методов в таком классе
+объявляются как транзакции при помощи методов C<transaction>, C<form>.
 
-     ,      .
-    C<InvokeAction($method,$action)>,  / 
-.
+Перед выполнением транзакции создается экземпляр объекта, в рамках которого будет выполнена транзакция.
+Для этого вызывается метод C<InvokeAction($method,$action)>, который создает/восстанавливает контекст
+транзакции.
 
-        .      
-  (C<TransactionWrapper>  C<FormWrapper>).     
-       ,      .  
+Транзакции на данный момент делятся на простые и формы. Различные типы транзакций выполняются при помощи
+различных оберток (C<TransactionWrapper> и C<FormWrapper>). Каждая обертка отвечает за конструирование
+экземпляра объекта и вызов метода для выполнения транзакции, а также за возврат результата выполнения.  
 
-=head2  
+=head2 Простые транзакции
 
-    ,   ,    
- .
+Простые транзакции получаю только запрос, без предварительной обработки, и возвращенный результат напрямую
+передается пользователю.
 
-=head2 
+=head2 Формы
 
-     ,   DOM    .
-  DOM   .      
+При использовании форм запрос предварительно обрабатывается, для получения DOM документа с данными формы.
+Для постороенния DOM документа используется схема. При этом становятся доступны дополнительные свойства
 C<formData>, C<formSchema>, C<formErrors>.
 
-      ,    , 
-  
+Результат выполнения транзакции не возвращается наверх напрямую, а включается в структуру, которая
+выглядит следующим образом
 
 =begin code
 
@@ -312,42 +312,42 @@
 
 =item C<state>
 
-  .
+Состояние верификации формы.
 
 =over
 
 =item C<new>
 
-  ,    ,   .
-      .
+Первоначальное содержимое формы, оно может быть некорректным, но это нормально.
+В данном состоянии транзакция обычно не выполняется.
 
 =item C<correct>
 
-  ,  ,       C<result>
+Данные формы корректны, транзакция выполнена, и ее результат доступен через поле C<result>
 
 =item C<invalid>
 
-    ,     C<formErrors>. 
- .
+Содержимое формы не прошло верификацию, ошибки доступны через поле C<formErrors>. Транзакция
+не выполнялась.
 
 =back
 
 =item C<result>
 
-  ,    .
+Результат выполнения транзакции, если конечно таковая выполнялась.
 
 =item C<formData>
 
-    .   ,     ,
-     ,   .
+ДОМ документ с данными формами. Документ существует всегда, не зависимо от его корректности,
+может быть использован для построения формы, уже заполненную параметрами.
 
 =item C<formSchema>
 
-  ,      .
+Схема данных формы, может использоваться для построения динамических форм.
 
 =item C<formErrors>
 
-       .
+Ссылка на массив с ошибками при проверки формы.
 
 =back
 
@@ -357,47 +357,47 @@
 
 =item C<[get] application>
 
- ,   .
+Объект приложения, которое обрабатывает запрос.
 
 =item C<[get] query>
 
- .
+Текущий запрос.
 
 =item C<[get] response>
 
- .
+Текущий ответ.
 
 =item C<[get] formData>
 
-C<IMPL::DOM::Document>   ,     .
+C<IMPL::DOM::Document> документ с данныим, если данный запрос является формой.
 
 =item C<[get] formSchema>
 
-C<IMPL::DOM::Schema>      .
+C<IMPL::DOM::Schema> документ со схемой формы данного запроса.
 
 =item C<[get] formErrors>
 
-  ,   .      , 
- ,      .
+Ошибки верификации данных, если таковые были. Обычно при наличии ошибок в форме, транзакция
+не выполняется, а эти ошибки передаются в ответ.
 
 =item C<InvokeAction($method,$action)>
 
-   ,       
- .
+Конструирует контекст выполнения транзакции, может быть переопределен для конструирования контекста по
+своим правилам.
 
 =item C<TransactionWrapper($method,$action,$methodInfo)>
 
-    ,       
- .
+Обертка для конструирования простых транзакций, может быть переопределен для конструирования контекста по
+своим правилам.
 
 =item C<FormWrapper($method,$action,$methodInfo)>
 
-   ,       
- .
+Обертка для конструирования форм, может быть переопределен для конструирования контекста по
+своим правилам.
 
 =item C<discover()>
 
-,    ,      C<Simple Module Definition>.
+Метод, опубликованный для вызова контроллером, возвращает описание методов в формате C<Simple Module Definition>.
 
 =begin code
 
@@ -464,4 +464,4 @@
 
 =end code
 
-=cut
\ No newline at end of file
+=cut