annotate Lib/IMPL/Web/AutoLocator.pm @ 234:2530d1bb9638

sync
author sergey
date Thu, 11 Oct 2012 20:11:45 +0400
parents 5c82eec23bb6
children a02b110da931
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
210
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
1 package IMPL::Web::AutoLocator;
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
2 use strict;
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
3
232
5c82eec23bb6 Fixed degradations due refactoring
sergey
parents: 229
diff changeset
4 use IMPL::Const qw(:prop);
5c82eec23bb6 Fixed degradations due refactoring
sergey
parents: 229
diff changeset
5 use IMPL::lang qw( :hash );
210
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
6 use URI;
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
7 use URI::Escape;
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
8 use IMPL::declare {
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
9 require => {
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
10 Exception => 'IMPL::Exception',
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
11 ArgumentException => '-IMPL::InvalidArgumentException'
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
12 },
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
13 base => [
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
14 'IMPL::Object' => undef,
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
15 'IMPL::Object::Autofill' => '@_',
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
16 'IMPL::Object::Serializable' => '@_'
229
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
17 ],
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
18 props => [
232
5c82eec23bb6 Fixed degradations due refactoring
sergey
parents: 229
diff changeset
19 base => PROP_RO,
5c82eec23bb6 Fixed degradations due refactoring
sergey
parents: 229
diff changeset
20 view => PROP_RW,
5c82eec23bb6 Fixed degradations due refactoring
sergey
parents: 229
diff changeset
21 query => PROP_RW,
5c82eec23bb6 Fixed degradations due refactoring
sergey
parents: 229
diff changeset
22 hash => PROP_RW
210
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
23 ]
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
24 };
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
25
229
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
26 sub Child {
210
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
27 my $this = shift;
211
2b9b55cfb79b Completed IMPL::Web::AutoLocator, added tests
cin
parents: 210
diff changeset
28 my $child = shift or die ArgumentException->new("a child resource identifier is required");
2b9b55cfb79b Completed IMPL::Web::AutoLocator, added tests
cin
parents: 210
diff changeset
29 die ArgumentException->new("a child resource can't be a reference") if ref $child;
210
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
30
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
31 # safe
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
32 $child = uri_escape($child);
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
33
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
34 my %args;
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
35
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
36 $args{base} = $this->base =~ /\/$/ ? $this->base . $child : $this->base . '/' . $child;
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
37 $args{view} = $this->view if $this->view;
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
38 $args{hash} = $this->hash if $this->hash;
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
39
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
40 if (@_) {
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
41 my $query = shift;
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
42
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
43 $args{query} = ref $query eq 'HASH' ? hashMerge($this->query,$query) : $query;
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
44 }
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
45
212
292226770180 bugfixes
sergey
parents: 211
diff changeset
46 return $this->new(%args);
211
2b9b55cfb79b Completed IMPL::Web::AutoLocator, added tests
cin
parents: 210
diff changeset
47 }
2b9b55cfb79b Completed IMPL::Web::AutoLocator, added tests
cin
parents: 210
diff changeset
48
2b9b55cfb79b Completed IMPL::Web::AutoLocator, added tests
cin
parents: 210
diff changeset
49 sub SetView {
2b9b55cfb79b Completed IMPL::Web::AutoLocator, added tests
cin
parents: 210
diff changeset
50 my ($this,$newView) = @_;
2b9b55cfb79b Completed IMPL::Web::AutoLocator, added tests
cin
parents: 210
diff changeset
51
2b9b55cfb79b Completed IMPL::Web::AutoLocator, added tests
cin
parents: 210
diff changeset
52 $this->view($newView);
2b9b55cfb79b Completed IMPL::Web::AutoLocator, added tests
cin
parents: 210
diff changeset
53
2b9b55cfb79b Completed IMPL::Web::AutoLocator, added tests
cin
parents: 210
diff changeset
54 return $this;
2b9b55cfb79b Completed IMPL::Web::AutoLocator, added tests
cin
parents: 210
diff changeset
55 }
2b9b55cfb79b Completed IMPL::Web::AutoLocator, added tests
cin
parents: 210
diff changeset
56
2b9b55cfb79b Completed IMPL::Web::AutoLocator, added tests
cin
parents: 210
diff changeset
57 sub url {
2b9b55cfb79b Completed IMPL::Web::AutoLocator, added tests
cin
parents: 210
diff changeset
58 my ($this) = @_;
2b9b55cfb79b Completed IMPL::Web::AutoLocator, added tests
cin
parents: 210
diff changeset
59
2b9b55cfb79b Completed IMPL::Web::AutoLocator, added tests
cin
parents: 210
diff changeset
60 my $url = URI->new($this->view ? $this->base . "." . $this->view : $this->base);
2b9b55cfb79b Completed IMPL::Web::AutoLocator, added tests
cin
parents: 210
diff changeset
61 $url->query_form($this->query);
2b9b55cfb79b Completed IMPL::Web::AutoLocator, added tests
cin
parents: 210
diff changeset
62 $url->fragment($this->hash);
2b9b55cfb79b Completed IMPL::Web::AutoLocator, added tests
cin
parents: 210
diff changeset
63
2b9b55cfb79b Completed IMPL::Web::AutoLocator, added tests
cin
parents: 210
diff changeset
64 return $url;
2b9b55cfb79b Completed IMPL::Web::AutoLocator, added tests
cin
parents: 210
diff changeset
65 }
2b9b55cfb79b Completed IMPL::Web::AutoLocator, added tests
cin
parents: 210
diff changeset
66
2b9b55cfb79b Completed IMPL::Web::AutoLocator, added tests
cin
parents: 210
diff changeset
67 sub AUTOLOAD {
2b9b55cfb79b Completed IMPL::Web::AutoLocator, added tests
cin
parents: 210
diff changeset
68 our $AUTOLOAD;
2b9b55cfb79b Completed IMPL::Web::AutoLocator, added tests
cin
parents: 210
diff changeset
69
2b9b55cfb79b Completed IMPL::Web::AutoLocator, added tests
cin
parents: 210
diff changeset
70 (my $method) = ($AUTOLOAD =~ m/(\w+)$/);
2b9b55cfb79b Completed IMPL::Web::AutoLocator, added tests
cin
parents: 210
diff changeset
71
2b9b55cfb79b Completed IMPL::Web::AutoLocator, added tests
cin
parents: 210
diff changeset
72 return if $method eq 'DESTROY';
2b9b55cfb79b Completed IMPL::Web::AutoLocator, added tests
cin
parents: 210
diff changeset
73
2b9b55cfb79b Completed IMPL::Web::AutoLocator, added tests
cin
parents: 210
diff changeset
74 my $this = shift;
229
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
75 return $this->Child($method,@_);
210
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
76 }
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
77
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
78
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
79
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
80 1;
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
81
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
82 __END__
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
83
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
84 =head1 NAME
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
85
229
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
86 C<IMPL::Web::AutoLocator> - Обертка вокруг адреса ресурса.
210
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
87
229
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
88 =head1 SYNOPSIS
210
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
89
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
90 =begin code
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
91
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
92 use IMPL::require {
229
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
93 Locator => 'IMPL::Web::AutoLocator'
210
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
94 };
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
95
212
292226770180 bugfixes
sergey
parents: 211
diff changeset
96 my $bugTracker = Locator->new(base => "http://myhost.org/bugzilla")->SetView("cgi");
210
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
97
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
98 my $bug = $bugTracker->show_bug({id = 1});
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
99
212
292226770180 bugfixes
sergey
parents: 211
diff changeset
100 my $wikiPages = Locator->new(base => "http://myhost.org/wiki/bin/view");
210
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
101
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
102 my $page = $wiki->Main->HowTo;
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
103
229
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
104 my $images = Locator->new(base => "http://static.myhost.org/images", view => "png");
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
105
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
106 my $editIco = $images->icons->small->edit;
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
107
210
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
108 =end code
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
109
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
110 =head1 DESCRIPTION
6adaeb86945d added IMPL::Web::AutoLocator
sergey
parents:
diff changeset
111
229
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
112 Для удобстав навигации по ресурсам, полностью отражает классическую структуру
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
113 иерархически организованных ресурсов. позволяет гибко работать с параметрами
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
114 запроса и хешем. Для постоты чтения реализует метод C<AUTOLOAD> для доступа
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
115 к дочерним ресурсам.
211
2b9b55cfb79b Completed IMPL::Web::AutoLocator, added tests
cin
parents: 210
diff changeset
116
2b9b55cfb79b Completed IMPL::Web::AutoLocator, added tests
cin
parents: 210
diff changeset
117 =head1 MEMBERS
2b9b55cfb79b Completed IMPL::Web::AutoLocator, added tests
cin
parents: 210
diff changeset
118
229
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
119 =head2 C<CTOR(%args)>
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
120
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
121 Создает новый объект расположение. Позволяет задать путь, расширение, параметры
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
122 запроса и фрагмент ресурса.
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
123
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
124 =over
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
125
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
126 =item * C<base>
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
127
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
128 Строка с базовым адресом для дочерних ресурсов.
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
129
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
130 =item * C<view>
211
2b9b55cfb79b Completed IMPL::Web::AutoLocator, added tests
cin
parents: 210
diff changeset
131
229
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
132 Задает суфикс, обозначающий представление ресурса, аналогично расширению у
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
133 файлов. Данный суффикс может использоваться контроллером для выбора
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
134 представления ресурса.
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
135
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
136 =item * C<query>
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
137
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
138 Ссылка на хеш с параметрами запроса
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
139
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
140 =item * C<hash>
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
141
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
142 Часть C<uri> обозначающая фрагмент документа (все, что идет после символа C<#>).
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
143
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
144 =back
211
2b9b55cfb79b Completed IMPL::Web::AutoLocator, added tests
cin
parents: 210
diff changeset
145
229
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
146 =head2 C<Child($child[,$query])>
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
147
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
148 Получает расположение дочернего ресурса. При этом cоздается новый объект адреса ресурса.
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
149
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
150 =head2 C<SetView($view)>
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
151
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
152 Позволяет указать представление (расширение) у текущего адреса ресурса. Изменяет
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
153 представление и возвращает измененный адрес ресурса.
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
154
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
155 =head2 C<[get]base>
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
156
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
157 Базовый адрес, относительно которого будут получены дочерние ресурсы.
211
2b9b55cfb79b Completed IMPL::Web::AutoLocator, added tests
cin
parents: 210
diff changeset
158
229
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
159 =head2 C<[get,set]view>
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
160
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
161 Представление для ресурсов, аналогично расширению у файлов.
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
162
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
163 =head2 C<[get,set]query>
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
164
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
165 Ссылка на хеш с параметрами для C<GET> запроса.
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
166
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
167 =head2 C<[get,set]hash>
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
168
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
169 Часть адреса ресурса, отвечающая за фрагмент.
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
170
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
171 =head2 C<[get]url>
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
172
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
173 Объект C<URI> для текущего адреса.
211
2b9b55cfb79b Completed IMPL::Web::AutoLocator, added tests
cin
parents: 210
diff changeset
174
2b9b55cfb79b Completed IMPL::Web::AutoLocator, added tests
cin
parents: 210
diff changeset
175 =head2 C<AUTLOAD>
2b9b55cfb79b Completed IMPL::Web::AutoLocator, added tests
cin
parents: 210
diff changeset
176
229
47f77e6409f7 heavily reworked the resource model of the web application:
sergey
parents: 212
diff changeset
177 Перенаправляет вызовы методов в метод C<Child> передавая первым параметром имя метода.
212
292226770180 bugfixes
sergey
parents: 211
diff changeset
178
292226770180 bugfixes
sergey
parents: 211
diff changeset
179 =cut
292226770180 bugfixes
sergey
parents: 211
diff changeset
180