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

Annotation of /WebApplication/WebMenu.pm

Parent Directory Parent Directory | Revision Log Revision Log


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

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

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3