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

Annotation of /WebApplication/WebMenu.pm

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.3 - (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.3 # $Id: WebMenu.pm,v 1.2 2007/03/14 20:19:03 paarmann 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.3 my ($self, $category, $url, $target, $right) = @_;
121 : paarmann 1.1
122 :     unless ($category) {
123 :     confess 'No category given.';
124 :     }
125 :    
126 :     if (exists($self->{categories_index}->{$category})) {
127 :     confess "Trying to add category '$category' which already exists.";
128 :     }
129 :    
130 :     $url = '' unless ($url);
131 :     $target = '' unless ($target);
132 :    
133 :     # update the category index
134 :     $self->{categories_index}->{$category} = scalar(@{$self->{categories}});
135 :    
136 :     # add the category and link
137 : paczian 1.3 push @{$self->{categories}}, [ $category, $url, $target, $right ];
138 : paarmann 1.1
139 :     # init the entries array for that category
140 :     $self->{entries}->{$category} = [];
141 :    
142 :     return $self;
143 :     }
144 :    
145 :    
146 :     =pod
147 :    
148 :     =item * B<delete_category> (I<category>)
149 :    
150 : paarmann 1.2 Deletes a category from the menu. I<category> is mandatory and expects the
151 :     name of the menu category. If the category does not exist a warning is printed.
152 : paarmann 1.1
153 :     =cut
154 :    
155 :     sub delete_category {
156 :     my ($self, $category) = @_;
157 :    
158 :     unless ($category) {
159 :     confess 'No category given.';
160 :     }
161 :    
162 :     my $i = $self->{categories_index}->{$category};
163 :     if ($i) {
164 :     splice @{$self->{categories}}, $i, 1;
165 :     delete $self->{categories_index}->{$category};
166 :     delete $self->{entries}->{$category}
167 :     }
168 :     else {
169 :     warn "Trying to delete non-existant category '$category'.";
170 :     }
171 :    
172 :     return $self;
173 :     }
174 :    
175 :    
176 :     =pod
177 :    
178 :     =item * B<get_categories> ()
179 :    
180 :     Returns the names of all categories (in a random order).
181 :    
182 :     =cut
183 :    
184 :     sub get_categories {
185 :     return keys(%{$_[0]->{categories_index}});
186 :     }
187 :    
188 :    
189 :     =pod
190 :    
191 :     =item * B<add_entry> (I<category>, I<entry>, I<url>)
192 :    
193 : paarmann 1.2 Adds an entry and link to a existing category of the menu. I<category>, I<entry>
194 :     and I<url> are mandatory. I<category> expects the name of the menu category.
195 :     I<entry> can be any string, I<url> expects a url. I<target> is optional and
196 :     defines a href target for that link.
197 : paarmann 1.1
198 :     =cut
199 :    
200 :     sub add_entry {
201 :     my ($self, $category, $entry, $url, $target) = @_;
202 :    
203 :     unless ($category and $entry and $url) {
204 :     confess "Missing parameter ('$category', '$entry', '$url').";
205 :     }
206 :    
207 :     unless (exists($self->{categories_index}->{$category})) {
208 :     confess "Trying to add to non-existant category '$category'.";
209 :     }
210 :    
211 :     $target = '' unless ($target);
212 :    
213 :     push @{$self->{entries}->{$category}}, [ $entry, $url, $target ];
214 :    
215 :     return $self;
216 :     }
217 :    
218 :     =pod
219 :    
220 : paczian 1.3 =item * B<output> (I<application>)
221 : paarmann 1.1
222 : paczian 1.3 Returns the html output of the menu. I<application> must be a reference to the
223 :     application this menu is being printed in. This is only neccessary if rights
224 :     are required for any category to be displayed.
225 : paarmann 1.1
226 :     =cut
227 :    
228 :     sub output {
229 : paczian 1.3 my ($self, $application) = @_;
230 :    
231 :     return '' unless scalar(@{$self->{categories}});
232 : paarmann 1.1
233 :     my $html = "<div id='menu'>\n";
234 :     $html .= "\t<ul id='nav'>\n";
235 :    
236 :     foreach (@{$self->{categories}}) {
237 :    
238 : paczian 1.3 my ($cat, $c_url, $c_target, $right) = @$_;
239 :    
240 :     # check if a right is required to see this category
241 :     if (defined($right)) {
242 :     unless (defined($application) && ref($application) eq 'WebApplication') {
243 :     confess "When using rights for a menu category, an application reference must be passed.";
244 :     }
245 :     next unless ($application->session->user && $application->session->user->has_right($application, @$right));
246 :     }
247 :    
248 : paarmann 1.1 my $url = ($c_url) ? qq~href="$c_url"~ : '';
249 :     my $target = ($c_target) ? qq~target="$c_target"~ : '';
250 :    
251 :     $html .= qq~\t\t<li><div><a $url $target>$cat</a></div>\n~;
252 :    
253 :     if (scalar(@{$self->{entries}->{$cat}})) {
254 :    
255 :     $html .= "\t\t<ul>\n";
256 :    
257 :     foreach (@{$self->{entries}->{$cat}}) {
258 :    
259 :     my ($entry, $e_url, $e_target) = @$_;
260 :     my $target = ($e_target) ? qq~target="$e_target"~ : '';
261 :     $html .= qq~\t\t\t<li><a href="$e_url" $target>$entry</a></li>\n~;
262 :     }
263 :    
264 :     $html .= "\t\t</ul>\n";
265 :    
266 :     }
267 :    
268 :     $html .= "\t\t</li>\n";
269 :    
270 :     }
271 :    
272 :     $html .= "\t</ul>\n";
273 : paczian 1.3
274 :     # display user string
275 :     if ($application->session->user) {
276 :     $html .= qq~<div id="user" style="padding-top: 4px; padding-right: 5px; text-align: right;">
277 :     <img height="15px" src="./Html/user.gif" title="Current User" />
278 :     <strong>~ . $application->session->user->firstname . " " . $application->session->user->lastname . qq~</strong></div>~;
279 :     }
280 :    
281 : paarmann 1.1 $html .= "</div>\n";
282 :    
283 :     return $html;
284 :    
285 :     }

MCS Webmaster
ViewVC Help
Powered by ViewVC 1.0.3