[Bio] / WebApplication / WebMenu.pm Repository:
ViewVC logotype

Annotation of /WebApplication/WebMenu.pm

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.8 - (view) (download) (as text)

1 : paarmann 1.1 package WebMenu;
2 :    
3 : paarmann 1.2 # WebMenu - manage menu for the WeApplication framework
4 :    
5 : parrello 1.8 # $Id: WebMenu.pm,v 1.7 2007/11/15 21:53:40 paczian Exp $
6 : paarmann 1.2
7 : paarmann 1.1 use strict;
8 :     use warnings;
9 : parrello 1.8 use Tracer;
10 : paarmann 1.1
11 :    
12 :     =pod
13 :    
14 :     =head1 NAME
15 :    
16 :     WebMenu - manage menu for the WeApplication framework
17 :    
18 :     =head1 SYNOPSIS
19 :    
20 :     use WebMenu;
21 :    
22 :     my $menu = WebMenu->new();
23 :    
24 :     $menu->add_category("Edit");
25 :    
26 :     $menu->add_entry("Edit", "Copy", "copy.cgi");
27 :    
28 :     $menu->add_entry("Edit", "Paste", "paste.cgi", "_blank");
29 :    
30 :     $menu->output();
31 :    
32 :    
33 :     =head1 DESCRIPTION
34 :    
35 : paarmann 1.2 The WebMenu module defines a mechanism to build a menu structure by defining
36 :     categories (top level menu entries) and optional links, as well as sub entries
37 :     for each of the categories (consisting of a entry name, an url and an optional
38 :     browser target.
39 :    
40 :     The html output of the menu consists of an unordered list of lists, ie. a two
41 :     level hierarchy of html links (<a href> tags) embedded in <ul> tags representing
42 :     categories and their entries.
43 : paarmann 1.1
44 :     =head1 METHODS
45 :    
46 :     =over 4
47 :    
48 :     =item * B<new> ()
49 :    
50 :     Creates a new instance of the WebMenu object.
51 :    
52 :     =cut
53 :    
54 :     sub new {
55 :     my $class = shift;
56 :    
57 :     my $self = { home => undef,
58 :     entries => {},
59 :     categories => [],
60 :     categories_index => {},
61 : paczian 1.5 search => 0,
62 : paarmann 1.1 };
63 :     bless $self, $class;
64 :    
65 :     return $self;
66 :     }
67 :    
68 :    
69 :     =pod
70 :    
71 :     =item * B<flush> ()
72 :    
73 :     Flushes all categories and entries from the menu (leaving it empty).
74 :    
75 :     =cut
76 :    
77 :     sub flush {
78 :     my $self = shift;
79 :     $self->{home} = undef;
80 :     $self->{entries} = {};
81 :     $self->{categories} = [];
82 :     $self->{categories_index} = {};
83 : paczian 1.5 $self->{search} = 0;
84 : paarmann 1.1 return $self;
85 :     }
86 :    
87 :    
88 :     =pod
89 :    
90 :     =item * B<home> (I<url>)
91 :    
92 : paarmann 1.2 Returns the link of the home page. If the optional parameter I<url> is given,
93 :     home will be set. I<url> may be undef.
94 : paarmann 1.1
95 :     =cut
96 :    
97 :     sub home {
98 :     my $self = shift;
99 :     if (scalar(@_)) {
100 :     $self->{home} = $_[0];
101 :     }
102 :     return $self->{home};
103 :     }
104 :    
105 :    
106 :     =pod
107 :    
108 : paczian 1.3 =item * B<add_category> (I<category>, I<url>, I<target>, I<right>)
109 : paarmann 1.1
110 : paarmann 1.2 Adds a category to the menu. I<category> is mandatory and expects the name of the
111 :     menu category. I<url> is optional and will add a link to the category name in the menu.
112 : paczian 1.3 I<target> is optional and defines a href target for that link. The optional I<right>
113 :     parameter specifies the right a user must have to be able to see this category.
114 : paarmann 1.1
115 :     =cut
116 :    
117 :     sub add_category {
118 : paczian 1.4 my ($self, $category, $url, $target, $right, $order) = @_;
119 : paarmann 1.1
120 :     unless ($category) {
121 : paarmann 1.6 die 'No category given.';
122 : paarmann 1.1 }
123 :    
124 : paczian 1.4 unless ($order) {
125 :     $order = scalar(@{$self->{categories}});
126 :     }
127 :    
128 : paarmann 1.1 if (exists($self->{categories_index}->{$category})) {
129 : paarmann 1.6 die "Trying to add category '$category' which already exists.";
130 : paarmann 1.1 }
131 :    
132 :     $url = '' unless ($url);
133 :     $target = '' unless ($target);
134 :    
135 :     # update the category index
136 :     $self->{categories_index}->{$category} = scalar(@{$self->{categories}});
137 :    
138 :     # add the category and link
139 : paczian 1.4 push @{$self->{categories}}, [ $category, $url, $target, $right, $order ];
140 : paarmann 1.1
141 :     # init the entries array for that category
142 :     $self->{entries}->{$category} = [];
143 :    
144 :     return $self;
145 :     }
146 :    
147 :    
148 :     =pod
149 :    
150 :     =item * B<delete_category> (I<category>)
151 :    
152 : paarmann 1.2 Deletes a category from the menu. I<category> is mandatory and expects the
153 :     name of the menu category. If the category does not exist a warning is printed.
154 : paarmann 1.1
155 :     =cut
156 :    
157 :     sub delete_category {
158 :     my ($self, $category) = @_;
159 :    
160 :     unless ($category) {
161 : paarmann 1.6 die 'No category given.';
162 : paarmann 1.1 }
163 :    
164 :     my $i = $self->{categories_index}->{$category};
165 :     if ($i) {
166 :     splice @{$self->{categories}}, $i, 1;
167 :     delete $self->{categories_index}->{$category};
168 :     delete $self->{entries}->{$category}
169 :     }
170 :     else {
171 :     warn "Trying to delete non-existant category '$category'.";
172 :     }
173 :    
174 :     return $self;
175 :     }
176 :    
177 :    
178 :     =pod
179 :    
180 :     =item * B<get_categories> ()
181 :    
182 :     Returns the names of all categories (in a random order).
183 :    
184 :     =cut
185 :    
186 :     sub get_categories {
187 :     return keys(%{$_[0]->{categories_index}});
188 :     }
189 :    
190 : paczian 1.5 =pod
191 :    
192 :     =item * B<search> (I<search_component>)
193 :    
194 :     Getter / Setter for the search component of the menu
195 :    
196 :     =cut
197 :    
198 :     sub search {
199 :     my ($self, $search) = @_;
200 :    
201 :     if (defined($search)) {
202 :     $self->{search} = $search;
203 :     }
204 :    
205 :     return $self->{search};
206 :     }
207 : paarmann 1.1
208 :     =pod
209 :    
210 :     =item * B<add_entry> (I<category>, I<entry>, I<url>)
211 :    
212 : paarmann 1.2 Adds an entry and link to a existing category of the menu. I<category>, I<entry>
213 :     and I<url> are mandatory. I<category> expects the name of the menu category.
214 :     I<entry> can be any string, I<url> expects a url. I<target> is optional and
215 :     defines a href target for that link.
216 : paarmann 1.1
217 :     =cut
218 :    
219 :     sub add_entry {
220 :     my ($self, $category, $entry, $url, $target) = @_;
221 :    
222 : paczian 1.7 unless ($category and $entry){# and $url) {
223 : paarmann 1.6 die "Missing parameter ('$category', '$entry', '$url').";
224 : paarmann 1.1 }
225 :    
226 :     unless (exists($self->{categories_index}->{$category})) {
227 : paarmann 1.6 die "Trying to add to non-existant category '$category'.";
228 : paarmann 1.1 }
229 :    
230 :     $target = '' unless ($target);
231 :    
232 :     push @{$self->{entries}->{$category}}, [ $entry, $url, $target ];
233 :    
234 :     return $self;
235 :     }
236 :    
237 :     =pod
238 :    
239 : paczian 1.3 =item * B<output> (I<application>)
240 : paarmann 1.1
241 : paczian 1.3 Returns the html output of the menu. I<application> must be a reference to the
242 :     application this menu is being printed in. This is only neccessary if rights
243 :     are required for any category to be displayed.
244 : paarmann 1.1
245 :     =cut
246 :    
247 :     sub output {
248 : paczian 1.3 my ($self, $application) = @_;
249 :    
250 :     return '' unless scalar(@{$self->{categories}});
251 : paarmann 1.1
252 :     my $html = "<div id='menu'>\n";
253 :     $html .= "\t<ul id='nav'>\n";
254 :    
255 : paczian 1.4 my @ordered_categories = sort { $a->[4] <=> $b->[4] } @{$self->{categories}};
256 :     foreach (@ordered_categories) {
257 : paarmann 1.1
258 : paczian 1.4 my ($cat, $c_url, $c_target, $right, $order) = @$_;
259 : paczian 1.3
260 :     # check if a right is required to see this category
261 :     if (defined($right)) {
262 :     unless (defined($application) && ref($application) eq 'WebApplication') {
263 : paarmann 1.6 die "When using rights for a menu category, an application reference must be passed.";
264 : paczian 1.3 }
265 : paarmann 1.6 next unless ($application->session->user &&
266 :     $application->session->user->has_right($application, @$right));
267 : paczian 1.3 }
268 :    
269 : paarmann 1.1 my $url = ($c_url) ? qq~href="$c_url"~ : '';
270 :     my $target = ($c_target) ? qq~target="$c_target"~ : '';
271 :    
272 :     $html .= qq~\t\t<li><div><a $url $target>$cat</a></div>\n~;
273 :    
274 :     if (scalar(@{$self->{entries}->{$cat}})) {
275 :    
276 :     $html .= "\t\t<ul>\n";
277 :    
278 :     foreach (@{$self->{entries}->{$cat}}) {
279 :    
280 :     my ($entry, $e_url, $e_target) = @$_;
281 : paczian 1.7 if ($e_url) {
282 :     my $target = ($e_target) ? qq~target="$e_target"~ : '';
283 :     $html .= qq~\t\t\t<li><a href="$e_url" $target>$entry</a></li>\n~;
284 :     } else {
285 :     $html .= qq~\t\t\t<li>$entry</li>\n~;
286 :     }
287 : paarmann 1.1 }
288 :    
289 :     $html .= "\t\t</ul>\n";
290 :    
291 :     }
292 :    
293 :     $html .= "\t\t</li>\n";
294 :    
295 :     }
296 :    
297 :     $html .= "\t</ul>\n";
298 : paczian 1.3
299 : paarmann 1.1 $html .= "</div>\n";
300 :    
301 :     return $html;
302 :    
303 :     }
304 : paarmann 1.6
305 :     1;

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3