pub/Impl: Lib/IMPL/Web/Handler/RestController.pm annotate

annotate Lib/IMPL/Web/Handler/RestController.pm @ 231:ff1e8fa932f2

sync

author	sergey
date	Tue, 09 Oct 2012 03:09:41 +0400
parents	6d8092d8ce1b
children	3cebcf6fdb9b

rev	line source
197 6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	1 package IMPL::Web::Handler::RestController;
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	2 use strict;
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	3
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	4 use IMPL::lang qw(:declare :constants);
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	5 use IMPL::declare {
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	6 require => {
229 47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	7 ResourceInterface => 'IMPL::Web::Application::ResourceInterface',
199 e743a8481327 Added REST support for forms (with only get and post methods) sergey parents: 198 diff changeset	8 Exception => 'IMPL::Exception',
e743a8481327 Added REST support for forms (with only get and post methods) sergey parents: 198 diff changeset	9 ArgumentExecption => '-IMPL::InvalidArgumentException',
229 47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	10 NotFoundException => 'IMPL::Web::NotFoundException'
197 6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	11 },
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	12 base => {
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	13 'IMPL::Object' => undef,
198 2ffe6f661605 Implemented IMPL::Web::Handler::RestController cin parents: 197 diff changeset	14 'IMPL::Object::Autofill' => '@_',
2ffe6f661605 Implemented IMPL::Web::Handler::RestController cin parents: 197 diff changeset	15 'IMPL::Object::Serializable' => undef
229 47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	16 },
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	17 props => [
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	18 rootResource => PROP_GET \| PROP_OWNERSET,
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	19 trailingSlash => PROP_GET \| PROP_OWNERSET
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	20 ]
197 6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	21 };
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	22
199 e743a8481327 Added REST support for forms (with only get and post methods) sergey parents: 198 diff changeset	23 sub CTOR {
e743a8481327 Added REST support for forms (with only get and post methods) sergey parents: 198 diff changeset	24 my ($this) = @_;
e743a8481327 Added REST support for forms (with only get and post methods) sergey parents: 198 diff changeset	25
229 47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	26 die ArgumentException->new(rootResource => "A web-resource is required")
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	27 unless eval { $this->rootResource->isa(ResourceInterface) };
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	28
197 6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	29 }
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	30
229 47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	31 sub GetResourcePath {
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	32 my ($this,$action) = @_;
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	33
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	34 my $pathInfo = $action->pathInfo;
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	35 my @segments;
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	36
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	37 if (length $pathInfo) {
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	38
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	39 @segments = split(/\//, $pathInfo, $this->trailingSlash ? -1 : 0);
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	40
230 6d8092d8ce1b reworked IMPL::Security sergey* parents: 229 diff changeset	41 # remove first segment if it is empty
6d8092d8ce1b reworked IMPL::Security sergey* parents: 229 diff changeset	42 shift @segments if @segments && length($segments[0]) == 0;
229 47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	43
230 6d8092d8ce1b reworked IMPL::Security sergey* parents: 229 diff changeset	44 if(@segments) {
6d8092d8ce1b reworked IMPL::Security sergey* parents: 229 diff changeset	45 my ($obj,$view) = (pop(@segments) =~ m/(.*?)(?:\.(\w+))?$/);
6d8092d8ce1b reworked IMPL::Security sergey* parents: 229 diff changeset	46 push @segments, $obj;
6d8092d8ce1b reworked IMPL::Security sergey* parents: 229 diff changeset	47 }
229 47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	48
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	49 }
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	50
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	51 return @segments;
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	52 }
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	53
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	54
197 6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	55 sub Invoke {
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	56 my ($this,$action) = @_;
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	57
229 47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	58 my $method = $action->requestMethod;
197 6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	59
229 47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	60 my @segments = $this->GetResourcePath($action);
198 2ffe6f661605 Implemented IMPL::Web::Handler::RestController cin parents: 197 diff changeset	61
229 47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	62 my $res = $this->rootResource;
197 6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	63
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	64 while(@segments) {
199 e743a8481327 Added REST support for forms (with only get and post methods) sergey parents: 198 diff changeset	65 my $id = shift @segments;
202 5146e17a7b76 IMPL::Web::Application::RestResource fixes, documentation sergey parents: 199 diff changeset	66
229 47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	67 $res = $res->FetchChildResource($id);
197 6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	68 }
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	69
229 47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	70 $res = $res->InvokeHttpVerb($method,$action);
197 6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	71 }
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	72
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	73 1;
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	74
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	75 __END__
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	76
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	77 =pod
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	78
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	79 =head1 NAME
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	80
229 47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	81 C<IMPL::Web::Handler::RestController> - Обрабатывает C<HTTP> запрос передавая
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	82 его соответствующему ресурсу.
213 d6e2ea24af08 sync sergey parents: 212 diff changeset	83
197 6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	84 =head1 SYNOPSIS
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	85
229 47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	86 Используется в конфигурации приложения как элемент цепочки обработчиков.
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	87 Как правило располагается на самом верхнем уровне.
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	88
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	89 =begin code xml
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	90
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	91 <handlers type="ARRAY">
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	92 <item type="IMPL::Web::Handler::RestController">
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	93 <rootResource type="My::App::Web::RootResource"/>
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	94 </item>
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	95 <item type="IMPL::Web::Handler::JSONView" />
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	96 <item type="IMPL::Web::Handler::SecureCookie" />
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	97 <item type="IMPL::Web::Handler::ErrorHandler" />
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	98 </handlers>
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	99
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	100 =end code xml
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	101
213 d6e2ea24af08 sync sergey parents: 212 diff changeset	102
197 6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	103 =head1 DESCRIPTION
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	104
229 47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	105 Использует C<PATH_INFO> для определения нужного ресурса, затем предает
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	106 найденному ресурсу управление для обработки запроса.
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	107
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	108 Если ресурс не найден, то возникает исключение C<IMPL::Web::NotFoundException>.
213 d6e2ea24af08 sync sergey parents: 212 diff changeset	109
229 47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	110 Для определения нужного ресурса контроллер разбивает C<PATH_INFO> на фрагменты
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	111 и использует каждый фрагмент для получения дочернего ресурса начиная с корневого.
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	112 Для чего используется метод
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	113 C<< IMPL::Web::Application::ResourceInterface->FetchChildResource($childId) >>.
213 d6e2ea24af08 sync sergey parents: 212 diff changeset	114
229 47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	115 =head1 MEMEBERS
213 d6e2ea24af08 sync sergey parents: 212 diff changeset	116
229 47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	117 =head2 C<[get]rootResource>
213 d6e2ea24af08 sync sergey parents: 212 diff changeset	118
229 47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	119 Корневой ресурс приложения, должен быть всегда и реализовывать интерфес ресурса
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	120 C<IMPL::Web::Application::ResourceInterface>.
213 d6e2ea24af08 sync sergey parents: 212 diff changeset	121
229 47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	122 =head2 C<[get]trailingSlash>
213 d6e2ea24af08 sync sergey parents: 212 diff changeset	123
229 47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	124 Если данная переменная имеет значение C<true>, то слеш в конце пути к ресурсу
47f77e6409f7 heavily reworked the resource model of the web application: sergey parents: 213 diff changeset	125 будет интерпретироваться, как дочерний ресурс с пустым идентификатором.
197 6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	126
6b1dda998839 Added IMPL::declare, IMPL::require, to simplify module definitions sergey parents: diff changeset	127 =cut

Mercurial > pub > Impl

annotate Lib/IMPL/Web/Handler/RestController.pm @ 231:ff1e8fa932f2